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
;
910 EMACS_INT help_echo_pos
;
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
*,
960 EMACS_INT
, EMACS_INT
);
961 static void store_mode_line_noprop_char (char);
962 static int store_mode_line_noprop (const unsigned char *, int, int);
963 static void x_consider_frame_title (Lisp_Object
);
964 static void handle_stop (struct it
*);
965 static void handle_stop_backwards (struct it
*, EMACS_INT
);
966 static int tool_bar_lines_needed (struct frame
*, int *);
967 static int single_display_spec_intangible_p (Lisp_Object
);
968 static void ensure_echo_area_buffers (void);
969 static Lisp_Object
unwind_with_echo_area_buffer (Lisp_Object
);
970 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
971 static int with_echo_area_buffer (struct window
*, int,
972 int (*) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
973 EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
974 static void clear_garbaged_frames (void);
975 static int current_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
976 static int truncate_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
977 static int set_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
978 static int display_echo_area (struct window
*);
979 static int display_echo_area_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
980 static int resize_mini_window_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
981 static Lisp_Object
unwind_redisplay (Lisp_Object
);
982 static int string_char_and_length (const unsigned char *, int *);
983 static struct text_pos
display_prop_end (struct it
*, Lisp_Object
,
985 static int compute_window_start_on_continuation_line (struct window
*);
986 static Lisp_Object
safe_eval_handler (Lisp_Object
);
987 static void insert_left_trunc_glyphs (struct it
*);
988 static struct glyph_row
*get_overlay_arrow_glyph_row (struct window
*,
990 static void extend_face_to_end_of_line (struct it
*);
991 static int append_space_for_newline (struct it
*, int);
992 static int cursor_row_fully_visible_p (struct window
*, int, int);
993 static int try_scrolling (Lisp_Object
, int, EMACS_INT
, EMACS_INT
, int, int);
994 static int try_cursor_movement (Lisp_Object
, struct text_pos
, int *);
995 static int trailing_whitespace_p (EMACS_INT
);
996 static int message_log_check_duplicate (EMACS_INT
, EMACS_INT
,
997 EMACS_INT
, EMACS_INT
);
998 static void push_it (struct it
*);
999 static void pop_it (struct it
*);
1000 static void sync_frame_with_window_matrix_rows (struct window
*);
1001 static void select_frame_for_redisplay (Lisp_Object
);
1002 static void redisplay_internal (int);
1003 static int echo_area_display (int);
1004 static void redisplay_windows (Lisp_Object
);
1005 static void redisplay_window (Lisp_Object
, int);
1006 static Lisp_Object
redisplay_window_error (Lisp_Object
);
1007 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
1008 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
1009 static int update_menu_bar (struct frame
*, int, int);
1010 static int try_window_reusing_current_matrix (struct window
*);
1011 static int try_window_id (struct window
*);
1012 static int display_line (struct it
*);
1013 static int display_mode_lines (struct window
*);
1014 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
1015 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int);
1016 static int store_mode_line_string (const char *, Lisp_Object
, int, int, int, Lisp_Object
);
1017 static const char *decode_mode_spec (struct window
*, int, int, int,
1019 static void display_menu_bar (struct window
*);
1020 static int display_count_lines (EMACS_INT
, EMACS_INT
, EMACS_INT
, int,
1022 static int display_string (const unsigned char *, Lisp_Object
, Lisp_Object
,
1023 EMACS_INT
, EMACS_INT
, struct it
*, int, int, int, int);
1024 static void compute_line_metrics (struct it
*);
1025 static void run_redisplay_end_trigger_hook (struct it
*);
1026 static int get_overlay_strings (struct it
*, EMACS_INT
);
1027 static int get_overlay_strings_1 (struct it
*, EMACS_INT
, int);
1028 static void next_overlay_string (struct it
*);
1029 static void reseat (struct it
*, struct text_pos
, int);
1030 static void reseat_1 (struct it
*, struct text_pos
, int);
1031 static void back_to_previous_visible_line_start (struct it
*);
1032 void reseat_at_previous_visible_line_start (struct it
*);
1033 static void reseat_at_next_visible_line_start (struct it
*, int);
1034 static int next_element_from_ellipsis (struct it
*);
1035 static int next_element_from_display_vector (struct it
*);
1036 static int next_element_from_string (struct it
*);
1037 static int next_element_from_c_string (struct it
*);
1038 static int next_element_from_buffer (struct it
*);
1039 static int next_element_from_composition (struct it
*);
1040 static int next_element_from_image (struct it
*);
1041 static int next_element_from_stretch (struct it
*);
1042 static void load_overlay_strings (struct it
*, EMACS_INT
);
1043 static int init_from_display_pos (struct it
*, struct window
*,
1044 struct display_pos
*);
1045 static void reseat_to_string (struct it
*, const unsigned char *,
1046 Lisp_Object
, EMACS_INT
, EMACS_INT
, int, int);
1047 static enum move_it_result
1048 move_it_in_display_line_to (struct it
*, EMACS_INT
, int,
1049 enum move_operation_enum
);
1050 void move_it_vertically_backward (struct it
*, int);
1051 static void init_to_row_start (struct it
*, struct window
*,
1052 struct glyph_row
*);
1053 static int init_to_row_end (struct it
*, struct window
*,
1054 struct glyph_row
*);
1055 static void back_to_previous_line_start (struct it
*);
1056 static int forward_to_next_line_start (struct it
*, int *);
1057 static struct text_pos
string_pos_nchars_ahead (struct text_pos
,
1058 Lisp_Object
, EMACS_INT
);
1059 static struct text_pos
string_pos (EMACS_INT
, Lisp_Object
);
1060 static struct text_pos
c_string_pos (EMACS_INT
, const unsigned char *, int);
1061 static EMACS_INT
number_of_chars (const unsigned char *, int);
1062 static void compute_stop_pos (struct it
*);
1063 static void compute_string_pos (struct text_pos
*, struct text_pos
,
1065 static int face_before_or_after_it_pos (struct it
*, int);
1066 static EMACS_INT
next_overlay_change (EMACS_INT
);
1067 static int handle_single_display_spec (struct it
*, Lisp_Object
,
1068 Lisp_Object
, Lisp_Object
,
1069 struct text_pos
*, int);
1070 static int underlying_face_id (struct it
*);
1071 static int in_ellipses_for_invisible_text_p (struct display_pos
*,
1074 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
1075 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
1077 #ifdef HAVE_WINDOW_SYSTEM
1079 static void update_tool_bar (struct frame
*, int);
1080 static void build_desired_tool_bar_string (struct frame
*f
);
1081 static int redisplay_tool_bar (struct frame
*);
1082 static void display_tool_bar_line (struct it
*, int);
1083 static void notice_overwritten_cursor (struct window
*,
1084 enum glyph_row_area
,
1085 int, int, int, int);
1086 static void append_stretch_glyph (struct it
*, Lisp_Object
,
1091 #endif /* HAVE_WINDOW_SYSTEM */
1094 /***********************************************************************
1095 Window display dimensions
1096 ***********************************************************************/
1098 /* Return the bottom boundary y-position for text lines in window W.
1099 This is the first y position at which a line cannot start.
1100 It is relative to the top of the window.
1102 This is the height of W minus the height of a mode line, if any. */
1105 window_text_bottom_y (struct window
*w
)
1107 int height
= WINDOW_TOTAL_HEIGHT (w
);
1109 if (WINDOW_WANTS_MODELINE_P (w
))
1110 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
1114 /* Return the pixel width of display area AREA of window W. AREA < 0
1115 means return the total width of W, not including fringes to
1116 the left and right of the window. */
1119 window_box_width (struct window
*w
, int area
)
1121 int cols
= XFASTINT (w
->total_cols
);
1124 if (!w
->pseudo_window_p
)
1126 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
1128 if (area
== TEXT_AREA
)
1130 if (INTEGERP (w
->left_margin_cols
))
1131 cols
-= XFASTINT (w
->left_margin_cols
);
1132 if (INTEGERP (w
->right_margin_cols
))
1133 cols
-= XFASTINT (w
->right_margin_cols
);
1134 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
1136 else if (area
== LEFT_MARGIN_AREA
)
1138 cols
= (INTEGERP (w
->left_margin_cols
)
1139 ? XFASTINT (w
->left_margin_cols
) : 0);
1142 else if (area
== RIGHT_MARGIN_AREA
)
1144 cols
= (INTEGERP (w
->right_margin_cols
)
1145 ? XFASTINT (w
->right_margin_cols
) : 0);
1150 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
1154 /* Return the pixel height of the display area of window W, not
1155 including mode lines of W, if any. */
1158 window_box_height (struct window
*w
)
1160 struct frame
*f
= XFRAME (w
->frame
);
1161 int height
= WINDOW_TOTAL_HEIGHT (w
);
1163 xassert (height
>= 0);
1165 /* Note: the code below that determines the mode-line/header-line
1166 height is essentially the same as that contained in the macro
1167 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
1168 the appropriate glyph row has its `mode_line_p' flag set,
1169 and if it doesn't, uses estimate_mode_line_height instead. */
1171 if (WINDOW_WANTS_MODELINE_P (w
))
1173 struct glyph_row
*ml_row
1174 = (w
->current_matrix
&& w
->current_matrix
->rows
1175 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1177 if (ml_row
&& ml_row
->mode_line_p
)
1178 height
-= ml_row
->height
;
1180 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1183 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1185 struct glyph_row
*hl_row
1186 = (w
->current_matrix
&& w
->current_matrix
->rows
1187 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1189 if (hl_row
&& hl_row
->mode_line_p
)
1190 height
-= hl_row
->height
;
1192 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1195 /* With a very small font and a mode-line that's taller than
1196 default, we might end up with a negative height. */
1197 return max (0, height
);
1200 /* Return the window-relative coordinate of the left edge of display
1201 area AREA of window W. AREA < 0 means return the left edge of the
1202 whole window, to the right of the left fringe of W. */
1205 window_box_left_offset (struct window
*w
, int area
)
1209 if (w
->pseudo_window_p
)
1212 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1214 if (area
== TEXT_AREA
)
1215 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1216 + window_box_width (w
, LEFT_MARGIN_AREA
));
1217 else if (area
== RIGHT_MARGIN_AREA
)
1218 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1219 + window_box_width (w
, LEFT_MARGIN_AREA
)
1220 + window_box_width (w
, TEXT_AREA
)
1221 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1223 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1224 else if (area
== LEFT_MARGIN_AREA
1225 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1226 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1232 /* Return the window-relative coordinate of the right edge of display
1233 area AREA of window W. AREA < 0 means return the right edge of the
1234 whole window, to the left of the right fringe of W. */
1237 window_box_right_offset (struct window
*w
, int area
)
1239 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1242 /* Return the frame-relative coordinate of the left edge of display
1243 area AREA of window W. AREA < 0 means return the left edge of the
1244 whole window, to the right of the left fringe of W. */
1247 window_box_left (struct window
*w
, int area
)
1249 struct frame
*f
= XFRAME (w
->frame
);
1252 if (w
->pseudo_window_p
)
1253 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1255 x
= (WINDOW_LEFT_EDGE_X (w
)
1256 + window_box_left_offset (w
, area
));
1262 /* Return the frame-relative coordinate of the right edge of display
1263 area AREA of window W. AREA < 0 means return the right edge of the
1264 whole window, to the left of the right fringe of W. */
1267 window_box_right (struct window
*w
, int area
)
1269 return window_box_left (w
, area
) + window_box_width (w
, area
);
1272 /* Get the bounding box of the display area AREA of window W, without
1273 mode lines, in frame-relative coordinates. AREA < 0 means the
1274 whole window, not including the left and right fringes of
1275 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1276 coordinates of the upper-left corner of the box. Return in
1277 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1280 window_box (struct window
*w
, int area
, int *box_x
, int *box_y
,
1281 int *box_width
, int *box_height
)
1284 *box_width
= window_box_width (w
, area
);
1286 *box_height
= window_box_height (w
);
1288 *box_x
= window_box_left (w
, area
);
1291 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1292 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1293 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1298 /* Get the bounding box of the display area AREA of window W, without
1299 mode lines. AREA < 0 means the whole window, not including the
1300 left and right fringe of the window. Return in *TOP_LEFT_X
1301 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1302 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1303 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1307 window_box_edges (struct window
*w
, int area
, int *top_left_x
, int *top_left_y
,
1308 int *bottom_right_x
, int *bottom_right_y
)
1310 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1312 *bottom_right_x
+= *top_left_x
;
1313 *bottom_right_y
+= *top_left_y
;
1318 /***********************************************************************
1320 ***********************************************************************/
1322 /* Return the bottom y-position of the line the iterator IT is in.
1323 This can modify IT's settings. */
1326 line_bottom_y (struct it
*it
)
1328 int line_height
= it
->max_ascent
+ it
->max_descent
;
1329 int line_top_y
= it
->current_y
;
1331 if (line_height
== 0)
1334 line_height
= last_height
;
1335 else if (IT_CHARPOS (*it
) < ZV
)
1337 move_it_by_lines (it
, 1, 1);
1338 line_height
= (it
->max_ascent
|| it
->max_descent
1339 ? it
->max_ascent
+ it
->max_descent
1344 struct glyph_row
*row
= it
->glyph_row
;
1346 /* Use the default character height. */
1347 it
->glyph_row
= NULL
;
1348 it
->what
= IT_CHARACTER
;
1351 PRODUCE_GLYPHS (it
);
1352 line_height
= it
->ascent
+ it
->descent
;
1353 it
->glyph_row
= row
;
1357 return line_top_y
+ line_height
;
1361 /* Return 1 if position CHARPOS is visible in window W.
1362 CHARPOS < 0 means return info about WINDOW_END position.
1363 If visible, set *X and *Y to pixel coordinates of top left corner.
1364 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1365 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1368 pos_visible_p (struct window
*w
, EMACS_INT charpos
, int *x
, int *y
,
1369 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1372 struct text_pos top
;
1374 struct buffer
*old_buffer
= NULL
;
1376 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1379 if (XBUFFER (w
->buffer
) != current_buffer
)
1381 old_buffer
= current_buffer
;
1382 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1385 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1387 /* Compute exact mode line heights. */
1388 if (WINDOW_WANTS_MODELINE_P (w
))
1389 current_mode_line_height
1390 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1391 current_buffer
->mode_line_format
);
1393 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1394 current_header_line_height
1395 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1396 current_buffer
->header_line_format
);
1398 start_display (&it
, w
, top
);
1399 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1400 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1402 if (charpos
>= 0 && IT_CHARPOS (it
) >= charpos
)
1404 /* We have reached CHARPOS, or passed it. How the call to
1405 move_it_to can overshoot: (i) If CHARPOS is on invisible
1406 text, move_it_to stops at the end of the invisible text,
1407 after CHARPOS. (ii) If CHARPOS is in a display vector,
1408 move_it_to stops on its last glyph. */
1409 int top_x
= it
.current_x
;
1410 int top_y
= it
.current_y
;
1411 enum it_method it_method
= it
.method
;
1412 /* Calling line_bottom_y may change it.method, it.position, etc. */
1413 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1414 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1416 if (top_y
< window_top_y
)
1417 visible_p
= bottom_y
> window_top_y
;
1418 else if (top_y
< it
.last_visible_y
)
1422 if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1424 /* We stopped on the last glyph of a display vector.
1425 Try and recompute. Hack alert! */
1426 if (charpos
< 2 || top
.charpos
>= charpos
)
1427 top_x
= it
.glyph_row
->x
;
1431 start_display (&it2
, w
, top
);
1432 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1433 get_next_display_element (&it2
);
1434 PRODUCE_GLYPHS (&it2
);
1435 if (ITERATOR_AT_END_OF_LINE_P (&it2
)
1436 || it2
.current_x
> it2
.last_visible_x
)
1437 top_x
= it
.glyph_row
->x
;
1440 top_x
= it2
.current_x
;
1441 top_y
= it2
.current_y
;
1447 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1448 *rtop
= max (0, window_top_y
- top_y
);
1449 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1450 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1451 - max (top_y
, window_top_y
)));
1460 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1461 move_it_by_lines (&it
, 1, 0);
1462 if (charpos
< IT_CHARPOS (it
)
1463 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1466 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1468 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1469 *rtop
= max (0, -it2
.current_y
);
1470 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1471 - it
.last_visible_y
));
1472 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1474 - max (it2
.current_y
,
1475 WINDOW_HEADER_LINE_HEIGHT (w
))));
1481 set_buffer_internal_1 (old_buffer
);
1483 current_header_line_height
= current_mode_line_height
= -1;
1485 if (visible_p
&& XFASTINT (w
->hscroll
) > 0)
1486 *x
-= XFASTINT (w
->hscroll
) * WINDOW_FRAME_COLUMN_WIDTH (w
);
1489 /* Debugging code. */
1491 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1492 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1494 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1501 /* Return the next character from STR which is MAXLEN bytes long.
1502 Return in *LEN the length of the character. This is like
1503 STRING_CHAR_AND_LENGTH but never returns an invalid character. If
1504 we find one, we return a `?', but with the length of the invalid
1508 string_char_and_length (const unsigned char *str
, int *len
)
1512 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1513 if (!CHAR_VALID_P (c
, 1))
1514 /* We may not change the length here because other places in Emacs
1515 don't use this function, i.e. they silently accept invalid
1524 /* Given a position POS containing a valid character and byte position
1525 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1527 static struct text_pos
1528 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, EMACS_INT nchars
)
1530 xassert (STRINGP (string
) && nchars
>= 0);
1532 if (STRING_MULTIBYTE (string
))
1534 EMACS_INT rest
= SBYTES (string
) - BYTEPOS (pos
);
1535 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1540 string_char_and_length (p
, &len
);
1541 p
+= len
, rest
-= len
;
1542 xassert (rest
>= 0);
1544 BYTEPOS (pos
) += len
;
1548 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1554 /* Value is the text position, i.e. character and byte position,
1555 for character position CHARPOS in STRING. */
1557 static INLINE
struct text_pos
1558 string_pos (EMACS_INT charpos
, Lisp_Object string
)
1560 struct text_pos pos
;
1561 xassert (STRINGP (string
));
1562 xassert (charpos
>= 0);
1563 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1568 /* Value is a text position, i.e. character and byte position, for
1569 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1570 means recognize multibyte characters. */
1572 static struct text_pos
1573 c_string_pos (EMACS_INT charpos
, const unsigned char *s
, int multibyte_p
)
1575 struct text_pos pos
;
1577 xassert (s
!= NULL
);
1578 xassert (charpos
>= 0);
1582 EMACS_INT rest
= strlen (s
);
1585 SET_TEXT_POS (pos
, 0, 0);
1588 string_char_and_length (s
, &len
);
1589 s
+= len
, rest
-= len
;
1590 xassert (rest
>= 0);
1592 BYTEPOS (pos
) += len
;
1596 SET_TEXT_POS (pos
, charpos
, charpos
);
1602 /* Value is the number of characters in C string S. MULTIBYTE_P
1603 non-zero means recognize multibyte characters. */
1606 number_of_chars (const unsigned char *s
, int multibyte_p
)
1612 EMACS_INT rest
= strlen (s
);
1614 unsigned char *p
= (unsigned char *) s
;
1616 for (nchars
= 0; rest
> 0; ++nchars
)
1618 string_char_and_length (p
, &len
);
1619 rest
-= len
, p
+= len
;
1623 nchars
= strlen (s
);
1629 /* Compute byte position NEWPOS->bytepos corresponding to
1630 NEWPOS->charpos. POS is a known position in string STRING.
1631 NEWPOS->charpos must be >= POS.charpos. */
1634 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1636 xassert (STRINGP (string
));
1637 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1639 if (STRING_MULTIBYTE (string
))
1640 *newpos
= string_pos_nchars_ahead (pos
, string
,
1641 CHARPOS (*newpos
) - CHARPOS (pos
));
1643 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1647 Return an estimation of the pixel height of mode or header lines on
1648 frame F. FACE_ID specifies what line's height to estimate. */
1651 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1653 #ifdef HAVE_WINDOW_SYSTEM
1654 if (FRAME_WINDOW_P (f
))
1656 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1658 /* This function is called so early when Emacs starts that the face
1659 cache and mode line face are not yet initialized. */
1660 if (FRAME_FACE_CACHE (f
))
1662 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1666 height
= FONT_HEIGHT (face
->font
);
1667 if (face
->box_line_width
> 0)
1668 height
+= 2 * face
->box_line_width
;
1679 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1680 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1681 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1682 not force the value into range. */
1685 pixel_to_glyph_coords (FRAME_PTR f
, register int pix_x
, register int pix_y
,
1686 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1689 #ifdef HAVE_WINDOW_SYSTEM
1690 if (FRAME_WINDOW_P (f
))
1692 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1693 even for negative values. */
1695 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1697 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1699 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1700 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1703 STORE_NATIVE_RECT (*bounds
,
1704 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1705 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1706 FRAME_COLUMN_WIDTH (f
) - 1,
1707 FRAME_LINE_HEIGHT (f
) - 1);
1713 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1714 pix_x
= FRAME_TOTAL_COLS (f
);
1718 else if (pix_y
> FRAME_LINES (f
))
1719 pix_y
= FRAME_LINES (f
);
1729 /* Given HPOS/VPOS in the current matrix of W, return corresponding
1730 frame-relative pixel positions in *FRAME_X and *FRAME_Y. If we
1731 can't tell the positions because W's display is not up to date,
1735 glyph_to_pixel_coords (struct window
*w
, int hpos
, int vpos
,
1736 int *frame_x
, int *frame_y
)
1738 #ifdef HAVE_WINDOW_SYSTEM
1739 if (FRAME_WINDOW_P (XFRAME (WINDOW_FRAME (w
))))
1743 xassert (hpos
>= 0 && hpos
< w
->current_matrix
->matrix_w
);
1744 xassert (vpos
>= 0 && vpos
< w
->current_matrix
->matrix_h
);
1746 if (display_completed
)
1748 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
1749 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1750 struct glyph
*end
= glyph
+ min (hpos
, row
->used
[TEXT_AREA
]);
1756 hpos
+= glyph
->pixel_width
;
1760 /* If first glyph is partially visible, its first visible position is still 0. */
1772 *frame_x
= WINDOW_TO_FRAME_PIXEL_X (w
, hpos
);
1773 *frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, vpos
);
1784 #ifdef HAVE_WINDOW_SYSTEM
1786 /* Find the glyph under window-relative coordinates X/Y in window W.
1787 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1788 strings. Return in *HPOS and *VPOS the row and column number of
1789 the glyph found. Return in *AREA the glyph area containing X.
1790 Value is a pointer to the glyph found or null if X/Y is not on
1791 text, or we can't tell because W's current matrix is not up to
1796 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1797 int *dx
, int *dy
, int *area
)
1799 struct glyph
*glyph
, *end
;
1800 struct glyph_row
*row
= NULL
;
1803 /* Find row containing Y. Give up if some row is not enabled. */
1804 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1806 row
= MATRIX_ROW (w
->current_matrix
, i
);
1807 if (!row
->enabled_p
)
1809 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1816 /* Give up if Y is not in the window. */
1817 if (i
== w
->current_matrix
->nrows
)
1820 /* Get the glyph area containing X. */
1821 if (w
->pseudo_window_p
)
1828 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1830 *area
= LEFT_MARGIN_AREA
;
1831 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1833 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1836 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1840 *area
= RIGHT_MARGIN_AREA
;
1841 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1845 /* Find glyph containing X. */
1846 glyph
= row
->glyphs
[*area
];
1847 end
= glyph
+ row
->used
[*area
];
1849 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1851 x
-= glyph
->pixel_width
;
1861 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1864 *hpos
= glyph
- row
->glyphs
[*area
];
1870 Convert frame-relative x/y to coordinates relative to window W.
1871 Takes pseudo-windows into account. */
1874 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1876 if (w
->pseudo_window_p
)
1878 /* A pseudo-window is always full-width, and starts at the
1879 left edge of the frame, plus a frame border. */
1880 struct frame
*f
= XFRAME (w
->frame
);
1881 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1882 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1886 *x
-= WINDOW_LEFT_EDGE_X (w
);
1887 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1892 Return in RECTS[] at most N clipping rectangles for glyph string S.
1893 Return the number of stored rectangles. */
1896 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
1903 if (s
->row
->full_width_p
)
1905 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1906 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1907 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1909 /* Unless displaying a mode or menu bar line, which are always
1910 fully visible, clip to the visible part of the row. */
1911 if (s
->w
->pseudo_window_p
)
1912 r
.height
= s
->row
->visible_height
;
1914 r
.height
= s
->height
;
1918 /* This is a text line that may be partially visible. */
1919 r
.x
= window_box_left (s
->w
, s
->area
);
1920 r
.width
= window_box_width (s
->w
, s
->area
);
1921 r
.height
= s
->row
->visible_height
;
1925 if (r
.x
< s
->clip_head
->x
)
1927 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1928 r
.width
-= s
->clip_head
->x
- r
.x
;
1931 r
.x
= s
->clip_head
->x
;
1934 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1936 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1937 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1942 /* If S draws overlapping rows, it's sufficient to use the top and
1943 bottom of the window for clipping because this glyph string
1944 intentionally draws over other lines. */
1945 if (s
->for_overlaps
)
1947 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1948 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1950 /* Alas, the above simple strategy does not work for the
1951 environments with anti-aliased text: if the same text is
1952 drawn onto the same place multiple times, it gets thicker.
1953 If the overlap we are processing is for the erased cursor, we
1954 take the intersection with the rectagle of the cursor. */
1955 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
1957 XRectangle rc
, r_save
= r
;
1959 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
1960 rc
.y
= s
->w
->phys_cursor
.y
;
1961 rc
.width
= s
->w
->phys_cursor_width
;
1962 rc
.height
= s
->w
->phys_cursor_height
;
1964 x_intersect_rectangles (&r_save
, &rc
, &r
);
1969 /* Don't use S->y for clipping because it doesn't take partially
1970 visible lines into account. For example, it can be negative for
1971 partially visible lines at the top of a window. */
1972 if (!s
->row
->full_width_p
1973 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
1974 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1976 r
.y
= max (0, s
->row
->y
);
1979 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
1981 /* If drawing the cursor, don't let glyph draw outside its
1982 advertised boundaries. Cleartype does this under some circumstances. */
1983 if (s
->hl
== DRAW_CURSOR
)
1985 struct glyph
*glyph
= s
->first_glyph
;
1990 r
.width
-= s
->x
- r
.x
;
1993 r
.width
= min (r
.width
, glyph
->pixel_width
);
1995 /* If r.y is below window bottom, ensure that we still see a cursor. */
1996 height
= min (glyph
->ascent
+ glyph
->descent
,
1997 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
1998 max_y
= window_text_bottom_y (s
->w
) - height
;
1999 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
2000 if (s
->ybase
- glyph
->ascent
> max_y
)
2007 /* Don't draw cursor glyph taller than our actual glyph. */
2008 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
2009 if (height
< r
.height
)
2011 max_y
= r
.y
+ r
.height
;
2012 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
2013 r
.height
= min (max_y
- r
.y
, height
);
2020 XRectangle r_save
= r
;
2022 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
2026 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
2027 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
2029 #ifdef CONVERT_FROM_XRECT
2030 CONVERT_FROM_XRECT (r
, *rects
);
2038 /* If we are processing overlapping and allowed to return
2039 multiple clipping rectangles, we exclude the row of the glyph
2040 string from the clipping rectangle. This is to avoid drawing
2041 the same text on the environment with anti-aliasing. */
2042 #ifdef CONVERT_FROM_XRECT
2045 XRectangle
*rs
= rects
;
2047 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2049 if (s
->for_overlaps
& OVERLAPS_PRED
)
2052 if (r
.y
+ r
.height
> row_y
)
2055 rs
[i
].height
= row_y
- r
.y
;
2061 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2064 if (r
.y
< row_y
+ s
->row
->visible_height
)
2066 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2068 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2069 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2078 #ifdef CONVERT_FROM_XRECT
2079 for (i
= 0; i
< n
; i
++)
2080 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2087 Return in *NR the clipping rectangle for glyph string S. */
2090 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
2092 get_glyph_string_clip_rects (s
, nr
, 1);
2097 Return the position and height of the phys cursor in window W.
2098 Set w->phys_cursor_width to width of phys cursor.
2102 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
2103 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
2105 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2106 int x
, y
, wd
, h
, h0
, y0
;
2108 /* Compute the width of the rectangle to draw. If on a stretch
2109 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2110 rectangle as wide as the glyph, but use a canonical character
2112 wd
= glyph
->pixel_width
- 1;
2113 #if defined(HAVE_NTGUI) || defined(HAVE_NS)
2117 x
= w
->phys_cursor
.x
;
2124 if (glyph
->type
== STRETCH_GLYPH
2125 && !x_stretch_cursor_p
)
2126 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2127 w
->phys_cursor_width
= wd
;
2129 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
2131 /* If y is below window bottom, ensure that we still see a cursor. */
2132 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2134 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
2135 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
2137 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2140 h
= max (h
- (y0
- y
) + 1, h0
);
2145 y0
= window_text_bottom_y (w
) - h0
;
2153 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2154 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2159 * Remember which glyph the mouse is over.
2163 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
2167 struct glyph_row
*r
, *gr
, *end_row
;
2168 enum window_part part
;
2169 enum glyph_row_area area
;
2170 int x
, y
, width
, height
;
2172 /* Try to determine frame pixel position and size of the glyph under
2173 frame pixel coordinates X/Y on frame F. */
2175 if (!f
->glyphs_initialized_p
2176 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, &x
, &y
, 0),
2179 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2180 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2184 w
= XWINDOW (window
);
2185 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2186 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2188 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2189 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2191 if (w
->pseudo_window_p
)
2194 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2200 case ON_LEFT_MARGIN
:
2201 area
= LEFT_MARGIN_AREA
;
2204 case ON_RIGHT_MARGIN
:
2205 area
= RIGHT_MARGIN_AREA
;
2208 case ON_HEADER_LINE
:
2210 gr
= (part
== ON_HEADER_LINE
2211 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2212 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2215 goto text_glyph_row_found
;
2222 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2223 if (r
->y
+ r
->height
> y
)
2229 text_glyph_row_found
:
2232 struct glyph
*g
= gr
->glyphs
[area
];
2233 struct glyph
*end
= g
+ gr
->used
[area
];
2235 height
= gr
->height
;
2236 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2237 if (gx
+ g
->pixel_width
> x
)
2242 if (g
->type
== IMAGE_GLYPH
)
2244 /* Don't remember when mouse is over image, as
2245 image may have hot-spots. */
2246 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2249 width
= g
->pixel_width
;
2253 /* Use nominal char spacing at end of line. */
2255 gx
+= (x
/ width
) * width
;
2258 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2259 gx
+= window_box_left_offset (w
, area
);
2263 /* Use nominal line height at end of window. */
2264 gx
= (x
/ width
) * width
;
2266 gy
+= (y
/ height
) * height
;
2270 case ON_LEFT_FRINGE
:
2271 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2272 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2273 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2274 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2277 case ON_RIGHT_FRINGE
:
2278 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2279 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2280 : window_box_right_offset (w
, TEXT_AREA
));
2281 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2285 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2287 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2288 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2289 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2291 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2295 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2296 if (r
->y
+ r
->height
> y
)
2303 height
= gr
->height
;
2306 /* Use nominal line height at end of window. */
2308 gy
+= (y
/ height
) * height
;
2315 /* If there is no glyph under the mouse, then we divide the screen
2316 into a grid of the smallest glyph in the frame, and use that
2319 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2320 round down even for negative values. */
2326 gx
= (gx
/ width
) * width
;
2327 gy
= (gy
/ height
) * height
;
2332 gx
+= WINDOW_LEFT_EDGE_X (w
);
2333 gy
+= WINDOW_TOP_EDGE_Y (w
);
2336 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2338 /* Visible feedback for debugging. */
2341 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2342 f
->output_data
.x
->normal_gc
,
2343 gx
, gy
, width
, height
);
2349 #endif /* HAVE_WINDOW_SYSTEM */
2352 /***********************************************************************
2353 Lisp form evaluation
2354 ***********************************************************************/
2356 /* Error handler for safe_eval and safe_call. */
2359 safe_eval_handler (Lisp_Object arg
)
2361 add_to_log ("Error during redisplay: %s", arg
, Qnil
);
2366 /* Evaluate SEXPR and return the result, or nil if something went
2367 wrong. Prevent redisplay during the evaluation. */
2369 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
2370 Return the result, or nil if something went wrong. Prevent
2371 redisplay during the evaluation. */
2374 safe_call (int nargs
, Lisp_Object
*args
)
2378 if (inhibit_eval_during_redisplay
)
2382 int count
= SPECPDL_INDEX ();
2383 struct gcpro gcpro1
;
2386 gcpro1
.nvars
= nargs
;
2387 specbind (Qinhibit_redisplay
, Qt
);
2388 /* Use Qt to ensure debugger does not run,
2389 so there is no possibility of wanting to redisplay. */
2390 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2393 val
= unbind_to (count
, val
);
2400 /* Call function FN with one argument ARG.
2401 Return the result, or nil if something went wrong. */
2404 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2406 Lisp_Object args
[2];
2409 return safe_call (2, args
);
2412 static Lisp_Object Qeval
;
2415 safe_eval (Lisp_Object sexpr
)
2417 return safe_call1 (Qeval
, sexpr
);
2420 /* Call function FN with one argument ARG.
2421 Return the result, or nil if something went wrong. */
2424 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2426 Lisp_Object args
[3];
2430 return safe_call (3, args
);
2435 /***********************************************************************
2437 ***********************************************************************/
2441 /* Define CHECK_IT to perform sanity checks on iterators.
2442 This is for debugging. It is too slow to do unconditionally. */
2448 if (it
->method
== GET_FROM_STRING
)
2450 xassert (STRINGP (it
->string
));
2451 xassert (IT_STRING_CHARPOS (*it
) >= 0);
2455 xassert (IT_STRING_CHARPOS (*it
) < 0);
2456 if (it
->method
== GET_FROM_BUFFER
)
2458 /* Check that character and byte positions agree. */
2459 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2464 xassert (it
->current
.dpvec_index
>= 0);
2466 xassert (it
->current
.dpvec_index
< 0);
2469 #define CHECK_IT(IT) check_it ((IT))
2473 #define CHECK_IT(IT) (void) 0
2480 /* Check that the window end of window W is what we expect it
2481 to be---the last row in the current matrix displaying text. */
2484 check_window_end (w
)
2487 if (!MINI_WINDOW_P (w
)
2488 && !NILP (w
->window_end_valid
))
2490 struct glyph_row
*row
;
2491 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
2492 XFASTINT (w
->window_end_vpos
)),
2494 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2495 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2499 #define CHECK_WINDOW_END(W) check_window_end ((W))
2501 #else /* not GLYPH_DEBUG */
2503 #define CHECK_WINDOW_END(W) (void) 0
2505 #endif /* not GLYPH_DEBUG */
2509 /***********************************************************************
2510 Iterator initialization
2511 ***********************************************************************/
2513 /* Initialize IT for displaying current_buffer in window W, starting
2514 at character position CHARPOS. CHARPOS < 0 means that no buffer
2515 position is specified which is useful when the iterator is assigned
2516 a position later. BYTEPOS is the byte position corresponding to
2517 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2519 If ROW is not null, calls to produce_glyphs with IT as parameter
2520 will produce glyphs in that row.
2522 BASE_FACE_ID is the id of a base face to use. It must be one of
2523 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2524 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2525 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2527 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2528 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2529 will be initialized to use the corresponding mode line glyph row of
2530 the desired matrix of W. */
2533 init_iterator (struct it
*it
, struct window
*w
,
2534 EMACS_INT charpos
, EMACS_INT bytepos
,
2535 struct glyph_row
*row
, enum face_id base_face_id
)
2537 int highlight_region_p
;
2538 enum face_id remapped_base_face_id
= base_face_id
;
2540 /* Some precondition checks. */
2541 xassert (w
!= NULL
&& it
!= NULL
);
2542 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2545 /* If face attributes have been changed since the last redisplay,
2546 free realized faces now because they depend on face definitions
2547 that might have changed. Don't free faces while there might be
2548 desired matrices pending which reference these faces. */
2549 if (face_change_count
&& !inhibit_free_realized_faces
)
2551 face_change_count
= 0;
2552 free_all_realized_faces (Qnil
);
2555 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2556 if (! NILP (Vface_remapping_alist
))
2557 remapped_base_face_id
= lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2559 /* Use one of the mode line rows of W's desired matrix if
2563 if (base_face_id
== MODE_LINE_FACE_ID
2564 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2565 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2566 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2567 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2571 memset (it
, 0, sizeof *it
);
2572 it
->current
.overlay_string_index
= -1;
2573 it
->current
.dpvec_index
= -1;
2574 it
->base_face_id
= remapped_base_face_id
;
2576 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2578 /* The window in which we iterate over current_buffer: */
2579 XSETWINDOW (it
->window
, w
);
2581 it
->f
= XFRAME (w
->frame
);
2585 /* Extra space between lines (on window systems only). */
2586 if (base_face_id
== DEFAULT_FACE_ID
2587 && FRAME_WINDOW_P (it
->f
))
2589 if (NATNUMP (current_buffer
->extra_line_spacing
))
2590 it
->extra_line_spacing
= XFASTINT (current_buffer
->extra_line_spacing
);
2591 else if (FLOATP (current_buffer
->extra_line_spacing
))
2592 it
->extra_line_spacing
= (XFLOAT_DATA (current_buffer
->extra_line_spacing
)
2593 * FRAME_LINE_HEIGHT (it
->f
));
2594 else if (it
->f
->extra_line_spacing
> 0)
2595 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2596 it
->max_extra_line_spacing
= 0;
2599 /* If realized faces have been removed, e.g. because of face
2600 attribute changes of named faces, recompute them. When running
2601 in batch mode, the face cache of the initial frame is null. If
2602 we happen to get called, make a dummy face cache. */
2603 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2604 init_frame_faces (it
->f
);
2605 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2606 recompute_basic_faces (it
->f
);
2608 /* Current value of the `slice', `space-width', and 'height' properties. */
2609 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2610 it
->space_width
= Qnil
;
2611 it
->font_height
= Qnil
;
2612 it
->override_ascent
= -1;
2614 /* Are control characters displayed as `^C'? */
2615 it
->ctl_arrow_p
= !NILP (current_buffer
->ctl_arrow
);
2617 /* -1 means everything between a CR and the following line end
2618 is invisible. >0 means lines indented more than this value are
2620 it
->selective
= (INTEGERP (current_buffer
->selective_display
)
2621 ? XFASTINT (current_buffer
->selective_display
)
2622 : (!NILP (current_buffer
->selective_display
)
2624 it
->selective_display_ellipsis_p
2625 = !NILP (current_buffer
->selective_display_ellipses
);
2627 /* Display table to use. */
2628 it
->dp
= window_display_table (w
);
2630 /* Are multibyte characters enabled in current_buffer? */
2631 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
2633 /* Do we need to reorder bidirectional text? Not if this is a
2634 unibyte buffer: by definition, none of the single-byte characters
2635 are strong R2L, so no reordering is needed. And bidi.c doesn't
2636 support unibyte buffers anyway. */
2638 = !NILP (current_buffer
->bidi_display_reordering
) && it
->multibyte_p
;
2640 /* Non-zero if we should highlight the region. */
2642 = (!NILP (Vtransient_mark_mode
)
2643 && !NILP (current_buffer
->mark_active
)
2644 && XMARKER (current_buffer
->mark
)->buffer
!= 0);
2646 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2647 start and end of a visible region in window IT->w. Set both to
2648 -1 to indicate no region. */
2649 if (highlight_region_p
2650 /* Maybe highlight only in selected window. */
2651 && (/* Either show region everywhere. */
2652 highlight_nonselected_windows
2653 /* Or show region in the selected window. */
2654 || w
== XWINDOW (selected_window
)
2655 /* Or show the region if we are in the mini-buffer and W is
2656 the window the mini-buffer refers to. */
2657 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2658 && WINDOWP (minibuf_selected_window
)
2659 && w
== XWINDOW (minibuf_selected_window
))))
2661 EMACS_INT charpos
= marker_position (current_buffer
->mark
);
2662 it
->region_beg_charpos
= min (PT
, charpos
);
2663 it
->region_end_charpos
= max (PT
, charpos
);
2666 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2668 /* Get the position at which the redisplay_end_trigger hook should
2669 be run, if it is to be run at all. */
2670 if (MARKERP (w
->redisplay_end_trigger
)
2671 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2672 it
->redisplay_end_trigger_charpos
2673 = marker_position (w
->redisplay_end_trigger
);
2674 else if (INTEGERP (w
->redisplay_end_trigger
))
2675 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
2677 /* Correct bogus values of tab_width. */
2678 it
->tab_width
= XINT (current_buffer
->tab_width
);
2679 if (it
->tab_width
<= 0 || it
->tab_width
> 1000)
2682 /* Are lines in the display truncated? */
2683 if (base_face_id
!= DEFAULT_FACE_ID
2684 || XINT (it
->w
->hscroll
)
2685 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2686 && ((!NILP (Vtruncate_partial_width_windows
)
2687 && !INTEGERP (Vtruncate_partial_width_windows
))
2688 || (INTEGERP (Vtruncate_partial_width_windows
)
2689 && (WINDOW_TOTAL_COLS (it
->w
)
2690 < XINT (Vtruncate_partial_width_windows
))))))
2691 it
->line_wrap
= TRUNCATE
;
2692 else if (NILP (current_buffer
->truncate_lines
))
2693 it
->line_wrap
= NILP (current_buffer
->word_wrap
)
2694 ? WINDOW_WRAP
: WORD_WRAP
;
2696 it
->line_wrap
= TRUNCATE
;
2698 /* Get dimensions of truncation and continuation glyphs. These are
2699 displayed as fringe bitmaps under X, so we don't need them for such
2701 if (!FRAME_WINDOW_P (it
->f
))
2703 if (it
->line_wrap
== TRUNCATE
)
2705 /* We will need the truncation glyph. */
2706 xassert (it
->glyph_row
== NULL
);
2707 produce_special_glyphs (it
, IT_TRUNCATION
);
2708 it
->truncation_pixel_width
= it
->pixel_width
;
2712 /* We will need the continuation glyph. */
2713 xassert (it
->glyph_row
== NULL
);
2714 produce_special_glyphs (it
, IT_CONTINUATION
);
2715 it
->continuation_pixel_width
= it
->pixel_width
;
2718 /* Reset these values to zero because the produce_special_glyphs
2719 above has changed them. */
2720 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2721 it
->phys_ascent
= it
->phys_descent
= 0;
2724 /* Set this after getting the dimensions of truncation and
2725 continuation glyphs, so that we don't produce glyphs when calling
2726 produce_special_glyphs, above. */
2727 it
->glyph_row
= row
;
2728 it
->area
= TEXT_AREA
;
2730 /* Forget any previous info about this row being reversed. */
2732 it
->glyph_row
->reversed_p
= 0;
2734 /* Get the dimensions of the display area. The display area
2735 consists of the visible window area plus a horizontally scrolled
2736 part to the left of the window. All x-values are relative to the
2737 start of this total display area. */
2738 if (base_face_id
!= DEFAULT_FACE_ID
)
2740 /* Mode lines, menu bar in terminal frames. */
2741 it
->first_visible_x
= 0;
2742 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2747 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2748 it
->last_visible_x
= (it
->first_visible_x
2749 + window_box_width (w
, TEXT_AREA
));
2751 /* If we truncate lines, leave room for the truncator glyph(s) at
2752 the right margin. Otherwise, leave room for the continuation
2753 glyph(s). Truncation and continuation glyphs are not inserted
2754 for window-based redisplay. */
2755 if (!FRAME_WINDOW_P (it
->f
))
2757 if (it
->line_wrap
== TRUNCATE
)
2758 it
->last_visible_x
-= it
->truncation_pixel_width
;
2760 it
->last_visible_x
-= it
->continuation_pixel_width
;
2763 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2764 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2767 /* Leave room for a border glyph. */
2768 if (!FRAME_WINDOW_P (it
->f
)
2769 && !WINDOW_RIGHTMOST_P (it
->w
))
2770 it
->last_visible_x
-= 1;
2772 it
->last_visible_y
= window_text_bottom_y (w
);
2774 /* For mode lines and alike, arrange for the first glyph having a
2775 left box line if the face specifies a box. */
2776 if (base_face_id
!= DEFAULT_FACE_ID
)
2780 it
->face_id
= remapped_base_face_id
;
2782 /* If we have a boxed mode line, make the first character appear
2783 with a left box line. */
2784 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2785 if (face
->box
!= FACE_NO_BOX
)
2786 it
->start_of_box_run_p
= 1;
2789 /* If we are to reorder bidirectional text, init the bidi
2793 /* Note the paragraph direction that this buffer wants to
2795 if (EQ (current_buffer
->bidi_paragraph_direction
, Qleft_to_right
))
2796 it
->paragraph_embedding
= L2R
;
2797 else if (EQ (current_buffer
->bidi_paragraph_direction
, Qright_to_left
))
2798 it
->paragraph_embedding
= R2L
;
2800 it
->paragraph_embedding
= NEUTRAL_DIR
;
2801 bidi_init_it (charpos
, bytepos
, &it
->bidi_it
);
2804 /* If a buffer position was specified, set the iterator there,
2805 getting overlays and face properties from that position. */
2806 if (charpos
>= BUF_BEG (current_buffer
))
2808 it
->end_charpos
= ZV
;
2810 IT_CHARPOS (*it
) = charpos
;
2812 /* Compute byte position if not specified. */
2813 if (bytepos
< charpos
)
2814 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2816 IT_BYTEPOS (*it
) = bytepos
;
2818 it
->start
= it
->current
;
2820 /* Compute faces etc. */
2821 reseat (it
, it
->current
.pos
, 1);
2828 /* Initialize IT for the display of window W with window start POS. */
2831 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2833 struct glyph_row
*row
;
2834 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2836 row
= w
->desired_matrix
->rows
+ first_vpos
;
2837 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2838 it
->first_vpos
= first_vpos
;
2840 /* Don't reseat to previous visible line start if current start
2841 position is in a string or image. */
2842 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2844 int start_at_line_beg_p
;
2845 int first_y
= it
->current_y
;
2847 /* If window start is not at a line start, skip forward to POS to
2848 get the correct continuation lines width. */
2849 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2850 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2851 if (!start_at_line_beg_p
)
2855 reseat_at_previous_visible_line_start (it
);
2856 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2858 new_x
= it
->current_x
+ it
->pixel_width
;
2860 /* If lines are continued, this line may end in the middle
2861 of a multi-glyph character (e.g. a control character
2862 displayed as \003, or in the middle of an overlay
2863 string). In this case move_it_to above will not have
2864 taken us to the start of the continuation line but to the
2865 end of the continued line. */
2866 if (it
->current_x
> 0
2867 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2868 && (/* And glyph doesn't fit on the line. */
2869 new_x
> it
->last_visible_x
2870 /* Or it fits exactly and we're on a window
2872 || (new_x
== it
->last_visible_x
2873 && FRAME_WINDOW_P (it
->f
))))
2875 if (it
->current
.dpvec_index
>= 0
2876 || it
->current
.overlay_string_index
>= 0)
2878 set_iterator_to_next (it
, 1);
2879 move_it_in_display_line_to (it
, -1, -1, 0);
2882 it
->continuation_lines_width
+= it
->current_x
;
2885 /* We're starting a new display line, not affected by the
2886 height of the continued line, so clear the appropriate
2887 fields in the iterator structure. */
2888 it
->max_ascent
= it
->max_descent
= 0;
2889 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2891 it
->current_y
= first_y
;
2893 it
->current_x
= it
->hpos
= 0;
2899 /* Return 1 if POS is a position in ellipses displayed for invisible
2900 text. W is the window we display, for text property lookup. */
2903 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
2905 Lisp_Object prop
, window
;
2907 EMACS_INT charpos
= CHARPOS (pos
->pos
);
2909 /* If POS specifies a position in a display vector, this might
2910 be for an ellipsis displayed for invisible text. We won't
2911 get the iterator set up for delivering that ellipsis unless
2912 we make sure that it gets aware of the invisible text. */
2913 if (pos
->dpvec_index
>= 0
2914 && pos
->overlay_string_index
< 0
2915 && CHARPOS (pos
->string_pos
) < 0
2917 && (XSETWINDOW (window
, w
),
2918 prop
= Fget_char_property (make_number (charpos
),
2919 Qinvisible
, window
),
2920 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2922 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2924 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2931 /* Initialize IT for stepping through current_buffer in window W,
2932 starting at position POS that includes overlay string and display
2933 vector/ control character translation position information. Value
2934 is zero if there are overlay strings with newlines at POS. */
2937 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
2939 EMACS_INT charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
2940 int i
, overlay_strings_with_newlines
= 0;
2942 /* If POS specifies a position in a display vector, this might
2943 be for an ellipsis displayed for invisible text. We won't
2944 get the iterator set up for delivering that ellipsis unless
2945 we make sure that it gets aware of the invisible text. */
2946 if (in_ellipses_for_invisible_text_p (pos
, w
))
2952 /* Keep in mind: the call to reseat in init_iterator skips invisible
2953 text, so we might end up at a position different from POS. This
2954 is only a problem when POS is a row start after a newline and an
2955 overlay starts there with an after-string, and the overlay has an
2956 invisible property. Since we don't skip invisible text in
2957 display_line and elsewhere immediately after consuming the
2958 newline before the row start, such a POS will not be in a string,
2959 but the call to init_iterator below will move us to the
2961 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
2963 /* This only scans the current chunk -- it should scan all chunks.
2964 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
2965 to 16 in 22.1 to make this a lesser problem. */
2966 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
2968 const char *s
= SDATA (it
->overlay_strings
[i
]);
2969 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
2971 while (s
< e
&& *s
!= '\n')
2976 overlay_strings_with_newlines
= 1;
2981 /* If position is within an overlay string, set up IT to the right
2983 if (pos
->overlay_string_index
>= 0)
2987 /* If the first overlay string happens to have a `display'
2988 property for an image, the iterator will be set up for that
2989 image, and we have to undo that setup first before we can
2990 correct the overlay string index. */
2991 if (it
->method
== GET_FROM_IMAGE
)
2994 /* We already have the first chunk of overlay strings in
2995 IT->overlay_strings. Load more until the one for
2996 pos->overlay_string_index is in IT->overlay_strings. */
2997 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
2999 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
3000 it
->current
.overlay_string_index
= 0;
3003 load_overlay_strings (it
, 0);
3004 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
3008 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
3009 relative_index
= (it
->current
.overlay_string_index
3010 % OVERLAY_STRING_CHUNK_SIZE
);
3011 it
->string
= it
->overlay_strings
[relative_index
];
3012 xassert (STRINGP (it
->string
));
3013 it
->current
.string_pos
= pos
->string_pos
;
3014 it
->method
= GET_FROM_STRING
;
3017 if (CHARPOS (pos
->string_pos
) >= 0)
3019 /* Recorded position is not in an overlay string, but in another
3020 string. This can only be a string from a `display' property.
3021 IT should already be filled with that string. */
3022 it
->current
.string_pos
= pos
->string_pos
;
3023 xassert (STRINGP (it
->string
));
3026 /* Restore position in display vector translations, control
3027 character translations or ellipses. */
3028 if (pos
->dpvec_index
>= 0)
3030 if (it
->dpvec
== NULL
)
3031 get_next_display_element (it
);
3032 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3033 it
->current
.dpvec_index
= pos
->dpvec_index
;
3037 return !overlay_strings_with_newlines
;
3041 /* Initialize IT for stepping through current_buffer in window W
3042 starting at ROW->start. */
3045 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3047 init_from_display_pos (it
, w
, &row
->start
);
3048 it
->start
= row
->start
;
3049 it
->continuation_lines_width
= row
->continuation_lines_width
;
3054 /* Initialize IT for stepping through current_buffer in window W
3055 starting in the line following ROW, i.e. starting at ROW->end.
3056 Value is zero if there are overlay strings with newlines at ROW's
3060 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3064 if (init_from_display_pos (it
, w
, &row
->end
))
3066 if (row
->continued_p
)
3067 it
->continuation_lines_width
3068 = row
->continuation_lines_width
+ row
->pixel_width
;
3079 /***********************************************************************
3081 ***********************************************************************/
3083 /* Called when IT reaches IT->stop_charpos. Handle text property and
3084 overlay changes. Set IT->stop_charpos to the next position where
3088 handle_stop (struct it
*it
)
3090 enum prop_handled handled
;
3091 int handle_overlay_change_p
;
3095 it
->current
.dpvec_index
= -1;
3096 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3097 it
->ignore_overlay_strings_at_pos_p
= 0;
3100 /* Use face of preceding text for ellipsis (if invisible) */
3101 if (it
->selective_display_ellipsis_p
)
3102 it
->saved_face_id
= it
->face_id
;
3106 handled
= HANDLED_NORMALLY
;
3108 /* Call text property handlers. */
3109 for (p
= it_props
; p
->handler
; ++p
)
3111 handled
= p
->handler (it
);
3113 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3115 else if (handled
== HANDLED_RETURN
)
3117 /* We still want to show before and after strings from
3118 overlays even if the actual buffer text is replaced. */
3119 if (!handle_overlay_change_p
3121 || !get_overlay_strings_1 (it
, 0, 0))
3124 setup_for_ellipsis (it
, 0);
3125 /* When handling a display spec, we might load an
3126 empty string. In that case, discard it here. We
3127 used to discard it in handle_single_display_spec,
3128 but that causes get_overlay_strings_1, above, to
3129 ignore overlay strings that we must check. */
3130 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3134 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3138 it
->ignore_overlay_strings_at_pos_p
= 1;
3139 it
->string_from_display_prop_p
= 0;
3140 handle_overlay_change_p
= 0;
3142 handled
= HANDLED_RECOMPUTE_PROPS
;
3145 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3146 handle_overlay_change_p
= 0;
3149 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3151 /* Don't check for overlay strings below when set to deliver
3152 characters from a display vector. */
3153 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3154 handle_overlay_change_p
= 0;
3156 /* Handle overlay changes.
3157 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3158 if it finds overlays. */
3159 if (handle_overlay_change_p
)
3160 handled
= handle_overlay_change (it
);
3165 setup_for_ellipsis (it
, 0);
3169 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3171 /* Determine where to stop next. */
3172 if (handled
== HANDLED_NORMALLY
)
3173 compute_stop_pos (it
);
3177 /* Compute IT->stop_charpos from text property and overlay change
3178 information for IT's current position. */
3181 compute_stop_pos (struct it
*it
)
3183 register INTERVAL iv
, next_iv
;
3184 Lisp_Object object
, limit
, position
;
3185 EMACS_INT charpos
, bytepos
;
3187 /* If nowhere else, stop at the end. */
3188 it
->stop_charpos
= it
->end_charpos
;
3190 if (STRINGP (it
->string
))
3192 /* Strings are usually short, so don't limit the search for
3194 object
= it
->string
;
3196 charpos
= IT_STRING_CHARPOS (*it
);
3197 bytepos
= IT_STRING_BYTEPOS (*it
);
3203 /* If next overlay change is in front of the current stop pos
3204 (which is IT->end_charpos), stop there. Note: value of
3205 next_overlay_change is point-max if no overlay change
3207 charpos
= IT_CHARPOS (*it
);
3208 bytepos
= IT_BYTEPOS (*it
);
3209 pos
= next_overlay_change (charpos
);
3210 if (pos
< it
->stop_charpos
)
3211 it
->stop_charpos
= pos
;
3213 /* If showing the region, we have to stop at the region
3214 start or end because the face might change there. */
3215 if (it
->region_beg_charpos
> 0)
3217 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3218 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3219 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3220 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3223 /* Set up variables for computing the stop position from text
3224 property changes. */
3225 XSETBUFFER (object
, current_buffer
);
3226 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3229 /* Get the interval containing IT's position. Value is a null
3230 interval if there isn't such an interval. */
3231 position
= make_number (charpos
);
3232 iv
= validate_interval_range (object
, &position
, &position
, 0);
3233 if (!NULL_INTERVAL_P (iv
))
3235 Lisp_Object values_here
[LAST_PROP_IDX
];
3238 /* Get properties here. */
3239 for (p
= it_props
; p
->handler
; ++p
)
3240 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3242 /* Look for an interval following iv that has different
3244 for (next_iv
= next_interval (iv
);
3245 (!NULL_INTERVAL_P (next_iv
)
3247 || XFASTINT (limit
) > next_iv
->position
));
3248 next_iv
= next_interval (next_iv
))
3250 for (p
= it_props
; p
->handler
; ++p
)
3252 Lisp_Object new_value
;
3254 new_value
= textget (next_iv
->plist
, *p
->name
);
3255 if (!EQ (values_here
[p
->idx
], new_value
))
3263 if (!NULL_INTERVAL_P (next_iv
))
3265 if (INTEGERP (limit
)
3266 && next_iv
->position
>= XFASTINT (limit
))
3267 /* No text property change up to limit. */
3268 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3270 /* Text properties change in next_iv. */
3271 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3275 if (it
->cmp_it
.id
< 0)
3277 EMACS_INT stoppos
= it
->end_charpos
;
3279 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3281 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3282 stoppos
, it
->string
);
3285 xassert (STRINGP (it
->string
)
3286 || (it
->stop_charpos
>= BEGV
3287 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3291 /* Return the position of the next overlay change after POS in
3292 current_buffer. Value is point-max if no overlay change
3293 follows. This is like `next-overlay-change' but doesn't use
3297 next_overlay_change (EMACS_INT pos
)
3301 Lisp_Object
*overlays
;
3304 /* Get all overlays at the given position. */
3305 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3307 /* If any of these overlays ends before endpos,
3308 use its ending point instead. */
3309 for (i
= 0; i
< noverlays
; ++i
)
3314 oend
= OVERLAY_END (overlays
[i
]);
3315 oendpos
= OVERLAY_POSITION (oend
);
3316 endpos
= min (endpos
, oendpos
);
3324 /***********************************************************************
3326 ***********************************************************************/
3328 /* Handle changes in the `fontified' property of the current buffer by
3329 calling hook functions from Qfontification_functions to fontify
3332 static enum prop_handled
3333 handle_fontified_prop (struct it
*it
)
3335 Lisp_Object prop
, pos
;
3336 enum prop_handled handled
= HANDLED_NORMALLY
;
3338 if (!NILP (Vmemory_full
))
3341 /* Get the value of the `fontified' property at IT's current buffer
3342 position. (The `fontified' property doesn't have a special
3343 meaning in strings.) If the value is nil, call functions from
3344 Qfontification_functions. */
3345 if (!STRINGP (it
->string
)
3347 && !NILP (Vfontification_functions
)
3348 && !NILP (Vrun_hooks
)
3349 && (pos
= make_number (IT_CHARPOS (*it
)),
3350 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3351 /* Ignore the special cased nil value always present at EOB since
3352 no amount of fontifying will be able to change it. */
3353 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3355 int count
= SPECPDL_INDEX ();
3358 val
= Vfontification_functions
;
3359 specbind (Qfontification_functions
, Qnil
);
3361 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3362 safe_call1 (val
, pos
);
3365 Lisp_Object globals
, fn
;
3366 struct gcpro gcpro1
, gcpro2
;
3369 GCPRO2 (val
, globals
);
3371 for (; CONSP (val
); val
= XCDR (val
))
3377 /* A value of t indicates this hook has a local
3378 binding; it means to run the global binding too.
3379 In a global value, t should not occur. If it
3380 does, we must ignore it to avoid an endless
3382 for (globals
= Fdefault_value (Qfontification_functions
);
3384 globals
= XCDR (globals
))
3386 fn
= XCAR (globals
);
3388 safe_call1 (fn
, pos
);
3392 safe_call1 (fn
, pos
);
3398 unbind_to (count
, Qnil
);
3400 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3401 something. This avoids an endless loop if they failed to
3402 fontify the text for which reason ever. */
3403 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3404 handled
= HANDLED_RECOMPUTE_PROPS
;
3412 /***********************************************************************
3414 ***********************************************************************/
3416 /* Set up iterator IT from face properties at its current position.
3417 Called from handle_stop. */
3419 static enum prop_handled
3420 handle_face_prop (struct it
*it
)
3423 EMACS_INT next_stop
;
3425 if (!STRINGP (it
->string
))
3428 = face_at_buffer_position (it
->w
,
3430 it
->region_beg_charpos
,
3431 it
->region_end_charpos
,
3434 + TEXT_PROP_DISTANCE_LIMIT
),
3435 0, it
->base_face_id
);
3437 /* Is this a start of a run of characters with box face?
3438 Caveat: this can be called for a freshly initialized
3439 iterator; face_id is -1 in this case. We know that the new
3440 face will not change until limit, i.e. if the new face has a
3441 box, all characters up to limit will have one. But, as
3442 usual, we don't know whether limit is really the end. */
3443 if (new_face_id
!= it
->face_id
)
3445 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3447 /* If new face has a box but old face has not, this is
3448 the start of a run of characters with box, i.e. it has
3449 a shadow on the left side. The value of face_id of the
3450 iterator will be -1 if this is the initial call that gets
3451 the face. In this case, we have to look in front of IT's
3452 position and see whether there is a face != new_face_id. */
3453 it
->start_of_box_run_p
3454 = (new_face
->box
!= FACE_NO_BOX
3455 && (it
->face_id
>= 0
3456 || IT_CHARPOS (*it
) == BEG
3457 || new_face_id
!= face_before_it_pos (it
)));
3458 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3466 Lisp_Object from_overlay
3467 = (it
->current
.overlay_string_index
>= 0
3468 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3471 /* See if we got to this string directly or indirectly from
3472 an overlay property. That includes the before-string or
3473 after-string of an overlay, strings in display properties
3474 provided by an overlay, their text properties, etc.
3476 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3477 if (! NILP (from_overlay
))
3478 for (i
= it
->sp
- 1; i
>= 0; i
--)
3480 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3482 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3483 else if (! NILP (it
->stack
[i
].from_overlay
))
3484 from_overlay
= it
->stack
[i
].from_overlay
;
3486 if (!NILP (from_overlay
))
3490 if (! NILP (from_overlay
))
3492 bufpos
= IT_CHARPOS (*it
);
3493 /* For a string from an overlay, the base face depends
3494 only on text properties and ignores overlays. */
3496 = face_for_overlay_string (it
->w
,
3498 it
->region_beg_charpos
,
3499 it
->region_end_charpos
,
3502 + TEXT_PROP_DISTANCE_LIMIT
),
3510 /* For strings from a `display' property, use the face at
3511 IT's current buffer position as the base face to merge
3512 with, so that overlay strings appear in the same face as
3513 surrounding text, unless they specify their own
3515 base_face_id
= underlying_face_id (it
);
3518 new_face_id
= face_at_string_position (it
->w
,
3520 IT_STRING_CHARPOS (*it
),
3522 it
->region_beg_charpos
,
3523 it
->region_end_charpos
,
3527 /* Is this a start of a run of characters with box? Caveat:
3528 this can be called for a freshly allocated iterator; face_id
3529 is -1 is this case. We know that the new face will not
3530 change until the next check pos, i.e. if the new face has a
3531 box, all characters up to that position will have a
3532 box. But, as usual, we don't know whether that position
3533 is really the end. */
3534 if (new_face_id
!= it
->face_id
)
3536 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3537 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3539 /* If new face has a box but old face hasn't, this is the
3540 start of a run of characters with box, i.e. it has a
3541 shadow on the left side. */
3542 it
->start_of_box_run_p
3543 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3544 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3548 it
->face_id
= new_face_id
;
3549 return HANDLED_NORMALLY
;
3553 /* Return the ID of the face ``underlying'' IT's current position,
3554 which is in a string. If the iterator is associated with a
3555 buffer, return the face at IT's current buffer position.
3556 Otherwise, use the iterator's base_face_id. */
3559 underlying_face_id (struct it
*it
)
3561 int face_id
= it
->base_face_id
, i
;
3563 xassert (STRINGP (it
->string
));
3565 for (i
= it
->sp
- 1; i
>= 0; --i
)
3566 if (NILP (it
->stack
[i
].string
))
3567 face_id
= it
->stack
[i
].face_id
;
3573 /* Compute the face one character before or after the current position
3574 of IT. BEFORE_P non-zero means get the face in front of IT's
3575 position. Value is the id of the face. */
3578 face_before_or_after_it_pos (struct it
*it
, int before_p
)
3581 EMACS_INT next_check_charpos
;
3582 struct text_pos pos
;
3584 xassert (it
->s
== NULL
);
3586 if (STRINGP (it
->string
))
3591 /* No face change past the end of the string (for the case
3592 we are padding with spaces). No face change before the
3594 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3595 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3598 /* Set pos to the position before or after IT's current position. */
3600 pos
= string_pos (IT_STRING_CHARPOS (*it
) - 1, it
->string
);
3602 /* For composition, we must check the character after the
3604 pos
= (it
->what
== IT_COMPOSITION
3605 ? string_pos (IT_STRING_CHARPOS (*it
)
3606 + it
->cmp_it
.nchars
, it
->string
)
3607 : string_pos (IT_STRING_CHARPOS (*it
) + 1, it
->string
));
3609 if (it
->current
.overlay_string_index
>= 0)
3610 bufpos
= IT_CHARPOS (*it
);
3614 base_face_id
= underlying_face_id (it
);
3616 /* Get the face for ASCII, or unibyte. */
3617 face_id
= face_at_string_position (it
->w
,
3621 it
->region_beg_charpos
,
3622 it
->region_end_charpos
,
3623 &next_check_charpos
,
3626 /* Correct the face for charsets different from ASCII. Do it
3627 for the multibyte case only. The face returned above is
3628 suitable for unibyte text if IT->string is unibyte. */
3629 if (STRING_MULTIBYTE (it
->string
))
3631 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos
);
3633 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3635 c
= string_char_and_length (p
, &len
);
3636 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), it
->string
);
3641 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3642 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3645 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3646 pos
= it
->current
.pos
;
3649 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3652 if (it
->what
== IT_COMPOSITION
)
3653 /* For composition, we must check the position after the
3655 pos
.charpos
+= it
->cmp_it
.nchars
, pos
.bytepos
+= it
->len
;
3657 INC_TEXT_POS (pos
, it
->multibyte_p
);
3660 /* Determine face for CHARSET_ASCII, or unibyte. */
3661 face_id
= face_at_buffer_position (it
->w
,
3663 it
->region_beg_charpos
,
3664 it
->region_end_charpos
,
3665 &next_check_charpos
,
3668 /* Correct the face for charsets different from ASCII. Do it
3669 for the multibyte case only. The face returned above is
3670 suitable for unibyte text if current_buffer is unibyte. */
3671 if (it
->multibyte_p
)
3673 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3674 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3675 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3684 /***********************************************************************
3686 ***********************************************************************/
3688 /* Set up iterator IT from invisible properties at its current
3689 position. Called from handle_stop. */
3691 static enum prop_handled
3692 handle_invisible_prop (struct it
*it
)
3694 enum prop_handled handled
= HANDLED_NORMALLY
;
3696 if (STRINGP (it
->string
))
3698 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3700 /* Get the value of the invisible text property at the
3701 current position. Value will be nil if there is no such
3703 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3704 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3707 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3709 handled
= HANDLED_RECOMPUTE_PROPS
;
3711 /* Get the position at which the next change of the
3712 invisible text property can be found in IT->string.
3713 Value will be nil if the property value is the same for
3714 all the rest of IT->string. */
3715 XSETINT (limit
, SCHARS (it
->string
));
3716 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3719 /* Text at current position is invisible. The next
3720 change in the property is at position end_charpos.
3721 Move IT's current position to that position. */
3722 if (INTEGERP (end_charpos
)
3723 && XFASTINT (end_charpos
) < XFASTINT (limit
))
3725 struct text_pos old
;
3726 old
= it
->current
.string_pos
;
3727 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3728 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
3732 /* The rest of the string is invisible. If this is an
3733 overlay string, proceed with the next overlay string
3734 or whatever comes and return a character from there. */
3735 if (it
->current
.overlay_string_index
>= 0)
3737 next_overlay_string (it
);
3738 /* Don't check for overlay strings when we just
3739 finished processing them. */
3740 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
3744 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
3745 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
3753 EMACS_INT newpos
, next_stop
, start_charpos
, tem
;
3754 Lisp_Object pos
, prop
, overlay
;
3756 /* First of all, is there invisible text at this position? */
3757 tem
= start_charpos
= IT_CHARPOS (*it
);
3758 pos
= make_number (tem
);
3759 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
3761 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3763 /* If we are on invisible text, skip over it. */
3764 if (invis_p
&& start_charpos
< it
->end_charpos
)
3766 /* Record whether we have to display an ellipsis for the
3768 int display_ellipsis_p
= invis_p
== 2;
3770 handled
= HANDLED_RECOMPUTE_PROPS
;
3772 /* Loop skipping over invisible text. The loop is left at
3773 ZV or with IT on the first char being visible again. */
3776 /* Try to skip some invisible text. Return value is the
3777 position reached which can be equal to where we start
3778 if there is nothing invisible there. This skips both
3779 over invisible text properties and overlays with
3780 invisible property. */
3781 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
3783 /* If we skipped nothing at all we weren't at invisible
3784 text in the first place. If everything to the end of
3785 the buffer was skipped, end the loop. */
3786 if (newpos
== tem
|| newpos
>= ZV
)
3790 /* We skipped some characters but not necessarily
3791 all there are. Check if we ended up on visible
3792 text. Fget_char_property returns the property of
3793 the char before the given position, i.e. if we
3794 get invis_p = 0, this means that the char at
3795 newpos is visible. */
3796 pos
= make_number (newpos
);
3797 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
3798 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3801 /* If we ended up on invisible text, proceed to
3802 skip starting with next_stop. */
3806 /* If there are adjacent invisible texts, don't lose the
3807 second one's ellipsis. */
3809 display_ellipsis_p
= 1;
3813 /* The position newpos is now either ZV or on visible text. */
3814 if (it
->bidi_p
&& newpos
< ZV
)
3816 /* With bidi iteration, the region of invisible text
3817 could start and/or end in the middle of a non-base
3818 embedding level. Therefore, we need to skip
3819 invisible text using the bidi iterator, starting at
3820 IT's current position, until we find ourselves
3821 outside the invisible text. Skipping invisible text
3822 _after_ bidi iteration avoids affecting the visual
3823 order of the displayed text when invisible properties
3824 are added or removed. */
3825 if (it
->bidi_it
.first_elt
)
3827 /* If we were `reseat'ed to a new paragraph,
3828 determine the paragraph base direction. We need
3829 to do it now because next_element_from_buffer may
3830 not have a chance to do it, if we are going to
3831 skip any text at the beginning, which resets the
3833 bidi_paragraph_init (it
->paragraph_embedding
,
3838 bidi_move_to_visually_next (&it
->bidi_it
);
3840 while (it
->stop_charpos
<= it
->bidi_it
.charpos
3841 && it
->bidi_it
.charpos
< newpos
);
3842 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3843 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
3844 /* If we overstepped NEWPOS, record its position in the
3845 iterator, so that we skip invisible text if later the
3846 bidi iteration lands us in the invisible region
3848 if (IT_CHARPOS (*it
) >= newpos
)
3849 it
->prev_stop
= newpos
;
3853 IT_CHARPOS (*it
) = newpos
;
3854 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
3857 /* If there are before-strings at the start of invisible
3858 text, and the text is invisible because of a text
3859 property, arrange to show before-strings because 20.x did
3860 it that way. (If the text is invisible because of an
3861 overlay property instead of a text property, this is
3862 already handled in the overlay code.) */
3864 && get_overlay_strings (it
, it
->stop_charpos
))
3866 handled
= HANDLED_RECOMPUTE_PROPS
;
3867 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
3869 else if (display_ellipsis_p
)
3871 /* Make sure that the glyphs of the ellipsis will get
3872 correct `charpos' values. If we would not update
3873 it->position here, the glyphs would belong to the
3874 last visible character _before_ the invisible
3875 text, which confuses `set_cursor_from_row'.
3877 We use the last invisible position instead of the
3878 first because this way the cursor is always drawn on
3879 the first "." of the ellipsis, whenever PT is inside
3880 the invisible text. Otherwise the cursor would be
3881 placed _after_ the ellipsis when the point is after the
3882 first invisible character. */
3883 if (!STRINGP (it
->object
))
3885 it
->position
.charpos
= newpos
- 1;
3886 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
3889 /* Let the ellipsis display before
3890 considering any properties of the following char.
3891 Fixes jasonr@gnu.org 01 Oct 07 bug. */
3892 handled
= HANDLED_RETURN
;
3901 /* Make iterator IT return `...' next.
3902 Replaces LEN characters from buffer. */
3905 setup_for_ellipsis (struct it
*it
, int len
)
3907 /* Use the display table definition for `...'. Invalid glyphs
3908 will be handled by the method returning elements from dpvec. */
3909 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
3911 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
3912 it
->dpvec
= v
->contents
;
3913 it
->dpend
= v
->contents
+ v
->size
;
3917 /* Default `...'. */
3918 it
->dpvec
= default_invis_vector
;
3919 it
->dpend
= default_invis_vector
+ 3;
3922 it
->dpvec_char_len
= len
;
3923 it
->current
.dpvec_index
= 0;
3924 it
->dpvec_face_id
= -1;
3926 /* Remember the current face id in case glyphs specify faces.
3927 IT's face is restored in set_iterator_to_next.
3928 saved_face_id was set to preceding char's face in handle_stop. */
3929 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
3930 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
3932 it
->method
= GET_FROM_DISPLAY_VECTOR
;
3938 /***********************************************************************
3940 ***********************************************************************/
3942 /* Set up iterator IT from `display' property at its current position.
3943 Called from handle_stop.
3944 We return HANDLED_RETURN if some part of the display property
3945 overrides the display of the buffer text itself.
3946 Otherwise we return HANDLED_NORMALLY. */
3948 static enum prop_handled
3949 handle_display_prop (struct it
*it
)
3951 Lisp_Object prop
, object
, overlay
;
3952 struct text_pos
*position
;
3953 /* Nonzero if some property replaces the display of the text itself. */
3954 int display_replaced_p
= 0;
3956 if (STRINGP (it
->string
))
3958 object
= it
->string
;
3959 position
= &it
->current
.string_pos
;
3963 XSETWINDOW (object
, it
->w
);
3964 position
= &it
->current
.pos
;
3967 /* Reset those iterator values set from display property values. */
3968 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
3969 it
->space_width
= Qnil
;
3970 it
->font_height
= Qnil
;
3973 /* We don't support recursive `display' properties, i.e. string
3974 values that have a string `display' property, that have a string
3975 `display' property etc. */
3976 if (!it
->string_from_display_prop_p
)
3977 it
->area
= TEXT_AREA
;
3979 prop
= get_char_property_and_overlay (make_number (position
->charpos
),
3980 Qdisplay
, object
, &overlay
);
3982 return HANDLED_NORMALLY
;
3983 /* Now OVERLAY is the overlay that gave us this property, or nil
3984 if it was a text property. */
3986 if (!STRINGP (it
->string
))
3987 object
= it
->w
->buffer
;
3990 /* Simple properties. */
3991 && !EQ (XCAR (prop
), Qimage
)
3992 && !EQ (XCAR (prop
), Qspace
)
3993 && !EQ (XCAR (prop
), Qwhen
)
3994 && !EQ (XCAR (prop
), Qslice
)
3995 && !EQ (XCAR (prop
), Qspace_width
)
3996 && !EQ (XCAR (prop
), Qheight
)
3997 && !EQ (XCAR (prop
), Qraise
)
3998 /* Marginal area specifications. */
3999 && !(CONSP (XCAR (prop
)) && EQ (XCAR (XCAR (prop
)), Qmargin
))
4000 && !EQ (XCAR (prop
), Qleft_fringe
)
4001 && !EQ (XCAR (prop
), Qright_fringe
)
4002 && !NILP (XCAR (prop
)))
4004 for (; CONSP (prop
); prop
= XCDR (prop
))
4006 if (handle_single_display_spec (it
, XCAR (prop
), object
, overlay
,
4007 position
, display_replaced_p
))
4009 display_replaced_p
= 1;
4010 /* If some text in a string is replaced, `position' no
4011 longer points to the position of `object'. */
4012 if (STRINGP (object
))
4017 else if (VECTORP (prop
))
4020 for (i
= 0; i
< ASIZE (prop
); ++i
)
4021 if (handle_single_display_spec (it
, AREF (prop
, i
), object
, overlay
,
4022 position
, display_replaced_p
))
4024 display_replaced_p
= 1;
4025 /* If some text in a string is replaced, `position' no
4026 longer points to the position of `object'. */
4027 if (STRINGP (object
))
4033 if (handle_single_display_spec (it
, prop
, object
, overlay
,
4035 display_replaced_p
= 1;
4038 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4042 /* Value is the position of the end of the `display' property starting
4043 at START_POS in OBJECT. */
4045 static struct text_pos
4046 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4049 struct text_pos end_pos
;
4051 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4052 Qdisplay
, object
, Qnil
);
4053 CHARPOS (end_pos
) = XFASTINT (end
);
4054 if (STRINGP (object
))
4055 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4057 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4063 /* Set up IT from a single `display' specification PROP. OBJECT
4064 is the object in which the `display' property was found. *POSITION
4065 is the position at which it was found. DISPLAY_REPLACED_P non-zero
4066 means that we previously saw a display specification which already
4067 replaced text display with something else, for example an image;
4068 we ignore such properties after the first one has been processed.
4070 OVERLAY is the overlay this `display' property came from,
4071 or nil if it was a text property.
4073 If PROP is a `space' or `image' specification, and in some other
4074 cases too, set *POSITION to the position where the `display'
4077 Value is non-zero if something was found which replaces the display
4078 of buffer or string text. */
4081 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4082 Lisp_Object overlay
, struct text_pos
*position
,
4083 int display_replaced_before_p
)
4086 Lisp_Object location
, value
;
4087 struct text_pos start_pos
, save_pos
;
4090 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4091 If the result is non-nil, use VALUE instead of SPEC. */
4093 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4102 if (!NILP (form
) && !EQ (form
, Qt
))
4104 int count
= SPECPDL_INDEX ();
4105 struct gcpro gcpro1
;
4107 /* Bind `object' to the object having the `display' property, a
4108 buffer or string. Bind `position' to the position in the
4109 object where the property was found, and `buffer-position'
4110 to the current position in the buffer. */
4111 specbind (Qobject
, object
);
4112 specbind (Qposition
, make_number (CHARPOS (*position
)));
4113 specbind (Qbuffer_position
,
4114 make_number (STRINGP (object
)
4115 ? IT_CHARPOS (*it
) : CHARPOS (*position
)));
4117 form
= safe_eval (form
);
4119 unbind_to (count
, Qnil
);
4125 /* Handle `(height HEIGHT)' specifications. */
4127 && EQ (XCAR (spec
), Qheight
)
4128 && CONSP (XCDR (spec
)))
4130 if (!FRAME_WINDOW_P (it
->f
))
4133 it
->font_height
= XCAR (XCDR (spec
));
4134 if (!NILP (it
->font_height
))
4136 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4137 int new_height
= -1;
4139 if (CONSP (it
->font_height
)
4140 && (EQ (XCAR (it
->font_height
), Qplus
)
4141 || EQ (XCAR (it
->font_height
), Qminus
))
4142 && CONSP (XCDR (it
->font_height
))
4143 && INTEGERP (XCAR (XCDR (it
->font_height
))))
4145 /* `(+ N)' or `(- N)' where N is an integer. */
4146 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4147 if (EQ (XCAR (it
->font_height
), Qplus
))
4149 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4151 else if (FUNCTIONP (it
->font_height
))
4153 /* Call function with current height as argument.
4154 Value is the new height. */
4156 height
= safe_call1 (it
->font_height
,
4157 face
->lface
[LFACE_HEIGHT_INDEX
]);
4158 if (NUMBERP (height
))
4159 new_height
= XFLOATINT (height
);
4161 else if (NUMBERP (it
->font_height
))
4163 /* Value is a multiple of the canonical char height. */
4166 face
= FACE_FROM_ID (it
->f
,
4167 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4168 new_height
= (XFLOATINT (it
->font_height
)
4169 * XINT (face
->lface
[LFACE_HEIGHT_INDEX
]));
4173 /* Evaluate IT->font_height with `height' bound to the
4174 current specified height to get the new height. */
4175 int count
= SPECPDL_INDEX ();
4177 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4178 value
= safe_eval (it
->font_height
);
4179 unbind_to (count
, Qnil
);
4181 if (NUMBERP (value
))
4182 new_height
= XFLOATINT (value
);
4186 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4192 /* Handle `(space-width WIDTH)'. */
4194 && EQ (XCAR (spec
), Qspace_width
)
4195 && CONSP (XCDR (spec
)))
4197 if (!FRAME_WINDOW_P (it
->f
))
4200 value
= XCAR (XCDR (spec
));
4201 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4202 it
->space_width
= value
;
4207 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4209 && EQ (XCAR (spec
), Qslice
))
4213 if (!FRAME_WINDOW_P (it
->f
))
4216 if (tem
= XCDR (spec
), CONSP (tem
))
4218 it
->slice
.x
= XCAR (tem
);
4219 if (tem
= XCDR (tem
), CONSP (tem
))
4221 it
->slice
.y
= XCAR (tem
);
4222 if (tem
= XCDR (tem
), CONSP (tem
))
4224 it
->slice
.width
= XCAR (tem
);
4225 if (tem
= XCDR (tem
), CONSP (tem
))
4226 it
->slice
.height
= XCAR (tem
);
4234 /* Handle `(raise FACTOR)'. */
4236 && EQ (XCAR (spec
), Qraise
)
4237 && CONSP (XCDR (spec
)))
4239 if (!FRAME_WINDOW_P (it
->f
))
4242 #ifdef HAVE_WINDOW_SYSTEM
4243 value
= XCAR (XCDR (spec
));
4244 if (NUMBERP (value
))
4246 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4247 it
->voffset
= - (XFLOATINT (value
)
4248 * (FONT_HEIGHT (face
->font
)));
4250 #endif /* HAVE_WINDOW_SYSTEM */
4255 /* Don't handle the other kinds of display specifications
4256 inside a string that we got from a `display' property. */
4257 if (it
->string_from_display_prop_p
)
4260 /* Characters having this form of property are not displayed, so
4261 we have to find the end of the property. */
4262 start_pos
= *position
;
4263 *position
= display_prop_end (it
, object
, start_pos
);
4266 /* Stop the scan at that end position--we assume that all
4267 text properties change there. */
4268 it
->stop_charpos
= position
->charpos
;
4270 /* Handle `(left-fringe BITMAP [FACE])'
4271 and `(right-fringe BITMAP [FACE])'. */
4273 && (EQ (XCAR (spec
), Qleft_fringe
)
4274 || EQ (XCAR (spec
), Qright_fringe
))
4275 && CONSP (XCDR (spec
)))
4277 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
4280 if (!FRAME_WINDOW_P (it
->f
))
4281 /* If we return here, POSITION has been advanced
4282 across the text with this property. */
4285 #ifdef HAVE_WINDOW_SYSTEM
4286 value
= XCAR (XCDR (spec
));
4287 if (!SYMBOLP (value
)
4288 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4289 /* If we return here, POSITION has been advanced
4290 across the text with this property. */
4293 if (CONSP (XCDR (XCDR (spec
))))
4295 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4296 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4302 /* Save current settings of IT so that we can restore them
4303 when we are finished with the glyph property value. */
4305 save_pos
= it
->position
;
4306 it
->position
= *position
;
4308 it
->position
= save_pos
;
4310 it
->area
= TEXT_AREA
;
4311 it
->what
= IT_IMAGE
;
4312 it
->image_id
= -1; /* no image */
4313 it
->position
= start_pos
;
4314 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4315 it
->method
= GET_FROM_IMAGE
;
4316 it
->from_overlay
= Qnil
;
4317 it
->face_id
= face_id
;
4319 /* Say that we haven't consumed the characters with
4320 `display' property yet. The call to pop_it in
4321 set_iterator_to_next will clean this up. */
4322 *position
= start_pos
;
4324 if (EQ (XCAR (spec
), Qleft_fringe
))
4326 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4327 it
->left_user_fringe_face_id
= face_id
;
4331 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4332 it
->right_user_fringe_face_id
= face_id
;
4334 #endif /* HAVE_WINDOW_SYSTEM */
4338 /* Prepare to handle `((margin left-margin) ...)',
4339 `((margin right-margin) ...)' and `((margin nil) ...)'
4340 prefixes for display specifications. */
4341 location
= Qunbound
;
4342 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4346 value
= XCDR (spec
);
4348 value
= XCAR (value
);
4351 if (EQ (XCAR (tem
), Qmargin
)
4352 && (tem
= XCDR (tem
),
4353 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4355 || EQ (tem
, Qleft_margin
)
4356 || EQ (tem
, Qright_margin
))))
4360 if (EQ (location
, Qunbound
))
4366 /* After this point, VALUE is the property after any
4367 margin prefix has been stripped. It must be a string,
4368 an image specification, or `(space ...)'.
4370 LOCATION specifies where to display: `left-margin',
4371 `right-margin' or nil. */
4373 valid_p
= (STRINGP (value
)
4374 #ifdef HAVE_WINDOW_SYSTEM
4375 || (FRAME_WINDOW_P (it
->f
) && valid_image_p (value
))
4376 #endif /* not HAVE_WINDOW_SYSTEM */
4377 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4379 if (valid_p
&& !display_replaced_before_p
)
4381 /* Save current settings of IT so that we can restore them
4382 when we are finished with the glyph property value. */
4383 save_pos
= it
->position
;
4384 it
->position
= *position
;
4386 it
->position
= save_pos
;
4387 it
->from_overlay
= overlay
;
4389 if (NILP (location
))
4390 it
->area
= TEXT_AREA
;
4391 else if (EQ (location
, Qleft_margin
))
4392 it
->area
= LEFT_MARGIN_AREA
;
4394 it
->area
= RIGHT_MARGIN_AREA
;
4396 if (STRINGP (value
))
4399 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4400 it
->current
.overlay_string_index
= -1;
4401 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4402 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4403 it
->method
= GET_FROM_STRING
;
4404 it
->stop_charpos
= 0;
4405 it
->string_from_display_prop_p
= 1;
4406 /* Say that we haven't consumed the characters with
4407 `display' property yet. The call to pop_it in
4408 set_iterator_to_next will clean this up. */
4409 if (BUFFERP (object
))
4410 *position
= start_pos
;
4412 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4414 it
->method
= GET_FROM_STRETCH
;
4416 *position
= it
->position
= start_pos
;
4418 #ifdef HAVE_WINDOW_SYSTEM
4421 it
->what
= IT_IMAGE
;
4422 it
->image_id
= lookup_image (it
->f
, value
);
4423 it
->position
= start_pos
;
4424 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4425 it
->method
= GET_FROM_IMAGE
;
4427 /* Say that we haven't consumed the characters with
4428 `display' property yet. The call to pop_it in
4429 set_iterator_to_next will clean this up. */
4430 *position
= start_pos
;
4432 #endif /* HAVE_WINDOW_SYSTEM */
4437 /* Invalid property or property not supported. Restore
4438 POSITION to what it was before. */
4439 *position
= start_pos
;
4444 /* Check if SPEC is a display sub-property value whose text should be
4445 treated as intangible. */
4448 single_display_spec_intangible_p (Lisp_Object prop
)
4450 /* Skip over `when FORM'. */
4451 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4465 /* Skip over `margin LOCATION'. If LOCATION is in the margins,
4466 we don't need to treat text as intangible. */
4467 if (EQ (XCAR (prop
), Qmargin
))
4475 || EQ (XCAR (prop
), Qleft_margin
)
4476 || EQ (XCAR (prop
), Qright_margin
))
4480 return (CONSP (prop
)
4481 && (EQ (XCAR (prop
), Qimage
)
4482 || EQ (XCAR (prop
), Qspace
)));
4486 /* Check if PROP is a display property value whose text should be
4487 treated as intangible. */
4490 display_prop_intangible_p (Lisp_Object prop
)
4493 && CONSP (XCAR (prop
))
4494 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4496 /* A list of sub-properties. */
4497 while (CONSP (prop
))
4499 if (single_display_spec_intangible_p (XCAR (prop
)))
4504 else if (VECTORP (prop
))
4506 /* A vector of sub-properties. */
4508 for (i
= 0; i
< ASIZE (prop
); ++i
)
4509 if (single_display_spec_intangible_p (AREF (prop
, i
)))
4513 return single_display_spec_intangible_p (prop
);
4519 /* Return 1 if PROP is a display sub-property value containing STRING. */
4522 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
4524 if (EQ (string
, prop
))
4527 /* Skip over `when FORM'. */
4528 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4537 /* Skip over `margin LOCATION'. */
4538 if (EQ (XCAR (prop
), Qmargin
))
4549 return CONSP (prop
) && EQ (XCAR (prop
), string
);
4553 /* Return 1 if STRING appears in the `display' property PROP. */
4556 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
4559 && CONSP (XCAR (prop
))
4560 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4562 /* A list of sub-properties. */
4563 while (CONSP (prop
))
4565 if (single_display_spec_string_p (XCAR (prop
), string
))
4570 else if (VECTORP (prop
))
4572 /* A vector of sub-properties. */
4574 for (i
= 0; i
< ASIZE (prop
); ++i
)
4575 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4579 return single_display_spec_string_p (prop
, string
);
4584 /* Look for STRING in overlays and text properties in W's buffer,
4585 between character positions FROM and TO (excluding TO).
4586 BACK_P non-zero means look back (in this case, TO is supposed to be
4588 Value is the first character position where STRING was found, or
4589 zero if it wasn't found before hitting TO.
4591 W's buffer must be current.
4593 This function may only use code that doesn't eval because it is
4594 called asynchronously from note_mouse_highlight. */
4597 string_buffer_position_lim (struct window
*w
, Lisp_Object string
,
4598 EMACS_INT from
, EMACS_INT to
, int back_p
)
4600 Lisp_Object limit
, prop
, pos
;
4603 pos
= make_number (from
);
4605 if (!back_p
) /* looking forward */
4607 limit
= make_number (min (to
, ZV
));
4608 while (!found
&& !EQ (pos
, limit
))
4610 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4611 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4614 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
4618 else /* looking back */
4620 limit
= make_number (max (to
, BEGV
));
4621 while (!found
&& !EQ (pos
, limit
))
4623 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4624 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4627 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
4632 return found
? XINT (pos
) : 0;
4635 /* Determine which buffer position in W's buffer STRING comes from.
4636 AROUND_CHARPOS is an approximate position where it could come from.
4637 Value is the buffer position or 0 if it couldn't be determined.
4639 W's buffer must be current.
4641 This function is necessary because we don't record buffer positions
4642 in glyphs generated from strings (to keep struct glyph small).
4643 This function may only use code that doesn't eval because it is
4644 called asynchronously from note_mouse_highlight. */
4647 string_buffer_position (struct window
*w
, Lisp_Object string
, EMACS_INT around_charpos
)
4649 const int MAX_DISTANCE
= 1000;
4650 EMACS_INT found
= string_buffer_position_lim (w
, string
, around_charpos
,
4651 around_charpos
+ MAX_DISTANCE
,
4655 found
= string_buffer_position_lim (w
, string
, around_charpos
,
4656 around_charpos
- MAX_DISTANCE
, 1);
4662 /***********************************************************************
4663 `composition' property
4664 ***********************************************************************/
4666 /* Set up iterator IT from `composition' property at its current
4667 position. Called from handle_stop. */
4669 static enum prop_handled
4670 handle_composition_prop (struct it
*it
)
4672 Lisp_Object prop
, string
;
4673 EMACS_INT pos
, pos_byte
, start
, end
;
4675 if (STRINGP (it
->string
))
4679 pos
= IT_STRING_CHARPOS (*it
);
4680 pos_byte
= IT_STRING_BYTEPOS (*it
);
4681 string
= it
->string
;
4682 s
= SDATA (string
) + pos_byte
;
4683 it
->c
= STRING_CHAR (s
);
4687 pos
= IT_CHARPOS (*it
);
4688 pos_byte
= IT_BYTEPOS (*it
);
4690 it
->c
= FETCH_CHAR (pos_byte
);
4693 /* If there's a valid composition and point is not inside of the
4694 composition (in the case that the composition is from the current
4695 buffer), draw a glyph composed from the composition components. */
4696 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
4697 && COMPOSITION_VALID_P (start
, end
, prop
)
4698 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
4702 if (STRINGP (it
->string
))
4703 pos_byte
= string_char_to_byte (it
->string
, start
);
4705 pos_byte
= CHAR_TO_BYTE (start
);
4707 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
4710 if (it
->cmp_it
.id
>= 0)
4713 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
4714 it
->cmp_it
.nglyphs
= -1;
4718 return HANDLED_NORMALLY
;
4723 /***********************************************************************
4725 ***********************************************************************/
4727 /* The following structure is used to record overlay strings for
4728 later sorting in load_overlay_strings. */
4730 struct overlay_entry
4732 Lisp_Object overlay
;
4739 /* Set up iterator IT from overlay strings at its current position.
4740 Called from handle_stop. */
4742 static enum prop_handled
4743 handle_overlay_change (struct it
*it
)
4745 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
4746 return HANDLED_RECOMPUTE_PROPS
;
4748 return HANDLED_NORMALLY
;
4752 /* Set up the next overlay string for delivery by IT, if there is an
4753 overlay string to deliver. Called by set_iterator_to_next when the
4754 end of the current overlay string is reached. If there are more
4755 overlay strings to display, IT->string and
4756 IT->current.overlay_string_index are set appropriately here.
4757 Otherwise IT->string is set to nil. */
4760 next_overlay_string (struct it
*it
)
4762 ++it
->current
.overlay_string_index
;
4763 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
4765 /* No more overlay strings. Restore IT's settings to what
4766 they were before overlay strings were processed, and
4767 continue to deliver from current_buffer. */
4769 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
4772 || (NILP (it
->string
)
4773 && it
->method
== GET_FROM_BUFFER
4774 && it
->stop_charpos
>= BEGV
4775 && it
->stop_charpos
<= it
->end_charpos
));
4776 it
->current
.overlay_string_index
= -1;
4777 it
->n_overlay_strings
= 0;
4779 /* If we're at the end of the buffer, record that we have
4780 processed the overlay strings there already, so that
4781 next_element_from_buffer doesn't try it again. */
4782 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
4783 it
->overlay_strings_at_end_processed_p
= 1;
4787 /* There are more overlay strings to process. If
4788 IT->current.overlay_string_index has advanced to a position
4789 where we must load IT->overlay_strings with more strings, do
4791 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
4793 if (it
->current
.overlay_string_index
&& i
== 0)
4794 load_overlay_strings (it
, 0);
4796 /* Initialize IT to deliver display elements from the overlay
4798 it
->string
= it
->overlay_strings
[i
];
4799 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4800 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
4801 it
->method
= GET_FROM_STRING
;
4802 it
->stop_charpos
= 0;
4803 if (it
->cmp_it
.stop_pos
>= 0)
4804 it
->cmp_it
.stop_pos
= 0;
4811 /* Compare two overlay_entry structures E1 and E2. Used as a
4812 comparison function for qsort in load_overlay_strings. Overlay
4813 strings for the same position are sorted so that
4815 1. All after-strings come in front of before-strings, except
4816 when they come from the same overlay.
4818 2. Within after-strings, strings are sorted so that overlay strings
4819 from overlays with higher priorities come first.
4821 2. Within before-strings, strings are sorted so that overlay
4822 strings from overlays with higher priorities come last.
4824 Value is analogous to strcmp. */
4828 compare_overlay_entries (const void *e1
, const void *e2
)
4830 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
4831 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
4834 if (entry1
->after_string_p
!= entry2
->after_string_p
)
4836 /* Let after-strings appear in front of before-strings if
4837 they come from different overlays. */
4838 if (EQ (entry1
->overlay
, entry2
->overlay
))
4839 result
= entry1
->after_string_p
? 1 : -1;
4841 result
= entry1
->after_string_p
? -1 : 1;
4843 else if (entry1
->after_string_p
)
4844 /* After-strings sorted in order of decreasing priority. */
4845 result
= entry2
->priority
- entry1
->priority
;
4847 /* Before-strings sorted in order of increasing priority. */
4848 result
= entry1
->priority
- entry2
->priority
;
4854 /* Load the vector IT->overlay_strings with overlay strings from IT's
4855 current buffer position, or from CHARPOS if that is > 0. Set
4856 IT->n_overlays to the total number of overlay strings found.
4858 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
4859 a time. On entry into load_overlay_strings,
4860 IT->current.overlay_string_index gives the number of overlay
4861 strings that have already been loaded by previous calls to this
4864 IT->add_overlay_start contains an additional overlay start
4865 position to consider for taking overlay strings from, if non-zero.
4866 This position comes into play when the overlay has an `invisible'
4867 property, and both before and after-strings. When we've skipped to
4868 the end of the overlay, because of its `invisible' property, we
4869 nevertheless want its before-string to appear.
4870 IT->add_overlay_start will contain the overlay start position
4873 Overlay strings are sorted so that after-string strings come in
4874 front of before-string strings. Within before and after-strings,
4875 strings are sorted by overlay priority. See also function
4876 compare_overlay_entries. */
4879 load_overlay_strings (struct it
*it
, EMACS_INT charpos
)
4881 Lisp_Object overlay
, window
, str
, invisible
;
4882 struct Lisp_Overlay
*ov
;
4883 EMACS_INT start
, end
;
4885 int n
= 0, i
, j
, invis_p
;
4886 struct overlay_entry
*entries
4887 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
4890 charpos
= IT_CHARPOS (*it
);
4892 /* Append the overlay string STRING of overlay OVERLAY to vector
4893 `entries' which has size `size' and currently contains `n'
4894 elements. AFTER_P non-zero means STRING is an after-string of
4896 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
4899 Lisp_Object priority; \
4903 int new_size = 2 * size; \
4904 struct overlay_entry *old = entries; \
4906 (struct overlay_entry *) alloca (new_size \
4907 * sizeof *entries); \
4908 memcpy (entries, old, size * sizeof *entries); \
4912 entries[n].string = (STRING); \
4913 entries[n].overlay = (OVERLAY); \
4914 priority = Foverlay_get ((OVERLAY), Qpriority); \
4915 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
4916 entries[n].after_string_p = (AFTER_P); \
4921 /* Process overlay before the overlay center. */
4922 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
4924 XSETMISC (overlay
, ov
);
4925 xassert (OVERLAYP (overlay
));
4926 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4927 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4932 /* Skip this overlay if it doesn't start or end at IT's current
4934 if (end
!= charpos
&& start
!= charpos
)
4937 /* Skip this overlay if it doesn't apply to IT->w. */
4938 window
= Foverlay_get (overlay
, Qwindow
);
4939 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4942 /* If the text ``under'' the overlay is invisible, both before-
4943 and after-strings from this overlay are visible; start and
4944 end position are indistinguishable. */
4945 invisible
= Foverlay_get (overlay
, Qinvisible
);
4946 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4948 /* If overlay has a non-empty before-string, record it. */
4949 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4950 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4952 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4954 /* If overlay has a non-empty after-string, record it. */
4955 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4956 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4958 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4961 /* Process overlays after the overlay center. */
4962 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
4964 XSETMISC (overlay
, ov
);
4965 xassert (OVERLAYP (overlay
));
4966 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4967 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4969 if (start
> charpos
)
4972 /* Skip this overlay if it doesn't start or end at IT's current
4974 if (end
!= charpos
&& start
!= charpos
)
4977 /* Skip this overlay if it doesn't apply to IT->w. */
4978 window
= Foverlay_get (overlay
, Qwindow
);
4979 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4982 /* If the text ``under'' the overlay is invisible, it has a zero
4983 dimension, and both before- and after-strings apply. */
4984 invisible
= Foverlay_get (overlay
, Qinvisible
);
4985 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4987 /* If overlay has a non-empty before-string, record it. */
4988 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4989 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4991 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4993 /* If overlay has a non-empty after-string, record it. */
4994 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4995 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4997 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5000 #undef RECORD_OVERLAY_STRING
5004 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5006 /* Record the total number of strings to process. */
5007 it
->n_overlay_strings
= n
;
5009 /* IT->current.overlay_string_index is the number of overlay strings
5010 that have already been consumed by IT. Copy some of the
5011 remaining overlay strings to IT->overlay_strings. */
5013 j
= it
->current
.overlay_string_index
;
5014 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5016 it
->overlay_strings
[i
] = entries
[j
].string
;
5017 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5024 /* Get the first chunk of overlay strings at IT's current buffer
5025 position, or at CHARPOS if that is > 0. Value is non-zero if at
5026 least one overlay string was found. */
5029 get_overlay_strings_1 (struct it
*it
, EMACS_INT charpos
, int compute_stop_p
)
5031 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5032 process. This fills IT->overlay_strings with strings, and sets
5033 IT->n_overlay_strings to the total number of strings to process.
5034 IT->pos.overlay_string_index has to be set temporarily to zero
5035 because load_overlay_strings needs this; it must be set to -1
5036 when no overlay strings are found because a zero value would
5037 indicate a position in the first overlay string. */
5038 it
->current
.overlay_string_index
= 0;
5039 load_overlay_strings (it
, charpos
);
5041 /* If we found overlay strings, set up IT to deliver display
5042 elements from the first one. Otherwise set up IT to deliver
5043 from current_buffer. */
5044 if (it
->n_overlay_strings
)
5046 /* Make sure we know settings in current_buffer, so that we can
5047 restore meaningful values when we're done with the overlay
5050 compute_stop_pos (it
);
5051 xassert (it
->face_id
>= 0);
5053 /* Save IT's settings. They are restored after all overlay
5054 strings have been processed. */
5055 xassert (!compute_stop_p
|| it
->sp
== 0);
5057 /* When called from handle_stop, there might be an empty display
5058 string loaded. In that case, don't bother saving it. */
5059 if (!STRINGP (it
->string
) || SCHARS (it
->string
))
5062 /* Set up IT to deliver display elements from the first overlay
5064 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5065 it
->string
= it
->overlay_strings
[0];
5066 it
->from_overlay
= Qnil
;
5067 it
->stop_charpos
= 0;
5068 xassert (STRINGP (it
->string
));
5069 it
->end_charpos
= SCHARS (it
->string
);
5070 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5071 it
->method
= GET_FROM_STRING
;
5075 it
->current
.overlay_string_index
= -1;
5080 get_overlay_strings (struct it
*it
, EMACS_INT charpos
)
5083 it
->method
= GET_FROM_BUFFER
;
5085 (void) get_overlay_strings_1 (it
, charpos
, 1);
5089 /* Value is non-zero if we found at least one overlay string. */
5090 return STRINGP (it
->string
);
5095 /***********************************************************************
5096 Saving and restoring state
5097 ***********************************************************************/
5099 /* Save current settings of IT on IT->stack. Called, for example,
5100 before setting up IT for an overlay string, to be able to restore
5101 IT's settings to what they were after the overlay string has been
5105 push_it (struct it
*it
)
5107 struct iterator_stack_entry
*p
;
5109 xassert (it
->sp
< IT_STACK_SIZE
);
5110 p
= it
->stack
+ it
->sp
;
5112 p
->stop_charpos
= it
->stop_charpos
;
5113 p
->prev_stop
= it
->prev_stop
;
5114 p
->base_level_stop
= it
->base_level_stop
;
5115 p
->cmp_it
= it
->cmp_it
;
5116 xassert (it
->face_id
>= 0);
5117 p
->face_id
= it
->face_id
;
5118 p
->string
= it
->string
;
5119 p
->method
= it
->method
;
5120 p
->from_overlay
= it
->from_overlay
;
5123 case GET_FROM_IMAGE
:
5124 p
->u
.image
.object
= it
->object
;
5125 p
->u
.image
.image_id
= it
->image_id
;
5126 p
->u
.image
.slice
= it
->slice
;
5128 case GET_FROM_STRETCH
:
5129 p
->u
.stretch
.object
= it
->object
;
5132 p
->position
= it
->position
;
5133 p
->current
= it
->current
;
5134 p
->end_charpos
= it
->end_charpos
;
5135 p
->string_nchars
= it
->string_nchars
;
5137 p
->multibyte_p
= it
->multibyte_p
;
5138 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5139 p
->space_width
= it
->space_width
;
5140 p
->font_height
= it
->font_height
;
5141 p
->voffset
= it
->voffset
;
5142 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5143 p
->display_ellipsis_p
= 0;
5144 p
->line_wrap
= it
->line_wrap
;
5149 iterate_out_of_display_property (struct it
*it
)
5151 /* Maybe initialize paragraph direction. If we are at the beginning
5152 of a new paragraph, next_element_from_buffer may not have a
5153 chance to do that. */
5154 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
5155 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
5156 /* prev_stop can be zero, so check against BEGV as well. */
5157 while (it
->bidi_it
.charpos
>= BEGV
5158 && it
->prev_stop
<= it
->bidi_it
.charpos
5159 && it
->bidi_it
.charpos
< CHARPOS (it
->position
))
5160 bidi_move_to_visually_next (&it
->bidi_it
);
5161 /* Record the stop_pos we just crossed, for when we cross it
5163 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5164 it
->prev_stop
= CHARPOS (it
->position
);
5165 /* If we ended up not where pop_it put us, resync IT's
5166 positional members with the bidi iterator. */
5167 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5169 SET_TEXT_POS (it
->position
,
5170 it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5171 it
->current
.pos
= it
->position
;
5175 /* Restore IT's settings from IT->stack. Called, for example, when no
5176 more overlay strings must be processed, and we return to delivering
5177 display elements from a buffer, or when the end of a string from a
5178 `display' property is reached and we return to delivering display
5179 elements from an overlay string, or from a buffer. */
5182 pop_it (struct it
*it
)
5184 struct iterator_stack_entry
*p
;
5186 xassert (it
->sp
> 0);
5188 p
= it
->stack
+ it
->sp
;
5189 it
->stop_charpos
= p
->stop_charpos
;
5190 it
->prev_stop
= p
->prev_stop
;
5191 it
->base_level_stop
= p
->base_level_stop
;
5192 it
->cmp_it
= p
->cmp_it
;
5193 it
->face_id
= p
->face_id
;
5194 it
->current
= p
->current
;
5195 it
->position
= p
->position
;
5196 it
->string
= p
->string
;
5197 it
->from_overlay
= p
->from_overlay
;
5198 if (NILP (it
->string
))
5199 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5200 it
->method
= p
->method
;
5203 case GET_FROM_IMAGE
:
5204 it
->image_id
= p
->u
.image
.image_id
;
5205 it
->object
= p
->u
.image
.object
;
5206 it
->slice
= p
->u
.image
.slice
;
5208 case GET_FROM_STRETCH
:
5209 it
->object
= p
->u
.comp
.object
;
5211 case GET_FROM_BUFFER
:
5212 it
->object
= it
->w
->buffer
;
5215 /* Bidi-iterate until we get out of the portion of text, if
5216 any, covered by a `display' text property or an overlay
5217 with `display' property. (We cannot just jump there,
5218 because the internal coherency of the bidi iterator state
5219 can not be preserved across such jumps.) We also must
5220 determine the paragraph base direction if the overlay we
5221 just processed is at the beginning of a new
5223 iterate_out_of_display_property (it
);
5226 case GET_FROM_STRING
:
5227 it
->object
= it
->string
;
5229 case GET_FROM_DISPLAY_VECTOR
:
5231 it
->method
= GET_FROM_C_STRING
;
5232 else if (STRINGP (it
->string
))
5233 it
->method
= GET_FROM_STRING
;
5236 it
->method
= GET_FROM_BUFFER
;
5237 it
->object
= it
->w
->buffer
;
5240 it
->end_charpos
= p
->end_charpos
;
5241 it
->string_nchars
= p
->string_nchars
;
5243 it
->multibyte_p
= p
->multibyte_p
;
5244 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5245 it
->space_width
= p
->space_width
;
5246 it
->font_height
= p
->font_height
;
5247 it
->voffset
= p
->voffset
;
5248 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5249 it
->line_wrap
= p
->line_wrap
;
5254 /***********************************************************************
5256 ***********************************************************************/
5258 /* Set IT's current position to the previous line start. */
5261 back_to_previous_line_start (struct it
*it
)
5263 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5264 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5268 /* Move IT to the next line start.
5270 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5271 we skipped over part of the text (as opposed to moving the iterator
5272 continuously over the text). Otherwise, don't change the value
5275 Newlines may come from buffer text, overlay strings, or strings
5276 displayed via the `display' property. That's the reason we can't
5277 simply use find_next_newline_no_quit.
5279 Note that this function may not skip over invisible text that is so
5280 because of text properties and immediately follows a newline. If
5281 it would, function reseat_at_next_visible_line_start, when called
5282 from set_iterator_to_next, would effectively make invisible
5283 characters following a newline part of the wrong glyph row, which
5284 leads to wrong cursor motion. */
5287 forward_to_next_line_start (struct it
*it
, int *skipped_p
)
5289 int old_selective
, newline_found_p
, n
;
5290 const int MAX_NEWLINE_DISTANCE
= 500;
5292 /* If already on a newline, just consume it to avoid unintended
5293 skipping over invisible text below. */
5294 if (it
->what
== IT_CHARACTER
5296 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5298 set_iterator_to_next (it
, 0);
5303 /* Don't handle selective display in the following. It's (a)
5304 unnecessary because it's done by the caller, and (b) leads to an
5305 infinite recursion because next_element_from_ellipsis indirectly
5306 calls this function. */
5307 old_selective
= it
->selective
;
5310 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5311 from buffer text. */
5312 for (n
= newline_found_p
= 0;
5313 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5314 n
+= STRINGP (it
->string
) ? 0 : 1)
5316 if (!get_next_display_element (it
))
5318 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5319 set_iterator_to_next (it
, 0);
5322 /* If we didn't find a newline near enough, see if we can use a
5324 if (!newline_found_p
)
5326 EMACS_INT start
= IT_CHARPOS (*it
);
5327 EMACS_INT limit
= find_next_newline_no_quit (start
, 1);
5330 xassert (!STRINGP (it
->string
));
5332 /* If there isn't any `display' property in sight, and no
5333 overlays, we can just use the position of the newline in
5335 if (it
->stop_charpos
>= limit
5336 || ((pos
= Fnext_single_property_change (make_number (start
),
5338 Qnil
, make_number (limit
)),
5340 && next_overlay_change (start
) == ZV
))
5342 IT_CHARPOS (*it
) = limit
;
5343 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5344 *skipped_p
= newline_found_p
= 1;
5348 while (get_next_display_element (it
)
5349 && !newline_found_p
)
5351 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5352 set_iterator_to_next (it
, 0);
5357 it
->selective
= old_selective
;
5358 return newline_found_p
;
5362 /* Set IT's current position to the previous visible line start. Skip
5363 invisible text that is so either due to text properties or due to
5364 selective display. Caution: this does not change IT->current_x and
5368 back_to_previous_visible_line_start (struct it
*it
)
5370 while (IT_CHARPOS (*it
) > BEGV
)
5372 back_to_previous_line_start (it
);
5374 if (IT_CHARPOS (*it
) <= BEGV
)
5377 /* If selective > 0, then lines indented more than its value are
5379 if (it
->selective
> 0
5380 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5381 (double) it
->selective
)) /* iftc */
5384 /* Check the newline before point for invisibility. */
5387 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5388 Qinvisible
, it
->window
);
5389 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5393 if (IT_CHARPOS (*it
) <= BEGV
)
5400 Lisp_Object val
, overlay
;
5402 /* If newline is part of a composition, continue from start of composition */
5403 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5404 && beg
< IT_CHARPOS (*it
))
5407 /* If newline is replaced by a display property, find start of overlay
5408 or interval and continue search from that point. */
5410 pos
= --IT_CHARPOS (it2
);
5413 it2
.string_from_display_prop_p
= 0;
5414 if (handle_display_prop (&it2
) == HANDLED_RETURN
5415 && !NILP (val
= get_char_property_and_overlay
5416 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5417 && (OVERLAYP (overlay
)
5418 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5419 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5422 /* Newline is not replaced by anything -- so we are done. */
5428 IT_CHARPOS (*it
) = beg
;
5429 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5433 it
->continuation_lines_width
= 0;
5435 xassert (IT_CHARPOS (*it
) >= BEGV
);
5436 xassert (IT_CHARPOS (*it
) == BEGV
5437 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5442 /* Reseat iterator IT at the previous visible line start. Skip
5443 invisible text that is so either due to text properties or due to
5444 selective display. At the end, update IT's overlay information,
5445 face information etc. */
5448 reseat_at_previous_visible_line_start (struct it
*it
)
5450 back_to_previous_visible_line_start (it
);
5451 reseat (it
, it
->current
.pos
, 1);
5456 /* Reseat iterator IT on the next visible line start in the current
5457 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5458 preceding the line start. Skip over invisible text that is so
5459 because of selective display. Compute faces, overlays etc at the
5460 new position. Note that this function does not skip over text that
5461 is invisible because of text properties. */
5464 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
5466 int newline_found_p
, skipped_p
= 0;
5468 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5470 /* Skip over lines that are invisible because they are indented
5471 more than the value of IT->selective. */
5472 if (it
->selective
> 0)
5473 while (IT_CHARPOS (*it
) < ZV
5474 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5475 (double) it
->selective
)) /* iftc */
5477 xassert (IT_BYTEPOS (*it
) == BEGV
5478 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5479 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5482 /* Position on the newline if that's what's requested. */
5483 if (on_newline_p
&& newline_found_p
)
5485 if (STRINGP (it
->string
))
5487 if (IT_STRING_CHARPOS (*it
) > 0)
5489 --IT_STRING_CHARPOS (*it
);
5490 --IT_STRING_BYTEPOS (*it
);
5493 else if (IT_CHARPOS (*it
) > BEGV
)
5497 reseat (it
, it
->current
.pos
, 0);
5501 reseat (it
, it
->current
.pos
, 0);
5508 /***********************************************************************
5509 Changing an iterator's position
5510 ***********************************************************************/
5512 /* Change IT's current position to POS in current_buffer. If FORCE_P
5513 is non-zero, always check for text properties at the new position.
5514 Otherwise, text properties are only looked up if POS >=
5515 IT->check_charpos of a property. */
5518 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
5520 EMACS_INT original_pos
= IT_CHARPOS (*it
);
5522 reseat_1 (it
, pos
, 0);
5524 /* Determine where to check text properties. Avoid doing it
5525 where possible because text property lookup is very expensive. */
5527 || CHARPOS (pos
) > it
->stop_charpos
5528 || CHARPOS (pos
) < original_pos
)
5532 /* For bidi iteration, we need to prime prev_stop and
5533 base_level_stop with our best estimations. */
5534 if (CHARPOS (pos
) < it
->prev_stop
)
5536 handle_stop_backwards (it
, BEGV
);
5537 if (CHARPOS (pos
) < it
->base_level_stop
)
5538 it
->base_level_stop
= 0;
5540 else if (CHARPOS (pos
) > it
->stop_charpos
5541 && it
->stop_charpos
>= BEGV
)
5542 handle_stop_backwards (it
, it
->stop_charpos
);
5549 it
->prev_stop
= it
->base_level_stop
= 0;
5558 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
5559 IT->stop_pos to POS, also. */
5562 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
5564 /* Don't call this function when scanning a C string. */
5565 xassert (it
->s
== NULL
);
5567 /* POS must be a reasonable value. */
5568 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
5570 it
->current
.pos
= it
->position
= pos
;
5571 it
->end_charpos
= ZV
;
5573 it
->current
.dpvec_index
= -1;
5574 it
->current
.overlay_string_index
= -1;
5575 IT_STRING_CHARPOS (*it
) = -1;
5576 IT_STRING_BYTEPOS (*it
) = -1;
5578 it
->string_from_display_prop_p
= 0;
5579 it
->method
= GET_FROM_BUFFER
;
5580 it
->object
= it
->w
->buffer
;
5581 it
->area
= TEXT_AREA
;
5582 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
5584 it
->string_from_display_prop_p
= 0;
5585 it
->face_before_selective_p
= 0;
5587 it
->bidi_it
.first_elt
= 1;
5591 it
->stop_charpos
= CHARPOS (pos
);
5592 it
->base_level_stop
= CHARPOS (pos
);
5597 /* Set up IT for displaying a string, starting at CHARPOS in window W.
5598 If S is non-null, it is a C string to iterate over. Otherwise,
5599 STRING gives a Lisp string to iterate over.
5601 If PRECISION > 0, don't return more then PRECISION number of
5602 characters from the string.
5604 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
5605 characters have been returned. FIELD_WIDTH < 0 means an infinite
5608 MULTIBYTE = 0 means disable processing of multibyte characters,
5609 MULTIBYTE > 0 means enable it,
5610 MULTIBYTE < 0 means use IT->multibyte_p.
5612 IT must be initialized via a prior call to init_iterator before
5613 calling this function. */
5616 reseat_to_string (struct it
*it
, const unsigned char *s
, Lisp_Object string
,
5617 EMACS_INT charpos
, EMACS_INT precision
, int field_width
,
5620 /* No region in strings. */
5621 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
5623 /* No text property checks performed by default, but see below. */
5624 it
->stop_charpos
= -1;
5626 /* Set iterator position and end position. */
5627 memset (&it
->current
, 0, sizeof it
->current
);
5628 it
->current
.overlay_string_index
= -1;
5629 it
->current
.dpvec_index
= -1;
5630 xassert (charpos
>= 0);
5632 /* If STRING is specified, use its multibyteness, otherwise use the
5633 setting of MULTIBYTE, if specified. */
5635 it
->multibyte_p
= multibyte
> 0;
5639 xassert (STRINGP (string
));
5640 it
->string
= string
;
5642 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
5643 it
->method
= GET_FROM_STRING
;
5644 it
->current
.string_pos
= string_pos (charpos
, string
);
5651 /* Note that we use IT->current.pos, not it->current.string_pos,
5652 for displaying C strings. */
5653 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
5654 if (it
->multibyte_p
)
5656 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
5657 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
5661 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
5662 it
->end_charpos
= it
->string_nchars
= strlen (s
);
5665 it
->method
= GET_FROM_C_STRING
;
5668 /* PRECISION > 0 means don't return more than PRECISION characters
5670 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
5671 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
5673 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
5674 characters have been returned. FIELD_WIDTH == 0 means don't pad,
5675 FIELD_WIDTH < 0 means infinite field width. This is useful for
5676 padding with `-' at the end of a mode line. */
5677 if (field_width
< 0)
5678 field_width
= INFINITY
;
5679 if (field_width
> it
->end_charpos
- charpos
)
5680 it
->end_charpos
= charpos
+ field_width
;
5682 /* Use the standard display table for displaying strings. */
5683 if (DISP_TABLE_P (Vstandard_display_table
))
5684 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
5686 it
->stop_charpos
= charpos
;
5687 if (s
== NULL
&& it
->multibyte_p
)
5689 EMACS_INT endpos
= SCHARS (it
->string
);
5690 if (endpos
> it
->end_charpos
)
5691 endpos
= it
->end_charpos
;
5692 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
5700 /***********************************************************************
5702 ***********************************************************************/
5704 /* Map enum it_method value to corresponding next_element_from_* function. */
5706 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
5708 next_element_from_buffer
,
5709 next_element_from_display_vector
,
5710 next_element_from_string
,
5711 next_element_from_c_string
,
5712 next_element_from_image
,
5713 next_element_from_stretch
5716 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
5719 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
5720 (possibly with the following characters). */
5722 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
5723 ((IT)->cmp_it.id >= 0 \
5724 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
5725 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
5726 END_CHARPOS, (IT)->w, \
5727 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
5731 /* Load IT's display element fields with information about the next
5732 display element from the current position of IT. Value is zero if
5733 end of buffer (or C string) is reached. */
5735 static struct frame
*last_escape_glyph_frame
= NULL
;
5736 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
5737 static int last_escape_glyph_merged_face_id
= 0;
5740 get_next_display_element (struct it
*it
)
5742 /* Non-zero means that we found a display element. Zero means that
5743 we hit the end of what we iterate over. Performance note: the
5744 function pointer `method' used here turns out to be faster than
5745 using a sequence of if-statements. */
5749 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
5751 if (it
->what
== IT_CHARACTER
)
5753 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
5754 and only if (a) the resolved directionality of that character
5756 /* FIXME: Do we need an exception for characters from display
5758 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
5759 it
->c
= bidi_mirror_char (it
->c
);
5760 /* Map via display table or translate control characters.
5761 IT->c, IT->len etc. have been set to the next character by
5762 the function call above. If we have a display table, and it
5763 contains an entry for IT->c, translate it. Don't do this if
5764 IT->c itself comes from a display table, otherwise we could
5765 end up in an infinite recursion. (An alternative could be to
5766 count the recursion depth of this function and signal an
5767 error when a certain maximum depth is reached.) Is it worth
5769 if (success_p
&& it
->dpvec
== NULL
)
5772 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
5773 enum { char_is_other
= 0, char_is_nbsp
, char_is_soft_hyphen
}
5774 nbsp_or_shy
= char_is_other
;
5775 int c
= it
->c
; /* This is the character to display. */
5777 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
5779 xassert (SINGLE_BYTE_CHAR_P (c
));
5780 if (unibyte_display_via_language_environment
)
5782 c
= DECODE_CHAR (unibyte
, c
);
5784 c
= BYTE8_TO_CHAR (it
->c
);
5787 c
= BYTE8_TO_CHAR (it
->c
);
5791 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
5794 struct Lisp_Vector
*v
= XVECTOR (dv
);
5796 /* Return the first character from the display table
5797 entry, if not empty. If empty, don't display the
5798 current character. */
5801 it
->dpvec_char_len
= it
->len
;
5802 it
->dpvec
= v
->contents
;
5803 it
->dpend
= v
->contents
+ v
->size
;
5804 it
->current
.dpvec_index
= 0;
5805 it
->dpvec_face_id
= -1;
5806 it
->saved_face_id
= it
->face_id
;
5807 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5812 set_iterator_to_next (it
, 0);
5817 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
5818 nbsp_or_shy
= (c
== 0xA0 ? char_is_nbsp
5819 : c
== 0xAD ? char_is_soft_hyphen
5822 /* Translate control characters into `\003' or `^C' form.
5823 Control characters coming from a display table entry are
5824 currently not translated because we use IT->dpvec to hold
5825 the translation. This could easily be changed but I
5826 don't believe that it is worth doing.
5828 NBSP and SOFT-HYPEN are property translated too.
5830 Non-printable characters and raw-byte characters are also
5831 translated to octal form. */
5832 if (((c
< ' ' || c
== 127) /* ASCII control chars */
5833 ? (it
->area
!= TEXT_AREA
5834 /* In mode line, treat \n, \t like other crl chars. */
5837 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
5838 || (c
!= '\n' && c
!= '\t'))
5841 || ! CHAR_PRINTABLE_P (c
))))
5843 /* C is a control character, NBSP, SOFT-HYPEN, raw-byte,
5844 or a non-printable character which must be displayed
5845 either as '\003' or as `^C' where the '\\' and '^'
5846 can be defined in the display table. Fill
5847 IT->ctl_chars with glyphs for what we have to
5848 display. Then, set IT->dpvec to these glyphs. */
5851 int face_id
, lface_id
= 0 ;
5854 /* Handle control characters with ^. */
5856 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
5860 g
= '^'; /* default glyph for Control */
5861 /* Set IT->ctl_chars[0] to the glyph for `^'. */
5863 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5864 && GLYPH_CODE_CHAR_VALID_P (gc
))
5866 g
= GLYPH_CODE_CHAR (gc
);
5867 lface_id
= GLYPH_CODE_FACE (gc
);
5871 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
5873 else if (it
->f
== last_escape_glyph_frame
5874 && it
->face_id
== last_escape_glyph_face_id
)
5876 face_id
= last_escape_glyph_merged_face_id
;
5880 /* Merge the escape-glyph face into the current face. */
5881 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5883 last_escape_glyph_frame
= it
->f
;
5884 last_escape_glyph_face_id
= it
->face_id
;
5885 last_escape_glyph_merged_face_id
= face_id
;
5888 XSETINT (it
->ctl_chars
[0], g
);
5889 XSETINT (it
->ctl_chars
[1], c
^ 0100);
5891 goto display_control
;
5894 /* Handle non-break space in the mode where it only gets
5897 if (EQ (Vnobreak_char_display
, Qt
)
5898 && nbsp_or_shy
== char_is_nbsp
)
5900 /* Merge the no-break-space face into the current face. */
5901 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
5905 XSETINT (it
->ctl_chars
[0], ' ');
5907 goto display_control
;
5910 /* Handle sequences that start with the "escape glyph". */
5912 /* the default escape glyph is \. */
5913 escape_glyph
= '\\';
5916 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5917 && GLYPH_CODE_CHAR_VALID_P (gc
))
5919 escape_glyph
= GLYPH_CODE_CHAR (gc
);
5920 lface_id
= GLYPH_CODE_FACE (gc
);
5924 /* The display table specified a face.
5925 Merge it into face_id and also into escape_glyph. */
5926 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
5929 else if (it
->f
== last_escape_glyph_frame
5930 && it
->face_id
== last_escape_glyph_face_id
)
5932 face_id
= last_escape_glyph_merged_face_id
;
5936 /* Merge the escape-glyph face into the current face. */
5937 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5939 last_escape_glyph_frame
= it
->f
;
5940 last_escape_glyph_face_id
= it
->face_id
;
5941 last_escape_glyph_merged_face_id
= face_id
;
5944 /* Handle soft hyphens in the mode where they only get
5947 if (EQ (Vnobreak_char_display
, Qt
)
5948 && nbsp_or_shy
== char_is_soft_hyphen
)
5950 XSETINT (it
->ctl_chars
[0], '-');
5952 goto display_control
;
5955 /* Handle non-break space and soft hyphen
5956 with the escape glyph. */
5960 XSETINT (it
->ctl_chars
[0], escape_glyph
);
5961 c
= (nbsp_or_shy
== char_is_nbsp
? ' ' : '-');
5962 XSETINT (it
->ctl_chars
[1], c
);
5964 goto display_control
;
5971 if (CHAR_BYTE8_P (c
))
5972 /* Display \200 instead of \17777600. */
5973 c
= CHAR_TO_BYTE8 (c
);
5974 len
= sprintf (str
, "%03o", c
);
5976 XSETINT (it
->ctl_chars
[0], escape_glyph
);
5977 for (i
= 0; i
< len
; i
++)
5978 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
5983 /* Set up IT->dpvec and return first character from it. */
5984 it
->dpvec_char_len
= it
->len
;
5985 it
->dpvec
= it
->ctl_chars
;
5986 it
->dpend
= it
->dpvec
+ ctl_len
;
5987 it
->current
.dpvec_index
= 0;
5988 it
->dpvec_face_id
= face_id
;
5989 it
->saved_face_id
= it
->face_id
;
5990 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5994 it
->char_to_display
= c
;
5998 it
->char_to_display
= it
->c
;
6002 #ifdef HAVE_WINDOW_SYSTEM
6003 /* Adjust face id for a multibyte character. There are no multibyte
6004 character in unibyte text. */
6005 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
6008 && FRAME_WINDOW_P (it
->f
))
6010 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6012 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
6014 /* Automatic composition with glyph-string. */
6015 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
6017 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
6021 EMACS_INT pos
= (it
->s
? -1
6022 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
6023 : IT_CHARPOS (*it
));
6025 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
, pos
,
6031 /* Is this character the last one of a run of characters with
6032 box? If yes, set IT->end_of_box_run_p to 1. */
6036 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
6038 int face_id
= underlying_face_id (it
);
6039 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
6043 if (face
->box
== FACE_NO_BOX
)
6045 /* If the box comes from face properties in a
6046 display string, check faces in that string. */
6047 int string_face_id
= face_after_it_pos (it
);
6048 it
->end_of_box_run_p
6049 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
6052 /* Otherwise, the box comes from the underlying face.
6053 If this is the last string character displayed, check
6054 the next buffer location. */
6055 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
6056 && (it
->current
.overlay_string_index
6057 == it
->n_overlay_strings
- 1))
6061 struct text_pos pos
= it
->current
.pos
;
6062 INC_TEXT_POS (pos
, it
->multibyte_p
);
6064 next_face_id
= face_at_buffer_position
6065 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
6066 it
->region_end_charpos
, &ignore
,
6067 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
6069 it
->end_of_box_run_p
6070 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
6077 int face_id
= face_after_it_pos (it
);
6078 it
->end_of_box_run_p
6079 = (face_id
!= it
->face_id
6080 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
6084 /* Value is 0 if end of buffer or string reached. */
6089 /* Move IT to the next display element.
6091 RESEAT_P non-zero means if called on a newline in buffer text,
6092 skip to the next visible line start.
6094 Functions get_next_display_element and set_iterator_to_next are
6095 separate because I find this arrangement easier to handle than a
6096 get_next_display_element function that also increments IT's
6097 position. The way it is we can first look at an iterator's current
6098 display element, decide whether it fits on a line, and if it does,
6099 increment the iterator position. The other way around we probably
6100 would either need a flag indicating whether the iterator has to be
6101 incremented the next time, or we would have to implement a
6102 decrement position function which would not be easy to write. */
6105 set_iterator_to_next (struct it
*it
, int reseat_p
)
6107 /* Reset flags indicating start and end of a sequence of characters
6108 with box. Reset them at the start of this function because
6109 moving the iterator to a new position might set them. */
6110 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6114 case GET_FROM_BUFFER
:
6115 /* The current display element of IT is a character from
6116 current_buffer. Advance in the buffer, and maybe skip over
6117 invisible lines that are so because of selective display. */
6118 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6119 reseat_at_next_visible_line_start (it
, 0);
6120 else if (it
->cmp_it
.id
>= 0)
6122 /* We are currently getting glyphs from a composition. */
6127 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6128 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6129 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6131 it
->cmp_it
.from
= it
->cmp_it
.to
;
6136 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6138 it
->end_charpos
, Qnil
);
6141 else if (! it
->cmp_it
.reversed_p
)
6143 /* Composition created while scanning forward. */
6144 /* Update IT's char/byte positions to point to the first
6145 character of the next grapheme cluster, or to the
6146 character visually after the current composition. */
6147 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6148 bidi_move_to_visually_next (&it
->bidi_it
);
6149 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6150 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6152 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6154 /* Proceed to the next grapheme cluster. */
6155 it
->cmp_it
.from
= it
->cmp_it
.to
;
6159 /* No more grapheme clusters in this composition.
6160 Find the next stop position. */
6161 EMACS_INT stop
= it
->end_charpos
;
6162 if (it
->bidi_it
.scan_dir
< 0)
6163 /* Now we are scanning backward and don't know
6166 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6167 IT_BYTEPOS (*it
), stop
, Qnil
);
6172 /* Composition created while scanning backward. */
6173 /* Update IT's char/byte positions to point to the last
6174 character of the previous grapheme cluster, or the
6175 character visually after the current composition. */
6176 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6177 bidi_move_to_visually_next (&it
->bidi_it
);
6178 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6179 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6180 if (it
->cmp_it
.from
> 0)
6182 /* Proceed to the previous grapheme cluster. */
6183 it
->cmp_it
.to
= it
->cmp_it
.from
;
6187 /* No more grapheme clusters in this composition.
6188 Find the next stop position. */
6189 EMACS_INT stop
= it
->end_charpos
;
6190 if (it
->bidi_it
.scan_dir
< 0)
6191 /* Now we are scanning backward and don't know
6194 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6195 IT_BYTEPOS (*it
), stop
, Qnil
);
6201 xassert (it
->len
!= 0);
6205 IT_BYTEPOS (*it
) += it
->len
;
6206 IT_CHARPOS (*it
) += 1;
6210 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6211 /* If this is a new paragraph, determine its base
6212 direction (a.k.a. its base embedding level). */
6213 if (it
->bidi_it
.new_paragraph
)
6214 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6215 bidi_move_to_visually_next (&it
->bidi_it
);
6216 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6217 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6218 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6220 /* As the scan direction was changed, we must
6221 re-compute the stop position for composition. */
6222 EMACS_INT stop
= it
->end_charpos
;
6223 if (it
->bidi_it
.scan_dir
< 0)
6225 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6226 IT_BYTEPOS (*it
), stop
, Qnil
);
6229 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6233 case GET_FROM_C_STRING
:
6234 /* Current display element of IT is from a C string. */
6235 IT_BYTEPOS (*it
) += it
->len
;
6236 IT_CHARPOS (*it
) += 1;
6239 case GET_FROM_DISPLAY_VECTOR
:
6240 /* Current display element of IT is from a display table entry.
6241 Advance in the display table definition. Reset it to null if
6242 end reached, and continue with characters from buffers/
6244 ++it
->current
.dpvec_index
;
6246 /* Restore face of the iterator to what they were before the
6247 display vector entry (these entries may contain faces). */
6248 it
->face_id
= it
->saved_face_id
;
6250 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6252 int recheck_faces
= it
->ellipsis_p
;
6255 it
->method
= GET_FROM_C_STRING
;
6256 else if (STRINGP (it
->string
))
6257 it
->method
= GET_FROM_STRING
;
6260 it
->method
= GET_FROM_BUFFER
;
6261 it
->object
= it
->w
->buffer
;
6265 it
->current
.dpvec_index
= -1;
6267 /* Skip over characters which were displayed via IT->dpvec. */
6268 if (it
->dpvec_char_len
< 0)
6269 reseat_at_next_visible_line_start (it
, 1);
6270 else if (it
->dpvec_char_len
> 0)
6272 if (it
->method
== GET_FROM_STRING
6273 && it
->n_overlay_strings
> 0)
6274 it
->ignore_overlay_strings_at_pos_p
= 1;
6275 it
->len
= it
->dpvec_char_len
;
6276 set_iterator_to_next (it
, reseat_p
);
6279 /* Maybe recheck faces after display vector */
6281 it
->stop_charpos
= IT_CHARPOS (*it
);
6285 case GET_FROM_STRING
:
6286 /* Current display element is a character from a Lisp string. */
6287 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6288 if (it
->cmp_it
.id
>= 0)
6290 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6291 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6292 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6293 it
->cmp_it
.from
= it
->cmp_it
.to
;
6297 composition_compute_stop_pos (&it
->cmp_it
,
6298 IT_STRING_CHARPOS (*it
),
6299 IT_STRING_BYTEPOS (*it
),
6300 it
->end_charpos
, it
->string
);
6305 IT_STRING_BYTEPOS (*it
) += it
->len
;
6306 IT_STRING_CHARPOS (*it
) += 1;
6309 consider_string_end
:
6311 if (it
->current
.overlay_string_index
>= 0)
6313 /* IT->string is an overlay string. Advance to the
6314 next, if there is one. */
6315 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6318 next_overlay_string (it
);
6320 setup_for_ellipsis (it
, 0);
6325 /* IT->string is not an overlay string. If we reached
6326 its end, and there is something on IT->stack, proceed
6327 with what is on the stack. This can be either another
6328 string, this time an overlay string, or a buffer. */
6329 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
6333 if (it
->method
== GET_FROM_STRING
)
6334 goto consider_string_end
;
6339 case GET_FROM_IMAGE
:
6340 case GET_FROM_STRETCH
:
6341 /* The position etc with which we have to proceed are on
6342 the stack. The position may be at the end of a string,
6343 if the `display' property takes up the whole string. */
6344 xassert (it
->sp
> 0);
6346 if (it
->method
== GET_FROM_STRING
)
6347 goto consider_string_end
;
6351 /* There are no other methods defined, so this should be a bug. */
6355 xassert (it
->method
!= GET_FROM_STRING
6356 || (STRINGP (it
->string
)
6357 && IT_STRING_CHARPOS (*it
) >= 0));
6360 /* Load IT's display element fields with information about the next
6361 display element which comes from a display table entry or from the
6362 result of translating a control character to one of the forms `^C'
6365 IT->dpvec holds the glyphs to return as characters.
6366 IT->saved_face_id holds the face id before the display vector--it
6367 is restored into IT->face_id in set_iterator_to_next. */
6370 next_element_from_display_vector (struct it
*it
)
6375 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
6377 it
->face_id
= it
->saved_face_id
;
6379 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
6380 That seemed totally bogus - so I changed it... */
6381 gc
= it
->dpvec
[it
->current
.dpvec_index
];
6383 if (GLYPH_CODE_P (gc
) && GLYPH_CODE_CHAR_VALID_P (gc
))
6385 it
->c
= GLYPH_CODE_CHAR (gc
);
6386 it
->len
= CHAR_BYTES (it
->c
);
6388 /* The entry may contain a face id to use. Such a face id is
6389 the id of a Lisp face, not a realized face. A face id of
6390 zero means no face is specified. */
6391 if (it
->dpvec_face_id
>= 0)
6392 it
->face_id
= it
->dpvec_face_id
;
6395 int lface_id
= GLYPH_CODE_FACE (gc
);
6397 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6402 /* Display table entry is invalid. Return a space. */
6403 it
->c
= ' ', it
->len
= 1;
6405 /* Don't change position and object of the iterator here. They are
6406 still the values of the character that had this display table
6407 entry or was translated, and that's what we want. */
6408 it
->what
= IT_CHARACTER
;
6413 /* Load IT with the next display element from Lisp string IT->string.
6414 IT->current.string_pos is the current position within the string.
6415 If IT->current.overlay_string_index >= 0, the Lisp string is an
6419 next_element_from_string (struct it
*it
)
6421 struct text_pos position
;
6423 xassert (STRINGP (it
->string
));
6424 xassert (IT_STRING_CHARPOS (*it
) >= 0);
6425 position
= it
->current
.string_pos
;
6427 /* Time to check for invisible text? */
6428 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
6429 && IT_STRING_CHARPOS (*it
) == it
->stop_charpos
)
6433 /* Since a handler may have changed IT->method, we must
6435 return GET_NEXT_DISPLAY_ELEMENT (it
);
6438 if (it
->current
.overlay_string_index
>= 0)
6440 /* Get the next character from an overlay string. In overlay
6441 strings, There is no field width or padding with spaces to
6443 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6448 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6449 IT_STRING_BYTEPOS (*it
), SCHARS (it
->string
))
6450 && next_element_from_composition (it
))
6454 else if (STRING_MULTIBYTE (it
->string
))
6456 const unsigned char *s
= (SDATA (it
->string
)
6457 + IT_STRING_BYTEPOS (*it
));
6458 it
->c
= string_char_and_length (s
, &it
->len
);
6462 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6468 /* Get the next character from a Lisp string that is not an
6469 overlay string. Such strings come from the mode line, for
6470 example. We may have to pad with spaces, or truncate the
6471 string. See also next_element_from_c_string. */
6472 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
6477 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
6479 /* Pad with spaces. */
6480 it
->c
= ' ', it
->len
= 1;
6481 CHARPOS (position
) = BYTEPOS (position
) = -1;
6483 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6484 IT_STRING_BYTEPOS (*it
), it
->string_nchars
)
6485 && next_element_from_composition (it
))
6489 else if (STRING_MULTIBYTE (it
->string
))
6491 const unsigned char *s
= (SDATA (it
->string
)
6492 + IT_STRING_BYTEPOS (*it
));
6493 it
->c
= string_char_and_length (s
, &it
->len
);
6497 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6502 /* Record what we have and where it came from. */
6503 it
->what
= IT_CHARACTER
;
6504 it
->object
= it
->string
;
6505 it
->position
= position
;
6510 /* Load IT with next display element from C string IT->s.
6511 IT->string_nchars is the maximum number of characters to return
6512 from the string. IT->end_charpos may be greater than
6513 IT->string_nchars when this function is called, in which case we
6514 may have to return padding spaces. Value is zero if end of string
6515 reached, including padding spaces. */
6518 next_element_from_c_string (struct it
*it
)
6523 it
->what
= IT_CHARACTER
;
6524 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
6527 /* IT's position can be greater IT->string_nchars in case a field
6528 width or precision has been specified when the iterator was
6530 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6532 /* End of the game. */
6536 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
6538 /* Pad with spaces. */
6539 it
->c
= ' ', it
->len
= 1;
6540 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
6542 else if (it
->multibyte_p
)
6543 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
6545 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
6551 /* Set up IT to return characters from an ellipsis, if appropriate.
6552 The definition of the ellipsis glyphs may come from a display table
6553 entry. This function fills IT with the first glyph from the
6554 ellipsis if an ellipsis is to be displayed. */
6557 next_element_from_ellipsis (struct it
*it
)
6559 if (it
->selective_display_ellipsis_p
)
6560 setup_for_ellipsis (it
, it
->len
);
6563 /* The face at the current position may be different from the
6564 face we find after the invisible text. Remember what it
6565 was in IT->saved_face_id, and signal that it's there by
6566 setting face_before_selective_p. */
6567 it
->saved_face_id
= it
->face_id
;
6568 it
->method
= GET_FROM_BUFFER
;
6569 it
->object
= it
->w
->buffer
;
6570 reseat_at_next_visible_line_start (it
, 1);
6571 it
->face_before_selective_p
= 1;
6574 return GET_NEXT_DISPLAY_ELEMENT (it
);
6578 /* Deliver an image display element. The iterator IT is already
6579 filled with image information (done in handle_display_prop). Value
6584 next_element_from_image (struct it
*it
)
6586 it
->what
= IT_IMAGE
;
6587 it
->ignore_overlay_strings_at_pos_p
= 0;
6592 /* Fill iterator IT with next display element from a stretch glyph
6593 property. IT->object is the value of the text property. Value is
6597 next_element_from_stretch (struct it
*it
)
6599 it
->what
= IT_STRETCH
;
6603 /* Scan forward from CHARPOS in the current buffer, until we find a
6604 stop position > current IT's position. Then handle the stop
6605 position before that. This is called when we bump into a stop
6606 position while reordering bidirectional text. CHARPOS should be
6607 the last previously processed stop_pos (or BEGV, if none were
6608 processed yet) whose position is less that IT's current
6612 handle_stop_backwards (struct it
*it
, EMACS_INT charpos
)
6614 EMACS_INT where_we_are
= IT_CHARPOS (*it
);
6615 struct display_pos save_current
= it
->current
;
6616 struct text_pos save_position
= it
->position
;
6617 struct text_pos pos1
;
6618 EMACS_INT next_stop
;
6620 /* Scan in strict logical order. */
6624 it
->prev_stop
= charpos
;
6625 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
6626 reseat_1 (it
, pos1
, 0);
6627 compute_stop_pos (it
);
6628 /* We must advance forward, right? */
6629 if (it
->stop_charpos
<= it
->prev_stop
)
6631 charpos
= it
->stop_charpos
;
6633 while (charpos
<= where_we_are
);
6635 next_stop
= it
->stop_charpos
;
6636 it
->stop_charpos
= it
->prev_stop
;
6638 it
->current
= save_current
;
6639 it
->position
= save_position
;
6641 it
->stop_charpos
= next_stop
;
6644 /* Load IT with the next display element from current_buffer. Value
6645 is zero if end of buffer reached. IT->stop_charpos is the next
6646 position at which to stop and check for text properties or buffer
6650 next_element_from_buffer (struct it
*it
)
6654 xassert (IT_CHARPOS (*it
) >= BEGV
);
6656 /* With bidi reordering, the character to display might not be the
6657 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
6658 we were reseat()ed to a new buffer position, which is potentially
6659 a different paragraph. */
6660 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
6662 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6663 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6664 if (it
->bidi_it
.bytepos
== ZV_BYTE
)
6666 /* Nothing to do, but reset the FIRST_ELT flag, like
6667 bidi_paragraph_init does, because we are not going to
6669 it
->bidi_it
.first_elt
= 0;
6671 else if (it
->bidi_it
.bytepos
== BEGV_BYTE
6672 /* FIXME: Should support all Unicode line separators. */
6673 || FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
6674 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')
6676 /* If we are at the beginning of a line, we can produce the
6677 next element right away. */
6678 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6679 bidi_move_to_visually_next (&it
->bidi_it
);
6683 EMACS_INT orig_bytepos
= IT_BYTEPOS (*it
);
6685 /* We need to prime the bidi iterator starting at the line's
6686 beginning, before we will be able to produce the next
6688 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
), -1);
6689 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
6690 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6691 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6692 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6695 /* Now return to buffer position where we were asked to
6696 get the next display element, and produce that. */
6697 bidi_move_to_visually_next (&it
->bidi_it
);
6699 while (it
->bidi_it
.bytepos
!= orig_bytepos
6700 && it
->bidi_it
.bytepos
< ZV_BYTE
);
6703 it
->bidi_it
.first_elt
= 0; /* paranoia: bidi.c does this */
6704 /* Adjust IT's position information to where we ended up. */
6705 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6706 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6707 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
6709 EMACS_INT stop
= it
->end_charpos
;
6710 if (it
->bidi_it
.scan_dir
< 0)
6712 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6713 IT_BYTEPOS (*it
), stop
, Qnil
);
6717 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
6719 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6721 int overlay_strings_follow_p
;
6723 /* End of the game, except when overlay strings follow that
6724 haven't been returned yet. */
6725 if (it
->overlay_strings_at_end_processed_p
)
6726 overlay_strings_follow_p
= 0;
6729 it
->overlay_strings_at_end_processed_p
= 1;
6730 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
6733 if (overlay_strings_follow_p
)
6734 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6738 it
->position
= it
->current
.pos
;
6742 else if (!(!it
->bidi_p
6743 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6744 || IT_CHARPOS (*it
) == it
->stop_charpos
))
6746 /* With bidi non-linear iteration, we could find ourselves
6747 far beyond the last computed stop_charpos, with several
6748 other stop positions in between that we missed. Scan
6749 them all now, in buffer's logical order, until we find
6750 and handle the last stop_charpos that precedes our
6751 current position. */
6752 handle_stop_backwards (it
, it
->stop_charpos
);
6753 return GET_NEXT_DISPLAY_ELEMENT (it
);
6759 /* Take note of the stop position we just moved across,
6760 for when we will move back across it. */
6761 it
->prev_stop
= it
->stop_charpos
;
6762 /* If we are at base paragraph embedding level, take
6763 note of the last stop position seen at this
6765 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
6766 it
->base_level_stop
= it
->stop_charpos
;
6769 return GET_NEXT_DISPLAY_ELEMENT (it
);
6773 /* We can sometimes back up for reasons that have nothing
6774 to do with bidi reordering. E.g., compositions. The
6775 code below is only needed when we are above the base
6776 embedding level, so test for that explicitly. */
6777 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6778 && IT_CHARPOS (*it
) < it
->prev_stop
)
6780 if (it
->base_level_stop
<= 0)
6781 it
->base_level_stop
= BEGV
;
6782 if (IT_CHARPOS (*it
) < it
->base_level_stop
)
6784 handle_stop_backwards (it
, it
->base_level_stop
);
6785 return GET_NEXT_DISPLAY_ELEMENT (it
);
6789 /* No face changes, overlays etc. in sight, so just return a
6790 character from current_buffer. */
6794 /* Maybe run the redisplay end trigger hook. Performance note:
6795 This doesn't seem to cost measurable time. */
6796 if (it
->redisplay_end_trigger_charpos
6798 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
6799 run_redisplay_end_trigger_hook (it
);
6801 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
6802 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6804 && next_element_from_composition (it
))
6809 /* Get the next character, maybe multibyte. */
6810 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
6811 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
6812 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
6814 it
->c
= *p
, it
->len
= 1;
6816 /* Record what we have and where it came from. */
6817 it
->what
= IT_CHARACTER
;
6818 it
->object
= it
->w
->buffer
;
6819 it
->position
= it
->current
.pos
;
6821 /* Normally we return the character found above, except when we
6822 really want to return an ellipsis for selective display. */
6827 /* A value of selective > 0 means hide lines indented more
6828 than that number of columns. */
6829 if (it
->selective
> 0
6830 && IT_CHARPOS (*it
) + 1 < ZV
6831 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
6832 IT_BYTEPOS (*it
) + 1,
6833 (double) it
->selective
)) /* iftc */
6835 success_p
= next_element_from_ellipsis (it
);
6836 it
->dpvec_char_len
= -1;
6839 else if (it
->c
== '\r' && it
->selective
== -1)
6841 /* A value of selective == -1 means that everything from the
6842 CR to the end of the line is invisible, with maybe an
6843 ellipsis displayed for it. */
6844 success_p
= next_element_from_ellipsis (it
);
6845 it
->dpvec_char_len
= -1;
6850 /* Value is zero if end of buffer reached. */
6851 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
6856 /* Run the redisplay end trigger hook for IT. */
6859 run_redisplay_end_trigger_hook (struct it
*it
)
6861 Lisp_Object args
[3];
6863 /* IT->glyph_row should be non-null, i.e. we should be actually
6864 displaying something, or otherwise we should not run the hook. */
6865 xassert (it
->glyph_row
);
6867 /* Set up hook arguments. */
6868 args
[0] = Qredisplay_end_trigger_functions
;
6869 args
[1] = it
->window
;
6870 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
6871 it
->redisplay_end_trigger_charpos
= 0;
6873 /* Since we are *trying* to run these functions, don't try to run
6874 them again, even if they get an error. */
6875 it
->w
->redisplay_end_trigger
= Qnil
;
6876 Frun_hook_with_args (3, args
);
6878 /* Notice if it changed the face of the character we are on. */
6879 handle_face_prop (it
);
6883 /* Deliver a composition display element. Unlike the other
6884 next_element_from_XXX, this function is not registered in the array
6885 get_next_element[]. It is called from next_element_from_buffer and
6886 next_element_from_string when necessary. */
6889 next_element_from_composition (struct it
*it
)
6891 it
->what
= IT_COMPOSITION
;
6892 it
->len
= it
->cmp_it
.nbytes
;
6893 if (STRINGP (it
->string
))
6897 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6898 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6901 it
->position
= it
->current
.string_pos
;
6902 it
->object
= it
->string
;
6903 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
6904 IT_STRING_BYTEPOS (*it
), it
->string
);
6910 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6911 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6914 if (it
->bidi_it
.new_paragraph
)
6915 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6916 /* Resync the bidi iterator with IT's new position.
6917 FIXME: this doesn't support bidirectional text. */
6918 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
6919 bidi_move_to_visually_next (&it
->bidi_it
);
6923 it
->position
= it
->current
.pos
;
6924 it
->object
= it
->w
->buffer
;
6925 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
6926 IT_BYTEPOS (*it
), Qnil
);
6933 /***********************************************************************
6934 Moving an iterator without producing glyphs
6935 ***********************************************************************/
6937 /* Check if iterator is at a position corresponding to a valid buffer
6938 position after some move_it_ call. */
6940 #define IT_POS_VALID_AFTER_MOVE_P(it) \
6941 ((it)->method == GET_FROM_STRING \
6942 ? IT_STRING_CHARPOS (*it) == 0 \
6946 /* Move iterator IT to a specified buffer or X position within one
6947 line on the display without producing glyphs.
6949 OP should be a bit mask including some or all of these bits:
6950 MOVE_TO_X: Stop upon reaching x-position TO_X.
6951 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
6952 Regardless of OP's value, stop upon reaching the end of the display line.
6954 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
6955 This means, in particular, that TO_X includes window's horizontal
6958 The return value has several possible values that
6959 say what condition caused the scan to stop:
6961 MOVE_POS_MATCH_OR_ZV
6962 - when TO_POS or ZV was reached.
6965 -when TO_X was reached before TO_POS or ZV were reached.
6968 - when we reached the end of the display area and the line must
6972 - when we reached the end of the display area and the line is
6976 - when we stopped at a line end, i.e. a newline or a CR and selective
6979 static enum move_it_result
6980 move_it_in_display_line_to (struct it
*it
,
6981 EMACS_INT to_charpos
, int to_x
,
6982 enum move_operation_enum op
)
6984 enum move_it_result result
= MOVE_UNDEFINED
;
6985 struct glyph_row
*saved_glyph_row
;
6986 struct it wrap_it
, atpos_it
, atx_it
;
6988 enum it_method prev_method
= it
->method
;
6989 EMACS_INT prev_pos
= IT_CHARPOS (*it
);
6991 /* Don't produce glyphs in produce_glyphs. */
6992 saved_glyph_row
= it
->glyph_row
;
6993 it
->glyph_row
= NULL
;
6995 /* Use wrap_it to save a copy of IT wherever a word wrap could
6996 occur. Use atpos_it to save a copy of IT at the desired buffer
6997 position, if found, so that we can scan ahead and check if the
6998 word later overshoots the window edge. Use atx_it similarly, for
7004 #define BUFFER_POS_REACHED_P() \
7005 ((op & MOVE_TO_POS) != 0 \
7006 && BUFFERP (it->object) \
7007 && (IT_CHARPOS (*it) == to_charpos \
7008 || (!it->bidi_p && IT_CHARPOS (*it) > to_charpos)) \
7009 && (it->method == GET_FROM_BUFFER \
7010 || (it->method == GET_FROM_DISPLAY_VECTOR \
7011 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
7013 /* If there's a line-/wrap-prefix, handle it. */
7014 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
7015 && it
->current_y
< it
->last_visible_y
)
7016 handle_line_prefix (it
);
7020 int x
, i
, ascent
= 0, descent
= 0;
7022 /* Utility macro to reset an iterator with x, ascent, and descent. */
7023 #define IT_RESET_X_ASCENT_DESCENT(IT) \
7024 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
7025 (IT)->max_descent = descent)
7027 /* Stop if we move beyond TO_CHARPOS (after an image or stretch
7029 if ((op
& MOVE_TO_POS
) != 0
7030 && BUFFERP (it
->object
)
7031 && it
->method
== GET_FROM_BUFFER
7032 && ((!it
->bidi_p
&& IT_CHARPOS (*it
) > to_charpos
)
7034 && (prev_method
== GET_FROM_IMAGE
7035 || prev_method
== GET_FROM_STRETCH
)
7036 /* Passed TO_CHARPOS from left to right. */
7037 && ((prev_pos
< to_charpos
7038 && IT_CHARPOS (*it
) > to_charpos
)
7039 /* Passed TO_CHARPOS from right to left. */
7040 || (prev_pos
> to_charpos
7041 && IT_CHARPOS (*it
) < to_charpos
)))))
7043 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7045 result
= MOVE_POS_MATCH_OR_ZV
;
7048 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7049 /* If wrap_it is valid, the current position might be in a
7050 word that is wrapped. So, save the iterator in
7051 atpos_it and continue to see if wrapping happens. */
7055 prev_method
= it
->method
;
7056 if (it
->method
== GET_FROM_BUFFER
)
7057 prev_pos
= IT_CHARPOS (*it
);
7058 /* Stop when ZV reached.
7059 We used to stop here when TO_CHARPOS reached as well, but that is
7060 too soon if this glyph does not fit on this line. So we handle it
7061 explicitly below. */
7062 if (!get_next_display_element (it
))
7064 result
= MOVE_POS_MATCH_OR_ZV
;
7068 if (it
->line_wrap
== TRUNCATE
)
7070 if (BUFFER_POS_REACHED_P ())
7072 result
= MOVE_POS_MATCH_OR_ZV
;
7078 if (it
->line_wrap
== WORD_WRAP
)
7080 if (IT_DISPLAYING_WHITESPACE (it
))
7084 /* We have reached a glyph that follows one or more
7085 whitespace characters. If the position is
7086 already found, we are done. */
7087 if (atpos_it
.sp
>= 0)
7090 result
= MOVE_POS_MATCH_OR_ZV
;
7096 result
= MOVE_X_REACHED
;
7099 /* Otherwise, we can wrap here. */
7106 /* Remember the line height for the current line, in case
7107 the next element doesn't fit on the line. */
7108 ascent
= it
->max_ascent
;
7109 descent
= it
->max_descent
;
7111 /* The call to produce_glyphs will get the metrics of the
7112 display element IT is loaded with. Record the x-position
7113 before this display element, in case it doesn't fit on the
7117 PRODUCE_GLYPHS (it
);
7119 if (it
->area
!= TEXT_AREA
)
7121 set_iterator_to_next (it
, 1);
7125 /* The number of glyphs we get back in IT->nglyphs will normally
7126 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
7127 character on a terminal frame, or (iii) a line end. For the
7128 second case, IT->nglyphs - 1 padding glyphs will be present.
7129 (On X frames, there is only one glyph produced for a
7130 composite character.)
7132 The behavior implemented below means, for continuation lines,
7133 that as many spaces of a TAB as fit on the current line are
7134 displayed there. For terminal frames, as many glyphs of a
7135 multi-glyph character are displayed in the current line, too.
7136 This is what the old redisplay code did, and we keep it that
7137 way. Under X, the whole shape of a complex character must
7138 fit on the line or it will be completely displayed in the
7141 Note that both for tabs and padding glyphs, all glyphs have
7145 /* More than one glyph or glyph doesn't fit on line. All
7146 glyphs have the same width. */
7147 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
7149 int x_before_this_char
= x
;
7150 int hpos_before_this_char
= it
->hpos
;
7152 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
7154 new_x
= x
+ single_glyph_width
;
7156 /* We want to leave anything reaching TO_X to the caller. */
7157 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
7159 if (BUFFER_POS_REACHED_P ())
7161 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7162 goto buffer_pos_reached
;
7163 if (atpos_it
.sp
< 0)
7166 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7171 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7174 result
= MOVE_X_REACHED
;
7180 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
7185 if (/* Lines are continued. */
7186 it
->line_wrap
!= TRUNCATE
7187 && (/* And glyph doesn't fit on the line. */
7188 new_x
> it
->last_visible_x
7189 /* Or it fits exactly and we're on a window
7191 || (new_x
== it
->last_visible_x
7192 && FRAME_WINDOW_P (it
->f
))))
7194 if (/* IT->hpos == 0 means the very first glyph
7195 doesn't fit on the line, e.g. a wide image. */
7197 || (new_x
== it
->last_visible_x
7198 && FRAME_WINDOW_P (it
->f
)))
7201 it
->current_x
= new_x
;
7203 /* The character's last glyph just barely fits
7205 if (i
== it
->nglyphs
- 1)
7207 /* If this is the destination position,
7208 return a position *before* it in this row,
7209 now that we know it fits in this row. */
7210 if (BUFFER_POS_REACHED_P ())
7212 if (it
->line_wrap
!= WORD_WRAP
7215 it
->hpos
= hpos_before_this_char
;
7216 it
->current_x
= x_before_this_char
;
7217 result
= MOVE_POS_MATCH_OR_ZV
;
7220 if (it
->line_wrap
== WORD_WRAP
7224 atpos_it
.current_x
= x_before_this_char
;
7225 atpos_it
.hpos
= hpos_before_this_char
;
7229 set_iterator_to_next (it
, 1);
7230 /* On graphical terminals, newlines may
7231 "overflow" into the fringe if
7232 overflow-newline-into-fringe is non-nil.
7233 On text-only terminals, newlines may
7234 overflow into the last glyph on the
7236 if (!FRAME_WINDOW_P (it
->f
)
7237 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7239 if (!get_next_display_element (it
))
7241 result
= MOVE_POS_MATCH_OR_ZV
;
7244 if (BUFFER_POS_REACHED_P ())
7246 if (ITERATOR_AT_END_OF_LINE_P (it
))
7247 result
= MOVE_POS_MATCH_OR_ZV
;
7249 result
= MOVE_LINE_CONTINUED
;
7252 if (ITERATOR_AT_END_OF_LINE_P (it
))
7254 result
= MOVE_NEWLINE_OR_CR
;
7261 IT_RESET_X_ASCENT_DESCENT (it
);
7263 if (wrap_it
.sp
>= 0)
7270 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
7272 result
= MOVE_LINE_CONTINUED
;
7276 if (BUFFER_POS_REACHED_P ())
7278 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7279 goto buffer_pos_reached
;
7280 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7283 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7287 if (new_x
> it
->first_visible_x
)
7289 /* Glyph is visible. Increment number of glyphs that
7290 would be displayed. */
7295 if (result
!= MOVE_UNDEFINED
)
7298 else if (BUFFER_POS_REACHED_P ())
7301 IT_RESET_X_ASCENT_DESCENT (it
);
7302 result
= MOVE_POS_MATCH_OR_ZV
;
7305 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
7307 /* Stop when TO_X specified and reached. This check is
7308 necessary here because of lines consisting of a line end,
7309 only. The line end will not produce any glyphs and we
7310 would never get MOVE_X_REACHED. */
7311 xassert (it
->nglyphs
== 0);
7312 result
= MOVE_X_REACHED
;
7316 /* Is this a line end? If yes, we're done. */
7317 if (ITERATOR_AT_END_OF_LINE_P (it
))
7319 result
= MOVE_NEWLINE_OR_CR
;
7323 if (it
->method
== GET_FROM_BUFFER
)
7324 prev_pos
= IT_CHARPOS (*it
);
7325 /* The current display element has been consumed. Advance
7327 set_iterator_to_next (it
, 1);
7329 /* Stop if lines are truncated and IT's current x-position is
7330 past the right edge of the window now. */
7331 if (it
->line_wrap
== TRUNCATE
7332 && it
->current_x
>= it
->last_visible_x
)
7334 if (!FRAME_WINDOW_P (it
->f
)
7335 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7337 if (!get_next_display_element (it
)
7338 || BUFFER_POS_REACHED_P ())
7340 result
= MOVE_POS_MATCH_OR_ZV
;
7343 if (ITERATOR_AT_END_OF_LINE_P (it
))
7345 result
= MOVE_NEWLINE_OR_CR
;
7349 result
= MOVE_LINE_TRUNCATED
;
7352 #undef IT_RESET_X_ASCENT_DESCENT
7355 #undef BUFFER_POS_REACHED_P
7357 /* If we scanned beyond to_pos and didn't find a point to wrap at,
7358 restore the saved iterator. */
7359 if (atpos_it
.sp
>= 0)
7361 else if (atx_it
.sp
>= 0)
7366 /* Restore the iterator settings altered at the beginning of this
7368 it
->glyph_row
= saved_glyph_row
;
7372 /* For external use. */
7374 move_it_in_display_line (struct it
*it
,
7375 EMACS_INT to_charpos
, int to_x
,
7376 enum move_operation_enum op
)
7378 if (it
->line_wrap
== WORD_WRAP
7379 && (op
& MOVE_TO_X
))
7381 struct it save_it
= *it
;
7382 int skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7383 /* When word-wrap is on, TO_X may lie past the end
7384 of a wrapped line. Then it->current is the
7385 character on the next line, so backtrack to the
7386 space before the wrap point. */
7387 if (skip
== MOVE_LINE_CONTINUED
)
7389 int prev_x
= max (it
->current_x
- 1, 0);
7391 move_it_in_display_line_to
7392 (it
, -1, prev_x
, MOVE_TO_X
);
7396 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7400 /* Move IT forward until it satisfies one or more of the criteria in
7401 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
7403 OP is a bit-mask that specifies where to stop, and in particular,
7404 which of those four position arguments makes a difference. See the
7405 description of enum move_operation_enum.
7407 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
7408 screen line, this function will set IT to the next position >
7412 move_it_to (struct it
*it
, EMACS_INT to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
7414 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
7415 int line_height
, line_start_x
= 0, reached
= 0;
7419 if (op
& MOVE_TO_VPOS
)
7421 /* If no TO_CHARPOS and no TO_X specified, stop at the
7422 start of the line TO_VPOS. */
7423 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
7425 if (it
->vpos
== to_vpos
)
7431 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
7435 /* TO_VPOS >= 0 means stop at TO_X in the line at
7436 TO_VPOS, or at TO_POS, whichever comes first. */
7437 if (it
->vpos
== to_vpos
)
7443 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7445 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
7450 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
7452 /* We have reached TO_X but not in the line we want. */
7453 skip
= move_it_in_display_line_to (it
, to_charpos
,
7455 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7463 else if (op
& MOVE_TO_Y
)
7465 struct it it_backup
;
7467 if (it
->line_wrap
== WORD_WRAP
)
7470 /* TO_Y specified means stop at TO_X in the line containing
7471 TO_Y---or at TO_CHARPOS if this is reached first. The
7472 problem is that we can't really tell whether the line
7473 contains TO_Y before we have completely scanned it, and
7474 this may skip past TO_X. What we do is to first scan to
7477 If TO_X is not specified, use a TO_X of zero. The reason
7478 is to make the outcome of this function more predictable.
7479 If we didn't use TO_X == 0, we would stop at the end of
7480 the line which is probably not what a caller would expect
7482 skip
= move_it_in_display_line_to
7483 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
7484 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
7486 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
7487 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7489 else if (skip
== MOVE_X_REACHED
)
7491 /* If TO_X was reached, we want to know whether TO_Y is
7492 in the line. We know this is the case if the already
7493 scanned glyphs make the line tall enough. Otherwise,
7494 we must check by scanning the rest of the line. */
7495 line_height
= it
->max_ascent
+ it
->max_descent
;
7496 if (to_y
>= it
->current_y
7497 && to_y
< it
->current_y
+ line_height
)
7503 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
7504 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
7506 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
7507 line_height
= it
->max_ascent
+ it
->max_descent
;
7508 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7510 if (to_y
>= it
->current_y
7511 && to_y
< it
->current_y
+ line_height
)
7513 /* If TO_Y is in this line and TO_X was reached
7514 above, we scanned too far. We have to restore
7515 IT's settings to the ones before skipping. */
7522 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7528 /* Check whether TO_Y is in this line. */
7529 line_height
= it
->max_ascent
+ it
->max_descent
;
7530 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7532 if (to_y
>= it
->current_y
7533 && to_y
< it
->current_y
+ line_height
)
7535 /* When word-wrap is on, TO_X may lie past the end
7536 of a wrapped line. Then it->current is the
7537 character on the next line, so backtrack to the
7538 space before the wrap point. */
7539 if (skip
== MOVE_LINE_CONTINUED
7540 && it
->line_wrap
== WORD_WRAP
)
7542 int prev_x
= max (it
->current_x
- 1, 0);
7544 skip
= move_it_in_display_line_to
7545 (it
, -1, prev_x
, MOVE_TO_X
);
7554 else if (BUFFERP (it
->object
)
7555 && (it
->method
== GET_FROM_BUFFER
7556 || it
->method
== GET_FROM_STRETCH
)
7557 && IT_CHARPOS (*it
) >= to_charpos
)
7558 skip
= MOVE_POS_MATCH_OR_ZV
;
7560 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
7564 case MOVE_POS_MATCH_OR_ZV
:
7568 case MOVE_NEWLINE_OR_CR
:
7569 set_iterator_to_next (it
, 1);
7570 it
->continuation_lines_width
= 0;
7573 case MOVE_LINE_TRUNCATED
:
7574 it
->continuation_lines_width
= 0;
7575 reseat_at_next_visible_line_start (it
, 0);
7576 if ((op
& MOVE_TO_POS
) != 0
7577 && IT_CHARPOS (*it
) > to_charpos
)
7584 case MOVE_LINE_CONTINUED
:
7585 /* For continued lines ending in a tab, some of the glyphs
7586 associated with the tab are displayed on the current
7587 line. Since it->current_x does not include these glyphs,
7588 we use it->last_visible_x instead. */
7591 it
->continuation_lines_width
+= it
->last_visible_x
;
7592 /* When moving by vpos, ensure that the iterator really
7593 advances to the next line (bug#847, bug#969). Fixme:
7594 do we need to do this in other circumstances? */
7595 if (it
->current_x
!= it
->last_visible_x
7596 && (op
& MOVE_TO_VPOS
)
7597 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
7599 line_start_x
= it
->current_x
+ it
->pixel_width
7600 - it
->last_visible_x
;
7601 set_iterator_to_next (it
, 0);
7605 it
->continuation_lines_width
+= it
->current_x
;
7612 /* Reset/increment for the next run. */
7613 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
7614 it
->current_x
= line_start_x
;
7617 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7619 last_height
= it
->max_ascent
+ it
->max_descent
;
7620 last_max_ascent
= it
->max_ascent
;
7621 it
->max_ascent
= it
->max_descent
= 0;
7626 /* On text terminals, we may stop at the end of a line in the middle
7627 of a multi-character glyph. If the glyph itself is continued,
7628 i.e. it is actually displayed on the next line, don't treat this
7629 stopping point as valid; move to the next line instead (unless
7630 that brings us offscreen). */
7631 if (!FRAME_WINDOW_P (it
->f
)
7633 && IT_CHARPOS (*it
) == to_charpos
7634 && it
->what
== IT_CHARACTER
7636 && it
->line_wrap
== WINDOW_WRAP
7637 && it
->current_x
== it
->last_visible_x
- 1
7640 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
7642 it
->continuation_lines_width
+= it
->current_x
;
7643 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
7644 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7646 last_height
= it
->max_ascent
+ it
->max_descent
;
7647 last_max_ascent
= it
->max_ascent
;
7650 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
7654 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
7656 If DY > 0, move IT backward at least that many pixels. DY = 0
7657 means move IT backward to the preceding line start or BEGV. This
7658 function may move over more than DY pixels if IT->current_y - DY
7659 ends up in the middle of a line; in this case IT->current_y will be
7660 set to the top of the line moved to. */
7663 move_it_vertically_backward (struct it
*it
, int dy
)
7667 EMACS_INT start_pos
;
7672 start_pos
= IT_CHARPOS (*it
);
7674 /* Estimate how many newlines we must move back. */
7675 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
7677 /* Set the iterator's position that many lines back. */
7678 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
7679 back_to_previous_visible_line_start (it
);
7681 /* Reseat the iterator here. When moving backward, we don't want
7682 reseat to skip forward over invisible text, set up the iterator
7683 to deliver from overlay strings at the new position etc. So,
7684 use reseat_1 here. */
7685 reseat_1 (it
, it
->current
.pos
, 1);
7687 /* We are now surely at a line start. */
7688 it
->current_x
= it
->hpos
= 0;
7689 it
->continuation_lines_width
= 0;
7691 /* Move forward and see what y-distance we moved. First move to the
7692 start of the next line so that we get its height. We need this
7693 height to be able to tell whether we reached the specified
7696 it2
.max_ascent
= it2
.max_descent
= 0;
7699 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
7700 MOVE_TO_POS
| MOVE_TO_VPOS
);
7702 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
7703 xassert (IT_CHARPOS (*it
) >= BEGV
);
7706 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
7707 xassert (IT_CHARPOS (*it
) >= BEGV
);
7708 /* H is the actual vertical distance from the position in *IT
7709 and the starting position. */
7710 h
= it2
.current_y
- it
->current_y
;
7711 /* NLINES is the distance in number of lines. */
7712 nlines
= it2
.vpos
- it
->vpos
;
7714 /* Correct IT's y and vpos position
7715 so that they are relative to the starting point. */
7721 /* DY == 0 means move to the start of the screen line. The
7722 value of nlines is > 0 if continuation lines were involved. */
7724 move_it_by_lines (it
, nlines
, 1);
7728 /* The y-position we try to reach, relative to *IT.
7729 Note that H has been subtracted in front of the if-statement. */
7730 int target_y
= it
->current_y
+ h
- dy
;
7731 int y0
= it3
.current_y
;
7732 int y1
= line_bottom_y (&it3
);
7733 int line_height
= y1
- y0
;
7735 /* If we did not reach target_y, try to move further backward if
7736 we can. If we moved too far backward, try to move forward. */
7737 if (target_y
< it
->current_y
7738 /* This is heuristic. In a window that's 3 lines high, with
7739 a line height of 13 pixels each, recentering with point
7740 on the bottom line will try to move -39/2 = 19 pixels
7741 backward. Try to avoid moving into the first line. */
7742 && (it
->current_y
- target_y
7743 > min (window_box_height (it
->w
), line_height
* 2 / 3))
7744 && IT_CHARPOS (*it
) > BEGV
)
7746 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
7747 target_y
- it
->current_y
));
7748 dy
= it
->current_y
- target_y
;
7749 goto move_further_back
;
7751 else if (target_y
>= it
->current_y
+ line_height
7752 && IT_CHARPOS (*it
) < ZV
)
7754 /* Should move forward by at least one line, maybe more.
7756 Note: Calling move_it_by_lines can be expensive on
7757 terminal frames, where compute_motion is used (via
7758 vmotion) to do the job, when there are very long lines
7759 and truncate-lines is nil. That's the reason for
7760 treating terminal frames specially here. */
7762 if (!FRAME_WINDOW_P (it
->f
))
7763 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
7768 move_it_by_lines (it
, 1, 1);
7770 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
7777 /* Move IT by a specified amount of pixel lines DY. DY negative means
7778 move backwards. DY = 0 means move to start of screen line. At the
7779 end, IT will be on the start of a screen line. */
7782 move_it_vertically (struct it
*it
, int dy
)
7785 move_it_vertically_backward (it
, -dy
);
7788 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
7789 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
7790 MOVE_TO_POS
| MOVE_TO_Y
);
7791 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
7793 /* If buffer ends in ZV without a newline, move to the start of
7794 the line to satisfy the post-condition. */
7795 if (IT_CHARPOS (*it
) == ZV
7797 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
7798 move_it_by_lines (it
, 0, 0);
7803 /* Move iterator IT past the end of the text line it is in. */
7806 move_it_past_eol (struct it
*it
)
7808 enum move_it_result rc
;
7810 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
7811 if (rc
== MOVE_NEWLINE_OR_CR
)
7812 set_iterator_to_next (it
, 0);
7816 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
7817 negative means move up. DVPOS == 0 means move to the start of the
7818 screen line. NEED_Y_P non-zero means calculate IT->current_y. If
7819 NEED_Y_P is zero, IT->current_y will be left unchanged.
7821 Further optimization ideas: If we would know that IT->f doesn't use
7822 a face with proportional font, we could be faster for
7823 truncate-lines nil. */
7826 move_it_by_lines (struct it
*it
, int dvpos
, int need_y_p
)
7829 /* The commented-out optimization uses vmotion on terminals. This
7830 gives bad results, because elements like it->what, on which
7831 callers such as pos_visible_p rely, aren't updated. */
7832 /* struct position pos;
7833 if (!FRAME_WINDOW_P (it->f))
7835 struct text_pos textpos;
7837 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
7838 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
7839 reseat (it, textpos, 1);
7840 it->vpos += pos.vpos;
7841 it->current_y += pos.vpos;
7847 /* DVPOS == 0 means move to the start of the screen line. */
7848 move_it_vertically_backward (it
, 0);
7849 xassert (it
->current_x
== 0 && it
->hpos
== 0);
7850 /* Let next call to line_bottom_y calculate real line height */
7855 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
7856 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
7857 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
7862 EMACS_INT start_charpos
, i
;
7864 /* Start at the beginning of the screen line containing IT's
7865 position. This may actually move vertically backwards,
7866 in case of overlays, so adjust dvpos accordingly. */
7868 move_it_vertically_backward (it
, 0);
7871 /* Go back -DVPOS visible lines and reseat the iterator there. */
7872 start_charpos
= IT_CHARPOS (*it
);
7873 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
7874 back_to_previous_visible_line_start (it
);
7875 reseat (it
, it
->current
.pos
, 1);
7877 /* Move further back if we end up in a string or an image. */
7878 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
7880 /* First try to move to start of display line. */
7882 move_it_vertically_backward (it
, 0);
7884 if (IT_POS_VALID_AFTER_MOVE_P (it
))
7886 /* If start of line is still in string or image,
7887 move further back. */
7888 back_to_previous_visible_line_start (it
);
7889 reseat (it
, it
->current
.pos
, 1);
7893 it
->current_x
= it
->hpos
= 0;
7895 /* Above call may have moved too far if continuation lines
7896 are involved. Scan forward and see if it did. */
7898 it2
.vpos
= it2
.current_y
= 0;
7899 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
7900 it
->vpos
-= it2
.vpos
;
7901 it
->current_y
-= it2
.current_y
;
7902 it
->current_x
= it
->hpos
= 0;
7904 /* If we moved too far back, move IT some lines forward. */
7905 if (it2
.vpos
> -dvpos
)
7907 int delta
= it2
.vpos
+ dvpos
;
7909 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
7910 /* Move back again if we got too far ahead. */
7911 if (IT_CHARPOS (*it
) >= start_charpos
)
7917 /* Return 1 if IT points into the middle of a display vector. */
7920 in_display_vector_p (struct it
*it
)
7922 return (it
->method
== GET_FROM_DISPLAY_VECTOR
7923 && it
->current
.dpvec_index
> 0
7924 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
7928 /***********************************************************************
7930 ***********************************************************************/
7933 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
7937 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
7939 Lisp_Object args
[3];
7940 Lisp_Object msg
, fmt
;
7943 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
7946 /* Do nothing if called asynchronously. Inserting text into
7947 a buffer may call after-change-functions and alike and
7948 that would means running Lisp asynchronously. */
7949 if (handling_signal
)
7953 GCPRO4 (fmt
, msg
, arg1
, arg2
);
7955 args
[0] = fmt
= build_string (format
);
7958 msg
= Fformat (3, args
);
7960 len
= SBYTES (msg
) + 1;
7961 SAFE_ALLOCA (buffer
, char *, len
);
7962 memcpy (buffer
, SDATA (msg
), len
);
7964 message_dolog (buffer
, len
- 1, 1, 0);
7971 /* Output a newline in the *Messages* buffer if "needs" one. */
7974 message_log_maybe_newline (void)
7976 if (message_log_need_newline
)
7977 message_dolog ("", 0, 1, 0);
7981 /* Add a string M of length NBYTES to the message log, optionally
7982 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
7983 nonzero, means interpret the contents of M as multibyte. This
7984 function calls low-level routines in order to bypass text property
7985 hooks, etc. which might not be safe to run.
7987 This may GC (insert may run before/after change hooks),
7988 so the buffer M must NOT point to a Lisp string. */
7991 message_dolog (const char *m
, EMACS_INT nbytes
, int nlflag
, int multibyte
)
7993 if (!NILP (Vmemory_full
))
7996 if (!NILP (Vmessage_log_max
))
7998 struct buffer
*oldbuf
;
7999 Lisp_Object oldpoint
, oldbegv
, oldzv
;
8000 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
8001 EMACS_INT point_at_end
= 0;
8002 EMACS_INT zv_at_end
= 0;
8003 Lisp_Object old_deactivate_mark
, tem
;
8004 struct gcpro gcpro1
;
8006 old_deactivate_mark
= Vdeactivate_mark
;
8007 oldbuf
= current_buffer
;
8008 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
8009 current_buffer
->undo_list
= Qt
;
8011 oldpoint
= message_dolog_marker1
;
8012 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
8013 oldbegv
= message_dolog_marker2
;
8014 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
8015 oldzv
= message_dolog_marker3
;
8016 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
8017 GCPRO1 (old_deactivate_mark
);
8025 BEGV_BYTE
= BEG_BYTE
;
8028 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8030 /* Insert the string--maybe converting multibyte to single byte
8031 or vice versa, so that all the text fits the buffer. */
8033 && NILP (current_buffer
->enable_multibyte_characters
))
8037 unsigned char work
[1];
8039 /* Convert a multibyte string to single-byte
8040 for the *Message* buffer. */
8041 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
8043 c
= string_char_and_length (m
+ i
, &char_bytes
);
8044 work
[0] = (ASCII_CHAR_P (c
)
8046 : multibyte_char_to_unibyte (c
, Qnil
));
8047 insert_1_both (work
, 1, 1, 1, 0, 0);
8050 else if (! multibyte
8051 && ! NILP (current_buffer
->enable_multibyte_characters
))
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 EMACS_INT this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
8074 insert_1 ("\n", 1, 1, 0, 0);
8076 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8078 this_bol_byte
= PT_BYTE
;
8080 /* See if this line duplicates the previous one.
8081 If so, combine duplicates. */
8084 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8086 prev_bol_byte
= PT_BYTE
;
8088 dup
= message_log_check_duplicate (prev_bol
, prev_bol_byte
,
8089 this_bol
, this_bol_byte
);
8092 del_range_both (prev_bol
, prev_bol_byte
,
8093 this_bol
, this_bol_byte
, 0);
8099 /* If you change this format, don't forget to also
8100 change message_log_check_duplicate. */
8101 sprintf (dupstr
, " [%d times]", dup
);
8102 duplen
= strlen (dupstr
);
8103 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
8104 insert_1 (dupstr
, duplen
, 1, 0, 1);
8109 /* If we have more than the desired maximum number of lines
8110 in the *Messages* buffer now, delete the oldest ones.
8111 This is safe because we don't have undo in this buffer. */
8113 if (NATNUMP (Vmessage_log_max
))
8115 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
8116 -XFASTINT (Vmessage_log_max
) - 1, 0);
8117 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
8120 BEGV
= XMARKER (oldbegv
)->charpos
;
8121 BEGV_BYTE
= marker_byte_position (oldbegv
);
8130 ZV
= XMARKER (oldzv
)->charpos
;
8131 ZV_BYTE
= marker_byte_position (oldzv
);
8135 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8137 /* We can't do Fgoto_char (oldpoint) because it will run some
8139 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
8140 XMARKER (oldpoint
)->bytepos
);
8143 unchain_marker (XMARKER (oldpoint
));
8144 unchain_marker (XMARKER (oldbegv
));
8145 unchain_marker (XMARKER (oldzv
));
8147 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
8148 set_buffer_internal (oldbuf
);
8150 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
8151 message_log_need_newline
= !nlflag
;
8152 Vdeactivate_mark
= old_deactivate_mark
;
8157 /* We are at the end of the buffer after just having inserted a newline.
8158 (Note: We depend on the fact we won't be crossing the gap.)
8159 Check to see if the most recent message looks a lot like the previous one.
8160 Return 0 if different, 1 if the new one should just replace it, or a
8161 value N > 1 if we should also append " [N times]". */
8164 message_log_check_duplicate (EMACS_INT prev_bol
, EMACS_INT prev_bol_byte
,
8165 EMACS_INT this_bol
, EMACS_INT this_bol_byte
)
8168 EMACS_INT len
= Z_BYTE
- 1 - this_bol_byte
;
8170 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
8171 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
8173 for (i
= 0; i
< len
; i
++)
8175 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
8183 if (*p1
++ == ' ' && *p1
++ == '[')
8186 while (*p1
>= '0' && *p1
<= '9')
8187 n
= n
* 10 + *p1
++ - '0';
8188 if (strncmp (p1
, " times]\n", 8) == 0)
8195 /* Display an echo area message M with a specified length of NBYTES
8196 bytes. The string may include null characters. If M is 0, clear
8197 out any existing message, and let the mini-buffer text show
8200 This may GC, so the buffer M must NOT point to a Lisp string. */
8203 message2 (const char *m
, EMACS_INT nbytes
, int multibyte
)
8205 /* First flush out any partial line written with print. */
8206 message_log_maybe_newline ();
8208 message_dolog (m
, nbytes
, 1, multibyte
);
8209 message2_nolog (m
, nbytes
, multibyte
);
8213 /* The non-logging counterpart of message2. */
8216 message2_nolog (const char *m
, EMACS_INT nbytes
, int multibyte
)
8218 struct frame
*sf
= SELECTED_FRAME ();
8219 message_enable_multibyte
= multibyte
;
8221 if (FRAME_INITIAL_P (sf
))
8223 if (noninteractive_need_newline
)
8224 putc ('\n', stderr
);
8225 noninteractive_need_newline
= 0;
8227 fwrite (m
, nbytes
, 1, stderr
);
8228 if (cursor_in_echo_area
== 0)
8229 fprintf (stderr
, "\n");
8232 /* A null message buffer means that the frame hasn't really been
8233 initialized yet. Error messages get reported properly by
8234 cmd_error, so this must be just an informative message; toss it. */
8235 else if (INTERACTIVE
8236 && sf
->glyphs_initialized_p
8237 && FRAME_MESSAGE_BUF (sf
))
8239 Lisp_Object mini_window
;
8242 /* Get the frame containing the mini-buffer
8243 that the selected frame is using. */
8244 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8245 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8247 FRAME_SAMPLE_VISIBILITY (f
);
8248 if (FRAME_VISIBLE_P (sf
)
8249 && ! FRAME_VISIBLE_P (f
))
8250 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
8254 set_message (m
, Qnil
, nbytes
, multibyte
);
8255 if (minibuffer_auto_raise
)
8256 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8259 clear_message (1, 1);
8261 do_pending_window_change (0);
8262 echo_area_display (1);
8263 do_pending_window_change (0);
8264 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8265 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8270 /* Display an echo area message M with a specified length of NBYTES
8271 bytes. The string may include null characters. If M is not a
8272 string, clear out any existing message, and let the mini-buffer
8275 This function cancels echoing. */
8278 message3 (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
8280 struct gcpro gcpro1
;
8283 clear_message (1,1);
8286 /* First flush out any partial line written with print. */
8287 message_log_maybe_newline ();
8293 SAFE_ALLOCA (buffer
, char *, nbytes
);
8294 memcpy (buffer
, SDATA (m
), nbytes
);
8295 message_dolog (buffer
, nbytes
, 1, multibyte
);
8298 message3_nolog (m
, nbytes
, multibyte
);
8304 /* The non-logging version of message3.
8305 This does not cancel echoing, because it is used for echoing.
8306 Perhaps we need to make a separate function for echoing
8307 and make this cancel echoing. */
8310 message3_nolog (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
8312 struct frame
*sf
= SELECTED_FRAME ();
8313 message_enable_multibyte
= multibyte
;
8315 if (FRAME_INITIAL_P (sf
))
8317 if (noninteractive_need_newline
)
8318 putc ('\n', stderr
);
8319 noninteractive_need_newline
= 0;
8321 fwrite (SDATA (m
), nbytes
, 1, stderr
);
8322 if (cursor_in_echo_area
== 0)
8323 fprintf (stderr
, "\n");
8326 /* A null message buffer means that the frame hasn't really been
8327 initialized yet. Error messages get reported properly by
8328 cmd_error, so this must be just an informative message; toss it. */
8329 else if (INTERACTIVE
8330 && sf
->glyphs_initialized_p
8331 && FRAME_MESSAGE_BUF (sf
))
8333 Lisp_Object mini_window
;
8337 /* Get the frame containing the mini-buffer
8338 that the selected frame is using. */
8339 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8340 frame
= XWINDOW (mini_window
)->frame
;
8343 FRAME_SAMPLE_VISIBILITY (f
);
8344 if (FRAME_VISIBLE_P (sf
)
8345 && !FRAME_VISIBLE_P (f
))
8346 Fmake_frame_visible (frame
);
8348 if (STRINGP (m
) && SCHARS (m
) > 0)
8350 set_message (NULL
, m
, nbytes
, multibyte
);
8351 if (minibuffer_auto_raise
)
8352 Fraise_frame (frame
);
8353 /* Assume we are not echoing.
8354 (If we are, echo_now will override this.) */
8355 echo_message_buffer
= Qnil
;
8358 clear_message (1, 1);
8360 do_pending_window_change (0);
8361 echo_area_display (1);
8362 do_pending_window_change (0);
8363 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8364 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8369 /* Display a null-terminated echo area message M. If M is 0, clear
8370 out any existing message, and let the mini-buffer text show through.
8372 The buffer M must continue to exist until after the echo area gets
8373 cleared or some other message gets displayed there. Do not pass
8374 text that is stored in a Lisp string. Do not pass text in a buffer
8375 that was alloca'd. */
8378 message1 (const char *m
)
8380 message2 (m
, (m
? strlen (m
) : 0), 0);
8384 /* The non-logging counterpart of message1. */
8387 message1_nolog (const char *m
)
8389 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
8392 /* Display a message M which contains a single %s
8393 which gets replaced with STRING. */
8396 message_with_string (const char *m
, Lisp_Object string
, int log
)
8398 CHECK_STRING (string
);
8404 if (noninteractive_need_newline
)
8405 putc ('\n', stderr
);
8406 noninteractive_need_newline
= 0;
8407 fprintf (stderr
, m
, SDATA (string
));
8408 if (!cursor_in_echo_area
)
8409 fprintf (stderr
, "\n");
8413 else if (INTERACTIVE
)
8415 /* The frame whose minibuffer we're going to display the message on.
8416 It may be larger than the selected frame, so we need
8417 to use its buffer, not the selected frame's buffer. */
8418 Lisp_Object mini_window
;
8419 struct frame
*f
, *sf
= SELECTED_FRAME ();
8421 /* Get the frame containing the minibuffer
8422 that the selected frame is using. */
8423 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8424 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8426 /* A null message buffer means that the frame hasn't really been
8427 initialized yet. Error messages get reported properly by
8428 cmd_error, so this must be just an informative message; toss it. */
8429 if (FRAME_MESSAGE_BUF (f
))
8431 Lisp_Object args
[2], message
;
8432 struct gcpro gcpro1
, gcpro2
;
8434 args
[0] = build_string (m
);
8435 args
[1] = message
= string
;
8436 GCPRO2 (args
[0], message
);
8439 message
= Fformat (2, args
);
8442 message3 (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
8444 message3_nolog (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
8448 /* Print should start at the beginning of the message
8449 buffer next time. */
8450 message_buf_print
= 0;
8456 /* Dump an informative message to the minibuf. If M is 0, clear out
8457 any existing message, and let the mini-buffer text show through. */
8460 vmessage (const char *m
, va_list ap
)
8466 if (noninteractive_need_newline
)
8467 putc ('\n', stderr
);
8468 noninteractive_need_newline
= 0;
8469 vfprintf (stderr
, m
, ap
);
8470 if (cursor_in_echo_area
== 0)
8471 fprintf (stderr
, "\n");
8475 else if (INTERACTIVE
)
8477 /* The frame whose mini-buffer we're going to display the message
8478 on. It may be larger than the selected frame, so we need to
8479 use its buffer, not the selected frame's buffer. */
8480 Lisp_Object mini_window
;
8481 struct frame
*f
, *sf
= SELECTED_FRAME ();
8483 /* Get the frame containing the mini-buffer
8484 that the selected frame is using. */
8485 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8486 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8488 /* A null message buffer means that the frame hasn't really been
8489 initialized yet. Error messages get reported properly by
8490 cmd_error, so this must be just an informative message; toss
8492 if (FRAME_MESSAGE_BUF (f
))
8498 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8499 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, ap
);
8501 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
8506 /* Print should start at the beginning of the message
8507 buffer next time. */
8508 message_buf_print
= 0;
8514 message (const char *m
, ...)
8523 /* The non-logging version of message. */
8526 message_nolog (const char *m
, ...)
8528 Lisp_Object old_log_max
;
8531 old_log_max
= Vmessage_log_max
;
8532 Vmessage_log_max
= Qnil
;
8534 Vmessage_log_max
= old_log_max
;
8539 /* Display the current message in the current mini-buffer. This is
8540 only called from error handlers in process.c, and is not time
8544 update_echo_area (void)
8546 if (!NILP (echo_area_buffer
[0]))
8549 string
= Fcurrent_message ();
8550 message3 (string
, SBYTES (string
),
8551 !NILP (current_buffer
->enable_multibyte_characters
));
8556 /* Make sure echo area buffers in `echo_buffers' are live.
8557 If they aren't, make new ones. */
8560 ensure_echo_area_buffers (void)
8564 for (i
= 0; i
< 2; ++i
)
8565 if (!BUFFERP (echo_buffer
[i
])
8566 || NILP (XBUFFER (echo_buffer
[i
])->name
))
8569 Lisp_Object old_buffer
;
8572 old_buffer
= echo_buffer
[i
];
8573 sprintf (name
, " *Echo Area %d*", i
);
8574 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
8575 XBUFFER (echo_buffer
[i
])->truncate_lines
= Qnil
;
8576 /* to force word wrap in echo area -
8577 it was decided to postpone this*/
8578 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
8580 for (j
= 0; j
< 2; ++j
)
8581 if (EQ (old_buffer
, echo_area_buffer
[j
]))
8582 echo_area_buffer
[j
] = echo_buffer
[i
];
8587 /* Call FN with args A1..A4 with either the current or last displayed
8588 echo_area_buffer as current buffer.
8590 WHICH zero means use the current message buffer
8591 echo_area_buffer[0]. If that is nil, choose a suitable buffer
8592 from echo_buffer[] and clear it.
8594 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
8595 suitable buffer from echo_buffer[] and clear it.
8597 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
8598 that the current message becomes the last displayed one, make
8599 choose a suitable buffer for echo_area_buffer[0], and clear it.
8601 Value is what FN returns. */
8604 with_echo_area_buffer (struct window
*w
, int which
,
8605 int (*fn
) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
8606 EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
8609 int this_one
, the_other
, clear_buffer_p
, rc
;
8610 int count
= SPECPDL_INDEX ();
8612 /* If buffers aren't live, make new ones. */
8613 ensure_echo_area_buffers ();
8618 this_one
= 0, the_other
= 1;
8620 this_one
= 1, the_other
= 0;
8623 this_one
= 0, the_other
= 1;
8626 /* We need a fresh one in case the current echo buffer equals
8627 the one containing the last displayed echo area message. */
8628 if (!NILP (echo_area_buffer
[this_one
])
8629 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
8630 echo_area_buffer
[this_one
] = Qnil
;
8633 /* Choose a suitable buffer from echo_buffer[] is we don't
8635 if (NILP (echo_area_buffer
[this_one
]))
8637 echo_area_buffer
[this_one
]
8638 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
8639 ? echo_buffer
[the_other
]
8640 : echo_buffer
[this_one
]);
8644 buffer
= echo_area_buffer
[this_one
];
8646 /* Don't get confused by reusing the buffer used for echoing
8647 for a different purpose. */
8648 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
8651 record_unwind_protect (unwind_with_echo_area_buffer
,
8652 with_echo_area_buffer_unwind_data (w
));
8654 /* Make the echo area buffer current. Note that for display
8655 purposes, it is not necessary that the displayed window's buffer
8656 == current_buffer, except for text property lookup. So, let's
8657 only set that buffer temporarily here without doing a full
8658 Fset_window_buffer. We must also change w->pointm, though,
8659 because otherwise an assertions in unshow_buffer fails, and Emacs
8661 set_buffer_internal_1 (XBUFFER (buffer
));
8665 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
8668 current_buffer
->undo_list
= Qt
;
8669 current_buffer
->read_only
= Qnil
;
8670 specbind (Qinhibit_read_only
, Qt
);
8671 specbind (Qinhibit_modification_hooks
, Qt
);
8673 if (clear_buffer_p
&& Z
> BEG
)
8676 xassert (BEGV
>= BEG
);
8677 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8679 rc
= fn (a1
, a2
, a3
, a4
);
8681 xassert (BEGV
>= BEG
);
8682 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8684 unbind_to (count
, Qnil
);
8689 /* Save state that should be preserved around the call to the function
8690 FN called in with_echo_area_buffer. */
8693 with_echo_area_buffer_unwind_data (struct window
*w
)
8696 Lisp_Object vector
, tmp
;
8698 /* Reduce consing by keeping one vector in
8699 Vwith_echo_area_save_vector. */
8700 vector
= Vwith_echo_area_save_vector
;
8701 Vwith_echo_area_save_vector
= Qnil
;
8704 vector
= Fmake_vector (make_number (7), Qnil
);
8706 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
8707 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
8708 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
8712 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
8713 ASET (vector
, i
, w
->buffer
); ++i
;
8714 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
8715 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
8720 for (; i
< end
; ++i
)
8721 ASET (vector
, i
, Qnil
);
8724 xassert (i
== ASIZE (vector
));
8729 /* Restore global state from VECTOR which was created by
8730 with_echo_area_buffer_unwind_data. */
8733 unwind_with_echo_area_buffer (Lisp_Object vector
)
8735 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
8736 Vdeactivate_mark
= AREF (vector
, 1);
8737 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
8739 if (WINDOWP (AREF (vector
, 3)))
8742 Lisp_Object buffer
, charpos
, bytepos
;
8744 w
= XWINDOW (AREF (vector
, 3));
8745 buffer
= AREF (vector
, 4);
8746 charpos
= AREF (vector
, 5);
8747 bytepos
= AREF (vector
, 6);
8750 set_marker_both (w
->pointm
, buffer
,
8751 XFASTINT (charpos
), XFASTINT (bytepos
));
8754 Vwith_echo_area_save_vector
= vector
;
8759 /* Set up the echo area for use by print functions. MULTIBYTE_P
8760 non-zero means we will print multibyte. */
8763 setup_echo_area_for_printing (int multibyte_p
)
8765 /* If we can't find an echo area any more, exit. */
8766 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8769 ensure_echo_area_buffers ();
8771 if (!message_buf_print
)
8773 /* A message has been output since the last time we printed.
8774 Choose a fresh echo area buffer. */
8775 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8776 echo_area_buffer
[0] = echo_buffer
[1];
8778 echo_area_buffer
[0] = echo_buffer
[0];
8780 /* Switch to that buffer and clear it. */
8781 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8782 current_buffer
->truncate_lines
= Qnil
;
8786 int count
= SPECPDL_INDEX ();
8787 specbind (Qinhibit_read_only
, Qt
);
8788 /* Note that undo recording is always disabled. */
8790 unbind_to (count
, Qnil
);
8792 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8794 /* Set up the buffer for the multibyteness we need. */
8796 != !NILP (current_buffer
->enable_multibyte_characters
))
8797 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
8799 /* Raise the frame containing the echo area. */
8800 if (minibuffer_auto_raise
)
8802 struct frame
*sf
= SELECTED_FRAME ();
8803 Lisp_Object mini_window
;
8804 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8805 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8808 message_log_maybe_newline ();
8809 message_buf_print
= 1;
8813 if (NILP (echo_area_buffer
[0]))
8815 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8816 echo_area_buffer
[0] = echo_buffer
[1];
8818 echo_area_buffer
[0] = echo_buffer
[0];
8821 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
8823 /* Someone switched buffers between print requests. */
8824 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8825 current_buffer
->truncate_lines
= Qnil
;
8831 /* Display an echo area message in window W. Value is non-zero if W's
8832 height is changed. If display_last_displayed_message_p is
8833 non-zero, display the message that was last displayed, otherwise
8834 display the current message. */
8837 display_echo_area (struct window
*w
)
8839 int i
, no_message_p
, window_height_changed_p
, count
;
8841 /* Temporarily disable garbage collections while displaying the echo
8842 area. This is done because a GC can print a message itself.
8843 That message would modify the echo area buffer's contents while a
8844 redisplay of the buffer is going on, and seriously confuse
8846 count
= inhibit_garbage_collection ();
8848 /* If there is no message, we must call display_echo_area_1
8849 nevertheless because it resizes the window. But we will have to
8850 reset the echo_area_buffer in question to nil at the end because
8851 with_echo_area_buffer will sets it to an empty buffer. */
8852 i
= display_last_displayed_message_p
? 1 : 0;
8853 no_message_p
= NILP (echo_area_buffer
[i
]);
8855 window_height_changed_p
8856 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
8857 display_echo_area_1
,
8858 (EMACS_INT
) w
, Qnil
, 0, 0);
8861 echo_area_buffer
[i
] = Qnil
;
8863 unbind_to (count
, Qnil
);
8864 return window_height_changed_p
;
8868 /* Helper for display_echo_area. Display the current buffer which
8869 contains the current echo area message in window W, a mini-window,
8870 a pointer to which is passed in A1. A2..A4 are currently not used.
8871 Change the height of W so that all of the message is displayed.
8872 Value is non-zero if height of W was changed. */
8875 display_echo_area_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
8877 struct window
*w
= (struct window
*) a1
;
8879 struct text_pos start
;
8880 int window_height_changed_p
= 0;
8882 /* Do this before displaying, so that we have a large enough glyph
8883 matrix for the display. If we can't get enough space for the
8884 whole text, display the last N lines. That works by setting w->start. */
8885 window_height_changed_p
= resize_mini_window (w
, 0);
8887 /* Use the starting position chosen by resize_mini_window. */
8888 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
8891 clear_glyph_matrix (w
->desired_matrix
);
8892 XSETWINDOW (window
, w
);
8893 try_window (window
, start
, 0);
8895 return window_height_changed_p
;
8899 /* Resize the echo area window to exactly the size needed for the
8900 currently displayed message, if there is one. If a mini-buffer
8901 is active, don't shrink it. */
8904 resize_echo_area_exactly (void)
8906 if (BUFFERP (echo_area_buffer
[0])
8907 && WINDOWP (echo_area_window
))
8909 struct window
*w
= XWINDOW (echo_area_window
);
8911 Lisp_Object resize_exactly
;
8913 if (minibuf_level
== 0)
8914 resize_exactly
= Qt
;
8916 resize_exactly
= Qnil
;
8918 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
8919 (EMACS_INT
) w
, resize_exactly
, 0, 0);
8922 ++windows_or_buffers_changed
;
8923 ++update_mode_lines
;
8924 redisplay_internal (0);
8930 /* Callback function for with_echo_area_buffer, when used from
8931 resize_echo_area_exactly. A1 contains a pointer to the window to
8932 resize, EXACTLY non-nil means resize the mini-window exactly to the
8933 size of the text displayed. A3 and A4 are not used. Value is what
8934 resize_mini_window returns. */
8937 resize_mini_window_1 (EMACS_INT a1
, Lisp_Object exactly
, EMACS_INT a3
, EMACS_INT a4
)
8939 return resize_mini_window ((struct window
*) a1
, !NILP (exactly
));
8943 /* Resize mini-window W to fit the size of its contents. EXACT_P
8944 means size the window exactly to the size needed. Otherwise, it's
8945 only enlarged until W's buffer is empty.
8947 Set W->start to the right place to begin display. If the whole
8948 contents fit, start at the beginning. Otherwise, start so as
8949 to make the end of the contents appear. This is particularly
8950 important for y-or-n-p, but seems desirable generally.
8952 Value is non-zero if the window height has been changed. */
8955 resize_mini_window (struct window
*w
, int exact_p
)
8957 struct frame
*f
= XFRAME (w
->frame
);
8958 int window_height_changed_p
= 0;
8960 xassert (MINI_WINDOW_P (w
));
8962 /* By default, start display at the beginning. */
8963 set_marker_both (w
->start
, w
->buffer
,
8964 BUF_BEGV (XBUFFER (w
->buffer
)),
8965 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
8967 /* Don't resize windows while redisplaying a window; it would
8968 confuse redisplay functions when the size of the window they are
8969 displaying changes from under them. Such a resizing can happen,
8970 for instance, when which-func prints a long message while
8971 we are running fontification-functions. We're running these
8972 functions with safe_call which binds inhibit-redisplay to t. */
8973 if (!NILP (Vinhibit_redisplay
))
8976 /* Nil means don't try to resize. */
8977 if (NILP (Vresize_mini_windows
)
8978 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
8981 if (!FRAME_MINIBUF_ONLY_P (f
))
8984 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
8985 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
8986 int height
, max_height
;
8987 int unit
= FRAME_LINE_HEIGHT (f
);
8988 struct text_pos start
;
8989 struct buffer
*old_current_buffer
= NULL
;
8991 if (current_buffer
!= XBUFFER (w
->buffer
))
8993 old_current_buffer
= current_buffer
;
8994 set_buffer_internal (XBUFFER (w
->buffer
));
8997 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8999 /* Compute the max. number of lines specified by the user. */
9000 if (FLOATP (Vmax_mini_window_height
))
9001 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
9002 else if (INTEGERP (Vmax_mini_window_height
))
9003 max_height
= XINT (Vmax_mini_window_height
);
9005 max_height
= total_height
/ 4;
9007 /* Correct that max. height if it's bogus. */
9008 max_height
= max (1, max_height
);
9009 max_height
= min (total_height
, max_height
);
9011 /* Find out the height of the text in the window. */
9012 if (it
.line_wrap
== TRUNCATE
)
9017 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
9018 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
9019 height
= it
.current_y
+ last_height
;
9021 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9022 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
9023 height
= (height
+ unit
- 1) / unit
;
9026 /* Compute a suitable window start. */
9027 if (height
> max_height
)
9029 height
= max_height
;
9030 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
9031 move_it_vertically_backward (&it
, (height
- 1) * unit
);
9032 start
= it
.current
.pos
;
9035 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
9036 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
9038 if (EQ (Vresize_mini_windows
, Qgrow_only
))
9040 /* Let it grow only, until we display an empty message, in which
9041 case the window shrinks again. */
9042 if (height
> WINDOW_TOTAL_LINES (w
))
9044 int old_height
= WINDOW_TOTAL_LINES (w
);
9045 freeze_window_starts (f
, 1);
9046 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9047 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9049 else if (height
< WINDOW_TOTAL_LINES (w
)
9050 && (exact_p
|| BEGV
== ZV
))
9052 int old_height
= WINDOW_TOTAL_LINES (w
);
9053 freeze_window_starts (f
, 0);
9054 shrink_mini_window (w
);
9055 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9060 /* Always resize to exact size needed. */
9061 if (height
> WINDOW_TOTAL_LINES (w
))
9063 int old_height
= WINDOW_TOTAL_LINES (w
);
9064 freeze_window_starts (f
, 1);
9065 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9066 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9068 else if (height
< WINDOW_TOTAL_LINES (w
))
9070 int old_height
= WINDOW_TOTAL_LINES (w
);
9071 freeze_window_starts (f
, 0);
9072 shrink_mini_window (w
);
9076 freeze_window_starts (f
, 1);
9077 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9080 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9084 if (old_current_buffer
)
9085 set_buffer_internal (old_current_buffer
);
9088 return window_height_changed_p
;
9092 /* Value is the current message, a string, or nil if there is no
9096 current_message (void)
9100 if (!BUFFERP (echo_area_buffer
[0]))
9104 with_echo_area_buffer (0, 0, current_message_1
,
9105 (EMACS_INT
) &msg
, Qnil
, 0, 0);
9107 echo_area_buffer
[0] = Qnil
;
9115 current_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9117 Lisp_Object
*msg
= (Lisp_Object
*) a1
;
9120 *msg
= make_buffer_string (BEG
, Z
, 1);
9127 /* Push the current message on Vmessage_stack for later restauration
9128 by restore_message. Value is non-zero if the current message isn't
9129 empty. This is a relatively infrequent operation, so it's not
9130 worth optimizing. */
9136 msg
= current_message ();
9137 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
9138 return STRINGP (msg
);
9142 /* Restore message display from the top of Vmessage_stack. */
9145 restore_message (void)
9149 xassert (CONSP (Vmessage_stack
));
9150 msg
= XCAR (Vmessage_stack
);
9152 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9154 message3_nolog (msg
, 0, 0);
9158 /* Handler for record_unwind_protect calling pop_message. */
9161 pop_message_unwind (Lisp_Object dummy
)
9167 /* Pop the top-most entry off Vmessage_stack. */
9172 xassert (CONSP (Vmessage_stack
));
9173 Vmessage_stack
= XCDR (Vmessage_stack
);
9177 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
9178 exits. If the stack is not empty, we have a missing pop_message
9182 check_message_stack (void)
9184 if (!NILP (Vmessage_stack
))
9189 /* Truncate to NCHARS what will be displayed in the echo area the next
9190 time we display it---but don't redisplay it now. */
9193 truncate_echo_area (EMACS_INT nchars
)
9196 echo_area_buffer
[0] = Qnil
;
9197 /* A null message buffer means that the frame hasn't really been
9198 initialized yet. Error messages get reported properly by
9199 cmd_error, so this must be just an informative message; toss it. */
9200 else if (!noninteractive
9202 && !NILP (echo_area_buffer
[0]))
9204 struct frame
*sf
= SELECTED_FRAME ();
9205 if (FRAME_MESSAGE_BUF (sf
))
9206 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
9211 /* Helper function for truncate_echo_area. Truncate the current
9212 message to at most NCHARS characters. */
9215 truncate_message_1 (EMACS_INT nchars
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9217 if (BEG
+ nchars
< Z
)
9218 del_range (BEG
+ nchars
, Z
);
9220 echo_area_buffer
[0] = Qnil
;
9225 /* Set the current message to a substring of S or STRING.
9227 If STRING is a Lisp string, set the message to the first NBYTES
9228 bytes from STRING. NBYTES zero means use the whole string. If
9229 STRING is multibyte, the message will be displayed multibyte.
9231 If S is not null, set the message to the first LEN bytes of S. LEN
9232 zero means use the whole string. MULTIBYTE_P non-zero means S is
9233 multibyte. Display the message multibyte in that case.
9235 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
9236 to t before calling set_message_1 (which calls insert).
9240 set_message (const char *s
, Lisp_Object string
,
9241 EMACS_INT nbytes
, int multibyte_p
)
9243 message_enable_multibyte
9244 = ((s
&& multibyte_p
)
9245 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
9247 with_echo_area_buffer (0, -1, set_message_1
,
9248 (EMACS_INT
) s
, string
, nbytes
, multibyte_p
);
9249 message_buf_print
= 0;
9250 help_echo_showing_p
= 0;
9254 /* Helper function for set_message. Arguments have the same meaning
9255 as there, with A1 corresponding to S and A2 corresponding to STRING
9256 This function is called with the echo area buffer being
9260 set_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT nbytes
, EMACS_INT multibyte_p
)
9262 const char *s
= (const char *) a1
;
9263 Lisp_Object string
= a2
;
9265 /* Change multibyteness of the echo buffer appropriately. */
9266 if (message_enable_multibyte
9267 != !NILP (current_buffer
->enable_multibyte_characters
))
9268 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
9270 current_buffer
->truncate_lines
= message_truncate_lines
? Qt
: Qnil
;
9272 /* Insert new message at BEG. */
9273 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9275 if (STRINGP (string
))
9280 nbytes
= SBYTES (string
);
9281 nchars
= string_byte_to_char (string
, nbytes
);
9283 /* This function takes care of single/multibyte conversion. We
9284 just have to ensure that the echo area buffer has the right
9285 setting of enable_multibyte_characters. */
9286 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
9291 nbytes
= strlen (s
);
9293 if (multibyte_p
&& NILP (current_buffer
->enable_multibyte_characters
))
9295 /* Convert from multi-byte to single-byte. */
9298 unsigned char work
[1];
9300 /* Convert a multibyte string to single-byte. */
9301 for (i
= 0; i
< nbytes
; i
+= n
)
9303 c
= string_char_and_length (s
+ i
, &n
);
9304 work
[0] = (ASCII_CHAR_P (c
)
9306 : multibyte_char_to_unibyte (c
, Qnil
));
9307 insert_1_both (work
, 1, 1, 1, 0, 0);
9310 else if (!multibyte_p
9311 && !NILP (current_buffer
->enable_multibyte_characters
))
9313 /* Convert from single-byte to multi-byte. */
9316 const unsigned char *msg
= (const unsigned char *) s
;
9317 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9319 /* Convert a single-byte string to multibyte. */
9320 for (i
= 0; i
< nbytes
; i
++)
9323 MAKE_CHAR_MULTIBYTE (c
);
9324 n
= CHAR_STRING (c
, str
);
9325 insert_1_both (str
, 1, n
, 1, 0, 0);
9329 insert_1 (s
, nbytes
, 1, 0, 0);
9336 /* Clear messages. CURRENT_P non-zero means clear the current
9337 message. LAST_DISPLAYED_P non-zero means clear the message
9341 clear_message (int current_p
, int last_displayed_p
)
9345 echo_area_buffer
[0] = Qnil
;
9346 message_cleared_p
= 1;
9349 if (last_displayed_p
)
9350 echo_area_buffer
[1] = Qnil
;
9352 message_buf_print
= 0;
9355 /* Clear garbaged frames.
9357 This function is used where the old redisplay called
9358 redraw_garbaged_frames which in turn called redraw_frame which in
9359 turn called clear_frame. The call to clear_frame was a source of
9360 flickering. I believe a clear_frame is not necessary. It should
9361 suffice in the new redisplay to invalidate all current matrices,
9362 and ensure a complete redisplay of all windows. */
9365 clear_garbaged_frames (void)
9369 Lisp_Object tail
, frame
;
9370 int changed_count
= 0;
9372 FOR_EACH_FRAME (tail
, frame
)
9374 struct frame
*f
= XFRAME (frame
);
9376 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
9380 Fredraw_frame (frame
);
9381 f
->force_flush_display_p
= 1;
9383 clear_current_matrices (f
);
9392 ++windows_or_buffers_changed
;
9397 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
9398 is non-zero update selected_frame. Value is non-zero if the
9399 mini-windows height has been changed. */
9402 echo_area_display (int update_frame_p
)
9404 Lisp_Object mini_window
;
9407 int window_height_changed_p
= 0;
9408 struct frame
*sf
= SELECTED_FRAME ();
9410 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9411 w
= XWINDOW (mini_window
);
9412 f
= XFRAME (WINDOW_FRAME (w
));
9414 /* Don't display if frame is invisible or not yet initialized. */
9415 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
9418 #ifdef HAVE_WINDOW_SYSTEM
9419 /* When Emacs starts, selected_frame may be the initial terminal
9420 frame. If we let this through, a message would be displayed on
9422 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
9424 #endif /* HAVE_WINDOW_SYSTEM */
9426 /* Redraw garbaged frames. */
9428 clear_garbaged_frames ();
9430 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
9432 echo_area_window
= mini_window
;
9433 window_height_changed_p
= display_echo_area (w
);
9434 w
->must_be_updated_p
= 1;
9436 /* Update the display, unless called from redisplay_internal.
9437 Also don't update the screen during redisplay itself. The
9438 update will happen at the end of redisplay, and an update
9439 here could cause confusion. */
9440 if (update_frame_p
&& !redisplaying_p
)
9444 /* If the display update has been interrupted by pending
9445 input, update mode lines in the frame. Due to the
9446 pending input, it might have been that redisplay hasn't
9447 been called, so that mode lines above the echo area are
9448 garbaged. This looks odd, so we prevent it here. */
9449 if (!display_completed
)
9450 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
9452 if (window_height_changed_p
9453 /* Don't do this if Emacs is shutting down. Redisplay
9454 needs to run hooks. */
9455 && !NILP (Vrun_hooks
))
9457 /* Must update other windows. Likewise as in other
9458 cases, don't let this update be interrupted by
9460 int count
= SPECPDL_INDEX ();
9461 specbind (Qredisplay_dont_pause
, Qt
);
9462 windows_or_buffers_changed
= 1;
9463 redisplay_internal (0);
9464 unbind_to (count
, Qnil
);
9466 else if (FRAME_WINDOW_P (f
) && n
== 0)
9468 /* Window configuration is the same as before.
9469 Can do with a display update of the echo area,
9470 unless we displayed some mode lines. */
9471 update_single_window (w
, 1);
9472 FRAME_RIF (f
)->flush_display (f
);
9475 update_frame (f
, 1, 1);
9477 /* If cursor is in the echo area, make sure that the next
9478 redisplay displays the minibuffer, so that the cursor will
9479 be replaced with what the minibuffer wants. */
9480 if (cursor_in_echo_area
)
9481 ++windows_or_buffers_changed
;
9484 else if (!EQ (mini_window
, selected_window
))
9485 windows_or_buffers_changed
++;
9487 /* Last displayed message is now the current message. */
9488 echo_area_buffer
[1] = echo_area_buffer
[0];
9489 /* Inform read_char that we're not echoing. */
9490 echo_message_buffer
= Qnil
;
9492 /* Prevent redisplay optimization in redisplay_internal by resetting
9493 this_line_start_pos. This is done because the mini-buffer now
9494 displays the message instead of its buffer text. */
9495 if (EQ (mini_window
, selected_window
))
9496 CHARPOS (this_line_start_pos
) = 0;
9498 return window_height_changed_p
;
9503 /***********************************************************************
9504 Mode Lines and Frame Titles
9505 ***********************************************************************/
9507 /* A buffer for constructing non-propertized mode-line strings and
9508 frame titles in it; allocated from the heap in init_xdisp and
9509 resized as needed in store_mode_line_noprop_char. */
9511 static char *mode_line_noprop_buf
;
9513 /* The buffer's end, and a current output position in it. */
9515 static char *mode_line_noprop_buf_end
;
9516 static char *mode_line_noprop_ptr
;
9518 #define MODE_LINE_NOPROP_LEN(start) \
9519 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
9522 MODE_LINE_DISPLAY
= 0,
9528 /* Alist that caches the results of :propertize.
9529 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
9530 static Lisp_Object mode_line_proptrans_alist
;
9532 /* List of strings making up the mode-line. */
9533 static Lisp_Object mode_line_string_list
;
9535 /* Base face property when building propertized mode line string. */
9536 static Lisp_Object mode_line_string_face
;
9537 static Lisp_Object mode_line_string_face_prop
;
9540 /* Unwind data for mode line strings */
9542 static Lisp_Object Vmode_line_unwind_vector
;
9545 format_mode_line_unwind_data (struct buffer
*obuf
,
9549 Lisp_Object vector
, tmp
;
9551 /* Reduce consing by keeping one vector in
9552 Vwith_echo_area_save_vector. */
9553 vector
= Vmode_line_unwind_vector
;
9554 Vmode_line_unwind_vector
= Qnil
;
9557 vector
= Fmake_vector (make_number (8), Qnil
);
9559 ASET (vector
, 0, make_number (mode_line_target
));
9560 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
9561 ASET (vector
, 2, mode_line_string_list
);
9562 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
9563 ASET (vector
, 4, mode_line_string_face
);
9564 ASET (vector
, 5, mode_line_string_face_prop
);
9567 XSETBUFFER (tmp
, obuf
);
9570 ASET (vector
, 6, tmp
);
9571 ASET (vector
, 7, owin
);
9577 unwind_format_mode_line (Lisp_Object vector
)
9579 mode_line_target
= XINT (AREF (vector
, 0));
9580 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
9581 mode_line_string_list
= AREF (vector
, 2);
9582 if (! EQ (AREF (vector
, 3), Qt
))
9583 mode_line_proptrans_alist
= AREF (vector
, 3);
9584 mode_line_string_face
= AREF (vector
, 4);
9585 mode_line_string_face_prop
= AREF (vector
, 5);
9587 if (!NILP (AREF (vector
, 7)))
9588 /* Select window before buffer, since it may change the buffer. */
9589 Fselect_window (AREF (vector
, 7), Qt
);
9591 if (!NILP (AREF (vector
, 6)))
9593 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
9594 ASET (vector
, 6, Qnil
);
9597 Vmode_line_unwind_vector
= vector
;
9602 /* Store a single character C for the frame title in mode_line_noprop_buf.
9603 Re-allocate mode_line_noprop_buf if necessary. */
9606 store_mode_line_noprop_char (char c
)
9608 /* If output position has reached the end of the allocated buffer,
9609 double the buffer's size. */
9610 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
9612 int len
= MODE_LINE_NOPROP_LEN (0);
9613 int new_size
= 2 * len
* sizeof *mode_line_noprop_buf
;
9614 mode_line_noprop_buf
= (char *) xrealloc (mode_line_noprop_buf
, new_size
);
9615 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ new_size
;
9616 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
9619 *mode_line_noprop_ptr
++ = c
;
9623 /* Store part of a frame title in mode_line_noprop_buf, beginning at
9624 mode_line_noprop_ptr. STR is the string to store. Do not copy
9625 characters that yield more columns than PRECISION; PRECISION <= 0
9626 means copy the whole string. Pad with spaces until FIELD_WIDTH
9627 number of characters have been copied; FIELD_WIDTH <= 0 means don't
9628 pad. Called from display_mode_element when it is used to build a
9632 store_mode_line_noprop (const unsigned char *str
, int field_width
, int precision
)
9635 EMACS_INT dummy
, nbytes
;
9637 /* Copy at most PRECISION chars from STR. */
9638 nbytes
= strlen (str
);
9639 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
9641 store_mode_line_noprop_char (*str
++);
9643 /* Fill up with spaces until FIELD_WIDTH reached. */
9644 while (field_width
> 0
9647 store_mode_line_noprop_char (' ');
9654 /***********************************************************************
9656 ***********************************************************************/
9658 #ifdef HAVE_WINDOW_SYSTEM
9660 /* Set the title of FRAME, if it has changed. The title format is
9661 Vicon_title_format if FRAME is iconified, otherwise it is
9662 frame_title_format. */
9665 x_consider_frame_title (Lisp_Object frame
)
9667 struct frame
*f
= XFRAME (frame
);
9669 if (FRAME_WINDOW_P (f
)
9670 || FRAME_MINIBUF_ONLY_P (f
)
9671 || f
->explicit_name
)
9673 /* Do we have more than one visible frame on this X display? */
9680 int count
= SPECPDL_INDEX ();
9682 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
9684 Lisp_Object other_frame
= XCAR (tail
);
9685 struct frame
*tf
= XFRAME (other_frame
);
9688 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
9689 && !FRAME_MINIBUF_ONLY_P (tf
)
9690 && !EQ (other_frame
, tip_frame
)
9691 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
9695 /* Set global variable indicating that multiple frames exist. */
9696 multiple_frames
= CONSP (tail
);
9698 /* Switch to the buffer of selected window of the frame. Set up
9699 mode_line_target so that display_mode_element will output into
9700 mode_line_noprop_buf; then display the title. */
9701 record_unwind_protect (unwind_format_mode_line
,
9702 format_mode_line_unwind_data
9703 (current_buffer
, selected_window
, 0));
9705 Fselect_window (f
->selected_window
, Qt
);
9706 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
9707 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
9709 mode_line_target
= MODE_LINE_TITLE
;
9710 title_start
= MODE_LINE_NOPROP_LEN (0);
9711 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
9712 NULL
, DEFAULT_FACE_ID
);
9713 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
9714 len
= MODE_LINE_NOPROP_LEN (title_start
);
9715 title
= mode_line_noprop_buf
+ title_start
;
9716 unbind_to (count
, Qnil
);
9718 /* Set the title only if it's changed. This avoids consing in
9719 the common case where it hasn't. (If it turns out that we've
9720 already wasted too much time by walking through the list with
9721 display_mode_element, then we might need to optimize at a
9722 higher level than this.) */
9723 if (! STRINGP (f
->name
)
9724 || SBYTES (f
->name
) != len
9725 || memcmp (title
, SDATA (f
->name
), len
) != 0)
9726 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
9730 #endif /* not HAVE_WINDOW_SYSTEM */
9735 /***********************************************************************
9737 ***********************************************************************/
9740 /* Prepare for redisplay by updating menu-bar item lists when
9741 appropriate. This can call eval. */
9744 prepare_menu_bars (void)
9747 struct gcpro gcpro1
, gcpro2
;
9749 Lisp_Object tooltip_frame
;
9751 #ifdef HAVE_WINDOW_SYSTEM
9752 tooltip_frame
= tip_frame
;
9754 tooltip_frame
= Qnil
;
9757 /* Update all frame titles based on their buffer names, etc. We do
9758 this before the menu bars so that the buffer-menu will show the
9759 up-to-date frame titles. */
9760 #ifdef HAVE_WINDOW_SYSTEM
9761 if (windows_or_buffers_changed
|| update_mode_lines
)
9763 Lisp_Object tail
, frame
;
9765 FOR_EACH_FRAME (tail
, frame
)
9768 if (!EQ (frame
, tooltip_frame
)
9769 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
9770 x_consider_frame_title (frame
);
9773 #endif /* HAVE_WINDOW_SYSTEM */
9775 /* Update the menu bar item lists, if appropriate. This has to be
9776 done before any actual redisplay or generation of display lines. */
9777 all_windows
= (update_mode_lines
9778 || buffer_shared
> 1
9779 || windows_or_buffers_changed
);
9782 Lisp_Object tail
, frame
;
9783 int count
= SPECPDL_INDEX ();
9784 /* 1 means that update_menu_bar has run its hooks
9785 so any further calls to update_menu_bar shouldn't do so again. */
9786 int menu_bar_hooks_run
= 0;
9788 record_unwind_save_match_data ();
9790 FOR_EACH_FRAME (tail
, frame
)
9794 /* Ignore tooltip frame. */
9795 if (EQ (frame
, tooltip_frame
))
9798 /* If a window on this frame changed size, report that to
9799 the user and clear the size-change flag. */
9800 if (FRAME_WINDOW_SIZES_CHANGED (f
))
9802 Lisp_Object functions
;
9804 /* Clear flag first in case we get an error below. */
9805 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
9806 functions
= Vwindow_size_change_functions
;
9807 GCPRO2 (tail
, functions
);
9809 while (CONSP (functions
))
9811 if (!EQ (XCAR (functions
), Qt
))
9812 call1 (XCAR (functions
), frame
);
9813 functions
= XCDR (functions
);
9819 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
9820 #ifdef HAVE_WINDOW_SYSTEM
9821 update_tool_bar (f
, 0);
9824 if (windows_or_buffers_changed
9826 ns_set_doc_edited (f
, Fbuffer_modified_p
9827 (XWINDOW (f
->selected_window
)->buffer
));
9832 unbind_to (count
, Qnil
);
9836 struct frame
*sf
= SELECTED_FRAME ();
9837 update_menu_bar (sf
, 1, 0);
9838 #ifdef HAVE_WINDOW_SYSTEM
9839 update_tool_bar (sf
, 1);
9845 /* Update the menu bar item list for frame F. This has to be done
9846 before we start to fill in any display lines, because it can call
9849 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
9851 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
9852 already ran the menu bar hooks for this redisplay, so there
9853 is no need to run them again. The return value is the
9854 updated value of this flag, to pass to the next call. */
9857 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
9860 register struct window
*w
;
9862 /* If called recursively during a menu update, do nothing. This can
9863 happen when, for instance, an activate-menubar-hook causes a
9865 if (inhibit_menubar_update
)
9868 window
= FRAME_SELECTED_WINDOW (f
);
9869 w
= XWINDOW (window
);
9871 if (FRAME_WINDOW_P (f
)
9873 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9874 || defined (HAVE_NS) || defined (USE_GTK)
9875 FRAME_EXTERNAL_MENU_BAR (f
)
9877 FRAME_MENU_BAR_LINES (f
) > 0
9879 : FRAME_MENU_BAR_LINES (f
) > 0)
9881 /* If the user has switched buffers or windows, we need to
9882 recompute to reflect the new bindings. But we'll
9883 recompute when update_mode_lines is set too; that means
9884 that people can use force-mode-line-update to request
9885 that the menu bar be recomputed. The adverse effect on
9886 the rest of the redisplay algorithm is about the same as
9887 windows_or_buffers_changed anyway. */
9888 if (windows_or_buffers_changed
9889 /* This used to test w->update_mode_line, but we believe
9890 there is no need to recompute the menu in that case. */
9891 || update_mode_lines
9892 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9893 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9894 != !NILP (w
->last_had_star
))
9895 || ((!NILP (Vtransient_mark_mode
)
9896 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
9897 != !NILP (w
->region_showing
)))
9899 struct buffer
*prev
= current_buffer
;
9900 int count
= SPECPDL_INDEX ();
9902 specbind (Qinhibit_menubar_update
, Qt
);
9904 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9905 if (save_match_data
)
9906 record_unwind_save_match_data ();
9907 if (NILP (Voverriding_local_map_menu_flag
))
9909 specbind (Qoverriding_terminal_local_map
, Qnil
);
9910 specbind (Qoverriding_local_map
, Qnil
);
9915 /* Run the Lucid hook. */
9916 safe_run_hooks (Qactivate_menubar_hook
);
9918 /* If it has changed current-menubar from previous value,
9919 really recompute the menu-bar from the value. */
9920 if (! NILP (Vlucid_menu_bar_dirty_flag
))
9921 call0 (Qrecompute_lucid_menubar
);
9923 safe_run_hooks (Qmenu_bar_update_hook
);
9928 XSETFRAME (Vmenu_updating_frame
, f
);
9929 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
9931 /* Redisplay the menu bar in case we changed it. */
9932 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9933 || defined (HAVE_NS) || defined (USE_GTK)
9934 if (FRAME_WINDOW_P (f
))
9936 #if defined (HAVE_NS)
9937 /* All frames on Mac OS share the same menubar. So only
9938 the selected frame should be allowed to set it. */
9939 if (f
== SELECTED_FRAME ())
9941 set_frame_menubar (f
, 0, 0);
9944 /* On a terminal screen, the menu bar is an ordinary screen
9945 line, and this makes it get updated. */
9946 w
->update_mode_line
= Qt
;
9947 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9948 /* In the non-toolkit version, the menu bar is an ordinary screen
9949 line, and this makes it get updated. */
9950 w
->update_mode_line
= Qt
;
9951 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9953 unbind_to (count
, Qnil
);
9954 set_buffer_internal_1 (prev
);
9963 /***********************************************************************
9965 ***********************************************************************/
9967 #ifdef HAVE_WINDOW_SYSTEM
9970 Nominal cursor position -- where to draw output.
9971 HPOS and VPOS are window relative glyph matrix coordinates.
9972 X and Y are window relative pixel coordinates. */
9974 struct cursor_pos output_cursor
;
9978 Set the global variable output_cursor to CURSOR. All cursor
9979 positions are relative to updated_window. */
9982 set_output_cursor (struct cursor_pos
*cursor
)
9984 output_cursor
.hpos
= cursor
->hpos
;
9985 output_cursor
.vpos
= cursor
->vpos
;
9986 output_cursor
.x
= cursor
->x
;
9987 output_cursor
.y
= cursor
->y
;
9992 Set a nominal cursor position.
9994 HPOS and VPOS are column/row positions in a window glyph matrix. X
9995 and Y are window text area relative pixel positions.
9997 If this is done during an update, updated_window will contain the
9998 window that is being updated and the position is the future output
9999 cursor position for that window. If updated_window is null, use
10000 selected_window and display the cursor at the given position. */
10003 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
10007 /* If updated_window is not set, work on selected_window. */
10008 if (updated_window
)
10009 w
= updated_window
;
10011 w
= XWINDOW (selected_window
);
10013 /* Set the output cursor. */
10014 output_cursor
.hpos
= hpos
;
10015 output_cursor
.vpos
= vpos
;
10016 output_cursor
.x
= x
;
10017 output_cursor
.y
= y
;
10019 /* If not called as part of an update, really display the cursor.
10020 This will also set the cursor position of W. */
10021 if (updated_window
== NULL
)
10024 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
10025 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
10026 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
10031 #endif /* HAVE_WINDOW_SYSTEM */
10034 /***********************************************************************
10036 ***********************************************************************/
10038 #ifdef HAVE_WINDOW_SYSTEM
10040 /* Where the mouse was last time we reported a mouse event. */
10042 FRAME_PTR last_mouse_frame
;
10044 /* Tool-bar item index of the item on which a mouse button was pressed
10047 int last_tool_bar_item
;
10051 update_tool_bar_unwind (Lisp_Object frame
)
10053 selected_frame
= frame
;
10057 /* Update the tool-bar item list for frame F. This has to be done
10058 before we start to fill in any display lines. Called from
10059 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
10060 and restore it here. */
10063 update_tool_bar (struct frame
*f
, int save_match_data
)
10065 #if defined (USE_GTK) || defined (HAVE_NS)
10066 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
10068 int do_update
= WINDOWP (f
->tool_bar_window
)
10069 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
10074 Lisp_Object window
;
10077 window
= FRAME_SELECTED_WINDOW (f
);
10078 w
= XWINDOW (window
);
10080 /* If the user has switched buffers or windows, we need to
10081 recompute to reflect the new bindings. But we'll
10082 recompute when update_mode_lines is set too; that means
10083 that people can use force-mode-line-update to request
10084 that the menu bar be recomputed. The adverse effect on
10085 the rest of the redisplay algorithm is about the same as
10086 windows_or_buffers_changed anyway. */
10087 if (windows_or_buffers_changed
10088 || !NILP (w
->update_mode_line
)
10089 || update_mode_lines
10090 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10091 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10092 != !NILP (w
->last_had_star
))
10093 || ((!NILP (Vtransient_mark_mode
)
10094 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
10095 != !NILP (w
->region_showing
)))
10097 struct buffer
*prev
= current_buffer
;
10098 int count
= SPECPDL_INDEX ();
10099 Lisp_Object frame
, new_tool_bar
;
10100 int new_n_tool_bar
;
10101 struct gcpro gcpro1
;
10103 /* Set current_buffer to the buffer of the selected
10104 window of the frame, so that we get the right local
10106 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10108 /* Save match data, if we must. */
10109 if (save_match_data
)
10110 record_unwind_save_match_data ();
10112 /* Make sure that we don't accidentally use bogus keymaps. */
10113 if (NILP (Voverriding_local_map_menu_flag
))
10115 specbind (Qoverriding_terminal_local_map
, Qnil
);
10116 specbind (Qoverriding_local_map
, Qnil
);
10119 GCPRO1 (new_tool_bar
);
10121 /* We must temporarily set the selected frame to this frame
10122 before calling tool_bar_items, because the calculation of
10123 the tool-bar keymap uses the selected frame (see
10124 `tool-bar-make-keymap' in tool-bar.el). */
10125 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
10126 XSETFRAME (frame
, f
);
10127 selected_frame
= frame
;
10129 /* Build desired tool-bar items from keymaps. */
10130 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
10133 /* Redisplay the tool-bar if we changed it. */
10134 if (new_n_tool_bar
!= f
->n_tool_bar_items
10135 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
10137 /* Redisplay that happens asynchronously due to an expose event
10138 may access f->tool_bar_items. Make sure we update both
10139 variables within BLOCK_INPUT so no such event interrupts. */
10141 f
->tool_bar_items
= new_tool_bar
;
10142 f
->n_tool_bar_items
= new_n_tool_bar
;
10143 w
->update_mode_line
= Qt
;
10149 unbind_to (count
, Qnil
);
10150 set_buffer_internal_1 (prev
);
10156 /* Set F->desired_tool_bar_string to a Lisp string representing frame
10157 F's desired tool-bar contents. F->tool_bar_items must have
10158 been set up previously by calling prepare_menu_bars. */
10161 build_desired_tool_bar_string (struct frame
*f
)
10163 int i
, size
, size_needed
;
10164 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10165 Lisp_Object image
, plist
, props
;
10167 image
= plist
= props
= Qnil
;
10168 GCPRO3 (image
, plist
, props
);
10170 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
10171 Otherwise, make a new string. */
10173 /* The size of the string we might be able to reuse. */
10174 size
= (STRINGP (f
->desired_tool_bar_string
)
10175 ? SCHARS (f
->desired_tool_bar_string
)
10178 /* We need one space in the string for each image. */
10179 size_needed
= f
->n_tool_bar_items
;
10181 /* Reuse f->desired_tool_bar_string, if possible. */
10182 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
10183 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
10184 make_number (' '));
10187 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
10188 Fremove_text_properties (make_number (0), make_number (size
),
10189 props
, f
->desired_tool_bar_string
);
10192 /* Put a `display' property on the string for the images to display,
10193 put a `menu_item' property on tool-bar items with a value that
10194 is the index of the item in F's tool-bar item vector. */
10195 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
10197 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
10199 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
10200 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
10201 int hmargin
, vmargin
, relief
, idx
, end
;
10203 /* If image is a vector, choose the image according to the
10205 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
10206 if (VECTORP (image
))
10210 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
10211 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
10214 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
10215 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
10217 xassert (ASIZE (image
) >= idx
);
10218 image
= AREF (image
, idx
);
10223 /* Ignore invalid image specifications. */
10224 if (!valid_image_p (image
))
10227 /* Display the tool-bar button pressed, or depressed. */
10228 plist
= Fcopy_sequence (XCDR (image
));
10230 /* Compute margin and relief to draw. */
10231 relief
= (tool_bar_button_relief
>= 0
10232 ? tool_bar_button_relief
10233 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
10234 hmargin
= vmargin
= relief
;
10236 if (INTEGERP (Vtool_bar_button_margin
)
10237 && XINT (Vtool_bar_button_margin
) > 0)
10239 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
10240 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
10242 else if (CONSP (Vtool_bar_button_margin
))
10244 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
10245 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
10246 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
10248 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
10249 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
10250 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
10253 if (auto_raise_tool_bar_buttons_p
)
10255 /* Add a `:relief' property to the image spec if the item is
10259 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
10266 /* If image is selected, display it pressed, i.e. with a
10267 negative relief. If it's not selected, display it with a
10269 plist
= Fplist_put (plist
, QCrelief
,
10271 ? make_number (-relief
)
10272 : make_number (relief
)));
10277 /* Put a margin around the image. */
10278 if (hmargin
|| vmargin
)
10280 if (hmargin
== vmargin
)
10281 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
10283 plist
= Fplist_put (plist
, QCmargin
,
10284 Fcons (make_number (hmargin
),
10285 make_number (vmargin
)));
10288 /* If button is not enabled, and we don't have special images
10289 for the disabled state, make the image appear disabled by
10290 applying an appropriate algorithm to it. */
10291 if (!enabled_p
&& idx
< 0)
10292 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
10294 /* Put a `display' text property on the string for the image to
10295 display. Put a `menu-item' property on the string that gives
10296 the start of this item's properties in the tool-bar items
10298 image
= Fcons (Qimage
, plist
);
10299 props
= list4 (Qdisplay
, image
,
10300 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
10302 /* Let the last image hide all remaining spaces in the tool bar
10303 string. The string can be longer than needed when we reuse a
10304 previous string. */
10305 if (i
+ 1 == f
->n_tool_bar_items
)
10306 end
= SCHARS (f
->desired_tool_bar_string
);
10309 Fadd_text_properties (make_number (i
), make_number (end
),
10310 props
, f
->desired_tool_bar_string
);
10318 /* Display one line of the tool-bar of frame IT->f.
10320 HEIGHT specifies the desired height of the tool-bar line.
10321 If the actual height of the glyph row is less than HEIGHT, the
10322 row's height is increased to HEIGHT, and the icons are centered
10323 vertically in the new height.
10325 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
10326 count a final empty row in case the tool-bar width exactly matches
10331 display_tool_bar_line (struct it
*it
, int height
)
10333 struct glyph_row
*row
= it
->glyph_row
;
10334 int max_x
= it
->last_visible_x
;
10335 struct glyph
*last
;
10337 prepare_desired_row (row
);
10338 row
->y
= it
->current_y
;
10340 /* Note that this isn't made use of if the face hasn't a box,
10341 so there's no need to check the face here. */
10342 it
->start_of_box_run_p
= 1;
10344 while (it
->current_x
< max_x
)
10346 int x
, n_glyphs_before
, i
, nglyphs
;
10347 struct it it_before
;
10349 /* Get the next display element. */
10350 if (!get_next_display_element (it
))
10352 /* Don't count empty row if we are counting needed tool-bar lines. */
10353 if (height
< 0 && !it
->hpos
)
10358 /* Produce glyphs. */
10359 n_glyphs_before
= row
->used
[TEXT_AREA
];
10362 PRODUCE_GLYPHS (it
);
10364 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
10366 x
= it_before
.current_x
;
10367 while (i
< nglyphs
)
10369 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
10371 if (x
+ glyph
->pixel_width
> max_x
)
10373 /* Glyph doesn't fit on line. Backtrack. */
10374 row
->used
[TEXT_AREA
] = n_glyphs_before
;
10376 /* If this is the only glyph on this line, it will never fit on the
10377 toolbar, so skip it. But ensure there is at least one glyph,
10378 so we don't accidentally disable the tool-bar. */
10379 if (n_glyphs_before
== 0
10380 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
10386 x
+= glyph
->pixel_width
;
10390 /* Stop at line ends. */
10391 if (ITERATOR_AT_END_OF_LINE_P (it
))
10394 set_iterator_to_next (it
, 1);
10399 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
10401 /* Use default face for the border below the tool bar.
10403 FIXME: When auto-resize-tool-bars is grow-only, there is
10404 no additional border below the possibly empty tool-bar lines.
10405 So to make the extra empty lines look "normal", we have to
10406 use the tool-bar face for the border too. */
10407 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
10408 it
->face_id
= DEFAULT_FACE_ID
;
10410 extend_face_to_end_of_line (it
);
10411 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
10412 last
->right_box_line_p
= 1;
10413 if (last
== row
->glyphs
[TEXT_AREA
])
10414 last
->left_box_line_p
= 1;
10416 /* Make line the desired height and center it vertically. */
10417 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
10419 /* Don't add more than one line height. */
10420 height
%= FRAME_LINE_HEIGHT (it
->f
);
10421 it
->max_ascent
+= height
/ 2;
10422 it
->max_descent
+= (height
+ 1) / 2;
10425 compute_line_metrics (it
);
10427 /* If line is empty, make it occupy the rest of the tool-bar. */
10428 if (!row
->displays_text_p
)
10430 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
10431 row
->visible_height
= row
->height
;
10432 row
->ascent
= row
->phys_ascent
= 0;
10433 row
->extra_line_spacing
= 0;
10436 row
->full_width_p
= 1;
10437 row
->continued_p
= 0;
10438 row
->truncated_on_left_p
= 0;
10439 row
->truncated_on_right_p
= 0;
10441 it
->current_x
= it
->hpos
= 0;
10442 it
->current_y
+= row
->height
;
10448 /* Max tool-bar height. */
10450 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
10451 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
10453 /* Value is the number of screen lines needed to make all tool-bar
10454 items of frame F visible. The number of actual rows needed is
10455 returned in *N_ROWS if non-NULL. */
10458 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
10460 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10462 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
10463 the desired matrix, so use (unused) mode-line row as temporary row to
10464 avoid destroying the first tool-bar row. */
10465 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
10467 /* Initialize an iterator for iteration over
10468 F->desired_tool_bar_string in the tool-bar window of frame F. */
10469 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
10470 it
.first_visible_x
= 0;
10471 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10472 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10474 while (!ITERATOR_AT_END_P (&it
))
10476 clear_glyph_row (temp_row
);
10477 it
.glyph_row
= temp_row
;
10478 display_tool_bar_line (&it
, -1);
10480 clear_glyph_row (temp_row
);
10482 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
10484 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
10486 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
10490 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
10492 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
10493 (Lisp_Object frame
)
10500 frame
= selected_frame
;
10502 CHECK_FRAME (frame
);
10503 f
= XFRAME (frame
);
10505 if (WINDOWP (f
->tool_bar_window
)
10506 || (w
= XWINDOW (f
->tool_bar_window
),
10507 WINDOW_TOTAL_LINES (w
) > 0))
10509 update_tool_bar (f
, 1);
10510 if (f
->n_tool_bar_items
)
10512 build_desired_tool_bar_string (f
);
10513 nlines
= tool_bar_lines_needed (f
, NULL
);
10517 return make_number (nlines
);
10521 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
10522 height should be changed. */
10525 redisplay_tool_bar (struct frame
*f
)
10529 struct glyph_row
*row
;
10531 #if defined (USE_GTK) || defined (HAVE_NS)
10532 if (FRAME_EXTERNAL_TOOL_BAR (f
))
10533 update_frame_tool_bar (f
);
10537 /* If frame hasn't a tool-bar window or if it is zero-height, don't
10538 do anything. This means you must start with tool-bar-lines
10539 non-zero to get the auto-sizing effect. Or in other words, you
10540 can turn off tool-bars by specifying tool-bar-lines zero. */
10541 if (!WINDOWP (f
->tool_bar_window
)
10542 || (w
= XWINDOW (f
->tool_bar_window
),
10543 WINDOW_TOTAL_LINES (w
) == 0))
10546 /* Set up an iterator for the tool-bar window. */
10547 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
10548 it
.first_visible_x
= 0;
10549 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10550 row
= it
.glyph_row
;
10552 /* Build a string that represents the contents of the tool-bar. */
10553 build_desired_tool_bar_string (f
);
10554 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10556 if (f
->n_tool_bar_rows
== 0)
10560 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
10561 nlines
!= WINDOW_TOTAL_LINES (w
)))
10564 int old_height
= WINDOW_TOTAL_LINES (w
);
10566 XSETFRAME (frame
, f
);
10567 Fmodify_frame_parameters (frame
,
10568 Fcons (Fcons (Qtool_bar_lines
,
10569 make_number (nlines
)),
10571 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10573 clear_glyph_matrix (w
->desired_matrix
);
10574 fonts_changed_p
= 1;
10580 /* Display as many lines as needed to display all tool-bar items. */
10582 if (f
->n_tool_bar_rows
> 0)
10584 int border
, rows
, height
, extra
;
10586 if (INTEGERP (Vtool_bar_border
))
10587 border
= XINT (Vtool_bar_border
);
10588 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
10589 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
10590 else if (EQ (Vtool_bar_border
, Qborder_width
))
10591 border
= f
->border_width
;
10597 rows
= f
->n_tool_bar_rows
;
10598 height
= max (1, (it
.last_visible_y
- border
) / rows
);
10599 extra
= it
.last_visible_y
- border
- height
* rows
;
10601 while (it
.current_y
< it
.last_visible_y
)
10604 if (extra
> 0 && rows
-- > 0)
10606 h
= (extra
+ rows
- 1) / rows
;
10609 display_tool_bar_line (&it
, height
+ h
);
10614 while (it
.current_y
< it
.last_visible_y
)
10615 display_tool_bar_line (&it
, 0);
10618 /* It doesn't make much sense to try scrolling in the tool-bar
10619 window, so don't do it. */
10620 w
->desired_matrix
->no_scrolling_p
= 1;
10621 w
->must_be_updated_p
= 1;
10623 if (!NILP (Vauto_resize_tool_bars
))
10625 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
10626 int change_height_p
= 0;
10628 /* If we couldn't display everything, change the tool-bar's
10629 height if there is room for more. */
10630 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
10631 && it
.current_y
< max_tool_bar_height
)
10632 change_height_p
= 1;
10634 row
= it
.glyph_row
- 1;
10636 /* If there are blank lines at the end, except for a partially
10637 visible blank line at the end that is smaller than
10638 FRAME_LINE_HEIGHT, change the tool-bar's height. */
10639 if (!row
->displays_text_p
10640 && row
->height
>= FRAME_LINE_HEIGHT (f
))
10641 change_height_p
= 1;
10643 /* If row displays tool-bar items, but is partially visible,
10644 change the tool-bar's height. */
10645 if (row
->displays_text_p
10646 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
10647 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
10648 change_height_p
= 1;
10650 /* Resize windows as needed by changing the `tool-bar-lines'
10651 frame parameter. */
10652 if (change_height_p
)
10655 int old_height
= WINDOW_TOTAL_LINES (w
);
10657 int nlines
= tool_bar_lines_needed (f
, &nrows
);
10659 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
10660 && !f
->minimize_tool_bar_window_p
)
10661 ? (nlines
> old_height
)
10662 : (nlines
!= old_height
));
10663 f
->minimize_tool_bar_window_p
= 0;
10665 if (change_height_p
)
10667 XSETFRAME (frame
, f
);
10668 Fmodify_frame_parameters (frame
,
10669 Fcons (Fcons (Qtool_bar_lines
,
10670 make_number (nlines
)),
10672 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10674 clear_glyph_matrix (w
->desired_matrix
);
10675 f
->n_tool_bar_rows
= nrows
;
10676 fonts_changed_p
= 1;
10683 f
->minimize_tool_bar_window_p
= 0;
10688 /* Get information about the tool-bar item which is displayed in GLYPH
10689 on frame F. Return in *PROP_IDX the index where tool-bar item
10690 properties start in F->tool_bar_items. Value is zero if
10691 GLYPH doesn't display a tool-bar item. */
10694 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
10700 /* This function can be called asynchronously, which means we must
10701 exclude any possibility that Fget_text_property signals an
10703 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
10704 charpos
= max (0, charpos
);
10706 /* Get the text property `menu-item' at pos. The value of that
10707 property is the start index of this item's properties in
10708 F->tool_bar_items. */
10709 prop
= Fget_text_property (make_number (charpos
),
10710 Qmenu_item
, f
->current_tool_bar_string
);
10711 if (INTEGERP (prop
))
10713 *prop_idx
= XINT (prop
);
10723 /* Get information about the tool-bar item at position X/Y on frame F.
10724 Return in *GLYPH a pointer to the glyph of the tool-bar item in
10725 the current matrix of the tool-bar window of F, or NULL if not
10726 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
10727 item in F->tool_bar_items. Value is
10729 -1 if X/Y is not on a tool-bar item
10730 0 if X/Y is on the same item that was highlighted before.
10734 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
10735 int *hpos
, int *vpos
, int *prop_idx
)
10737 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10738 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10741 /* Find the glyph under X/Y. */
10742 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
10743 if (*glyph
== NULL
)
10746 /* Get the start of this tool-bar item's properties in
10747 f->tool_bar_items. */
10748 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
10751 /* Is mouse on the highlighted item? */
10752 if (EQ (f
->tool_bar_window
, dpyinfo
->mouse_face_window
)
10753 && *vpos
>= dpyinfo
->mouse_face_beg_row
10754 && *vpos
<= dpyinfo
->mouse_face_end_row
10755 && (*vpos
> dpyinfo
->mouse_face_beg_row
10756 || *hpos
>= dpyinfo
->mouse_face_beg_col
)
10757 && (*vpos
< dpyinfo
->mouse_face_end_row
10758 || *hpos
< dpyinfo
->mouse_face_end_col
10759 || dpyinfo
->mouse_face_past_end
))
10767 Handle mouse button event on the tool-bar of frame F, at
10768 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
10769 0 for button release. MODIFIERS is event modifiers for button
10773 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
10774 unsigned int modifiers
)
10776 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10777 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10778 int hpos
, vpos
, prop_idx
;
10779 struct glyph
*glyph
;
10780 Lisp_Object enabled_p
;
10782 /* If not on the highlighted tool-bar item, return. */
10783 frame_to_window_pixel_xy (w
, &x
, &y
);
10784 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
10787 /* If item is disabled, do nothing. */
10788 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10789 if (NILP (enabled_p
))
10794 /* Show item in pressed state. */
10795 show_mouse_face (dpyinfo
, DRAW_IMAGE_SUNKEN
);
10796 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
10797 last_tool_bar_item
= prop_idx
;
10801 Lisp_Object key
, frame
;
10802 struct input_event event
;
10803 EVENT_INIT (event
);
10805 /* Show item in released state. */
10806 show_mouse_face (dpyinfo
, DRAW_IMAGE_RAISED
);
10807 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
10809 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
10811 XSETFRAME (frame
, f
);
10812 event
.kind
= TOOL_BAR_EVENT
;
10813 event
.frame_or_window
= frame
;
10815 kbd_buffer_store_event (&event
);
10817 event
.kind
= TOOL_BAR_EVENT
;
10818 event
.frame_or_window
= frame
;
10820 event
.modifiers
= modifiers
;
10821 kbd_buffer_store_event (&event
);
10822 last_tool_bar_item
= -1;
10827 /* Possibly highlight a tool-bar item on frame F when mouse moves to
10828 tool-bar window-relative coordinates X/Y. Called from
10829 note_mouse_highlight. */
10832 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
10834 Lisp_Object window
= f
->tool_bar_window
;
10835 struct window
*w
= XWINDOW (window
);
10836 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10838 struct glyph
*glyph
;
10839 struct glyph_row
*row
;
10841 Lisp_Object enabled_p
;
10843 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
10844 int mouse_down_p
, rc
;
10846 /* Function note_mouse_highlight is called with negative X/Y
10847 values when mouse moves outside of the frame. */
10848 if (x
<= 0 || y
<= 0)
10850 clear_mouse_face (dpyinfo
);
10854 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
10857 /* Not on tool-bar item. */
10858 clear_mouse_face (dpyinfo
);
10862 /* On same tool-bar item as before. */
10863 goto set_help_echo
;
10865 clear_mouse_face (dpyinfo
);
10867 /* Mouse is down, but on different tool-bar item? */
10868 mouse_down_p
= (dpyinfo
->grabbed
10869 && f
== last_mouse_frame
10870 && FRAME_LIVE_P (f
));
10872 && last_tool_bar_item
!= prop_idx
)
10875 dpyinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
10876 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
10878 /* If tool-bar item is not enabled, don't highlight it. */
10879 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10880 if (!NILP (enabled_p
))
10882 /* Compute the x-position of the glyph. In front and past the
10883 image is a space. We include this in the highlighted area. */
10884 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
10885 for (i
= x
= 0; i
< hpos
; ++i
)
10886 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
10888 /* Record this as the current active region. */
10889 dpyinfo
->mouse_face_beg_col
= hpos
;
10890 dpyinfo
->mouse_face_beg_row
= vpos
;
10891 dpyinfo
->mouse_face_beg_x
= x
;
10892 dpyinfo
->mouse_face_beg_y
= row
->y
;
10893 dpyinfo
->mouse_face_past_end
= 0;
10895 dpyinfo
->mouse_face_end_col
= hpos
+ 1;
10896 dpyinfo
->mouse_face_end_row
= vpos
;
10897 dpyinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
10898 dpyinfo
->mouse_face_end_y
= row
->y
;
10899 dpyinfo
->mouse_face_window
= window
;
10900 dpyinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
10902 /* Display it as active. */
10903 show_mouse_face (dpyinfo
, draw
);
10904 dpyinfo
->mouse_face_image_state
= draw
;
10909 /* Set help_echo_string to a help string to display for this tool-bar item.
10910 XTread_socket does the rest. */
10911 help_echo_object
= help_echo_window
= Qnil
;
10912 help_echo_pos
= -1;
10913 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
10914 if (NILP (help_echo_string
))
10915 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
10918 #endif /* HAVE_WINDOW_SYSTEM */
10922 /************************************************************************
10923 Horizontal scrolling
10924 ************************************************************************/
10926 static int hscroll_window_tree (Lisp_Object
);
10927 static int hscroll_windows (Lisp_Object
);
10929 /* For all leaf windows in the window tree rooted at WINDOW, set their
10930 hscroll value so that PT is (i) visible in the window, and (ii) so
10931 that it is not within a certain margin at the window's left and
10932 right border. Value is non-zero if any window's hscroll has been
10936 hscroll_window_tree (Lisp_Object window
)
10938 int hscrolled_p
= 0;
10939 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
10940 int hscroll_step_abs
= 0;
10941 double hscroll_step_rel
= 0;
10943 if (hscroll_relative_p
)
10945 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
10946 if (hscroll_step_rel
< 0)
10948 hscroll_relative_p
= 0;
10949 hscroll_step_abs
= 0;
10952 else if (INTEGERP (Vhscroll_step
))
10954 hscroll_step_abs
= XINT (Vhscroll_step
);
10955 if (hscroll_step_abs
< 0)
10956 hscroll_step_abs
= 0;
10959 hscroll_step_abs
= 0;
10961 while (WINDOWP (window
))
10963 struct window
*w
= XWINDOW (window
);
10965 if (WINDOWP (w
->hchild
))
10966 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
10967 else if (WINDOWP (w
->vchild
))
10968 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
10969 else if (w
->cursor
.vpos
>= 0)
10972 int text_area_width
;
10973 struct glyph_row
*current_cursor_row
10974 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
10975 struct glyph_row
*desired_cursor_row
10976 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
10977 struct glyph_row
*cursor_row
10978 = (desired_cursor_row
->enabled_p
10979 ? desired_cursor_row
10980 : current_cursor_row
);
10982 text_area_width
= window_box_width (w
, TEXT_AREA
);
10984 /* Scroll when cursor is inside this scroll margin. */
10985 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
10987 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
10988 && ((XFASTINT (w
->hscroll
)
10989 && w
->cursor
.x
<= h_margin
)
10990 || (cursor_row
->enabled_p
10991 && cursor_row
->truncated_on_right_p
10992 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
10996 struct buffer
*saved_current_buffer
;
11000 /* Find point in a display of infinite width. */
11001 saved_current_buffer
= current_buffer
;
11002 current_buffer
= XBUFFER (w
->buffer
);
11004 if (w
== XWINDOW (selected_window
))
11005 pt
= BUF_PT (current_buffer
);
11008 pt
= marker_position (w
->pointm
);
11009 pt
= max (BEGV
, pt
);
11013 /* Move iterator to pt starting at cursor_row->start in
11014 a line with infinite width. */
11015 init_to_row_start (&it
, w
, cursor_row
);
11016 it
.last_visible_x
= INFINITY
;
11017 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
11018 current_buffer
= saved_current_buffer
;
11020 /* Position cursor in window. */
11021 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
11022 hscroll
= max (0, (it
.current_x
11023 - (ITERATOR_AT_END_OF_LINE_P (&it
)
11024 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
11025 : (text_area_width
/ 2))))
11026 / FRAME_COLUMN_WIDTH (it
.f
);
11027 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
11029 if (hscroll_relative_p
)
11030 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
11033 wanted_x
= text_area_width
11034 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11037 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11041 if (hscroll_relative_p
)
11042 wanted_x
= text_area_width
* hscroll_step_rel
11045 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11048 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11050 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
11052 /* Don't call Fset_window_hscroll if value hasn't
11053 changed because it will prevent redisplay
11055 if (XFASTINT (w
->hscroll
) != hscroll
)
11057 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
11058 w
->hscroll
= make_number (hscroll
);
11067 /* Value is non-zero if hscroll of any leaf window has been changed. */
11068 return hscrolled_p
;
11072 /* Set hscroll so that cursor is visible and not inside horizontal
11073 scroll margins for all windows in the tree rooted at WINDOW. See
11074 also hscroll_window_tree above. Value is non-zero if any window's
11075 hscroll has been changed. If it has, desired matrices on the frame
11076 of WINDOW are cleared. */
11079 hscroll_windows (Lisp_Object window
)
11081 int hscrolled_p
= hscroll_window_tree (window
);
11083 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
11084 return hscrolled_p
;
11089 /************************************************************************
11091 ************************************************************************/
11093 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
11094 to a non-zero value. This is sometimes handy to have in a debugger
11099 /* First and last unchanged row for try_window_id. */
11101 int debug_first_unchanged_at_end_vpos
;
11102 int debug_last_unchanged_at_beg_vpos
;
11104 /* Delta vpos and y. */
11106 int debug_dvpos
, debug_dy
;
11108 /* Delta in characters and bytes for try_window_id. */
11110 EMACS_INT debug_delta
, debug_delta_bytes
;
11112 /* Values of window_end_pos and window_end_vpos at the end of
11115 EMACS_INT debug_end_pos
, debug_end_vpos
;
11117 /* Append a string to W->desired_matrix->method. FMT is a printf
11118 format string. A1...A9 are a supplement for a variable-length
11119 argument list. If trace_redisplay_p is non-zero also printf the
11120 resulting string to stderr. */
11123 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
11126 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
11129 char *method
= w
->desired_matrix
->method
;
11130 int len
= strlen (method
);
11131 int size
= sizeof w
->desired_matrix
->method
;
11132 int remaining
= size
- len
- 1;
11134 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
11135 if (len
&& remaining
)
11138 --remaining
, ++len
;
11141 strncpy (method
+ len
, buffer
, remaining
);
11143 if (trace_redisplay_p
)
11144 fprintf (stderr
, "%p (%s): %s\n",
11146 ((BUFFERP (w
->buffer
)
11147 && STRINGP (XBUFFER (w
->buffer
)->name
))
11148 ? (char *) SDATA (XBUFFER (w
->buffer
)->name
)
11153 #endif /* GLYPH_DEBUG */
11156 /* Value is non-zero if all changes in window W, which displays
11157 current_buffer, are in the text between START and END. START is a
11158 buffer position, END is given as a distance from Z. Used in
11159 redisplay_internal for display optimization. */
11162 text_outside_line_unchanged_p (struct window
*w
,
11163 EMACS_INT start
, EMACS_INT end
)
11165 int unchanged_p
= 1;
11167 /* If text or overlays have changed, see where. */
11168 if (XFASTINT (w
->last_modified
) < MODIFF
11169 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11171 /* Gap in the line? */
11172 if (GPT
< start
|| Z
- GPT
< end
)
11175 /* Changes start in front of the line, or end after it? */
11177 && (BEG_UNCHANGED
< start
- 1
11178 || END_UNCHANGED
< end
))
11181 /* If selective display, can't optimize if changes start at the
11182 beginning of the line. */
11184 && INTEGERP (current_buffer
->selective_display
)
11185 && XINT (current_buffer
->selective_display
) > 0
11186 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
11189 /* If there are overlays at the start or end of the line, these
11190 may have overlay strings with newlines in them. A change at
11191 START, for instance, may actually concern the display of such
11192 overlay strings as well, and they are displayed on different
11193 lines. So, quickly rule out this case. (For the future, it
11194 might be desirable to implement something more telling than
11195 just BEG/END_UNCHANGED.) */
11198 if (BEG
+ BEG_UNCHANGED
== start
11199 && overlay_touches_p (start
))
11201 if (END_UNCHANGED
== end
11202 && overlay_touches_p (Z
- end
))
11206 /* Under bidi reordering, adding or deleting a character in the
11207 beginning of a paragraph, before the first strong directional
11208 character, can change the base direction of the paragraph (unless
11209 the buffer specifies a fixed paragraph direction), which will
11210 require to redisplay the whole paragraph. It might be worthwhile
11211 to find the paragraph limits and widen the range of redisplayed
11212 lines to that, but for now just give up this optimization. */
11213 if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
)
11214 && NILP (XBUFFER (w
->buffer
)->bidi_paragraph_direction
))
11218 return unchanged_p
;
11222 /* Do a frame update, taking possible shortcuts into account. This is
11223 the main external entry point for redisplay.
11225 If the last redisplay displayed an echo area message and that message
11226 is no longer requested, we clear the echo area or bring back the
11227 mini-buffer if that is in use. */
11232 redisplay_internal (0);
11237 overlay_arrow_string_or_property (Lisp_Object var
)
11241 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
11244 return Voverlay_arrow_string
;
11247 /* Return 1 if there are any overlay-arrows in current_buffer. */
11249 overlay_arrow_in_current_buffer_p (void)
11253 for (vlist
= Voverlay_arrow_variable_list
;
11255 vlist
= XCDR (vlist
))
11257 Lisp_Object var
= XCAR (vlist
);
11260 if (!SYMBOLP (var
))
11262 val
= find_symbol_value (var
);
11264 && current_buffer
== XMARKER (val
)->buffer
)
11271 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
11275 overlay_arrows_changed_p (void)
11279 for (vlist
= Voverlay_arrow_variable_list
;
11281 vlist
= XCDR (vlist
))
11283 Lisp_Object var
= XCAR (vlist
);
11284 Lisp_Object val
, pstr
;
11286 if (!SYMBOLP (var
))
11288 val
= find_symbol_value (var
);
11289 if (!MARKERP (val
))
11291 if (! EQ (COERCE_MARKER (val
),
11292 Fget (var
, Qlast_arrow_position
))
11293 || ! (pstr
= overlay_arrow_string_or_property (var
),
11294 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
11300 /* Mark overlay arrows to be updated on next redisplay. */
11303 update_overlay_arrows (int up_to_date
)
11307 for (vlist
= Voverlay_arrow_variable_list
;
11309 vlist
= XCDR (vlist
))
11311 Lisp_Object var
= XCAR (vlist
);
11313 if (!SYMBOLP (var
))
11316 if (up_to_date
> 0)
11318 Lisp_Object val
= find_symbol_value (var
);
11319 Fput (var
, Qlast_arrow_position
,
11320 COERCE_MARKER (val
));
11321 Fput (var
, Qlast_arrow_string
,
11322 overlay_arrow_string_or_property (var
));
11324 else if (up_to_date
< 0
11325 || !NILP (Fget (var
, Qlast_arrow_position
)))
11327 Fput (var
, Qlast_arrow_position
, Qt
);
11328 Fput (var
, Qlast_arrow_string
, Qt
);
11334 /* Return overlay arrow string to display at row.
11335 Return integer (bitmap number) for arrow bitmap in left fringe.
11336 Return nil if no overlay arrow. */
11339 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
11343 for (vlist
= Voverlay_arrow_variable_list
;
11345 vlist
= XCDR (vlist
))
11347 Lisp_Object var
= XCAR (vlist
);
11350 if (!SYMBOLP (var
))
11353 val
= find_symbol_value (var
);
11356 && current_buffer
== XMARKER (val
)->buffer
11357 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
11359 if (FRAME_WINDOW_P (it
->f
)
11360 /* FIXME: if ROW->reversed_p is set, this should test
11361 the right fringe, not the left one. */
11362 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
11364 #ifdef HAVE_WINDOW_SYSTEM
11365 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
11368 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
11369 return make_number (fringe_bitmap
);
11372 return make_number (-1); /* Use default arrow bitmap */
11374 return overlay_arrow_string_or_property (var
);
11381 /* Return 1 if point moved out of or into a composition. Otherwise
11382 return 0. PREV_BUF and PREV_PT are the last point buffer and
11383 position. BUF and PT are the current point buffer and position. */
11386 check_point_in_composition (struct buffer
*prev_buf
, EMACS_INT prev_pt
,
11387 struct buffer
*buf
, EMACS_INT pt
)
11389 EMACS_INT start
, end
;
11391 Lisp_Object buffer
;
11393 XSETBUFFER (buffer
, buf
);
11394 /* Check a composition at the last point if point moved within the
11396 if (prev_buf
== buf
)
11399 /* Point didn't move. */
11402 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
11403 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
11404 && COMPOSITION_VALID_P (start
, end
, prop
)
11405 && start
< prev_pt
&& end
> prev_pt
)
11406 /* The last point was within the composition. Return 1 iff
11407 point moved out of the composition. */
11408 return (pt
<= start
|| pt
>= end
);
11411 /* Check a composition at the current point. */
11412 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
11413 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
11414 && COMPOSITION_VALID_P (start
, end
, prop
)
11415 && start
< pt
&& end
> pt
);
11419 /* Reconsider the setting of B->clip_changed which is displayed
11423 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
11425 if (b
->clip_changed
11426 && !NILP (w
->window_end_valid
)
11427 && w
->current_matrix
->buffer
== b
11428 && w
->current_matrix
->zv
== BUF_ZV (b
)
11429 && w
->current_matrix
->begv
== BUF_BEGV (b
))
11430 b
->clip_changed
= 0;
11432 /* If display wasn't paused, and W is not a tool bar window, see if
11433 point has been moved into or out of a composition. In that case,
11434 we set b->clip_changed to 1 to force updating the screen. If
11435 b->clip_changed has already been set to 1, we can skip this
11437 if (!b
->clip_changed
11438 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
11442 if (w
== XWINDOW (selected_window
))
11443 pt
= BUF_PT (current_buffer
);
11445 pt
= marker_position (w
->pointm
);
11447 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
11448 || pt
!= XINT (w
->last_point
))
11449 && check_point_in_composition (w
->current_matrix
->buffer
,
11450 XINT (w
->last_point
),
11451 XBUFFER (w
->buffer
), pt
))
11452 b
->clip_changed
= 1;
11457 /* Select FRAME to forward the values of frame-local variables into C
11458 variables so that the redisplay routines can access those values
11462 select_frame_for_redisplay (Lisp_Object frame
)
11464 Lisp_Object tail
, tem
;
11465 Lisp_Object old
= selected_frame
;
11466 struct Lisp_Symbol
*sym
;
11468 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
11470 selected_frame
= frame
;
11473 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
11474 if (CONSP (XCAR (tail
))
11475 && (tem
= XCAR (XCAR (tail
)),
11477 && (sym
= indirect_variable (XSYMBOL (tem
)),
11478 sym
->redirect
== SYMBOL_LOCALIZED
)
11479 && sym
->val
.blv
->frame_local
)
11480 /* Use find_symbol_value rather than Fsymbol_value
11481 to avoid an error if it is void. */
11482 find_symbol_value (tem
);
11483 } while (!EQ (frame
, old
) && (frame
= old
, 1));
11487 #define STOP_POLLING \
11488 do { if (! polling_stopped_here) stop_polling (); \
11489 polling_stopped_here = 1; } while (0)
11491 #define RESUME_POLLING \
11492 do { if (polling_stopped_here) start_polling (); \
11493 polling_stopped_here = 0; } while (0)
11496 /* If PRESERVE_ECHO_AREA is nonzero, it means this redisplay is not in
11497 response to any user action; therefore, we should preserve the echo
11498 area. (Actually, our caller does that job.) Perhaps in the future
11499 avoid recentering windows if it is not necessary; currently that
11500 causes some problems. */
11503 redisplay_internal (int preserve_echo_area
)
11505 struct window
*w
= XWINDOW (selected_window
);
11508 int must_finish
= 0;
11509 struct text_pos tlbufpos
, tlendpos
;
11510 int number_of_visible_frames
;
11513 int polling_stopped_here
= 0;
11514 Lisp_Object old_frame
= selected_frame
;
11516 /* Non-zero means redisplay has to consider all windows on all
11517 frames. Zero means, only selected_window is considered. */
11518 int consider_all_windows_p
;
11520 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
11522 /* No redisplay if running in batch mode or frame is not yet fully
11523 initialized, or redisplay is explicitly turned off by setting
11524 Vinhibit_redisplay. */
11525 if (FRAME_INITIAL_P (SELECTED_FRAME ())
11526 || !NILP (Vinhibit_redisplay
))
11529 /* Don't examine these until after testing Vinhibit_redisplay.
11530 When Emacs is shutting down, perhaps because its connection to
11531 X has dropped, we should not look at them at all. */
11532 f
= XFRAME (w
->frame
);
11533 sf
= SELECTED_FRAME ();
11535 if (!f
->glyphs_initialized_p
)
11538 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
11539 if (popup_activated ())
11543 /* I don't think this happens but let's be paranoid. */
11544 if (redisplaying_p
)
11547 /* Record a function that resets redisplaying_p to its old value
11548 when we leave this function. */
11549 count
= SPECPDL_INDEX ();
11550 record_unwind_protect (unwind_redisplay
,
11551 Fcons (make_number (redisplaying_p
), selected_frame
));
11553 specbind (Qinhibit_free_realized_faces
, Qnil
);
11556 Lisp_Object tail
, frame
;
11558 FOR_EACH_FRAME (tail
, frame
)
11560 struct frame
*f
= XFRAME (frame
);
11561 f
->already_hscrolled_p
= 0;
11566 if (!EQ (old_frame
, selected_frame
)
11567 && FRAME_LIVE_P (XFRAME (old_frame
)))
11568 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
11569 selected_frame and selected_window to be temporarily out-of-sync so
11570 when we come back here via `goto retry', we need to resync because we
11571 may need to run Elisp code (via prepare_menu_bars). */
11572 select_frame_for_redisplay (old_frame
);
11575 reconsider_clip_changes (w
, current_buffer
);
11576 last_escape_glyph_frame
= NULL
;
11577 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
11579 /* If new fonts have been loaded that make a glyph matrix adjustment
11580 necessary, do it. */
11581 if (fonts_changed_p
)
11583 adjust_glyphs (NULL
);
11584 ++windows_or_buffers_changed
;
11585 fonts_changed_p
= 0;
11588 /* If face_change_count is non-zero, init_iterator will free all
11589 realized faces, which includes the faces referenced from current
11590 matrices. So, we can't reuse current matrices in this case. */
11591 if (face_change_count
)
11592 ++windows_or_buffers_changed
;
11594 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11595 && FRAME_TTY (sf
)->previous_frame
!= sf
)
11597 /* Since frames on a single ASCII terminal share the same
11598 display area, displaying a different frame means redisplay
11599 the whole thing. */
11600 windows_or_buffers_changed
++;
11601 SET_FRAME_GARBAGED (sf
);
11603 set_tty_color_mode (FRAME_TTY (sf
), sf
);
11605 FRAME_TTY (sf
)->previous_frame
= sf
;
11608 /* Set the visible flags for all frames. Do this before checking
11609 for resized or garbaged frames; they want to know if their frames
11610 are visible. See the comment in frame.h for
11611 FRAME_SAMPLE_VISIBILITY. */
11613 Lisp_Object tail
, frame
;
11615 number_of_visible_frames
= 0;
11617 FOR_EACH_FRAME (tail
, frame
)
11619 struct frame
*f
= XFRAME (frame
);
11621 FRAME_SAMPLE_VISIBILITY (f
);
11622 if (FRAME_VISIBLE_P (f
))
11623 ++number_of_visible_frames
;
11624 clear_desired_matrices (f
);
11628 /* Notice any pending interrupt request to change frame size. */
11629 do_pending_window_change (1);
11631 /* Clear frames marked as garbaged. */
11632 if (frame_garbaged
)
11633 clear_garbaged_frames ();
11635 /* Build menubar and tool-bar items. */
11636 if (NILP (Vmemory_full
))
11637 prepare_menu_bars ();
11639 if (windows_or_buffers_changed
)
11640 update_mode_lines
++;
11642 /* Detect case that we need to write or remove a star in the mode line. */
11643 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
11645 w
->update_mode_line
= Qt
;
11646 if (buffer_shared
> 1)
11647 update_mode_lines
++;
11650 /* Avoid invocation of point motion hooks by `current_column' below. */
11651 count1
= SPECPDL_INDEX ();
11652 specbind (Qinhibit_point_motion_hooks
, Qt
);
11654 /* If %c is in the mode line, update it if needed. */
11655 if (!NILP (w
->column_number_displayed
)
11656 /* This alternative quickly identifies a common case
11657 where no change is needed. */
11658 && !(PT
== XFASTINT (w
->last_point
)
11659 && XFASTINT (w
->last_modified
) >= MODIFF
11660 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
11661 && (XFASTINT (w
->column_number_displayed
)
11662 != (int) current_column ())) /* iftc */
11663 w
->update_mode_line
= Qt
;
11665 unbind_to (count1
, Qnil
);
11667 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
11669 /* The variable buffer_shared is set in redisplay_window and
11670 indicates that we redisplay a buffer in different windows. See
11672 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
11673 || cursor_type_changed
);
11675 /* If specs for an arrow have changed, do thorough redisplay
11676 to ensure we remove any arrow that should no longer exist. */
11677 if (overlay_arrows_changed_p ())
11678 consider_all_windows_p
= windows_or_buffers_changed
= 1;
11680 /* Normally the message* functions will have already displayed and
11681 updated the echo area, but the frame may have been trashed, or
11682 the update may have been preempted, so display the echo area
11683 again here. Checking message_cleared_p captures the case that
11684 the echo area should be cleared. */
11685 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
11686 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
11687 || (message_cleared_p
11688 && minibuf_level
== 0
11689 /* If the mini-window is currently selected, this means the
11690 echo-area doesn't show through. */
11691 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
11693 int window_height_changed_p
= echo_area_display (0);
11696 /* If we don't display the current message, don't clear the
11697 message_cleared_p flag, because, if we did, we wouldn't clear
11698 the echo area in the next redisplay which doesn't preserve
11700 if (!display_last_displayed_message_p
)
11701 message_cleared_p
= 0;
11703 if (fonts_changed_p
)
11705 else if (window_height_changed_p
)
11707 consider_all_windows_p
= 1;
11708 ++update_mode_lines
;
11709 ++windows_or_buffers_changed
;
11711 /* If window configuration was changed, frames may have been
11712 marked garbaged. Clear them or we will experience
11713 surprises wrt scrolling. */
11714 if (frame_garbaged
)
11715 clear_garbaged_frames ();
11718 else if (EQ (selected_window
, minibuf_window
)
11719 && (current_buffer
->clip_changed
11720 || XFASTINT (w
->last_modified
) < MODIFF
11721 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11722 && resize_mini_window (w
, 0))
11724 /* Resized active mini-window to fit the size of what it is
11725 showing if its contents might have changed. */
11727 /* FIXME: this causes all frames to be updated, which seems unnecessary
11728 since only the current frame needs to be considered. This function needs
11729 to be rewritten with two variables, consider_all_windows and
11730 consider_all_frames. */
11731 consider_all_windows_p
= 1;
11732 ++windows_or_buffers_changed
;
11733 ++update_mode_lines
;
11735 /* If window configuration was changed, frames may have been
11736 marked garbaged. Clear them or we will experience
11737 surprises wrt scrolling. */
11738 if (frame_garbaged
)
11739 clear_garbaged_frames ();
11743 /* If showing the region, and mark has changed, we must redisplay
11744 the whole window. The assignment to this_line_start_pos prevents
11745 the optimization directly below this if-statement. */
11746 if (((!NILP (Vtransient_mark_mode
)
11747 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
11748 != !NILP (w
->region_showing
))
11749 || (!NILP (w
->region_showing
)
11750 && !EQ (w
->region_showing
,
11751 Fmarker_position (XBUFFER (w
->buffer
)->mark
))))
11752 CHARPOS (this_line_start_pos
) = 0;
11754 /* Optimize the case that only the line containing the cursor in the
11755 selected window has changed. Variables starting with this_ are
11756 set in display_line and record information about the line
11757 containing the cursor. */
11758 tlbufpos
= this_line_start_pos
;
11759 tlendpos
= this_line_end_pos
;
11760 if (!consider_all_windows_p
11761 && CHARPOS (tlbufpos
) > 0
11762 && NILP (w
->update_mode_line
)
11763 && !current_buffer
->clip_changed
11764 && !current_buffer
->prevent_redisplay_optimizations_p
11765 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
11766 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
11767 /* Make sure recorded data applies to current buffer, etc. */
11768 && this_line_buffer
== current_buffer
11769 && current_buffer
== XBUFFER (w
->buffer
)
11770 && NILP (w
->force_start
)
11771 && NILP (w
->optional_new_start
)
11772 /* Point must be on the line that we have info recorded about. */
11773 && PT
>= CHARPOS (tlbufpos
)
11774 && PT
<= Z
- CHARPOS (tlendpos
)
11775 /* All text outside that line, including its final newline,
11776 must be unchanged. */
11777 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
11778 CHARPOS (tlendpos
)))
11780 if (CHARPOS (tlbufpos
) > BEGV
11781 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
11782 && (CHARPOS (tlbufpos
) == ZV
11783 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
11784 /* Former continuation line has disappeared by becoming empty. */
11786 else if (XFASTINT (w
->last_modified
) < MODIFF
11787 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
11788 || MINI_WINDOW_P (w
))
11790 /* We have to handle the case of continuation around a
11791 wide-column character (see the comment in indent.c around
11794 For instance, in the following case:
11796 -------- Insert --------
11797 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
11798 J_I_ ==> J_I_ `^^' are cursors.
11802 As we have to redraw the line above, we cannot use this
11806 int line_height_before
= this_line_pixel_height
;
11808 /* Note that start_display will handle the case that the
11809 line starting at tlbufpos is a continuation line. */
11810 start_display (&it
, w
, tlbufpos
);
11812 /* Implementation note: It this still necessary? */
11813 if (it
.current_x
!= this_line_start_x
)
11816 TRACE ((stderr
, "trying display optimization 1\n"));
11817 w
->cursor
.vpos
= -1;
11818 overlay_arrow_seen
= 0;
11819 it
.vpos
= this_line_vpos
;
11820 it
.current_y
= this_line_y
;
11821 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
11822 display_line (&it
);
11824 /* If line contains point, is not continued,
11825 and ends at same distance from eob as before, we win. */
11826 if (w
->cursor
.vpos
>= 0
11827 /* Line is not continued, otherwise this_line_start_pos
11828 would have been set to 0 in display_line. */
11829 && CHARPOS (this_line_start_pos
)
11830 /* Line ends as before. */
11831 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
11832 /* Line has same height as before. Otherwise other lines
11833 would have to be shifted up or down. */
11834 && this_line_pixel_height
== line_height_before
)
11836 /* If this is not the window's last line, we must adjust
11837 the charstarts of the lines below. */
11838 if (it
.current_y
< it
.last_visible_y
)
11840 struct glyph_row
*row
11841 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
11842 EMACS_INT delta
, delta_bytes
;
11844 /* We used to distinguish between two cases here,
11845 conditioned by Z - CHARPOS (tlendpos) == ZV, for
11846 when the line ends in a newline or the end of the
11847 buffer's accessible portion. But both cases did
11848 the same, so they were collapsed. */
11850 - CHARPOS (tlendpos
)
11851 - MATRIX_ROW_START_CHARPOS (row
));
11852 delta_bytes
= (Z_BYTE
11853 - BYTEPOS (tlendpos
)
11854 - MATRIX_ROW_START_BYTEPOS (row
));
11856 increment_matrix_positions (w
->current_matrix
,
11857 this_line_vpos
+ 1,
11858 w
->current_matrix
->nrows
,
11859 delta
, delta_bytes
);
11862 /* If this row displays text now but previously didn't,
11863 or vice versa, w->window_end_vpos may have to be
11865 if ((it
.glyph_row
- 1)->displays_text_p
)
11867 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
11868 XSETINT (w
->window_end_vpos
, this_line_vpos
);
11870 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
11871 && this_line_vpos
> 0)
11872 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
11873 w
->window_end_valid
= Qnil
;
11875 /* Update hint: No need to try to scroll in update_window. */
11876 w
->desired_matrix
->no_scrolling_p
= 1;
11879 *w
->desired_matrix
->method
= 0;
11880 debug_method_add (w
, "optimization 1");
11882 #ifdef HAVE_WINDOW_SYSTEM
11883 update_window_fringes (w
, 0);
11890 else if (/* Cursor position hasn't changed. */
11891 PT
== XFASTINT (w
->last_point
)
11892 /* Make sure the cursor was last displayed
11893 in this window. Otherwise we have to reposition it. */
11894 && 0 <= w
->cursor
.vpos
11895 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
11899 do_pending_window_change (1);
11901 /* We used to always goto end_of_redisplay here, but this
11902 isn't enough if we have a blinking cursor. */
11903 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
11904 goto end_of_redisplay
;
11908 /* If highlighting the region, or if the cursor is in the echo area,
11909 then we can't just move the cursor. */
11910 else if (! (!NILP (Vtransient_mark_mode
)
11911 && !NILP (current_buffer
->mark_active
))
11912 && (EQ (selected_window
, current_buffer
->last_selected_window
)
11913 || highlight_nonselected_windows
)
11914 && NILP (w
->region_showing
)
11915 && NILP (Vshow_trailing_whitespace
)
11916 && !cursor_in_echo_area
)
11919 struct glyph_row
*row
;
11921 /* Skip from tlbufpos to PT and see where it is. Note that
11922 PT may be in invisible text. If so, we will end at the
11923 next visible position. */
11924 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
11925 NULL
, DEFAULT_FACE_ID
);
11926 it
.current_x
= this_line_start_x
;
11927 it
.current_y
= this_line_y
;
11928 it
.vpos
= this_line_vpos
;
11930 /* The call to move_it_to stops in front of PT, but
11931 moves over before-strings. */
11932 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
11934 if (it
.vpos
== this_line_vpos
11935 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
11938 xassert (this_line_vpos
== it
.vpos
);
11939 xassert (this_line_y
== it
.current_y
);
11940 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
11942 *w
->desired_matrix
->method
= 0;
11943 debug_method_add (w
, "optimization 3");
11952 /* Text changed drastically or point moved off of line. */
11953 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
11956 CHARPOS (this_line_start_pos
) = 0;
11957 consider_all_windows_p
|= buffer_shared
> 1;
11958 ++clear_face_cache_count
;
11959 #ifdef HAVE_WINDOW_SYSTEM
11960 ++clear_image_cache_count
;
11963 /* Build desired matrices, and update the display. If
11964 consider_all_windows_p is non-zero, do it for all windows on all
11965 frames. Otherwise do it for selected_window, only. */
11967 if (consider_all_windows_p
)
11969 Lisp_Object tail
, frame
;
11971 FOR_EACH_FRAME (tail
, frame
)
11972 XFRAME (frame
)->updated_p
= 0;
11974 /* Recompute # windows showing selected buffer. This will be
11975 incremented each time such a window is displayed. */
11978 FOR_EACH_FRAME (tail
, frame
)
11980 struct frame
*f
= XFRAME (frame
);
11982 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
11984 if (! EQ (frame
, selected_frame
))
11985 /* Select the frame, for the sake of frame-local
11987 select_frame_for_redisplay (frame
);
11989 /* Mark all the scroll bars to be removed; we'll redeem
11990 the ones we want when we redisplay their windows. */
11991 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
11992 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
11994 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11995 redisplay_windows (FRAME_ROOT_WINDOW (f
));
11997 /* The X error handler may have deleted that frame. */
11998 if (!FRAME_LIVE_P (f
))
12001 /* Any scroll bars which redisplay_windows should have
12002 nuked should now go away. */
12003 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
12004 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
12006 /* If fonts changed, display again. */
12007 /* ??? rms: I suspect it is a mistake to jump all the way
12008 back to retry here. It should just retry this frame. */
12009 if (fonts_changed_p
)
12012 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12014 /* See if we have to hscroll. */
12015 if (!f
->already_hscrolled_p
)
12017 f
->already_hscrolled_p
= 1;
12018 if (hscroll_windows (f
->root_window
))
12022 /* Prevent various kinds of signals during display
12023 update. stdio is not robust about handling
12024 signals, which can cause an apparent I/O
12026 if (interrupt_input
)
12027 unrequest_sigio ();
12030 /* Update the display. */
12031 set_window_update_flags (XWINDOW (f
->root_window
), 1);
12032 pause
|= update_frame (f
, 0, 0);
12038 if (!EQ (old_frame
, selected_frame
)
12039 && FRAME_LIVE_P (XFRAME (old_frame
)))
12040 /* We played a bit fast-and-loose above and allowed selected_frame
12041 and selected_window to be temporarily out-of-sync but let's make
12042 sure this stays contained. */
12043 select_frame_for_redisplay (old_frame
);
12044 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
12048 /* Do the mark_window_display_accurate after all windows have
12049 been redisplayed because this call resets flags in buffers
12050 which are needed for proper redisplay. */
12051 FOR_EACH_FRAME (tail
, frame
)
12053 struct frame
*f
= XFRAME (frame
);
12056 mark_window_display_accurate (f
->root_window
, 1);
12057 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
12058 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
12063 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12065 Lisp_Object mini_window
;
12066 struct frame
*mini_frame
;
12068 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
12069 /* Use list_of_error, not Qerror, so that
12070 we catch only errors and don't run the debugger. */
12071 internal_condition_case_1 (redisplay_window_1
, selected_window
,
12073 redisplay_window_error
);
12075 /* Compare desired and current matrices, perform output. */
12078 /* If fonts changed, display again. */
12079 if (fonts_changed_p
)
12082 /* Prevent various kinds of signals during display update.
12083 stdio is not robust about handling signals,
12084 which can cause an apparent I/O error. */
12085 if (interrupt_input
)
12086 unrequest_sigio ();
12089 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12091 if (hscroll_windows (selected_window
))
12094 XWINDOW (selected_window
)->must_be_updated_p
= 1;
12095 pause
= update_frame (sf
, 0, 0);
12098 /* We may have called echo_area_display at the top of this
12099 function. If the echo area is on another frame, that may
12100 have put text on a frame other than the selected one, so the
12101 above call to update_frame would not have caught it. Catch
12103 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
12104 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
12106 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
12108 XWINDOW (mini_window
)->must_be_updated_p
= 1;
12109 pause
|= update_frame (mini_frame
, 0, 0);
12110 if (!pause
&& hscroll_windows (mini_window
))
12115 /* If display was paused because of pending input, make sure we do a
12116 thorough update the next time. */
12119 /* Prevent the optimization at the beginning of
12120 redisplay_internal that tries a single-line update of the
12121 line containing the cursor in the selected window. */
12122 CHARPOS (this_line_start_pos
) = 0;
12124 /* Let the overlay arrow be updated the next time. */
12125 update_overlay_arrows (0);
12127 /* If we pause after scrolling, some rows in the current
12128 matrices of some windows are not valid. */
12129 if (!WINDOW_FULL_WIDTH_P (w
)
12130 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
12131 update_mode_lines
= 1;
12135 if (!consider_all_windows_p
)
12137 /* This has already been done above if
12138 consider_all_windows_p is set. */
12139 mark_window_display_accurate_1 (w
, 1);
12141 /* Say overlay arrows are up to date. */
12142 update_overlay_arrows (1);
12144 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
12145 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
12148 update_mode_lines
= 0;
12149 windows_or_buffers_changed
= 0;
12150 cursor_type_changed
= 0;
12153 /* Start SIGIO interrupts coming again. Having them off during the
12154 code above makes it less likely one will discard output, but not
12155 impossible, since there might be stuff in the system buffer here.
12156 But it is much hairier to try to do anything about that. */
12157 if (interrupt_input
)
12161 /* If a frame has become visible which was not before, redisplay
12162 again, so that we display it. Expose events for such a frame
12163 (which it gets when becoming visible) don't call the parts of
12164 redisplay constructing glyphs, so simply exposing a frame won't
12165 display anything in this case. So, we have to display these
12166 frames here explicitly. */
12169 Lisp_Object tail
, frame
;
12172 FOR_EACH_FRAME (tail
, frame
)
12174 int this_is_visible
= 0;
12176 if (XFRAME (frame
)->visible
)
12177 this_is_visible
= 1;
12178 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
12179 if (XFRAME (frame
)->visible
)
12180 this_is_visible
= 1;
12182 if (this_is_visible
)
12186 if (new_count
!= number_of_visible_frames
)
12187 windows_or_buffers_changed
++;
12190 /* Change frame size now if a change is pending. */
12191 do_pending_window_change (1);
12193 /* If we just did a pending size change, or have additional
12194 visible frames, redisplay again. */
12195 if (windows_or_buffers_changed
&& !pause
)
12198 /* Clear the face and image caches.
12200 We used to do this only if consider_all_windows_p. But the cache
12201 needs to be cleared if a timer creates images in the current
12202 buffer (e.g. the test case in Bug#6230). */
12204 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
12206 clear_face_cache (0);
12207 clear_face_cache_count
= 0;
12210 #ifdef HAVE_WINDOW_SYSTEM
12211 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
12213 clear_image_caches (Qnil
);
12214 clear_image_cache_count
= 0;
12216 #endif /* HAVE_WINDOW_SYSTEM */
12219 unbind_to (count
, Qnil
);
12224 /* Redisplay, but leave alone any recent echo area message unless
12225 another message has been requested in its place.
12227 This is useful in situations where you need to redisplay but no
12228 user action has occurred, making it inappropriate for the message
12229 area to be cleared. See tracking_off and
12230 wait_reading_process_output for examples of these situations.
12232 FROM_WHERE is an integer saying from where this function was
12233 called. This is useful for debugging. */
12236 redisplay_preserve_echo_area (int from_where
)
12238 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
12240 if (!NILP (echo_area_buffer
[1]))
12242 /* We have a previously displayed message, but no current
12243 message. Redisplay the previous message. */
12244 display_last_displayed_message_p
= 1;
12245 redisplay_internal (1);
12246 display_last_displayed_message_p
= 0;
12249 redisplay_internal (1);
12251 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
12252 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
12253 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
12257 /* Function registered with record_unwind_protect in
12258 redisplay_internal. Reset redisplaying_p to the value it had
12259 before redisplay_internal was called, and clear
12260 prevent_freeing_realized_faces_p. It also selects the previously
12261 selected frame, unless it has been deleted (by an X connection
12262 failure during redisplay, for example). */
12265 unwind_redisplay (Lisp_Object val
)
12267 Lisp_Object old_redisplaying_p
, old_frame
;
12269 old_redisplaying_p
= XCAR (val
);
12270 redisplaying_p
= XFASTINT (old_redisplaying_p
);
12271 old_frame
= XCDR (val
);
12272 if (! EQ (old_frame
, selected_frame
)
12273 && FRAME_LIVE_P (XFRAME (old_frame
)))
12274 select_frame_for_redisplay (old_frame
);
12279 /* Mark the display of window W as accurate or inaccurate. If
12280 ACCURATE_P is non-zero mark display of W as accurate. If
12281 ACCURATE_P is zero, arrange for W to be redisplayed the next time
12282 redisplay_internal is called. */
12285 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
12287 if (BUFFERP (w
->buffer
))
12289 struct buffer
*b
= XBUFFER (w
->buffer
);
12292 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
12293 w
->last_overlay_modified
12294 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
12296 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
12300 b
->clip_changed
= 0;
12301 b
->prevent_redisplay_optimizations_p
= 0;
12303 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
12304 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
12305 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
12306 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
12308 w
->current_matrix
->buffer
= b
;
12309 w
->current_matrix
->begv
= BUF_BEGV (b
);
12310 w
->current_matrix
->zv
= BUF_ZV (b
);
12312 w
->last_cursor
= w
->cursor
;
12313 w
->last_cursor_off_p
= w
->cursor_off_p
;
12315 if (w
== XWINDOW (selected_window
))
12316 w
->last_point
= make_number (BUF_PT (b
));
12318 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
12324 w
->window_end_valid
= w
->buffer
;
12325 w
->update_mode_line
= Qnil
;
12330 /* Mark the display of windows in the window tree rooted at WINDOW as
12331 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
12332 windows as accurate. If ACCURATE_P is zero, arrange for windows to
12333 be redisplayed the next time redisplay_internal is called. */
12336 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
12340 for (; !NILP (window
); window
= w
->next
)
12342 w
= XWINDOW (window
);
12343 mark_window_display_accurate_1 (w
, accurate_p
);
12345 if (!NILP (w
->vchild
))
12346 mark_window_display_accurate (w
->vchild
, accurate_p
);
12347 if (!NILP (w
->hchild
))
12348 mark_window_display_accurate (w
->hchild
, accurate_p
);
12353 update_overlay_arrows (1);
12357 /* Force a thorough redisplay the next time by setting
12358 last_arrow_position and last_arrow_string to t, which is
12359 unequal to any useful value of Voverlay_arrow_... */
12360 update_overlay_arrows (-1);
12365 /* Return value in display table DP (Lisp_Char_Table *) for character
12366 C. Since a display table doesn't have any parent, we don't have to
12367 follow parent. Do not call this function directly but use the
12368 macro DISP_CHAR_VECTOR. */
12371 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
12375 if (ASCII_CHAR_P (c
))
12378 if (SUB_CHAR_TABLE_P (val
))
12379 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
12385 XSETCHAR_TABLE (table
, dp
);
12386 val
= char_table_ref (table
, c
);
12395 /***********************************************************************
12397 ***********************************************************************/
12399 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
12402 redisplay_windows (Lisp_Object window
)
12404 while (!NILP (window
))
12406 struct window
*w
= XWINDOW (window
);
12408 if (!NILP (w
->hchild
))
12409 redisplay_windows (w
->hchild
);
12410 else if (!NILP (w
->vchild
))
12411 redisplay_windows (w
->vchild
);
12412 else if (!NILP (w
->buffer
))
12414 displayed_buffer
= XBUFFER (w
->buffer
);
12415 /* Use list_of_error, not Qerror, so that
12416 we catch only errors and don't run the debugger. */
12417 internal_condition_case_1 (redisplay_window_0
, window
,
12419 redisplay_window_error
);
12427 redisplay_window_error (Lisp_Object ignore
)
12429 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
12434 redisplay_window_0 (Lisp_Object window
)
12436 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12437 redisplay_window (window
, 0);
12442 redisplay_window_1 (Lisp_Object window
)
12444 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12445 redisplay_window (window
, 1);
12450 /* Increment GLYPH until it reaches END or CONDITION fails while
12451 adding (GLYPH)->pixel_width to X. */
12453 #define SKIP_GLYPHS(glyph, end, x, condition) \
12456 (x) += (glyph)->pixel_width; \
12459 while ((glyph) < (end) && (condition))
12462 /* Set cursor position of W. PT is assumed to be displayed in ROW.
12463 DELTA and DELTA_BYTES are the numbers of characters and bytes by
12464 which positions recorded in ROW differ from current buffer
12467 Return 0 if cursor is not on this row, 1 otherwise. */
12470 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
12471 struct glyph_matrix
*matrix
,
12472 EMACS_INT delta
, EMACS_INT delta_bytes
,
12475 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
12476 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
12477 struct glyph
*cursor
= NULL
;
12478 /* The last known character position in row. */
12479 EMACS_INT last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12481 EMACS_INT pt_old
= PT
- delta
;
12482 EMACS_INT pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12483 EMACS_INT pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
12484 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
12485 /* A glyph beyond the edge of TEXT_AREA which we should never
12487 struct glyph
*glyphs_end
= end
;
12488 /* Non-zero means we've found a match for cursor position, but that
12489 glyph has the avoid_cursor_p flag set. */
12490 int match_with_avoid_cursor
= 0;
12491 /* Non-zero means we've seen at least one glyph that came from a
12493 int string_seen
= 0;
12494 /* Largest buffer position seen so far during scan of glyph row. */
12495 EMACS_INT bpos_max
= last_pos
;
12496 /* Last buffer position covered by an overlay string with an integer
12497 `cursor' property. */
12498 EMACS_INT bpos_covered
= 0;
12500 /* Skip over glyphs not having an object at the start and the end of
12501 the row. These are special glyphs like truncation marks on
12502 terminal frames. */
12503 if (row
->displays_text_p
)
12505 if (!row
->reversed_p
)
12508 && INTEGERP (glyph
->object
)
12509 && glyph
->charpos
< 0)
12511 x
+= glyph
->pixel_width
;
12515 && INTEGERP ((end
- 1)->object
)
12516 /* CHARPOS is zero for blanks and stretch glyphs
12517 inserted by extend_face_to_end_of_line. */
12518 && (end
- 1)->charpos
<= 0)
12520 glyph_before
= glyph
- 1;
12527 /* If the glyph row is reversed, we need to process it from back
12528 to front, so swap the edge pointers. */
12529 glyphs_end
= end
= glyph
- 1;
12530 glyph
+= row
->used
[TEXT_AREA
] - 1;
12532 while (glyph
> end
+ 1
12533 && INTEGERP (glyph
->object
)
12534 && glyph
->charpos
< 0)
12537 x
-= glyph
->pixel_width
;
12539 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
12541 /* By default, in reversed rows we put the cursor on the
12542 rightmost (first in the reading order) glyph. */
12543 for (g
= end
+ 1; g
< glyph
; g
++)
12544 x
+= g
->pixel_width
;
12546 && INTEGERP ((end
+ 1)->object
)
12547 && (end
+ 1)->charpos
<= 0)
12549 glyph_before
= glyph
+ 1;
12553 else if (row
->reversed_p
)
12555 /* In R2L rows that don't display text, put the cursor on the
12556 rightmost glyph. Case in point: an empty last line that is
12557 part of an R2L paragraph. */
12559 /* Avoid placing the cursor on the last glyph of the row, where
12560 on terminal frames we hold the vertical border between
12561 adjacent windows. */
12562 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
12563 && !WINDOW_RIGHTMOST_P (w
)
12564 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
12566 x
= -1; /* will be computed below, at label compute_x */
12569 /* Step 1: Try to find the glyph whose character position
12570 corresponds to point. If that's not possible, find 2 glyphs
12571 whose character positions are the closest to point, one before
12572 point, the other after it. */
12573 if (!row
->reversed_p
)
12574 while (/* not marched to end of glyph row */
12576 /* glyph was not inserted by redisplay for internal purposes */
12577 && !INTEGERP (glyph
->object
))
12579 if (BUFFERP (glyph
->object
))
12581 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12583 if (glyph
->charpos
> bpos_max
)
12584 bpos_max
= glyph
->charpos
;
12585 if (!glyph
->avoid_cursor_p
)
12587 /* If we hit point, we've found the glyph on which to
12588 display the cursor. */
12591 match_with_avoid_cursor
= 0;
12594 /* See if we've found a better approximation to
12595 POS_BEFORE or to POS_AFTER. Note that we want the
12596 first (leftmost) glyph of all those that are the
12597 closest from below, and the last (rightmost) of all
12598 those from above. */
12599 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12601 pos_before
= glyph
->charpos
;
12602 glyph_before
= glyph
;
12604 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12606 pos_after
= glyph
->charpos
;
12607 glyph_after
= glyph
;
12610 else if (dpos
== 0)
12611 match_with_avoid_cursor
= 1;
12613 else if (STRINGP (glyph
->object
))
12615 Lisp_Object chprop
;
12616 EMACS_INT glyph_pos
= glyph
->charpos
;
12618 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12620 if (INTEGERP (chprop
))
12622 bpos_covered
= bpos_max
+ XINT (chprop
);
12623 /* If the `cursor' property covers buffer positions up
12624 to and including point, we should display cursor on
12625 this glyph. Note that overlays and text properties
12626 with string values stop bidi reordering, so every
12627 buffer position to the left of the string is always
12628 smaller than any position to the right of the
12629 string. Therefore, if a `cursor' property on one
12630 of the string's characters has an integer value, we
12631 will break out of the loop below _before_ we get to
12632 the position match above. IOW, integer values of
12633 the `cursor' property override the "exact match for
12634 point" strategy of positioning the cursor. */
12635 /* Implementation note: bpos_max == pt_old when, e.g.,
12636 we are in an empty line, where bpos_max is set to
12637 MATRIX_ROW_START_CHARPOS, see above. */
12638 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12647 x
+= glyph
->pixel_width
;
12650 else if (glyph
> end
) /* row is reversed */
12651 while (!INTEGERP (glyph
->object
))
12653 if (BUFFERP (glyph
->object
))
12655 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12657 if (glyph
->charpos
> bpos_max
)
12658 bpos_max
= glyph
->charpos
;
12659 if (!glyph
->avoid_cursor_p
)
12663 match_with_avoid_cursor
= 0;
12666 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12668 pos_before
= glyph
->charpos
;
12669 glyph_before
= glyph
;
12671 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12673 pos_after
= glyph
->charpos
;
12674 glyph_after
= glyph
;
12677 else if (dpos
== 0)
12678 match_with_avoid_cursor
= 1;
12680 else if (STRINGP (glyph
->object
))
12682 Lisp_Object chprop
;
12683 EMACS_INT glyph_pos
= glyph
->charpos
;
12685 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12687 if (INTEGERP (chprop
))
12689 bpos_covered
= bpos_max
+ XINT (chprop
);
12690 /* If the `cursor' property covers buffer positions up
12691 to and including point, we should display cursor on
12693 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12702 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
12704 x
--; /* can't use any pixel_width */
12707 x
-= glyph
->pixel_width
;
12710 /* Step 2: If we didn't find an exact match for point, we need to
12711 look for a proper place to put the cursor among glyphs between
12712 GLYPH_BEFORE and GLYPH_AFTER. */
12713 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
12714 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12715 && bpos_covered
< pt_old
)
12717 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
12719 EMACS_INT ellipsis_pos
;
12721 /* Scan back over the ellipsis glyphs. */
12722 if (!row
->reversed_p
)
12724 ellipsis_pos
= (glyph
- 1)->charpos
;
12725 while (glyph
> row
->glyphs
[TEXT_AREA
]
12726 && (glyph
- 1)->charpos
== ellipsis_pos
)
12727 glyph
--, x
-= glyph
->pixel_width
;
12728 /* That loop always goes one position too far, including
12729 the glyph before the ellipsis. So scan forward over
12731 x
+= glyph
->pixel_width
;
12734 else /* row is reversed */
12736 ellipsis_pos
= (glyph
+ 1)->charpos
;
12737 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
12738 && (glyph
+ 1)->charpos
== ellipsis_pos
)
12739 glyph
++, x
+= glyph
->pixel_width
;
12740 x
-= glyph
->pixel_width
;
12744 else if (match_with_avoid_cursor
12745 /* zero-width characters produce no glyphs */
12746 || ((row
->reversed_p
12747 ? glyph_after
> glyphs_end
12748 : glyph_after
< glyphs_end
)
12749 && eabs (glyph_after
- glyph_before
) == 1))
12751 cursor
= glyph_after
;
12754 else if (string_seen
)
12756 int incr
= row
->reversed_p
? -1 : +1;
12758 /* Need to find the glyph that came out of a string which is
12759 present at point. That glyph is somewhere between
12760 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
12761 positioned between POS_BEFORE and POS_AFTER in the
12763 struct glyph
*stop
= glyph_after
;
12764 EMACS_INT pos
= pos_before
;
12767 for (glyph
= glyph_before
+ incr
;
12768 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
12771 /* Any glyphs that come from the buffer are here because
12772 of bidi reordering. Skip them, and only pay
12773 attention to glyphs that came from some string. */
12774 if (STRINGP (glyph
->object
))
12779 str
= glyph
->object
;
12780 tem
= string_buffer_position_lim (w
, str
, pos
, pos_after
, 0);
12781 if (tem
== 0 /* from overlay */
12784 /* If the string from which this glyph came is
12785 found in the buffer at point, then we've
12786 found the glyph we've been looking for. If
12787 it comes from an overlay (tem == 0), and it
12788 has the `cursor' property on one of its
12789 glyphs, record that glyph as a candidate for
12790 displaying the cursor. (As in the
12791 unidirectional version, we will display the
12792 cursor on the last candidate we find.) */
12793 if (tem
== 0 || tem
== pt_old
)
12795 /* The glyphs from this string could have
12796 been reordered. Find the one with the
12797 smallest string position. Or there could
12798 be a character in the string with the
12799 `cursor' property, which means display
12800 cursor on that character's glyph. */
12801 EMACS_INT strpos
= glyph
->charpos
;
12804 for (glyph
+= incr
;
12805 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
12806 && EQ (glyph
->object
, str
);
12810 EMACS_INT gpos
= glyph
->charpos
;
12812 cprop
= Fget_char_property (make_number (gpos
),
12820 if (glyph
->charpos
< strpos
)
12822 strpos
= glyph
->charpos
;
12831 pos
= tem
+ 1; /* don't find previous instances */
12833 /* This string is not what we want; skip all of the
12834 glyphs that came from it. */
12837 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
12838 && EQ (glyph
->object
, str
));
12844 /* If we reached the end of the line, and END was from a string,
12845 the cursor is not on this line. */
12847 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
12848 && STRINGP (end
->object
)
12849 && row
->continued_p
)
12855 if (cursor
!= NULL
)
12861 /* Need to compute x that corresponds to GLYPH. */
12862 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
12864 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
12866 x
+= g
->pixel_width
;
12870 /* ROW could be part of a continued line, which, under bidi
12871 reordering, might have other rows whose start and end charpos
12872 occlude point. Only set w->cursor if we found a better
12873 approximation to the cursor position than we have from previously
12874 examined candidate rows belonging to the same continued line. */
12875 if (/* we already have a candidate row */
12876 w
->cursor
.vpos
>= 0
12877 /* that candidate is not the row we are processing */
12878 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
12879 /* the row we are processing is part of a continued line */
12880 && (row
->continued_p
|| MATRIX_ROW_CONTINUATION_LINE_P (row
))
12881 /* Make sure cursor.vpos specifies a row whose start and end
12882 charpos occlude point. This is because some callers of this
12883 function leave cursor.vpos at the row where the cursor was
12884 displayed during the last redisplay cycle. */
12885 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
12886 && pt_old
< MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
12889 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
12891 /* Don't consider glyphs that are outside TEXT_AREA. */
12892 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
12894 /* Keep the candidate whose buffer position is the closest to
12896 if (/* previous candidate is a glyph in TEXT_AREA of that row */
12897 w
->cursor
.hpos
>= 0
12898 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
12899 && BUFFERP (g1
->object
)
12900 && (g1
->charpos
== pt_old
/* an exact match always wins */
12901 || (BUFFERP (glyph
->object
)
12902 && eabs (g1
->charpos
- pt_old
)
12903 < eabs (glyph
->charpos
- pt_old
))))
12905 /* If this candidate gives an exact match, use that. */
12906 if (!(BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12907 /* Otherwise, keep the candidate that comes from a row
12908 spanning less buffer positions. This may win when one or
12909 both candidate positions are on glyphs that came from
12910 display strings, for which we cannot compare buffer
12912 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
12913 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
12914 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
12917 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
12919 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
12920 w
->cursor
.y
= row
->y
+ dy
;
12922 if (w
== XWINDOW (selected_window
))
12924 if (!row
->continued_p
12925 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
12928 this_line_buffer
= XBUFFER (w
->buffer
);
12930 CHARPOS (this_line_start_pos
)
12931 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
12932 BYTEPOS (this_line_start_pos
)
12933 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
12935 CHARPOS (this_line_end_pos
)
12936 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
12937 BYTEPOS (this_line_end_pos
)
12938 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
12940 this_line_y
= w
->cursor
.y
;
12941 this_line_pixel_height
= row
->height
;
12942 this_line_vpos
= w
->cursor
.vpos
;
12943 this_line_start_x
= row
->x
;
12946 CHARPOS (this_line_start_pos
) = 0;
12953 /* Run window scroll functions, if any, for WINDOW with new window
12954 start STARTP. Sets the window start of WINDOW to that position.
12956 We assume that the window's buffer is really current. */
12958 static INLINE
struct text_pos
12959 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
12961 struct window
*w
= XWINDOW (window
);
12962 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
12964 if (current_buffer
!= XBUFFER (w
->buffer
))
12967 if (!NILP (Vwindow_scroll_functions
))
12969 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
12970 make_number (CHARPOS (startp
)));
12971 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12972 /* In case the hook functions switch buffers. */
12973 if (current_buffer
!= XBUFFER (w
->buffer
))
12974 set_buffer_internal_1 (XBUFFER (w
->buffer
));
12981 /* Make sure the line containing the cursor is fully visible.
12982 A value of 1 means there is nothing to be done.
12983 (Either the line is fully visible, or it cannot be made so,
12984 or we cannot tell.)
12986 If FORCE_P is non-zero, return 0 even if partial visible cursor row
12987 is higher than window.
12989 A value of 0 means the caller should do scrolling
12990 as if point had gone off the screen. */
12993 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
12995 struct glyph_matrix
*matrix
;
12996 struct glyph_row
*row
;
12999 if (!make_cursor_line_fully_visible_p
)
13002 /* It's not always possible to find the cursor, e.g, when a window
13003 is full of overlay strings. Don't do anything in that case. */
13004 if (w
->cursor
.vpos
< 0)
13007 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
13008 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
13010 /* If the cursor row is not partially visible, there's nothing to do. */
13011 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
13014 /* If the row the cursor is in is taller than the window's height,
13015 it's not clear what to do, so do nothing. */
13016 window_height
= window_box_height (w
);
13017 if (row
->height
>= window_height
)
13019 if (!force_p
|| MINI_WINDOW_P (w
)
13020 || w
->vscroll
|| w
->cursor
.vpos
== 0)
13027 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
13028 non-zero means only WINDOW is redisplayed in redisplay_internal.
13029 TEMP_SCROLL_STEP has the same meaning as scroll_step, and is used
13030 in redisplay_window to bring a partially visible line into view in
13031 the case that only the cursor has moved.
13033 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
13034 last screen line's vertical height extends past the end of the screen.
13038 1 if scrolling succeeded
13040 0 if scrolling didn't find point.
13042 -1 if new fonts have been loaded so that we must interrupt
13043 redisplay, adjust glyph matrices, and try again. */
13049 SCROLLING_NEED_LARGER_MATRICES
13053 try_scrolling (Lisp_Object window
, int just_this_one_p
,
13054 EMACS_INT scroll_conservatively
, EMACS_INT scroll_step
,
13055 int temp_scroll_step
, int last_line_misfit
)
13057 struct window
*w
= XWINDOW (window
);
13058 struct frame
*f
= XFRAME (w
->frame
);
13059 struct text_pos pos
, startp
;
13061 int this_scroll_margin
, scroll_max
, rc
, height
;
13062 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
13063 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
13064 Lisp_Object aggressive
;
13065 int scroll_limit
= INT_MAX
/ FRAME_LINE_HEIGHT (f
);
13068 debug_method_add (w
, "try_scrolling");
13071 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13073 /* Compute scroll margin height in pixels. We scroll when point is
13074 within this distance from the top or bottom of the window. */
13075 if (scroll_margin
> 0)
13076 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
13077 * FRAME_LINE_HEIGHT (f
);
13079 this_scroll_margin
= 0;
13081 /* Force scroll_conservatively to have a reasonable value, to avoid
13082 overflow while computing how much to scroll. Note that the user
13083 can supply scroll-conservatively equal to `most-positive-fixnum',
13084 which can be larger than INT_MAX. */
13085 if (scroll_conservatively
> scroll_limit
)
13087 scroll_conservatively
= scroll_limit
;
13088 scroll_max
= INT_MAX
;
13090 else if (scroll_step
|| scroll_conservatively
|| temp_scroll_step
)
13091 /* Compute how much we should try to scroll maximally to bring
13092 point into view. */
13093 scroll_max
= (max (scroll_step
,
13094 max (scroll_conservatively
, temp_scroll_step
))
13095 * FRAME_LINE_HEIGHT (f
));
13096 else if (NUMBERP (current_buffer
->scroll_down_aggressively
)
13097 || NUMBERP (current_buffer
->scroll_up_aggressively
))
13098 /* We're trying to scroll because of aggressive scrolling but no
13099 scroll_step is set. Choose an arbitrary one. */
13100 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
13106 /* Decide whether to scroll down. */
13107 if (PT
> CHARPOS (startp
))
13109 int scroll_margin_y
;
13111 /* Compute the pixel ypos of the scroll margin, then move it to
13112 either that ypos or PT, whichever comes first. */
13113 start_display (&it
, w
, startp
);
13114 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
13115 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
13116 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
13117 (MOVE_TO_POS
| MOVE_TO_Y
));
13119 if (PT
> CHARPOS (it
.current
.pos
))
13121 int y0
= line_bottom_y (&it
);
13122 /* Compute how many pixels below window bottom to stop searching
13123 for PT. This avoids costly search for PT that is far away if
13124 the user limited scrolling by a small number of lines, but
13125 always finds PT if scroll_conservatively is set to a large
13126 number, such as most-positive-fixnum. */
13127 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
13129 slack
>= INT_MAX
- it
.last_visible_y
13131 : it
.last_visible_y
+ slack
;
13133 /* Compute the distance from the scroll margin to PT or to
13134 the scroll limit, whichever comes first. This should
13135 include the height of the cursor line, to make that line
13137 move_it_to (&it
, PT
, -1, y_to_move
,
13138 -1, MOVE_TO_POS
| MOVE_TO_Y
);
13139 dy
= line_bottom_y (&it
) - y0
;
13141 if (dy
> scroll_max
)
13142 return SCROLLING_FAILED
;
13150 /* Point is in or below the bottom scroll margin, so move the
13151 window start down. If scrolling conservatively, move it just
13152 enough down to make point visible. If scroll_step is set,
13153 move it down by scroll_step. */
13154 if (scroll_conservatively
)
13156 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
13157 FRAME_LINE_HEIGHT (f
) * scroll_conservatively
);
13158 else if (scroll_step
|| temp_scroll_step
)
13159 amount_to_scroll
= scroll_max
;
13162 aggressive
= current_buffer
->scroll_up_aggressively
;
13163 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13164 if (NUMBERP (aggressive
))
13166 double float_amount
= XFLOATINT (aggressive
) * height
;
13167 amount_to_scroll
= float_amount
;
13168 if (amount_to_scroll
== 0 && float_amount
> 0)
13169 amount_to_scroll
= 1;
13173 if (amount_to_scroll
<= 0)
13174 return SCROLLING_FAILED
;
13176 start_display (&it
, w
, startp
);
13177 if (scroll_max
< INT_MAX
)
13178 move_it_vertically (&it
, amount_to_scroll
);
13181 /* Extra precision for users who set scroll-conservatively
13182 to most-positive-fixnum: make sure the amount we scroll
13183 the window start is never less than amount_to_scroll,
13184 which was computed as distance from window bottom to
13185 point. This matters when lines at window top and lines
13186 below window bottom have different height. */
13187 struct it it1
= it
;
13188 /* We use a temporary it1 because line_bottom_y can modify
13189 its argument, if it moves one line down; see there. */
13190 int start_y
= line_bottom_y (&it1
);
13193 move_it_by_lines (&it
, 1, 1);
13195 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
13198 /* If STARTP is unchanged, move it down another screen line. */
13199 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
13200 move_it_by_lines (&it
, 1, 1);
13201 startp
= it
.current
.pos
;
13205 struct text_pos scroll_margin_pos
= startp
;
13207 /* See if point is inside the scroll margin at the top of the
13209 if (this_scroll_margin
)
13211 start_display (&it
, w
, startp
);
13212 move_it_vertically (&it
, this_scroll_margin
);
13213 scroll_margin_pos
= it
.current
.pos
;
13216 if (PT
< CHARPOS (scroll_margin_pos
))
13218 /* Point is in the scroll margin at the top of the window or
13219 above what is displayed in the window. */
13222 /* Compute the vertical distance from PT to the scroll
13223 margin position. Give up if distance is greater than
13225 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
13226 start_display (&it
, w
, pos
);
13228 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
13229 it
.last_visible_y
, -1,
13230 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13231 dy
= it
.current_y
- y0
;
13232 if (dy
> scroll_max
)
13233 return SCROLLING_FAILED
;
13235 /* Compute new window start. */
13236 start_display (&it
, w
, startp
);
13238 if (scroll_conservatively
)
13240 = max (dy
, FRAME_LINE_HEIGHT (f
) * max (scroll_step
, temp_scroll_step
));
13241 else if (scroll_step
|| temp_scroll_step
)
13242 amount_to_scroll
= scroll_max
;
13245 aggressive
= current_buffer
->scroll_down_aggressively
;
13246 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13247 if (NUMBERP (aggressive
))
13249 double float_amount
= XFLOATINT (aggressive
) * height
;
13250 amount_to_scroll
= float_amount
;
13251 if (amount_to_scroll
== 0 && float_amount
> 0)
13252 amount_to_scroll
= 1;
13256 if (amount_to_scroll
<= 0)
13257 return SCROLLING_FAILED
;
13259 move_it_vertically_backward (&it
, amount_to_scroll
);
13260 startp
= it
.current
.pos
;
13264 /* Run window scroll functions. */
13265 startp
= run_window_scroll_functions (window
, startp
);
13267 /* Display the window. Give up if new fonts are loaded, or if point
13269 if (!try_window (window
, startp
, 0))
13270 rc
= SCROLLING_NEED_LARGER_MATRICES
;
13271 else if (w
->cursor
.vpos
< 0)
13273 clear_glyph_matrix (w
->desired_matrix
);
13274 rc
= SCROLLING_FAILED
;
13278 /* Maybe forget recorded base line for line number display. */
13279 if (!just_this_one_p
13280 || current_buffer
->clip_changed
13281 || BEG_UNCHANGED
< CHARPOS (startp
))
13282 w
->base_line_number
= Qnil
;
13284 /* If cursor ends up on a partially visible line,
13285 treat that as being off the bottom of the screen. */
13286 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0))
13288 clear_glyph_matrix (w
->desired_matrix
);
13289 ++extra_scroll_margin_lines
;
13292 rc
= SCROLLING_SUCCESS
;
13299 /* Compute a suitable window start for window W if display of W starts
13300 on a continuation line. Value is non-zero if a new window start
13303 The new window start will be computed, based on W's width, starting
13304 from the start of the continued line. It is the start of the
13305 screen line with the minimum distance from the old start W->start. */
13308 compute_window_start_on_continuation_line (struct window
*w
)
13310 struct text_pos pos
, start_pos
;
13311 int window_start_changed_p
= 0;
13313 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
13315 /* If window start is on a continuation line... Window start may be
13316 < BEGV in case there's invisible text at the start of the
13317 buffer (M-x rmail, for example). */
13318 if (CHARPOS (start_pos
) > BEGV
13319 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
13322 struct glyph_row
*row
;
13324 /* Handle the case that the window start is out of range. */
13325 if (CHARPOS (start_pos
) < BEGV
)
13326 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
13327 else if (CHARPOS (start_pos
) > ZV
)
13328 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
13330 /* Find the start of the continued line. This should be fast
13331 because scan_buffer is fast (newline cache). */
13332 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
13333 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
13334 row
, DEFAULT_FACE_ID
);
13335 reseat_at_previous_visible_line_start (&it
);
13337 /* If the line start is "too far" away from the window start,
13338 say it takes too much time to compute a new window start. */
13339 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
13340 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
13342 int min_distance
, distance
;
13344 /* Move forward by display lines to find the new window
13345 start. If window width was enlarged, the new start can
13346 be expected to be > the old start. If window width was
13347 decreased, the new window start will be < the old start.
13348 So, we're looking for the display line start with the
13349 minimum distance from the old window start. */
13350 pos
= it
.current
.pos
;
13351 min_distance
= INFINITY
;
13352 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
13353 distance
< min_distance
)
13355 min_distance
= distance
;
13356 pos
= it
.current
.pos
;
13357 move_it_by_lines (&it
, 1, 0);
13360 /* Set the window start there. */
13361 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
13362 window_start_changed_p
= 1;
13366 return window_start_changed_p
;
13370 /* Try cursor movement in case text has not changed in window WINDOW,
13371 with window start STARTP. Value is
13373 CURSOR_MOVEMENT_SUCCESS if successful
13375 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
13377 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
13378 display. *SCROLL_STEP is set to 1, under certain circumstances, if
13379 we want to scroll as if scroll-step were set to 1. See the code.
13381 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
13382 which case we have to abort this redisplay, and adjust matrices
13387 CURSOR_MOVEMENT_SUCCESS
,
13388 CURSOR_MOVEMENT_CANNOT_BE_USED
,
13389 CURSOR_MOVEMENT_MUST_SCROLL
,
13390 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
13394 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
13396 struct window
*w
= XWINDOW (window
);
13397 struct frame
*f
= XFRAME (w
->frame
);
13398 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
13401 if (inhibit_try_cursor_movement
)
13405 /* Handle case where text has not changed, only point, and it has
13406 not moved off the frame. */
13407 if (/* Point may be in this window. */
13408 PT
>= CHARPOS (startp
)
13409 /* Selective display hasn't changed. */
13410 && !current_buffer
->clip_changed
13411 /* Function force-mode-line-update is used to force a thorough
13412 redisplay. It sets either windows_or_buffers_changed or
13413 update_mode_lines. So don't take a shortcut here for these
13415 && !update_mode_lines
13416 && !windows_or_buffers_changed
13417 && !cursor_type_changed
13418 /* Can't use this case if highlighting a region. When a
13419 region exists, cursor movement has to do more than just
13421 && !(!NILP (Vtransient_mark_mode
)
13422 && !NILP (current_buffer
->mark_active
))
13423 && NILP (w
->region_showing
)
13424 && NILP (Vshow_trailing_whitespace
)
13425 /* Right after splitting windows, last_point may be nil. */
13426 && INTEGERP (w
->last_point
)
13427 /* This code is not used for mini-buffer for the sake of the case
13428 of redisplaying to replace an echo area message; since in
13429 that case the mini-buffer contents per se are usually
13430 unchanged. This code is of no real use in the mini-buffer
13431 since the handling of this_line_start_pos, etc., in redisplay
13432 handles the same cases. */
13433 && !EQ (window
, minibuf_window
)
13434 /* When splitting windows or for new windows, it happens that
13435 redisplay is called with a nil window_end_vpos or one being
13436 larger than the window. This should really be fixed in
13437 window.c. I don't have this on my list, now, so we do
13438 approximately the same as the old redisplay code. --gerd. */
13439 && INTEGERP (w
->window_end_vpos
)
13440 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
13441 && (FRAME_WINDOW_P (f
)
13442 || !overlay_arrow_in_current_buffer_p ()))
13444 int this_scroll_margin
, top_scroll_margin
;
13445 struct glyph_row
*row
= NULL
;
13448 debug_method_add (w
, "cursor movement");
13451 /* Scroll if point within this distance from the top or bottom
13452 of the window. This is a pixel value. */
13453 if (scroll_margin
> 0)
13455 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
13456 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
13459 this_scroll_margin
= 0;
13461 top_scroll_margin
= this_scroll_margin
;
13462 if (WINDOW_WANTS_HEADER_LINE_P (w
))
13463 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
13465 /* Start with the row the cursor was displayed during the last
13466 not paused redisplay. Give up if that row is not valid. */
13467 if (w
->last_cursor
.vpos
< 0
13468 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
13469 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13472 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
13473 if (row
->mode_line_p
)
13475 if (!row
->enabled_p
)
13476 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13479 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
13481 int scroll_p
= 0, must_scroll
= 0;
13482 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
13484 if (PT
> XFASTINT (w
->last_point
))
13486 /* Point has moved forward. */
13487 while (MATRIX_ROW_END_CHARPOS (row
) < PT
13488 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
13490 xassert (row
->enabled_p
);
13494 /* If the end position of a row equals the start
13495 position of the next row, and PT is at that position,
13496 we would rather display cursor in the next line. */
13497 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13498 && MATRIX_ROW_END_CHARPOS (row
) == PT
13499 && row
< w
->current_matrix
->rows
13500 + w
->current_matrix
->nrows
- 1
13501 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
13502 && !cursor_row_p (w
, row
))
13505 /* If within the scroll margin, scroll. Note that
13506 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
13507 the next line would be drawn, and that
13508 this_scroll_margin can be zero. */
13509 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
13510 || PT
> MATRIX_ROW_END_CHARPOS (row
)
13511 /* Line is completely visible last line in window
13512 and PT is to be set in the next line. */
13513 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
13514 && PT
== MATRIX_ROW_END_CHARPOS (row
)
13515 && !row
->ends_at_zv_p
13516 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
13519 else if (PT
< XFASTINT (w
->last_point
))
13521 /* Cursor has to be moved backward. Note that PT >=
13522 CHARPOS (startp) because of the outer if-statement. */
13523 while (!row
->mode_line_p
13524 && (MATRIX_ROW_START_CHARPOS (row
) > PT
13525 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13526 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
13527 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
13528 row
> w
->current_matrix
->rows
13529 && (row
-1)->ends_in_newline_from_string_p
))))
13530 && (row
->y
> top_scroll_margin
13531 || CHARPOS (startp
) == BEGV
))
13533 xassert (row
->enabled_p
);
13537 /* Consider the following case: Window starts at BEGV,
13538 there is invisible, intangible text at BEGV, so that
13539 display starts at some point START > BEGV. It can
13540 happen that we are called with PT somewhere between
13541 BEGV and START. Try to handle that case. */
13542 if (row
< w
->current_matrix
->rows
13543 || row
->mode_line_p
)
13545 row
= w
->current_matrix
->rows
;
13546 if (row
->mode_line_p
)
13550 /* Due to newlines in overlay strings, we may have to
13551 skip forward over overlay strings. */
13552 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13553 && MATRIX_ROW_END_CHARPOS (row
) == PT
13554 && !cursor_row_p (w
, row
))
13557 /* If within the scroll margin, scroll. */
13558 if (row
->y
< top_scroll_margin
13559 && CHARPOS (startp
) != BEGV
)
13564 /* Cursor did not move. So don't scroll even if cursor line
13565 is partially visible, as it was so before. */
13566 rc
= CURSOR_MOVEMENT_SUCCESS
;
13569 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
13570 || PT
> MATRIX_ROW_END_CHARPOS (row
))
13572 /* if PT is not in the glyph row, give up. */
13573 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13576 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13577 && !NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
13579 /* If rows are bidi-reordered and point moved, back up
13580 until we find a row that does not belong to a
13581 continuation line. This is because we must consider
13582 all rows of a continued line as candidates for the
13583 new cursor positioning, since row start and end
13584 positions change non-linearly with vertical position
13586 /* FIXME: Revisit this when glyph ``spilling'' in
13587 continuation lines' rows is implemented for
13588 bidi-reordered rows. */
13589 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
13591 xassert (row
->enabled_p
);
13593 /* If we hit the beginning of the displayed portion
13594 without finding the first row of a continued
13596 if (row
<= w
->current_matrix
->rows
)
13598 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13606 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13607 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
13608 && make_cursor_line_fully_visible_p
)
13610 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
13611 && !row
->ends_at_zv_p
13612 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
13613 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13614 else if (row
->height
> window_box_height (w
))
13616 /* If we end up in a partially visible line, let's
13617 make it fully visible, except when it's taller
13618 than the window, in which case we can't do much
13621 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13625 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13626 if (!cursor_row_fully_visible_p (w
, 0, 1))
13627 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13629 rc
= CURSOR_MOVEMENT_SUCCESS
;
13633 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13634 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13635 && !NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
13637 /* With bidi-reordered rows, there could be more than
13638 one candidate row whose start and end positions
13639 occlude point. We need to let set_cursor_from_row
13640 find the best candidate. */
13641 /* FIXME: Revisit this when glyph ``spilling'' in
13642 continuation lines' rows is implemented for
13643 bidi-reordered rows. */
13648 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
13649 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
13650 && cursor_row_p (w
, row
))
13651 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
13653 /* As soon as we've found the first suitable row
13654 whose ends_at_zv_p flag is set, we are done. */
13656 && MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
)
13658 rc
= CURSOR_MOVEMENT_SUCCESS
;
13663 while ((MATRIX_ROW_CONTINUATION_LINE_P (row
)
13664 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
13665 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13666 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
13667 /* If we didn't find any candidate rows, or exited the
13668 loop before all the candidates were examined, signal
13669 to the caller that this method failed. */
13670 if (rc
!= CURSOR_MOVEMENT_SUCCESS
13671 && (!rv
|| MATRIX_ROW_CONTINUATION_LINE_P (row
)))
13672 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13674 rc
= CURSOR_MOVEMENT_SUCCESS
;
13680 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
13682 rc
= CURSOR_MOVEMENT_SUCCESS
;
13687 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13688 && MATRIX_ROW_START_CHARPOS (row
) == PT
13689 && cursor_row_p (w
, row
));
13698 set_vertical_scroll_bar (struct window
*w
)
13700 EMACS_INT start
, end
, whole
;
13702 /* Calculate the start and end positions for the current window.
13703 At some point, it would be nice to choose between scrollbars
13704 which reflect the whole buffer size, with special markers
13705 indicating narrowing, and scrollbars which reflect only the
13708 Note that mini-buffers sometimes aren't displaying any text. */
13709 if (!MINI_WINDOW_P (w
)
13710 || (w
== XWINDOW (minibuf_window
)
13711 && NILP (echo_area_buffer
[0])))
13713 struct buffer
*buf
= XBUFFER (w
->buffer
);
13714 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
13715 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
13716 /* I don't think this is guaranteed to be right. For the
13717 moment, we'll pretend it is. */
13718 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
13722 if (whole
< (end
- start
))
13723 whole
= end
- start
;
13726 start
= end
= whole
= 0;
13728 /* Indicate what this scroll bar ought to be displaying now. */
13729 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13730 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13731 (w
, end
- start
, whole
, start
);
13735 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
13736 selected_window is redisplayed.
13738 We can return without actually redisplaying the window if
13739 fonts_changed_p is nonzero. In that case, redisplay_internal will
13743 redisplay_window (Lisp_Object window
, int just_this_one_p
)
13745 struct window
*w
= XWINDOW (window
);
13746 struct frame
*f
= XFRAME (w
->frame
);
13747 struct buffer
*buffer
= XBUFFER (w
->buffer
);
13748 struct buffer
*old
= current_buffer
;
13749 struct text_pos lpoint
, opoint
, startp
;
13750 int update_mode_line
;
13753 /* Record it now because it's overwritten. */
13754 int current_matrix_up_to_date_p
= 0;
13755 int used_current_matrix_p
= 0;
13756 /* This is less strict than current_matrix_up_to_date_p.
13757 It indictes that the buffer contents and narrowing are unchanged. */
13758 int buffer_unchanged_p
= 0;
13759 int temp_scroll_step
= 0;
13760 int count
= SPECPDL_INDEX ();
13762 int centering_position
= -1;
13763 int last_line_misfit
= 0;
13764 EMACS_INT beg_unchanged
, end_unchanged
;
13766 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13769 /* W must be a leaf window here. */
13770 xassert (!NILP (w
->buffer
));
13772 *w
->desired_matrix
->method
= 0;
13776 reconsider_clip_changes (w
, buffer
);
13778 /* Has the mode line to be updated? */
13779 update_mode_line
= (!NILP (w
->update_mode_line
)
13780 || update_mode_lines
13781 || buffer
->clip_changed
13782 || buffer
->prevent_redisplay_optimizations_p
);
13784 if (MINI_WINDOW_P (w
))
13786 if (w
== XWINDOW (echo_area_window
)
13787 && !NILP (echo_area_buffer
[0]))
13789 if (update_mode_line
)
13790 /* We may have to update a tty frame's menu bar or a
13791 tool-bar. Example `M-x C-h C-h C-g'. */
13792 goto finish_menu_bars
;
13794 /* We've already displayed the echo area glyphs in this window. */
13795 goto finish_scroll_bars
;
13797 else if ((w
!= XWINDOW (minibuf_window
)
13798 || minibuf_level
== 0)
13799 /* When buffer is nonempty, redisplay window normally. */
13800 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
13801 /* Quail displays non-mini buffers in minibuffer window.
13802 In that case, redisplay the window normally. */
13803 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
13805 /* W is a mini-buffer window, but it's not active, so clear
13807 int yb
= window_text_bottom_y (w
);
13808 struct glyph_row
*row
;
13811 for (y
= 0, row
= w
->desired_matrix
->rows
;
13813 y
+= row
->height
, ++row
)
13814 blank_row (w
, row
, y
);
13815 goto finish_scroll_bars
;
13818 clear_glyph_matrix (w
->desired_matrix
);
13821 /* Otherwise set up data on this window; select its buffer and point
13823 /* Really select the buffer, for the sake of buffer-local
13825 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13827 current_matrix_up_to_date_p
13828 = (!NILP (w
->window_end_valid
)
13829 && !current_buffer
->clip_changed
13830 && !current_buffer
->prevent_redisplay_optimizations_p
13831 && XFASTINT (w
->last_modified
) >= MODIFF
13832 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13834 /* Run the window-bottom-change-functions
13835 if it is possible that the text on the screen has changed
13836 (either due to modification of the text, or any other reason). */
13837 if (!current_matrix_up_to_date_p
13838 && !NILP (Vwindow_text_change_functions
))
13840 safe_run_hooks (Qwindow_text_change_functions
);
13844 beg_unchanged
= BEG_UNCHANGED
;
13845 end_unchanged
= END_UNCHANGED
;
13847 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
13849 specbind (Qinhibit_point_motion_hooks
, Qt
);
13852 = (!NILP (w
->window_end_valid
)
13853 && !current_buffer
->clip_changed
13854 && XFASTINT (w
->last_modified
) >= MODIFF
13855 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13857 /* When windows_or_buffers_changed is non-zero, we can't rely on
13858 the window end being valid, so set it to nil there. */
13859 if (windows_or_buffers_changed
)
13861 /* If window starts on a continuation line, maybe adjust the
13862 window start in case the window's width changed. */
13863 if (XMARKER (w
->start
)->buffer
== current_buffer
)
13864 compute_window_start_on_continuation_line (w
);
13866 w
->window_end_valid
= Qnil
;
13869 /* Some sanity checks. */
13870 CHECK_WINDOW_END (w
);
13871 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
13873 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
13876 /* If %c is in mode line, update it if needed. */
13877 if (!NILP (w
->column_number_displayed
)
13878 /* This alternative quickly identifies a common case
13879 where no change is needed. */
13880 && !(PT
== XFASTINT (w
->last_point
)
13881 && XFASTINT (w
->last_modified
) >= MODIFF
13882 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
13883 && (XFASTINT (w
->column_number_displayed
)
13884 != (int) current_column ())) /* iftc */
13885 update_mode_line
= 1;
13887 /* Count number of windows showing the selected buffer. An indirect
13888 buffer counts as its base buffer. */
13889 if (!just_this_one_p
)
13891 struct buffer
*current_base
, *window_base
;
13892 current_base
= current_buffer
;
13893 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13894 if (current_base
->base_buffer
)
13895 current_base
= current_base
->base_buffer
;
13896 if (window_base
->base_buffer
)
13897 window_base
= window_base
->base_buffer
;
13898 if (current_base
== window_base
)
13902 /* Point refers normally to the selected window. For any other
13903 window, set up appropriate value. */
13904 if (!EQ (window
, selected_window
))
13906 EMACS_INT new_pt
= XMARKER (w
->pointm
)->charpos
;
13907 EMACS_INT new_pt_byte
= marker_byte_position (w
->pointm
);
13911 new_pt_byte
= BEGV_BYTE
;
13912 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
13914 else if (new_pt
> (ZV
- 1))
13917 new_pt_byte
= ZV_BYTE
;
13918 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
13921 /* We don't use SET_PT so that the point-motion hooks don't run. */
13922 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
13925 /* If any of the character widths specified in the display table
13926 have changed, invalidate the width run cache. It's true that
13927 this may be a bit late to catch such changes, but the rest of
13928 redisplay goes (non-fatally) haywire when the display table is
13929 changed, so why should we worry about doing any better? */
13930 if (current_buffer
->width_run_cache
)
13932 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
13934 if (! disptab_matches_widthtab (disptab
,
13935 XVECTOR (current_buffer
->width_table
)))
13937 invalidate_region_cache (current_buffer
,
13938 current_buffer
->width_run_cache
,
13940 recompute_width_table (current_buffer
, disptab
);
13944 /* If window-start is screwed up, choose a new one. */
13945 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
13948 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13950 /* If someone specified a new starting point but did not insist,
13951 check whether it can be used. */
13952 if (!NILP (w
->optional_new_start
)
13953 && CHARPOS (startp
) >= BEGV
13954 && CHARPOS (startp
) <= ZV
)
13956 w
->optional_new_start
= Qnil
;
13957 start_display (&it
, w
, startp
);
13958 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
13959 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13960 if (IT_CHARPOS (it
) == PT
)
13961 w
->force_start
= Qt
;
13962 /* IT may overshoot PT if text at PT is invisible. */
13963 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
13964 w
->force_start
= Qt
;
13969 /* Handle case where place to start displaying has been specified,
13970 unless the specified location is outside the accessible range. */
13971 if (!NILP (w
->force_start
)
13972 || w
->frozen_window_start_p
)
13974 /* We set this later on if we have to adjust point. */
13977 w
->force_start
= Qnil
;
13979 w
->window_end_valid
= Qnil
;
13981 /* Forget any recorded base line for line number display. */
13982 if (!buffer_unchanged_p
)
13983 w
->base_line_number
= Qnil
;
13985 /* Redisplay the mode line. Select the buffer properly for that.
13986 Also, run the hook window-scroll-functions
13987 because we have scrolled. */
13988 /* Note, we do this after clearing force_start because
13989 if there's an error, it is better to forget about force_start
13990 than to get into an infinite loop calling the hook functions
13991 and having them get more errors. */
13992 if (!update_mode_line
13993 || ! NILP (Vwindow_scroll_functions
))
13995 update_mode_line
= 1;
13996 w
->update_mode_line
= Qt
;
13997 startp
= run_window_scroll_functions (window
, startp
);
14000 w
->last_modified
= make_number (0);
14001 w
->last_overlay_modified
= make_number (0);
14002 if (CHARPOS (startp
) < BEGV
)
14003 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
14004 else if (CHARPOS (startp
) > ZV
)
14005 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
14007 /* Redisplay, then check if cursor has been set during the
14008 redisplay. Give up if new fonts were loaded. */
14009 /* We used to issue a CHECK_MARGINS argument to try_window here,
14010 but this causes scrolling to fail when point begins inside
14011 the scroll margin (bug#148) -- cyd */
14012 if (!try_window (window
, startp
, 0))
14014 w
->force_start
= Qt
;
14015 clear_glyph_matrix (w
->desired_matrix
);
14016 goto need_larger_matrices
;
14019 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
14021 /* If point does not appear, try to move point so it does
14022 appear. The desired matrix has been built above, so we
14023 can use it here. */
14024 new_vpos
= window_box_height (w
) / 2;
14027 if (!cursor_row_fully_visible_p (w
, 0, 0))
14029 /* Point does appear, but on a line partly visible at end of window.
14030 Move it back to a fully-visible line. */
14031 new_vpos
= window_box_height (w
);
14034 /* If we need to move point for either of the above reasons,
14035 now actually do it. */
14038 struct glyph_row
*row
;
14040 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
14041 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
14044 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
14045 MATRIX_ROW_START_BYTEPOS (row
));
14047 if (w
!= XWINDOW (selected_window
))
14048 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
14049 else if (current_buffer
== old
)
14050 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
14052 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
14054 /* If we are highlighting the region, then we just changed
14055 the region, so redisplay to show it. */
14056 if (!NILP (Vtransient_mark_mode
)
14057 && !NILP (current_buffer
->mark_active
))
14059 clear_glyph_matrix (w
->desired_matrix
);
14060 if (!try_window (window
, startp
, 0))
14061 goto need_larger_matrices
;
14066 debug_method_add (w
, "forced window start");
14071 /* Handle case where text has not changed, only point, and it has
14072 not moved off the frame, and we are not retrying after hscroll.
14073 (current_matrix_up_to_date_p is nonzero when retrying.) */
14074 if (current_matrix_up_to_date_p
14075 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
14076 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
14080 case CURSOR_MOVEMENT_SUCCESS
:
14081 used_current_matrix_p
= 1;
14084 case CURSOR_MOVEMENT_MUST_SCROLL
:
14085 goto try_to_scroll
;
14091 /* If current starting point was originally the beginning of a line
14092 but no longer is, find a new starting point. */
14093 else if (!NILP (w
->start_at_line_beg
)
14094 && !(CHARPOS (startp
) <= BEGV
14095 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
14098 debug_method_add (w
, "recenter 1");
14103 /* Try scrolling with try_window_id. Value is > 0 if update has
14104 been done, it is -1 if we know that the same window start will
14105 not work. It is 0 if unsuccessful for some other reason. */
14106 else if ((tem
= try_window_id (w
)) != 0)
14109 debug_method_add (w
, "try_window_id %d", tem
);
14112 if (fonts_changed_p
)
14113 goto need_larger_matrices
;
14117 /* Otherwise try_window_id has returned -1 which means that we
14118 don't want the alternative below this comment to execute. */
14120 else if (CHARPOS (startp
) >= BEGV
14121 && CHARPOS (startp
) <= ZV
14122 && PT
>= CHARPOS (startp
)
14123 && (CHARPOS (startp
) < ZV
14124 /* Avoid starting at end of buffer. */
14125 || CHARPOS (startp
) == BEGV
14126 || (XFASTINT (w
->last_modified
) >= MODIFF
14127 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
14130 /* If first window line is a continuation line, and window start
14131 is inside the modified region, but the first change is before
14132 current window start, we must select a new window start.
14134 However, if this is the result of a down-mouse event (e.g. by
14135 extending the mouse-drag-overlay), we don't want to select a
14136 new window start, since that would change the position under
14137 the mouse, resulting in an unwanted mouse-movement rather
14138 than a simple mouse-click. */
14139 if (NILP (w
->start_at_line_beg
)
14140 && NILP (do_mouse_tracking
)
14141 && CHARPOS (startp
) > BEGV
14142 && CHARPOS (startp
) > BEG
+ beg_unchanged
14143 && CHARPOS (startp
) <= Z
- end_unchanged
14144 /* Even if w->start_at_line_beg is nil, a new window may
14145 start at a line_beg, since that's how set_buffer_window
14146 sets it. So, we need to check the return value of
14147 compute_window_start_on_continuation_line. (See also
14149 && XMARKER (w
->start
)->buffer
== current_buffer
14150 && compute_window_start_on_continuation_line (w
))
14152 w
->force_start
= Qt
;
14153 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14158 debug_method_add (w
, "same window start");
14161 /* Try to redisplay starting at same place as before.
14162 If point has not moved off frame, accept the results. */
14163 if (!current_matrix_up_to_date_p
14164 /* Don't use try_window_reusing_current_matrix in this case
14165 because a window scroll function can have changed the
14167 || !NILP (Vwindow_scroll_functions
)
14168 || MINI_WINDOW_P (w
)
14169 || !(used_current_matrix_p
14170 = try_window_reusing_current_matrix (w
)))
14172 IF_DEBUG (debug_method_add (w
, "1"));
14173 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
14174 /* -1 means we need to scroll.
14175 0 means we need new matrices, but fonts_changed_p
14176 is set in that case, so we will detect it below. */
14177 goto try_to_scroll
;
14180 if (fonts_changed_p
)
14181 goto need_larger_matrices
;
14183 if (w
->cursor
.vpos
>= 0)
14185 if (!just_this_one_p
14186 || current_buffer
->clip_changed
14187 || BEG_UNCHANGED
< CHARPOS (startp
))
14188 /* Forget any recorded base line for line number display. */
14189 w
->base_line_number
= Qnil
;
14191 if (!cursor_row_fully_visible_p (w
, 1, 0))
14193 clear_glyph_matrix (w
->desired_matrix
);
14194 last_line_misfit
= 1;
14196 /* Drop through and scroll. */
14201 clear_glyph_matrix (w
->desired_matrix
);
14206 w
->last_modified
= make_number (0);
14207 w
->last_overlay_modified
= make_number (0);
14209 /* Redisplay the mode line. Select the buffer properly for that. */
14210 if (!update_mode_line
)
14212 update_mode_line
= 1;
14213 w
->update_mode_line
= Qt
;
14216 /* Try to scroll by specified few lines. */
14217 if ((scroll_conservatively
14219 || temp_scroll_step
14220 || NUMBERP (current_buffer
->scroll_up_aggressively
)
14221 || NUMBERP (current_buffer
->scroll_down_aggressively
))
14222 && !current_buffer
->clip_changed
14223 && CHARPOS (startp
) >= BEGV
14224 && CHARPOS (startp
) <= ZV
)
14226 /* The function returns -1 if new fonts were loaded, 1 if
14227 successful, 0 if not successful. */
14228 int rc
= try_scrolling (window
, just_this_one_p
,
14229 scroll_conservatively
,
14231 temp_scroll_step
, last_line_misfit
);
14234 case SCROLLING_SUCCESS
:
14237 case SCROLLING_NEED_LARGER_MATRICES
:
14238 goto need_larger_matrices
;
14240 case SCROLLING_FAILED
:
14248 /* Finally, just choose place to start which centers point */
14251 if (centering_position
< 0)
14252 centering_position
= window_box_height (w
) / 2;
14255 debug_method_add (w
, "recenter");
14258 /* w->vscroll = 0; */
14260 /* Forget any previously recorded base line for line number display. */
14261 if (!buffer_unchanged_p
)
14262 w
->base_line_number
= Qnil
;
14264 /* Move backward half the height of the window. */
14265 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14266 it
.current_y
= it
.last_visible_y
;
14267 move_it_vertically_backward (&it
, centering_position
);
14268 xassert (IT_CHARPOS (it
) >= BEGV
);
14270 /* The function move_it_vertically_backward may move over more
14271 than the specified y-distance. If it->w is small, e.g. a
14272 mini-buffer window, we may end up in front of the window's
14273 display area. Start displaying at the start of the line
14274 containing PT in this case. */
14275 if (it
.current_y
<= 0)
14277 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14278 move_it_vertically_backward (&it
, 0);
14282 it
.current_x
= it
.hpos
= 0;
14284 /* Set startp here explicitly in case that helps avoid an infinite loop
14285 in case the window-scroll-functions functions get errors. */
14286 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
14288 /* Run scroll hooks. */
14289 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
14291 /* Redisplay the window. */
14292 if (!current_matrix_up_to_date_p
14293 || windows_or_buffers_changed
14294 || cursor_type_changed
14295 /* Don't use try_window_reusing_current_matrix in this case
14296 because it can have changed the buffer. */
14297 || !NILP (Vwindow_scroll_functions
)
14298 || !just_this_one_p
14299 || MINI_WINDOW_P (w
)
14300 || !(used_current_matrix_p
14301 = try_window_reusing_current_matrix (w
)))
14302 try_window (window
, startp
, 0);
14304 /* If new fonts have been loaded (due to fontsets), give up. We
14305 have to start a new redisplay since we need to re-adjust glyph
14307 if (fonts_changed_p
)
14308 goto need_larger_matrices
;
14310 /* If cursor did not appear assume that the middle of the window is
14311 in the first line of the window. Do it again with the next line.
14312 (Imagine a window of height 100, displaying two lines of height
14313 60. Moving back 50 from it->last_visible_y will end in the first
14315 if (w
->cursor
.vpos
< 0)
14317 if (!NILP (w
->window_end_valid
)
14318 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
14320 clear_glyph_matrix (w
->desired_matrix
);
14321 move_it_by_lines (&it
, 1, 0);
14322 try_window (window
, it
.current
.pos
, 0);
14324 else if (PT
< IT_CHARPOS (it
))
14326 clear_glyph_matrix (w
->desired_matrix
);
14327 move_it_by_lines (&it
, -1, 0);
14328 try_window (window
, it
.current
.pos
, 0);
14332 /* Not much we can do about it. */
14336 /* Consider the following case: Window starts at BEGV, there is
14337 invisible, intangible text at BEGV, so that display starts at
14338 some point START > BEGV. It can happen that we are called with
14339 PT somewhere between BEGV and START. Try to handle that case. */
14340 if (w
->cursor
.vpos
< 0)
14342 struct glyph_row
*row
= w
->current_matrix
->rows
;
14343 if (row
->mode_line_p
)
14345 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14348 if (!cursor_row_fully_visible_p (w
, 0, 0))
14350 /* If vscroll is enabled, disable it and try again. */
14354 clear_glyph_matrix (w
->desired_matrix
);
14358 /* If centering point failed to make the whole line visible,
14359 put point at the top instead. That has to make the whole line
14360 visible, if it can be done. */
14361 if (centering_position
== 0)
14364 clear_glyph_matrix (w
->desired_matrix
);
14365 centering_position
= 0;
14371 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14372 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
14373 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
14376 /* Display the mode line, if we must. */
14377 if ((update_mode_line
14378 /* If window not full width, must redo its mode line
14379 if (a) the window to its side is being redone and
14380 (b) we do a frame-based redisplay. This is a consequence
14381 of how inverted lines are drawn in frame-based redisplay. */
14382 || (!just_this_one_p
14383 && !FRAME_WINDOW_P (f
)
14384 && !WINDOW_FULL_WIDTH_P (w
))
14385 /* Line number to display. */
14386 || INTEGERP (w
->base_line_pos
)
14387 /* Column number is displayed and different from the one displayed. */
14388 || (!NILP (w
->column_number_displayed
)
14389 && (XFASTINT (w
->column_number_displayed
)
14390 != (int) current_column ()))) /* iftc */
14391 /* This means that the window has a mode line. */
14392 && (WINDOW_WANTS_MODELINE_P (w
)
14393 || WINDOW_WANTS_HEADER_LINE_P (w
)))
14395 display_mode_lines (w
);
14397 /* If mode line height has changed, arrange for a thorough
14398 immediate redisplay using the correct mode line height. */
14399 if (WINDOW_WANTS_MODELINE_P (w
)
14400 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
14402 fonts_changed_p
= 1;
14403 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
14404 = DESIRED_MODE_LINE_HEIGHT (w
);
14407 /* If header line height has changed, arrange for a thorough
14408 immediate redisplay using the correct header line height. */
14409 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14410 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
14412 fonts_changed_p
= 1;
14413 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
14414 = DESIRED_HEADER_LINE_HEIGHT (w
);
14417 if (fonts_changed_p
)
14418 goto need_larger_matrices
;
14421 if (!line_number_displayed
14422 && !BUFFERP (w
->base_line_pos
))
14424 w
->base_line_pos
= Qnil
;
14425 w
->base_line_number
= Qnil
;
14430 /* When we reach a frame's selected window, redo the frame's menu bar. */
14431 if (update_mode_line
14432 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
14434 int redisplay_menu_p
= 0;
14435 int redisplay_tool_bar_p
= 0;
14437 if (FRAME_WINDOW_P (f
))
14439 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
14440 || defined (HAVE_NS) || defined (USE_GTK)
14441 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
14443 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14447 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14449 if (redisplay_menu_p
)
14450 display_menu_bar (w
);
14452 #ifdef HAVE_WINDOW_SYSTEM
14453 if (FRAME_WINDOW_P (f
))
14455 #if defined (USE_GTK) || defined (HAVE_NS)
14456 redisplay_tool_bar_p
= FRAME_EXTERNAL_TOOL_BAR (f
);
14458 redisplay_tool_bar_p
= WINDOWP (f
->tool_bar_window
)
14459 && (FRAME_TOOL_BAR_LINES (f
) > 0
14460 || !NILP (Vauto_resize_tool_bars
));
14463 if (redisplay_tool_bar_p
&& redisplay_tool_bar (f
))
14465 ignore_mouse_drag_p
= 1;
14471 #ifdef HAVE_WINDOW_SYSTEM
14472 if (FRAME_WINDOW_P (f
)
14473 && update_window_fringes (w
, (just_this_one_p
14474 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
14475 || w
->pseudo_window_p
)))
14479 if (draw_window_fringes (w
, 1))
14480 x_draw_vertical_border (w
);
14484 #endif /* HAVE_WINDOW_SYSTEM */
14486 /* We go to this label, with fonts_changed_p nonzero,
14487 if it is necessary to try again using larger glyph matrices.
14488 We have to redeem the scroll bar even in this case,
14489 because the loop in redisplay_internal expects that. */
14490 need_larger_matrices
:
14492 finish_scroll_bars
:
14494 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
14496 /* Set the thumb's position and size. */
14497 set_vertical_scroll_bar (w
);
14499 /* Note that we actually used the scroll bar attached to this
14500 window, so it shouldn't be deleted at the end of redisplay. */
14501 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
14502 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
14505 /* Restore current_buffer and value of point in it. The window
14506 update may have changed the buffer, so first make sure `opoint'
14507 is still valid (Bug#6177). */
14508 if (CHARPOS (opoint
) < BEGV
)
14509 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
14510 else if (CHARPOS (opoint
) > ZV
)
14511 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
14513 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
14515 set_buffer_internal_1 (old
);
14516 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
14517 shorter. This can be caused by log truncation in *Messages*. */
14518 if (CHARPOS (lpoint
) <= ZV
)
14519 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
14521 unbind_to (count
, Qnil
);
14525 /* Build the complete desired matrix of WINDOW with a window start
14526 buffer position POS.
14528 Value is 1 if successful. It is zero if fonts were loaded during
14529 redisplay which makes re-adjusting glyph matrices necessary, and -1
14530 if point would appear in the scroll margins.
14531 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
14532 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
14536 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
14538 struct window
*w
= XWINDOW (window
);
14540 struct glyph_row
*last_text_row
= NULL
;
14541 struct frame
*f
= XFRAME (w
->frame
);
14543 /* Make POS the new window start. */
14544 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
14546 /* Mark cursor position as unknown. No overlay arrow seen. */
14547 w
->cursor
.vpos
= -1;
14548 overlay_arrow_seen
= 0;
14550 /* Initialize iterator and info to start at POS. */
14551 start_display (&it
, w
, pos
);
14553 /* Display all lines of W. */
14554 while (it
.current_y
< it
.last_visible_y
)
14556 if (display_line (&it
))
14557 last_text_row
= it
.glyph_row
- 1;
14558 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
14562 /* Don't let the cursor end in the scroll margins. */
14563 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
14564 && !MINI_WINDOW_P (w
))
14566 int this_scroll_margin
;
14568 if (scroll_margin
> 0)
14570 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14571 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14574 this_scroll_margin
= 0;
14576 if ((w
->cursor
.y
>= 0 /* not vscrolled */
14577 && w
->cursor
.y
< this_scroll_margin
14578 && CHARPOS (pos
) > BEGV
14579 && IT_CHARPOS (it
) < ZV
)
14580 /* rms: considering make_cursor_line_fully_visible_p here
14581 seems to give wrong results. We don't want to recenter
14582 when the last line is partly visible, we want to allow
14583 that case to be handled in the usual way. */
14584 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
14586 w
->cursor
.vpos
= -1;
14587 clear_glyph_matrix (w
->desired_matrix
);
14592 /* If bottom moved off end of frame, change mode line percentage. */
14593 if (XFASTINT (w
->window_end_pos
) <= 0
14594 && Z
!= IT_CHARPOS (it
))
14595 w
->update_mode_line
= Qt
;
14597 /* Set window_end_pos to the offset of the last character displayed
14598 on the window from the end of current_buffer. Set
14599 window_end_vpos to its row number. */
14602 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
14603 w
->window_end_bytepos
14604 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14606 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14608 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14609 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
14610 ->displays_text_p
);
14614 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14615 w
->window_end_pos
= make_number (Z
- ZV
);
14616 w
->window_end_vpos
= make_number (0);
14619 /* But that is not valid info until redisplay finishes. */
14620 w
->window_end_valid
= Qnil
;
14626 /************************************************************************
14627 Window redisplay reusing current matrix when buffer has not changed
14628 ************************************************************************/
14630 /* Try redisplay of window W showing an unchanged buffer with a
14631 different window start than the last time it was displayed by
14632 reusing its current matrix. Value is non-zero if successful.
14633 W->start is the new window start. */
14636 try_window_reusing_current_matrix (struct window
*w
)
14638 struct frame
*f
= XFRAME (w
->frame
);
14639 struct glyph_row
*row
, *bottom_row
;
14642 struct text_pos start
, new_start
;
14643 int nrows_scrolled
, i
;
14644 struct glyph_row
*last_text_row
;
14645 struct glyph_row
*last_reused_text_row
;
14646 struct glyph_row
*start_row
;
14647 int start_vpos
, min_y
, max_y
;
14650 if (inhibit_try_window_reusing
)
14654 if (/* This function doesn't handle terminal frames. */
14655 !FRAME_WINDOW_P (f
)
14656 /* Don't try to reuse the display if windows have been split
14658 || windows_or_buffers_changed
14659 || cursor_type_changed
)
14662 /* Can't do this if region may have changed. */
14663 if ((!NILP (Vtransient_mark_mode
)
14664 && !NILP (current_buffer
->mark_active
))
14665 || !NILP (w
->region_showing
)
14666 || !NILP (Vshow_trailing_whitespace
))
14669 /* If top-line visibility has changed, give up. */
14670 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14671 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
14674 /* Give up if old or new display is scrolled vertically. We could
14675 make this function handle this, but right now it doesn't. */
14676 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14677 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
14680 /* The variable new_start now holds the new window start. The old
14681 start `start' can be determined from the current matrix. */
14682 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
14683 start
= start_row
->minpos
;
14684 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14686 /* Clear the desired matrix for the display below. */
14687 clear_glyph_matrix (w
->desired_matrix
);
14689 if (CHARPOS (new_start
) <= CHARPOS (start
))
14693 /* Don't use this method if the display starts with an ellipsis
14694 displayed for invisible text. It's not easy to handle that case
14695 below, and it's certainly not worth the effort since this is
14696 not a frequent case. */
14697 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
14700 IF_DEBUG (debug_method_add (w
, "twu1"));
14702 /* Display up to a row that can be reused. The variable
14703 last_text_row is set to the last row displayed that displays
14704 text. Note that it.vpos == 0 if or if not there is a
14705 header-line; it's not the same as the MATRIX_ROW_VPOS! */
14706 start_display (&it
, w
, new_start
);
14707 first_row_y
= it
.current_y
;
14708 w
->cursor
.vpos
= -1;
14709 last_text_row
= last_reused_text_row
= NULL
;
14711 while (it
.current_y
< it
.last_visible_y
14712 && !fonts_changed_p
)
14714 /* If we have reached into the characters in the START row,
14715 that means the line boundaries have changed. So we
14716 can't start copying with the row START. Maybe it will
14717 work to start copying with the following row. */
14718 while (IT_CHARPOS (it
) > CHARPOS (start
))
14720 /* Advance to the next row as the "start". */
14722 start
= start_row
->minpos
;
14723 /* If there are no more rows to try, or just one, give up. */
14724 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
14725 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
14726 || CHARPOS (start
) == ZV
)
14728 clear_glyph_matrix (w
->desired_matrix
);
14732 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14734 /* If we have reached alignment,
14735 we can copy the rest of the rows. */
14736 if (IT_CHARPOS (it
) == CHARPOS (start
))
14739 if (display_line (&it
))
14740 last_text_row
= it
.glyph_row
- 1;
14743 /* A value of current_y < last_visible_y means that we stopped
14744 at the previous window start, which in turn means that we
14745 have at least one reusable row. */
14746 if (it
.current_y
< it
.last_visible_y
)
14748 /* IT.vpos always starts from 0; it counts text lines. */
14749 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
14751 /* Find PT if not already found in the lines displayed. */
14752 if (w
->cursor
.vpos
< 0)
14754 int dy
= it
.current_y
- start_row
->y
;
14756 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14757 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
14759 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
14760 dy
, nrows_scrolled
);
14763 clear_glyph_matrix (w
->desired_matrix
);
14768 /* Scroll the display. Do it before the current matrix is
14769 changed. The problem here is that update has not yet
14770 run, i.e. part of the current matrix is not up to date.
14771 scroll_run_hook will clear the cursor, and use the
14772 current matrix to get the height of the row the cursor is
14774 run
.current_y
= start_row
->y
;
14775 run
.desired_y
= it
.current_y
;
14776 run
.height
= it
.last_visible_y
- it
.current_y
;
14778 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
14781 FRAME_RIF (f
)->update_window_begin_hook (w
);
14782 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14783 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14784 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14788 /* Shift current matrix down by nrows_scrolled lines. */
14789 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14790 rotate_matrix (w
->current_matrix
,
14792 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14795 /* Disable lines that must be updated. */
14796 for (i
= 0; i
< nrows_scrolled
; ++i
)
14797 (start_row
+ i
)->enabled_p
= 0;
14799 /* Re-compute Y positions. */
14800 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14801 max_y
= it
.last_visible_y
;
14802 for (row
= start_row
+ nrows_scrolled
;
14806 row
->y
= it
.current_y
;
14807 row
->visible_height
= row
->height
;
14809 if (row
->y
< min_y
)
14810 row
->visible_height
-= min_y
- row
->y
;
14811 if (row
->y
+ row
->height
> max_y
)
14812 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14813 row
->redraw_fringe_bitmaps_p
= 1;
14815 it
.current_y
+= row
->height
;
14817 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14818 last_reused_text_row
= row
;
14819 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
14823 /* Disable lines in the current matrix which are now
14824 below the window. */
14825 for (++row
; row
< bottom_row
; ++row
)
14826 row
->enabled_p
= row
->mode_line_p
= 0;
14829 /* Update window_end_pos etc.; last_reused_text_row is the last
14830 reused row from the current matrix containing text, if any.
14831 The value of last_text_row is the last displayed line
14832 containing text. */
14833 if (last_reused_text_row
)
14835 w
->window_end_bytepos
14836 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
14838 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
14840 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
14841 w
->current_matrix
));
14843 else if (last_text_row
)
14845 w
->window_end_bytepos
14846 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14848 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14850 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14854 /* This window must be completely empty. */
14855 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14856 w
->window_end_pos
= make_number (Z
- ZV
);
14857 w
->window_end_vpos
= make_number (0);
14859 w
->window_end_valid
= Qnil
;
14861 /* Update hint: don't try scrolling again in update_window. */
14862 w
->desired_matrix
->no_scrolling_p
= 1;
14865 debug_method_add (w
, "try_window_reusing_current_matrix 1");
14869 else if (CHARPOS (new_start
) > CHARPOS (start
))
14871 struct glyph_row
*pt_row
, *row
;
14872 struct glyph_row
*first_reusable_row
;
14873 struct glyph_row
*first_row_to_display
;
14875 int yb
= window_text_bottom_y (w
);
14877 /* Find the row starting at new_start, if there is one. Don't
14878 reuse a partially visible line at the end. */
14879 first_reusable_row
= start_row
;
14880 while (first_reusable_row
->enabled_p
14881 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
14882 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14883 < CHARPOS (new_start
)))
14884 ++first_reusable_row
;
14886 /* Give up if there is no row to reuse. */
14887 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
14888 || !first_reusable_row
->enabled_p
14889 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14890 != CHARPOS (new_start
)))
14893 /* We can reuse fully visible rows beginning with
14894 first_reusable_row to the end of the window. Set
14895 first_row_to_display to the first row that cannot be reused.
14896 Set pt_row to the row containing point, if there is any. */
14898 for (first_row_to_display
= first_reusable_row
;
14899 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
14900 ++first_row_to_display
)
14902 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
14903 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
14904 pt_row
= first_row_to_display
;
14907 /* Start displaying at the start of first_row_to_display. */
14908 xassert (first_row_to_display
->y
< yb
);
14909 init_to_row_start (&it
, w
, first_row_to_display
);
14911 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
14913 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
14915 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
14916 + WINDOW_HEADER_LINE_HEIGHT (w
));
14918 /* Display lines beginning with first_row_to_display in the
14919 desired matrix. Set last_text_row to the last row displayed
14920 that displays text. */
14921 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
14922 if (pt_row
== NULL
)
14923 w
->cursor
.vpos
= -1;
14924 last_text_row
= NULL
;
14925 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
14926 if (display_line (&it
))
14927 last_text_row
= it
.glyph_row
- 1;
14929 /* If point is in a reused row, adjust y and vpos of the cursor
14933 w
->cursor
.vpos
-= nrows_scrolled
;
14934 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
14937 /* Give up if point isn't in a row displayed or reused. (This
14938 also handles the case where w->cursor.vpos < nrows_scrolled
14939 after the calls to display_line, which can happen with scroll
14940 margins. See bug#1295.) */
14941 if (w
->cursor
.vpos
< 0)
14943 clear_glyph_matrix (w
->desired_matrix
);
14947 /* Scroll the display. */
14948 run
.current_y
= first_reusable_row
->y
;
14949 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14950 run
.height
= it
.last_visible_y
- run
.current_y
;
14951 dy
= run
.current_y
- run
.desired_y
;
14956 FRAME_RIF (f
)->update_window_begin_hook (w
);
14957 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14958 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14959 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14963 /* Adjust Y positions of reused rows. */
14964 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14965 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14966 max_y
= it
.last_visible_y
;
14967 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
14970 row
->visible_height
= row
->height
;
14971 if (row
->y
< min_y
)
14972 row
->visible_height
-= min_y
- row
->y
;
14973 if (row
->y
+ row
->height
> max_y
)
14974 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14975 row
->redraw_fringe_bitmaps_p
= 1;
14978 /* Scroll the current matrix. */
14979 xassert (nrows_scrolled
> 0);
14980 rotate_matrix (w
->current_matrix
,
14982 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14985 /* Disable rows not reused. */
14986 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
14987 row
->enabled_p
= 0;
14989 /* Point may have moved to a different line, so we cannot assume that
14990 the previous cursor position is valid; locate the correct row. */
14993 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
14994 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
14998 w
->cursor
.y
= row
->y
;
15000 if (row
< bottom_row
)
15002 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15003 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
15005 /* Can't use this optimization with bidi-reordered glyph
15006 rows, unless cursor is already at point. */
15007 if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
15009 if (!(w
->cursor
.hpos
>= 0
15010 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
15011 && BUFFERP (glyph
->object
)
15012 && glyph
->charpos
== PT
))
15017 && (!BUFFERP (glyph
->object
)
15018 || glyph
->charpos
< PT
);
15022 w
->cursor
.x
+= glyph
->pixel_width
;
15027 /* Adjust window end. A null value of last_text_row means that
15028 the window end is in reused rows which in turn means that
15029 only its vpos can have changed. */
15032 w
->window_end_bytepos
15033 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15035 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15037 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15042 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
15045 w
->window_end_valid
= Qnil
;
15046 w
->desired_matrix
->no_scrolling_p
= 1;
15049 debug_method_add (w
, "try_window_reusing_current_matrix 2");
15059 /************************************************************************
15060 Window redisplay reusing current matrix when buffer has changed
15061 ************************************************************************/
15063 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
15064 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
15065 EMACS_INT
*, EMACS_INT
*);
15066 static struct glyph_row
*
15067 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
15068 struct glyph_row
*);
15071 /* Return the last row in MATRIX displaying text. If row START is
15072 non-null, start searching with that row. IT gives the dimensions
15073 of the display. Value is null if matrix is empty; otherwise it is
15074 a pointer to the row found. */
15076 static struct glyph_row
*
15077 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
15078 struct glyph_row
*start
)
15080 struct glyph_row
*row
, *row_found
;
15082 /* Set row_found to the last row in IT->w's current matrix
15083 displaying text. The loop looks funny but think of partially
15086 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
15087 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15089 xassert (row
->enabled_p
);
15091 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
15100 /* Return the last row in the current matrix of W that is not affected
15101 by changes at the start of current_buffer that occurred since W's
15102 current matrix was built. Value is null if no such row exists.
15104 BEG_UNCHANGED us the number of characters unchanged at the start of
15105 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
15106 first changed character in current_buffer. Characters at positions <
15107 BEG + BEG_UNCHANGED are at the same buffer positions as they were
15108 when the current matrix was built. */
15110 static struct glyph_row
*
15111 find_last_unchanged_at_beg_row (struct window
*w
)
15113 EMACS_INT first_changed_pos
= BEG
+ BEG_UNCHANGED
;
15114 struct glyph_row
*row
;
15115 struct glyph_row
*row_found
= NULL
;
15116 int yb
= window_text_bottom_y (w
);
15118 /* Find the last row displaying unchanged text. */
15119 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15120 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15121 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
15124 if (/* If row ends before first_changed_pos, it is unchanged,
15125 except in some case. */
15126 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
15127 /* When row ends in ZV and we write at ZV it is not
15129 && !row
->ends_at_zv_p
15130 /* When first_changed_pos is the end of a continued line,
15131 row is not unchanged because it may be no longer
15133 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
15134 && (row
->continued_p
15135 || row
->exact_window_width_line_p
)))
15138 /* Stop if last visible row. */
15139 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
15147 /* Find the first glyph row in the current matrix of W that is not
15148 affected by changes at the end of current_buffer since the
15149 time W's current matrix was built.
15151 Return in *DELTA the number of chars by which buffer positions in
15152 unchanged text at the end of current_buffer must be adjusted.
15154 Return in *DELTA_BYTES the corresponding number of bytes.
15156 Value is null if no such row exists, i.e. all rows are affected by
15159 static struct glyph_row
*
15160 find_first_unchanged_at_end_row (struct window
*w
,
15161 EMACS_INT
*delta
, EMACS_INT
*delta_bytes
)
15163 struct glyph_row
*row
;
15164 struct glyph_row
*row_found
= NULL
;
15166 *delta
= *delta_bytes
= 0;
15168 /* Display must not have been paused, otherwise the current matrix
15169 is not up to date. */
15170 eassert (!NILP (w
->window_end_valid
));
15172 /* A value of window_end_pos >= END_UNCHANGED means that the window
15173 end is in the range of changed text. If so, there is no
15174 unchanged row at the end of W's current matrix. */
15175 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
15178 /* Set row to the last row in W's current matrix displaying text. */
15179 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15181 /* If matrix is entirely empty, no unchanged row exists. */
15182 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15184 /* The value of row is the last glyph row in the matrix having a
15185 meaningful buffer position in it. The end position of row
15186 corresponds to window_end_pos. This allows us to translate
15187 buffer positions in the current matrix to current buffer
15188 positions for characters not in changed text. */
15190 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15191 EMACS_INT Z_BYTE_old
=
15192 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15193 EMACS_INT last_unchanged_pos
, last_unchanged_pos_old
;
15194 struct glyph_row
*first_text_row
15195 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15197 *delta
= Z
- Z_old
;
15198 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15200 /* Set last_unchanged_pos to the buffer position of the last
15201 character in the buffer that has not been changed. Z is the
15202 index + 1 of the last character in current_buffer, i.e. by
15203 subtracting END_UNCHANGED we get the index of the last
15204 unchanged character, and we have to add BEG to get its buffer
15206 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
15207 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
15209 /* Search backward from ROW for a row displaying a line that
15210 starts at a minimum position >= last_unchanged_pos_old. */
15211 for (; row
> first_text_row
; --row
)
15213 /* This used to abort, but it can happen.
15214 It is ok to just stop the search instead here. KFS. */
15215 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15218 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
15223 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
15229 /* Make sure that glyph rows in the current matrix of window W
15230 reference the same glyph memory as corresponding rows in the
15231 frame's frame matrix. This function is called after scrolling W's
15232 current matrix on a terminal frame in try_window_id and
15233 try_window_reusing_current_matrix. */
15236 sync_frame_with_window_matrix_rows (struct window
*w
)
15238 struct frame
*f
= XFRAME (w
->frame
);
15239 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
15241 /* Preconditions: W must be a leaf window and full-width. Its frame
15242 must have a frame matrix. */
15243 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
15244 xassert (WINDOW_FULL_WIDTH_P (w
));
15245 xassert (!FRAME_WINDOW_P (f
));
15247 /* If W is a full-width window, glyph pointers in W's current matrix
15248 have, by definition, to be the same as glyph pointers in the
15249 corresponding frame matrix. Note that frame matrices have no
15250 marginal areas (see build_frame_matrix). */
15251 window_row
= w
->current_matrix
->rows
;
15252 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
15253 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
15254 while (window_row
< window_row_end
)
15256 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
15257 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
15259 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
15260 frame_row
->glyphs
[TEXT_AREA
] = start
;
15261 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
15262 frame_row
->glyphs
[LAST_AREA
] = end
;
15264 /* Disable frame rows whose corresponding window rows have
15265 been disabled in try_window_id. */
15266 if (!window_row
->enabled_p
)
15267 frame_row
->enabled_p
= 0;
15269 ++window_row
, ++frame_row
;
15274 /* Find the glyph row in window W containing CHARPOS. Consider all
15275 rows between START and END (not inclusive). END null means search
15276 all rows to the end of the display area of W. Value is the row
15277 containing CHARPOS or null. */
15280 row_containing_pos (struct window
*w
, EMACS_INT charpos
,
15281 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
15283 struct glyph_row
*row
= start
;
15284 struct glyph_row
*best_row
= NULL
;
15285 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
15288 /* If we happen to start on a header-line, skip that. */
15289 if (row
->mode_line_p
)
15292 if ((end
&& row
>= end
) || !row
->enabled_p
)
15295 last_y
= window_text_bottom_y (w
) - dy
;
15299 /* Give up if we have gone too far. */
15300 if (end
&& row
>= end
)
15302 /* This formerly returned if they were equal.
15303 I think that both quantities are of a "last plus one" type;
15304 if so, when they are equal, the row is within the screen. -- rms. */
15305 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
15308 /* If it is in this row, return this row. */
15309 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
15310 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
15311 /* The end position of a row equals the start
15312 position of the next row. If CHARPOS is there, we
15313 would rather display it in the next line, except
15314 when this line ends in ZV. */
15315 && !row
->ends_at_zv_p
15316 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15317 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
15321 if (NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
15323 /* In bidi-reordered rows, there could be several rows
15324 occluding point. We need to find the one which fits
15325 CHARPOS the best. */
15326 for (g
= row
->glyphs
[TEXT_AREA
];
15327 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
15330 if (!STRINGP (g
->object
))
15332 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
15334 mindif
= eabs (g
->charpos
- charpos
);
15347 /* Try to redisplay window W by reusing its existing display. W's
15348 current matrix must be up to date when this function is called,
15349 i.e. window_end_valid must not be nil.
15353 1 if display has been updated
15354 0 if otherwise unsuccessful
15355 -1 if redisplay with same window start is known not to succeed
15357 The following steps are performed:
15359 1. Find the last row in the current matrix of W that is not
15360 affected by changes at the start of current_buffer. If no such row
15363 2. Find the first row in W's current matrix that is not affected by
15364 changes at the end of current_buffer. Maybe there is no such row.
15366 3. Display lines beginning with the row + 1 found in step 1 to the
15367 row found in step 2 or, if step 2 didn't find a row, to the end of
15370 4. If cursor is not known to appear on the window, give up.
15372 5. If display stopped at the row found in step 2, scroll the
15373 display and current matrix as needed.
15375 6. Maybe display some lines at the end of W, if we must. This can
15376 happen under various circumstances, like a partially visible line
15377 becoming fully visible, or because newly displayed lines are displayed
15378 in smaller font sizes.
15380 7. Update W's window end information. */
15383 try_window_id (struct window
*w
)
15385 struct frame
*f
= XFRAME (w
->frame
);
15386 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
15387 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
15388 struct glyph_row
*last_unchanged_at_beg_row
;
15389 struct glyph_row
*first_unchanged_at_end_row
;
15390 struct glyph_row
*row
;
15391 struct glyph_row
*bottom_row
;
15394 EMACS_INT delta
= 0, delta_bytes
= 0, stop_pos
;
15396 struct text_pos start_pos
;
15398 int first_unchanged_at_end_vpos
= 0;
15399 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
15400 struct text_pos start
;
15401 EMACS_INT first_changed_charpos
, last_changed_charpos
;
15404 if (inhibit_try_window_id
)
15408 /* This is handy for debugging. */
15410 #define GIVE_UP(X) \
15412 fprintf (stderr, "try_window_id give up %d\n", (X)); \
15416 #define GIVE_UP(X) return 0
15419 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
15421 /* Don't use this for mini-windows because these can show
15422 messages and mini-buffers, and we don't handle that here. */
15423 if (MINI_WINDOW_P (w
))
15426 /* This flag is used to prevent redisplay optimizations. */
15427 if (windows_or_buffers_changed
|| cursor_type_changed
)
15430 /* Verify that narrowing has not changed.
15431 Also verify that we were not told to prevent redisplay optimizations.
15432 It would be nice to further
15433 reduce the number of cases where this prevents try_window_id. */
15434 if (current_buffer
->clip_changed
15435 || current_buffer
->prevent_redisplay_optimizations_p
)
15438 /* Window must either use window-based redisplay or be full width. */
15439 if (!FRAME_WINDOW_P (f
)
15440 && (!FRAME_LINE_INS_DEL_OK (f
)
15441 || !WINDOW_FULL_WIDTH_P (w
)))
15444 /* Give up if point is known NOT to appear in W. */
15445 if (PT
< CHARPOS (start
))
15448 /* Another way to prevent redisplay optimizations. */
15449 if (XFASTINT (w
->last_modified
) == 0)
15452 /* Verify that window is not hscrolled. */
15453 if (XFASTINT (w
->hscroll
) != 0)
15456 /* Verify that display wasn't paused. */
15457 if (NILP (w
->window_end_valid
))
15460 /* Can't use this if highlighting a region because a cursor movement
15461 will do more than just set the cursor. */
15462 if (!NILP (Vtransient_mark_mode
)
15463 && !NILP (current_buffer
->mark_active
))
15466 /* Likewise if highlighting trailing whitespace. */
15467 if (!NILP (Vshow_trailing_whitespace
))
15470 /* Likewise if showing a region. */
15471 if (!NILP (w
->region_showing
))
15474 /* Can't use this if overlay arrow position and/or string have
15476 if (overlay_arrows_changed_p ())
15479 /* When word-wrap is on, adding a space to the first word of a
15480 wrapped line can change the wrap position, altering the line
15481 above it. It might be worthwhile to handle this more
15482 intelligently, but for now just redisplay from scratch. */
15483 if (!NILP (XBUFFER (w
->buffer
)->word_wrap
))
15486 /* Under bidi reordering, adding or deleting a character in the
15487 beginning of a paragraph, before the first strong directional
15488 character, can change the base direction of the paragraph (unless
15489 the buffer specifies a fixed paragraph direction), which will
15490 require to redisplay the whole paragraph. It might be worthwhile
15491 to find the paragraph limits and widen the range of redisplayed
15492 lines to that, but for now just give up this optimization and
15493 redisplay from scratch. */
15494 if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
)
15495 && NILP (XBUFFER (w
->buffer
)->bidi_paragraph_direction
))
15498 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
15499 only if buffer has really changed. The reason is that the gap is
15500 initially at Z for freshly visited files. The code below would
15501 set end_unchanged to 0 in that case. */
15502 if (MODIFF
> SAVE_MODIFF
15503 /* This seems to happen sometimes after saving a buffer. */
15504 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
15506 if (GPT
- BEG
< BEG_UNCHANGED
)
15507 BEG_UNCHANGED
= GPT
- BEG
;
15508 if (Z
- GPT
< END_UNCHANGED
)
15509 END_UNCHANGED
= Z
- GPT
;
15512 /* The position of the first and last character that has been changed. */
15513 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
15514 last_changed_charpos
= Z
- END_UNCHANGED
;
15516 /* If window starts after a line end, and the last change is in
15517 front of that newline, then changes don't affect the display.
15518 This case happens with stealth-fontification. Note that although
15519 the display is unchanged, glyph positions in the matrix have to
15520 be adjusted, of course. */
15521 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15522 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15523 && ((last_changed_charpos
< CHARPOS (start
)
15524 && CHARPOS (start
) == BEGV
)
15525 || (last_changed_charpos
< CHARPOS (start
) - 1
15526 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
15528 EMACS_INT Z_old
, delta
, Z_BYTE_old
, delta_bytes
;
15529 struct glyph_row
*r0
;
15531 /* Compute how many chars/bytes have been added to or removed
15532 from the buffer. */
15533 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15534 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15536 delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15538 /* Give up if PT is not in the window. Note that it already has
15539 been checked at the start of try_window_id that PT is not in
15540 front of the window start. */
15541 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + delta
)
15544 /* If window start is unchanged, we can reuse the whole matrix
15545 as is, after adjusting glyph positions. No need to compute
15546 the window end again, since its offset from Z hasn't changed. */
15547 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15548 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + delta
15549 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + delta_bytes
15550 /* PT must not be in a partially visible line. */
15551 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + delta
15552 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15554 /* Adjust positions in the glyph matrix. */
15555 if (delta
|| delta_bytes
)
15557 struct glyph_row
*r1
15558 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15559 increment_matrix_positions (w
->current_matrix
,
15560 MATRIX_ROW_VPOS (r0
, current_matrix
),
15561 MATRIX_ROW_VPOS (r1
, current_matrix
),
15562 delta
, delta_bytes
);
15565 /* Set the cursor. */
15566 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15568 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15575 /* Handle the case that changes are all below what is displayed in
15576 the window, and that PT is in the window. This shortcut cannot
15577 be taken if ZV is visible in the window, and text has been added
15578 there that is visible in the window. */
15579 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
15580 /* ZV is not visible in the window, or there are no
15581 changes at ZV, actually. */
15582 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
15583 || first_changed_charpos
== last_changed_charpos
))
15585 struct glyph_row
*r0
;
15587 /* Give up if PT is not in the window. Note that it already has
15588 been checked at the start of try_window_id that PT is not in
15589 front of the window start. */
15590 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
15593 /* If window start is unchanged, we can reuse the whole matrix
15594 as is, without changing glyph positions since no text has
15595 been added/removed in front of the window end. */
15596 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15597 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
15598 /* PT must not be in a partially visible line. */
15599 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
15600 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15602 /* We have to compute the window end anew since text
15603 could have been added/removed after it. */
15605 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15606 w
->window_end_bytepos
15607 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15609 /* Set the cursor. */
15610 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15612 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15619 /* Give up if window start is in the changed area.
15621 The condition used to read
15623 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
15625 but why that was tested escapes me at the moment. */
15626 if (CHARPOS (start
) >= first_changed_charpos
15627 && CHARPOS (start
) <= last_changed_charpos
)
15630 /* Check that window start agrees with the start of the first glyph
15631 row in its current matrix. Check this after we know the window
15632 start is not in changed text, otherwise positions would not be
15634 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15635 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
15638 /* Give up if the window ends in strings. Overlay strings
15639 at the end are difficult to handle, so don't try. */
15640 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
15641 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
15644 /* Compute the position at which we have to start displaying new
15645 lines. Some of the lines at the top of the window might be
15646 reusable because they are not displaying changed text. Find the
15647 last row in W's current matrix not affected by changes at the
15648 start of current_buffer. Value is null if changes start in the
15649 first line of window. */
15650 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
15651 if (last_unchanged_at_beg_row
)
15653 /* Avoid starting to display in the moddle of a character, a TAB
15654 for instance. This is easier than to set up the iterator
15655 exactly, and it's not a frequent case, so the additional
15656 effort wouldn't really pay off. */
15657 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
15658 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
15659 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
15660 --last_unchanged_at_beg_row
;
15662 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
15665 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
15667 start_pos
= it
.current
.pos
;
15669 /* Start displaying new lines in the desired matrix at the same
15670 vpos we would use in the current matrix, i.e. below
15671 last_unchanged_at_beg_row. */
15672 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
15674 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15675 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
15677 xassert (it
.hpos
== 0 && it
.current_x
== 0);
15681 /* There are no reusable lines at the start of the window.
15682 Start displaying in the first text line. */
15683 start_display (&it
, w
, start
);
15684 it
.vpos
= it
.first_vpos
;
15685 start_pos
= it
.current
.pos
;
15688 /* Find the first row that is not affected by changes at the end of
15689 the buffer. Value will be null if there is no unchanged row, in
15690 which case we must redisplay to the end of the window. delta
15691 will be set to the value by which buffer positions beginning with
15692 first_unchanged_at_end_row have to be adjusted due to text
15694 first_unchanged_at_end_row
15695 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
15696 IF_DEBUG (debug_delta
= delta
);
15697 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
15699 /* Set stop_pos to the buffer position up to which we will have to
15700 display new lines. If first_unchanged_at_end_row != NULL, this
15701 is the buffer position of the start of the line displayed in that
15702 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
15703 that we don't stop at a buffer position. */
15705 if (first_unchanged_at_end_row
)
15707 xassert (last_unchanged_at_beg_row
== NULL
15708 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
15710 /* If this is a continuation line, move forward to the next one
15711 that isn't. Changes in lines above affect this line.
15712 Caution: this may move first_unchanged_at_end_row to a row
15713 not displaying text. */
15714 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
15715 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15716 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15717 < it
.last_visible_y
))
15718 ++first_unchanged_at_end_row
;
15720 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15721 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15722 >= it
.last_visible_y
))
15723 first_unchanged_at_end_row
= NULL
;
15726 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
15728 first_unchanged_at_end_vpos
15729 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
15730 xassert (stop_pos
>= Z
- END_UNCHANGED
);
15733 else if (last_unchanged_at_beg_row
== NULL
)
15739 /* Either there is no unchanged row at the end, or the one we have
15740 now displays text. This is a necessary condition for the window
15741 end pos calculation at the end of this function. */
15742 xassert (first_unchanged_at_end_row
== NULL
15743 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
15745 debug_last_unchanged_at_beg_vpos
15746 = (last_unchanged_at_beg_row
15747 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
15749 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
15751 #endif /* GLYPH_DEBUG != 0 */
15754 /* Display new lines. Set last_text_row to the last new line
15755 displayed which has text on it, i.e. might end up as being the
15756 line where the window_end_vpos is. */
15757 w
->cursor
.vpos
= -1;
15758 last_text_row
= NULL
;
15759 overlay_arrow_seen
= 0;
15760 while (it
.current_y
< it
.last_visible_y
15761 && !fonts_changed_p
15762 && (first_unchanged_at_end_row
== NULL
15763 || IT_CHARPOS (it
) < stop_pos
))
15765 if (display_line (&it
))
15766 last_text_row
= it
.glyph_row
- 1;
15769 if (fonts_changed_p
)
15773 /* Compute differences in buffer positions, y-positions etc. for
15774 lines reused at the bottom of the window. Compute what we can
15776 if (first_unchanged_at_end_row
15777 /* No lines reused because we displayed everything up to the
15778 bottom of the window. */
15779 && it
.current_y
< it
.last_visible_y
)
15782 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
15784 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
15785 run
.current_y
= first_unchanged_at_end_row
->y
;
15786 run
.desired_y
= run
.current_y
+ dy
;
15787 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
15791 delta
= delta_bytes
= dvpos
= dy
15792 = run
.current_y
= run
.desired_y
= run
.height
= 0;
15793 first_unchanged_at_end_row
= NULL
;
15795 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
15798 /* Find the cursor if not already found. We have to decide whether
15799 PT will appear on this window (it sometimes doesn't, but this is
15800 not a very frequent case.) This decision has to be made before
15801 the current matrix is altered. A value of cursor.vpos < 0 means
15802 that PT is either in one of the lines beginning at
15803 first_unchanged_at_end_row or below the window. Don't care for
15804 lines that might be displayed later at the window end; as
15805 mentioned, this is not a frequent case. */
15806 if (w
->cursor
.vpos
< 0)
15808 /* Cursor in unchanged rows at the top? */
15809 if (PT
< CHARPOS (start_pos
)
15810 && last_unchanged_at_beg_row
)
15812 row
= row_containing_pos (w
, PT
,
15813 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
15814 last_unchanged_at_beg_row
+ 1, 0);
15816 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15819 /* Start from first_unchanged_at_end_row looking for PT. */
15820 else if (first_unchanged_at_end_row
)
15822 row
= row_containing_pos (w
, PT
- delta
,
15823 first_unchanged_at_end_row
, NULL
, 0);
15825 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
15826 delta_bytes
, dy
, dvpos
);
15829 /* Give up if cursor was not found. */
15830 if (w
->cursor
.vpos
< 0)
15832 clear_glyph_matrix (w
->desired_matrix
);
15837 /* Don't let the cursor end in the scroll margins. */
15839 int this_scroll_margin
, cursor_height
;
15841 this_scroll_margin
= max (0, scroll_margin
);
15842 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15843 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
15844 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
15846 if ((w
->cursor
.y
< this_scroll_margin
15847 && CHARPOS (start
) > BEGV
)
15848 /* Old redisplay didn't take scroll margin into account at the bottom,
15849 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
15850 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
15851 ? cursor_height
+ this_scroll_margin
15852 : 1)) > it
.last_visible_y
)
15854 w
->cursor
.vpos
= -1;
15855 clear_glyph_matrix (w
->desired_matrix
);
15860 /* Scroll the display. Do it before changing the current matrix so
15861 that xterm.c doesn't get confused about where the cursor glyph is
15863 if (dy
&& run
.height
)
15867 if (FRAME_WINDOW_P (f
))
15869 FRAME_RIF (f
)->update_window_begin_hook (w
);
15870 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15871 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15872 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15876 /* Terminal frame. In this case, dvpos gives the number of
15877 lines to scroll by; dvpos < 0 means scroll up. */
15878 int first_unchanged_at_end_vpos
15879 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
15880 int from
= WINDOW_TOP_EDGE_LINE (w
) + first_unchanged_at_end_vpos
;
15881 int end
= (WINDOW_TOP_EDGE_LINE (w
)
15882 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
15883 + window_internal_height (w
));
15885 /* Perform the operation on the screen. */
15888 /* Scroll last_unchanged_at_beg_row to the end of the
15889 window down dvpos lines. */
15890 set_terminal_window (f
, end
);
15892 /* On dumb terminals delete dvpos lines at the end
15893 before inserting dvpos empty lines. */
15894 if (!FRAME_SCROLL_REGION_OK (f
))
15895 ins_del_lines (f
, end
- dvpos
, -dvpos
);
15897 /* Insert dvpos empty lines in front of
15898 last_unchanged_at_beg_row. */
15899 ins_del_lines (f
, from
, dvpos
);
15901 else if (dvpos
< 0)
15903 /* Scroll up last_unchanged_at_beg_vpos to the end of
15904 the window to last_unchanged_at_beg_vpos - |dvpos|. */
15905 set_terminal_window (f
, end
);
15907 /* Delete dvpos lines in front of
15908 last_unchanged_at_beg_vpos. ins_del_lines will set
15909 the cursor to the given vpos and emit |dvpos| delete
15911 ins_del_lines (f
, from
+ dvpos
, dvpos
);
15913 /* On a dumb terminal insert dvpos empty lines at the
15915 if (!FRAME_SCROLL_REGION_OK (f
))
15916 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
15919 set_terminal_window (f
, 0);
15925 /* Shift reused rows of the current matrix to the right position.
15926 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
15928 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15929 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
15932 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
15933 bottom_vpos
, dvpos
);
15934 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
15937 else if (dvpos
> 0)
15939 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
15940 bottom_vpos
, dvpos
);
15941 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
15942 first_unchanged_at_end_vpos
+ dvpos
, 0);
15945 /* For frame-based redisplay, make sure that current frame and window
15946 matrix are in sync with respect to glyph memory. */
15947 if (!FRAME_WINDOW_P (f
))
15948 sync_frame_with_window_matrix_rows (w
);
15950 /* Adjust buffer positions in reused rows. */
15951 if (delta
|| delta_bytes
)
15952 increment_matrix_positions (current_matrix
,
15953 first_unchanged_at_end_vpos
+ dvpos
,
15954 bottom_vpos
, delta
, delta_bytes
);
15956 /* Adjust Y positions. */
15958 shift_glyph_matrix (w
, current_matrix
,
15959 first_unchanged_at_end_vpos
+ dvpos
,
15962 if (first_unchanged_at_end_row
)
15964 first_unchanged_at_end_row
+= dvpos
;
15965 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
15966 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
15967 first_unchanged_at_end_row
= NULL
;
15970 /* If scrolling up, there may be some lines to display at the end of
15972 last_text_row_at_end
= NULL
;
15975 /* Scrolling up can leave for example a partially visible line
15976 at the end of the window to be redisplayed. */
15977 /* Set last_row to the glyph row in the current matrix where the
15978 window end line is found. It has been moved up or down in
15979 the matrix by dvpos. */
15980 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
15981 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
15983 /* If last_row is the window end line, it should display text. */
15984 xassert (last_row
->displays_text_p
);
15986 /* If window end line was partially visible before, begin
15987 displaying at that line. Otherwise begin displaying with the
15988 line following it. */
15989 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
15991 init_to_row_start (&it
, w
, last_row
);
15992 it
.vpos
= last_vpos
;
15993 it
.current_y
= last_row
->y
;
15997 init_to_row_end (&it
, w
, last_row
);
15998 it
.vpos
= 1 + last_vpos
;
15999 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
16003 /* We may start in a continuation line. If so, we have to
16004 get the right continuation_lines_width and current_x. */
16005 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
16006 it
.hpos
= it
.current_x
= 0;
16008 /* Display the rest of the lines at the window end. */
16009 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
16010 while (it
.current_y
< it
.last_visible_y
16011 && !fonts_changed_p
)
16013 /* Is it always sure that the display agrees with lines in
16014 the current matrix? I don't think so, so we mark rows
16015 displayed invalid in the current matrix by setting their
16016 enabled_p flag to zero. */
16017 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
16018 if (display_line (&it
))
16019 last_text_row_at_end
= it
.glyph_row
- 1;
16023 /* Update window_end_pos and window_end_vpos. */
16024 if (first_unchanged_at_end_row
16025 && !last_text_row_at_end
)
16027 /* Window end line if one of the preserved rows from the current
16028 matrix. Set row to the last row displaying text in current
16029 matrix starting at first_unchanged_at_end_row, after
16031 xassert (first_unchanged_at_end_row
->displays_text_p
);
16032 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
16033 first_unchanged_at_end_row
);
16034 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
16036 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16037 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16039 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
16040 xassert (w
->window_end_bytepos
>= 0);
16041 IF_DEBUG (debug_method_add (w
, "A"));
16043 else if (last_text_row_at_end
)
16046 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
16047 w
->window_end_bytepos
16048 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
16050 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
16051 xassert (w
->window_end_bytepos
>= 0);
16052 IF_DEBUG (debug_method_add (w
, "B"));
16054 else if (last_text_row
)
16056 /* We have displayed either to the end of the window or at the
16057 end of the window, i.e. the last row with text is to be found
16058 in the desired matrix. */
16060 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16061 w
->window_end_bytepos
16062 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16064 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
16065 xassert (w
->window_end_bytepos
>= 0);
16067 else if (first_unchanged_at_end_row
== NULL
16068 && last_text_row
== NULL
16069 && last_text_row_at_end
== NULL
)
16071 /* Displayed to end of window, but no line containing text was
16072 displayed. Lines were deleted at the end of the window. */
16073 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
16074 int vpos
= XFASTINT (w
->window_end_vpos
);
16075 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
16076 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
16079 row
== NULL
&& vpos
>= first_vpos
;
16080 --vpos
, --current_row
, --desired_row
)
16082 if (desired_row
->enabled_p
)
16084 if (desired_row
->displays_text_p
)
16087 else if (current_row
->displays_text_p
)
16091 xassert (row
!= NULL
);
16092 w
->window_end_vpos
= make_number (vpos
+ 1);
16093 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16094 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16095 xassert (w
->window_end_bytepos
>= 0);
16096 IF_DEBUG (debug_method_add (w
, "C"));
16101 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
16102 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
16104 /* Record that display has not been completed. */
16105 w
->window_end_valid
= Qnil
;
16106 w
->desired_matrix
->no_scrolling_p
= 1;
16114 /***********************************************************************
16115 More debugging support
16116 ***********************************************************************/
16120 void dump_glyph_row (struct glyph_row
*, int, int);
16121 void dump_glyph_matrix (struct glyph_matrix
*, int);
16122 void dump_glyph (struct glyph_row
*, struct glyph
*, int);
16125 /* Dump the contents of glyph matrix MATRIX on stderr.
16127 GLYPHS 0 means don't show glyph contents.
16128 GLYPHS 1 means show glyphs in short form
16129 GLYPHS > 1 means show glyphs in long form. */
16132 dump_glyph_matrix (matrix
, glyphs
)
16133 struct glyph_matrix
*matrix
;
16137 for (i
= 0; i
< matrix
->nrows
; ++i
)
16138 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
16142 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
16143 the glyph row and area where the glyph comes from. */
16146 dump_glyph (row
, glyph
, area
)
16147 struct glyph_row
*row
;
16148 struct glyph
*glyph
;
16151 if (glyph
->type
== CHAR_GLYPH
)
16154 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16155 glyph
- row
->glyphs
[TEXT_AREA
],
16158 (BUFFERP (glyph
->object
)
16160 : (STRINGP (glyph
->object
)
16163 glyph
->pixel_width
,
16165 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
16169 glyph
->left_box_line_p
,
16170 glyph
->right_box_line_p
);
16172 else if (glyph
->type
== STRETCH_GLYPH
)
16175 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16176 glyph
- row
->glyphs
[TEXT_AREA
],
16179 (BUFFERP (glyph
->object
)
16181 : (STRINGP (glyph
->object
)
16184 glyph
->pixel_width
,
16188 glyph
->left_box_line_p
,
16189 glyph
->right_box_line_p
);
16191 else if (glyph
->type
== IMAGE_GLYPH
)
16194 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16195 glyph
- row
->glyphs
[TEXT_AREA
],
16198 (BUFFERP (glyph
->object
)
16200 : (STRINGP (glyph
->object
)
16203 glyph
->pixel_width
,
16207 glyph
->left_box_line_p
,
16208 glyph
->right_box_line_p
);
16210 else if (glyph
->type
== COMPOSITE_GLYPH
)
16213 " %5d %4c %6d %c %3d 0x%05x",
16214 glyph
- row
->glyphs
[TEXT_AREA
],
16217 (BUFFERP (glyph
->object
)
16219 : (STRINGP (glyph
->object
)
16222 glyph
->pixel_width
,
16224 if (glyph
->u
.cmp
.automatic
)
16227 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
16228 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
16230 glyph
->left_box_line_p
,
16231 glyph
->right_box_line_p
);
16236 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
16237 GLYPHS 0 means don't show glyph contents.
16238 GLYPHS 1 means show glyphs in short form
16239 GLYPHS > 1 means show glyphs in long form. */
16242 dump_glyph_row (row
, vpos
, glyphs
)
16243 struct glyph_row
*row
;
16248 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
16249 fprintf (stderr
, "======================================================================\n");
16251 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d\
16252 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
16254 MATRIX_ROW_START_CHARPOS (row
),
16255 MATRIX_ROW_END_CHARPOS (row
),
16256 row
->used
[TEXT_AREA
],
16257 row
->contains_overlapping_glyphs_p
,
16259 row
->truncated_on_left_p
,
16260 row
->truncated_on_right_p
,
16262 MATRIX_ROW_CONTINUATION_LINE_P (row
),
16263 row
->displays_text_p
,
16266 row
->ends_in_middle_of_char_p
,
16267 row
->starts_in_middle_of_char_p
,
16273 row
->visible_height
,
16276 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
16277 row
->end
.overlay_string_index
,
16278 row
->continuation_lines_width
);
16279 fprintf (stderr
, "%9d %5d\n",
16280 CHARPOS (row
->start
.string_pos
),
16281 CHARPOS (row
->end
.string_pos
));
16282 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
16283 row
->end
.dpvec_index
);
16290 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16292 struct glyph
*glyph
= row
->glyphs
[area
];
16293 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
16295 /* Glyph for a line end in text. */
16296 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
16299 if (glyph
< glyph_end
)
16300 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
16302 for (; glyph
< glyph_end
; ++glyph
)
16303 dump_glyph (row
, glyph
, area
);
16306 else if (glyphs
== 1)
16310 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16312 char *s
= (char *) alloca (row
->used
[area
] + 1);
16315 for (i
= 0; i
< row
->used
[area
]; ++i
)
16317 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
16318 if (glyph
->type
== CHAR_GLYPH
16319 && glyph
->u
.ch
< 0x80
16320 && glyph
->u
.ch
>= ' ')
16321 s
[i
] = glyph
->u
.ch
;
16327 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
16333 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
16334 Sdump_glyph_matrix
, 0, 1, "p",
16335 doc
: /* Dump the current matrix of the selected window to stderr.
16336 Shows contents of glyph row structures. With non-nil
16337 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
16338 glyphs in short form, otherwise show glyphs in long form. */)
16339 (Lisp_Object glyphs
)
16341 struct window
*w
= XWINDOW (selected_window
);
16342 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16344 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
16345 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
16346 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
16347 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
16348 fprintf (stderr
, "=============================================\n");
16349 dump_glyph_matrix (w
->current_matrix
,
16350 NILP (glyphs
) ? 0 : XINT (glyphs
));
16355 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
16356 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
16359 struct frame
*f
= XFRAME (selected_frame
);
16360 dump_glyph_matrix (f
->current_matrix
, 1);
16365 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
16366 doc
: /* Dump glyph row ROW to stderr.
16367 GLYPH 0 means don't dump glyphs.
16368 GLYPH 1 means dump glyphs in short form.
16369 GLYPH > 1 or omitted means dump glyphs in long form. */)
16370 (Lisp_Object row
, Lisp_Object glyphs
)
16372 struct glyph_matrix
*matrix
;
16375 CHECK_NUMBER (row
);
16376 matrix
= XWINDOW (selected_window
)->current_matrix
;
16378 if (vpos
>= 0 && vpos
< matrix
->nrows
)
16379 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
16381 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16386 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
16387 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
16388 GLYPH 0 means don't dump glyphs.
16389 GLYPH 1 means dump glyphs in short form.
16390 GLYPH > 1 or omitted means dump glyphs in long form. */)
16391 (Lisp_Object row
, Lisp_Object glyphs
)
16393 struct frame
*sf
= SELECTED_FRAME ();
16394 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
16397 CHECK_NUMBER (row
);
16399 if (vpos
>= 0 && vpos
< m
->nrows
)
16400 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
16401 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16406 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
16407 doc
: /* Toggle tracing of redisplay.
16408 With ARG, turn tracing on if and only if ARG is positive. */)
16412 trace_redisplay_p
= !trace_redisplay_p
;
16415 arg
= Fprefix_numeric_value (arg
);
16416 trace_redisplay_p
= XINT (arg
) > 0;
16423 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
16424 doc
: /* Like `format', but print result to stderr.
16425 usage: (trace-to-stderr STRING &rest OBJECTS) */)
16426 (int nargs
, Lisp_Object
*args
)
16428 Lisp_Object s
= Fformat (nargs
, args
);
16429 fprintf (stderr
, "%s", SDATA (s
));
16433 #endif /* GLYPH_DEBUG */
16437 /***********************************************************************
16438 Building Desired Matrix Rows
16439 ***********************************************************************/
16441 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
16442 Used for non-window-redisplay windows, and for windows w/o left fringe. */
16444 static struct glyph_row
*
16445 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
16447 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
16448 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16449 struct buffer
*old
= current_buffer
;
16450 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
16451 int arrow_len
= SCHARS (overlay_arrow_string
);
16452 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
16453 const unsigned char *p
;
16456 int n_glyphs_before
;
16458 set_buffer_temp (buffer
);
16459 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
16460 it
.glyph_row
->used
[TEXT_AREA
] = 0;
16461 SET_TEXT_POS (it
.position
, 0, 0);
16463 multibyte_p
= !NILP (buffer
->enable_multibyte_characters
);
16465 while (p
< arrow_end
)
16467 Lisp_Object face
, ilisp
;
16469 /* Get the next character. */
16471 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
16474 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
16475 if (! ASCII_CHAR_P (it
.c
))
16476 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
16480 /* Get its face. */
16481 ilisp
= make_number (p
- arrow_string
);
16482 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
16483 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
16485 /* Compute its width, get its glyphs. */
16486 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
16487 SET_TEXT_POS (it
.position
, -1, -1);
16488 PRODUCE_GLYPHS (&it
);
16490 /* If this character doesn't fit any more in the line, we have
16491 to remove some glyphs. */
16492 if (it
.current_x
> it
.last_visible_x
)
16494 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
16499 set_buffer_temp (old
);
16500 return it
.glyph_row
;
16504 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
16505 glyphs are only inserted for terminal frames since we can't really
16506 win with truncation glyphs when partially visible glyphs are
16507 involved. Which glyphs to insert is determined by
16508 produce_special_glyphs. */
16511 insert_left_trunc_glyphs (struct it
*it
)
16513 struct it truncate_it
;
16514 struct glyph
*from
, *end
, *to
, *toend
;
16516 xassert (!FRAME_WINDOW_P (it
->f
));
16518 /* Get the truncation glyphs. */
16520 truncate_it
.current_x
= 0;
16521 truncate_it
.face_id
= DEFAULT_FACE_ID
;
16522 truncate_it
.glyph_row
= &scratch_glyph_row
;
16523 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
16524 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
16525 truncate_it
.object
= make_number (0);
16526 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
16528 /* Overwrite glyphs from IT with truncation glyphs. */
16529 if (!it
->glyph_row
->reversed_p
)
16531 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16532 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
16533 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16534 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
16539 /* There may be padding glyphs left over. Overwrite them too. */
16540 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
16542 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16548 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
16552 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
16553 that back to front. */
16554 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16555 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16556 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16557 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16559 while (from
>= end
&& to
>= toend
)
16561 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
16564 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
16565 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16566 while (from
>= end
&& to
>= toend
)
16571 /* Need to free some room before prepending additional
16573 int move_by
= from
- end
+ 1;
16574 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16575 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16577 for ( ; g
>= g0
; g
--)
16579 while (from
>= end
)
16581 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
16587 /* Compute the pixel height and width of IT->glyph_row.
16589 Most of the time, ascent and height of a display line will be equal
16590 to the max_ascent and max_height values of the display iterator
16591 structure. This is not the case if
16593 1. We hit ZV without displaying anything. In this case, max_ascent
16594 and max_height will be zero.
16596 2. We have some glyphs that don't contribute to the line height.
16597 (The glyph row flag contributes_to_line_height_p is for future
16598 pixmap extensions).
16600 The first case is easily covered by using default values because in
16601 these cases, the line height does not really matter, except that it
16602 must not be zero. */
16605 compute_line_metrics (struct it
*it
)
16607 struct glyph_row
*row
= it
->glyph_row
;
16610 if (FRAME_WINDOW_P (it
->f
))
16612 int i
, min_y
, max_y
;
16614 /* The line may consist of one space only, that was added to
16615 place the cursor on it. If so, the row's height hasn't been
16617 if (row
->height
== 0)
16619 if (it
->max_ascent
+ it
->max_descent
== 0)
16620 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
16621 row
->ascent
= it
->max_ascent
;
16622 row
->height
= it
->max_ascent
+ it
->max_descent
;
16623 row
->phys_ascent
= it
->max_phys_ascent
;
16624 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16625 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
16628 /* Compute the width of this line. */
16629 row
->pixel_width
= row
->x
;
16630 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
16631 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
16633 xassert (row
->pixel_width
>= 0);
16634 xassert (row
->ascent
>= 0 && row
->height
> 0);
16636 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
16637 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
16639 /* If first line's physical ascent is larger than its logical
16640 ascent, use the physical ascent, and make the row taller.
16641 This makes accented characters fully visible. */
16642 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
16643 && row
->phys_ascent
> row
->ascent
)
16645 row
->height
+= row
->phys_ascent
- row
->ascent
;
16646 row
->ascent
= row
->phys_ascent
;
16649 /* Compute how much of the line is visible. */
16650 row
->visible_height
= row
->height
;
16652 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
16653 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
16655 if (row
->y
< min_y
)
16656 row
->visible_height
-= min_y
- row
->y
;
16657 if (row
->y
+ row
->height
> max_y
)
16658 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16662 row
->pixel_width
= row
->used
[TEXT_AREA
];
16663 if (row
->continued_p
)
16664 row
->pixel_width
-= it
->continuation_pixel_width
;
16665 else if (row
->truncated_on_right_p
)
16666 row
->pixel_width
-= it
->truncation_pixel_width
;
16667 row
->ascent
= row
->phys_ascent
= 0;
16668 row
->height
= row
->phys_height
= row
->visible_height
= 1;
16669 row
->extra_line_spacing
= 0;
16672 /* Compute a hash code for this row. */
16674 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16675 for (i
= 0; i
< row
->used
[area
]; ++i
)
16676 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
16677 + row
->glyphs
[area
][i
].u
.val
16678 + row
->glyphs
[area
][i
].face_id
16679 + row
->glyphs
[area
][i
].padding_p
16680 + (row
->glyphs
[area
][i
].type
<< 2));
16682 it
->max_ascent
= it
->max_descent
= 0;
16683 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
16687 /* Append one space to the glyph row of iterator IT if doing a
16688 window-based redisplay. The space has the same face as
16689 IT->face_id. Value is non-zero if a space was added.
16691 This function is called to make sure that there is always one glyph
16692 at the end of a glyph row that the cursor can be set on under
16693 window-systems. (If there weren't such a glyph we would not know
16694 how wide and tall a box cursor should be displayed).
16696 At the same time this space let's a nicely handle clearing to the
16697 end of the line if the row ends in italic text. */
16700 append_space_for_newline (struct it
*it
, int default_face_p
)
16702 if (FRAME_WINDOW_P (it
->f
))
16704 int n
= it
->glyph_row
->used
[TEXT_AREA
];
16706 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
16707 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
16709 /* Save some values that must not be changed.
16710 Must save IT->c and IT->len because otherwise
16711 ITERATOR_AT_END_P wouldn't work anymore after
16712 append_space_for_newline has been called. */
16713 enum display_element_type saved_what
= it
->what
;
16714 int saved_c
= it
->c
, saved_len
= it
->len
;
16715 int saved_char_to_display
= it
->char_to_display
;
16716 int saved_x
= it
->current_x
;
16717 int saved_face_id
= it
->face_id
;
16718 struct text_pos saved_pos
;
16719 Lisp_Object saved_object
;
16722 saved_object
= it
->object
;
16723 saved_pos
= it
->position
;
16725 it
->what
= IT_CHARACTER
;
16726 memset (&it
->position
, 0, sizeof it
->position
);
16727 it
->object
= make_number (0);
16728 it
->c
= it
->char_to_display
= ' ';
16731 if (default_face_p
)
16732 it
->face_id
= DEFAULT_FACE_ID
;
16733 else if (it
->face_before_selective_p
)
16734 it
->face_id
= it
->saved_face_id
;
16735 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
16736 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
16738 PRODUCE_GLYPHS (it
);
16740 it
->override_ascent
= -1;
16741 it
->constrain_row_ascent_descent_p
= 0;
16742 it
->current_x
= saved_x
;
16743 it
->object
= saved_object
;
16744 it
->position
= saved_pos
;
16745 it
->what
= saved_what
;
16746 it
->face_id
= saved_face_id
;
16747 it
->len
= saved_len
;
16749 it
->char_to_display
= saved_char_to_display
;
16758 /* Extend the face of the last glyph in the text area of IT->glyph_row
16759 to the end of the display line. Called from display_line. If the
16760 glyph row is empty, add a space glyph to it so that we know the
16761 face to draw. Set the glyph row flag fill_line_p. If the glyph
16762 row is R2L, prepend a stretch glyph to cover the empty space to the
16763 left of the leftmost glyph. */
16766 extend_face_to_end_of_line (struct it
*it
)
16769 struct frame
*f
= it
->f
;
16771 /* If line is already filled, do nothing. Non window-system frames
16772 get a grace of one more ``pixel'' because their characters are
16773 1-``pixel'' wide, so they hit the equality too early. This grace
16774 is needed only for R2L rows that are not continued, to produce
16775 one extra blank where we could display the cursor. */
16776 if (it
->current_x
>= it
->last_visible_x
16777 + (!FRAME_WINDOW_P (f
)
16778 && it
->glyph_row
->reversed_p
16779 && !it
->glyph_row
->continued_p
))
16782 /* Face extension extends the background and box of IT->face_id
16783 to the end of the line. If the background equals the background
16784 of the frame, we don't have to do anything. */
16785 if (it
->face_before_selective_p
)
16786 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
16788 face
= FACE_FROM_ID (f
, it
->face_id
);
16790 if (FRAME_WINDOW_P (f
)
16791 && it
->glyph_row
->displays_text_p
16792 && face
->box
== FACE_NO_BOX
16793 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
16795 && !it
->glyph_row
->reversed_p
)
16798 /* Set the glyph row flag indicating that the face of the last glyph
16799 in the text area has to be drawn to the end of the text area. */
16800 it
->glyph_row
->fill_line_p
= 1;
16802 /* If current character of IT is not ASCII, make sure we have the
16803 ASCII face. This will be automatically undone the next time
16804 get_next_display_element returns a multibyte character. Note
16805 that the character will always be single byte in unibyte
16807 if (!ASCII_CHAR_P (it
->c
))
16809 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
16812 if (FRAME_WINDOW_P (f
))
16814 /* If the row is empty, add a space with the current face of IT,
16815 so that we know which face to draw. */
16816 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
16818 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
16819 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
16820 it
->glyph_row
->used
[TEXT_AREA
] = 1;
16822 #ifdef HAVE_WINDOW_SYSTEM
16823 if (it
->glyph_row
->reversed_p
)
16825 /* Prepend a stretch glyph to the row, such that the
16826 rightmost glyph will be drawn flushed all the way to the
16827 right margin of the window. The stretch glyph that will
16828 occupy the empty space, if any, to the left of the
16830 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
16831 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16832 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
16834 int row_width
, stretch_ascent
, stretch_width
;
16835 struct text_pos saved_pos
;
16836 int saved_face_id
, saved_avoid_cursor
;
16838 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
16839 row_width
+= g
->pixel_width
;
16840 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
16841 if (stretch_width
> 0)
16844 (((it
->ascent
+ it
->descent
)
16845 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
16846 saved_pos
= it
->position
;
16847 memset (&it
->position
, 0, sizeof it
->position
);
16848 saved_avoid_cursor
= it
->avoid_cursor_p
;
16849 it
->avoid_cursor_p
= 1;
16850 saved_face_id
= it
->face_id
;
16851 /* The last row's stretch glyph should get the default
16852 face, to avoid painting the rest of the window with
16853 the region face, if the region ends at ZV. */
16854 if (it
->glyph_row
->ends_at_zv_p
)
16855 it
->face_id
= DEFAULT_FACE_ID
;
16857 it
->face_id
= face
->id
;
16858 append_stretch_glyph (it
, make_number (0), stretch_width
,
16859 it
->ascent
+ it
->descent
, stretch_ascent
);
16860 it
->position
= saved_pos
;
16861 it
->avoid_cursor_p
= saved_avoid_cursor
;
16862 it
->face_id
= saved_face_id
;
16865 #endif /* HAVE_WINDOW_SYSTEM */
16869 /* Save some values that must not be changed. */
16870 int saved_x
= it
->current_x
;
16871 struct text_pos saved_pos
;
16872 Lisp_Object saved_object
;
16873 enum display_element_type saved_what
= it
->what
;
16874 int saved_face_id
= it
->face_id
;
16876 saved_object
= it
->object
;
16877 saved_pos
= it
->position
;
16879 it
->what
= IT_CHARACTER
;
16880 memset (&it
->position
, 0, sizeof it
->position
);
16881 it
->object
= make_number (0);
16882 it
->c
= it
->char_to_display
= ' ';
16884 /* The last row's blank glyphs should get the default face, to
16885 avoid painting the rest of the window with the region face,
16886 if the region ends at ZV. */
16887 if (it
->glyph_row
->ends_at_zv_p
)
16888 it
->face_id
= DEFAULT_FACE_ID
;
16890 it
->face_id
= face
->id
;
16892 PRODUCE_GLYPHS (it
);
16894 while (it
->current_x
<= it
->last_visible_x
)
16895 PRODUCE_GLYPHS (it
);
16897 /* Don't count these blanks really. It would let us insert a left
16898 truncation glyph below and make us set the cursor on them, maybe. */
16899 it
->current_x
= saved_x
;
16900 it
->object
= saved_object
;
16901 it
->position
= saved_pos
;
16902 it
->what
= saved_what
;
16903 it
->face_id
= saved_face_id
;
16908 /* Value is non-zero if text starting at CHARPOS in current_buffer is
16909 trailing whitespace. */
16912 trailing_whitespace_p (EMACS_INT charpos
)
16914 EMACS_INT bytepos
= CHAR_TO_BYTE (charpos
);
16917 while (bytepos
< ZV_BYTE
16918 && (c
= FETCH_CHAR (bytepos
),
16919 c
== ' ' || c
== '\t'))
16922 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
16924 if (bytepos
!= PT_BYTE
)
16931 /* Highlight trailing whitespace, if any, in ROW. */
16934 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
16936 int used
= row
->used
[TEXT_AREA
];
16940 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
16941 struct glyph
*glyph
= start
+ used
- 1;
16943 if (row
->reversed_p
)
16945 /* Right-to-left rows need to be processed in the opposite
16946 direction, so swap the edge pointers. */
16948 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
16951 /* Skip over glyphs inserted to display the cursor at the
16952 end of a line, for extending the face of the last glyph
16953 to the end of the line on terminals, and for truncation
16954 and continuation glyphs. */
16955 if (!row
->reversed_p
)
16957 while (glyph
>= start
16958 && glyph
->type
== CHAR_GLYPH
16959 && INTEGERP (glyph
->object
))
16964 while (glyph
<= start
16965 && glyph
->type
== CHAR_GLYPH
16966 && INTEGERP (glyph
->object
))
16970 /* If last glyph is a space or stretch, and it's trailing
16971 whitespace, set the face of all trailing whitespace glyphs in
16972 IT->glyph_row to `trailing-whitespace'. */
16973 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
16974 && BUFFERP (glyph
->object
)
16975 && (glyph
->type
== STRETCH_GLYPH
16976 || (glyph
->type
== CHAR_GLYPH
16977 && glyph
->u
.ch
== ' '))
16978 && trailing_whitespace_p (glyph
->charpos
))
16980 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
16984 if (!row
->reversed_p
)
16986 while (glyph
>= start
16987 && BUFFERP (glyph
->object
)
16988 && (glyph
->type
== STRETCH_GLYPH
16989 || (glyph
->type
== CHAR_GLYPH
16990 && glyph
->u
.ch
== ' ')))
16991 (glyph
--)->face_id
= face_id
;
16995 while (glyph
<= start
16996 && BUFFERP (glyph
->object
)
16997 && (glyph
->type
== STRETCH_GLYPH
16998 || (glyph
->type
== CHAR_GLYPH
16999 && glyph
->u
.ch
== ' ')))
17000 (glyph
++)->face_id
= face_id
;
17007 /* Value is non-zero if glyph row ROW in window W should be
17008 used to hold the cursor. */
17011 cursor_row_p (struct window
*w
, struct glyph_row
*row
)
17013 int cursor_row_p
= 1;
17015 if (PT
== CHARPOS (row
->end
.pos
))
17017 /* Suppose the row ends on a string.
17018 Unless the row is continued, that means it ends on a newline
17019 in the string. If it's anything other than a display string
17020 (e.g. a before-string from an overlay), we don't want the
17021 cursor there. (This heuristic seems to give the optimal
17022 behavior for the various types of multi-line strings.) */
17023 if (CHARPOS (row
->end
.string_pos
) >= 0)
17025 if (row
->continued_p
)
17029 /* Check for `display' property. */
17030 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
17031 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
17032 struct glyph
*glyph
;
17035 for (glyph
= end
; glyph
>= beg
; --glyph
)
17036 if (STRINGP (glyph
->object
))
17039 = Fget_char_property (make_number (PT
),
17043 && display_prop_string_p (prop
, glyph
->object
));
17048 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
17050 /* If the row ends in middle of a real character,
17051 and the line is continued, we want the cursor here.
17052 That's because CHARPOS (ROW->end.pos) would equal
17053 PT if PT is before the character. */
17054 if (!row
->ends_in_ellipsis_p
)
17055 cursor_row_p
= row
->continued_p
;
17057 /* If the row ends in an ellipsis, then
17058 CHARPOS (ROW->end.pos) will equal point after the
17059 invisible text. We want that position to be displayed
17060 after the ellipsis. */
17063 /* If the row ends at ZV, display the cursor at the end of that
17064 row instead of at the start of the row below. */
17065 else if (row
->ends_at_zv_p
)
17071 return cursor_row_p
;
17076 /* Push the display property PROP so that it will be rendered at the
17077 current position in IT. Return 1 if PROP was successfully pushed,
17081 push_display_prop (struct it
*it
, Lisp_Object prop
)
17085 if (STRINGP (prop
))
17087 if (SCHARS (prop
) == 0)
17094 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
17095 it
->current
.overlay_string_index
= -1;
17096 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
17097 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
17098 it
->method
= GET_FROM_STRING
;
17099 it
->stop_charpos
= 0;
17101 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
17103 it
->method
= GET_FROM_STRETCH
;
17106 #ifdef HAVE_WINDOW_SYSTEM
17107 else if (IMAGEP (prop
))
17109 it
->what
= IT_IMAGE
;
17110 it
->image_id
= lookup_image (it
->f
, prop
);
17111 it
->method
= GET_FROM_IMAGE
;
17113 #endif /* HAVE_WINDOW_SYSTEM */
17116 pop_it (it
); /* bogus display property, give up */
17123 /* Return the character-property PROP at the current position in IT. */
17126 get_it_property (struct it
*it
, Lisp_Object prop
)
17128 Lisp_Object position
;
17130 if (STRINGP (it
->object
))
17131 position
= make_number (IT_STRING_CHARPOS (*it
));
17132 else if (BUFFERP (it
->object
))
17133 position
= make_number (IT_CHARPOS (*it
));
17137 return Fget_char_property (position
, prop
, it
->object
);
17140 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
17143 handle_line_prefix (struct it
*it
)
17145 Lisp_Object prefix
;
17146 if (it
->continuation_lines_width
> 0)
17148 prefix
= get_it_property (it
, Qwrap_prefix
);
17150 prefix
= Vwrap_prefix
;
17154 prefix
= get_it_property (it
, Qline_prefix
);
17156 prefix
= Vline_prefix
;
17158 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
17160 /* If the prefix is wider than the window, and we try to wrap
17161 it, it would acquire its own wrap prefix, and so on till the
17162 iterator stack overflows. So, don't wrap the prefix. */
17163 it
->line_wrap
= TRUNCATE
;
17164 it
->avoid_cursor_p
= 1;
17170 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
17171 only for R2L lines from display_line, when it decides that too many
17172 glyphs were produced by PRODUCE_GLYPHS, and the line needs to be
17175 unproduce_glyphs (struct it
*it
, int n
)
17177 struct glyph
*glyph
, *end
;
17179 xassert (it
->glyph_row
);
17180 xassert (it
->glyph_row
->reversed_p
);
17181 xassert (it
->area
== TEXT_AREA
);
17182 xassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
17184 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
17185 n
= it
->glyph_row
->used
[TEXT_AREA
];
17186 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
17187 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
17188 for ( ; glyph
< end
; glyph
++)
17189 glyph
[-n
] = *glyph
;
17192 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
17193 and ROW->maxpos. */
17195 find_row_edges (struct it
*it
, struct glyph_row
*row
,
17196 EMACS_INT min_pos
, EMACS_INT min_bpos
,
17197 EMACS_INT max_pos
, EMACS_INT max_bpos
)
17199 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17200 lines' rows is implemented for bidi-reordered rows. */
17202 /* ROW->minpos is the value of min_pos, the minimal buffer position
17205 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
17208 /* We didn't find _any_ valid buffer positions in any of the
17209 glyphs, so we must trust the iterator's computed
17211 row
->minpos
= row
->start
.pos
;
17212 max_pos
= CHARPOS (it
->current
.pos
);
17213 max_bpos
= BYTEPOS (it
->current
.pos
);
17219 /* Here are the various use-cases for ending the row, and the
17220 corresponding values for ROW->maxpos:
17222 Line ends in a newline from buffer eol_pos + 1
17223 Line is continued from buffer max_pos + 1
17224 Line is truncated on right it->current.pos
17225 Line ends in a newline from string max_pos
17226 Line is continued from string max_pos
17227 Line is continued from display vector max_pos
17228 Line is entirely from a string min_pos == max_pos
17229 Line is entirely from a display vector min_pos == max_pos
17230 Line that ends at ZV ZV
17232 If you discover other use-cases, please add them here as
17234 if (row
->ends_at_zv_p
)
17235 row
->maxpos
= it
->current
.pos
;
17236 else if (row
->used
[TEXT_AREA
])
17238 if (row
->ends_in_newline_from_string_p
)
17239 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17240 else if (CHARPOS (it
->eol_pos
) > 0)
17241 SET_TEXT_POS (row
->maxpos
,
17242 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
17243 else if (row
->continued_p
)
17245 /* If max_pos is different from IT's current position, it
17246 means IT->method does not belong to the display element
17247 at max_pos. However, it also means that the display
17248 element at max_pos was displayed in its entirety on this
17249 line, which is equivalent to saying that the next line
17250 starts at the next buffer position. */
17251 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
17252 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17255 INC_BOTH (max_pos
, max_bpos
);
17256 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17259 else if (row
->truncated_on_right_p
)
17260 /* display_line already called reseat_at_next_visible_line_start,
17261 which puts the iterator at the beginning of the next line, in
17262 the logical order. */
17263 row
->maxpos
= it
->current
.pos
;
17264 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
17265 /* A line that is entirely from a string/image/stretch... */
17266 row
->maxpos
= row
->minpos
;
17271 row
->maxpos
= it
->current
.pos
;
17274 /* Construct the glyph row IT->glyph_row in the desired matrix of
17275 IT->w from text at the current position of IT. See dispextern.h
17276 for an overview of struct it. Value is non-zero if
17277 IT->glyph_row displays text, as opposed to a line displaying ZV
17281 display_line (struct it
*it
)
17283 struct glyph_row
*row
= it
->glyph_row
;
17284 Lisp_Object overlay_arrow_string
;
17286 int may_wrap
= 0, wrap_x
;
17287 int wrap_row_used
= -1, wrap_row_ascent
, wrap_row_height
;
17288 int wrap_row_phys_ascent
, wrap_row_phys_height
;
17289 int wrap_row_extra_line_spacing
;
17290 EMACS_INT wrap_row_min_pos
, wrap_row_min_bpos
;
17291 EMACS_INT wrap_row_max_pos
, wrap_row_max_bpos
;
17293 EMACS_INT min_pos
= ZV
+ 1, min_bpos
, max_pos
= 0, max_bpos
;
17295 /* We always start displaying at hpos zero even if hscrolled. */
17296 xassert (it
->hpos
== 0 && it
->current_x
== 0);
17298 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
17299 >= it
->w
->desired_matrix
->nrows
)
17301 it
->w
->nrows_scale_factor
++;
17302 fonts_changed_p
= 1;
17306 /* Is IT->w showing the region? */
17307 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
17309 /* Clear the result glyph row and enable it. */
17310 prepare_desired_row (row
);
17312 row
->y
= it
->current_y
;
17313 row
->start
= it
->start
;
17314 row
->continuation_lines_width
= it
->continuation_lines_width
;
17315 row
->displays_text_p
= 1;
17316 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
17317 it
->starts_in_middle_of_char_p
= 0;
17319 /* Arrange the overlays nicely for our purposes. Usually, we call
17320 display_line on only one line at a time, in which case this
17321 can't really hurt too much, or we call it on lines which appear
17322 one after another in the buffer, in which case all calls to
17323 recenter_overlay_lists but the first will be pretty cheap. */
17324 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
17326 /* Move over display elements that are not visible because we are
17327 hscrolled. This may stop at an x-position < IT->first_visible_x
17328 if the first glyph is partially visible or if we hit a line end. */
17329 if (it
->current_x
< it
->first_visible_x
)
17331 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
17332 MOVE_TO_POS
| MOVE_TO_X
);
17336 /* We only do this when not calling `move_it_in_display_line_to'
17337 above, because move_it_in_display_line_to calls
17338 handle_line_prefix itself. */
17339 handle_line_prefix (it
);
17342 /* Get the initial row height. This is either the height of the
17343 text hscrolled, if there is any, or zero. */
17344 row
->ascent
= it
->max_ascent
;
17345 row
->height
= it
->max_ascent
+ it
->max_descent
;
17346 row
->phys_ascent
= it
->max_phys_ascent
;
17347 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
17348 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
17350 /* Utility macro to record max and min buffer positions seen until now. */
17351 #define RECORD_MAX_MIN_POS(IT) \
17354 if (IT_CHARPOS (*(IT)) < min_pos) \
17356 min_pos = IT_CHARPOS (*(IT)); \
17357 min_bpos = IT_BYTEPOS (*(IT)); \
17359 if (IT_CHARPOS (*(IT)) > max_pos) \
17361 max_pos = IT_CHARPOS (*(IT)); \
17362 max_bpos = IT_BYTEPOS (*(IT)); \
17367 /* Loop generating characters. The loop is left with IT on the next
17368 character to display. */
17371 int n_glyphs_before
, hpos_before
, x_before
;
17373 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
17375 /* Retrieve the next thing to display. Value is zero if end of
17377 if (!get_next_display_element (it
))
17379 /* Maybe add a space at the end of this line that is used to
17380 display the cursor there under X. Set the charpos of the
17381 first glyph of blank lines not corresponding to any text
17383 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17384 row
->exact_window_width_line_p
= 1;
17385 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
17386 || row
->used
[TEXT_AREA
] == 0)
17388 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
17389 row
->displays_text_p
= 0;
17391 if (!NILP (XBUFFER (it
->w
->buffer
)->indicate_empty_lines
)
17392 && (!MINI_WINDOW_P (it
->w
)
17393 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
17394 row
->indicate_empty_line_p
= 1;
17397 it
->continuation_lines_width
= 0;
17398 row
->ends_at_zv_p
= 1;
17399 /* A row that displays right-to-left text must always have
17400 its last face extended all the way to the end of line,
17401 even if this row ends in ZV, because we still write to
17402 the screen left to right. */
17403 if (row
->reversed_p
)
17404 extend_face_to_end_of_line (it
);
17408 /* Now, get the metrics of what we want to display. This also
17409 generates glyphs in `row' (which is IT->glyph_row). */
17410 n_glyphs_before
= row
->used
[TEXT_AREA
];
17413 /* Remember the line height so far in case the next element doesn't
17414 fit on the line. */
17415 if (it
->line_wrap
!= TRUNCATE
)
17417 ascent
= it
->max_ascent
;
17418 descent
= it
->max_descent
;
17419 phys_ascent
= it
->max_phys_ascent
;
17420 phys_descent
= it
->max_phys_descent
;
17422 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
17424 if (IT_DISPLAYING_WHITESPACE (it
))
17430 wrap_row_used
= row
->used
[TEXT_AREA
];
17431 wrap_row_ascent
= row
->ascent
;
17432 wrap_row_height
= row
->height
;
17433 wrap_row_phys_ascent
= row
->phys_ascent
;
17434 wrap_row_phys_height
= row
->phys_height
;
17435 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
17436 wrap_row_min_pos
= min_pos
;
17437 wrap_row_min_bpos
= min_bpos
;
17438 wrap_row_max_pos
= max_pos
;
17439 wrap_row_max_bpos
= max_bpos
;
17445 PRODUCE_GLYPHS (it
);
17447 /* If this display element was in marginal areas, continue with
17449 if (it
->area
!= TEXT_AREA
)
17451 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17452 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17453 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17454 row
->phys_height
= max (row
->phys_height
,
17455 it
->max_phys_ascent
+ it
->max_phys_descent
);
17456 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17457 it
->max_extra_line_spacing
);
17458 set_iterator_to_next (it
, 1);
17462 /* Does the display element fit on the line? If we truncate
17463 lines, we should draw past the right edge of the window. If
17464 we don't truncate, we want to stop so that we can display the
17465 continuation glyph before the right margin. If lines are
17466 continued, there are two possible strategies for characters
17467 resulting in more than 1 glyph (e.g. tabs): Display as many
17468 glyphs as possible in this line and leave the rest for the
17469 continuation line, or display the whole element in the next
17470 line. Original redisplay did the former, so we do it also. */
17471 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
17472 hpos_before
= it
->hpos
;
17475 if (/* Not a newline. */
17477 /* Glyphs produced fit entirely in the line. */
17478 && it
->current_x
< it
->last_visible_x
)
17480 it
->hpos
+= nglyphs
;
17481 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17482 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17483 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17484 row
->phys_height
= max (row
->phys_height
,
17485 it
->max_phys_ascent
+ it
->max_phys_descent
);
17486 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17487 it
->max_extra_line_spacing
);
17488 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
17489 row
->x
= x
- it
->first_visible_x
;
17490 /* Record the maximum and minimum buffer positions seen so
17491 far in glyphs that will be displayed by this row. */
17493 RECORD_MAX_MIN_POS (it
);
17498 struct glyph
*glyph
;
17500 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
17502 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
17503 new_x
= x
+ glyph
->pixel_width
;
17505 if (/* Lines are continued. */
17506 it
->line_wrap
!= TRUNCATE
17507 && (/* Glyph doesn't fit on the line. */
17508 new_x
> it
->last_visible_x
17509 /* Or it fits exactly on a window system frame. */
17510 || (new_x
== it
->last_visible_x
17511 && FRAME_WINDOW_P (it
->f
))))
17513 /* End of a continued line. */
17516 || (new_x
== it
->last_visible_x
17517 && FRAME_WINDOW_P (it
->f
)))
17519 /* Current glyph is the only one on the line or
17520 fits exactly on the line. We must continue
17521 the line because we can't draw the cursor
17522 after the glyph. */
17523 row
->continued_p
= 1;
17524 it
->current_x
= new_x
;
17525 it
->continuation_lines_width
+= new_x
;
17527 /* Record the maximum and minimum buffer
17528 positions seen so far in glyphs that will be
17529 displayed by this row. */
17531 RECORD_MAX_MIN_POS (it
);
17532 if (i
== nglyphs
- 1)
17534 /* If line-wrap is on, check if a previous
17535 wrap point was found. */
17536 if (wrap_row_used
> 0
17537 /* Even if there is a previous wrap
17538 point, continue the line here as
17539 usual, if (i) the previous character
17540 was a space or tab AND (ii) the
17541 current character is not. */
17543 || IT_DISPLAYING_WHITESPACE (it
)))
17546 set_iterator_to_next (it
, 1);
17547 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17549 if (!get_next_display_element (it
))
17551 row
->exact_window_width_line_p
= 1;
17552 it
->continuation_lines_width
= 0;
17553 row
->continued_p
= 0;
17554 row
->ends_at_zv_p
= 1;
17556 else if (ITERATOR_AT_END_OF_LINE_P (it
))
17558 row
->continued_p
= 0;
17559 row
->exact_window_width_line_p
= 1;
17564 else if (CHAR_GLYPH_PADDING_P (*glyph
)
17565 && !FRAME_WINDOW_P (it
->f
))
17567 /* A padding glyph that doesn't fit on this line.
17568 This means the whole character doesn't fit
17570 if (row
->reversed_p
)
17571 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17572 - n_glyphs_before
);
17573 row
->used
[TEXT_AREA
] = n_glyphs_before
;
17575 /* Fill the rest of the row with continuation
17576 glyphs like in 20.x. */
17577 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
17578 < row
->glyphs
[1 + TEXT_AREA
])
17579 produce_special_glyphs (it
, IT_CONTINUATION
);
17581 row
->continued_p
= 1;
17582 it
->current_x
= x_before
;
17583 it
->continuation_lines_width
+= x_before
;
17585 /* Restore the height to what it was before the
17586 element not fitting on the line. */
17587 it
->max_ascent
= ascent
;
17588 it
->max_descent
= descent
;
17589 it
->max_phys_ascent
= phys_ascent
;
17590 it
->max_phys_descent
= phys_descent
;
17592 else if (wrap_row_used
> 0)
17595 if (row
->reversed_p
)
17596 unproduce_glyphs (it
,
17597 row
->used
[TEXT_AREA
] - wrap_row_used
);
17599 it
->continuation_lines_width
+= wrap_x
;
17600 row
->used
[TEXT_AREA
] = wrap_row_used
;
17601 row
->ascent
= wrap_row_ascent
;
17602 row
->height
= wrap_row_height
;
17603 row
->phys_ascent
= wrap_row_phys_ascent
;
17604 row
->phys_height
= wrap_row_phys_height
;
17605 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
17606 min_pos
= wrap_row_min_pos
;
17607 min_bpos
= wrap_row_min_bpos
;
17608 max_pos
= wrap_row_max_pos
;
17609 max_bpos
= wrap_row_max_bpos
;
17610 row
->continued_p
= 1;
17611 row
->ends_at_zv_p
= 0;
17612 row
->exact_window_width_line_p
= 0;
17613 it
->continuation_lines_width
+= x
;
17615 /* Make sure that a non-default face is extended
17616 up to the right margin of the window. */
17617 extend_face_to_end_of_line (it
);
17619 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
17621 /* A TAB that extends past the right edge of the
17622 window. This produces a single glyph on
17623 window system frames. We leave the glyph in
17624 this row and let it fill the row, but don't
17625 consume the TAB. */
17626 it
->continuation_lines_width
+= it
->last_visible_x
;
17627 row
->ends_in_middle_of_char_p
= 1;
17628 row
->continued_p
= 1;
17629 glyph
->pixel_width
= it
->last_visible_x
- x
;
17630 it
->starts_in_middle_of_char_p
= 1;
17634 /* Something other than a TAB that draws past
17635 the right edge of the window. Restore
17636 positions to values before the element. */
17637 if (row
->reversed_p
)
17638 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17639 - (n_glyphs_before
+ i
));
17640 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
17642 /* Display continuation glyphs. */
17643 if (!FRAME_WINDOW_P (it
->f
))
17644 produce_special_glyphs (it
, IT_CONTINUATION
);
17645 row
->continued_p
= 1;
17647 it
->current_x
= x_before
;
17648 it
->continuation_lines_width
+= x
;
17649 extend_face_to_end_of_line (it
);
17651 if (nglyphs
> 1 && i
> 0)
17653 row
->ends_in_middle_of_char_p
= 1;
17654 it
->starts_in_middle_of_char_p
= 1;
17657 /* Restore the height to what it was before the
17658 element not fitting on the line. */
17659 it
->max_ascent
= ascent
;
17660 it
->max_descent
= descent
;
17661 it
->max_phys_ascent
= phys_ascent
;
17662 it
->max_phys_descent
= phys_descent
;
17667 else if (new_x
> it
->first_visible_x
)
17669 /* Increment number of glyphs actually displayed. */
17672 /* Record the maximum and minimum buffer positions
17673 seen so far in glyphs that will be displayed by
17676 RECORD_MAX_MIN_POS (it
);
17678 if (x
< it
->first_visible_x
)
17679 /* Glyph is partially visible, i.e. row starts at
17680 negative X position. */
17681 row
->x
= x
- it
->first_visible_x
;
17685 /* Glyph is completely off the left margin of the
17686 window. This should not happen because of the
17687 move_it_in_display_line at the start of this
17688 function, unless the text display area of the
17689 window is empty. */
17690 xassert (it
->first_visible_x
<= it
->last_visible_x
);
17694 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17695 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17696 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17697 row
->phys_height
= max (row
->phys_height
,
17698 it
->max_phys_ascent
+ it
->max_phys_descent
);
17699 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17700 it
->max_extra_line_spacing
);
17702 /* End of this display line if row is continued. */
17703 if (row
->continued_p
|| row
->ends_at_zv_p
)
17708 /* Is this a line end? If yes, we're also done, after making
17709 sure that a non-default face is extended up to the right
17710 margin of the window. */
17711 if (ITERATOR_AT_END_OF_LINE_P (it
))
17713 int used_before
= row
->used
[TEXT_AREA
];
17715 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
17717 /* Add a space at the end of the line that is used to
17718 display the cursor there. */
17719 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17720 append_space_for_newline (it
, 0);
17722 /* Extend the face to the end of the line. */
17723 extend_face_to_end_of_line (it
);
17725 /* Make sure we have the position. */
17726 if (used_before
== 0)
17727 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
17729 /* Record the position of the newline, for use in
17731 it
->eol_pos
= it
->current
.pos
;
17733 /* Consume the line end. This skips over invisible lines. */
17734 set_iterator_to_next (it
, 1);
17735 it
->continuation_lines_width
= 0;
17739 /* Proceed with next display element. Note that this skips
17740 over lines invisible because of selective display. */
17741 set_iterator_to_next (it
, 1);
17743 /* If we truncate lines, we are done when the last displayed
17744 glyphs reach past the right margin of the window. */
17745 if (it
->line_wrap
== TRUNCATE
17746 && (FRAME_WINDOW_P (it
->f
)
17747 ? (it
->current_x
>= it
->last_visible_x
)
17748 : (it
->current_x
> it
->last_visible_x
)))
17750 /* Maybe add truncation glyphs. */
17751 if (!FRAME_WINDOW_P (it
->f
))
17755 if (!row
->reversed_p
)
17757 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
17758 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17763 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
17764 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17766 /* Remove any padding glyphs at the front of ROW, to
17767 make room for the truncation glyphs we will be
17768 adding below. The loop below always inserts at
17769 least one truncation glyph, so also remove the
17770 last glyph added to ROW. */
17771 unproduce_glyphs (it
, i
+ 1);
17772 /* Adjust i for the loop below. */
17773 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
17776 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
17778 row
->used
[TEXT_AREA
] = i
;
17779 produce_special_glyphs (it
, IT_TRUNCATION
);
17782 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17784 /* Don't truncate if we can overflow newline into fringe. */
17785 if (!get_next_display_element (it
))
17787 it
->continuation_lines_width
= 0;
17788 row
->ends_at_zv_p
= 1;
17789 row
->exact_window_width_line_p
= 1;
17792 if (ITERATOR_AT_END_OF_LINE_P (it
))
17794 row
->exact_window_width_line_p
= 1;
17795 goto at_end_of_line
;
17799 row
->truncated_on_right_p
= 1;
17800 it
->continuation_lines_width
= 0;
17801 reseat_at_next_visible_line_start (it
, 0);
17802 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
17803 it
->hpos
= hpos_before
;
17804 it
->current_x
= x_before
;
17809 /* If line is not empty and hscrolled, maybe insert truncation glyphs
17810 at the left window margin. */
17811 if (it
->first_visible_x
17812 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
17814 if (!FRAME_WINDOW_P (it
->f
))
17815 insert_left_trunc_glyphs (it
);
17816 row
->truncated_on_left_p
= 1;
17819 /* Remember the position at which this line ends.
17821 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
17822 cannot be before the call to find_row_edges below, since that is
17823 where these positions are determined. */
17824 row
->end
= it
->current
;
17827 row
->minpos
= row
->start
.pos
;
17828 row
->maxpos
= row
->end
.pos
;
17832 /* ROW->minpos and ROW->maxpos must be the smallest and
17833 `1 + the largest' buffer positions in ROW. But if ROW was
17834 bidi-reordered, these two positions can be anywhere in the
17835 row, so we must determine them now. */
17836 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
17839 /* If the start of this line is the overlay arrow-position, then
17840 mark this glyph row as the one containing the overlay arrow.
17841 This is clearly a mess with variable size fonts. It would be
17842 better to let it be displayed like cursors under X. */
17843 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
17844 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
17845 !NILP (overlay_arrow_string
)))
17847 /* Overlay arrow in window redisplay is a fringe bitmap. */
17848 if (STRINGP (overlay_arrow_string
))
17850 struct glyph_row
*arrow_row
17851 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
17852 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
17853 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
17854 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
17855 struct glyph
*p2
, *end
;
17857 /* Copy the arrow glyphs. */
17858 while (glyph
< arrow_end
)
17861 /* Throw away padding glyphs. */
17863 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17864 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
17870 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
17875 xassert (INTEGERP (overlay_arrow_string
));
17876 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
17878 overlay_arrow_seen
= 1;
17881 /* Compute pixel dimensions of this line. */
17882 compute_line_metrics (it
);
17884 /* Record whether this row ends inside an ellipsis. */
17885 row
->ends_in_ellipsis_p
17886 = (it
->method
== GET_FROM_DISPLAY_VECTOR
17887 && it
->ellipsis_p
);
17889 /* Save fringe bitmaps in this row. */
17890 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
17891 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
17892 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
17893 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
17895 it
->left_user_fringe_bitmap
= 0;
17896 it
->left_user_fringe_face_id
= 0;
17897 it
->right_user_fringe_bitmap
= 0;
17898 it
->right_user_fringe_face_id
= 0;
17900 /* Maybe set the cursor. */
17901 cvpos
= it
->w
->cursor
.vpos
;
17903 /* In bidi-reordered rows, keep checking for proper cursor
17904 position even if one has been found already, because buffer
17905 positions in such rows change non-linearly with ROW->VPOS,
17906 when a line is continued. One exception: when we are at ZV,
17907 display cursor on the first suitable glyph row, since all
17908 the empty rows after that also have their position set to ZV. */
17909 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17910 lines' rows is implemented for bidi-reordered rows. */
17912 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
17913 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
17914 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
17915 && cursor_row_p (it
->w
, row
))
17916 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
17918 /* Highlight trailing whitespace. */
17919 if (!NILP (Vshow_trailing_whitespace
))
17920 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
17922 /* Prepare for the next line. This line starts horizontally at (X
17923 HPOS) = (0 0). Vertical positions are incremented. As a
17924 convenience for the caller, IT->glyph_row is set to the next
17926 it
->current_x
= it
->hpos
= 0;
17927 it
->current_y
+= row
->height
;
17928 SET_TEXT_POS (it
->eol_pos
, 0, 0);
17931 /* The next row should by default use the same value of the
17932 reversed_p flag as this one. set_iterator_to_next decides when
17933 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
17934 the flag accordingly. */
17935 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
17936 it
->glyph_row
->reversed_p
= row
->reversed_p
;
17937 it
->start
= row
->end
;
17938 return row
->displays_text_p
;
17940 #undef RECORD_MAX_MIN_POS
17943 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
17944 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
17945 doc
: /* Return paragraph direction at point in BUFFER.
17946 Value is either `left-to-right' or `right-to-left'.
17947 If BUFFER is omitted or nil, it defaults to the current buffer.
17949 Paragraph direction determines how the text in the paragraph is displayed.
17950 In left-to-right paragraphs, text begins at the left margin of the window
17951 and the reading direction is generally left to right. In right-to-left
17952 paragraphs, text begins at the right margin and is read from right to left.
17954 See also `bidi-paragraph-direction'. */)
17955 (Lisp_Object buffer
)
17957 struct buffer
*buf
;
17958 struct buffer
*old
;
17961 buf
= current_buffer
;
17964 CHECK_BUFFER (buffer
);
17965 buf
= XBUFFER (buffer
);
17966 old
= current_buffer
;
17969 if (NILP (buf
->bidi_display_reordering
))
17970 return Qleft_to_right
;
17971 else if (!NILP (buf
->bidi_paragraph_direction
))
17972 return buf
->bidi_paragraph_direction
;
17975 /* Determine the direction from buffer text. We could try to
17976 use current_matrix if it is up to date, but this seems fast
17977 enough as it is. */
17978 struct bidi_it itb
;
17979 EMACS_INT pos
= BUF_PT (buf
);
17980 EMACS_INT bytepos
= BUF_PT_BYTE (buf
);
17983 if (buf
!= current_buffer
)
17984 set_buffer_temp (buf
);
17985 /* bidi_paragraph_init finds the base direction of the paragraph
17986 by searching forward from paragraph start. We need the base
17987 direction of the current or _previous_ paragraph, so we need
17988 to make sure we are within that paragraph. To that end, find
17989 the previous non-empty line. */
17990 if (pos
>= ZV
&& pos
> BEGV
)
17993 bytepos
= CHAR_TO_BYTE (pos
);
17995 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
17996 || c
== ' ' || c
== '\t' || c
== '\f')
17998 if (bytepos
<= BEGV_BYTE
)
18003 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
18006 itb
.bytepos
= bytepos
;
18008 itb
.separator_limit
= -1;
18009 itb
.paragraph_dir
= NEUTRAL_DIR
;
18011 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
18012 if (buf
!= current_buffer
)
18013 set_buffer_temp (old
);
18014 switch (itb
.paragraph_dir
)
18017 return Qleft_to_right
;
18020 return Qright_to_left
;
18030 /***********************************************************************
18032 ***********************************************************************/
18034 /* Redisplay the menu bar in the frame for window W.
18036 The menu bar of X frames that don't have X toolkit support is
18037 displayed in a special window W->frame->menu_bar_window.
18039 The menu bar of terminal frames is treated specially as far as
18040 glyph matrices are concerned. Menu bar lines are not part of
18041 windows, so the update is done directly on the frame matrix rows
18042 for the menu bar. */
18045 display_menu_bar (struct window
*w
)
18047 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18052 /* Don't do all this for graphical frames. */
18054 if (FRAME_W32_P (f
))
18057 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
18063 if (FRAME_NS_P (f
))
18065 #endif /* HAVE_NS */
18067 #ifdef USE_X_TOOLKIT
18068 xassert (!FRAME_WINDOW_P (f
));
18069 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
18070 it
.first_visible_x
= 0;
18071 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18072 #else /* not USE_X_TOOLKIT */
18073 if (FRAME_WINDOW_P (f
))
18075 /* Menu bar lines are displayed in the desired matrix of the
18076 dummy window menu_bar_window. */
18077 struct window
*menu_w
;
18078 xassert (WINDOWP (f
->menu_bar_window
));
18079 menu_w
= XWINDOW (f
->menu_bar_window
);
18080 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
18082 it
.first_visible_x
= 0;
18083 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18087 /* This is a TTY frame, i.e. character hpos/vpos are used as
18089 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
18091 it
.first_visible_x
= 0;
18092 it
.last_visible_x
= FRAME_COLS (f
);
18094 #endif /* not USE_X_TOOLKIT */
18096 if (! mode_line_inverse_video
)
18097 /* Force the menu-bar to be displayed in the default face. */
18098 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18100 /* Clear all rows of the menu bar. */
18101 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
18103 struct glyph_row
*row
= it
.glyph_row
+ i
;
18104 clear_glyph_row (row
);
18105 row
->enabled_p
= 1;
18106 row
->full_width_p
= 1;
18109 /* Display all items of the menu bar. */
18110 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
18111 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
18113 Lisp_Object string
;
18115 /* Stop at nil string. */
18116 string
= AREF (items
, i
+ 1);
18120 /* Remember where item was displayed. */
18121 ASET (items
, i
+ 3, make_number (it
.hpos
));
18123 /* Display the item, pad with one space. */
18124 if (it
.current_x
< it
.last_visible_x
)
18125 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
18126 SCHARS (string
) + 1, 0, 0, -1);
18129 /* Fill out the line with spaces. */
18130 if (it
.current_x
< it
.last_visible_x
)
18131 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
18133 /* Compute the total height of the lines. */
18134 compute_line_metrics (&it
);
18139 /***********************************************************************
18141 ***********************************************************************/
18143 /* Redisplay mode lines in the window tree whose root is WINDOW. If
18144 FORCE is non-zero, redisplay mode lines unconditionally.
18145 Otherwise, redisplay only mode lines that are garbaged. Value is
18146 the number of windows whose mode lines were redisplayed. */
18149 redisplay_mode_lines (Lisp_Object window
, int force
)
18153 while (!NILP (window
))
18155 struct window
*w
= XWINDOW (window
);
18157 if (WINDOWP (w
->hchild
))
18158 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
18159 else if (WINDOWP (w
->vchild
))
18160 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
18162 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
18163 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
18165 struct text_pos lpoint
;
18166 struct buffer
*old
= current_buffer
;
18168 /* Set the window's buffer for the mode line display. */
18169 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
18170 set_buffer_internal_1 (XBUFFER (w
->buffer
));
18172 /* Point refers normally to the selected window. For any
18173 other window, set up appropriate value. */
18174 if (!EQ (window
, selected_window
))
18176 struct text_pos pt
;
18178 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
18179 if (CHARPOS (pt
) < BEGV
)
18180 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
18181 else if (CHARPOS (pt
) > (ZV
- 1))
18182 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
18184 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
18187 /* Display mode lines. */
18188 clear_glyph_matrix (w
->desired_matrix
);
18189 if (display_mode_lines (w
))
18192 w
->must_be_updated_p
= 1;
18195 /* Restore old settings. */
18196 set_buffer_internal_1 (old
);
18197 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
18207 /* Display the mode and/or header line of window W. Value is the
18208 sum number of mode lines and header lines displayed. */
18211 display_mode_lines (struct window
*w
)
18213 Lisp_Object old_selected_window
, old_selected_frame
;
18216 old_selected_frame
= selected_frame
;
18217 selected_frame
= w
->frame
;
18218 old_selected_window
= selected_window
;
18219 XSETWINDOW (selected_window
, w
);
18221 /* These will be set while the mode line specs are processed. */
18222 line_number_displayed
= 0;
18223 w
->column_number_displayed
= Qnil
;
18225 if (WINDOW_WANTS_MODELINE_P (w
))
18227 struct window
*sel_w
= XWINDOW (old_selected_window
);
18229 /* Select mode line face based on the real selected window. */
18230 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
18231 current_buffer
->mode_line_format
);
18235 if (WINDOW_WANTS_HEADER_LINE_P (w
))
18237 display_mode_line (w
, HEADER_LINE_FACE_ID
,
18238 current_buffer
->header_line_format
);
18242 selected_frame
= old_selected_frame
;
18243 selected_window
= old_selected_window
;
18248 /* Display mode or header line of window W. FACE_ID specifies which
18249 line to display; it is either MODE_LINE_FACE_ID or
18250 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
18251 display. Value is the pixel height of the mode/header line
18255 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
18259 int count
= SPECPDL_INDEX ();
18261 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
18262 /* Don't extend on a previously drawn mode-line.
18263 This may happen if called from pos_visible_p. */
18264 it
.glyph_row
->enabled_p
= 0;
18265 prepare_desired_row (it
.glyph_row
);
18267 it
.glyph_row
->mode_line_p
= 1;
18269 if (! mode_line_inverse_video
)
18270 /* Force the mode-line to be displayed in the default face. */
18271 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18273 record_unwind_protect (unwind_format_mode_line
,
18274 format_mode_line_unwind_data (NULL
, Qnil
, 0));
18276 mode_line_target
= MODE_LINE_DISPLAY
;
18278 /* Temporarily make frame's keyboard the current kboard so that
18279 kboard-local variables in the mode_line_format will get the right
18281 push_kboard (FRAME_KBOARD (it
.f
));
18282 record_unwind_save_match_data ();
18283 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
18286 unbind_to (count
, Qnil
);
18288 /* Fill up with spaces. */
18289 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
18291 compute_line_metrics (&it
);
18292 it
.glyph_row
->full_width_p
= 1;
18293 it
.glyph_row
->continued_p
= 0;
18294 it
.glyph_row
->truncated_on_left_p
= 0;
18295 it
.glyph_row
->truncated_on_right_p
= 0;
18297 /* Make a 3D mode-line have a shadow at its right end. */
18298 face
= FACE_FROM_ID (it
.f
, face_id
);
18299 extend_face_to_end_of_line (&it
);
18300 if (face
->box
!= FACE_NO_BOX
)
18302 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
18303 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
18304 last
->right_box_line_p
= 1;
18307 return it
.glyph_row
->height
;
18310 /* Move element ELT in LIST to the front of LIST.
18311 Return the updated list. */
18314 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
18316 register Lisp_Object tail
, prev
;
18317 register Lisp_Object tem
;
18321 while (CONSP (tail
))
18327 /* Splice out the link TAIL. */
18329 list
= XCDR (tail
);
18331 Fsetcdr (prev
, XCDR (tail
));
18333 /* Now make it the first. */
18334 Fsetcdr (tail
, list
);
18339 tail
= XCDR (tail
);
18343 /* Not found--return unchanged LIST. */
18347 /* Contribute ELT to the mode line for window IT->w. How it
18348 translates into text depends on its data type.
18350 IT describes the display environment in which we display, as usual.
18352 DEPTH is the depth in recursion. It is used to prevent
18353 infinite recursion here.
18355 FIELD_WIDTH is the number of characters the display of ELT should
18356 occupy in the mode line, and PRECISION is the maximum number of
18357 characters to display from ELT's representation. See
18358 display_string for details.
18360 Returns the hpos of the end of the text generated by ELT.
18362 PROPS is a property list to add to any string we encounter.
18364 If RISKY is nonzero, remove (disregard) any properties in any string
18365 we encounter, and ignore :eval and :propertize.
18367 The global variable `mode_line_target' determines whether the
18368 output is passed to `store_mode_line_noprop',
18369 `store_mode_line_string', or `display_string'. */
18372 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
18373 Lisp_Object elt
, Lisp_Object props
, int risky
)
18375 int n
= 0, field
, prec
;
18380 elt
= build_string ("*too-deep*");
18384 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
18388 /* A string: output it and check for %-constructs within it. */
18390 EMACS_INT offset
= 0;
18392 if (SCHARS (elt
) > 0
18393 && (!NILP (props
) || risky
))
18395 Lisp_Object oprops
, aelt
;
18396 oprops
= Ftext_properties_at (make_number (0), elt
);
18398 /* If the starting string's properties are not what
18399 we want, translate the string. Also, if the string
18400 is risky, do that anyway. */
18402 if (NILP (Fequal (props
, oprops
)) || risky
)
18404 /* If the starting string has properties,
18405 merge the specified ones onto the existing ones. */
18406 if (! NILP (oprops
) && !risky
)
18410 oprops
= Fcopy_sequence (oprops
);
18412 while (CONSP (tem
))
18414 oprops
= Fplist_put (oprops
, XCAR (tem
),
18415 XCAR (XCDR (tem
)));
18416 tem
= XCDR (XCDR (tem
));
18421 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
18422 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
18424 /* AELT is what we want. Move it to the front
18425 without consing. */
18427 mode_line_proptrans_alist
18428 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
18434 /* If AELT has the wrong props, it is useless.
18435 so get rid of it. */
18437 mode_line_proptrans_alist
18438 = Fdelq (aelt
, mode_line_proptrans_alist
);
18440 elt
= Fcopy_sequence (elt
);
18441 Fset_text_properties (make_number (0), Flength (elt
),
18443 /* Add this item to mode_line_proptrans_alist. */
18444 mode_line_proptrans_alist
18445 = Fcons (Fcons (elt
, props
),
18446 mode_line_proptrans_alist
);
18447 /* Truncate mode_line_proptrans_alist
18448 to at most 50 elements. */
18449 tem
= Fnthcdr (make_number (50),
18450 mode_line_proptrans_alist
);
18452 XSETCDR (tem
, Qnil
);
18461 prec
= precision
- n
;
18462 switch (mode_line_target
)
18464 case MODE_LINE_NOPROP
:
18465 case MODE_LINE_TITLE
:
18466 n
+= store_mode_line_noprop (SDATA (elt
), -1, prec
);
18468 case MODE_LINE_STRING
:
18469 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
18471 case MODE_LINE_DISPLAY
:
18472 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
18473 0, prec
, 0, STRING_MULTIBYTE (elt
));
18480 /* Handle the non-literal case. */
18482 while ((precision
<= 0 || n
< precision
)
18483 && SREF (elt
, offset
) != 0
18484 && (mode_line_target
!= MODE_LINE_DISPLAY
18485 || it
->current_x
< it
->last_visible_x
))
18487 EMACS_INT last_offset
= offset
;
18489 /* Advance to end of string or next format specifier. */
18490 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
18493 if (offset
- 1 != last_offset
)
18495 EMACS_INT nchars
, nbytes
;
18497 /* Output to end of string or up to '%'. Field width
18498 is length of string. Don't output more than
18499 PRECISION allows us. */
18502 prec
= c_string_width (SDATA (elt
) + last_offset
,
18503 offset
- last_offset
, precision
- n
,
18506 switch (mode_line_target
)
18508 case MODE_LINE_NOPROP
:
18509 case MODE_LINE_TITLE
:
18510 n
+= store_mode_line_noprop (SDATA (elt
) + last_offset
, 0, prec
);
18512 case MODE_LINE_STRING
:
18514 EMACS_INT bytepos
= last_offset
;
18515 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
18516 EMACS_INT endpos
= (precision
<= 0
18517 ? string_byte_to_char (elt
, offset
)
18518 : charpos
+ nchars
);
18520 n
+= store_mode_line_string (NULL
,
18521 Fsubstring (elt
, make_number (charpos
),
18522 make_number (endpos
)),
18526 case MODE_LINE_DISPLAY
:
18528 EMACS_INT bytepos
= last_offset
;
18529 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
18531 if (precision
<= 0)
18532 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
18533 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
18535 STRING_MULTIBYTE (elt
));
18540 else /* c == '%' */
18542 EMACS_INT percent_position
= offset
;
18544 /* Get the specified minimum width. Zero means
18547 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
18548 field
= field
* 10 + c
- '0';
18550 /* Don't pad beyond the total padding allowed. */
18551 if (field_width
- n
> 0 && field
> field_width
- n
)
18552 field
= field_width
- n
;
18554 /* Note that either PRECISION <= 0 or N < PRECISION. */
18555 prec
= precision
- n
;
18558 n
+= display_mode_element (it
, depth
, field
, prec
,
18559 Vglobal_mode_string
, props
,
18564 EMACS_INT bytepos
, charpos
;
18565 const unsigned char *spec
;
18566 Lisp_Object string
;
18568 bytepos
= percent_position
;
18569 charpos
= (STRING_MULTIBYTE (elt
)
18570 ? string_byte_to_char (elt
, bytepos
)
18572 spec
= decode_mode_spec (it
->w
, c
, field
, prec
, &string
);
18573 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
18575 switch (mode_line_target
)
18577 case MODE_LINE_NOPROP
:
18578 case MODE_LINE_TITLE
:
18579 n
+= store_mode_line_noprop (spec
, field
, prec
);
18581 case MODE_LINE_STRING
:
18583 int len
= strlen (spec
);
18584 Lisp_Object tem
= make_string (spec
, len
);
18585 props
= Ftext_properties_at (make_number (charpos
), elt
);
18586 /* Should only keep face property in props */
18587 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
18590 case MODE_LINE_DISPLAY
:
18592 int nglyphs_before
, nwritten
;
18594 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
18595 nwritten
= display_string (spec
, string
, elt
,
18600 /* Assign to the glyphs written above the
18601 string where the `%x' came from, position
18605 struct glyph
*glyph
18606 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
18610 for (i
= 0; i
< nwritten
; ++i
)
18612 glyph
[i
].object
= elt
;
18613 glyph
[i
].charpos
= charpos
;
18630 /* A symbol: process the value of the symbol recursively
18631 as if it appeared here directly. Avoid error if symbol void.
18632 Special case: if value of symbol is a string, output the string
18635 register Lisp_Object tem
;
18637 /* If the variable is not marked as risky to set
18638 then its contents are risky to use. */
18639 if (NILP (Fget (elt
, Qrisky_local_variable
)))
18642 tem
= Fboundp (elt
);
18645 tem
= Fsymbol_value (elt
);
18646 /* If value is a string, output that string literally:
18647 don't check for % within it. */
18651 if (!EQ (tem
, elt
))
18653 /* Give up right away for nil or t. */
18663 register Lisp_Object car
, tem
;
18665 /* A cons cell: five distinct cases.
18666 If first element is :eval or :propertize, do something special.
18667 If first element is a string or a cons, process all the elements
18668 and effectively concatenate them.
18669 If first element is a negative number, truncate displaying cdr to
18670 at most that many characters. If positive, pad (with spaces)
18671 to at least that many characters.
18672 If first element is a symbol, process the cadr or caddr recursively
18673 according to whether the symbol's value is non-nil or nil. */
18675 if (EQ (car
, QCeval
))
18677 /* An element of the form (:eval FORM) means evaluate FORM
18678 and use the result as mode line elements. */
18683 if (CONSP (XCDR (elt
)))
18686 spec
= safe_eval (XCAR (XCDR (elt
)));
18687 n
+= display_mode_element (it
, depth
, field_width
- n
,
18688 precision
- n
, spec
, props
,
18692 else if (EQ (car
, QCpropertize
))
18694 /* An element of the form (:propertize ELT PROPS...)
18695 means display ELT but applying properties PROPS. */
18700 if (CONSP (XCDR (elt
)))
18701 n
+= display_mode_element (it
, depth
, field_width
- n
,
18702 precision
- n
, XCAR (XCDR (elt
)),
18703 XCDR (XCDR (elt
)), risky
);
18705 else if (SYMBOLP (car
))
18707 tem
= Fboundp (car
);
18711 /* elt is now the cdr, and we know it is a cons cell.
18712 Use its car if CAR has a non-nil value. */
18715 tem
= Fsymbol_value (car
);
18722 /* Symbol's value is nil (or symbol is unbound)
18723 Get the cddr of the original list
18724 and if possible find the caddr and use that. */
18728 else if (!CONSP (elt
))
18733 else if (INTEGERP (car
))
18735 register int lim
= XINT (car
);
18739 /* Negative int means reduce maximum width. */
18740 if (precision
<= 0)
18743 precision
= min (precision
, -lim
);
18747 /* Padding specified. Don't let it be more than
18748 current maximum. */
18750 lim
= min (precision
, lim
);
18752 /* If that's more padding than already wanted, queue it.
18753 But don't reduce padding already specified even if
18754 that is beyond the current truncation point. */
18755 field_width
= max (lim
, field_width
);
18759 else if (STRINGP (car
) || CONSP (car
))
18761 Lisp_Object halftail
= elt
;
18765 && (precision
<= 0 || n
< precision
))
18767 n
+= display_mode_element (it
, depth
,
18768 /* Do padding only after the last
18769 element in the list. */
18770 (! CONSP (XCDR (elt
))
18773 precision
- n
, XCAR (elt
),
18777 if ((len
& 1) == 0)
18778 halftail
= XCDR (halftail
);
18779 /* Check for cycle. */
18780 if (EQ (halftail
, elt
))
18789 elt
= build_string ("*invalid*");
18793 /* Pad to FIELD_WIDTH. */
18794 if (field_width
> 0 && n
< field_width
)
18796 switch (mode_line_target
)
18798 case MODE_LINE_NOPROP
:
18799 case MODE_LINE_TITLE
:
18800 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
18802 case MODE_LINE_STRING
:
18803 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
18805 case MODE_LINE_DISPLAY
:
18806 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
18815 /* Store a mode-line string element in mode_line_string_list.
18817 If STRING is non-null, display that C string. Otherwise, the Lisp
18818 string LISP_STRING is displayed.
18820 FIELD_WIDTH is the minimum number of output glyphs to produce.
18821 If STRING has fewer characters than FIELD_WIDTH, pad to the right
18822 with spaces. FIELD_WIDTH <= 0 means don't pad.
18824 PRECISION is the maximum number of characters to output from
18825 STRING. PRECISION <= 0 means don't truncate the string.
18827 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
18828 properties to the string.
18830 PROPS are the properties to add to the string.
18831 The mode_line_string_face face property is always added to the string.
18835 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
18836 int field_width
, int precision
, Lisp_Object props
)
18841 if (string
!= NULL
)
18843 len
= strlen (string
);
18844 if (precision
> 0 && len
> precision
)
18846 lisp_string
= make_string (string
, len
);
18848 props
= mode_line_string_face_prop
;
18849 else if (!NILP (mode_line_string_face
))
18851 Lisp_Object face
= Fplist_get (props
, Qface
);
18852 props
= Fcopy_sequence (props
);
18854 face
= mode_line_string_face
;
18856 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
18857 props
= Fplist_put (props
, Qface
, face
);
18859 Fadd_text_properties (make_number (0), make_number (len
),
18860 props
, lisp_string
);
18864 len
= XFASTINT (Flength (lisp_string
));
18865 if (precision
> 0 && len
> precision
)
18868 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
18871 if (!NILP (mode_line_string_face
))
18875 props
= Ftext_properties_at (make_number (0), lisp_string
);
18876 face
= Fplist_get (props
, Qface
);
18878 face
= mode_line_string_face
;
18880 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
18881 props
= Fcons (Qface
, Fcons (face
, Qnil
));
18883 lisp_string
= Fcopy_sequence (lisp_string
);
18886 Fadd_text_properties (make_number (0), make_number (len
),
18887 props
, lisp_string
);
18892 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
18896 if (field_width
> len
)
18898 field_width
-= len
;
18899 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
18901 Fadd_text_properties (make_number (0), make_number (field_width
),
18902 props
, lisp_string
);
18903 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
18911 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
18913 doc
: /* Format a string out of a mode line format specification.
18914 First arg FORMAT specifies the mode line format (see `mode-line-format'
18915 for details) to use.
18917 Optional second arg FACE specifies the face property to put
18918 on all characters for which no face is specified.
18919 The value t means whatever face the window's mode line currently uses
18920 \(either `mode-line' or `mode-line-inactive', depending).
18921 A value of nil means the default is no face property.
18922 If FACE is an integer, the value string has no text properties.
18924 Optional third and fourth args WINDOW and BUFFER specify the window
18925 and buffer to use as the context for the formatting (defaults
18926 are the selected window and the window's buffer). */)
18927 (Lisp_Object format
, Lisp_Object face
, Lisp_Object window
, Lisp_Object buffer
)
18932 struct buffer
*old_buffer
= NULL
;
18934 int no_props
= INTEGERP (face
);
18935 int count
= SPECPDL_INDEX ();
18937 int string_start
= 0;
18940 window
= selected_window
;
18941 CHECK_WINDOW (window
);
18942 w
= XWINDOW (window
);
18945 buffer
= w
->buffer
;
18946 CHECK_BUFFER (buffer
);
18948 /* Make formatting the modeline a non-op when noninteractive, otherwise
18949 there will be problems later caused by a partially initialized frame. */
18950 if (NILP (format
) || noninteractive
)
18951 return empty_unibyte_string
;
18959 face
= (EQ (window
, selected_window
) ? Qmode_line
: Qmode_line_inactive
);
18960 face_id
= lookup_named_face (XFRAME (WINDOW_FRAME (w
)), face
, 0);
18964 face_id
= DEFAULT_FACE_ID
;
18966 if (XBUFFER (buffer
) != current_buffer
)
18967 old_buffer
= current_buffer
;
18969 /* Save things including mode_line_proptrans_alist,
18970 and set that to nil so that we don't alter the outer value. */
18971 record_unwind_protect (unwind_format_mode_line
,
18972 format_mode_line_unwind_data
18973 (old_buffer
, selected_window
, 1));
18974 mode_line_proptrans_alist
= Qnil
;
18976 Fselect_window (window
, Qt
);
18978 set_buffer_internal_1 (XBUFFER (buffer
));
18980 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
18984 mode_line_target
= MODE_LINE_NOPROP
;
18985 mode_line_string_face_prop
= Qnil
;
18986 mode_line_string_list
= Qnil
;
18987 string_start
= MODE_LINE_NOPROP_LEN (0);
18991 mode_line_target
= MODE_LINE_STRING
;
18992 mode_line_string_list
= Qnil
;
18993 mode_line_string_face
= face
;
18994 mode_line_string_face_prop
18995 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
18998 push_kboard (FRAME_KBOARD (it
.f
));
18999 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
19004 len
= MODE_LINE_NOPROP_LEN (string_start
);
19005 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
19009 mode_line_string_list
= Fnreverse (mode_line_string_list
);
19010 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
19011 empty_unibyte_string
);
19014 unbind_to (count
, Qnil
);
19018 /* Write a null-terminated, right justified decimal representation of
19019 the positive integer D to BUF using a minimal field width WIDTH. */
19022 pint2str (register char *buf
, register int width
, register int d
)
19024 register char *p
= buf
;
19032 *p
++ = d
% 10 + '0';
19037 for (width
-= (int) (p
- buf
); width
> 0; --width
)
19048 /* Write a null-terminated, right justified decimal and "human
19049 readable" representation of the nonnegative integer D to BUF using
19050 a minimal field width WIDTH. D should be smaller than 999.5e24. */
19052 static const char power_letter
[] =
19066 pint2hrstr (char *buf
, int width
, int d
)
19068 /* We aim to represent the nonnegative integer D as
19069 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
19072 /* -1 means: do not use TENTHS. */
19076 /* Length of QUOTIENT.TENTHS as a string. */
19082 if (1000 <= quotient
)
19084 /* Scale to the appropriate EXPONENT. */
19087 remainder
= quotient
% 1000;
19091 while (1000 <= quotient
);
19093 /* Round to nearest and decide whether to use TENTHS or not. */
19096 tenths
= remainder
/ 100;
19097 if (50 <= remainder
% 100)
19104 if (quotient
== 10)
19112 if (500 <= remainder
)
19114 if (quotient
< 999)
19125 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
19126 if (tenths
== -1 && quotient
<= 99)
19133 p
= psuffix
= buf
+ max (width
, length
);
19135 /* Print EXPONENT. */
19137 *psuffix
++ = power_letter
[exponent
];
19140 /* Print TENTHS. */
19143 *--p
= '0' + tenths
;
19147 /* Print QUOTIENT. */
19150 int digit
= quotient
% 10;
19151 *--p
= '0' + digit
;
19153 while ((quotient
/= 10) != 0);
19155 /* Print leading spaces. */
19160 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
19161 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
19162 type of CODING_SYSTEM. Return updated pointer into BUF. */
19164 static unsigned char invalid_eol_type
[] = "(*invalid*)";
19167 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
19170 int multibyte
= !NILP (current_buffer
->enable_multibyte_characters
);
19171 const unsigned char *eol_str
;
19173 /* The EOL conversion we are using. */
19174 Lisp_Object eoltype
;
19176 val
= CODING_SYSTEM_SPEC (coding_system
);
19179 if (!VECTORP (val
)) /* Not yet decided. */
19184 eoltype
= eol_mnemonic_undecided
;
19185 /* Don't mention EOL conversion if it isn't decided. */
19190 Lisp_Object eolvalue
;
19192 attrs
= AREF (val
, 0);
19193 eolvalue
= AREF (val
, 2);
19196 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
19200 /* The EOL conversion that is normal on this system. */
19202 if (NILP (eolvalue
)) /* Not yet decided. */
19203 eoltype
= eol_mnemonic_undecided
;
19204 else if (VECTORP (eolvalue
)) /* Not yet decided. */
19205 eoltype
= eol_mnemonic_undecided
;
19206 else /* eolvalue is Qunix, Qdos, or Qmac. */
19207 eoltype
= (EQ (eolvalue
, Qunix
)
19208 ? eol_mnemonic_unix
19209 : (EQ (eolvalue
, Qdos
) == 1
19210 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
19216 /* Mention the EOL conversion if it is not the usual one. */
19217 if (STRINGP (eoltype
))
19219 eol_str
= SDATA (eoltype
);
19220 eol_str_len
= SBYTES (eoltype
);
19222 else if (CHARACTERP (eoltype
))
19224 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
19225 eol_str_len
= CHAR_STRING (XINT (eoltype
), tmp
);
19230 eol_str
= invalid_eol_type
;
19231 eol_str_len
= sizeof (invalid_eol_type
) - 1;
19233 memcpy (buf
, eol_str
, eol_str_len
);
19234 buf
+= eol_str_len
;
19240 /* Return a string for the output of a mode line %-spec for window W,
19241 generated by character C. PRECISION >= 0 means don't return a
19242 string longer than that value. FIELD_WIDTH > 0 means pad the
19243 string returned with spaces to that value. Return a Lisp string in
19244 *STRING if the resulting string is taken from that Lisp string.
19246 Note we operate on the current buffer for most purposes,
19247 the exception being w->base_line_pos. */
19249 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
19251 static const char *
19252 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
19253 int precision
, Lisp_Object
*string
)
19256 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19257 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
19258 struct buffer
*b
= current_buffer
;
19266 if (!NILP (b
->read_only
))
19268 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19273 /* This differs from %* only for a modified read-only buffer. */
19274 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19276 if (!NILP (b
->read_only
))
19281 /* This differs from %* in ignoring read-only-ness. */
19282 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19294 if (command_loop_level
> 5)
19296 p
= decode_mode_spec_buf
;
19297 for (i
= 0; i
< command_loop_level
; i
++)
19300 return decode_mode_spec_buf
;
19308 if (command_loop_level
> 5)
19310 p
= decode_mode_spec_buf
;
19311 for (i
= 0; i
< command_loop_level
; i
++)
19314 return decode_mode_spec_buf
;
19321 /* Let lots_of_dashes be a string of infinite length. */
19322 if (mode_line_target
== MODE_LINE_NOPROP
||
19323 mode_line_target
== MODE_LINE_STRING
)
19325 if (field_width
<= 0
19326 || field_width
> sizeof (lots_of_dashes
))
19328 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
19329 decode_mode_spec_buf
[i
] = '-';
19330 decode_mode_spec_buf
[i
] = '\0';
19331 return decode_mode_spec_buf
;
19334 return lots_of_dashes
;
19342 /* %c and %l are ignored in `frame-title-format'.
19343 (In redisplay_internal, the frame title is drawn _before_ the
19344 windows are updated, so the stuff which depends on actual
19345 window contents (such as %l) may fail to render properly, or
19346 even crash emacs.) */
19347 if (mode_line_target
== MODE_LINE_TITLE
)
19351 int col
= (int) current_column (); /* iftc */
19352 w
->column_number_displayed
= make_number (col
);
19353 pint2str (decode_mode_spec_buf
, field_width
, col
);
19354 return decode_mode_spec_buf
;
19358 #ifndef SYSTEM_MALLOC
19360 if (NILP (Vmemory_full
))
19363 return "!MEM FULL! ";
19370 /* %F displays the frame name. */
19371 if (!NILP (f
->title
))
19372 return (char *) SDATA (f
->title
);
19373 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
19374 return (char *) SDATA (f
->name
);
19383 EMACS_INT size
= ZV
- BEGV
;
19384 pint2str (decode_mode_spec_buf
, field_width
, size
);
19385 return decode_mode_spec_buf
;
19390 EMACS_INT size
= ZV
- BEGV
;
19391 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
19392 return decode_mode_spec_buf
;
19397 EMACS_INT startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
19398 int topline
, nlines
, height
;
19401 /* %c and %l are ignored in `frame-title-format'. */
19402 if (mode_line_target
== MODE_LINE_TITLE
)
19405 startpos
= XMARKER (w
->start
)->charpos
;
19406 startpos_byte
= marker_byte_position (w
->start
);
19407 height
= WINDOW_TOTAL_LINES (w
);
19409 /* If we decided that this buffer isn't suitable for line numbers,
19410 don't forget that too fast. */
19411 if (EQ (w
->base_line_pos
, w
->buffer
))
19413 /* But do forget it, if the window shows a different buffer now. */
19414 else if (BUFFERP (w
->base_line_pos
))
19415 w
->base_line_pos
= Qnil
;
19417 /* If the buffer is very big, don't waste time. */
19418 if (INTEGERP (Vline_number_display_limit
)
19419 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
19421 w
->base_line_pos
= Qnil
;
19422 w
->base_line_number
= Qnil
;
19426 if (INTEGERP (w
->base_line_number
)
19427 && INTEGERP (w
->base_line_pos
)
19428 && XFASTINT (w
->base_line_pos
) <= startpos
)
19430 line
= XFASTINT (w
->base_line_number
);
19431 linepos
= XFASTINT (w
->base_line_pos
);
19432 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
19437 linepos
= BUF_BEGV (b
);
19438 linepos_byte
= BUF_BEGV_BYTE (b
);
19441 /* Count lines from base line to window start position. */
19442 nlines
= display_count_lines (linepos
, linepos_byte
,
19446 topline
= nlines
+ line
;
19448 /* Determine a new base line, if the old one is too close
19449 or too far away, or if we did not have one.
19450 "Too close" means it's plausible a scroll-down would
19451 go back past it. */
19452 if (startpos
== BUF_BEGV (b
))
19454 w
->base_line_number
= make_number (topline
);
19455 w
->base_line_pos
= make_number (BUF_BEGV (b
));
19457 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
19458 || linepos
== BUF_BEGV (b
))
19460 EMACS_INT limit
= BUF_BEGV (b
);
19461 EMACS_INT limit_byte
= BUF_BEGV_BYTE (b
);
19462 EMACS_INT position
;
19463 int distance
= (height
* 2 + 30) * line_number_display_limit_width
;
19465 if (startpos
- distance
> limit
)
19467 limit
= startpos
- distance
;
19468 limit_byte
= CHAR_TO_BYTE (limit
);
19471 nlines
= display_count_lines (startpos
, startpos_byte
,
19473 - (height
* 2 + 30),
19475 /* If we couldn't find the lines we wanted within
19476 line_number_display_limit_width chars per line,
19477 give up on line numbers for this window. */
19478 if (position
== limit_byte
&& limit
== startpos
- distance
)
19480 w
->base_line_pos
= w
->buffer
;
19481 w
->base_line_number
= Qnil
;
19485 w
->base_line_number
= make_number (topline
- nlines
);
19486 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
19489 /* Now count lines from the start pos to point. */
19490 nlines
= display_count_lines (startpos
, startpos_byte
,
19491 PT_BYTE
, PT
, &junk
);
19493 /* Record that we did display the line number. */
19494 line_number_displayed
= 1;
19496 /* Make the string to show. */
19497 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
19498 return decode_mode_spec_buf
;
19501 char* p
= decode_mode_spec_buf
;
19502 int pad
= field_width
- 2;
19508 return decode_mode_spec_buf
;
19514 obj
= b
->mode_name
;
19518 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
19524 EMACS_INT pos
= marker_position (w
->start
);
19525 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
19527 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
19529 if (pos
<= BUF_BEGV (b
))
19534 else if (pos
<= BUF_BEGV (b
))
19538 if (total
> 1000000)
19539 /* Do it differently for a large value, to avoid overflow. */
19540 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19542 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19543 /* We can't normally display a 3-digit number,
19544 so get us a 2-digit number that is close. */
19547 sprintf (decode_mode_spec_buf
, "%2ld%%", (long)total
);
19548 return decode_mode_spec_buf
;
19552 /* Display percentage of size above the bottom of the screen. */
19555 EMACS_INT toppos
= marker_position (w
->start
);
19556 EMACS_INT botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
19557 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
19559 if (botpos
>= BUF_ZV (b
))
19561 if (toppos
<= BUF_BEGV (b
))
19568 if (total
> 1000000)
19569 /* Do it differently for a large value, to avoid overflow. */
19570 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19572 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19573 /* We can't normally display a 3-digit number,
19574 so get us a 2-digit number that is close. */
19577 if (toppos
<= BUF_BEGV (b
))
19578 sprintf (decode_mode_spec_buf
, "Top%2ld%%", (long)total
);
19580 sprintf (decode_mode_spec_buf
, "%2ld%%", (long)total
);
19581 return decode_mode_spec_buf
;
19586 /* status of process */
19587 obj
= Fget_buffer_process (Fcurrent_buffer ());
19589 return "no process";
19591 obj
= Fsymbol_name (Fprocess_status (obj
));
19597 int count
= inhibit_garbage_collection ();
19598 Lisp_Object val
= call1 (intern ("file-remote-p"),
19599 current_buffer
->directory
);
19600 unbind_to (count
, Qnil
);
19608 case 't': /* indicate TEXT or BINARY */
19609 #ifdef MODE_LINE_BINARY_TEXT
19610 return MODE_LINE_BINARY_TEXT (b
);
19616 /* coding-system (not including end-of-line format) */
19618 /* coding-system (including end-of-line type) */
19620 int eol_flag
= (c
== 'Z');
19621 char *p
= decode_mode_spec_buf
;
19623 if (! FRAME_WINDOW_P (f
))
19625 /* No need to mention EOL here--the terminal never needs
19626 to do EOL conversion. */
19627 p
= decode_mode_spec_coding (CODING_ID_NAME
19628 (FRAME_KEYBOARD_CODING (f
)->id
),
19630 p
= decode_mode_spec_coding (CODING_ID_NAME
19631 (FRAME_TERMINAL_CODING (f
)->id
),
19634 p
= decode_mode_spec_coding (b
->buffer_file_coding_system
,
19637 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
19638 #ifdef subprocesses
19639 obj
= Fget_buffer_process (Fcurrent_buffer ());
19640 if (PROCESSP (obj
))
19642 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
19644 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
19647 #endif /* subprocesses */
19650 return decode_mode_spec_buf
;
19657 return (char *) SDATA (obj
);
19664 /* Count up to COUNT lines starting from START / START_BYTE.
19665 But don't go beyond LIMIT_BYTE.
19666 Return the number of lines thus found (always nonnegative).
19668 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
19671 display_count_lines (EMACS_INT start
, EMACS_INT start_byte
,
19672 EMACS_INT limit_byte
, int count
,
19673 EMACS_INT
*byte_pos_ptr
)
19675 register unsigned char *cursor
;
19676 unsigned char *base
;
19678 register int ceiling
;
19679 register unsigned char *ceiling_addr
;
19680 int orig_count
= count
;
19682 /* If we are not in selective display mode,
19683 check only for newlines. */
19684 int selective_display
= (!NILP (current_buffer
->selective_display
)
19685 && !INTEGERP (current_buffer
->selective_display
));
19689 while (start_byte
< limit_byte
)
19691 ceiling
= BUFFER_CEILING_OF (start_byte
);
19692 ceiling
= min (limit_byte
- 1, ceiling
);
19693 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
19694 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
19697 if (selective_display
)
19698 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
19701 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
19704 if (cursor
!= ceiling_addr
)
19708 start_byte
+= cursor
- base
+ 1;
19709 *byte_pos_ptr
= start_byte
;
19713 if (++cursor
== ceiling_addr
)
19719 start_byte
+= cursor
- base
;
19724 while (start_byte
> limit_byte
)
19726 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
19727 ceiling
= max (limit_byte
, ceiling
);
19728 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
19729 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
19732 if (selective_display
)
19733 while (--cursor
!= ceiling_addr
19734 && *cursor
!= '\n' && *cursor
!= 015)
19737 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
19740 if (cursor
!= ceiling_addr
)
19744 start_byte
+= cursor
- base
+ 1;
19745 *byte_pos_ptr
= start_byte
;
19746 /* When scanning backwards, we should
19747 not count the newline posterior to which we stop. */
19748 return - orig_count
- 1;
19754 /* Here we add 1 to compensate for the last decrement
19755 of CURSOR, which took it past the valid range. */
19756 start_byte
+= cursor
- base
+ 1;
19760 *byte_pos_ptr
= limit_byte
;
19763 return - orig_count
+ count
;
19764 return orig_count
- count
;
19770 /***********************************************************************
19772 ***********************************************************************/
19774 /* Display a NUL-terminated string, starting with index START.
19776 If STRING is non-null, display that C string. Otherwise, the Lisp
19777 string LISP_STRING is displayed. There's a case that STRING is
19778 non-null and LISP_STRING is not nil. It means STRING is a string
19779 data of LISP_STRING. In that case, we display LISP_STRING while
19780 ignoring its text properties.
19782 If FACE_STRING is not nil, FACE_STRING_POS is a position in
19783 FACE_STRING. Display STRING or LISP_STRING with the face at
19784 FACE_STRING_POS in FACE_STRING:
19786 Display the string in the environment given by IT, but use the
19787 standard display table, temporarily.
19789 FIELD_WIDTH is the minimum number of output glyphs to produce.
19790 If STRING has fewer characters than FIELD_WIDTH, pad to the right
19791 with spaces. If STRING has more characters, more than FIELD_WIDTH
19792 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
19794 PRECISION is the maximum number of characters to output from
19795 STRING. PRECISION < 0 means don't truncate the string.
19797 This is roughly equivalent to printf format specifiers:
19799 FIELD_WIDTH PRECISION PRINTF
19800 ----------------------------------------
19806 MULTIBYTE zero means do not display multibyte chars, > 0 means do
19807 display them, and < 0 means obey the current buffer's value of
19808 enable_multibyte_characters.
19810 Value is the number of columns displayed. */
19813 display_string (const unsigned char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
19814 EMACS_INT face_string_pos
, EMACS_INT start
, struct it
*it
,
19815 int field_width
, int precision
, int max_x
, int multibyte
)
19817 int hpos_at_start
= it
->hpos
;
19818 int saved_face_id
= it
->face_id
;
19819 struct glyph_row
*row
= it
->glyph_row
;
19821 /* Initialize the iterator IT for iteration over STRING beginning
19822 with index START. */
19823 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
19824 precision
, field_width
, multibyte
);
19825 if (string
&& STRINGP (lisp_string
))
19826 /* LISP_STRING is the one returned by decode_mode_spec. We should
19827 ignore its text properties. */
19828 it
->stop_charpos
= -1;
19830 /* If displaying STRING, set up the face of the iterator
19831 from LISP_STRING, if that's given. */
19832 if (STRINGP (face_string
))
19838 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
19839 0, it
->region_beg_charpos
,
19840 it
->region_end_charpos
,
19841 &endptr
, it
->base_face_id
, 0);
19842 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19843 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
19846 /* Set max_x to the maximum allowed X position. Don't let it go
19847 beyond the right edge of the window. */
19849 max_x
= it
->last_visible_x
;
19851 max_x
= min (max_x
, it
->last_visible_x
);
19853 /* Skip over display elements that are not visible. because IT->w is
19855 if (it
->current_x
< it
->first_visible_x
)
19856 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
19857 MOVE_TO_POS
| MOVE_TO_X
);
19859 row
->ascent
= it
->max_ascent
;
19860 row
->height
= it
->max_ascent
+ it
->max_descent
;
19861 row
->phys_ascent
= it
->max_phys_ascent
;
19862 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19863 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19865 /* This condition is for the case that we are called with current_x
19866 past last_visible_x. */
19867 while (it
->current_x
< max_x
)
19869 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
19871 /* Get the next display element. */
19872 if (!get_next_display_element (it
))
19875 /* Produce glyphs. */
19876 x_before
= it
->current_x
;
19877 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
19878 PRODUCE_GLYPHS (it
);
19880 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
19883 while (i
< nglyphs
)
19885 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
19887 if (it
->line_wrap
!= TRUNCATE
19888 && x
+ glyph
->pixel_width
> max_x
)
19890 /* End of continued line or max_x reached. */
19891 if (CHAR_GLYPH_PADDING_P (*glyph
))
19893 /* A wide character is unbreakable. */
19894 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
19895 it
->current_x
= x_before
;
19899 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
19904 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
19906 /* Glyph is at least partially visible. */
19908 if (x
< it
->first_visible_x
)
19909 it
->glyph_row
->x
= x
- it
->first_visible_x
;
19913 /* Glyph is off the left margin of the display area.
19914 Should not happen. */
19918 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19919 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19920 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19921 row
->phys_height
= max (row
->phys_height
,
19922 it
->max_phys_ascent
+ it
->max_phys_descent
);
19923 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19924 it
->max_extra_line_spacing
);
19925 x
+= glyph
->pixel_width
;
19929 /* Stop if max_x reached. */
19933 /* Stop at line ends. */
19934 if (ITERATOR_AT_END_OF_LINE_P (it
))
19936 it
->continuation_lines_width
= 0;
19940 set_iterator_to_next (it
, 1);
19942 /* Stop if truncating at the right edge. */
19943 if (it
->line_wrap
== TRUNCATE
19944 && it
->current_x
>= it
->last_visible_x
)
19946 /* Add truncation mark, but don't do it if the line is
19947 truncated at a padding space. */
19948 if (IT_CHARPOS (*it
) < it
->string_nchars
)
19950 if (!FRAME_WINDOW_P (it
->f
))
19954 if (it
->current_x
> it
->last_visible_x
)
19956 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
19957 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19959 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
19961 row
->used
[TEXT_AREA
] = i
;
19962 produce_special_glyphs (it
, IT_TRUNCATION
);
19965 produce_special_glyphs (it
, IT_TRUNCATION
);
19967 it
->glyph_row
->truncated_on_right_p
= 1;
19973 /* Maybe insert a truncation at the left. */
19974 if (it
->first_visible_x
19975 && IT_CHARPOS (*it
) > 0)
19977 if (!FRAME_WINDOW_P (it
->f
))
19978 insert_left_trunc_glyphs (it
);
19979 it
->glyph_row
->truncated_on_left_p
= 1;
19982 it
->face_id
= saved_face_id
;
19984 /* Value is number of columns displayed. */
19985 return it
->hpos
- hpos_at_start
;
19990 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
19991 appears as an element of LIST or as the car of an element of LIST.
19992 If PROPVAL is a list, compare each element against LIST in that
19993 way, and return 1/2 if any element of PROPVAL is found in LIST.
19994 Otherwise return 0. This function cannot quit.
19995 The return value is 2 if the text is invisible but with an ellipsis
19996 and 1 if it's invisible and without an ellipsis. */
19999 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
20001 register Lisp_Object tail
, proptail
;
20003 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
20005 register Lisp_Object tem
;
20007 if (EQ (propval
, tem
))
20009 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
20010 return NILP (XCDR (tem
)) ? 1 : 2;
20013 if (CONSP (propval
))
20015 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
20017 Lisp_Object propelt
;
20018 propelt
= XCAR (proptail
);
20019 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
20021 register Lisp_Object tem
;
20023 if (EQ (propelt
, tem
))
20025 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
20026 return NILP (XCDR (tem
)) ? 1 : 2;
20034 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
20035 doc
: /* Non-nil if the property makes the text invisible.
20036 POS-OR-PROP can be a marker or number, in which case it is taken to be
20037 a position in the current buffer and the value of the `invisible' property
20038 is checked; or it can be some other value, which is then presumed to be the
20039 value of the `invisible' property of the text of interest.
20040 The non-nil value returned can be t for truly invisible text or something
20041 else if the text is replaced by an ellipsis. */)
20042 (Lisp_Object pos_or_prop
)
20045 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
20046 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
20048 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
20049 return (invis
== 0 ? Qnil
20051 : make_number (invis
));
20054 /* Calculate a width or height in pixels from a specification using
20055 the following elements:
20058 NUM - a (fractional) multiple of the default font width/height
20059 (NUM) - specifies exactly NUM pixels
20060 UNIT - a fixed number of pixels, see below.
20061 ELEMENT - size of a display element in pixels, see below.
20062 (NUM . SPEC) - equals NUM * SPEC
20063 (+ SPEC SPEC ...) - add pixel values
20064 (- SPEC SPEC ...) - subtract pixel values
20065 (- SPEC) - negate pixel value
20068 INT or FLOAT - a number constant
20069 SYMBOL - use symbol's (buffer local) variable binding.
20072 in - pixels per inch *)
20073 mm - pixels per 1/1000 meter *)
20074 cm - pixels per 1/100 meter *)
20075 width - width of current font in pixels.
20076 height - height of current font in pixels.
20078 *) using the ratio(s) defined in display-pixels-per-inch.
20082 left-fringe - left fringe width in pixels
20083 right-fringe - right fringe width in pixels
20085 left-margin - left margin width in pixels
20086 right-margin - right margin width in pixels
20088 scroll-bar - scroll-bar area width in pixels
20092 Pixels corresponding to 5 inches:
20095 Total width of non-text areas on left side of window (if scroll-bar is on left):
20096 '(space :width (+ left-fringe left-margin scroll-bar))
20098 Align to first text column (in header line):
20099 '(space :align-to 0)
20101 Align to middle of text area minus half the width of variable `my-image'
20102 containing a loaded image:
20103 '(space :align-to (0.5 . (- text my-image)))
20105 Width of left margin minus width of 1 character in the default font:
20106 '(space :width (- left-margin 1))
20108 Width of left margin minus width of 2 characters in the current font:
20109 '(space :width (- left-margin (2 . width)))
20111 Center 1 character over left-margin (in header line):
20112 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
20114 Different ways to express width of left fringe plus left margin minus one pixel:
20115 '(space :width (- (+ left-fringe left-margin) (1)))
20116 '(space :width (+ left-fringe left-margin (- (1))))
20117 '(space :width (+ left-fringe left-margin (-1)))
20121 #define NUMVAL(X) \
20122 ((INTEGERP (X) || FLOATP (X)) \
20127 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
20128 struct font
*font
, int width_p
, int *align_to
)
20132 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
20133 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
20136 return OK_PIXELS (0);
20138 xassert (FRAME_LIVE_P (it
->f
));
20140 if (SYMBOLP (prop
))
20142 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
20144 char *unit
= SDATA (SYMBOL_NAME (prop
));
20146 if (unit
[0] == 'i' && unit
[1] == 'n')
20148 else if (unit
[0] == 'm' && unit
[1] == 'm')
20150 else if (unit
[0] == 'c' && unit
[1] == 'm')
20157 #ifdef HAVE_WINDOW_SYSTEM
20158 if (FRAME_WINDOW_P (it
->f
)
20160 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
20161 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
20163 return OK_PIXELS (ppi
/ pixels
);
20166 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
20167 || (CONSP (Vdisplay_pixels_per_inch
)
20169 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
20170 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
20172 return OK_PIXELS (ppi
/ pixels
);
20178 #ifdef HAVE_WINDOW_SYSTEM
20179 if (EQ (prop
, Qheight
))
20180 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
20181 if (EQ (prop
, Qwidth
))
20182 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
20184 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
20185 return OK_PIXELS (1);
20188 if (EQ (prop
, Qtext
))
20189 return OK_PIXELS (width_p
20190 ? window_box_width (it
->w
, TEXT_AREA
)
20191 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
20193 if (align_to
&& *align_to
< 0)
20196 if (EQ (prop
, Qleft
))
20197 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
20198 if (EQ (prop
, Qright
))
20199 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
20200 if (EQ (prop
, Qcenter
))
20201 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
20202 + window_box_width (it
->w
, TEXT_AREA
) / 2);
20203 if (EQ (prop
, Qleft_fringe
))
20204 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20205 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
20206 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
20207 if (EQ (prop
, Qright_fringe
))
20208 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20209 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20210 : window_box_right_offset (it
->w
, TEXT_AREA
));
20211 if (EQ (prop
, Qleft_margin
))
20212 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
20213 if (EQ (prop
, Qright_margin
))
20214 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
20215 if (EQ (prop
, Qscroll_bar
))
20216 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
20218 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20219 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20220 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20225 if (EQ (prop
, Qleft_fringe
))
20226 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
20227 if (EQ (prop
, Qright_fringe
))
20228 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
20229 if (EQ (prop
, Qleft_margin
))
20230 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
20231 if (EQ (prop
, Qright_margin
))
20232 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
20233 if (EQ (prop
, Qscroll_bar
))
20234 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
20237 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
20240 if (INTEGERP (prop
) || FLOATP (prop
))
20242 int base_unit
= (width_p
20243 ? FRAME_COLUMN_WIDTH (it
->f
)
20244 : FRAME_LINE_HEIGHT (it
->f
));
20245 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
20250 Lisp_Object car
= XCAR (prop
);
20251 Lisp_Object cdr
= XCDR (prop
);
20255 #ifdef HAVE_WINDOW_SYSTEM
20256 if (FRAME_WINDOW_P (it
->f
)
20257 && valid_image_p (prop
))
20259 int id
= lookup_image (it
->f
, prop
);
20260 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
20262 return OK_PIXELS (width_p
? img
->width
: img
->height
);
20265 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
20271 while (CONSP (cdr
))
20273 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
20274 font
, width_p
, align_to
))
20277 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
20282 if (EQ (car
, Qminus
))
20284 return OK_PIXELS (pixels
);
20287 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
20290 if (INTEGERP (car
) || FLOATP (car
))
20293 pixels
= XFLOATINT (car
);
20295 return OK_PIXELS (pixels
);
20296 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
20297 font
, width_p
, align_to
))
20298 return OK_PIXELS (pixels
* fact
);
20309 /***********************************************************************
20311 ***********************************************************************/
20313 #ifdef HAVE_WINDOW_SYSTEM
20318 dump_glyph_string (s
)
20319 struct glyph_string
*s
;
20321 fprintf (stderr
, "glyph string\n");
20322 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
20323 s
->x
, s
->y
, s
->width
, s
->height
);
20324 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
20325 fprintf (stderr
, " hl = %d\n", s
->hl
);
20326 fprintf (stderr
, " left overhang = %d, right = %d\n",
20327 s
->left_overhang
, s
->right_overhang
);
20328 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
20329 fprintf (stderr
, " extends to end of line = %d\n",
20330 s
->extends_to_end_of_line_p
);
20331 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
20332 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
20335 #endif /* GLYPH_DEBUG */
20337 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
20338 of XChar2b structures for S; it can't be allocated in
20339 init_glyph_string because it must be allocated via `alloca'. W
20340 is the window on which S is drawn. ROW and AREA are the glyph row
20341 and area within the row from which S is constructed. START is the
20342 index of the first glyph structure covered by S. HL is a
20343 face-override for drawing S. */
20346 #define OPTIONAL_HDC(hdc) HDC hdc,
20347 #define DECLARE_HDC(hdc) HDC hdc;
20348 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
20349 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
20352 #ifndef OPTIONAL_HDC
20353 #define OPTIONAL_HDC(hdc)
20354 #define DECLARE_HDC(hdc)
20355 #define ALLOCATE_HDC(hdc, f)
20356 #define RELEASE_HDC(hdc, f)
20360 init_glyph_string (struct glyph_string
*s
,
20362 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
20363 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
20365 memset (s
, 0, sizeof *s
);
20367 s
->f
= XFRAME (w
->frame
);
20371 s
->display
= FRAME_X_DISPLAY (s
->f
);
20372 s
->window
= FRAME_X_WINDOW (s
->f
);
20373 s
->char2b
= char2b
;
20377 s
->first_glyph
= row
->glyphs
[area
] + start
;
20378 s
->height
= row
->height
;
20379 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
20380 s
->ybase
= s
->y
+ row
->ascent
;
20384 /* Append the list of glyph strings with head H and tail T to the list
20385 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
20388 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
20389 struct glyph_string
*h
, struct glyph_string
*t
)
20403 /* Prepend the list of glyph strings with head H and tail T to the
20404 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
20408 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
20409 struct glyph_string
*h
, struct glyph_string
*t
)
20423 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
20424 Set *HEAD and *TAIL to the resulting list. */
20427 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
20428 struct glyph_string
*s
)
20430 s
->next
= s
->prev
= NULL
;
20431 append_glyph_string_lists (head
, tail
, s
, s
);
20435 /* Get face and two-byte form of character C in face FACE_ID on frame
20436 F. The encoding of C is returned in *CHAR2B. MULTIBYTE_P non-zero
20437 means we want to display multibyte text. DISPLAY_P non-zero means
20438 make sure that X resources for the face returned are allocated.
20439 Value is a pointer to a realized face that is ready for display if
20440 DISPLAY_P is non-zero. */
20442 static INLINE
struct face
*
20443 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
20444 XChar2b
*char2b
, int multibyte_p
, int display_p
)
20446 struct face
*face
= FACE_FROM_ID (f
, face_id
);
20450 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
20452 if (code
!= FONT_INVALID_CODE
)
20453 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20455 STORE_XCHAR2B (char2b
, 0, 0);
20458 /* Make sure X resources of the face are allocated. */
20459 #ifdef HAVE_X_WINDOWS
20463 xassert (face
!= NULL
);
20464 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20471 /* Get face and two-byte form of character glyph GLYPH on frame F.
20472 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
20473 a pointer to a realized face that is ready for display. */
20475 static INLINE
struct face
*
20476 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
20477 XChar2b
*char2b
, int *two_byte_p
)
20481 xassert (glyph
->type
== CHAR_GLYPH
);
20482 face
= FACE_FROM_ID (f
, glyph
->face_id
);
20491 if (CHAR_BYTE8_P (glyph
->u
.ch
))
20492 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
20494 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
20496 if (code
!= FONT_INVALID_CODE
)
20497 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20499 STORE_XCHAR2B (char2b
, 0, 0);
20502 /* Make sure X resources of the face are allocated. */
20503 xassert (face
!= NULL
);
20504 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20509 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
20510 Retunr 1 if FONT has a glyph for C, otherwise return 0. */
20513 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
20517 if (CHAR_BYTE8_P (c
))
20518 code
= CHAR_TO_BYTE8 (c
);
20520 code
= font
->driver
->encode_char (font
, c
);
20522 if (code
== FONT_INVALID_CODE
)
20524 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20529 /* Fill glyph string S with composition components specified by S->cmp.
20531 BASE_FACE is the base face of the composition.
20532 S->cmp_from is the index of the first component for S.
20534 OVERLAPS non-zero means S should draw the foreground only, and use
20535 its physical height for clipping. See also draw_glyphs.
20537 Value is the index of a component not in S. */
20540 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
20544 /* For all glyphs of this composition, starting at the offset
20545 S->cmp_from, until we reach the end of the definition or encounter a
20546 glyph that requires the different face, add it to S. */
20551 s
->for_overlaps
= overlaps
;
20554 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
20556 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
20560 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
20563 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
20564 s
->char2b
+ i
, 1, 1);
20570 s
->font
= s
->face
->font
;
20572 else if (s
->face
!= face
)
20580 /* All glyph strings for the same composition has the same width,
20581 i.e. the width set for the first component of the composition. */
20582 s
->width
= s
->first_glyph
->pixel_width
;
20584 /* If the specified font could not be loaded, use the frame's
20585 default font, but record the fact that we couldn't load it in
20586 the glyph string so that we can draw rectangles for the
20587 characters of the glyph string. */
20588 if (s
->font
== NULL
)
20590 s
->font_not_found_p
= 1;
20591 s
->font
= FRAME_FONT (s
->f
);
20594 /* Adjust base line for subscript/superscript text. */
20595 s
->ybase
+= s
->first_glyph
->voffset
;
20597 /* This glyph string must always be drawn with 16-bit functions. */
20604 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
20605 int start
, int end
, int overlaps
)
20607 struct glyph
*glyph
, *last
;
20608 Lisp_Object lgstring
;
20611 s
->for_overlaps
= overlaps
;
20612 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20613 last
= s
->row
->glyphs
[s
->area
] + end
;
20614 s
->cmp_id
= glyph
->u
.cmp
.id
;
20615 s
->cmp_from
= glyph
->slice
.cmp
.from
;
20616 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
20617 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20618 lgstring
= composition_gstring_from_id (s
->cmp_id
);
20619 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
20621 while (glyph
< last
20622 && glyph
->u
.cmp
.automatic
20623 && glyph
->u
.cmp
.id
== s
->cmp_id
20624 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
20625 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
20627 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
20629 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
20630 unsigned code
= LGLYPH_CODE (lglyph
);
20632 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
20634 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
20635 return glyph
- s
->row
->glyphs
[s
->area
];
20639 /* Fill glyph string S from a sequence of character glyphs.
20641 FACE_ID is the face id of the string. START is the index of the
20642 first glyph to consider, END is the index of the last + 1.
20643 OVERLAPS non-zero means S should draw the foreground only, and use
20644 its physical height for clipping. See also draw_glyphs.
20646 Value is the index of the first glyph not in S. */
20649 fill_glyph_string (struct glyph_string
*s
, int face_id
,
20650 int start
, int end
, int overlaps
)
20652 struct glyph
*glyph
, *last
;
20654 int glyph_not_available_p
;
20656 xassert (s
->f
== XFRAME (s
->w
->frame
));
20657 xassert (s
->nchars
== 0);
20658 xassert (start
>= 0 && end
> start
);
20660 s
->for_overlaps
= overlaps
;
20661 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20662 last
= s
->row
->glyphs
[s
->area
] + end
;
20663 voffset
= glyph
->voffset
;
20664 s
->padding_p
= glyph
->padding_p
;
20665 glyph_not_available_p
= glyph
->glyph_not_available_p
;
20667 while (glyph
< last
20668 && glyph
->type
== CHAR_GLYPH
20669 && glyph
->voffset
== voffset
20670 /* Same face id implies same font, nowadays. */
20671 && glyph
->face_id
== face_id
20672 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
20676 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
20677 s
->char2b
+ s
->nchars
,
20679 s
->two_byte_p
= two_byte_p
;
20681 xassert (s
->nchars
<= end
- start
);
20682 s
->width
+= glyph
->pixel_width
;
20683 if (glyph
++->padding_p
!= s
->padding_p
)
20687 s
->font
= s
->face
->font
;
20689 /* If the specified font could not be loaded, use the frame's font,
20690 but record the fact that we couldn't load it in
20691 S->font_not_found_p so that we can draw rectangles for the
20692 characters of the glyph string. */
20693 if (s
->font
== NULL
|| glyph_not_available_p
)
20695 s
->font_not_found_p
= 1;
20696 s
->font
= FRAME_FONT (s
->f
);
20699 /* Adjust base line for subscript/superscript text. */
20700 s
->ybase
+= voffset
;
20702 xassert (s
->face
&& s
->face
->gc
);
20703 return glyph
- s
->row
->glyphs
[s
->area
];
20707 /* Fill glyph string S from image glyph S->first_glyph. */
20710 fill_image_glyph_string (struct glyph_string
*s
)
20712 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
20713 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
20715 s
->slice
= s
->first_glyph
->slice
.img
;
20716 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
20717 s
->font
= s
->face
->font
;
20718 s
->width
= s
->first_glyph
->pixel_width
;
20720 /* Adjust base line for subscript/superscript text. */
20721 s
->ybase
+= s
->first_glyph
->voffset
;
20725 /* Fill glyph string S from a sequence of stretch glyphs.
20727 ROW is the glyph row in which the glyphs are found, AREA is the
20728 area within the row. START is the index of the first glyph to
20729 consider, END is the index of the last + 1.
20731 Value is the index of the first glyph not in S. */
20734 fill_stretch_glyph_string (struct glyph_string
*s
, struct glyph_row
*row
,
20735 enum glyph_row_area area
, int start
, int end
)
20737 struct glyph
*glyph
, *last
;
20738 int voffset
, face_id
;
20740 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
20742 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20743 last
= s
->row
->glyphs
[s
->area
] + end
;
20744 face_id
= glyph
->face_id
;
20745 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20746 s
->font
= s
->face
->font
;
20747 s
->width
= glyph
->pixel_width
;
20749 voffset
= glyph
->voffset
;
20753 && glyph
->type
== STRETCH_GLYPH
20754 && glyph
->voffset
== voffset
20755 && glyph
->face_id
== face_id
);
20757 s
->width
+= glyph
->pixel_width
;
20759 /* Adjust base line for subscript/superscript text. */
20760 s
->ybase
+= voffset
;
20762 /* The case that face->gc == 0 is handled when drawing the glyph
20763 string by calling PREPARE_FACE_FOR_DISPLAY. */
20765 return glyph
- s
->row
->glyphs
[s
->area
];
20768 static struct font_metrics
*
20769 get_per_char_metric (struct frame
*f
, struct font
*font
, XChar2b
*char2b
)
20771 static struct font_metrics metrics
;
20772 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
20774 if (! font
|| code
== FONT_INVALID_CODE
)
20776 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
20781 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
20782 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
20783 assumed to be zero. */
20786 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
20788 *left
= *right
= 0;
20790 if (glyph
->type
== CHAR_GLYPH
)
20794 struct font_metrics
*pcm
;
20796 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
20797 if (face
->font
&& (pcm
= get_per_char_metric (f
, face
->font
, &char2b
)))
20799 if (pcm
->rbearing
> pcm
->width
)
20800 *right
= pcm
->rbearing
- pcm
->width
;
20801 if (pcm
->lbearing
< 0)
20802 *left
= -pcm
->lbearing
;
20805 else if (glyph
->type
== COMPOSITE_GLYPH
)
20807 if (! glyph
->u
.cmp
.automatic
)
20809 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
20811 if (cmp
->rbearing
> cmp
->pixel_width
)
20812 *right
= cmp
->rbearing
- cmp
->pixel_width
;
20813 if (cmp
->lbearing
< 0)
20814 *left
= - cmp
->lbearing
;
20818 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
20819 struct font_metrics metrics
;
20821 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
20822 glyph
->slice
.cmp
.to
+ 1, &metrics
);
20823 if (metrics
.rbearing
> metrics
.width
)
20824 *right
= metrics
.rbearing
- metrics
.width
;
20825 if (metrics
.lbearing
< 0)
20826 *left
= - metrics
.lbearing
;
20832 /* Return the index of the first glyph preceding glyph string S that
20833 is overwritten by S because of S's left overhang. Value is -1
20834 if no glyphs are overwritten. */
20837 left_overwritten (struct glyph_string
*s
)
20841 if (s
->left_overhang
)
20844 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20845 int first
= s
->first_glyph
- glyphs
;
20847 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
20848 x
-= glyphs
[i
].pixel_width
;
20859 /* Return the index of the first glyph preceding glyph string S that
20860 is overwriting S because of its right overhang. Value is -1 if no
20861 glyph in front of S overwrites S. */
20864 left_overwriting (struct glyph_string
*s
)
20867 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20868 int first
= s
->first_glyph
- glyphs
;
20872 for (i
= first
- 1; i
>= 0; --i
)
20875 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
20878 x
-= glyphs
[i
].pixel_width
;
20885 /* Return the index of the last glyph following glyph string S that is
20886 overwritten by S because of S's right overhang. Value is -1 if
20887 no such glyph is found. */
20890 right_overwritten (struct glyph_string
*s
)
20894 if (s
->right_overhang
)
20897 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20898 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
20899 int end
= s
->row
->used
[s
->area
];
20901 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
20902 x
+= glyphs
[i
].pixel_width
;
20911 /* Return the index of the last glyph following glyph string S that
20912 overwrites S because of its left overhang. Value is negative
20913 if no such glyph is found. */
20916 right_overwriting (struct glyph_string
*s
)
20919 int end
= s
->row
->used
[s
->area
];
20920 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20921 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
20925 for (i
= first
; i
< end
; ++i
)
20928 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
20931 x
+= glyphs
[i
].pixel_width
;
20938 /* Set background width of glyph string S. START is the index of the
20939 first glyph following S. LAST_X is the right-most x-position + 1
20940 in the drawing area. */
20943 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
20945 /* If the face of this glyph string has to be drawn to the end of
20946 the drawing area, set S->extends_to_end_of_line_p. */
20948 if (start
== s
->row
->used
[s
->area
]
20949 && s
->area
== TEXT_AREA
20950 && ((s
->row
->fill_line_p
20951 && (s
->hl
== DRAW_NORMAL_TEXT
20952 || s
->hl
== DRAW_IMAGE_RAISED
20953 || s
->hl
== DRAW_IMAGE_SUNKEN
))
20954 || s
->hl
== DRAW_MOUSE_FACE
))
20955 s
->extends_to_end_of_line_p
= 1;
20957 /* If S extends its face to the end of the line, set its
20958 background_width to the distance to the right edge of the drawing
20960 if (s
->extends_to_end_of_line_p
)
20961 s
->background_width
= last_x
- s
->x
+ 1;
20963 s
->background_width
= s
->width
;
20967 /* Compute overhangs and x-positions for glyph string S and its
20968 predecessors, or successors. X is the starting x-position for S.
20969 BACKWARD_P non-zero means process predecessors. */
20972 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
20978 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
20979 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
20989 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
20990 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
21000 /* The following macros are only called from draw_glyphs below.
21001 They reference the following parameters of that function directly:
21002 `w', `row', `area', and `overlap_p'
21003 as well as the following local variables:
21004 `s', `f', and `hdc' (in W32) */
21007 /* On W32, silently add local `hdc' variable to argument list of
21008 init_glyph_string. */
21009 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
21010 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
21012 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
21013 init_glyph_string (s, char2b, w, row, area, start, hl)
21016 /* Add a glyph string for a stretch glyph to the list of strings
21017 between HEAD and TAIL. START is the index of the stretch glyph in
21018 row area AREA of glyph row ROW. END is the index of the last glyph
21019 in that glyph row area. X is the current output position assigned
21020 to the new glyph string constructed. HL overrides that face of the
21021 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21022 is the right-most x-position of the drawing area. */
21024 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
21025 and below -- keep them on one line. */
21026 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21029 s = (struct glyph_string *) alloca (sizeof *s); \
21030 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21031 START = fill_stretch_glyph_string (s, row, area, START, END); \
21032 append_glyph_string (&HEAD, &TAIL, s); \
21038 /* Add a glyph string for an image glyph to the list of strings
21039 between HEAD and TAIL. START is the index of the image glyph in
21040 row area AREA of glyph row ROW. END is the index of the last glyph
21041 in that glyph row area. X is the current output position assigned
21042 to the new glyph string constructed. HL overrides that face of the
21043 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21044 is the right-most x-position of the drawing area. */
21046 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21049 s = (struct glyph_string *) alloca (sizeof *s); \
21050 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21051 fill_image_glyph_string (s); \
21052 append_glyph_string (&HEAD, &TAIL, s); \
21059 /* Add a glyph string for a sequence of character glyphs to the list
21060 of strings between HEAD and TAIL. START is the index of the first
21061 glyph in row area AREA of glyph row ROW that is part of the new
21062 glyph string. END is the index of the last glyph in that glyph row
21063 area. X is the current output position assigned to the new glyph
21064 string constructed. HL overrides that face of the glyph; e.g. it
21065 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
21066 right-most x-position of the drawing area. */
21068 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21074 face_id = (row)->glyphs[area][START].face_id; \
21076 s = (struct glyph_string *) alloca (sizeof *s); \
21077 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
21078 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21079 append_glyph_string (&HEAD, &TAIL, s); \
21081 START = fill_glyph_string (s, face_id, START, END, overlaps); \
21086 /* Add a glyph string for a composite sequence to the list of strings
21087 between HEAD and TAIL. START is the index of the first glyph in
21088 row area AREA of glyph row ROW that is part of the new glyph
21089 string. END is the index of the last glyph in that glyph row area.
21090 X is the current output position assigned to the new glyph string
21091 constructed. HL overrides that face of the glyph; e.g. it is
21092 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
21093 x-position of the drawing area. */
21095 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21097 int face_id = (row)->glyphs[area][START].face_id; \
21098 struct face *base_face = FACE_FROM_ID (f, face_id); \
21099 int cmp_id = (row)->glyphs[area][START].u.cmp.id; \
21100 struct composition *cmp = composition_table[cmp_id]; \
21102 struct glyph_string *first_s; \
21105 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
21107 /* Make glyph_strings for each glyph sequence that is drawable by \
21108 the same face, and append them to HEAD/TAIL. */ \
21109 for (n = 0; n < cmp->glyph_len;) \
21111 s = (struct glyph_string *) alloca (sizeof *s); \
21112 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21113 append_glyph_string (&(HEAD), &(TAIL), s); \
21119 n = fill_composite_glyph_string (s, base_face, overlaps); \
21127 /* Add a glyph string for a glyph-string sequence to the list of strings
21128 between HEAD and TAIL. */
21130 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21134 Lisp_Object gstring; \
21136 face_id = (row)->glyphs[area][START].face_id; \
21137 gstring = (composition_gstring_from_id \
21138 ((row)->glyphs[area][START].u.cmp.id)); \
21139 s = (struct glyph_string *) alloca (sizeof *s); \
21140 char2b = (XChar2b *) alloca ((sizeof *char2b) \
21141 * LGSTRING_GLYPH_LEN (gstring)); \
21142 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21143 append_glyph_string (&(HEAD), &(TAIL), s); \
21145 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
21149 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
21150 of AREA of glyph row ROW on window W between indices START and END.
21151 HL overrides the face for drawing glyph strings, e.g. it is
21152 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
21153 x-positions of the drawing area.
21155 This is an ugly monster macro construct because we must use alloca
21156 to allocate glyph strings (because draw_glyphs can be called
21157 asynchronously). */
21159 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21162 HEAD = TAIL = NULL; \
21163 while (START < END) \
21165 struct glyph *first_glyph = (row)->glyphs[area] + START; \
21166 switch (first_glyph->type) \
21169 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
21173 case COMPOSITE_GLYPH: \
21174 if (first_glyph->u.cmp.automatic) \
21175 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
21178 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
21182 case STRETCH_GLYPH: \
21183 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
21187 case IMAGE_GLYPH: \
21188 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
21198 set_glyph_string_background_width (s, START, LAST_X); \
21205 /* Draw glyphs between START and END in AREA of ROW on window W,
21206 starting at x-position X. X is relative to AREA in W. HL is a
21207 face-override with the following meaning:
21209 DRAW_NORMAL_TEXT draw normally
21210 DRAW_CURSOR draw in cursor face
21211 DRAW_MOUSE_FACE draw in mouse face.
21212 DRAW_INVERSE_VIDEO draw in mode line face
21213 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
21214 DRAW_IMAGE_RAISED draw an image with a raised relief around it
21216 If OVERLAPS is non-zero, draw only the foreground of characters and
21217 clip to the physical height of ROW. Non-zero value also defines
21218 the overlapping part to be drawn:
21220 OVERLAPS_PRED overlap with preceding rows
21221 OVERLAPS_SUCC overlap with succeeding rows
21222 OVERLAPS_BOTH overlap with both preceding/succeeding rows
21223 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
21225 Value is the x-position reached, relative to AREA of W. */
21228 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
21229 enum glyph_row_area area
, EMACS_INT start
, EMACS_INT end
,
21230 enum draw_glyphs_face hl
, int overlaps
)
21232 struct glyph_string
*head
, *tail
;
21233 struct glyph_string
*s
;
21234 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
21235 int i
, j
, x_reached
, last_x
, area_left
= 0;
21236 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21239 ALLOCATE_HDC (hdc
, f
);
21241 /* Let's rather be paranoid than getting a SEGV. */
21242 end
= min (end
, row
->used
[area
]);
21243 start
= max (0, start
);
21244 start
= min (end
, start
);
21246 /* Translate X to frame coordinates. Set last_x to the right
21247 end of the drawing area. */
21248 if (row
->full_width_p
)
21250 /* X is relative to the left edge of W, without scroll bars
21252 area_left
= WINDOW_LEFT_EDGE_X (w
);
21253 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
21257 area_left
= window_box_left (w
, area
);
21258 last_x
= area_left
+ window_box_width (w
, area
);
21262 /* Build a doubly-linked list of glyph_string structures between
21263 head and tail from what we have to draw. Note that the macro
21264 BUILD_GLYPH_STRINGS will modify its start parameter. That's
21265 the reason we use a separate variable `i'. */
21267 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
21269 x_reached
= tail
->x
+ tail
->background_width
;
21273 /* If there are any glyphs with lbearing < 0 or rbearing > width in
21274 the row, redraw some glyphs in front or following the glyph
21275 strings built above. */
21276 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
21278 struct glyph_string
*h
, *t
;
21279 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
21280 int mouse_beg_col
, mouse_end_col
, check_mouse_face
= 0;
21283 /* If mouse highlighting is on, we may need to draw adjacent
21284 glyphs using mouse-face highlighting. */
21285 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
21287 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
21289 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
21290 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
21292 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
21294 check_mouse_face
= 1;
21295 mouse_beg_col
= (row
== mouse_beg_row
)
21296 ? dpyinfo
->mouse_face_beg_col
: 0;
21297 mouse_end_col
= (row
== mouse_end_row
)
21298 ? dpyinfo
->mouse_face_end_col
21299 : row
->used
[TEXT_AREA
];
21303 /* Compute overhangs for all glyph strings. */
21304 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
21305 for (s
= head
; s
; s
= s
->next
)
21306 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
21308 /* Prepend glyph strings for glyphs in front of the first glyph
21309 string that are overwritten because of the first glyph
21310 string's left overhang. The background of all strings
21311 prepended must be drawn because the first glyph string
21313 i
= left_overwritten (head
);
21316 enum draw_glyphs_face overlap_hl
;
21318 /* If this row contains mouse highlighting, attempt to draw
21319 the overlapped glyphs with the correct highlight. This
21320 code fails if the overlap encompasses more than one glyph
21321 and mouse-highlight spans only some of these glyphs.
21322 However, making it work perfectly involves a lot more
21323 code, and I don't know if the pathological case occurs in
21324 practice, so we'll stick to this for now. --- cyd */
21325 if (check_mouse_face
21326 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21327 overlap_hl
= DRAW_MOUSE_FACE
;
21329 overlap_hl
= DRAW_NORMAL_TEXT
;
21332 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
21333 overlap_hl
, dummy_x
, last_x
);
21335 compute_overhangs_and_x (t
, head
->x
, 1);
21336 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21340 /* Prepend glyph strings for glyphs in front of the first glyph
21341 string that overwrite that glyph string because of their
21342 right overhang. For these strings, only the foreground must
21343 be drawn, because it draws over the glyph string at `head'.
21344 The background must not be drawn because this would overwrite
21345 right overhangs of preceding glyphs for which no glyph
21347 i
= left_overwriting (head
);
21350 enum draw_glyphs_face overlap_hl
;
21352 if (check_mouse_face
21353 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21354 overlap_hl
= DRAW_MOUSE_FACE
;
21356 overlap_hl
= DRAW_NORMAL_TEXT
;
21359 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
21360 overlap_hl
, dummy_x
, last_x
);
21361 for (s
= h
; s
; s
= s
->next
)
21362 s
->background_filled_p
= 1;
21363 compute_overhangs_and_x (t
, head
->x
, 1);
21364 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21367 /* Append glyphs strings for glyphs following the last glyph
21368 string tail that are overwritten by tail. The background of
21369 these strings has to be drawn because tail's foreground draws
21371 i
= right_overwritten (tail
);
21374 enum draw_glyphs_face overlap_hl
;
21376 if (check_mouse_face
21377 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21378 overlap_hl
= DRAW_MOUSE_FACE
;
21380 overlap_hl
= DRAW_NORMAL_TEXT
;
21382 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21383 overlap_hl
, x
, last_x
);
21384 /* Because BUILD_GLYPH_STRINGS updates the first argument,
21385 we don't have `end = i;' here. */
21386 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21387 append_glyph_string_lists (&head
, &tail
, h
, t
);
21391 /* Append glyph strings for glyphs following the last glyph
21392 string tail that overwrite tail. The foreground of such
21393 glyphs has to be drawn because it writes into the background
21394 of tail. The background must not be drawn because it could
21395 paint over the foreground of following glyphs. */
21396 i
= right_overwriting (tail
);
21399 enum draw_glyphs_face overlap_hl
;
21400 if (check_mouse_face
21401 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21402 overlap_hl
= DRAW_MOUSE_FACE
;
21404 overlap_hl
= DRAW_NORMAL_TEXT
;
21407 i
++; /* We must include the Ith glyph. */
21408 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21409 overlap_hl
, x
, last_x
);
21410 for (s
= h
; s
; s
= s
->next
)
21411 s
->background_filled_p
= 1;
21412 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21413 append_glyph_string_lists (&head
, &tail
, h
, t
);
21415 if (clip_head
|| clip_tail
)
21416 for (s
= head
; s
; s
= s
->next
)
21418 s
->clip_head
= clip_head
;
21419 s
->clip_tail
= clip_tail
;
21423 /* Draw all strings. */
21424 for (s
= head
; s
; s
= s
->next
)
21425 FRAME_RIF (f
)->draw_glyph_string (s
);
21428 /* When focus a sole frame and move horizontally, this sets on_p to 0
21429 causing a failure to erase prev cursor position. */
21430 if (area
== TEXT_AREA
21431 && !row
->full_width_p
21432 /* When drawing overlapping rows, only the glyph strings'
21433 foreground is drawn, which doesn't erase a cursor
21437 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
21438 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
21439 : (tail
? tail
->x
+ tail
->background_width
: x
));
21443 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
21444 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
21448 /* Value is the x-position up to which drawn, relative to AREA of W.
21449 This doesn't include parts drawn because of overhangs. */
21450 if (row
->full_width_p
)
21451 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
21453 x_reached
-= area_left
;
21455 RELEASE_HDC (hdc
, f
);
21460 /* Expand row matrix if too narrow. Don't expand if area
21463 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
21465 if (!fonts_changed_p \
21466 && (it->glyph_row->glyphs[area] \
21467 < it->glyph_row->glyphs[area + 1])) \
21469 it->w->ncols_scale_factor++; \
21470 fonts_changed_p = 1; \
21474 /* Store one glyph for IT->char_to_display in IT->glyph_row.
21475 Called from x_produce_glyphs when IT->glyph_row is non-null. */
21478 append_glyph (struct it
*it
)
21480 struct glyph
*glyph
;
21481 enum glyph_row_area area
= it
->area
;
21483 xassert (it
->glyph_row
);
21484 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
21486 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21487 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21489 /* If the glyph row is reversed, we need to prepend the glyph
21490 rather than append it. */
21491 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
21495 /* Make room for the additional glyph. */
21496 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
21498 glyph
= it
->glyph_row
->glyphs
[area
];
21500 glyph
->charpos
= CHARPOS (it
->position
);
21501 glyph
->object
= it
->object
;
21502 if (it
->pixel_width
> 0)
21504 glyph
->pixel_width
= it
->pixel_width
;
21505 glyph
->padding_p
= 0;
21509 /* Assure at least 1-pixel width. Otherwise, cursor can't
21510 be displayed correctly. */
21511 glyph
->pixel_width
= 1;
21512 glyph
->padding_p
= 1;
21514 glyph
->ascent
= it
->ascent
;
21515 glyph
->descent
= it
->descent
;
21516 glyph
->voffset
= it
->voffset
;
21517 glyph
->type
= CHAR_GLYPH
;
21518 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21519 glyph
->multibyte_p
= it
->multibyte_p
;
21520 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21521 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21522 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21523 || it
->phys_descent
> it
->descent
);
21524 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
21525 glyph
->face_id
= it
->face_id
;
21526 glyph
->u
.ch
= it
->char_to_display
;
21527 glyph
->slice
.img
= null_glyph_slice
;
21528 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21531 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21532 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21534 glyph
->bidi_type
= it
->bidi_it
.type
;
21538 glyph
->resolved_level
= 0;
21539 glyph
->bidi_type
= UNKNOWN_BT
;
21541 ++it
->glyph_row
->used
[area
];
21544 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21547 /* Store one glyph for the composition IT->cmp_it.id in
21548 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
21552 append_composite_glyph (struct it
*it
)
21554 struct glyph
*glyph
;
21555 enum glyph_row_area area
= it
->area
;
21557 xassert (it
->glyph_row
);
21559 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21560 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21562 /* If the glyph row is reversed, we need to prepend the glyph
21563 rather than append it. */
21564 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
21568 /* Make room for the new glyph. */
21569 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
21571 glyph
= it
->glyph_row
->glyphs
[it
->area
];
21573 glyph
->charpos
= it
->cmp_it
.charpos
;
21574 glyph
->object
= it
->object
;
21575 glyph
->pixel_width
= it
->pixel_width
;
21576 glyph
->ascent
= it
->ascent
;
21577 glyph
->descent
= it
->descent
;
21578 glyph
->voffset
= it
->voffset
;
21579 glyph
->type
= COMPOSITE_GLYPH
;
21580 if (it
->cmp_it
.ch
< 0)
21582 glyph
->u
.cmp
.automatic
= 0;
21583 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21584 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
21588 glyph
->u
.cmp
.automatic
= 1;
21589 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21590 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
21591 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
21593 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21594 glyph
->multibyte_p
= it
->multibyte_p
;
21595 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21596 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21597 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21598 || it
->phys_descent
> it
->descent
);
21599 glyph
->padding_p
= 0;
21600 glyph
->glyph_not_available_p
= 0;
21601 glyph
->face_id
= it
->face_id
;
21602 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21605 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21606 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21608 glyph
->bidi_type
= it
->bidi_it
.type
;
21610 ++it
->glyph_row
->used
[area
];
21613 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21617 /* Change IT->ascent and IT->height according to the setting of
21621 take_vertical_position_into_account (struct it
*it
)
21625 if (it
->voffset
< 0)
21626 /* Increase the ascent so that we can display the text higher
21628 it
->ascent
-= it
->voffset
;
21630 /* Increase the descent so that we can display the text lower
21632 it
->descent
+= it
->voffset
;
21637 /* Produce glyphs/get display metrics for the image IT is loaded with.
21638 See the description of struct display_iterator in dispextern.h for
21639 an overview of struct display_iterator. */
21642 produce_image_glyph (struct it
*it
)
21646 int glyph_ascent
, crop
;
21647 struct glyph_slice slice
;
21649 xassert (it
->what
== IT_IMAGE
);
21651 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21653 /* Make sure X resources of the face is loaded. */
21654 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21656 if (it
->image_id
< 0)
21658 /* Fringe bitmap. */
21659 it
->ascent
= it
->phys_ascent
= 0;
21660 it
->descent
= it
->phys_descent
= 0;
21661 it
->pixel_width
= 0;
21666 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
21668 /* Make sure X resources of the image is loaded. */
21669 prepare_image_for_display (it
->f
, img
);
21671 slice
.x
= slice
.y
= 0;
21672 slice
.width
= img
->width
;
21673 slice
.height
= img
->height
;
21675 if (INTEGERP (it
->slice
.x
))
21676 slice
.x
= XINT (it
->slice
.x
);
21677 else if (FLOATP (it
->slice
.x
))
21678 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
21680 if (INTEGERP (it
->slice
.y
))
21681 slice
.y
= XINT (it
->slice
.y
);
21682 else if (FLOATP (it
->slice
.y
))
21683 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
21685 if (INTEGERP (it
->slice
.width
))
21686 slice
.width
= XINT (it
->slice
.width
);
21687 else if (FLOATP (it
->slice
.width
))
21688 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
21690 if (INTEGERP (it
->slice
.height
))
21691 slice
.height
= XINT (it
->slice
.height
);
21692 else if (FLOATP (it
->slice
.height
))
21693 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
21695 if (slice
.x
>= img
->width
)
21696 slice
.x
= img
->width
;
21697 if (slice
.y
>= img
->height
)
21698 slice
.y
= img
->height
;
21699 if (slice
.x
+ slice
.width
>= img
->width
)
21700 slice
.width
= img
->width
- slice
.x
;
21701 if (slice
.y
+ slice
.height
> img
->height
)
21702 slice
.height
= img
->height
- slice
.y
;
21704 if (slice
.width
== 0 || slice
.height
== 0)
21707 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
21709 it
->descent
= slice
.height
- glyph_ascent
;
21711 it
->descent
+= img
->vmargin
;
21712 if (slice
.y
+ slice
.height
== img
->height
)
21713 it
->descent
+= img
->vmargin
;
21714 it
->phys_descent
= it
->descent
;
21716 it
->pixel_width
= slice
.width
;
21718 it
->pixel_width
+= img
->hmargin
;
21719 if (slice
.x
+ slice
.width
== img
->width
)
21720 it
->pixel_width
+= img
->hmargin
;
21722 /* It's quite possible for images to have an ascent greater than
21723 their height, so don't get confused in that case. */
21724 if (it
->descent
< 0)
21729 if (face
->box
!= FACE_NO_BOX
)
21731 if (face
->box_line_width
> 0)
21734 it
->ascent
+= face
->box_line_width
;
21735 if (slice
.y
+ slice
.height
== img
->height
)
21736 it
->descent
+= face
->box_line_width
;
21739 if (it
->start_of_box_run_p
&& slice
.x
== 0)
21740 it
->pixel_width
+= eabs (face
->box_line_width
);
21741 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
21742 it
->pixel_width
+= eabs (face
->box_line_width
);
21745 take_vertical_position_into_account (it
);
21747 /* Automatically crop wide image glyphs at right edge so we can
21748 draw the cursor on same display row. */
21749 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
21750 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
21752 it
->pixel_width
-= crop
;
21753 slice
.width
-= crop
;
21758 struct glyph
*glyph
;
21759 enum glyph_row_area area
= it
->area
;
21761 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21762 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21764 glyph
->charpos
= CHARPOS (it
->position
);
21765 glyph
->object
= it
->object
;
21766 glyph
->pixel_width
= it
->pixel_width
;
21767 glyph
->ascent
= glyph_ascent
;
21768 glyph
->descent
= it
->descent
;
21769 glyph
->voffset
= it
->voffset
;
21770 glyph
->type
= IMAGE_GLYPH
;
21771 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21772 glyph
->multibyte_p
= it
->multibyte_p
;
21773 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21774 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21775 glyph
->overlaps_vertically_p
= 0;
21776 glyph
->padding_p
= 0;
21777 glyph
->glyph_not_available_p
= 0;
21778 glyph
->face_id
= it
->face_id
;
21779 glyph
->u
.img_id
= img
->id
;
21780 glyph
->slice
.img
= slice
;
21781 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21784 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21785 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21787 glyph
->bidi_type
= it
->bidi_it
.type
;
21789 ++it
->glyph_row
->used
[area
];
21792 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21797 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
21798 of the glyph, WIDTH and HEIGHT are the width and height of the
21799 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
21802 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
21803 int width
, int height
, int ascent
)
21805 struct glyph
*glyph
;
21806 enum glyph_row_area area
= it
->area
;
21808 xassert (ascent
>= 0 && ascent
<= height
);
21810 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21811 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21813 /* If the glyph row is reversed, we need to prepend the glyph
21814 rather than append it. */
21815 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
21819 /* Make room for the additional glyph. */
21820 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
21822 glyph
= it
->glyph_row
->glyphs
[area
];
21824 glyph
->charpos
= CHARPOS (it
->position
);
21825 glyph
->object
= object
;
21826 glyph
->pixel_width
= width
;
21827 glyph
->ascent
= ascent
;
21828 glyph
->descent
= height
- ascent
;
21829 glyph
->voffset
= it
->voffset
;
21830 glyph
->type
= STRETCH_GLYPH
;
21831 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21832 glyph
->multibyte_p
= it
->multibyte_p
;
21833 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21834 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21835 glyph
->overlaps_vertically_p
= 0;
21836 glyph
->padding_p
= 0;
21837 glyph
->glyph_not_available_p
= 0;
21838 glyph
->face_id
= it
->face_id
;
21839 glyph
->u
.stretch
.ascent
= ascent
;
21840 glyph
->u
.stretch
.height
= height
;
21841 glyph
->slice
.img
= null_glyph_slice
;
21842 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21845 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21846 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21848 glyph
->bidi_type
= it
->bidi_it
.type
;
21852 glyph
->resolved_level
= 0;
21853 glyph
->bidi_type
= UNKNOWN_BT
;
21855 ++it
->glyph_row
->used
[area
];
21858 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21862 /* Produce a stretch glyph for iterator IT. IT->object is the value
21863 of the glyph property displayed. The value must be a list
21864 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
21867 1. `:width WIDTH' specifies that the space should be WIDTH *
21868 canonical char width wide. WIDTH may be an integer or floating
21871 2. `:relative-width FACTOR' specifies that the width of the stretch
21872 should be computed from the width of the first character having the
21873 `glyph' property, and should be FACTOR times that width.
21875 3. `:align-to HPOS' specifies that the space should be wide enough
21876 to reach HPOS, a value in canonical character units.
21878 Exactly one of the above pairs must be present.
21880 4. `:height HEIGHT' specifies that the height of the stretch produced
21881 should be HEIGHT, measured in canonical character units.
21883 5. `:relative-height FACTOR' specifies that the height of the
21884 stretch should be FACTOR times the height of the characters having
21885 the glyph property.
21887 Either none or exactly one of 4 or 5 must be present.
21889 6. `:ascent ASCENT' specifies that ASCENT percent of the height
21890 of the stretch should be used for the ascent of the stretch.
21891 ASCENT must be in the range 0 <= ASCENT <= 100. */
21894 produce_stretch_glyph (struct it
*it
)
21896 /* (space :width WIDTH :height HEIGHT ...) */
21897 Lisp_Object prop
, plist
;
21898 int width
= 0, height
= 0, align_to
= -1;
21899 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
21902 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21903 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
21905 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21907 /* List should start with `space'. */
21908 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
21909 plist
= XCDR (it
->object
);
21911 /* Compute the width of the stretch. */
21912 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
21913 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
21915 /* Absolute width `:width WIDTH' specified and valid. */
21916 zero_width_ok_p
= 1;
21919 else if (prop
= Fplist_get (plist
, QCrelative_width
),
21922 /* Relative width `:relative-width FACTOR' specified and valid.
21923 Compute the width of the characters having the `glyph'
21926 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
21929 if (it
->multibyte_p
)
21930 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
21933 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
21934 if (! ASCII_CHAR_P (it2
.c
))
21935 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
21938 it2
.glyph_row
= NULL
;
21939 it2
.what
= IT_CHARACTER
;
21940 x_produce_glyphs (&it2
);
21941 width
= NUMVAL (prop
) * it2
.pixel_width
;
21943 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
21944 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
21946 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
21947 align_to
= (align_to
< 0
21949 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
21950 else if (align_to
< 0)
21951 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
21952 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
21953 zero_width_ok_p
= 1;
21956 /* Nothing specified -> width defaults to canonical char width. */
21957 width
= FRAME_COLUMN_WIDTH (it
->f
);
21959 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
21962 /* Compute height. */
21963 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
21964 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
21967 zero_height_ok_p
= 1;
21969 else if (prop
= Fplist_get (plist
, QCrelative_height
),
21971 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
21973 height
= FONT_HEIGHT (font
);
21975 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
21978 /* Compute percentage of height used for ascent. If
21979 `:ascent ASCENT' is present and valid, use that. Otherwise,
21980 derive the ascent from the font in use. */
21981 if (prop
= Fplist_get (plist
, QCascent
),
21982 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
21983 ascent
= height
* NUMVAL (prop
) / 100.0;
21984 else if (!NILP (prop
)
21985 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
21986 ascent
= min (max (0, (int)tem
), height
);
21988 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
21990 if (width
> 0 && it
->line_wrap
!= TRUNCATE
21991 && it
->current_x
+ width
> it
->last_visible_x
)
21992 width
= it
->last_visible_x
- it
->current_x
- 1;
21994 if (width
> 0 && height
> 0 && it
->glyph_row
)
21996 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
21997 if (!STRINGP (object
))
21998 object
= it
->w
->buffer
;
21999 append_stretch_glyph (it
, object
, width
, height
, ascent
);
22002 it
->pixel_width
= width
;
22003 it
->ascent
= it
->phys_ascent
= ascent
;
22004 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
22005 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
22007 take_vertical_position_into_account (it
);
22010 /* Calculate line-height and line-spacing properties.
22011 An integer value specifies explicit pixel value.
22012 A float value specifies relative value to current face height.
22013 A cons (float . face-name) specifies relative value to
22014 height of specified face font.
22016 Returns height in pixels, or nil. */
22020 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
22021 int boff
, int override
)
22023 Lisp_Object face_name
= Qnil
;
22024 int ascent
, descent
, height
;
22026 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
22031 face_name
= XCAR (val
);
22033 if (!NUMBERP (val
))
22034 val
= make_number (1);
22035 if (NILP (face_name
))
22037 height
= it
->ascent
+ it
->descent
;
22042 if (NILP (face_name
))
22044 font
= FRAME_FONT (it
->f
);
22045 boff
= FRAME_BASELINE_OFFSET (it
->f
);
22047 else if (EQ (face_name
, Qt
))
22056 face_id
= lookup_named_face (it
->f
, face_name
, 0);
22058 return make_number (-1);
22060 face
= FACE_FROM_ID (it
->f
, face_id
);
22063 return make_number (-1);
22064 boff
= font
->baseline_offset
;
22065 if (font
->vertical_centering
)
22066 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22069 ascent
= FONT_BASE (font
) + boff
;
22070 descent
= FONT_DESCENT (font
) - boff
;
22074 it
->override_ascent
= ascent
;
22075 it
->override_descent
= descent
;
22076 it
->override_boff
= boff
;
22079 height
= ascent
+ descent
;
22083 height
= (int)(XFLOAT_DATA (val
) * height
);
22084 else if (INTEGERP (val
))
22085 height
*= XINT (val
);
22087 return make_number (height
);
22092 Produce glyphs/get display metrics for the display element IT is
22093 loaded with. See the description of struct it in dispextern.h
22094 for an overview of struct it. */
22097 x_produce_glyphs (struct it
*it
)
22099 int extra_line_spacing
= it
->extra_line_spacing
;
22101 it
->glyph_not_available_p
= 0;
22103 if (it
->what
== IT_CHARACTER
)
22106 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22107 struct font
*font
= face
->font
;
22108 int font_not_found_p
= font
== NULL
;
22109 struct font_metrics
*pcm
= NULL
;
22110 int boff
; /* baseline offset */
22112 if (font_not_found_p
)
22114 /* When no suitable font found, display an empty box based
22115 on the metrics of the font of the default face (or what
22117 struct face
*no_font_face
22118 = FACE_FROM_ID (it
->f
,
22119 NILP (Vface_remapping_alist
) ? DEFAULT_FACE_ID
22120 : lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
22121 font
= no_font_face
->font
;
22122 boff
= font
->baseline_offset
;
22126 boff
= font
->baseline_offset
;
22127 if (font
->vertical_centering
)
22128 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22131 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
22137 if (it
->override_ascent
>= 0)
22139 it
->ascent
= it
->override_ascent
;
22140 it
->descent
= it
->override_descent
;
22141 boff
= it
->override_boff
;
22145 it
->ascent
= FONT_BASE (font
) + boff
;
22146 it
->descent
= FONT_DESCENT (font
) - boff
;
22149 if (! font_not_found_p
22150 && get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
22152 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22153 if (pcm
->width
== 0
22154 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
22160 it
->phys_ascent
= pcm
->ascent
+ boff
;
22161 it
->phys_descent
= pcm
->descent
- boff
;
22162 it
->pixel_width
= pcm
->width
;
22166 it
->glyph_not_available_p
= 1;
22167 it
->phys_ascent
= it
->ascent
;
22168 it
->phys_descent
= it
->descent
;
22169 it
->pixel_width
= font
->space_width
;
22172 if (it
->constrain_row_ascent_descent_p
)
22174 if (it
->descent
> it
->max_descent
)
22176 it
->ascent
+= it
->descent
- it
->max_descent
;
22177 it
->descent
= it
->max_descent
;
22179 if (it
->ascent
> it
->max_ascent
)
22181 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22182 it
->ascent
= it
->max_ascent
;
22184 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22185 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22186 extra_line_spacing
= 0;
22189 /* If this is a space inside a region of text with
22190 `space-width' property, change its width. */
22191 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
22193 it
->pixel_width
*= XFLOATINT (it
->space_width
);
22195 /* If face has a box, add the box thickness to the character
22196 height. If character has a box line to the left and/or
22197 right, add the box line width to the character's width. */
22198 if (face
->box
!= FACE_NO_BOX
)
22200 int thick
= face
->box_line_width
;
22204 it
->ascent
+= thick
;
22205 it
->descent
+= thick
;
22210 if (it
->start_of_box_run_p
)
22211 it
->pixel_width
+= thick
;
22212 if (it
->end_of_box_run_p
)
22213 it
->pixel_width
+= thick
;
22216 /* If face has an overline, add the height of the overline
22217 (1 pixel) and a 1 pixel margin to the character height. */
22218 if (face
->overline_p
)
22219 it
->ascent
+= overline_margin
;
22221 if (it
->constrain_row_ascent_descent_p
)
22223 if (it
->ascent
> it
->max_ascent
)
22224 it
->ascent
= it
->max_ascent
;
22225 if (it
->descent
> it
->max_descent
)
22226 it
->descent
= it
->max_descent
;
22229 take_vertical_position_into_account (it
);
22231 /* If we have to actually produce glyphs, do it. */
22236 /* Translate a space with a `space-width' property
22237 into a stretch glyph. */
22238 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
22239 / FONT_HEIGHT (font
));
22240 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22241 it
->ascent
+ it
->descent
, ascent
);
22246 /* If characters with lbearing or rbearing are displayed
22247 in this line, record that fact in a flag of the
22248 glyph row. This is used to optimize X output code. */
22249 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
22250 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22252 if (! stretched_p
&& it
->pixel_width
== 0)
22253 /* We assure that all visible glyphs have at least 1-pixel
22255 it
->pixel_width
= 1;
22257 else if (it
->char_to_display
== '\n')
22259 /* A newline has no width, but we need the height of the
22260 line. But if previous part of the line sets a height,
22261 don't increase that height */
22263 Lisp_Object height
;
22264 Lisp_Object total_height
= Qnil
;
22266 it
->override_ascent
= -1;
22267 it
->pixel_width
= 0;
22270 height
= get_it_property (it
, Qline_height
);
22271 /* Split (line-height total-height) list */
22273 && CONSP (XCDR (height
))
22274 && NILP (XCDR (XCDR (height
))))
22276 total_height
= XCAR (XCDR (height
));
22277 height
= XCAR (height
);
22279 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
22281 if (it
->override_ascent
>= 0)
22283 it
->ascent
= it
->override_ascent
;
22284 it
->descent
= it
->override_descent
;
22285 boff
= it
->override_boff
;
22289 it
->ascent
= FONT_BASE (font
) + boff
;
22290 it
->descent
= FONT_DESCENT (font
) - boff
;
22293 if (EQ (height
, Qt
))
22295 if (it
->descent
> it
->max_descent
)
22297 it
->ascent
+= it
->descent
- it
->max_descent
;
22298 it
->descent
= it
->max_descent
;
22300 if (it
->ascent
> it
->max_ascent
)
22302 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22303 it
->ascent
= it
->max_ascent
;
22305 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22306 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22307 it
->constrain_row_ascent_descent_p
= 1;
22308 extra_line_spacing
= 0;
22312 Lisp_Object spacing
;
22314 it
->phys_ascent
= it
->ascent
;
22315 it
->phys_descent
= it
->descent
;
22317 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
22318 && face
->box
!= FACE_NO_BOX
22319 && face
->box_line_width
> 0)
22321 it
->ascent
+= face
->box_line_width
;
22322 it
->descent
+= face
->box_line_width
;
22325 && XINT (height
) > it
->ascent
+ it
->descent
)
22326 it
->ascent
= XINT (height
) - it
->descent
;
22328 if (!NILP (total_height
))
22329 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
22332 spacing
= get_it_property (it
, Qline_spacing
);
22333 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
22335 if (INTEGERP (spacing
))
22337 extra_line_spacing
= XINT (spacing
);
22338 if (!NILP (total_height
))
22339 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
22343 else /* i.e. (it->char_to_display == '\t') */
22345 if (font
->space_width
> 0)
22347 int tab_width
= it
->tab_width
* font
->space_width
;
22348 int x
= it
->current_x
+ it
->continuation_lines_width
;
22349 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
22351 /* If the distance from the current position to the next tab
22352 stop is less than a space character width, use the
22353 tab stop after that. */
22354 if (next_tab_x
- x
< font
->space_width
)
22355 next_tab_x
+= tab_width
;
22357 it
->pixel_width
= next_tab_x
- x
;
22359 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
22360 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
22364 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22365 it
->ascent
+ it
->descent
, it
->ascent
);
22370 it
->pixel_width
= 0;
22375 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
22377 /* A static composition.
22379 Note: A composition is represented as one glyph in the
22380 glyph matrix. There are no padding glyphs.
22382 Important note: pixel_width, ascent, and descent are the
22383 values of what is drawn by draw_glyphs (i.e. the values of
22384 the overall glyphs composed). */
22385 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22386 int boff
; /* baseline offset */
22387 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
22388 int glyph_len
= cmp
->glyph_len
;
22389 struct font
*font
= face
->font
;
22393 /* If we have not yet calculated pixel size data of glyphs of
22394 the composition for the current face font, calculate them
22395 now. Theoretically, we have to check all fonts for the
22396 glyphs, but that requires much time and memory space. So,
22397 here we check only the font of the first glyph. This may
22398 lead to incorrect display, but it's very rare, and C-l
22399 (recenter-top-bottom) can correct the display anyway. */
22400 if (! cmp
->font
|| cmp
->font
!= font
)
22402 /* Ascent and descent of the font of the first character
22403 of this composition (adjusted by baseline offset).
22404 Ascent and descent of overall glyphs should not be less
22405 than these, respectively. */
22406 int font_ascent
, font_descent
, font_height
;
22407 /* Bounding box of the overall glyphs. */
22408 int leftmost
, rightmost
, lowest
, highest
;
22409 int lbearing
, rbearing
;
22410 int i
, width
, ascent
, descent
;
22411 int left_padded
= 0, right_padded
= 0;
22414 struct font_metrics
*pcm
;
22415 int font_not_found_p
;
22418 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
22419 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
22421 if (glyph_len
< cmp
->glyph_len
)
22423 for (i
= 0; i
< glyph_len
; i
++)
22425 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
22427 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22432 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
22433 : IT_CHARPOS (*it
));
22434 /* If no suitable font is found, use the default font. */
22435 font_not_found_p
= font
== NULL
;
22436 if (font_not_found_p
)
22438 face
= face
->ascii_face
;
22441 boff
= font
->baseline_offset
;
22442 if (font
->vertical_centering
)
22443 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22444 font_ascent
= FONT_BASE (font
) + boff
;
22445 font_descent
= FONT_DESCENT (font
) - boff
;
22446 font_height
= FONT_HEIGHT (font
);
22448 cmp
->font
= (void *) font
;
22451 if (! font_not_found_p
)
22453 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
22454 &char2b
, it
->multibyte_p
, 0);
22455 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22458 /* Initialize the bounding box. */
22461 width
= pcm
->width
;
22462 ascent
= pcm
->ascent
;
22463 descent
= pcm
->descent
;
22464 lbearing
= pcm
->lbearing
;
22465 rbearing
= pcm
->rbearing
;
22469 width
= font
->space_width
;
22470 ascent
= FONT_BASE (font
);
22471 descent
= FONT_DESCENT (font
);
22478 lowest
= - descent
+ boff
;
22479 highest
= ascent
+ boff
;
22481 if (! font_not_found_p
22482 && font
->default_ascent
22483 && CHAR_TABLE_P (Vuse_default_ascent
)
22484 && !NILP (Faref (Vuse_default_ascent
,
22485 make_number (it
->char_to_display
))))
22486 highest
= font
->default_ascent
+ boff
;
22488 /* Draw the first glyph at the normal position. It may be
22489 shifted to right later if some other glyphs are drawn
22491 cmp
->offsets
[i
* 2] = 0;
22492 cmp
->offsets
[i
* 2 + 1] = boff
;
22493 cmp
->lbearing
= lbearing
;
22494 cmp
->rbearing
= rbearing
;
22496 /* Set cmp->offsets for the remaining glyphs. */
22497 for (i
++; i
< glyph_len
; i
++)
22499 int left
, right
, btm
, top
;
22500 int ch
= COMPOSITION_GLYPH (cmp
, i
);
22502 struct face
*this_face
;
22507 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
22508 this_face
= FACE_FROM_ID (it
->f
, face_id
);
22509 font
= this_face
->font
;
22515 this_boff
= font
->baseline_offset
;
22516 if (font
->vertical_centering
)
22517 this_boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22518 get_char_face_and_encoding (it
->f
, ch
, face_id
,
22519 &char2b
, it
->multibyte_p
, 0);
22520 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22523 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22526 width
= pcm
->width
;
22527 ascent
= pcm
->ascent
;
22528 descent
= pcm
->descent
;
22529 lbearing
= pcm
->lbearing
;
22530 rbearing
= pcm
->rbearing
;
22531 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
22533 /* Relative composition with or without
22534 alternate chars. */
22535 left
= (leftmost
+ rightmost
- width
) / 2;
22536 btm
= - descent
+ boff
;
22537 if (font
->relative_compose
22538 && (! CHAR_TABLE_P (Vignore_relative_composition
)
22539 || NILP (Faref (Vignore_relative_composition
,
22540 make_number (ch
)))))
22543 if (- descent
>= font
->relative_compose
)
22544 /* One extra pixel between two glyphs. */
22546 else if (ascent
<= 0)
22547 /* One extra pixel between two glyphs. */
22548 btm
= lowest
- 1 - ascent
- descent
;
22553 /* A composition rule is specified by an integer
22554 value that encodes global and new reference
22555 points (GREF and NREF). GREF and NREF are
22556 specified by numbers as below:
22558 0---1---2 -- ascent
22562 9--10--11 -- center
22564 ---3---4---5--- baseline
22566 6---7---8 -- descent
22568 int rule
= COMPOSITION_RULE (cmp
, i
);
22569 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
22571 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
22572 grefx
= gref
% 3, nrefx
= nref
% 3;
22573 grefy
= gref
/ 3, nrefy
= nref
/ 3;
22575 xoff
= font_height
* (xoff
- 128) / 256;
22577 yoff
= font_height
* (yoff
- 128) / 256;
22580 + grefx
* (rightmost
- leftmost
) / 2
22581 - nrefx
* width
/ 2
22584 btm
= ((grefy
== 0 ? highest
22586 : grefy
== 2 ? lowest
22587 : (highest
+ lowest
) / 2)
22588 - (nrefy
== 0 ? ascent
+ descent
22589 : nrefy
== 1 ? descent
- boff
22591 : (ascent
+ descent
) / 2)
22595 cmp
->offsets
[i
* 2] = left
;
22596 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
22598 /* Update the bounding box of the overall glyphs. */
22601 right
= left
+ width
;
22602 if (left
< leftmost
)
22604 if (right
> rightmost
)
22607 top
= btm
+ descent
+ ascent
;
22613 if (cmp
->lbearing
> left
+ lbearing
)
22614 cmp
->lbearing
= left
+ lbearing
;
22615 if (cmp
->rbearing
< left
+ rbearing
)
22616 cmp
->rbearing
= left
+ rbearing
;
22620 /* If there are glyphs whose x-offsets are negative,
22621 shift all glyphs to the right and make all x-offsets
22625 for (i
= 0; i
< cmp
->glyph_len
; i
++)
22626 cmp
->offsets
[i
* 2] -= leftmost
;
22627 rightmost
-= leftmost
;
22628 cmp
->lbearing
-= leftmost
;
22629 cmp
->rbearing
-= leftmost
;
22632 if (left_padded
&& cmp
->lbearing
< 0)
22634 for (i
= 0; i
< cmp
->glyph_len
; i
++)
22635 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
22636 rightmost
-= cmp
->lbearing
;
22637 cmp
->rbearing
-= cmp
->lbearing
;
22640 if (right_padded
&& rightmost
< cmp
->rbearing
)
22642 rightmost
= cmp
->rbearing
;
22645 cmp
->pixel_width
= rightmost
;
22646 cmp
->ascent
= highest
;
22647 cmp
->descent
= - lowest
;
22648 if (cmp
->ascent
< font_ascent
)
22649 cmp
->ascent
= font_ascent
;
22650 if (cmp
->descent
< font_descent
)
22651 cmp
->descent
= font_descent
;
22655 && (cmp
->lbearing
< 0
22656 || cmp
->rbearing
> cmp
->pixel_width
))
22657 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22659 it
->pixel_width
= cmp
->pixel_width
;
22660 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
22661 it
->descent
= it
->phys_descent
= cmp
->descent
;
22662 if (face
->box
!= FACE_NO_BOX
)
22664 int thick
= face
->box_line_width
;
22668 it
->ascent
+= thick
;
22669 it
->descent
+= thick
;
22674 if (it
->start_of_box_run_p
)
22675 it
->pixel_width
+= thick
;
22676 if (it
->end_of_box_run_p
)
22677 it
->pixel_width
+= thick
;
22680 /* If face has an overline, add the height of the overline
22681 (1 pixel) and a 1 pixel margin to the character height. */
22682 if (face
->overline_p
)
22683 it
->ascent
+= overline_margin
;
22685 take_vertical_position_into_account (it
);
22686 if (it
->ascent
< 0)
22688 if (it
->descent
< 0)
22692 append_composite_glyph (it
);
22694 else if (it
->what
== IT_COMPOSITION
)
22696 /* A dynamic (automatic) composition. */
22697 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22698 Lisp_Object gstring
;
22699 struct font_metrics metrics
;
22701 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
22703 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
22706 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
22707 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22708 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
22709 it
->descent
= it
->phys_descent
= metrics
.descent
;
22710 if (face
->box
!= FACE_NO_BOX
)
22712 int thick
= face
->box_line_width
;
22716 it
->ascent
+= thick
;
22717 it
->descent
+= thick
;
22722 if (it
->start_of_box_run_p
)
22723 it
->pixel_width
+= thick
;
22724 if (it
->end_of_box_run_p
)
22725 it
->pixel_width
+= thick
;
22727 /* If face has an overline, add the height of the overline
22728 (1 pixel) and a 1 pixel margin to the character height. */
22729 if (face
->overline_p
)
22730 it
->ascent
+= overline_margin
;
22731 take_vertical_position_into_account (it
);
22732 if (it
->ascent
< 0)
22734 if (it
->descent
< 0)
22738 append_composite_glyph (it
);
22740 else if (it
->what
== IT_IMAGE
)
22741 produce_image_glyph (it
);
22742 else if (it
->what
== IT_STRETCH
)
22743 produce_stretch_glyph (it
);
22745 /* Accumulate dimensions. Note: can't assume that it->descent > 0
22746 because this isn't true for images with `:ascent 100'. */
22747 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
22748 if (it
->area
== TEXT_AREA
)
22749 it
->current_x
+= it
->pixel_width
;
22751 if (extra_line_spacing
> 0)
22753 it
->descent
+= extra_line_spacing
;
22754 if (extra_line_spacing
> it
->max_extra_line_spacing
)
22755 it
->max_extra_line_spacing
= extra_line_spacing
;
22758 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
22759 it
->max_descent
= max (it
->max_descent
, it
->descent
);
22760 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
22761 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
22765 Output LEN glyphs starting at START at the nominal cursor position.
22766 Advance the nominal cursor over the text. The global variable
22767 updated_window contains the window being updated, updated_row is
22768 the glyph row being updated, and updated_area is the area of that
22769 row being updated. */
22772 x_write_glyphs (struct glyph
*start
, int len
)
22776 xassert (updated_window
&& updated_row
);
22779 /* Write glyphs. */
22781 hpos
= start
- updated_row
->glyphs
[updated_area
];
22782 x
= draw_glyphs (updated_window
, output_cursor
.x
,
22783 updated_row
, updated_area
,
22785 DRAW_NORMAL_TEXT
, 0);
22787 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
22788 if (updated_area
== TEXT_AREA
22789 && updated_window
->phys_cursor_on_p
22790 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
22791 && updated_window
->phys_cursor
.hpos
>= hpos
22792 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
22793 updated_window
->phys_cursor_on_p
= 0;
22797 /* Advance the output cursor. */
22798 output_cursor
.hpos
+= len
;
22799 output_cursor
.x
= x
;
22804 Insert LEN glyphs from START at the nominal cursor position. */
22807 x_insert_glyphs (struct glyph
*start
, int len
)
22811 int line_height
, shift_by_width
, shifted_region_width
;
22812 struct glyph_row
*row
;
22813 struct glyph
*glyph
;
22814 int frame_x
, frame_y
;
22817 xassert (updated_window
&& updated_row
);
22819 w
= updated_window
;
22820 f
= XFRAME (WINDOW_FRAME (w
));
22822 /* Get the height of the line we are in. */
22824 line_height
= row
->height
;
22826 /* Get the width of the glyphs to insert. */
22827 shift_by_width
= 0;
22828 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
22829 shift_by_width
+= glyph
->pixel_width
;
22831 /* Get the width of the region to shift right. */
22832 shifted_region_width
= (window_box_width (w
, updated_area
)
22837 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
22838 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
22840 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
22841 line_height
, shift_by_width
);
22843 /* Write the glyphs. */
22844 hpos
= start
- row
->glyphs
[updated_area
];
22845 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
22847 DRAW_NORMAL_TEXT
, 0);
22849 /* Advance the output cursor. */
22850 output_cursor
.hpos
+= len
;
22851 output_cursor
.x
+= shift_by_width
;
22857 Erase the current text line from the nominal cursor position
22858 (inclusive) to pixel column TO_X (exclusive). The idea is that
22859 everything from TO_X onward is already erased.
22861 TO_X is a pixel position relative to updated_area of
22862 updated_window. TO_X == -1 means clear to the end of this area. */
22865 x_clear_end_of_line (int to_x
)
22868 struct window
*w
= updated_window
;
22869 int max_x
, min_y
, max_y
;
22870 int from_x
, from_y
, to_y
;
22872 xassert (updated_window
&& updated_row
);
22873 f
= XFRAME (w
->frame
);
22875 if (updated_row
->full_width_p
)
22876 max_x
= WINDOW_TOTAL_WIDTH (w
);
22878 max_x
= window_box_width (w
, updated_area
);
22879 max_y
= window_text_bottom_y (w
);
22881 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
22882 of window. For TO_X > 0, truncate to end of drawing area. */
22888 to_x
= min (to_x
, max_x
);
22890 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
22892 /* Notice if the cursor will be cleared by this operation. */
22893 if (!updated_row
->full_width_p
)
22894 notice_overwritten_cursor (w
, updated_area
,
22895 output_cursor
.x
, -1,
22897 MATRIX_ROW_BOTTOM_Y (updated_row
));
22899 from_x
= output_cursor
.x
;
22901 /* Translate to frame coordinates. */
22902 if (updated_row
->full_width_p
)
22904 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
22905 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
22909 int area_left
= window_box_left (w
, updated_area
);
22910 from_x
+= area_left
;
22914 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
22915 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
22916 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
22918 /* Prevent inadvertently clearing to end of the X window. */
22919 if (to_x
> from_x
&& to_y
> from_y
)
22922 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
22923 to_x
- from_x
, to_y
- from_y
);
22928 #endif /* HAVE_WINDOW_SYSTEM */
22932 /***********************************************************************
22934 ***********************************************************************/
22936 /* Value is the internal representation of the specified cursor type
22937 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
22938 of the bar cursor. */
22940 static enum text_cursor_kinds
22941 get_specified_cursor_type (Lisp_Object arg
, int *width
)
22943 enum text_cursor_kinds type
;
22948 if (EQ (arg
, Qbox
))
22949 return FILLED_BOX_CURSOR
;
22951 if (EQ (arg
, Qhollow
))
22952 return HOLLOW_BOX_CURSOR
;
22954 if (EQ (arg
, Qbar
))
22961 && EQ (XCAR (arg
), Qbar
)
22962 && INTEGERP (XCDR (arg
))
22963 && XINT (XCDR (arg
)) >= 0)
22965 *width
= XINT (XCDR (arg
));
22969 if (EQ (arg
, Qhbar
))
22972 return HBAR_CURSOR
;
22976 && EQ (XCAR (arg
), Qhbar
)
22977 && INTEGERP (XCDR (arg
))
22978 && XINT (XCDR (arg
)) >= 0)
22980 *width
= XINT (XCDR (arg
));
22981 return HBAR_CURSOR
;
22984 /* Treat anything unknown as "hollow box cursor".
22985 It was bad to signal an error; people have trouble fixing
22986 .Xdefaults with Emacs, when it has something bad in it. */
22987 type
= HOLLOW_BOX_CURSOR
;
22992 /* Set the default cursor types for specified frame. */
22994 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
22999 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
23000 FRAME_CURSOR_WIDTH (f
) = width
;
23002 /* By default, set up the blink-off state depending on the on-state. */
23004 tem
= Fassoc (arg
, Vblink_cursor_alist
);
23007 FRAME_BLINK_OFF_CURSOR (f
)
23008 = get_specified_cursor_type (XCDR (tem
), &width
);
23009 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
23012 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
23016 /* Return the cursor we want to be displayed in window W. Return
23017 width of bar/hbar cursor through WIDTH arg. Return with
23018 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
23019 (i.e. if the `system caret' should track this cursor).
23021 In a mini-buffer window, we want the cursor only to appear if we
23022 are reading input from this window. For the selected window, we
23023 want the cursor type given by the frame parameter or buffer local
23024 setting of cursor-type. If explicitly marked off, draw no cursor.
23025 In all other cases, we want a hollow box cursor. */
23027 static enum text_cursor_kinds
23028 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
23029 int *active_cursor
)
23031 struct frame
*f
= XFRAME (w
->frame
);
23032 struct buffer
*b
= XBUFFER (w
->buffer
);
23033 int cursor_type
= DEFAULT_CURSOR
;
23034 Lisp_Object alt_cursor
;
23035 int non_selected
= 0;
23037 *active_cursor
= 1;
23040 if (cursor_in_echo_area
23041 && FRAME_HAS_MINIBUF_P (f
)
23042 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
23044 if (w
== XWINDOW (echo_area_window
))
23046 if (EQ (b
->cursor_type
, Qt
) || NILP (b
->cursor_type
))
23048 *width
= FRAME_CURSOR_WIDTH (f
);
23049 return FRAME_DESIRED_CURSOR (f
);
23052 return get_specified_cursor_type (b
->cursor_type
, width
);
23055 *active_cursor
= 0;
23059 /* Detect a nonselected window or nonselected frame. */
23060 else if (w
!= XWINDOW (f
->selected_window
)
23061 #ifdef HAVE_WINDOW_SYSTEM
23062 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
23066 *active_cursor
= 0;
23068 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
23074 /* Never display a cursor in a window in which cursor-type is nil. */
23075 if (NILP (b
->cursor_type
))
23078 /* Get the normal cursor type for this window. */
23079 if (EQ (b
->cursor_type
, Qt
))
23081 cursor_type
= FRAME_DESIRED_CURSOR (f
);
23082 *width
= FRAME_CURSOR_WIDTH (f
);
23085 cursor_type
= get_specified_cursor_type (b
->cursor_type
, width
);
23087 /* Use cursor-in-non-selected-windows instead
23088 for non-selected window or frame. */
23091 alt_cursor
= b
->cursor_in_non_selected_windows
;
23092 if (!EQ (Qt
, alt_cursor
))
23093 return get_specified_cursor_type (alt_cursor
, width
);
23094 /* t means modify the normal cursor type. */
23095 if (cursor_type
== FILLED_BOX_CURSOR
)
23096 cursor_type
= HOLLOW_BOX_CURSOR
;
23097 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
23099 return cursor_type
;
23102 /* Use normal cursor if not blinked off. */
23103 if (!w
->cursor_off_p
)
23105 #ifdef HAVE_WINDOW_SYSTEM
23106 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
23108 if (cursor_type
== FILLED_BOX_CURSOR
)
23110 /* Using a block cursor on large images can be very annoying.
23111 So use a hollow cursor for "large" images.
23112 If image is not transparent (no mask), also use hollow cursor. */
23113 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
23114 if (img
!= NULL
&& IMAGEP (img
->spec
))
23116 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
23117 where N = size of default frame font size.
23118 This should cover most of the "tiny" icons people may use. */
23120 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
23121 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
23122 cursor_type
= HOLLOW_BOX_CURSOR
;
23125 else if (cursor_type
!= NO_CURSOR
)
23127 /* Display current only supports BOX and HOLLOW cursors for images.
23128 So for now, unconditionally use a HOLLOW cursor when cursor is
23129 not a solid box cursor. */
23130 cursor_type
= HOLLOW_BOX_CURSOR
;
23134 return cursor_type
;
23137 /* Cursor is blinked off, so determine how to "toggle" it. */
23139 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
23140 if ((alt_cursor
= Fassoc (b
->cursor_type
, Vblink_cursor_alist
), !NILP (alt_cursor
)))
23141 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
23143 /* Then see if frame has specified a specific blink off cursor type. */
23144 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
23146 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
23147 return FRAME_BLINK_OFF_CURSOR (f
);
23151 /* Some people liked having a permanently visible blinking cursor,
23152 while others had very strong opinions against it. So it was
23153 decided to remove it. KFS 2003-09-03 */
23155 /* Finally perform built-in cursor blinking:
23156 filled box <-> hollow box
23157 wide [h]bar <-> narrow [h]bar
23158 narrow [h]bar <-> no cursor
23159 other type <-> no cursor */
23161 if (cursor_type
== FILLED_BOX_CURSOR
)
23162 return HOLLOW_BOX_CURSOR
;
23164 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
23167 return cursor_type
;
23175 #ifdef HAVE_WINDOW_SYSTEM
23177 /* Notice when the text cursor of window W has been completely
23178 overwritten by a drawing operation that outputs glyphs in AREA
23179 starting at X0 and ending at X1 in the line starting at Y0 and
23180 ending at Y1. X coordinates are area-relative. X1 < 0 means all
23181 the rest of the line after X0 has been written. Y coordinates
23182 are window-relative. */
23185 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
23186 int x0
, int x1
, int y0
, int y1
)
23188 int cx0
, cx1
, cy0
, cy1
;
23189 struct glyph_row
*row
;
23191 if (!w
->phys_cursor_on_p
)
23193 if (area
!= TEXT_AREA
)
23196 if (w
->phys_cursor
.vpos
< 0
23197 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
23198 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
23199 !(row
->enabled_p
&& row
->displays_text_p
)))
23202 if (row
->cursor_in_fringe_p
)
23204 row
->cursor_in_fringe_p
= 0;
23205 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
23206 w
->phys_cursor_on_p
= 0;
23210 cx0
= w
->phys_cursor
.x
;
23211 cx1
= cx0
+ w
->phys_cursor_width
;
23212 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
23215 /* The cursor image will be completely removed from the
23216 screen if the output area intersects the cursor area in
23217 y-direction. When we draw in [y0 y1[, and some part of
23218 the cursor is at y < y0, that part must have been drawn
23219 before. When scrolling, the cursor is erased before
23220 actually scrolling, so we don't come here. When not
23221 scrolling, the rows above the old cursor row must have
23222 changed, and in this case these rows must have written
23223 over the cursor image.
23225 Likewise if part of the cursor is below y1, with the
23226 exception of the cursor being in the first blank row at
23227 the buffer and window end because update_text_area
23228 doesn't draw that row. (Except when it does, but
23229 that's handled in update_text_area.) */
23231 cy0
= w
->phys_cursor
.y
;
23232 cy1
= cy0
+ w
->phys_cursor_height
;
23233 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
23236 w
->phys_cursor_on_p
= 0;
23239 #endif /* HAVE_WINDOW_SYSTEM */
23242 /************************************************************************
23244 ************************************************************************/
23246 #ifdef HAVE_WINDOW_SYSTEM
23249 Fix the display of area AREA of overlapping row ROW in window W
23250 with respect to the overlapping part OVERLAPS. */
23253 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
23254 enum glyph_row_area area
, int overlaps
)
23261 for (i
= 0; i
< row
->used
[area
];)
23263 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
23265 int start
= i
, start_x
= x
;
23269 x
+= row
->glyphs
[area
][i
].pixel_width
;
23272 while (i
< row
->used
[area
]
23273 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
23275 draw_glyphs (w
, start_x
, row
, area
,
23277 DRAW_NORMAL_TEXT
, overlaps
);
23281 x
+= row
->glyphs
[area
][i
].pixel_width
;
23291 Draw the cursor glyph of window W in glyph row ROW. See the
23292 comment of draw_glyphs for the meaning of HL. */
23295 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
23296 enum draw_glyphs_face hl
)
23298 /* If cursor hpos is out of bounds, don't draw garbage. This can
23299 happen in mini-buffer windows when switching between echo area
23300 glyphs and mini-buffer. */
23301 if ((row
->reversed_p
23302 ? (w
->phys_cursor
.hpos
>= 0)
23303 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
23305 int on_p
= w
->phys_cursor_on_p
;
23307 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
23308 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
23310 w
->phys_cursor_on_p
= on_p
;
23312 if (hl
== DRAW_CURSOR
)
23313 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23314 /* When we erase the cursor, and ROW is overlapped by other
23315 rows, make sure that these overlapping parts of other rows
23317 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
23319 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23321 if (row
> w
->current_matrix
->rows
23322 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
23323 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
23324 OVERLAPS_ERASED_CURSOR
);
23326 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
23327 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
23328 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
23329 OVERLAPS_ERASED_CURSOR
);
23336 Erase the image of a cursor of window W from the screen. */
23339 erase_phys_cursor (struct window
*w
)
23341 struct frame
*f
= XFRAME (w
->frame
);
23342 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
23343 int hpos
= w
->phys_cursor
.hpos
;
23344 int vpos
= w
->phys_cursor
.vpos
;
23345 int mouse_face_here_p
= 0;
23346 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
23347 struct glyph_row
*cursor_row
;
23348 struct glyph
*cursor_glyph
;
23349 enum draw_glyphs_face hl
;
23351 /* No cursor displayed or row invalidated => nothing to do on the
23353 if (w
->phys_cursor_type
== NO_CURSOR
)
23354 goto mark_cursor_off
;
23356 /* VPOS >= active_glyphs->nrows means that window has been resized.
23357 Don't bother to erase the cursor. */
23358 if (vpos
>= active_glyphs
->nrows
)
23359 goto mark_cursor_off
;
23361 /* If row containing cursor is marked invalid, there is nothing we
23363 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
23364 if (!cursor_row
->enabled_p
)
23365 goto mark_cursor_off
;
23367 /* If line spacing is > 0, old cursor may only be partially visible in
23368 window after split-window. So adjust visible height. */
23369 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
23370 window_text_bottom_y (w
) - cursor_row
->y
);
23372 /* If row is completely invisible, don't attempt to delete a cursor which
23373 isn't there. This can happen if cursor is at top of a window, and
23374 we switch to a buffer with a header line in that window. */
23375 if (cursor_row
->visible_height
<= 0)
23376 goto mark_cursor_off
;
23378 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
23379 if (cursor_row
->cursor_in_fringe_p
)
23381 cursor_row
->cursor_in_fringe_p
= 0;
23382 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
23383 goto mark_cursor_off
;
23386 /* This can happen when the new row is shorter than the old one.
23387 In this case, either draw_glyphs or clear_end_of_line
23388 should have cleared the cursor. Note that we wouldn't be
23389 able to erase the cursor in this case because we don't have a
23390 cursor glyph at hand. */
23391 if ((cursor_row
->reversed_p
23392 ? (w
->phys_cursor
.hpos
< 0)
23393 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
23394 goto mark_cursor_off
;
23396 /* If the cursor is in the mouse face area, redisplay that when
23397 we clear the cursor. */
23398 if (! NILP (dpyinfo
->mouse_face_window
)
23399 && w
== XWINDOW (dpyinfo
->mouse_face_window
)
23400 && (vpos
> dpyinfo
->mouse_face_beg_row
23401 || (vpos
== dpyinfo
->mouse_face_beg_row
23402 && hpos
>= dpyinfo
->mouse_face_beg_col
))
23403 && (vpos
< dpyinfo
->mouse_face_end_row
23404 || (vpos
== dpyinfo
->mouse_face_end_row
23405 && hpos
< dpyinfo
->mouse_face_end_col
))
23406 /* Don't redraw the cursor's spot in mouse face if it is at the
23407 end of a line (on a newline). The cursor appears there, but
23408 mouse highlighting does not. */
23409 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
23410 mouse_face_here_p
= 1;
23412 /* Maybe clear the display under the cursor. */
23413 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
23416 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
23419 cursor_glyph
= get_phys_cursor_glyph (w
);
23420 if (cursor_glyph
== NULL
)
23421 goto mark_cursor_off
;
23423 width
= cursor_glyph
->pixel_width
;
23424 left_x
= window_box_left_offset (w
, TEXT_AREA
);
23425 x
= w
->phys_cursor
.x
;
23427 width
-= left_x
- x
;
23428 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
23429 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
23430 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
23433 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
23436 /* Erase the cursor by redrawing the character underneath it. */
23437 if (mouse_face_here_p
)
23438 hl
= DRAW_MOUSE_FACE
;
23440 hl
= DRAW_NORMAL_TEXT
;
23441 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
23444 w
->phys_cursor_on_p
= 0;
23445 w
->phys_cursor_type
= NO_CURSOR
;
23450 Display or clear cursor of window W. If ON is zero, clear the
23451 cursor. If it is non-zero, display the cursor. If ON is nonzero,
23452 where to put the cursor is specified by HPOS, VPOS, X and Y. */
23455 display_and_set_cursor (struct window
*w
, int on
,
23456 int hpos
, int vpos
, int x
, int y
)
23458 struct frame
*f
= XFRAME (w
->frame
);
23459 int new_cursor_type
;
23460 int new_cursor_width
;
23462 struct glyph_row
*glyph_row
;
23463 struct glyph
*glyph
;
23465 /* This is pointless on invisible frames, and dangerous on garbaged
23466 windows and frames; in the latter case, the frame or window may
23467 be in the midst of changing its size, and x and y may be off the
23469 if (! FRAME_VISIBLE_P (f
)
23470 || FRAME_GARBAGED_P (f
)
23471 || vpos
>= w
->current_matrix
->nrows
23472 || hpos
>= w
->current_matrix
->matrix_w
)
23475 /* If cursor is off and we want it off, return quickly. */
23476 if (!on
&& !w
->phys_cursor_on_p
)
23479 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
23480 /* If cursor row is not enabled, we don't really know where to
23481 display the cursor. */
23482 if (!glyph_row
->enabled_p
)
23484 w
->phys_cursor_on_p
= 0;
23489 if (!glyph_row
->exact_window_width_line_p
23490 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
23491 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
23493 xassert (interrupt_input_blocked
);
23495 /* Set new_cursor_type to the cursor we want to be displayed. */
23496 new_cursor_type
= get_window_cursor_type (w
, glyph
,
23497 &new_cursor_width
, &active_cursor
);
23499 /* If cursor is currently being shown and we don't want it to be or
23500 it is in the wrong place, or the cursor type is not what we want,
23502 if (w
->phys_cursor_on_p
23504 || w
->phys_cursor
.x
!= x
23505 || w
->phys_cursor
.y
!= y
23506 || new_cursor_type
!= w
->phys_cursor_type
23507 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
23508 && new_cursor_width
!= w
->phys_cursor_width
)))
23509 erase_phys_cursor (w
);
23511 /* Don't check phys_cursor_on_p here because that flag is only set
23512 to zero in some cases where we know that the cursor has been
23513 completely erased, to avoid the extra work of erasing the cursor
23514 twice. In other words, phys_cursor_on_p can be 1 and the cursor
23515 still not be visible, or it has only been partly erased. */
23518 w
->phys_cursor_ascent
= glyph_row
->ascent
;
23519 w
->phys_cursor_height
= glyph_row
->height
;
23521 /* Set phys_cursor_.* before x_draw_.* is called because some
23522 of them may need the information. */
23523 w
->phys_cursor
.x
= x
;
23524 w
->phys_cursor
.y
= glyph_row
->y
;
23525 w
->phys_cursor
.hpos
= hpos
;
23526 w
->phys_cursor
.vpos
= vpos
;
23529 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
23530 new_cursor_type
, new_cursor_width
,
23531 on
, active_cursor
);
23535 /* Switch the display of W's cursor on or off, according to the value
23539 update_window_cursor (struct window
*w
, int on
)
23541 /* Don't update cursor in windows whose frame is in the process
23542 of being deleted. */
23543 if (w
->current_matrix
)
23546 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
23547 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
23553 /* Call update_window_cursor with parameter ON_P on all leaf windows
23554 in the window tree rooted at W. */
23557 update_cursor_in_window_tree (struct window
*w
, int on_p
)
23561 if (!NILP (w
->hchild
))
23562 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
23563 else if (!NILP (w
->vchild
))
23564 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
23566 update_window_cursor (w
, on_p
);
23568 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
23574 Display the cursor on window W, or clear it, according to ON_P.
23575 Don't change the cursor's position. */
23578 x_update_cursor (struct frame
*f
, int on_p
)
23580 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
23585 Clear the cursor of window W to background color, and mark the
23586 cursor as not shown. This is used when the text where the cursor
23587 is about to be rewritten. */
23590 x_clear_cursor (struct window
*w
)
23592 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
23593 update_window_cursor (w
, 0);
23598 Display the active region described by mouse_face_* according to DRAW. */
23601 show_mouse_face (Display_Info
*dpyinfo
, enum draw_glyphs_face draw
)
23603 struct window
*w
= XWINDOW (dpyinfo
->mouse_face_window
);
23604 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23606 if (/* If window is in the process of being destroyed, don't bother
23608 w
->current_matrix
!= NULL
23609 /* Don't update mouse highlight if hidden */
23610 && (draw
!= DRAW_MOUSE_FACE
|| !dpyinfo
->mouse_face_hidden
)
23611 /* Recognize when we are called to operate on rows that don't exist
23612 anymore. This can happen when a window is split. */
23613 && dpyinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
23615 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
23616 struct glyph_row
*row
, *first
, *last
;
23618 first
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
23619 last
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
23621 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
23623 int start_hpos
, end_hpos
, start_x
;
23625 /* For all but the first row, the highlight starts at column 0. */
23628 start_hpos
= dpyinfo
->mouse_face_beg_col
;
23629 start_x
= dpyinfo
->mouse_face_beg_x
;
23638 end_hpos
= dpyinfo
->mouse_face_end_col
;
23641 end_hpos
= row
->used
[TEXT_AREA
];
23642 if (draw
== DRAW_NORMAL_TEXT
)
23643 row
->fill_line_p
= 1; /* Clear to end of line */
23646 if (end_hpos
> start_hpos
)
23648 draw_glyphs (w
, start_x
, row
, TEXT_AREA
,
23649 start_hpos
, end_hpos
,
23653 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
23657 /* When we've written over the cursor, arrange for it to
23658 be displayed again. */
23659 if (phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
23662 display_and_set_cursor (w
, 1,
23663 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
23664 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
23669 /* Change the mouse cursor. */
23670 if (draw
== DRAW_NORMAL_TEXT
&& !EQ (dpyinfo
->mouse_face_window
, f
->tool_bar_window
))
23671 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
23672 else if (draw
== DRAW_MOUSE_FACE
)
23673 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
23675 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
23679 Clear out the mouse-highlighted active region.
23680 Redraw it un-highlighted first. Value is non-zero if mouse
23681 face was actually drawn unhighlighted. */
23684 clear_mouse_face (Display_Info
*dpyinfo
)
23688 if (!dpyinfo
->mouse_face_hidden
&& !NILP (dpyinfo
->mouse_face_window
))
23690 show_mouse_face (dpyinfo
, DRAW_NORMAL_TEXT
);
23694 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
23695 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
23696 dpyinfo
->mouse_face_window
= Qnil
;
23697 dpyinfo
->mouse_face_overlay
= Qnil
;
23703 Non-zero if physical cursor of window W is within mouse face. */
23706 cursor_in_mouse_face_p (struct window
*w
)
23708 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
23709 int in_mouse_face
= 0;
23711 if (WINDOWP (dpyinfo
->mouse_face_window
)
23712 && XWINDOW (dpyinfo
->mouse_face_window
) == w
)
23714 int hpos
= w
->phys_cursor
.hpos
;
23715 int vpos
= w
->phys_cursor
.vpos
;
23717 if (vpos
>= dpyinfo
->mouse_face_beg_row
23718 && vpos
<= dpyinfo
->mouse_face_end_row
23719 && (vpos
> dpyinfo
->mouse_face_beg_row
23720 || hpos
>= dpyinfo
->mouse_face_beg_col
)
23721 && (vpos
< dpyinfo
->mouse_face_end_row
23722 || hpos
< dpyinfo
->mouse_face_end_col
23723 || dpyinfo
->mouse_face_past_end
))
23727 return in_mouse_face
;
23733 /* This function sets the mouse_face_* elements of DPYINFO, assuming
23734 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
23735 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
23736 for the overlay or run of text properties specifying the mouse
23737 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
23738 before-string and after-string that must also be highlighted.
23739 DISPLAY_STRING, if non-nil, is a display string that may cover some
23740 or all of the highlighted text. */
23743 mouse_face_from_buffer_pos (Lisp_Object window
,
23744 Display_Info
*dpyinfo
,
23745 EMACS_INT mouse_charpos
,
23746 EMACS_INT start_charpos
,
23747 EMACS_INT end_charpos
,
23748 Lisp_Object before_string
,
23749 Lisp_Object after_string
,
23750 Lisp_Object display_string
)
23752 struct window
*w
= XWINDOW (window
);
23753 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
23754 struct glyph_row
*row
;
23755 struct glyph
*glyph
, *end
;
23759 xassert (NILP (display_string
) || STRINGP (display_string
));
23760 xassert (NILP (before_string
) || STRINGP (before_string
));
23761 xassert (NILP (after_string
) || STRINGP (after_string
));
23763 /* Find the first highlighted glyph. */
23764 if (start_charpos
< MATRIX_ROW_START_CHARPOS (first
))
23766 dpyinfo
->mouse_face_beg_col
= 0;
23767 dpyinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (first
, w
->current_matrix
);
23768 dpyinfo
->mouse_face_beg_x
= first
->x
;
23769 dpyinfo
->mouse_face_beg_y
= first
->y
;
23773 row
= row_containing_pos (w
, start_charpos
, first
, NULL
, 0);
23775 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
23777 /* If the before-string or display-string contains newlines,
23778 row_containing_pos skips to its last row. Move back. */
23779 if (!NILP (before_string
) || !NILP (display_string
))
23781 struct glyph_row
*prev
;
23782 while ((prev
= row
- 1, prev
>= first
)
23783 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
23784 && prev
->used
[TEXT_AREA
] > 0)
23786 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
23787 glyph
= beg
+ prev
->used
[TEXT_AREA
];
23788 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
23790 || !(EQ (glyph
->object
, before_string
)
23791 || EQ (glyph
->object
, display_string
)))
23797 glyph
= row
->glyphs
[TEXT_AREA
];
23798 end
= glyph
+ row
->used
[TEXT_AREA
];
23800 dpyinfo
->mouse_face_beg_y
= row
->y
;
23801 dpyinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
23803 /* Skip truncation glyphs at the start of the glyph row. */
23804 if (row
->displays_text_p
)
23806 && INTEGERP (glyph
->object
)
23807 && glyph
->charpos
< 0;
23809 x
+= glyph
->pixel_width
;
23811 /* Scan the glyph row, stopping before BEFORE_STRING or
23812 DISPLAY_STRING or START_CHARPOS. */
23814 && !INTEGERP (glyph
->object
)
23815 && !EQ (glyph
->object
, before_string
)
23816 && !EQ (glyph
->object
, display_string
)
23817 && !(BUFFERP (glyph
->object
)
23818 && glyph
->charpos
>= start_charpos
);
23820 x
+= glyph
->pixel_width
;
23822 dpyinfo
->mouse_face_beg_x
= x
;
23823 dpyinfo
->mouse_face_beg_col
= glyph
- row
->glyphs
[TEXT_AREA
];
23826 /* Find the last highlighted glyph. */
23827 row
= row_containing_pos (w
, end_charpos
, first
, NULL
, 0);
23830 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
23831 dpyinfo
->mouse_face_past_end
= 1;
23833 else if (!NILP (after_string
))
23835 /* If the after-string has newlines, advance to its last row. */
23836 struct glyph_row
*next
;
23837 struct glyph_row
*last
23838 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
23840 for (next
= row
+ 1;
23842 && next
->used
[TEXT_AREA
] > 0
23843 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
23848 glyph
= row
->glyphs
[TEXT_AREA
];
23849 end
= glyph
+ row
->used
[TEXT_AREA
];
23851 dpyinfo
->mouse_face_end_y
= row
->y
;
23852 dpyinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
23854 /* Skip truncation glyphs at the start of the row. */
23855 if (row
->displays_text_p
)
23857 && INTEGERP (glyph
->object
)
23858 && glyph
->charpos
< 0;
23860 x
+= glyph
->pixel_width
;
23862 /* Scan the glyph row, stopping at END_CHARPOS or when we encounter
23865 && !INTEGERP (glyph
->object
)
23866 && !EQ (glyph
->object
, after_string
)
23867 && !(BUFFERP (glyph
->object
) && glyph
->charpos
>= end_charpos
);
23869 x
+= glyph
->pixel_width
;
23871 /* If we found AFTER_STRING, consume it and stop. */
23872 if (EQ (glyph
->object
, after_string
))
23874 for (; EQ (glyph
->object
, after_string
) && glyph
< end
; ++glyph
)
23875 x
+= glyph
->pixel_width
;
23879 /* If there's no after-string, we must check if we overshot,
23880 which might be the case if we stopped after a string glyph.
23881 That glyph may belong to a before-string or display-string
23882 associated with the end position, which must not be
23884 Lisp_Object prev_object
;
23887 while (glyph
> row
->glyphs
[TEXT_AREA
])
23889 prev_object
= (glyph
- 1)->object
;
23890 if (!STRINGP (prev_object
) || EQ (prev_object
, display_string
))
23893 pos
= string_buffer_position (w
, prev_object
, end_charpos
);
23894 if (pos
&& pos
< end_charpos
)
23897 for (; glyph
> row
->glyphs
[TEXT_AREA
]
23898 && EQ ((glyph
- 1)->object
, prev_object
);
23900 x
-= (glyph
- 1)->pixel_width
;
23904 dpyinfo
->mouse_face_end_x
= x
;
23905 dpyinfo
->mouse_face_end_col
= glyph
- row
->glyphs
[TEXT_AREA
];
23906 dpyinfo
->mouse_face_window
= window
;
23907 dpyinfo
->mouse_face_face_id
23908 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
23910 !dpyinfo
->mouse_face_hidden
, -1);
23911 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23915 /* Find the position of the glyph for position POS in OBJECT in
23916 window W's current matrix, and return in *X, *Y the pixel
23917 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
23919 RIGHT_P non-zero means return the position of the right edge of the
23920 glyph, RIGHT_P zero means return the left edge position.
23922 If no glyph for POS exists in the matrix, return the position of
23923 the glyph with the next smaller position that is in the matrix, if
23924 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
23925 exists in the matrix, return the position of the glyph with the
23926 next larger position in OBJECT.
23928 Value is non-zero if a glyph was found. */
23931 fast_find_string_pos (struct window
*w
, EMACS_INT pos
, Lisp_Object object
,
23932 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
23934 int yb
= window_text_bottom_y (w
);
23935 struct glyph_row
*r
;
23936 struct glyph
*best_glyph
= NULL
;
23937 struct glyph_row
*best_row
= NULL
;
23940 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
23941 r
->enabled_p
&& r
->y
< yb
;
23944 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
23945 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
23948 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
23949 if (EQ (g
->object
, object
))
23951 if (g
->charpos
== pos
)
23958 else if (best_glyph
== NULL
23959 || ((eabs (g
->charpos
- pos
)
23960 < eabs (best_glyph
->charpos
- pos
))
23963 : g
->charpos
> pos
)))
23977 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
23981 *x
+= best_glyph
->pixel_width
;
23986 *vpos
= best_row
- w
->current_matrix
->rows
;
23989 return best_glyph
!= NULL
;
23993 /* See if position X, Y is within a hot-spot of an image. */
23996 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
23998 if (!CONSP (hot_spot
))
24001 if (EQ (XCAR (hot_spot
), Qrect
))
24003 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
24004 Lisp_Object rect
= XCDR (hot_spot
);
24008 if (!CONSP (XCAR (rect
)))
24010 if (!CONSP (XCDR (rect
)))
24012 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
24014 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
24016 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
24018 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
24022 else if (EQ (XCAR (hot_spot
), Qcircle
))
24024 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
24025 Lisp_Object circ
= XCDR (hot_spot
);
24026 Lisp_Object lr
, lx0
, ly0
;
24028 && CONSP (XCAR (circ
))
24029 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
24030 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
24031 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
24033 double r
= XFLOATINT (lr
);
24034 double dx
= XINT (lx0
) - x
;
24035 double dy
= XINT (ly0
) - y
;
24036 return (dx
* dx
+ dy
* dy
<= r
* r
);
24039 else if (EQ (XCAR (hot_spot
), Qpoly
))
24041 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
24042 if (VECTORP (XCDR (hot_spot
)))
24044 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
24045 Lisp_Object
*poly
= v
->contents
;
24049 Lisp_Object lx
, ly
;
24052 /* Need an even number of coordinates, and at least 3 edges. */
24053 if (n
< 6 || n
& 1)
24056 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
24057 If count is odd, we are inside polygon. Pixels on edges
24058 may or may not be included depending on actual geometry of the
24060 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
24061 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
24063 x0
= XINT (lx
), y0
= XINT (ly
);
24064 for (i
= 0; i
< n
; i
+= 2)
24066 int x1
= x0
, y1
= y0
;
24067 if ((lx
= poly
[i
], !INTEGERP (lx
))
24068 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
24070 x0
= XINT (lx
), y0
= XINT (ly
);
24072 /* Does this segment cross the X line? */
24080 if (y
> y0
&& y
> y1
)
24082 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
24092 find_hot_spot (Lisp_Object map
, int x
, int y
)
24094 while (CONSP (map
))
24096 if (CONSP (XCAR (map
))
24097 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
24105 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
24107 doc
: /* Lookup in image map MAP coordinates X and Y.
24108 An image map is an alist where each element has the format (AREA ID PLIST).
24109 An AREA is specified as either a rectangle, a circle, or a polygon:
24110 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
24111 pixel coordinates of the upper left and bottom right corners.
24112 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
24113 and the radius of the circle; r may be a float or integer.
24114 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
24115 vector describes one corner in the polygon.
24116 Returns the alist element for the first matching AREA in MAP. */)
24117 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
24125 return find_hot_spot (map
, XINT (x
), XINT (y
));
24129 /* Display frame CURSOR, optionally using shape defined by POINTER. */
24131 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
24133 /* Do not change cursor shape while dragging mouse. */
24134 if (!NILP (do_mouse_tracking
))
24137 if (!NILP (pointer
))
24139 if (EQ (pointer
, Qarrow
))
24140 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24141 else if (EQ (pointer
, Qhand
))
24142 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
24143 else if (EQ (pointer
, Qtext
))
24144 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
24145 else if (EQ (pointer
, intern ("hdrag")))
24146 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
24147 #ifdef HAVE_X_WINDOWS
24148 else if (EQ (pointer
, intern ("vdrag")))
24149 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
24151 else if (EQ (pointer
, intern ("hourglass")))
24152 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
24153 else if (EQ (pointer
, Qmodeline
))
24154 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
24156 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24159 if (cursor
!= No_Cursor
)
24160 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
24163 /* Take proper action when mouse has moved to the mode or header line
24164 or marginal area AREA of window W, x-position X and y-position Y.
24165 X is relative to the start of the text display area of W, so the
24166 width of bitmap areas and scroll bars must be subtracted to get a
24167 position relative to the start of the mode line. */
24170 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
24171 enum window_part area
)
24173 struct window
*w
= XWINDOW (window
);
24174 struct frame
*f
= XFRAME (w
->frame
);
24175 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24176 Cursor cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24177 Lisp_Object pointer
= Qnil
;
24178 int dx
, dy
, width
, height
;
24180 Lisp_Object string
, object
= Qnil
;
24181 Lisp_Object pos
, help
;
24183 Lisp_Object mouse_face
;
24184 int original_x_pixel
= x
;
24185 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
24186 struct glyph_row
*row
;
24188 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
24193 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
24194 &object
, &dx
, &dy
, &width
, &height
);
24196 row
= (area
== ON_MODE_LINE
24197 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
24198 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
24201 if (row
->mode_line_p
&& row
->enabled_p
)
24203 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
24204 end
= glyph
+ row
->used
[TEXT_AREA
];
24206 for (x0
= original_x_pixel
;
24207 glyph
< end
&& x0
>= glyph
->pixel_width
;
24209 x0
-= glyph
->pixel_width
;
24217 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
24218 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
24219 &object
, &dx
, &dy
, &width
, &height
);
24224 if (IMAGEP (object
))
24226 Lisp_Object image_map
, hotspot
;
24227 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
24229 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
24231 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
24233 Lisp_Object area_id
, plist
;
24235 area_id
= XCAR (hotspot
);
24236 /* Could check AREA_ID to see if we enter/leave this hot-spot.
24237 If so, we could look for mouse-enter, mouse-leave
24238 properties in PLIST (and do something...). */
24239 hotspot
= XCDR (hotspot
);
24240 if (CONSP (hotspot
)
24241 && (plist
= XCAR (hotspot
), CONSP (plist
)))
24243 pointer
= Fplist_get (plist
, Qpointer
);
24244 if (NILP (pointer
))
24246 help
= Fplist_get (plist
, Qhelp_echo
);
24249 help_echo_string
= help
;
24250 /* Is this correct? ++kfs */
24251 XSETWINDOW (help_echo_window
, w
);
24252 help_echo_object
= w
->buffer
;
24253 help_echo_pos
= charpos
;
24257 if (NILP (pointer
))
24258 pointer
= Fplist_get (XCDR (object
), QCpointer
);
24261 if (STRINGP (string
))
24263 pos
= make_number (charpos
);
24264 /* If we're on a string with `help-echo' text property, arrange
24265 for the help to be displayed. This is done by setting the
24266 global variable help_echo_string to the help string. */
24269 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
24272 help_echo_string
= help
;
24273 XSETWINDOW (help_echo_window
, w
);
24274 help_echo_object
= string
;
24275 help_echo_pos
= charpos
;
24279 if (NILP (pointer
))
24280 pointer
= Fget_text_property (pos
, Qpointer
, string
);
24282 /* Change the mouse pointer according to what is under X/Y. */
24283 if (NILP (pointer
) && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
24286 map
= Fget_text_property (pos
, Qlocal_map
, string
);
24287 if (!KEYMAPP (map
))
24288 map
= Fget_text_property (pos
, Qkeymap
, string
);
24289 if (!KEYMAPP (map
))
24290 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
24293 /* Change the mouse face according to what is under X/Y. */
24294 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
24295 if (!NILP (mouse_face
)
24296 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
24301 struct glyph
* tmp_glyph
;
24305 int total_pixel_width
;
24310 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
24311 Qmouse_face
, string
, Qnil
);
24313 b
= make_number (0);
24315 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
24317 e
= make_number (SCHARS (string
));
24319 /* Calculate the position(glyph position: GPOS) of GLYPH in
24320 displayed string. GPOS is different from CHARPOS.
24322 CHARPOS is the position of glyph in internal string
24323 object. A mode line string format has structures which
24324 is converted to a flatten by emacs lisp interpreter.
24325 The internal string is an element of the structures.
24326 The displayed string is the flatten string. */
24328 if (glyph
> row_start_glyph
)
24330 tmp_glyph
= glyph
- 1;
24331 while (tmp_glyph
>= row_start_glyph
24332 && tmp_glyph
->charpos
>= XINT (b
)
24333 && EQ (tmp_glyph
->object
, glyph
->object
))
24340 /* Calculate the lenght(glyph sequence length: GSEQ_LENGTH) of
24341 displayed string holding GLYPH.
24343 GSEQ_LENGTH is different from SCHARS (STRING).
24344 SCHARS (STRING) returns the length of the internal string. */
24345 for (tmp_glyph
= glyph
, gseq_length
= gpos
;
24346 tmp_glyph
->charpos
< XINT (e
);
24347 tmp_glyph
++, gseq_length
++)
24349 if (!EQ (tmp_glyph
->object
, glyph
->object
))
24353 total_pixel_width
= 0;
24354 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
24355 total_pixel_width
+= tmp_glyph
->pixel_width
;
24357 /* Pre calculation of re-rendering position */
24359 hpos
= (area
== ON_MODE_LINE
24360 ? (w
->current_matrix
)->nrows
- 1
24363 /* If the re-rendering position is included in the last
24364 re-rendering area, we should do nothing. */
24365 if ( EQ (window
, dpyinfo
->mouse_face_window
)
24366 && dpyinfo
->mouse_face_beg_col
<= vpos
24367 && vpos
< dpyinfo
->mouse_face_end_col
24368 && dpyinfo
->mouse_face_beg_row
== hpos
)
24371 if (clear_mouse_face (dpyinfo
))
24372 cursor
= No_Cursor
;
24374 dpyinfo
->mouse_face_beg_col
= vpos
;
24375 dpyinfo
->mouse_face_beg_row
= hpos
;
24377 dpyinfo
->mouse_face_beg_x
= original_x_pixel
- (total_pixel_width
+ dx
);
24378 dpyinfo
->mouse_face_beg_y
= 0;
24380 dpyinfo
->mouse_face_end_col
= vpos
+ gseq_length
;
24381 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_beg_row
;
24383 dpyinfo
->mouse_face_end_x
= 0;
24384 dpyinfo
->mouse_face_end_y
= 0;
24386 dpyinfo
->mouse_face_past_end
= 0;
24387 dpyinfo
->mouse_face_window
= window
;
24389 dpyinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
24392 glyph
->face_id
, 1);
24393 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
24395 if (NILP (pointer
))
24398 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
24399 clear_mouse_face (dpyinfo
);
24401 define_frame_cursor1 (f
, cursor
, pointer
);
24406 Take proper action when the mouse has moved to position X, Y on
24407 frame F as regards highlighting characters that have mouse-face
24408 properties. Also de-highlighting chars where the mouse was before.
24409 X and Y can be negative or out of range. */
24412 note_mouse_highlight (struct frame
*f
, int x
, int y
)
24414 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24415 enum window_part part
;
24416 Lisp_Object window
;
24418 Cursor cursor
= No_Cursor
;
24419 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
24422 /* When a menu is active, don't highlight because this looks odd. */
24423 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
24424 if (popup_activated ())
24428 if (NILP (Vmouse_highlight
)
24429 || !f
->glyphs_initialized_p
24430 || f
->pointer_invisible
)
24433 dpyinfo
->mouse_face_mouse_x
= x
;
24434 dpyinfo
->mouse_face_mouse_y
= y
;
24435 dpyinfo
->mouse_face_mouse_frame
= f
;
24437 if (dpyinfo
->mouse_face_defer
)
24440 if (gc_in_progress
)
24442 dpyinfo
->mouse_face_deferred_gc
= 1;
24446 /* Which window is that in? */
24447 window
= window_from_coordinates (f
, x
, y
, &part
, 0, 0, 1);
24449 /* If we were displaying active text in another window, clear that.
24450 Also clear if we move out of text area in same window. */
24451 if (! EQ (window
, dpyinfo
->mouse_face_window
)
24452 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
24453 && !NILP (dpyinfo
->mouse_face_window
)))
24454 clear_mouse_face (dpyinfo
);
24456 /* Not on a window -> return. */
24457 if (!WINDOWP (window
))
24460 /* Reset help_echo_string. It will get recomputed below. */
24461 help_echo_string
= Qnil
;
24463 /* Convert to window-relative pixel coordinates. */
24464 w
= XWINDOW (window
);
24465 frame_to_window_pixel_xy (w
, &x
, &y
);
24467 /* Handle tool-bar window differently since it doesn't display a
24469 if (EQ (window
, f
->tool_bar_window
))
24471 note_tool_bar_highlight (f
, x
, y
);
24475 /* Mouse is on the mode, header line or margin? */
24476 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
24477 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
24479 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
24483 if (part
== ON_VERTICAL_BORDER
)
24485 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
24486 help_echo_string
= build_string ("drag-mouse-1: resize");
24488 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
24489 || part
== ON_SCROLL_BAR
)
24490 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24492 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
24494 /* Are we in a window whose display is up to date?
24495 And verify the buffer's text has not changed. */
24496 b
= XBUFFER (w
->buffer
);
24497 if (part
== ON_TEXT
24498 && EQ (w
->window_end_valid
, w
->buffer
)
24499 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
24500 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
24502 int hpos
, vpos
, i
, dx
, dy
, area
;
24504 struct glyph
*glyph
;
24505 Lisp_Object object
;
24506 Lisp_Object mouse_face
= Qnil
, overlay
= Qnil
, position
;
24507 Lisp_Object
*overlay_vec
= NULL
;
24509 struct buffer
*obuf
;
24510 EMACS_INT obegv
, ozv
;
24513 /* Find the glyph under X/Y. */
24514 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
24516 /* Look for :pointer property on image. */
24517 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
24519 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
24520 if (img
!= NULL
&& IMAGEP (img
->spec
))
24522 Lisp_Object image_map
, hotspot
;
24523 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
24525 && (hotspot
= find_hot_spot (image_map
,
24526 glyph
->slice
.img
.x
+ dx
,
24527 glyph
->slice
.img
.y
+ dy
),
24529 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
24531 Lisp_Object area_id
, plist
;
24533 area_id
= XCAR (hotspot
);
24534 /* Could check AREA_ID to see if we enter/leave this hot-spot.
24535 If so, we could look for mouse-enter, mouse-leave
24536 properties in PLIST (and do something...). */
24537 hotspot
= XCDR (hotspot
);
24538 if (CONSP (hotspot
)
24539 && (plist
= XCAR (hotspot
), CONSP (plist
)))
24541 pointer
= Fplist_get (plist
, Qpointer
);
24542 if (NILP (pointer
))
24544 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
24545 if (!NILP (help_echo_string
))
24547 help_echo_window
= window
;
24548 help_echo_object
= glyph
->object
;
24549 help_echo_pos
= glyph
->charpos
;
24553 if (NILP (pointer
))
24554 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
24558 /* Clear mouse face if X/Y not over text. */
24560 || area
!= TEXT_AREA
24561 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
)
24563 if (clear_mouse_face (dpyinfo
))
24564 cursor
= No_Cursor
;
24565 if (NILP (pointer
))
24567 if (area
!= TEXT_AREA
)
24568 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24570 pointer
= Vvoid_text_area_pointer
;
24575 pos
= glyph
->charpos
;
24576 object
= glyph
->object
;
24577 if (!STRINGP (object
) && !BUFFERP (object
))
24580 /* If we get an out-of-range value, return now; avoid an error. */
24581 if (BUFFERP (object
) && pos
> BUF_Z (b
))
24584 /* Make the window's buffer temporarily current for
24585 overlays_at and compute_char_face. */
24586 obuf
= current_buffer
;
24587 current_buffer
= b
;
24593 /* Is this char mouse-active or does it have help-echo? */
24594 position
= make_number (pos
);
24596 if (BUFFERP (object
))
24598 /* Put all the overlays we want in a vector in overlay_vec. */
24599 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
24600 /* Sort overlays into increasing priority order. */
24601 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
24606 same_region
= (EQ (window
, dpyinfo
->mouse_face_window
)
24607 && vpos
>= dpyinfo
->mouse_face_beg_row
24608 && vpos
<= dpyinfo
->mouse_face_end_row
24609 && (vpos
> dpyinfo
->mouse_face_beg_row
24610 || hpos
>= dpyinfo
->mouse_face_beg_col
)
24611 && (vpos
< dpyinfo
->mouse_face_end_row
24612 || hpos
< dpyinfo
->mouse_face_end_col
24613 || dpyinfo
->mouse_face_past_end
));
24616 cursor
= No_Cursor
;
24618 /* Check mouse-face highlighting. */
24620 /* If there exists an overlay with mouse-face overlapping
24621 the one we are currently highlighting, we have to
24622 check if we enter the overlapping overlay, and then
24623 highlight only that. */
24624 || (OVERLAYP (dpyinfo
->mouse_face_overlay
)
24625 && mouse_face_overlay_overlaps (dpyinfo
->mouse_face_overlay
)))
24627 /* Find the highest priority overlay with a mouse-face. */
24629 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
24631 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
24632 if (!NILP (mouse_face
))
24633 overlay
= overlay_vec
[i
];
24636 /* If we're highlighting the same overlay as before, there's
24637 no need to do that again. */
24638 if (!NILP (overlay
) && EQ (overlay
, dpyinfo
->mouse_face_overlay
))
24639 goto check_help_echo
;
24640 dpyinfo
->mouse_face_overlay
= overlay
;
24642 /* Clear the display of the old active region, if any. */
24643 if (clear_mouse_face (dpyinfo
))
24644 cursor
= No_Cursor
;
24646 /* If no overlay applies, get a text property. */
24647 if (NILP (overlay
))
24648 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
24650 /* Next, compute the bounds of the mouse highlighting and
24652 if (!NILP (mouse_face
) && STRINGP (object
))
24654 /* The mouse-highlighting comes from a display string
24655 with a mouse-face. */
24659 b
= Fprevious_single_property_change
24660 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
24661 e
= Fnext_single_property_change
24662 (position
, Qmouse_face
, object
, Qnil
);
24664 b
= make_number (0);
24666 e
= make_number (SCHARS (object
) - 1);
24668 fast_find_string_pos (w
, XINT (b
), object
,
24669 &dpyinfo
->mouse_face_beg_col
,
24670 &dpyinfo
->mouse_face_beg_row
,
24671 &dpyinfo
->mouse_face_beg_x
,
24672 &dpyinfo
->mouse_face_beg_y
, 0);
24673 fast_find_string_pos (w
, XINT (e
), object
,
24674 &dpyinfo
->mouse_face_end_col
,
24675 &dpyinfo
->mouse_face_end_row
,
24676 &dpyinfo
->mouse_face_end_x
,
24677 &dpyinfo
->mouse_face_end_y
, 1);
24678 dpyinfo
->mouse_face_past_end
= 0;
24679 dpyinfo
->mouse_face_window
= window
;
24680 dpyinfo
->mouse_face_face_id
24681 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
24682 glyph
->face_id
, 1);
24683 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
24684 cursor
= No_Cursor
;
24688 /* The mouse-highlighting, if any, comes from an overlay
24689 or text property in the buffer. */
24690 Lisp_Object buffer
, display_string
;
24692 if (STRINGP (object
))
24694 /* If we are on a display string with no mouse-face,
24695 check if the text under it has one. */
24696 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
24697 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
24698 pos
= string_buffer_position (w
, object
, start
);
24701 mouse_face
= get_char_property_and_overlay
24702 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
24703 buffer
= w
->buffer
;
24704 display_string
= object
;
24710 display_string
= Qnil
;
24713 if (!NILP (mouse_face
))
24715 Lisp_Object before
, after
;
24716 Lisp_Object before_string
, after_string
;
24718 if (NILP (overlay
))
24720 /* Handle the text property case. */
24721 before
= Fprevious_single_property_change
24722 (make_number (pos
+ 1), Qmouse_face
, buffer
,
24723 Fmarker_position (w
->start
));
24724 after
= Fnext_single_property_change
24725 (make_number (pos
), Qmouse_face
, buffer
,
24726 make_number (BUF_Z (XBUFFER (buffer
))
24727 - XFASTINT (w
->window_end_pos
)));
24728 before_string
= after_string
= Qnil
;
24732 /* Handle the overlay case. */
24733 before
= Foverlay_start (overlay
);
24734 after
= Foverlay_end (overlay
);
24735 before_string
= Foverlay_get (overlay
, Qbefore_string
);
24736 after_string
= Foverlay_get (overlay
, Qafter_string
);
24738 if (!STRINGP (before_string
)) before_string
= Qnil
;
24739 if (!STRINGP (after_string
)) after_string
= Qnil
;
24742 mouse_face_from_buffer_pos (window
, dpyinfo
, pos
,
24745 before_string
, after_string
,
24747 cursor
= No_Cursor
;
24754 /* Look for a `help-echo' property. */
24755 if (NILP (help_echo_string
)) {
24756 Lisp_Object help
, overlay
;
24758 /* Check overlays first. */
24759 help
= overlay
= Qnil
;
24760 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
24762 overlay
= overlay_vec
[i
];
24763 help
= Foverlay_get (overlay
, Qhelp_echo
);
24768 help_echo_string
= help
;
24769 help_echo_window
= window
;
24770 help_echo_object
= overlay
;
24771 help_echo_pos
= pos
;
24775 Lisp_Object object
= glyph
->object
;
24776 EMACS_INT charpos
= glyph
->charpos
;
24778 /* Try text properties. */
24779 if (STRINGP (object
)
24781 && charpos
< SCHARS (object
))
24783 help
= Fget_text_property (make_number (charpos
),
24784 Qhelp_echo
, object
);
24787 /* If the string itself doesn't specify a help-echo,
24788 see if the buffer text ``under'' it does. */
24789 struct glyph_row
*r
24790 = MATRIX_ROW (w
->current_matrix
, vpos
);
24791 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
24792 EMACS_INT pos
= string_buffer_position (w
, object
, start
);
24795 help
= Fget_char_property (make_number (pos
),
24796 Qhelp_echo
, w
->buffer
);
24800 object
= w
->buffer
;
24805 else if (BUFFERP (object
)
24808 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
24813 help_echo_string
= help
;
24814 help_echo_window
= window
;
24815 help_echo_object
= object
;
24816 help_echo_pos
= charpos
;
24821 /* Look for a `pointer' property. */
24822 if (NILP (pointer
))
24824 /* Check overlays first. */
24825 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
24826 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
24828 if (NILP (pointer
))
24830 Lisp_Object object
= glyph
->object
;
24831 EMACS_INT charpos
= glyph
->charpos
;
24833 /* Try text properties. */
24834 if (STRINGP (object
)
24836 && charpos
< SCHARS (object
))
24838 pointer
= Fget_text_property (make_number (charpos
),
24840 if (NILP (pointer
))
24842 /* If the string itself doesn't specify a pointer,
24843 see if the buffer text ``under'' it does. */
24844 struct glyph_row
*r
24845 = MATRIX_ROW (w
->current_matrix
, vpos
);
24846 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
24847 EMACS_INT pos
= string_buffer_position (w
, object
,
24850 pointer
= Fget_char_property (make_number (pos
),
24851 Qpointer
, w
->buffer
);
24854 else if (BUFFERP (object
)
24857 pointer
= Fget_text_property (make_number (charpos
),
24864 current_buffer
= obuf
;
24869 define_frame_cursor1 (f
, cursor
, pointer
);
24874 Clear any mouse-face on window W. This function is part of the
24875 redisplay interface, and is called from try_window_id and similar
24876 functions to ensure the mouse-highlight is off. */
24879 x_clear_window_mouse_face (struct window
*w
)
24881 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
24882 Lisp_Object window
;
24885 XSETWINDOW (window
, w
);
24886 if (EQ (window
, dpyinfo
->mouse_face_window
))
24887 clear_mouse_face (dpyinfo
);
24893 Just discard the mouse face information for frame F, if any.
24894 This is used when the size of F is changed. */
24897 cancel_mouse_face (struct frame
*f
)
24899 Lisp_Object window
;
24900 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24902 window
= dpyinfo
->mouse_face_window
;
24903 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
24905 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
24906 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
24907 dpyinfo
->mouse_face_window
= Qnil
;
24912 #endif /* HAVE_WINDOW_SYSTEM */
24915 /***********************************************************************
24917 ***********************************************************************/
24919 #ifdef HAVE_WINDOW_SYSTEM
24921 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
24922 which intersects rectangle R. R is in window-relative coordinates. */
24925 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
24926 enum glyph_row_area area
)
24928 struct glyph
*first
= row
->glyphs
[area
];
24929 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
24930 struct glyph
*last
;
24931 int first_x
, start_x
, x
;
24933 if (area
== TEXT_AREA
&& row
->fill_line_p
)
24934 /* If row extends face to end of line write the whole line. */
24935 draw_glyphs (w
, 0, row
, area
,
24936 0, row
->used
[area
],
24937 DRAW_NORMAL_TEXT
, 0);
24940 /* Set START_X to the window-relative start position for drawing glyphs of
24941 AREA. The first glyph of the text area can be partially visible.
24942 The first glyphs of other areas cannot. */
24943 start_x
= window_box_left_offset (w
, area
);
24945 if (area
== TEXT_AREA
)
24948 /* Find the first glyph that must be redrawn. */
24950 && x
+ first
->pixel_width
< r
->x
)
24952 x
+= first
->pixel_width
;
24956 /* Find the last one. */
24960 && x
< r
->x
+ r
->width
)
24962 x
+= last
->pixel_width
;
24968 draw_glyphs (w
, first_x
- start_x
, row
, area
,
24969 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
24970 DRAW_NORMAL_TEXT
, 0);
24975 /* Redraw the parts of the glyph row ROW on window W intersecting
24976 rectangle R. R is in window-relative coordinates. Value is
24977 non-zero if mouse-face was overwritten. */
24980 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
24982 xassert (row
->enabled_p
);
24984 if (row
->mode_line_p
|| w
->pseudo_window_p
)
24985 draw_glyphs (w
, 0, row
, TEXT_AREA
,
24986 0, row
->used
[TEXT_AREA
],
24987 DRAW_NORMAL_TEXT
, 0);
24990 if (row
->used
[LEFT_MARGIN_AREA
])
24991 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
24992 if (row
->used
[TEXT_AREA
])
24993 expose_area (w
, row
, r
, TEXT_AREA
);
24994 if (row
->used
[RIGHT_MARGIN_AREA
])
24995 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
24996 draw_row_fringe_bitmaps (w
, row
);
24999 return row
->mouse_face_p
;
25003 /* Redraw those parts of glyphs rows during expose event handling that
25004 overlap other rows. Redrawing of an exposed line writes over parts
25005 of lines overlapping that exposed line; this function fixes that.
25007 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
25008 row in W's current matrix that is exposed and overlaps other rows.
25009 LAST_OVERLAPPING_ROW is the last such row. */
25012 expose_overlaps (struct window
*w
,
25013 struct glyph_row
*first_overlapping_row
,
25014 struct glyph_row
*last_overlapping_row
,
25017 struct glyph_row
*row
;
25019 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
25020 if (row
->overlapping_p
)
25022 xassert (row
->enabled_p
&& !row
->mode_line_p
);
25025 if (row
->used
[LEFT_MARGIN_AREA
])
25026 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
25028 if (row
->used
[TEXT_AREA
])
25029 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
25031 if (row
->used
[RIGHT_MARGIN_AREA
])
25032 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
25038 /* Return non-zero if W's cursor intersects rectangle R. */
25041 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
25043 XRectangle cr
, result
;
25044 struct glyph
*cursor_glyph
;
25045 struct glyph_row
*row
;
25047 if (w
->phys_cursor
.vpos
>= 0
25048 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
25049 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
25051 && row
->cursor_in_fringe_p
)
25053 /* Cursor is in the fringe. */
25054 cr
.x
= window_box_right_offset (w
,
25055 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
25056 ? RIGHT_MARGIN_AREA
25059 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
25060 cr
.height
= row
->height
;
25061 return x_intersect_rectangles (&cr
, r
, &result
);
25064 cursor_glyph
= get_phys_cursor_glyph (w
);
25067 /* r is relative to W's box, but w->phys_cursor.x is relative
25068 to left edge of W's TEXT area. Adjust it. */
25069 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
25070 cr
.y
= w
->phys_cursor
.y
;
25071 cr
.width
= cursor_glyph
->pixel_width
;
25072 cr
.height
= w
->phys_cursor_height
;
25073 /* ++KFS: W32 version used W32-specific IntersectRect here, but
25074 I assume the effect is the same -- and this is portable. */
25075 return x_intersect_rectangles (&cr
, r
, &result
);
25077 /* If we don't understand the format, pretend we're not in the hot-spot. */
25083 Draw a vertical window border to the right of window W if W doesn't
25084 have vertical scroll bars. */
25087 x_draw_vertical_border (struct window
*w
)
25089 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25091 /* We could do better, if we knew what type of scroll-bar the adjacent
25092 windows (on either side) have... But we don't :-(
25093 However, I think this works ok. ++KFS 2003-04-25 */
25095 /* Redraw borders between horizontally adjacent windows. Don't
25096 do it for frames with vertical scroll bars because either the
25097 right scroll bar of a window, or the left scroll bar of its
25098 neighbor will suffice as a border. */
25099 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
25102 if (!WINDOW_RIGHTMOST_P (w
)
25103 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
25105 int x0
, x1
, y0
, y1
;
25107 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
25110 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
25113 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
25115 else if (!WINDOW_LEFTMOST_P (w
)
25116 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
25118 int x0
, x1
, y0
, y1
;
25120 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
25123 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
25126 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
25131 /* Redraw the part of window W intersection rectangle FR. Pixel
25132 coordinates in FR are frame-relative. Call this function with
25133 input blocked. Value is non-zero if the exposure overwrites
25137 expose_window (struct window
*w
, XRectangle
*fr
)
25139 struct frame
*f
= XFRAME (w
->frame
);
25141 int mouse_face_overwritten_p
= 0;
25143 /* If window is not yet fully initialized, do nothing. This can
25144 happen when toolkit scroll bars are used and a window is split.
25145 Reconfiguring the scroll bar will generate an expose for a newly
25147 if (w
->current_matrix
== NULL
)
25150 /* When we're currently updating the window, display and current
25151 matrix usually don't agree. Arrange for a thorough display
25153 if (w
== updated_window
)
25155 SET_FRAME_GARBAGED (f
);
25159 /* Frame-relative pixel rectangle of W. */
25160 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
25161 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
25162 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
25163 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
25165 if (x_intersect_rectangles (fr
, &wr
, &r
))
25167 int yb
= window_text_bottom_y (w
);
25168 struct glyph_row
*row
;
25169 int cursor_cleared_p
;
25170 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
25172 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
25173 r
.x
, r
.y
, r
.width
, r
.height
));
25175 /* Convert to window coordinates. */
25176 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
25177 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
25179 /* Turn off the cursor. */
25180 if (!w
->pseudo_window_p
25181 && phys_cursor_in_rect_p (w
, &r
))
25183 x_clear_cursor (w
);
25184 cursor_cleared_p
= 1;
25187 cursor_cleared_p
= 0;
25189 /* Update lines intersecting rectangle R. */
25190 first_overlapping_row
= last_overlapping_row
= NULL
;
25191 for (row
= w
->current_matrix
->rows
;
25196 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
25198 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
25199 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
25200 || (r
.y
>= y0
&& r
.y
< y1
)
25201 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
25203 /* A header line may be overlapping, but there is no need
25204 to fix overlapping areas for them. KFS 2005-02-12 */
25205 if (row
->overlapping_p
&& !row
->mode_line_p
)
25207 if (first_overlapping_row
== NULL
)
25208 first_overlapping_row
= row
;
25209 last_overlapping_row
= row
;
25213 if (expose_line (w
, row
, &r
))
25214 mouse_face_overwritten_p
= 1;
25217 else if (row
->overlapping_p
)
25219 /* We must redraw a row overlapping the exposed area. */
25221 ? y0
+ row
->phys_height
> r
.y
25222 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
25224 if (first_overlapping_row
== NULL
)
25225 first_overlapping_row
= row
;
25226 last_overlapping_row
= row
;
25234 /* Display the mode line if there is one. */
25235 if (WINDOW_WANTS_MODELINE_P (w
)
25236 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
25238 && row
->y
< r
.y
+ r
.height
)
25240 if (expose_line (w
, row
, &r
))
25241 mouse_face_overwritten_p
= 1;
25244 if (!w
->pseudo_window_p
)
25246 /* Fix the display of overlapping rows. */
25247 if (first_overlapping_row
)
25248 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
25251 /* Draw border between windows. */
25252 x_draw_vertical_border (w
);
25254 /* Turn the cursor on again. */
25255 if (cursor_cleared_p
)
25256 update_window_cursor (w
, 1);
25260 return mouse_face_overwritten_p
;
25265 /* Redraw (parts) of all windows in the window tree rooted at W that
25266 intersect R. R contains frame pixel coordinates. Value is
25267 non-zero if the exposure overwrites mouse-face. */
25270 expose_window_tree (struct window
*w
, XRectangle
*r
)
25272 struct frame
*f
= XFRAME (w
->frame
);
25273 int mouse_face_overwritten_p
= 0;
25275 while (w
&& !FRAME_GARBAGED_P (f
))
25277 if (!NILP (w
->hchild
))
25278 mouse_face_overwritten_p
25279 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
25280 else if (!NILP (w
->vchild
))
25281 mouse_face_overwritten_p
25282 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
25284 mouse_face_overwritten_p
|= expose_window (w
, r
);
25286 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
25289 return mouse_face_overwritten_p
;
25294 Redisplay an exposed area of frame F. X and Y are the upper-left
25295 corner of the exposed rectangle. W and H are width and height of
25296 the exposed area. All are pixel values. W or H zero means redraw
25297 the entire frame. */
25300 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
25303 int mouse_face_overwritten_p
= 0;
25305 TRACE ((stderr
, "expose_frame "));
25307 /* No need to redraw if frame will be redrawn soon. */
25308 if (FRAME_GARBAGED_P (f
))
25310 TRACE ((stderr
, " garbaged\n"));
25314 /* If basic faces haven't been realized yet, there is no point in
25315 trying to redraw anything. This can happen when we get an expose
25316 event while Emacs is starting, e.g. by moving another window. */
25317 if (FRAME_FACE_CACHE (f
) == NULL
25318 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
25320 TRACE ((stderr
, " no faces\n"));
25324 if (w
== 0 || h
== 0)
25327 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
25328 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
25338 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
25339 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
25341 if (WINDOWP (f
->tool_bar_window
))
25342 mouse_face_overwritten_p
25343 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
25345 #ifdef HAVE_X_WINDOWS
25347 #ifndef USE_X_TOOLKIT
25348 if (WINDOWP (f
->menu_bar_window
))
25349 mouse_face_overwritten_p
25350 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
25351 #endif /* not USE_X_TOOLKIT */
25355 /* Some window managers support a focus-follows-mouse style with
25356 delayed raising of frames. Imagine a partially obscured frame,
25357 and moving the mouse into partially obscured mouse-face on that
25358 frame. The visible part of the mouse-face will be highlighted,
25359 then the WM raises the obscured frame. With at least one WM, KDE
25360 2.1, Emacs is not getting any event for the raising of the frame
25361 (even tried with SubstructureRedirectMask), only Expose events.
25362 These expose events will draw text normally, i.e. not
25363 highlighted. Which means we must redo the highlight here.
25364 Subsume it under ``we love X''. --gerd 2001-08-15 */
25365 /* Included in Windows version because Windows most likely does not
25366 do the right thing if any third party tool offers
25367 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
25368 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
25370 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
25371 if (f
== dpyinfo
->mouse_face_mouse_frame
)
25373 int x
= dpyinfo
->mouse_face_mouse_x
;
25374 int y
= dpyinfo
->mouse_face_mouse_y
;
25375 clear_mouse_face (dpyinfo
);
25376 note_mouse_highlight (f
, x
, y
);
25383 Determine the intersection of two rectangles R1 and R2. Return
25384 the intersection in *RESULT. Value is non-zero if RESULT is not
25388 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
25390 XRectangle
*left
, *right
;
25391 XRectangle
*upper
, *lower
;
25392 int intersection_p
= 0;
25394 /* Rearrange so that R1 is the left-most rectangle. */
25396 left
= r1
, right
= r2
;
25398 left
= r2
, right
= r1
;
25400 /* X0 of the intersection is right.x0, if this is inside R1,
25401 otherwise there is no intersection. */
25402 if (right
->x
<= left
->x
+ left
->width
)
25404 result
->x
= right
->x
;
25406 /* The right end of the intersection is the minimum of the
25407 the right ends of left and right. */
25408 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
25411 /* Same game for Y. */
25413 upper
= r1
, lower
= r2
;
25415 upper
= r2
, lower
= r1
;
25417 /* The upper end of the intersection is lower.y0, if this is inside
25418 of upper. Otherwise, there is no intersection. */
25419 if (lower
->y
<= upper
->y
+ upper
->height
)
25421 result
->y
= lower
->y
;
25423 /* The lower end of the intersection is the minimum of the lower
25424 ends of upper and lower. */
25425 result
->height
= (min (lower
->y
+ lower
->height
,
25426 upper
->y
+ upper
->height
)
25428 intersection_p
= 1;
25432 return intersection_p
;
25435 #endif /* HAVE_WINDOW_SYSTEM */
25438 /***********************************************************************
25440 ***********************************************************************/
25443 syms_of_xdisp (void)
25445 Vwith_echo_area_save_vector
= Qnil
;
25446 staticpro (&Vwith_echo_area_save_vector
);
25448 Vmessage_stack
= Qnil
;
25449 staticpro (&Vmessage_stack
);
25451 Qinhibit_redisplay
= intern_c_string ("inhibit-redisplay");
25452 staticpro (&Qinhibit_redisplay
);
25454 message_dolog_marker1
= Fmake_marker ();
25455 staticpro (&message_dolog_marker1
);
25456 message_dolog_marker2
= Fmake_marker ();
25457 staticpro (&message_dolog_marker2
);
25458 message_dolog_marker3
= Fmake_marker ();
25459 staticpro (&message_dolog_marker3
);
25462 defsubr (&Sdump_frame_glyph_matrix
);
25463 defsubr (&Sdump_glyph_matrix
);
25464 defsubr (&Sdump_glyph_row
);
25465 defsubr (&Sdump_tool_bar_row
);
25466 defsubr (&Strace_redisplay
);
25467 defsubr (&Strace_to_stderr
);
25469 #ifdef HAVE_WINDOW_SYSTEM
25470 defsubr (&Stool_bar_lines_needed
);
25471 defsubr (&Slookup_image_map
);
25473 defsubr (&Sformat_mode_line
);
25474 defsubr (&Sinvisible_p
);
25475 defsubr (&Scurrent_bidi_paragraph_direction
);
25477 staticpro (&Qmenu_bar_update_hook
);
25478 Qmenu_bar_update_hook
= intern_c_string ("menu-bar-update-hook");
25480 staticpro (&Qoverriding_terminal_local_map
);
25481 Qoverriding_terminal_local_map
= intern_c_string ("overriding-terminal-local-map");
25483 staticpro (&Qoverriding_local_map
);
25484 Qoverriding_local_map
= intern_c_string ("overriding-local-map");
25486 staticpro (&Qwindow_scroll_functions
);
25487 Qwindow_scroll_functions
= intern_c_string ("window-scroll-functions");
25489 staticpro (&Qwindow_text_change_functions
);
25490 Qwindow_text_change_functions
= intern_c_string ("window-text-change-functions");
25492 staticpro (&Qredisplay_end_trigger_functions
);
25493 Qredisplay_end_trigger_functions
= intern_c_string ("redisplay-end-trigger-functions");
25495 staticpro (&Qinhibit_point_motion_hooks
);
25496 Qinhibit_point_motion_hooks
= intern_c_string ("inhibit-point-motion-hooks");
25498 Qeval
= intern_c_string ("eval");
25499 staticpro (&Qeval
);
25501 QCdata
= intern_c_string (":data");
25502 staticpro (&QCdata
);
25503 Qdisplay
= intern_c_string ("display");
25504 staticpro (&Qdisplay
);
25505 Qspace_width
= intern_c_string ("space-width");
25506 staticpro (&Qspace_width
);
25507 Qraise
= intern_c_string ("raise");
25508 staticpro (&Qraise
);
25509 Qslice
= intern_c_string ("slice");
25510 staticpro (&Qslice
);
25511 Qspace
= intern_c_string ("space");
25512 staticpro (&Qspace
);
25513 Qmargin
= intern_c_string ("margin");
25514 staticpro (&Qmargin
);
25515 Qpointer
= intern_c_string ("pointer");
25516 staticpro (&Qpointer
);
25517 Qleft_margin
= intern_c_string ("left-margin");
25518 staticpro (&Qleft_margin
);
25519 Qright_margin
= intern_c_string ("right-margin");
25520 staticpro (&Qright_margin
);
25521 Qcenter
= intern_c_string ("center");
25522 staticpro (&Qcenter
);
25523 Qline_height
= intern_c_string ("line-height");
25524 staticpro (&Qline_height
);
25525 QCalign_to
= intern_c_string (":align-to");
25526 staticpro (&QCalign_to
);
25527 QCrelative_width
= intern_c_string (":relative-width");
25528 staticpro (&QCrelative_width
);
25529 QCrelative_height
= intern_c_string (":relative-height");
25530 staticpro (&QCrelative_height
);
25531 QCeval
= intern_c_string (":eval");
25532 staticpro (&QCeval
);
25533 QCpropertize
= intern_c_string (":propertize");
25534 staticpro (&QCpropertize
);
25535 QCfile
= intern_c_string (":file");
25536 staticpro (&QCfile
);
25537 Qfontified
= intern_c_string ("fontified");
25538 staticpro (&Qfontified
);
25539 Qfontification_functions
= intern_c_string ("fontification-functions");
25540 staticpro (&Qfontification_functions
);
25541 Qtrailing_whitespace
= intern_c_string ("trailing-whitespace");
25542 staticpro (&Qtrailing_whitespace
);
25543 Qescape_glyph
= intern_c_string ("escape-glyph");
25544 staticpro (&Qescape_glyph
);
25545 Qnobreak_space
= intern_c_string ("nobreak-space");
25546 staticpro (&Qnobreak_space
);
25547 Qimage
= intern_c_string ("image");
25548 staticpro (&Qimage
);
25549 Qtext
= intern_c_string ("text");
25550 staticpro (&Qtext
);
25551 Qboth
= intern_c_string ("both");
25552 staticpro (&Qboth
);
25553 Qboth_horiz
= intern_c_string ("both-horiz");
25554 staticpro (&Qboth_horiz
);
25555 Qtext_image_horiz
= intern_c_string ("text-image-horiz");
25556 staticpro (&Qtext_image_horiz
);
25557 QCmap
= intern_c_string (":map");
25558 staticpro (&QCmap
);
25559 QCpointer
= intern_c_string (":pointer");
25560 staticpro (&QCpointer
);
25561 Qrect
= intern_c_string ("rect");
25562 staticpro (&Qrect
);
25563 Qcircle
= intern_c_string ("circle");
25564 staticpro (&Qcircle
);
25565 Qpoly
= intern_c_string ("poly");
25566 staticpro (&Qpoly
);
25567 Qmessage_truncate_lines
= intern_c_string ("message-truncate-lines");
25568 staticpro (&Qmessage_truncate_lines
);
25569 Qgrow_only
= intern_c_string ("grow-only");
25570 staticpro (&Qgrow_only
);
25571 Qinhibit_menubar_update
= intern_c_string ("inhibit-menubar-update");
25572 staticpro (&Qinhibit_menubar_update
);
25573 Qinhibit_eval_during_redisplay
= intern_c_string ("inhibit-eval-during-redisplay");
25574 staticpro (&Qinhibit_eval_during_redisplay
);
25575 Qposition
= intern_c_string ("position");
25576 staticpro (&Qposition
);
25577 Qbuffer_position
= intern_c_string ("buffer-position");
25578 staticpro (&Qbuffer_position
);
25579 Qobject
= intern_c_string ("object");
25580 staticpro (&Qobject
);
25581 Qbar
= intern_c_string ("bar");
25583 Qhbar
= intern_c_string ("hbar");
25584 staticpro (&Qhbar
);
25585 Qbox
= intern_c_string ("box");
25587 Qhollow
= intern_c_string ("hollow");
25588 staticpro (&Qhollow
);
25589 Qhand
= intern_c_string ("hand");
25590 staticpro (&Qhand
);
25591 Qarrow
= intern_c_string ("arrow");
25592 staticpro (&Qarrow
);
25593 Qtext
= intern_c_string ("text");
25594 staticpro (&Qtext
);
25595 Qrisky_local_variable
= intern_c_string ("risky-local-variable");
25596 staticpro (&Qrisky_local_variable
);
25597 Qinhibit_free_realized_faces
= intern_c_string ("inhibit-free-realized-faces");
25598 staticpro (&Qinhibit_free_realized_faces
);
25600 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
25601 Fcons (intern_c_string ("void-variable"), Qnil
)),
25603 staticpro (&list_of_error
);
25605 Qlast_arrow_position
= intern_c_string ("last-arrow-position");
25606 staticpro (&Qlast_arrow_position
);
25607 Qlast_arrow_string
= intern_c_string ("last-arrow-string");
25608 staticpro (&Qlast_arrow_string
);
25610 Qoverlay_arrow_string
= intern_c_string ("overlay-arrow-string");
25611 staticpro (&Qoverlay_arrow_string
);
25612 Qoverlay_arrow_bitmap
= intern_c_string ("overlay-arrow-bitmap");
25613 staticpro (&Qoverlay_arrow_bitmap
);
25615 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
25616 staticpro (&echo_buffer
[0]);
25617 staticpro (&echo_buffer
[1]);
25619 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
25620 staticpro (&echo_area_buffer
[0]);
25621 staticpro (&echo_area_buffer
[1]);
25623 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
25624 staticpro (&Vmessages_buffer_name
);
25626 mode_line_proptrans_alist
= Qnil
;
25627 staticpro (&mode_line_proptrans_alist
);
25628 mode_line_string_list
= Qnil
;
25629 staticpro (&mode_line_string_list
);
25630 mode_line_string_face
= Qnil
;
25631 staticpro (&mode_line_string_face
);
25632 mode_line_string_face_prop
= Qnil
;
25633 staticpro (&mode_line_string_face_prop
);
25634 Vmode_line_unwind_vector
= Qnil
;
25635 staticpro (&Vmode_line_unwind_vector
);
25637 help_echo_string
= Qnil
;
25638 staticpro (&help_echo_string
);
25639 help_echo_object
= Qnil
;
25640 staticpro (&help_echo_object
);
25641 help_echo_window
= Qnil
;
25642 staticpro (&help_echo_window
);
25643 previous_help_echo_string
= Qnil
;
25644 staticpro (&previous_help_echo_string
);
25645 help_echo_pos
= -1;
25647 Qright_to_left
= intern_c_string ("right-to-left");
25648 staticpro (&Qright_to_left
);
25649 Qleft_to_right
= intern_c_string ("left-to-right");
25650 staticpro (&Qleft_to_right
);
25652 #ifdef HAVE_WINDOW_SYSTEM
25653 DEFVAR_BOOL ("x-stretch-cursor", &x_stretch_cursor_p
,
25654 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
25655 For example, if a block cursor is over a tab, it will be drawn as
25656 wide as that tab on the display. */);
25657 x_stretch_cursor_p
= 0;
25660 DEFVAR_LISP ("show-trailing-whitespace", &Vshow_trailing_whitespace
,
25661 doc
: /* *Non-nil means highlight trailing whitespace.
25662 The face used for trailing whitespace is `trailing-whitespace'. */);
25663 Vshow_trailing_whitespace
= Qnil
;
25665 DEFVAR_LISP ("nobreak-char-display", &Vnobreak_char_display
,
25666 doc
: /* *Control highlighting of nobreak space and soft hyphen.
25667 A value of t means highlight the character itself (for nobreak space,
25668 use face `nobreak-space').
25669 A value of nil means no highlighting.
25670 Other values mean display the escape glyph followed by an ordinary
25671 space or ordinary hyphen. */);
25672 Vnobreak_char_display
= Qt
;
25674 DEFVAR_LISP ("void-text-area-pointer", &Vvoid_text_area_pointer
,
25675 doc
: /* *The pointer shape to show in void text areas.
25676 A value of nil means to show the text pointer. Other options are `arrow',
25677 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
25678 Vvoid_text_area_pointer
= Qarrow
;
25680 DEFVAR_LISP ("inhibit-redisplay", &Vinhibit_redisplay
,
25681 doc
: /* Non-nil means don't actually do any redisplay.
25682 This is used for internal purposes. */);
25683 Vinhibit_redisplay
= Qnil
;
25685 DEFVAR_LISP ("global-mode-string", &Vglobal_mode_string
,
25686 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
25687 Vglobal_mode_string
= Qnil
;
25689 DEFVAR_LISP ("overlay-arrow-position", &Voverlay_arrow_position
,
25690 doc
: /* Marker for where to display an arrow on top of the buffer text.
25691 This must be the beginning of a line in order to work.
25692 See also `overlay-arrow-string'. */);
25693 Voverlay_arrow_position
= Qnil
;
25695 DEFVAR_LISP ("overlay-arrow-string", &Voverlay_arrow_string
,
25696 doc
: /* String to display as an arrow in non-window frames.
25697 See also `overlay-arrow-position'. */);
25698 Voverlay_arrow_string
= make_pure_c_string ("=>");
25700 DEFVAR_LISP ("overlay-arrow-variable-list", &Voverlay_arrow_variable_list
,
25701 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
25702 The symbols on this list are examined during redisplay to determine
25703 where to display overlay arrows. */);
25704 Voverlay_arrow_variable_list
25705 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
25707 DEFVAR_INT ("scroll-step", &scroll_step
,
25708 doc
: /* *The number of lines to try scrolling a window by when point moves out.
25709 If that fails to bring point back on frame, point is centered instead.
25710 If this is zero, point is always centered after it moves off frame.
25711 If you want scrolling to always be a line at a time, you should set
25712 `scroll-conservatively' to a large value rather than set this to 1. */);
25714 DEFVAR_INT ("scroll-conservatively", &scroll_conservatively
,
25715 doc
: /* *Scroll up to this many lines, to bring point back on screen.
25716 If point moves off-screen, redisplay will scroll by up to
25717 `scroll-conservatively' lines in order to bring point just barely
25718 onto the screen again. If that cannot be done, then redisplay
25719 recenters point as usual.
25721 A value of zero means always recenter point if it moves off screen. */);
25722 scroll_conservatively
= 0;
25724 DEFVAR_INT ("scroll-margin", &scroll_margin
,
25725 doc
: /* *Number of lines of margin at the top and bottom of a window.
25726 Recenter the window whenever point gets within this many lines
25727 of the top or bottom of the window. */);
25730 DEFVAR_LISP ("display-pixels-per-inch", &Vdisplay_pixels_per_inch
,
25731 doc
: /* Pixels per inch value for non-window system displays.
25732 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
25733 Vdisplay_pixels_per_inch
= make_float (72.0);
25736 DEFVAR_INT ("debug-end-pos", &debug_end_pos
, doc
: /* Don't ask. */);
25739 DEFVAR_LISP ("truncate-partial-width-windows",
25740 &Vtruncate_partial_width_windows
,
25741 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
25742 For an integer value, truncate lines in each window narrower than the
25743 full frame width, provided the window width is less than that integer;
25744 otherwise, respect the value of `truncate-lines'.
25746 For any other non-nil value, truncate lines in all windows that do
25747 not span the full frame width.
25749 A value of nil means to respect the value of `truncate-lines'.
25751 If `word-wrap' is enabled, you might want to reduce this. */);
25752 Vtruncate_partial_width_windows
= make_number (50);
25754 DEFVAR_BOOL ("mode-line-inverse-video", &mode_line_inverse_video
,
25755 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
25756 Any other value means to use the appropriate face, `mode-line',
25757 `header-line', or `menu' respectively. */);
25758 mode_line_inverse_video
= 1;
25760 DEFVAR_LISP ("line-number-display-limit", &Vline_number_display_limit
,
25761 doc
: /* *Maximum buffer size for which line number should be displayed.
25762 If the buffer is bigger than this, the line number does not appear
25763 in the mode line. A value of nil means no limit. */);
25764 Vline_number_display_limit
= Qnil
;
25766 DEFVAR_INT ("line-number-display-limit-width",
25767 &line_number_display_limit_width
,
25768 doc
: /* *Maximum line width (in characters) for line number display.
25769 If the average length of the lines near point is bigger than this, then the
25770 line number may be omitted from the mode line. */);
25771 line_number_display_limit_width
= 200;
25773 DEFVAR_BOOL ("highlight-nonselected-windows", &highlight_nonselected_windows
,
25774 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
25775 highlight_nonselected_windows
= 0;
25777 DEFVAR_BOOL ("multiple-frames", &multiple_frames
,
25778 doc
: /* Non-nil if more than one frame is visible on this display.
25779 Minibuffer-only frames don't count, but iconified frames do.
25780 This variable is not guaranteed to be accurate except while processing
25781 `frame-title-format' and `icon-title-format'. */);
25783 DEFVAR_LISP ("frame-title-format", &Vframe_title_format
,
25784 doc
: /* Template for displaying the title bar of visible frames.
25785 \(Assuming the window manager supports this feature.)
25787 This variable has the same structure as `mode-line-format', except that
25788 the %c and %l constructs are ignored. It is used only on frames for
25789 which no explicit name has been set \(see `modify-frame-parameters'). */);
25791 DEFVAR_LISP ("icon-title-format", &Vicon_title_format
,
25792 doc
: /* Template for displaying the title bar of an iconified frame.
25793 \(Assuming the window manager supports this feature.)
25794 This variable has the same structure as `mode-line-format' (which see),
25795 and is used only on frames for which no explicit name has been set
25796 \(see `modify-frame-parameters'). */);
25798 = Vframe_title_format
25799 = pure_cons (intern_c_string ("multiple-frames"),
25800 pure_cons (make_pure_c_string ("%b"),
25801 pure_cons (pure_cons (empty_unibyte_string
,
25802 pure_cons (intern_c_string ("invocation-name"),
25803 pure_cons (make_pure_c_string ("@"),
25804 pure_cons (intern_c_string ("system-name"),
25808 DEFVAR_LISP ("message-log-max", &Vmessage_log_max
,
25809 doc
: /* Maximum number of lines to keep in the message log buffer.
25810 If nil, disable message logging. If t, log messages but don't truncate
25811 the buffer when it becomes large. */);
25812 Vmessage_log_max
= make_number (100);
25814 DEFVAR_LISP ("window-size-change-functions", &Vwindow_size_change_functions
,
25815 doc
: /* Functions called before redisplay, if window sizes have changed.
25816 The value should be a list of functions that take one argument.
25817 Just before redisplay, for each frame, if any of its windows have changed
25818 size since the last redisplay, or have been split or deleted,
25819 all the functions in the list are called, with the frame as argument. */);
25820 Vwindow_size_change_functions
= Qnil
;
25822 DEFVAR_LISP ("window-scroll-functions", &Vwindow_scroll_functions
,
25823 doc
: /* List of functions to call before redisplaying a window with scrolling.
25824 Each function is called with two arguments, the window and its new
25825 display-start position. Note that these functions are also called by
25826 `set-window-buffer'. Also note that the value of `window-end' is not
25827 valid when these functions are called. */);
25828 Vwindow_scroll_functions
= Qnil
;
25830 DEFVAR_LISP ("window-text-change-functions",
25831 &Vwindow_text_change_functions
,
25832 doc
: /* Functions to call in redisplay when text in the window might change. */);
25833 Vwindow_text_change_functions
= Qnil
;
25835 DEFVAR_LISP ("redisplay-end-trigger-functions", &Vredisplay_end_trigger_functions
,
25836 doc
: /* Functions called when redisplay of a window reaches the end trigger.
25837 Each function is called with two arguments, the window and the end trigger value.
25838 See `set-window-redisplay-end-trigger'. */);
25839 Vredisplay_end_trigger_functions
= Qnil
;
25841 DEFVAR_LISP ("mouse-autoselect-window", &Vmouse_autoselect_window
,
25842 doc
: /* *Non-nil means autoselect window with mouse pointer.
25843 If nil, do not autoselect windows.
25844 A positive number means delay autoselection by that many seconds: a
25845 window is autoselected only after the mouse has remained in that
25846 window for the duration of the delay.
25847 A negative number has a similar effect, but causes windows to be
25848 autoselected only after the mouse has stopped moving. \(Because of
25849 the way Emacs compares mouse events, you will occasionally wait twice
25850 that time before the window gets selected.\)
25851 Any other value means to autoselect window instantaneously when the
25852 mouse pointer enters it.
25854 Autoselection selects the minibuffer only if it is active, and never
25855 unselects the minibuffer if it is active.
25857 When customizing this variable make sure that the actual value of
25858 `focus-follows-mouse' matches the behavior of your window manager. */);
25859 Vmouse_autoselect_window
= Qnil
;
25861 DEFVAR_LISP ("auto-resize-tool-bars", &Vauto_resize_tool_bars
,
25862 doc
: /* *Non-nil means automatically resize tool-bars.
25863 This dynamically changes the tool-bar's height to the minimum height
25864 that is needed to make all tool-bar items visible.
25865 If value is `grow-only', the tool-bar's height is only increased
25866 automatically; to decrease the tool-bar height, use \\[recenter]. */);
25867 Vauto_resize_tool_bars
= Qt
;
25869 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", &auto_raise_tool_bar_buttons_p
,
25870 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
25871 auto_raise_tool_bar_buttons_p
= 1;
25873 DEFVAR_BOOL ("make-cursor-line-fully-visible", &make_cursor_line_fully_visible_p
,
25874 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
25875 make_cursor_line_fully_visible_p
= 1;
25877 DEFVAR_LISP ("tool-bar-border", &Vtool_bar_border
,
25878 doc
: /* *Border below tool-bar in pixels.
25879 If an integer, use it as the height of the border.
25880 If it is one of `internal-border-width' or `border-width', use the
25881 value of the corresponding frame parameter.
25882 Otherwise, no border is added below the tool-bar. */);
25883 Vtool_bar_border
= Qinternal_border_width
;
25885 DEFVAR_LISP ("tool-bar-button-margin", &Vtool_bar_button_margin
,
25886 doc
: /* *Margin around tool-bar buttons in pixels.
25887 If an integer, use that for both horizontal and vertical margins.
25888 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
25889 HORZ specifying the horizontal margin, and VERT specifying the
25890 vertical margin. */);
25891 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
25893 DEFVAR_INT ("tool-bar-button-relief", &tool_bar_button_relief
,
25894 doc
: /* *Relief thickness of tool-bar buttons. */);
25895 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
25897 DEFVAR_LISP ("tool-bar-style", &Vtool_bar_style
,
25898 doc
: /* *Tool bar style to use.
25900 image - show images only
25901 text - show text only
25902 both - show both, text below image
25903 both-horiz - show text to the right of the image
25904 text-image-horiz - show text to the left of the image
25905 any other - use system default or image if no system default. */);
25906 Vtool_bar_style
= Qnil
;
25908 DEFVAR_INT ("tool-bar-max-label-size", &tool_bar_max_label_size
,
25909 doc
: /* *Maximum number of characters a label can have to be shown.
25910 The tool bar style must also show labels for this to have any effect, see
25911 `tool-bar-style'. */);
25912 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
25914 DEFVAR_LISP ("fontification-functions", &Vfontification_functions
,
25915 doc
: /* List of functions to call to fontify regions of text.
25916 Each function is called with one argument POS. Functions must
25917 fontify a region starting at POS in the current buffer, and give
25918 fontified regions the property `fontified'. */);
25919 Vfontification_functions
= Qnil
;
25920 Fmake_variable_buffer_local (Qfontification_functions
);
25922 DEFVAR_BOOL ("unibyte-display-via-language-environment",
25923 &unibyte_display_via_language_environment
,
25924 doc
: /* *Non-nil means display unibyte text according to language environment.
25925 Specifically, this means that raw bytes in the range 160-255 decimal
25926 are displayed by converting them to the equivalent multibyte characters
25927 according to the current language environment. As a result, they are
25928 displayed according to the current fontset.
25930 Note that this variable affects only how these bytes are displayed,
25931 but does not change the fact they are interpreted as raw bytes. */);
25932 unibyte_display_via_language_environment
= 0;
25934 DEFVAR_LISP ("max-mini-window-height", &Vmax_mini_window_height
,
25935 doc
: /* *Maximum height for resizing mini-windows.
25936 If a float, it specifies a fraction of the mini-window frame's height.
25937 If an integer, it specifies a number of lines. */);
25938 Vmax_mini_window_height
= make_float (0.25);
25940 DEFVAR_LISP ("resize-mini-windows", &Vresize_mini_windows
,
25941 doc
: /* *How to resize mini-windows.
25942 A value of nil means don't automatically resize mini-windows.
25943 A value of t means resize them to fit the text displayed in them.
25944 A value of `grow-only', the default, means let mini-windows grow
25945 only, until their display becomes empty, at which point the windows
25946 go back to their normal size. */);
25947 Vresize_mini_windows
= Qgrow_only
;
25949 DEFVAR_LISP ("blink-cursor-alist", &Vblink_cursor_alist
,
25950 doc
: /* Alist specifying how to blink the cursor off.
25951 Each element has the form (ON-STATE . OFF-STATE). Whenever the
25952 `cursor-type' frame-parameter or variable equals ON-STATE,
25953 comparing using `equal', Emacs uses OFF-STATE to specify
25954 how to blink it off. ON-STATE and OFF-STATE are values for
25955 the `cursor-type' frame parameter.
25957 If a frame's ON-STATE has no entry in this list,
25958 the frame's other specifications determine how to blink the cursor off. */);
25959 Vblink_cursor_alist
= Qnil
;
25961 DEFVAR_BOOL ("auto-hscroll-mode", &automatic_hscrolling_p
,
25962 doc
: /* *Non-nil means scroll the display automatically to make point visible. */);
25963 automatic_hscrolling_p
= 1;
25964 Qauto_hscroll_mode
= intern_c_string ("auto-hscroll-mode");
25965 staticpro (&Qauto_hscroll_mode
);
25967 DEFVAR_INT ("hscroll-margin", &hscroll_margin
,
25968 doc
: /* *How many columns away from the window edge point is allowed to get
25969 before automatic hscrolling will horizontally scroll the window. */);
25970 hscroll_margin
= 5;
25972 DEFVAR_LISP ("hscroll-step", &Vhscroll_step
,
25973 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
25974 When point is less than `hscroll-margin' columns from the window
25975 edge, automatic hscrolling will scroll the window by the amount of columns
25976 determined by this variable. If its value is a positive integer, scroll that
25977 many columns. If it's a positive floating-point number, it specifies the
25978 fraction of the window's width to scroll. If it's nil or zero, point will be
25979 centered horizontally after the scroll. Any other value, including negative
25980 numbers, are treated as if the value were zero.
25982 Automatic hscrolling always moves point outside the scroll margin, so if
25983 point was more than scroll step columns inside the margin, the window will
25984 scroll more than the value given by the scroll step.
25986 Note that the lower bound for automatic hscrolling specified by `scroll-left'
25987 and `scroll-right' overrides this variable's effect. */);
25988 Vhscroll_step
= make_number (0);
25990 DEFVAR_BOOL ("message-truncate-lines", &message_truncate_lines
,
25991 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
25992 Bind this around calls to `message' to let it take effect. */);
25993 message_truncate_lines
= 0;
25995 DEFVAR_LISP ("menu-bar-update-hook", &Vmenu_bar_update_hook
,
25996 doc
: /* Normal hook run to update the menu bar definitions.
25997 Redisplay runs this hook before it redisplays the menu bar.
25998 This is used to update submenus such as Buffers,
25999 whose contents depend on various data. */);
26000 Vmenu_bar_update_hook
= Qnil
;
26002 DEFVAR_LISP ("menu-updating-frame", &Vmenu_updating_frame
,
26003 doc
: /* Frame for which we are updating a menu.
26004 The enable predicate for a menu binding should check this variable. */);
26005 Vmenu_updating_frame
= Qnil
;
26007 DEFVAR_BOOL ("inhibit-menubar-update", &inhibit_menubar_update
,
26008 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
26009 inhibit_menubar_update
= 0;
26011 DEFVAR_LISP ("wrap-prefix", &Vwrap_prefix
,
26012 doc
: /* Prefix prepended to all continuation lines at display time.
26013 The value may be a string, an image, or a stretch-glyph; it is
26014 interpreted in the same way as the value of a `display' text property.
26016 This variable is overridden by any `wrap-prefix' text or overlay
26019 To add a prefix to non-continuation lines, use `line-prefix'. */);
26020 Vwrap_prefix
= Qnil
;
26021 staticpro (&Qwrap_prefix
);
26022 Qwrap_prefix
= intern_c_string ("wrap-prefix");
26023 Fmake_variable_buffer_local (Qwrap_prefix
);
26025 DEFVAR_LISP ("line-prefix", &Vline_prefix
,
26026 doc
: /* Prefix prepended to all non-continuation lines at display time.
26027 The value may be a string, an image, or a stretch-glyph; it is
26028 interpreted in the same way as the value of a `display' text property.
26030 This variable is overridden by any `line-prefix' text or overlay
26033 To add a prefix to continuation lines, use `wrap-prefix'. */);
26034 Vline_prefix
= Qnil
;
26035 staticpro (&Qline_prefix
);
26036 Qline_prefix
= intern_c_string ("line-prefix");
26037 Fmake_variable_buffer_local (Qline_prefix
);
26039 DEFVAR_BOOL ("inhibit-eval-during-redisplay", &inhibit_eval_during_redisplay
,
26040 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
26041 inhibit_eval_during_redisplay
= 0;
26043 DEFVAR_BOOL ("inhibit-free-realized-faces", &inhibit_free_realized_faces
,
26044 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
26045 inhibit_free_realized_faces
= 0;
26048 DEFVAR_BOOL ("inhibit-try-window-id", &inhibit_try_window_id
,
26049 doc
: /* Inhibit try_window_id display optimization. */);
26050 inhibit_try_window_id
= 0;
26052 DEFVAR_BOOL ("inhibit-try-window-reusing", &inhibit_try_window_reusing
,
26053 doc
: /* Inhibit try_window_reusing display optimization. */);
26054 inhibit_try_window_reusing
= 0;
26056 DEFVAR_BOOL ("inhibit-try-cursor-movement", &inhibit_try_cursor_movement
,
26057 doc
: /* Inhibit try_cursor_movement display optimization. */);
26058 inhibit_try_cursor_movement
= 0;
26059 #endif /* GLYPH_DEBUG */
26061 DEFVAR_INT ("overline-margin", &overline_margin
,
26062 doc
: /* *Space between overline and text, in pixels.
26063 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
26064 margin to the caracter height. */);
26065 overline_margin
= 2;
26067 DEFVAR_INT ("underline-minimum-offset",
26068 &underline_minimum_offset
,
26069 doc
: /* Minimum distance between baseline and underline.
26070 This can improve legibility of underlined text at small font sizes,
26071 particularly when using variable `x-use-underline-position-properties'
26072 with fonts that specify an UNDERLINE_POSITION relatively close to the
26073 baseline. The default value is 1. */);
26074 underline_minimum_offset
= 1;
26076 DEFVAR_BOOL ("display-hourglass", &display_hourglass_p
,
26077 doc
: /* Non-zero means Emacs displays an hourglass pointer on window systems. */);
26078 display_hourglass_p
= 1;
26080 DEFVAR_LISP ("hourglass-delay", &Vhourglass_delay
,
26081 doc
: /* *Seconds to wait before displaying an hourglass pointer.
26082 Value must be an integer or float. */);
26083 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
26085 hourglass_atimer
= NULL
;
26086 hourglass_shown_p
= 0;
26090 /* Initialize this module when Emacs starts. */
26095 Lisp_Object root_window
;
26096 struct window
*mini_w
;
26098 current_header_line_height
= current_mode_line_height
= -1;
26100 CHARPOS (this_line_start_pos
) = 0;
26102 mini_w
= XWINDOW (minibuf_window
);
26103 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
26105 if (!noninteractive
)
26107 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
26110 XWINDOW (root_window
)->top_line
= make_number (FRAME_TOP_MARGIN (f
));
26111 set_window_height (root_window
,
26112 FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
),
26114 mini_w
->top_line
= make_number (FRAME_LINES (f
) - 1);
26115 set_window_height (minibuf_window
, 1, 0);
26117 XWINDOW (root_window
)->total_cols
= make_number (FRAME_COLS (f
));
26118 mini_w
->total_cols
= make_number (FRAME_COLS (f
));
26120 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
26121 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
26122 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
26124 /* The default ellipsis glyphs `...'. */
26125 for (i
= 0; i
< 3; ++i
)
26126 default_invis_vector
[i
] = make_number ('.');
26130 /* Allocate the buffer for frame titles.
26131 Also used for `format-mode-line'. */
26133 mode_line_noprop_buf
= (char *) xmalloc (size
);
26134 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
26135 mode_line_noprop_ptr
= mode_line_noprop_buf
;
26136 mode_line_target
= MODE_LINE_DISPLAY
;
26139 help_echo_showing_p
= 0;
26142 /* Since w32 does not support atimers, it defines its own implementation of
26143 the following three functions in w32fns.c. */
26146 /* Platform-independent portion of hourglass implementation. */
26148 /* Return non-zero if houglass timer has been started or hourglass is shown. */
26150 hourglass_started (void)
26152 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
26155 /* Cancel a currently active hourglass timer, and start a new one. */
26157 start_hourglass (void)
26159 #if defined (HAVE_WINDOW_SYSTEM)
26161 int secs
, usecs
= 0;
26163 cancel_hourglass ();
26165 if (INTEGERP (Vhourglass_delay
)
26166 && XINT (Vhourglass_delay
) > 0)
26167 secs
= XFASTINT (Vhourglass_delay
);
26168 else if (FLOATP (Vhourglass_delay
)
26169 && XFLOAT_DATA (Vhourglass_delay
) > 0)
26172 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
26173 secs
= XFASTINT (tem
);
26174 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
26177 secs
= DEFAULT_HOURGLASS_DELAY
;
26179 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
26180 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
26181 show_hourglass
, NULL
);
26186 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
26189 cancel_hourglass (void)
26191 #if defined (HAVE_WINDOW_SYSTEM)
26192 if (hourglass_atimer
)
26194 cancel_atimer (hourglass_atimer
);
26195 hourglass_atimer
= NULL
;
26198 if (hourglass_shown_p
)
26202 #endif /* ! WINDOWSNT */
26204 /* arch-tag: eacc864d-bb6a-4b74-894a-1a4399a1358b
26205 (do not change this comment) */