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. */
228 #include "keyboard.h"
231 #include "termchar.h"
232 #include "dispextern.h"
234 #include "character.h"
237 #include "commands.h"
241 #include "termhooks.h"
242 #include "termopts.h"
243 #include "intervals.h"
246 #include "region-cache.h"
249 #include "blockinput.h"
251 #ifdef HAVE_X_WINDOWS
266 #ifndef FRAME_X_OUTPUT
267 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
270 #define INFINITY 10000000
272 Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
273 Lisp_Object Qwindow_scroll_functions
, Vwindow_scroll_functions
;
274 Lisp_Object Qwindow_text_change_functions
, Vwindow_text_change_functions
;
275 Lisp_Object Qredisplay_end_trigger_functions
, Vredisplay_end_trigger_functions
;
276 Lisp_Object Qinhibit_point_motion_hooks
;
277 Lisp_Object QCeval
, QCfile
, QCdata
, QCpropertize
;
278 Lisp_Object Qfontified
;
279 Lisp_Object Qgrow_only
;
280 Lisp_Object Qinhibit_eval_during_redisplay
;
281 Lisp_Object Qbuffer_position
, Qposition
, Qobject
;
282 Lisp_Object Qright_to_left
, Qleft_to_right
;
285 Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
288 Lisp_Object Qarrow
, Qhand
, Qtext
;
290 Lisp_Object Qrisky_local_variable
;
292 /* Holds the list (error). */
293 Lisp_Object list_of_error
;
295 /* Functions called to fontify regions of text. */
297 Lisp_Object Vfontification_functions
;
298 Lisp_Object Qfontification_functions
;
300 /* Non-nil means automatically select any window when the mouse
301 cursor moves into it. */
302 Lisp_Object Vmouse_autoselect_window
;
304 Lisp_Object Vwrap_prefix
, Qwrap_prefix
;
305 Lisp_Object Vline_prefix
, Qline_prefix
;
307 /* Non-zero means draw tool bar buttons raised when the mouse moves
310 int auto_raise_tool_bar_buttons_p
;
312 /* Non-zero means to reposition window if cursor line is only partially visible. */
314 int make_cursor_line_fully_visible_p
;
316 /* Margin below tool bar in pixels. 0 or nil means no margin.
317 If value is `internal-border-width' or `border-width',
318 the corresponding frame parameter is used. */
320 Lisp_Object Vtool_bar_border
;
322 /* Margin around tool bar buttons in pixels. */
324 Lisp_Object Vtool_bar_button_margin
;
326 /* Thickness of shadow to draw around tool bar buttons. */
328 EMACS_INT tool_bar_button_relief
;
330 /* Non-nil means automatically resize tool-bars so that all tool-bar
331 items are visible, and no blank lines remain.
333 If value is `grow-only', only make tool-bar bigger. */
335 Lisp_Object Vauto_resize_tool_bars
;
337 /* Type of tool bar. Can be symbols image, text, both or both-hroiz. */
339 Lisp_Object Vtool_bar_style
;
341 /* Maximum number of characters a label can have to be shown. */
343 EMACS_INT tool_bar_max_label_size
;
345 /* Non-zero means draw block and hollow cursor as wide as the glyph
346 under it. For example, if a block cursor is over a tab, it will be
347 drawn as wide as that tab on the display. */
349 int x_stretch_cursor_p
;
351 /* Non-nil means don't actually do any redisplay. */
353 Lisp_Object Vinhibit_redisplay
, Qinhibit_redisplay
;
355 /* Non-zero means Lisp evaluation during redisplay is inhibited. */
357 int inhibit_eval_during_redisplay
;
359 /* Names of text properties relevant for redisplay. */
361 Lisp_Object Qdisplay
;
363 /* Symbols used in text property values. */
365 Lisp_Object Vdisplay_pixels_per_inch
;
366 Lisp_Object Qspace
, QCalign_to
, QCrelative_width
, QCrelative_height
;
367 Lisp_Object Qleft_margin
, Qright_margin
, Qspace_width
, Qraise
;
370 Lisp_Object Qmargin
, Qpointer
;
371 Lisp_Object Qline_height
;
373 /* Non-nil means highlight trailing whitespace. */
375 Lisp_Object Vshow_trailing_whitespace
;
377 /* Non-nil means escape non-break space and hyphens. */
379 Lisp_Object Vnobreak_char_display
;
381 #ifdef HAVE_WINDOW_SYSTEM
383 /* Test if overflow newline into fringe. Called with iterator IT
384 at or past right window margin, and with IT->current_x set. */
386 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(IT) \
387 (!NILP (Voverflow_newline_into_fringe) \
388 && FRAME_WINDOW_P ((IT)->f) \
389 && ((IT)->bidi_it.paragraph_dir == R2L \
390 ? (WINDOW_LEFT_FRINGE_WIDTH ((IT)->w) > 0) \
391 : (WINDOW_RIGHT_FRINGE_WIDTH ((IT)->w) > 0)) \
392 && (IT)->current_x == (IT)->last_visible_x \
393 && (IT)->line_wrap != WORD_WRAP)
395 #else /* !HAVE_WINDOW_SYSTEM */
396 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) 0
397 #endif /* HAVE_WINDOW_SYSTEM */
399 /* Test if the display element loaded in IT is a space or tab
400 character. This is used to determine word wrapping. */
402 #define IT_DISPLAYING_WHITESPACE(it) \
403 (it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t'))
405 /* Non-nil means show the text cursor in void text areas
406 i.e. in blank areas after eol and eob. This used to be
407 the default in 21.3. */
409 Lisp_Object Vvoid_text_area_pointer
;
411 /* Name of the face used to highlight trailing whitespace. */
413 Lisp_Object Qtrailing_whitespace
;
415 /* Name and number of the face used to highlight escape glyphs. */
417 Lisp_Object Qescape_glyph
;
419 /* Name and number of the face used to highlight non-breaking spaces. */
421 Lisp_Object Qnobreak_space
;
423 /* The symbol `image' which is the car of the lists used to represent
424 images in Lisp. Also a tool bar style. */
428 /* The image map types. */
429 Lisp_Object QCmap
, QCpointer
;
430 Lisp_Object Qrect
, Qcircle
, Qpoly
;
432 /* Tool bar styles */
433 Lisp_Object Qtext
, Qboth
, Qboth_horiz
, Qtext_image_horiz
;
435 /* Non-zero means print newline to stdout before next mini-buffer
438 int noninteractive_need_newline
;
440 /* Non-zero means print newline to message log before next message. */
442 static int message_log_need_newline
;
444 /* Three markers that message_dolog uses.
445 It could allocate them itself, but that causes trouble
446 in handling memory-full errors. */
447 static Lisp_Object message_dolog_marker1
;
448 static Lisp_Object message_dolog_marker2
;
449 static Lisp_Object message_dolog_marker3
;
451 /* The buffer position of the first character appearing entirely or
452 partially on the line of the selected window which contains the
453 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
454 redisplay optimization in redisplay_internal. */
456 static struct text_pos this_line_start_pos
;
458 /* Number of characters past the end of the line above, including the
459 terminating newline. */
461 static struct text_pos this_line_end_pos
;
463 /* The vertical positions and the height of this line. */
465 static int this_line_vpos
;
466 static int this_line_y
;
467 static int this_line_pixel_height
;
469 /* X position at which this display line starts. Usually zero;
470 negative if first character is partially visible. */
472 static int this_line_start_x
;
474 /* Buffer that this_line_.* variables are referring to. */
476 static struct buffer
*this_line_buffer
;
478 /* Nonzero means truncate lines in all windows less wide than the
481 Lisp_Object Vtruncate_partial_width_windows
;
483 /* A flag to control how to display unibyte 8-bit character. */
485 int unibyte_display_via_language_environment
;
487 /* Nonzero means we have more than one non-mini-buffer-only frame.
488 Not guaranteed to be accurate except while parsing
489 frame-title-format. */
493 Lisp_Object Vglobal_mode_string
;
496 /* List of variables (symbols) which hold markers for overlay arrows.
497 The symbols on this list are examined during redisplay to determine
498 where to display overlay arrows. */
500 Lisp_Object Voverlay_arrow_variable_list
;
502 /* Marker for where to display an arrow on top of the buffer text. */
504 Lisp_Object Voverlay_arrow_position
;
506 /* String to display for the arrow. Only used on terminal frames. */
508 Lisp_Object Voverlay_arrow_string
;
510 /* Values of those variables at last redisplay are stored as
511 properties on `overlay-arrow-position' symbol. However, if
512 Voverlay_arrow_position is a marker, last-arrow-position is its
513 numerical position. */
515 Lisp_Object Qlast_arrow_position
, Qlast_arrow_string
;
517 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
518 properties on a symbol in overlay-arrow-variable-list. */
520 Lisp_Object Qoverlay_arrow_string
, Qoverlay_arrow_bitmap
;
522 /* Like mode-line-format, but for the title bar on a visible frame. */
524 Lisp_Object Vframe_title_format
;
526 /* Like mode-line-format, but for the title bar on an iconified frame. */
528 Lisp_Object Vicon_title_format
;
530 /* List of functions to call when a window's size changes. These
531 functions get one arg, a frame on which one or more windows' sizes
534 static Lisp_Object Vwindow_size_change_functions
;
536 Lisp_Object Qmenu_bar_update_hook
, Vmenu_bar_update_hook
;
538 /* Nonzero if an overlay arrow has been displayed in this window. */
540 static int overlay_arrow_seen
;
542 /* Nonzero means highlight the region even in nonselected windows. */
544 int highlight_nonselected_windows
;
546 /* If cursor motion alone moves point off frame, try scrolling this
547 many lines up or down if that will bring it back. */
549 static EMACS_INT scroll_step
;
551 /* Nonzero means scroll just far enough to bring point back on the
552 screen, when appropriate. */
554 static EMACS_INT scroll_conservatively
;
556 /* Recenter the window whenever point gets within this many lines of
557 the top or bottom of the window. This value is translated into a
558 pixel value by multiplying it with FRAME_LINE_HEIGHT, which means
559 that there is really a fixed pixel height scroll margin. */
561 EMACS_INT scroll_margin
;
563 /* Number of windows showing the buffer of the selected window (or
564 another buffer with the same base buffer). keyboard.c refers to
569 /* Vector containing glyphs for an ellipsis `...'. */
571 static Lisp_Object default_invis_vector
[3];
573 /* Zero means display the mode-line/header-line/menu-bar in the default face
574 (this slightly odd definition is for compatibility with previous versions
575 of emacs), non-zero means display them using their respective faces.
577 This variable is deprecated. */
579 int mode_line_inverse_video
;
581 /* Prompt to display in front of the mini-buffer contents. */
583 Lisp_Object minibuf_prompt
;
585 /* Width of current mini-buffer prompt. Only set after display_line
586 of the line that contains the prompt. */
588 int minibuf_prompt_width
;
590 /* This is the window where the echo area message was displayed. It
591 is always a mini-buffer window, but it may not be the same window
592 currently active as a mini-buffer. */
594 Lisp_Object echo_area_window
;
596 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
597 pushes the current message and the value of
598 message_enable_multibyte on the stack, the function restore_message
599 pops the stack and displays MESSAGE again. */
601 Lisp_Object Vmessage_stack
;
603 /* Nonzero means multibyte characters were enabled when the echo area
604 message was specified. */
606 int message_enable_multibyte
;
608 /* Nonzero if we should redraw the mode lines on the next redisplay. */
610 int update_mode_lines
;
612 /* Nonzero if window sizes or contents have changed since last
613 redisplay that finished. */
615 int windows_or_buffers_changed
;
617 /* Nonzero means a frame's cursor type has been changed. */
619 int cursor_type_changed
;
621 /* Nonzero after display_mode_line if %l was used and it displayed a
624 int line_number_displayed
;
626 /* Maximum buffer size for which to display line numbers. */
628 Lisp_Object Vline_number_display_limit
;
630 /* Line width to consider when repositioning for line number display. */
632 static EMACS_INT line_number_display_limit_width
;
634 /* Number of lines to keep in the message log buffer. t means
635 infinite. nil means don't log at all. */
637 Lisp_Object Vmessage_log_max
;
639 /* The name of the *Messages* buffer, a string. */
641 static Lisp_Object Vmessages_buffer_name
;
643 /* Current, index 0, and last displayed echo area message. Either
644 buffers from echo_buffers, or nil to indicate no message. */
646 Lisp_Object echo_area_buffer
[2];
648 /* The buffers referenced from echo_area_buffer. */
650 static Lisp_Object echo_buffer
[2];
652 /* A vector saved used in with_area_buffer to reduce consing. */
654 static Lisp_Object Vwith_echo_area_save_vector
;
656 /* Non-zero means display_echo_area should display the last echo area
657 message again. Set by redisplay_preserve_echo_area. */
659 static int display_last_displayed_message_p
;
661 /* Nonzero if echo area is being used by print; zero if being used by
664 int message_buf_print
;
666 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
668 Lisp_Object Qinhibit_menubar_update
;
669 int inhibit_menubar_update
;
671 /* When evaluating expressions from menu bar items (enable conditions,
672 for instance), this is the frame they are being processed for. */
674 Lisp_Object Vmenu_updating_frame
;
676 /* Maximum height for resizing mini-windows. Either a float
677 specifying a fraction of the available height, or an integer
678 specifying a number of lines. */
680 Lisp_Object Vmax_mini_window_height
;
682 /* Non-zero means messages should be displayed with truncated
683 lines instead of being continued. */
685 int message_truncate_lines
;
686 Lisp_Object Qmessage_truncate_lines
;
688 /* Set to 1 in clear_message to make redisplay_internal aware
689 of an emptied echo area. */
691 static int message_cleared_p
;
693 /* How to blink the default frame cursor off. */
694 Lisp_Object Vblink_cursor_alist
;
696 /* A scratch glyph row with contents used for generating truncation
697 glyphs. Also used in direct_output_for_insert. */
699 #define MAX_SCRATCH_GLYPHS 100
700 struct glyph_row scratch_glyph_row
;
701 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
703 /* Ascent and height of the last line processed by move_it_to. */
705 static int last_max_ascent
, last_height
;
707 /* Non-zero if there's a help-echo in the echo area. */
709 int help_echo_showing_p
;
711 /* If >= 0, computed, exact values of mode-line and header-line height
712 to use in the macros CURRENT_MODE_LINE_HEIGHT and
713 CURRENT_HEADER_LINE_HEIGHT. */
715 int current_mode_line_height
, current_header_line_height
;
717 /* The maximum distance to look ahead for text properties. Values
718 that are too small let us call compute_char_face and similar
719 functions too often which is expensive. Values that are too large
720 let us call compute_char_face and alike too often because we
721 might not be interested in text properties that far away. */
723 #define TEXT_PROP_DISTANCE_LIMIT 100
727 /* Variables to turn off display optimizations from Lisp. */
729 int inhibit_try_window_id
, inhibit_try_window_reusing
;
730 int inhibit_try_cursor_movement
;
732 /* Non-zero means print traces of redisplay if compiled with
735 int trace_redisplay_p
;
737 #endif /* GLYPH_DEBUG */
739 #ifdef DEBUG_TRACE_MOVE
740 /* Non-zero means trace with TRACE_MOVE to stderr. */
743 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
745 #define TRACE_MOVE(x) (void) 0
748 /* Non-zero means automatically scroll windows horizontally to make
751 int automatic_hscrolling_p
;
752 Lisp_Object Qauto_hscroll_mode
;
754 /* How close to the margin can point get before the window is scrolled
756 EMACS_INT hscroll_margin
;
758 /* How much to scroll horizontally when point is inside the above margin. */
759 Lisp_Object Vhscroll_step
;
761 /* The variable `resize-mini-windows'. If nil, don't resize
762 mini-windows. If t, always resize them to fit the text they
763 display. If `grow-only', let mini-windows grow only until they
766 Lisp_Object Vresize_mini_windows
;
768 /* Buffer being redisplayed -- for redisplay_window_error. */
770 struct buffer
*displayed_buffer
;
772 /* Space between overline and text. */
774 EMACS_INT overline_margin
;
776 /* Require underline to be at least this many screen pixels below baseline
777 This to avoid underline "merging" with the base of letters at small
778 font sizes, particularly when x_use_underline_position_properties is on. */
780 EMACS_INT underline_minimum_offset
;
782 /* Value returned from text property handlers (see below). */
787 HANDLED_RECOMPUTE_PROPS
,
788 HANDLED_OVERLAY_STRING_CONSUMED
,
792 /* A description of text properties that redisplay is interested
797 /* The name of the property. */
800 /* A unique index for the property. */
803 /* A handler function called to set up iterator IT from the property
804 at IT's current position. Value is used to steer handle_stop. */
805 enum prop_handled (*handler
) (struct it
*it
);
808 static enum prop_handled
handle_face_prop (struct it
*);
809 static enum prop_handled
handle_invisible_prop (struct it
*);
810 static enum prop_handled
handle_display_prop (struct it
*);
811 static enum prop_handled
handle_composition_prop (struct it
*);
812 static enum prop_handled
handle_overlay_change (struct it
*);
813 static enum prop_handled
handle_fontified_prop (struct it
*);
815 /* Properties handled by iterators. */
817 static struct props it_props
[] =
819 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
820 /* Handle `face' before `display' because some sub-properties of
821 `display' need to know the face. */
822 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
823 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
824 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
825 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
829 /* Value is the position described by X. If X is a marker, value is
830 the marker_position of X. Otherwise, value is X. */
832 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
834 /* Enumeration returned by some move_it_.* functions internally. */
838 /* Not used. Undefined value. */
841 /* Move ended at the requested buffer position or ZV. */
842 MOVE_POS_MATCH_OR_ZV
,
844 /* Move ended at the requested X pixel position. */
847 /* Move within a line ended at the end of a line that must be
851 /* Move within a line ended at the end of a line that would
852 be displayed truncated. */
855 /* Move within a line ended at a line end. */
859 /* This counter is used to clear the face cache every once in a while
860 in redisplay_internal. It is incremented for each redisplay.
861 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
864 #define CLEAR_FACE_CACHE_COUNT 500
865 static int clear_face_cache_count
;
867 /* Similarly for the image cache. */
869 #ifdef HAVE_WINDOW_SYSTEM
870 #define CLEAR_IMAGE_CACHE_COUNT 101
871 static int clear_image_cache_count
;
874 /* Non-zero while redisplay_internal is in progress. */
878 /* Non-zero means don't free realized faces. Bound while freeing
879 realized faces is dangerous because glyph matrices might still
882 int inhibit_free_realized_faces
;
883 Lisp_Object Qinhibit_free_realized_faces
;
885 /* If a string, XTread_socket generates an event to display that string.
886 (The display is done in read_char.) */
888 Lisp_Object help_echo_string
;
889 Lisp_Object help_echo_window
;
890 Lisp_Object help_echo_object
;
893 /* Temporary variable for XTread_socket. */
895 Lisp_Object previous_help_echo_string
;
897 /* Null glyph slice */
899 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
901 /* Platform-independent portion of hourglass implementation. */
903 /* Non-zero means we're allowed to display a hourglass pointer. */
904 int display_hourglass_p
;
906 /* Non-zero means an hourglass cursor is currently shown. */
907 int hourglass_shown_p
;
909 /* If non-null, an asynchronous timer that, when it expires, displays
910 an hourglass cursor on all frames. */
911 struct atimer
*hourglass_atimer
;
913 /* Number of seconds to wait before displaying an hourglass cursor. */
914 Lisp_Object Vhourglass_delay
;
916 /* Default number of seconds to wait before displaying an hourglass
918 #define DEFAULT_HOURGLASS_DELAY 1
921 /* Function prototypes. */
923 static void setup_for_ellipsis (struct it
*, int);
924 static void mark_window_display_accurate_1 (struct window
*, int);
925 static int single_display_spec_string_p (Lisp_Object
, Lisp_Object
);
926 static int display_prop_string_p (Lisp_Object
, Lisp_Object
);
927 static int cursor_row_p (struct window
*, struct glyph_row
*);
928 static int redisplay_mode_lines (Lisp_Object
, int);
929 static char *decode_mode_spec_coding (Lisp_Object
, char *, int);
931 static Lisp_Object
get_it_property (struct it
*it
, Lisp_Object prop
);
933 static void handle_line_prefix (struct it
*);
935 static void pint2str (char *, int, int);
936 static void pint2hrstr (char *, int, int);
937 static struct text_pos
run_window_scroll_functions (Lisp_Object
,
939 static void reconsider_clip_changes (struct window
*, struct buffer
*);
940 static int text_outside_line_unchanged_p (struct window
*, int, int);
941 static void store_mode_line_noprop_char (char);
942 static int store_mode_line_noprop (const unsigned char *, int, int);
943 static void x_consider_frame_title (Lisp_Object
);
944 static void handle_stop (struct it
*);
945 static void handle_stop_backwards (struct it
*, EMACS_INT
);
946 static int tool_bar_lines_needed (struct frame
*, int *);
947 static int single_display_spec_intangible_p (Lisp_Object
);
948 static void ensure_echo_area_buffers (void);
949 static Lisp_Object
unwind_with_echo_area_buffer (Lisp_Object
);
950 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
951 static int with_echo_area_buffer (struct window
*, int,
952 int (*) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
953 EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
954 static void clear_garbaged_frames (void);
955 static int current_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
956 static int truncate_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
957 static int set_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
958 static int display_echo_area (struct window
*);
959 static int display_echo_area_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
960 static int resize_mini_window_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
961 static Lisp_Object
unwind_redisplay (Lisp_Object
);
962 static int string_char_and_length (const unsigned char *, int *);
963 static struct text_pos
display_prop_end (struct it
*, Lisp_Object
,
965 static int compute_window_start_on_continuation_line (struct window
*);
966 static Lisp_Object
safe_eval_handler (Lisp_Object
);
967 static void insert_left_trunc_glyphs (struct it
*);
968 static struct glyph_row
*get_overlay_arrow_glyph_row (struct window
*,
970 static void extend_face_to_end_of_line (struct it
*);
971 static int append_space_for_newline (struct it
*, int);
972 static int cursor_row_fully_visible_p (struct window
*, int, int);
973 static int try_scrolling (Lisp_Object
, int, EMACS_INT
, EMACS_INT
, int, int);
974 static int try_cursor_movement (Lisp_Object
, struct text_pos
, int *);
975 static int trailing_whitespace_p (int);
976 static int message_log_check_duplicate (int, int, int, int);
977 static void push_it (struct it
*);
978 static void pop_it (struct it
*);
979 static void sync_frame_with_window_matrix_rows (struct window
*);
980 static void select_frame_for_redisplay (Lisp_Object
);
981 static void redisplay_internal (int);
982 static int echo_area_display (int);
983 static void redisplay_windows (Lisp_Object
);
984 static void redisplay_window (Lisp_Object
, int);
985 static Lisp_Object
redisplay_window_error (Lisp_Object
);
986 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
987 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
988 static int update_menu_bar (struct frame
*, int, int);
989 static int try_window_reusing_current_matrix (struct window
*);
990 static int try_window_id (struct window
*);
991 static int display_line (struct it
*);
992 static int display_mode_lines (struct window
*);
993 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
994 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int);
995 static int store_mode_line_string (char *, Lisp_Object
, int, int, int, Lisp_Object
);
996 static char *decode_mode_spec (struct window
*, int, int, int,
998 static void display_menu_bar (struct window
*);
999 static int display_count_lines (int, int, int, int, int *);
1000 static int display_string (unsigned char *, Lisp_Object
, Lisp_Object
,
1001 EMACS_INT
, EMACS_INT
, struct it
*, int, int, int, int);
1002 static void compute_line_metrics (struct it
*);
1003 static void run_redisplay_end_trigger_hook (struct it
*);
1004 static int get_overlay_strings (struct it
*, int);
1005 static int get_overlay_strings_1 (struct it
*, int, int);
1006 static void next_overlay_string (struct it
*);
1007 static void reseat (struct it
*, struct text_pos
, int);
1008 static void reseat_1 (struct it
*, struct text_pos
, int);
1009 static void back_to_previous_visible_line_start (struct it
*);
1010 void reseat_at_previous_visible_line_start (struct it
*);
1011 static void reseat_at_next_visible_line_start (struct it
*, int);
1012 static int next_element_from_ellipsis (struct it
*);
1013 static int next_element_from_display_vector (struct it
*);
1014 static int next_element_from_string (struct it
*);
1015 static int next_element_from_c_string (struct it
*);
1016 static int next_element_from_buffer (struct it
*);
1017 static int next_element_from_composition (struct it
*);
1018 static int next_element_from_image (struct it
*);
1019 static int next_element_from_stretch (struct it
*);
1020 static void load_overlay_strings (struct it
*, int);
1021 static int init_from_display_pos (struct it
*, struct window
*,
1022 struct display_pos
*);
1023 static void reseat_to_string (struct it
*, unsigned char *,
1024 Lisp_Object
, int, int, int, int);
1025 static enum move_it_result
1026 move_it_in_display_line_to (struct it
*, EMACS_INT
, int,
1027 enum move_operation_enum
);
1028 void move_it_vertically_backward (struct it
*, int);
1029 static void init_to_row_start (struct it
*, struct window
*,
1030 struct glyph_row
*);
1031 static int init_to_row_end (struct it
*, struct window
*,
1032 struct glyph_row
*);
1033 static void back_to_previous_line_start (struct it
*);
1034 static int forward_to_next_line_start (struct it
*, int *);
1035 static struct text_pos
string_pos_nchars_ahead (struct text_pos
,
1037 static struct text_pos
string_pos (int, Lisp_Object
);
1038 static struct text_pos
c_string_pos (int, unsigned char *, int);
1039 static int number_of_chars (unsigned char *, int);
1040 static void compute_stop_pos (struct it
*);
1041 static void compute_string_pos (struct text_pos
*, struct text_pos
,
1043 static int face_before_or_after_it_pos (struct it
*, int);
1044 static EMACS_INT
next_overlay_change (EMACS_INT
);
1045 static int handle_single_display_spec (struct it
*, Lisp_Object
,
1046 Lisp_Object
, Lisp_Object
,
1047 struct text_pos
*, int);
1048 static int underlying_face_id (struct it
*);
1049 static int in_ellipses_for_invisible_text_p (struct display_pos
*,
1052 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
1053 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
1055 #ifdef HAVE_WINDOW_SYSTEM
1057 static void update_tool_bar (struct frame
*, int);
1058 static void build_desired_tool_bar_string (struct frame
*f
);
1059 static int redisplay_tool_bar (struct frame
*);
1060 static void display_tool_bar_line (struct it
*, int);
1061 static void notice_overwritten_cursor (struct window
*,
1062 enum glyph_row_area
,
1063 int, int, int, int);
1064 static void append_stretch_glyph (struct it
*, Lisp_Object
,
1069 #endif /* HAVE_WINDOW_SYSTEM */
1072 /***********************************************************************
1073 Window display dimensions
1074 ***********************************************************************/
1076 /* Return the bottom boundary y-position for text lines in window W.
1077 This is the first y position at which a line cannot start.
1078 It is relative to the top of the window.
1080 This is the height of W minus the height of a mode line, if any. */
1083 window_text_bottom_y (struct window
*w
)
1085 int height
= WINDOW_TOTAL_HEIGHT (w
);
1087 if (WINDOW_WANTS_MODELINE_P (w
))
1088 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
1092 /* Return the pixel width of display area AREA of window W. AREA < 0
1093 means return the total width of W, not including fringes to
1094 the left and right of the window. */
1097 window_box_width (struct window
*w
, int area
)
1099 int cols
= XFASTINT (w
->total_cols
);
1102 if (!w
->pseudo_window_p
)
1104 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
1106 if (area
== TEXT_AREA
)
1108 if (INTEGERP (w
->left_margin_cols
))
1109 cols
-= XFASTINT (w
->left_margin_cols
);
1110 if (INTEGERP (w
->right_margin_cols
))
1111 cols
-= XFASTINT (w
->right_margin_cols
);
1112 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
1114 else if (area
== LEFT_MARGIN_AREA
)
1116 cols
= (INTEGERP (w
->left_margin_cols
)
1117 ? XFASTINT (w
->left_margin_cols
) : 0);
1120 else if (area
== RIGHT_MARGIN_AREA
)
1122 cols
= (INTEGERP (w
->right_margin_cols
)
1123 ? XFASTINT (w
->right_margin_cols
) : 0);
1128 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
1132 /* Return the pixel height of the display area of window W, not
1133 including mode lines of W, if any. */
1136 window_box_height (struct window
*w
)
1138 struct frame
*f
= XFRAME (w
->frame
);
1139 int height
= WINDOW_TOTAL_HEIGHT (w
);
1141 xassert (height
>= 0);
1143 /* Note: the code below that determines the mode-line/header-line
1144 height is essentially the same as that contained in the macro
1145 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
1146 the appropriate glyph row has its `mode_line_p' flag set,
1147 and if it doesn't, uses estimate_mode_line_height instead. */
1149 if (WINDOW_WANTS_MODELINE_P (w
))
1151 struct glyph_row
*ml_row
1152 = (w
->current_matrix
&& w
->current_matrix
->rows
1153 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1155 if (ml_row
&& ml_row
->mode_line_p
)
1156 height
-= ml_row
->height
;
1158 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1161 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1163 struct glyph_row
*hl_row
1164 = (w
->current_matrix
&& w
->current_matrix
->rows
1165 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1167 if (hl_row
&& hl_row
->mode_line_p
)
1168 height
-= hl_row
->height
;
1170 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1173 /* With a very small font and a mode-line that's taller than
1174 default, we might end up with a negative height. */
1175 return max (0, height
);
1178 /* Return the window-relative coordinate of the left edge of display
1179 area AREA of window W. AREA < 0 means return the left edge of the
1180 whole window, to the right of the left fringe of W. */
1183 window_box_left_offset (struct window
*w
, int area
)
1187 if (w
->pseudo_window_p
)
1190 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1192 if (area
== TEXT_AREA
)
1193 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1194 + window_box_width (w
, LEFT_MARGIN_AREA
));
1195 else if (area
== RIGHT_MARGIN_AREA
)
1196 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1197 + window_box_width (w
, LEFT_MARGIN_AREA
)
1198 + window_box_width (w
, TEXT_AREA
)
1199 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1201 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1202 else if (area
== LEFT_MARGIN_AREA
1203 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1204 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1210 /* Return the window-relative coordinate of the right edge of display
1211 area AREA of window W. AREA < 0 means return the left edge of the
1212 whole window, to the left of the right fringe of W. */
1215 window_box_right_offset (struct window
*w
, int area
)
1217 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1220 /* Return the frame-relative coordinate of the left edge of display
1221 area AREA of window W. AREA < 0 means return the left edge of the
1222 whole window, to the right of the left fringe of W. */
1225 window_box_left (struct window
*w
, int area
)
1227 struct frame
*f
= XFRAME (w
->frame
);
1230 if (w
->pseudo_window_p
)
1231 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1233 x
= (WINDOW_LEFT_EDGE_X (w
)
1234 + window_box_left_offset (w
, area
));
1240 /* Return the frame-relative coordinate of the right edge of display
1241 area AREA of window W. AREA < 0 means return the left edge of the
1242 whole window, to the left of the right fringe of W. */
1245 window_box_right (struct window
*w
, int area
)
1247 return window_box_left (w
, area
) + window_box_width (w
, area
);
1250 /* Get the bounding box of the display area AREA of window W, without
1251 mode lines, in frame-relative coordinates. AREA < 0 means the
1252 whole window, not including the left and right fringes of
1253 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1254 coordinates of the upper-left corner of the box. Return in
1255 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1258 window_box (struct window
*w
, int area
, int *box_x
, int *box_y
,
1259 int *box_width
, int *box_height
)
1262 *box_width
= window_box_width (w
, area
);
1264 *box_height
= window_box_height (w
);
1266 *box_x
= window_box_left (w
, area
);
1269 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1270 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1271 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1276 /* Get the bounding box of the display area AREA of window W, without
1277 mode lines. AREA < 0 means the whole window, not including the
1278 left and right fringe of the window. Return in *TOP_LEFT_X
1279 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1280 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1281 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1285 window_box_edges (struct window
*w
, int area
, int *top_left_x
, int *top_left_y
,
1286 int *bottom_right_x
, int *bottom_right_y
)
1288 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1290 *bottom_right_x
+= *top_left_x
;
1291 *bottom_right_y
+= *top_left_y
;
1296 /***********************************************************************
1298 ***********************************************************************/
1300 /* Return the bottom y-position of the line the iterator IT is in.
1301 This can modify IT's settings. */
1304 line_bottom_y (struct it
*it
)
1306 int line_height
= it
->max_ascent
+ it
->max_descent
;
1307 int line_top_y
= it
->current_y
;
1309 if (line_height
== 0)
1312 line_height
= last_height
;
1313 else if (IT_CHARPOS (*it
) < ZV
)
1315 move_it_by_lines (it
, 1, 1);
1316 line_height
= (it
->max_ascent
|| it
->max_descent
1317 ? it
->max_ascent
+ it
->max_descent
1322 struct glyph_row
*row
= it
->glyph_row
;
1324 /* Use the default character height. */
1325 it
->glyph_row
= NULL
;
1326 it
->what
= IT_CHARACTER
;
1329 PRODUCE_GLYPHS (it
);
1330 line_height
= it
->ascent
+ it
->descent
;
1331 it
->glyph_row
= row
;
1335 return line_top_y
+ line_height
;
1339 /* Return 1 if position CHARPOS is visible in window W.
1340 CHARPOS < 0 means return info about WINDOW_END position.
1341 If visible, set *X and *Y to pixel coordinates of top left corner.
1342 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1343 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1346 pos_visible_p (struct window
*w
, int charpos
, int *x
, int *y
,
1347 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1350 struct text_pos top
;
1352 struct buffer
*old_buffer
= NULL
;
1354 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1357 if (XBUFFER (w
->buffer
) != current_buffer
)
1359 old_buffer
= current_buffer
;
1360 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1363 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1365 /* Compute exact mode line heights. */
1366 if (WINDOW_WANTS_MODELINE_P (w
))
1367 current_mode_line_height
1368 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1369 current_buffer
->mode_line_format
);
1371 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1372 current_header_line_height
1373 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1374 current_buffer
->header_line_format
);
1376 start_display (&it
, w
, top
);
1377 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1378 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1380 if (charpos
>= 0 && IT_CHARPOS (it
) >= charpos
)
1382 /* We have reached CHARPOS, or passed it. How the call to
1383 move_it_to can overshoot: (i) If CHARPOS is on invisible
1384 text, move_it_to stops at the end of the invisible text,
1385 after CHARPOS. (ii) If CHARPOS is in a display vector,
1386 move_it_to stops on its last glyph. */
1387 int top_x
= it
.current_x
;
1388 int top_y
= it
.current_y
;
1389 enum it_method it_method
= it
.method
;
1390 /* Calling line_bottom_y may change it.method, it.position, etc. */
1391 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1392 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1394 if (top_y
< window_top_y
)
1395 visible_p
= bottom_y
> window_top_y
;
1396 else if (top_y
< it
.last_visible_y
)
1400 if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1402 /* We stopped on the last glyph of a display vector.
1403 Try and recompute. Hack alert! */
1404 if (charpos
< 2 || top
.charpos
>= charpos
)
1405 top_x
= it
.glyph_row
->x
;
1409 start_display (&it2
, w
, top
);
1410 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1411 get_next_display_element (&it2
);
1412 PRODUCE_GLYPHS (&it2
);
1413 if (ITERATOR_AT_END_OF_LINE_P (&it2
)
1414 || it2
.current_x
> it2
.last_visible_x
)
1415 top_x
= it
.glyph_row
->x
;
1418 top_x
= it2
.current_x
;
1419 top_y
= it2
.current_y
;
1425 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1426 *rtop
= max (0, window_top_y
- top_y
);
1427 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1428 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1429 - max (top_y
, window_top_y
)));
1438 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1439 move_it_by_lines (&it
, 1, 0);
1440 if (charpos
< IT_CHARPOS (it
)
1441 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1444 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1446 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1447 *rtop
= max (0, -it2
.current_y
);
1448 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1449 - it
.last_visible_y
));
1450 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1452 - max (it2
.current_y
,
1453 WINDOW_HEADER_LINE_HEIGHT (w
))));
1459 set_buffer_internal_1 (old_buffer
);
1461 current_header_line_height
= current_mode_line_height
= -1;
1463 if (visible_p
&& XFASTINT (w
->hscroll
) > 0)
1464 *x
-= XFASTINT (w
->hscroll
) * WINDOW_FRAME_COLUMN_WIDTH (w
);
1467 /* Debugging code. */
1469 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1470 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1472 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1479 /* Return the next character from STR which is MAXLEN bytes long.
1480 Return in *LEN the length of the character. This is like
1481 STRING_CHAR_AND_LENGTH but never returns an invalid character. If
1482 we find one, we return a `?', but with the length of the invalid
1486 string_char_and_length (const unsigned char *str
, int *len
)
1490 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1491 if (!CHAR_VALID_P (c
, 1))
1492 /* We may not change the length here because other places in Emacs
1493 don't use this function, i.e. they silently accept invalid
1502 /* Given a position POS containing a valid character and byte position
1503 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1505 static struct text_pos
1506 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, int nchars
)
1508 xassert (STRINGP (string
) && nchars
>= 0);
1510 if (STRING_MULTIBYTE (string
))
1512 int rest
= SBYTES (string
) - BYTEPOS (pos
);
1513 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1518 string_char_and_length (p
, &len
);
1519 p
+= len
, rest
-= len
;
1520 xassert (rest
>= 0);
1522 BYTEPOS (pos
) += len
;
1526 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1532 /* Value is the text position, i.e. character and byte position,
1533 for character position CHARPOS in STRING. */
1535 static INLINE
struct text_pos
1536 string_pos (int charpos
, Lisp_Object string
)
1538 struct text_pos pos
;
1539 xassert (STRINGP (string
));
1540 xassert (charpos
>= 0);
1541 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1546 /* Value is a text position, i.e. character and byte position, for
1547 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1548 means recognize multibyte characters. */
1550 static struct text_pos
1551 c_string_pos (int charpos
, unsigned char *s
, int multibyte_p
)
1553 struct text_pos pos
;
1555 xassert (s
!= NULL
);
1556 xassert (charpos
>= 0);
1560 int rest
= strlen (s
), len
;
1562 SET_TEXT_POS (pos
, 0, 0);
1565 string_char_and_length (s
, &len
);
1566 s
+= len
, rest
-= len
;
1567 xassert (rest
>= 0);
1569 BYTEPOS (pos
) += len
;
1573 SET_TEXT_POS (pos
, charpos
, charpos
);
1579 /* Value is the number of characters in C string S. MULTIBYTE_P
1580 non-zero means recognize multibyte characters. */
1583 number_of_chars (unsigned char *s
, int multibyte_p
)
1589 int rest
= strlen (s
), len
;
1590 unsigned char *p
= (unsigned char *) s
;
1592 for (nchars
= 0; rest
> 0; ++nchars
)
1594 string_char_and_length (p
, &len
);
1595 rest
-= len
, p
+= len
;
1599 nchars
= strlen (s
);
1605 /* Compute byte position NEWPOS->bytepos corresponding to
1606 NEWPOS->charpos. POS is a known position in string STRING.
1607 NEWPOS->charpos must be >= POS.charpos. */
1610 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1612 xassert (STRINGP (string
));
1613 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1615 if (STRING_MULTIBYTE (string
))
1616 *newpos
= string_pos_nchars_ahead (pos
, string
,
1617 CHARPOS (*newpos
) - CHARPOS (pos
));
1619 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1623 Return an estimation of the pixel height of mode or header lines on
1624 frame F. FACE_ID specifies what line's height to estimate. */
1627 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1629 #ifdef HAVE_WINDOW_SYSTEM
1630 if (FRAME_WINDOW_P (f
))
1632 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1634 /* This function is called so early when Emacs starts that the face
1635 cache and mode line face are not yet initialized. */
1636 if (FRAME_FACE_CACHE (f
))
1638 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1642 height
= FONT_HEIGHT (face
->font
);
1643 if (face
->box_line_width
> 0)
1644 height
+= 2 * face
->box_line_width
;
1655 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1656 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1657 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1658 not force the value into range. */
1661 pixel_to_glyph_coords (FRAME_PTR f
, register int pix_x
, register int pix_y
,
1662 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1665 #ifdef HAVE_WINDOW_SYSTEM
1666 if (FRAME_WINDOW_P (f
))
1668 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1669 even for negative values. */
1671 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1673 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1675 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1676 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1679 STORE_NATIVE_RECT (*bounds
,
1680 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1681 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1682 FRAME_COLUMN_WIDTH (f
) - 1,
1683 FRAME_LINE_HEIGHT (f
) - 1);
1689 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1690 pix_x
= FRAME_TOTAL_COLS (f
);
1694 else if (pix_y
> FRAME_LINES (f
))
1695 pix_y
= FRAME_LINES (f
);
1705 /* Given HPOS/VPOS in the current matrix of W, return corresponding
1706 frame-relative pixel positions in *FRAME_X and *FRAME_Y. If we
1707 can't tell the positions because W's display is not up to date,
1711 glyph_to_pixel_coords (struct window
*w
, int hpos
, int vpos
,
1712 int *frame_x
, int *frame_y
)
1714 #ifdef HAVE_WINDOW_SYSTEM
1715 if (FRAME_WINDOW_P (XFRAME (WINDOW_FRAME (w
))))
1719 xassert (hpos
>= 0 && hpos
< w
->current_matrix
->matrix_w
);
1720 xassert (vpos
>= 0 && vpos
< w
->current_matrix
->matrix_h
);
1722 if (display_completed
)
1724 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
1725 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1726 struct glyph
*end
= glyph
+ min (hpos
, row
->used
[TEXT_AREA
]);
1732 hpos
+= glyph
->pixel_width
;
1736 /* If first glyph is partially visible, its first visible position is still 0. */
1748 *frame_x
= WINDOW_TO_FRAME_PIXEL_X (w
, hpos
);
1749 *frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, vpos
);
1760 #ifdef HAVE_WINDOW_SYSTEM
1762 /* Find the glyph under window-relative coordinates X/Y in window W.
1763 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1764 strings. Return in *HPOS and *VPOS the row and column number of
1765 the glyph found. Return in *AREA the glyph area containing X.
1766 Value is a pointer to the glyph found or null if X/Y is not on
1767 text, or we can't tell because W's current matrix is not up to
1772 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1773 int *dx
, int *dy
, int *area
)
1775 struct glyph
*glyph
, *end
;
1776 struct glyph_row
*row
= NULL
;
1779 /* Find row containing Y. Give up if some row is not enabled. */
1780 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1782 row
= MATRIX_ROW (w
->current_matrix
, i
);
1783 if (!row
->enabled_p
)
1785 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1792 /* Give up if Y is not in the window. */
1793 if (i
== w
->current_matrix
->nrows
)
1796 /* Get the glyph area containing X. */
1797 if (w
->pseudo_window_p
)
1804 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1806 *area
= LEFT_MARGIN_AREA
;
1807 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1809 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1812 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1816 *area
= RIGHT_MARGIN_AREA
;
1817 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1821 /* Find glyph containing X. */
1822 glyph
= row
->glyphs
[*area
];
1823 end
= glyph
+ row
->used
[*area
];
1825 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1827 x
-= glyph
->pixel_width
;
1837 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1840 *hpos
= glyph
- row
->glyphs
[*area
];
1846 Convert frame-relative x/y to coordinates relative to window W.
1847 Takes pseudo-windows into account. */
1850 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1852 if (w
->pseudo_window_p
)
1854 /* A pseudo-window is always full-width, and starts at the
1855 left edge of the frame, plus a frame border. */
1856 struct frame
*f
= XFRAME (w
->frame
);
1857 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1858 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1862 *x
-= WINDOW_LEFT_EDGE_X (w
);
1863 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1868 Return in RECTS[] at most N clipping rectangles for glyph string S.
1869 Return the number of stored rectangles. */
1872 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
1879 if (s
->row
->full_width_p
)
1881 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1882 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1883 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1885 /* Unless displaying a mode or menu bar line, which are always
1886 fully visible, clip to the visible part of the row. */
1887 if (s
->w
->pseudo_window_p
)
1888 r
.height
= s
->row
->visible_height
;
1890 r
.height
= s
->height
;
1894 /* This is a text line that may be partially visible. */
1895 r
.x
= window_box_left (s
->w
, s
->area
);
1896 r
.width
= window_box_width (s
->w
, s
->area
);
1897 r
.height
= s
->row
->visible_height
;
1901 if (r
.x
< s
->clip_head
->x
)
1903 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1904 r
.width
-= s
->clip_head
->x
- r
.x
;
1907 r
.x
= s
->clip_head
->x
;
1910 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1912 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1913 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1918 /* If S draws overlapping rows, it's sufficient to use the top and
1919 bottom of the window for clipping because this glyph string
1920 intentionally draws over other lines. */
1921 if (s
->for_overlaps
)
1923 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1924 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1926 /* Alas, the above simple strategy does not work for the
1927 environments with anti-aliased text: if the same text is
1928 drawn onto the same place multiple times, it gets thicker.
1929 If the overlap we are processing is for the erased cursor, we
1930 take the intersection with the rectagle of the cursor. */
1931 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
1933 XRectangle rc
, r_save
= r
;
1935 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
1936 rc
.y
= s
->w
->phys_cursor
.y
;
1937 rc
.width
= s
->w
->phys_cursor_width
;
1938 rc
.height
= s
->w
->phys_cursor_height
;
1940 x_intersect_rectangles (&r_save
, &rc
, &r
);
1945 /* Don't use S->y for clipping because it doesn't take partially
1946 visible lines into account. For example, it can be negative for
1947 partially visible lines at the top of a window. */
1948 if (!s
->row
->full_width_p
1949 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
1950 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1952 r
.y
= max (0, s
->row
->y
);
1955 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
1957 /* If drawing the cursor, don't let glyph draw outside its
1958 advertised boundaries. Cleartype does this under some circumstances. */
1959 if (s
->hl
== DRAW_CURSOR
)
1961 struct glyph
*glyph
= s
->first_glyph
;
1966 r
.width
-= s
->x
- r
.x
;
1969 r
.width
= min (r
.width
, glyph
->pixel_width
);
1971 /* If r.y is below window bottom, ensure that we still see a cursor. */
1972 height
= min (glyph
->ascent
+ glyph
->descent
,
1973 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
1974 max_y
= window_text_bottom_y (s
->w
) - height
;
1975 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
1976 if (s
->ybase
- glyph
->ascent
> max_y
)
1983 /* Don't draw cursor glyph taller than our actual glyph. */
1984 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
1985 if (height
< r
.height
)
1987 max_y
= r
.y
+ r
.height
;
1988 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
1989 r
.height
= min (max_y
- r
.y
, height
);
1996 XRectangle r_save
= r
;
1998 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
2002 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
2003 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
2005 #ifdef CONVERT_FROM_XRECT
2006 CONVERT_FROM_XRECT (r
, *rects
);
2014 /* If we are processing overlapping and allowed to return
2015 multiple clipping rectangles, we exclude the row of the glyph
2016 string from the clipping rectangle. This is to avoid drawing
2017 the same text on the environment with anti-aliasing. */
2018 #ifdef CONVERT_FROM_XRECT
2021 XRectangle
*rs
= rects
;
2023 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2025 if (s
->for_overlaps
& OVERLAPS_PRED
)
2028 if (r
.y
+ r
.height
> row_y
)
2031 rs
[i
].height
= row_y
- r
.y
;
2037 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2040 if (r
.y
< row_y
+ s
->row
->visible_height
)
2042 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2044 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2045 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2054 #ifdef CONVERT_FROM_XRECT
2055 for (i
= 0; i
< n
; i
++)
2056 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2063 Return in *NR the clipping rectangle for glyph string S. */
2066 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
2068 get_glyph_string_clip_rects (s
, nr
, 1);
2073 Return the position and height of the phys cursor in window W.
2074 Set w->phys_cursor_width to width of phys cursor.
2078 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
2079 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
2081 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2082 int x
, y
, wd
, h
, h0
, y0
;
2084 /* Compute the width of the rectangle to draw. If on a stretch
2085 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2086 rectangle as wide as the glyph, but use a canonical character
2088 wd
= glyph
->pixel_width
- 1;
2089 #if defined(HAVE_NTGUI) || defined(HAVE_NS)
2093 x
= w
->phys_cursor
.x
;
2100 if (glyph
->type
== STRETCH_GLYPH
2101 && !x_stretch_cursor_p
)
2102 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2103 w
->phys_cursor_width
= wd
;
2105 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
2107 /* If y is below window bottom, ensure that we still see a cursor. */
2108 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2110 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
2111 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
2113 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2116 h
= max (h
- (y0
- y
) + 1, h0
);
2121 y0
= window_text_bottom_y (w
) - h0
;
2129 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2130 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2135 * Remember which glyph the mouse is over.
2139 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
2143 struct glyph_row
*r
, *gr
, *end_row
;
2144 enum window_part part
;
2145 enum glyph_row_area area
;
2146 int x
, y
, width
, height
;
2148 /* Try to determine frame pixel position and size of the glyph under
2149 frame pixel coordinates X/Y on frame F. */
2151 if (!f
->glyphs_initialized_p
2152 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, &x
, &y
, 0),
2155 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2156 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2160 w
= XWINDOW (window
);
2161 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2162 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2164 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2165 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2167 if (w
->pseudo_window_p
)
2170 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2176 case ON_LEFT_MARGIN
:
2177 area
= LEFT_MARGIN_AREA
;
2180 case ON_RIGHT_MARGIN
:
2181 area
= RIGHT_MARGIN_AREA
;
2184 case ON_HEADER_LINE
:
2186 gr
= (part
== ON_HEADER_LINE
2187 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2188 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2191 goto text_glyph_row_found
;
2198 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2199 if (r
->y
+ r
->height
> y
)
2205 text_glyph_row_found
:
2208 struct glyph
*g
= gr
->glyphs
[area
];
2209 struct glyph
*end
= g
+ gr
->used
[area
];
2211 height
= gr
->height
;
2212 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2213 if (gx
+ g
->pixel_width
> x
)
2218 if (g
->type
== IMAGE_GLYPH
)
2220 /* Don't remember when mouse is over image, as
2221 image may have hot-spots. */
2222 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2225 width
= g
->pixel_width
;
2229 /* Use nominal char spacing at end of line. */
2231 gx
+= (x
/ width
) * width
;
2234 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2235 gx
+= window_box_left_offset (w
, area
);
2239 /* Use nominal line height at end of window. */
2240 gx
= (x
/ width
) * width
;
2242 gy
+= (y
/ height
) * height
;
2246 case ON_LEFT_FRINGE
:
2247 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2248 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2249 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2250 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2253 case ON_RIGHT_FRINGE
:
2254 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2255 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2256 : window_box_right_offset (w
, TEXT_AREA
));
2257 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2261 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2263 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2264 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2265 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2267 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2271 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2272 if (r
->y
+ r
->height
> y
)
2279 height
= gr
->height
;
2282 /* Use nominal line height at end of window. */
2284 gy
+= (y
/ height
) * height
;
2291 /* If there is no glyph under the mouse, then we divide the screen
2292 into a grid of the smallest glyph in the frame, and use that
2295 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2296 round down even for negative values. */
2302 gx
= (gx
/ width
) * width
;
2303 gy
= (gy
/ height
) * height
;
2308 gx
+= WINDOW_LEFT_EDGE_X (w
);
2309 gy
+= WINDOW_TOP_EDGE_Y (w
);
2312 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2314 /* Visible feedback for debugging. */
2317 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2318 f
->output_data
.x
->normal_gc
,
2319 gx
, gy
, width
, height
);
2325 #endif /* HAVE_WINDOW_SYSTEM */
2328 /***********************************************************************
2329 Lisp form evaluation
2330 ***********************************************************************/
2332 /* Error handler for safe_eval and safe_call. */
2335 safe_eval_handler (Lisp_Object arg
)
2337 add_to_log ("Error during redisplay: %s", arg
, Qnil
);
2342 /* Evaluate SEXPR and return the result, or nil if something went
2343 wrong. Prevent redisplay during the evaluation. */
2345 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
2346 Return the result, or nil if something went wrong. Prevent
2347 redisplay during the evaluation. */
2350 safe_call (int nargs
, Lisp_Object
*args
)
2354 if (inhibit_eval_during_redisplay
)
2358 int count
= SPECPDL_INDEX ();
2359 struct gcpro gcpro1
;
2362 gcpro1
.nvars
= nargs
;
2363 specbind (Qinhibit_redisplay
, Qt
);
2364 /* Use Qt to ensure debugger does not run,
2365 so there is no possibility of wanting to redisplay. */
2366 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2369 val
= unbind_to (count
, val
);
2376 /* Call function FN with one argument ARG.
2377 Return the result, or nil if something went wrong. */
2380 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2382 Lisp_Object args
[2];
2385 return safe_call (2, args
);
2388 static Lisp_Object Qeval
;
2391 safe_eval (Lisp_Object sexpr
)
2393 return safe_call1 (Qeval
, sexpr
);
2396 /* Call function FN with one argument ARG.
2397 Return the result, or nil if something went wrong. */
2400 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2402 Lisp_Object args
[3];
2406 return safe_call (3, args
);
2411 /***********************************************************************
2413 ***********************************************************************/
2417 /* Define CHECK_IT to perform sanity checks on iterators.
2418 This is for debugging. It is too slow to do unconditionally. */
2424 if (it
->method
== GET_FROM_STRING
)
2426 xassert (STRINGP (it
->string
));
2427 xassert (IT_STRING_CHARPOS (*it
) >= 0);
2431 xassert (IT_STRING_CHARPOS (*it
) < 0);
2432 if (it
->method
== GET_FROM_BUFFER
)
2434 /* Check that character and byte positions agree. */
2435 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2440 xassert (it
->current
.dpvec_index
>= 0);
2442 xassert (it
->current
.dpvec_index
< 0);
2445 #define CHECK_IT(IT) check_it ((IT))
2449 #define CHECK_IT(IT) (void) 0
2456 /* Check that the window end of window W is what we expect it
2457 to be---the last row in the current matrix displaying text. */
2460 check_window_end (w
)
2463 if (!MINI_WINDOW_P (w
)
2464 && !NILP (w
->window_end_valid
))
2466 struct glyph_row
*row
;
2467 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
2468 XFASTINT (w
->window_end_vpos
)),
2470 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2471 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2475 #define CHECK_WINDOW_END(W) check_window_end ((W))
2477 #else /* not GLYPH_DEBUG */
2479 #define CHECK_WINDOW_END(W) (void) 0
2481 #endif /* not GLYPH_DEBUG */
2485 /***********************************************************************
2486 Iterator initialization
2487 ***********************************************************************/
2489 /* Initialize IT for displaying current_buffer in window W, starting
2490 at character position CHARPOS. CHARPOS < 0 means that no buffer
2491 position is specified which is useful when the iterator is assigned
2492 a position later. BYTEPOS is the byte position corresponding to
2493 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2495 If ROW is not null, calls to produce_glyphs with IT as parameter
2496 will produce glyphs in that row.
2498 BASE_FACE_ID is the id of a base face to use. It must be one of
2499 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2500 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2501 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2503 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2504 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2505 will be initialized to use the corresponding mode line glyph row of
2506 the desired matrix of W. */
2509 init_iterator (struct it
*it
, struct window
*w
,
2510 EMACS_INT charpos
, EMACS_INT bytepos
,
2511 struct glyph_row
*row
, enum face_id base_face_id
)
2513 int highlight_region_p
;
2514 enum face_id remapped_base_face_id
= base_face_id
;
2516 /* Some precondition checks. */
2517 xassert (w
!= NULL
&& it
!= NULL
);
2518 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2521 /* If face attributes have been changed since the last redisplay,
2522 free realized faces now because they depend on face definitions
2523 that might have changed. Don't free faces while there might be
2524 desired matrices pending which reference these faces. */
2525 if (face_change_count
&& !inhibit_free_realized_faces
)
2527 face_change_count
= 0;
2528 free_all_realized_faces (Qnil
);
2531 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2532 if (! NILP (Vface_remapping_alist
))
2533 remapped_base_face_id
= lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2535 /* Use one of the mode line rows of W's desired matrix if
2539 if (base_face_id
== MODE_LINE_FACE_ID
2540 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2541 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2542 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2543 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2547 memset (it
, 0, sizeof *it
);
2548 it
->current
.overlay_string_index
= -1;
2549 it
->current
.dpvec_index
= -1;
2550 it
->base_face_id
= remapped_base_face_id
;
2552 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2554 /* The window in which we iterate over current_buffer: */
2555 XSETWINDOW (it
->window
, w
);
2557 it
->f
= XFRAME (w
->frame
);
2561 /* Extra space between lines (on window systems only). */
2562 if (base_face_id
== DEFAULT_FACE_ID
2563 && FRAME_WINDOW_P (it
->f
))
2565 if (NATNUMP (current_buffer
->extra_line_spacing
))
2566 it
->extra_line_spacing
= XFASTINT (current_buffer
->extra_line_spacing
);
2567 else if (FLOATP (current_buffer
->extra_line_spacing
))
2568 it
->extra_line_spacing
= (XFLOAT_DATA (current_buffer
->extra_line_spacing
)
2569 * FRAME_LINE_HEIGHT (it
->f
));
2570 else if (it
->f
->extra_line_spacing
> 0)
2571 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2572 it
->max_extra_line_spacing
= 0;
2575 /* If realized faces have been removed, e.g. because of face
2576 attribute changes of named faces, recompute them. When running
2577 in batch mode, the face cache of the initial frame is null. If
2578 we happen to get called, make a dummy face cache. */
2579 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2580 init_frame_faces (it
->f
);
2581 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2582 recompute_basic_faces (it
->f
);
2584 /* Current value of the `slice', `space-width', and 'height' properties. */
2585 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2586 it
->space_width
= Qnil
;
2587 it
->font_height
= Qnil
;
2588 it
->override_ascent
= -1;
2590 /* Are control characters displayed as `^C'? */
2591 it
->ctl_arrow_p
= !NILP (current_buffer
->ctl_arrow
);
2593 /* -1 means everything between a CR and the following line end
2594 is invisible. >0 means lines indented more than this value are
2596 it
->selective
= (INTEGERP (current_buffer
->selective_display
)
2597 ? XFASTINT (current_buffer
->selective_display
)
2598 : (!NILP (current_buffer
->selective_display
)
2600 it
->selective_display_ellipsis_p
2601 = !NILP (current_buffer
->selective_display_ellipses
);
2603 /* Display table to use. */
2604 it
->dp
= window_display_table (w
);
2606 /* Are multibyte characters enabled in current_buffer? */
2607 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
2609 /* Do we need to reorder bidirectional text? Not if this is a
2610 unibyte buffer: by definition, none of the single-byte characters
2611 are strong R2L, so no reordering is needed. And bidi.c doesn't
2612 support unibyte buffers anyway. */
2614 = !NILP (current_buffer
->bidi_display_reordering
) && it
->multibyte_p
;
2616 /* Non-zero if we should highlight the region. */
2618 = (!NILP (Vtransient_mark_mode
)
2619 && !NILP (current_buffer
->mark_active
)
2620 && XMARKER (current_buffer
->mark
)->buffer
!= 0);
2622 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2623 start and end of a visible region in window IT->w. Set both to
2624 -1 to indicate no region. */
2625 if (highlight_region_p
2626 /* Maybe highlight only in selected window. */
2627 && (/* Either show region everywhere. */
2628 highlight_nonselected_windows
2629 /* Or show region in the selected window. */
2630 || w
== XWINDOW (selected_window
)
2631 /* Or show the region if we are in the mini-buffer and W is
2632 the window the mini-buffer refers to. */
2633 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2634 && WINDOWP (minibuf_selected_window
)
2635 && w
== XWINDOW (minibuf_selected_window
))))
2637 int charpos
= marker_position (current_buffer
->mark
);
2638 it
->region_beg_charpos
= min (PT
, charpos
);
2639 it
->region_end_charpos
= max (PT
, charpos
);
2642 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2644 /* Get the position at which the redisplay_end_trigger hook should
2645 be run, if it is to be run at all. */
2646 if (MARKERP (w
->redisplay_end_trigger
)
2647 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2648 it
->redisplay_end_trigger_charpos
2649 = marker_position (w
->redisplay_end_trigger
);
2650 else if (INTEGERP (w
->redisplay_end_trigger
))
2651 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
2653 /* Correct bogus values of tab_width. */
2654 it
->tab_width
= XINT (current_buffer
->tab_width
);
2655 if (it
->tab_width
<= 0 || it
->tab_width
> 1000)
2658 /* Are lines in the display truncated? */
2659 if (base_face_id
!= DEFAULT_FACE_ID
2660 || XINT (it
->w
->hscroll
)
2661 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2662 && ((!NILP (Vtruncate_partial_width_windows
)
2663 && !INTEGERP (Vtruncate_partial_width_windows
))
2664 || (INTEGERP (Vtruncate_partial_width_windows
)
2665 && (WINDOW_TOTAL_COLS (it
->w
)
2666 < XINT (Vtruncate_partial_width_windows
))))))
2667 it
->line_wrap
= TRUNCATE
;
2668 else if (NILP (current_buffer
->truncate_lines
))
2669 it
->line_wrap
= NILP (current_buffer
->word_wrap
)
2670 ? WINDOW_WRAP
: WORD_WRAP
;
2672 it
->line_wrap
= TRUNCATE
;
2674 /* Get dimensions of truncation and continuation glyphs. These are
2675 displayed as fringe bitmaps under X, so we don't need them for such
2677 if (!FRAME_WINDOW_P (it
->f
))
2679 if (it
->line_wrap
== TRUNCATE
)
2681 /* We will need the truncation glyph. */
2682 xassert (it
->glyph_row
== NULL
);
2683 produce_special_glyphs (it
, IT_TRUNCATION
);
2684 it
->truncation_pixel_width
= it
->pixel_width
;
2688 /* We will need the continuation glyph. */
2689 xassert (it
->glyph_row
== NULL
);
2690 produce_special_glyphs (it
, IT_CONTINUATION
);
2691 it
->continuation_pixel_width
= it
->pixel_width
;
2694 /* Reset these values to zero because the produce_special_glyphs
2695 above has changed them. */
2696 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2697 it
->phys_ascent
= it
->phys_descent
= 0;
2700 /* Set this after getting the dimensions of truncation and
2701 continuation glyphs, so that we don't produce glyphs when calling
2702 produce_special_glyphs, above. */
2703 it
->glyph_row
= row
;
2704 it
->area
= TEXT_AREA
;
2706 /* Forget any previous info about this row being reversed. */
2708 it
->glyph_row
->reversed_p
= 0;
2710 /* Get the dimensions of the display area. The display area
2711 consists of the visible window area plus a horizontally scrolled
2712 part to the left of the window. All x-values are relative to the
2713 start of this total display area. */
2714 if (base_face_id
!= DEFAULT_FACE_ID
)
2716 /* Mode lines, menu bar in terminal frames. */
2717 it
->first_visible_x
= 0;
2718 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2723 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2724 it
->last_visible_x
= (it
->first_visible_x
2725 + window_box_width (w
, TEXT_AREA
));
2727 /* If we truncate lines, leave room for the truncator glyph(s) at
2728 the right margin. Otherwise, leave room for the continuation
2729 glyph(s). Truncation and continuation glyphs are not inserted
2730 for window-based redisplay. */
2731 if (!FRAME_WINDOW_P (it
->f
))
2733 if (it
->line_wrap
== TRUNCATE
)
2734 it
->last_visible_x
-= it
->truncation_pixel_width
;
2736 it
->last_visible_x
-= it
->continuation_pixel_width
;
2739 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2740 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2743 /* Leave room for a border glyph. */
2744 if (!FRAME_WINDOW_P (it
->f
)
2745 && !WINDOW_RIGHTMOST_P (it
->w
))
2746 it
->last_visible_x
-= 1;
2748 it
->last_visible_y
= window_text_bottom_y (w
);
2750 /* For mode lines and alike, arrange for the first glyph having a
2751 left box line if the face specifies a box. */
2752 if (base_face_id
!= DEFAULT_FACE_ID
)
2756 it
->face_id
= remapped_base_face_id
;
2758 /* If we have a boxed mode line, make the first character appear
2759 with a left box line. */
2760 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2761 if (face
->box
!= FACE_NO_BOX
)
2762 it
->start_of_box_run_p
= 1;
2765 /* If we are to reorder bidirectional text, init the bidi
2769 /* Note the paragraph direction that this buffer wants to
2771 if (EQ (current_buffer
->bidi_paragraph_direction
, Qleft_to_right
))
2772 it
->paragraph_embedding
= L2R
;
2773 else if (EQ (current_buffer
->bidi_paragraph_direction
, Qright_to_left
))
2774 it
->paragraph_embedding
= R2L
;
2776 it
->paragraph_embedding
= NEUTRAL_DIR
;
2777 bidi_init_it (charpos
, bytepos
, &it
->bidi_it
);
2780 /* If a buffer position was specified, set the iterator there,
2781 getting overlays and face properties from that position. */
2782 if (charpos
>= BUF_BEG (current_buffer
))
2784 it
->end_charpos
= ZV
;
2786 IT_CHARPOS (*it
) = charpos
;
2788 /* Compute byte position if not specified. */
2789 if (bytepos
< charpos
)
2790 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2792 IT_BYTEPOS (*it
) = bytepos
;
2794 it
->start
= it
->current
;
2796 /* Compute faces etc. */
2797 reseat (it
, it
->current
.pos
, 1);
2804 /* Initialize IT for the display of window W with window start POS. */
2807 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2809 struct glyph_row
*row
;
2810 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2812 row
= w
->desired_matrix
->rows
+ first_vpos
;
2813 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2814 it
->first_vpos
= first_vpos
;
2816 /* Don't reseat to previous visible line start if current start
2817 position is in a string or image. */
2818 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2820 int start_at_line_beg_p
;
2821 int first_y
= it
->current_y
;
2823 /* If window start is not at a line start, skip forward to POS to
2824 get the correct continuation lines width. */
2825 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2826 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2827 if (!start_at_line_beg_p
)
2831 reseat_at_previous_visible_line_start (it
);
2832 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2834 new_x
= it
->current_x
+ it
->pixel_width
;
2836 /* If lines are continued, this line may end in the middle
2837 of a multi-glyph character (e.g. a control character
2838 displayed as \003, or in the middle of an overlay
2839 string). In this case move_it_to above will not have
2840 taken us to the start of the continuation line but to the
2841 end of the continued line. */
2842 if (it
->current_x
> 0
2843 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2844 && (/* And glyph doesn't fit on the line. */
2845 new_x
> it
->last_visible_x
2846 /* Or it fits exactly and we're on a window
2848 || (new_x
== it
->last_visible_x
2849 && FRAME_WINDOW_P (it
->f
))))
2851 if (it
->current
.dpvec_index
>= 0
2852 || it
->current
.overlay_string_index
>= 0)
2854 set_iterator_to_next (it
, 1);
2855 move_it_in_display_line_to (it
, -1, -1, 0);
2858 it
->continuation_lines_width
+= it
->current_x
;
2861 /* We're starting a new display line, not affected by the
2862 height of the continued line, so clear the appropriate
2863 fields in the iterator structure. */
2864 it
->max_ascent
= it
->max_descent
= 0;
2865 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2867 it
->current_y
= first_y
;
2869 it
->current_x
= it
->hpos
= 0;
2875 /* Return 1 if POS is a position in ellipses displayed for invisible
2876 text. W is the window we display, for text property lookup. */
2879 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
2881 Lisp_Object prop
, window
;
2883 int charpos
= CHARPOS (pos
->pos
);
2885 /* If POS specifies a position in a display vector, this might
2886 be for an ellipsis displayed for invisible text. We won't
2887 get the iterator set up for delivering that ellipsis unless
2888 we make sure that it gets aware of the invisible text. */
2889 if (pos
->dpvec_index
>= 0
2890 && pos
->overlay_string_index
< 0
2891 && CHARPOS (pos
->string_pos
) < 0
2893 && (XSETWINDOW (window
, w
),
2894 prop
= Fget_char_property (make_number (charpos
),
2895 Qinvisible
, window
),
2896 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2898 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2900 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2907 /* Initialize IT for stepping through current_buffer in window W,
2908 starting at position POS that includes overlay string and display
2909 vector/ control character translation position information. Value
2910 is zero if there are overlay strings with newlines at POS. */
2913 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
2915 EMACS_INT charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
2916 int i
, overlay_strings_with_newlines
= 0;
2918 /* If POS specifies a position in a display vector, this might
2919 be for an ellipsis displayed for invisible text. We won't
2920 get the iterator set up for delivering that ellipsis unless
2921 we make sure that it gets aware of the invisible text. */
2922 if (in_ellipses_for_invisible_text_p (pos
, w
))
2928 /* Keep in mind: the call to reseat in init_iterator skips invisible
2929 text, so we might end up at a position different from POS. This
2930 is only a problem when POS is a row start after a newline and an
2931 overlay starts there with an after-string, and the overlay has an
2932 invisible property. Since we don't skip invisible text in
2933 display_line and elsewhere immediately after consuming the
2934 newline before the row start, such a POS will not be in a string,
2935 but the call to init_iterator below will move us to the
2937 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
2939 /* This only scans the current chunk -- it should scan all chunks.
2940 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
2941 to 16 in 22.1 to make this a lesser problem. */
2942 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
2944 const char *s
= SDATA (it
->overlay_strings
[i
]);
2945 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
2947 while (s
< e
&& *s
!= '\n')
2952 overlay_strings_with_newlines
= 1;
2957 /* If position is within an overlay string, set up IT to the right
2959 if (pos
->overlay_string_index
>= 0)
2963 /* If the first overlay string happens to have a `display'
2964 property for an image, the iterator will be set up for that
2965 image, and we have to undo that setup first before we can
2966 correct the overlay string index. */
2967 if (it
->method
== GET_FROM_IMAGE
)
2970 /* We already have the first chunk of overlay strings in
2971 IT->overlay_strings. Load more until the one for
2972 pos->overlay_string_index is in IT->overlay_strings. */
2973 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
2975 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
2976 it
->current
.overlay_string_index
= 0;
2979 load_overlay_strings (it
, 0);
2980 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
2984 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
2985 relative_index
= (it
->current
.overlay_string_index
2986 % OVERLAY_STRING_CHUNK_SIZE
);
2987 it
->string
= it
->overlay_strings
[relative_index
];
2988 xassert (STRINGP (it
->string
));
2989 it
->current
.string_pos
= pos
->string_pos
;
2990 it
->method
= GET_FROM_STRING
;
2993 if (CHARPOS (pos
->string_pos
) >= 0)
2995 /* Recorded position is not in an overlay string, but in another
2996 string. This can only be a string from a `display' property.
2997 IT should already be filled with that string. */
2998 it
->current
.string_pos
= pos
->string_pos
;
2999 xassert (STRINGP (it
->string
));
3002 /* Restore position in display vector translations, control
3003 character translations or ellipses. */
3004 if (pos
->dpvec_index
>= 0)
3006 if (it
->dpvec
== NULL
)
3007 get_next_display_element (it
);
3008 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3009 it
->current
.dpvec_index
= pos
->dpvec_index
;
3013 return !overlay_strings_with_newlines
;
3017 /* Initialize IT for stepping through current_buffer in window W
3018 starting at ROW->start. */
3021 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3023 init_from_display_pos (it
, w
, &row
->start
);
3024 it
->start
= row
->start
;
3025 it
->continuation_lines_width
= row
->continuation_lines_width
;
3030 /* Initialize IT for stepping through current_buffer in window W
3031 starting in the line following ROW, i.e. starting at ROW->end.
3032 Value is zero if there are overlay strings with newlines at ROW's
3036 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3040 if (init_from_display_pos (it
, w
, &row
->end
))
3042 if (row
->continued_p
)
3043 it
->continuation_lines_width
3044 = row
->continuation_lines_width
+ row
->pixel_width
;
3055 /***********************************************************************
3057 ***********************************************************************/
3059 /* Called when IT reaches IT->stop_charpos. Handle text property and
3060 overlay changes. Set IT->stop_charpos to the next position where
3064 handle_stop (struct it
*it
)
3066 enum prop_handled handled
;
3067 int handle_overlay_change_p
;
3071 it
->current
.dpvec_index
= -1;
3072 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3073 it
->ignore_overlay_strings_at_pos_p
= 0;
3076 /* Use face of preceding text for ellipsis (if invisible) */
3077 if (it
->selective_display_ellipsis_p
)
3078 it
->saved_face_id
= it
->face_id
;
3082 handled
= HANDLED_NORMALLY
;
3084 /* Call text property handlers. */
3085 for (p
= it_props
; p
->handler
; ++p
)
3087 handled
= p
->handler (it
);
3089 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3091 else if (handled
== HANDLED_RETURN
)
3093 /* We still want to show before and after strings from
3094 overlays even if the actual buffer text is replaced. */
3095 if (!handle_overlay_change_p
3097 || !get_overlay_strings_1 (it
, 0, 0))
3100 setup_for_ellipsis (it
, 0);
3101 /* When handling a display spec, we might load an
3102 empty string. In that case, discard it here. We
3103 used to discard it in handle_single_display_spec,
3104 but that causes get_overlay_strings_1, above, to
3105 ignore overlay strings that we must check. */
3106 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3110 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3114 it
->ignore_overlay_strings_at_pos_p
= 1;
3115 it
->string_from_display_prop_p
= 0;
3116 handle_overlay_change_p
= 0;
3118 handled
= HANDLED_RECOMPUTE_PROPS
;
3121 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3122 handle_overlay_change_p
= 0;
3125 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3127 /* Don't check for overlay strings below when set to deliver
3128 characters from a display vector. */
3129 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3130 handle_overlay_change_p
= 0;
3132 /* Handle overlay changes.
3133 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3134 if it finds overlays. */
3135 if (handle_overlay_change_p
)
3136 handled
= handle_overlay_change (it
);
3141 setup_for_ellipsis (it
, 0);
3145 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3147 /* Determine where to stop next. */
3148 if (handled
== HANDLED_NORMALLY
)
3149 compute_stop_pos (it
);
3153 /* Compute IT->stop_charpos from text property and overlay change
3154 information for IT's current position. */
3157 compute_stop_pos (struct it
*it
)
3159 register INTERVAL iv
, next_iv
;
3160 Lisp_Object object
, limit
, position
;
3161 EMACS_INT charpos
, bytepos
;
3163 /* If nowhere else, stop at the end. */
3164 it
->stop_charpos
= it
->end_charpos
;
3166 if (STRINGP (it
->string
))
3168 /* Strings are usually short, so don't limit the search for
3170 object
= it
->string
;
3172 charpos
= IT_STRING_CHARPOS (*it
);
3173 bytepos
= IT_STRING_BYTEPOS (*it
);
3179 /* If next overlay change is in front of the current stop pos
3180 (which is IT->end_charpos), stop there. Note: value of
3181 next_overlay_change is point-max if no overlay change
3183 charpos
= IT_CHARPOS (*it
);
3184 bytepos
= IT_BYTEPOS (*it
);
3185 pos
= next_overlay_change (charpos
);
3186 if (pos
< it
->stop_charpos
)
3187 it
->stop_charpos
= pos
;
3189 /* If showing the region, we have to stop at the region
3190 start or end because the face might change there. */
3191 if (it
->region_beg_charpos
> 0)
3193 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3194 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3195 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3196 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3199 /* Set up variables for computing the stop position from text
3200 property changes. */
3201 XSETBUFFER (object
, current_buffer
);
3202 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3205 /* Get the interval containing IT's position. Value is a null
3206 interval if there isn't such an interval. */
3207 position
= make_number (charpos
);
3208 iv
= validate_interval_range (object
, &position
, &position
, 0);
3209 if (!NULL_INTERVAL_P (iv
))
3211 Lisp_Object values_here
[LAST_PROP_IDX
];
3214 /* Get properties here. */
3215 for (p
= it_props
; p
->handler
; ++p
)
3216 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3218 /* Look for an interval following iv that has different
3220 for (next_iv
= next_interval (iv
);
3221 (!NULL_INTERVAL_P (next_iv
)
3223 || XFASTINT (limit
) > next_iv
->position
));
3224 next_iv
= next_interval (next_iv
))
3226 for (p
= it_props
; p
->handler
; ++p
)
3228 Lisp_Object new_value
;
3230 new_value
= textget (next_iv
->plist
, *p
->name
);
3231 if (!EQ (values_here
[p
->idx
], new_value
))
3239 if (!NULL_INTERVAL_P (next_iv
))
3241 if (INTEGERP (limit
)
3242 && next_iv
->position
>= XFASTINT (limit
))
3243 /* No text property change up to limit. */
3244 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3246 /* Text properties change in next_iv. */
3247 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3251 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3252 it
->stop_charpos
, it
->string
);
3254 xassert (STRINGP (it
->string
)
3255 || (it
->stop_charpos
>= BEGV
3256 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3260 /* Return the position of the next overlay change after POS in
3261 current_buffer. Value is point-max if no overlay change
3262 follows. This is like `next-overlay-change' but doesn't use
3266 next_overlay_change (EMACS_INT pos
)
3270 Lisp_Object
*overlays
;
3273 /* Get all overlays at the given position. */
3274 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3276 /* If any of these overlays ends before endpos,
3277 use its ending point instead. */
3278 for (i
= 0; i
< noverlays
; ++i
)
3283 oend
= OVERLAY_END (overlays
[i
]);
3284 oendpos
= OVERLAY_POSITION (oend
);
3285 endpos
= min (endpos
, oendpos
);
3293 /***********************************************************************
3295 ***********************************************************************/
3297 /* Handle changes in the `fontified' property of the current buffer by
3298 calling hook functions from Qfontification_functions to fontify
3301 static enum prop_handled
3302 handle_fontified_prop (struct it
*it
)
3304 Lisp_Object prop
, pos
;
3305 enum prop_handled handled
= HANDLED_NORMALLY
;
3307 if (!NILP (Vmemory_full
))
3310 /* Get the value of the `fontified' property at IT's current buffer
3311 position. (The `fontified' property doesn't have a special
3312 meaning in strings.) If the value is nil, call functions from
3313 Qfontification_functions. */
3314 if (!STRINGP (it
->string
)
3316 && !NILP (Vfontification_functions
)
3317 && !NILP (Vrun_hooks
)
3318 && (pos
= make_number (IT_CHARPOS (*it
)),
3319 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3320 /* Ignore the special cased nil value always present at EOB since
3321 no amount of fontifying will be able to change it. */
3322 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3324 int count
= SPECPDL_INDEX ();
3327 val
= Vfontification_functions
;
3328 specbind (Qfontification_functions
, Qnil
);
3330 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3331 safe_call1 (val
, pos
);
3334 Lisp_Object globals
, fn
;
3335 struct gcpro gcpro1
, gcpro2
;
3338 GCPRO2 (val
, globals
);
3340 for (; CONSP (val
); val
= XCDR (val
))
3346 /* A value of t indicates this hook has a local
3347 binding; it means to run the global binding too.
3348 In a global value, t should not occur. If it
3349 does, we must ignore it to avoid an endless
3351 for (globals
= Fdefault_value (Qfontification_functions
);
3353 globals
= XCDR (globals
))
3355 fn
= XCAR (globals
);
3357 safe_call1 (fn
, pos
);
3361 safe_call1 (fn
, pos
);
3367 unbind_to (count
, Qnil
);
3369 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3370 something. This avoids an endless loop if they failed to
3371 fontify the text for which reason ever. */
3372 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3373 handled
= HANDLED_RECOMPUTE_PROPS
;
3381 /***********************************************************************
3383 ***********************************************************************/
3385 /* Set up iterator IT from face properties at its current position.
3386 Called from handle_stop. */
3388 static enum prop_handled
3389 handle_face_prop (struct it
*it
)
3392 EMACS_INT next_stop
;
3394 if (!STRINGP (it
->string
))
3397 = face_at_buffer_position (it
->w
,
3399 it
->region_beg_charpos
,
3400 it
->region_end_charpos
,
3403 + TEXT_PROP_DISTANCE_LIMIT
),
3404 0, it
->base_face_id
);
3406 /* Is this a start of a run of characters with box face?
3407 Caveat: this can be called for a freshly initialized
3408 iterator; face_id is -1 in this case. We know that the new
3409 face will not change until limit, i.e. if the new face has a
3410 box, all characters up to limit will have one. But, as
3411 usual, we don't know whether limit is really the end. */
3412 if (new_face_id
!= it
->face_id
)
3414 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3416 /* If new face has a box but old face has not, this is
3417 the start of a run of characters with box, i.e. it has
3418 a shadow on the left side. The value of face_id of the
3419 iterator will be -1 if this is the initial call that gets
3420 the face. In this case, we have to look in front of IT's
3421 position and see whether there is a face != new_face_id. */
3422 it
->start_of_box_run_p
3423 = (new_face
->box
!= FACE_NO_BOX
3424 && (it
->face_id
>= 0
3425 || IT_CHARPOS (*it
) == BEG
3426 || new_face_id
!= face_before_it_pos (it
)));
3427 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3432 int base_face_id
, bufpos
;
3434 Lisp_Object from_overlay
3435 = (it
->current
.overlay_string_index
>= 0
3436 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3439 /* See if we got to this string directly or indirectly from
3440 an overlay property. That includes the before-string or
3441 after-string of an overlay, strings in display properties
3442 provided by an overlay, their text properties, etc.
3444 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3445 if (! NILP (from_overlay
))
3446 for (i
= it
->sp
- 1; i
>= 0; i
--)
3448 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3450 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3451 else if (! NILP (it
->stack
[i
].from_overlay
))
3452 from_overlay
= it
->stack
[i
].from_overlay
;
3454 if (!NILP (from_overlay
))
3458 if (! NILP (from_overlay
))
3460 bufpos
= IT_CHARPOS (*it
);
3461 /* For a string from an overlay, the base face depends
3462 only on text properties and ignores overlays. */
3464 = face_for_overlay_string (it
->w
,
3466 it
->region_beg_charpos
,
3467 it
->region_end_charpos
,
3470 + TEXT_PROP_DISTANCE_LIMIT
),
3478 /* For strings from a `display' property, use the face at
3479 IT's current buffer position as the base face to merge
3480 with, so that overlay strings appear in the same face as
3481 surrounding text, unless they specify their own
3483 base_face_id
= underlying_face_id (it
);
3486 new_face_id
= face_at_string_position (it
->w
,
3488 IT_STRING_CHARPOS (*it
),
3490 it
->region_beg_charpos
,
3491 it
->region_end_charpos
,
3495 /* Is this a start of a run of characters with box? Caveat:
3496 this can be called for a freshly allocated iterator; face_id
3497 is -1 is this case. We know that the new face will not
3498 change until the next check pos, i.e. if the new face has a
3499 box, all characters up to that position will have a
3500 box. But, as usual, we don't know whether that position
3501 is really the end. */
3502 if (new_face_id
!= it
->face_id
)
3504 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3505 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3507 /* If new face has a box but old face hasn't, this is the
3508 start of a run of characters with box, i.e. it has a
3509 shadow on the left side. */
3510 it
->start_of_box_run_p
3511 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3512 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3516 it
->face_id
= new_face_id
;
3517 return HANDLED_NORMALLY
;
3521 /* Return the ID of the face ``underlying'' IT's current position,
3522 which is in a string. If the iterator is associated with a
3523 buffer, return the face at IT's current buffer position.
3524 Otherwise, use the iterator's base_face_id. */
3527 underlying_face_id (struct it
*it
)
3529 int face_id
= it
->base_face_id
, i
;
3531 xassert (STRINGP (it
->string
));
3533 for (i
= it
->sp
- 1; i
>= 0; --i
)
3534 if (NILP (it
->stack
[i
].string
))
3535 face_id
= it
->stack
[i
].face_id
;
3541 /* Compute the face one character before or after the current position
3542 of IT. BEFORE_P non-zero means get the face in front of IT's
3543 position. Value is the id of the face. */
3546 face_before_or_after_it_pos (struct it
*it
, int before_p
)
3549 EMACS_INT next_check_charpos
;
3550 struct text_pos pos
;
3552 xassert (it
->s
== NULL
);
3554 if (STRINGP (it
->string
))
3556 int bufpos
, base_face_id
;
3558 /* No face change past the end of the string (for the case
3559 we are padding with spaces). No face change before the
3561 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3562 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3565 /* Set pos to the position before or after IT's current position. */
3567 pos
= string_pos (IT_STRING_CHARPOS (*it
) - 1, it
->string
);
3569 /* For composition, we must check the character after the
3571 pos
= (it
->what
== IT_COMPOSITION
3572 ? string_pos (IT_STRING_CHARPOS (*it
)
3573 + it
->cmp_it
.nchars
, it
->string
)
3574 : string_pos (IT_STRING_CHARPOS (*it
) + 1, it
->string
));
3576 if (it
->current
.overlay_string_index
>= 0)
3577 bufpos
= IT_CHARPOS (*it
);
3581 base_face_id
= underlying_face_id (it
);
3583 /* Get the face for ASCII, or unibyte. */
3584 face_id
= face_at_string_position (it
->w
,
3588 it
->region_beg_charpos
,
3589 it
->region_end_charpos
,
3590 &next_check_charpos
,
3593 /* Correct the face for charsets different from ASCII. Do it
3594 for the multibyte case only. The face returned above is
3595 suitable for unibyte text if IT->string is unibyte. */
3596 if (STRING_MULTIBYTE (it
->string
))
3598 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos
);
3599 int rest
= SBYTES (it
->string
) - BYTEPOS (pos
);
3601 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3603 c
= string_char_and_length (p
, &len
);
3604 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), it
->string
);
3609 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3610 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3613 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3614 pos
= it
->current
.pos
;
3617 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3620 if (it
->what
== IT_COMPOSITION
)
3621 /* For composition, we must check the position after the
3623 pos
.charpos
+= it
->cmp_it
.nchars
, pos
.bytepos
+= it
->len
;
3625 INC_TEXT_POS (pos
, it
->multibyte_p
);
3628 /* Determine face for CHARSET_ASCII, or unibyte. */
3629 face_id
= face_at_buffer_position (it
->w
,
3631 it
->region_beg_charpos
,
3632 it
->region_end_charpos
,
3633 &next_check_charpos
,
3636 /* Correct the face for charsets different from ASCII. Do it
3637 for the multibyte case only. The face returned above is
3638 suitable for unibyte text if current_buffer is unibyte. */
3639 if (it
->multibyte_p
)
3641 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3642 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3643 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3652 /***********************************************************************
3654 ***********************************************************************/
3656 /* Set up iterator IT from invisible properties at its current
3657 position. Called from handle_stop. */
3659 static enum prop_handled
3660 handle_invisible_prop (struct it
*it
)
3662 enum prop_handled handled
= HANDLED_NORMALLY
;
3664 if (STRINGP (it
->string
))
3666 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3668 /* Get the value of the invisible text property at the
3669 current position. Value will be nil if there is no such
3671 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3672 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3675 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3677 handled
= HANDLED_RECOMPUTE_PROPS
;
3679 /* Get the position at which the next change of the
3680 invisible text property can be found in IT->string.
3681 Value will be nil if the property value is the same for
3682 all the rest of IT->string. */
3683 XSETINT (limit
, SCHARS (it
->string
));
3684 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3687 /* Text at current position is invisible. The next
3688 change in the property is at position end_charpos.
3689 Move IT's current position to that position. */
3690 if (INTEGERP (end_charpos
)
3691 && XFASTINT (end_charpos
) < XFASTINT (limit
))
3693 struct text_pos old
;
3694 old
= it
->current
.string_pos
;
3695 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3696 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
3700 /* The rest of the string is invisible. If this is an
3701 overlay string, proceed with the next overlay string
3702 or whatever comes and return a character from there. */
3703 if (it
->current
.overlay_string_index
>= 0)
3705 next_overlay_string (it
);
3706 /* Don't check for overlay strings when we just
3707 finished processing them. */
3708 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
3712 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
3713 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
3721 EMACS_INT newpos
, next_stop
, start_charpos
, tem
;
3722 Lisp_Object pos
, prop
, overlay
;
3724 /* First of all, is there invisible text at this position? */
3725 tem
= start_charpos
= IT_CHARPOS (*it
);
3726 pos
= make_number (tem
);
3727 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
3729 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3731 /* If we are on invisible text, skip over it. */
3732 if (invis_p
&& start_charpos
< it
->end_charpos
)
3734 /* Record whether we have to display an ellipsis for the
3736 int display_ellipsis_p
= invis_p
== 2;
3738 handled
= HANDLED_RECOMPUTE_PROPS
;
3740 /* Loop skipping over invisible text. The loop is left at
3741 ZV or with IT on the first char being visible again. */
3744 /* Try to skip some invisible text. Return value is the
3745 position reached which can be equal to where we start
3746 if there is nothing invisible there. This skips both
3747 over invisible text properties and overlays with
3748 invisible property. */
3749 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
3751 /* If we skipped nothing at all we weren't at invisible
3752 text in the first place. If everything to the end of
3753 the buffer was skipped, end the loop. */
3754 if (newpos
== tem
|| newpos
>= ZV
)
3758 /* We skipped some characters but not necessarily
3759 all there are. Check if we ended up on visible
3760 text. Fget_char_property returns the property of
3761 the char before the given position, i.e. if we
3762 get invis_p = 0, this means that the char at
3763 newpos is visible. */
3764 pos
= make_number (newpos
);
3765 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
3766 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3769 /* If we ended up on invisible text, proceed to
3770 skip starting with next_stop. */
3774 /* If there are adjacent invisible texts, don't lose the
3775 second one's ellipsis. */
3777 display_ellipsis_p
= 1;
3781 /* The position newpos is now either ZV or on visible text. */
3782 if (it
->bidi_p
&& newpos
< ZV
)
3784 /* With bidi iteration, the region of invisible text
3785 could start and/or end in the middle of a non-base
3786 embedding level. Therefore, we need to skip
3787 invisible text using the bidi iterator, starting at
3788 IT's current position, until we find ourselves
3789 outside the invisible text. Skipping invisible text
3790 _after_ bidi iteration avoids affecting the visual
3791 order of the displayed text when invisible properties
3792 are added or removed. */
3793 if (it
->bidi_it
.first_elt
)
3795 /* If we were `reseat'ed to a new paragraph,
3796 determine the paragraph base direction. We need
3797 to do it now because next_element_from_buffer may
3798 not have a chance to do it, if we are going to
3799 skip any text at the beginning, which resets the
3801 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
);
3805 bidi_move_to_visually_next (&it
->bidi_it
);
3807 while (it
->stop_charpos
<= it
->bidi_it
.charpos
3808 && it
->bidi_it
.charpos
< newpos
);
3809 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3810 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
3811 /* If we overstepped NEWPOS, record its position in the
3812 iterator, so that we skip invisible text if later the
3813 bidi iteration lands us in the invisible region
3815 if (IT_CHARPOS (*it
) >= newpos
)
3816 it
->prev_stop
= newpos
;
3820 IT_CHARPOS (*it
) = newpos
;
3821 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
3824 /* If there are before-strings at the start of invisible
3825 text, and the text is invisible because of a text
3826 property, arrange to show before-strings because 20.x did
3827 it that way. (If the text is invisible because of an
3828 overlay property instead of a text property, this is
3829 already handled in the overlay code.) */
3831 && get_overlay_strings (it
, it
->stop_charpos
))
3833 handled
= HANDLED_RECOMPUTE_PROPS
;
3834 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
3836 else if (display_ellipsis_p
)
3838 /* Make sure that the glyphs of the ellipsis will get
3839 correct `charpos' values. If we would not update
3840 it->position here, the glyphs would belong to the
3841 last visible character _before_ the invisible
3842 text, which confuses `set_cursor_from_row'.
3844 We use the last invisible position instead of the
3845 first because this way the cursor is always drawn on
3846 the first "." of the ellipsis, whenever PT is inside
3847 the invisible text. Otherwise the cursor would be
3848 placed _after_ the ellipsis when the point is after the
3849 first invisible character. */
3850 if (!STRINGP (it
->object
))
3852 it
->position
.charpos
= newpos
- 1;
3853 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
3856 /* Let the ellipsis display before
3857 considering any properties of the following char.
3858 Fixes jasonr@gnu.org 01 Oct 07 bug. */
3859 handled
= HANDLED_RETURN
;
3868 /* Make iterator IT return `...' next.
3869 Replaces LEN characters from buffer. */
3872 setup_for_ellipsis (struct it
*it
, int len
)
3874 /* Use the display table definition for `...'. Invalid glyphs
3875 will be handled by the method returning elements from dpvec. */
3876 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
3878 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
3879 it
->dpvec
= v
->contents
;
3880 it
->dpend
= v
->contents
+ v
->size
;
3884 /* Default `...'. */
3885 it
->dpvec
= default_invis_vector
;
3886 it
->dpend
= default_invis_vector
+ 3;
3889 it
->dpvec_char_len
= len
;
3890 it
->current
.dpvec_index
= 0;
3891 it
->dpvec_face_id
= -1;
3893 /* Remember the current face id in case glyphs specify faces.
3894 IT's face is restored in set_iterator_to_next.
3895 saved_face_id was set to preceding char's face in handle_stop. */
3896 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
3897 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
3899 it
->method
= GET_FROM_DISPLAY_VECTOR
;
3905 /***********************************************************************
3907 ***********************************************************************/
3909 /* Set up iterator IT from `display' property at its current position.
3910 Called from handle_stop.
3911 We return HANDLED_RETURN if some part of the display property
3912 overrides the display of the buffer text itself.
3913 Otherwise we return HANDLED_NORMALLY. */
3915 static enum prop_handled
3916 handle_display_prop (struct it
*it
)
3918 Lisp_Object prop
, object
, overlay
;
3919 struct text_pos
*position
;
3920 /* Nonzero if some property replaces the display of the text itself. */
3921 int display_replaced_p
= 0;
3923 if (STRINGP (it
->string
))
3925 object
= it
->string
;
3926 position
= &it
->current
.string_pos
;
3930 XSETWINDOW (object
, it
->w
);
3931 position
= &it
->current
.pos
;
3934 /* Reset those iterator values set from display property values. */
3935 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
3936 it
->space_width
= Qnil
;
3937 it
->font_height
= Qnil
;
3940 /* We don't support recursive `display' properties, i.e. string
3941 values that have a string `display' property, that have a string
3942 `display' property etc. */
3943 if (!it
->string_from_display_prop_p
)
3944 it
->area
= TEXT_AREA
;
3946 prop
= get_char_property_and_overlay (make_number (position
->charpos
),
3947 Qdisplay
, object
, &overlay
);
3949 return HANDLED_NORMALLY
;
3950 /* Now OVERLAY is the overlay that gave us this property, or nil
3951 if it was a text property. */
3953 if (!STRINGP (it
->string
))
3954 object
= it
->w
->buffer
;
3957 /* Simple properties. */
3958 && !EQ (XCAR (prop
), Qimage
)
3959 && !EQ (XCAR (prop
), Qspace
)
3960 && !EQ (XCAR (prop
), Qwhen
)
3961 && !EQ (XCAR (prop
), Qslice
)
3962 && !EQ (XCAR (prop
), Qspace_width
)
3963 && !EQ (XCAR (prop
), Qheight
)
3964 && !EQ (XCAR (prop
), Qraise
)
3965 /* Marginal area specifications. */
3966 && !(CONSP (XCAR (prop
)) && EQ (XCAR (XCAR (prop
)), Qmargin
))
3967 && !EQ (XCAR (prop
), Qleft_fringe
)
3968 && !EQ (XCAR (prop
), Qright_fringe
)
3969 && !NILP (XCAR (prop
)))
3971 for (; CONSP (prop
); prop
= XCDR (prop
))
3973 if (handle_single_display_spec (it
, XCAR (prop
), object
, overlay
,
3974 position
, display_replaced_p
))
3976 display_replaced_p
= 1;
3977 /* If some text in a string is replaced, `position' no
3978 longer points to the position of `object'. */
3979 if (STRINGP (object
))
3984 else if (VECTORP (prop
))
3987 for (i
= 0; i
< ASIZE (prop
); ++i
)
3988 if (handle_single_display_spec (it
, AREF (prop
, i
), object
, overlay
,
3989 position
, display_replaced_p
))
3991 display_replaced_p
= 1;
3992 /* If some text in a string is replaced, `position' no
3993 longer points to the position of `object'. */
3994 if (STRINGP (object
))
4000 if (handle_single_display_spec (it
, prop
, object
, overlay
,
4002 display_replaced_p
= 1;
4005 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4009 /* Value is the position of the end of the `display' property starting
4010 at START_POS in OBJECT. */
4012 static struct text_pos
4013 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4016 struct text_pos end_pos
;
4018 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4019 Qdisplay
, object
, Qnil
);
4020 CHARPOS (end_pos
) = XFASTINT (end
);
4021 if (STRINGP (object
))
4022 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4024 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4030 /* Set up IT from a single `display' specification PROP. OBJECT
4031 is the object in which the `display' property was found. *POSITION
4032 is the position at which it was found. DISPLAY_REPLACED_P non-zero
4033 means that we previously saw a display specification which already
4034 replaced text display with something else, for example an image;
4035 we ignore such properties after the first one has been processed.
4037 OVERLAY is the overlay this `display' property came from,
4038 or nil if it was a text property.
4040 If PROP is a `space' or `image' specification, and in some other
4041 cases too, set *POSITION to the position where the `display'
4044 Value is non-zero if something was found which replaces the display
4045 of buffer or string text. */
4048 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4049 Lisp_Object overlay
, struct text_pos
*position
,
4050 int display_replaced_before_p
)
4053 Lisp_Object location
, value
;
4054 struct text_pos start_pos
, save_pos
;
4057 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4058 If the result is non-nil, use VALUE instead of SPEC. */
4060 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4069 if (!NILP (form
) && !EQ (form
, Qt
))
4071 int count
= SPECPDL_INDEX ();
4072 struct gcpro gcpro1
;
4074 /* Bind `object' to the object having the `display' property, a
4075 buffer or string. Bind `position' to the position in the
4076 object where the property was found, and `buffer-position'
4077 to the current position in the buffer. */
4078 specbind (Qobject
, object
);
4079 specbind (Qposition
, make_number (CHARPOS (*position
)));
4080 specbind (Qbuffer_position
,
4081 make_number (STRINGP (object
)
4082 ? IT_CHARPOS (*it
) : CHARPOS (*position
)));
4084 form
= safe_eval (form
);
4086 unbind_to (count
, Qnil
);
4092 /* Handle `(height HEIGHT)' specifications. */
4094 && EQ (XCAR (spec
), Qheight
)
4095 && CONSP (XCDR (spec
)))
4097 if (!FRAME_WINDOW_P (it
->f
))
4100 it
->font_height
= XCAR (XCDR (spec
));
4101 if (!NILP (it
->font_height
))
4103 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4104 int new_height
= -1;
4106 if (CONSP (it
->font_height
)
4107 && (EQ (XCAR (it
->font_height
), Qplus
)
4108 || EQ (XCAR (it
->font_height
), Qminus
))
4109 && CONSP (XCDR (it
->font_height
))
4110 && INTEGERP (XCAR (XCDR (it
->font_height
))))
4112 /* `(+ N)' or `(- N)' where N is an integer. */
4113 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4114 if (EQ (XCAR (it
->font_height
), Qplus
))
4116 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4118 else if (FUNCTIONP (it
->font_height
))
4120 /* Call function with current height as argument.
4121 Value is the new height. */
4123 height
= safe_call1 (it
->font_height
,
4124 face
->lface
[LFACE_HEIGHT_INDEX
]);
4125 if (NUMBERP (height
))
4126 new_height
= XFLOATINT (height
);
4128 else if (NUMBERP (it
->font_height
))
4130 /* Value is a multiple of the canonical char height. */
4133 face
= FACE_FROM_ID (it
->f
,
4134 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4135 new_height
= (XFLOATINT (it
->font_height
)
4136 * XINT (face
->lface
[LFACE_HEIGHT_INDEX
]));
4140 /* Evaluate IT->font_height with `height' bound to the
4141 current specified height to get the new height. */
4142 int count
= SPECPDL_INDEX ();
4144 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4145 value
= safe_eval (it
->font_height
);
4146 unbind_to (count
, Qnil
);
4148 if (NUMBERP (value
))
4149 new_height
= XFLOATINT (value
);
4153 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4159 /* Handle `(space-width WIDTH)'. */
4161 && EQ (XCAR (spec
), Qspace_width
)
4162 && CONSP (XCDR (spec
)))
4164 if (!FRAME_WINDOW_P (it
->f
))
4167 value
= XCAR (XCDR (spec
));
4168 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4169 it
->space_width
= value
;
4174 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4176 && EQ (XCAR (spec
), Qslice
))
4180 if (!FRAME_WINDOW_P (it
->f
))
4183 if (tem
= XCDR (spec
), CONSP (tem
))
4185 it
->slice
.x
= XCAR (tem
);
4186 if (tem
= XCDR (tem
), CONSP (tem
))
4188 it
->slice
.y
= XCAR (tem
);
4189 if (tem
= XCDR (tem
), CONSP (tem
))
4191 it
->slice
.width
= XCAR (tem
);
4192 if (tem
= XCDR (tem
), CONSP (tem
))
4193 it
->slice
.height
= XCAR (tem
);
4201 /* Handle `(raise FACTOR)'. */
4203 && EQ (XCAR (spec
), Qraise
)
4204 && CONSP (XCDR (spec
)))
4206 if (!FRAME_WINDOW_P (it
->f
))
4209 #ifdef HAVE_WINDOW_SYSTEM
4210 value
= XCAR (XCDR (spec
));
4211 if (NUMBERP (value
))
4213 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4214 it
->voffset
= - (XFLOATINT (value
)
4215 * (FONT_HEIGHT (face
->font
)));
4217 #endif /* HAVE_WINDOW_SYSTEM */
4222 /* Don't handle the other kinds of display specifications
4223 inside a string that we got from a `display' property. */
4224 if (it
->string_from_display_prop_p
)
4227 /* Characters having this form of property are not displayed, so
4228 we have to find the end of the property. */
4229 start_pos
= *position
;
4230 *position
= display_prop_end (it
, object
, start_pos
);
4233 /* Stop the scan at that end position--we assume that all
4234 text properties change there. */
4235 it
->stop_charpos
= position
->charpos
;
4237 /* Handle `(left-fringe BITMAP [FACE])'
4238 and `(right-fringe BITMAP [FACE])'. */
4240 && (EQ (XCAR (spec
), Qleft_fringe
)
4241 || EQ (XCAR (spec
), Qright_fringe
))
4242 && CONSP (XCDR (spec
)))
4244 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
4247 if (!FRAME_WINDOW_P (it
->f
))
4248 /* If we return here, POSITION has been advanced
4249 across the text with this property. */
4252 #ifdef HAVE_WINDOW_SYSTEM
4253 value
= XCAR (XCDR (spec
));
4254 if (!SYMBOLP (value
)
4255 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4256 /* If we return here, POSITION has been advanced
4257 across the text with this property. */
4260 if (CONSP (XCDR (XCDR (spec
))))
4262 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4263 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4269 /* Save current settings of IT so that we can restore them
4270 when we are finished with the glyph property value. */
4272 save_pos
= it
->position
;
4273 it
->position
= *position
;
4275 it
->position
= save_pos
;
4277 it
->area
= TEXT_AREA
;
4278 it
->what
= IT_IMAGE
;
4279 it
->image_id
= -1; /* no image */
4280 it
->position
= start_pos
;
4281 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4282 it
->method
= GET_FROM_IMAGE
;
4283 it
->from_overlay
= Qnil
;
4284 it
->face_id
= face_id
;
4286 /* Say that we haven't consumed the characters with
4287 `display' property yet. The call to pop_it in
4288 set_iterator_to_next will clean this up. */
4289 *position
= start_pos
;
4291 if (EQ (XCAR (spec
), Qleft_fringe
))
4293 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4294 it
->left_user_fringe_face_id
= face_id
;
4298 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4299 it
->right_user_fringe_face_id
= face_id
;
4301 #endif /* HAVE_WINDOW_SYSTEM */
4305 /* Prepare to handle `((margin left-margin) ...)',
4306 `((margin right-margin) ...)' and `((margin nil) ...)'
4307 prefixes for display specifications. */
4308 location
= Qunbound
;
4309 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4313 value
= XCDR (spec
);
4315 value
= XCAR (value
);
4318 if (EQ (XCAR (tem
), Qmargin
)
4319 && (tem
= XCDR (tem
),
4320 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4322 || EQ (tem
, Qleft_margin
)
4323 || EQ (tem
, Qright_margin
))))
4327 if (EQ (location
, Qunbound
))
4333 /* After this point, VALUE is the property after any
4334 margin prefix has been stripped. It must be a string,
4335 an image specification, or `(space ...)'.
4337 LOCATION specifies where to display: `left-margin',
4338 `right-margin' or nil. */
4340 valid_p
= (STRINGP (value
)
4341 #ifdef HAVE_WINDOW_SYSTEM
4342 || (FRAME_WINDOW_P (it
->f
) && valid_image_p (value
))
4343 #endif /* not HAVE_WINDOW_SYSTEM */
4344 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4346 if (valid_p
&& !display_replaced_before_p
)
4348 /* Save current settings of IT so that we can restore them
4349 when we are finished with the glyph property value. */
4350 save_pos
= it
->position
;
4351 it
->position
= *position
;
4353 it
->position
= save_pos
;
4354 it
->from_overlay
= overlay
;
4356 if (NILP (location
))
4357 it
->area
= TEXT_AREA
;
4358 else if (EQ (location
, Qleft_margin
))
4359 it
->area
= LEFT_MARGIN_AREA
;
4361 it
->area
= RIGHT_MARGIN_AREA
;
4363 if (STRINGP (value
))
4366 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4367 it
->current
.overlay_string_index
= -1;
4368 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4369 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4370 it
->method
= GET_FROM_STRING
;
4371 it
->stop_charpos
= 0;
4372 it
->string_from_display_prop_p
= 1;
4373 /* Say that we haven't consumed the characters with
4374 `display' property yet. The call to pop_it in
4375 set_iterator_to_next will clean this up. */
4376 if (BUFFERP (object
))
4377 *position
= start_pos
;
4379 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4381 it
->method
= GET_FROM_STRETCH
;
4383 *position
= it
->position
= start_pos
;
4385 #ifdef HAVE_WINDOW_SYSTEM
4388 it
->what
= IT_IMAGE
;
4389 it
->image_id
= lookup_image (it
->f
, value
);
4390 it
->position
= start_pos
;
4391 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4392 it
->method
= GET_FROM_IMAGE
;
4394 /* Say that we haven't consumed the characters with
4395 `display' property yet. The call to pop_it in
4396 set_iterator_to_next will clean this up. */
4397 *position
= start_pos
;
4399 #endif /* HAVE_WINDOW_SYSTEM */
4404 /* Invalid property or property not supported. Restore
4405 POSITION to what it was before. */
4406 *position
= start_pos
;
4411 /* Check if SPEC is a display sub-property value whose text should be
4412 treated as intangible. */
4415 single_display_spec_intangible_p (Lisp_Object prop
)
4417 /* Skip over `when FORM'. */
4418 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4432 /* Skip over `margin LOCATION'. If LOCATION is in the margins,
4433 we don't need to treat text as intangible. */
4434 if (EQ (XCAR (prop
), Qmargin
))
4442 || EQ (XCAR (prop
), Qleft_margin
)
4443 || EQ (XCAR (prop
), Qright_margin
))
4447 return (CONSP (prop
)
4448 && (EQ (XCAR (prop
), Qimage
)
4449 || EQ (XCAR (prop
), Qspace
)));
4453 /* Check if PROP is a display property value whose text should be
4454 treated as intangible. */
4457 display_prop_intangible_p (Lisp_Object prop
)
4460 && CONSP (XCAR (prop
))
4461 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4463 /* A list of sub-properties. */
4464 while (CONSP (prop
))
4466 if (single_display_spec_intangible_p (XCAR (prop
)))
4471 else if (VECTORP (prop
))
4473 /* A vector of sub-properties. */
4475 for (i
= 0; i
< ASIZE (prop
); ++i
)
4476 if (single_display_spec_intangible_p (AREF (prop
, i
)))
4480 return single_display_spec_intangible_p (prop
);
4486 /* Return 1 if PROP is a display sub-property value containing STRING. */
4489 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
4491 if (EQ (string
, prop
))
4494 /* Skip over `when FORM'. */
4495 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4504 /* Skip over `margin LOCATION'. */
4505 if (EQ (XCAR (prop
), Qmargin
))
4516 return CONSP (prop
) && EQ (XCAR (prop
), string
);
4520 /* Return 1 if STRING appears in the `display' property PROP. */
4523 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
4526 && CONSP (XCAR (prop
))
4527 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4529 /* A list of sub-properties. */
4530 while (CONSP (prop
))
4532 if (single_display_spec_string_p (XCAR (prop
), string
))
4537 else if (VECTORP (prop
))
4539 /* A vector of sub-properties. */
4541 for (i
= 0; i
< ASIZE (prop
); ++i
)
4542 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4546 return single_display_spec_string_p (prop
, string
);
4551 /* Look for STRING in overlays and text properties in W's buffer,
4552 between character positions FROM and TO (excluding TO).
4553 BACK_P non-zero means look back (in this case, TO is supposed to be
4555 Value is the first character position where STRING was found, or
4556 zero if it wasn't found before hitting TO.
4558 W's buffer must be current.
4560 This function may only use code that doesn't eval because it is
4561 called asynchronously from note_mouse_highlight. */
4564 string_buffer_position_lim (struct window
*w
, Lisp_Object string
,
4565 EMACS_INT from
, EMACS_INT to
, int back_p
)
4567 Lisp_Object limit
, prop
, pos
;
4570 pos
= make_number (from
);
4572 if (!back_p
) /* looking forward */
4574 limit
= make_number (min (to
, ZV
));
4575 while (!found
&& !EQ (pos
, limit
))
4577 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4578 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4581 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
4585 else /* looking back */
4587 limit
= make_number (max (to
, BEGV
));
4588 while (!found
&& !EQ (pos
, limit
))
4590 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4591 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4594 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
4599 return found
? XINT (pos
) : 0;
4602 /* Determine which buffer position in W's buffer STRING comes from.
4603 AROUND_CHARPOS is an approximate position where it could come from.
4604 Value is the buffer position or 0 if it couldn't be determined.
4606 W's buffer must be current.
4608 This function is necessary because we don't record buffer positions
4609 in glyphs generated from strings (to keep struct glyph small).
4610 This function may only use code that doesn't eval because it is
4611 called asynchronously from note_mouse_highlight. */
4614 string_buffer_position (struct window
*w
, Lisp_Object string
, EMACS_INT around_charpos
)
4616 Lisp_Object limit
, prop
, pos
;
4617 const int MAX_DISTANCE
= 1000;
4618 EMACS_INT found
= string_buffer_position_lim (w
, string
, around_charpos
,
4619 around_charpos
+ MAX_DISTANCE
,
4623 found
= string_buffer_position_lim (w
, string
, around_charpos
,
4624 around_charpos
- MAX_DISTANCE
, 1);
4630 /***********************************************************************
4631 `composition' property
4632 ***********************************************************************/
4634 /* Set up iterator IT from `composition' property at its current
4635 position. Called from handle_stop. */
4637 static enum prop_handled
4638 handle_composition_prop (struct it
*it
)
4640 Lisp_Object prop
, string
;
4641 EMACS_INT pos
, pos_byte
, start
, end
;
4643 if (STRINGP (it
->string
))
4647 pos
= IT_STRING_CHARPOS (*it
);
4648 pos_byte
= IT_STRING_BYTEPOS (*it
);
4649 string
= it
->string
;
4650 s
= SDATA (string
) + pos_byte
;
4651 it
->c
= STRING_CHAR (s
);
4655 pos
= IT_CHARPOS (*it
);
4656 pos_byte
= IT_BYTEPOS (*it
);
4658 it
->c
= FETCH_CHAR (pos_byte
);
4661 /* If there's a valid composition and point is not inside of the
4662 composition (in the case that the composition is from the current
4663 buffer), draw a glyph composed from the composition components. */
4664 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
4665 && COMPOSITION_VALID_P (start
, end
, prop
)
4666 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
4670 if (STRINGP (it
->string
))
4671 pos_byte
= string_char_to_byte (it
->string
, start
);
4673 pos_byte
= CHAR_TO_BYTE (start
);
4675 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
4678 if (it
->cmp_it
.id
>= 0)
4681 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
4682 it
->cmp_it
.nglyphs
= -1;
4686 return HANDLED_NORMALLY
;
4691 /***********************************************************************
4693 ***********************************************************************/
4695 /* The following structure is used to record overlay strings for
4696 later sorting in load_overlay_strings. */
4698 struct overlay_entry
4700 Lisp_Object overlay
;
4707 /* Set up iterator IT from overlay strings at its current position.
4708 Called from handle_stop. */
4710 static enum prop_handled
4711 handle_overlay_change (struct it
*it
)
4713 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
4714 return HANDLED_RECOMPUTE_PROPS
;
4716 return HANDLED_NORMALLY
;
4720 /* Set up the next overlay string for delivery by IT, if there is an
4721 overlay string to deliver. Called by set_iterator_to_next when the
4722 end of the current overlay string is reached. If there are more
4723 overlay strings to display, IT->string and
4724 IT->current.overlay_string_index are set appropriately here.
4725 Otherwise IT->string is set to nil. */
4728 next_overlay_string (struct it
*it
)
4730 ++it
->current
.overlay_string_index
;
4731 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
4733 /* No more overlay strings. Restore IT's settings to what
4734 they were before overlay strings were processed, and
4735 continue to deliver from current_buffer. */
4737 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
4740 || (NILP (it
->string
)
4741 && it
->method
== GET_FROM_BUFFER
4742 && it
->stop_charpos
>= BEGV
4743 && it
->stop_charpos
<= it
->end_charpos
));
4744 it
->current
.overlay_string_index
= -1;
4745 it
->n_overlay_strings
= 0;
4747 /* If we're at the end of the buffer, record that we have
4748 processed the overlay strings there already, so that
4749 next_element_from_buffer doesn't try it again. */
4750 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
4751 it
->overlay_strings_at_end_processed_p
= 1;
4755 /* There are more overlay strings to process. If
4756 IT->current.overlay_string_index has advanced to a position
4757 where we must load IT->overlay_strings with more strings, do
4759 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
4761 if (it
->current
.overlay_string_index
&& i
== 0)
4762 load_overlay_strings (it
, 0);
4764 /* Initialize IT to deliver display elements from the overlay
4766 it
->string
= it
->overlay_strings
[i
];
4767 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4768 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
4769 it
->method
= GET_FROM_STRING
;
4770 it
->stop_charpos
= 0;
4771 if (it
->cmp_it
.stop_pos
>= 0)
4772 it
->cmp_it
.stop_pos
= 0;
4779 /* Compare two overlay_entry structures E1 and E2. Used as a
4780 comparison function for qsort in load_overlay_strings. Overlay
4781 strings for the same position are sorted so that
4783 1. All after-strings come in front of before-strings, except
4784 when they come from the same overlay.
4786 2. Within after-strings, strings are sorted so that overlay strings
4787 from overlays with higher priorities come first.
4789 2. Within before-strings, strings are sorted so that overlay
4790 strings from overlays with higher priorities come last.
4792 Value is analogous to strcmp. */
4796 compare_overlay_entries (const void *e1
, const void *e2
)
4798 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
4799 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
4802 if (entry1
->after_string_p
!= entry2
->after_string_p
)
4804 /* Let after-strings appear in front of before-strings if
4805 they come from different overlays. */
4806 if (EQ (entry1
->overlay
, entry2
->overlay
))
4807 result
= entry1
->after_string_p
? 1 : -1;
4809 result
= entry1
->after_string_p
? -1 : 1;
4811 else if (entry1
->after_string_p
)
4812 /* After-strings sorted in order of decreasing priority. */
4813 result
= entry2
->priority
- entry1
->priority
;
4815 /* Before-strings sorted in order of increasing priority. */
4816 result
= entry1
->priority
- entry2
->priority
;
4822 /* Load the vector IT->overlay_strings with overlay strings from IT's
4823 current buffer position, or from CHARPOS if that is > 0. Set
4824 IT->n_overlays to the total number of overlay strings found.
4826 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
4827 a time. On entry into load_overlay_strings,
4828 IT->current.overlay_string_index gives the number of overlay
4829 strings that have already been loaded by previous calls to this
4832 IT->add_overlay_start contains an additional overlay start
4833 position to consider for taking overlay strings from, if non-zero.
4834 This position comes into play when the overlay has an `invisible'
4835 property, and both before and after-strings. When we've skipped to
4836 the end of the overlay, because of its `invisible' property, we
4837 nevertheless want its before-string to appear.
4838 IT->add_overlay_start will contain the overlay start position
4841 Overlay strings are sorted so that after-string strings come in
4842 front of before-string strings. Within before and after-strings,
4843 strings are sorted by overlay priority. See also function
4844 compare_overlay_entries. */
4847 load_overlay_strings (struct it
*it
, int charpos
)
4849 Lisp_Object overlay
, window
, str
, invisible
;
4850 struct Lisp_Overlay
*ov
;
4853 int n
= 0, i
, j
, invis_p
;
4854 struct overlay_entry
*entries
4855 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
4858 charpos
= IT_CHARPOS (*it
);
4860 /* Append the overlay string STRING of overlay OVERLAY to vector
4861 `entries' which has size `size' and currently contains `n'
4862 elements. AFTER_P non-zero means STRING is an after-string of
4864 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
4867 Lisp_Object priority; \
4871 int new_size = 2 * size; \
4872 struct overlay_entry *old = entries; \
4874 (struct overlay_entry *) alloca (new_size \
4875 * sizeof *entries); \
4876 memcpy (entries, old, size * sizeof *entries); \
4880 entries[n].string = (STRING); \
4881 entries[n].overlay = (OVERLAY); \
4882 priority = Foverlay_get ((OVERLAY), Qpriority); \
4883 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
4884 entries[n].after_string_p = (AFTER_P); \
4889 /* Process overlay before the overlay center. */
4890 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
4892 XSETMISC (overlay
, ov
);
4893 xassert (OVERLAYP (overlay
));
4894 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4895 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4900 /* Skip this overlay if it doesn't start or end at IT's current
4902 if (end
!= charpos
&& start
!= charpos
)
4905 /* Skip this overlay if it doesn't apply to IT->w. */
4906 window
= Foverlay_get (overlay
, Qwindow
);
4907 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4910 /* If the text ``under'' the overlay is invisible, both before-
4911 and after-strings from this overlay are visible; start and
4912 end position are indistinguishable. */
4913 invisible
= Foverlay_get (overlay
, Qinvisible
);
4914 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4916 /* If overlay has a non-empty before-string, record it. */
4917 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4918 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4920 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4922 /* If overlay has a non-empty after-string, record it. */
4923 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4924 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4926 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4929 /* Process overlays after the overlay center. */
4930 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
4932 XSETMISC (overlay
, ov
);
4933 xassert (OVERLAYP (overlay
));
4934 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4935 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4937 if (start
> charpos
)
4940 /* Skip this overlay if it doesn't start or end at IT's current
4942 if (end
!= charpos
&& start
!= charpos
)
4945 /* Skip this overlay if it doesn't apply to IT->w. */
4946 window
= Foverlay_get (overlay
, Qwindow
);
4947 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4950 /* If the text ``under'' the overlay is invisible, it has a zero
4951 dimension, and both before- and after-strings apply. */
4952 invisible
= Foverlay_get (overlay
, Qinvisible
);
4953 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4955 /* If overlay has a non-empty before-string, record it. */
4956 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4957 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4959 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4961 /* If overlay has a non-empty after-string, record it. */
4962 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4963 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4965 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4968 #undef RECORD_OVERLAY_STRING
4972 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
4974 /* Record the total number of strings to process. */
4975 it
->n_overlay_strings
= n
;
4977 /* IT->current.overlay_string_index is the number of overlay strings
4978 that have already been consumed by IT. Copy some of the
4979 remaining overlay strings to IT->overlay_strings. */
4981 j
= it
->current
.overlay_string_index
;
4982 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
4984 it
->overlay_strings
[i
] = entries
[j
].string
;
4985 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
4992 /* Get the first chunk of overlay strings at IT's current buffer
4993 position, or at CHARPOS if that is > 0. Value is non-zero if at
4994 least one overlay string was found. */
4997 get_overlay_strings_1 (struct it
*it
, int charpos
, int compute_stop_p
)
4999 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5000 process. This fills IT->overlay_strings with strings, and sets
5001 IT->n_overlay_strings to the total number of strings to process.
5002 IT->pos.overlay_string_index has to be set temporarily to zero
5003 because load_overlay_strings needs this; it must be set to -1
5004 when no overlay strings are found because a zero value would
5005 indicate a position in the first overlay string. */
5006 it
->current
.overlay_string_index
= 0;
5007 load_overlay_strings (it
, charpos
);
5009 /* If we found overlay strings, set up IT to deliver display
5010 elements from the first one. Otherwise set up IT to deliver
5011 from current_buffer. */
5012 if (it
->n_overlay_strings
)
5014 /* Make sure we know settings in current_buffer, so that we can
5015 restore meaningful values when we're done with the overlay
5018 compute_stop_pos (it
);
5019 xassert (it
->face_id
>= 0);
5021 /* Save IT's settings. They are restored after all overlay
5022 strings have been processed. */
5023 xassert (!compute_stop_p
|| it
->sp
== 0);
5025 /* When called from handle_stop, there might be an empty display
5026 string loaded. In that case, don't bother saving it. */
5027 if (!STRINGP (it
->string
) || SCHARS (it
->string
))
5030 /* Set up IT to deliver display elements from the first overlay
5032 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5033 it
->string
= it
->overlay_strings
[0];
5034 it
->from_overlay
= Qnil
;
5035 it
->stop_charpos
= 0;
5036 xassert (STRINGP (it
->string
));
5037 it
->end_charpos
= SCHARS (it
->string
);
5038 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5039 it
->method
= GET_FROM_STRING
;
5043 it
->current
.overlay_string_index
= -1;
5048 get_overlay_strings (struct it
*it
, int charpos
)
5051 it
->method
= GET_FROM_BUFFER
;
5053 (void) get_overlay_strings_1 (it
, charpos
, 1);
5057 /* Value is non-zero if we found at least one overlay string. */
5058 return STRINGP (it
->string
);
5063 /***********************************************************************
5064 Saving and restoring state
5065 ***********************************************************************/
5067 /* Save current settings of IT on IT->stack. Called, for example,
5068 before setting up IT for an overlay string, to be able to restore
5069 IT's settings to what they were after the overlay string has been
5073 push_it (struct it
*it
)
5075 struct iterator_stack_entry
*p
;
5077 xassert (it
->sp
< IT_STACK_SIZE
);
5078 p
= it
->stack
+ it
->sp
;
5080 p
->stop_charpos
= it
->stop_charpos
;
5081 p
->prev_stop
= it
->prev_stop
;
5082 p
->base_level_stop
= it
->base_level_stop
;
5083 p
->cmp_it
= it
->cmp_it
;
5084 xassert (it
->face_id
>= 0);
5085 p
->face_id
= it
->face_id
;
5086 p
->string
= it
->string
;
5087 p
->method
= it
->method
;
5088 p
->from_overlay
= it
->from_overlay
;
5091 case GET_FROM_IMAGE
:
5092 p
->u
.image
.object
= it
->object
;
5093 p
->u
.image
.image_id
= it
->image_id
;
5094 p
->u
.image
.slice
= it
->slice
;
5096 case GET_FROM_STRETCH
:
5097 p
->u
.stretch
.object
= it
->object
;
5100 p
->position
= it
->position
;
5101 p
->current
= it
->current
;
5102 p
->end_charpos
= it
->end_charpos
;
5103 p
->string_nchars
= it
->string_nchars
;
5105 p
->multibyte_p
= it
->multibyte_p
;
5106 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5107 p
->space_width
= it
->space_width
;
5108 p
->font_height
= it
->font_height
;
5109 p
->voffset
= it
->voffset
;
5110 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5111 p
->display_ellipsis_p
= 0;
5112 p
->line_wrap
= it
->line_wrap
;
5117 iterate_out_of_display_property (struct it
*it
)
5119 /* Maybe initialize paragraph direction. If we are at the beginning
5120 of a new paragraph, next_element_from_buffer may not have a
5121 chance to do that. */
5122 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
5123 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
);
5124 /* prev_stop can be zero, so check against BEGV as well. */
5125 while (it
->bidi_it
.charpos
>= BEGV
5126 && it
->prev_stop
<= it
->bidi_it
.charpos
5127 && it
->bidi_it
.charpos
< CHARPOS (it
->position
))
5128 bidi_move_to_visually_next (&it
->bidi_it
);
5129 /* Record the stop_pos we just crossed, for when we cross it
5131 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5132 it
->prev_stop
= CHARPOS (it
->position
);
5133 /* If we ended up not where pop_it put us, resync IT's
5134 positional members with the bidi iterator. */
5135 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5137 SET_TEXT_POS (it
->position
,
5138 it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5139 it
->current
.pos
= it
->position
;
5143 /* Restore IT's settings from IT->stack. Called, for example, when no
5144 more overlay strings must be processed, and we return to delivering
5145 display elements from a buffer, or when the end of a string from a
5146 `display' property is reached and we return to delivering display
5147 elements from an overlay string, or from a buffer. */
5150 pop_it (struct it
*it
)
5152 struct iterator_stack_entry
*p
;
5154 xassert (it
->sp
> 0);
5156 p
= it
->stack
+ it
->sp
;
5157 it
->stop_charpos
= p
->stop_charpos
;
5158 it
->prev_stop
= p
->prev_stop
;
5159 it
->base_level_stop
= p
->base_level_stop
;
5160 it
->cmp_it
= p
->cmp_it
;
5161 it
->face_id
= p
->face_id
;
5162 it
->current
= p
->current
;
5163 it
->position
= p
->position
;
5164 it
->string
= p
->string
;
5165 it
->from_overlay
= p
->from_overlay
;
5166 if (NILP (it
->string
))
5167 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5168 it
->method
= p
->method
;
5171 case GET_FROM_IMAGE
:
5172 it
->image_id
= p
->u
.image
.image_id
;
5173 it
->object
= p
->u
.image
.object
;
5174 it
->slice
= p
->u
.image
.slice
;
5176 case GET_FROM_STRETCH
:
5177 it
->object
= p
->u
.comp
.object
;
5179 case GET_FROM_BUFFER
:
5180 it
->object
= it
->w
->buffer
;
5183 /* Bidi-iterate until we get out of the portion of text, if
5184 any, covered by a `display' text property or an overlay
5185 with `display' property. (We cannot just jump there,
5186 because the internal coherency of the bidi iterator state
5187 can not be preserved across such jumps.) We also must
5188 determine the paragraph base direction if the overlay we
5189 just processed is at the beginning of a new
5191 iterate_out_of_display_property (it
);
5194 case GET_FROM_STRING
:
5195 it
->object
= it
->string
;
5197 case GET_FROM_DISPLAY_VECTOR
:
5199 it
->method
= GET_FROM_C_STRING
;
5200 else if (STRINGP (it
->string
))
5201 it
->method
= GET_FROM_STRING
;
5204 it
->method
= GET_FROM_BUFFER
;
5205 it
->object
= it
->w
->buffer
;
5208 it
->end_charpos
= p
->end_charpos
;
5209 it
->string_nchars
= p
->string_nchars
;
5211 it
->multibyte_p
= p
->multibyte_p
;
5212 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5213 it
->space_width
= p
->space_width
;
5214 it
->font_height
= p
->font_height
;
5215 it
->voffset
= p
->voffset
;
5216 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5217 it
->line_wrap
= p
->line_wrap
;
5222 /***********************************************************************
5224 ***********************************************************************/
5226 /* Set IT's current position to the previous line start. */
5229 back_to_previous_line_start (struct it
*it
)
5231 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5232 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5236 /* Move IT to the next line start.
5238 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5239 we skipped over part of the text (as opposed to moving the iterator
5240 continuously over the text). Otherwise, don't change the value
5243 Newlines may come from buffer text, overlay strings, or strings
5244 displayed via the `display' property. That's the reason we can't
5245 simply use find_next_newline_no_quit.
5247 Note that this function may not skip over invisible text that is so
5248 because of text properties and immediately follows a newline. If
5249 it would, function reseat_at_next_visible_line_start, when called
5250 from set_iterator_to_next, would effectively make invisible
5251 characters following a newline part of the wrong glyph row, which
5252 leads to wrong cursor motion. */
5255 forward_to_next_line_start (struct it
*it
, int *skipped_p
)
5257 int old_selective
, newline_found_p
, n
;
5258 const int MAX_NEWLINE_DISTANCE
= 500;
5260 /* If already on a newline, just consume it to avoid unintended
5261 skipping over invisible text below. */
5262 if (it
->what
== IT_CHARACTER
5264 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5266 set_iterator_to_next (it
, 0);
5271 /* Don't handle selective display in the following. It's (a)
5272 unnecessary because it's done by the caller, and (b) leads to an
5273 infinite recursion because next_element_from_ellipsis indirectly
5274 calls this function. */
5275 old_selective
= it
->selective
;
5278 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5279 from buffer text. */
5280 for (n
= newline_found_p
= 0;
5281 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5282 n
+= STRINGP (it
->string
) ? 0 : 1)
5284 if (!get_next_display_element (it
))
5286 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5287 set_iterator_to_next (it
, 0);
5290 /* If we didn't find a newline near enough, see if we can use a
5292 if (!newline_found_p
)
5294 int start
= IT_CHARPOS (*it
);
5295 int limit
= find_next_newline_no_quit (start
, 1);
5298 xassert (!STRINGP (it
->string
));
5300 /* If there isn't any `display' property in sight, and no
5301 overlays, we can just use the position of the newline in
5303 if (it
->stop_charpos
>= limit
5304 || ((pos
= Fnext_single_property_change (make_number (start
),
5306 Qnil
, make_number (limit
)),
5308 && next_overlay_change (start
) == ZV
))
5310 IT_CHARPOS (*it
) = limit
;
5311 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5312 *skipped_p
= newline_found_p
= 1;
5316 while (get_next_display_element (it
)
5317 && !newline_found_p
)
5319 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5320 set_iterator_to_next (it
, 0);
5325 it
->selective
= old_selective
;
5326 return newline_found_p
;
5330 /* Set IT's current position to the previous visible line start. Skip
5331 invisible text that is so either due to text properties or due to
5332 selective display. Caution: this does not change IT->current_x and
5336 back_to_previous_visible_line_start (struct it
*it
)
5338 while (IT_CHARPOS (*it
) > BEGV
)
5340 back_to_previous_line_start (it
);
5342 if (IT_CHARPOS (*it
) <= BEGV
)
5345 /* If selective > 0, then lines indented more than its value are
5347 if (it
->selective
> 0
5348 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5349 (double) it
->selective
)) /* iftc */
5352 /* Check the newline before point for invisibility. */
5355 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5356 Qinvisible
, it
->window
);
5357 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5361 if (IT_CHARPOS (*it
) <= BEGV
)
5368 Lisp_Object val
, overlay
;
5370 /* If newline is part of a composition, continue from start of composition */
5371 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5372 && beg
< IT_CHARPOS (*it
))
5375 /* If newline is replaced by a display property, find start of overlay
5376 or interval and continue search from that point. */
5378 pos
= --IT_CHARPOS (it2
);
5381 it2
.string_from_display_prop_p
= 0;
5382 if (handle_display_prop (&it2
) == HANDLED_RETURN
5383 && !NILP (val
= get_char_property_and_overlay
5384 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5385 && (OVERLAYP (overlay
)
5386 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5387 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5390 /* Newline is not replaced by anything -- so we are done. */
5396 IT_CHARPOS (*it
) = beg
;
5397 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5401 it
->continuation_lines_width
= 0;
5403 xassert (IT_CHARPOS (*it
) >= BEGV
);
5404 xassert (IT_CHARPOS (*it
) == BEGV
5405 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5410 /* Reseat iterator IT at the previous visible line start. Skip
5411 invisible text that is so either due to text properties or due to
5412 selective display. At the end, update IT's overlay information,
5413 face information etc. */
5416 reseat_at_previous_visible_line_start (struct it
*it
)
5418 back_to_previous_visible_line_start (it
);
5419 reseat (it
, it
->current
.pos
, 1);
5424 /* Reseat iterator IT on the next visible line start in the current
5425 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5426 preceding the line start. Skip over invisible text that is so
5427 because of selective display. Compute faces, overlays etc at the
5428 new position. Note that this function does not skip over text that
5429 is invisible because of text properties. */
5432 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
5434 int newline_found_p
, skipped_p
= 0;
5436 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5438 /* Skip over lines that are invisible because they are indented
5439 more than the value of IT->selective. */
5440 if (it
->selective
> 0)
5441 while (IT_CHARPOS (*it
) < ZV
5442 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5443 (double) it
->selective
)) /* iftc */
5445 xassert (IT_BYTEPOS (*it
) == BEGV
5446 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5447 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5450 /* Position on the newline if that's what's requested. */
5451 if (on_newline_p
&& newline_found_p
)
5453 if (STRINGP (it
->string
))
5455 if (IT_STRING_CHARPOS (*it
) > 0)
5457 --IT_STRING_CHARPOS (*it
);
5458 --IT_STRING_BYTEPOS (*it
);
5461 else if (IT_CHARPOS (*it
) > BEGV
)
5465 reseat (it
, it
->current
.pos
, 0);
5469 reseat (it
, it
->current
.pos
, 0);
5476 /***********************************************************************
5477 Changing an iterator's position
5478 ***********************************************************************/
5480 /* Change IT's current position to POS in current_buffer. If FORCE_P
5481 is non-zero, always check for text properties at the new position.
5482 Otherwise, text properties are only looked up if POS >=
5483 IT->check_charpos of a property. */
5486 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
5488 int original_pos
= IT_CHARPOS (*it
);
5490 reseat_1 (it
, pos
, 0);
5492 /* Determine where to check text properties. Avoid doing it
5493 where possible because text property lookup is very expensive. */
5495 || CHARPOS (pos
) > it
->stop_charpos
5496 || CHARPOS (pos
) < original_pos
)
5500 /* For bidi iteration, we need to prime prev_stop and
5501 base_level_stop with our best estimations. */
5502 if (CHARPOS (pos
) < it
->prev_stop
)
5504 handle_stop_backwards (it
, BEGV
);
5505 if (CHARPOS (pos
) < it
->base_level_stop
)
5506 it
->base_level_stop
= 0;
5508 else if (CHARPOS (pos
) > it
->stop_charpos
5509 && it
->stop_charpos
>= BEGV
)
5510 handle_stop_backwards (it
, it
->stop_charpos
);
5517 it
->prev_stop
= it
->base_level_stop
= 0;
5526 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
5527 IT->stop_pos to POS, also. */
5530 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
5532 /* Don't call this function when scanning a C string. */
5533 xassert (it
->s
== NULL
);
5535 /* POS must be a reasonable value. */
5536 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
5538 it
->current
.pos
= it
->position
= pos
;
5539 it
->end_charpos
= ZV
;
5541 it
->current
.dpvec_index
= -1;
5542 it
->current
.overlay_string_index
= -1;
5543 IT_STRING_CHARPOS (*it
) = -1;
5544 IT_STRING_BYTEPOS (*it
) = -1;
5546 it
->string_from_display_prop_p
= 0;
5547 it
->method
= GET_FROM_BUFFER
;
5548 it
->object
= it
->w
->buffer
;
5549 it
->area
= TEXT_AREA
;
5550 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
5552 it
->string_from_display_prop_p
= 0;
5553 it
->face_before_selective_p
= 0;
5555 it
->bidi_it
.first_elt
= 1;
5559 it
->stop_charpos
= CHARPOS (pos
);
5560 it
->base_level_stop
= CHARPOS (pos
);
5565 /* Set up IT for displaying a string, starting at CHARPOS in window W.
5566 If S is non-null, it is a C string to iterate over. Otherwise,
5567 STRING gives a Lisp string to iterate over.
5569 If PRECISION > 0, don't return more then PRECISION number of
5570 characters from the string.
5572 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
5573 characters have been returned. FIELD_WIDTH < 0 means an infinite
5576 MULTIBYTE = 0 means disable processing of multibyte characters,
5577 MULTIBYTE > 0 means enable it,
5578 MULTIBYTE < 0 means use IT->multibyte_p.
5580 IT must be initialized via a prior call to init_iterator before
5581 calling this function. */
5584 reseat_to_string (struct it
*it
, unsigned char *s
, Lisp_Object string
,
5585 int charpos
, int precision
, int field_width
, int multibyte
)
5587 /* No region in strings. */
5588 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
5590 /* No text property checks performed by default, but see below. */
5591 it
->stop_charpos
= -1;
5593 /* Set iterator position and end position. */
5594 memset (&it
->current
, 0, sizeof it
->current
);
5595 it
->current
.overlay_string_index
= -1;
5596 it
->current
.dpvec_index
= -1;
5597 xassert (charpos
>= 0);
5599 /* If STRING is specified, use its multibyteness, otherwise use the
5600 setting of MULTIBYTE, if specified. */
5602 it
->multibyte_p
= multibyte
> 0;
5606 xassert (STRINGP (string
));
5607 it
->string
= string
;
5609 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
5610 it
->method
= GET_FROM_STRING
;
5611 it
->current
.string_pos
= string_pos (charpos
, string
);
5618 /* Note that we use IT->current.pos, not it->current.string_pos,
5619 for displaying C strings. */
5620 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
5621 if (it
->multibyte_p
)
5623 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
5624 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
5628 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
5629 it
->end_charpos
= it
->string_nchars
= strlen (s
);
5632 it
->method
= GET_FROM_C_STRING
;
5635 /* PRECISION > 0 means don't return more than PRECISION characters
5637 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
5638 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
5640 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
5641 characters have been returned. FIELD_WIDTH == 0 means don't pad,
5642 FIELD_WIDTH < 0 means infinite field width. This is useful for
5643 padding with `-' at the end of a mode line. */
5644 if (field_width
< 0)
5645 field_width
= INFINITY
;
5646 if (field_width
> it
->end_charpos
- charpos
)
5647 it
->end_charpos
= charpos
+ field_width
;
5649 /* Use the standard display table for displaying strings. */
5650 if (DISP_TABLE_P (Vstandard_display_table
))
5651 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
5653 it
->stop_charpos
= charpos
;
5654 if (s
== NULL
&& it
->multibyte_p
)
5656 EMACS_INT endpos
= SCHARS (it
->string
);
5657 if (endpos
> it
->end_charpos
)
5658 endpos
= it
->end_charpos
;
5659 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
5667 /***********************************************************************
5669 ***********************************************************************/
5671 /* Map enum it_method value to corresponding next_element_from_* function. */
5673 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
5675 next_element_from_buffer
,
5676 next_element_from_display_vector
,
5677 next_element_from_string
,
5678 next_element_from_c_string
,
5679 next_element_from_image
,
5680 next_element_from_stretch
5683 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
5686 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
5687 (possibly with the following characters). */
5689 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
5690 ((IT)->cmp_it.id >= 0 \
5691 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
5692 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
5693 END_CHARPOS, (IT)->w, \
5694 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
5698 /* Load IT's display element fields with information about the next
5699 display element from the current position of IT. Value is zero if
5700 end of buffer (or C string) is reached. */
5702 static struct frame
*last_escape_glyph_frame
= NULL
;
5703 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
5704 static int last_escape_glyph_merged_face_id
= 0;
5707 get_next_display_element (struct it
*it
)
5709 /* Non-zero means that we found a display element. Zero means that
5710 we hit the end of what we iterate over. Performance note: the
5711 function pointer `method' used here turns out to be faster than
5712 using a sequence of if-statements. */
5716 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
5718 if (it
->what
== IT_CHARACTER
)
5720 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
5721 and only if (a) the resolved directionality of that character
5723 /* FIXME: Do we need an exception for characters from display
5725 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
5726 it
->c
= bidi_mirror_char (it
->c
);
5727 /* Map via display table or translate control characters.
5728 IT->c, IT->len etc. have been set to the next character by
5729 the function call above. If we have a display table, and it
5730 contains an entry for IT->c, translate it. Don't do this if
5731 IT->c itself comes from a display table, otherwise we could
5732 end up in an infinite recursion. (An alternative could be to
5733 count the recursion depth of this function and signal an
5734 error when a certain maximum depth is reached.) Is it worth
5736 if (success_p
&& it
->dpvec
== NULL
)
5739 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
5740 enum { char_is_other
= 0, char_is_nbsp
, char_is_soft_hyphen
}
5741 nbsp_or_shy
= char_is_other
;
5742 int decoded
= it
->c
;
5745 && (dv
= DISP_CHAR_VECTOR (it
->dp
, it
->c
),
5748 struct Lisp_Vector
*v
= XVECTOR (dv
);
5750 /* Return the first character from the display table
5751 entry, if not empty. If empty, don't display the
5752 current character. */
5755 it
->dpvec_char_len
= it
->len
;
5756 it
->dpvec
= v
->contents
;
5757 it
->dpend
= v
->contents
+ v
->size
;
5758 it
->current
.dpvec_index
= 0;
5759 it
->dpvec_face_id
= -1;
5760 it
->saved_face_id
= it
->face_id
;
5761 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5766 set_iterator_to_next (it
, 0);
5771 if (unibyte_display_via_language_environment
5772 && !ASCII_CHAR_P (it
->c
))
5773 decoded
= DECODE_CHAR (unibyte
, it
->c
);
5775 if (it
->c
>= 0x80 && ! NILP (Vnobreak_char_display
))
5777 if (it
->multibyte_p
)
5778 nbsp_or_shy
= (it
->c
== 0xA0 ? char_is_nbsp
5779 : it
->c
== 0xAD ? char_is_soft_hyphen
5781 else if (unibyte_display_via_language_environment
)
5782 nbsp_or_shy
= (decoded
== 0xA0 ? char_is_nbsp
5783 : decoded
== 0xAD ? char_is_soft_hyphen
5787 /* Translate control characters into `\003' or `^C' form.
5788 Control characters coming from a display table entry are
5789 currently not translated because we use IT->dpvec to hold
5790 the translation. This could easily be changed but I
5791 don't believe that it is worth doing.
5793 If it->multibyte_p is nonzero, non-printable non-ASCII
5794 characters are also translated to octal form.
5796 If it->multibyte_p is zero, eight-bit characters that
5797 don't have corresponding multibyte char code are also
5798 translated to octal form. */
5800 ? (it
->area
!= TEXT_AREA
5801 /* In mode line, treat \n, \t like other crl chars. */
5804 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
5805 || (it
->c
!= '\n' && it
->c
!= '\t'))
5808 ? ! CHAR_PRINTABLE_P (it
->c
)
5809 : (! unibyte_display_via_language_environment
5811 : (decoded
>= 0x80 && decoded
< 0xA0))))))
5813 /* IT->c is a control character which must be displayed
5814 either as '\003' or as `^C' where the '\\' and '^'
5815 can be defined in the display table. Fill
5816 IT->ctl_chars with glyphs for what we have to
5817 display. Then, set IT->dpvec to these glyphs. */
5820 int face_id
, lface_id
= 0 ;
5823 /* Handle control characters with ^. */
5825 if (it
->c
< 128 && it
->ctl_arrow_p
)
5829 g
= '^'; /* default glyph for Control */
5830 /* Set IT->ctl_chars[0] to the glyph for `^'. */
5832 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5833 && GLYPH_CODE_CHAR_VALID_P (gc
))
5835 g
= GLYPH_CODE_CHAR (gc
);
5836 lface_id
= GLYPH_CODE_FACE (gc
);
5840 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
5842 else if (it
->f
== last_escape_glyph_frame
5843 && it
->face_id
== last_escape_glyph_face_id
)
5845 face_id
= last_escape_glyph_merged_face_id
;
5849 /* Merge the escape-glyph face into the current face. */
5850 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5852 last_escape_glyph_frame
= it
->f
;
5853 last_escape_glyph_face_id
= it
->face_id
;
5854 last_escape_glyph_merged_face_id
= face_id
;
5857 XSETINT (it
->ctl_chars
[0], g
);
5858 XSETINT (it
->ctl_chars
[1], it
->c
^ 0100);
5860 goto display_control
;
5863 /* Handle non-break space in the mode where it only gets
5866 if (EQ (Vnobreak_char_display
, Qt
)
5867 && nbsp_or_shy
== char_is_nbsp
)
5869 /* Merge the no-break-space face into the current face. */
5870 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
5874 XSETINT (it
->ctl_chars
[0], ' ');
5876 goto display_control
;
5879 /* Handle sequences that start with the "escape glyph". */
5881 /* the default escape glyph is \. */
5882 escape_glyph
= '\\';
5885 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5886 && GLYPH_CODE_CHAR_VALID_P (gc
))
5888 escape_glyph
= GLYPH_CODE_CHAR (gc
);
5889 lface_id
= GLYPH_CODE_FACE (gc
);
5893 /* The display table specified a face.
5894 Merge it into face_id and also into escape_glyph. */
5895 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
5898 else if (it
->f
== last_escape_glyph_frame
5899 && it
->face_id
== last_escape_glyph_face_id
)
5901 face_id
= last_escape_glyph_merged_face_id
;
5905 /* Merge the escape-glyph face into the current face. */
5906 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5908 last_escape_glyph_frame
= it
->f
;
5909 last_escape_glyph_face_id
= it
->face_id
;
5910 last_escape_glyph_merged_face_id
= face_id
;
5913 /* Handle soft hyphens in the mode where they only get
5916 if (EQ (Vnobreak_char_display
, Qt
)
5917 && nbsp_or_shy
== char_is_soft_hyphen
)
5920 XSETINT (it
->ctl_chars
[0], '-');
5922 goto display_control
;
5925 /* Handle non-break space and soft hyphen
5926 with the escape glyph. */
5930 XSETINT (it
->ctl_chars
[0], escape_glyph
);
5931 it
->c
= (nbsp_or_shy
== char_is_nbsp
? ' ' : '-');
5932 XSETINT (it
->ctl_chars
[1], it
->c
);
5934 goto display_control
;
5938 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
5942 /* Set IT->ctl_chars[0] to the glyph for `\\'. */
5943 if (CHAR_BYTE8_P (it
->c
))
5945 str
[0] = CHAR_TO_BYTE8 (it
->c
);
5948 else if (it
->c
< 256)
5955 /* It's an invalid character, which shouldn't
5956 happen actually, but due to bugs it may
5957 happen. Let's print the char as is, there's
5958 not much meaningful we can do with it. */
5960 str
[1] = it
->c
>> 8;
5961 str
[2] = it
->c
>> 16;
5962 str
[3] = it
->c
>> 24;
5966 for (i
= 0; i
< len
; i
++)
5969 XSETINT (it
->ctl_chars
[i
* 4], escape_glyph
);
5970 /* Insert three more glyphs into IT->ctl_chars for
5971 the octal display of the character. */
5972 g
= ((str
[i
] >> 6) & 7) + '0';
5973 XSETINT (it
->ctl_chars
[i
* 4 + 1], g
);
5974 g
= ((str
[i
] >> 3) & 7) + '0';
5975 XSETINT (it
->ctl_chars
[i
* 4 + 2], g
);
5976 g
= (str
[i
] & 7) + '0';
5977 XSETINT (it
->ctl_chars
[i
* 4 + 3], g
);
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
;
5997 #ifdef HAVE_WINDOW_SYSTEM
5998 /* Adjust face id for a multibyte character. There are no multibyte
5999 character in unibyte text. */
6000 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
6003 && FRAME_WINDOW_P (it
->f
))
6005 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6007 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
6009 /* Automatic composition with glyph-string. */
6010 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
6012 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
6016 int pos
= (it
->s
? -1
6017 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
6018 : IT_CHARPOS (*it
));
6020 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->c
, pos
, it
->string
);
6025 /* Is this character the last one of a run of characters with
6026 box? If yes, set IT->end_of_box_run_p to 1. */
6030 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
6032 int face_id
= underlying_face_id (it
);
6033 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
6037 if (face
->box
== FACE_NO_BOX
)
6039 /* If the box comes from face properties in a
6040 display string, check faces in that string. */
6041 int string_face_id
= face_after_it_pos (it
);
6042 it
->end_of_box_run_p
6043 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
6046 /* Otherwise, the box comes from the underlying face.
6047 If this is the last string character displayed, check
6048 the next buffer location. */
6049 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
6050 && (it
->current
.overlay_string_index
6051 == it
->n_overlay_strings
- 1))
6055 struct text_pos pos
= it
->current
.pos
;
6056 INC_TEXT_POS (pos
, it
->multibyte_p
);
6058 next_face_id
= face_at_buffer_position
6059 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
6060 it
->region_end_charpos
, &ignore
,
6061 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
6063 it
->end_of_box_run_p
6064 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
6071 int face_id
= face_after_it_pos (it
);
6072 it
->end_of_box_run_p
6073 = (face_id
!= it
->face_id
6074 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
6078 /* Value is 0 if end of buffer or string reached. */
6083 /* Move IT to the next display element.
6085 RESEAT_P non-zero means if called on a newline in buffer text,
6086 skip to the next visible line start.
6088 Functions get_next_display_element and set_iterator_to_next are
6089 separate because I find this arrangement easier to handle than a
6090 get_next_display_element function that also increments IT's
6091 position. The way it is we can first look at an iterator's current
6092 display element, decide whether it fits on a line, and if it does,
6093 increment the iterator position. The other way around we probably
6094 would either need a flag indicating whether the iterator has to be
6095 incremented the next time, or we would have to implement a
6096 decrement position function which would not be easy to write. */
6099 set_iterator_to_next (struct it
*it
, int reseat_p
)
6101 /* Reset flags indicating start and end of a sequence of characters
6102 with box. Reset them at the start of this function because
6103 moving the iterator to a new position might set them. */
6104 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6108 case GET_FROM_BUFFER
:
6109 /* The current display element of IT is a character from
6110 current_buffer. Advance in the buffer, and maybe skip over
6111 invisible lines that are so because of selective display. */
6112 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6113 reseat_at_next_visible_line_start (it
, 0);
6114 else if (it
->cmp_it
.id
>= 0)
6116 /* We are currently getting glyphs from a composition. */
6121 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6122 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6123 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6125 it
->cmp_it
.from
= it
->cmp_it
.to
;
6130 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6132 it
->stop_charpos
, Qnil
);
6135 else if (! it
->cmp_it
.reversed_p
)
6137 /* Composition created while scanning forward. */
6138 /* Update IT's char/byte positions to point to the first
6139 character of the next grapheme cluster, or to the
6140 character visually after the current composition. */
6141 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6142 bidi_move_to_visually_next (&it
->bidi_it
);
6143 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6144 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6146 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6148 /* Proceed to the next grapheme cluster. */
6149 it
->cmp_it
.from
= it
->cmp_it
.to
;
6153 /* No more grapheme clusters in this composition.
6154 Find the next stop position. */
6155 EMACS_INT stop
= it
->stop_charpos
;
6156 if (it
->bidi_it
.scan_dir
< 0)
6157 /* Now we are scanning backward and don't know
6160 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6161 IT_BYTEPOS (*it
), stop
, Qnil
);
6166 /* Composition created while scanning backward. */
6167 /* Update IT's char/byte positions to point to the last
6168 character of the previous grapheme cluster, or the
6169 character visually after the current composition. */
6170 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6171 bidi_move_to_visually_next (&it
->bidi_it
);
6172 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6173 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6174 if (it
->cmp_it
.from
> 0)
6176 /* Proceed to the previous grapheme cluster. */
6177 it
->cmp_it
.to
= it
->cmp_it
.from
;
6181 /* No more grapheme clusters in this composition.
6182 Find the next stop position. */
6183 EMACS_INT stop
= it
->stop_charpos
;
6184 if (it
->bidi_it
.scan_dir
< 0)
6185 /* Now we are scanning backward and don't know
6188 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6189 IT_BYTEPOS (*it
), stop
, Qnil
);
6195 xassert (it
->len
!= 0);
6199 IT_BYTEPOS (*it
) += it
->len
;
6200 IT_CHARPOS (*it
) += 1;
6204 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6205 /* If this is a new paragraph, determine its base
6206 direction (a.k.a. its base embedding level). */
6207 if (it
->bidi_it
.new_paragraph
)
6208 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
);
6209 bidi_move_to_visually_next (&it
->bidi_it
);
6210 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6211 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6212 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6214 /* As the scan direction was changed, we must
6215 re-compute the stop position for composition. */
6216 EMACS_INT stop
= it
->stop_charpos
;
6217 if (it
->bidi_it
.scan_dir
< 0)
6219 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6220 IT_BYTEPOS (*it
), stop
, Qnil
);
6223 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6227 case GET_FROM_C_STRING
:
6228 /* Current display element of IT is from a C string. */
6229 IT_BYTEPOS (*it
) += it
->len
;
6230 IT_CHARPOS (*it
) += 1;
6233 case GET_FROM_DISPLAY_VECTOR
:
6234 /* Current display element of IT is from a display table entry.
6235 Advance in the display table definition. Reset it to null if
6236 end reached, and continue with characters from buffers/
6238 ++it
->current
.dpvec_index
;
6240 /* Restore face of the iterator to what they were before the
6241 display vector entry (these entries may contain faces). */
6242 it
->face_id
= it
->saved_face_id
;
6244 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6246 int recheck_faces
= it
->ellipsis_p
;
6249 it
->method
= GET_FROM_C_STRING
;
6250 else if (STRINGP (it
->string
))
6251 it
->method
= GET_FROM_STRING
;
6254 it
->method
= GET_FROM_BUFFER
;
6255 it
->object
= it
->w
->buffer
;
6259 it
->current
.dpvec_index
= -1;
6261 /* Skip over characters which were displayed via IT->dpvec. */
6262 if (it
->dpvec_char_len
< 0)
6263 reseat_at_next_visible_line_start (it
, 1);
6264 else if (it
->dpvec_char_len
> 0)
6266 if (it
->method
== GET_FROM_STRING
6267 && it
->n_overlay_strings
> 0)
6268 it
->ignore_overlay_strings_at_pos_p
= 1;
6269 it
->len
= it
->dpvec_char_len
;
6270 set_iterator_to_next (it
, reseat_p
);
6273 /* Maybe recheck faces after display vector */
6275 it
->stop_charpos
= IT_CHARPOS (*it
);
6279 case GET_FROM_STRING
:
6280 /* Current display element is a character from a Lisp string. */
6281 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6282 if (it
->cmp_it
.id
>= 0)
6284 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6285 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6286 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6287 it
->cmp_it
.from
= it
->cmp_it
.to
;
6291 composition_compute_stop_pos (&it
->cmp_it
,
6292 IT_STRING_CHARPOS (*it
),
6293 IT_STRING_BYTEPOS (*it
),
6294 it
->stop_charpos
, it
->string
);
6299 IT_STRING_BYTEPOS (*it
) += it
->len
;
6300 IT_STRING_CHARPOS (*it
) += 1;
6303 consider_string_end
:
6305 if (it
->current
.overlay_string_index
>= 0)
6307 /* IT->string is an overlay string. Advance to the
6308 next, if there is one. */
6309 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6312 next_overlay_string (it
);
6314 setup_for_ellipsis (it
, 0);
6319 /* IT->string is not an overlay string. If we reached
6320 its end, and there is something on IT->stack, proceed
6321 with what is on the stack. This can be either another
6322 string, this time an overlay string, or a buffer. */
6323 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
6327 if (it
->method
== GET_FROM_STRING
)
6328 goto consider_string_end
;
6333 case GET_FROM_IMAGE
:
6334 case GET_FROM_STRETCH
:
6335 /* The position etc with which we have to proceed are on
6336 the stack. The position may be at the end of a string,
6337 if the `display' property takes up the whole string. */
6338 xassert (it
->sp
> 0);
6340 if (it
->method
== GET_FROM_STRING
)
6341 goto consider_string_end
;
6345 /* There are no other methods defined, so this should be a bug. */
6349 xassert (it
->method
!= GET_FROM_STRING
6350 || (STRINGP (it
->string
)
6351 && IT_STRING_CHARPOS (*it
) >= 0));
6354 /* Load IT's display element fields with information about the next
6355 display element which comes from a display table entry or from the
6356 result of translating a control character to one of the forms `^C'
6359 IT->dpvec holds the glyphs to return as characters.
6360 IT->saved_face_id holds the face id before the display vector--it
6361 is restored into IT->face_id in set_iterator_to_next. */
6364 next_element_from_display_vector (struct it
*it
)
6369 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
6371 it
->face_id
= it
->saved_face_id
;
6373 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
6374 That seemed totally bogus - so I changed it... */
6375 gc
= it
->dpvec
[it
->current
.dpvec_index
];
6377 if (GLYPH_CODE_P (gc
) && GLYPH_CODE_CHAR_VALID_P (gc
))
6379 it
->c
= GLYPH_CODE_CHAR (gc
);
6380 it
->len
= CHAR_BYTES (it
->c
);
6382 /* The entry may contain a face id to use. Such a face id is
6383 the id of a Lisp face, not a realized face. A face id of
6384 zero means no face is specified. */
6385 if (it
->dpvec_face_id
>= 0)
6386 it
->face_id
= it
->dpvec_face_id
;
6389 int lface_id
= GLYPH_CODE_FACE (gc
);
6391 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6396 /* Display table entry is invalid. Return a space. */
6397 it
->c
= ' ', it
->len
= 1;
6399 /* Don't change position and object of the iterator here. They are
6400 still the values of the character that had this display table
6401 entry or was translated, and that's what we want. */
6402 it
->what
= IT_CHARACTER
;
6407 /* Load IT with the next display element from Lisp string IT->string.
6408 IT->current.string_pos is the current position within the string.
6409 If IT->current.overlay_string_index >= 0, the Lisp string is an
6413 next_element_from_string (struct it
*it
)
6415 struct text_pos position
;
6417 xassert (STRINGP (it
->string
));
6418 xassert (IT_STRING_CHARPOS (*it
) >= 0);
6419 position
= it
->current
.string_pos
;
6421 /* Time to check for invisible text? */
6422 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
6423 && IT_STRING_CHARPOS (*it
) == it
->stop_charpos
)
6427 /* Since a handler may have changed IT->method, we must
6429 return GET_NEXT_DISPLAY_ELEMENT (it
);
6432 if (it
->current
.overlay_string_index
>= 0)
6434 /* Get the next character from an overlay string. In overlay
6435 strings, There is no field width or padding with spaces to
6437 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6442 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6443 IT_STRING_BYTEPOS (*it
), SCHARS (it
->string
))
6444 && next_element_from_composition (it
))
6448 else if (STRING_MULTIBYTE (it
->string
))
6450 int remaining
= SBYTES (it
->string
) - IT_STRING_BYTEPOS (*it
);
6451 const unsigned char *s
= (SDATA (it
->string
)
6452 + IT_STRING_BYTEPOS (*it
));
6453 it
->c
= string_char_and_length (s
, &it
->len
);
6457 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6463 /* Get the next character from a Lisp string that is not an
6464 overlay string. Such strings come from the mode line, for
6465 example. We may have to pad with spaces, or truncate the
6466 string. See also next_element_from_c_string. */
6467 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
6472 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
6474 /* Pad with spaces. */
6475 it
->c
= ' ', it
->len
= 1;
6476 CHARPOS (position
) = BYTEPOS (position
) = -1;
6478 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6479 IT_STRING_BYTEPOS (*it
), it
->string_nchars
)
6480 && next_element_from_composition (it
))
6484 else if (STRING_MULTIBYTE (it
->string
))
6486 int maxlen
= SBYTES (it
->string
) - IT_STRING_BYTEPOS (*it
);
6487 const unsigned char *s
= (SDATA (it
->string
)
6488 + IT_STRING_BYTEPOS (*it
));
6489 it
->c
= string_char_and_length (s
, &it
->len
);
6493 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6498 /* Record what we have and where it came from. */
6499 it
->what
= IT_CHARACTER
;
6500 it
->object
= it
->string
;
6501 it
->position
= position
;
6506 /* Load IT with next display element from C string IT->s.
6507 IT->string_nchars is the maximum number of characters to return
6508 from the string. IT->end_charpos may be greater than
6509 IT->string_nchars when this function is called, in which case we
6510 may have to return padding spaces. Value is zero if end of string
6511 reached, including padding spaces. */
6514 next_element_from_c_string (struct it
*it
)
6519 it
->what
= IT_CHARACTER
;
6520 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
6523 /* IT's position can be greater IT->string_nchars in case a field
6524 width or precision has been specified when the iterator was
6526 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6528 /* End of the game. */
6532 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
6534 /* Pad with spaces. */
6535 it
->c
= ' ', it
->len
= 1;
6536 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
6538 else if (it
->multibyte_p
)
6540 /* Implementation note: The calls to strlen apparently aren't a
6541 performance problem because there is no noticeable performance
6542 difference between Emacs running in unibyte or multibyte mode. */
6543 int maxlen
= strlen (it
->s
) - IT_BYTEPOS (*it
);
6544 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
6547 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
6553 /* Set up IT to return characters from an ellipsis, if appropriate.
6554 The definition of the ellipsis glyphs may come from a display table
6555 entry. This function fills IT with the first glyph from the
6556 ellipsis if an ellipsis is to be displayed. */
6559 next_element_from_ellipsis (struct it
*it
)
6561 if (it
->selective_display_ellipsis_p
)
6562 setup_for_ellipsis (it
, it
->len
);
6565 /* The face at the current position may be different from the
6566 face we find after the invisible text. Remember what it
6567 was in IT->saved_face_id, and signal that it's there by
6568 setting face_before_selective_p. */
6569 it
->saved_face_id
= it
->face_id
;
6570 it
->method
= GET_FROM_BUFFER
;
6571 it
->object
= it
->w
->buffer
;
6572 reseat_at_next_visible_line_start (it
, 1);
6573 it
->face_before_selective_p
= 1;
6576 return GET_NEXT_DISPLAY_ELEMENT (it
);
6580 /* Deliver an image display element. The iterator IT is already
6581 filled with image information (done in handle_display_prop). Value
6586 next_element_from_image (struct it
*it
)
6588 it
->what
= IT_IMAGE
;
6589 it
->ignore_overlay_strings_at_pos_p
= 0;
6594 /* Fill iterator IT with next display element from a stretch glyph
6595 property. IT->object is the value of the text property. Value is
6599 next_element_from_stretch (struct it
*it
)
6601 it
->what
= IT_STRETCH
;
6605 /* Scan forward from CHARPOS in the current buffer, until we find a
6606 stop position > current IT's position. Then handle the stop
6607 position before that. This is called when we bump into a stop
6608 position while reordering bidirectional text. CHARPOS should be
6609 the last previously processed stop_pos (or BEGV, if none were
6610 processed yet) whose position is less that IT's current
6614 handle_stop_backwards (struct it
*it
, EMACS_INT charpos
)
6616 EMACS_INT where_we_are
= IT_CHARPOS (*it
);
6617 struct display_pos save_current
= it
->current
;
6618 struct text_pos save_position
= it
->position
;
6619 struct text_pos pos1
;
6620 EMACS_INT next_stop
;
6622 /* Scan in strict logical order. */
6626 it
->prev_stop
= charpos
;
6627 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
6628 reseat_1 (it
, pos1
, 0);
6629 compute_stop_pos (it
);
6630 /* We must advance forward, right? */
6631 if (it
->stop_charpos
<= it
->prev_stop
)
6633 charpos
= it
->stop_charpos
;
6635 while (charpos
<= where_we_are
);
6637 next_stop
= it
->stop_charpos
;
6638 it
->stop_charpos
= it
->prev_stop
;
6640 it
->current
= save_current
;
6641 it
->position
= save_position
;
6643 it
->stop_charpos
= next_stop
;
6646 /* Load IT with the next display element from current_buffer. Value
6647 is zero if end of buffer reached. IT->stop_charpos is the next
6648 position at which to stop and check for text properties or buffer
6652 next_element_from_buffer (struct it
*it
)
6656 xassert (IT_CHARPOS (*it
) >= BEGV
);
6658 /* With bidi reordering, the character to display might not be the
6659 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
6660 we were reseat()ed to a new buffer position, which is potentially
6661 a different paragraph. */
6662 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
6664 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6665 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6666 if (it
->bidi_it
.bytepos
== ZV_BYTE
)
6668 /* Nothing to do, but reset the FIRST_ELT flag, like
6669 bidi_paragraph_init does, because we are not going to
6671 it
->bidi_it
.first_elt
= 0;
6673 else if (it
->bidi_it
.bytepos
== BEGV_BYTE
6674 /* FIXME: Should support all Unicode line separators. */
6675 || FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
6676 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')
6678 /* If we are at the beginning of a line, we can produce the
6679 next element right away. */
6680 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
);
6681 bidi_move_to_visually_next (&it
->bidi_it
);
6685 int orig_bytepos
= IT_BYTEPOS (*it
);
6687 /* We need to prime the bidi iterator starting at the line's
6688 beginning, before we will be able to produce the next
6690 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
), -1);
6691 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
6692 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6693 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6694 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
);
6697 /* Now return to buffer position where we were asked to
6698 get the next display element, and produce that. */
6699 bidi_move_to_visually_next (&it
->bidi_it
);
6701 while (it
->bidi_it
.bytepos
!= orig_bytepos
6702 && it
->bidi_it
.bytepos
< ZV_BYTE
);
6705 it
->bidi_it
.first_elt
= 0; /* paranoia: bidi.c does this */
6706 /* Adjust IT's position information to where we ended up. */
6707 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6708 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6709 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
6711 EMACS_INT stop
= it
->stop_charpos
;
6712 if (it
->bidi_it
.scan_dir
< 0)
6714 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6715 IT_BYTEPOS (*it
), stop
, Qnil
);
6719 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
6721 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6723 int overlay_strings_follow_p
;
6725 /* End of the game, except when overlay strings follow that
6726 haven't been returned yet. */
6727 if (it
->overlay_strings_at_end_processed_p
)
6728 overlay_strings_follow_p
= 0;
6731 it
->overlay_strings_at_end_processed_p
= 1;
6732 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
6735 if (overlay_strings_follow_p
)
6736 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6740 it
->position
= it
->current
.pos
;
6744 else if (!(!it
->bidi_p
6745 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6746 || IT_CHARPOS (*it
) == it
->stop_charpos
))
6748 /* With bidi non-linear iteration, we could find ourselves
6749 far beyond the last computed stop_charpos, with several
6750 other stop positions in between that we missed. Scan
6751 them all now, in buffer's logical order, until we find
6752 and handle the last stop_charpos that precedes our
6753 current position. */
6754 handle_stop_backwards (it
, it
->stop_charpos
);
6755 return GET_NEXT_DISPLAY_ELEMENT (it
);
6761 /* Take note of the stop position we just moved across,
6762 for when we will move back across it. */
6763 it
->prev_stop
= it
->stop_charpos
;
6764 /* If we are at base paragraph embedding level, take
6765 note of the last stop position seen at this
6767 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
6768 it
->base_level_stop
= it
->stop_charpos
;
6771 return GET_NEXT_DISPLAY_ELEMENT (it
);
6775 /* We can sometimes back up for reasons that have nothing
6776 to do with bidi reordering. E.g., compositions. The
6777 code below is only needed when we are above the base
6778 embedding level, so test for that explicitly. */
6779 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6780 && IT_CHARPOS (*it
) < it
->prev_stop
)
6782 if (it
->base_level_stop
<= 0)
6783 it
->base_level_stop
= BEGV
;
6784 if (IT_CHARPOS (*it
) < it
->base_level_stop
)
6786 handle_stop_backwards (it
, it
->base_level_stop
);
6787 return GET_NEXT_DISPLAY_ELEMENT (it
);
6791 /* No face changes, overlays etc. in sight, so just return a
6792 character from current_buffer. */
6796 /* Maybe run the redisplay end trigger hook. Performance note:
6797 This doesn't seem to cost measurable time. */
6798 if (it
->redisplay_end_trigger_charpos
6800 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
6801 run_redisplay_end_trigger_hook (it
);
6803 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
6804 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6806 && next_element_from_composition (it
))
6811 /* Get the next character, maybe multibyte. */
6812 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
6813 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
6814 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
6816 it
->c
= *p
, it
->len
= 1;
6818 /* Record what we have and where it came from. */
6819 it
->what
= IT_CHARACTER
;
6820 it
->object
= it
->w
->buffer
;
6821 it
->position
= it
->current
.pos
;
6823 /* Normally we return the character found above, except when we
6824 really want to return an ellipsis for selective display. */
6829 /* A value of selective > 0 means hide lines indented more
6830 than that number of columns. */
6831 if (it
->selective
> 0
6832 && IT_CHARPOS (*it
) + 1 < ZV
6833 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
6834 IT_BYTEPOS (*it
) + 1,
6835 (double) it
->selective
)) /* iftc */
6837 success_p
= next_element_from_ellipsis (it
);
6838 it
->dpvec_char_len
= -1;
6841 else if (it
->c
== '\r' && it
->selective
== -1)
6843 /* A value of selective == -1 means that everything from the
6844 CR to the end of the line is invisible, with maybe an
6845 ellipsis displayed for it. */
6846 success_p
= next_element_from_ellipsis (it
);
6847 it
->dpvec_char_len
= -1;
6852 /* Value is zero if end of buffer reached. */
6853 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
6858 /* Run the redisplay end trigger hook for IT. */
6861 run_redisplay_end_trigger_hook (struct it
*it
)
6863 Lisp_Object args
[3];
6865 /* IT->glyph_row should be non-null, i.e. we should be actually
6866 displaying something, or otherwise we should not run the hook. */
6867 xassert (it
->glyph_row
);
6869 /* Set up hook arguments. */
6870 args
[0] = Qredisplay_end_trigger_functions
;
6871 args
[1] = it
->window
;
6872 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
6873 it
->redisplay_end_trigger_charpos
= 0;
6875 /* Since we are *trying* to run these functions, don't try to run
6876 them again, even if they get an error. */
6877 it
->w
->redisplay_end_trigger
= Qnil
;
6878 Frun_hook_with_args (3, args
);
6880 /* Notice if it changed the face of the character we are on. */
6881 handle_face_prop (it
);
6885 /* Deliver a composition display element. Unlike the other
6886 next_element_from_XXX, this function is not registered in the array
6887 get_next_element[]. It is called from next_element_from_buffer and
6888 next_element_from_string when necessary. */
6891 next_element_from_composition (struct it
*it
)
6893 it
->what
= IT_COMPOSITION
;
6894 it
->len
= it
->cmp_it
.nbytes
;
6895 if (STRINGP (it
->string
))
6899 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6900 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6903 it
->position
= it
->current
.string_pos
;
6904 it
->object
= it
->string
;
6905 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
6906 IT_STRING_BYTEPOS (*it
), it
->string
);
6912 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6913 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6916 if (it
->bidi_it
.new_paragraph
)
6917 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
);
6918 /* Resync the bidi iterator with IT's new position.
6919 FIXME: this doesn't support bidirectional text. */
6920 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
6921 bidi_move_to_visually_next (&it
->bidi_it
);
6925 it
->position
= it
->current
.pos
;
6926 it
->object
= it
->w
->buffer
;
6927 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
6928 IT_BYTEPOS (*it
), Qnil
);
6935 /***********************************************************************
6936 Moving an iterator without producing glyphs
6937 ***********************************************************************/
6939 /* Check if iterator is at a position corresponding to a valid buffer
6940 position after some move_it_ call. */
6942 #define IT_POS_VALID_AFTER_MOVE_P(it) \
6943 ((it)->method == GET_FROM_STRING \
6944 ? IT_STRING_CHARPOS (*it) == 0 \
6948 /* Move iterator IT to a specified buffer or X position within one
6949 line on the display without producing glyphs.
6951 OP should be a bit mask including some or all of these bits:
6952 MOVE_TO_X: Stop upon reaching x-position TO_X.
6953 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
6954 Regardless of OP's value, stop upon reaching the end of the display line.
6956 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
6957 This means, in particular, that TO_X includes window's horizontal
6960 The return value has several possible values that
6961 say what condition caused the scan to stop:
6963 MOVE_POS_MATCH_OR_ZV
6964 - when TO_POS or ZV was reached.
6967 -when TO_X was reached before TO_POS or ZV were reached.
6970 - when we reached the end of the display area and the line must
6974 - when we reached the end of the display area and the line is
6978 - when we stopped at a line end, i.e. a newline or a CR and selective
6981 static enum move_it_result
6982 move_it_in_display_line_to (struct it
*it
,
6983 EMACS_INT to_charpos
, int to_x
,
6984 enum move_operation_enum op
)
6986 enum move_it_result result
= MOVE_UNDEFINED
;
6987 struct glyph_row
*saved_glyph_row
;
6988 struct it wrap_it
, atpos_it
, atx_it
;
6990 enum it_method prev_method
= it
->method
;
6991 EMACS_INT prev_pos
= IT_CHARPOS (*it
);
6993 /* Don't produce glyphs in produce_glyphs. */
6994 saved_glyph_row
= it
->glyph_row
;
6995 it
->glyph_row
= NULL
;
6997 /* Use wrap_it to save a copy of IT wherever a word wrap could
6998 occur. Use atpos_it to save a copy of IT at the desired buffer
6999 position, if found, so that we can scan ahead and check if the
7000 word later overshoots the window edge. Use atx_it similarly, for
7006 #define BUFFER_POS_REACHED_P() \
7007 ((op & MOVE_TO_POS) != 0 \
7008 && BUFFERP (it->object) \
7009 && (IT_CHARPOS (*it) == to_charpos \
7010 || (!it->bidi_p && IT_CHARPOS (*it) > to_charpos)) \
7011 && (it->method == GET_FROM_BUFFER \
7012 || (it->method == GET_FROM_DISPLAY_VECTOR \
7013 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
7015 /* If there's a line-/wrap-prefix, handle it. */
7016 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
7017 && it
->current_y
< it
->last_visible_y
)
7018 handle_line_prefix (it
);
7022 int x
, i
, ascent
= 0, descent
= 0;
7024 /* Utility macro to reset an iterator with x, ascent, and descent. */
7025 #define IT_RESET_X_ASCENT_DESCENT(IT) \
7026 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
7027 (IT)->max_descent = descent)
7029 /* Stop if we move beyond TO_CHARPOS (after an image or stretch
7031 if ((op
& MOVE_TO_POS
) != 0
7032 && BUFFERP (it
->object
)
7033 && it
->method
== GET_FROM_BUFFER
7034 && ((!it
->bidi_p
&& IT_CHARPOS (*it
) > to_charpos
)
7036 && (prev_method
== GET_FROM_IMAGE
7037 || prev_method
== GET_FROM_STRETCH
)
7038 /* Passed TO_CHARPOS from left to right. */
7039 && ((prev_pos
< to_charpos
7040 && IT_CHARPOS (*it
) > to_charpos
)
7041 /* Passed TO_CHARPOS from right to left. */
7042 || (prev_pos
> to_charpos
7043 && IT_CHARPOS (*it
) < to_charpos
)))))
7045 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7047 result
= MOVE_POS_MATCH_OR_ZV
;
7050 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7051 /* If wrap_it is valid, the current position might be in a
7052 word that is wrapped. So, save the iterator in
7053 atpos_it and continue to see if wrapping happens. */
7057 prev_method
= it
->method
;
7058 if (it
->method
== GET_FROM_BUFFER
)
7059 prev_pos
= IT_CHARPOS (*it
);
7060 /* Stop when ZV reached.
7061 We used to stop here when TO_CHARPOS reached as well, but that is
7062 too soon if this glyph does not fit on this line. So we handle it
7063 explicitly below. */
7064 if (!get_next_display_element (it
))
7066 result
= MOVE_POS_MATCH_OR_ZV
;
7070 if (it
->line_wrap
== TRUNCATE
)
7072 if (BUFFER_POS_REACHED_P ())
7074 result
= MOVE_POS_MATCH_OR_ZV
;
7080 if (it
->line_wrap
== WORD_WRAP
)
7082 if (IT_DISPLAYING_WHITESPACE (it
))
7086 /* We have reached a glyph that follows one or more
7087 whitespace characters. If the position is
7088 already found, we are done. */
7089 if (atpos_it
.sp
>= 0)
7092 result
= MOVE_POS_MATCH_OR_ZV
;
7098 result
= MOVE_X_REACHED
;
7101 /* Otherwise, we can wrap here. */
7108 /* Remember the line height for the current line, in case
7109 the next element doesn't fit on the line. */
7110 ascent
= it
->max_ascent
;
7111 descent
= it
->max_descent
;
7113 /* The call to produce_glyphs will get the metrics of the
7114 display element IT is loaded with. Record the x-position
7115 before this display element, in case it doesn't fit on the
7119 PRODUCE_GLYPHS (it
);
7121 if (it
->area
!= TEXT_AREA
)
7123 set_iterator_to_next (it
, 1);
7127 /* The number of glyphs we get back in IT->nglyphs will normally
7128 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
7129 character on a terminal frame, or (iii) a line end. For the
7130 second case, IT->nglyphs - 1 padding glyphs will be present.
7131 (On X frames, there is only one glyph produced for a
7132 composite character.)
7134 The behavior implemented below means, for continuation lines,
7135 that as many spaces of a TAB as fit on the current line are
7136 displayed there. For terminal frames, as many glyphs of a
7137 multi-glyph character are displayed in the current line, too.
7138 This is what the old redisplay code did, and we keep it that
7139 way. Under X, the whole shape of a complex character must
7140 fit on the line or it will be completely displayed in the
7143 Note that both for tabs and padding glyphs, all glyphs have
7147 /* More than one glyph or glyph doesn't fit on line. All
7148 glyphs have the same width. */
7149 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
7151 int x_before_this_char
= x
;
7152 int hpos_before_this_char
= it
->hpos
;
7154 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
7156 new_x
= x
+ single_glyph_width
;
7158 /* We want to leave anything reaching TO_X to the caller. */
7159 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
7161 if (BUFFER_POS_REACHED_P ())
7163 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7164 goto buffer_pos_reached
;
7165 if (atpos_it
.sp
< 0)
7168 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7173 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7176 result
= MOVE_X_REACHED
;
7182 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
7187 if (/* Lines are continued. */
7188 it
->line_wrap
!= TRUNCATE
7189 && (/* And glyph doesn't fit on the line. */
7190 new_x
> it
->last_visible_x
7191 /* Or it fits exactly and we're on a window
7193 || (new_x
== it
->last_visible_x
7194 && FRAME_WINDOW_P (it
->f
))))
7196 if (/* IT->hpos == 0 means the very first glyph
7197 doesn't fit on the line, e.g. a wide image. */
7199 || (new_x
== it
->last_visible_x
7200 && FRAME_WINDOW_P (it
->f
)))
7203 it
->current_x
= new_x
;
7205 /* The character's last glyph just barely fits
7207 if (i
== it
->nglyphs
- 1)
7209 /* If this is the destination position,
7210 return a position *before* it in this row,
7211 now that we know it fits in this row. */
7212 if (BUFFER_POS_REACHED_P ())
7214 if (it
->line_wrap
!= WORD_WRAP
7217 it
->hpos
= hpos_before_this_char
;
7218 it
->current_x
= x_before_this_char
;
7219 result
= MOVE_POS_MATCH_OR_ZV
;
7222 if (it
->line_wrap
== WORD_WRAP
7226 atpos_it
.current_x
= x_before_this_char
;
7227 atpos_it
.hpos
= hpos_before_this_char
;
7231 set_iterator_to_next (it
, 1);
7232 /* On graphical terminals, newlines may
7233 "overflow" into the fringe if
7234 overflow-newline-into-fringe is non-nil.
7235 On text-only terminals, newlines may
7236 overflow into the last glyph on the
7238 if (!FRAME_WINDOW_P (it
->f
)
7239 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7241 if (!get_next_display_element (it
))
7243 result
= MOVE_POS_MATCH_OR_ZV
;
7246 if (BUFFER_POS_REACHED_P ())
7248 if (ITERATOR_AT_END_OF_LINE_P (it
))
7249 result
= MOVE_POS_MATCH_OR_ZV
;
7251 result
= MOVE_LINE_CONTINUED
;
7254 if (ITERATOR_AT_END_OF_LINE_P (it
))
7256 result
= MOVE_NEWLINE_OR_CR
;
7263 IT_RESET_X_ASCENT_DESCENT (it
);
7265 if (wrap_it
.sp
>= 0)
7272 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
7274 result
= MOVE_LINE_CONTINUED
;
7278 if (BUFFER_POS_REACHED_P ())
7280 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7281 goto buffer_pos_reached
;
7282 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7285 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7289 if (new_x
> it
->first_visible_x
)
7291 /* Glyph is visible. Increment number of glyphs that
7292 would be displayed. */
7297 if (result
!= MOVE_UNDEFINED
)
7300 else if (BUFFER_POS_REACHED_P ())
7303 IT_RESET_X_ASCENT_DESCENT (it
);
7304 result
= MOVE_POS_MATCH_OR_ZV
;
7307 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
7309 /* Stop when TO_X specified and reached. This check is
7310 necessary here because of lines consisting of a line end,
7311 only. The line end will not produce any glyphs and we
7312 would never get MOVE_X_REACHED. */
7313 xassert (it
->nglyphs
== 0);
7314 result
= MOVE_X_REACHED
;
7318 /* Is this a line end? If yes, we're done. */
7319 if (ITERATOR_AT_END_OF_LINE_P (it
))
7321 result
= MOVE_NEWLINE_OR_CR
;
7325 if (it
->method
== GET_FROM_BUFFER
)
7326 prev_pos
= IT_CHARPOS (*it
);
7327 /* The current display element has been consumed. Advance
7329 set_iterator_to_next (it
, 1);
7331 /* Stop if lines are truncated and IT's current x-position is
7332 past the right edge of the window now. */
7333 if (it
->line_wrap
== TRUNCATE
7334 && it
->current_x
>= it
->last_visible_x
)
7336 if (!FRAME_WINDOW_P (it
->f
)
7337 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7339 if (!get_next_display_element (it
)
7340 || BUFFER_POS_REACHED_P ())
7342 result
= MOVE_POS_MATCH_OR_ZV
;
7345 if (ITERATOR_AT_END_OF_LINE_P (it
))
7347 result
= MOVE_NEWLINE_OR_CR
;
7351 result
= MOVE_LINE_TRUNCATED
;
7354 #undef IT_RESET_X_ASCENT_DESCENT
7357 #undef BUFFER_POS_REACHED_P
7359 /* If we scanned beyond to_pos and didn't find a point to wrap at,
7360 restore the saved iterator. */
7361 if (atpos_it
.sp
>= 0)
7363 else if (atx_it
.sp
>= 0)
7368 /* Restore the iterator settings altered at the beginning of this
7370 it
->glyph_row
= saved_glyph_row
;
7374 /* For external use. */
7376 move_it_in_display_line (struct it
*it
,
7377 EMACS_INT to_charpos
, int to_x
,
7378 enum move_operation_enum op
)
7380 if (it
->line_wrap
== WORD_WRAP
7381 && (op
& MOVE_TO_X
))
7383 struct it save_it
= *it
;
7384 int skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7385 /* When word-wrap is on, TO_X may lie past the end
7386 of a wrapped line. Then it->current is the
7387 character on the next line, so backtrack to the
7388 space before the wrap point. */
7389 if (skip
== MOVE_LINE_CONTINUED
)
7391 int prev_x
= max (it
->current_x
- 1, 0);
7393 move_it_in_display_line_to
7394 (it
, -1, prev_x
, MOVE_TO_X
);
7398 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7402 /* Move IT forward until it satisfies one or more of the criteria in
7403 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
7405 OP is a bit-mask that specifies where to stop, and in particular,
7406 which of those four position arguments makes a difference. See the
7407 description of enum move_operation_enum.
7409 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
7410 screen line, this function will set IT to the next position >
7414 move_it_to (struct it
*it
, int to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
7416 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
7417 int line_height
, line_start_x
= 0, reached
= 0;
7421 if (op
& MOVE_TO_VPOS
)
7423 /* If no TO_CHARPOS and no TO_X specified, stop at the
7424 start of the line TO_VPOS. */
7425 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
7427 if (it
->vpos
== to_vpos
)
7433 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
7437 /* TO_VPOS >= 0 means stop at TO_X in the line at
7438 TO_VPOS, or at TO_POS, whichever comes first. */
7439 if (it
->vpos
== to_vpos
)
7445 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7447 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
7452 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
7454 /* We have reached TO_X but not in the line we want. */
7455 skip
= move_it_in_display_line_to (it
, to_charpos
,
7457 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7465 else if (op
& MOVE_TO_Y
)
7467 struct it it_backup
;
7469 if (it
->line_wrap
== WORD_WRAP
)
7472 /* TO_Y specified means stop at TO_X in the line containing
7473 TO_Y---or at TO_CHARPOS if this is reached first. The
7474 problem is that we can't really tell whether the line
7475 contains TO_Y before we have completely scanned it, and
7476 this may skip past TO_X. What we do is to first scan to
7479 If TO_X is not specified, use a TO_X of zero. The reason
7480 is to make the outcome of this function more predictable.
7481 If we didn't use TO_X == 0, we would stop at the end of
7482 the line which is probably not what a caller would expect
7484 skip
= move_it_in_display_line_to
7485 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
7486 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
7488 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
7489 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7491 else if (skip
== MOVE_X_REACHED
)
7493 /* If TO_X was reached, we want to know whether TO_Y is
7494 in the line. We know this is the case if the already
7495 scanned glyphs make the line tall enough. Otherwise,
7496 we must check by scanning the rest of the line. */
7497 line_height
= it
->max_ascent
+ it
->max_descent
;
7498 if (to_y
>= it
->current_y
7499 && to_y
< it
->current_y
+ line_height
)
7505 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
7506 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
7508 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
7509 line_height
= it
->max_ascent
+ it
->max_descent
;
7510 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7512 if (to_y
>= it
->current_y
7513 && to_y
< it
->current_y
+ line_height
)
7515 /* If TO_Y is in this line and TO_X was reached
7516 above, we scanned too far. We have to restore
7517 IT's settings to the ones before skipping. */
7524 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7530 /* Check whether TO_Y is in this line. */
7531 line_height
= it
->max_ascent
+ it
->max_descent
;
7532 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7534 if (to_y
>= it
->current_y
7535 && to_y
< it
->current_y
+ line_height
)
7537 /* When word-wrap is on, TO_X may lie past the end
7538 of a wrapped line. Then it->current is the
7539 character on the next line, so backtrack to the
7540 space before the wrap point. */
7541 if (skip
== MOVE_LINE_CONTINUED
7542 && it
->line_wrap
== WORD_WRAP
)
7544 int prev_x
= max (it
->current_x
- 1, 0);
7546 skip
= move_it_in_display_line_to
7547 (it
, -1, prev_x
, MOVE_TO_X
);
7556 else if (BUFFERP (it
->object
)
7557 && (it
->method
== GET_FROM_BUFFER
7558 || it
->method
== GET_FROM_STRETCH
)
7559 && IT_CHARPOS (*it
) >= to_charpos
)
7560 skip
= MOVE_POS_MATCH_OR_ZV
;
7562 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
7566 case MOVE_POS_MATCH_OR_ZV
:
7570 case MOVE_NEWLINE_OR_CR
:
7571 set_iterator_to_next (it
, 1);
7572 it
->continuation_lines_width
= 0;
7575 case MOVE_LINE_TRUNCATED
:
7576 it
->continuation_lines_width
= 0;
7577 reseat_at_next_visible_line_start (it
, 0);
7578 if ((op
& MOVE_TO_POS
) != 0
7579 && IT_CHARPOS (*it
) > to_charpos
)
7586 case MOVE_LINE_CONTINUED
:
7587 /* For continued lines ending in a tab, some of the glyphs
7588 associated with the tab are displayed on the current
7589 line. Since it->current_x does not include these glyphs,
7590 we use it->last_visible_x instead. */
7593 it
->continuation_lines_width
+= it
->last_visible_x
;
7594 /* When moving by vpos, ensure that the iterator really
7595 advances to the next line (bug#847, bug#969). Fixme:
7596 do we need to do this in other circumstances? */
7597 if (it
->current_x
!= it
->last_visible_x
7598 && (op
& MOVE_TO_VPOS
)
7599 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
7601 line_start_x
= it
->current_x
+ it
->pixel_width
7602 - it
->last_visible_x
;
7603 set_iterator_to_next (it
, 0);
7607 it
->continuation_lines_width
+= it
->current_x
;
7614 /* Reset/increment for the next run. */
7615 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
7616 it
->current_x
= line_start_x
;
7619 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7621 last_height
= it
->max_ascent
+ it
->max_descent
;
7622 last_max_ascent
= it
->max_ascent
;
7623 it
->max_ascent
= it
->max_descent
= 0;
7628 /* On text terminals, we may stop at the end of a line in the middle
7629 of a multi-character glyph. If the glyph itself is continued,
7630 i.e. it is actually displayed on the next line, don't treat this
7631 stopping point as valid; move to the next line instead (unless
7632 that brings us offscreen). */
7633 if (!FRAME_WINDOW_P (it
->f
)
7635 && IT_CHARPOS (*it
) == to_charpos
7636 && it
->what
== IT_CHARACTER
7638 && it
->line_wrap
== WINDOW_WRAP
7639 && it
->current_x
== it
->last_visible_x
- 1
7642 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
7644 it
->continuation_lines_width
+= it
->current_x
;
7645 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
7646 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7648 last_height
= it
->max_ascent
+ it
->max_descent
;
7649 last_max_ascent
= it
->max_ascent
;
7652 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
7656 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
7658 If DY > 0, move IT backward at least that many pixels. DY = 0
7659 means move IT backward to the preceding line start or BEGV. This
7660 function may move over more than DY pixels if IT->current_y - DY
7661 ends up in the middle of a line; in this case IT->current_y will be
7662 set to the top of the line moved to. */
7665 move_it_vertically_backward (struct it
*it
, int dy
)
7674 start_pos
= IT_CHARPOS (*it
);
7676 /* Estimate how many newlines we must move back. */
7677 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
7679 /* Set the iterator's position that many lines back. */
7680 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
7681 back_to_previous_visible_line_start (it
);
7683 /* Reseat the iterator here. When moving backward, we don't want
7684 reseat to skip forward over invisible text, set up the iterator
7685 to deliver from overlay strings at the new position etc. So,
7686 use reseat_1 here. */
7687 reseat_1 (it
, it
->current
.pos
, 1);
7689 /* We are now surely at a line start. */
7690 it
->current_x
= it
->hpos
= 0;
7691 it
->continuation_lines_width
= 0;
7693 /* Move forward and see what y-distance we moved. First move to the
7694 start of the next line so that we get its height. We need this
7695 height to be able to tell whether we reached the specified
7698 it2
.max_ascent
= it2
.max_descent
= 0;
7701 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
7702 MOVE_TO_POS
| MOVE_TO_VPOS
);
7704 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
7705 xassert (IT_CHARPOS (*it
) >= BEGV
);
7708 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
7709 xassert (IT_CHARPOS (*it
) >= BEGV
);
7710 /* H is the actual vertical distance from the position in *IT
7711 and the starting position. */
7712 h
= it2
.current_y
- it
->current_y
;
7713 /* NLINES is the distance in number of lines. */
7714 nlines
= it2
.vpos
- it
->vpos
;
7716 /* Correct IT's y and vpos position
7717 so that they are relative to the starting point. */
7723 /* DY == 0 means move to the start of the screen line. The
7724 value of nlines is > 0 if continuation lines were involved. */
7726 move_it_by_lines (it
, nlines
, 1);
7730 /* The y-position we try to reach, relative to *IT.
7731 Note that H has been subtracted in front of the if-statement. */
7732 int target_y
= it
->current_y
+ h
- dy
;
7733 int y0
= it3
.current_y
;
7734 int y1
= line_bottom_y (&it3
);
7735 int line_height
= y1
- y0
;
7737 /* If we did not reach target_y, try to move further backward if
7738 we can. If we moved too far backward, try to move forward. */
7739 if (target_y
< it
->current_y
7740 /* This is heuristic. In a window that's 3 lines high, with
7741 a line height of 13 pixels each, recentering with point
7742 on the bottom line will try to move -39/2 = 19 pixels
7743 backward. Try to avoid moving into the first line. */
7744 && (it
->current_y
- target_y
7745 > min (window_box_height (it
->w
), line_height
* 2 / 3))
7746 && IT_CHARPOS (*it
) > BEGV
)
7748 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
7749 target_y
- it
->current_y
));
7750 dy
= it
->current_y
- target_y
;
7751 goto move_further_back
;
7753 else if (target_y
>= it
->current_y
+ line_height
7754 && IT_CHARPOS (*it
) < ZV
)
7756 /* Should move forward by at least one line, maybe more.
7758 Note: Calling move_it_by_lines can be expensive on
7759 terminal frames, where compute_motion is used (via
7760 vmotion) to do the job, when there are very long lines
7761 and truncate-lines is nil. That's the reason for
7762 treating terminal frames specially here. */
7764 if (!FRAME_WINDOW_P (it
->f
))
7765 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
7770 move_it_by_lines (it
, 1, 1);
7772 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
7779 /* Move IT by a specified amount of pixel lines DY. DY negative means
7780 move backwards. DY = 0 means move to start of screen line. At the
7781 end, IT will be on the start of a screen line. */
7784 move_it_vertically (struct it
*it
, int dy
)
7787 move_it_vertically_backward (it
, -dy
);
7790 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
7791 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
7792 MOVE_TO_POS
| MOVE_TO_Y
);
7793 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
7795 /* If buffer ends in ZV without a newline, move to the start of
7796 the line to satisfy the post-condition. */
7797 if (IT_CHARPOS (*it
) == ZV
7799 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
7800 move_it_by_lines (it
, 0, 0);
7805 /* Move iterator IT past the end of the text line it is in. */
7808 move_it_past_eol (struct it
*it
)
7810 enum move_it_result rc
;
7812 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
7813 if (rc
== MOVE_NEWLINE_OR_CR
)
7814 set_iterator_to_next (it
, 0);
7818 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
7819 negative means move up. DVPOS == 0 means move to the start of the
7820 screen line. NEED_Y_P non-zero means calculate IT->current_y. If
7821 NEED_Y_P is zero, IT->current_y will be left unchanged.
7823 Further optimization ideas: If we would know that IT->f doesn't use
7824 a face with proportional font, we could be faster for
7825 truncate-lines nil. */
7828 move_it_by_lines (struct it
*it
, int dvpos
, int need_y_p
)
7830 struct position pos
;
7832 /* The commented-out optimization uses vmotion on terminals. This
7833 gives bad results, because elements like it->what, on which
7834 callers such as pos_visible_p rely, aren't updated. */
7835 /* if (!FRAME_WINDOW_P (it->f))
7837 struct text_pos textpos;
7839 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
7840 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
7841 reseat (it, textpos, 1);
7842 it->vpos += pos.vpos;
7843 it->current_y += pos.vpos;
7849 /* DVPOS == 0 means move to the start of the screen line. */
7850 move_it_vertically_backward (it
, 0);
7851 xassert (it
->current_x
== 0 && it
->hpos
== 0);
7852 /* Let next call to line_bottom_y calculate real line height */
7857 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
7858 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
7859 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
7864 int start_charpos
, i
;
7866 /* Start at the beginning of the screen line containing IT's
7867 position. This may actually move vertically backwards,
7868 in case of overlays, so adjust dvpos accordingly. */
7870 move_it_vertically_backward (it
, 0);
7873 /* Go back -DVPOS visible lines and reseat the iterator there. */
7874 start_charpos
= IT_CHARPOS (*it
);
7875 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
7876 back_to_previous_visible_line_start (it
);
7877 reseat (it
, it
->current
.pos
, 1);
7879 /* Move further back if we end up in a string or an image. */
7880 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
7882 /* First try to move to start of display line. */
7884 move_it_vertically_backward (it
, 0);
7886 if (IT_POS_VALID_AFTER_MOVE_P (it
))
7888 /* If start of line is still in string or image,
7889 move further back. */
7890 back_to_previous_visible_line_start (it
);
7891 reseat (it
, it
->current
.pos
, 1);
7895 it
->current_x
= it
->hpos
= 0;
7897 /* Above call may have moved too far if continuation lines
7898 are involved. Scan forward and see if it did. */
7900 it2
.vpos
= it2
.current_y
= 0;
7901 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
7902 it
->vpos
-= it2
.vpos
;
7903 it
->current_y
-= it2
.current_y
;
7904 it
->current_x
= it
->hpos
= 0;
7906 /* If we moved too far back, move IT some lines forward. */
7907 if (it2
.vpos
> -dvpos
)
7909 int delta
= it2
.vpos
+ dvpos
;
7911 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
7912 /* Move back again if we got too far ahead. */
7913 if (IT_CHARPOS (*it
) >= start_charpos
)
7919 /* Return 1 if IT points into the middle of a display vector. */
7922 in_display_vector_p (struct it
*it
)
7924 return (it
->method
== GET_FROM_DISPLAY_VECTOR
7925 && it
->current
.dpvec_index
> 0
7926 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
7930 /***********************************************************************
7932 ***********************************************************************/
7935 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
7939 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
7941 Lisp_Object args
[3];
7942 Lisp_Object msg
, fmt
;
7945 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
7948 /* Do nothing if called asynchronously. Inserting text into
7949 a buffer may call after-change-functions and alike and
7950 that would means running Lisp asynchronously. */
7951 if (handling_signal
)
7955 GCPRO4 (fmt
, msg
, arg1
, arg2
);
7957 args
[0] = fmt
= build_string (format
);
7960 msg
= Fformat (3, args
);
7962 len
= SBYTES (msg
) + 1;
7963 SAFE_ALLOCA (buffer
, char *, len
);
7964 memcpy (buffer
, SDATA (msg
), len
);
7966 message_dolog (buffer
, len
- 1, 1, 0);
7973 /* Output a newline in the *Messages* buffer if "needs" one. */
7976 message_log_maybe_newline (void)
7978 if (message_log_need_newline
)
7979 message_dolog ("", 0, 1, 0);
7983 /* Add a string M of length NBYTES to the message log, optionally
7984 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
7985 nonzero, means interpret the contents of M as multibyte. This
7986 function calls low-level routines in order to bypass text property
7987 hooks, etc. which might not be safe to run.
7989 This may GC (insert may run before/after change hooks),
7990 so the buffer M must NOT point to a Lisp string. */
7993 message_dolog (const char *m
, int nbytes
, int nlflag
, int multibyte
)
7995 if (!NILP (Vmemory_full
))
7998 if (!NILP (Vmessage_log_max
))
8000 struct buffer
*oldbuf
;
8001 Lisp_Object oldpoint
, oldbegv
, oldzv
;
8002 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
8003 int point_at_end
= 0;
8005 Lisp_Object old_deactivate_mark
, tem
;
8006 struct gcpro gcpro1
;
8008 old_deactivate_mark
= Vdeactivate_mark
;
8009 oldbuf
= current_buffer
;
8010 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
8011 current_buffer
->undo_list
= Qt
;
8013 oldpoint
= message_dolog_marker1
;
8014 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
8015 oldbegv
= message_dolog_marker2
;
8016 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
8017 oldzv
= message_dolog_marker3
;
8018 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
8019 GCPRO1 (old_deactivate_mark
);
8027 BEGV_BYTE
= BEG_BYTE
;
8030 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8032 /* Insert the string--maybe converting multibyte to single byte
8033 or vice versa, so that all the text fits the buffer. */
8035 && NILP (current_buffer
->enable_multibyte_characters
))
8037 int i
, c
, char_bytes
;
8038 unsigned char work
[1];
8040 /* Convert a multibyte string to single-byte
8041 for the *Message* buffer. */
8042 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
8044 c
= string_char_and_length (m
+ i
, &char_bytes
);
8045 work
[0] = (ASCII_CHAR_P (c
)
8047 : multibyte_char_to_unibyte (c
, Qnil
));
8048 insert_1_both (work
, 1, 1, 1, 0, 0);
8051 else if (! multibyte
8052 && ! NILP (current_buffer
->enable_multibyte_characters
))
8054 int i
, c
, char_bytes
;
8055 unsigned char *msg
= (unsigned char *) m
;
8056 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
8057 /* Convert a single-byte string to multibyte
8058 for the *Message* buffer. */
8059 for (i
= 0; i
< nbytes
; i
++)
8062 MAKE_CHAR_MULTIBYTE (c
);
8063 char_bytes
= CHAR_STRING (c
, str
);
8064 insert_1_both (str
, 1, char_bytes
, 1, 0, 0);
8068 insert_1 (m
, nbytes
, 1, 0, 0);
8072 int this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
, dup
;
8073 insert_1 ("\n", 1, 1, 0, 0);
8075 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8077 this_bol_byte
= PT_BYTE
;
8079 /* See if this line duplicates the previous one.
8080 If so, combine duplicates. */
8083 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8085 prev_bol_byte
= PT_BYTE
;
8087 dup
= message_log_check_duplicate (prev_bol
, prev_bol_byte
,
8088 this_bol
, this_bol_byte
);
8091 del_range_both (prev_bol
, prev_bol_byte
,
8092 this_bol
, this_bol_byte
, 0);
8098 /* If you change this format, don't forget to also
8099 change message_log_check_duplicate. */
8100 sprintf (dupstr
, " [%d times]", dup
);
8101 duplen
= strlen (dupstr
);
8102 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
8103 insert_1 (dupstr
, duplen
, 1, 0, 1);
8108 /* If we have more than the desired maximum number of lines
8109 in the *Messages* buffer now, delete the oldest ones.
8110 This is safe because we don't have undo in this buffer. */
8112 if (NATNUMP (Vmessage_log_max
))
8114 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
8115 -XFASTINT (Vmessage_log_max
) - 1, 0);
8116 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
8119 BEGV
= XMARKER (oldbegv
)->charpos
;
8120 BEGV_BYTE
= marker_byte_position (oldbegv
);
8129 ZV
= XMARKER (oldzv
)->charpos
;
8130 ZV_BYTE
= marker_byte_position (oldzv
);
8134 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8136 /* We can't do Fgoto_char (oldpoint) because it will run some
8138 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
8139 XMARKER (oldpoint
)->bytepos
);
8142 unchain_marker (XMARKER (oldpoint
));
8143 unchain_marker (XMARKER (oldbegv
));
8144 unchain_marker (XMARKER (oldzv
));
8146 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
8147 set_buffer_internal (oldbuf
);
8149 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
8150 message_log_need_newline
= !nlflag
;
8151 Vdeactivate_mark
= old_deactivate_mark
;
8156 /* We are at the end of the buffer after just having inserted a newline.
8157 (Note: We depend on the fact we won't be crossing the gap.)
8158 Check to see if the most recent message looks a lot like the previous one.
8159 Return 0 if different, 1 if the new one should just replace it, or a
8160 value N > 1 if we should also append " [N times]". */
8163 message_log_check_duplicate (int prev_bol
, int prev_bol_byte
,
8164 int this_bol
, int this_bol_byte
)
8167 int len
= Z_BYTE
- 1 - this_bol_byte
;
8169 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
8170 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
8172 for (i
= 0; i
< len
; i
++)
8174 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
8182 if (*p1
++ == ' ' && *p1
++ == '[')
8185 while (*p1
>= '0' && *p1
<= '9')
8186 n
= n
* 10 + *p1
++ - '0';
8187 if (strncmp (p1
, " times]\n", 8) == 0)
8194 /* Display an echo area message M with a specified length of NBYTES
8195 bytes. The string may include null characters. If M is 0, clear
8196 out any existing message, and let the mini-buffer text show
8199 This may GC, so the buffer M must NOT point to a Lisp string. */
8202 message2 (const char *m
, int nbytes
, int multibyte
)
8204 /* First flush out any partial line written with print. */
8205 message_log_maybe_newline ();
8207 message_dolog (m
, nbytes
, 1, multibyte
);
8208 message2_nolog (m
, nbytes
, multibyte
);
8212 /* The non-logging counterpart of message2. */
8215 message2_nolog (const char *m
, int nbytes
, int multibyte
)
8217 struct frame
*sf
= SELECTED_FRAME ();
8218 message_enable_multibyte
= multibyte
;
8220 if (FRAME_INITIAL_P (sf
))
8222 if (noninteractive_need_newline
)
8223 putc ('\n', stderr
);
8224 noninteractive_need_newline
= 0;
8226 fwrite (m
, nbytes
, 1, stderr
);
8227 if (cursor_in_echo_area
== 0)
8228 fprintf (stderr
, "\n");
8231 /* A null message buffer means that the frame hasn't really been
8232 initialized yet. Error messages get reported properly by
8233 cmd_error, so this must be just an informative message; toss it. */
8234 else if (INTERACTIVE
8235 && sf
->glyphs_initialized_p
8236 && FRAME_MESSAGE_BUF (sf
))
8238 Lisp_Object mini_window
;
8241 /* Get the frame containing the mini-buffer
8242 that the selected frame is using. */
8243 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8244 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8246 FRAME_SAMPLE_VISIBILITY (f
);
8247 if (FRAME_VISIBLE_P (sf
)
8248 && ! FRAME_VISIBLE_P (f
))
8249 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
8253 set_message (m
, Qnil
, nbytes
, multibyte
);
8254 if (minibuffer_auto_raise
)
8255 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8258 clear_message (1, 1);
8260 do_pending_window_change (0);
8261 echo_area_display (1);
8262 do_pending_window_change (0);
8263 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8264 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8269 /* Display an echo area message M with a specified length of NBYTES
8270 bytes. The string may include null characters. If M is not a
8271 string, clear out any existing message, and let the mini-buffer
8274 This function cancels echoing. */
8277 message3 (Lisp_Object m
, int nbytes
, int multibyte
)
8279 struct gcpro gcpro1
;
8282 clear_message (1,1);
8285 /* First flush out any partial line written with print. */
8286 message_log_maybe_newline ();
8292 SAFE_ALLOCA (buffer
, char *, nbytes
);
8293 memcpy (buffer
, SDATA (m
), nbytes
);
8294 message_dolog (buffer
, nbytes
, 1, multibyte
);
8297 message3_nolog (m
, nbytes
, multibyte
);
8303 /* The non-logging version of message3.
8304 This does not cancel echoing, because it is used for echoing.
8305 Perhaps we need to make a separate function for echoing
8306 and make this cancel echoing. */
8309 message3_nolog (Lisp_Object m
, int nbytes
, int multibyte
)
8311 struct frame
*sf
= SELECTED_FRAME ();
8312 message_enable_multibyte
= multibyte
;
8314 if (FRAME_INITIAL_P (sf
))
8316 if (noninteractive_need_newline
)
8317 putc ('\n', stderr
);
8318 noninteractive_need_newline
= 0;
8320 fwrite (SDATA (m
), nbytes
, 1, stderr
);
8321 if (cursor_in_echo_area
== 0)
8322 fprintf (stderr
, "\n");
8325 /* A null message buffer means that the frame hasn't really been
8326 initialized yet. Error messages get reported properly by
8327 cmd_error, so this must be just an informative message; toss it. */
8328 else if (INTERACTIVE
8329 && sf
->glyphs_initialized_p
8330 && FRAME_MESSAGE_BUF (sf
))
8332 Lisp_Object mini_window
;
8336 /* Get the frame containing the mini-buffer
8337 that the selected frame is using. */
8338 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8339 frame
= XWINDOW (mini_window
)->frame
;
8342 FRAME_SAMPLE_VISIBILITY (f
);
8343 if (FRAME_VISIBLE_P (sf
)
8344 && !FRAME_VISIBLE_P (f
))
8345 Fmake_frame_visible (frame
);
8347 if (STRINGP (m
) && SCHARS (m
) > 0)
8349 set_message (NULL
, m
, nbytes
, multibyte
);
8350 if (minibuffer_auto_raise
)
8351 Fraise_frame (frame
);
8352 /* Assume we are not echoing.
8353 (If we are, echo_now will override this.) */
8354 echo_message_buffer
= Qnil
;
8357 clear_message (1, 1);
8359 do_pending_window_change (0);
8360 echo_area_display (1);
8361 do_pending_window_change (0);
8362 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8363 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8368 /* Display a null-terminated echo area message M. If M is 0, clear
8369 out any existing message, and let the mini-buffer text show through.
8371 The buffer M must continue to exist until after the echo area gets
8372 cleared or some other message gets displayed there. Do not pass
8373 text that is stored in a Lisp string. Do not pass text in a buffer
8374 that was alloca'd. */
8377 message1 (const char *m
)
8379 message2 (m
, (m
? strlen (m
) : 0), 0);
8383 /* The non-logging counterpart of message1. */
8386 message1_nolog (const char *m
)
8388 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
8391 /* Display a message M which contains a single %s
8392 which gets replaced with STRING. */
8395 message_with_string (const char *m
, Lisp_Object string
, int log
)
8397 CHECK_STRING (string
);
8403 if (noninteractive_need_newline
)
8404 putc ('\n', stderr
);
8405 noninteractive_need_newline
= 0;
8406 fprintf (stderr
, m
, SDATA (string
));
8407 if (!cursor_in_echo_area
)
8408 fprintf (stderr
, "\n");
8412 else if (INTERACTIVE
)
8414 /* The frame whose minibuffer we're going to display the message on.
8415 It may be larger than the selected frame, so we need
8416 to use its buffer, not the selected frame's buffer. */
8417 Lisp_Object mini_window
;
8418 struct frame
*f
, *sf
= SELECTED_FRAME ();
8420 /* Get the frame containing the minibuffer
8421 that the selected frame is using. */
8422 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8423 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8425 /* A null message buffer means that the frame hasn't really been
8426 initialized yet. Error messages get reported properly by
8427 cmd_error, so this must be just an informative message; toss it. */
8428 if (FRAME_MESSAGE_BUF (f
))
8430 Lisp_Object args
[2], message
;
8431 struct gcpro gcpro1
, gcpro2
;
8433 args
[0] = build_string (m
);
8434 args
[1] = message
= string
;
8435 GCPRO2 (args
[0], message
);
8438 message
= Fformat (2, args
);
8441 message3 (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
8443 message3_nolog (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
8447 /* Print should start at the beginning of the message
8448 buffer next time. */
8449 message_buf_print
= 0;
8455 /* Dump an informative message to the minibuf. If M is 0, clear out
8456 any existing message, and let the mini-buffer text show through. */
8459 vmessage (const char *m
, va_list ap
)
8465 if (noninteractive_need_newline
)
8466 putc ('\n', stderr
);
8467 noninteractive_need_newline
= 0;
8468 vfprintf (stderr
, m
, ap
);
8469 if (cursor_in_echo_area
== 0)
8470 fprintf (stderr
, "\n");
8474 else if (INTERACTIVE
)
8476 /* The frame whose mini-buffer we're going to display the message
8477 on. It may be larger than the selected frame, so we need to
8478 use its buffer, not the selected frame's buffer. */
8479 Lisp_Object mini_window
;
8480 struct frame
*f
, *sf
= SELECTED_FRAME ();
8482 /* Get the frame containing the mini-buffer
8483 that the selected frame is using. */
8484 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8485 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8487 /* A null message buffer means that the frame hasn't really been
8488 initialized yet. Error messages get reported properly by
8489 cmd_error, so this must be just an informative message; toss
8491 if (FRAME_MESSAGE_BUF (f
))
8497 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8498 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, ap
);
8500 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
8505 /* Print should start at the beginning of the message
8506 buffer next time. */
8507 message_buf_print
= 0;
8513 message (const char *m
, ...)
8522 /* The non-logging version of message. */
8525 message_nolog (const char *m
, ...)
8527 Lisp_Object old_log_max
;
8530 old_log_max
= Vmessage_log_max
;
8531 Vmessage_log_max
= Qnil
;
8533 Vmessage_log_max
= old_log_max
;
8538 /* Display the current message in the current mini-buffer. This is
8539 only called from error handlers in process.c, and is not time
8543 update_echo_area (void)
8545 if (!NILP (echo_area_buffer
[0]))
8548 string
= Fcurrent_message ();
8549 message3 (string
, SBYTES (string
),
8550 !NILP (current_buffer
->enable_multibyte_characters
));
8555 /* Make sure echo area buffers in `echo_buffers' are live.
8556 If they aren't, make new ones. */
8559 ensure_echo_area_buffers (void)
8563 for (i
= 0; i
< 2; ++i
)
8564 if (!BUFFERP (echo_buffer
[i
])
8565 || NILP (XBUFFER (echo_buffer
[i
])->name
))
8568 Lisp_Object old_buffer
;
8571 old_buffer
= echo_buffer
[i
];
8572 sprintf (name
, " *Echo Area %d*", i
);
8573 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
8574 XBUFFER (echo_buffer
[i
])->truncate_lines
= Qnil
;
8575 /* to force word wrap in echo area -
8576 it was decided to postpone this*/
8577 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
8579 for (j
= 0; j
< 2; ++j
)
8580 if (EQ (old_buffer
, echo_area_buffer
[j
]))
8581 echo_area_buffer
[j
] = echo_buffer
[i
];
8586 /* Call FN with args A1..A4 with either the current or last displayed
8587 echo_area_buffer as current buffer.
8589 WHICH zero means use the current message buffer
8590 echo_area_buffer[0]. If that is nil, choose a suitable buffer
8591 from echo_buffer[] and clear it.
8593 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
8594 suitable buffer from echo_buffer[] and clear it.
8596 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
8597 that the current message becomes the last displayed one, make
8598 choose a suitable buffer for echo_area_buffer[0], and clear it.
8600 Value is what FN returns. */
8603 with_echo_area_buffer (struct window
*w
, int which
,
8604 int (*fn
) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
8605 EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
8608 int this_one
, the_other
, clear_buffer_p
, rc
;
8609 int count
= SPECPDL_INDEX ();
8611 /* If buffers aren't live, make new ones. */
8612 ensure_echo_area_buffers ();
8617 this_one
= 0, the_other
= 1;
8619 this_one
= 1, the_other
= 0;
8622 this_one
= 0, the_other
= 1;
8625 /* We need a fresh one in case the current echo buffer equals
8626 the one containing the last displayed echo area message. */
8627 if (!NILP (echo_area_buffer
[this_one
])
8628 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
8629 echo_area_buffer
[this_one
] = Qnil
;
8632 /* Choose a suitable buffer from echo_buffer[] is we don't
8634 if (NILP (echo_area_buffer
[this_one
]))
8636 echo_area_buffer
[this_one
]
8637 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
8638 ? echo_buffer
[the_other
]
8639 : echo_buffer
[this_one
]);
8643 buffer
= echo_area_buffer
[this_one
];
8645 /* Don't get confused by reusing the buffer used for echoing
8646 for a different purpose. */
8647 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
8650 record_unwind_protect (unwind_with_echo_area_buffer
,
8651 with_echo_area_buffer_unwind_data (w
));
8653 /* Make the echo area buffer current. Note that for display
8654 purposes, it is not necessary that the displayed window's buffer
8655 == current_buffer, except for text property lookup. So, let's
8656 only set that buffer temporarily here without doing a full
8657 Fset_window_buffer. We must also change w->pointm, though,
8658 because otherwise an assertions in unshow_buffer fails, and Emacs
8660 set_buffer_internal_1 (XBUFFER (buffer
));
8664 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
8667 current_buffer
->undo_list
= Qt
;
8668 current_buffer
->read_only
= Qnil
;
8669 specbind (Qinhibit_read_only
, Qt
);
8670 specbind (Qinhibit_modification_hooks
, Qt
);
8672 if (clear_buffer_p
&& Z
> BEG
)
8675 xassert (BEGV
>= BEG
);
8676 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8678 rc
= fn (a1
, a2
, a3
, a4
);
8680 xassert (BEGV
>= BEG
);
8681 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8683 unbind_to (count
, Qnil
);
8688 /* Save state that should be preserved around the call to the function
8689 FN called in with_echo_area_buffer. */
8692 with_echo_area_buffer_unwind_data (struct window
*w
)
8695 Lisp_Object vector
, tmp
;
8697 /* Reduce consing by keeping one vector in
8698 Vwith_echo_area_save_vector. */
8699 vector
= Vwith_echo_area_save_vector
;
8700 Vwith_echo_area_save_vector
= Qnil
;
8703 vector
= Fmake_vector (make_number (7), Qnil
);
8705 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
8706 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
8707 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
8711 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
8712 ASET (vector
, i
, w
->buffer
); ++i
;
8713 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
8714 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
8719 for (; i
< end
; ++i
)
8720 ASET (vector
, i
, Qnil
);
8723 xassert (i
== ASIZE (vector
));
8728 /* Restore global state from VECTOR which was created by
8729 with_echo_area_buffer_unwind_data. */
8732 unwind_with_echo_area_buffer (Lisp_Object vector
)
8734 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
8735 Vdeactivate_mark
= AREF (vector
, 1);
8736 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
8738 if (WINDOWP (AREF (vector
, 3)))
8741 Lisp_Object buffer
, charpos
, bytepos
;
8743 w
= XWINDOW (AREF (vector
, 3));
8744 buffer
= AREF (vector
, 4);
8745 charpos
= AREF (vector
, 5);
8746 bytepos
= AREF (vector
, 6);
8749 set_marker_both (w
->pointm
, buffer
,
8750 XFASTINT (charpos
), XFASTINT (bytepos
));
8753 Vwith_echo_area_save_vector
= vector
;
8758 /* Set up the echo area for use by print functions. MULTIBYTE_P
8759 non-zero means we will print multibyte. */
8762 setup_echo_area_for_printing (int multibyte_p
)
8764 /* If we can't find an echo area any more, exit. */
8765 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8768 ensure_echo_area_buffers ();
8770 if (!message_buf_print
)
8772 /* A message has been output since the last time we printed.
8773 Choose a fresh echo area buffer. */
8774 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8775 echo_area_buffer
[0] = echo_buffer
[1];
8777 echo_area_buffer
[0] = echo_buffer
[0];
8779 /* Switch to that buffer and clear it. */
8780 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8781 current_buffer
->truncate_lines
= Qnil
;
8785 int count
= SPECPDL_INDEX ();
8786 specbind (Qinhibit_read_only
, Qt
);
8787 /* Note that undo recording is always disabled. */
8789 unbind_to (count
, Qnil
);
8791 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8793 /* Set up the buffer for the multibyteness we need. */
8795 != !NILP (current_buffer
->enable_multibyte_characters
))
8796 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
8798 /* Raise the frame containing the echo area. */
8799 if (minibuffer_auto_raise
)
8801 struct frame
*sf
= SELECTED_FRAME ();
8802 Lisp_Object mini_window
;
8803 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8804 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8807 message_log_maybe_newline ();
8808 message_buf_print
= 1;
8812 if (NILP (echo_area_buffer
[0]))
8814 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8815 echo_area_buffer
[0] = echo_buffer
[1];
8817 echo_area_buffer
[0] = echo_buffer
[0];
8820 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
8822 /* Someone switched buffers between print requests. */
8823 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8824 current_buffer
->truncate_lines
= Qnil
;
8830 /* Display an echo area message in window W. Value is non-zero if W's
8831 height is changed. If display_last_displayed_message_p is
8832 non-zero, display the message that was last displayed, otherwise
8833 display the current message. */
8836 display_echo_area (struct window
*w
)
8838 int i
, no_message_p
, window_height_changed_p
, count
;
8840 /* Temporarily disable garbage collections while displaying the echo
8841 area. This is done because a GC can print a message itself.
8842 That message would modify the echo area buffer's contents while a
8843 redisplay of the buffer is going on, and seriously confuse
8845 count
= inhibit_garbage_collection ();
8847 /* If there is no message, we must call display_echo_area_1
8848 nevertheless because it resizes the window. But we will have to
8849 reset the echo_area_buffer in question to nil at the end because
8850 with_echo_area_buffer will sets it to an empty buffer. */
8851 i
= display_last_displayed_message_p
? 1 : 0;
8852 no_message_p
= NILP (echo_area_buffer
[i
]);
8854 window_height_changed_p
8855 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
8856 display_echo_area_1
,
8857 (EMACS_INT
) w
, Qnil
, 0, 0);
8860 echo_area_buffer
[i
] = Qnil
;
8862 unbind_to (count
, Qnil
);
8863 return window_height_changed_p
;
8867 /* Helper for display_echo_area. Display the current buffer which
8868 contains the current echo area message in window W, a mini-window,
8869 a pointer to which is passed in A1. A2..A4 are currently not used.
8870 Change the height of W so that all of the message is displayed.
8871 Value is non-zero if height of W was changed. */
8874 display_echo_area_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
8876 struct window
*w
= (struct window
*) a1
;
8878 struct text_pos start
;
8879 int window_height_changed_p
= 0;
8881 /* Do this before displaying, so that we have a large enough glyph
8882 matrix for the display. If we can't get enough space for the
8883 whole text, display the last N lines. That works by setting w->start. */
8884 window_height_changed_p
= resize_mini_window (w
, 0);
8886 /* Use the starting position chosen by resize_mini_window. */
8887 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
8890 clear_glyph_matrix (w
->desired_matrix
);
8891 XSETWINDOW (window
, w
);
8892 try_window (window
, start
, 0);
8894 return window_height_changed_p
;
8898 /* Resize the echo area window to exactly the size needed for the
8899 currently displayed message, if there is one. If a mini-buffer
8900 is active, don't shrink it. */
8903 resize_echo_area_exactly (void)
8905 if (BUFFERP (echo_area_buffer
[0])
8906 && WINDOWP (echo_area_window
))
8908 struct window
*w
= XWINDOW (echo_area_window
);
8910 Lisp_Object resize_exactly
;
8912 if (minibuf_level
== 0)
8913 resize_exactly
= Qt
;
8915 resize_exactly
= Qnil
;
8917 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
8918 (EMACS_INT
) w
, resize_exactly
, 0, 0);
8921 ++windows_or_buffers_changed
;
8922 ++update_mode_lines
;
8923 redisplay_internal (0);
8929 /* Callback function for with_echo_area_buffer, when used from
8930 resize_echo_area_exactly. A1 contains a pointer to the window to
8931 resize, EXACTLY non-nil means resize the mini-window exactly to the
8932 size of the text displayed. A3 and A4 are not used. Value is what
8933 resize_mini_window returns. */
8936 resize_mini_window_1 (EMACS_INT a1
, Lisp_Object exactly
, EMACS_INT a3
, EMACS_INT a4
)
8938 return resize_mini_window ((struct window
*) a1
, !NILP (exactly
));
8942 /* Resize mini-window W to fit the size of its contents. EXACT_P
8943 means size the window exactly to the size needed. Otherwise, it's
8944 only enlarged until W's buffer is empty.
8946 Set W->start to the right place to begin display. If the whole
8947 contents fit, start at the beginning. Otherwise, start so as
8948 to make the end of the contents appear. This is particularly
8949 important for y-or-n-p, but seems desirable generally.
8951 Value is non-zero if the window height has been changed. */
8954 resize_mini_window (struct window
*w
, int exact_p
)
8956 struct frame
*f
= XFRAME (w
->frame
);
8957 int window_height_changed_p
= 0;
8959 xassert (MINI_WINDOW_P (w
));
8961 /* By default, start display at the beginning. */
8962 set_marker_both (w
->start
, w
->buffer
,
8963 BUF_BEGV (XBUFFER (w
->buffer
)),
8964 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
8966 /* Don't resize windows while redisplaying a window; it would
8967 confuse redisplay functions when the size of the window they are
8968 displaying changes from under them. Such a resizing can happen,
8969 for instance, when which-func prints a long message while
8970 we are running fontification-functions. We're running these
8971 functions with safe_call which binds inhibit-redisplay to t. */
8972 if (!NILP (Vinhibit_redisplay
))
8975 /* Nil means don't try to resize. */
8976 if (NILP (Vresize_mini_windows
)
8977 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
8980 if (!FRAME_MINIBUF_ONLY_P (f
))
8983 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
8984 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
8985 int height
, max_height
;
8986 int unit
= FRAME_LINE_HEIGHT (f
);
8987 struct text_pos start
;
8988 struct buffer
*old_current_buffer
= NULL
;
8990 if (current_buffer
!= XBUFFER (w
->buffer
))
8992 old_current_buffer
= current_buffer
;
8993 set_buffer_internal (XBUFFER (w
->buffer
));
8996 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8998 /* Compute the max. number of lines specified by the user. */
8999 if (FLOATP (Vmax_mini_window_height
))
9000 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
9001 else if (INTEGERP (Vmax_mini_window_height
))
9002 max_height
= XINT (Vmax_mini_window_height
);
9004 max_height
= total_height
/ 4;
9006 /* Correct that max. height if it's bogus. */
9007 max_height
= max (1, max_height
);
9008 max_height
= min (total_height
, max_height
);
9010 /* Find out the height of the text in the window. */
9011 if (it
.line_wrap
== TRUNCATE
)
9016 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
9017 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
9018 height
= it
.current_y
+ last_height
;
9020 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9021 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
9022 height
= (height
+ unit
- 1) / unit
;
9025 /* Compute a suitable window start. */
9026 if (height
> max_height
)
9028 height
= max_height
;
9029 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
9030 move_it_vertically_backward (&it
, (height
- 1) * unit
);
9031 start
= it
.current
.pos
;
9034 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
9035 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
9037 if (EQ (Vresize_mini_windows
, Qgrow_only
))
9039 /* Let it grow only, until we display an empty message, in which
9040 case the window shrinks again. */
9041 if (height
> WINDOW_TOTAL_LINES (w
))
9043 int old_height
= WINDOW_TOTAL_LINES (w
);
9044 freeze_window_starts (f
, 1);
9045 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9046 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9048 else if (height
< WINDOW_TOTAL_LINES (w
)
9049 && (exact_p
|| BEGV
== ZV
))
9051 int old_height
= WINDOW_TOTAL_LINES (w
);
9052 freeze_window_starts (f
, 0);
9053 shrink_mini_window (w
);
9054 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9059 /* Always resize to exact size needed. */
9060 if (height
> WINDOW_TOTAL_LINES (w
))
9062 int old_height
= WINDOW_TOTAL_LINES (w
);
9063 freeze_window_starts (f
, 1);
9064 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9065 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9067 else if (height
< WINDOW_TOTAL_LINES (w
))
9069 int old_height
= WINDOW_TOTAL_LINES (w
);
9070 freeze_window_starts (f
, 0);
9071 shrink_mini_window (w
);
9075 freeze_window_starts (f
, 1);
9076 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9079 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9083 if (old_current_buffer
)
9084 set_buffer_internal (old_current_buffer
);
9087 return window_height_changed_p
;
9091 /* Value is the current message, a string, or nil if there is no
9095 current_message (void)
9099 if (!BUFFERP (echo_area_buffer
[0]))
9103 with_echo_area_buffer (0, 0, current_message_1
,
9104 (EMACS_INT
) &msg
, Qnil
, 0, 0);
9106 echo_area_buffer
[0] = Qnil
;
9114 current_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9116 Lisp_Object
*msg
= (Lisp_Object
*) a1
;
9119 *msg
= make_buffer_string (BEG
, Z
, 1);
9126 /* Push the current message on Vmessage_stack for later restauration
9127 by restore_message. Value is non-zero if the current message isn't
9128 empty. This is a relatively infrequent operation, so it's not
9129 worth optimizing. */
9135 msg
= current_message ();
9136 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
9137 return STRINGP (msg
);
9141 /* Restore message display from the top of Vmessage_stack. */
9144 restore_message (void)
9148 xassert (CONSP (Vmessage_stack
));
9149 msg
= XCAR (Vmessage_stack
);
9151 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9153 message3_nolog (msg
, 0, 0);
9157 /* Handler for record_unwind_protect calling pop_message. */
9160 pop_message_unwind (Lisp_Object dummy
)
9166 /* Pop the top-most entry off Vmessage_stack. */
9171 xassert (CONSP (Vmessage_stack
));
9172 Vmessage_stack
= XCDR (Vmessage_stack
);
9176 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
9177 exits. If the stack is not empty, we have a missing pop_message
9181 check_message_stack (void)
9183 if (!NILP (Vmessage_stack
))
9188 /* Truncate to NCHARS what will be displayed in the echo area the next
9189 time we display it---but don't redisplay it now. */
9192 truncate_echo_area (int nchars
)
9195 echo_area_buffer
[0] = Qnil
;
9196 /* A null message buffer means that the frame hasn't really been
9197 initialized yet. Error messages get reported properly by
9198 cmd_error, so this must be just an informative message; toss it. */
9199 else if (!noninteractive
9201 && !NILP (echo_area_buffer
[0]))
9203 struct frame
*sf
= SELECTED_FRAME ();
9204 if (FRAME_MESSAGE_BUF (sf
))
9205 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
9210 /* Helper function for truncate_echo_area. Truncate the current
9211 message to at most NCHARS characters. */
9214 truncate_message_1 (EMACS_INT nchars
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9216 if (BEG
+ nchars
< Z
)
9217 del_range (BEG
+ nchars
, Z
);
9219 echo_area_buffer
[0] = Qnil
;
9224 /* Set the current message to a substring of S or STRING.
9226 If STRING is a Lisp string, set the message to the first NBYTES
9227 bytes from STRING. NBYTES zero means use the whole string. If
9228 STRING is multibyte, the message will be displayed multibyte.
9230 If S is not null, set the message to the first LEN bytes of S. LEN
9231 zero means use the whole string. MULTIBYTE_P non-zero means S is
9232 multibyte. Display the message multibyte in that case.
9234 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
9235 to t before calling set_message_1 (which calls insert).
9239 set_message (const char *s
, Lisp_Object string
, int nbytes
, int multibyte_p
)
9241 message_enable_multibyte
9242 = ((s
&& multibyte_p
)
9243 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
9245 with_echo_area_buffer (0, -1, set_message_1
,
9246 (EMACS_INT
) s
, string
, nbytes
, multibyte_p
);
9247 message_buf_print
= 0;
9248 help_echo_showing_p
= 0;
9252 /* Helper function for set_message. Arguments have the same meaning
9253 as there, with A1 corresponding to S and A2 corresponding to STRING
9254 This function is called with the echo area buffer being
9258 set_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT nbytes
, EMACS_INT multibyte_p
)
9260 const char *s
= (const char *) a1
;
9261 Lisp_Object string
= a2
;
9263 /* Change multibyteness of the echo buffer appropriately. */
9264 if (message_enable_multibyte
9265 != !NILP (current_buffer
->enable_multibyte_characters
))
9266 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
9268 current_buffer
->truncate_lines
= message_truncate_lines
? Qt
: Qnil
;
9270 /* Insert new message at BEG. */
9271 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9273 if (STRINGP (string
))
9278 nbytes
= SBYTES (string
);
9279 nchars
= string_byte_to_char (string
, nbytes
);
9281 /* This function takes care of single/multibyte conversion. We
9282 just have to ensure that the echo area buffer has the right
9283 setting of enable_multibyte_characters. */
9284 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
9289 nbytes
= strlen (s
);
9291 if (multibyte_p
&& NILP (current_buffer
->enable_multibyte_characters
))
9293 /* Convert from multi-byte to single-byte. */
9295 unsigned char work
[1];
9297 /* Convert a multibyte string to single-byte. */
9298 for (i
= 0; i
< nbytes
; i
+= n
)
9300 c
= string_char_and_length (s
+ i
, &n
);
9301 work
[0] = (ASCII_CHAR_P (c
)
9303 : multibyte_char_to_unibyte (c
, Qnil
));
9304 insert_1_both (work
, 1, 1, 1, 0, 0);
9307 else if (!multibyte_p
9308 && !NILP (current_buffer
->enable_multibyte_characters
))
9310 /* Convert from single-byte to multi-byte. */
9312 const unsigned char *msg
= (const unsigned char *) s
;
9313 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9315 /* Convert a single-byte string to multibyte. */
9316 for (i
= 0; i
< nbytes
; i
++)
9319 MAKE_CHAR_MULTIBYTE (c
);
9320 n
= CHAR_STRING (c
, str
);
9321 insert_1_both (str
, 1, n
, 1, 0, 0);
9325 insert_1 (s
, nbytes
, 1, 0, 0);
9332 /* Clear messages. CURRENT_P non-zero means clear the current
9333 message. LAST_DISPLAYED_P non-zero means clear the message
9337 clear_message (int current_p
, int last_displayed_p
)
9341 echo_area_buffer
[0] = Qnil
;
9342 message_cleared_p
= 1;
9345 if (last_displayed_p
)
9346 echo_area_buffer
[1] = Qnil
;
9348 message_buf_print
= 0;
9351 /* Clear garbaged frames.
9353 This function is used where the old redisplay called
9354 redraw_garbaged_frames which in turn called redraw_frame which in
9355 turn called clear_frame. The call to clear_frame was a source of
9356 flickering. I believe a clear_frame is not necessary. It should
9357 suffice in the new redisplay to invalidate all current matrices,
9358 and ensure a complete redisplay of all windows. */
9361 clear_garbaged_frames (void)
9365 Lisp_Object tail
, frame
;
9366 int changed_count
= 0;
9368 FOR_EACH_FRAME (tail
, frame
)
9370 struct frame
*f
= XFRAME (frame
);
9372 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
9376 Fredraw_frame (frame
);
9377 f
->force_flush_display_p
= 1;
9379 clear_current_matrices (f
);
9388 ++windows_or_buffers_changed
;
9393 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
9394 is non-zero update selected_frame. Value is non-zero if the
9395 mini-windows height has been changed. */
9398 echo_area_display (int update_frame_p
)
9400 Lisp_Object mini_window
;
9403 int window_height_changed_p
= 0;
9404 struct frame
*sf
= SELECTED_FRAME ();
9406 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9407 w
= XWINDOW (mini_window
);
9408 f
= XFRAME (WINDOW_FRAME (w
));
9410 /* Don't display if frame is invisible or not yet initialized. */
9411 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
9414 #ifdef HAVE_WINDOW_SYSTEM
9415 /* When Emacs starts, selected_frame may be the initial terminal
9416 frame. If we let this through, a message would be displayed on
9418 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
9420 #endif /* HAVE_WINDOW_SYSTEM */
9422 /* Redraw garbaged frames. */
9424 clear_garbaged_frames ();
9426 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
9428 echo_area_window
= mini_window
;
9429 window_height_changed_p
= display_echo_area (w
);
9430 w
->must_be_updated_p
= 1;
9432 /* Update the display, unless called from redisplay_internal.
9433 Also don't update the screen during redisplay itself. The
9434 update will happen at the end of redisplay, and an update
9435 here could cause confusion. */
9436 if (update_frame_p
&& !redisplaying_p
)
9440 /* If the display update has been interrupted by pending
9441 input, update mode lines in the frame. Due to the
9442 pending input, it might have been that redisplay hasn't
9443 been called, so that mode lines above the echo area are
9444 garbaged. This looks odd, so we prevent it here. */
9445 if (!display_completed
)
9446 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
9448 if (window_height_changed_p
9449 /* Don't do this if Emacs is shutting down. Redisplay
9450 needs to run hooks. */
9451 && !NILP (Vrun_hooks
))
9453 /* Must update other windows. Likewise as in other
9454 cases, don't let this update be interrupted by
9456 int count
= SPECPDL_INDEX ();
9457 specbind (Qredisplay_dont_pause
, Qt
);
9458 windows_or_buffers_changed
= 1;
9459 redisplay_internal (0);
9460 unbind_to (count
, Qnil
);
9462 else if (FRAME_WINDOW_P (f
) && n
== 0)
9464 /* Window configuration is the same as before.
9465 Can do with a display update of the echo area,
9466 unless we displayed some mode lines. */
9467 update_single_window (w
, 1);
9468 FRAME_RIF (f
)->flush_display (f
);
9471 update_frame (f
, 1, 1);
9473 /* If cursor is in the echo area, make sure that the next
9474 redisplay displays the minibuffer, so that the cursor will
9475 be replaced with what the minibuffer wants. */
9476 if (cursor_in_echo_area
)
9477 ++windows_or_buffers_changed
;
9480 else if (!EQ (mini_window
, selected_window
))
9481 windows_or_buffers_changed
++;
9483 /* Last displayed message is now the current message. */
9484 echo_area_buffer
[1] = echo_area_buffer
[0];
9485 /* Inform read_char that we're not echoing. */
9486 echo_message_buffer
= Qnil
;
9488 /* Prevent redisplay optimization in redisplay_internal by resetting
9489 this_line_start_pos. This is done because the mini-buffer now
9490 displays the message instead of its buffer text. */
9491 if (EQ (mini_window
, selected_window
))
9492 CHARPOS (this_line_start_pos
) = 0;
9494 return window_height_changed_p
;
9499 /***********************************************************************
9500 Mode Lines and Frame Titles
9501 ***********************************************************************/
9503 /* A buffer for constructing non-propertized mode-line strings and
9504 frame titles in it; allocated from the heap in init_xdisp and
9505 resized as needed in store_mode_line_noprop_char. */
9507 static char *mode_line_noprop_buf
;
9509 /* The buffer's end, and a current output position in it. */
9511 static char *mode_line_noprop_buf_end
;
9512 static char *mode_line_noprop_ptr
;
9514 #define MODE_LINE_NOPROP_LEN(start) \
9515 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
9518 MODE_LINE_DISPLAY
= 0,
9524 /* Alist that caches the results of :propertize.
9525 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
9526 static Lisp_Object mode_line_proptrans_alist
;
9528 /* List of strings making up the mode-line. */
9529 static Lisp_Object mode_line_string_list
;
9531 /* Base face property when building propertized mode line string. */
9532 static Lisp_Object mode_line_string_face
;
9533 static Lisp_Object mode_line_string_face_prop
;
9536 /* Unwind data for mode line strings */
9538 static Lisp_Object Vmode_line_unwind_vector
;
9541 format_mode_line_unwind_data (struct buffer
*obuf
,
9545 Lisp_Object vector
, tmp
;
9547 /* Reduce consing by keeping one vector in
9548 Vwith_echo_area_save_vector. */
9549 vector
= Vmode_line_unwind_vector
;
9550 Vmode_line_unwind_vector
= Qnil
;
9553 vector
= Fmake_vector (make_number (8), Qnil
);
9555 ASET (vector
, 0, make_number (mode_line_target
));
9556 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
9557 ASET (vector
, 2, mode_line_string_list
);
9558 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
9559 ASET (vector
, 4, mode_line_string_face
);
9560 ASET (vector
, 5, mode_line_string_face_prop
);
9563 XSETBUFFER (tmp
, obuf
);
9566 ASET (vector
, 6, tmp
);
9567 ASET (vector
, 7, owin
);
9573 unwind_format_mode_line (Lisp_Object vector
)
9575 mode_line_target
= XINT (AREF (vector
, 0));
9576 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
9577 mode_line_string_list
= AREF (vector
, 2);
9578 if (! EQ (AREF (vector
, 3), Qt
))
9579 mode_line_proptrans_alist
= AREF (vector
, 3);
9580 mode_line_string_face
= AREF (vector
, 4);
9581 mode_line_string_face_prop
= AREF (vector
, 5);
9583 if (!NILP (AREF (vector
, 7)))
9584 /* Select window before buffer, since it may change the buffer. */
9585 Fselect_window (AREF (vector
, 7), Qt
);
9587 if (!NILP (AREF (vector
, 6)))
9589 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
9590 ASET (vector
, 6, Qnil
);
9593 Vmode_line_unwind_vector
= vector
;
9598 /* Store a single character C for the frame title in mode_line_noprop_buf.
9599 Re-allocate mode_line_noprop_buf if necessary. */
9602 store_mode_line_noprop_char (char c
)
9604 /* If output position has reached the end of the allocated buffer,
9605 double the buffer's size. */
9606 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
9608 int len
= MODE_LINE_NOPROP_LEN (0);
9609 int new_size
= 2 * len
* sizeof *mode_line_noprop_buf
;
9610 mode_line_noprop_buf
= (char *) xrealloc (mode_line_noprop_buf
, new_size
);
9611 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ new_size
;
9612 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
9615 *mode_line_noprop_ptr
++ = c
;
9619 /* Store part of a frame title in mode_line_noprop_buf, beginning at
9620 mode_line_noprop_ptr. STR is the string to store. Do not copy
9621 characters that yield more columns than PRECISION; PRECISION <= 0
9622 means copy the whole string. Pad with spaces until FIELD_WIDTH
9623 number of characters have been copied; FIELD_WIDTH <= 0 means don't
9624 pad. Called from display_mode_element when it is used to build a
9628 store_mode_line_noprop (const unsigned char *str
, int field_width
, int precision
)
9633 /* Copy at most PRECISION chars from STR. */
9634 nbytes
= strlen (str
);
9635 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
9637 store_mode_line_noprop_char (*str
++);
9639 /* Fill up with spaces until FIELD_WIDTH reached. */
9640 while (field_width
> 0
9643 store_mode_line_noprop_char (' ');
9650 /***********************************************************************
9652 ***********************************************************************/
9654 #ifdef HAVE_WINDOW_SYSTEM
9656 /* Set the title of FRAME, if it has changed. The title format is
9657 Vicon_title_format if FRAME is iconified, otherwise it is
9658 frame_title_format. */
9661 x_consider_frame_title (Lisp_Object frame
)
9663 struct frame
*f
= XFRAME (frame
);
9665 if (FRAME_WINDOW_P (f
)
9666 || FRAME_MINIBUF_ONLY_P (f
)
9667 || f
->explicit_name
)
9669 /* Do we have more than one visible frame on this X display? */
9676 int count
= SPECPDL_INDEX ();
9678 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
9680 Lisp_Object other_frame
= XCAR (tail
);
9681 struct frame
*tf
= XFRAME (other_frame
);
9684 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
9685 && !FRAME_MINIBUF_ONLY_P (tf
)
9686 && !EQ (other_frame
, tip_frame
)
9687 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
9691 /* Set global variable indicating that multiple frames exist. */
9692 multiple_frames
= CONSP (tail
);
9694 /* Switch to the buffer of selected window of the frame. Set up
9695 mode_line_target so that display_mode_element will output into
9696 mode_line_noprop_buf; then display the title. */
9697 record_unwind_protect (unwind_format_mode_line
,
9698 format_mode_line_unwind_data
9699 (current_buffer
, selected_window
, 0));
9701 Fselect_window (f
->selected_window
, Qt
);
9702 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
9703 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
9705 mode_line_target
= MODE_LINE_TITLE
;
9706 title_start
= MODE_LINE_NOPROP_LEN (0);
9707 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
9708 NULL
, DEFAULT_FACE_ID
);
9709 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
9710 len
= MODE_LINE_NOPROP_LEN (title_start
);
9711 title
= mode_line_noprop_buf
+ title_start
;
9712 unbind_to (count
, Qnil
);
9714 /* Set the title only if it's changed. This avoids consing in
9715 the common case where it hasn't. (If it turns out that we've
9716 already wasted too much time by walking through the list with
9717 display_mode_element, then we might need to optimize at a
9718 higher level than this.) */
9719 if (! STRINGP (f
->name
)
9720 || SBYTES (f
->name
) != len
9721 || memcmp (title
, SDATA (f
->name
), len
) != 0)
9722 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
9726 #endif /* not HAVE_WINDOW_SYSTEM */
9731 /***********************************************************************
9733 ***********************************************************************/
9736 /* Prepare for redisplay by updating menu-bar item lists when
9737 appropriate. This can call eval. */
9740 prepare_menu_bars (void)
9743 struct gcpro gcpro1
, gcpro2
;
9745 Lisp_Object tooltip_frame
;
9747 #ifdef HAVE_WINDOW_SYSTEM
9748 tooltip_frame
= tip_frame
;
9750 tooltip_frame
= Qnil
;
9753 /* Update all frame titles based on their buffer names, etc. We do
9754 this before the menu bars so that the buffer-menu will show the
9755 up-to-date frame titles. */
9756 #ifdef HAVE_WINDOW_SYSTEM
9757 if (windows_or_buffers_changed
|| update_mode_lines
)
9759 Lisp_Object tail
, frame
;
9761 FOR_EACH_FRAME (tail
, frame
)
9764 if (!EQ (frame
, tooltip_frame
)
9765 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
9766 x_consider_frame_title (frame
);
9769 #endif /* HAVE_WINDOW_SYSTEM */
9771 /* Update the menu bar item lists, if appropriate. This has to be
9772 done before any actual redisplay or generation of display lines. */
9773 all_windows
= (update_mode_lines
9774 || buffer_shared
> 1
9775 || windows_or_buffers_changed
);
9778 Lisp_Object tail
, frame
;
9779 int count
= SPECPDL_INDEX ();
9780 /* 1 means that update_menu_bar has run its hooks
9781 so any further calls to update_menu_bar shouldn't do so again. */
9782 int menu_bar_hooks_run
= 0;
9784 record_unwind_save_match_data ();
9786 FOR_EACH_FRAME (tail
, frame
)
9790 /* Ignore tooltip frame. */
9791 if (EQ (frame
, tooltip_frame
))
9794 /* If a window on this frame changed size, report that to
9795 the user and clear the size-change flag. */
9796 if (FRAME_WINDOW_SIZES_CHANGED (f
))
9798 Lisp_Object functions
;
9800 /* Clear flag first in case we get an error below. */
9801 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
9802 functions
= Vwindow_size_change_functions
;
9803 GCPRO2 (tail
, functions
);
9805 while (CONSP (functions
))
9807 if (!EQ (XCAR (functions
), Qt
))
9808 call1 (XCAR (functions
), frame
);
9809 functions
= XCDR (functions
);
9815 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
9816 #ifdef HAVE_WINDOW_SYSTEM
9817 update_tool_bar (f
, 0);
9820 if (windows_or_buffers_changed
9822 ns_set_doc_edited (f
, Fbuffer_modified_p
9823 (XWINDOW (f
->selected_window
)->buffer
));
9828 unbind_to (count
, Qnil
);
9832 struct frame
*sf
= SELECTED_FRAME ();
9833 update_menu_bar (sf
, 1, 0);
9834 #ifdef HAVE_WINDOW_SYSTEM
9835 update_tool_bar (sf
, 1);
9841 /* Update the menu bar item list for frame F. This has to be done
9842 before we start to fill in any display lines, because it can call
9845 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
9847 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
9848 already ran the menu bar hooks for this redisplay, so there
9849 is no need to run them again. The return value is the
9850 updated value of this flag, to pass to the next call. */
9853 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
9856 register struct window
*w
;
9858 /* If called recursively during a menu update, do nothing. This can
9859 happen when, for instance, an activate-menubar-hook causes a
9861 if (inhibit_menubar_update
)
9864 window
= FRAME_SELECTED_WINDOW (f
);
9865 w
= XWINDOW (window
);
9867 if (FRAME_WINDOW_P (f
)
9869 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9870 || defined (HAVE_NS) || defined (USE_GTK)
9871 FRAME_EXTERNAL_MENU_BAR (f
)
9873 FRAME_MENU_BAR_LINES (f
) > 0
9875 : FRAME_MENU_BAR_LINES (f
) > 0)
9877 /* If the user has switched buffers or windows, we need to
9878 recompute to reflect the new bindings. But we'll
9879 recompute when update_mode_lines is set too; that means
9880 that people can use force-mode-line-update to request
9881 that the menu bar be recomputed. The adverse effect on
9882 the rest of the redisplay algorithm is about the same as
9883 windows_or_buffers_changed anyway. */
9884 if (windows_or_buffers_changed
9885 /* This used to test w->update_mode_line, but we believe
9886 there is no need to recompute the menu in that case. */
9887 || update_mode_lines
9888 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9889 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9890 != !NILP (w
->last_had_star
))
9891 || ((!NILP (Vtransient_mark_mode
)
9892 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
9893 != !NILP (w
->region_showing
)))
9895 struct buffer
*prev
= current_buffer
;
9896 int count
= SPECPDL_INDEX ();
9898 specbind (Qinhibit_menubar_update
, Qt
);
9900 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9901 if (save_match_data
)
9902 record_unwind_save_match_data ();
9903 if (NILP (Voverriding_local_map_menu_flag
))
9905 specbind (Qoverriding_terminal_local_map
, Qnil
);
9906 specbind (Qoverriding_local_map
, Qnil
);
9911 /* Run the Lucid hook. */
9912 safe_run_hooks (Qactivate_menubar_hook
);
9914 /* If it has changed current-menubar from previous value,
9915 really recompute the menu-bar from the value. */
9916 if (! NILP (Vlucid_menu_bar_dirty_flag
))
9917 call0 (Qrecompute_lucid_menubar
);
9919 safe_run_hooks (Qmenu_bar_update_hook
);
9924 XSETFRAME (Vmenu_updating_frame
, f
);
9925 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
9927 /* Redisplay the menu bar in case we changed it. */
9928 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9929 || defined (HAVE_NS) || defined (USE_GTK)
9930 if (FRAME_WINDOW_P (f
))
9932 #if defined (HAVE_NS)
9933 /* All frames on Mac OS share the same menubar. So only
9934 the selected frame should be allowed to set it. */
9935 if (f
== SELECTED_FRAME ())
9937 set_frame_menubar (f
, 0, 0);
9940 /* On a terminal screen, the menu bar is an ordinary screen
9941 line, and this makes it get updated. */
9942 w
->update_mode_line
= Qt
;
9943 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9944 /* In the non-toolkit version, the menu bar is an ordinary screen
9945 line, and this makes it get updated. */
9946 w
->update_mode_line
= Qt
;
9947 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9949 unbind_to (count
, Qnil
);
9950 set_buffer_internal_1 (prev
);
9959 /***********************************************************************
9961 ***********************************************************************/
9963 #ifdef HAVE_WINDOW_SYSTEM
9966 Nominal cursor position -- where to draw output.
9967 HPOS and VPOS are window relative glyph matrix coordinates.
9968 X and Y are window relative pixel coordinates. */
9970 struct cursor_pos output_cursor
;
9974 Set the global variable output_cursor to CURSOR. All cursor
9975 positions are relative to updated_window. */
9978 set_output_cursor (struct cursor_pos
*cursor
)
9980 output_cursor
.hpos
= cursor
->hpos
;
9981 output_cursor
.vpos
= cursor
->vpos
;
9982 output_cursor
.x
= cursor
->x
;
9983 output_cursor
.y
= cursor
->y
;
9988 Set a nominal cursor position.
9990 HPOS and VPOS are column/row positions in a window glyph matrix. X
9991 and Y are window text area relative pixel positions.
9993 If this is done during an update, updated_window will contain the
9994 window that is being updated and the position is the future output
9995 cursor position for that window. If updated_window is null, use
9996 selected_window and display the cursor at the given position. */
9999 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
10003 /* If updated_window is not set, work on selected_window. */
10004 if (updated_window
)
10005 w
= updated_window
;
10007 w
= XWINDOW (selected_window
);
10009 /* Set the output cursor. */
10010 output_cursor
.hpos
= hpos
;
10011 output_cursor
.vpos
= vpos
;
10012 output_cursor
.x
= x
;
10013 output_cursor
.y
= y
;
10015 /* If not called as part of an update, really display the cursor.
10016 This will also set the cursor position of W. */
10017 if (updated_window
== NULL
)
10020 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
10021 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
10022 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
10027 #endif /* HAVE_WINDOW_SYSTEM */
10030 /***********************************************************************
10032 ***********************************************************************/
10034 #ifdef HAVE_WINDOW_SYSTEM
10036 /* Where the mouse was last time we reported a mouse event. */
10038 FRAME_PTR last_mouse_frame
;
10040 /* Tool-bar item index of the item on which a mouse button was pressed
10043 int last_tool_bar_item
;
10047 update_tool_bar_unwind (Lisp_Object frame
)
10049 selected_frame
= frame
;
10053 /* Update the tool-bar item list for frame F. This has to be done
10054 before we start to fill in any display lines. Called from
10055 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
10056 and restore it here. */
10059 update_tool_bar (struct frame
*f
, int save_match_data
)
10061 #if defined (USE_GTK) || defined (HAVE_NS)
10062 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
10064 int do_update
= WINDOWP (f
->tool_bar_window
)
10065 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
10070 Lisp_Object window
;
10073 window
= FRAME_SELECTED_WINDOW (f
);
10074 w
= XWINDOW (window
);
10076 /* If the user has switched buffers or windows, we need to
10077 recompute to reflect the new bindings. But we'll
10078 recompute when update_mode_lines is set too; that means
10079 that people can use force-mode-line-update to request
10080 that the menu bar be recomputed. The adverse effect on
10081 the rest of the redisplay algorithm is about the same as
10082 windows_or_buffers_changed anyway. */
10083 if (windows_or_buffers_changed
10084 || !NILP (w
->update_mode_line
)
10085 || update_mode_lines
10086 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10087 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10088 != !NILP (w
->last_had_star
))
10089 || ((!NILP (Vtransient_mark_mode
)
10090 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
10091 != !NILP (w
->region_showing
)))
10093 struct buffer
*prev
= current_buffer
;
10094 int count
= SPECPDL_INDEX ();
10095 Lisp_Object frame
, new_tool_bar
;
10096 int new_n_tool_bar
;
10097 struct gcpro gcpro1
;
10099 /* Set current_buffer to the buffer of the selected
10100 window of the frame, so that we get the right local
10102 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10104 /* Save match data, if we must. */
10105 if (save_match_data
)
10106 record_unwind_save_match_data ();
10108 /* Make sure that we don't accidentally use bogus keymaps. */
10109 if (NILP (Voverriding_local_map_menu_flag
))
10111 specbind (Qoverriding_terminal_local_map
, Qnil
);
10112 specbind (Qoverriding_local_map
, Qnil
);
10115 GCPRO1 (new_tool_bar
);
10117 /* We must temporarily set the selected frame to this frame
10118 before calling tool_bar_items, because the calculation of
10119 the tool-bar keymap uses the selected frame (see
10120 `tool-bar-make-keymap' in tool-bar.el). */
10121 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
10122 XSETFRAME (frame
, f
);
10123 selected_frame
= frame
;
10125 /* Build desired tool-bar items from keymaps. */
10126 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
10129 /* Redisplay the tool-bar if we changed it. */
10130 if (new_n_tool_bar
!= f
->n_tool_bar_items
10131 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
10133 /* Redisplay that happens asynchronously due to an expose event
10134 may access f->tool_bar_items. Make sure we update both
10135 variables within BLOCK_INPUT so no such event interrupts. */
10137 f
->tool_bar_items
= new_tool_bar
;
10138 f
->n_tool_bar_items
= new_n_tool_bar
;
10139 w
->update_mode_line
= Qt
;
10145 unbind_to (count
, Qnil
);
10146 set_buffer_internal_1 (prev
);
10152 /* Set F->desired_tool_bar_string to a Lisp string representing frame
10153 F's desired tool-bar contents. F->tool_bar_items must have
10154 been set up previously by calling prepare_menu_bars. */
10157 build_desired_tool_bar_string (struct frame
*f
)
10159 int i
, size
, size_needed
;
10160 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10161 Lisp_Object image
, plist
, props
;
10163 image
= plist
= props
= Qnil
;
10164 GCPRO3 (image
, plist
, props
);
10166 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
10167 Otherwise, make a new string. */
10169 /* The size of the string we might be able to reuse. */
10170 size
= (STRINGP (f
->desired_tool_bar_string
)
10171 ? SCHARS (f
->desired_tool_bar_string
)
10174 /* We need one space in the string for each image. */
10175 size_needed
= f
->n_tool_bar_items
;
10177 /* Reuse f->desired_tool_bar_string, if possible. */
10178 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
10179 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
10180 make_number (' '));
10183 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
10184 Fremove_text_properties (make_number (0), make_number (size
),
10185 props
, f
->desired_tool_bar_string
);
10188 /* Put a `display' property on the string for the images to display,
10189 put a `menu_item' property on tool-bar items with a value that
10190 is the index of the item in F's tool-bar item vector. */
10191 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
10193 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
10195 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
10196 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
10197 int hmargin
, vmargin
, relief
, idx
, end
;
10199 /* If image is a vector, choose the image according to the
10201 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
10202 if (VECTORP (image
))
10206 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
10207 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
10210 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
10211 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
10213 xassert (ASIZE (image
) >= idx
);
10214 image
= AREF (image
, idx
);
10219 /* Ignore invalid image specifications. */
10220 if (!valid_image_p (image
))
10223 /* Display the tool-bar button pressed, or depressed. */
10224 plist
= Fcopy_sequence (XCDR (image
));
10226 /* Compute margin and relief to draw. */
10227 relief
= (tool_bar_button_relief
>= 0
10228 ? tool_bar_button_relief
10229 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
10230 hmargin
= vmargin
= relief
;
10232 if (INTEGERP (Vtool_bar_button_margin
)
10233 && XINT (Vtool_bar_button_margin
) > 0)
10235 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
10236 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
10238 else if (CONSP (Vtool_bar_button_margin
))
10240 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
10241 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
10242 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
10244 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
10245 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
10246 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
10249 if (auto_raise_tool_bar_buttons_p
)
10251 /* Add a `:relief' property to the image spec if the item is
10255 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
10262 /* If image is selected, display it pressed, i.e. with a
10263 negative relief. If it's not selected, display it with a
10265 plist
= Fplist_put (plist
, QCrelief
,
10267 ? make_number (-relief
)
10268 : make_number (relief
)));
10273 /* Put a margin around the image. */
10274 if (hmargin
|| vmargin
)
10276 if (hmargin
== vmargin
)
10277 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
10279 plist
= Fplist_put (plist
, QCmargin
,
10280 Fcons (make_number (hmargin
),
10281 make_number (vmargin
)));
10284 /* If button is not enabled, and we don't have special images
10285 for the disabled state, make the image appear disabled by
10286 applying an appropriate algorithm to it. */
10287 if (!enabled_p
&& idx
< 0)
10288 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
10290 /* Put a `display' text property on the string for the image to
10291 display. Put a `menu-item' property on the string that gives
10292 the start of this item's properties in the tool-bar items
10294 image
= Fcons (Qimage
, plist
);
10295 props
= list4 (Qdisplay
, image
,
10296 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
10298 /* Let the last image hide all remaining spaces in the tool bar
10299 string. The string can be longer than needed when we reuse a
10300 previous string. */
10301 if (i
+ 1 == f
->n_tool_bar_items
)
10302 end
= SCHARS (f
->desired_tool_bar_string
);
10305 Fadd_text_properties (make_number (i
), make_number (end
),
10306 props
, f
->desired_tool_bar_string
);
10314 /* Display one line of the tool-bar of frame IT->f.
10316 HEIGHT specifies the desired height of the tool-bar line.
10317 If the actual height of the glyph row is less than HEIGHT, the
10318 row's height is increased to HEIGHT, and the icons are centered
10319 vertically in the new height.
10321 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
10322 count a final empty row in case the tool-bar width exactly matches
10327 display_tool_bar_line (struct it
*it
, int height
)
10329 struct glyph_row
*row
= it
->glyph_row
;
10330 int max_x
= it
->last_visible_x
;
10331 struct glyph
*last
;
10333 prepare_desired_row (row
);
10334 row
->y
= it
->current_y
;
10336 /* Note that this isn't made use of if the face hasn't a box,
10337 so there's no need to check the face here. */
10338 it
->start_of_box_run_p
= 1;
10340 while (it
->current_x
< max_x
)
10342 int x
, n_glyphs_before
, i
, nglyphs
;
10343 struct it it_before
;
10345 /* Get the next display element. */
10346 if (!get_next_display_element (it
))
10348 /* Don't count empty row if we are counting needed tool-bar lines. */
10349 if (height
< 0 && !it
->hpos
)
10354 /* Produce glyphs. */
10355 n_glyphs_before
= row
->used
[TEXT_AREA
];
10358 PRODUCE_GLYPHS (it
);
10360 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
10362 x
= it_before
.current_x
;
10363 while (i
< nglyphs
)
10365 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
10367 if (x
+ glyph
->pixel_width
> max_x
)
10369 /* Glyph doesn't fit on line. Backtrack. */
10370 row
->used
[TEXT_AREA
] = n_glyphs_before
;
10372 /* If this is the only glyph on this line, it will never fit on the
10373 toolbar, so skip it. But ensure there is at least one glyph,
10374 so we don't accidentally disable the tool-bar. */
10375 if (n_glyphs_before
== 0
10376 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
10382 x
+= glyph
->pixel_width
;
10386 /* Stop at line ends. */
10387 if (ITERATOR_AT_END_OF_LINE_P (it
))
10390 set_iterator_to_next (it
, 1);
10395 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
10397 /* Use default face for the border below the tool bar.
10399 FIXME: When auto-resize-tool-bars is grow-only, there is
10400 no additional border below the possibly empty tool-bar lines.
10401 So to make the extra empty lines look "normal", we have to
10402 use the tool-bar face for the border too. */
10403 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
10404 it
->face_id
= DEFAULT_FACE_ID
;
10406 extend_face_to_end_of_line (it
);
10407 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
10408 last
->right_box_line_p
= 1;
10409 if (last
== row
->glyphs
[TEXT_AREA
])
10410 last
->left_box_line_p
= 1;
10412 /* Make line the desired height and center it vertically. */
10413 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
10415 /* Don't add more than one line height. */
10416 height
%= FRAME_LINE_HEIGHT (it
->f
);
10417 it
->max_ascent
+= height
/ 2;
10418 it
->max_descent
+= (height
+ 1) / 2;
10421 compute_line_metrics (it
);
10423 /* If line is empty, make it occupy the rest of the tool-bar. */
10424 if (!row
->displays_text_p
)
10426 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
10427 row
->visible_height
= row
->height
;
10428 row
->ascent
= row
->phys_ascent
= 0;
10429 row
->extra_line_spacing
= 0;
10432 row
->full_width_p
= 1;
10433 row
->continued_p
= 0;
10434 row
->truncated_on_left_p
= 0;
10435 row
->truncated_on_right_p
= 0;
10437 it
->current_x
= it
->hpos
= 0;
10438 it
->current_y
+= row
->height
;
10444 /* Max tool-bar height. */
10446 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
10447 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
10449 /* Value is the number of screen lines needed to make all tool-bar
10450 items of frame F visible. The number of actual rows needed is
10451 returned in *N_ROWS if non-NULL. */
10454 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
10456 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10458 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
10459 the desired matrix, so use (unused) mode-line row as temporary row to
10460 avoid destroying the first tool-bar row. */
10461 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
10463 /* Initialize an iterator for iteration over
10464 F->desired_tool_bar_string in the tool-bar window of frame F. */
10465 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
10466 it
.first_visible_x
= 0;
10467 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10468 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10470 while (!ITERATOR_AT_END_P (&it
))
10472 clear_glyph_row (temp_row
);
10473 it
.glyph_row
= temp_row
;
10474 display_tool_bar_line (&it
, -1);
10476 clear_glyph_row (temp_row
);
10478 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
10480 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
10482 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
10486 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
10488 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
10489 (Lisp_Object frame
)
10496 frame
= selected_frame
;
10498 CHECK_FRAME (frame
);
10499 f
= XFRAME (frame
);
10501 if (WINDOWP (f
->tool_bar_window
)
10502 || (w
= XWINDOW (f
->tool_bar_window
),
10503 WINDOW_TOTAL_LINES (w
) > 0))
10505 update_tool_bar (f
, 1);
10506 if (f
->n_tool_bar_items
)
10508 build_desired_tool_bar_string (f
);
10509 nlines
= tool_bar_lines_needed (f
, NULL
);
10513 return make_number (nlines
);
10517 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
10518 height should be changed. */
10521 redisplay_tool_bar (struct frame
*f
)
10525 struct glyph_row
*row
;
10527 #if defined (USE_GTK) || defined (HAVE_NS)
10528 if (FRAME_EXTERNAL_TOOL_BAR (f
))
10529 update_frame_tool_bar (f
);
10533 /* If frame hasn't a tool-bar window or if it is zero-height, don't
10534 do anything. This means you must start with tool-bar-lines
10535 non-zero to get the auto-sizing effect. Or in other words, you
10536 can turn off tool-bars by specifying tool-bar-lines zero. */
10537 if (!WINDOWP (f
->tool_bar_window
)
10538 || (w
= XWINDOW (f
->tool_bar_window
),
10539 WINDOW_TOTAL_LINES (w
) == 0))
10542 /* Set up an iterator for the tool-bar window. */
10543 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
10544 it
.first_visible_x
= 0;
10545 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10546 row
= it
.glyph_row
;
10548 /* Build a string that represents the contents of the tool-bar. */
10549 build_desired_tool_bar_string (f
);
10550 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10552 if (f
->n_tool_bar_rows
== 0)
10556 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
10557 nlines
!= WINDOW_TOTAL_LINES (w
)))
10560 int old_height
= WINDOW_TOTAL_LINES (w
);
10562 XSETFRAME (frame
, f
);
10563 Fmodify_frame_parameters (frame
,
10564 Fcons (Fcons (Qtool_bar_lines
,
10565 make_number (nlines
)),
10567 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10569 clear_glyph_matrix (w
->desired_matrix
);
10570 fonts_changed_p
= 1;
10576 /* Display as many lines as needed to display all tool-bar items. */
10578 if (f
->n_tool_bar_rows
> 0)
10580 int border
, rows
, height
, extra
;
10582 if (INTEGERP (Vtool_bar_border
))
10583 border
= XINT (Vtool_bar_border
);
10584 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
10585 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
10586 else if (EQ (Vtool_bar_border
, Qborder_width
))
10587 border
= f
->border_width
;
10593 rows
= f
->n_tool_bar_rows
;
10594 height
= max (1, (it
.last_visible_y
- border
) / rows
);
10595 extra
= it
.last_visible_y
- border
- height
* rows
;
10597 while (it
.current_y
< it
.last_visible_y
)
10600 if (extra
> 0 && rows
-- > 0)
10602 h
= (extra
+ rows
- 1) / rows
;
10605 display_tool_bar_line (&it
, height
+ h
);
10610 while (it
.current_y
< it
.last_visible_y
)
10611 display_tool_bar_line (&it
, 0);
10614 /* It doesn't make much sense to try scrolling in the tool-bar
10615 window, so don't do it. */
10616 w
->desired_matrix
->no_scrolling_p
= 1;
10617 w
->must_be_updated_p
= 1;
10619 if (!NILP (Vauto_resize_tool_bars
))
10621 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
10622 int change_height_p
= 0;
10624 /* If we couldn't display everything, change the tool-bar's
10625 height if there is room for more. */
10626 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
10627 && it
.current_y
< max_tool_bar_height
)
10628 change_height_p
= 1;
10630 row
= it
.glyph_row
- 1;
10632 /* If there are blank lines at the end, except for a partially
10633 visible blank line at the end that is smaller than
10634 FRAME_LINE_HEIGHT, change the tool-bar's height. */
10635 if (!row
->displays_text_p
10636 && row
->height
>= FRAME_LINE_HEIGHT (f
))
10637 change_height_p
= 1;
10639 /* If row displays tool-bar items, but is partially visible,
10640 change the tool-bar's height. */
10641 if (row
->displays_text_p
10642 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
10643 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
10644 change_height_p
= 1;
10646 /* Resize windows as needed by changing the `tool-bar-lines'
10647 frame parameter. */
10648 if (change_height_p
)
10651 int old_height
= WINDOW_TOTAL_LINES (w
);
10653 int nlines
= tool_bar_lines_needed (f
, &nrows
);
10655 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
10656 && !f
->minimize_tool_bar_window_p
)
10657 ? (nlines
> old_height
)
10658 : (nlines
!= old_height
));
10659 f
->minimize_tool_bar_window_p
= 0;
10661 if (change_height_p
)
10663 XSETFRAME (frame
, f
);
10664 Fmodify_frame_parameters (frame
,
10665 Fcons (Fcons (Qtool_bar_lines
,
10666 make_number (nlines
)),
10668 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10670 clear_glyph_matrix (w
->desired_matrix
);
10671 f
->n_tool_bar_rows
= nrows
;
10672 fonts_changed_p
= 1;
10679 f
->minimize_tool_bar_window_p
= 0;
10684 /* Get information about the tool-bar item which is displayed in GLYPH
10685 on frame F. Return in *PROP_IDX the index where tool-bar item
10686 properties start in F->tool_bar_items. Value is zero if
10687 GLYPH doesn't display a tool-bar item. */
10690 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
10696 /* This function can be called asynchronously, which means we must
10697 exclude any possibility that Fget_text_property signals an
10699 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
10700 charpos
= max (0, charpos
);
10702 /* Get the text property `menu-item' at pos. The value of that
10703 property is the start index of this item's properties in
10704 F->tool_bar_items. */
10705 prop
= Fget_text_property (make_number (charpos
),
10706 Qmenu_item
, f
->current_tool_bar_string
);
10707 if (INTEGERP (prop
))
10709 *prop_idx
= XINT (prop
);
10719 /* Get information about the tool-bar item at position X/Y on frame F.
10720 Return in *GLYPH a pointer to the glyph of the tool-bar item in
10721 the current matrix of the tool-bar window of F, or NULL if not
10722 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
10723 item in F->tool_bar_items. Value is
10725 -1 if X/Y is not on a tool-bar item
10726 0 if X/Y is on the same item that was highlighted before.
10730 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
10731 int *hpos
, int *vpos
, int *prop_idx
)
10733 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10734 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10737 /* Find the glyph under X/Y. */
10738 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
10739 if (*glyph
== NULL
)
10742 /* Get the start of this tool-bar item's properties in
10743 f->tool_bar_items. */
10744 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
10747 /* Is mouse on the highlighted item? */
10748 if (EQ (f
->tool_bar_window
, dpyinfo
->mouse_face_window
)
10749 && *vpos
>= dpyinfo
->mouse_face_beg_row
10750 && *vpos
<= dpyinfo
->mouse_face_end_row
10751 && (*vpos
> dpyinfo
->mouse_face_beg_row
10752 || *hpos
>= dpyinfo
->mouse_face_beg_col
)
10753 && (*vpos
< dpyinfo
->mouse_face_end_row
10754 || *hpos
< dpyinfo
->mouse_face_end_col
10755 || dpyinfo
->mouse_face_past_end
))
10763 Handle mouse button event on the tool-bar of frame F, at
10764 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
10765 0 for button release. MODIFIERS is event modifiers for button
10769 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
10770 unsigned int modifiers
)
10772 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10773 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10774 int hpos
, vpos
, prop_idx
;
10775 struct glyph
*glyph
;
10776 Lisp_Object enabled_p
;
10778 /* If not on the highlighted tool-bar item, return. */
10779 frame_to_window_pixel_xy (w
, &x
, &y
);
10780 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
10783 /* If item is disabled, do nothing. */
10784 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10785 if (NILP (enabled_p
))
10790 /* Show item in pressed state. */
10791 show_mouse_face (dpyinfo
, DRAW_IMAGE_SUNKEN
);
10792 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
10793 last_tool_bar_item
= prop_idx
;
10797 Lisp_Object key
, frame
;
10798 struct input_event event
;
10799 EVENT_INIT (event
);
10801 /* Show item in released state. */
10802 show_mouse_face (dpyinfo
, DRAW_IMAGE_RAISED
);
10803 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
10805 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
10807 XSETFRAME (frame
, f
);
10808 event
.kind
= TOOL_BAR_EVENT
;
10809 event
.frame_or_window
= frame
;
10811 kbd_buffer_store_event (&event
);
10813 event
.kind
= TOOL_BAR_EVENT
;
10814 event
.frame_or_window
= frame
;
10816 event
.modifiers
= modifiers
;
10817 kbd_buffer_store_event (&event
);
10818 last_tool_bar_item
= -1;
10823 /* Possibly highlight a tool-bar item on frame F when mouse moves to
10824 tool-bar window-relative coordinates X/Y. Called from
10825 note_mouse_highlight. */
10828 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
10830 Lisp_Object window
= f
->tool_bar_window
;
10831 struct window
*w
= XWINDOW (window
);
10832 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10834 struct glyph
*glyph
;
10835 struct glyph_row
*row
;
10837 Lisp_Object enabled_p
;
10839 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
10840 int mouse_down_p
, rc
;
10842 /* Function note_mouse_highlight is called with negative x(y
10843 values when mouse moves outside of the frame. */
10844 if (x
<= 0 || y
<= 0)
10846 clear_mouse_face (dpyinfo
);
10850 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
10853 /* Not on tool-bar item. */
10854 clear_mouse_face (dpyinfo
);
10858 /* On same tool-bar item as before. */
10859 goto set_help_echo
;
10861 clear_mouse_face (dpyinfo
);
10863 /* Mouse is down, but on different tool-bar item? */
10864 mouse_down_p
= (dpyinfo
->grabbed
10865 && f
== last_mouse_frame
10866 && FRAME_LIVE_P (f
));
10868 && last_tool_bar_item
!= prop_idx
)
10871 dpyinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
10872 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
10874 /* If tool-bar item is not enabled, don't highlight it. */
10875 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10876 if (!NILP (enabled_p
))
10878 /* Compute the x-position of the glyph. In front and past the
10879 image is a space. We include this in the highlighted area. */
10880 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
10881 for (i
= x
= 0; i
< hpos
; ++i
)
10882 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
10884 /* Record this as the current active region. */
10885 dpyinfo
->mouse_face_beg_col
= hpos
;
10886 dpyinfo
->mouse_face_beg_row
= vpos
;
10887 dpyinfo
->mouse_face_beg_x
= x
;
10888 dpyinfo
->mouse_face_beg_y
= row
->y
;
10889 dpyinfo
->mouse_face_past_end
= 0;
10891 dpyinfo
->mouse_face_end_col
= hpos
+ 1;
10892 dpyinfo
->mouse_face_end_row
= vpos
;
10893 dpyinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
10894 dpyinfo
->mouse_face_end_y
= row
->y
;
10895 dpyinfo
->mouse_face_window
= window
;
10896 dpyinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
10898 /* Display it as active. */
10899 show_mouse_face (dpyinfo
, draw
);
10900 dpyinfo
->mouse_face_image_state
= draw
;
10905 /* Set help_echo_string to a help string to display for this tool-bar item.
10906 XTread_socket does the rest. */
10907 help_echo_object
= help_echo_window
= Qnil
;
10908 help_echo_pos
= -1;
10909 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
10910 if (NILP (help_echo_string
))
10911 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
10914 #endif /* HAVE_WINDOW_SYSTEM */
10918 /************************************************************************
10919 Horizontal scrolling
10920 ************************************************************************/
10922 static int hscroll_window_tree (Lisp_Object
);
10923 static int hscroll_windows (Lisp_Object
);
10925 /* For all leaf windows in the window tree rooted at WINDOW, set their
10926 hscroll value so that PT is (i) visible in the window, and (ii) so
10927 that it is not within a certain margin at the window's left and
10928 right border. Value is non-zero if any window's hscroll has been
10932 hscroll_window_tree (Lisp_Object window
)
10934 int hscrolled_p
= 0;
10935 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
10936 int hscroll_step_abs
= 0;
10937 double hscroll_step_rel
= 0;
10939 if (hscroll_relative_p
)
10941 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
10942 if (hscroll_step_rel
< 0)
10944 hscroll_relative_p
= 0;
10945 hscroll_step_abs
= 0;
10948 else if (INTEGERP (Vhscroll_step
))
10950 hscroll_step_abs
= XINT (Vhscroll_step
);
10951 if (hscroll_step_abs
< 0)
10952 hscroll_step_abs
= 0;
10955 hscroll_step_abs
= 0;
10957 while (WINDOWP (window
))
10959 struct window
*w
= XWINDOW (window
);
10961 if (WINDOWP (w
->hchild
))
10962 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
10963 else if (WINDOWP (w
->vchild
))
10964 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
10965 else if (w
->cursor
.vpos
>= 0)
10968 int text_area_width
;
10969 struct glyph_row
*current_cursor_row
10970 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
10971 struct glyph_row
*desired_cursor_row
10972 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
10973 struct glyph_row
*cursor_row
10974 = (desired_cursor_row
->enabled_p
10975 ? desired_cursor_row
10976 : current_cursor_row
);
10978 text_area_width
= window_box_width (w
, TEXT_AREA
);
10980 /* Scroll when cursor is inside this scroll margin. */
10981 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
10983 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
10984 && ((XFASTINT (w
->hscroll
)
10985 && w
->cursor
.x
<= h_margin
)
10986 || (cursor_row
->enabled_p
10987 && cursor_row
->truncated_on_right_p
10988 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
10992 struct buffer
*saved_current_buffer
;
10996 /* Find point in a display of infinite width. */
10997 saved_current_buffer
= current_buffer
;
10998 current_buffer
= XBUFFER (w
->buffer
);
11000 if (w
== XWINDOW (selected_window
))
11001 pt
= BUF_PT (current_buffer
);
11004 pt
= marker_position (w
->pointm
);
11005 pt
= max (BEGV
, pt
);
11009 /* Move iterator to pt starting at cursor_row->start in
11010 a line with infinite width. */
11011 init_to_row_start (&it
, w
, cursor_row
);
11012 it
.last_visible_x
= INFINITY
;
11013 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
11014 current_buffer
= saved_current_buffer
;
11016 /* Position cursor in window. */
11017 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
11018 hscroll
= max (0, (it
.current_x
11019 - (ITERATOR_AT_END_OF_LINE_P (&it
)
11020 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
11021 : (text_area_width
/ 2))))
11022 / FRAME_COLUMN_WIDTH (it
.f
);
11023 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
11025 if (hscroll_relative_p
)
11026 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
11029 wanted_x
= text_area_width
11030 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11033 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11037 if (hscroll_relative_p
)
11038 wanted_x
= text_area_width
* hscroll_step_rel
11041 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11044 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11046 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
11048 /* Don't call Fset_window_hscroll if value hasn't
11049 changed because it will prevent redisplay
11051 if (XFASTINT (w
->hscroll
) != hscroll
)
11053 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
11054 w
->hscroll
= make_number (hscroll
);
11063 /* Value is non-zero if hscroll of any leaf window has been changed. */
11064 return hscrolled_p
;
11068 /* Set hscroll so that cursor is visible and not inside horizontal
11069 scroll margins for all windows in the tree rooted at WINDOW. See
11070 also hscroll_window_tree above. Value is non-zero if any window's
11071 hscroll has been changed. If it has, desired matrices on the frame
11072 of WINDOW are cleared. */
11075 hscroll_windows (Lisp_Object window
)
11077 int hscrolled_p
= hscroll_window_tree (window
);
11079 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
11080 return hscrolled_p
;
11085 /************************************************************************
11087 ************************************************************************/
11089 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
11090 to a non-zero value. This is sometimes handy to have in a debugger
11095 /* First and last unchanged row for try_window_id. */
11097 int debug_first_unchanged_at_end_vpos
;
11098 int debug_last_unchanged_at_beg_vpos
;
11100 /* Delta vpos and y. */
11102 int debug_dvpos
, debug_dy
;
11104 /* Delta in characters and bytes for try_window_id. */
11106 int debug_delta
, debug_delta_bytes
;
11108 /* Values of window_end_pos and window_end_vpos at the end of
11111 EMACS_INT debug_end_pos
, debug_end_vpos
;
11113 /* Append a string to W->desired_matrix->method. FMT is a printf
11114 format string. A1...A9 are a supplement for a variable-length
11115 argument list. If trace_redisplay_p is non-zero also printf the
11116 resulting string to stderr. */
11119 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
11122 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
11125 char *method
= w
->desired_matrix
->method
;
11126 int len
= strlen (method
);
11127 int size
= sizeof w
->desired_matrix
->method
;
11128 int remaining
= size
- len
- 1;
11130 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
11131 if (len
&& remaining
)
11134 --remaining
, ++len
;
11137 strncpy (method
+ len
, buffer
, remaining
);
11139 if (trace_redisplay_p
)
11140 fprintf (stderr
, "%p (%s): %s\n",
11142 ((BUFFERP (w
->buffer
)
11143 && STRINGP (XBUFFER (w
->buffer
)->name
))
11144 ? (char *) SDATA (XBUFFER (w
->buffer
)->name
)
11149 #endif /* GLYPH_DEBUG */
11152 /* Value is non-zero if all changes in window W, which displays
11153 current_buffer, are in the text between START and END. START is a
11154 buffer position, END is given as a distance from Z. Used in
11155 redisplay_internal for display optimization. */
11158 text_outside_line_unchanged_p (struct window
*w
, int start
, int end
)
11160 int unchanged_p
= 1;
11162 /* If text or overlays have changed, see where. */
11163 if (XFASTINT (w
->last_modified
) < MODIFF
11164 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11166 /* Gap in the line? */
11167 if (GPT
< start
|| Z
- GPT
< end
)
11170 /* Changes start in front of the line, or end after it? */
11172 && (BEG_UNCHANGED
< start
- 1
11173 || END_UNCHANGED
< end
))
11176 /* If selective display, can't optimize if changes start at the
11177 beginning of the line. */
11179 && INTEGERP (current_buffer
->selective_display
)
11180 && XINT (current_buffer
->selective_display
) > 0
11181 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
11184 /* If there are overlays at the start or end of the line, these
11185 may have overlay strings with newlines in them. A change at
11186 START, for instance, may actually concern the display of such
11187 overlay strings as well, and they are displayed on different
11188 lines. So, quickly rule out this case. (For the future, it
11189 might be desirable to implement something more telling than
11190 just BEG/END_UNCHANGED.) */
11193 if (BEG
+ BEG_UNCHANGED
== start
11194 && overlay_touches_p (start
))
11196 if (END_UNCHANGED
== end
11197 && overlay_touches_p (Z
- end
))
11201 /* Under bidi reordering, adding or deleting a character in the
11202 beginning of a paragraph, before the first strong directional
11203 character, can change the base direction of the paragraph (unless
11204 the buffer specifies a fixed paragraph direction), which will
11205 require to redisplay the whole paragraph. It might be worthwhile
11206 to find the paragraph limits and widen the range of redisplayed
11207 lines to that, but for now just give up this optimization. */
11208 if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
)
11209 && NILP (XBUFFER (w
->buffer
)->bidi_paragraph_direction
))
11213 return unchanged_p
;
11217 /* Do a frame update, taking possible shortcuts into account. This is
11218 the main external entry point for redisplay.
11220 If the last redisplay displayed an echo area message and that message
11221 is no longer requested, we clear the echo area or bring back the
11222 mini-buffer if that is in use. */
11227 redisplay_internal (0);
11232 overlay_arrow_string_or_property (Lisp_Object var
)
11236 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
11239 return Voverlay_arrow_string
;
11242 /* Return 1 if there are any overlay-arrows in current_buffer. */
11244 overlay_arrow_in_current_buffer_p (void)
11248 for (vlist
= Voverlay_arrow_variable_list
;
11250 vlist
= XCDR (vlist
))
11252 Lisp_Object var
= XCAR (vlist
);
11255 if (!SYMBOLP (var
))
11257 val
= find_symbol_value (var
);
11259 && current_buffer
== XMARKER (val
)->buffer
)
11266 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
11270 overlay_arrows_changed_p (void)
11274 for (vlist
= Voverlay_arrow_variable_list
;
11276 vlist
= XCDR (vlist
))
11278 Lisp_Object var
= XCAR (vlist
);
11279 Lisp_Object val
, pstr
;
11281 if (!SYMBOLP (var
))
11283 val
= find_symbol_value (var
);
11284 if (!MARKERP (val
))
11286 if (! EQ (COERCE_MARKER (val
),
11287 Fget (var
, Qlast_arrow_position
))
11288 || ! (pstr
= overlay_arrow_string_or_property (var
),
11289 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
11295 /* Mark overlay arrows to be updated on next redisplay. */
11298 update_overlay_arrows (int up_to_date
)
11302 for (vlist
= Voverlay_arrow_variable_list
;
11304 vlist
= XCDR (vlist
))
11306 Lisp_Object var
= XCAR (vlist
);
11308 if (!SYMBOLP (var
))
11311 if (up_to_date
> 0)
11313 Lisp_Object val
= find_symbol_value (var
);
11314 Fput (var
, Qlast_arrow_position
,
11315 COERCE_MARKER (val
));
11316 Fput (var
, Qlast_arrow_string
,
11317 overlay_arrow_string_or_property (var
));
11319 else if (up_to_date
< 0
11320 || !NILP (Fget (var
, Qlast_arrow_position
)))
11322 Fput (var
, Qlast_arrow_position
, Qt
);
11323 Fput (var
, Qlast_arrow_string
, Qt
);
11329 /* Return overlay arrow string to display at row.
11330 Return integer (bitmap number) for arrow bitmap in left fringe.
11331 Return nil if no overlay arrow. */
11334 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
11338 for (vlist
= Voverlay_arrow_variable_list
;
11340 vlist
= XCDR (vlist
))
11342 Lisp_Object var
= XCAR (vlist
);
11345 if (!SYMBOLP (var
))
11348 val
= find_symbol_value (var
);
11351 && current_buffer
== XMARKER (val
)->buffer
11352 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
11354 if (FRAME_WINDOW_P (it
->f
)
11355 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
11357 #ifdef HAVE_WINDOW_SYSTEM
11358 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
11361 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
11362 return make_number (fringe_bitmap
);
11365 return make_number (-1); /* Use default arrow bitmap */
11367 return overlay_arrow_string_or_property (var
);
11374 /* Return 1 if point moved out of or into a composition. Otherwise
11375 return 0. PREV_BUF and PREV_PT are the last point buffer and
11376 position. BUF and PT are the current point buffer and position. */
11379 check_point_in_composition (struct buffer
*prev_buf
, int prev_pt
,
11380 struct buffer
*buf
, int pt
)
11382 EMACS_INT start
, end
;
11384 Lisp_Object buffer
;
11386 XSETBUFFER (buffer
, buf
);
11387 /* Check a composition at the last point if point moved within the
11389 if (prev_buf
== buf
)
11392 /* Point didn't move. */
11395 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
11396 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
11397 && COMPOSITION_VALID_P (start
, end
, prop
)
11398 && start
< prev_pt
&& end
> prev_pt
)
11399 /* The last point was within the composition. Return 1 iff
11400 point moved out of the composition. */
11401 return (pt
<= start
|| pt
>= end
);
11404 /* Check a composition at the current point. */
11405 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
11406 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
11407 && COMPOSITION_VALID_P (start
, end
, prop
)
11408 && start
< pt
&& end
> pt
);
11412 /* Reconsider the setting of B->clip_changed which is displayed
11416 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
11418 if (b
->clip_changed
11419 && !NILP (w
->window_end_valid
)
11420 && w
->current_matrix
->buffer
== b
11421 && w
->current_matrix
->zv
== BUF_ZV (b
)
11422 && w
->current_matrix
->begv
== BUF_BEGV (b
))
11423 b
->clip_changed
= 0;
11425 /* If display wasn't paused, and W is not a tool bar window, see if
11426 point has been moved into or out of a composition. In that case,
11427 we set b->clip_changed to 1 to force updating the screen. If
11428 b->clip_changed has already been set to 1, we can skip this
11430 if (!b
->clip_changed
11431 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
11435 if (w
== XWINDOW (selected_window
))
11436 pt
= BUF_PT (current_buffer
);
11438 pt
= marker_position (w
->pointm
);
11440 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
11441 || pt
!= XINT (w
->last_point
))
11442 && check_point_in_composition (w
->current_matrix
->buffer
,
11443 XINT (w
->last_point
),
11444 XBUFFER (w
->buffer
), pt
))
11445 b
->clip_changed
= 1;
11450 /* Select FRAME to forward the values of frame-local variables into C
11451 variables so that the redisplay routines can access those values
11455 select_frame_for_redisplay (Lisp_Object frame
)
11457 Lisp_Object tail
, tem
;
11458 Lisp_Object old
= selected_frame
;
11459 struct Lisp_Symbol
*sym
;
11461 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
11463 selected_frame
= frame
;
11466 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
11467 if (CONSP (XCAR (tail
))
11468 && (tem
= XCAR (XCAR (tail
)),
11470 && (sym
= indirect_variable (XSYMBOL (tem
)),
11471 sym
->redirect
== SYMBOL_LOCALIZED
)
11472 && sym
->val
.blv
->frame_local
)
11473 /* Use find_symbol_value rather than Fsymbol_value
11474 to avoid an error if it is void. */
11475 find_symbol_value (tem
);
11476 } while (!EQ (frame
, old
) && (frame
= old
, 1));
11480 #define STOP_POLLING \
11481 do { if (! polling_stopped_here) stop_polling (); \
11482 polling_stopped_here = 1; } while (0)
11484 #define RESUME_POLLING \
11485 do { if (polling_stopped_here) start_polling (); \
11486 polling_stopped_here = 0; } while (0)
11489 /* If PRESERVE_ECHO_AREA is nonzero, it means this redisplay is not in
11490 response to any user action; therefore, we should preserve the echo
11491 area. (Actually, our caller does that job.) Perhaps in the future
11492 avoid recentering windows if it is not necessary; currently that
11493 causes some problems. */
11496 redisplay_internal (int preserve_echo_area
)
11498 struct window
*w
= XWINDOW (selected_window
);
11501 int must_finish
= 0;
11502 struct text_pos tlbufpos
, tlendpos
;
11503 int number_of_visible_frames
;
11506 int polling_stopped_here
= 0;
11507 Lisp_Object old_frame
= selected_frame
;
11509 /* Non-zero means redisplay has to consider all windows on all
11510 frames. Zero means, only selected_window is considered. */
11511 int consider_all_windows_p
;
11513 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
11515 /* No redisplay if running in batch mode or frame is not yet fully
11516 initialized, or redisplay is explicitly turned off by setting
11517 Vinhibit_redisplay. */
11518 if (FRAME_INITIAL_P (SELECTED_FRAME ())
11519 || !NILP (Vinhibit_redisplay
))
11522 /* Don't examine these until after testing Vinhibit_redisplay.
11523 When Emacs is shutting down, perhaps because its connection to
11524 X has dropped, we should not look at them at all. */
11525 f
= XFRAME (w
->frame
);
11526 sf
= SELECTED_FRAME ();
11528 if (!f
->glyphs_initialized_p
)
11531 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
11532 if (popup_activated ())
11536 /* I don't think this happens but let's be paranoid. */
11537 if (redisplaying_p
)
11540 /* Record a function that resets redisplaying_p to its old value
11541 when we leave this function. */
11542 count
= SPECPDL_INDEX ();
11543 record_unwind_protect (unwind_redisplay
,
11544 Fcons (make_number (redisplaying_p
), selected_frame
));
11546 specbind (Qinhibit_free_realized_faces
, Qnil
);
11549 Lisp_Object tail
, frame
;
11551 FOR_EACH_FRAME (tail
, frame
)
11553 struct frame
*f
= XFRAME (frame
);
11554 f
->already_hscrolled_p
= 0;
11559 if (!EQ (old_frame
, selected_frame
)
11560 && FRAME_LIVE_P (XFRAME (old_frame
)))
11561 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
11562 selected_frame and selected_window to be temporarily out-of-sync so
11563 when we come back here via `goto retry', we need to resync because we
11564 may need to run Elisp code (via prepare_menu_bars). */
11565 select_frame_for_redisplay (old_frame
);
11568 reconsider_clip_changes (w
, current_buffer
);
11569 last_escape_glyph_frame
= NULL
;
11570 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
11572 /* If new fonts have been loaded that make a glyph matrix adjustment
11573 necessary, do it. */
11574 if (fonts_changed_p
)
11576 adjust_glyphs (NULL
);
11577 ++windows_or_buffers_changed
;
11578 fonts_changed_p
= 0;
11581 /* If face_change_count is non-zero, init_iterator will free all
11582 realized faces, which includes the faces referenced from current
11583 matrices. So, we can't reuse current matrices in this case. */
11584 if (face_change_count
)
11585 ++windows_or_buffers_changed
;
11587 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11588 && FRAME_TTY (sf
)->previous_frame
!= sf
)
11590 /* Since frames on a single ASCII terminal share the same
11591 display area, displaying a different frame means redisplay
11592 the whole thing. */
11593 windows_or_buffers_changed
++;
11594 SET_FRAME_GARBAGED (sf
);
11596 set_tty_color_mode (FRAME_TTY (sf
), sf
);
11598 FRAME_TTY (sf
)->previous_frame
= sf
;
11601 /* Set the visible flags for all frames. Do this before checking
11602 for resized or garbaged frames; they want to know if their frames
11603 are visible. See the comment in frame.h for
11604 FRAME_SAMPLE_VISIBILITY. */
11606 Lisp_Object tail
, frame
;
11608 number_of_visible_frames
= 0;
11610 FOR_EACH_FRAME (tail
, frame
)
11612 struct frame
*f
= XFRAME (frame
);
11614 FRAME_SAMPLE_VISIBILITY (f
);
11615 if (FRAME_VISIBLE_P (f
))
11616 ++number_of_visible_frames
;
11617 clear_desired_matrices (f
);
11621 /* Notice any pending interrupt request to change frame size. */
11622 do_pending_window_change (1);
11624 /* Clear frames marked as garbaged. */
11625 if (frame_garbaged
)
11626 clear_garbaged_frames ();
11628 /* Build menubar and tool-bar items. */
11629 if (NILP (Vmemory_full
))
11630 prepare_menu_bars ();
11632 if (windows_or_buffers_changed
)
11633 update_mode_lines
++;
11635 /* Detect case that we need to write or remove a star in the mode line. */
11636 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
11638 w
->update_mode_line
= Qt
;
11639 if (buffer_shared
> 1)
11640 update_mode_lines
++;
11643 /* Avoid invocation of point motion hooks by `current_column' below. */
11644 count1
= SPECPDL_INDEX ();
11645 specbind (Qinhibit_point_motion_hooks
, Qt
);
11647 /* If %c is in the mode line, update it if needed. */
11648 if (!NILP (w
->column_number_displayed
)
11649 /* This alternative quickly identifies a common case
11650 where no change is needed. */
11651 && !(PT
== XFASTINT (w
->last_point
)
11652 && XFASTINT (w
->last_modified
) >= MODIFF
11653 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
11654 && (XFASTINT (w
->column_number_displayed
)
11655 != (int) current_column ())) /* iftc */
11656 w
->update_mode_line
= Qt
;
11658 unbind_to (count1
, Qnil
);
11660 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
11662 /* The variable buffer_shared is set in redisplay_window and
11663 indicates that we redisplay a buffer in different windows. See
11665 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
11666 || cursor_type_changed
);
11668 /* If specs for an arrow have changed, do thorough redisplay
11669 to ensure we remove any arrow that should no longer exist. */
11670 if (overlay_arrows_changed_p ())
11671 consider_all_windows_p
= windows_or_buffers_changed
= 1;
11673 /* Normally the message* functions will have already displayed and
11674 updated the echo area, but the frame may have been trashed, or
11675 the update may have been preempted, so display the echo area
11676 again here. Checking message_cleared_p captures the case that
11677 the echo area should be cleared. */
11678 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
11679 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
11680 || (message_cleared_p
11681 && minibuf_level
== 0
11682 /* If the mini-window is currently selected, this means the
11683 echo-area doesn't show through. */
11684 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
11686 int window_height_changed_p
= echo_area_display (0);
11689 /* If we don't display the current message, don't clear the
11690 message_cleared_p flag, because, if we did, we wouldn't clear
11691 the echo area in the next redisplay which doesn't preserve
11693 if (!display_last_displayed_message_p
)
11694 message_cleared_p
= 0;
11696 if (fonts_changed_p
)
11698 else if (window_height_changed_p
)
11700 consider_all_windows_p
= 1;
11701 ++update_mode_lines
;
11702 ++windows_or_buffers_changed
;
11704 /* If window configuration was changed, frames may have been
11705 marked garbaged. Clear them or we will experience
11706 surprises wrt scrolling. */
11707 if (frame_garbaged
)
11708 clear_garbaged_frames ();
11711 else if (EQ (selected_window
, minibuf_window
)
11712 && (current_buffer
->clip_changed
11713 || XFASTINT (w
->last_modified
) < MODIFF
11714 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11715 && resize_mini_window (w
, 0))
11717 /* Resized active mini-window to fit the size of what it is
11718 showing if its contents might have changed. */
11720 /* FIXME: this causes all frames to be updated, which seems unnecessary
11721 since only the current frame needs to be considered. This function needs
11722 to be rewritten with two variables, consider_all_windows and
11723 consider_all_frames. */
11724 consider_all_windows_p
= 1;
11725 ++windows_or_buffers_changed
;
11726 ++update_mode_lines
;
11728 /* If window configuration was changed, frames may have been
11729 marked garbaged. Clear them or we will experience
11730 surprises wrt scrolling. */
11731 if (frame_garbaged
)
11732 clear_garbaged_frames ();
11736 /* If showing the region, and mark has changed, we must redisplay
11737 the whole window. The assignment to this_line_start_pos prevents
11738 the optimization directly below this if-statement. */
11739 if (((!NILP (Vtransient_mark_mode
)
11740 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
11741 != !NILP (w
->region_showing
))
11742 || (!NILP (w
->region_showing
)
11743 && !EQ (w
->region_showing
,
11744 Fmarker_position (XBUFFER (w
->buffer
)->mark
))))
11745 CHARPOS (this_line_start_pos
) = 0;
11747 /* Optimize the case that only the line containing the cursor in the
11748 selected window has changed. Variables starting with this_ are
11749 set in display_line and record information about the line
11750 containing the cursor. */
11751 tlbufpos
= this_line_start_pos
;
11752 tlendpos
= this_line_end_pos
;
11753 if (!consider_all_windows_p
11754 && CHARPOS (tlbufpos
) > 0
11755 && NILP (w
->update_mode_line
)
11756 && !current_buffer
->clip_changed
11757 && !current_buffer
->prevent_redisplay_optimizations_p
11758 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
11759 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
11760 /* Make sure recorded data applies to current buffer, etc. */
11761 && this_line_buffer
== current_buffer
11762 && current_buffer
== XBUFFER (w
->buffer
)
11763 && NILP (w
->force_start
)
11764 && NILP (w
->optional_new_start
)
11765 /* Point must be on the line that we have info recorded about. */
11766 && PT
>= CHARPOS (tlbufpos
)
11767 && PT
<= Z
- CHARPOS (tlendpos
)
11768 /* All text outside that line, including its final newline,
11769 must be unchanged. */
11770 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
11771 CHARPOS (tlendpos
)))
11773 if (CHARPOS (tlbufpos
) > BEGV
11774 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
11775 && (CHARPOS (tlbufpos
) == ZV
11776 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
11777 /* Former continuation line has disappeared by becoming empty. */
11779 else if (XFASTINT (w
->last_modified
) < MODIFF
11780 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
11781 || MINI_WINDOW_P (w
))
11783 /* We have to handle the case of continuation around a
11784 wide-column character (see the comment in indent.c around
11787 For instance, in the following case:
11789 -------- Insert --------
11790 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
11791 J_I_ ==> J_I_ `^^' are cursors.
11795 As we have to redraw the line above, we cannot use this
11799 int line_height_before
= this_line_pixel_height
;
11801 /* Note that start_display will handle the case that the
11802 line starting at tlbufpos is a continuation line. */
11803 start_display (&it
, w
, tlbufpos
);
11805 /* Implementation note: It this still necessary? */
11806 if (it
.current_x
!= this_line_start_x
)
11809 TRACE ((stderr
, "trying display optimization 1\n"));
11810 w
->cursor
.vpos
= -1;
11811 overlay_arrow_seen
= 0;
11812 it
.vpos
= this_line_vpos
;
11813 it
.current_y
= this_line_y
;
11814 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
11815 display_line (&it
);
11817 /* If line contains point, is not continued,
11818 and ends at same distance from eob as before, we win. */
11819 if (w
->cursor
.vpos
>= 0
11820 /* Line is not continued, otherwise this_line_start_pos
11821 would have been set to 0 in display_line. */
11822 && CHARPOS (this_line_start_pos
)
11823 /* Line ends as before. */
11824 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
11825 /* Line has same height as before. Otherwise other lines
11826 would have to be shifted up or down. */
11827 && this_line_pixel_height
== line_height_before
)
11829 /* If this is not the window's last line, we must adjust
11830 the charstarts of the lines below. */
11831 if (it
.current_y
< it
.last_visible_y
)
11833 struct glyph_row
*row
11834 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
11835 int delta
, delta_bytes
;
11837 /* We used to distinguish between two cases here,
11838 conditioned by Z - CHARPOS (tlendpos) == ZV, for
11839 when the line ends in a newline or the end of the
11840 buffer's accessible portion. But both cases did
11841 the same, so they were collapsed. */
11843 - CHARPOS (tlendpos
)
11844 - MATRIX_ROW_START_CHARPOS (row
));
11845 delta_bytes
= (Z_BYTE
11846 - BYTEPOS (tlendpos
)
11847 - MATRIX_ROW_START_BYTEPOS (row
));
11849 increment_matrix_positions (w
->current_matrix
,
11850 this_line_vpos
+ 1,
11851 w
->current_matrix
->nrows
,
11852 delta
, delta_bytes
);
11855 /* If this row displays text now but previously didn't,
11856 or vice versa, w->window_end_vpos may have to be
11858 if ((it
.glyph_row
- 1)->displays_text_p
)
11860 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
11861 XSETINT (w
->window_end_vpos
, this_line_vpos
);
11863 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
11864 && this_line_vpos
> 0)
11865 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
11866 w
->window_end_valid
= Qnil
;
11868 /* Update hint: No need to try to scroll in update_window. */
11869 w
->desired_matrix
->no_scrolling_p
= 1;
11872 *w
->desired_matrix
->method
= 0;
11873 debug_method_add (w
, "optimization 1");
11875 #ifdef HAVE_WINDOW_SYSTEM
11876 update_window_fringes (w
, 0);
11883 else if (/* Cursor position hasn't changed. */
11884 PT
== XFASTINT (w
->last_point
)
11885 /* Make sure the cursor was last displayed
11886 in this window. Otherwise we have to reposition it. */
11887 && 0 <= w
->cursor
.vpos
11888 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
11892 do_pending_window_change (1);
11894 /* We used to always goto end_of_redisplay here, but this
11895 isn't enough if we have a blinking cursor. */
11896 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
11897 goto end_of_redisplay
;
11901 /* If highlighting the region, or if the cursor is in the echo area,
11902 then we can't just move the cursor. */
11903 else if (! (!NILP (Vtransient_mark_mode
)
11904 && !NILP (current_buffer
->mark_active
))
11905 && (EQ (selected_window
, current_buffer
->last_selected_window
)
11906 || highlight_nonselected_windows
)
11907 && NILP (w
->region_showing
)
11908 && NILP (Vshow_trailing_whitespace
)
11909 && !cursor_in_echo_area
)
11912 struct glyph_row
*row
;
11914 /* Skip from tlbufpos to PT and see where it is. Note that
11915 PT may be in invisible text. If so, we will end at the
11916 next visible position. */
11917 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
11918 NULL
, DEFAULT_FACE_ID
);
11919 it
.current_x
= this_line_start_x
;
11920 it
.current_y
= this_line_y
;
11921 it
.vpos
= this_line_vpos
;
11923 /* The call to move_it_to stops in front of PT, but
11924 moves over before-strings. */
11925 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
11927 if (it
.vpos
== this_line_vpos
11928 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
11931 xassert (this_line_vpos
== it
.vpos
);
11932 xassert (this_line_y
== it
.current_y
);
11933 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
11935 *w
->desired_matrix
->method
= 0;
11936 debug_method_add (w
, "optimization 3");
11945 /* Text changed drastically or point moved off of line. */
11946 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
11949 CHARPOS (this_line_start_pos
) = 0;
11950 consider_all_windows_p
|= buffer_shared
> 1;
11951 ++clear_face_cache_count
;
11952 #ifdef HAVE_WINDOW_SYSTEM
11953 ++clear_image_cache_count
;
11956 /* Build desired matrices, and update the display. If
11957 consider_all_windows_p is non-zero, do it for all windows on all
11958 frames. Otherwise do it for selected_window, only. */
11960 if (consider_all_windows_p
)
11962 Lisp_Object tail
, frame
;
11964 FOR_EACH_FRAME (tail
, frame
)
11965 XFRAME (frame
)->updated_p
= 0;
11967 /* Recompute # windows showing selected buffer. This will be
11968 incremented each time such a window is displayed. */
11971 FOR_EACH_FRAME (tail
, frame
)
11973 struct frame
*f
= XFRAME (frame
);
11975 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
11977 if (! EQ (frame
, selected_frame
))
11978 /* Select the frame, for the sake of frame-local
11980 select_frame_for_redisplay (frame
);
11982 /* Mark all the scroll bars to be removed; we'll redeem
11983 the ones we want when we redisplay their windows. */
11984 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
11985 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
11987 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11988 redisplay_windows (FRAME_ROOT_WINDOW (f
));
11990 /* The X error handler may have deleted that frame. */
11991 if (!FRAME_LIVE_P (f
))
11994 /* Any scroll bars which redisplay_windows should have
11995 nuked should now go away. */
11996 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
11997 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
11999 /* If fonts changed, display again. */
12000 /* ??? rms: I suspect it is a mistake to jump all the way
12001 back to retry here. It should just retry this frame. */
12002 if (fonts_changed_p
)
12005 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12007 /* See if we have to hscroll. */
12008 if (!f
->already_hscrolled_p
)
12010 f
->already_hscrolled_p
= 1;
12011 if (hscroll_windows (f
->root_window
))
12015 /* Prevent various kinds of signals during display
12016 update. stdio is not robust about handling
12017 signals, which can cause an apparent I/O
12019 if (interrupt_input
)
12020 unrequest_sigio ();
12023 /* Update the display. */
12024 set_window_update_flags (XWINDOW (f
->root_window
), 1);
12025 pause
|= update_frame (f
, 0, 0);
12031 if (!EQ (old_frame
, selected_frame
)
12032 && FRAME_LIVE_P (XFRAME (old_frame
)))
12033 /* We played a bit fast-and-loose above and allowed selected_frame
12034 and selected_window to be temporarily out-of-sync but let's make
12035 sure this stays contained. */
12036 select_frame_for_redisplay (old_frame
);
12037 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
12041 /* Do the mark_window_display_accurate after all windows have
12042 been redisplayed because this call resets flags in buffers
12043 which are needed for proper redisplay. */
12044 FOR_EACH_FRAME (tail
, frame
)
12046 struct frame
*f
= XFRAME (frame
);
12049 mark_window_display_accurate (f
->root_window
, 1);
12050 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
12051 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
12056 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12058 Lisp_Object mini_window
;
12059 struct frame
*mini_frame
;
12061 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
12062 /* Use list_of_error, not Qerror, so that
12063 we catch only errors and don't run the debugger. */
12064 internal_condition_case_1 (redisplay_window_1
, selected_window
,
12066 redisplay_window_error
);
12068 /* Compare desired and current matrices, perform output. */
12071 /* If fonts changed, display again. */
12072 if (fonts_changed_p
)
12075 /* Prevent various kinds of signals during display update.
12076 stdio is not robust about handling signals,
12077 which can cause an apparent I/O error. */
12078 if (interrupt_input
)
12079 unrequest_sigio ();
12082 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12084 if (hscroll_windows (selected_window
))
12087 XWINDOW (selected_window
)->must_be_updated_p
= 1;
12088 pause
= update_frame (sf
, 0, 0);
12091 /* We may have called echo_area_display at the top of this
12092 function. If the echo area is on another frame, that may
12093 have put text on a frame other than the selected one, so the
12094 above call to update_frame would not have caught it. Catch
12096 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
12097 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
12099 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
12101 XWINDOW (mini_window
)->must_be_updated_p
= 1;
12102 pause
|= update_frame (mini_frame
, 0, 0);
12103 if (!pause
&& hscroll_windows (mini_window
))
12108 /* If display was paused because of pending input, make sure we do a
12109 thorough update the next time. */
12112 /* Prevent the optimization at the beginning of
12113 redisplay_internal that tries a single-line update of the
12114 line containing the cursor in the selected window. */
12115 CHARPOS (this_line_start_pos
) = 0;
12117 /* Let the overlay arrow be updated the next time. */
12118 update_overlay_arrows (0);
12120 /* If we pause after scrolling, some rows in the current
12121 matrices of some windows are not valid. */
12122 if (!WINDOW_FULL_WIDTH_P (w
)
12123 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
12124 update_mode_lines
= 1;
12128 if (!consider_all_windows_p
)
12130 /* This has already been done above if
12131 consider_all_windows_p is set. */
12132 mark_window_display_accurate_1 (w
, 1);
12134 /* Say overlay arrows are up to date. */
12135 update_overlay_arrows (1);
12137 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
12138 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
12141 update_mode_lines
= 0;
12142 windows_or_buffers_changed
= 0;
12143 cursor_type_changed
= 0;
12146 /* Start SIGIO interrupts coming again. Having them off during the
12147 code above makes it less likely one will discard output, but not
12148 impossible, since there might be stuff in the system buffer here.
12149 But it is much hairier to try to do anything about that. */
12150 if (interrupt_input
)
12154 /* If a frame has become visible which was not before, redisplay
12155 again, so that we display it. Expose events for such a frame
12156 (which it gets when becoming visible) don't call the parts of
12157 redisplay constructing glyphs, so simply exposing a frame won't
12158 display anything in this case. So, we have to display these
12159 frames here explicitly. */
12162 Lisp_Object tail
, frame
;
12165 FOR_EACH_FRAME (tail
, frame
)
12167 int this_is_visible
= 0;
12169 if (XFRAME (frame
)->visible
)
12170 this_is_visible
= 1;
12171 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
12172 if (XFRAME (frame
)->visible
)
12173 this_is_visible
= 1;
12175 if (this_is_visible
)
12179 if (new_count
!= number_of_visible_frames
)
12180 windows_or_buffers_changed
++;
12183 /* Change frame size now if a change is pending. */
12184 do_pending_window_change (1);
12186 /* If we just did a pending size change, or have additional
12187 visible frames, redisplay again. */
12188 if (windows_or_buffers_changed
&& !pause
)
12191 /* Clear the face and image caches.
12193 We used to do this only if consider_all_windows_p. But the cache
12194 needs to be cleared if a timer creates images in the current
12195 buffer (e.g. the test case in Bug#6230). */
12197 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
12199 clear_face_cache (0);
12200 clear_face_cache_count
= 0;
12203 #ifdef HAVE_WINDOW_SYSTEM
12204 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
12206 clear_image_caches (Qnil
);
12207 clear_image_cache_count
= 0;
12209 #endif /* HAVE_WINDOW_SYSTEM */
12212 unbind_to (count
, Qnil
);
12217 /* Redisplay, but leave alone any recent echo area message unless
12218 another message has been requested in its place.
12220 This is useful in situations where you need to redisplay but no
12221 user action has occurred, making it inappropriate for the message
12222 area to be cleared. See tracking_off and
12223 wait_reading_process_output for examples of these situations.
12225 FROM_WHERE is an integer saying from where this function was
12226 called. This is useful for debugging. */
12229 redisplay_preserve_echo_area (int from_where
)
12231 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
12233 if (!NILP (echo_area_buffer
[1]))
12235 /* We have a previously displayed message, but no current
12236 message. Redisplay the previous message. */
12237 display_last_displayed_message_p
= 1;
12238 redisplay_internal (1);
12239 display_last_displayed_message_p
= 0;
12242 redisplay_internal (1);
12244 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
12245 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
12246 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
12250 /* Function registered with record_unwind_protect in
12251 redisplay_internal. Reset redisplaying_p to the value it had
12252 before redisplay_internal was called, and clear
12253 prevent_freeing_realized_faces_p. It also selects the previously
12254 selected frame, unless it has been deleted (by an X connection
12255 failure during redisplay, for example). */
12258 unwind_redisplay (Lisp_Object val
)
12260 Lisp_Object old_redisplaying_p
, old_frame
;
12262 old_redisplaying_p
= XCAR (val
);
12263 redisplaying_p
= XFASTINT (old_redisplaying_p
);
12264 old_frame
= XCDR (val
);
12265 if (! EQ (old_frame
, selected_frame
)
12266 && FRAME_LIVE_P (XFRAME (old_frame
)))
12267 select_frame_for_redisplay (old_frame
);
12272 /* Mark the display of window W as accurate or inaccurate. If
12273 ACCURATE_P is non-zero mark display of W as accurate. If
12274 ACCURATE_P is zero, arrange for W to be redisplayed the next time
12275 redisplay_internal is called. */
12278 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
12280 if (BUFFERP (w
->buffer
))
12282 struct buffer
*b
= XBUFFER (w
->buffer
);
12285 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
12286 w
->last_overlay_modified
12287 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
12289 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
12293 b
->clip_changed
= 0;
12294 b
->prevent_redisplay_optimizations_p
= 0;
12296 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
12297 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
12298 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
12299 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
12301 w
->current_matrix
->buffer
= b
;
12302 w
->current_matrix
->begv
= BUF_BEGV (b
);
12303 w
->current_matrix
->zv
= BUF_ZV (b
);
12305 w
->last_cursor
= w
->cursor
;
12306 w
->last_cursor_off_p
= w
->cursor_off_p
;
12308 if (w
== XWINDOW (selected_window
))
12309 w
->last_point
= make_number (BUF_PT (b
));
12311 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
12317 w
->window_end_valid
= w
->buffer
;
12318 w
->update_mode_line
= Qnil
;
12323 /* Mark the display of windows in the window tree rooted at WINDOW as
12324 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
12325 windows as accurate. If ACCURATE_P is zero, arrange for windows to
12326 be redisplayed the next time redisplay_internal is called. */
12329 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
12333 for (; !NILP (window
); window
= w
->next
)
12335 w
= XWINDOW (window
);
12336 mark_window_display_accurate_1 (w
, accurate_p
);
12338 if (!NILP (w
->vchild
))
12339 mark_window_display_accurate (w
->vchild
, accurate_p
);
12340 if (!NILP (w
->hchild
))
12341 mark_window_display_accurate (w
->hchild
, accurate_p
);
12346 update_overlay_arrows (1);
12350 /* Force a thorough redisplay the next time by setting
12351 last_arrow_position and last_arrow_string to t, which is
12352 unequal to any useful value of Voverlay_arrow_... */
12353 update_overlay_arrows (-1);
12358 /* Return value in display table DP (Lisp_Char_Table *) for character
12359 C. Since a display table doesn't have any parent, we don't have to
12360 follow parent. Do not call this function directly but use the
12361 macro DISP_CHAR_VECTOR. */
12364 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
12368 if (ASCII_CHAR_P (c
))
12371 if (SUB_CHAR_TABLE_P (val
))
12372 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
12378 XSETCHAR_TABLE (table
, dp
);
12379 val
= char_table_ref (table
, c
);
12388 /***********************************************************************
12390 ***********************************************************************/
12392 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
12395 redisplay_windows (Lisp_Object window
)
12397 while (!NILP (window
))
12399 struct window
*w
= XWINDOW (window
);
12401 if (!NILP (w
->hchild
))
12402 redisplay_windows (w
->hchild
);
12403 else if (!NILP (w
->vchild
))
12404 redisplay_windows (w
->vchild
);
12405 else if (!NILP (w
->buffer
))
12407 displayed_buffer
= XBUFFER (w
->buffer
);
12408 /* Use list_of_error, not Qerror, so that
12409 we catch only errors and don't run the debugger. */
12410 internal_condition_case_1 (redisplay_window_0
, window
,
12412 redisplay_window_error
);
12420 redisplay_window_error (Lisp_Object ignore
)
12422 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
12427 redisplay_window_0 (Lisp_Object window
)
12429 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12430 redisplay_window (window
, 0);
12435 redisplay_window_1 (Lisp_Object window
)
12437 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12438 redisplay_window (window
, 1);
12443 /* Increment GLYPH until it reaches END or CONDITION fails while
12444 adding (GLYPH)->pixel_width to X. */
12446 #define SKIP_GLYPHS(glyph, end, x, condition) \
12449 (x) += (glyph)->pixel_width; \
12452 while ((glyph) < (end) && (condition))
12455 /* Set cursor position of W. PT is assumed to be displayed in ROW.
12456 DELTA and DELTA_BYTES are the numbers of characters and bytes by
12457 which positions recorded in ROW differ from current buffer
12460 Return 0 if cursor is not on this row, 1 otherwise. */
12463 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
12464 struct glyph_matrix
*matrix
, int delta
, int delta_bytes
,
12467 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
12468 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
12469 struct glyph
*cursor
= NULL
;
12470 /* The last known character position in row. */
12471 int last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12473 EMACS_INT pt_old
= PT
- delta
;
12474 EMACS_INT pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12475 EMACS_INT pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
12476 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
12477 /* A glyph beyond the edge of TEXT_AREA which we should never
12479 struct glyph
*glyphs_end
= end
;
12480 /* Non-zero means we've found a match for cursor position, but that
12481 glyph has the avoid_cursor_p flag set. */
12482 int match_with_avoid_cursor
= 0;
12483 /* Non-zero means we've seen at least one glyph that came from a
12485 int string_seen
= 0;
12486 /* Largest buffer position seen so far during scan of glyph row. */
12487 EMACS_INT bpos_max
= last_pos
;
12488 /* Last buffer position covered by an overlay string with an integer
12489 `cursor' property. */
12490 EMACS_INT bpos_covered
= 0;
12492 /* Skip over glyphs not having an object at the start and the end of
12493 the row. These are special glyphs like truncation marks on
12494 terminal frames. */
12495 if (row
->displays_text_p
)
12497 if (!row
->reversed_p
)
12500 && INTEGERP (glyph
->object
)
12501 && glyph
->charpos
< 0)
12503 x
+= glyph
->pixel_width
;
12507 && INTEGERP ((end
- 1)->object
)
12508 /* CHARPOS is zero for blanks and stretch glyphs
12509 inserted by extend_face_to_end_of_line. */
12510 && (end
- 1)->charpos
<= 0)
12512 glyph_before
= glyph
- 1;
12519 /* If the glyph row is reversed, we need to process it from back
12520 to front, so swap the edge pointers. */
12521 glyphs_end
= end
= glyph
- 1;
12522 glyph
+= row
->used
[TEXT_AREA
] - 1;
12524 while (glyph
> end
+ 1
12525 && INTEGERP (glyph
->object
)
12526 && glyph
->charpos
< 0)
12529 x
-= glyph
->pixel_width
;
12531 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
12533 /* By default, in reversed rows we put the cursor on the
12534 rightmost (first in the reading order) glyph. */
12535 for (g
= end
+ 1; g
< glyph
; g
++)
12536 x
+= g
->pixel_width
;
12538 && INTEGERP ((end
+ 1)->object
)
12539 && (end
+ 1)->charpos
<= 0)
12541 glyph_before
= glyph
+ 1;
12545 else if (row
->reversed_p
)
12547 /* In R2L rows that don't display text, put the cursor on the
12548 rightmost glyph. Case in point: an empty last line that is
12549 part of an R2L paragraph. */
12551 /* Avoid placing the cursor on the last glyph of the row, where
12552 on terminal frames we hold the vertical border between
12553 adjacent windows. */
12554 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
12555 && !WINDOW_RIGHTMOST_P (w
)
12556 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
12558 x
= -1; /* will be computed below, at label compute_x */
12561 /* Step 1: Try to find the glyph whose character position
12562 corresponds to point. If that's not possible, find 2 glyphs
12563 whose character positions are the closest to point, one before
12564 point, the other after it. */
12565 if (!row
->reversed_p
)
12566 while (/* not marched to end of glyph row */
12568 /* glyph was not inserted by redisplay for internal purposes */
12569 && !INTEGERP (glyph
->object
))
12571 if (BUFFERP (glyph
->object
))
12573 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12575 if (glyph
->charpos
> bpos_max
)
12576 bpos_max
= glyph
->charpos
;
12577 if (!glyph
->avoid_cursor_p
)
12579 /* If we hit point, we've found the glyph on which to
12580 display the cursor. */
12583 match_with_avoid_cursor
= 0;
12586 /* See if we've found a better approximation to
12587 POS_BEFORE or to POS_AFTER. Note that we want the
12588 first (leftmost) glyph of all those that are the
12589 closest from below, and the last (rightmost) of all
12590 those from above. */
12591 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12593 pos_before
= glyph
->charpos
;
12594 glyph_before
= glyph
;
12596 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12598 pos_after
= glyph
->charpos
;
12599 glyph_after
= glyph
;
12602 else if (dpos
== 0)
12603 match_with_avoid_cursor
= 1;
12605 else if (STRINGP (glyph
->object
))
12607 Lisp_Object chprop
;
12608 int glyph_pos
= glyph
->charpos
;
12610 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12612 if (INTEGERP (chprop
))
12614 bpos_covered
= bpos_max
+ XINT (chprop
);
12615 /* If the `cursor' property covers buffer positions up
12616 to and including point, we should display cursor on
12617 this glyph. Note that overlays and text properties
12618 with string values stop bidi reordering, so every
12619 buffer position to the left of the string is always
12620 smaller than any position to the right of the
12621 string. Therefore, if a `cursor' property on one
12622 of the string's characters has an integer value, we
12623 will break out of the loop below _before_ we get to
12624 the position match above. IOW, integer values of
12625 the `cursor' property override the "exact match for
12626 point" strategy of positioning the cursor. */
12627 /* Implementation note: bpos_max == pt_old when, e.g.,
12628 we are in an empty line, where bpos_max is set to
12629 MATRIX_ROW_START_CHARPOS, see above. */
12630 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12639 x
+= glyph
->pixel_width
;
12642 else if (glyph
> end
) /* row is reversed */
12643 while (!INTEGERP (glyph
->object
))
12645 if (BUFFERP (glyph
->object
))
12647 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12649 if (glyph
->charpos
> bpos_max
)
12650 bpos_max
= glyph
->charpos
;
12651 if (!glyph
->avoid_cursor_p
)
12655 match_with_avoid_cursor
= 0;
12658 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12660 pos_before
= glyph
->charpos
;
12661 glyph_before
= glyph
;
12663 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12665 pos_after
= glyph
->charpos
;
12666 glyph_after
= glyph
;
12669 else if (dpos
== 0)
12670 match_with_avoid_cursor
= 1;
12672 else if (STRINGP (glyph
->object
))
12674 Lisp_Object chprop
;
12675 int glyph_pos
= glyph
->charpos
;
12677 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12679 if (INTEGERP (chprop
))
12681 bpos_covered
= bpos_max
+ XINT (chprop
);
12682 /* If the `cursor' property covers buffer positions up
12683 to and including point, we should display cursor on
12685 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12694 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
12696 x
--; /* can't use any pixel_width */
12699 x
-= glyph
->pixel_width
;
12702 /* Step 2: If we didn't find an exact match for point, we need to
12703 look for a proper place to put the cursor among glyphs between
12704 GLYPH_BEFORE and GLYPH_AFTER. */
12705 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
12706 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12707 && bpos_covered
< pt_old
)
12709 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
12711 EMACS_INT ellipsis_pos
;
12713 /* Scan back over the ellipsis glyphs. */
12714 if (!row
->reversed_p
)
12716 ellipsis_pos
= (glyph
- 1)->charpos
;
12717 while (glyph
> row
->glyphs
[TEXT_AREA
]
12718 && (glyph
- 1)->charpos
== ellipsis_pos
)
12719 glyph
--, x
-= glyph
->pixel_width
;
12720 /* That loop always goes one position too far, including
12721 the glyph before the ellipsis. So scan forward over
12723 x
+= glyph
->pixel_width
;
12726 else /* row is reversed */
12728 ellipsis_pos
= (glyph
+ 1)->charpos
;
12729 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
12730 && (glyph
+ 1)->charpos
== ellipsis_pos
)
12731 glyph
++, x
+= glyph
->pixel_width
;
12732 x
-= glyph
->pixel_width
;
12736 else if (match_with_avoid_cursor
12737 /* zero-width characters produce no glyphs */
12738 || ((row
->reversed_p
12739 ? glyph_after
> glyphs_end
12740 : glyph_after
< glyphs_end
)
12741 && eabs (glyph_after
- glyph_before
) == 1))
12743 cursor
= glyph_after
;
12746 else if (string_seen
)
12748 int incr
= row
->reversed_p
? -1 : +1;
12750 /* Need to find the glyph that came out of a string which is
12751 present at point. That glyph is somewhere between
12752 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
12753 positioned between POS_BEFORE and POS_AFTER in the
12755 struct glyph
*stop
= glyph_after
;
12756 EMACS_INT pos
= pos_before
;
12759 for (glyph
= glyph_before
+ incr
;
12760 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
12763 /* Any glyphs that come from the buffer are here because
12764 of bidi reordering. Skip them, and only pay
12765 attention to glyphs that came from some string. */
12766 if (STRINGP (glyph
->object
))
12771 str
= glyph
->object
;
12772 tem
= string_buffer_position_lim (w
, str
, pos
, pos_after
, 0);
12773 if (tem
== 0 /* from overlay */
12776 /* If the string from which this glyph came is
12777 found in the buffer at point, then we've
12778 found the glyph we've been looking for. If
12779 it comes from an overlay (tem == 0), and it
12780 has the `cursor' property on one of its
12781 glyphs, record that glyph as a candidate for
12782 displaying the cursor. (As in the
12783 unidirectional version, we will display the
12784 cursor on the last candidate we find.) */
12785 if (tem
== 0 || tem
== pt_old
)
12787 /* The glyphs from this string could have
12788 been reordered. Find the one with the
12789 smallest string position. Or there could
12790 be a character in the string with the
12791 `cursor' property, which means display
12792 cursor on that character's glyph. */
12793 int strpos
= glyph
->charpos
;
12796 for (glyph
+= incr
;
12797 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
12798 && EQ (glyph
->object
, str
);
12802 int gpos
= glyph
->charpos
;
12804 cprop
= Fget_char_property (make_number (gpos
),
12812 if (glyph
->charpos
< strpos
)
12814 strpos
= glyph
->charpos
;
12823 pos
= tem
+ 1; /* don't find previous instances */
12825 /* This string is not what we want; skip all of the
12826 glyphs that came from it. */
12829 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
12830 && EQ (glyph
->object
, str
));
12836 /* If we reached the end of the line, and END was from a string,
12837 the cursor is not on this line. */
12839 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
12840 && STRINGP (end
->object
)
12841 && row
->continued_p
)
12847 if (cursor
!= NULL
)
12853 /* Need to compute x that corresponds to GLYPH. */
12854 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
12856 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
12858 x
+= g
->pixel_width
;
12862 /* ROW could be part of a continued line, which, under bidi
12863 reordering, might have other rows whose start and end charpos
12864 occlude point. Only set w->cursor if we found a better
12865 approximation to the cursor position than we have from previously
12866 examined candidate rows belonging to the same continued line. */
12867 if (/* we already have a candidate row */
12868 w
->cursor
.vpos
>= 0
12869 /* that candidate is not the row we are processing */
12870 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
12871 /* the row we are processing is part of a continued line */
12872 && (row
->continued_p
|| MATRIX_ROW_CONTINUATION_LINE_P (row
))
12873 /* Make sure cursor.vpos specifies a row whose start and end
12874 charpos occlude point. This is because some callers of this
12875 function leave cursor.vpos at the row where the cursor was
12876 displayed during the last redisplay cycle. */
12877 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
12878 && pt_old
< MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
12881 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
12883 /* Don't consider glyphs that are outside TEXT_AREA. */
12884 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
12886 /* Keep the candidate whose buffer position is the closest to
12888 if (/* previous candidate is a glyph in TEXT_AREA of that row */
12889 w
->cursor
.hpos
>= 0
12890 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
12891 && BUFFERP (g1
->object
)
12892 && (g1
->charpos
== pt_old
/* an exact match always wins */
12893 || (BUFFERP (glyph
->object
)
12894 && eabs (g1
->charpos
- pt_old
)
12895 < eabs (glyph
->charpos
- pt_old
))))
12897 /* If this candidate gives an exact match, use that. */
12898 if (!(BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12899 /* Otherwise, keep the candidate that comes from a row
12900 spanning less buffer positions. This may win when one or
12901 both candidate positions are on glyphs that came from
12902 display strings, for which we cannot compare buffer
12904 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
12905 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
12906 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
12909 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
12911 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
12912 w
->cursor
.y
= row
->y
+ dy
;
12914 if (w
== XWINDOW (selected_window
))
12916 if (!row
->continued_p
12917 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
12920 this_line_buffer
= XBUFFER (w
->buffer
);
12922 CHARPOS (this_line_start_pos
)
12923 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
12924 BYTEPOS (this_line_start_pos
)
12925 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
12927 CHARPOS (this_line_end_pos
)
12928 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
12929 BYTEPOS (this_line_end_pos
)
12930 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
12932 this_line_y
= w
->cursor
.y
;
12933 this_line_pixel_height
= row
->height
;
12934 this_line_vpos
= w
->cursor
.vpos
;
12935 this_line_start_x
= row
->x
;
12938 CHARPOS (this_line_start_pos
) = 0;
12945 /* Run window scroll functions, if any, for WINDOW with new window
12946 start STARTP. Sets the window start of WINDOW to that position.
12948 We assume that the window's buffer is really current. */
12950 static INLINE
struct text_pos
12951 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
12953 struct window
*w
= XWINDOW (window
);
12954 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
12956 if (current_buffer
!= XBUFFER (w
->buffer
))
12959 if (!NILP (Vwindow_scroll_functions
))
12961 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
12962 make_number (CHARPOS (startp
)));
12963 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12964 /* In case the hook functions switch buffers. */
12965 if (current_buffer
!= XBUFFER (w
->buffer
))
12966 set_buffer_internal_1 (XBUFFER (w
->buffer
));
12973 /* Make sure the line containing the cursor is fully visible.
12974 A value of 1 means there is nothing to be done.
12975 (Either the line is fully visible, or it cannot be made so,
12976 or we cannot tell.)
12978 If FORCE_P is non-zero, return 0 even if partial visible cursor row
12979 is higher than window.
12981 A value of 0 means the caller should do scrolling
12982 as if point had gone off the screen. */
12985 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
12987 struct glyph_matrix
*matrix
;
12988 struct glyph_row
*row
;
12991 if (!make_cursor_line_fully_visible_p
)
12994 /* It's not always possible to find the cursor, e.g, when a window
12995 is full of overlay strings. Don't do anything in that case. */
12996 if (w
->cursor
.vpos
< 0)
12999 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
13000 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
13002 /* If the cursor row is not partially visible, there's nothing to do. */
13003 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
13006 /* If the row the cursor is in is taller than the window's height,
13007 it's not clear what to do, so do nothing. */
13008 window_height
= window_box_height (w
);
13009 if (row
->height
>= window_height
)
13011 if (!force_p
|| MINI_WINDOW_P (w
)
13012 || w
->vscroll
|| w
->cursor
.vpos
== 0)
13019 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
13020 non-zero means only WINDOW is redisplayed in redisplay_internal.
13021 TEMP_SCROLL_STEP has the same meaning as scroll_step, and is used
13022 in redisplay_window to bring a partially visible line into view in
13023 the case that only the cursor has moved.
13025 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
13026 last screen line's vertical height extends past the end of the screen.
13030 1 if scrolling succeeded
13032 0 if scrolling didn't find point.
13034 -1 if new fonts have been loaded so that we must interrupt
13035 redisplay, adjust glyph matrices, and try again. */
13041 SCROLLING_NEED_LARGER_MATRICES
13045 try_scrolling (Lisp_Object window
, int just_this_one_p
,
13046 EMACS_INT scroll_conservatively
, EMACS_INT scroll_step
,
13047 int temp_scroll_step
, int last_line_misfit
)
13049 struct window
*w
= XWINDOW (window
);
13050 struct frame
*f
= XFRAME (w
->frame
);
13051 struct text_pos pos
, startp
;
13053 int this_scroll_margin
, scroll_max
, rc
, height
;
13054 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
13055 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
13056 Lisp_Object aggressive
;
13057 int scroll_limit
= INT_MAX
/ FRAME_LINE_HEIGHT (f
);
13060 debug_method_add (w
, "try_scrolling");
13063 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13065 /* Compute scroll margin height in pixels. We scroll when point is
13066 within this distance from the top or bottom of the window. */
13067 if (scroll_margin
> 0)
13068 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
13069 * FRAME_LINE_HEIGHT (f
);
13071 this_scroll_margin
= 0;
13073 /* Force scroll_conservatively to have a reasonable value, to avoid
13074 overflow while computing how much to scroll. Note that the user
13075 can supply scroll-conservatively equal to `most-positive-fixnum',
13076 which can be larger than INT_MAX. */
13077 if (scroll_conservatively
> scroll_limit
)
13079 scroll_conservatively
= scroll_limit
;
13080 scroll_max
= INT_MAX
;
13082 else if (scroll_step
|| scroll_conservatively
|| temp_scroll_step
)
13083 /* Compute how much we should try to scroll maximally to bring
13084 point into view. */
13085 scroll_max
= (max (scroll_step
,
13086 max (scroll_conservatively
, temp_scroll_step
))
13087 * FRAME_LINE_HEIGHT (f
));
13088 else if (NUMBERP (current_buffer
->scroll_down_aggressively
)
13089 || NUMBERP (current_buffer
->scroll_up_aggressively
))
13090 /* We're trying to scroll because of aggressive scrolling but no
13091 scroll_step is set. Choose an arbitrary one. */
13092 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
13098 /* Decide whether to scroll down. */
13099 if (PT
> CHARPOS (startp
))
13101 int scroll_margin_y
;
13103 /* Compute the pixel ypos of the scroll margin, then move it to
13104 either that ypos or PT, whichever comes first. */
13105 start_display (&it
, w
, startp
);
13106 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
13107 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
13108 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
13109 (MOVE_TO_POS
| MOVE_TO_Y
));
13111 if (PT
> CHARPOS (it
.current
.pos
))
13113 int y0
= line_bottom_y (&it
);
13114 /* Compute how many pixels below window bottom to stop searching
13115 for PT. This avoids costly search for PT that is far away if
13116 the user limited scrolling by a small number of lines, but
13117 always finds PT if scroll_conservatively is set to a large
13118 number, such as most-positive-fixnum. */
13119 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
13121 slack
>= INT_MAX
- it
.last_visible_y
13123 : it
.last_visible_y
+ slack
;
13125 /* Compute the distance from the scroll margin to PT or to
13126 the scroll limit, whichever comes first. This should
13127 include the height of the cursor line, to make that line
13129 move_it_to (&it
, PT
, -1, y_to_move
,
13130 -1, MOVE_TO_POS
| MOVE_TO_Y
);
13131 dy
= line_bottom_y (&it
) - y0
;
13133 if (dy
> scroll_max
)
13134 return SCROLLING_FAILED
;
13142 /* Point is in or below the bottom scroll margin, so move the
13143 window start down. If scrolling conservatively, move it just
13144 enough down to make point visible. If scroll_step is set,
13145 move it down by scroll_step. */
13146 if (scroll_conservatively
)
13148 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
13149 FRAME_LINE_HEIGHT (f
) * scroll_conservatively
);
13150 else if (scroll_step
|| temp_scroll_step
)
13151 amount_to_scroll
= scroll_max
;
13154 aggressive
= current_buffer
->scroll_up_aggressively
;
13155 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13156 if (NUMBERP (aggressive
))
13158 double float_amount
= XFLOATINT (aggressive
) * height
;
13159 amount_to_scroll
= float_amount
;
13160 if (amount_to_scroll
== 0 && float_amount
> 0)
13161 amount_to_scroll
= 1;
13165 if (amount_to_scroll
<= 0)
13166 return SCROLLING_FAILED
;
13168 start_display (&it
, w
, startp
);
13169 if (scroll_max
< INT_MAX
)
13170 move_it_vertically (&it
, amount_to_scroll
);
13173 /* Extra precision for users who set scroll-conservatively
13174 to most-positive-fixnum: make sure the amount we scroll
13175 the window start is never less than amount_to_scroll,
13176 which was computed as distance from window bottom to
13177 point. This matters when lines at window top and lines
13178 below window bottom have different height. */
13179 struct it it1
= it
;
13180 /* We use a temporary it1 because line_bottom_y can modify
13181 its argument, if it moves one line down; see there. */
13182 int start_y
= line_bottom_y (&it1
);
13185 move_it_by_lines (&it
, 1, 1);
13187 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
13190 /* If STARTP is unchanged, move it down another screen line. */
13191 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
13192 move_it_by_lines (&it
, 1, 1);
13193 startp
= it
.current
.pos
;
13197 struct text_pos scroll_margin_pos
= startp
;
13199 /* See if point is inside the scroll margin at the top of the
13201 if (this_scroll_margin
)
13203 start_display (&it
, w
, startp
);
13204 move_it_vertically (&it
, this_scroll_margin
);
13205 scroll_margin_pos
= it
.current
.pos
;
13208 if (PT
< CHARPOS (scroll_margin_pos
))
13210 /* Point is in the scroll margin at the top of the window or
13211 above what is displayed in the window. */
13214 /* Compute the vertical distance from PT to the scroll
13215 margin position. Give up if distance is greater than
13217 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
13218 start_display (&it
, w
, pos
);
13220 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
13221 it
.last_visible_y
, -1,
13222 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13223 dy
= it
.current_y
- y0
;
13224 if (dy
> scroll_max
)
13225 return SCROLLING_FAILED
;
13227 /* Compute new window start. */
13228 start_display (&it
, w
, startp
);
13230 if (scroll_conservatively
)
13232 = max (dy
, FRAME_LINE_HEIGHT (f
) * max (scroll_step
, temp_scroll_step
));
13233 else if (scroll_step
|| temp_scroll_step
)
13234 amount_to_scroll
= scroll_max
;
13237 aggressive
= current_buffer
->scroll_down_aggressively
;
13238 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13239 if (NUMBERP (aggressive
))
13241 double float_amount
= XFLOATINT (aggressive
) * height
;
13242 amount_to_scroll
= float_amount
;
13243 if (amount_to_scroll
== 0 && float_amount
> 0)
13244 amount_to_scroll
= 1;
13248 if (amount_to_scroll
<= 0)
13249 return SCROLLING_FAILED
;
13251 move_it_vertically_backward (&it
, amount_to_scroll
);
13252 startp
= it
.current
.pos
;
13256 /* Run window scroll functions. */
13257 startp
= run_window_scroll_functions (window
, startp
);
13259 /* Display the window. Give up if new fonts are loaded, or if point
13261 if (!try_window (window
, startp
, 0))
13262 rc
= SCROLLING_NEED_LARGER_MATRICES
;
13263 else if (w
->cursor
.vpos
< 0)
13265 clear_glyph_matrix (w
->desired_matrix
);
13266 rc
= SCROLLING_FAILED
;
13270 /* Maybe forget recorded base line for line number display. */
13271 if (!just_this_one_p
13272 || current_buffer
->clip_changed
13273 || BEG_UNCHANGED
< CHARPOS (startp
))
13274 w
->base_line_number
= Qnil
;
13276 /* If cursor ends up on a partially visible line,
13277 treat that as being off the bottom of the screen. */
13278 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0))
13280 clear_glyph_matrix (w
->desired_matrix
);
13281 ++extra_scroll_margin_lines
;
13284 rc
= SCROLLING_SUCCESS
;
13291 /* Compute a suitable window start for window W if display of W starts
13292 on a continuation line. Value is non-zero if a new window start
13295 The new window start will be computed, based on W's width, starting
13296 from the start of the continued line. It is the start of the
13297 screen line with the minimum distance from the old start W->start. */
13300 compute_window_start_on_continuation_line (struct window
*w
)
13302 struct text_pos pos
, start_pos
;
13303 int window_start_changed_p
= 0;
13305 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
13307 /* If window start is on a continuation line... Window start may be
13308 < BEGV in case there's invisible text at the start of the
13309 buffer (M-x rmail, for example). */
13310 if (CHARPOS (start_pos
) > BEGV
13311 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
13314 struct glyph_row
*row
;
13316 /* Handle the case that the window start is out of range. */
13317 if (CHARPOS (start_pos
) < BEGV
)
13318 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
13319 else if (CHARPOS (start_pos
) > ZV
)
13320 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
13322 /* Find the start of the continued line. This should be fast
13323 because scan_buffer is fast (newline cache). */
13324 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
13325 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
13326 row
, DEFAULT_FACE_ID
);
13327 reseat_at_previous_visible_line_start (&it
);
13329 /* If the line start is "too far" away from the window start,
13330 say it takes too much time to compute a new window start. */
13331 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
13332 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
13334 int min_distance
, distance
;
13336 /* Move forward by display lines to find the new window
13337 start. If window width was enlarged, the new start can
13338 be expected to be > the old start. If window width was
13339 decreased, the new window start will be < the old start.
13340 So, we're looking for the display line start with the
13341 minimum distance from the old window start. */
13342 pos
= it
.current
.pos
;
13343 min_distance
= INFINITY
;
13344 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
13345 distance
< min_distance
)
13347 min_distance
= distance
;
13348 pos
= it
.current
.pos
;
13349 move_it_by_lines (&it
, 1, 0);
13352 /* Set the window start there. */
13353 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
13354 window_start_changed_p
= 1;
13358 return window_start_changed_p
;
13362 /* Try cursor movement in case text has not changed in window WINDOW,
13363 with window start STARTP. Value is
13365 CURSOR_MOVEMENT_SUCCESS if successful
13367 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
13369 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
13370 display. *SCROLL_STEP is set to 1, under certain circumstances, if
13371 we want to scroll as if scroll-step were set to 1. See the code.
13373 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
13374 which case we have to abort this redisplay, and adjust matrices
13379 CURSOR_MOVEMENT_SUCCESS
,
13380 CURSOR_MOVEMENT_CANNOT_BE_USED
,
13381 CURSOR_MOVEMENT_MUST_SCROLL
,
13382 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
13386 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
13388 struct window
*w
= XWINDOW (window
);
13389 struct frame
*f
= XFRAME (w
->frame
);
13390 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
13393 if (inhibit_try_cursor_movement
)
13397 /* Handle case where text has not changed, only point, and it has
13398 not moved off the frame. */
13399 if (/* Point may be in this window. */
13400 PT
>= CHARPOS (startp
)
13401 /* Selective display hasn't changed. */
13402 && !current_buffer
->clip_changed
13403 /* Function force-mode-line-update is used to force a thorough
13404 redisplay. It sets either windows_or_buffers_changed or
13405 update_mode_lines. So don't take a shortcut here for these
13407 && !update_mode_lines
13408 && !windows_or_buffers_changed
13409 && !cursor_type_changed
13410 /* Can't use this case if highlighting a region. When a
13411 region exists, cursor movement has to do more than just
13413 && !(!NILP (Vtransient_mark_mode
)
13414 && !NILP (current_buffer
->mark_active
))
13415 && NILP (w
->region_showing
)
13416 && NILP (Vshow_trailing_whitespace
)
13417 /* Right after splitting windows, last_point may be nil. */
13418 && INTEGERP (w
->last_point
)
13419 /* This code is not used for mini-buffer for the sake of the case
13420 of redisplaying to replace an echo area message; since in
13421 that case the mini-buffer contents per se are usually
13422 unchanged. This code is of no real use in the mini-buffer
13423 since the handling of this_line_start_pos, etc., in redisplay
13424 handles the same cases. */
13425 && !EQ (window
, minibuf_window
)
13426 /* When splitting windows or for new windows, it happens that
13427 redisplay is called with a nil window_end_vpos or one being
13428 larger than the window. This should really be fixed in
13429 window.c. I don't have this on my list, now, so we do
13430 approximately the same as the old redisplay code. --gerd. */
13431 && INTEGERP (w
->window_end_vpos
)
13432 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
13433 && (FRAME_WINDOW_P (f
)
13434 || !overlay_arrow_in_current_buffer_p ()))
13436 int this_scroll_margin
, top_scroll_margin
;
13437 struct glyph_row
*row
= NULL
;
13440 debug_method_add (w
, "cursor movement");
13443 /* Scroll if point within this distance from the top or bottom
13444 of the window. This is a pixel value. */
13445 if (scroll_margin
> 0)
13447 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
13448 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
13451 this_scroll_margin
= 0;
13453 top_scroll_margin
= this_scroll_margin
;
13454 if (WINDOW_WANTS_HEADER_LINE_P (w
))
13455 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
13457 /* Start with the row the cursor was displayed during the last
13458 not paused redisplay. Give up if that row is not valid. */
13459 if (w
->last_cursor
.vpos
< 0
13460 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
13461 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13464 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
13465 if (row
->mode_line_p
)
13467 if (!row
->enabled_p
)
13468 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13471 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
13473 int scroll_p
= 0, must_scroll
= 0;
13474 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
13476 if (PT
> XFASTINT (w
->last_point
))
13478 /* Point has moved forward. */
13479 while (MATRIX_ROW_END_CHARPOS (row
) < PT
13480 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
13482 xassert (row
->enabled_p
);
13486 /* If the end position of a row equals the start
13487 position of the next row, and PT is at that position,
13488 we would rather display cursor in the next line. */
13489 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13490 && MATRIX_ROW_END_CHARPOS (row
) == PT
13491 && row
< w
->current_matrix
->rows
13492 + w
->current_matrix
->nrows
- 1
13493 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
13494 && !cursor_row_p (w
, row
))
13497 /* If within the scroll margin, scroll. Note that
13498 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
13499 the next line would be drawn, and that
13500 this_scroll_margin can be zero. */
13501 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
13502 || PT
> MATRIX_ROW_END_CHARPOS (row
)
13503 /* Line is completely visible last line in window
13504 and PT is to be set in the next line. */
13505 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
13506 && PT
== MATRIX_ROW_END_CHARPOS (row
)
13507 && !row
->ends_at_zv_p
13508 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
13511 else if (PT
< XFASTINT (w
->last_point
))
13513 /* Cursor has to be moved backward. Note that PT >=
13514 CHARPOS (startp) because of the outer if-statement. */
13515 while (!row
->mode_line_p
13516 && (MATRIX_ROW_START_CHARPOS (row
) > PT
13517 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13518 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
13519 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
13520 row
> w
->current_matrix
->rows
13521 && (row
-1)->ends_in_newline_from_string_p
))))
13522 && (row
->y
> top_scroll_margin
13523 || CHARPOS (startp
) == BEGV
))
13525 xassert (row
->enabled_p
);
13529 /* Consider the following case: Window starts at BEGV,
13530 there is invisible, intangible text at BEGV, so that
13531 display starts at some point START > BEGV. It can
13532 happen that we are called with PT somewhere between
13533 BEGV and START. Try to handle that case. */
13534 if (row
< w
->current_matrix
->rows
13535 || row
->mode_line_p
)
13537 row
= w
->current_matrix
->rows
;
13538 if (row
->mode_line_p
)
13542 /* Due to newlines in overlay strings, we may have to
13543 skip forward over overlay strings. */
13544 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13545 && MATRIX_ROW_END_CHARPOS (row
) == PT
13546 && !cursor_row_p (w
, row
))
13549 /* If within the scroll margin, scroll. */
13550 if (row
->y
< top_scroll_margin
13551 && CHARPOS (startp
) != BEGV
)
13556 /* Cursor did not move. So don't scroll even if cursor line
13557 is partially visible, as it was so before. */
13558 rc
= CURSOR_MOVEMENT_SUCCESS
;
13561 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
13562 || PT
> MATRIX_ROW_END_CHARPOS (row
))
13564 /* if PT is not in the glyph row, give up. */
13565 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13568 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13569 && !NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
13571 /* If rows are bidi-reordered and point moved, back up
13572 until we find a row that does not belong to a
13573 continuation line. This is because we must consider
13574 all rows of a continued line as candidates for the
13575 new cursor positioning, since row start and end
13576 positions change non-linearly with vertical position
13578 /* FIXME: Revisit this when glyph ``spilling'' in
13579 continuation lines' rows is implemented for
13580 bidi-reordered rows. */
13581 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
13583 xassert (row
->enabled_p
);
13585 /* If we hit the beginning of the displayed portion
13586 without finding the first row of a continued
13588 if (row
<= w
->current_matrix
->rows
)
13590 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13598 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13599 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
13600 && make_cursor_line_fully_visible_p
)
13602 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
13603 && !row
->ends_at_zv_p
13604 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
13605 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13606 else if (row
->height
> window_box_height (w
))
13608 /* If we end up in a partially visible line, let's
13609 make it fully visible, except when it's taller
13610 than the window, in which case we can't do much
13613 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13617 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13618 if (!cursor_row_fully_visible_p (w
, 0, 1))
13619 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13621 rc
= CURSOR_MOVEMENT_SUCCESS
;
13625 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13626 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13627 && !NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
13629 /* With bidi-reordered rows, there could be more than
13630 one candidate row whose start and end positions
13631 occlude point. We need to let set_cursor_from_row
13632 find the best candidate. */
13633 /* FIXME: Revisit this when glyph ``spilling'' in
13634 continuation lines' rows is implemented for
13635 bidi-reordered rows. */
13640 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
13641 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
13642 && cursor_row_p (w
, row
))
13643 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
13645 /* As soon as we've found the first suitable row
13646 whose ends_at_zv_p flag is set, we are done. */
13648 && MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
)
13650 rc
= CURSOR_MOVEMENT_SUCCESS
;
13655 while ((MATRIX_ROW_CONTINUATION_LINE_P (row
)
13656 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
13657 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13658 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
13659 /* If we didn't find any candidate rows, or exited the
13660 loop before all the candidates were examined, signal
13661 to the caller that this method failed. */
13662 if (rc
!= CURSOR_MOVEMENT_SUCCESS
13663 && (!rv
|| MATRIX_ROW_CONTINUATION_LINE_P (row
)))
13664 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13666 rc
= CURSOR_MOVEMENT_SUCCESS
;
13672 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
13674 rc
= CURSOR_MOVEMENT_SUCCESS
;
13679 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13680 && MATRIX_ROW_START_CHARPOS (row
) == PT
13681 && cursor_row_p (w
, row
));
13690 set_vertical_scroll_bar (struct window
*w
)
13692 int start
, end
, whole
;
13694 /* Calculate the start and end positions for the current window.
13695 At some point, it would be nice to choose between scrollbars
13696 which reflect the whole buffer size, with special markers
13697 indicating narrowing, and scrollbars which reflect only the
13700 Note that mini-buffers sometimes aren't displaying any text. */
13701 if (!MINI_WINDOW_P (w
)
13702 || (w
== XWINDOW (minibuf_window
)
13703 && NILP (echo_area_buffer
[0])))
13705 struct buffer
*buf
= XBUFFER (w
->buffer
);
13706 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
13707 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
13708 /* I don't think this is guaranteed to be right. For the
13709 moment, we'll pretend it is. */
13710 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
13714 if (whole
< (end
- start
))
13715 whole
= end
- start
;
13718 start
= end
= whole
= 0;
13720 /* Indicate what this scroll bar ought to be displaying now. */
13721 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13722 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13723 (w
, end
- start
, whole
, start
);
13727 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
13728 selected_window is redisplayed.
13730 We can return without actually redisplaying the window if
13731 fonts_changed_p is nonzero. In that case, redisplay_internal will
13735 redisplay_window (Lisp_Object window
, int just_this_one_p
)
13737 struct window
*w
= XWINDOW (window
);
13738 struct frame
*f
= XFRAME (w
->frame
);
13739 struct buffer
*buffer
= XBUFFER (w
->buffer
);
13740 struct buffer
*old
= current_buffer
;
13741 struct text_pos lpoint
, opoint
, startp
;
13742 int update_mode_line
;
13745 /* Record it now because it's overwritten. */
13746 int current_matrix_up_to_date_p
= 0;
13747 int used_current_matrix_p
= 0;
13748 /* This is less strict than current_matrix_up_to_date_p.
13749 It indictes that the buffer contents and narrowing are unchanged. */
13750 int buffer_unchanged_p
= 0;
13751 int temp_scroll_step
= 0;
13752 int count
= SPECPDL_INDEX ();
13754 int centering_position
= -1;
13755 int last_line_misfit
= 0;
13756 int beg_unchanged
, end_unchanged
;
13758 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13761 /* W must be a leaf window here. */
13762 xassert (!NILP (w
->buffer
));
13764 *w
->desired_matrix
->method
= 0;
13768 reconsider_clip_changes (w
, buffer
);
13770 /* Has the mode line to be updated? */
13771 update_mode_line
= (!NILP (w
->update_mode_line
)
13772 || update_mode_lines
13773 || buffer
->clip_changed
13774 || buffer
->prevent_redisplay_optimizations_p
);
13776 if (MINI_WINDOW_P (w
))
13778 if (w
== XWINDOW (echo_area_window
)
13779 && !NILP (echo_area_buffer
[0]))
13781 if (update_mode_line
)
13782 /* We may have to update a tty frame's menu bar or a
13783 tool-bar. Example `M-x C-h C-h C-g'. */
13784 goto finish_menu_bars
;
13786 /* We've already displayed the echo area glyphs in this window. */
13787 goto finish_scroll_bars
;
13789 else if ((w
!= XWINDOW (minibuf_window
)
13790 || minibuf_level
== 0)
13791 /* When buffer is nonempty, redisplay window normally. */
13792 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
13793 /* Quail displays non-mini buffers in minibuffer window.
13794 In that case, redisplay the window normally. */
13795 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
13797 /* W is a mini-buffer window, but it's not active, so clear
13799 int yb
= window_text_bottom_y (w
);
13800 struct glyph_row
*row
;
13803 for (y
= 0, row
= w
->desired_matrix
->rows
;
13805 y
+= row
->height
, ++row
)
13806 blank_row (w
, row
, y
);
13807 goto finish_scroll_bars
;
13810 clear_glyph_matrix (w
->desired_matrix
);
13813 /* Otherwise set up data on this window; select its buffer and point
13815 /* Really select the buffer, for the sake of buffer-local
13817 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13819 current_matrix_up_to_date_p
13820 = (!NILP (w
->window_end_valid
)
13821 && !current_buffer
->clip_changed
13822 && !current_buffer
->prevent_redisplay_optimizations_p
13823 && XFASTINT (w
->last_modified
) >= MODIFF
13824 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13826 /* Run the window-bottom-change-functions
13827 if it is possible that the text on the screen has changed
13828 (either due to modification of the text, or any other reason). */
13829 if (!current_matrix_up_to_date_p
13830 && !NILP (Vwindow_text_change_functions
))
13832 safe_run_hooks (Qwindow_text_change_functions
);
13836 beg_unchanged
= BEG_UNCHANGED
;
13837 end_unchanged
= END_UNCHANGED
;
13839 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
13841 specbind (Qinhibit_point_motion_hooks
, Qt
);
13844 = (!NILP (w
->window_end_valid
)
13845 && !current_buffer
->clip_changed
13846 && XFASTINT (w
->last_modified
) >= MODIFF
13847 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13849 /* When windows_or_buffers_changed is non-zero, we can't rely on
13850 the window end being valid, so set it to nil there. */
13851 if (windows_or_buffers_changed
)
13853 /* If window starts on a continuation line, maybe adjust the
13854 window start in case the window's width changed. */
13855 if (XMARKER (w
->start
)->buffer
== current_buffer
)
13856 compute_window_start_on_continuation_line (w
);
13858 w
->window_end_valid
= Qnil
;
13861 /* Some sanity checks. */
13862 CHECK_WINDOW_END (w
);
13863 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
13865 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
13868 /* If %c is in mode line, update it if needed. */
13869 if (!NILP (w
->column_number_displayed
)
13870 /* This alternative quickly identifies a common case
13871 where no change is needed. */
13872 && !(PT
== XFASTINT (w
->last_point
)
13873 && XFASTINT (w
->last_modified
) >= MODIFF
13874 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
13875 && (XFASTINT (w
->column_number_displayed
)
13876 != (int) current_column ())) /* iftc */
13877 update_mode_line
= 1;
13879 /* Count number of windows showing the selected buffer. An indirect
13880 buffer counts as its base buffer. */
13881 if (!just_this_one_p
)
13883 struct buffer
*current_base
, *window_base
;
13884 current_base
= current_buffer
;
13885 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13886 if (current_base
->base_buffer
)
13887 current_base
= current_base
->base_buffer
;
13888 if (window_base
->base_buffer
)
13889 window_base
= window_base
->base_buffer
;
13890 if (current_base
== window_base
)
13894 /* Point refers normally to the selected window. For any other
13895 window, set up appropriate value. */
13896 if (!EQ (window
, selected_window
))
13898 int new_pt
= XMARKER (w
->pointm
)->charpos
;
13899 int new_pt_byte
= marker_byte_position (w
->pointm
);
13903 new_pt_byte
= BEGV_BYTE
;
13904 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
13906 else if (new_pt
> (ZV
- 1))
13909 new_pt_byte
= ZV_BYTE
;
13910 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
13913 /* We don't use SET_PT so that the point-motion hooks don't run. */
13914 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
13917 /* If any of the character widths specified in the display table
13918 have changed, invalidate the width run cache. It's true that
13919 this may be a bit late to catch such changes, but the rest of
13920 redisplay goes (non-fatally) haywire when the display table is
13921 changed, so why should we worry about doing any better? */
13922 if (current_buffer
->width_run_cache
)
13924 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
13926 if (! disptab_matches_widthtab (disptab
,
13927 XVECTOR (current_buffer
->width_table
)))
13929 invalidate_region_cache (current_buffer
,
13930 current_buffer
->width_run_cache
,
13932 recompute_width_table (current_buffer
, disptab
);
13936 /* If window-start is screwed up, choose a new one. */
13937 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
13940 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13942 /* If someone specified a new starting point but did not insist,
13943 check whether it can be used. */
13944 if (!NILP (w
->optional_new_start
)
13945 && CHARPOS (startp
) >= BEGV
13946 && CHARPOS (startp
) <= ZV
)
13948 w
->optional_new_start
= Qnil
;
13949 start_display (&it
, w
, startp
);
13950 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
13951 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13952 if (IT_CHARPOS (it
) == PT
)
13953 w
->force_start
= Qt
;
13954 /* IT may overshoot PT if text at PT is invisible. */
13955 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
13956 w
->force_start
= Qt
;
13961 /* Handle case where place to start displaying has been specified,
13962 unless the specified location is outside the accessible range. */
13963 if (!NILP (w
->force_start
)
13964 || w
->frozen_window_start_p
)
13966 /* We set this later on if we have to adjust point. */
13969 w
->force_start
= Qnil
;
13971 w
->window_end_valid
= Qnil
;
13973 /* Forget any recorded base line for line number display. */
13974 if (!buffer_unchanged_p
)
13975 w
->base_line_number
= Qnil
;
13977 /* Redisplay the mode line. Select the buffer properly for that.
13978 Also, run the hook window-scroll-functions
13979 because we have scrolled. */
13980 /* Note, we do this after clearing force_start because
13981 if there's an error, it is better to forget about force_start
13982 than to get into an infinite loop calling the hook functions
13983 and having them get more errors. */
13984 if (!update_mode_line
13985 || ! NILP (Vwindow_scroll_functions
))
13987 update_mode_line
= 1;
13988 w
->update_mode_line
= Qt
;
13989 startp
= run_window_scroll_functions (window
, startp
);
13992 w
->last_modified
= make_number (0);
13993 w
->last_overlay_modified
= make_number (0);
13994 if (CHARPOS (startp
) < BEGV
)
13995 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
13996 else if (CHARPOS (startp
) > ZV
)
13997 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
13999 /* Redisplay, then check if cursor has been set during the
14000 redisplay. Give up if new fonts were loaded. */
14001 /* We used to issue a CHECK_MARGINS argument to try_window here,
14002 but this causes scrolling to fail when point begins inside
14003 the scroll margin (bug#148) -- cyd */
14004 if (!try_window (window
, startp
, 0))
14006 w
->force_start
= Qt
;
14007 clear_glyph_matrix (w
->desired_matrix
);
14008 goto need_larger_matrices
;
14011 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
14013 /* If point does not appear, try to move point so it does
14014 appear. The desired matrix has been built above, so we
14015 can use it here. */
14016 new_vpos
= window_box_height (w
) / 2;
14019 if (!cursor_row_fully_visible_p (w
, 0, 0))
14021 /* Point does appear, but on a line partly visible at end of window.
14022 Move it back to a fully-visible line. */
14023 new_vpos
= window_box_height (w
);
14026 /* If we need to move point for either of the above reasons,
14027 now actually do it. */
14030 struct glyph_row
*row
;
14032 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
14033 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
14036 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
14037 MATRIX_ROW_START_BYTEPOS (row
));
14039 if (w
!= XWINDOW (selected_window
))
14040 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
14041 else if (current_buffer
== old
)
14042 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
14044 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
14046 /* If we are highlighting the region, then we just changed
14047 the region, so redisplay to show it. */
14048 if (!NILP (Vtransient_mark_mode
)
14049 && !NILP (current_buffer
->mark_active
))
14051 clear_glyph_matrix (w
->desired_matrix
);
14052 if (!try_window (window
, startp
, 0))
14053 goto need_larger_matrices
;
14058 debug_method_add (w
, "forced window start");
14063 /* Handle case where text has not changed, only point, and it has
14064 not moved off the frame, and we are not retrying after hscroll.
14065 (current_matrix_up_to_date_p is nonzero when retrying.) */
14066 if (current_matrix_up_to_date_p
14067 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
14068 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
14072 case CURSOR_MOVEMENT_SUCCESS
:
14073 used_current_matrix_p
= 1;
14076 case CURSOR_MOVEMENT_MUST_SCROLL
:
14077 goto try_to_scroll
;
14083 /* If current starting point was originally the beginning of a line
14084 but no longer is, find a new starting point. */
14085 else if (!NILP (w
->start_at_line_beg
)
14086 && !(CHARPOS (startp
) <= BEGV
14087 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
14090 debug_method_add (w
, "recenter 1");
14095 /* Try scrolling with try_window_id. Value is > 0 if update has
14096 been done, it is -1 if we know that the same window start will
14097 not work. It is 0 if unsuccessful for some other reason. */
14098 else if ((tem
= try_window_id (w
)) != 0)
14101 debug_method_add (w
, "try_window_id %d", tem
);
14104 if (fonts_changed_p
)
14105 goto need_larger_matrices
;
14109 /* Otherwise try_window_id has returned -1 which means that we
14110 don't want the alternative below this comment to execute. */
14112 else if (CHARPOS (startp
) >= BEGV
14113 && CHARPOS (startp
) <= ZV
14114 && PT
>= CHARPOS (startp
)
14115 && (CHARPOS (startp
) < ZV
14116 /* Avoid starting at end of buffer. */
14117 || CHARPOS (startp
) == BEGV
14118 || (XFASTINT (w
->last_modified
) >= MODIFF
14119 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
14122 /* If first window line is a continuation line, and window start
14123 is inside the modified region, but the first change is before
14124 current window start, we must select a new window start.
14126 However, if this is the result of a down-mouse event (e.g. by
14127 extending the mouse-drag-overlay), we don't want to select a
14128 new window start, since that would change the position under
14129 the mouse, resulting in an unwanted mouse-movement rather
14130 than a simple mouse-click. */
14131 if (NILP (w
->start_at_line_beg
)
14132 && NILP (do_mouse_tracking
)
14133 && CHARPOS (startp
) > BEGV
14134 && CHARPOS (startp
) > BEG
+ beg_unchanged
14135 && CHARPOS (startp
) <= Z
- end_unchanged
14136 /* Even if w->start_at_line_beg is nil, a new window may
14137 start at a line_beg, since that's how set_buffer_window
14138 sets it. So, we need to check the return value of
14139 compute_window_start_on_continuation_line. (See also
14141 && XMARKER (w
->start
)->buffer
== current_buffer
14142 && compute_window_start_on_continuation_line (w
))
14144 w
->force_start
= Qt
;
14145 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14150 debug_method_add (w
, "same window start");
14153 /* Try to redisplay starting at same place as before.
14154 If point has not moved off frame, accept the results. */
14155 if (!current_matrix_up_to_date_p
14156 /* Don't use try_window_reusing_current_matrix in this case
14157 because a window scroll function can have changed the
14159 || !NILP (Vwindow_scroll_functions
)
14160 || MINI_WINDOW_P (w
)
14161 || !(used_current_matrix_p
14162 = try_window_reusing_current_matrix (w
)))
14164 IF_DEBUG (debug_method_add (w
, "1"));
14165 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
14166 /* -1 means we need to scroll.
14167 0 means we need new matrices, but fonts_changed_p
14168 is set in that case, so we will detect it below. */
14169 goto try_to_scroll
;
14172 if (fonts_changed_p
)
14173 goto need_larger_matrices
;
14175 if (w
->cursor
.vpos
>= 0)
14177 if (!just_this_one_p
14178 || current_buffer
->clip_changed
14179 || BEG_UNCHANGED
< CHARPOS (startp
))
14180 /* Forget any recorded base line for line number display. */
14181 w
->base_line_number
= Qnil
;
14183 if (!cursor_row_fully_visible_p (w
, 1, 0))
14185 clear_glyph_matrix (w
->desired_matrix
);
14186 last_line_misfit
= 1;
14188 /* Drop through and scroll. */
14193 clear_glyph_matrix (w
->desired_matrix
);
14198 w
->last_modified
= make_number (0);
14199 w
->last_overlay_modified
= make_number (0);
14201 /* Redisplay the mode line. Select the buffer properly for that. */
14202 if (!update_mode_line
)
14204 update_mode_line
= 1;
14205 w
->update_mode_line
= Qt
;
14208 /* Try to scroll by specified few lines. */
14209 if ((scroll_conservatively
14211 || temp_scroll_step
14212 || NUMBERP (current_buffer
->scroll_up_aggressively
)
14213 || NUMBERP (current_buffer
->scroll_down_aggressively
))
14214 && !current_buffer
->clip_changed
14215 && CHARPOS (startp
) >= BEGV
14216 && CHARPOS (startp
) <= ZV
)
14218 /* The function returns -1 if new fonts were loaded, 1 if
14219 successful, 0 if not successful. */
14220 int rc
= try_scrolling (window
, just_this_one_p
,
14221 scroll_conservatively
,
14223 temp_scroll_step
, last_line_misfit
);
14226 case SCROLLING_SUCCESS
:
14229 case SCROLLING_NEED_LARGER_MATRICES
:
14230 goto need_larger_matrices
;
14232 case SCROLLING_FAILED
:
14240 /* Finally, just choose place to start which centers point */
14243 if (centering_position
< 0)
14244 centering_position
= window_box_height (w
) / 2;
14247 debug_method_add (w
, "recenter");
14250 /* w->vscroll = 0; */
14252 /* Forget any previously recorded base line for line number display. */
14253 if (!buffer_unchanged_p
)
14254 w
->base_line_number
= Qnil
;
14256 /* Move backward half the height of the window. */
14257 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14258 it
.current_y
= it
.last_visible_y
;
14259 move_it_vertically_backward (&it
, centering_position
);
14260 xassert (IT_CHARPOS (it
) >= BEGV
);
14262 /* The function move_it_vertically_backward may move over more
14263 than the specified y-distance. If it->w is small, e.g. a
14264 mini-buffer window, we may end up in front of the window's
14265 display area. Start displaying at the start of the line
14266 containing PT in this case. */
14267 if (it
.current_y
<= 0)
14269 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14270 move_it_vertically_backward (&it
, 0);
14274 it
.current_x
= it
.hpos
= 0;
14276 /* Set startp here explicitly in case that helps avoid an infinite loop
14277 in case the window-scroll-functions functions get errors. */
14278 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
14280 /* Run scroll hooks. */
14281 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
14283 /* Redisplay the window. */
14284 if (!current_matrix_up_to_date_p
14285 || windows_or_buffers_changed
14286 || cursor_type_changed
14287 /* Don't use try_window_reusing_current_matrix in this case
14288 because it can have changed the buffer. */
14289 || !NILP (Vwindow_scroll_functions
)
14290 || !just_this_one_p
14291 || MINI_WINDOW_P (w
)
14292 || !(used_current_matrix_p
14293 = try_window_reusing_current_matrix (w
)))
14294 try_window (window
, startp
, 0);
14296 /* If new fonts have been loaded (due to fontsets), give up. We
14297 have to start a new redisplay since we need to re-adjust glyph
14299 if (fonts_changed_p
)
14300 goto need_larger_matrices
;
14302 /* If cursor did not appear assume that the middle of the window is
14303 in the first line of the window. Do it again with the next line.
14304 (Imagine a window of height 100, displaying two lines of height
14305 60. Moving back 50 from it->last_visible_y will end in the first
14307 if (w
->cursor
.vpos
< 0)
14309 if (!NILP (w
->window_end_valid
)
14310 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
14312 clear_glyph_matrix (w
->desired_matrix
);
14313 move_it_by_lines (&it
, 1, 0);
14314 try_window (window
, it
.current
.pos
, 0);
14316 else if (PT
< IT_CHARPOS (it
))
14318 clear_glyph_matrix (w
->desired_matrix
);
14319 move_it_by_lines (&it
, -1, 0);
14320 try_window (window
, it
.current
.pos
, 0);
14324 /* Not much we can do about it. */
14328 /* Consider the following case: Window starts at BEGV, there is
14329 invisible, intangible text at BEGV, so that display starts at
14330 some point START > BEGV. It can happen that we are called with
14331 PT somewhere between BEGV and START. Try to handle that case. */
14332 if (w
->cursor
.vpos
< 0)
14334 struct glyph_row
*row
= w
->current_matrix
->rows
;
14335 if (row
->mode_line_p
)
14337 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14340 if (!cursor_row_fully_visible_p (w
, 0, 0))
14342 /* If vscroll is enabled, disable it and try again. */
14346 clear_glyph_matrix (w
->desired_matrix
);
14350 /* If centering point failed to make the whole line visible,
14351 put point at the top instead. That has to make the whole line
14352 visible, if it can be done. */
14353 if (centering_position
== 0)
14356 clear_glyph_matrix (w
->desired_matrix
);
14357 centering_position
= 0;
14363 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14364 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
14365 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
14368 /* Display the mode line, if we must. */
14369 if ((update_mode_line
14370 /* If window not full width, must redo its mode line
14371 if (a) the window to its side is being redone and
14372 (b) we do a frame-based redisplay. This is a consequence
14373 of how inverted lines are drawn in frame-based redisplay. */
14374 || (!just_this_one_p
14375 && !FRAME_WINDOW_P (f
)
14376 && !WINDOW_FULL_WIDTH_P (w
))
14377 /* Line number to display. */
14378 || INTEGERP (w
->base_line_pos
)
14379 /* Column number is displayed and different from the one displayed. */
14380 || (!NILP (w
->column_number_displayed
)
14381 && (XFASTINT (w
->column_number_displayed
)
14382 != (int) current_column ()))) /* iftc */
14383 /* This means that the window has a mode line. */
14384 && (WINDOW_WANTS_MODELINE_P (w
)
14385 || WINDOW_WANTS_HEADER_LINE_P (w
)))
14387 display_mode_lines (w
);
14389 /* If mode line height has changed, arrange for a thorough
14390 immediate redisplay using the correct mode line height. */
14391 if (WINDOW_WANTS_MODELINE_P (w
)
14392 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
14394 fonts_changed_p
= 1;
14395 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
14396 = DESIRED_MODE_LINE_HEIGHT (w
);
14399 /* If header line height has changed, arrange for a thorough
14400 immediate redisplay using the correct header line height. */
14401 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14402 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
14404 fonts_changed_p
= 1;
14405 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
14406 = DESIRED_HEADER_LINE_HEIGHT (w
);
14409 if (fonts_changed_p
)
14410 goto need_larger_matrices
;
14413 if (!line_number_displayed
14414 && !BUFFERP (w
->base_line_pos
))
14416 w
->base_line_pos
= Qnil
;
14417 w
->base_line_number
= Qnil
;
14422 /* When we reach a frame's selected window, redo the frame's menu bar. */
14423 if (update_mode_line
14424 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
14426 int redisplay_menu_p
= 0;
14427 int redisplay_tool_bar_p
= 0;
14429 if (FRAME_WINDOW_P (f
))
14431 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
14432 || defined (HAVE_NS) || defined (USE_GTK)
14433 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
14435 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14439 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14441 if (redisplay_menu_p
)
14442 display_menu_bar (w
);
14444 #ifdef HAVE_WINDOW_SYSTEM
14445 if (FRAME_WINDOW_P (f
))
14447 #if defined (USE_GTK) || defined (HAVE_NS)
14448 redisplay_tool_bar_p
= FRAME_EXTERNAL_TOOL_BAR (f
);
14450 redisplay_tool_bar_p
= WINDOWP (f
->tool_bar_window
)
14451 && (FRAME_TOOL_BAR_LINES (f
) > 0
14452 || !NILP (Vauto_resize_tool_bars
));
14455 if (redisplay_tool_bar_p
&& redisplay_tool_bar (f
))
14457 ignore_mouse_drag_p
= 1;
14463 #ifdef HAVE_WINDOW_SYSTEM
14464 if (FRAME_WINDOW_P (f
)
14465 && update_window_fringes (w
, (just_this_one_p
14466 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
14467 || w
->pseudo_window_p
)))
14471 if (draw_window_fringes (w
, 1))
14472 x_draw_vertical_border (w
);
14476 #endif /* HAVE_WINDOW_SYSTEM */
14478 /* We go to this label, with fonts_changed_p nonzero,
14479 if it is necessary to try again using larger glyph matrices.
14480 We have to redeem the scroll bar even in this case,
14481 because the loop in redisplay_internal expects that. */
14482 need_larger_matrices
:
14484 finish_scroll_bars
:
14486 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
14488 /* Set the thumb's position and size. */
14489 set_vertical_scroll_bar (w
);
14491 /* Note that we actually used the scroll bar attached to this
14492 window, so it shouldn't be deleted at the end of redisplay. */
14493 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
14494 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
14497 /* Restore current_buffer and value of point in it. The window
14498 update may have changed the buffer, so first make sure `opoint'
14499 is still valid (Bug#6177). */
14500 if (CHARPOS (opoint
) < BEGV
)
14501 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
14502 else if (CHARPOS (opoint
) > ZV
)
14503 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
14505 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
14507 set_buffer_internal_1 (old
);
14508 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
14509 shorter. This can be caused by log truncation in *Messages*. */
14510 if (CHARPOS (lpoint
) <= ZV
)
14511 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
14513 unbind_to (count
, Qnil
);
14517 /* Build the complete desired matrix of WINDOW with a window start
14518 buffer position POS.
14520 Value is 1 if successful. It is zero if fonts were loaded during
14521 redisplay which makes re-adjusting glyph matrices necessary, and -1
14522 if point would appear in the scroll margins.
14523 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
14524 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
14528 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
14530 struct window
*w
= XWINDOW (window
);
14532 struct glyph_row
*last_text_row
= NULL
;
14533 struct frame
*f
= XFRAME (w
->frame
);
14535 /* Make POS the new window start. */
14536 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
14538 /* Mark cursor position as unknown. No overlay arrow seen. */
14539 w
->cursor
.vpos
= -1;
14540 overlay_arrow_seen
= 0;
14542 /* Initialize iterator and info to start at POS. */
14543 start_display (&it
, w
, pos
);
14545 /* Display all lines of W. */
14546 while (it
.current_y
< it
.last_visible_y
)
14548 if (display_line (&it
))
14549 last_text_row
= it
.glyph_row
- 1;
14550 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
14554 /* Don't let the cursor end in the scroll margins. */
14555 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
14556 && !MINI_WINDOW_P (w
))
14558 int this_scroll_margin
;
14560 if (scroll_margin
> 0)
14562 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14563 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14566 this_scroll_margin
= 0;
14568 if ((w
->cursor
.y
>= 0 /* not vscrolled */
14569 && w
->cursor
.y
< this_scroll_margin
14570 && CHARPOS (pos
) > BEGV
14571 && IT_CHARPOS (it
) < ZV
)
14572 /* rms: considering make_cursor_line_fully_visible_p here
14573 seems to give wrong results. We don't want to recenter
14574 when the last line is partly visible, we want to allow
14575 that case to be handled in the usual way. */
14576 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
14578 w
->cursor
.vpos
= -1;
14579 clear_glyph_matrix (w
->desired_matrix
);
14584 /* If bottom moved off end of frame, change mode line percentage. */
14585 if (XFASTINT (w
->window_end_pos
) <= 0
14586 && Z
!= IT_CHARPOS (it
))
14587 w
->update_mode_line
= Qt
;
14589 /* Set window_end_pos to the offset of the last character displayed
14590 on the window from the end of current_buffer. Set
14591 window_end_vpos to its row number. */
14594 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
14595 w
->window_end_bytepos
14596 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14598 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14600 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14601 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
14602 ->displays_text_p
);
14606 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14607 w
->window_end_pos
= make_number (Z
- ZV
);
14608 w
->window_end_vpos
= make_number (0);
14611 /* But that is not valid info until redisplay finishes. */
14612 w
->window_end_valid
= Qnil
;
14618 /************************************************************************
14619 Window redisplay reusing current matrix when buffer has not changed
14620 ************************************************************************/
14622 /* Try redisplay of window W showing an unchanged buffer with a
14623 different window start than the last time it was displayed by
14624 reusing its current matrix. Value is non-zero if successful.
14625 W->start is the new window start. */
14628 try_window_reusing_current_matrix (struct window
*w
)
14630 struct frame
*f
= XFRAME (w
->frame
);
14631 struct glyph_row
*row
, *bottom_row
;
14634 struct text_pos start
, new_start
;
14635 int nrows_scrolled
, i
;
14636 struct glyph_row
*last_text_row
;
14637 struct glyph_row
*last_reused_text_row
;
14638 struct glyph_row
*start_row
;
14639 int start_vpos
, min_y
, max_y
;
14642 if (inhibit_try_window_reusing
)
14646 if (/* This function doesn't handle terminal frames. */
14647 !FRAME_WINDOW_P (f
)
14648 /* Don't try to reuse the display if windows have been split
14650 || windows_or_buffers_changed
14651 || cursor_type_changed
)
14654 /* Can't do this if region may have changed. */
14655 if ((!NILP (Vtransient_mark_mode
)
14656 && !NILP (current_buffer
->mark_active
))
14657 || !NILP (w
->region_showing
)
14658 || !NILP (Vshow_trailing_whitespace
))
14661 /* If top-line visibility has changed, give up. */
14662 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14663 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
14666 /* Give up if old or new display is scrolled vertically. We could
14667 make this function handle this, but right now it doesn't. */
14668 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14669 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
14672 /* The variable new_start now holds the new window start. The old
14673 start `start' can be determined from the current matrix. */
14674 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
14675 start
= start_row
->minpos
;
14676 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14678 /* Clear the desired matrix for the display below. */
14679 clear_glyph_matrix (w
->desired_matrix
);
14681 if (CHARPOS (new_start
) <= CHARPOS (start
))
14685 /* Don't use this method if the display starts with an ellipsis
14686 displayed for invisible text. It's not easy to handle that case
14687 below, and it's certainly not worth the effort since this is
14688 not a frequent case. */
14689 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
14692 IF_DEBUG (debug_method_add (w
, "twu1"));
14694 /* Display up to a row that can be reused. The variable
14695 last_text_row is set to the last row displayed that displays
14696 text. Note that it.vpos == 0 if or if not there is a
14697 header-line; it's not the same as the MATRIX_ROW_VPOS! */
14698 start_display (&it
, w
, new_start
);
14699 first_row_y
= it
.current_y
;
14700 w
->cursor
.vpos
= -1;
14701 last_text_row
= last_reused_text_row
= NULL
;
14703 while (it
.current_y
< it
.last_visible_y
14704 && !fonts_changed_p
)
14706 /* If we have reached into the characters in the START row,
14707 that means the line boundaries have changed. So we
14708 can't start copying with the row START. Maybe it will
14709 work to start copying with the following row. */
14710 while (IT_CHARPOS (it
) > CHARPOS (start
))
14712 /* Advance to the next row as the "start". */
14714 start
= start_row
->minpos
;
14715 /* If there are no more rows to try, or just one, give up. */
14716 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
14717 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
14718 || CHARPOS (start
) == ZV
)
14720 clear_glyph_matrix (w
->desired_matrix
);
14724 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14726 /* If we have reached alignment,
14727 we can copy the rest of the rows. */
14728 if (IT_CHARPOS (it
) == CHARPOS (start
))
14731 if (display_line (&it
))
14732 last_text_row
= it
.glyph_row
- 1;
14735 /* A value of current_y < last_visible_y means that we stopped
14736 at the previous window start, which in turn means that we
14737 have at least one reusable row. */
14738 if (it
.current_y
< it
.last_visible_y
)
14740 /* IT.vpos always starts from 0; it counts text lines. */
14741 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
14743 /* Find PT if not already found in the lines displayed. */
14744 if (w
->cursor
.vpos
< 0)
14746 int dy
= it
.current_y
- start_row
->y
;
14748 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14749 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
14751 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
14752 dy
, nrows_scrolled
);
14755 clear_glyph_matrix (w
->desired_matrix
);
14760 /* Scroll the display. Do it before the current matrix is
14761 changed. The problem here is that update has not yet
14762 run, i.e. part of the current matrix is not up to date.
14763 scroll_run_hook will clear the cursor, and use the
14764 current matrix to get the height of the row the cursor is
14766 run
.current_y
= start_row
->y
;
14767 run
.desired_y
= it
.current_y
;
14768 run
.height
= it
.last_visible_y
- it
.current_y
;
14770 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
14773 FRAME_RIF (f
)->update_window_begin_hook (w
);
14774 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14775 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14776 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14780 /* Shift current matrix down by nrows_scrolled lines. */
14781 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14782 rotate_matrix (w
->current_matrix
,
14784 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14787 /* Disable lines that must be updated. */
14788 for (i
= 0; i
< nrows_scrolled
; ++i
)
14789 (start_row
+ i
)->enabled_p
= 0;
14791 /* Re-compute Y positions. */
14792 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14793 max_y
= it
.last_visible_y
;
14794 for (row
= start_row
+ nrows_scrolled
;
14798 row
->y
= it
.current_y
;
14799 row
->visible_height
= row
->height
;
14801 if (row
->y
< min_y
)
14802 row
->visible_height
-= min_y
- row
->y
;
14803 if (row
->y
+ row
->height
> max_y
)
14804 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14805 row
->redraw_fringe_bitmaps_p
= 1;
14807 it
.current_y
+= row
->height
;
14809 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14810 last_reused_text_row
= row
;
14811 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
14815 /* Disable lines in the current matrix which are now
14816 below the window. */
14817 for (++row
; row
< bottom_row
; ++row
)
14818 row
->enabled_p
= row
->mode_line_p
= 0;
14821 /* Update window_end_pos etc.; last_reused_text_row is the last
14822 reused row from the current matrix containing text, if any.
14823 The value of last_text_row is the last displayed line
14824 containing text. */
14825 if (last_reused_text_row
)
14827 w
->window_end_bytepos
14828 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
14830 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
14832 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
14833 w
->current_matrix
));
14835 else if (last_text_row
)
14837 w
->window_end_bytepos
14838 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14840 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14842 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14846 /* This window must be completely empty. */
14847 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14848 w
->window_end_pos
= make_number (Z
- ZV
);
14849 w
->window_end_vpos
= make_number (0);
14851 w
->window_end_valid
= Qnil
;
14853 /* Update hint: don't try scrolling again in update_window. */
14854 w
->desired_matrix
->no_scrolling_p
= 1;
14857 debug_method_add (w
, "try_window_reusing_current_matrix 1");
14861 else if (CHARPOS (new_start
) > CHARPOS (start
))
14863 struct glyph_row
*pt_row
, *row
;
14864 struct glyph_row
*first_reusable_row
;
14865 struct glyph_row
*first_row_to_display
;
14867 int yb
= window_text_bottom_y (w
);
14869 /* Find the row starting at new_start, if there is one. Don't
14870 reuse a partially visible line at the end. */
14871 first_reusable_row
= start_row
;
14872 while (first_reusable_row
->enabled_p
14873 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
14874 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14875 < CHARPOS (new_start
)))
14876 ++first_reusable_row
;
14878 /* Give up if there is no row to reuse. */
14879 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
14880 || !first_reusable_row
->enabled_p
14881 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14882 != CHARPOS (new_start
)))
14885 /* We can reuse fully visible rows beginning with
14886 first_reusable_row to the end of the window. Set
14887 first_row_to_display to the first row that cannot be reused.
14888 Set pt_row to the row containing point, if there is any. */
14890 for (first_row_to_display
= first_reusable_row
;
14891 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
14892 ++first_row_to_display
)
14894 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
14895 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
14896 pt_row
= first_row_to_display
;
14899 /* Start displaying at the start of first_row_to_display. */
14900 xassert (first_row_to_display
->y
< yb
);
14901 init_to_row_start (&it
, w
, first_row_to_display
);
14903 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
14905 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
14907 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
14908 + WINDOW_HEADER_LINE_HEIGHT (w
));
14910 /* Display lines beginning with first_row_to_display in the
14911 desired matrix. Set last_text_row to the last row displayed
14912 that displays text. */
14913 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
14914 if (pt_row
== NULL
)
14915 w
->cursor
.vpos
= -1;
14916 last_text_row
= NULL
;
14917 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
14918 if (display_line (&it
))
14919 last_text_row
= it
.glyph_row
- 1;
14921 /* If point is in a reused row, adjust y and vpos of the cursor
14925 w
->cursor
.vpos
-= nrows_scrolled
;
14926 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
14929 /* Give up if point isn't in a row displayed or reused. (This
14930 also handles the case where w->cursor.vpos < nrows_scrolled
14931 after the calls to display_line, which can happen with scroll
14932 margins. See bug#1295.) */
14933 if (w
->cursor
.vpos
< 0)
14935 clear_glyph_matrix (w
->desired_matrix
);
14939 /* Scroll the display. */
14940 run
.current_y
= first_reusable_row
->y
;
14941 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14942 run
.height
= it
.last_visible_y
- run
.current_y
;
14943 dy
= run
.current_y
- run
.desired_y
;
14948 FRAME_RIF (f
)->update_window_begin_hook (w
);
14949 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14950 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14951 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14955 /* Adjust Y positions of reused rows. */
14956 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14957 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14958 max_y
= it
.last_visible_y
;
14959 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
14962 row
->visible_height
= row
->height
;
14963 if (row
->y
< min_y
)
14964 row
->visible_height
-= min_y
- row
->y
;
14965 if (row
->y
+ row
->height
> max_y
)
14966 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14967 row
->redraw_fringe_bitmaps_p
= 1;
14970 /* Scroll the current matrix. */
14971 xassert (nrows_scrolled
> 0);
14972 rotate_matrix (w
->current_matrix
,
14974 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14977 /* Disable rows not reused. */
14978 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
14979 row
->enabled_p
= 0;
14981 /* Point may have moved to a different line, so we cannot assume that
14982 the previous cursor position is valid; locate the correct row. */
14985 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
14986 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
14990 w
->cursor
.y
= row
->y
;
14992 if (row
< bottom_row
)
14994 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
14995 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
14997 /* Can't use this optimization with bidi-reordered glyph
14998 rows, unless cursor is already at point. */
14999 if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
15001 if (!(w
->cursor
.hpos
>= 0
15002 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
15003 && BUFFERP (glyph
->object
)
15004 && glyph
->charpos
== PT
))
15009 && (!BUFFERP (glyph
->object
)
15010 || glyph
->charpos
< PT
);
15014 w
->cursor
.x
+= glyph
->pixel_width
;
15019 /* Adjust window end. A null value of last_text_row means that
15020 the window end is in reused rows which in turn means that
15021 only its vpos can have changed. */
15024 w
->window_end_bytepos
15025 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15027 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15029 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15034 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
15037 w
->window_end_valid
= Qnil
;
15038 w
->desired_matrix
->no_scrolling_p
= 1;
15041 debug_method_add (w
, "try_window_reusing_current_matrix 2");
15051 /************************************************************************
15052 Window redisplay reusing current matrix when buffer has changed
15053 ************************************************************************/
15055 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
15056 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
15058 static struct glyph_row
*
15059 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
15060 struct glyph_row
*);
15063 /* Return the last row in MATRIX displaying text. If row START is
15064 non-null, start searching with that row. IT gives the dimensions
15065 of the display. Value is null if matrix is empty; otherwise it is
15066 a pointer to the row found. */
15068 static struct glyph_row
*
15069 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
15070 struct glyph_row
*start
)
15072 struct glyph_row
*row
, *row_found
;
15074 /* Set row_found to the last row in IT->w's current matrix
15075 displaying text. The loop looks funny but think of partially
15078 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
15079 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15081 xassert (row
->enabled_p
);
15083 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
15092 /* Return the last row in the current matrix of W that is not affected
15093 by changes at the start of current_buffer that occurred since W's
15094 current matrix was built. Value is null if no such row exists.
15096 BEG_UNCHANGED us the number of characters unchanged at the start of
15097 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
15098 first changed character in current_buffer. Characters at positions <
15099 BEG + BEG_UNCHANGED are at the same buffer positions as they were
15100 when the current matrix was built. */
15102 static struct glyph_row
*
15103 find_last_unchanged_at_beg_row (struct window
*w
)
15105 int first_changed_pos
= BEG
+ BEG_UNCHANGED
;
15106 struct glyph_row
*row
;
15107 struct glyph_row
*row_found
= NULL
;
15108 int yb
= window_text_bottom_y (w
);
15110 /* Find the last row displaying unchanged text. */
15111 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15112 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15113 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
15116 if (/* If row ends before first_changed_pos, it is unchanged,
15117 except in some case. */
15118 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
15119 /* When row ends in ZV and we write at ZV it is not
15121 && !row
->ends_at_zv_p
15122 /* When first_changed_pos is the end of a continued line,
15123 row is not unchanged because it may be no longer
15125 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
15126 && (row
->continued_p
15127 || row
->exact_window_width_line_p
)))
15130 /* Stop if last visible row. */
15131 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
15139 /* Find the first glyph row in the current matrix of W that is not
15140 affected by changes at the end of current_buffer since the
15141 time W's current matrix was built.
15143 Return in *DELTA the number of chars by which buffer positions in
15144 unchanged text at the end of current_buffer must be adjusted.
15146 Return in *DELTA_BYTES the corresponding number of bytes.
15148 Value is null if no such row exists, i.e. all rows are affected by
15151 static struct glyph_row
*
15152 find_first_unchanged_at_end_row (struct window
*w
, int *delta
, int *delta_bytes
)
15154 struct glyph_row
*row
;
15155 struct glyph_row
*row_found
= NULL
;
15157 *delta
= *delta_bytes
= 0;
15159 /* Display must not have been paused, otherwise the current matrix
15160 is not up to date. */
15161 eassert (!NILP (w
->window_end_valid
));
15163 /* A value of window_end_pos >= END_UNCHANGED means that the window
15164 end is in the range of changed text. If so, there is no
15165 unchanged row at the end of W's current matrix. */
15166 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
15169 /* Set row to the last row in W's current matrix displaying text. */
15170 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15172 /* If matrix is entirely empty, no unchanged row exists. */
15173 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15175 /* The value of row is the last glyph row in the matrix having a
15176 meaningful buffer position in it. The end position of row
15177 corresponds to window_end_pos. This allows us to translate
15178 buffer positions in the current matrix to current buffer
15179 positions for characters not in changed text. */
15180 int Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15181 int Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15182 int last_unchanged_pos
, last_unchanged_pos_old
;
15183 struct glyph_row
*first_text_row
15184 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15186 *delta
= Z
- Z_old
;
15187 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15189 /* Set last_unchanged_pos to the buffer position of the last
15190 character in the buffer that has not been changed. Z is the
15191 index + 1 of the last character in current_buffer, i.e. by
15192 subtracting END_UNCHANGED we get the index of the last
15193 unchanged character, and we have to add BEG to get its buffer
15195 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
15196 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
15198 /* Search backward from ROW for a row displaying a line that
15199 starts at a minimum position >= last_unchanged_pos_old. */
15200 for (; row
> first_text_row
; --row
)
15202 /* This used to abort, but it can happen.
15203 It is ok to just stop the search instead here. KFS. */
15204 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15207 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
15212 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
15218 /* Make sure that glyph rows in the current matrix of window W
15219 reference the same glyph memory as corresponding rows in the
15220 frame's frame matrix. This function is called after scrolling W's
15221 current matrix on a terminal frame in try_window_id and
15222 try_window_reusing_current_matrix. */
15225 sync_frame_with_window_matrix_rows (struct window
*w
)
15227 struct frame
*f
= XFRAME (w
->frame
);
15228 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
15230 /* Preconditions: W must be a leaf window and full-width. Its frame
15231 must have a frame matrix. */
15232 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
15233 xassert (WINDOW_FULL_WIDTH_P (w
));
15234 xassert (!FRAME_WINDOW_P (f
));
15236 /* If W is a full-width window, glyph pointers in W's current matrix
15237 have, by definition, to be the same as glyph pointers in the
15238 corresponding frame matrix. Note that frame matrices have no
15239 marginal areas (see build_frame_matrix). */
15240 window_row
= w
->current_matrix
->rows
;
15241 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
15242 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
15243 while (window_row
< window_row_end
)
15245 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
15246 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
15248 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
15249 frame_row
->glyphs
[TEXT_AREA
] = start
;
15250 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
15251 frame_row
->glyphs
[LAST_AREA
] = end
;
15253 /* Disable frame rows whose corresponding window rows have
15254 been disabled in try_window_id. */
15255 if (!window_row
->enabled_p
)
15256 frame_row
->enabled_p
= 0;
15258 ++window_row
, ++frame_row
;
15263 /* Find the glyph row in window W containing CHARPOS. Consider all
15264 rows between START and END (not inclusive). END null means search
15265 all rows to the end of the display area of W. Value is the row
15266 containing CHARPOS or null. */
15269 row_containing_pos (struct window
*w
, int charpos
, struct glyph_row
*start
,
15270 struct glyph_row
*end
, int dy
)
15272 struct glyph_row
*row
= start
;
15273 struct glyph_row
*best_row
= NULL
;
15274 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
15277 /* If we happen to start on a header-line, skip that. */
15278 if (row
->mode_line_p
)
15281 if ((end
&& row
>= end
) || !row
->enabled_p
)
15284 last_y
= window_text_bottom_y (w
) - dy
;
15288 /* Give up if we have gone too far. */
15289 if (end
&& row
>= end
)
15291 /* This formerly returned if they were equal.
15292 I think that both quantities are of a "last plus one" type;
15293 if so, when they are equal, the row is within the screen. -- rms. */
15294 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
15297 /* If it is in this row, return this row. */
15298 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
15299 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
15300 /* The end position of a row equals the start
15301 position of the next row. If CHARPOS is there, we
15302 would rather display it in the next line, except
15303 when this line ends in ZV. */
15304 && !row
->ends_at_zv_p
15305 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15306 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
15310 if (NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
15312 /* In bidi-reordered rows, there could be several rows
15313 occluding point. We need to find the one which fits
15314 CHARPOS the best. */
15315 for (g
= row
->glyphs
[TEXT_AREA
];
15316 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
15319 if (!STRINGP (g
->object
))
15321 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
15323 mindif
= eabs (g
->charpos
- charpos
);
15336 /* Try to redisplay window W by reusing its existing display. W's
15337 current matrix must be up to date when this function is called,
15338 i.e. window_end_valid must not be nil.
15342 1 if display has been updated
15343 0 if otherwise unsuccessful
15344 -1 if redisplay with same window start is known not to succeed
15346 The following steps are performed:
15348 1. Find the last row in the current matrix of W that is not
15349 affected by changes at the start of current_buffer. If no such row
15352 2. Find the first row in W's current matrix that is not affected by
15353 changes at the end of current_buffer. Maybe there is no such row.
15355 3. Display lines beginning with the row + 1 found in step 1 to the
15356 row found in step 2 or, if step 2 didn't find a row, to the end of
15359 4. If cursor is not known to appear on the window, give up.
15361 5. If display stopped at the row found in step 2, scroll the
15362 display and current matrix as needed.
15364 6. Maybe display some lines at the end of W, if we must. This can
15365 happen under various circumstances, like a partially visible line
15366 becoming fully visible, or because newly displayed lines are displayed
15367 in smaller font sizes.
15369 7. Update W's window end information. */
15372 try_window_id (struct window
*w
)
15374 struct frame
*f
= XFRAME (w
->frame
);
15375 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
15376 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
15377 struct glyph_row
*last_unchanged_at_beg_row
;
15378 struct glyph_row
*first_unchanged_at_end_row
;
15379 struct glyph_row
*row
;
15380 struct glyph_row
*bottom_row
;
15383 int delta
= 0, delta_bytes
= 0, stop_pos
, dvpos
, dy
;
15384 struct text_pos start_pos
;
15386 int first_unchanged_at_end_vpos
= 0;
15387 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
15388 struct text_pos start
;
15389 int first_changed_charpos
, last_changed_charpos
;
15392 if (inhibit_try_window_id
)
15396 /* This is handy for debugging. */
15398 #define GIVE_UP(X) \
15400 fprintf (stderr, "try_window_id give up %d\n", (X)); \
15404 #define GIVE_UP(X) return 0
15407 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
15409 /* Don't use this for mini-windows because these can show
15410 messages and mini-buffers, and we don't handle that here. */
15411 if (MINI_WINDOW_P (w
))
15414 /* This flag is used to prevent redisplay optimizations. */
15415 if (windows_or_buffers_changed
|| cursor_type_changed
)
15418 /* Verify that narrowing has not changed.
15419 Also verify that we were not told to prevent redisplay optimizations.
15420 It would be nice to further
15421 reduce the number of cases where this prevents try_window_id. */
15422 if (current_buffer
->clip_changed
15423 || current_buffer
->prevent_redisplay_optimizations_p
)
15426 /* Window must either use window-based redisplay or be full width. */
15427 if (!FRAME_WINDOW_P (f
)
15428 && (!FRAME_LINE_INS_DEL_OK (f
)
15429 || !WINDOW_FULL_WIDTH_P (w
)))
15432 /* Give up if point is known NOT to appear in W. */
15433 if (PT
< CHARPOS (start
))
15436 /* Another way to prevent redisplay optimizations. */
15437 if (XFASTINT (w
->last_modified
) == 0)
15440 /* Verify that window is not hscrolled. */
15441 if (XFASTINT (w
->hscroll
) != 0)
15444 /* Verify that display wasn't paused. */
15445 if (NILP (w
->window_end_valid
))
15448 /* Can't use this if highlighting a region because a cursor movement
15449 will do more than just set the cursor. */
15450 if (!NILP (Vtransient_mark_mode
)
15451 && !NILP (current_buffer
->mark_active
))
15454 /* Likewise if highlighting trailing whitespace. */
15455 if (!NILP (Vshow_trailing_whitespace
))
15458 /* Likewise if showing a region. */
15459 if (!NILP (w
->region_showing
))
15462 /* Can't use this if overlay arrow position and/or string have
15464 if (overlay_arrows_changed_p ())
15467 /* When word-wrap is on, adding a space to the first word of a
15468 wrapped line can change the wrap position, altering the line
15469 above it. It might be worthwhile to handle this more
15470 intelligently, but for now just redisplay from scratch. */
15471 if (!NILP (XBUFFER (w
->buffer
)->word_wrap
))
15474 /* Under bidi reordering, adding or deleting a character in the
15475 beginning of a paragraph, before the first strong directional
15476 character, can change the base direction of the paragraph (unless
15477 the buffer specifies a fixed paragraph direction), which will
15478 require to redisplay the whole paragraph. It might be worthwhile
15479 to find the paragraph limits and widen the range of redisplayed
15480 lines to that, but for now just give up this optimization and
15481 redisplay from scratch. */
15482 if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
)
15483 && NILP (XBUFFER (w
->buffer
)->bidi_paragraph_direction
))
15486 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
15487 only if buffer has really changed. The reason is that the gap is
15488 initially at Z for freshly visited files. The code below would
15489 set end_unchanged to 0 in that case. */
15490 if (MODIFF
> SAVE_MODIFF
15491 /* This seems to happen sometimes after saving a buffer. */
15492 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
15494 if (GPT
- BEG
< BEG_UNCHANGED
)
15495 BEG_UNCHANGED
= GPT
- BEG
;
15496 if (Z
- GPT
< END_UNCHANGED
)
15497 END_UNCHANGED
= Z
- GPT
;
15500 /* The position of the first and last character that has been changed. */
15501 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
15502 last_changed_charpos
= Z
- END_UNCHANGED
;
15504 /* If window starts after a line end, and the last change is in
15505 front of that newline, then changes don't affect the display.
15506 This case happens with stealth-fontification. Note that although
15507 the display is unchanged, glyph positions in the matrix have to
15508 be adjusted, of course. */
15509 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15510 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15511 && ((last_changed_charpos
< CHARPOS (start
)
15512 && CHARPOS (start
) == BEGV
)
15513 || (last_changed_charpos
< CHARPOS (start
) - 1
15514 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
15516 int Z_old
, delta
, Z_BYTE_old
, delta_bytes
;
15517 struct glyph_row
*r0
;
15519 /* Compute how many chars/bytes have been added to or removed
15520 from the buffer. */
15521 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15522 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15524 delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15526 /* Give up if PT is not in the window. Note that it already has
15527 been checked at the start of try_window_id that PT is not in
15528 front of the window start. */
15529 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + delta
)
15532 /* If window start is unchanged, we can reuse the whole matrix
15533 as is, after adjusting glyph positions. No need to compute
15534 the window end again, since its offset from Z hasn't changed. */
15535 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15536 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + delta
15537 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + delta_bytes
15538 /* PT must not be in a partially visible line. */
15539 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + delta
15540 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15542 /* Adjust positions in the glyph matrix. */
15543 if (delta
|| delta_bytes
)
15545 struct glyph_row
*r1
15546 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15547 increment_matrix_positions (w
->current_matrix
,
15548 MATRIX_ROW_VPOS (r0
, current_matrix
),
15549 MATRIX_ROW_VPOS (r1
, current_matrix
),
15550 delta
, delta_bytes
);
15553 /* Set the cursor. */
15554 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15556 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15563 /* Handle the case that changes are all below what is displayed in
15564 the window, and that PT is in the window. This shortcut cannot
15565 be taken if ZV is visible in the window, and text has been added
15566 there that is visible in the window. */
15567 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
15568 /* ZV is not visible in the window, or there are no
15569 changes at ZV, actually. */
15570 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
15571 || first_changed_charpos
== last_changed_charpos
))
15573 struct glyph_row
*r0
;
15575 /* Give up if PT is not in the window. Note that it already has
15576 been checked at the start of try_window_id that PT is not in
15577 front of the window start. */
15578 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
15581 /* If window start is unchanged, we can reuse the whole matrix
15582 as is, without changing glyph positions since no text has
15583 been added/removed in front of the window end. */
15584 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15585 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
15586 /* PT must not be in a partially visible line. */
15587 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
15588 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15590 /* We have to compute the window end anew since text
15591 could have been added/removed after it. */
15593 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15594 w
->window_end_bytepos
15595 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15597 /* Set the cursor. */
15598 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15600 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15607 /* Give up if window start is in the changed area.
15609 The condition used to read
15611 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
15613 but why that was tested escapes me at the moment. */
15614 if (CHARPOS (start
) >= first_changed_charpos
15615 && CHARPOS (start
) <= last_changed_charpos
)
15618 /* Check that window start agrees with the start of the first glyph
15619 row in its current matrix. Check this after we know the window
15620 start is not in changed text, otherwise positions would not be
15622 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15623 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
15626 /* Give up if the window ends in strings. Overlay strings
15627 at the end are difficult to handle, so don't try. */
15628 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
15629 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
15632 /* Compute the position at which we have to start displaying new
15633 lines. Some of the lines at the top of the window might be
15634 reusable because they are not displaying changed text. Find the
15635 last row in W's current matrix not affected by changes at the
15636 start of current_buffer. Value is null if changes start in the
15637 first line of window. */
15638 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
15639 if (last_unchanged_at_beg_row
)
15641 /* Avoid starting to display in the moddle of a character, a TAB
15642 for instance. This is easier than to set up the iterator
15643 exactly, and it's not a frequent case, so the additional
15644 effort wouldn't really pay off. */
15645 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
15646 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
15647 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
15648 --last_unchanged_at_beg_row
;
15650 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
15653 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
15655 start_pos
= it
.current
.pos
;
15657 /* Start displaying new lines in the desired matrix at the same
15658 vpos we would use in the current matrix, i.e. below
15659 last_unchanged_at_beg_row. */
15660 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
15662 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15663 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
15665 xassert (it
.hpos
== 0 && it
.current_x
== 0);
15669 /* There are no reusable lines at the start of the window.
15670 Start displaying in the first text line. */
15671 start_display (&it
, w
, start
);
15672 it
.vpos
= it
.first_vpos
;
15673 start_pos
= it
.current
.pos
;
15676 /* Find the first row that is not affected by changes at the end of
15677 the buffer. Value will be null if there is no unchanged row, in
15678 which case we must redisplay to the end of the window. delta
15679 will be set to the value by which buffer positions beginning with
15680 first_unchanged_at_end_row have to be adjusted due to text
15682 first_unchanged_at_end_row
15683 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
15684 IF_DEBUG (debug_delta
= delta
);
15685 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
15687 /* Set stop_pos to the buffer position up to which we will have to
15688 display new lines. If first_unchanged_at_end_row != NULL, this
15689 is the buffer position of the start of the line displayed in that
15690 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
15691 that we don't stop at a buffer position. */
15693 if (first_unchanged_at_end_row
)
15695 xassert (last_unchanged_at_beg_row
== NULL
15696 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
15698 /* If this is a continuation line, move forward to the next one
15699 that isn't. Changes in lines above affect this line.
15700 Caution: this may move first_unchanged_at_end_row to a row
15701 not displaying text. */
15702 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
15703 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15704 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15705 < it
.last_visible_y
))
15706 ++first_unchanged_at_end_row
;
15708 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15709 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15710 >= it
.last_visible_y
))
15711 first_unchanged_at_end_row
= NULL
;
15714 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
15716 first_unchanged_at_end_vpos
15717 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
15718 xassert (stop_pos
>= Z
- END_UNCHANGED
);
15721 else if (last_unchanged_at_beg_row
== NULL
)
15727 /* Either there is no unchanged row at the end, or the one we have
15728 now displays text. This is a necessary condition for the window
15729 end pos calculation at the end of this function. */
15730 xassert (first_unchanged_at_end_row
== NULL
15731 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
15733 debug_last_unchanged_at_beg_vpos
15734 = (last_unchanged_at_beg_row
15735 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
15737 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
15739 #endif /* GLYPH_DEBUG != 0 */
15742 /* Display new lines. Set last_text_row to the last new line
15743 displayed which has text on it, i.e. might end up as being the
15744 line where the window_end_vpos is. */
15745 w
->cursor
.vpos
= -1;
15746 last_text_row
= NULL
;
15747 overlay_arrow_seen
= 0;
15748 while (it
.current_y
< it
.last_visible_y
15749 && !fonts_changed_p
15750 && (first_unchanged_at_end_row
== NULL
15751 || IT_CHARPOS (it
) < stop_pos
))
15753 if (display_line (&it
))
15754 last_text_row
= it
.glyph_row
- 1;
15757 if (fonts_changed_p
)
15761 /* Compute differences in buffer positions, y-positions etc. for
15762 lines reused at the bottom of the window. Compute what we can
15764 if (first_unchanged_at_end_row
15765 /* No lines reused because we displayed everything up to the
15766 bottom of the window. */
15767 && it
.current_y
< it
.last_visible_y
)
15770 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
15772 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
15773 run
.current_y
= first_unchanged_at_end_row
->y
;
15774 run
.desired_y
= run
.current_y
+ dy
;
15775 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
15779 delta
= delta_bytes
= dvpos
= dy
15780 = run
.current_y
= run
.desired_y
= run
.height
= 0;
15781 first_unchanged_at_end_row
= NULL
;
15783 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
15786 /* Find the cursor if not already found. We have to decide whether
15787 PT will appear on this window (it sometimes doesn't, but this is
15788 not a very frequent case.) This decision has to be made before
15789 the current matrix is altered. A value of cursor.vpos < 0 means
15790 that PT is either in one of the lines beginning at
15791 first_unchanged_at_end_row or below the window. Don't care for
15792 lines that might be displayed later at the window end; as
15793 mentioned, this is not a frequent case. */
15794 if (w
->cursor
.vpos
< 0)
15796 /* Cursor in unchanged rows at the top? */
15797 if (PT
< CHARPOS (start_pos
)
15798 && last_unchanged_at_beg_row
)
15800 row
= row_containing_pos (w
, PT
,
15801 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
15802 last_unchanged_at_beg_row
+ 1, 0);
15804 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15807 /* Start from first_unchanged_at_end_row looking for PT. */
15808 else if (first_unchanged_at_end_row
)
15810 row
= row_containing_pos (w
, PT
- delta
,
15811 first_unchanged_at_end_row
, NULL
, 0);
15813 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
15814 delta_bytes
, dy
, dvpos
);
15817 /* Give up if cursor was not found. */
15818 if (w
->cursor
.vpos
< 0)
15820 clear_glyph_matrix (w
->desired_matrix
);
15825 /* Don't let the cursor end in the scroll margins. */
15827 int this_scroll_margin
, cursor_height
;
15829 this_scroll_margin
= max (0, scroll_margin
);
15830 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15831 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
15832 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
15834 if ((w
->cursor
.y
< this_scroll_margin
15835 && CHARPOS (start
) > BEGV
)
15836 /* Old redisplay didn't take scroll margin into account at the bottom,
15837 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
15838 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
15839 ? cursor_height
+ this_scroll_margin
15840 : 1)) > it
.last_visible_y
)
15842 w
->cursor
.vpos
= -1;
15843 clear_glyph_matrix (w
->desired_matrix
);
15848 /* Scroll the display. Do it before changing the current matrix so
15849 that xterm.c doesn't get confused about where the cursor glyph is
15851 if (dy
&& run
.height
)
15855 if (FRAME_WINDOW_P (f
))
15857 FRAME_RIF (f
)->update_window_begin_hook (w
);
15858 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15859 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15860 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15864 /* Terminal frame. In this case, dvpos gives the number of
15865 lines to scroll by; dvpos < 0 means scroll up. */
15866 int first_unchanged_at_end_vpos
15867 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
15868 int from
= WINDOW_TOP_EDGE_LINE (w
) + first_unchanged_at_end_vpos
;
15869 int end
= (WINDOW_TOP_EDGE_LINE (w
)
15870 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
15871 + window_internal_height (w
));
15873 /* Perform the operation on the screen. */
15876 /* Scroll last_unchanged_at_beg_row to the end of the
15877 window down dvpos lines. */
15878 set_terminal_window (f
, end
);
15880 /* On dumb terminals delete dvpos lines at the end
15881 before inserting dvpos empty lines. */
15882 if (!FRAME_SCROLL_REGION_OK (f
))
15883 ins_del_lines (f
, end
- dvpos
, -dvpos
);
15885 /* Insert dvpos empty lines in front of
15886 last_unchanged_at_beg_row. */
15887 ins_del_lines (f
, from
, dvpos
);
15889 else if (dvpos
< 0)
15891 /* Scroll up last_unchanged_at_beg_vpos to the end of
15892 the window to last_unchanged_at_beg_vpos - |dvpos|. */
15893 set_terminal_window (f
, end
);
15895 /* Delete dvpos lines in front of
15896 last_unchanged_at_beg_vpos. ins_del_lines will set
15897 the cursor to the given vpos and emit |dvpos| delete
15899 ins_del_lines (f
, from
+ dvpos
, dvpos
);
15901 /* On a dumb terminal insert dvpos empty lines at the
15903 if (!FRAME_SCROLL_REGION_OK (f
))
15904 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
15907 set_terminal_window (f
, 0);
15913 /* Shift reused rows of the current matrix to the right position.
15914 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
15916 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15917 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
15920 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
15921 bottom_vpos
, dvpos
);
15922 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
15925 else if (dvpos
> 0)
15927 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
15928 bottom_vpos
, dvpos
);
15929 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
15930 first_unchanged_at_end_vpos
+ dvpos
, 0);
15933 /* For frame-based redisplay, make sure that current frame and window
15934 matrix are in sync with respect to glyph memory. */
15935 if (!FRAME_WINDOW_P (f
))
15936 sync_frame_with_window_matrix_rows (w
);
15938 /* Adjust buffer positions in reused rows. */
15939 if (delta
|| delta_bytes
)
15940 increment_matrix_positions (current_matrix
,
15941 first_unchanged_at_end_vpos
+ dvpos
,
15942 bottom_vpos
, delta
, delta_bytes
);
15944 /* Adjust Y positions. */
15946 shift_glyph_matrix (w
, current_matrix
,
15947 first_unchanged_at_end_vpos
+ dvpos
,
15950 if (first_unchanged_at_end_row
)
15952 first_unchanged_at_end_row
+= dvpos
;
15953 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
15954 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
15955 first_unchanged_at_end_row
= NULL
;
15958 /* If scrolling up, there may be some lines to display at the end of
15960 last_text_row_at_end
= NULL
;
15963 /* Scrolling up can leave for example a partially visible line
15964 at the end of the window to be redisplayed. */
15965 /* Set last_row to the glyph row in the current matrix where the
15966 window end line is found. It has been moved up or down in
15967 the matrix by dvpos. */
15968 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
15969 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
15971 /* If last_row is the window end line, it should display text. */
15972 xassert (last_row
->displays_text_p
);
15974 /* If window end line was partially visible before, begin
15975 displaying at that line. Otherwise begin displaying with the
15976 line following it. */
15977 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
15979 init_to_row_start (&it
, w
, last_row
);
15980 it
.vpos
= last_vpos
;
15981 it
.current_y
= last_row
->y
;
15985 init_to_row_end (&it
, w
, last_row
);
15986 it
.vpos
= 1 + last_vpos
;
15987 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
15991 /* We may start in a continuation line. If so, we have to
15992 get the right continuation_lines_width and current_x. */
15993 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
15994 it
.hpos
= it
.current_x
= 0;
15996 /* Display the rest of the lines at the window end. */
15997 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15998 while (it
.current_y
< it
.last_visible_y
15999 && !fonts_changed_p
)
16001 /* Is it always sure that the display agrees with lines in
16002 the current matrix? I don't think so, so we mark rows
16003 displayed invalid in the current matrix by setting their
16004 enabled_p flag to zero. */
16005 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
16006 if (display_line (&it
))
16007 last_text_row_at_end
= it
.glyph_row
- 1;
16011 /* Update window_end_pos and window_end_vpos. */
16012 if (first_unchanged_at_end_row
16013 && !last_text_row_at_end
)
16015 /* Window end line if one of the preserved rows from the current
16016 matrix. Set row to the last row displaying text in current
16017 matrix starting at first_unchanged_at_end_row, after
16019 xassert (first_unchanged_at_end_row
->displays_text_p
);
16020 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
16021 first_unchanged_at_end_row
);
16022 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
16024 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16025 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16027 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
16028 xassert (w
->window_end_bytepos
>= 0);
16029 IF_DEBUG (debug_method_add (w
, "A"));
16031 else if (last_text_row_at_end
)
16034 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
16035 w
->window_end_bytepos
16036 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
16038 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
16039 xassert (w
->window_end_bytepos
>= 0);
16040 IF_DEBUG (debug_method_add (w
, "B"));
16042 else if (last_text_row
)
16044 /* We have displayed either to the end of the window or at the
16045 end of the window, i.e. the last row with text is to be found
16046 in the desired matrix. */
16048 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16049 w
->window_end_bytepos
16050 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16052 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
16053 xassert (w
->window_end_bytepos
>= 0);
16055 else if (first_unchanged_at_end_row
== NULL
16056 && last_text_row
== NULL
16057 && last_text_row_at_end
== NULL
)
16059 /* Displayed to end of window, but no line containing text was
16060 displayed. Lines were deleted at the end of the window. */
16061 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
16062 int vpos
= XFASTINT (w
->window_end_vpos
);
16063 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
16064 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
16067 row
== NULL
&& vpos
>= first_vpos
;
16068 --vpos
, --current_row
, --desired_row
)
16070 if (desired_row
->enabled_p
)
16072 if (desired_row
->displays_text_p
)
16075 else if (current_row
->displays_text_p
)
16079 xassert (row
!= NULL
);
16080 w
->window_end_vpos
= make_number (vpos
+ 1);
16081 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16082 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16083 xassert (w
->window_end_bytepos
>= 0);
16084 IF_DEBUG (debug_method_add (w
, "C"));
16089 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
16090 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
16092 /* Record that display has not been completed. */
16093 w
->window_end_valid
= Qnil
;
16094 w
->desired_matrix
->no_scrolling_p
= 1;
16102 /***********************************************************************
16103 More debugging support
16104 ***********************************************************************/
16108 void dump_glyph_row (struct glyph_row
*, int, int);
16109 void dump_glyph_matrix (struct glyph_matrix
*, int);
16110 void dump_glyph (struct glyph_row
*, struct glyph
*, int);
16113 /* Dump the contents of glyph matrix MATRIX on stderr.
16115 GLYPHS 0 means don't show glyph contents.
16116 GLYPHS 1 means show glyphs in short form
16117 GLYPHS > 1 means show glyphs in long form. */
16120 dump_glyph_matrix (matrix
, glyphs
)
16121 struct glyph_matrix
*matrix
;
16125 for (i
= 0; i
< matrix
->nrows
; ++i
)
16126 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
16130 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
16131 the glyph row and area where the glyph comes from. */
16134 dump_glyph (row
, glyph
, area
)
16135 struct glyph_row
*row
;
16136 struct glyph
*glyph
;
16139 if (glyph
->type
== CHAR_GLYPH
)
16142 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16143 glyph
- row
->glyphs
[TEXT_AREA
],
16146 (BUFFERP (glyph
->object
)
16148 : (STRINGP (glyph
->object
)
16151 glyph
->pixel_width
,
16153 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
16157 glyph
->left_box_line_p
,
16158 glyph
->right_box_line_p
);
16160 else if (glyph
->type
== STRETCH_GLYPH
)
16163 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16164 glyph
- row
->glyphs
[TEXT_AREA
],
16167 (BUFFERP (glyph
->object
)
16169 : (STRINGP (glyph
->object
)
16172 glyph
->pixel_width
,
16176 glyph
->left_box_line_p
,
16177 glyph
->right_box_line_p
);
16179 else if (glyph
->type
== IMAGE_GLYPH
)
16182 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16183 glyph
- row
->glyphs
[TEXT_AREA
],
16186 (BUFFERP (glyph
->object
)
16188 : (STRINGP (glyph
->object
)
16191 glyph
->pixel_width
,
16195 glyph
->left_box_line_p
,
16196 glyph
->right_box_line_p
);
16198 else if (glyph
->type
== COMPOSITE_GLYPH
)
16201 " %5d %4c %6d %c %3d 0x%05x",
16202 glyph
- row
->glyphs
[TEXT_AREA
],
16205 (BUFFERP (glyph
->object
)
16207 : (STRINGP (glyph
->object
)
16210 glyph
->pixel_width
,
16212 if (glyph
->u
.cmp
.automatic
)
16215 glyph
->u
.cmp
.from
, glyph
->u
.cmp
.to
);
16216 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
16218 glyph
->left_box_line_p
,
16219 glyph
->right_box_line_p
);
16224 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
16225 GLYPHS 0 means don't show glyph contents.
16226 GLYPHS 1 means show glyphs in short form
16227 GLYPHS > 1 means show glyphs in long form. */
16230 dump_glyph_row (row
, vpos
, glyphs
)
16231 struct glyph_row
*row
;
16236 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
16237 fprintf (stderr
, "======================================================================\n");
16239 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d\
16240 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
16242 MATRIX_ROW_START_CHARPOS (row
),
16243 MATRIX_ROW_END_CHARPOS (row
),
16244 row
->used
[TEXT_AREA
],
16245 row
->contains_overlapping_glyphs_p
,
16247 row
->truncated_on_left_p
,
16248 row
->truncated_on_right_p
,
16250 MATRIX_ROW_CONTINUATION_LINE_P (row
),
16251 row
->displays_text_p
,
16254 row
->ends_in_middle_of_char_p
,
16255 row
->starts_in_middle_of_char_p
,
16261 row
->visible_height
,
16264 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
16265 row
->end
.overlay_string_index
,
16266 row
->continuation_lines_width
);
16267 fprintf (stderr
, "%9d %5d\n",
16268 CHARPOS (row
->start
.string_pos
),
16269 CHARPOS (row
->end
.string_pos
));
16270 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
16271 row
->end
.dpvec_index
);
16278 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16280 struct glyph
*glyph
= row
->glyphs
[area
];
16281 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
16283 /* Glyph for a line end in text. */
16284 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
16287 if (glyph
< glyph_end
)
16288 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
16290 for (; glyph
< glyph_end
; ++glyph
)
16291 dump_glyph (row
, glyph
, area
);
16294 else if (glyphs
== 1)
16298 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16300 char *s
= (char *) alloca (row
->used
[area
] + 1);
16303 for (i
= 0; i
< row
->used
[area
]; ++i
)
16305 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
16306 if (glyph
->type
== CHAR_GLYPH
16307 && glyph
->u
.ch
< 0x80
16308 && glyph
->u
.ch
>= ' ')
16309 s
[i
] = glyph
->u
.ch
;
16315 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
16321 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
16322 Sdump_glyph_matrix
, 0, 1, "p",
16323 doc
: /* Dump the current matrix of the selected window to stderr.
16324 Shows contents of glyph row structures. With non-nil
16325 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
16326 glyphs in short form, otherwise show glyphs in long form. */)
16327 (Lisp_Object glyphs
)
16329 struct window
*w
= XWINDOW (selected_window
);
16330 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16332 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
16333 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
16334 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
16335 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
16336 fprintf (stderr
, "=============================================\n");
16337 dump_glyph_matrix (w
->current_matrix
,
16338 NILP (glyphs
) ? 0 : XINT (glyphs
));
16343 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
16344 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
16347 struct frame
*f
= XFRAME (selected_frame
);
16348 dump_glyph_matrix (f
->current_matrix
, 1);
16353 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
16354 doc
: /* Dump glyph row ROW to stderr.
16355 GLYPH 0 means don't dump glyphs.
16356 GLYPH 1 means dump glyphs in short form.
16357 GLYPH > 1 or omitted means dump glyphs in long form. */)
16358 (Lisp_Object row
, Lisp_Object glyphs
)
16360 struct glyph_matrix
*matrix
;
16363 CHECK_NUMBER (row
);
16364 matrix
= XWINDOW (selected_window
)->current_matrix
;
16366 if (vpos
>= 0 && vpos
< matrix
->nrows
)
16367 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
16369 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16374 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
16375 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
16376 GLYPH 0 means don't dump glyphs.
16377 GLYPH 1 means dump glyphs in short form.
16378 GLYPH > 1 or omitted means dump glyphs in long form. */)
16379 (Lisp_Object row
, Lisp_Object glyphs
)
16381 struct frame
*sf
= SELECTED_FRAME ();
16382 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
16385 CHECK_NUMBER (row
);
16387 if (vpos
>= 0 && vpos
< m
->nrows
)
16388 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
16389 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16394 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
16395 doc
: /* Toggle tracing of redisplay.
16396 With ARG, turn tracing on if and only if ARG is positive. */)
16400 trace_redisplay_p
= !trace_redisplay_p
;
16403 arg
= Fprefix_numeric_value (arg
);
16404 trace_redisplay_p
= XINT (arg
) > 0;
16411 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
16412 doc
: /* Like `format', but print result to stderr.
16413 usage: (trace-to-stderr STRING &rest OBJECTS) */)
16414 (int nargs
, Lisp_Object
*args
)
16416 Lisp_Object s
= Fformat (nargs
, args
);
16417 fprintf (stderr
, "%s", SDATA (s
));
16421 #endif /* GLYPH_DEBUG */
16425 /***********************************************************************
16426 Building Desired Matrix Rows
16427 ***********************************************************************/
16429 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
16430 Used for non-window-redisplay windows, and for windows w/o left fringe. */
16432 static struct glyph_row
*
16433 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
16435 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
16436 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16437 struct buffer
*old
= current_buffer
;
16438 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
16439 int arrow_len
= SCHARS (overlay_arrow_string
);
16440 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
16441 const unsigned char *p
;
16444 int n_glyphs_before
;
16446 set_buffer_temp (buffer
);
16447 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
16448 it
.glyph_row
->used
[TEXT_AREA
] = 0;
16449 SET_TEXT_POS (it
.position
, 0, 0);
16451 multibyte_p
= !NILP (buffer
->enable_multibyte_characters
);
16453 while (p
< arrow_end
)
16455 Lisp_Object face
, ilisp
;
16457 /* Get the next character. */
16459 it
.c
= string_char_and_length (p
, &it
.len
);
16461 it
.c
= *p
, it
.len
= 1;
16464 /* Get its face. */
16465 ilisp
= make_number (p
- arrow_string
);
16466 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
16467 it
.face_id
= compute_char_face (f
, it
.c
, face
);
16469 /* Compute its width, get its glyphs. */
16470 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
16471 SET_TEXT_POS (it
.position
, -1, -1);
16472 PRODUCE_GLYPHS (&it
);
16474 /* If this character doesn't fit any more in the line, we have
16475 to remove some glyphs. */
16476 if (it
.current_x
> it
.last_visible_x
)
16478 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
16483 set_buffer_temp (old
);
16484 return it
.glyph_row
;
16488 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
16489 glyphs are only inserted for terminal frames since we can't really
16490 win with truncation glyphs when partially visible glyphs are
16491 involved. Which glyphs to insert is determined by
16492 produce_special_glyphs. */
16495 insert_left_trunc_glyphs (struct it
*it
)
16497 struct it truncate_it
;
16498 struct glyph
*from
, *end
, *to
, *toend
;
16500 xassert (!FRAME_WINDOW_P (it
->f
));
16502 /* Get the truncation glyphs. */
16504 truncate_it
.current_x
= 0;
16505 truncate_it
.face_id
= DEFAULT_FACE_ID
;
16506 truncate_it
.glyph_row
= &scratch_glyph_row
;
16507 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
16508 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
16509 truncate_it
.object
= make_number (0);
16510 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
16512 /* Overwrite glyphs from IT with truncation glyphs. */
16513 if (!it
->glyph_row
->reversed_p
)
16515 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16516 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
16517 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16518 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
16523 /* There may be padding glyphs left over. Overwrite them too. */
16524 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
16526 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16532 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
16536 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
16537 that back to front. */
16538 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16539 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16540 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16541 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16543 while (from
>= end
&& to
>= toend
)
16545 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
16548 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
16549 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16550 while (from
>= end
&& to
>= toend
)
16555 /* Need to free some room before prepending additional
16557 int move_by
= from
- end
+ 1;
16558 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16559 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16561 for ( ; g
>= g0
; g
--)
16563 while (from
>= end
)
16565 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
16571 /* Compute the pixel height and width of IT->glyph_row.
16573 Most of the time, ascent and height of a display line will be equal
16574 to the max_ascent and max_height values of the display iterator
16575 structure. This is not the case if
16577 1. We hit ZV without displaying anything. In this case, max_ascent
16578 and max_height will be zero.
16580 2. We have some glyphs that don't contribute to the line height.
16581 (The glyph row flag contributes_to_line_height_p is for future
16582 pixmap extensions).
16584 The first case is easily covered by using default values because in
16585 these cases, the line height does not really matter, except that it
16586 must not be zero. */
16589 compute_line_metrics (struct it
*it
)
16591 struct glyph_row
*row
= it
->glyph_row
;
16594 if (FRAME_WINDOW_P (it
->f
))
16596 int i
, min_y
, max_y
;
16598 /* The line may consist of one space only, that was added to
16599 place the cursor on it. If so, the row's height hasn't been
16601 if (row
->height
== 0)
16603 if (it
->max_ascent
+ it
->max_descent
== 0)
16604 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
16605 row
->ascent
= it
->max_ascent
;
16606 row
->height
= it
->max_ascent
+ it
->max_descent
;
16607 row
->phys_ascent
= it
->max_phys_ascent
;
16608 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16609 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
16612 /* Compute the width of this line. */
16613 row
->pixel_width
= row
->x
;
16614 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
16615 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
16617 xassert (row
->pixel_width
>= 0);
16618 xassert (row
->ascent
>= 0 && row
->height
> 0);
16620 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
16621 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
16623 /* If first line's physical ascent is larger than its logical
16624 ascent, use the physical ascent, and make the row taller.
16625 This makes accented characters fully visible. */
16626 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
16627 && row
->phys_ascent
> row
->ascent
)
16629 row
->height
+= row
->phys_ascent
- row
->ascent
;
16630 row
->ascent
= row
->phys_ascent
;
16633 /* Compute how much of the line is visible. */
16634 row
->visible_height
= row
->height
;
16636 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
16637 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
16639 if (row
->y
< min_y
)
16640 row
->visible_height
-= min_y
- row
->y
;
16641 if (row
->y
+ row
->height
> max_y
)
16642 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16646 row
->pixel_width
= row
->used
[TEXT_AREA
];
16647 if (row
->continued_p
)
16648 row
->pixel_width
-= it
->continuation_pixel_width
;
16649 else if (row
->truncated_on_right_p
)
16650 row
->pixel_width
-= it
->truncation_pixel_width
;
16651 row
->ascent
= row
->phys_ascent
= 0;
16652 row
->height
= row
->phys_height
= row
->visible_height
= 1;
16653 row
->extra_line_spacing
= 0;
16656 /* Compute a hash code for this row. */
16658 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16659 for (i
= 0; i
< row
->used
[area
]; ++i
)
16660 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
16661 + row
->glyphs
[area
][i
].u
.val
16662 + row
->glyphs
[area
][i
].face_id
16663 + row
->glyphs
[area
][i
].padding_p
16664 + (row
->glyphs
[area
][i
].type
<< 2));
16666 it
->max_ascent
= it
->max_descent
= 0;
16667 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
16671 /* Append one space to the glyph row of iterator IT if doing a
16672 window-based redisplay. The space has the same face as
16673 IT->face_id. Value is non-zero if a space was added.
16675 This function is called to make sure that there is always one glyph
16676 at the end of a glyph row that the cursor can be set on under
16677 window-systems. (If there weren't such a glyph we would not know
16678 how wide and tall a box cursor should be displayed).
16680 At the same time this space let's a nicely handle clearing to the
16681 end of the line if the row ends in italic text. */
16684 append_space_for_newline (struct it
*it
, int default_face_p
)
16686 if (FRAME_WINDOW_P (it
->f
))
16688 int n
= it
->glyph_row
->used
[TEXT_AREA
];
16690 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
16691 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
16693 /* Save some values that must not be changed.
16694 Must save IT->c and IT->len because otherwise
16695 ITERATOR_AT_END_P wouldn't work anymore after
16696 append_space_for_newline has been called. */
16697 enum display_element_type saved_what
= it
->what
;
16698 int saved_c
= it
->c
, saved_len
= it
->len
;
16699 int saved_x
= it
->current_x
;
16700 int saved_face_id
= it
->face_id
;
16701 struct text_pos saved_pos
;
16702 Lisp_Object saved_object
;
16705 saved_object
= it
->object
;
16706 saved_pos
= it
->position
;
16708 it
->what
= IT_CHARACTER
;
16709 memset (&it
->position
, 0, sizeof it
->position
);
16710 it
->object
= make_number (0);
16714 if (default_face_p
)
16715 it
->face_id
= DEFAULT_FACE_ID
;
16716 else if (it
->face_before_selective_p
)
16717 it
->face_id
= it
->saved_face_id
;
16718 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
16719 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
16721 PRODUCE_GLYPHS (it
);
16723 it
->override_ascent
= -1;
16724 it
->constrain_row_ascent_descent_p
= 0;
16725 it
->current_x
= saved_x
;
16726 it
->object
= saved_object
;
16727 it
->position
= saved_pos
;
16728 it
->what
= saved_what
;
16729 it
->face_id
= saved_face_id
;
16730 it
->len
= saved_len
;
16740 /* Extend the face of the last glyph in the text area of IT->glyph_row
16741 to the end of the display line. Called from display_line. If the
16742 glyph row is empty, add a space glyph to it so that we know the
16743 face to draw. Set the glyph row flag fill_line_p. If the glyph
16744 row is R2L, prepend a stretch glyph to cover the empty space to the
16745 left of the leftmost glyph. */
16748 extend_face_to_end_of_line (struct it
*it
)
16751 struct frame
*f
= it
->f
;
16753 /* If line is already filled, do nothing. Non window-system frames
16754 get a grace of one more ``pixel'' because their characters are
16755 1-``pixel'' wide, so they hit the equality too early. This grace
16756 is needed only for R2L rows that are not continued, to produce
16757 one extra blank where we could display the cursor. */
16758 if (it
->current_x
>= it
->last_visible_x
16759 + (!FRAME_WINDOW_P (f
)
16760 && it
->glyph_row
->reversed_p
16761 && !it
->glyph_row
->continued_p
))
16764 /* Face extension extends the background and box of IT->face_id
16765 to the end of the line. If the background equals the background
16766 of the frame, we don't have to do anything. */
16767 if (it
->face_before_selective_p
)
16768 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
16770 face
= FACE_FROM_ID (f
, it
->face_id
);
16772 if (FRAME_WINDOW_P (f
)
16773 && it
->glyph_row
->displays_text_p
16774 && face
->box
== FACE_NO_BOX
16775 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
16777 && !it
->glyph_row
->reversed_p
)
16780 /* Set the glyph row flag indicating that the face of the last glyph
16781 in the text area has to be drawn to the end of the text area. */
16782 it
->glyph_row
->fill_line_p
= 1;
16784 /* If current character of IT is not ASCII, make sure we have the
16785 ASCII face. This will be automatically undone the next time
16786 get_next_display_element returns a multibyte character. Note
16787 that the character will always be single byte in unibyte
16789 if (!ASCII_CHAR_P (it
->c
))
16791 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
16794 if (FRAME_WINDOW_P (f
))
16796 /* If the row is empty, add a space with the current face of IT,
16797 so that we know which face to draw. */
16798 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
16800 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
16801 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
16802 it
->glyph_row
->used
[TEXT_AREA
] = 1;
16804 #ifdef HAVE_WINDOW_SYSTEM
16805 if (it
->glyph_row
->reversed_p
)
16807 /* Prepend a stretch glyph to the row, such that the
16808 rightmost glyph will be drawn flushed all the way to the
16809 right margin of the window. The stretch glyph that will
16810 occupy the empty space, if any, to the left of the
16812 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
16813 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16814 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
16816 int row_width
, stretch_ascent
, stretch_width
;
16817 struct text_pos saved_pos
;
16818 int saved_face_id
, saved_avoid_cursor
;
16820 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
16821 row_width
+= g
->pixel_width
;
16822 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
16823 if (stretch_width
> 0)
16826 (((it
->ascent
+ it
->descent
)
16827 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
16828 saved_pos
= it
->position
;
16829 memset (&it
->position
, 0, sizeof it
->position
);
16830 saved_avoid_cursor
= it
->avoid_cursor_p
;
16831 it
->avoid_cursor_p
= 1;
16832 saved_face_id
= it
->face_id
;
16833 /* The last row's stretch glyph should get the default
16834 face, to avoid painting the rest of the window with
16835 the region face, if the region ends at ZV. */
16836 if (it
->glyph_row
->ends_at_zv_p
)
16837 it
->face_id
= DEFAULT_FACE_ID
;
16839 it
->face_id
= face
->id
;
16840 append_stretch_glyph (it
, make_number (0), stretch_width
,
16841 it
->ascent
+ it
->descent
, stretch_ascent
);
16842 it
->position
= saved_pos
;
16843 it
->avoid_cursor_p
= saved_avoid_cursor
;
16844 it
->face_id
= saved_face_id
;
16847 #endif /* HAVE_WINDOW_SYSTEM */
16851 /* Save some values that must not be changed. */
16852 int saved_x
= it
->current_x
;
16853 struct text_pos saved_pos
;
16854 Lisp_Object saved_object
;
16855 enum display_element_type saved_what
= it
->what
;
16856 int saved_face_id
= it
->face_id
;
16858 saved_object
= it
->object
;
16859 saved_pos
= it
->position
;
16861 it
->what
= IT_CHARACTER
;
16862 memset (&it
->position
, 0, sizeof it
->position
);
16863 it
->object
= make_number (0);
16866 /* The last row's blank glyphs should get the default face, to
16867 avoid painting the rest of the window with the region face,
16868 if the region ends at ZV. */
16869 if (it
->glyph_row
->ends_at_zv_p
)
16870 it
->face_id
= DEFAULT_FACE_ID
;
16872 it
->face_id
= face
->id
;
16874 PRODUCE_GLYPHS (it
);
16876 while (it
->current_x
<= it
->last_visible_x
)
16877 PRODUCE_GLYPHS (it
);
16879 /* Don't count these blanks really. It would let us insert a left
16880 truncation glyph below and make us set the cursor on them, maybe. */
16881 it
->current_x
= saved_x
;
16882 it
->object
= saved_object
;
16883 it
->position
= saved_pos
;
16884 it
->what
= saved_what
;
16885 it
->face_id
= saved_face_id
;
16890 /* Value is non-zero if text starting at CHARPOS in current_buffer is
16891 trailing whitespace. */
16894 trailing_whitespace_p (int charpos
)
16896 int bytepos
= CHAR_TO_BYTE (charpos
);
16899 while (bytepos
< ZV_BYTE
16900 && (c
= FETCH_CHAR (bytepos
),
16901 c
== ' ' || c
== '\t'))
16904 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
16906 if (bytepos
!= PT_BYTE
)
16913 /* Highlight trailing whitespace, if any, in ROW. */
16916 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
16918 int used
= row
->used
[TEXT_AREA
];
16922 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
16923 struct glyph
*glyph
= start
+ used
- 1;
16925 if (row
->reversed_p
)
16927 /* Right-to-left rows need to be processed in the opposite
16928 direction, so swap the edge pointers. */
16930 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
16933 /* Skip over glyphs inserted to display the cursor at the
16934 end of a line, for extending the face of the last glyph
16935 to the end of the line on terminals, and for truncation
16936 and continuation glyphs. */
16937 if (!row
->reversed_p
)
16939 while (glyph
>= start
16940 && glyph
->type
== CHAR_GLYPH
16941 && INTEGERP (glyph
->object
))
16946 while (glyph
<= start
16947 && glyph
->type
== CHAR_GLYPH
16948 && INTEGERP (glyph
->object
))
16952 /* If last glyph is a space or stretch, and it's trailing
16953 whitespace, set the face of all trailing whitespace glyphs in
16954 IT->glyph_row to `trailing-whitespace'. */
16955 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
16956 && BUFFERP (glyph
->object
)
16957 && (glyph
->type
== STRETCH_GLYPH
16958 || (glyph
->type
== CHAR_GLYPH
16959 && glyph
->u
.ch
== ' '))
16960 && trailing_whitespace_p (glyph
->charpos
))
16962 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
16966 if (!row
->reversed_p
)
16968 while (glyph
>= start
16969 && BUFFERP (glyph
->object
)
16970 && (glyph
->type
== STRETCH_GLYPH
16971 || (glyph
->type
== CHAR_GLYPH
16972 && glyph
->u
.ch
== ' ')))
16973 (glyph
--)->face_id
= face_id
;
16977 while (glyph
<= start
16978 && BUFFERP (glyph
->object
)
16979 && (glyph
->type
== STRETCH_GLYPH
16980 || (glyph
->type
== CHAR_GLYPH
16981 && glyph
->u
.ch
== ' ')))
16982 (glyph
++)->face_id
= face_id
;
16989 /* Value is non-zero if glyph row ROW in window W should be
16990 used to hold the cursor. */
16993 cursor_row_p (struct window
*w
, struct glyph_row
*row
)
16995 int cursor_row_p
= 1;
16997 if (PT
== CHARPOS (row
->end
.pos
))
16999 /* Suppose the row ends on a string.
17000 Unless the row is continued, that means it ends on a newline
17001 in the string. If it's anything other than a display string
17002 (e.g. a before-string from an overlay), we don't want the
17003 cursor there. (This heuristic seems to give the optimal
17004 behavior for the various types of multi-line strings.) */
17005 if (CHARPOS (row
->end
.string_pos
) >= 0)
17007 if (row
->continued_p
)
17011 /* Check for `display' property. */
17012 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
17013 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
17014 struct glyph
*glyph
;
17017 for (glyph
= end
; glyph
>= beg
; --glyph
)
17018 if (STRINGP (glyph
->object
))
17021 = Fget_char_property (make_number (PT
),
17025 && display_prop_string_p (prop
, glyph
->object
));
17030 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
17032 /* If the row ends in middle of a real character,
17033 and the line is continued, we want the cursor here.
17034 That's because CHARPOS (ROW->end.pos) would equal
17035 PT if PT is before the character. */
17036 if (!row
->ends_in_ellipsis_p
)
17037 cursor_row_p
= row
->continued_p
;
17039 /* If the row ends in an ellipsis, then
17040 CHARPOS (ROW->end.pos) will equal point after the
17041 invisible text. We want that position to be displayed
17042 after the ellipsis. */
17045 /* If the row ends at ZV, display the cursor at the end of that
17046 row instead of at the start of the row below. */
17047 else if (row
->ends_at_zv_p
)
17053 return cursor_row_p
;
17058 /* Push the display property PROP so that it will be rendered at the
17059 current position in IT. Return 1 if PROP was successfully pushed,
17063 push_display_prop (struct it
*it
, Lisp_Object prop
)
17067 if (STRINGP (prop
))
17069 if (SCHARS (prop
) == 0)
17076 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
17077 it
->current
.overlay_string_index
= -1;
17078 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
17079 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
17080 it
->method
= GET_FROM_STRING
;
17081 it
->stop_charpos
= 0;
17083 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
17085 it
->method
= GET_FROM_STRETCH
;
17088 #ifdef HAVE_WINDOW_SYSTEM
17089 else if (IMAGEP (prop
))
17091 it
->what
= IT_IMAGE
;
17092 it
->image_id
= lookup_image (it
->f
, prop
);
17093 it
->method
= GET_FROM_IMAGE
;
17095 #endif /* HAVE_WINDOW_SYSTEM */
17098 pop_it (it
); /* bogus display property, give up */
17105 /* Return the character-property PROP at the current position in IT. */
17108 get_it_property (struct it
*it
, Lisp_Object prop
)
17110 Lisp_Object position
;
17112 if (STRINGP (it
->object
))
17113 position
= make_number (IT_STRING_CHARPOS (*it
));
17114 else if (BUFFERP (it
->object
))
17115 position
= make_number (IT_CHARPOS (*it
));
17119 return Fget_char_property (position
, prop
, it
->object
);
17122 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
17125 handle_line_prefix (struct it
*it
)
17127 Lisp_Object prefix
;
17128 if (it
->continuation_lines_width
> 0)
17130 prefix
= get_it_property (it
, Qwrap_prefix
);
17132 prefix
= Vwrap_prefix
;
17136 prefix
= get_it_property (it
, Qline_prefix
);
17138 prefix
= Vline_prefix
;
17140 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
17142 /* If the prefix is wider than the window, and we try to wrap
17143 it, it would acquire its own wrap prefix, and so on till the
17144 iterator stack overflows. So, don't wrap the prefix. */
17145 it
->line_wrap
= TRUNCATE
;
17146 it
->avoid_cursor_p
= 1;
17152 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
17153 only for R2L lines from display_line, when it decides that too many
17154 glyphs were produced by PRODUCE_GLYPHS, and the line needs to be
17157 unproduce_glyphs (struct it
*it
, int n
)
17159 struct glyph
*glyph
, *end
;
17161 xassert (it
->glyph_row
);
17162 xassert (it
->glyph_row
->reversed_p
);
17163 xassert (it
->area
== TEXT_AREA
);
17164 xassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
17166 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
17167 n
= it
->glyph_row
->used
[TEXT_AREA
];
17168 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
17169 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
17170 for ( ; glyph
< end
; glyph
++)
17171 glyph
[-n
] = *glyph
;
17174 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
17175 and ROW->maxpos. */
17177 find_row_edges (struct it
*it
, struct glyph_row
*row
,
17178 EMACS_INT min_pos
, EMACS_INT min_bpos
,
17179 EMACS_INT max_pos
, EMACS_INT max_bpos
)
17181 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17182 lines' rows is implemented for bidi-reordered rows. */
17184 /* ROW->minpos is the value of min_pos, the minimal buffer position
17187 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
17190 /* We didn't find _any_ valid buffer positions in any of the
17191 glyphs, so we must trust the iterator's computed
17193 row
->minpos
= row
->start
.pos
;
17194 max_pos
= CHARPOS (it
->current
.pos
);
17195 max_bpos
= BYTEPOS (it
->current
.pos
);
17201 /* Here are the various use-cases for ending the row, and the
17202 corresponding values for ROW->maxpos:
17204 Line ends in a newline from buffer eol_pos + 1
17205 Line is continued from buffer max_pos + 1
17206 Line is truncated on right it->current.pos
17207 Line ends in a newline from string max_pos
17208 Line is continued from string max_pos
17209 Line is continued from display vector max_pos
17210 Line is entirely from a string min_pos == max_pos
17211 Line is entirely from a display vector min_pos == max_pos
17212 Line that ends at ZV ZV
17214 If you discover other use-cases, please add them here as
17216 if (row
->ends_at_zv_p
)
17217 row
->maxpos
= it
->current
.pos
;
17218 else if (row
->used
[TEXT_AREA
])
17220 if (row
->ends_in_newline_from_string_p
)
17221 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17222 else if (CHARPOS (it
->eol_pos
) > 0)
17223 SET_TEXT_POS (row
->maxpos
,
17224 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
17225 else if (row
->continued_p
)
17227 /* If max_pos is different from IT's current position, it
17228 means IT->method does not belong to the display element
17229 at max_pos. However, it also means that the display
17230 element at max_pos was displayed in its entirety on this
17231 line, which is equivalent to saying that the next line
17232 starts at the next buffer position. */
17233 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
17234 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17237 INC_BOTH (max_pos
, max_bpos
);
17238 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17241 else if (row
->truncated_on_right_p
)
17242 /* display_line already called reseat_at_next_visible_line_start,
17243 which puts the iterator at the beginning of the next line, in
17244 the logical order. */
17245 row
->maxpos
= it
->current
.pos
;
17246 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
17247 /* A line that is entirely from a string/image/stretch... */
17248 row
->maxpos
= row
->minpos
;
17253 row
->maxpos
= it
->current
.pos
;
17256 /* Construct the glyph row IT->glyph_row in the desired matrix of
17257 IT->w from text at the current position of IT. See dispextern.h
17258 for an overview of struct it. Value is non-zero if
17259 IT->glyph_row displays text, as opposed to a line displaying ZV
17263 display_line (struct it
*it
)
17265 struct glyph_row
*row
= it
->glyph_row
;
17266 Lisp_Object overlay_arrow_string
;
17268 int may_wrap
= 0, wrap_x
;
17269 int wrap_row_used
= -1, wrap_row_ascent
, wrap_row_height
;
17270 int wrap_row_phys_ascent
, wrap_row_phys_height
;
17271 int wrap_row_extra_line_spacing
;
17272 EMACS_INT wrap_row_min_pos
, wrap_row_min_bpos
;
17273 EMACS_INT wrap_row_max_pos
, wrap_row_max_bpos
;
17275 EMACS_INT min_pos
= ZV
+ 1, min_bpos
, max_pos
= 0, max_bpos
;
17277 /* We always start displaying at hpos zero even if hscrolled. */
17278 xassert (it
->hpos
== 0 && it
->current_x
== 0);
17280 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
17281 >= it
->w
->desired_matrix
->nrows
)
17283 it
->w
->nrows_scale_factor
++;
17284 fonts_changed_p
= 1;
17288 /* Is IT->w showing the region? */
17289 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
17291 /* Clear the result glyph row and enable it. */
17292 prepare_desired_row (row
);
17294 row
->y
= it
->current_y
;
17295 row
->start
= it
->start
;
17296 row
->continuation_lines_width
= it
->continuation_lines_width
;
17297 row
->displays_text_p
= 1;
17298 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
17299 it
->starts_in_middle_of_char_p
= 0;
17301 /* Arrange the overlays nicely for our purposes. Usually, we call
17302 display_line on only one line at a time, in which case this
17303 can't really hurt too much, or we call it on lines which appear
17304 one after another in the buffer, in which case all calls to
17305 recenter_overlay_lists but the first will be pretty cheap. */
17306 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
17308 /* Move over display elements that are not visible because we are
17309 hscrolled. This may stop at an x-position < IT->first_visible_x
17310 if the first glyph is partially visible or if we hit a line end. */
17311 if (it
->current_x
< it
->first_visible_x
)
17313 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
17314 MOVE_TO_POS
| MOVE_TO_X
);
17318 /* We only do this when not calling `move_it_in_display_line_to'
17319 above, because move_it_in_display_line_to calls
17320 handle_line_prefix itself. */
17321 handle_line_prefix (it
);
17324 /* Get the initial row height. This is either the height of the
17325 text hscrolled, if there is any, or zero. */
17326 row
->ascent
= it
->max_ascent
;
17327 row
->height
= it
->max_ascent
+ it
->max_descent
;
17328 row
->phys_ascent
= it
->max_phys_ascent
;
17329 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
17330 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
17332 /* Utility macro to record max and min buffer positions seen until now. */
17333 #define RECORD_MAX_MIN_POS(IT) \
17336 if (IT_CHARPOS (*(IT)) < min_pos) \
17338 min_pos = IT_CHARPOS (*(IT)); \
17339 min_bpos = IT_BYTEPOS (*(IT)); \
17341 if (IT_CHARPOS (*(IT)) > max_pos) \
17343 max_pos = IT_CHARPOS (*(IT)); \
17344 max_bpos = IT_BYTEPOS (*(IT)); \
17349 /* Loop generating characters. The loop is left with IT on the next
17350 character to display. */
17353 int n_glyphs_before
, hpos_before
, x_before
;
17355 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
17357 /* Retrieve the next thing to display. Value is zero if end of
17359 if (!get_next_display_element (it
))
17361 /* Maybe add a space at the end of this line that is used to
17362 display the cursor there under X. Set the charpos of the
17363 first glyph of blank lines not corresponding to any text
17365 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17366 row
->exact_window_width_line_p
= 1;
17367 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
17368 || row
->used
[TEXT_AREA
] == 0)
17370 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
17371 row
->displays_text_p
= 0;
17373 if (!NILP (XBUFFER (it
->w
->buffer
)->indicate_empty_lines
)
17374 && (!MINI_WINDOW_P (it
->w
)
17375 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
17376 row
->indicate_empty_line_p
= 1;
17379 it
->continuation_lines_width
= 0;
17380 row
->ends_at_zv_p
= 1;
17381 /* A row that displays right-to-left text must always have
17382 its last face extended all the way to the end of line,
17383 even if this row ends in ZV, because we still write to
17384 the screen left to right. */
17385 if (row
->reversed_p
)
17386 extend_face_to_end_of_line (it
);
17390 /* Now, get the metrics of what we want to display. This also
17391 generates glyphs in `row' (which is IT->glyph_row). */
17392 n_glyphs_before
= row
->used
[TEXT_AREA
];
17395 /* Remember the line height so far in case the next element doesn't
17396 fit on the line. */
17397 if (it
->line_wrap
!= TRUNCATE
)
17399 ascent
= it
->max_ascent
;
17400 descent
= it
->max_descent
;
17401 phys_ascent
= it
->max_phys_ascent
;
17402 phys_descent
= it
->max_phys_descent
;
17404 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
17406 if (IT_DISPLAYING_WHITESPACE (it
))
17412 wrap_row_used
= row
->used
[TEXT_AREA
];
17413 wrap_row_ascent
= row
->ascent
;
17414 wrap_row_height
= row
->height
;
17415 wrap_row_phys_ascent
= row
->phys_ascent
;
17416 wrap_row_phys_height
= row
->phys_height
;
17417 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
17418 wrap_row_min_pos
= min_pos
;
17419 wrap_row_min_bpos
= min_bpos
;
17420 wrap_row_max_pos
= max_pos
;
17421 wrap_row_max_bpos
= max_bpos
;
17427 PRODUCE_GLYPHS (it
);
17429 /* If this display element was in marginal areas, continue with
17431 if (it
->area
!= TEXT_AREA
)
17433 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17434 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17435 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17436 row
->phys_height
= max (row
->phys_height
,
17437 it
->max_phys_ascent
+ it
->max_phys_descent
);
17438 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17439 it
->max_extra_line_spacing
);
17440 set_iterator_to_next (it
, 1);
17444 /* Does the display element fit on the line? If we truncate
17445 lines, we should draw past the right edge of the window. If
17446 we don't truncate, we want to stop so that we can display the
17447 continuation glyph before the right margin. If lines are
17448 continued, there are two possible strategies for characters
17449 resulting in more than 1 glyph (e.g. tabs): Display as many
17450 glyphs as possible in this line and leave the rest for the
17451 continuation line, or display the whole element in the next
17452 line. Original redisplay did the former, so we do it also. */
17453 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
17454 hpos_before
= it
->hpos
;
17457 if (/* Not a newline. */
17459 /* Glyphs produced fit entirely in the line. */
17460 && it
->current_x
< it
->last_visible_x
)
17462 it
->hpos
+= nglyphs
;
17463 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17464 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17465 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17466 row
->phys_height
= max (row
->phys_height
,
17467 it
->max_phys_ascent
+ it
->max_phys_descent
);
17468 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17469 it
->max_extra_line_spacing
);
17470 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
17471 row
->x
= x
- it
->first_visible_x
;
17472 /* Record the maximum and minimum buffer positions seen so
17473 far in glyphs that will be displayed by this row. */
17475 RECORD_MAX_MIN_POS (it
);
17480 struct glyph
*glyph
;
17482 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
17484 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
17485 new_x
= x
+ glyph
->pixel_width
;
17487 if (/* Lines are continued. */
17488 it
->line_wrap
!= TRUNCATE
17489 && (/* Glyph doesn't fit on the line. */
17490 new_x
> it
->last_visible_x
17491 /* Or it fits exactly on a window system frame. */
17492 || (new_x
== it
->last_visible_x
17493 && FRAME_WINDOW_P (it
->f
))))
17495 /* End of a continued line. */
17498 || (new_x
== it
->last_visible_x
17499 && FRAME_WINDOW_P (it
->f
)))
17501 /* Current glyph is the only one on the line or
17502 fits exactly on the line. We must continue
17503 the line because we can't draw the cursor
17504 after the glyph. */
17505 row
->continued_p
= 1;
17506 it
->current_x
= new_x
;
17507 it
->continuation_lines_width
+= new_x
;
17509 /* Record the maximum and minimum buffer
17510 positions seen so far in glyphs that will be
17511 displayed by this row. */
17513 RECORD_MAX_MIN_POS (it
);
17514 if (i
== nglyphs
- 1)
17516 /* If line-wrap is on, check if a previous
17517 wrap point was found. */
17518 if (wrap_row_used
> 0
17519 /* Even if there is a previous wrap
17520 point, continue the line here as
17521 usual, if (i) the previous character
17522 was a space or tab AND (ii) the
17523 current character is not. */
17525 || IT_DISPLAYING_WHITESPACE (it
)))
17528 set_iterator_to_next (it
, 1);
17529 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17531 if (!get_next_display_element (it
))
17533 row
->exact_window_width_line_p
= 1;
17534 it
->continuation_lines_width
= 0;
17535 row
->continued_p
= 0;
17536 row
->ends_at_zv_p
= 1;
17538 else if (ITERATOR_AT_END_OF_LINE_P (it
))
17540 row
->continued_p
= 0;
17541 row
->exact_window_width_line_p
= 1;
17546 else if (CHAR_GLYPH_PADDING_P (*glyph
)
17547 && !FRAME_WINDOW_P (it
->f
))
17549 /* A padding glyph that doesn't fit on this line.
17550 This means the whole character doesn't fit
17552 if (row
->reversed_p
)
17553 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17554 - n_glyphs_before
);
17555 row
->used
[TEXT_AREA
] = n_glyphs_before
;
17557 /* Fill the rest of the row with continuation
17558 glyphs like in 20.x. */
17559 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
17560 < row
->glyphs
[1 + TEXT_AREA
])
17561 produce_special_glyphs (it
, IT_CONTINUATION
);
17563 row
->continued_p
= 1;
17564 it
->current_x
= x_before
;
17565 it
->continuation_lines_width
+= x_before
;
17567 /* Restore the height to what it was before the
17568 element not fitting on the line. */
17569 it
->max_ascent
= ascent
;
17570 it
->max_descent
= descent
;
17571 it
->max_phys_ascent
= phys_ascent
;
17572 it
->max_phys_descent
= phys_descent
;
17574 else if (wrap_row_used
> 0)
17577 if (row
->reversed_p
)
17578 unproduce_glyphs (it
,
17579 row
->used
[TEXT_AREA
] - wrap_row_used
);
17581 it
->continuation_lines_width
+= wrap_x
;
17582 row
->used
[TEXT_AREA
] = wrap_row_used
;
17583 row
->ascent
= wrap_row_ascent
;
17584 row
->height
= wrap_row_height
;
17585 row
->phys_ascent
= wrap_row_phys_ascent
;
17586 row
->phys_height
= wrap_row_phys_height
;
17587 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
17588 min_pos
= wrap_row_min_pos
;
17589 min_bpos
= wrap_row_min_bpos
;
17590 max_pos
= wrap_row_max_pos
;
17591 max_bpos
= wrap_row_max_bpos
;
17592 row
->continued_p
= 1;
17593 row
->ends_at_zv_p
= 0;
17594 row
->exact_window_width_line_p
= 0;
17595 it
->continuation_lines_width
+= x
;
17597 /* Make sure that a non-default face is extended
17598 up to the right margin of the window. */
17599 extend_face_to_end_of_line (it
);
17601 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
17603 /* A TAB that extends past the right edge of the
17604 window. This produces a single glyph on
17605 window system frames. We leave the glyph in
17606 this row and let it fill the row, but don't
17607 consume the TAB. */
17608 it
->continuation_lines_width
+= it
->last_visible_x
;
17609 row
->ends_in_middle_of_char_p
= 1;
17610 row
->continued_p
= 1;
17611 glyph
->pixel_width
= it
->last_visible_x
- x
;
17612 it
->starts_in_middle_of_char_p
= 1;
17616 /* Something other than a TAB that draws past
17617 the right edge of the window. Restore
17618 positions to values before the element. */
17619 if (row
->reversed_p
)
17620 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17621 - (n_glyphs_before
+ i
));
17622 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
17624 /* Display continuation glyphs. */
17625 if (!FRAME_WINDOW_P (it
->f
))
17626 produce_special_glyphs (it
, IT_CONTINUATION
);
17627 row
->continued_p
= 1;
17629 it
->current_x
= x_before
;
17630 it
->continuation_lines_width
+= x
;
17631 extend_face_to_end_of_line (it
);
17633 if (nglyphs
> 1 && i
> 0)
17635 row
->ends_in_middle_of_char_p
= 1;
17636 it
->starts_in_middle_of_char_p
= 1;
17639 /* Restore the height to what it was before the
17640 element not fitting on the line. */
17641 it
->max_ascent
= ascent
;
17642 it
->max_descent
= descent
;
17643 it
->max_phys_ascent
= phys_ascent
;
17644 it
->max_phys_descent
= phys_descent
;
17649 else if (new_x
> it
->first_visible_x
)
17651 /* Increment number of glyphs actually displayed. */
17654 /* Record the maximum and minimum buffer positions
17655 seen so far in glyphs that will be displayed by
17658 RECORD_MAX_MIN_POS (it
);
17660 if (x
< it
->first_visible_x
)
17661 /* Glyph is partially visible, i.e. row starts at
17662 negative X position. */
17663 row
->x
= x
- it
->first_visible_x
;
17667 /* Glyph is completely off the left margin of the
17668 window. This should not happen because of the
17669 move_it_in_display_line at the start of this
17670 function, unless the text display area of the
17671 window is empty. */
17672 xassert (it
->first_visible_x
<= it
->last_visible_x
);
17676 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17677 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17678 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17679 row
->phys_height
= max (row
->phys_height
,
17680 it
->max_phys_ascent
+ it
->max_phys_descent
);
17681 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17682 it
->max_extra_line_spacing
);
17684 /* End of this display line if row is continued. */
17685 if (row
->continued_p
|| row
->ends_at_zv_p
)
17690 /* Is this a line end? If yes, we're also done, after making
17691 sure that a non-default face is extended up to the right
17692 margin of the window. */
17693 if (ITERATOR_AT_END_OF_LINE_P (it
))
17695 int used_before
= row
->used
[TEXT_AREA
];
17697 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
17699 /* Add a space at the end of the line that is used to
17700 display the cursor there. */
17701 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17702 append_space_for_newline (it
, 0);
17704 /* Extend the face to the end of the line. */
17705 extend_face_to_end_of_line (it
);
17707 /* Make sure we have the position. */
17708 if (used_before
== 0)
17709 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
17711 /* Record the position of the newline, for use in
17713 it
->eol_pos
= it
->current
.pos
;
17715 /* Consume the line end. This skips over invisible lines. */
17716 set_iterator_to_next (it
, 1);
17717 it
->continuation_lines_width
= 0;
17721 /* Proceed with next display element. Note that this skips
17722 over lines invisible because of selective display. */
17723 set_iterator_to_next (it
, 1);
17725 /* If we truncate lines, we are done when the last displayed
17726 glyphs reach past the right margin of the window. */
17727 if (it
->line_wrap
== TRUNCATE
17728 && (FRAME_WINDOW_P (it
->f
)
17729 ? (it
->current_x
>= it
->last_visible_x
)
17730 : (it
->current_x
> it
->last_visible_x
)))
17732 /* Maybe add truncation glyphs. */
17733 if (!FRAME_WINDOW_P (it
->f
))
17737 if (!row
->reversed_p
)
17739 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
17740 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17745 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
17746 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17748 /* Remove any padding glyphs at the front of ROW, to
17749 make room for the truncation glyphs we will be
17750 adding below. The loop below always inserts at
17751 least one truncation glyph, so also remove the
17752 last glyph added to ROW. */
17753 unproduce_glyphs (it
, i
+ 1);
17754 /* Adjust i for the loop below. */
17755 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
17758 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
17760 row
->used
[TEXT_AREA
] = i
;
17761 produce_special_glyphs (it
, IT_TRUNCATION
);
17764 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17766 /* Don't truncate if we can overflow newline into fringe. */
17767 if (!get_next_display_element (it
))
17769 it
->continuation_lines_width
= 0;
17770 row
->ends_at_zv_p
= 1;
17771 row
->exact_window_width_line_p
= 1;
17774 if (ITERATOR_AT_END_OF_LINE_P (it
))
17776 row
->exact_window_width_line_p
= 1;
17777 goto at_end_of_line
;
17781 row
->truncated_on_right_p
= 1;
17782 it
->continuation_lines_width
= 0;
17783 reseat_at_next_visible_line_start (it
, 0);
17784 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
17785 it
->hpos
= hpos_before
;
17786 it
->current_x
= x_before
;
17791 /* If line is not empty and hscrolled, maybe insert truncation glyphs
17792 at the left window margin. */
17793 if (it
->first_visible_x
17794 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
17796 if (!FRAME_WINDOW_P (it
->f
))
17797 insert_left_trunc_glyphs (it
);
17798 row
->truncated_on_left_p
= 1;
17801 /* If the start of this line is the overlay arrow-position, then
17802 mark this glyph row as the one containing the overlay arrow.
17803 This is clearly a mess with variable size fonts. It would be
17804 better to let it be displayed like cursors under X. */
17805 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
17806 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
17807 !NILP (overlay_arrow_string
)))
17809 /* Overlay arrow in window redisplay is a fringe bitmap. */
17810 if (STRINGP (overlay_arrow_string
))
17812 struct glyph_row
*arrow_row
17813 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
17814 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
17815 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
17816 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
17817 struct glyph
*p2
, *end
;
17819 /* Copy the arrow glyphs. */
17820 while (glyph
< arrow_end
)
17823 /* Throw away padding glyphs. */
17825 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17826 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
17832 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
17837 xassert (INTEGERP (overlay_arrow_string
));
17838 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
17840 overlay_arrow_seen
= 1;
17843 /* Compute pixel dimensions of this line. */
17844 compute_line_metrics (it
);
17846 /* Remember the position at which this line ends. */
17847 row
->end
= it
->current
;
17850 row
->minpos
= row
->start
.pos
;
17851 row
->maxpos
= row
->end
.pos
;
17855 /* ROW->minpos and ROW->maxpos must be the smallest and
17856 `1 + the largest' buffer positions in ROW. But if ROW was
17857 bidi-reordered, these two positions can be anywhere in the
17858 row, so we must determine them now. */
17859 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
17862 /* Record whether this row ends inside an ellipsis. */
17863 row
->ends_in_ellipsis_p
17864 = (it
->method
== GET_FROM_DISPLAY_VECTOR
17865 && it
->ellipsis_p
);
17867 /* Save fringe bitmaps in this row. */
17868 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
17869 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
17870 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
17871 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
17873 it
->left_user_fringe_bitmap
= 0;
17874 it
->left_user_fringe_face_id
= 0;
17875 it
->right_user_fringe_bitmap
= 0;
17876 it
->right_user_fringe_face_id
= 0;
17878 /* Maybe set the cursor. */
17879 cvpos
= it
->w
->cursor
.vpos
;
17881 /* In bidi-reordered rows, keep checking for proper cursor
17882 position even if one has been found already, because buffer
17883 positions in such rows change non-linearly with ROW->VPOS,
17884 when a line is continued. One exception: when we are at ZV,
17885 display cursor on the first suitable glyph row, since all
17886 the empty rows after that also have their position set to ZV. */
17887 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17888 lines' rows is implemented for bidi-reordered rows. */
17890 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
17891 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
17892 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
17893 && cursor_row_p (it
->w
, row
))
17894 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
17896 /* Highlight trailing whitespace. */
17897 if (!NILP (Vshow_trailing_whitespace
))
17898 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
17900 /* Prepare for the next line. This line starts horizontally at (X
17901 HPOS) = (0 0). Vertical positions are incremented. As a
17902 convenience for the caller, IT->glyph_row is set to the next
17904 it
->current_x
= it
->hpos
= 0;
17905 it
->current_y
+= row
->height
;
17906 SET_TEXT_POS (it
->eol_pos
, 0, 0);
17909 /* The next row should by default use the same value of the
17910 reversed_p flag as this one. set_iterator_to_next decides when
17911 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
17912 the flag accordingly. */
17913 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
17914 it
->glyph_row
->reversed_p
= row
->reversed_p
;
17915 it
->start
= row
->end
;
17916 return row
->displays_text_p
;
17918 #undef RECORD_MAX_MIN_POS
17921 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
17922 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
17923 doc
: /* Return paragraph direction at point in BUFFER.
17924 Value is either `left-to-right' or `right-to-left'.
17925 If BUFFER is omitted or nil, it defaults to the current buffer.
17927 Paragraph direction determines how the text in the paragraph is displayed.
17928 In left-to-right paragraphs, text begins at the left margin of the window
17929 and the reading direction is generally left to right. In right-to-left
17930 paragraphs, text begins at the right margin and is read from right to left.
17932 See also `bidi-paragraph-direction'. */)
17933 (Lisp_Object buffer
)
17935 struct buffer
*buf
;
17936 struct buffer
*old
;
17939 buf
= current_buffer
;
17942 CHECK_BUFFER (buffer
);
17943 buf
= XBUFFER (buffer
);
17944 old
= current_buffer
;
17947 if (NILP (buf
->bidi_display_reordering
))
17948 return Qleft_to_right
;
17949 else if (!NILP (buf
->bidi_paragraph_direction
))
17950 return buf
->bidi_paragraph_direction
;
17953 /* Determine the direction from buffer text. We could try to
17954 use current_matrix if it is up to date, but this seems fast
17955 enough as it is. */
17956 struct bidi_it itb
;
17957 EMACS_INT pos
= BUF_PT (buf
);
17958 EMACS_INT bytepos
= BUF_PT_BYTE (buf
);
17960 if (buf
!= current_buffer
)
17961 set_buffer_temp (buf
);
17962 /* Find previous non-empty line. */
17963 if (pos
>= ZV
&& pos
> BEGV
)
17966 bytepos
= CHAR_TO_BYTE (pos
);
17968 while (FETCH_BYTE (bytepos
) == '\n')
17970 if (bytepos
<= BEGV_BYTE
)
17975 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
17978 itb
.bytepos
= bytepos
;
17981 bidi_paragraph_init (NEUTRAL_DIR
, &itb
);
17982 if (buf
!= current_buffer
)
17983 set_buffer_temp (old
);
17984 switch (itb
.paragraph_dir
)
17987 return Qleft_to_right
;
17990 return Qright_to_left
;
18000 /***********************************************************************
18002 ***********************************************************************/
18004 /* Redisplay the menu bar in the frame for window W.
18006 The menu bar of X frames that don't have X toolkit support is
18007 displayed in a special window W->frame->menu_bar_window.
18009 The menu bar of terminal frames is treated specially as far as
18010 glyph matrices are concerned. Menu bar lines are not part of
18011 windows, so the update is done directly on the frame matrix rows
18012 for the menu bar. */
18015 display_menu_bar (struct window
*w
)
18017 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18022 /* Don't do all this for graphical frames. */
18024 if (FRAME_W32_P (f
))
18027 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
18033 if (FRAME_NS_P (f
))
18035 #endif /* HAVE_NS */
18037 #ifdef USE_X_TOOLKIT
18038 xassert (!FRAME_WINDOW_P (f
));
18039 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
18040 it
.first_visible_x
= 0;
18041 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18042 #else /* not USE_X_TOOLKIT */
18043 if (FRAME_WINDOW_P (f
))
18045 /* Menu bar lines are displayed in the desired matrix of the
18046 dummy window menu_bar_window. */
18047 struct window
*menu_w
;
18048 xassert (WINDOWP (f
->menu_bar_window
));
18049 menu_w
= XWINDOW (f
->menu_bar_window
);
18050 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
18052 it
.first_visible_x
= 0;
18053 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18057 /* This is a TTY frame, i.e. character hpos/vpos are used as
18059 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
18061 it
.first_visible_x
= 0;
18062 it
.last_visible_x
= FRAME_COLS (f
);
18064 #endif /* not USE_X_TOOLKIT */
18066 if (! mode_line_inverse_video
)
18067 /* Force the menu-bar to be displayed in the default face. */
18068 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18070 /* Clear all rows of the menu bar. */
18071 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
18073 struct glyph_row
*row
= it
.glyph_row
+ i
;
18074 clear_glyph_row (row
);
18075 row
->enabled_p
= 1;
18076 row
->full_width_p
= 1;
18079 /* Display all items of the menu bar. */
18080 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
18081 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
18083 Lisp_Object string
;
18085 /* Stop at nil string. */
18086 string
= AREF (items
, i
+ 1);
18090 /* Remember where item was displayed. */
18091 ASET (items
, i
+ 3, make_number (it
.hpos
));
18093 /* Display the item, pad with one space. */
18094 if (it
.current_x
< it
.last_visible_x
)
18095 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
18096 SCHARS (string
) + 1, 0, 0, -1);
18099 /* Fill out the line with spaces. */
18100 if (it
.current_x
< it
.last_visible_x
)
18101 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
18103 /* Compute the total height of the lines. */
18104 compute_line_metrics (&it
);
18109 /***********************************************************************
18111 ***********************************************************************/
18113 /* Redisplay mode lines in the window tree whose root is WINDOW. If
18114 FORCE is non-zero, redisplay mode lines unconditionally.
18115 Otherwise, redisplay only mode lines that are garbaged. Value is
18116 the number of windows whose mode lines were redisplayed. */
18119 redisplay_mode_lines (Lisp_Object window
, int force
)
18123 while (!NILP (window
))
18125 struct window
*w
= XWINDOW (window
);
18127 if (WINDOWP (w
->hchild
))
18128 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
18129 else if (WINDOWP (w
->vchild
))
18130 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
18132 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
18133 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
18135 struct text_pos lpoint
;
18136 struct buffer
*old
= current_buffer
;
18138 /* Set the window's buffer for the mode line display. */
18139 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
18140 set_buffer_internal_1 (XBUFFER (w
->buffer
));
18142 /* Point refers normally to the selected window. For any
18143 other window, set up appropriate value. */
18144 if (!EQ (window
, selected_window
))
18146 struct text_pos pt
;
18148 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
18149 if (CHARPOS (pt
) < BEGV
)
18150 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
18151 else if (CHARPOS (pt
) > (ZV
- 1))
18152 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
18154 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
18157 /* Display mode lines. */
18158 clear_glyph_matrix (w
->desired_matrix
);
18159 if (display_mode_lines (w
))
18162 w
->must_be_updated_p
= 1;
18165 /* Restore old settings. */
18166 set_buffer_internal_1 (old
);
18167 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
18177 /* Display the mode and/or header line of window W. Value is the
18178 sum number of mode lines and header lines displayed. */
18181 display_mode_lines (struct window
*w
)
18183 Lisp_Object old_selected_window
, old_selected_frame
;
18186 old_selected_frame
= selected_frame
;
18187 selected_frame
= w
->frame
;
18188 old_selected_window
= selected_window
;
18189 XSETWINDOW (selected_window
, w
);
18191 /* These will be set while the mode line specs are processed. */
18192 line_number_displayed
= 0;
18193 w
->column_number_displayed
= Qnil
;
18195 if (WINDOW_WANTS_MODELINE_P (w
))
18197 struct window
*sel_w
= XWINDOW (old_selected_window
);
18199 /* Select mode line face based on the real selected window. */
18200 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
18201 current_buffer
->mode_line_format
);
18205 if (WINDOW_WANTS_HEADER_LINE_P (w
))
18207 display_mode_line (w
, HEADER_LINE_FACE_ID
,
18208 current_buffer
->header_line_format
);
18212 selected_frame
= old_selected_frame
;
18213 selected_window
= old_selected_window
;
18218 /* Display mode or header line of window W. FACE_ID specifies which
18219 line to display; it is either MODE_LINE_FACE_ID or
18220 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
18221 display. Value is the pixel height of the mode/header line
18225 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
18229 int count
= SPECPDL_INDEX ();
18231 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
18232 /* Don't extend on a previously drawn mode-line.
18233 This may happen if called from pos_visible_p. */
18234 it
.glyph_row
->enabled_p
= 0;
18235 prepare_desired_row (it
.glyph_row
);
18237 it
.glyph_row
->mode_line_p
= 1;
18239 if (! mode_line_inverse_video
)
18240 /* Force the mode-line to be displayed in the default face. */
18241 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18243 record_unwind_protect (unwind_format_mode_line
,
18244 format_mode_line_unwind_data (NULL
, Qnil
, 0));
18246 mode_line_target
= MODE_LINE_DISPLAY
;
18248 /* Temporarily make frame's keyboard the current kboard so that
18249 kboard-local variables in the mode_line_format will get the right
18251 push_kboard (FRAME_KBOARD (it
.f
));
18252 record_unwind_save_match_data ();
18253 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
18256 unbind_to (count
, Qnil
);
18258 /* Fill up with spaces. */
18259 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
18261 compute_line_metrics (&it
);
18262 it
.glyph_row
->full_width_p
= 1;
18263 it
.glyph_row
->continued_p
= 0;
18264 it
.glyph_row
->truncated_on_left_p
= 0;
18265 it
.glyph_row
->truncated_on_right_p
= 0;
18267 /* Make a 3D mode-line have a shadow at its right end. */
18268 face
= FACE_FROM_ID (it
.f
, face_id
);
18269 extend_face_to_end_of_line (&it
);
18270 if (face
->box
!= FACE_NO_BOX
)
18272 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
18273 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
18274 last
->right_box_line_p
= 1;
18277 return it
.glyph_row
->height
;
18280 /* Move element ELT in LIST to the front of LIST.
18281 Return the updated list. */
18284 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
18286 register Lisp_Object tail
, prev
;
18287 register Lisp_Object tem
;
18291 while (CONSP (tail
))
18297 /* Splice out the link TAIL. */
18299 list
= XCDR (tail
);
18301 Fsetcdr (prev
, XCDR (tail
));
18303 /* Now make it the first. */
18304 Fsetcdr (tail
, list
);
18309 tail
= XCDR (tail
);
18313 /* Not found--return unchanged LIST. */
18317 /* Contribute ELT to the mode line for window IT->w. How it
18318 translates into text depends on its data type.
18320 IT describes the display environment in which we display, as usual.
18322 DEPTH is the depth in recursion. It is used to prevent
18323 infinite recursion here.
18325 FIELD_WIDTH is the number of characters the display of ELT should
18326 occupy in the mode line, and PRECISION is the maximum number of
18327 characters to display from ELT's representation. See
18328 display_string for details.
18330 Returns the hpos of the end of the text generated by ELT.
18332 PROPS is a property list to add to any string we encounter.
18334 If RISKY is nonzero, remove (disregard) any properties in any string
18335 we encounter, and ignore :eval and :propertize.
18337 The global variable `mode_line_target' determines whether the
18338 output is passed to `store_mode_line_noprop',
18339 `store_mode_line_string', or `display_string'. */
18342 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
18343 Lisp_Object elt
, Lisp_Object props
, int risky
)
18345 int n
= 0, field
, prec
;
18350 elt
= build_string ("*too-deep*");
18354 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
18358 /* A string: output it and check for %-constructs within it. */
18362 if (SCHARS (elt
) > 0
18363 && (!NILP (props
) || risky
))
18365 Lisp_Object oprops
, aelt
;
18366 oprops
= Ftext_properties_at (make_number (0), elt
);
18368 /* If the starting string's properties are not what
18369 we want, translate the string. Also, if the string
18370 is risky, do that anyway. */
18372 if (NILP (Fequal (props
, oprops
)) || risky
)
18374 /* If the starting string has properties,
18375 merge the specified ones onto the existing ones. */
18376 if (! NILP (oprops
) && !risky
)
18380 oprops
= Fcopy_sequence (oprops
);
18382 while (CONSP (tem
))
18384 oprops
= Fplist_put (oprops
, XCAR (tem
),
18385 XCAR (XCDR (tem
)));
18386 tem
= XCDR (XCDR (tem
));
18391 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
18392 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
18394 /* AELT is what we want. Move it to the front
18395 without consing. */
18397 mode_line_proptrans_alist
18398 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
18404 /* If AELT has the wrong props, it is useless.
18405 so get rid of it. */
18407 mode_line_proptrans_alist
18408 = Fdelq (aelt
, mode_line_proptrans_alist
);
18410 elt
= Fcopy_sequence (elt
);
18411 Fset_text_properties (make_number (0), Flength (elt
),
18413 /* Add this item to mode_line_proptrans_alist. */
18414 mode_line_proptrans_alist
18415 = Fcons (Fcons (elt
, props
),
18416 mode_line_proptrans_alist
);
18417 /* Truncate mode_line_proptrans_alist
18418 to at most 50 elements. */
18419 tem
= Fnthcdr (make_number (50),
18420 mode_line_proptrans_alist
);
18422 XSETCDR (tem
, Qnil
);
18431 prec
= precision
- n
;
18432 switch (mode_line_target
)
18434 case MODE_LINE_NOPROP
:
18435 case MODE_LINE_TITLE
:
18436 n
+= store_mode_line_noprop (SDATA (elt
), -1, prec
);
18438 case MODE_LINE_STRING
:
18439 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
18441 case MODE_LINE_DISPLAY
:
18442 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
18443 0, prec
, 0, STRING_MULTIBYTE (elt
));
18450 /* Handle the non-literal case. */
18452 while ((precision
<= 0 || n
< precision
)
18453 && SREF (elt
, offset
) != 0
18454 && (mode_line_target
!= MODE_LINE_DISPLAY
18455 || it
->current_x
< it
->last_visible_x
))
18457 int last_offset
= offset
;
18459 /* Advance to end of string or next format specifier. */
18460 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
18463 if (offset
- 1 != last_offset
)
18465 int nchars
, nbytes
;
18467 /* Output to end of string or up to '%'. Field width
18468 is length of string. Don't output more than
18469 PRECISION allows us. */
18472 prec
= c_string_width (SDATA (elt
) + last_offset
,
18473 offset
- last_offset
, precision
- n
,
18476 switch (mode_line_target
)
18478 case MODE_LINE_NOPROP
:
18479 case MODE_LINE_TITLE
:
18480 n
+= store_mode_line_noprop (SDATA (elt
) + last_offset
, 0, prec
);
18482 case MODE_LINE_STRING
:
18484 int bytepos
= last_offset
;
18485 int charpos
= string_byte_to_char (elt
, bytepos
);
18486 int endpos
= (precision
<= 0
18487 ? string_byte_to_char (elt
, offset
)
18488 : charpos
+ nchars
);
18490 n
+= store_mode_line_string (NULL
,
18491 Fsubstring (elt
, make_number (charpos
),
18492 make_number (endpos
)),
18496 case MODE_LINE_DISPLAY
:
18498 int bytepos
= last_offset
;
18499 int charpos
= string_byte_to_char (elt
, bytepos
);
18501 if (precision
<= 0)
18502 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
18503 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
18505 STRING_MULTIBYTE (elt
));
18510 else /* c == '%' */
18512 int percent_position
= offset
;
18514 /* Get the specified minimum width. Zero means
18517 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
18518 field
= field
* 10 + c
- '0';
18520 /* Don't pad beyond the total padding allowed. */
18521 if (field_width
- n
> 0 && field
> field_width
- n
)
18522 field
= field_width
- n
;
18524 /* Note that either PRECISION <= 0 or N < PRECISION. */
18525 prec
= precision
- n
;
18528 n
+= display_mode_element (it
, depth
, field
, prec
,
18529 Vglobal_mode_string
, props
,
18534 int bytepos
, charpos
;
18535 unsigned char *spec
;
18536 Lisp_Object string
;
18538 bytepos
= percent_position
;
18539 charpos
= (STRING_MULTIBYTE (elt
)
18540 ? string_byte_to_char (elt
, bytepos
)
18542 spec
= decode_mode_spec (it
->w
, c
, field
, prec
, &string
);
18543 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
18545 switch (mode_line_target
)
18547 case MODE_LINE_NOPROP
:
18548 case MODE_LINE_TITLE
:
18549 n
+= store_mode_line_noprop (spec
, field
, prec
);
18551 case MODE_LINE_STRING
:
18553 int len
= strlen (spec
);
18554 Lisp_Object tem
= make_string (spec
, len
);
18555 props
= Ftext_properties_at (make_number (charpos
), elt
);
18556 /* Should only keep face property in props */
18557 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
18560 case MODE_LINE_DISPLAY
:
18562 int nglyphs_before
, nwritten
;
18564 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
18565 nwritten
= display_string (spec
, string
, elt
,
18570 /* Assign to the glyphs written above the
18571 string where the `%x' came from, position
18575 struct glyph
*glyph
18576 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
18580 for (i
= 0; i
< nwritten
; ++i
)
18582 glyph
[i
].object
= elt
;
18583 glyph
[i
].charpos
= charpos
;
18600 /* A symbol: process the value of the symbol recursively
18601 as if it appeared here directly. Avoid error if symbol void.
18602 Special case: if value of symbol is a string, output the string
18605 register Lisp_Object tem
;
18607 /* If the variable is not marked as risky to set
18608 then its contents are risky to use. */
18609 if (NILP (Fget (elt
, Qrisky_local_variable
)))
18612 tem
= Fboundp (elt
);
18615 tem
= Fsymbol_value (elt
);
18616 /* If value is a string, output that string literally:
18617 don't check for % within it. */
18621 if (!EQ (tem
, elt
))
18623 /* Give up right away for nil or t. */
18633 register Lisp_Object car
, tem
;
18635 /* A cons cell: five distinct cases.
18636 If first element is :eval or :propertize, do something special.
18637 If first element is a string or a cons, process all the elements
18638 and effectively concatenate them.
18639 If first element is a negative number, truncate displaying cdr to
18640 at most that many characters. If positive, pad (with spaces)
18641 to at least that many characters.
18642 If first element is a symbol, process the cadr or caddr recursively
18643 according to whether the symbol's value is non-nil or nil. */
18645 if (EQ (car
, QCeval
))
18647 /* An element of the form (:eval FORM) means evaluate FORM
18648 and use the result as mode line elements. */
18653 if (CONSP (XCDR (elt
)))
18656 spec
= safe_eval (XCAR (XCDR (elt
)));
18657 n
+= display_mode_element (it
, depth
, field_width
- n
,
18658 precision
- n
, spec
, props
,
18662 else if (EQ (car
, QCpropertize
))
18664 /* An element of the form (:propertize ELT PROPS...)
18665 means display ELT but applying properties PROPS. */
18670 if (CONSP (XCDR (elt
)))
18671 n
+= display_mode_element (it
, depth
, field_width
- n
,
18672 precision
- n
, XCAR (XCDR (elt
)),
18673 XCDR (XCDR (elt
)), risky
);
18675 else if (SYMBOLP (car
))
18677 tem
= Fboundp (car
);
18681 /* elt is now the cdr, and we know it is a cons cell.
18682 Use its car if CAR has a non-nil value. */
18685 tem
= Fsymbol_value (car
);
18692 /* Symbol's value is nil (or symbol is unbound)
18693 Get the cddr of the original list
18694 and if possible find the caddr and use that. */
18698 else if (!CONSP (elt
))
18703 else if (INTEGERP (car
))
18705 register int lim
= XINT (car
);
18709 /* Negative int means reduce maximum width. */
18710 if (precision
<= 0)
18713 precision
= min (precision
, -lim
);
18717 /* Padding specified. Don't let it be more than
18718 current maximum. */
18720 lim
= min (precision
, lim
);
18722 /* If that's more padding than already wanted, queue it.
18723 But don't reduce padding already specified even if
18724 that is beyond the current truncation point. */
18725 field_width
= max (lim
, field_width
);
18729 else if (STRINGP (car
) || CONSP (car
))
18731 Lisp_Object halftail
= elt
;
18735 && (precision
<= 0 || n
< precision
))
18737 n
+= display_mode_element (it
, depth
,
18738 /* Do padding only after the last
18739 element in the list. */
18740 (! CONSP (XCDR (elt
))
18743 precision
- n
, XCAR (elt
),
18747 if ((len
& 1) == 0)
18748 halftail
= XCDR (halftail
);
18749 /* Check for cycle. */
18750 if (EQ (halftail
, elt
))
18759 elt
= build_string ("*invalid*");
18763 /* Pad to FIELD_WIDTH. */
18764 if (field_width
> 0 && n
< field_width
)
18766 switch (mode_line_target
)
18768 case MODE_LINE_NOPROP
:
18769 case MODE_LINE_TITLE
:
18770 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
18772 case MODE_LINE_STRING
:
18773 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
18775 case MODE_LINE_DISPLAY
:
18776 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
18785 /* Store a mode-line string element in mode_line_string_list.
18787 If STRING is non-null, display that C string. Otherwise, the Lisp
18788 string LISP_STRING is displayed.
18790 FIELD_WIDTH is the minimum number of output glyphs to produce.
18791 If STRING has fewer characters than FIELD_WIDTH, pad to the right
18792 with spaces. FIELD_WIDTH <= 0 means don't pad.
18794 PRECISION is the maximum number of characters to output from
18795 STRING. PRECISION <= 0 means don't truncate the string.
18797 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
18798 properties to the string.
18800 PROPS are the properties to add to the string.
18801 The mode_line_string_face face property is always added to the string.
18805 store_mode_line_string (char *string
, Lisp_Object lisp_string
, int copy_string
,
18806 int field_width
, int precision
, Lisp_Object props
)
18811 if (string
!= NULL
)
18813 len
= strlen (string
);
18814 if (precision
> 0 && len
> precision
)
18816 lisp_string
= make_string (string
, len
);
18818 props
= mode_line_string_face_prop
;
18819 else if (!NILP (mode_line_string_face
))
18821 Lisp_Object face
= Fplist_get (props
, Qface
);
18822 props
= Fcopy_sequence (props
);
18824 face
= mode_line_string_face
;
18826 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
18827 props
= Fplist_put (props
, Qface
, face
);
18829 Fadd_text_properties (make_number (0), make_number (len
),
18830 props
, lisp_string
);
18834 len
= XFASTINT (Flength (lisp_string
));
18835 if (precision
> 0 && len
> precision
)
18838 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
18841 if (!NILP (mode_line_string_face
))
18845 props
= Ftext_properties_at (make_number (0), lisp_string
);
18846 face
= Fplist_get (props
, Qface
);
18848 face
= mode_line_string_face
;
18850 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
18851 props
= Fcons (Qface
, Fcons (face
, Qnil
));
18853 lisp_string
= Fcopy_sequence (lisp_string
);
18856 Fadd_text_properties (make_number (0), make_number (len
),
18857 props
, lisp_string
);
18862 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
18866 if (field_width
> len
)
18868 field_width
-= len
;
18869 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
18871 Fadd_text_properties (make_number (0), make_number (field_width
),
18872 props
, lisp_string
);
18873 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
18881 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
18883 doc
: /* Format a string out of a mode line format specification.
18884 First arg FORMAT specifies the mode line format (see `mode-line-format'
18885 for details) to use.
18887 Optional second arg FACE specifies the face property to put
18888 on all characters for which no face is specified.
18889 The value t means whatever face the window's mode line currently uses
18890 \(either `mode-line' or `mode-line-inactive', depending).
18891 A value of nil means the default is no face property.
18892 If FACE is an integer, the value string has no text properties.
18894 Optional third and fourth args WINDOW and BUFFER specify the window
18895 and buffer to use as the context for the formatting (defaults
18896 are the selected window and the window's buffer). */)
18897 (Lisp_Object format
, Lisp_Object face
, Lisp_Object window
, Lisp_Object buffer
)
18902 struct buffer
*old_buffer
= NULL
;
18904 int no_props
= INTEGERP (face
);
18905 int count
= SPECPDL_INDEX ();
18907 int string_start
= 0;
18910 window
= selected_window
;
18911 CHECK_WINDOW (window
);
18912 w
= XWINDOW (window
);
18915 buffer
= w
->buffer
;
18916 CHECK_BUFFER (buffer
);
18918 /* Make formatting the modeline a non-op when noninteractive, otherwise
18919 there will be problems later caused by a partially initialized frame. */
18920 if (NILP (format
) || noninteractive
)
18921 return empty_unibyte_string
;
18929 face
= (EQ (window
, selected_window
) ? Qmode_line
: Qmode_line_inactive
);
18930 face_id
= lookup_named_face (XFRAME (WINDOW_FRAME (w
)), face
, 0);
18934 face_id
= DEFAULT_FACE_ID
;
18936 if (XBUFFER (buffer
) != current_buffer
)
18937 old_buffer
= current_buffer
;
18939 /* Save things including mode_line_proptrans_alist,
18940 and set that to nil so that we don't alter the outer value. */
18941 record_unwind_protect (unwind_format_mode_line
,
18942 format_mode_line_unwind_data
18943 (old_buffer
, selected_window
, 1));
18944 mode_line_proptrans_alist
= Qnil
;
18946 Fselect_window (window
, Qt
);
18948 set_buffer_internal_1 (XBUFFER (buffer
));
18950 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
18954 mode_line_target
= MODE_LINE_NOPROP
;
18955 mode_line_string_face_prop
= Qnil
;
18956 mode_line_string_list
= Qnil
;
18957 string_start
= MODE_LINE_NOPROP_LEN (0);
18961 mode_line_target
= MODE_LINE_STRING
;
18962 mode_line_string_list
= Qnil
;
18963 mode_line_string_face
= face
;
18964 mode_line_string_face_prop
18965 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
18968 push_kboard (FRAME_KBOARD (it
.f
));
18969 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
18974 len
= MODE_LINE_NOPROP_LEN (string_start
);
18975 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
18979 mode_line_string_list
= Fnreverse (mode_line_string_list
);
18980 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
18981 empty_unibyte_string
);
18984 unbind_to (count
, Qnil
);
18988 /* Write a null-terminated, right justified decimal representation of
18989 the positive integer D to BUF using a minimal field width WIDTH. */
18992 pint2str (register char *buf
, register int width
, register int d
)
18994 register char *p
= buf
;
19002 *p
++ = d
% 10 + '0';
19007 for (width
-= (int) (p
- buf
); width
> 0; --width
)
19018 /* Write a null-terminated, right justified decimal and "human
19019 readable" representation of the nonnegative integer D to BUF using
19020 a minimal field width WIDTH. D should be smaller than 999.5e24. */
19022 static const char power_letter
[] =
19036 pint2hrstr (char *buf
, int width
, int d
)
19038 /* We aim to represent the nonnegative integer D as
19039 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
19042 /* -1 means: do not use TENTHS. */
19046 /* Length of QUOTIENT.TENTHS as a string. */
19052 if (1000 <= quotient
)
19054 /* Scale to the appropriate EXPONENT. */
19057 remainder
= quotient
% 1000;
19061 while (1000 <= quotient
);
19063 /* Round to nearest and decide whether to use TENTHS or not. */
19066 tenths
= remainder
/ 100;
19067 if (50 <= remainder
% 100)
19074 if (quotient
== 10)
19082 if (500 <= remainder
)
19084 if (quotient
< 999)
19095 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
19096 if (tenths
== -1 && quotient
<= 99)
19103 p
= psuffix
= buf
+ max (width
, length
);
19105 /* Print EXPONENT. */
19107 *psuffix
++ = power_letter
[exponent
];
19110 /* Print TENTHS. */
19113 *--p
= '0' + tenths
;
19117 /* Print QUOTIENT. */
19120 int digit
= quotient
% 10;
19121 *--p
= '0' + digit
;
19123 while ((quotient
/= 10) != 0);
19125 /* Print leading spaces. */
19130 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
19131 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
19132 type of CODING_SYSTEM. Return updated pointer into BUF. */
19134 static unsigned char invalid_eol_type
[] = "(*invalid*)";
19137 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
19140 int multibyte
= !NILP (current_buffer
->enable_multibyte_characters
);
19141 const unsigned char *eol_str
;
19143 /* The EOL conversion we are using. */
19144 Lisp_Object eoltype
;
19146 val
= CODING_SYSTEM_SPEC (coding_system
);
19149 if (!VECTORP (val
)) /* Not yet decided. */
19154 eoltype
= eol_mnemonic_undecided
;
19155 /* Don't mention EOL conversion if it isn't decided. */
19160 Lisp_Object eolvalue
;
19162 attrs
= AREF (val
, 0);
19163 eolvalue
= AREF (val
, 2);
19166 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
19170 /* The EOL conversion that is normal on this system. */
19172 if (NILP (eolvalue
)) /* Not yet decided. */
19173 eoltype
= eol_mnemonic_undecided
;
19174 else if (VECTORP (eolvalue
)) /* Not yet decided. */
19175 eoltype
= eol_mnemonic_undecided
;
19176 else /* eolvalue is Qunix, Qdos, or Qmac. */
19177 eoltype
= (EQ (eolvalue
, Qunix
)
19178 ? eol_mnemonic_unix
19179 : (EQ (eolvalue
, Qdos
) == 1
19180 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
19186 /* Mention the EOL conversion if it is not the usual one. */
19187 if (STRINGP (eoltype
))
19189 eol_str
= SDATA (eoltype
);
19190 eol_str_len
= SBYTES (eoltype
);
19192 else if (CHARACTERP (eoltype
))
19194 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
19195 eol_str_len
= CHAR_STRING (XINT (eoltype
), tmp
);
19200 eol_str
= invalid_eol_type
;
19201 eol_str_len
= sizeof (invalid_eol_type
) - 1;
19203 memcpy (buf
, eol_str
, eol_str_len
);
19204 buf
+= eol_str_len
;
19210 /* Return a string for the output of a mode line %-spec for window W,
19211 generated by character C. PRECISION >= 0 means don't return a
19212 string longer than that value. FIELD_WIDTH > 0 means pad the
19213 string returned with spaces to that value. Return a Lisp string in
19214 *STRING if the resulting string is taken from that Lisp string.
19216 Note we operate on the current buffer for most purposes,
19217 the exception being w->base_line_pos. */
19219 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
19222 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
19223 int precision
, Lisp_Object
*string
)
19226 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19227 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
19228 struct buffer
*b
= current_buffer
;
19236 if (!NILP (b
->read_only
))
19238 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19243 /* This differs from %* only for a modified read-only buffer. */
19244 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19246 if (!NILP (b
->read_only
))
19251 /* This differs from %* in ignoring read-only-ness. */
19252 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19264 if (command_loop_level
> 5)
19266 p
= decode_mode_spec_buf
;
19267 for (i
= 0; i
< command_loop_level
; i
++)
19270 return decode_mode_spec_buf
;
19278 if (command_loop_level
> 5)
19280 p
= decode_mode_spec_buf
;
19281 for (i
= 0; i
< command_loop_level
; i
++)
19284 return decode_mode_spec_buf
;
19291 /* Let lots_of_dashes be a string of infinite length. */
19292 if (mode_line_target
== MODE_LINE_NOPROP
||
19293 mode_line_target
== MODE_LINE_STRING
)
19295 if (field_width
<= 0
19296 || field_width
> sizeof (lots_of_dashes
))
19298 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
19299 decode_mode_spec_buf
[i
] = '-';
19300 decode_mode_spec_buf
[i
] = '\0';
19301 return decode_mode_spec_buf
;
19304 return lots_of_dashes
;
19312 /* %c and %l are ignored in `frame-title-format'.
19313 (In redisplay_internal, the frame title is drawn _before_ the
19314 windows are updated, so the stuff which depends on actual
19315 window contents (such as %l) may fail to render properly, or
19316 even crash emacs.) */
19317 if (mode_line_target
== MODE_LINE_TITLE
)
19321 int col
= (int) current_column (); /* iftc */
19322 w
->column_number_displayed
= make_number (col
);
19323 pint2str (decode_mode_spec_buf
, field_width
, col
);
19324 return decode_mode_spec_buf
;
19328 #ifndef SYSTEM_MALLOC
19330 if (NILP (Vmemory_full
))
19333 return "!MEM FULL! ";
19340 /* %F displays the frame name. */
19341 if (!NILP (f
->title
))
19342 return (char *) SDATA (f
->title
);
19343 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
19344 return (char *) SDATA (f
->name
);
19353 int size
= ZV
- BEGV
;
19354 pint2str (decode_mode_spec_buf
, field_width
, size
);
19355 return decode_mode_spec_buf
;
19360 int size
= ZV
- BEGV
;
19361 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
19362 return decode_mode_spec_buf
;
19367 int startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
19368 int topline
, nlines
, junk
, height
;
19370 /* %c and %l are ignored in `frame-title-format'. */
19371 if (mode_line_target
== MODE_LINE_TITLE
)
19374 startpos
= XMARKER (w
->start
)->charpos
;
19375 startpos_byte
= marker_byte_position (w
->start
);
19376 height
= WINDOW_TOTAL_LINES (w
);
19378 /* If we decided that this buffer isn't suitable for line numbers,
19379 don't forget that too fast. */
19380 if (EQ (w
->base_line_pos
, w
->buffer
))
19382 /* But do forget it, if the window shows a different buffer now. */
19383 else if (BUFFERP (w
->base_line_pos
))
19384 w
->base_line_pos
= Qnil
;
19386 /* If the buffer is very big, don't waste time. */
19387 if (INTEGERP (Vline_number_display_limit
)
19388 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
19390 w
->base_line_pos
= Qnil
;
19391 w
->base_line_number
= Qnil
;
19395 if (INTEGERP (w
->base_line_number
)
19396 && INTEGERP (w
->base_line_pos
)
19397 && XFASTINT (w
->base_line_pos
) <= startpos
)
19399 line
= XFASTINT (w
->base_line_number
);
19400 linepos
= XFASTINT (w
->base_line_pos
);
19401 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
19406 linepos
= BUF_BEGV (b
);
19407 linepos_byte
= BUF_BEGV_BYTE (b
);
19410 /* Count lines from base line to window start position. */
19411 nlines
= display_count_lines (linepos
, linepos_byte
,
19415 topline
= nlines
+ line
;
19417 /* Determine a new base line, if the old one is too close
19418 or too far away, or if we did not have one.
19419 "Too close" means it's plausible a scroll-down would
19420 go back past it. */
19421 if (startpos
== BUF_BEGV (b
))
19423 w
->base_line_number
= make_number (topline
);
19424 w
->base_line_pos
= make_number (BUF_BEGV (b
));
19426 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
19427 || linepos
== BUF_BEGV (b
))
19429 int limit
= BUF_BEGV (b
);
19430 int limit_byte
= BUF_BEGV_BYTE (b
);
19432 int distance
= (height
* 2 + 30) * line_number_display_limit_width
;
19434 if (startpos
- distance
> limit
)
19436 limit
= startpos
- distance
;
19437 limit_byte
= CHAR_TO_BYTE (limit
);
19440 nlines
= display_count_lines (startpos
, startpos_byte
,
19442 - (height
* 2 + 30),
19444 /* If we couldn't find the lines we wanted within
19445 line_number_display_limit_width chars per line,
19446 give up on line numbers for this window. */
19447 if (position
== limit_byte
&& limit
== startpos
- distance
)
19449 w
->base_line_pos
= w
->buffer
;
19450 w
->base_line_number
= Qnil
;
19454 w
->base_line_number
= make_number (topline
- nlines
);
19455 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
19458 /* Now count lines from the start pos to point. */
19459 nlines
= display_count_lines (startpos
, startpos_byte
,
19460 PT_BYTE
, PT
, &junk
);
19462 /* Record that we did display the line number. */
19463 line_number_displayed
= 1;
19465 /* Make the string to show. */
19466 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
19467 return decode_mode_spec_buf
;
19470 char* p
= decode_mode_spec_buf
;
19471 int pad
= field_width
- 2;
19477 return decode_mode_spec_buf
;
19483 obj
= b
->mode_name
;
19487 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
19493 int pos
= marker_position (w
->start
);
19494 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
19496 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
19498 if (pos
<= BUF_BEGV (b
))
19503 else if (pos
<= BUF_BEGV (b
))
19507 if (total
> 1000000)
19508 /* Do it differently for a large value, to avoid overflow. */
19509 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19511 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19512 /* We can't normally display a 3-digit number,
19513 so get us a 2-digit number that is close. */
19516 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
19517 return decode_mode_spec_buf
;
19521 /* Display percentage of size above the bottom of the screen. */
19524 int toppos
= marker_position (w
->start
);
19525 int botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
19526 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
19528 if (botpos
>= BUF_ZV (b
))
19530 if (toppos
<= BUF_BEGV (b
))
19537 if (total
> 1000000)
19538 /* Do it differently for a large value, to avoid overflow. */
19539 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19541 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19542 /* We can't normally display a 3-digit number,
19543 so get us a 2-digit number that is close. */
19546 if (toppos
<= BUF_BEGV (b
))
19547 sprintf (decode_mode_spec_buf
, "Top%2d%%", total
);
19549 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
19550 return decode_mode_spec_buf
;
19555 /* status of process */
19556 obj
= Fget_buffer_process (Fcurrent_buffer ());
19558 return "no process";
19560 obj
= Fsymbol_name (Fprocess_status (obj
));
19566 int count
= inhibit_garbage_collection ();
19567 Lisp_Object val
= call1 (intern ("file-remote-p"),
19568 current_buffer
->directory
);
19569 unbind_to (count
, Qnil
);
19577 case 't': /* indicate TEXT or BINARY */
19578 #ifdef MODE_LINE_BINARY_TEXT
19579 return MODE_LINE_BINARY_TEXT (b
);
19585 /* coding-system (not including end-of-line format) */
19587 /* coding-system (including end-of-line type) */
19589 int eol_flag
= (c
== 'Z');
19590 char *p
= decode_mode_spec_buf
;
19592 if (! FRAME_WINDOW_P (f
))
19594 /* No need to mention EOL here--the terminal never needs
19595 to do EOL conversion. */
19596 p
= decode_mode_spec_coding (CODING_ID_NAME
19597 (FRAME_KEYBOARD_CODING (f
)->id
),
19599 p
= decode_mode_spec_coding (CODING_ID_NAME
19600 (FRAME_TERMINAL_CODING (f
)->id
),
19603 p
= decode_mode_spec_coding (b
->buffer_file_coding_system
,
19606 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
19607 #ifdef subprocesses
19608 obj
= Fget_buffer_process (Fcurrent_buffer ());
19609 if (PROCESSP (obj
))
19611 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
19613 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
19616 #endif /* subprocesses */
19619 return decode_mode_spec_buf
;
19626 return (char *) SDATA (obj
);
19633 /* Count up to COUNT lines starting from START / START_BYTE.
19634 But don't go beyond LIMIT_BYTE.
19635 Return the number of lines thus found (always nonnegative).
19637 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
19640 display_count_lines (int start
, int start_byte
, int limit_byte
, int count
,
19643 register unsigned char *cursor
;
19644 unsigned char *base
;
19646 register int ceiling
;
19647 register unsigned char *ceiling_addr
;
19648 int orig_count
= count
;
19650 /* If we are not in selective display mode,
19651 check only for newlines. */
19652 int selective_display
= (!NILP (current_buffer
->selective_display
)
19653 && !INTEGERP (current_buffer
->selective_display
));
19657 while (start_byte
< limit_byte
)
19659 ceiling
= BUFFER_CEILING_OF (start_byte
);
19660 ceiling
= min (limit_byte
- 1, ceiling
);
19661 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
19662 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
19665 if (selective_display
)
19666 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
19669 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
19672 if (cursor
!= ceiling_addr
)
19676 start_byte
+= cursor
- base
+ 1;
19677 *byte_pos_ptr
= start_byte
;
19681 if (++cursor
== ceiling_addr
)
19687 start_byte
+= cursor
- base
;
19692 while (start_byte
> limit_byte
)
19694 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
19695 ceiling
= max (limit_byte
, ceiling
);
19696 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
19697 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
19700 if (selective_display
)
19701 while (--cursor
!= ceiling_addr
19702 && *cursor
!= '\n' && *cursor
!= 015)
19705 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
19708 if (cursor
!= ceiling_addr
)
19712 start_byte
+= cursor
- base
+ 1;
19713 *byte_pos_ptr
= start_byte
;
19714 /* When scanning backwards, we should
19715 not count the newline posterior to which we stop. */
19716 return - orig_count
- 1;
19722 /* Here we add 1 to compensate for the last decrement
19723 of CURSOR, which took it past the valid range. */
19724 start_byte
+= cursor
- base
+ 1;
19728 *byte_pos_ptr
= limit_byte
;
19731 return - orig_count
+ count
;
19732 return orig_count
- count
;
19738 /***********************************************************************
19740 ***********************************************************************/
19742 /* Display a NUL-terminated string, starting with index START.
19744 If STRING is non-null, display that C string. Otherwise, the Lisp
19745 string LISP_STRING is displayed. There's a case that STRING is
19746 non-null and LISP_STRING is not nil. It means STRING is a string
19747 data of LISP_STRING. In that case, we display LISP_STRING while
19748 ignoring its text properties.
19750 If FACE_STRING is not nil, FACE_STRING_POS is a position in
19751 FACE_STRING. Display STRING or LISP_STRING with the face at
19752 FACE_STRING_POS in FACE_STRING:
19754 Display the string in the environment given by IT, but use the
19755 standard display table, temporarily.
19757 FIELD_WIDTH is the minimum number of output glyphs to produce.
19758 If STRING has fewer characters than FIELD_WIDTH, pad to the right
19759 with spaces. If STRING has more characters, more than FIELD_WIDTH
19760 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
19762 PRECISION is the maximum number of characters to output from
19763 STRING. PRECISION < 0 means don't truncate the string.
19765 This is roughly equivalent to printf format specifiers:
19767 FIELD_WIDTH PRECISION PRINTF
19768 ----------------------------------------
19774 MULTIBYTE zero means do not display multibyte chars, > 0 means do
19775 display them, and < 0 means obey the current buffer's value of
19776 enable_multibyte_characters.
19778 Value is the number of columns displayed. */
19781 display_string (unsigned char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
19782 EMACS_INT face_string_pos
, EMACS_INT start
, struct it
*it
,
19783 int field_width
, int precision
, int max_x
, int multibyte
)
19785 int hpos_at_start
= it
->hpos
;
19786 int saved_face_id
= it
->face_id
;
19787 struct glyph_row
*row
= it
->glyph_row
;
19789 /* Initialize the iterator IT for iteration over STRING beginning
19790 with index START. */
19791 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
19792 precision
, field_width
, multibyte
);
19793 if (string
&& STRINGP (lisp_string
))
19794 /* LISP_STRING is the one returned by decode_mode_spec. We should
19795 ignore its text properties. */
19796 it
->stop_charpos
= -1;
19798 /* If displaying STRING, set up the face of the iterator
19799 from LISP_STRING, if that's given. */
19800 if (STRINGP (face_string
))
19806 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
19807 0, it
->region_beg_charpos
,
19808 it
->region_end_charpos
,
19809 &endptr
, it
->base_face_id
, 0);
19810 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19811 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
19814 /* Set max_x to the maximum allowed X position. Don't let it go
19815 beyond the right edge of the window. */
19817 max_x
= it
->last_visible_x
;
19819 max_x
= min (max_x
, it
->last_visible_x
);
19821 /* Skip over display elements that are not visible. because IT->w is
19823 if (it
->current_x
< it
->first_visible_x
)
19824 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
19825 MOVE_TO_POS
| MOVE_TO_X
);
19827 row
->ascent
= it
->max_ascent
;
19828 row
->height
= it
->max_ascent
+ it
->max_descent
;
19829 row
->phys_ascent
= it
->max_phys_ascent
;
19830 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19831 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19833 /* This condition is for the case that we are called with current_x
19834 past last_visible_x. */
19835 while (it
->current_x
< max_x
)
19837 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
19839 /* Get the next display element. */
19840 if (!get_next_display_element (it
))
19843 /* Produce glyphs. */
19844 x_before
= it
->current_x
;
19845 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
19846 PRODUCE_GLYPHS (it
);
19848 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
19851 while (i
< nglyphs
)
19853 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
19855 if (it
->line_wrap
!= TRUNCATE
19856 && x
+ glyph
->pixel_width
> max_x
)
19858 /* End of continued line or max_x reached. */
19859 if (CHAR_GLYPH_PADDING_P (*glyph
))
19861 /* A wide character is unbreakable. */
19862 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
19863 it
->current_x
= x_before
;
19867 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
19872 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
19874 /* Glyph is at least partially visible. */
19876 if (x
< it
->first_visible_x
)
19877 it
->glyph_row
->x
= x
- it
->first_visible_x
;
19881 /* Glyph is off the left margin of the display area.
19882 Should not happen. */
19886 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19887 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19888 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19889 row
->phys_height
= max (row
->phys_height
,
19890 it
->max_phys_ascent
+ it
->max_phys_descent
);
19891 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19892 it
->max_extra_line_spacing
);
19893 x
+= glyph
->pixel_width
;
19897 /* Stop if max_x reached. */
19901 /* Stop at line ends. */
19902 if (ITERATOR_AT_END_OF_LINE_P (it
))
19904 it
->continuation_lines_width
= 0;
19908 set_iterator_to_next (it
, 1);
19910 /* Stop if truncating at the right edge. */
19911 if (it
->line_wrap
== TRUNCATE
19912 && it
->current_x
>= it
->last_visible_x
)
19914 /* Add truncation mark, but don't do it if the line is
19915 truncated at a padding space. */
19916 if (IT_CHARPOS (*it
) < it
->string_nchars
)
19918 if (!FRAME_WINDOW_P (it
->f
))
19922 if (it
->current_x
> it
->last_visible_x
)
19924 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
19925 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19927 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
19929 row
->used
[TEXT_AREA
] = i
;
19930 produce_special_glyphs (it
, IT_TRUNCATION
);
19933 produce_special_glyphs (it
, IT_TRUNCATION
);
19935 it
->glyph_row
->truncated_on_right_p
= 1;
19941 /* Maybe insert a truncation at the left. */
19942 if (it
->first_visible_x
19943 && IT_CHARPOS (*it
) > 0)
19945 if (!FRAME_WINDOW_P (it
->f
))
19946 insert_left_trunc_glyphs (it
);
19947 it
->glyph_row
->truncated_on_left_p
= 1;
19950 it
->face_id
= saved_face_id
;
19952 /* Value is number of columns displayed. */
19953 return it
->hpos
- hpos_at_start
;
19958 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
19959 appears as an element of LIST or as the car of an element of LIST.
19960 If PROPVAL is a list, compare each element against LIST in that
19961 way, and return 1/2 if any element of PROPVAL is found in LIST.
19962 Otherwise return 0. This function cannot quit.
19963 The return value is 2 if the text is invisible but with an ellipsis
19964 and 1 if it's invisible and without an ellipsis. */
19967 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
19969 register Lisp_Object tail
, proptail
;
19971 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
19973 register Lisp_Object tem
;
19975 if (EQ (propval
, tem
))
19977 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
19978 return NILP (XCDR (tem
)) ? 1 : 2;
19981 if (CONSP (propval
))
19983 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
19985 Lisp_Object propelt
;
19986 propelt
= XCAR (proptail
);
19987 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
19989 register Lisp_Object tem
;
19991 if (EQ (propelt
, tem
))
19993 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
19994 return NILP (XCDR (tem
)) ? 1 : 2;
20002 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
20003 doc
: /* Non-nil if the property makes the text invisible.
20004 POS-OR-PROP can be a marker or number, in which case it is taken to be
20005 a position in the current buffer and the value of the `invisible' property
20006 is checked; or it can be some other value, which is then presumed to be the
20007 value of the `invisible' property of the text of interest.
20008 The non-nil value returned can be t for truly invisible text or something
20009 else if the text is replaced by an ellipsis. */)
20010 (Lisp_Object pos_or_prop
)
20013 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
20014 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
20016 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
20017 return (invis
== 0 ? Qnil
20019 : make_number (invis
));
20022 /* Calculate a width or height in pixels from a specification using
20023 the following elements:
20026 NUM - a (fractional) multiple of the default font width/height
20027 (NUM) - specifies exactly NUM pixels
20028 UNIT - a fixed number of pixels, see below.
20029 ELEMENT - size of a display element in pixels, see below.
20030 (NUM . SPEC) - equals NUM * SPEC
20031 (+ SPEC SPEC ...) - add pixel values
20032 (- SPEC SPEC ...) - subtract pixel values
20033 (- SPEC) - negate pixel value
20036 INT or FLOAT - a number constant
20037 SYMBOL - use symbol's (buffer local) variable binding.
20040 in - pixels per inch *)
20041 mm - pixels per 1/1000 meter *)
20042 cm - pixels per 1/100 meter *)
20043 width - width of current font in pixels.
20044 height - height of current font in pixels.
20046 *) using the ratio(s) defined in display-pixels-per-inch.
20050 left-fringe - left fringe width in pixels
20051 right-fringe - right fringe width in pixels
20053 left-margin - left margin width in pixels
20054 right-margin - right margin width in pixels
20056 scroll-bar - scroll-bar area width in pixels
20060 Pixels corresponding to 5 inches:
20063 Total width of non-text areas on left side of window (if scroll-bar is on left):
20064 '(space :width (+ left-fringe left-margin scroll-bar))
20066 Align to first text column (in header line):
20067 '(space :align-to 0)
20069 Align to middle of text area minus half the width of variable `my-image'
20070 containing a loaded image:
20071 '(space :align-to (0.5 . (- text my-image)))
20073 Width of left margin minus width of 1 character in the default font:
20074 '(space :width (- left-margin 1))
20076 Width of left margin minus width of 2 characters in the current font:
20077 '(space :width (- left-margin (2 . width)))
20079 Center 1 character over left-margin (in header line):
20080 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
20082 Different ways to express width of left fringe plus left margin minus one pixel:
20083 '(space :width (- (+ left-fringe left-margin) (1)))
20084 '(space :width (+ left-fringe left-margin (- (1))))
20085 '(space :width (+ left-fringe left-margin (-1)))
20089 #define NUMVAL(X) \
20090 ((INTEGERP (X) || FLOATP (X)) \
20095 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
20096 struct font
*font
, int width_p
, int *align_to
)
20100 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
20101 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
20104 return OK_PIXELS (0);
20106 xassert (FRAME_LIVE_P (it
->f
));
20108 if (SYMBOLP (prop
))
20110 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
20112 char *unit
= SDATA (SYMBOL_NAME (prop
));
20114 if (unit
[0] == 'i' && unit
[1] == 'n')
20116 else if (unit
[0] == 'm' && unit
[1] == 'm')
20118 else if (unit
[0] == 'c' && unit
[1] == 'm')
20125 #ifdef HAVE_WINDOW_SYSTEM
20126 if (FRAME_WINDOW_P (it
->f
)
20128 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
20129 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
20131 return OK_PIXELS (ppi
/ pixels
);
20134 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
20135 || (CONSP (Vdisplay_pixels_per_inch
)
20137 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
20138 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
20140 return OK_PIXELS (ppi
/ pixels
);
20146 #ifdef HAVE_WINDOW_SYSTEM
20147 if (EQ (prop
, Qheight
))
20148 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
20149 if (EQ (prop
, Qwidth
))
20150 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
20152 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
20153 return OK_PIXELS (1);
20156 if (EQ (prop
, Qtext
))
20157 return OK_PIXELS (width_p
20158 ? window_box_width (it
->w
, TEXT_AREA
)
20159 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
20161 if (align_to
&& *align_to
< 0)
20164 if (EQ (prop
, Qleft
))
20165 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
20166 if (EQ (prop
, Qright
))
20167 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
20168 if (EQ (prop
, Qcenter
))
20169 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
20170 + window_box_width (it
->w
, TEXT_AREA
) / 2);
20171 if (EQ (prop
, Qleft_fringe
))
20172 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20173 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
20174 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
20175 if (EQ (prop
, Qright_fringe
))
20176 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20177 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20178 : window_box_right_offset (it
->w
, TEXT_AREA
));
20179 if (EQ (prop
, Qleft_margin
))
20180 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
20181 if (EQ (prop
, Qright_margin
))
20182 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
20183 if (EQ (prop
, Qscroll_bar
))
20184 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
20186 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20187 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20188 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20193 if (EQ (prop
, Qleft_fringe
))
20194 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
20195 if (EQ (prop
, Qright_fringe
))
20196 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
20197 if (EQ (prop
, Qleft_margin
))
20198 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
20199 if (EQ (prop
, Qright_margin
))
20200 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
20201 if (EQ (prop
, Qscroll_bar
))
20202 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
20205 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
20208 if (INTEGERP (prop
) || FLOATP (prop
))
20210 int base_unit
= (width_p
20211 ? FRAME_COLUMN_WIDTH (it
->f
)
20212 : FRAME_LINE_HEIGHT (it
->f
));
20213 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
20218 Lisp_Object car
= XCAR (prop
);
20219 Lisp_Object cdr
= XCDR (prop
);
20223 #ifdef HAVE_WINDOW_SYSTEM
20224 if (FRAME_WINDOW_P (it
->f
)
20225 && valid_image_p (prop
))
20227 int id
= lookup_image (it
->f
, prop
);
20228 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
20230 return OK_PIXELS (width_p
? img
->width
: img
->height
);
20233 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
20239 while (CONSP (cdr
))
20241 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
20242 font
, width_p
, align_to
))
20245 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
20250 if (EQ (car
, Qminus
))
20252 return OK_PIXELS (pixels
);
20255 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
20258 if (INTEGERP (car
) || FLOATP (car
))
20261 pixels
= XFLOATINT (car
);
20263 return OK_PIXELS (pixels
);
20264 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
20265 font
, width_p
, align_to
))
20266 return OK_PIXELS (pixels
* fact
);
20277 /***********************************************************************
20279 ***********************************************************************/
20281 #ifdef HAVE_WINDOW_SYSTEM
20286 dump_glyph_string (s
)
20287 struct glyph_string
*s
;
20289 fprintf (stderr
, "glyph string\n");
20290 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
20291 s
->x
, s
->y
, s
->width
, s
->height
);
20292 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
20293 fprintf (stderr
, " hl = %d\n", s
->hl
);
20294 fprintf (stderr
, " left overhang = %d, right = %d\n",
20295 s
->left_overhang
, s
->right_overhang
);
20296 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
20297 fprintf (stderr
, " extends to end of line = %d\n",
20298 s
->extends_to_end_of_line_p
);
20299 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
20300 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
20303 #endif /* GLYPH_DEBUG */
20305 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
20306 of XChar2b structures for S; it can't be allocated in
20307 init_glyph_string because it must be allocated via `alloca'. W
20308 is the window on which S is drawn. ROW and AREA are the glyph row
20309 and area within the row from which S is constructed. START is the
20310 index of the first glyph structure covered by S. HL is a
20311 face-override for drawing S. */
20314 #define OPTIONAL_HDC(hdc) HDC hdc,
20315 #define DECLARE_HDC(hdc) HDC hdc;
20316 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
20317 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
20320 #ifndef OPTIONAL_HDC
20321 #define OPTIONAL_HDC(hdc)
20322 #define DECLARE_HDC(hdc)
20323 #define ALLOCATE_HDC(hdc, f)
20324 #define RELEASE_HDC(hdc, f)
20328 init_glyph_string (struct glyph_string
*s
,
20330 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
20331 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
20333 memset (s
, 0, sizeof *s
);
20335 s
->f
= XFRAME (w
->frame
);
20339 s
->display
= FRAME_X_DISPLAY (s
->f
);
20340 s
->window
= FRAME_X_WINDOW (s
->f
);
20341 s
->char2b
= char2b
;
20345 s
->first_glyph
= row
->glyphs
[area
] + start
;
20346 s
->height
= row
->height
;
20347 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
20348 s
->ybase
= s
->y
+ row
->ascent
;
20352 /* Append the list of glyph strings with head H and tail T to the list
20353 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
20356 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
20357 struct glyph_string
*h
, struct glyph_string
*t
)
20371 /* Prepend the list of glyph strings with head H and tail T to the
20372 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
20376 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
20377 struct glyph_string
*h
, struct glyph_string
*t
)
20391 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
20392 Set *HEAD and *TAIL to the resulting list. */
20395 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
20396 struct glyph_string
*s
)
20398 s
->next
= s
->prev
= NULL
;
20399 append_glyph_string_lists (head
, tail
, s
, s
);
20403 /* Get face and two-byte form of character C in face FACE_ID on frame
20404 F. The encoding of C is returned in *CHAR2B. MULTIBYTE_P non-zero
20405 means we want to display multibyte text. DISPLAY_P non-zero means
20406 make sure that X resources for the face returned are allocated.
20407 Value is a pointer to a realized face that is ready for display if
20408 DISPLAY_P is non-zero. */
20410 static INLINE
struct face
*
20411 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
20412 XChar2b
*char2b
, int multibyte_p
, int display_p
)
20414 struct face
*face
= FACE_FROM_ID (f
, face_id
);
20418 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
20420 if (code
!= FONT_INVALID_CODE
)
20421 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20423 STORE_XCHAR2B (char2b
, 0, 0);
20426 /* Make sure X resources of the face are allocated. */
20427 #ifdef HAVE_X_WINDOWS
20431 xassert (face
!= NULL
);
20432 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20439 /* Get face and two-byte form of character glyph GLYPH on frame F.
20440 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
20441 a pointer to a realized face that is ready for display. */
20443 static INLINE
struct face
*
20444 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
20445 XChar2b
*char2b
, int *two_byte_p
)
20449 xassert (glyph
->type
== CHAR_GLYPH
);
20450 face
= FACE_FROM_ID (f
, glyph
->face_id
);
20457 unsigned code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
20459 if (code
!= FONT_INVALID_CODE
)
20460 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20462 STORE_XCHAR2B (char2b
, 0, 0);
20465 /* Make sure X resources of the face are allocated. */
20466 xassert (face
!= NULL
);
20467 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20472 /* Fill glyph string S with composition components specified by S->cmp.
20474 BASE_FACE is the base face of the composition.
20475 S->cmp_from is the index of the first component for S.
20477 OVERLAPS non-zero means S should draw the foreground only, and use
20478 its physical height for clipping. See also draw_glyphs.
20480 Value is the index of a component not in S. */
20483 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
20487 /* For all glyphs of this composition, starting at the offset
20488 S->cmp_from, until we reach the end of the definition or encounter a
20489 glyph that requires the different face, add it to S. */
20494 s
->for_overlaps
= overlaps
;
20497 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
20499 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
20503 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
20506 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
20507 s
->char2b
+ i
, 1, 1);
20513 s
->font
= s
->face
->font
;
20515 else if (s
->face
!= face
)
20523 /* All glyph strings for the same composition has the same width,
20524 i.e. the width set for the first component of the composition. */
20525 s
->width
= s
->first_glyph
->pixel_width
;
20527 /* If the specified font could not be loaded, use the frame's
20528 default font, but record the fact that we couldn't load it in
20529 the glyph string so that we can draw rectangles for the
20530 characters of the glyph string. */
20531 if (s
->font
== NULL
)
20533 s
->font_not_found_p
= 1;
20534 s
->font
= FRAME_FONT (s
->f
);
20537 /* Adjust base line for subscript/superscript text. */
20538 s
->ybase
+= s
->first_glyph
->voffset
;
20540 /* This glyph string must always be drawn with 16-bit functions. */
20547 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
20548 int start
, int end
, int overlaps
)
20550 struct glyph
*glyph
, *last
;
20551 Lisp_Object lgstring
;
20554 s
->for_overlaps
= overlaps
;
20555 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20556 last
= s
->row
->glyphs
[s
->area
] + end
;
20557 s
->cmp_id
= glyph
->u
.cmp
.id
;
20558 s
->cmp_from
= glyph
->u
.cmp
.from
;
20559 s
->cmp_to
= glyph
->u
.cmp
.to
+ 1;
20560 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20561 lgstring
= composition_gstring_from_id (s
->cmp_id
);
20562 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
20564 while (glyph
< last
20565 && glyph
->u
.cmp
.automatic
20566 && glyph
->u
.cmp
.id
== s
->cmp_id
20567 && s
->cmp_to
== glyph
->u
.cmp
.from
)
20568 s
->cmp_to
= (glyph
++)->u
.cmp
.to
+ 1;
20570 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
20572 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
20573 unsigned code
= LGLYPH_CODE (lglyph
);
20575 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
20577 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
20578 return glyph
- s
->row
->glyphs
[s
->area
];
20582 /* Fill glyph string S from a sequence of character glyphs.
20584 FACE_ID is the face id of the string. START is the index of the
20585 first glyph to consider, END is the index of the last + 1.
20586 OVERLAPS non-zero means S should draw the foreground only, and use
20587 its physical height for clipping. See also draw_glyphs.
20589 Value is the index of the first glyph not in S. */
20592 fill_glyph_string (struct glyph_string
*s
, int face_id
,
20593 int start
, int end
, int overlaps
)
20595 struct glyph
*glyph
, *last
;
20597 int glyph_not_available_p
;
20599 xassert (s
->f
== XFRAME (s
->w
->frame
));
20600 xassert (s
->nchars
== 0);
20601 xassert (start
>= 0 && end
> start
);
20603 s
->for_overlaps
= overlaps
;
20604 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20605 last
= s
->row
->glyphs
[s
->area
] + end
;
20606 voffset
= glyph
->voffset
;
20607 s
->padding_p
= glyph
->padding_p
;
20608 glyph_not_available_p
= glyph
->glyph_not_available_p
;
20610 while (glyph
< last
20611 && glyph
->type
== CHAR_GLYPH
20612 && glyph
->voffset
== voffset
20613 /* Same face id implies same font, nowadays. */
20614 && glyph
->face_id
== face_id
20615 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
20619 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
20620 s
->char2b
+ s
->nchars
,
20622 s
->two_byte_p
= two_byte_p
;
20624 xassert (s
->nchars
<= end
- start
);
20625 s
->width
+= glyph
->pixel_width
;
20626 if (glyph
++->padding_p
!= s
->padding_p
)
20630 s
->font
= s
->face
->font
;
20632 /* If the specified font could not be loaded, use the frame's font,
20633 but record the fact that we couldn't load it in
20634 S->font_not_found_p so that we can draw rectangles for the
20635 characters of the glyph string. */
20636 if (s
->font
== NULL
|| glyph_not_available_p
)
20638 s
->font_not_found_p
= 1;
20639 s
->font
= FRAME_FONT (s
->f
);
20642 /* Adjust base line for subscript/superscript text. */
20643 s
->ybase
+= voffset
;
20645 xassert (s
->face
&& s
->face
->gc
);
20646 return glyph
- s
->row
->glyphs
[s
->area
];
20650 /* Fill glyph string S from image glyph S->first_glyph. */
20653 fill_image_glyph_string (struct glyph_string
*s
)
20655 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
20656 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
20658 s
->slice
= s
->first_glyph
->slice
;
20659 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
20660 s
->font
= s
->face
->font
;
20661 s
->width
= s
->first_glyph
->pixel_width
;
20663 /* Adjust base line for subscript/superscript text. */
20664 s
->ybase
+= s
->first_glyph
->voffset
;
20668 /* Fill glyph string S from a sequence of stretch glyphs.
20670 ROW is the glyph row in which the glyphs are found, AREA is the
20671 area within the row. START is the index of the first glyph to
20672 consider, END is the index of the last + 1.
20674 Value is the index of the first glyph not in S. */
20677 fill_stretch_glyph_string (struct glyph_string
*s
, struct glyph_row
*row
,
20678 enum glyph_row_area area
, int start
, int end
)
20680 struct glyph
*glyph
, *last
;
20681 int voffset
, face_id
;
20683 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
20685 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20686 last
= s
->row
->glyphs
[s
->area
] + end
;
20687 face_id
= glyph
->face_id
;
20688 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20689 s
->font
= s
->face
->font
;
20690 s
->width
= glyph
->pixel_width
;
20692 voffset
= glyph
->voffset
;
20696 && glyph
->type
== STRETCH_GLYPH
20697 && glyph
->voffset
== voffset
20698 && glyph
->face_id
== face_id
);
20700 s
->width
+= glyph
->pixel_width
;
20702 /* Adjust base line for subscript/superscript text. */
20703 s
->ybase
+= voffset
;
20705 /* The case that face->gc == 0 is handled when drawing the glyph
20706 string by calling PREPARE_FACE_FOR_DISPLAY. */
20708 return glyph
- s
->row
->glyphs
[s
->area
];
20711 static struct font_metrics
*
20712 get_per_char_metric (struct frame
*f
, struct font
*font
, XChar2b
*char2b
)
20714 static struct font_metrics metrics
;
20715 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
20717 if (! font
|| code
== FONT_INVALID_CODE
)
20719 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
20724 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
20725 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
20726 assumed to be zero. */
20729 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
20731 *left
= *right
= 0;
20733 if (glyph
->type
== CHAR_GLYPH
)
20737 struct font_metrics
*pcm
;
20739 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
20740 if (face
->font
&& (pcm
= get_per_char_metric (f
, face
->font
, &char2b
)))
20742 if (pcm
->rbearing
> pcm
->width
)
20743 *right
= pcm
->rbearing
- pcm
->width
;
20744 if (pcm
->lbearing
< 0)
20745 *left
= -pcm
->lbearing
;
20748 else if (glyph
->type
== COMPOSITE_GLYPH
)
20750 if (! glyph
->u
.cmp
.automatic
)
20752 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
20754 if (cmp
->rbearing
> cmp
->pixel_width
)
20755 *right
= cmp
->rbearing
- cmp
->pixel_width
;
20756 if (cmp
->lbearing
< 0)
20757 *left
= - cmp
->lbearing
;
20761 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
20762 struct font_metrics metrics
;
20764 composition_gstring_width (gstring
, glyph
->u
.cmp
.from
,
20765 glyph
->u
.cmp
.to
+ 1, &metrics
);
20766 if (metrics
.rbearing
> metrics
.width
)
20767 *right
= metrics
.rbearing
- metrics
.width
;
20768 if (metrics
.lbearing
< 0)
20769 *left
= - metrics
.lbearing
;
20775 /* Return the index of the first glyph preceding glyph string S that
20776 is overwritten by S because of S's left overhang. Value is -1
20777 if no glyphs are overwritten. */
20780 left_overwritten (struct glyph_string
*s
)
20784 if (s
->left_overhang
)
20787 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20788 int first
= s
->first_glyph
- glyphs
;
20790 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
20791 x
-= glyphs
[i
].pixel_width
;
20802 /* Return the index of the first glyph preceding glyph string S that
20803 is overwriting S because of its right overhang. Value is -1 if no
20804 glyph in front of S overwrites S. */
20807 left_overwriting (struct glyph_string
*s
)
20810 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20811 int first
= s
->first_glyph
- glyphs
;
20815 for (i
= first
- 1; i
>= 0; --i
)
20818 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
20821 x
-= glyphs
[i
].pixel_width
;
20828 /* Return the index of the last glyph following glyph string S that is
20829 overwritten by S because of S's right overhang. Value is -1 if
20830 no such glyph is found. */
20833 right_overwritten (struct glyph_string
*s
)
20837 if (s
->right_overhang
)
20840 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20841 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
20842 int end
= s
->row
->used
[s
->area
];
20844 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
20845 x
+= glyphs
[i
].pixel_width
;
20854 /* Return the index of the last glyph following glyph string S that
20855 overwrites S because of its left overhang. Value is negative
20856 if no such glyph is found. */
20859 right_overwriting (struct glyph_string
*s
)
20862 int end
= s
->row
->used
[s
->area
];
20863 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20864 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
20868 for (i
= first
; i
< end
; ++i
)
20871 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
20874 x
+= glyphs
[i
].pixel_width
;
20881 /* Set background width of glyph string S. START is the index of the
20882 first glyph following S. LAST_X is the right-most x-position + 1
20883 in the drawing area. */
20886 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
20888 /* If the face of this glyph string has to be drawn to the end of
20889 the drawing area, set S->extends_to_end_of_line_p. */
20891 if (start
== s
->row
->used
[s
->area
]
20892 && s
->area
== TEXT_AREA
20893 && ((s
->row
->fill_line_p
20894 && (s
->hl
== DRAW_NORMAL_TEXT
20895 || s
->hl
== DRAW_IMAGE_RAISED
20896 || s
->hl
== DRAW_IMAGE_SUNKEN
))
20897 || s
->hl
== DRAW_MOUSE_FACE
))
20898 s
->extends_to_end_of_line_p
= 1;
20900 /* If S extends its face to the end of the line, set its
20901 background_width to the distance to the right edge of the drawing
20903 if (s
->extends_to_end_of_line_p
)
20904 s
->background_width
= last_x
- s
->x
+ 1;
20906 s
->background_width
= s
->width
;
20910 /* Compute overhangs and x-positions for glyph string S and its
20911 predecessors, or successors. X is the starting x-position for S.
20912 BACKWARD_P non-zero means process predecessors. */
20915 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
20921 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
20922 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
20932 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
20933 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
20943 /* The following macros are only called from draw_glyphs below.
20944 They reference the following parameters of that function directly:
20945 `w', `row', `area', and `overlap_p'
20946 as well as the following local variables:
20947 `s', `f', and `hdc' (in W32) */
20950 /* On W32, silently add local `hdc' variable to argument list of
20951 init_glyph_string. */
20952 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
20953 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
20955 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
20956 init_glyph_string (s, char2b, w, row, area, start, hl)
20959 /* Add a glyph string for a stretch glyph to the list of strings
20960 between HEAD and TAIL. START is the index of the stretch glyph in
20961 row area AREA of glyph row ROW. END is the index of the last glyph
20962 in that glyph row area. X is the current output position assigned
20963 to the new glyph string constructed. HL overrides that face of the
20964 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
20965 is the right-most x-position of the drawing area. */
20967 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
20968 and below -- keep them on one line. */
20969 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
20972 s = (struct glyph_string *) alloca (sizeof *s); \
20973 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
20974 START = fill_stretch_glyph_string (s, row, area, START, END); \
20975 append_glyph_string (&HEAD, &TAIL, s); \
20981 /* Add a glyph string for an image glyph to the list of strings
20982 between HEAD and TAIL. START is the index of the image glyph in
20983 row area AREA of glyph row ROW. END is the index of the last glyph
20984 in that glyph row area. X is the current output position assigned
20985 to the new glyph string constructed. HL overrides that face of the
20986 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
20987 is the right-most x-position of the drawing area. */
20989 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
20992 s = (struct glyph_string *) alloca (sizeof *s); \
20993 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
20994 fill_image_glyph_string (s); \
20995 append_glyph_string (&HEAD, &TAIL, s); \
21002 /* Add a glyph string for a sequence of character glyphs to the list
21003 of strings between HEAD and TAIL. START is the index of the first
21004 glyph in row area AREA of glyph row ROW that is part of the new
21005 glyph string. END is the index of the last glyph in that glyph row
21006 area. X is the current output position assigned to the new glyph
21007 string constructed. HL overrides that face of the glyph; e.g. it
21008 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
21009 right-most x-position of the drawing area. */
21011 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21017 face_id = (row)->glyphs[area][START].face_id; \
21019 s = (struct glyph_string *) alloca (sizeof *s); \
21020 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
21021 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21022 append_glyph_string (&HEAD, &TAIL, s); \
21024 START = fill_glyph_string (s, face_id, START, END, overlaps); \
21029 /* Add a glyph string for a composite sequence to the list of strings
21030 between HEAD and TAIL. START is the index of the first glyph in
21031 row area AREA of glyph row ROW that is part of the new glyph
21032 string. END is the index of the last glyph in that glyph row area.
21033 X is the current output position assigned to the new glyph string
21034 constructed. HL overrides that face of the glyph; e.g. it is
21035 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
21036 x-position of the drawing area. */
21038 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21040 int face_id = (row)->glyphs[area][START].face_id; \
21041 struct face *base_face = FACE_FROM_ID (f, face_id); \
21042 int cmp_id = (row)->glyphs[area][START].u.cmp.id; \
21043 struct composition *cmp = composition_table[cmp_id]; \
21045 struct glyph_string *first_s; \
21048 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
21050 /* Make glyph_strings for each glyph sequence that is drawable by \
21051 the same face, and append them to HEAD/TAIL. */ \
21052 for (n = 0; n < cmp->glyph_len;) \
21054 s = (struct glyph_string *) alloca (sizeof *s); \
21055 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21056 append_glyph_string (&(HEAD), &(TAIL), s); \
21062 n = fill_composite_glyph_string (s, base_face, overlaps); \
21070 /* Add a glyph string for a glyph-string sequence to the list of strings
21071 between HEAD and TAIL. */
21073 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21077 Lisp_Object gstring; \
21079 face_id = (row)->glyphs[area][START].face_id; \
21080 gstring = (composition_gstring_from_id \
21081 ((row)->glyphs[area][START].u.cmp.id)); \
21082 s = (struct glyph_string *) alloca (sizeof *s); \
21083 char2b = (XChar2b *) alloca ((sizeof *char2b) \
21084 * LGSTRING_GLYPH_LEN (gstring)); \
21085 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21086 append_glyph_string (&(HEAD), &(TAIL), s); \
21088 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
21092 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
21093 of AREA of glyph row ROW on window W between indices START and END.
21094 HL overrides the face for drawing glyph strings, e.g. it is
21095 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
21096 x-positions of the drawing area.
21098 This is an ugly monster macro construct because we must use alloca
21099 to allocate glyph strings (because draw_glyphs can be called
21100 asynchronously). */
21102 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21105 HEAD = TAIL = NULL; \
21106 while (START < END) \
21108 struct glyph *first_glyph = (row)->glyphs[area] + START; \
21109 switch (first_glyph->type) \
21112 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
21116 case COMPOSITE_GLYPH: \
21117 if (first_glyph->u.cmp.automatic) \
21118 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
21121 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
21125 case STRETCH_GLYPH: \
21126 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
21130 case IMAGE_GLYPH: \
21131 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
21141 set_glyph_string_background_width (s, START, LAST_X); \
21148 /* Draw glyphs between START and END in AREA of ROW on window W,
21149 starting at x-position X. X is relative to AREA in W. HL is a
21150 face-override with the following meaning:
21152 DRAW_NORMAL_TEXT draw normally
21153 DRAW_CURSOR draw in cursor face
21154 DRAW_MOUSE_FACE draw in mouse face.
21155 DRAW_INVERSE_VIDEO draw in mode line face
21156 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
21157 DRAW_IMAGE_RAISED draw an image with a raised relief around it
21159 If OVERLAPS is non-zero, draw only the foreground of characters and
21160 clip to the physical height of ROW. Non-zero value also defines
21161 the overlapping part to be drawn:
21163 OVERLAPS_PRED overlap with preceding rows
21164 OVERLAPS_SUCC overlap with succeeding rows
21165 OVERLAPS_BOTH overlap with both preceding/succeeding rows
21166 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
21168 Value is the x-position reached, relative to AREA of W. */
21171 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
21172 enum glyph_row_area area
, EMACS_INT start
, EMACS_INT end
,
21173 enum draw_glyphs_face hl
, int overlaps
)
21175 struct glyph_string
*head
, *tail
;
21176 struct glyph_string
*s
;
21177 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
21178 int i
, j
, x_reached
, last_x
, area_left
= 0;
21179 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21182 ALLOCATE_HDC (hdc
, f
);
21184 /* Let's rather be paranoid than getting a SEGV. */
21185 end
= min (end
, row
->used
[area
]);
21186 start
= max (0, start
);
21187 start
= min (end
, start
);
21189 /* Translate X to frame coordinates. Set last_x to the right
21190 end of the drawing area. */
21191 if (row
->full_width_p
)
21193 /* X is relative to the left edge of W, without scroll bars
21195 area_left
= WINDOW_LEFT_EDGE_X (w
);
21196 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
21200 area_left
= window_box_left (w
, area
);
21201 last_x
= area_left
+ window_box_width (w
, area
);
21205 /* Build a doubly-linked list of glyph_string structures between
21206 head and tail from what we have to draw. Note that the macro
21207 BUILD_GLYPH_STRINGS will modify its start parameter. That's
21208 the reason we use a separate variable `i'. */
21210 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
21212 x_reached
= tail
->x
+ tail
->background_width
;
21216 /* If there are any glyphs with lbearing < 0 or rbearing > width in
21217 the row, redraw some glyphs in front or following the glyph
21218 strings built above. */
21219 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
21221 struct glyph_string
*h
, *t
;
21222 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
21223 int mouse_beg_col
, mouse_end_col
, check_mouse_face
= 0;
21226 /* If mouse highlighting is on, we may need to draw adjacent
21227 glyphs using mouse-face highlighting. */
21228 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
21230 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
21232 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
21233 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
21235 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
21237 check_mouse_face
= 1;
21238 mouse_beg_col
= (row
== mouse_beg_row
)
21239 ? dpyinfo
->mouse_face_beg_col
: 0;
21240 mouse_end_col
= (row
== mouse_end_row
)
21241 ? dpyinfo
->mouse_face_end_col
21242 : row
->used
[TEXT_AREA
];
21246 /* Compute overhangs for all glyph strings. */
21247 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
21248 for (s
= head
; s
; s
= s
->next
)
21249 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
21251 /* Prepend glyph strings for glyphs in front of the first glyph
21252 string that are overwritten because of the first glyph
21253 string's left overhang. The background of all strings
21254 prepended must be drawn because the first glyph string
21256 i
= left_overwritten (head
);
21259 enum draw_glyphs_face overlap_hl
;
21261 /* If this row contains mouse highlighting, attempt to draw
21262 the overlapped glyphs with the correct highlight. This
21263 code fails if the overlap encompasses more than one glyph
21264 and mouse-highlight spans only some of these glyphs.
21265 However, making it work perfectly involves a lot more
21266 code, and I don't know if the pathological case occurs in
21267 practice, so we'll stick to this for now. --- cyd */
21268 if (check_mouse_face
21269 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21270 overlap_hl
= DRAW_MOUSE_FACE
;
21272 overlap_hl
= DRAW_NORMAL_TEXT
;
21275 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
21276 overlap_hl
, dummy_x
, last_x
);
21278 compute_overhangs_and_x (t
, head
->x
, 1);
21279 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21283 /* Prepend glyph strings for glyphs in front of the first glyph
21284 string that overwrite that glyph string because of their
21285 right overhang. For these strings, only the foreground must
21286 be drawn, because it draws over the glyph string at `head'.
21287 The background must not be drawn because this would overwrite
21288 right overhangs of preceding glyphs for which no glyph
21290 i
= left_overwriting (head
);
21293 enum draw_glyphs_face overlap_hl
;
21295 if (check_mouse_face
21296 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21297 overlap_hl
= DRAW_MOUSE_FACE
;
21299 overlap_hl
= DRAW_NORMAL_TEXT
;
21302 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
21303 overlap_hl
, dummy_x
, last_x
);
21304 for (s
= h
; s
; s
= s
->next
)
21305 s
->background_filled_p
= 1;
21306 compute_overhangs_and_x (t
, head
->x
, 1);
21307 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21310 /* Append glyphs strings for glyphs following the last glyph
21311 string tail that are overwritten by tail. The background of
21312 these strings has to be drawn because tail's foreground draws
21314 i
= right_overwritten (tail
);
21317 enum draw_glyphs_face overlap_hl
;
21319 if (check_mouse_face
21320 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21321 overlap_hl
= DRAW_MOUSE_FACE
;
21323 overlap_hl
= DRAW_NORMAL_TEXT
;
21325 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21326 overlap_hl
, x
, last_x
);
21327 /* Because BUILD_GLYPH_STRINGS updates the first argument,
21328 we don't have `end = i;' here. */
21329 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21330 append_glyph_string_lists (&head
, &tail
, h
, t
);
21334 /* Append glyph strings for glyphs following the last glyph
21335 string tail that overwrite tail. The foreground of such
21336 glyphs has to be drawn because it writes into the background
21337 of tail. The background must not be drawn because it could
21338 paint over the foreground of following glyphs. */
21339 i
= right_overwriting (tail
);
21342 enum draw_glyphs_face overlap_hl
;
21343 if (check_mouse_face
21344 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21345 overlap_hl
= DRAW_MOUSE_FACE
;
21347 overlap_hl
= DRAW_NORMAL_TEXT
;
21350 i
++; /* We must include the Ith glyph. */
21351 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21352 overlap_hl
, x
, last_x
);
21353 for (s
= h
; s
; s
= s
->next
)
21354 s
->background_filled_p
= 1;
21355 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21356 append_glyph_string_lists (&head
, &tail
, h
, t
);
21358 if (clip_head
|| clip_tail
)
21359 for (s
= head
; s
; s
= s
->next
)
21361 s
->clip_head
= clip_head
;
21362 s
->clip_tail
= clip_tail
;
21366 /* Draw all strings. */
21367 for (s
= head
; s
; s
= s
->next
)
21368 FRAME_RIF (f
)->draw_glyph_string (s
);
21371 /* When focus a sole frame and move horizontally, this sets on_p to 0
21372 causing a failure to erase prev cursor position. */
21373 if (area
== TEXT_AREA
21374 && !row
->full_width_p
21375 /* When drawing overlapping rows, only the glyph strings'
21376 foreground is drawn, which doesn't erase a cursor
21380 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
21381 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
21382 : (tail
? tail
->x
+ tail
->background_width
: x
));
21386 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
21387 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
21391 /* Value is the x-position up to which drawn, relative to AREA of W.
21392 This doesn't include parts drawn because of overhangs. */
21393 if (row
->full_width_p
)
21394 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
21396 x_reached
-= area_left
;
21398 RELEASE_HDC (hdc
, f
);
21403 /* Expand row matrix if too narrow. Don't expand if area
21406 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
21408 if (!fonts_changed_p \
21409 && (it->glyph_row->glyphs[area] \
21410 < it->glyph_row->glyphs[area + 1])) \
21412 it->w->ncols_scale_factor++; \
21413 fonts_changed_p = 1; \
21417 /* Store one glyph for IT->char_to_display in IT->glyph_row.
21418 Called from x_produce_glyphs when IT->glyph_row is non-null. */
21421 append_glyph (struct it
*it
)
21423 struct glyph
*glyph
;
21424 enum glyph_row_area area
= it
->area
;
21426 xassert (it
->glyph_row
);
21427 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
21429 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21430 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21432 /* If the glyph row is reversed, we need to prepend the glyph
21433 rather than append it. */
21434 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
21438 /* Make room for the additional glyph. */
21439 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
21441 glyph
= it
->glyph_row
->glyphs
[area
];
21443 glyph
->charpos
= CHARPOS (it
->position
);
21444 glyph
->object
= it
->object
;
21445 if (it
->pixel_width
> 0)
21447 glyph
->pixel_width
= it
->pixel_width
;
21448 glyph
->padding_p
= 0;
21452 /* Assure at least 1-pixel width. Otherwise, cursor can't
21453 be displayed correctly. */
21454 glyph
->pixel_width
= 1;
21455 glyph
->padding_p
= 1;
21457 glyph
->ascent
= it
->ascent
;
21458 glyph
->descent
= it
->descent
;
21459 glyph
->voffset
= it
->voffset
;
21460 glyph
->type
= CHAR_GLYPH
;
21461 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21462 glyph
->multibyte_p
= it
->multibyte_p
;
21463 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21464 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21465 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21466 || it
->phys_descent
> it
->descent
);
21467 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
21468 glyph
->face_id
= it
->face_id
;
21469 glyph
->u
.ch
= it
->char_to_display
;
21470 glyph
->slice
= null_glyph_slice
;
21471 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21474 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21475 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21477 glyph
->bidi_type
= it
->bidi_it
.type
;
21481 glyph
->resolved_level
= 0;
21482 glyph
->bidi_type
= UNKNOWN_BT
;
21484 ++it
->glyph_row
->used
[area
];
21487 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21490 /* Store one glyph for the composition IT->cmp_it.id in
21491 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
21495 append_composite_glyph (struct it
*it
)
21497 struct glyph
*glyph
;
21498 enum glyph_row_area area
= it
->area
;
21500 xassert (it
->glyph_row
);
21502 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21503 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21505 /* If the glyph row is reversed, we need to prepend the glyph
21506 rather than append it. */
21507 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
21511 /* Make room for the new glyph. */
21512 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
21514 glyph
= it
->glyph_row
->glyphs
[it
->area
];
21516 glyph
->charpos
= it
->cmp_it
.charpos
;
21517 glyph
->object
= it
->object
;
21518 glyph
->pixel_width
= it
->pixel_width
;
21519 glyph
->ascent
= it
->ascent
;
21520 glyph
->descent
= it
->descent
;
21521 glyph
->voffset
= it
->voffset
;
21522 glyph
->type
= COMPOSITE_GLYPH
;
21523 if (it
->cmp_it
.ch
< 0)
21525 glyph
->u
.cmp
.automatic
= 0;
21526 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21530 glyph
->u
.cmp
.automatic
= 1;
21531 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21532 glyph
->u
.cmp
.from
= it
->cmp_it
.from
;
21533 glyph
->u
.cmp
.to
= it
->cmp_it
.to
- 1;
21535 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21536 glyph
->multibyte_p
= it
->multibyte_p
;
21537 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21538 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21539 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21540 || it
->phys_descent
> it
->descent
);
21541 glyph
->padding_p
= 0;
21542 glyph
->glyph_not_available_p
= 0;
21543 glyph
->face_id
= it
->face_id
;
21544 glyph
->slice
= null_glyph_slice
;
21545 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21548 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21549 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21551 glyph
->bidi_type
= it
->bidi_it
.type
;
21553 ++it
->glyph_row
->used
[area
];
21556 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21560 /* Change IT->ascent and IT->height according to the setting of
21564 take_vertical_position_into_account (struct it
*it
)
21568 if (it
->voffset
< 0)
21569 /* Increase the ascent so that we can display the text higher
21571 it
->ascent
-= it
->voffset
;
21573 /* Increase the descent so that we can display the text lower
21575 it
->descent
+= it
->voffset
;
21580 /* Produce glyphs/get display metrics for the image IT is loaded with.
21581 See the description of struct display_iterator in dispextern.h for
21582 an overview of struct display_iterator. */
21585 produce_image_glyph (struct it
*it
)
21589 int glyph_ascent
, crop
;
21590 struct glyph_slice slice
;
21592 xassert (it
->what
== IT_IMAGE
);
21594 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21596 /* Make sure X resources of the face is loaded. */
21597 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21599 if (it
->image_id
< 0)
21601 /* Fringe bitmap. */
21602 it
->ascent
= it
->phys_ascent
= 0;
21603 it
->descent
= it
->phys_descent
= 0;
21604 it
->pixel_width
= 0;
21609 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
21611 /* Make sure X resources of the image is loaded. */
21612 prepare_image_for_display (it
->f
, img
);
21614 slice
.x
= slice
.y
= 0;
21615 slice
.width
= img
->width
;
21616 slice
.height
= img
->height
;
21618 if (INTEGERP (it
->slice
.x
))
21619 slice
.x
= XINT (it
->slice
.x
);
21620 else if (FLOATP (it
->slice
.x
))
21621 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
21623 if (INTEGERP (it
->slice
.y
))
21624 slice
.y
= XINT (it
->slice
.y
);
21625 else if (FLOATP (it
->slice
.y
))
21626 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
21628 if (INTEGERP (it
->slice
.width
))
21629 slice
.width
= XINT (it
->slice
.width
);
21630 else if (FLOATP (it
->slice
.width
))
21631 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
21633 if (INTEGERP (it
->slice
.height
))
21634 slice
.height
= XINT (it
->slice
.height
);
21635 else if (FLOATP (it
->slice
.height
))
21636 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
21638 if (slice
.x
>= img
->width
)
21639 slice
.x
= img
->width
;
21640 if (slice
.y
>= img
->height
)
21641 slice
.y
= img
->height
;
21642 if (slice
.x
+ slice
.width
>= img
->width
)
21643 slice
.width
= img
->width
- slice
.x
;
21644 if (slice
.y
+ slice
.height
> img
->height
)
21645 slice
.height
= img
->height
- slice
.y
;
21647 if (slice
.width
== 0 || slice
.height
== 0)
21650 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
21652 it
->descent
= slice
.height
- glyph_ascent
;
21654 it
->descent
+= img
->vmargin
;
21655 if (slice
.y
+ slice
.height
== img
->height
)
21656 it
->descent
+= img
->vmargin
;
21657 it
->phys_descent
= it
->descent
;
21659 it
->pixel_width
= slice
.width
;
21661 it
->pixel_width
+= img
->hmargin
;
21662 if (slice
.x
+ slice
.width
== img
->width
)
21663 it
->pixel_width
+= img
->hmargin
;
21665 /* It's quite possible for images to have an ascent greater than
21666 their height, so don't get confused in that case. */
21667 if (it
->descent
< 0)
21672 if (face
->box
!= FACE_NO_BOX
)
21674 if (face
->box_line_width
> 0)
21677 it
->ascent
+= face
->box_line_width
;
21678 if (slice
.y
+ slice
.height
== img
->height
)
21679 it
->descent
+= face
->box_line_width
;
21682 if (it
->start_of_box_run_p
&& slice
.x
== 0)
21683 it
->pixel_width
+= eabs (face
->box_line_width
);
21684 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
21685 it
->pixel_width
+= eabs (face
->box_line_width
);
21688 take_vertical_position_into_account (it
);
21690 /* Automatically crop wide image glyphs at right edge so we can
21691 draw the cursor on same display row. */
21692 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
21693 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
21695 it
->pixel_width
-= crop
;
21696 slice
.width
-= crop
;
21701 struct glyph
*glyph
;
21702 enum glyph_row_area area
= it
->area
;
21704 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21705 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21707 glyph
->charpos
= CHARPOS (it
->position
);
21708 glyph
->object
= it
->object
;
21709 glyph
->pixel_width
= it
->pixel_width
;
21710 glyph
->ascent
= glyph_ascent
;
21711 glyph
->descent
= it
->descent
;
21712 glyph
->voffset
= it
->voffset
;
21713 glyph
->type
= IMAGE_GLYPH
;
21714 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21715 glyph
->multibyte_p
= it
->multibyte_p
;
21716 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21717 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21718 glyph
->overlaps_vertically_p
= 0;
21719 glyph
->padding_p
= 0;
21720 glyph
->glyph_not_available_p
= 0;
21721 glyph
->face_id
= it
->face_id
;
21722 glyph
->u
.img_id
= img
->id
;
21723 glyph
->slice
= slice
;
21724 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21727 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21728 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21730 glyph
->bidi_type
= it
->bidi_it
.type
;
21732 ++it
->glyph_row
->used
[area
];
21735 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21740 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
21741 of the glyph, WIDTH and HEIGHT are the width and height of the
21742 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
21745 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
21746 int width
, int height
, int ascent
)
21748 struct glyph
*glyph
;
21749 enum glyph_row_area area
= it
->area
;
21751 xassert (ascent
>= 0 && ascent
<= height
);
21753 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21754 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21756 /* If the glyph row is reversed, we need to prepend the glyph
21757 rather than append it. */
21758 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
21762 /* Make room for the additional glyph. */
21763 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
21765 glyph
= it
->glyph_row
->glyphs
[area
];
21767 glyph
->charpos
= CHARPOS (it
->position
);
21768 glyph
->object
= object
;
21769 glyph
->pixel_width
= width
;
21770 glyph
->ascent
= ascent
;
21771 glyph
->descent
= height
- ascent
;
21772 glyph
->voffset
= it
->voffset
;
21773 glyph
->type
= STRETCH_GLYPH
;
21774 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21775 glyph
->multibyte_p
= it
->multibyte_p
;
21776 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21777 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21778 glyph
->overlaps_vertically_p
= 0;
21779 glyph
->padding_p
= 0;
21780 glyph
->glyph_not_available_p
= 0;
21781 glyph
->face_id
= it
->face_id
;
21782 glyph
->u
.stretch
.ascent
= ascent
;
21783 glyph
->u
.stretch
.height
= height
;
21784 glyph
->slice
= null_glyph_slice
;
21785 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21788 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21789 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21791 glyph
->bidi_type
= it
->bidi_it
.type
;
21795 glyph
->resolved_level
= 0;
21796 glyph
->bidi_type
= UNKNOWN_BT
;
21798 ++it
->glyph_row
->used
[area
];
21801 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21805 /* Produce a stretch glyph for iterator IT. IT->object is the value
21806 of the glyph property displayed. The value must be a list
21807 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
21810 1. `:width WIDTH' specifies that the space should be WIDTH *
21811 canonical char width wide. WIDTH may be an integer or floating
21814 2. `:relative-width FACTOR' specifies that the width of the stretch
21815 should be computed from the width of the first character having the
21816 `glyph' property, and should be FACTOR times that width.
21818 3. `:align-to HPOS' specifies that the space should be wide enough
21819 to reach HPOS, a value in canonical character units.
21821 Exactly one of the above pairs must be present.
21823 4. `:height HEIGHT' specifies that the height of the stretch produced
21824 should be HEIGHT, measured in canonical character units.
21826 5. `:relative-height FACTOR' specifies that the height of the
21827 stretch should be FACTOR times the height of the characters having
21828 the glyph property.
21830 Either none or exactly one of 4 or 5 must be present.
21832 6. `:ascent ASCENT' specifies that ASCENT percent of the height
21833 of the stretch should be used for the ascent of the stretch.
21834 ASCENT must be in the range 0 <= ASCENT <= 100. */
21837 produce_stretch_glyph (struct it
*it
)
21839 /* (space :width WIDTH :height HEIGHT ...) */
21840 Lisp_Object prop
, plist
;
21841 int width
= 0, height
= 0, align_to
= -1;
21842 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
21845 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21846 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
21848 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21850 /* List should start with `space'. */
21851 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
21852 plist
= XCDR (it
->object
);
21854 /* Compute the width of the stretch. */
21855 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
21856 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
21858 /* Absolute width `:width WIDTH' specified and valid. */
21859 zero_width_ok_p
= 1;
21862 else if (prop
= Fplist_get (plist
, QCrelative_width
),
21865 /* Relative width `:relative-width FACTOR' specified and valid.
21866 Compute the width of the characters having the `glyph'
21869 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
21872 if (it
->multibyte_p
)
21874 int maxlen
= ((IT_BYTEPOS (*it
) >= GPT
? ZV
: GPT
)
21875 - IT_BYTEPOS (*it
));
21876 it2
.c
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
21879 it2
.c
= *p
, it2
.len
= 1;
21881 it2
.glyph_row
= NULL
;
21882 it2
.what
= IT_CHARACTER
;
21883 x_produce_glyphs (&it2
);
21884 width
= NUMVAL (prop
) * it2
.pixel_width
;
21886 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
21887 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
21889 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
21890 align_to
= (align_to
< 0
21892 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
21893 else if (align_to
< 0)
21894 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
21895 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
21896 zero_width_ok_p
= 1;
21899 /* Nothing specified -> width defaults to canonical char width. */
21900 width
= FRAME_COLUMN_WIDTH (it
->f
);
21902 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
21905 /* Compute height. */
21906 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
21907 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
21910 zero_height_ok_p
= 1;
21912 else if (prop
= Fplist_get (plist
, QCrelative_height
),
21914 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
21916 height
= FONT_HEIGHT (font
);
21918 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
21921 /* Compute percentage of height used for ascent. If
21922 `:ascent ASCENT' is present and valid, use that. Otherwise,
21923 derive the ascent from the font in use. */
21924 if (prop
= Fplist_get (plist
, QCascent
),
21925 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
21926 ascent
= height
* NUMVAL (prop
) / 100.0;
21927 else if (!NILP (prop
)
21928 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
21929 ascent
= min (max (0, (int)tem
), height
);
21931 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
21933 if (width
> 0 && it
->line_wrap
!= TRUNCATE
21934 && it
->current_x
+ width
> it
->last_visible_x
)
21935 width
= it
->last_visible_x
- it
->current_x
- 1;
21937 if (width
> 0 && height
> 0 && it
->glyph_row
)
21939 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
21940 if (!STRINGP (object
))
21941 object
= it
->w
->buffer
;
21942 append_stretch_glyph (it
, object
, width
, height
, ascent
);
21945 it
->pixel_width
= width
;
21946 it
->ascent
= it
->phys_ascent
= ascent
;
21947 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
21948 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
21950 take_vertical_position_into_account (it
);
21953 /* Calculate line-height and line-spacing properties.
21954 An integer value specifies explicit pixel value.
21955 A float value specifies relative value to current face height.
21956 A cons (float . face-name) specifies relative value to
21957 height of specified face font.
21959 Returns height in pixels, or nil. */
21963 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
21964 int boff
, int override
)
21966 Lisp_Object face_name
= Qnil
;
21967 int ascent
, descent
, height
;
21969 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
21974 face_name
= XCAR (val
);
21976 if (!NUMBERP (val
))
21977 val
= make_number (1);
21978 if (NILP (face_name
))
21980 height
= it
->ascent
+ it
->descent
;
21985 if (NILP (face_name
))
21987 font
= FRAME_FONT (it
->f
);
21988 boff
= FRAME_BASELINE_OFFSET (it
->f
);
21990 else if (EQ (face_name
, Qt
))
21999 face_id
= lookup_named_face (it
->f
, face_name
, 0);
22001 return make_number (-1);
22003 face
= FACE_FROM_ID (it
->f
, face_id
);
22006 return make_number (-1);
22007 boff
= font
->baseline_offset
;
22008 if (font
->vertical_centering
)
22009 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22012 ascent
= FONT_BASE (font
) + boff
;
22013 descent
= FONT_DESCENT (font
) - boff
;
22017 it
->override_ascent
= ascent
;
22018 it
->override_descent
= descent
;
22019 it
->override_boff
= boff
;
22022 height
= ascent
+ descent
;
22026 height
= (int)(XFLOAT_DATA (val
) * height
);
22027 else if (INTEGERP (val
))
22028 height
*= XINT (val
);
22030 return make_number (height
);
22035 Produce glyphs/get display metrics for the display element IT is
22036 loaded with. See the description of struct it in dispextern.h
22037 for an overview of struct it. */
22040 x_produce_glyphs (struct it
*it
)
22042 int extra_line_spacing
= it
->extra_line_spacing
;
22044 it
->glyph_not_available_p
= 0;
22046 if (it
->what
== IT_CHARACTER
)
22050 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22051 struct font_metrics
*pcm
;
22052 int font_not_found_p
;
22053 int boff
; /* baseline offset */
22054 /* We may change it->multibyte_p upon unibyte<->multibyte
22055 conversion. So, save the current value now and restore it
22058 Note: It seems that we don't have to record multibyte_p in
22059 struct glyph because the character code itself tells whether
22060 or not the character is multibyte. Thus, in the future, we
22061 must consider eliminating the field `multibyte_p' in the
22063 int saved_multibyte_p
= it
->multibyte_p
;
22065 /* Maybe translate single-byte characters to multibyte, or the
22067 it
->char_to_display
= it
->c
;
22068 if (!ASCII_BYTE_P (it
->c
)
22069 && ! it
->multibyte_p
)
22071 if (SINGLE_BYTE_CHAR_P (it
->c
)
22072 && unibyte_display_via_language_environment
)
22074 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
22076 /* get_next_display_element assures that this decoding
22078 it
->char_to_display
= DECODE_CHAR (unibyte
, it
->c
);
22079 it
->multibyte_p
= 1;
22080 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
,
22082 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22086 /* Get font to use. Encode IT->char_to_display. */
22087 get_char_face_and_encoding (it
->f
, it
->char_to_display
, it
->face_id
,
22088 &char2b
, it
->multibyte_p
, 0);
22091 font_not_found_p
= font
== NULL
;
22092 if (font_not_found_p
)
22094 /* When no suitable font found, display an empty box based
22095 on the metrics of the font of the default face (or what
22097 struct face
*no_font_face
22098 = FACE_FROM_ID (it
->f
,
22099 NILP (Vface_remapping_alist
) ? DEFAULT_FACE_ID
22100 : lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
22101 font
= no_font_face
->font
;
22102 boff
= font
->baseline_offset
;
22106 boff
= font
->baseline_offset
;
22107 if (font
->vertical_centering
)
22108 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22111 if (it
->char_to_display
>= ' '
22112 && (!it
->multibyte_p
|| it
->char_to_display
< 128))
22114 /* Either unibyte or ASCII. */
22119 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22121 if (it
->override_ascent
>= 0)
22123 it
->ascent
= it
->override_ascent
;
22124 it
->descent
= it
->override_descent
;
22125 boff
= it
->override_boff
;
22129 it
->ascent
= FONT_BASE (font
) + boff
;
22130 it
->descent
= FONT_DESCENT (font
) - boff
;
22135 it
->phys_ascent
= pcm
->ascent
+ boff
;
22136 it
->phys_descent
= pcm
->descent
- boff
;
22137 it
->pixel_width
= pcm
->width
;
22141 it
->glyph_not_available_p
= 1;
22142 it
->phys_ascent
= it
->ascent
;
22143 it
->phys_descent
= it
->descent
;
22144 it
->pixel_width
= FONT_WIDTH (font
);
22147 if (it
->constrain_row_ascent_descent_p
)
22149 if (it
->descent
> it
->max_descent
)
22151 it
->ascent
+= it
->descent
- it
->max_descent
;
22152 it
->descent
= it
->max_descent
;
22154 if (it
->ascent
> it
->max_ascent
)
22156 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22157 it
->ascent
= it
->max_ascent
;
22159 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22160 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22161 extra_line_spacing
= 0;
22164 /* If this is a space inside a region of text with
22165 `space-width' property, change its width. */
22166 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
22168 it
->pixel_width
*= XFLOATINT (it
->space_width
);
22170 /* If face has a box, add the box thickness to the character
22171 height. If character has a box line to the left and/or
22172 right, add the box line width to the character's width. */
22173 if (face
->box
!= FACE_NO_BOX
)
22175 int thick
= face
->box_line_width
;
22179 it
->ascent
+= thick
;
22180 it
->descent
+= thick
;
22185 if (it
->start_of_box_run_p
)
22186 it
->pixel_width
+= thick
;
22187 if (it
->end_of_box_run_p
)
22188 it
->pixel_width
+= thick
;
22191 /* If face has an overline, add the height of the overline
22192 (1 pixel) and a 1 pixel margin to the character height. */
22193 if (face
->overline_p
)
22194 it
->ascent
+= overline_margin
;
22196 if (it
->constrain_row_ascent_descent_p
)
22198 if (it
->ascent
> it
->max_ascent
)
22199 it
->ascent
= it
->max_ascent
;
22200 if (it
->descent
> it
->max_descent
)
22201 it
->descent
= it
->max_descent
;
22204 take_vertical_position_into_account (it
);
22206 /* If we have to actually produce glyphs, do it. */
22211 /* Translate a space with a `space-width' property
22212 into a stretch glyph. */
22213 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
22214 / FONT_HEIGHT (font
));
22215 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22216 it
->ascent
+ it
->descent
, ascent
);
22221 /* If characters with lbearing or rbearing are displayed
22222 in this line, record that fact in a flag of the
22223 glyph row. This is used to optimize X output code. */
22224 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
22225 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22227 if (! stretched_p
&& it
->pixel_width
== 0)
22228 /* We assure that all visible glyphs have at least 1-pixel
22230 it
->pixel_width
= 1;
22232 else if (it
->char_to_display
== '\n')
22234 /* A newline has no width, but we need the height of the
22235 line. But if previous part of the line sets a height,
22236 don't increase that height */
22238 Lisp_Object height
;
22239 Lisp_Object total_height
= Qnil
;
22241 it
->override_ascent
= -1;
22242 it
->pixel_width
= 0;
22245 height
= get_it_property (it
, Qline_height
);
22246 /* Split (line-height total-height) list */
22248 && CONSP (XCDR (height
))
22249 && NILP (XCDR (XCDR (height
))))
22251 total_height
= XCAR (XCDR (height
));
22252 height
= XCAR (height
);
22254 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
22256 if (it
->override_ascent
>= 0)
22258 it
->ascent
= it
->override_ascent
;
22259 it
->descent
= it
->override_descent
;
22260 boff
= it
->override_boff
;
22264 it
->ascent
= FONT_BASE (font
) + boff
;
22265 it
->descent
= FONT_DESCENT (font
) - boff
;
22268 if (EQ (height
, Qt
))
22270 if (it
->descent
> it
->max_descent
)
22272 it
->ascent
+= it
->descent
- it
->max_descent
;
22273 it
->descent
= it
->max_descent
;
22275 if (it
->ascent
> it
->max_ascent
)
22277 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22278 it
->ascent
= it
->max_ascent
;
22280 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22281 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22282 it
->constrain_row_ascent_descent_p
= 1;
22283 extra_line_spacing
= 0;
22287 Lisp_Object spacing
;
22289 it
->phys_ascent
= it
->ascent
;
22290 it
->phys_descent
= it
->descent
;
22292 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
22293 && face
->box
!= FACE_NO_BOX
22294 && face
->box_line_width
> 0)
22296 it
->ascent
+= face
->box_line_width
;
22297 it
->descent
+= face
->box_line_width
;
22300 && XINT (height
) > it
->ascent
+ it
->descent
)
22301 it
->ascent
= XINT (height
) - it
->descent
;
22303 if (!NILP (total_height
))
22304 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
22307 spacing
= get_it_property (it
, Qline_spacing
);
22308 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
22310 if (INTEGERP (spacing
))
22312 extra_line_spacing
= XINT (spacing
);
22313 if (!NILP (total_height
))
22314 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
22318 else if (it
->char_to_display
== '\t')
22320 if (font
->space_width
> 0)
22322 int tab_width
= it
->tab_width
* font
->space_width
;
22323 int x
= it
->current_x
+ it
->continuation_lines_width
;
22324 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
22326 /* If the distance from the current position to the next tab
22327 stop is less than a space character width, use the
22328 tab stop after that. */
22329 if (next_tab_x
- x
< font
->space_width
)
22330 next_tab_x
+= tab_width
;
22332 it
->pixel_width
= next_tab_x
- x
;
22334 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
22335 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
22339 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22340 it
->ascent
+ it
->descent
, it
->ascent
);
22345 it
->pixel_width
= 0;
22351 /* A multi-byte character. Assume that the display width of the
22352 character is the width of the character multiplied by the
22353 width of the font. */
22355 /* If we found a font, this font should give us the right
22356 metrics. If we didn't find a font, use the frame's
22357 default font and calculate the width of the character by
22358 multiplying the width of font by the width of the
22361 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22363 if (font_not_found_p
|| !pcm
)
22365 int char_width
= CHAR_WIDTH (it
->char_to_display
);
22367 if (char_width
== 0)
22368 /* This is a non spacing character. But, as we are
22369 going to display an empty box, the box must occupy
22370 at least one column. */
22372 it
->glyph_not_available_p
= 1;
22373 it
->pixel_width
= font
->space_width
* char_width
;
22374 it
->phys_ascent
= FONT_BASE (font
) + boff
;
22375 it
->phys_descent
= FONT_DESCENT (font
) - boff
;
22379 it
->pixel_width
= pcm
->width
;
22380 it
->phys_ascent
= pcm
->ascent
+ boff
;
22381 it
->phys_descent
= pcm
->descent
- boff
;
22383 && (pcm
->lbearing
< 0
22384 || pcm
->rbearing
> pcm
->width
))
22385 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22388 it
->ascent
= FONT_BASE (font
) + boff
;
22389 it
->descent
= FONT_DESCENT (font
) - boff
;
22390 if (face
->box
!= FACE_NO_BOX
)
22392 int thick
= face
->box_line_width
;
22396 it
->ascent
+= thick
;
22397 it
->descent
+= thick
;
22402 if (it
->start_of_box_run_p
)
22403 it
->pixel_width
+= thick
;
22404 if (it
->end_of_box_run_p
)
22405 it
->pixel_width
+= thick
;
22408 /* If face has an overline, add the height of the overline
22409 (1 pixel) and a 1 pixel margin to the character height. */
22410 if (face
->overline_p
)
22411 it
->ascent
+= overline_margin
;
22413 take_vertical_position_into_account (it
);
22415 if (it
->ascent
< 0)
22417 if (it
->descent
< 0)
22422 if (it
->pixel_width
== 0)
22423 /* We assure that all visible glyphs have at least 1-pixel
22425 it
->pixel_width
= 1;
22427 it
->multibyte_p
= saved_multibyte_p
;
22429 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
22431 /* A static composition.
22433 Note: A composition is represented as one glyph in the
22434 glyph matrix. There are no padding glyphs.
22436 Important note: pixel_width, ascent, and descent are the
22437 values of what is drawn by draw_glyphs (i.e. the values of
22438 the overall glyphs composed). */
22439 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22440 int boff
; /* baseline offset */
22441 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
22442 int glyph_len
= cmp
->glyph_len
;
22443 struct font
*font
= face
->font
;
22447 /* If we have not yet calculated pixel size data of glyphs of
22448 the composition for the current face font, calculate them
22449 now. Theoretically, we have to check all fonts for the
22450 glyphs, but that requires much time and memory space. So,
22451 here we check only the font of the first glyph. This may
22452 lead to incorrect display, but it's very rare, and C-l
22453 (recenter-top-bottom) can correct the display anyway. */
22454 if (! cmp
->font
|| cmp
->font
!= font
)
22456 /* Ascent and descent of the font of the first character
22457 of this composition (adjusted by baseline offset).
22458 Ascent and descent of overall glyphs should not be less
22459 than these, respectively. */
22460 int font_ascent
, font_descent
, font_height
;
22461 /* Bounding box of the overall glyphs. */
22462 int leftmost
, rightmost
, lowest
, highest
;
22463 int lbearing
, rbearing
;
22464 int i
, width
, ascent
, descent
;
22465 int left_padded
= 0, right_padded
= 0;
22468 struct font_metrics
*pcm
;
22469 int font_not_found_p
;
22472 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
22473 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
22475 if (glyph_len
< cmp
->glyph_len
)
22477 for (i
= 0; i
< glyph_len
; i
++)
22479 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
22481 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22486 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
22487 : IT_CHARPOS (*it
));
22488 /* If no suitable font is found, use the default font. */
22489 font_not_found_p
= font
== NULL
;
22490 if (font_not_found_p
)
22492 face
= face
->ascii_face
;
22495 boff
= font
->baseline_offset
;
22496 if (font
->vertical_centering
)
22497 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22498 font_ascent
= FONT_BASE (font
) + boff
;
22499 font_descent
= FONT_DESCENT (font
) - boff
;
22500 font_height
= FONT_HEIGHT (font
);
22502 cmp
->font
= (void *) font
;
22505 if (! font_not_found_p
)
22507 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
22508 &char2b
, it
->multibyte_p
, 0);
22509 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22512 /* Initialize the bounding box. */
22515 width
= pcm
->width
;
22516 ascent
= pcm
->ascent
;
22517 descent
= pcm
->descent
;
22518 lbearing
= pcm
->lbearing
;
22519 rbearing
= pcm
->rbearing
;
22523 width
= FONT_WIDTH (font
);
22524 ascent
= FONT_BASE (font
);
22525 descent
= FONT_DESCENT (font
);
22532 lowest
= - descent
+ boff
;
22533 highest
= ascent
+ boff
;
22535 if (! font_not_found_p
22536 && font
->default_ascent
22537 && CHAR_TABLE_P (Vuse_default_ascent
)
22538 && !NILP (Faref (Vuse_default_ascent
,
22539 make_number (it
->char_to_display
))))
22540 highest
= font
->default_ascent
+ boff
;
22542 /* Draw the first glyph at the normal position. It may be
22543 shifted to right later if some other glyphs are drawn
22545 cmp
->offsets
[i
* 2] = 0;
22546 cmp
->offsets
[i
* 2 + 1] = boff
;
22547 cmp
->lbearing
= lbearing
;
22548 cmp
->rbearing
= rbearing
;
22550 /* Set cmp->offsets for the remaining glyphs. */
22551 for (i
++; i
< glyph_len
; i
++)
22553 int left
, right
, btm
, top
;
22554 int ch
= COMPOSITION_GLYPH (cmp
, i
);
22556 struct face
*this_face
;
22561 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
22562 this_face
= FACE_FROM_ID (it
->f
, face_id
);
22563 font
= this_face
->font
;
22569 this_boff
= font
->baseline_offset
;
22570 if (font
->vertical_centering
)
22571 this_boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22572 get_char_face_and_encoding (it
->f
, ch
, face_id
,
22573 &char2b
, it
->multibyte_p
, 0);
22574 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22577 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22580 width
= pcm
->width
;
22581 ascent
= pcm
->ascent
;
22582 descent
= pcm
->descent
;
22583 lbearing
= pcm
->lbearing
;
22584 rbearing
= pcm
->rbearing
;
22585 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
22587 /* Relative composition with or without
22588 alternate chars. */
22589 left
= (leftmost
+ rightmost
- width
) / 2;
22590 btm
= - descent
+ boff
;
22591 if (font
->relative_compose
22592 && (! CHAR_TABLE_P (Vignore_relative_composition
)
22593 || NILP (Faref (Vignore_relative_composition
,
22594 make_number (ch
)))))
22597 if (- descent
>= font
->relative_compose
)
22598 /* One extra pixel between two glyphs. */
22600 else if (ascent
<= 0)
22601 /* One extra pixel between two glyphs. */
22602 btm
= lowest
- 1 - ascent
- descent
;
22607 /* A composition rule is specified by an integer
22608 value that encodes global and new reference
22609 points (GREF and NREF). GREF and NREF are
22610 specified by numbers as below:
22612 0---1---2 -- ascent
22616 9--10--11 -- center
22618 ---3---4---5--- baseline
22620 6---7---8 -- descent
22622 int rule
= COMPOSITION_RULE (cmp
, i
);
22623 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
22625 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
22626 grefx
= gref
% 3, nrefx
= nref
% 3;
22627 grefy
= gref
/ 3, nrefy
= nref
/ 3;
22629 xoff
= font_height
* (xoff
- 128) / 256;
22631 yoff
= font_height
* (yoff
- 128) / 256;
22634 + grefx
* (rightmost
- leftmost
) / 2
22635 - nrefx
* width
/ 2
22638 btm
= ((grefy
== 0 ? highest
22640 : grefy
== 2 ? lowest
22641 : (highest
+ lowest
) / 2)
22642 - (nrefy
== 0 ? ascent
+ descent
22643 : nrefy
== 1 ? descent
- boff
22645 : (ascent
+ descent
) / 2)
22649 cmp
->offsets
[i
* 2] = left
;
22650 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
22652 /* Update the bounding box of the overall glyphs. */
22655 right
= left
+ width
;
22656 if (left
< leftmost
)
22658 if (right
> rightmost
)
22661 top
= btm
+ descent
+ ascent
;
22667 if (cmp
->lbearing
> left
+ lbearing
)
22668 cmp
->lbearing
= left
+ lbearing
;
22669 if (cmp
->rbearing
< left
+ rbearing
)
22670 cmp
->rbearing
= left
+ rbearing
;
22674 /* If there are glyphs whose x-offsets are negative,
22675 shift all glyphs to the right and make all x-offsets
22679 for (i
= 0; i
< cmp
->glyph_len
; i
++)
22680 cmp
->offsets
[i
* 2] -= leftmost
;
22681 rightmost
-= leftmost
;
22682 cmp
->lbearing
-= leftmost
;
22683 cmp
->rbearing
-= leftmost
;
22686 if (left_padded
&& cmp
->lbearing
< 0)
22688 for (i
= 0; i
< cmp
->glyph_len
; i
++)
22689 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
22690 rightmost
-= cmp
->lbearing
;
22691 cmp
->rbearing
-= cmp
->lbearing
;
22694 if (right_padded
&& rightmost
< cmp
->rbearing
)
22696 rightmost
= cmp
->rbearing
;
22699 cmp
->pixel_width
= rightmost
;
22700 cmp
->ascent
= highest
;
22701 cmp
->descent
= - lowest
;
22702 if (cmp
->ascent
< font_ascent
)
22703 cmp
->ascent
= font_ascent
;
22704 if (cmp
->descent
< font_descent
)
22705 cmp
->descent
= font_descent
;
22709 && (cmp
->lbearing
< 0
22710 || cmp
->rbearing
> cmp
->pixel_width
))
22711 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22713 it
->pixel_width
= cmp
->pixel_width
;
22714 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
22715 it
->descent
= it
->phys_descent
= cmp
->descent
;
22716 if (face
->box
!= FACE_NO_BOX
)
22718 int thick
= face
->box_line_width
;
22722 it
->ascent
+= thick
;
22723 it
->descent
+= thick
;
22728 if (it
->start_of_box_run_p
)
22729 it
->pixel_width
+= thick
;
22730 if (it
->end_of_box_run_p
)
22731 it
->pixel_width
+= thick
;
22734 /* If face has an overline, add the height of the overline
22735 (1 pixel) and a 1 pixel margin to the character height. */
22736 if (face
->overline_p
)
22737 it
->ascent
+= overline_margin
;
22739 take_vertical_position_into_account (it
);
22740 if (it
->ascent
< 0)
22742 if (it
->descent
< 0)
22746 append_composite_glyph (it
);
22748 else if (it
->what
== IT_COMPOSITION
)
22750 /* A dynamic (automatic) composition. */
22751 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22752 Lisp_Object gstring
;
22753 struct font_metrics metrics
;
22755 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
22757 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
22760 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
22761 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22762 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
22763 it
->descent
= it
->phys_descent
= metrics
.descent
;
22764 if (face
->box
!= FACE_NO_BOX
)
22766 int thick
= face
->box_line_width
;
22770 it
->ascent
+= thick
;
22771 it
->descent
+= thick
;
22776 if (it
->start_of_box_run_p
)
22777 it
->pixel_width
+= thick
;
22778 if (it
->end_of_box_run_p
)
22779 it
->pixel_width
+= thick
;
22781 /* If face has an overline, add the height of the overline
22782 (1 pixel) and a 1 pixel margin to the character height. */
22783 if (face
->overline_p
)
22784 it
->ascent
+= overline_margin
;
22785 take_vertical_position_into_account (it
);
22786 if (it
->ascent
< 0)
22788 if (it
->descent
< 0)
22792 append_composite_glyph (it
);
22794 else if (it
->what
== IT_IMAGE
)
22795 produce_image_glyph (it
);
22796 else if (it
->what
== IT_STRETCH
)
22797 produce_stretch_glyph (it
);
22799 /* Accumulate dimensions. Note: can't assume that it->descent > 0
22800 because this isn't true for images with `:ascent 100'. */
22801 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
22802 if (it
->area
== TEXT_AREA
)
22803 it
->current_x
+= it
->pixel_width
;
22805 if (extra_line_spacing
> 0)
22807 it
->descent
+= extra_line_spacing
;
22808 if (extra_line_spacing
> it
->max_extra_line_spacing
)
22809 it
->max_extra_line_spacing
= extra_line_spacing
;
22812 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
22813 it
->max_descent
= max (it
->max_descent
, it
->descent
);
22814 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
22815 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
22819 Output LEN glyphs starting at START at the nominal cursor position.
22820 Advance the nominal cursor over the text. The global variable
22821 updated_window contains the window being updated, updated_row is
22822 the glyph row being updated, and updated_area is the area of that
22823 row being updated. */
22826 x_write_glyphs (struct glyph
*start
, int len
)
22830 xassert (updated_window
&& updated_row
);
22833 /* Write glyphs. */
22835 hpos
= start
- updated_row
->glyphs
[updated_area
];
22836 x
= draw_glyphs (updated_window
, output_cursor
.x
,
22837 updated_row
, updated_area
,
22839 DRAW_NORMAL_TEXT
, 0);
22841 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
22842 if (updated_area
== TEXT_AREA
22843 && updated_window
->phys_cursor_on_p
22844 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
22845 && updated_window
->phys_cursor
.hpos
>= hpos
22846 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
22847 updated_window
->phys_cursor_on_p
= 0;
22851 /* Advance the output cursor. */
22852 output_cursor
.hpos
+= len
;
22853 output_cursor
.x
= x
;
22858 Insert LEN glyphs from START at the nominal cursor position. */
22861 x_insert_glyphs (struct glyph
*start
, int len
)
22865 int line_height
, shift_by_width
, shifted_region_width
;
22866 struct glyph_row
*row
;
22867 struct glyph
*glyph
;
22868 int frame_x
, frame_y
;
22871 xassert (updated_window
&& updated_row
);
22873 w
= updated_window
;
22874 f
= XFRAME (WINDOW_FRAME (w
));
22876 /* Get the height of the line we are in. */
22878 line_height
= row
->height
;
22880 /* Get the width of the glyphs to insert. */
22881 shift_by_width
= 0;
22882 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
22883 shift_by_width
+= glyph
->pixel_width
;
22885 /* Get the width of the region to shift right. */
22886 shifted_region_width
= (window_box_width (w
, updated_area
)
22891 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
22892 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
22894 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
22895 line_height
, shift_by_width
);
22897 /* Write the glyphs. */
22898 hpos
= start
- row
->glyphs
[updated_area
];
22899 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
22901 DRAW_NORMAL_TEXT
, 0);
22903 /* Advance the output cursor. */
22904 output_cursor
.hpos
+= len
;
22905 output_cursor
.x
+= shift_by_width
;
22911 Erase the current text line from the nominal cursor position
22912 (inclusive) to pixel column TO_X (exclusive). The idea is that
22913 everything from TO_X onward is already erased.
22915 TO_X is a pixel position relative to updated_area of
22916 updated_window. TO_X == -1 means clear to the end of this area. */
22919 x_clear_end_of_line (int to_x
)
22922 struct window
*w
= updated_window
;
22923 int max_x
, min_y
, max_y
;
22924 int from_x
, from_y
, to_y
;
22926 xassert (updated_window
&& updated_row
);
22927 f
= XFRAME (w
->frame
);
22929 if (updated_row
->full_width_p
)
22930 max_x
= WINDOW_TOTAL_WIDTH (w
);
22932 max_x
= window_box_width (w
, updated_area
);
22933 max_y
= window_text_bottom_y (w
);
22935 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
22936 of window. For TO_X > 0, truncate to end of drawing area. */
22942 to_x
= min (to_x
, max_x
);
22944 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
22946 /* Notice if the cursor will be cleared by this operation. */
22947 if (!updated_row
->full_width_p
)
22948 notice_overwritten_cursor (w
, updated_area
,
22949 output_cursor
.x
, -1,
22951 MATRIX_ROW_BOTTOM_Y (updated_row
));
22953 from_x
= output_cursor
.x
;
22955 /* Translate to frame coordinates. */
22956 if (updated_row
->full_width_p
)
22958 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
22959 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
22963 int area_left
= window_box_left (w
, updated_area
);
22964 from_x
+= area_left
;
22968 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
22969 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
22970 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
22972 /* Prevent inadvertently clearing to end of the X window. */
22973 if (to_x
> from_x
&& to_y
> from_y
)
22976 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
22977 to_x
- from_x
, to_y
- from_y
);
22982 #endif /* HAVE_WINDOW_SYSTEM */
22986 /***********************************************************************
22988 ***********************************************************************/
22990 /* Value is the internal representation of the specified cursor type
22991 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
22992 of the bar cursor. */
22994 static enum text_cursor_kinds
22995 get_specified_cursor_type (Lisp_Object arg
, int *width
)
22997 enum text_cursor_kinds type
;
23002 if (EQ (arg
, Qbox
))
23003 return FILLED_BOX_CURSOR
;
23005 if (EQ (arg
, Qhollow
))
23006 return HOLLOW_BOX_CURSOR
;
23008 if (EQ (arg
, Qbar
))
23015 && EQ (XCAR (arg
), Qbar
)
23016 && INTEGERP (XCDR (arg
))
23017 && XINT (XCDR (arg
)) >= 0)
23019 *width
= XINT (XCDR (arg
));
23023 if (EQ (arg
, Qhbar
))
23026 return HBAR_CURSOR
;
23030 && EQ (XCAR (arg
), Qhbar
)
23031 && INTEGERP (XCDR (arg
))
23032 && XINT (XCDR (arg
)) >= 0)
23034 *width
= XINT (XCDR (arg
));
23035 return HBAR_CURSOR
;
23038 /* Treat anything unknown as "hollow box cursor".
23039 It was bad to signal an error; people have trouble fixing
23040 .Xdefaults with Emacs, when it has something bad in it. */
23041 type
= HOLLOW_BOX_CURSOR
;
23046 /* Set the default cursor types for specified frame. */
23048 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
23053 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
23054 FRAME_CURSOR_WIDTH (f
) = width
;
23056 /* By default, set up the blink-off state depending on the on-state. */
23058 tem
= Fassoc (arg
, Vblink_cursor_alist
);
23061 FRAME_BLINK_OFF_CURSOR (f
)
23062 = get_specified_cursor_type (XCDR (tem
), &width
);
23063 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
23066 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
23070 /* Return the cursor we want to be displayed in window W. Return
23071 width of bar/hbar cursor through WIDTH arg. Return with
23072 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
23073 (i.e. if the `system caret' should track this cursor).
23075 In a mini-buffer window, we want the cursor only to appear if we
23076 are reading input from this window. For the selected window, we
23077 want the cursor type given by the frame parameter or buffer local
23078 setting of cursor-type. If explicitly marked off, draw no cursor.
23079 In all other cases, we want a hollow box cursor. */
23081 static enum text_cursor_kinds
23082 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
23083 int *active_cursor
)
23085 struct frame
*f
= XFRAME (w
->frame
);
23086 struct buffer
*b
= XBUFFER (w
->buffer
);
23087 int cursor_type
= DEFAULT_CURSOR
;
23088 Lisp_Object alt_cursor
;
23089 int non_selected
= 0;
23091 *active_cursor
= 1;
23094 if (cursor_in_echo_area
23095 && FRAME_HAS_MINIBUF_P (f
)
23096 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
23098 if (w
== XWINDOW (echo_area_window
))
23100 if (EQ (b
->cursor_type
, Qt
) || NILP (b
->cursor_type
))
23102 *width
= FRAME_CURSOR_WIDTH (f
);
23103 return FRAME_DESIRED_CURSOR (f
);
23106 return get_specified_cursor_type (b
->cursor_type
, width
);
23109 *active_cursor
= 0;
23113 /* Detect a nonselected window or nonselected frame. */
23114 else if (w
!= XWINDOW (f
->selected_window
)
23115 #ifdef HAVE_WINDOW_SYSTEM
23116 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
23120 *active_cursor
= 0;
23122 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
23128 /* Never display a cursor in a window in which cursor-type is nil. */
23129 if (NILP (b
->cursor_type
))
23132 /* Get the normal cursor type for this window. */
23133 if (EQ (b
->cursor_type
, Qt
))
23135 cursor_type
= FRAME_DESIRED_CURSOR (f
);
23136 *width
= FRAME_CURSOR_WIDTH (f
);
23139 cursor_type
= get_specified_cursor_type (b
->cursor_type
, width
);
23141 /* Use cursor-in-non-selected-windows instead
23142 for non-selected window or frame. */
23145 alt_cursor
= b
->cursor_in_non_selected_windows
;
23146 if (!EQ (Qt
, alt_cursor
))
23147 return get_specified_cursor_type (alt_cursor
, width
);
23148 /* t means modify the normal cursor type. */
23149 if (cursor_type
== FILLED_BOX_CURSOR
)
23150 cursor_type
= HOLLOW_BOX_CURSOR
;
23151 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
23153 return cursor_type
;
23156 /* Use normal cursor if not blinked off. */
23157 if (!w
->cursor_off_p
)
23159 #ifdef HAVE_WINDOW_SYSTEM
23160 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
23162 if (cursor_type
== FILLED_BOX_CURSOR
)
23164 /* Using a block cursor on large images can be very annoying.
23165 So use a hollow cursor for "large" images.
23166 If image is not transparent (no mask), also use hollow cursor. */
23167 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
23168 if (img
!= NULL
&& IMAGEP (img
->spec
))
23170 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
23171 where N = size of default frame font size.
23172 This should cover most of the "tiny" icons people may use. */
23174 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
23175 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
23176 cursor_type
= HOLLOW_BOX_CURSOR
;
23179 else if (cursor_type
!= NO_CURSOR
)
23181 /* Display current only supports BOX and HOLLOW cursors for images.
23182 So for now, unconditionally use a HOLLOW cursor when cursor is
23183 not a solid box cursor. */
23184 cursor_type
= HOLLOW_BOX_CURSOR
;
23188 return cursor_type
;
23191 /* Cursor is blinked off, so determine how to "toggle" it. */
23193 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
23194 if ((alt_cursor
= Fassoc (b
->cursor_type
, Vblink_cursor_alist
), !NILP (alt_cursor
)))
23195 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
23197 /* Then see if frame has specified a specific blink off cursor type. */
23198 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
23200 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
23201 return FRAME_BLINK_OFF_CURSOR (f
);
23205 /* Some people liked having a permanently visible blinking cursor,
23206 while others had very strong opinions against it. So it was
23207 decided to remove it. KFS 2003-09-03 */
23209 /* Finally perform built-in cursor blinking:
23210 filled box <-> hollow box
23211 wide [h]bar <-> narrow [h]bar
23212 narrow [h]bar <-> no cursor
23213 other type <-> no cursor */
23215 if (cursor_type
== FILLED_BOX_CURSOR
)
23216 return HOLLOW_BOX_CURSOR
;
23218 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
23221 return cursor_type
;
23229 #ifdef HAVE_WINDOW_SYSTEM
23231 /* Notice when the text cursor of window W has been completely
23232 overwritten by a drawing operation that outputs glyphs in AREA
23233 starting at X0 and ending at X1 in the line starting at Y0 and
23234 ending at Y1. X coordinates are area-relative. X1 < 0 means all
23235 the rest of the line after X0 has been written. Y coordinates
23236 are window-relative. */
23239 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
23240 int x0
, int x1
, int y0
, int y1
)
23242 int cx0
, cx1
, cy0
, cy1
;
23243 struct glyph_row
*row
;
23245 if (!w
->phys_cursor_on_p
)
23247 if (area
!= TEXT_AREA
)
23250 if (w
->phys_cursor
.vpos
< 0
23251 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
23252 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
23253 !(row
->enabled_p
&& row
->displays_text_p
)))
23256 if (row
->cursor_in_fringe_p
)
23258 row
->cursor_in_fringe_p
= 0;
23259 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
23260 w
->phys_cursor_on_p
= 0;
23264 cx0
= w
->phys_cursor
.x
;
23265 cx1
= cx0
+ w
->phys_cursor_width
;
23266 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
23269 /* The cursor image will be completely removed from the
23270 screen if the output area intersects the cursor area in
23271 y-direction. When we draw in [y0 y1[, and some part of
23272 the cursor is at y < y0, that part must have been drawn
23273 before. When scrolling, the cursor is erased before
23274 actually scrolling, so we don't come here. When not
23275 scrolling, the rows above the old cursor row must have
23276 changed, and in this case these rows must have written
23277 over the cursor image.
23279 Likewise if part of the cursor is below y1, with the
23280 exception of the cursor being in the first blank row at
23281 the buffer and window end because update_text_area
23282 doesn't draw that row. (Except when it does, but
23283 that's handled in update_text_area.) */
23285 cy0
= w
->phys_cursor
.y
;
23286 cy1
= cy0
+ w
->phys_cursor_height
;
23287 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
23290 w
->phys_cursor_on_p
= 0;
23293 #endif /* HAVE_WINDOW_SYSTEM */
23296 /************************************************************************
23298 ************************************************************************/
23300 #ifdef HAVE_WINDOW_SYSTEM
23303 Fix the display of area AREA of overlapping row ROW in window W
23304 with respect to the overlapping part OVERLAPS. */
23307 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
23308 enum glyph_row_area area
, int overlaps
)
23315 for (i
= 0; i
< row
->used
[area
];)
23317 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
23319 int start
= i
, start_x
= x
;
23323 x
+= row
->glyphs
[area
][i
].pixel_width
;
23326 while (i
< row
->used
[area
]
23327 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
23329 draw_glyphs (w
, start_x
, row
, area
,
23331 DRAW_NORMAL_TEXT
, overlaps
);
23335 x
+= row
->glyphs
[area
][i
].pixel_width
;
23345 Draw the cursor glyph of window W in glyph row ROW. See the
23346 comment of draw_glyphs for the meaning of HL. */
23349 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
23350 enum draw_glyphs_face hl
)
23352 /* If cursor hpos is out of bounds, don't draw garbage. This can
23353 happen in mini-buffer windows when switching between echo area
23354 glyphs and mini-buffer. */
23355 if ((row
->reversed_p
23356 ? (w
->phys_cursor
.hpos
>= 0)
23357 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
23359 int on_p
= w
->phys_cursor_on_p
;
23361 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
23362 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
23364 w
->phys_cursor_on_p
= on_p
;
23366 if (hl
== DRAW_CURSOR
)
23367 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23368 /* When we erase the cursor, and ROW is overlapped by other
23369 rows, make sure that these overlapping parts of other rows
23371 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
23373 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23375 if (row
> w
->current_matrix
->rows
23376 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
23377 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
23378 OVERLAPS_ERASED_CURSOR
);
23380 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
23381 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
23382 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
23383 OVERLAPS_ERASED_CURSOR
);
23390 Erase the image of a cursor of window W from the screen. */
23393 erase_phys_cursor (struct window
*w
)
23395 struct frame
*f
= XFRAME (w
->frame
);
23396 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
23397 int hpos
= w
->phys_cursor
.hpos
;
23398 int vpos
= w
->phys_cursor
.vpos
;
23399 int mouse_face_here_p
= 0;
23400 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
23401 struct glyph_row
*cursor_row
;
23402 struct glyph
*cursor_glyph
;
23403 enum draw_glyphs_face hl
;
23405 /* No cursor displayed or row invalidated => nothing to do on the
23407 if (w
->phys_cursor_type
== NO_CURSOR
)
23408 goto mark_cursor_off
;
23410 /* VPOS >= active_glyphs->nrows means that window has been resized.
23411 Don't bother to erase the cursor. */
23412 if (vpos
>= active_glyphs
->nrows
)
23413 goto mark_cursor_off
;
23415 /* If row containing cursor is marked invalid, there is nothing we
23417 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
23418 if (!cursor_row
->enabled_p
)
23419 goto mark_cursor_off
;
23421 /* If line spacing is > 0, old cursor may only be partially visible in
23422 window after split-window. So adjust visible height. */
23423 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
23424 window_text_bottom_y (w
) - cursor_row
->y
);
23426 /* If row is completely invisible, don't attempt to delete a cursor which
23427 isn't there. This can happen if cursor is at top of a window, and
23428 we switch to a buffer with a header line in that window. */
23429 if (cursor_row
->visible_height
<= 0)
23430 goto mark_cursor_off
;
23432 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
23433 if (cursor_row
->cursor_in_fringe_p
)
23435 cursor_row
->cursor_in_fringe_p
= 0;
23436 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
23437 goto mark_cursor_off
;
23440 /* This can happen when the new row is shorter than the old one.
23441 In this case, either draw_glyphs or clear_end_of_line
23442 should have cleared the cursor. Note that we wouldn't be
23443 able to erase the cursor in this case because we don't have a
23444 cursor glyph at hand. */
23445 if ((cursor_row
->reversed_p
23446 ? (w
->phys_cursor
.hpos
< 0)
23447 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
23448 goto mark_cursor_off
;
23450 /* If the cursor is in the mouse face area, redisplay that when
23451 we clear the cursor. */
23452 if (! NILP (dpyinfo
->mouse_face_window
)
23453 && w
== XWINDOW (dpyinfo
->mouse_face_window
)
23454 && (vpos
> dpyinfo
->mouse_face_beg_row
23455 || (vpos
== dpyinfo
->mouse_face_beg_row
23456 && hpos
>= dpyinfo
->mouse_face_beg_col
))
23457 && (vpos
< dpyinfo
->mouse_face_end_row
23458 || (vpos
== dpyinfo
->mouse_face_end_row
23459 && hpos
< dpyinfo
->mouse_face_end_col
))
23460 /* Don't redraw the cursor's spot in mouse face if it is at the
23461 end of a line (on a newline). The cursor appears there, but
23462 mouse highlighting does not. */
23463 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
23464 mouse_face_here_p
= 1;
23466 /* Maybe clear the display under the cursor. */
23467 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
23470 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
23473 cursor_glyph
= get_phys_cursor_glyph (w
);
23474 if (cursor_glyph
== NULL
)
23475 goto mark_cursor_off
;
23477 width
= cursor_glyph
->pixel_width
;
23478 left_x
= window_box_left_offset (w
, TEXT_AREA
);
23479 x
= w
->phys_cursor
.x
;
23481 width
-= left_x
- x
;
23482 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
23483 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
23484 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
23487 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
23490 /* Erase the cursor by redrawing the character underneath it. */
23491 if (mouse_face_here_p
)
23492 hl
= DRAW_MOUSE_FACE
;
23494 hl
= DRAW_NORMAL_TEXT
;
23495 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
23498 w
->phys_cursor_on_p
= 0;
23499 w
->phys_cursor_type
= NO_CURSOR
;
23504 Display or clear cursor of window W. If ON is zero, clear the
23505 cursor. If it is non-zero, display the cursor. If ON is nonzero,
23506 where to put the cursor is specified by HPOS, VPOS, X and Y. */
23509 display_and_set_cursor (struct window
*w
, int on
,
23510 int hpos
, int vpos
, int x
, int y
)
23512 struct frame
*f
= XFRAME (w
->frame
);
23513 int new_cursor_type
;
23514 int new_cursor_width
;
23516 struct glyph_row
*glyph_row
;
23517 struct glyph
*glyph
;
23519 /* This is pointless on invisible frames, and dangerous on garbaged
23520 windows and frames; in the latter case, the frame or window may
23521 be in the midst of changing its size, and x and y may be off the
23523 if (! FRAME_VISIBLE_P (f
)
23524 || FRAME_GARBAGED_P (f
)
23525 || vpos
>= w
->current_matrix
->nrows
23526 || hpos
>= w
->current_matrix
->matrix_w
)
23529 /* If cursor is off and we want it off, return quickly. */
23530 if (!on
&& !w
->phys_cursor_on_p
)
23533 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
23534 /* If cursor row is not enabled, we don't really know where to
23535 display the cursor. */
23536 if (!glyph_row
->enabled_p
)
23538 w
->phys_cursor_on_p
= 0;
23543 if (!glyph_row
->exact_window_width_line_p
23544 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
23545 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
23547 xassert (interrupt_input_blocked
);
23549 /* Set new_cursor_type to the cursor we want to be displayed. */
23550 new_cursor_type
= get_window_cursor_type (w
, glyph
,
23551 &new_cursor_width
, &active_cursor
);
23553 /* If cursor is currently being shown and we don't want it to be or
23554 it is in the wrong place, or the cursor type is not what we want,
23556 if (w
->phys_cursor_on_p
23558 || w
->phys_cursor
.x
!= x
23559 || w
->phys_cursor
.y
!= y
23560 || new_cursor_type
!= w
->phys_cursor_type
23561 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
23562 && new_cursor_width
!= w
->phys_cursor_width
)))
23563 erase_phys_cursor (w
);
23565 /* Don't check phys_cursor_on_p here because that flag is only set
23566 to zero in some cases where we know that the cursor has been
23567 completely erased, to avoid the extra work of erasing the cursor
23568 twice. In other words, phys_cursor_on_p can be 1 and the cursor
23569 still not be visible, or it has only been partly erased. */
23572 w
->phys_cursor_ascent
= glyph_row
->ascent
;
23573 w
->phys_cursor_height
= glyph_row
->height
;
23575 /* Set phys_cursor_.* before x_draw_.* is called because some
23576 of them may need the information. */
23577 w
->phys_cursor
.x
= x
;
23578 w
->phys_cursor
.y
= glyph_row
->y
;
23579 w
->phys_cursor
.hpos
= hpos
;
23580 w
->phys_cursor
.vpos
= vpos
;
23583 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
23584 new_cursor_type
, new_cursor_width
,
23585 on
, active_cursor
);
23589 /* Switch the display of W's cursor on or off, according to the value
23593 update_window_cursor (struct window
*w
, int on
)
23595 /* Don't update cursor in windows whose frame is in the process
23596 of being deleted. */
23597 if (w
->current_matrix
)
23600 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
23601 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
23607 /* Call update_window_cursor with parameter ON_P on all leaf windows
23608 in the window tree rooted at W. */
23611 update_cursor_in_window_tree (struct window
*w
, int on_p
)
23615 if (!NILP (w
->hchild
))
23616 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
23617 else if (!NILP (w
->vchild
))
23618 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
23620 update_window_cursor (w
, on_p
);
23622 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
23628 Display the cursor on window W, or clear it, according to ON_P.
23629 Don't change the cursor's position. */
23632 x_update_cursor (struct frame
*f
, int on_p
)
23634 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
23639 Clear the cursor of window W to background color, and mark the
23640 cursor as not shown. This is used when the text where the cursor
23641 is about to be rewritten. */
23644 x_clear_cursor (struct window
*w
)
23646 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
23647 update_window_cursor (w
, 0);
23652 Display the active region described by mouse_face_* according to DRAW. */
23655 show_mouse_face (Display_Info
*dpyinfo
, enum draw_glyphs_face draw
)
23657 struct window
*w
= XWINDOW (dpyinfo
->mouse_face_window
);
23658 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23660 if (/* If window is in the process of being destroyed, don't bother
23662 w
->current_matrix
!= NULL
23663 /* Don't update mouse highlight if hidden */
23664 && (draw
!= DRAW_MOUSE_FACE
|| !dpyinfo
->mouse_face_hidden
)
23665 /* Recognize when we are called to operate on rows that don't exist
23666 anymore. This can happen when a window is split. */
23667 && dpyinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
23669 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
23670 struct glyph_row
*row
, *first
, *last
;
23672 first
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
23673 last
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
23675 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
23677 int start_hpos
, end_hpos
, start_x
;
23679 /* For all but the first row, the highlight starts at column 0. */
23682 start_hpos
= dpyinfo
->mouse_face_beg_col
;
23683 start_x
= dpyinfo
->mouse_face_beg_x
;
23692 end_hpos
= dpyinfo
->mouse_face_end_col
;
23695 end_hpos
= row
->used
[TEXT_AREA
];
23696 if (draw
== DRAW_NORMAL_TEXT
)
23697 row
->fill_line_p
= 1; /* Clear to end of line */
23700 if (end_hpos
> start_hpos
)
23702 draw_glyphs (w
, start_x
, row
, TEXT_AREA
,
23703 start_hpos
, end_hpos
,
23707 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
23711 /* When we've written over the cursor, arrange for it to
23712 be displayed again. */
23713 if (phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
23716 display_and_set_cursor (w
, 1,
23717 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
23718 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
23723 /* Change the mouse cursor. */
23724 if (draw
== DRAW_NORMAL_TEXT
&& !EQ (dpyinfo
->mouse_face_window
, f
->tool_bar_window
))
23725 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
23726 else if (draw
== DRAW_MOUSE_FACE
)
23727 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
23729 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
23733 Clear out the mouse-highlighted active region.
23734 Redraw it un-highlighted first. Value is non-zero if mouse
23735 face was actually drawn unhighlighted. */
23738 clear_mouse_face (Display_Info
*dpyinfo
)
23742 if (!dpyinfo
->mouse_face_hidden
&& !NILP (dpyinfo
->mouse_face_window
))
23744 show_mouse_face (dpyinfo
, DRAW_NORMAL_TEXT
);
23748 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
23749 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
23750 dpyinfo
->mouse_face_window
= Qnil
;
23751 dpyinfo
->mouse_face_overlay
= Qnil
;
23757 Non-zero if physical cursor of window W is within mouse face. */
23760 cursor_in_mouse_face_p (struct window
*w
)
23762 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
23763 int in_mouse_face
= 0;
23765 if (WINDOWP (dpyinfo
->mouse_face_window
)
23766 && XWINDOW (dpyinfo
->mouse_face_window
) == w
)
23768 int hpos
= w
->phys_cursor
.hpos
;
23769 int vpos
= w
->phys_cursor
.vpos
;
23771 if (vpos
>= dpyinfo
->mouse_face_beg_row
23772 && vpos
<= dpyinfo
->mouse_face_end_row
23773 && (vpos
> dpyinfo
->mouse_face_beg_row
23774 || hpos
>= dpyinfo
->mouse_face_beg_col
)
23775 && (vpos
< dpyinfo
->mouse_face_end_row
23776 || hpos
< dpyinfo
->mouse_face_end_col
23777 || dpyinfo
->mouse_face_past_end
))
23781 return in_mouse_face
;
23787 /* This function sets the mouse_face_* elements of DPYINFO, assuming
23788 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
23789 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
23790 for the overlay or run of text properties specifying the mouse
23791 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
23792 before-string and after-string that must also be highlighted.
23793 DISPLAY_STRING, if non-nil, is a display string that may cover some
23794 or all of the highlighted text. */
23797 mouse_face_from_buffer_pos (Lisp_Object window
,
23798 Display_Info
*dpyinfo
,
23799 EMACS_INT mouse_charpos
,
23800 EMACS_INT start_charpos
,
23801 EMACS_INT end_charpos
,
23802 Lisp_Object before_string
,
23803 Lisp_Object after_string
,
23804 Lisp_Object display_string
)
23806 struct window
*w
= XWINDOW (window
);
23807 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
23808 struct glyph_row
*row
;
23809 struct glyph
*glyph
, *end
;
23813 xassert (NILP (display_string
) || STRINGP (display_string
));
23814 xassert (NILP (before_string
) || STRINGP (before_string
));
23815 xassert (NILP (after_string
) || STRINGP (after_string
));
23817 /* Find the first highlighted glyph. */
23818 if (start_charpos
< MATRIX_ROW_START_CHARPOS (first
))
23820 dpyinfo
->mouse_face_beg_col
= 0;
23821 dpyinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (first
, w
->current_matrix
);
23822 dpyinfo
->mouse_face_beg_x
= first
->x
;
23823 dpyinfo
->mouse_face_beg_y
= first
->y
;
23827 row
= row_containing_pos (w
, start_charpos
, first
, NULL
, 0);
23829 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
23831 /* If the before-string or display-string contains newlines,
23832 row_containing_pos skips to its last row. Move back. */
23833 if (!NILP (before_string
) || !NILP (display_string
))
23835 struct glyph_row
*prev
;
23836 while ((prev
= row
- 1, prev
>= first
)
23837 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
23838 && prev
->used
[TEXT_AREA
] > 0)
23840 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
23841 glyph
= beg
+ prev
->used
[TEXT_AREA
];
23842 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
23844 || !(EQ (glyph
->object
, before_string
)
23845 || EQ (glyph
->object
, display_string
)))
23851 glyph
= row
->glyphs
[TEXT_AREA
];
23852 end
= glyph
+ row
->used
[TEXT_AREA
];
23854 dpyinfo
->mouse_face_beg_y
= row
->y
;
23855 dpyinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
23857 /* Skip truncation glyphs at the start of the glyph row. */
23858 if (row
->displays_text_p
)
23860 && INTEGERP (glyph
->object
)
23861 && glyph
->charpos
< 0;
23863 x
+= glyph
->pixel_width
;
23865 /* Scan the glyph row, stopping before BEFORE_STRING or
23866 DISPLAY_STRING or START_CHARPOS. */
23868 && !INTEGERP (glyph
->object
)
23869 && !EQ (glyph
->object
, before_string
)
23870 && !EQ (glyph
->object
, display_string
)
23871 && !(BUFFERP (glyph
->object
)
23872 && glyph
->charpos
>= start_charpos
);
23874 x
+= glyph
->pixel_width
;
23876 dpyinfo
->mouse_face_beg_x
= x
;
23877 dpyinfo
->mouse_face_beg_col
= glyph
- row
->glyphs
[TEXT_AREA
];
23880 /* Find the last highlighted glyph. */
23881 row
= row_containing_pos (w
, end_charpos
, first
, NULL
, 0);
23884 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
23885 dpyinfo
->mouse_face_past_end
= 1;
23887 else if (!NILP (after_string
))
23889 /* If the after-string has newlines, advance to its last row. */
23890 struct glyph_row
*next
;
23891 struct glyph_row
*last
23892 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
23894 for (next
= row
+ 1;
23896 && next
->used
[TEXT_AREA
] > 0
23897 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
23902 glyph
= row
->glyphs
[TEXT_AREA
];
23903 end
= glyph
+ row
->used
[TEXT_AREA
];
23905 dpyinfo
->mouse_face_end_y
= row
->y
;
23906 dpyinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
23908 /* Skip truncation glyphs at the start of the row. */
23909 if (row
->displays_text_p
)
23911 && INTEGERP (glyph
->object
)
23912 && glyph
->charpos
< 0;
23914 x
+= glyph
->pixel_width
;
23916 /* Scan the glyph row, stopping at END_CHARPOS or when we encounter
23919 && !INTEGERP (glyph
->object
)
23920 && !EQ (glyph
->object
, after_string
)
23921 && !(BUFFERP (glyph
->object
) && glyph
->charpos
>= end_charpos
);
23923 x
+= glyph
->pixel_width
;
23925 /* If we found AFTER_STRING, consume it and stop. */
23926 if (EQ (glyph
->object
, after_string
))
23928 for (; EQ (glyph
->object
, after_string
) && glyph
< end
; ++glyph
)
23929 x
+= glyph
->pixel_width
;
23933 /* If there's no after-string, we must check if we overshot,
23934 which might be the case if we stopped after a string glyph.
23935 That glyph may belong to a before-string or display-string
23936 associated with the end position, which must not be
23938 Lisp_Object prev_object
;
23941 while (glyph
> row
->glyphs
[TEXT_AREA
])
23943 prev_object
= (glyph
- 1)->object
;
23944 if (!STRINGP (prev_object
) || EQ (prev_object
, display_string
))
23947 pos
= string_buffer_position (w
, prev_object
, end_charpos
);
23948 if (pos
&& pos
< end_charpos
)
23951 for (; glyph
> row
->glyphs
[TEXT_AREA
]
23952 && EQ ((glyph
- 1)->object
, prev_object
);
23954 x
-= (glyph
- 1)->pixel_width
;
23958 dpyinfo
->mouse_face_end_x
= x
;
23959 dpyinfo
->mouse_face_end_col
= glyph
- row
->glyphs
[TEXT_AREA
];
23960 dpyinfo
->mouse_face_window
= window
;
23961 dpyinfo
->mouse_face_face_id
23962 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
23964 !dpyinfo
->mouse_face_hidden
, -1);
23965 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23969 /* Find the position of the glyph for position POS in OBJECT in
23970 window W's current matrix, and return in *X, *Y the pixel
23971 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
23973 RIGHT_P non-zero means return the position of the right edge of the
23974 glyph, RIGHT_P zero means return the left edge position.
23976 If no glyph for POS exists in the matrix, return the position of
23977 the glyph with the next smaller position that is in the matrix, if
23978 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
23979 exists in the matrix, return the position of the glyph with the
23980 next larger position in OBJECT.
23982 Value is non-zero if a glyph was found. */
23985 fast_find_string_pos (struct window
*w
, EMACS_INT pos
, Lisp_Object object
,
23986 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
23988 int yb
= window_text_bottom_y (w
);
23989 struct glyph_row
*r
;
23990 struct glyph
*best_glyph
= NULL
;
23991 struct glyph_row
*best_row
= NULL
;
23994 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
23995 r
->enabled_p
&& r
->y
< yb
;
23998 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
23999 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
24002 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
24003 if (EQ (g
->object
, object
))
24005 if (g
->charpos
== pos
)
24012 else if (best_glyph
== NULL
24013 || ((eabs (g
->charpos
- pos
)
24014 < eabs (best_glyph
->charpos
- pos
))
24017 : g
->charpos
> pos
)))
24031 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
24035 *x
+= best_glyph
->pixel_width
;
24040 *vpos
= best_row
- w
->current_matrix
->rows
;
24043 return best_glyph
!= NULL
;
24047 /* See if position X, Y is within a hot-spot of an image. */
24050 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
24052 if (!CONSP (hot_spot
))
24055 if (EQ (XCAR (hot_spot
), Qrect
))
24057 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
24058 Lisp_Object rect
= XCDR (hot_spot
);
24062 if (!CONSP (XCAR (rect
)))
24064 if (!CONSP (XCDR (rect
)))
24066 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
24068 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
24070 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
24072 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
24076 else if (EQ (XCAR (hot_spot
), Qcircle
))
24078 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
24079 Lisp_Object circ
= XCDR (hot_spot
);
24080 Lisp_Object lr
, lx0
, ly0
;
24082 && CONSP (XCAR (circ
))
24083 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
24084 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
24085 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
24087 double r
= XFLOATINT (lr
);
24088 double dx
= XINT (lx0
) - x
;
24089 double dy
= XINT (ly0
) - y
;
24090 return (dx
* dx
+ dy
* dy
<= r
* r
);
24093 else if (EQ (XCAR (hot_spot
), Qpoly
))
24095 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
24096 if (VECTORP (XCDR (hot_spot
)))
24098 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
24099 Lisp_Object
*poly
= v
->contents
;
24103 Lisp_Object lx
, ly
;
24106 /* Need an even number of coordinates, and at least 3 edges. */
24107 if (n
< 6 || n
& 1)
24110 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
24111 If count is odd, we are inside polygon. Pixels on edges
24112 may or may not be included depending on actual geometry of the
24114 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
24115 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
24117 x0
= XINT (lx
), y0
= XINT (ly
);
24118 for (i
= 0; i
< n
; i
+= 2)
24120 int x1
= x0
, y1
= y0
;
24121 if ((lx
= poly
[i
], !INTEGERP (lx
))
24122 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
24124 x0
= XINT (lx
), y0
= XINT (ly
);
24126 /* Does this segment cross the X line? */
24134 if (y
> y0
&& y
> y1
)
24136 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
24146 find_hot_spot (Lisp_Object map
, int x
, int y
)
24148 while (CONSP (map
))
24150 if (CONSP (XCAR (map
))
24151 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
24159 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
24161 doc
: /* Lookup in image map MAP coordinates X and Y.
24162 An image map is an alist where each element has the format (AREA ID PLIST).
24163 An AREA is specified as either a rectangle, a circle, or a polygon:
24164 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
24165 pixel coordinates of the upper left and bottom right corners.
24166 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
24167 and the radius of the circle; r may be a float or integer.
24168 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
24169 vector describes one corner in the polygon.
24170 Returns the alist element for the first matching AREA in MAP. */)
24171 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
24179 return find_hot_spot (map
, XINT (x
), XINT (y
));
24183 /* Display frame CURSOR, optionally using shape defined by POINTER. */
24185 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
24187 /* Do not change cursor shape while dragging mouse. */
24188 if (!NILP (do_mouse_tracking
))
24191 if (!NILP (pointer
))
24193 if (EQ (pointer
, Qarrow
))
24194 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24195 else if (EQ (pointer
, Qhand
))
24196 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
24197 else if (EQ (pointer
, Qtext
))
24198 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
24199 else if (EQ (pointer
, intern ("hdrag")))
24200 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
24201 #ifdef HAVE_X_WINDOWS
24202 else if (EQ (pointer
, intern ("vdrag")))
24203 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
24205 else if (EQ (pointer
, intern ("hourglass")))
24206 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
24207 else if (EQ (pointer
, Qmodeline
))
24208 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
24210 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24213 if (cursor
!= No_Cursor
)
24214 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
24217 /* Take proper action when mouse has moved to the mode or header line
24218 or marginal area AREA of window W, x-position X and y-position Y.
24219 X is relative to the start of the text display area of W, so the
24220 width of bitmap areas and scroll bars must be subtracted to get a
24221 position relative to the start of the mode line. */
24224 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
24225 enum window_part area
)
24227 struct window
*w
= XWINDOW (window
);
24228 struct frame
*f
= XFRAME (w
->frame
);
24229 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24230 Cursor cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24231 Lisp_Object pointer
= Qnil
;
24232 int charpos
, dx
, dy
, width
, height
;
24233 Lisp_Object string
, object
= Qnil
;
24234 Lisp_Object pos
, help
;
24236 Lisp_Object mouse_face
;
24237 int original_x_pixel
= x
;
24238 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
24239 struct glyph_row
*row
;
24241 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
24246 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
24247 &object
, &dx
, &dy
, &width
, &height
);
24249 row
= (area
== ON_MODE_LINE
24250 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
24251 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
24254 if (row
->mode_line_p
&& row
->enabled_p
)
24256 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
24257 end
= glyph
+ row
->used
[TEXT_AREA
];
24259 for (x0
= original_x_pixel
;
24260 glyph
< end
&& x0
>= glyph
->pixel_width
;
24262 x0
-= glyph
->pixel_width
;
24270 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
24271 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
24272 &object
, &dx
, &dy
, &width
, &height
);
24277 if (IMAGEP (object
))
24279 Lisp_Object image_map
, hotspot
;
24280 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
24282 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
24284 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
24286 Lisp_Object area_id
, plist
;
24288 area_id
= XCAR (hotspot
);
24289 /* Could check AREA_ID to see if we enter/leave this hot-spot.
24290 If so, we could look for mouse-enter, mouse-leave
24291 properties in PLIST (and do something...). */
24292 hotspot
= XCDR (hotspot
);
24293 if (CONSP (hotspot
)
24294 && (plist
= XCAR (hotspot
), CONSP (plist
)))
24296 pointer
= Fplist_get (plist
, Qpointer
);
24297 if (NILP (pointer
))
24299 help
= Fplist_get (plist
, Qhelp_echo
);
24302 help_echo_string
= help
;
24303 /* Is this correct? ++kfs */
24304 XSETWINDOW (help_echo_window
, w
);
24305 help_echo_object
= w
->buffer
;
24306 help_echo_pos
= charpos
;
24310 if (NILP (pointer
))
24311 pointer
= Fplist_get (XCDR (object
), QCpointer
);
24314 if (STRINGP (string
))
24316 pos
= make_number (charpos
);
24317 /* If we're on a string with `help-echo' text property, arrange
24318 for the help to be displayed. This is done by setting the
24319 global variable help_echo_string to the help string. */
24322 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
24325 help_echo_string
= help
;
24326 XSETWINDOW (help_echo_window
, w
);
24327 help_echo_object
= string
;
24328 help_echo_pos
= charpos
;
24332 if (NILP (pointer
))
24333 pointer
= Fget_text_property (pos
, Qpointer
, string
);
24335 /* Change the mouse pointer according to what is under X/Y. */
24336 if (NILP (pointer
) && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
24339 map
= Fget_text_property (pos
, Qlocal_map
, string
);
24340 if (!KEYMAPP (map
))
24341 map
= Fget_text_property (pos
, Qkeymap
, string
);
24342 if (!KEYMAPP (map
))
24343 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
24346 /* Change the mouse face according to what is under X/Y. */
24347 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
24348 if (!NILP (mouse_face
)
24349 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
24354 struct glyph
* tmp_glyph
;
24358 int total_pixel_width
;
24363 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
24364 Qmouse_face
, string
, Qnil
);
24366 b
= make_number (0);
24368 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
24370 e
= make_number (SCHARS (string
));
24372 /* Calculate the position(glyph position: GPOS) of GLYPH in
24373 displayed string. GPOS is different from CHARPOS.
24375 CHARPOS is the position of glyph in internal string
24376 object. A mode line string format has structures which
24377 is converted to a flatten by emacs lisp interpreter.
24378 The internal string is an element of the structures.
24379 The displayed string is the flatten string. */
24381 if (glyph
> row_start_glyph
)
24383 tmp_glyph
= glyph
- 1;
24384 while (tmp_glyph
>= row_start_glyph
24385 && tmp_glyph
->charpos
>= XINT (b
)
24386 && EQ (tmp_glyph
->object
, glyph
->object
))
24393 /* Calculate the lenght(glyph sequence length: GSEQ_LENGTH) of
24394 displayed string holding GLYPH.
24396 GSEQ_LENGTH is different from SCHARS (STRING).
24397 SCHARS (STRING) returns the length of the internal string. */
24398 for (tmp_glyph
= glyph
, gseq_length
= gpos
;
24399 tmp_glyph
->charpos
< XINT (e
);
24400 tmp_glyph
++, gseq_length
++)
24402 if (!EQ (tmp_glyph
->object
, glyph
->object
))
24406 total_pixel_width
= 0;
24407 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
24408 total_pixel_width
+= tmp_glyph
->pixel_width
;
24410 /* Pre calculation of re-rendering position */
24412 hpos
= (area
== ON_MODE_LINE
24413 ? (w
->current_matrix
)->nrows
- 1
24416 /* If the re-rendering position is included in the last
24417 re-rendering area, we should do nothing. */
24418 if ( EQ (window
, dpyinfo
->mouse_face_window
)
24419 && dpyinfo
->mouse_face_beg_col
<= vpos
24420 && vpos
< dpyinfo
->mouse_face_end_col
24421 && dpyinfo
->mouse_face_beg_row
== hpos
)
24424 if (clear_mouse_face (dpyinfo
))
24425 cursor
= No_Cursor
;
24427 dpyinfo
->mouse_face_beg_col
= vpos
;
24428 dpyinfo
->mouse_face_beg_row
= hpos
;
24430 dpyinfo
->mouse_face_beg_x
= original_x_pixel
- (total_pixel_width
+ dx
);
24431 dpyinfo
->mouse_face_beg_y
= 0;
24433 dpyinfo
->mouse_face_end_col
= vpos
+ gseq_length
;
24434 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_beg_row
;
24436 dpyinfo
->mouse_face_end_x
= 0;
24437 dpyinfo
->mouse_face_end_y
= 0;
24439 dpyinfo
->mouse_face_past_end
= 0;
24440 dpyinfo
->mouse_face_window
= window
;
24442 dpyinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
24445 glyph
->face_id
, 1);
24446 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
24448 if (NILP (pointer
))
24451 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
24452 clear_mouse_face (dpyinfo
);
24454 define_frame_cursor1 (f
, cursor
, pointer
);
24459 Take proper action when the mouse has moved to position X, Y on
24460 frame F as regards highlighting characters that have mouse-face
24461 properties. Also de-highlighting chars where the mouse was before.
24462 X and Y can be negative or out of range. */
24465 note_mouse_highlight (struct frame
*f
, int x
, int y
)
24467 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24468 enum window_part part
;
24469 Lisp_Object window
;
24471 Cursor cursor
= No_Cursor
;
24472 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
24475 /* When a menu is active, don't highlight because this looks odd. */
24476 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
24477 if (popup_activated ())
24481 if (NILP (Vmouse_highlight
)
24482 || !f
->glyphs_initialized_p
24483 || f
->pointer_invisible
)
24486 dpyinfo
->mouse_face_mouse_x
= x
;
24487 dpyinfo
->mouse_face_mouse_y
= y
;
24488 dpyinfo
->mouse_face_mouse_frame
= f
;
24490 if (dpyinfo
->mouse_face_defer
)
24493 if (gc_in_progress
)
24495 dpyinfo
->mouse_face_deferred_gc
= 1;
24499 /* Which window is that in? */
24500 window
= window_from_coordinates (f
, x
, y
, &part
, 0, 0, 1);
24502 /* If we were displaying active text in another window, clear that.
24503 Also clear if we move out of text area in same window. */
24504 if (! EQ (window
, dpyinfo
->mouse_face_window
)
24505 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
24506 && !NILP (dpyinfo
->mouse_face_window
)))
24507 clear_mouse_face (dpyinfo
);
24509 /* Not on a window -> return. */
24510 if (!WINDOWP (window
))
24513 /* Reset help_echo_string. It will get recomputed below. */
24514 help_echo_string
= Qnil
;
24516 /* Convert to window-relative pixel coordinates. */
24517 w
= XWINDOW (window
);
24518 frame_to_window_pixel_xy (w
, &x
, &y
);
24520 /* Handle tool-bar window differently since it doesn't display a
24522 if (EQ (window
, f
->tool_bar_window
))
24524 note_tool_bar_highlight (f
, x
, y
);
24528 /* Mouse is on the mode, header line or margin? */
24529 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
24530 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
24532 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
24536 if (part
== ON_VERTICAL_BORDER
)
24538 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
24539 help_echo_string
= build_string ("drag-mouse-1: resize");
24541 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
24542 || part
== ON_SCROLL_BAR
)
24543 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24545 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
24547 /* Are we in a window whose display is up to date?
24548 And verify the buffer's text has not changed. */
24549 b
= XBUFFER (w
->buffer
);
24550 if (part
== ON_TEXT
24551 && EQ (w
->window_end_valid
, w
->buffer
)
24552 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
24553 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
24555 int hpos
, vpos
, i
, dx
, dy
, area
;
24557 struct glyph
*glyph
;
24558 Lisp_Object object
;
24559 Lisp_Object mouse_face
= Qnil
, overlay
= Qnil
, position
;
24560 Lisp_Object
*overlay_vec
= NULL
;
24562 struct buffer
*obuf
;
24563 int obegv
, ozv
, same_region
;
24565 /* Find the glyph under X/Y. */
24566 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
24568 /* Look for :pointer property on image. */
24569 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
24571 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
24572 if (img
!= NULL
&& IMAGEP (img
->spec
))
24574 Lisp_Object image_map
, hotspot
;
24575 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
24577 && (hotspot
= find_hot_spot (image_map
,
24578 glyph
->slice
.x
+ dx
,
24579 glyph
->slice
.y
+ dy
),
24581 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
24583 Lisp_Object area_id
, plist
;
24585 area_id
= XCAR (hotspot
);
24586 /* Could check AREA_ID to see if we enter/leave this hot-spot.
24587 If so, we could look for mouse-enter, mouse-leave
24588 properties in PLIST (and do something...). */
24589 hotspot
= XCDR (hotspot
);
24590 if (CONSP (hotspot
)
24591 && (plist
= XCAR (hotspot
), CONSP (plist
)))
24593 pointer
= Fplist_get (plist
, Qpointer
);
24594 if (NILP (pointer
))
24596 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
24597 if (!NILP (help_echo_string
))
24599 help_echo_window
= window
;
24600 help_echo_object
= glyph
->object
;
24601 help_echo_pos
= glyph
->charpos
;
24605 if (NILP (pointer
))
24606 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
24610 /* Clear mouse face if X/Y not over text. */
24612 || area
!= TEXT_AREA
24613 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
)
24615 if (clear_mouse_face (dpyinfo
))
24616 cursor
= No_Cursor
;
24617 if (NILP (pointer
))
24619 if (area
!= TEXT_AREA
)
24620 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24622 pointer
= Vvoid_text_area_pointer
;
24627 pos
= glyph
->charpos
;
24628 object
= glyph
->object
;
24629 if (!STRINGP (object
) && !BUFFERP (object
))
24632 /* If we get an out-of-range value, return now; avoid an error. */
24633 if (BUFFERP (object
) && pos
> BUF_Z (b
))
24636 /* Make the window's buffer temporarily current for
24637 overlays_at and compute_char_face. */
24638 obuf
= current_buffer
;
24639 current_buffer
= b
;
24645 /* Is this char mouse-active or does it have help-echo? */
24646 position
= make_number (pos
);
24648 if (BUFFERP (object
))
24650 /* Put all the overlays we want in a vector in overlay_vec. */
24651 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
24652 /* Sort overlays into increasing priority order. */
24653 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
24658 same_region
= (EQ (window
, dpyinfo
->mouse_face_window
)
24659 && vpos
>= dpyinfo
->mouse_face_beg_row
24660 && vpos
<= dpyinfo
->mouse_face_end_row
24661 && (vpos
> dpyinfo
->mouse_face_beg_row
24662 || hpos
>= dpyinfo
->mouse_face_beg_col
)
24663 && (vpos
< dpyinfo
->mouse_face_end_row
24664 || hpos
< dpyinfo
->mouse_face_end_col
24665 || dpyinfo
->mouse_face_past_end
));
24668 cursor
= No_Cursor
;
24670 /* Check mouse-face highlighting. */
24672 /* If there exists an overlay with mouse-face overlapping
24673 the one we are currently highlighting, we have to
24674 check if we enter the overlapping overlay, and then
24675 highlight only that. */
24676 || (OVERLAYP (dpyinfo
->mouse_face_overlay
)
24677 && mouse_face_overlay_overlaps (dpyinfo
->mouse_face_overlay
)))
24679 /* Find the highest priority overlay with a mouse-face. */
24681 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
24683 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
24684 if (!NILP (mouse_face
))
24685 overlay
= overlay_vec
[i
];
24688 /* If we're highlighting the same overlay as before, there's
24689 no need to do that again. */
24690 if (!NILP (overlay
) && EQ (overlay
, dpyinfo
->mouse_face_overlay
))
24691 goto check_help_echo
;
24692 dpyinfo
->mouse_face_overlay
= overlay
;
24694 /* Clear the display of the old active region, if any. */
24695 if (clear_mouse_face (dpyinfo
))
24696 cursor
= No_Cursor
;
24698 /* If no overlay applies, get a text property. */
24699 if (NILP (overlay
))
24700 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
24702 /* Next, compute the bounds of the mouse highlighting and
24704 if (!NILP (mouse_face
) && STRINGP (object
))
24706 /* The mouse-highlighting comes from a display string
24707 with a mouse-face. */
24711 b
= Fprevious_single_property_change
24712 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
24713 e
= Fnext_single_property_change
24714 (position
, Qmouse_face
, object
, Qnil
);
24716 b
= make_number (0);
24718 e
= make_number (SCHARS (object
) - 1);
24720 fast_find_string_pos (w
, XINT (b
), object
,
24721 &dpyinfo
->mouse_face_beg_col
,
24722 &dpyinfo
->mouse_face_beg_row
,
24723 &dpyinfo
->mouse_face_beg_x
,
24724 &dpyinfo
->mouse_face_beg_y
, 0);
24725 fast_find_string_pos (w
, XINT (e
), object
,
24726 &dpyinfo
->mouse_face_end_col
,
24727 &dpyinfo
->mouse_face_end_row
,
24728 &dpyinfo
->mouse_face_end_x
,
24729 &dpyinfo
->mouse_face_end_y
, 1);
24730 dpyinfo
->mouse_face_past_end
= 0;
24731 dpyinfo
->mouse_face_window
= window
;
24732 dpyinfo
->mouse_face_face_id
24733 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
24734 glyph
->face_id
, 1);
24735 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
24736 cursor
= No_Cursor
;
24740 /* The mouse-highlighting, if any, comes from an overlay
24741 or text property in the buffer. */
24742 Lisp_Object buffer
, display_string
;
24744 if (STRINGP (object
))
24746 /* If we are on a display string with no mouse-face,
24747 check if the text under it has one. */
24748 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
24749 int start
= MATRIX_ROW_START_CHARPOS (r
);
24750 pos
= string_buffer_position (w
, object
, start
);
24753 mouse_face
= get_char_property_and_overlay
24754 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
24755 buffer
= w
->buffer
;
24756 display_string
= object
;
24762 display_string
= Qnil
;
24765 if (!NILP (mouse_face
))
24767 Lisp_Object before
, after
;
24768 Lisp_Object before_string
, after_string
;
24770 if (NILP (overlay
))
24772 /* Handle the text property case. */
24773 before
= Fprevious_single_property_change
24774 (make_number (pos
+ 1), Qmouse_face
, buffer
,
24775 Fmarker_position (w
->start
));
24776 after
= Fnext_single_property_change
24777 (make_number (pos
), Qmouse_face
, buffer
,
24778 make_number (BUF_Z (XBUFFER (buffer
))
24779 - XFASTINT (w
->window_end_pos
)));
24780 before_string
= after_string
= Qnil
;
24784 /* Handle the overlay case. */
24785 before
= Foverlay_start (overlay
);
24786 after
= Foverlay_end (overlay
);
24787 before_string
= Foverlay_get (overlay
, Qbefore_string
);
24788 after_string
= Foverlay_get (overlay
, Qafter_string
);
24790 if (!STRINGP (before_string
)) before_string
= Qnil
;
24791 if (!STRINGP (after_string
)) after_string
= Qnil
;
24794 mouse_face_from_buffer_pos (window
, dpyinfo
, pos
,
24797 before_string
, after_string
,
24799 cursor
= No_Cursor
;
24806 /* Look for a `help-echo' property. */
24807 if (NILP (help_echo_string
)) {
24808 Lisp_Object help
, overlay
;
24810 /* Check overlays first. */
24811 help
= overlay
= Qnil
;
24812 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
24814 overlay
= overlay_vec
[i
];
24815 help
= Foverlay_get (overlay
, Qhelp_echo
);
24820 help_echo_string
= help
;
24821 help_echo_window
= window
;
24822 help_echo_object
= overlay
;
24823 help_echo_pos
= pos
;
24827 Lisp_Object object
= glyph
->object
;
24828 int charpos
= glyph
->charpos
;
24830 /* Try text properties. */
24831 if (STRINGP (object
)
24833 && charpos
< SCHARS (object
))
24835 help
= Fget_text_property (make_number (charpos
),
24836 Qhelp_echo
, object
);
24839 /* If the string itself doesn't specify a help-echo,
24840 see if the buffer text ``under'' it does. */
24841 struct glyph_row
*r
24842 = MATRIX_ROW (w
->current_matrix
, vpos
);
24843 int start
= MATRIX_ROW_START_CHARPOS (r
);
24844 EMACS_INT pos
= string_buffer_position (w
, object
, start
);
24847 help
= Fget_char_property (make_number (pos
),
24848 Qhelp_echo
, w
->buffer
);
24852 object
= w
->buffer
;
24857 else if (BUFFERP (object
)
24860 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
24865 help_echo_string
= help
;
24866 help_echo_window
= window
;
24867 help_echo_object
= object
;
24868 help_echo_pos
= charpos
;
24873 /* Look for a `pointer' property. */
24874 if (NILP (pointer
))
24876 /* Check overlays first. */
24877 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
24878 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
24880 if (NILP (pointer
))
24882 Lisp_Object object
= glyph
->object
;
24883 int charpos
= glyph
->charpos
;
24885 /* Try text properties. */
24886 if (STRINGP (object
)
24888 && charpos
< SCHARS (object
))
24890 pointer
= Fget_text_property (make_number (charpos
),
24892 if (NILP (pointer
))
24894 /* If the string itself doesn't specify a pointer,
24895 see if the buffer text ``under'' it does. */
24896 struct glyph_row
*r
24897 = MATRIX_ROW (w
->current_matrix
, vpos
);
24898 int start
= MATRIX_ROW_START_CHARPOS (r
);
24899 EMACS_INT pos
= string_buffer_position (w
, object
,
24902 pointer
= Fget_char_property (make_number (pos
),
24903 Qpointer
, w
->buffer
);
24906 else if (BUFFERP (object
)
24909 pointer
= Fget_text_property (make_number (charpos
),
24916 current_buffer
= obuf
;
24921 define_frame_cursor1 (f
, cursor
, pointer
);
24926 Clear any mouse-face on window W. This function is part of the
24927 redisplay interface, and is called from try_window_id and similar
24928 functions to ensure the mouse-highlight is off. */
24931 x_clear_window_mouse_face (struct window
*w
)
24933 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
24934 Lisp_Object window
;
24937 XSETWINDOW (window
, w
);
24938 if (EQ (window
, dpyinfo
->mouse_face_window
))
24939 clear_mouse_face (dpyinfo
);
24945 Just discard the mouse face information for frame F, if any.
24946 This is used when the size of F is changed. */
24949 cancel_mouse_face (struct frame
*f
)
24951 Lisp_Object window
;
24952 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24954 window
= dpyinfo
->mouse_face_window
;
24955 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
24957 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
24958 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
24959 dpyinfo
->mouse_face_window
= Qnil
;
24964 #endif /* HAVE_WINDOW_SYSTEM */
24967 /***********************************************************************
24969 ***********************************************************************/
24971 #ifdef HAVE_WINDOW_SYSTEM
24973 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
24974 which intersects rectangle R. R is in window-relative coordinates. */
24977 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
24978 enum glyph_row_area area
)
24980 struct glyph
*first
= row
->glyphs
[area
];
24981 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
24982 struct glyph
*last
;
24983 int first_x
, start_x
, x
;
24985 if (area
== TEXT_AREA
&& row
->fill_line_p
)
24986 /* If row extends face to end of line write the whole line. */
24987 draw_glyphs (w
, 0, row
, area
,
24988 0, row
->used
[area
],
24989 DRAW_NORMAL_TEXT
, 0);
24992 /* Set START_X to the window-relative start position for drawing glyphs of
24993 AREA. The first glyph of the text area can be partially visible.
24994 The first glyphs of other areas cannot. */
24995 start_x
= window_box_left_offset (w
, area
);
24997 if (area
== TEXT_AREA
)
25000 /* Find the first glyph that must be redrawn. */
25002 && x
+ first
->pixel_width
< r
->x
)
25004 x
+= first
->pixel_width
;
25008 /* Find the last one. */
25012 && x
< r
->x
+ r
->width
)
25014 x
+= last
->pixel_width
;
25020 draw_glyphs (w
, first_x
- start_x
, row
, area
,
25021 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
25022 DRAW_NORMAL_TEXT
, 0);
25027 /* Redraw the parts of the glyph row ROW on window W intersecting
25028 rectangle R. R is in window-relative coordinates. Value is
25029 non-zero if mouse-face was overwritten. */
25032 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
25034 xassert (row
->enabled_p
);
25036 if (row
->mode_line_p
|| w
->pseudo_window_p
)
25037 draw_glyphs (w
, 0, row
, TEXT_AREA
,
25038 0, row
->used
[TEXT_AREA
],
25039 DRAW_NORMAL_TEXT
, 0);
25042 if (row
->used
[LEFT_MARGIN_AREA
])
25043 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
25044 if (row
->used
[TEXT_AREA
])
25045 expose_area (w
, row
, r
, TEXT_AREA
);
25046 if (row
->used
[RIGHT_MARGIN_AREA
])
25047 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
25048 draw_row_fringe_bitmaps (w
, row
);
25051 return row
->mouse_face_p
;
25055 /* Redraw those parts of glyphs rows during expose event handling that
25056 overlap other rows. Redrawing of an exposed line writes over parts
25057 of lines overlapping that exposed line; this function fixes that.
25059 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
25060 row in W's current matrix that is exposed and overlaps other rows.
25061 LAST_OVERLAPPING_ROW is the last such row. */
25064 expose_overlaps (struct window
*w
,
25065 struct glyph_row
*first_overlapping_row
,
25066 struct glyph_row
*last_overlapping_row
,
25069 struct glyph_row
*row
;
25071 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
25072 if (row
->overlapping_p
)
25074 xassert (row
->enabled_p
&& !row
->mode_line_p
);
25077 if (row
->used
[LEFT_MARGIN_AREA
])
25078 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
25080 if (row
->used
[TEXT_AREA
])
25081 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
25083 if (row
->used
[RIGHT_MARGIN_AREA
])
25084 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
25090 /* Return non-zero if W's cursor intersects rectangle R. */
25093 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
25095 XRectangle cr
, result
;
25096 struct glyph
*cursor_glyph
;
25097 struct glyph_row
*row
;
25099 if (w
->phys_cursor
.vpos
>= 0
25100 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
25101 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
25103 && row
->cursor_in_fringe_p
)
25105 /* Cursor is in the fringe. */
25106 cr
.x
= window_box_right_offset (w
,
25107 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
25108 ? RIGHT_MARGIN_AREA
25111 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
25112 cr
.height
= row
->height
;
25113 return x_intersect_rectangles (&cr
, r
, &result
);
25116 cursor_glyph
= get_phys_cursor_glyph (w
);
25119 /* r is relative to W's box, but w->phys_cursor.x is relative
25120 to left edge of W's TEXT area. Adjust it. */
25121 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
25122 cr
.y
= w
->phys_cursor
.y
;
25123 cr
.width
= cursor_glyph
->pixel_width
;
25124 cr
.height
= w
->phys_cursor_height
;
25125 /* ++KFS: W32 version used W32-specific IntersectRect here, but
25126 I assume the effect is the same -- and this is portable. */
25127 return x_intersect_rectangles (&cr
, r
, &result
);
25129 /* If we don't understand the format, pretend we're not in the hot-spot. */
25135 Draw a vertical window border to the right of window W if W doesn't
25136 have vertical scroll bars. */
25139 x_draw_vertical_border (struct window
*w
)
25141 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25143 /* We could do better, if we knew what type of scroll-bar the adjacent
25144 windows (on either side) have... But we don't :-(
25145 However, I think this works ok. ++KFS 2003-04-25 */
25147 /* Redraw borders between horizontally adjacent windows. Don't
25148 do it for frames with vertical scroll bars because either the
25149 right scroll bar of a window, or the left scroll bar of its
25150 neighbor will suffice as a border. */
25151 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
25154 if (!WINDOW_RIGHTMOST_P (w
)
25155 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
25157 int x0
, x1
, y0
, y1
;
25159 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
25162 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
25165 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
25167 else if (!WINDOW_LEFTMOST_P (w
)
25168 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
25170 int x0
, x1
, y0
, y1
;
25172 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
25175 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
25178 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
25183 /* Redraw the part of window W intersection rectangle FR. Pixel
25184 coordinates in FR are frame-relative. Call this function with
25185 input blocked. Value is non-zero if the exposure overwrites
25189 expose_window (struct window
*w
, XRectangle
*fr
)
25191 struct frame
*f
= XFRAME (w
->frame
);
25193 int mouse_face_overwritten_p
= 0;
25195 /* If window is not yet fully initialized, do nothing. This can
25196 happen when toolkit scroll bars are used and a window is split.
25197 Reconfiguring the scroll bar will generate an expose for a newly
25199 if (w
->current_matrix
== NULL
)
25202 /* When we're currently updating the window, display and current
25203 matrix usually don't agree. Arrange for a thorough display
25205 if (w
== updated_window
)
25207 SET_FRAME_GARBAGED (f
);
25211 /* Frame-relative pixel rectangle of W. */
25212 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
25213 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
25214 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
25215 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
25217 if (x_intersect_rectangles (fr
, &wr
, &r
))
25219 int yb
= window_text_bottom_y (w
);
25220 struct glyph_row
*row
;
25221 int cursor_cleared_p
;
25222 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
25224 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
25225 r
.x
, r
.y
, r
.width
, r
.height
));
25227 /* Convert to window coordinates. */
25228 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
25229 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
25231 /* Turn off the cursor. */
25232 if (!w
->pseudo_window_p
25233 && phys_cursor_in_rect_p (w
, &r
))
25235 x_clear_cursor (w
);
25236 cursor_cleared_p
= 1;
25239 cursor_cleared_p
= 0;
25241 /* Update lines intersecting rectangle R. */
25242 first_overlapping_row
= last_overlapping_row
= NULL
;
25243 for (row
= w
->current_matrix
->rows
;
25248 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
25250 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
25251 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
25252 || (r
.y
>= y0
&& r
.y
< y1
)
25253 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
25255 /* A header line may be overlapping, but there is no need
25256 to fix overlapping areas for them. KFS 2005-02-12 */
25257 if (row
->overlapping_p
&& !row
->mode_line_p
)
25259 if (first_overlapping_row
== NULL
)
25260 first_overlapping_row
= row
;
25261 last_overlapping_row
= row
;
25265 if (expose_line (w
, row
, &r
))
25266 mouse_face_overwritten_p
= 1;
25269 else if (row
->overlapping_p
)
25271 /* We must redraw a row overlapping the exposed area. */
25273 ? y0
+ row
->phys_height
> r
.y
25274 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
25276 if (first_overlapping_row
== NULL
)
25277 first_overlapping_row
= row
;
25278 last_overlapping_row
= row
;
25286 /* Display the mode line if there is one. */
25287 if (WINDOW_WANTS_MODELINE_P (w
)
25288 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
25290 && row
->y
< r
.y
+ r
.height
)
25292 if (expose_line (w
, row
, &r
))
25293 mouse_face_overwritten_p
= 1;
25296 if (!w
->pseudo_window_p
)
25298 /* Fix the display of overlapping rows. */
25299 if (first_overlapping_row
)
25300 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
25303 /* Draw border between windows. */
25304 x_draw_vertical_border (w
);
25306 /* Turn the cursor on again. */
25307 if (cursor_cleared_p
)
25308 update_window_cursor (w
, 1);
25312 return mouse_face_overwritten_p
;
25317 /* Redraw (parts) of all windows in the window tree rooted at W that
25318 intersect R. R contains frame pixel coordinates. Value is
25319 non-zero if the exposure overwrites mouse-face. */
25322 expose_window_tree (struct window
*w
, XRectangle
*r
)
25324 struct frame
*f
= XFRAME (w
->frame
);
25325 int mouse_face_overwritten_p
= 0;
25327 while (w
&& !FRAME_GARBAGED_P (f
))
25329 if (!NILP (w
->hchild
))
25330 mouse_face_overwritten_p
25331 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
25332 else if (!NILP (w
->vchild
))
25333 mouse_face_overwritten_p
25334 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
25336 mouse_face_overwritten_p
|= expose_window (w
, r
);
25338 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
25341 return mouse_face_overwritten_p
;
25346 Redisplay an exposed area of frame F. X and Y are the upper-left
25347 corner of the exposed rectangle. W and H are width and height of
25348 the exposed area. All are pixel values. W or H zero means redraw
25349 the entire frame. */
25352 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
25355 int mouse_face_overwritten_p
= 0;
25357 TRACE ((stderr
, "expose_frame "));
25359 /* No need to redraw if frame will be redrawn soon. */
25360 if (FRAME_GARBAGED_P (f
))
25362 TRACE ((stderr
, " garbaged\n"));
25366 /* If basic faces haven't been realized yet, there is no point in
25367 trying to redraw anything. This can happen when we get an expose
25368 event while Emacs is starting, e.g. by moving another window. */
25369 if (FRAME_FACE_CACHE (f
) == NULL
25370 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
25372 TRACE ((stderr
, " no faces\n"));
25376 if (w
== 0 || h
== 0)
25379 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
25380 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
25390 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
25391 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
25393 if (WINDOWP (f
->tool_bar_window
))
25394 mouse_face_overwritten_p
25395 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
25397 #ifdef HAVE_X_WINDOWS
25399 #ifndef USE_X_TOOLKIT
25400 if (WINDOWP (f
->menu_bar_window
))
25401 mouse_face_overwritten_p
25402 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
25403 #endif /* not USE_X_TOOLKIT */
25407 /* Some window managers support a focus-follows-mouse style with
25408 delayed raising of frames. Imagine a partially obscured frame,
25409 and moving the mouse into partially obscured mouse-face on that
25410 frame. The visible part of the mouse-face will be highlighted,
25411 then the WM raises the obscured frame. With at least one WM, KDE
25412 2.1, Emacs is not getting any event for the raising of the frame
25413 (even tried with SubstructureRedirectMask), only Expose events.
25414 These expose events will draw text normally, i.e. not
25415 highlighted. Which means we must redo the highlight here.
25416 Subsume it under ``we love X''. --gerd 2001-08-15 */
25417 /* Included in Windows version because Windows most likely does not
25418 do the right thing if any third party tool offers
25419 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
25420 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
25422 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
25423 if (f
== dpyinfo
->mouse_face_mouse_frame
)
25425 int x
= dpyinfo
->mouse_face_mouse_x
;
25426 int y
= dpyinfo
->mouse_face_mouse_y
;
25427 clear_mouse_face (dpyinfo
);
25428 note_mouse_highlight (f
, x
, y
);
25435 Determine the intersection of two rectangles R1 and R2. Return
25436 the intersection in *RESULT. Value is non-zero if RESULT is not
25440 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
25442 XRectangle
*left
, *right
;
25443 XRectangle
*upper
, *lower
;
25444 int intersection_p
= 0;
25446 /* Rearrange so that R1 is the left-most rectangle. */
25448 left
= r1
, right
= r2
;
25450 left
= r2
, right
= r1
;
25452 /* X0 of the intersection is right.x0, if this is inside R1,
25453 otherwise there is no intersection. */
25454 if (right
->x
<= left
->x
+ left
->width
)
25456 result
->x
= right
->x
;
25458 /* The right end of the intersection is the minimum of the
25459 the right ends of left and right. */
25460 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
25463 /* Same game for Y. */
25465 upper
= r1
, lower
= r2
;
25467 upper
= r2
, lower
= r1
;
25469 /* The upper end of the intersection is lower.y0, if this is inside
25470 of upper. Otherwise, there is no intersection. */
25471 if (lower
->y
<= upper
->y
+ upper
->height
)
25473 result
->y
= lower
->y
;
25475 /* The lower end of the intersection is the minimum of the lower
25476 ends of upper and lower. */
25477 result
->height
= (min (lower
->y
+ lower
->height
,
25478 upper
->y
+ upper
->height
)
25480 intersection_p
= 1;
25484 return intersection_p
;
25487 #endif /* HAVE_WINDOW_SYSTEM */
25490 /***********************************************************************
25492 ***********************************************************************/
25495 syms_of_xdisp (void)
25497 Vwith_echo_area_save_vector
= Qnil
;
25498 staticpro (&Vwith_echo_area_save_vector
);
25500 Vmessage_stack
= Qnil
;
25501 staticpro (&Vmessage_stack
);
25503 Qinhibit_redisplay
= intern_c_string ("inhibit-redisplay");
25504 staticpro (&Qinhibit_redisplay
);
25506 message_dolog_marker1
= Fmake_marker ();
25507 staticpro (&message_dolog_marker1
);
25508 message_dolog_marker2
= Fmake_marker ();
25509 staticpro (&message_dolog_marker2
);
25510 message_dolog_marker3
= Fmake_marker ();
25511 staticpro (&message_dolog_marker3
);
25514 defsubr (&Sdump_frame_glyph_matrix
);
25515 defsubr (&Sdump_glyph_matrix
);
25516 defsubr (&Sdump_glyph_row
);
25517 defsubr (&Sdump_tool_bar_row
);
25518 defsubr (&Strace_redisplay
);
25519 defsubr (&Strace_to_stderr
);
25521 #ifdef HAVE_WINDOW_SYSTEM
25522 defsubr (&Stool_bar_lines_needed
);
25523 defsubr (&Slookup_image_map
);
25525 defsubr (&Sformat_mode_line
);
25526 defsubr (&Sinvisible_p
);
25527 defsubr (&Scurrent_bidi_paragraph_direction
);
25529 staticpro (&Qmenu_bar_update_hook
);
25530 Qmenu_bar_update_hook
= intern_c_string ("menu-bar-update-hook");
25532 staticpro (&Qoverriding_terminal_local_map
);
25533 Qoverriding_terminal_local_map
= intern_c_string ("overriding-terminal-local-map");
25535 staticpro (&Qoverriding_local_map
);
25536 Qoverriding_local_map
= intern_c_string ("overriding-local-map");
25538 staticpro (&Qwindow_scroll_functions
);
25539 Qwindow_scroll_functions
= intern_c_string ("window-scroll-functions");
25541 staticpro (&Qwindow_text_change_functions
);
25542 Qwindow_text_change_functions
= intern_c_string ("window-text-change-functions");
25544 staticpro (&Qredisplay_end_trigger_functions
);
25545 Qredisplay_end_trigger_functions
= intern_c_string ("redisplay-end-trigger-functions");
25547 staticpro (&Qinhibit_point_motion_hooks
);
25548 Qinhibit_point_motion_hooks
= intern_c_string ("inhibit-point-motion-hooks");
25550 Qeval
= intern_c_string ("eval");
25551 staticpro (&Qeval
);
25553 QCdata
= intern_c_string (":data");
25554 staticpro (&QCdata
);
25555 Qdisplay
= intern_c_string ("display");
25556 staticpro (&Qdisplay
);
25557 Qspace_width
= intern_c_string ("space-width");
25558 staticpro (&Qspace_width
);
25559 Qraise
= intern_c_string ("raise");
25560 staticpro (&Qraise
);
25561 Qslice
= intern_c_string ("slice");
25562 staticpro (&Qslice
);
25563 Qspace
= intern_c_string ("space");
25564 staticpro (&Qspace
);
25565 Qmargin
= intern_c_string ("margin");
25566 staticpro (&Qmargin
);
25567 Qpointer
= intern_c_string ("pointer");
25568 staticpro (&Qpointer
);
25569 Qleft_margin
= intern_c_string ("left-margin");
25570 staticpro (&Qleft_margin
);
25571 Qright_margin
= intern_c_string ("right-margin");
25572 staticpro (&Qright_margin
);
25573 Qcenter
= intern_c_string ("center");
25574 staticpro (&Qcenter
);
25575 Qline_height
= intern_c_string ("line-height");
25576 staticpro (&Qline_height
);
25577 QCalign_to
= intern_c_string (":align-to");
25578 staticpro (&QCalign_to
);
25579 QCrelative_width
= intern_c_string (":relative-width");
25580 staticpro (&QCrelative_width
);
25581 QCrelative_height
= intern_c_string (":relative-height");
25582 staticpro (&QCrelative_height
);
25583 QCeval
= intern_c_string (":eval");
25584 staticpro (&QCeval
);
25585 QCpropertize
= intern_c_string (":propertize");
25586 staticpro (&QCpropertize
);
25587 QCfile
= intern_c_string (":file");
25588 staticpro (&QCfile
);
25589 Qfontified
= intern_c_string ("fontified");
25590 staticpro (&Qfontified
);
25591 Qfontification_functions
= intern_c_string ("fontification-functions");
25592 staticpro (&Qfontification_functions
);
25593 Qtrailing_whitespace
= intern_c_string ("trailing-whitespace");
25594 staticpro (&Qtrailing_whitespace
);
25595 Qescape_glyph
= intern_c_string ("escape-glyph");
25596 staticpro (&Qescape_glyph
);
25597 Qnobreak_space
= intern_c_string ("nobreak-space");
25598 staticpro (&Qnobreak_space
);
25599 Qimage
= intern_c_string ("image");
25600 staticpro (&Qimage
);
25601 Qtext
= intern_c_string ("text");
25602 staticpro (&Qtext
);
25603 Qboth
= intern_c_string ("both");
25604 staticpro (&Qboth
);
25605 Qboth_horiz
= intern_c_string ("both-horiz");
25606 staticpro (&Qboth_horiz
);
25607 Qtext_image_horiz
= intern_c_string ("text-image-horiz");
25608 staticpro (&Qtext_image_horiz
);
25609 QCmap
= intern_c_string (":map");
25610 staticpro (&QCmap
);
25611 QCpointer
= intern_c_string (":pointer");
25612 staticpro (&QCpointer
);
25613 Qrect
= intern_c_string ("rect");
25614 staticpro (&Qrect
);
25615 Qcircle
= intern_c_string ("circle");
25616 staticpro (&Qcircle
);
25617 Qpoly
= intern_c_string ("poly");
25618 staticpro (&Qpoly
);
25619 Qmessage_truncate_lines
= intern_c_string ("message-truncate-lines");
25620 staticpro (&Qmessage_truncate_lines
);
25621 Qgrow_only
= intern_c_string ("grow-only");
25622 staticpro (&Qgrow_only
);
25623 Qinhibit_menubar_update
= intern_c_string ("inhibit-menubar-update");
25624 staticpro (&Qinhibit_menubar_update
);
25625 Qinhibit_eval_during_redisplay
= intern_c_string ("inhibit-eval-during-redisplay");
25626 staticpro (&Qinhibit_eval_during_redisplay
);
25627 Qposition
= intern_c_string ("position");
25628 staticpro (&Qposition
);
25629 Qbuffer_position
= intern_c_string ("buffer-position");
25630 staticpro (&Qbuffer_position
);
25631 Qobject
= intern_c_string ("object");
25632 staticpro (&Qobject
);
25633 Qbar
= intern_c_string ("bar");
25635 Qhbar
= intern_c_string ("hbar");
25636 staticpro (&Qhbar
);
25637 Qbox
= intern_c_string ("box");
25639 Qhollow
= intern_c_string ("hollow");
25640 staticpro (&Qhollow
);
25641 Qhand
= intern_c_string ("hand");
25642 staticpro (&Qhand
);
25643 Qarrow
= intern_c_string ("arrow");
25644 staticpro (&Qarrow
);
25645 Qtext
= intern_c_string ("text");
25646 staticpro (&Qtext
);
25647 Qrisky_local_variable
= intern_c_string ("risky-local-variable");
25648 staticpro (&Qrisky_local_variable
);
25649 Qinhibit_free_realized_faces
= intern_c_string ("inhibit-free-realized-faces");
25650 staticpro (&Qinhibit_free_realized_faces
);
25652 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
25653 Fcons (intern_c_string ("void-variable"), Qnil
)),
25655 staticpro (&list_of_error
);
25657 Qlast_arrow_position
= intern_c_string ("last-arrow-position");
25658 staticpro (&Qlast_arrow_position
);
25659 Qlast_arrow_string
= intern_c_string ("last-arrow-string");
25660 staticpro (&Qlast_arrow_string
);
25662 Qoverlay_arrow_string
= intern_c_string ("overlay-arrow-string");
25663 staticpro (&Qoverlay_arrow_string
);
25664 Qoverlay_arrow_bitmap
= intern_c_string ("overlay-arrow-bitmap");
25665 staticpro (&Qoverlay_arrow_bitmap
);
25667 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
25668 staticpro (&echo_buffer
[0]);
25669 staticpro (&echo_buffer
[1]);
25671 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
25672 staticpro (&echo_area_buffer
[0]);
25673 staticpro (&echo_area_buffer
[1]);
25675 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
25676 staticpro (&Vmessages_buffer_name
);
25678 mode_line_proptrans_alist
= Qnil
;
25679 staticpro (&mode_line_proptrans_alist
);
25680 mode_line_string_list
= Qnil
;
25681 staticpro (&mode_line_string_list
);
25682 mode_line_string_face
= Qnil
;
25683 staticpro (&mode_line_string_face
);
25684 mode_line_string_face_prop
= Qnil
;
25685 staticpro (&mode_line_string_face_prop
);
25686 Vmode_line_unwind_vector
= Qnil
;
25687 staticpro (&Vmode_line_unwind_vector
);
25689 help_echo_string
= Qnil
;
25690 staticpro (&help_echo_string
);
25691 help_echo_object
= Qnil
;
25692 staticpro (&help_echo_object
);
25693 help_echo_window
= Qnil
;
25694 staticpro (&help_echo_window
);
25695 previous_help_echo_string
= Qnil
;
25696 staticpro (&previous_help_echo_string
);
25697 help_echo_pos
= -1;
25699 Qright_to_left
= intern_c_string ("right-to-left");
25700 staticpro (&Qright_to_left
);
25701 Qleft_to_right
= intern_c_string ("left-to-right");
25702 staticpro (&Qleft_to_right
);
25704 #ifdef HAVE_WINDOW_SYSTEM
25705 DEFVAR_BOOL ("x-stretch-cursor", &x_stretch_cursor_p
,
25706 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
25707 For example, if a block cursor is over a tab, it will be drawn as
25708 wide as that tab on the display. */);
25709 x_stretch_cursor_p
= 0;
25712 DEFVAR_LISP ("show-trailing-whitespace", &Vshow_trailing_whitespace
,
25713 doc
: /* *Non-nil means highlight trailing whitespace.
25714 The face used for trailing whitespace is `trailing-whitespace'. */);
25715 Vshow_trailing_whitespace
= Qnil
;
25717 DEFVAR_LISP ("nobreak-char-display", &Vnobreak_char_display
,
25718 doc
: /* *Control highlighting of nobreak space and soft hyphen.
25719 A value of t means highlight the character itself (for nobreak space,
25720 use face `nobreak-space').
25721 A value of nil means no highlighting.
25722 Other values mean display the escape glyph followed by an ordinary
25723 space or ordinary hyphen. */);
25724 Vnobreak_char_display
= Qt
;
25726 DEFVAR_LISP ("void-text-area-pointer", &Vvoid_text_area_pointer
,
25727 doc
: /* *The pointer shape to show in void text areas.
25728 A value of nil means to show the text pointer. Other options are `arrow',
25729 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
25730 Vvoid_text_area_pointer
= Qarrow
;
25732 DEFVAR_LISP ("inhibit-redisplay", &Vinhibit_redisplay
,
25733 doc
: /* Non-nil means don't actually do any redisplay.
25734 This is used for internal purposes. */);
25735 Vinhibit_redisplay
= Qnil
;
25737 DEFVAR_LISP ("global-mode-string", &Vglobal_mode_string
,
25738 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
25739 Vglobal_mode_string
= Qnil
;
25741 DEFVAR_LISP ("overlay-arrow-position", &Voverlay_arrow_position
,
25742 doc
: /* Marker for where to display an arrow on top of the buffer text.
25743 This must be the beginning of a line in order to work.
25744 See also `overlay-arrow-string'. */);
25745 Voverlay_arrow_position
= Qnil
;
25747 DEFVAR_LISP ("overlay-arrow-string", &Voverlay_arrow_string
,
25748 doc
: /* String to display as an arrow in non-window frames.
25749 See also `overlay-arrow-position'. */);
25750 Voverlay_arrow_string
= make_pure_c_string ("=>");
25752 DEFVAR_LISP ("overlay-arrow-variable-list", &Voverlay_arrow_variable_list
,
25753 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
25754 The symbols on this list are examined during redisplay to determine
25755 where to display overlay arrows. */);
25756 Voverlay_arrow_variable_list
25757 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
25759 DEFVAR_INT ("scroll-step", &scroll_step
,
25760 doc
: /* *The number of lines to try scrolling a window by when point moves out.
25761 If that fails to bring point back on frame, point is centered instead.
25762 If this is zero, point is always centered after it moves off frame.
25763 If you want scrolling to always be a line at a time, you should set
25764 `scroll-conservatively' to a large value rather than set this to 1. */);
25766 DEFVAR_INT ("scroll-conservatively", &scroll_conservatively
,
25767 doc
: /* *Scroll up to this many lines, to bring point back on screen.
25768 If point moves off-screen, redisplay will scroll by up to
25769 `scroll-conservatively' lines in order to bring point just barely
25770 onto the screen again. If that cannot be done, then redisplay
25771 recenters point as usual.
25773 A value of zero means always recenter point if it moves off screen. */);
25774 scroll_conservatively
= 0;
25776 DEFVAR_INT ("scroll-margin", &scroll_margin
,
25777 doc
: /* *Number of lines of margin at the top and bottom of a window.
25778 Recenter the window whenever point gets within this many lines
25779 of the top or bottom of the window. */);
25782 DEFVAR_LISP ("display-pixels-per-inch", &Vdisplay_pixels_per_inch
,
25783 doc
: /* Pixels per inch value for non-window system displays.
25784 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
25785 Vdisplay_pixels_per_inch
= make_float (72.0);
25788 DEFVAR_INT ("debug-end-pos", &debug_end_pos
, doc
: /* Don't ask. */);
25791 DEFVAR_LISP ("truncate-partial-width-windows",
25792 &Vtruncate_partial_width_windows
,
25793 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
25794 For an integer value, truncate lines in each window narrower than the
25795 full frame width, provided the window width is less than that integer;
25796 otherwise, respect the value of `truncate-lines'.
25798 For any other non-nil value, truncate lines in all windows that do
25799 not span the full frame width.
25801 A value of nil means to respect the value of `truncate-lines'.
25803 If `word-wrap' is enabled, you might want to reduce this. */);
25804 Vtruncate_partial_width_windows
= make_number (50);
25806 DEFVAR_BOOL ("mode-line-inverse-video", &mode_line_inverse_video
,
25807 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
25808 Any other value means to use the appropriate face, `mode-line',
25809 `header-line', or `menu' respectively. */);
25810 mode_line_inverse_video
= 1;
25812 DEFVAR_LISP ("line-number-display-limit", &Vline_number_display_limit
,
25813 doc
: /* *Maximum buffer size for which line number should be displayed.
25814 If the buffer is bigger than this, the line number does not appear
25815 in the mode line. A value of nil means no limit. */);
25816 Vline_number_display_limit
= Qnil
;
25818 DEFVAR_INT ("line-number-display-limit-width",
25819 &line_number_display_limit_width
,
25820 doc
: /* *Maximum line width (in characters) for line number display.
25821 If the average length of the lines near point is bigger than this, then the
25822 line number may be omitted from the mode line. */);
25823 line_number_display_limit_width
= 200;
25825 DEFVAR_BOOL ("highlight-nonselected-windows", &highlight_nonselected_windows
,
25826 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
25827 highlight_nonselected_windows
= 0;
25829 DEFVAR_BOOL ("multiple-frames", &multiple_frames
,
25830 doc
: /* Non-nil if more than one frame is visible on this display.
25831 Minibuffer-only frames don't count, but iconified frames do.
25832 This variable is not guaranteed to be accurate except while processing
25833 `frame-title-format' and `icon-title-format'. */);
25835 DEFVAR_LISP ("frame-title-format", &Vframe_title_format
,
25836 doc
: /* Template for displaying the title bar of visible frames.
25837 \(Assuming the window manager supports this feature.)
25839 This variable has the same structure as `mode-line-format', except that
25840 the %c and %l constructs are ignored. It is used only on frames for
25841 which no explicit name has been set \(see `modify-frame-parameters'). */);
25843 DEFVAR_LISP ("icon-title-format", &Vicon_title_format
,
25844 doc
: /* Template for displaying the title bar of an iconified frame.
25845 \(Assuming the window manager supports this feature.)
25846 This variable has the same structure as `mode-line-format' (which see),
25847 and is used only on frames for which no explicit name has been set
25848 \(see `modify-frame-parameters'). */);
25850 = Vframe_title_format
25851 = pure_cons (intern_c_string ("multiple-frames"),
25852 pure_cons (make_pure_c_string ("%b"),
25853 pure_cons (pure_cons (empty_unibyte_string
,
25854 pure_cons (intern_c_string ("invocation-name"),
25855 pure_cons (make_pure_c_string ("@"),
25856 pure_cons (intern_c_string ("system-name"),
25860 DEFVAR_LISP ("message-log-max", &Vmessage_log_max
,
25861 doc
: /* Maximum number of lines to keep in the message log buffer.
25862 If nil, disable message logging. If t, log messages but don't truncate
25863 the buffer when it becomes large. */);
25864 Vmessage_log_max
= make_number (100);
25866 DEFVAR_LISP ("window-size-change-functions", &Vwindow_size_change_functions
,
25867 doc
: /* Functions called before redisplay, if window sizes have changed.
25868 The value should be a list of functions that take one argument.
25869 Just before redisplay, for each frame, if any of its windows have changed
25870 size since the last redisplay, or have been split or deleted,
25871 all the functions in the list are called, with the frame as argument. */);
25872 Vwindow_size_change_functions
= Qnil
;
25874 DEFVAR_LISP ("window-scroll-functions", &Vwindow_scroll_functions
,
25875 doc
: /* List of functions to call before redisplaying a window with scrolling.
25876 Each function is called with two arguments, the window and its new
25877 display-start position. Note that these functions are also called by
25878 `set-window-buffer'. Also note that the value of `window-end' is not
25879 valid when these functions are called. */);
25880 Vwindow_scroll_functions
= Qnil
;
25882 DEFVAR_LISP ("window-text-change-functions",
25883 &Vwindow_text_change_functions
,
25884 doc
: /* Functions to call in redisplay when text in the window might change. */);
25885 Vwindow_text_change_functions
= Qnil
;
25887 DEFVAR_LISP ("redisplay-end-trigger-functions", &Vredisplay_end_trigger_functions
,
25888 doc
: /* Functions called when redisplay of a window reaches the end trigger.
25889 Each function is called with two arguments, the window and the end trigger value.
25890 See `set-window-redisplay-end-trigger'. */);
25891 Vredisplay_end_trigger_functions
= Qnil
;
25893 DEFVAR_LISP ("mouse-autoselect-window", &Vmouse_autoselect_window
,
25894 doc
: /* *Non-nil means autoselect window with mouse pointer.
25895 If nil, do not autoselect windows.
25896 A positive number means delay autoselection by that many seconds: a
25897 window is autoselected only after the mouse has remained in that
25898 window for the duration of the delay.
25899 A negative number has a similar effect, but causes windows to be
25900 autoselected only after the mouse has stopped moving. \(Because of
25901 the way Emacs compares mouse events, you will occasionally wait twice
25902 that time before the window gets selected.\)
25903 Any other value means to autoselect window instantaneously when the
25904 mouse pointer enters it.
25906 Autoselection selects the minibuffer only if it is active, and never
25907 unselects the minibuffer if it is active.
25909 When customizing this variable make sure that the actual value of
25910 `focus-follows-mouse' matches the behavior of your window manager. */);
25911 Vmouse_autoselect_window
= Qnil
;
25913 DEFVAR_LISP ("auto-resize-tool-bars", &Vauto_resize_tool_bars
,
25914 doc
: /* *Non-nil means automatically resize tool-bars.
25915 This dynamically changes the tool-bar's height to the minimum height
25916 that is needed to make all tool-bar items visible.
25917 If value is `grow-only', the tool-bar's height is only increased
25918 automatically; to decrease the tool-bar height, use \\[recenter]. */);
25919 Vauto_resize_tool_bars
= Qt
;
25921 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", &auto_raise_tool_bar_buttons_p
,
25922 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
25923 auto_raise_tool_bar_buttons_p
= 1;
25925 DEFVAR_BOOL ("make-cursor-line-fully-visible", &make_cursor_line_fully_visible_p
,
25926 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
25927 make_cursor_line_fully_visible_p
= 1;
25929 DEFVAR_LISP ("tool-bar-border", &Vtool_bar_border
,
25930 doc
: /* *Border below tool-bar in pixels.
25931 If an integer, use it as the height of the border.
25932 If it is one of `internal-border-width' or `border-width', use the
25933 value of the corresponding frame parameter.
25934 Otherwise, no border is added below the tool-bar. */);
25935 Vtool_bar_border
= Qinternal_border_width
;
25937 DEFVAR_LISP ("tool-bar-button-margin", &Vtool_bar_button_margin
,
25938 doc
: /* *Margin around tool-bar buttons in pixels.
25939 If an integer, use that for both horizontal and vertical margins.
25940 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
25941 HORZ specifying the horizontal margin, and VERT specifying the
25942 vertical margin. */);
25943 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
25945 DEFVAR_INT ("tool-bar-button-relief", &tool_bar_button_relief
,
25946 doc
: /* *Relief thickness of tool-bar buttons. */);
25947 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
25949 DEFVAR_LISP ("tool-bar-style", &Vtool_bar_style
,
25950 doc
: /* *Tool bar style to use.
25952 image - show images only
25953 text - show text only
25954 both - show both, text below image
25955 both-horiz - show text to the right of the image
25956 text-image-horiz - show text to the left of the image
25957 any other - use system default or image if no system default. */);
25958 Vtool_bar_style
= Qnil
;
25960 DEFVAR_INT ("tool-bar-max-label-size", &tool_bar_max_label_size
,
25961 doc
: /* *Maximum number of characters a label can have to be shown.
25962 The tool bar style must also show labels for this to have any effect, see
25963 `tool-bar-style'. */);
25964 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
25966 DEFVAR_LISP ("fontification-functions", &Vfontification_functions
,
25967 doc
: /* List of functions to call to fontify regions of text.
25968 Each function is called with one argument POS. Functions must
25969 fontify a region starting at POS in the current buffer, and give
25970 fontified regions the property `fontified'. */);
25971 Vfontification_functions
= Qnil
;
25972 Fmake_variable_buffer_local (Qfontification_functions
);
25974 DEFVAR_BOOL ("unibyte-display-via-language-environment",
25975 &unibyte_display_via_language_environment
,
25976 doc
: /* *Non-nil means display unibyte text according to language environment.
25977 Specifically, this means that raw bytes in the range 160-255 decimal
25978 are displayed by converting them to the equivalent multibyte characters
25979 according to the current language environment. As a result, they are
25980 displayed according to the current fontset.
25982 Note that this variable affects only how these bytes are displayed,
25983 but does not change the fact they are interpreted as raw bytes. */);
25984 unibyte_display_via_language_environment
= 0;
25986 DEFVAR_LISP ("max-mini-window-height", &Vmax_mini_window_height
,
25987 doc
: /* *Maximum height for resizing mini-windows.
25988 If a float, it specifies a fraction of the mini-window frame's height.
25989 If an integer, it specifies a number of lines. */);
25990 Vmax_mini_window_height
= make_float (0.25);
25992 DEFVAR_LISP ("resize-mini-windows", &Vresize_mini_windows
,
25993 doc
: /* *How to resize mini-windows.
25994 A value of nil means don't automatically resize mini-windows.
25995 A value of t means resize them to fit the text displayed in them.
25996 A value of `grow-only', the default, means let mini-windows grow
25997 only, until their display becomes empty, at which point the windows
25998 go back to their normal size. */);
25999 Vresize_mini_windows
= Qgrow_only
;
26001 DEFVAR_LISP ("blink-cursor-alist", &Vblink_cursor_alist
,
26002 doc
: /* Alist specifying how to blink the cursor off.
26003 Each element has the form (ON-STATE . OFF-STATE). Whenever the
26004 `cursor-type' frame-parameter or variable equals ON-STATE,
26005 comparing using `equal', Emacs uses OFF-STATE to specify
26006 how to blink it off. ON-STATE and OFF-STATE are values for
26007 the `cursor-type' frame parameter.
26009 If a frame's ON-STATE has no entry in this list,
26010 the frame's other specifications determine how to blink the cursor off. */);
26011 Vblink_cursor_alist
= Qnil
;
26013 DEFVAR_BOOL ("auto-hscroll-mode", &automatic_hscrolling_p
,
26014 doc
: /* *Non-nil means scroll the display automatically to make point visible. */);
26015 automatic_hscrolling_p
= 1;
26016 Qauto_hscroll_mode
= intern_c_string ("auto-hscroll-mode");
26017 staticpro (&Qauto_hscroll_mode
);
26019 DEFVAR_INT ("hscroll-margin", &hscroll_margin
,
26020 doc
: /* *How many columns away from the window edge point is allowed to get
26021 before automatic hscrolling will horizontally scroll the window. */);
26022 hscroll_margin
= 5;
26024 DEFVAR_LISP ("hscroll-step", &Vhscroll_step
,
26025 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
26026 When point is less than `hscroll-margin' columns from the window
26027 edge, automatic hscrolling will scroll the window by the amount of columns
26028 determined by this variable. If its value is a positive integer, scroll that
26029 many columns. If it's a positive floating-point number, it specifies the
26030 fraction of the window's width to scroll. If it's nil or zero, point will be
26031 centered horizontally after the scroll. Any other value, including negative
26032 numbers, are treated as if the value were zero.
26034 Automatic hscrolling always moves point outside the scroll margin, so if
26035 point was more than scroll step columns inside the margin, the window will
26036 scroll more than the value given by the scroll step.
26038 Note that the lower bound for automatic hscrolling specified by `scroll-left'
26039 and `scroll-right' overrides this variable's effect. */);
26040 Vhscroll_step
= make_number (0);
26042 DEFVAR_BOOL ("message-truncate-lines", &message_truncate_lines
,
26043 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
26044 Bind this around calls to `message' to let it take effect. */);
26045 message_truncate_lines
= 0;
26047 DEFVAR_LISP ("menu-bar-update-hook", &Vmenu_bar_update_hook
,
26048 doc
: /* Normal hook run to update the menu bar definitions.
26049 Redisplay runs this hook before it redisplays the menu bar.
26050 This is used to update submenus such as Buffers,
26051 whose contents depend on various data. */);
26052 Vmenu_bar_update_hook
= Qnil
;
26054 DEFVAR_LISP ("menu-updating-frame", &Vmenu_updating_frame
,
26055 doc
: /* Frame for which we are updating a menu.
26056 The enable predicate for a menu binding should check this variable. */);
26057 Vmenu_updating_frame
= Qnil
;
26059 DEFVAR_BOOL ("inhibit-menubar-update", &inhibit_menubar_update
,
26060 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
26061 inhibit_menubar_update
= 0;
26063 DEFVAR_LISP ("wrap-prefix", &Vwrap_prefix
,
26064 doc
: /* Prefix prepended to all continuation lines at display time.
26065 The value may be a string, an image, or a stretch-glyph; it is
26066 interpreted in the same way as the value of a `display' text property.
26068 This variable is overridden by any `wrap-prefix' text or overlay
26071 To add a prefix to non-continuation lines, use `line-prefix'. */);
26072 Vwrap_prefix
= Qnil
;
26073 staticpro (&Qwrap_prefix
);
26074 Qwrap_prefix
= intern_c_string ("wrap-prefix");
26075 Fmake_variable_buffer_local (Qwrap_prefix
);
26077 DEFVAR_LISP ("line-prefix", &Vline_prefix
,
26078 doc
: /* Prefix prepended to all non-continuation lines at display time.
26079 The value may be a string, an image, or a stretch-glyph; it is
26080 interpreted in the same way as the value of a `display' text property.
26082 This variable is overridden by any `line-prefix' text or overlay
26085 To add a prefix to continuation lines, use `wrap-prefix'. */);
26086 Vline_prefix
= Qnil
;
26087 staticpro (&Qline_prefix
);
26088 Qline_prefix
= intern_c_string ("line-prefix");
26089 Fmake_variable_buffer_local (Qline_prefix
);
26091 DEFVAR_BOOL ("inhibit-eval-during-redisplay", &inhibit_eval_during_redisplay
,
26092 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
26093 inhibit_eval_during_redisplay
= 0;
26095 DEFVAR_BOOL ("inhibit-free-realized-faces", &inhibit_free_realized_faces
,
26096 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
26097 inhibit_free_realized_faces
= 0;
26100 DEFVAR_BOOL ("inhibit-try-window-id", &inhibit_try_window_id
,
26101 doc
: /* Inhibit try_window_id display optimization. */);
26102 inhibit_try_window_id
= 0;
26104 DEFVAR_BOOL ("inhibit-try-window-reusing", &inhibit_try_window_reusing
,
26105 doc
: /* Inhibit try_window_reusing display optimization. */);
26106 inhibit_try_window_reusing
= 0;
26108 DEFVAR_BOOL ("inhibit-try-cursor-movement", &inhibit_try_cursor_movement
,
26109 doc
: /* Inhibit try_cursor_movement display optimization. */);
26110 inhibit_try_cursor_movement
= 0;
26111 #endif /* GLYPH_DEBUG */
26113 DEFVAR_INT ("overline-margin", &overline_margin
,
26114 doc
: /* *Space between overline and text, in pixels.
26115 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
26116 margin to the caracter height. */);
26117 overline_margin
= 2;
26119 DEFVAR_INT ("underline-minimum-offset",
26120 &underline_minimum_offset
,
26121 doc
: /* Minimum distance between baseline and underline.
26122 This can improve legibility of underlined text at small font sizes,
26123 particularly when using variable `x-use-underline-position-properties'
26124 with fonts that specify an UNDERLINE_POSITION relatively close to the
26125 baseline. The default value is 1. */);
26126 underline_minimum_offset
= 1;
26128 DEFVAR_BOOL ("display-hourglass", &display_hourglass_p
,
26129 doc
: /* Non-zero means Emacs displays an hourglass pointer on window systems. */);
26130 display_hourglass_p
= 1;
26132 DEFVAR_LISP ("hourglass-delay", &Vhourglass_delay
,
26133 doc
: /* *Seconds to wait before displaying an hourglass pointer.
26134 Value must be an integer or float. */);
26135 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
26137 hourglass_atimer
= NULL
;
26138 hourglass_shown_p
= 0;
26142 /* Initialize this module when Emacs starts. */
26147 Lisp_Object root_window
;
26148 struct window
*mini_w
;
26150 current_header_line_height
= current_mode_line_height
= -1;
26152 CHARPOS (this_line_start_pos
) = 0;
26154 mini_w
= XWINDOW (minibuf_window
);
26155 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
26157 if (!noninteractive
)
26159 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
26162 XWINDOW (root_window
)->top_line
= make_number (FRAME_TOP_MARGIN (f
));
26163 set_window_height (root_window
,
26164 FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
),
26166 mini_w
->top_line
= make_number (FRAME_LINES (f
) - 1);
26167 set_window_height (minibuf_window
, 1, 0);
26169 XWINDOW (root_window
)->total_cols
= make_number (FRAME_COLS (f
));
26170 mini_w
->total_cols
= make_number (FRAME_COLS (f
));
26172 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
26173 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
26174 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
26176 /* The default ellipsis glyphs `...'. */
26177 for (i
= 0; i
< 3; ++i
)
26178 default_invis_vector
[i
] = make_number ('.');
26182 /* Allocate the buffer for frame titles.
26183 Also used for `format-mode-line'. */
26185 mode_line_noprop_buf
= (char *) xmalloc (size
);
26186 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
26187 mode_line_noprop_ptr
= mode_line_noprop_buf
;
26188 mode_line_target
= MODE_LINE_DISPLAY
;
26191 help_echo_showing_p
= 0;
26194 /* Since w32 does not support atimers, it defines its own implementation of
26195 the following three functions in w32fns.c. */
26198 /* Platform-independent portion of hourglass implementation. */
26200 /* Return non-zero if houglass timer has been started or hourglass is shown. */
26202 hourglass_started (void)
26204 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
26207 /* Cancel a currently active hourglass timer, and start a new one. */
26209 start_hourglass (void)
26211 #if defined (HAVE_WINDOW_SYSTEM)
26213 int secs
, usecs
= 0;
26215 cancel_hourglass ();
26217 if (INTEGERP (Vhourglass_delay
)
26218 && XINT (Vhourglass_delay
) > 0)
26219 secs
= XFASTINT (Vhourglass_delay
);
26220 else if (FLOATP (Vhourglass_delay
)
26221 && XFLOAT_DATA (Vhourglass_delay
) > 0)
26224 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
26225 secs
= XFASTINT (tem
);
26226 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
26229 secs
= DEFAULT_HOURGLASS_DELAY
;
26231 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
26232 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
26233 show_hourglass
, NULL
);
26238 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
26241 cancel_hourglass (void)
26243 #if defined (HAVE_WINDOW_SYSTEM)
26244 if (hourglass_atimer
)
26246 cancel_atimer (hourglass_atimer
);
26247 hourglass_atimer
= NULL
;
26250 if (hourglass_shown_p
)
26254 #endif /* ! WINDOWSNT */
26256 /* arch-tag: eacc864d-bb6a-4b74-894a-1a4399a1358b
26257 (do not change this comment) */