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
;
10198 extern Lisp_Object QCrelief
, QCmargin
, QCconversion
;
10200 /* If image is a vector, choose the image according to the
10202 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
10203 if (VECTORP (image
))
10207 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
10208 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
10211 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
10212 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
10214 xassert (ASIZE (image
) >= idx
);
10215 image
= AREF (image
, idx
);
10220 /* Ignore invalid image specifications. */
10221 if (!valid_image_p (image
))
10224 /* Display the tool-bar button pressed, or depressed. */
10225 plist
= Fcopy_sequence (XCDR (image
));
10227 /* Compute margin and relief to draw. */
10228 relief
= (tool_bar_button_relief
>= 0
10229 ? tool_bar_button_relief
10230 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
10231 hmargin
= vmargin
= relief
;
10233 if (INTEGERP (Vtool_bar_button_margin
)
10234 && XINT (Vtool_bar_button_margin
) > 0)
10236 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
10237 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
10239 else if (CONSP (Vtool_bar_button_margin
))
10241 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
10242 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
10243 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
10245 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
10246 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
10247 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
10250 if (auto_raise_tool_bar_buttons_p
)
10252 /* Add a `:relief' property to the image spec if the item is
10256 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
10263 /* If image is selected, display it pressed, i.e. with a
10264 negative relief. If it's not selected, display it with a
10266 plist
= Fplist_put (plist
, QCrelief
,
10268 ? make_number (-relief
)
10269 : make_number (relief
)));
10274 /* Put a margin around the image. */
10275 if (hmargin
|| vmargin
)
10277 if (hmargin
== vmargin
)
10278 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
10280 plist
= Fplist_put (plist
, QCmargin
,
10281 Fcons (make_number (hmargin
),
10282 make_number (vmargin
)));
10285 /* If button is not enabled, and we don't have special images
10286 for the disabled state, make the image appear disabled by
10287 applying an appropriate algorithm to it. */
10288 if (!enabled_p
&& idx
< 0)
10289 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
10291 /* Put a `display' text property on the string for the image to
10292 display. Put a `menu-item' property on the string that gives
10293 the start of this item's properties in the tool-bar items
10295 image
= Fcons (Qimage
, plist
);
10296 props
= list4 (Qdisplay
, image
,
10297 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
10299 /* Let the last image hide all remaining spaces in the tool bar
10300 string. The string can be longer than needed when we reuse a
10301 previous string. */
10302 if (i
+ 1 == f
->n_tool_bar_items
)
10303 end
= SCHARS (f
->desired_tool_bar_string
);
10306 Fadd_text_properties (make_number (i
), make_number (end
),
10307 props
, f
->desired_tool_bar_string
);
10315 /* Display one line of the tool-bar of frame IT->f.
10317 HEIGHT specifies the desired height of the tool-bar line.
10318 If the actual height of the glyph row is less than HEIGHT, the
10319 row's height is increased to HEIGHT, and the icons are centered
10320 vertically in the new height.
10322 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
10323 count a final empty row in case the tool-bar width exactly matches
10328 display_tool_bar_line (struct it
*it
, int height
)
10330 struct glyph_row
*row
= it
->glyph_row
;
10331 int max_x
= it
->last_visible_x
;
10332 struct glyph
*last
;
10334 prepare_desired_row (row
);
10335 row
->y
= it
->current_y
;
10337 /* Note that this isn't made use of if the face hasn't a box,
10338 so there's no need to check the face here. */
10339 it
->start_of_box_run_p
= 1;
10341 while (it
->current_x
< max_x
)
10343 int x
, n_glyphs_before
, i
, nglyphs
;
10344 struct it it_before
;
10346 /* Get the next display element. */
10347 if (!get_next_display_element (it
))
10349 /* Don't count empty row if we are counting needed tool-bar lines. */
10350 if (height
< 0 && !it
->hpos
)
10355 /* Produce glyphs. */
10356 n_glyphs_before
= row
->used
[TEXT_AREA
];
10359 PRODUCE_GLYPHS (it
);
10361 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
10363 x
= it_before
.current_x
;
10364 while (i
< nglyphs
)
10366 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
10368 if (x
+ glyph
->pixel_width
> max_x
)
10370 /* Glyph doesn't fit on line. Backtrack. */
10371 row
->used
[TEXT_AREA
] = n_glyphs_before
;
10373 /* If this is the only glyph on this line, it will never fit on the
10374 toolbar, so skip it. But ensure there is at least one glyph,
10375 so we don't accidentally disable the tool-bar. */
10376 if (n_glyphs_before
== 0
10377 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
10383 x
+= glyph
->pixel_width
;
10387 /* Stop at line ends. */
10388 if (ITERATOR_AT_END_OF_LINE_P (it
))
10391 set_iterator_to_next (it
, 1);
10396 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
10398 /* Use default face for the border below the tool bar.
10400 FIXME: When auto-resize-tool-bars is grow-only, there is
10401 no additional border below the possibly empty tool-bar lines.
10402 So to make the extra empty lines look "normal", we have to
10403 use the tool-bar face for the border too. */
10404 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
10405 it
->face_id
= DEFAULT_FACE_ID
;
10407 extend_face_to_end_of_line (it
);
10408 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
10409 last
->right_box_line_p
= 1;
10410 if (last
== row
->glyphs
[TEXT_AREA
])
10411 last
->left_box_line_p
= 1;
10413 /* Make line the desired height and center it vertically. */
10414 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
10416 /* Don't add more than one line height. */
10417 height
%= FRAME_LINE_HEIGHT (it
->f
);
10418 it
->max_ascent
+= height
/ 2;
10419 it
->max_descent
+= (height
+ 1) / 2;
10422 compute_line_metrics (it
);
10424 /* If line is empty, make it occupy the rest of the tool-bar. */
10425 if (!row
->displays_text_p
)
10427 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
10428 row
->visible_height
= row
->height
;
10429 row
->ascent
= row
->phys_ascent
= 0;
10430 row
->extra_line_spacing
= 0;
10433 row
->full_width_p
= 1;
10434 row
->continued_p
= 0;
10435 row
->truncated_on_left_p
= 0;
10436 row
->truncated_on_right_p
= 0;
10438 it
->current_x
= it
->hpos
= 0;
10439 it
->current_y
+= row
->height
;
10445 /* Max tool-bar height. */
10447 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
10448 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
10450 /* Value is the number of screen lines needed to make all tool-bar
10451 items of frame F visible. The number of actual rows needed is
10452 returned in *N_ROWS if non-NULL. */
10455 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
10457 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10459 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
10460 the desired matrix, so use (unused) mode-line row as temporary row to
10461 avoid destroying the first tool-bar row. */
10462 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
10464 /* Initialize an iterator for iteration over
10465 F->desired_tool_bar_string in the tool-bar window of frame F. */
10466 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
10467 it
.first_visible_x
= 0;
10468 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10469 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10471 while (!ITERATOR_AT_END_P (&it
))
10473 clear_glyph_row (temp_row
);
10474 it
.glyph_row
= temp_row
;
10475 display_tool_bar_line (&it
, -1);
10477 clear_glyph_row (temp_row
);
10479 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
10481 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
10483 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
10487 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
10489 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
10490 (Lisp_Object frame
)
10497 frame
= selected_frame
;
10499 CHECK_FRAME (frame
);
10500 f
= XFRAME (frame
);
10502 if (WINDOWP (f
->tool_bar_window
)
10503 || (w
= XWINDOW (f
->tool_bar_window
),
10504 WINDOW_TOTAL_LINES (w
) > 0))
10506 update_tool_bar (f
, 1);
10507 if (f
->n_tool_bar_items
)
10509 build_desired_tool_bar_string (f
);
10510 nlines
= tool_bar_lines_needed (f
, NULL
);
10514 return make_number (nlines
);
10518 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
10519 height should be changed. */
10522 redisplay_tool_bar (struct frame
*f
)
10526 struct glyph_row
*row
;
10528 #if defined (USE_GTK) || defined (HAVE_NS)
10529 if (FRAME_EXTERNAL_TOOL_BAR (f
))
10530 update_frame_tool_bar (f
);
10534 /* If frame hasn't a tool-bar window or if it is zero-height, don't
10535 do anything. This means you must start with tool-bar-lines
10536 non-zero to get the auto-sizing effect. Or in other words, you
10537 can turn off tool-bars by specifying tool-bar-lines zero. */
10538 if (!WINDOWP (f
->tool_bar_window
)
10539 || (w
= XWINDOW (f
->tool_bar_window
),
10540 WINDOW_TOTAL_LINES (w
) == 0))
10543 /* Set up an iterator for the tool-bar window. */
10544 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
10545 it
.first_visible_x
= 0;
10546 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10547 row
= it
.glyph_row
;
10549 /* Build a string that represents the contents of the tool-bar. */
10550 build_desired_tool_bar_string (f
);
10551 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10553 if (f
->n_tool_bar_rows
== 0)
10557 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
10558 nlines
!= WINDOW_TOTAL_LINES (w
)))
10561 int old_height
= WINDOW_TOTAL_LINES (w
);
10563 XSETFRAME (frame
, f
);
10564 Fmodify_frame_parameters (frame
,
10565 Fcons (Fcons (Qtool_bar_lines
,
10566 make_number (nlines
)),
10568 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10570 clear_glyph_matrix (w
->desired_matrix
);
10571 fonts_changed_p
= 1;
10577 /* Display as many lines as needed to display all tool-bar items. */
10579 if (f
->n_tool_bar_rows
> 0)
10581 int border
, rows
, height
, extra
;
10583 if (INTEGERP (Vtool_bar_border
))
10584 border
= XINT (Vtool_bar_border
);
10585 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
10586 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
10587 else if (EQ (Vtool_bar_border
, Qborder_width
))
10588 border
= f
->border_width
;
10594 rows
= f
->n_tool_bar_rows
;
10595 height
= max (1, (it
.last_visible_y
- border
) / rows
);
10596 extra
= it
.last_visible_y
- border
- height
* rows
;
10598 while (it
.current_y
< it
.last_visible_y
)
10601 if (extra
> 0 && rows
-- > 0)
10603 h
= (extra
+ rows
- 1) / rows
;
10606 display_tool_bar_line (&it
, height
+ h
);
10611 while (it
.current_y
< it
.last_visible_y
)
10612 display_tool_bar_line (&it
, 0);
10615 /* It doesn't make much sense to try scrolling in the tool-bar
10616 window, so don't do it. */
10617 w
->desired_matrix
->no_scrolling_p
= 1;
10618 w
->must_be_updated_p
= 1;
10620 if (!NILP (Vauto_resize_tool_bars
))
10622 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
10623 int change_height_p
= 0;
10625 /* If we couldn't display everything, change the tool-bar's
10626 height if there is room for more. */
10627 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
10628 && it
.current_y
< max_tool_bar_height
)
10629 change_height_p
= 1;
10631 row
= it
.glyph_row
- 1;
10633 /* If there are blank lines at the end, except for a partially
10634 visible blank line at the end that is smaller than
10635 FRAME_LINE_HEIGHT, change the tool-bar's height. */
10636 if (!row
->displays_text_p
10637 && row
->height
>= FRAME_LINE_HEIGHT (f
))
10638 change_height_p
= 1;
10640 /* If row displays tool-bar items, but is partially visible,
10641 change the tool-bar's height. */
10642 if (row
->displays_text_p
10643 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
10644 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
10645 change_height_p
= 1;
10647 /* Resize windows as needed by changing the `tool-bar-lines'
10648 frame parameter. */
10649 if (change_height_p
)
10652 int old_height
= WINDOW_TOTAL_LINES (w
);
10654 int nlines
= tool_bar_lines_needed (f
, &nrows
);
10656 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
10657 && !f
->minimize_tool_bar_window_p
)
10658 ? (nlines
> old_height
)
10659 : (nlines
!= old_height
));
10660 f
->minimize_tool_bar_window_p
= 0;
10662 if (change_height_p
)
10664 XSETFRAME (frame
, f
);
10665 Fmodify_frame_parameters (frame
,
10666 Fcons (Fcons (Qtool_bar_lines
,
10667 make_number (nlines
)),
10669 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10671 clear_glyph_matrix (w
->desired_matrix
);
10672 f
->n_tool_bar_rows
= nrows
;
10673 fonts_changed_p
= 1;
10680 f
->minimize_tool_bar_window_p
= 0;
10685 /* Get information about the tool-bar item which is displayed in GLYPH
10686 on frame F. Return in *PROP_IDX the index where tool-bar item
10687 properties start in F->tool_bar_items. Value is zero if
10688 GLYPH doesn't display a tool-bar item. */
10691 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
10697 /* This function can be called asynchronously, which means we must
10698 exclude any possibility that Fget_text_property signals an
10700 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
10701 charpos
= max (0, charpos
);
10703 /* Get the text property `menu-item' at pos. The value of that
10704 property is the start index of this item's properties in
10705 F->tool_bar_items. */
10706 prop
= Fget_text_property (make_number (charpos
),
10707 Qmenu_item
, f
->current_tool_bar_string
);
10708 if (INTEGERP (prop
))
10710 *prop_idx
= XINT (prop
);
10720 /* Get information about the tool-bar item at position X/Y on frame F.
10721 Return in *GLYPH a pointer to the glyph of the tool-bar item in
10722 the current matrix of the tool-bar window of F, or NULL if not
10723 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
10724 item in F->tool_bar_items. Value is
10726 -1 if X/Y is not on a tool-bar item
10727 0 if X/Y is on the same item that was highlighted before.
10731 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
10732 int *hpos
, int *vpos
, int *prop_idx
)
10734 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10735 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10738 /* Find the glyph under X/Y. */
10739 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
10740 if (*glyph
== NULL
)
10743 /* Get the start of this tool-bar item's properties in
10744 f->tool_bar_items. */
10745 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
10748 /* Is mouse on the highlighted item? */
10749 if (EQ (f
->tool_bar_window
, dpyinfo
->mouse_face_window
)
10750 && *vpos
>= dpyinfo
->mouse_face_beg_row
10751 && *vpos
<= dpyinfo
->mouse_face_end_row
10752 && (*vpos
> dpyinfo
->mouse_face_beg_row
10753 || *hpos
>= dpyinfo
->mouse_face_beg_col
)
10754 && (*vpos
< dpyinfo
->mouse_face_end_row
10755 || *hpos
< dpyinfo
->mouse_face_end_col
10756 || dpyinfo
->mouse_face_past_end
))
10764 Handle mouse button event on the tool-bar of frame F, at
10765 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
10766 0 for button release. MODIFIERS is event modifiers for button
10770 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
10771 unsigned int modifiers
)
10773 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10774 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10775 int hpos
, vpos
, prop_idx
;
10776 struct glyph
*glyph
;
10777 Lisp_Object enabled_p
;
10779 /* If not on the highlighted tool-bar item, return. */
10780 frame_to_window_pixel_xy (w
, &x
, &y
);
10781 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
10784 /* If item is disabled, do nothing. */
10785 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10786 if (NILP (enabled_p
))
10791 /* Show item in pressed state. */
10792 show_mouse_face (dpyinfo
, DRAW_IMAGE_SUNKEN
);
10793 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
10794 last_tool_bar_item
= prop_idx
;
10798 Lisp_Object key
, frame
;
10799 struct input_event event
;
10800 EVENT_INIT (event
);
10802 /* Show item in released state. */
10803 show_mouse_face (dpyinfo
, DRAW_IMAGE_RAISED
);
10804 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
10806 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
10808 XSETFRAME (frame
, f
);
10809 event
.kind
= TOOL_BAR_EVENT
;
10810 event
.frame_or_window
= frame
;
10812 kbd_buffer_store_event (&event
);
10814 event
.kind
= TOOL_BAR_EVENT
;
10815 event
.frame_or_window
= frame
;
10817 event
.modifiers
= modifiers
;
10818 kbd_buffer_store_event (&event
);
10819 last_tool_bar_item
= -1;
10824 /* Possibly highlight a tool-bar item on frame F when mouse moves to
10825 tool-bar window-relative coordinates X/Y. Called from
10826 note_mouse_highlight. */
10829 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
10831 Lisp_Object window
= f
->tool_bar_window
;
10832 struct window
*w
= XWINDOW (window
);
10833 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10835 struct glyph
*glyph
;
10836 struct glyph_row
*row
;
10838 Lisp_Object enabled_p
;
10840 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
10841 int mouse_down_p
, rc
;
10843 /* Function note_mouse_highlight is called with negative x(y
10844 values when mouse moves outside of the frame. */
10845 if (x
<= 0 || y
<= 0)
10847 clear_mouse_face (dpyinfo
);
10851 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
10854 /* Not on tool-bar item. */
10855 clear_mouse_face (dpyinfo
);
10859 /* On same tool-bar item as before. */
10860 goto set_help_echo
;
10862 clear_mouse_face (dpyinfo
);
10864 /* Mouse is down, but on different tool-bar item? */
10865 mouse_down_p
= (dpyinfo
->grabbed
10866 && f
== last_mouse_frame
10867 && FRAME_LIVE_P (f
));
10869 && last_tool_bar_item
!= prop_idx
)
10872 dpyinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
10873 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
10875 /* If tool-bar item is not enabled, don't highlight it. */
10876 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10877 if (!NILP (enabled_p
))
10879 /* Compute the x-position of the glyph. In front and past the
10880 image is a space. We include this in the highlighted area. */
10881 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
10882 for (i
= x
= 0; i
< hpos
; ++i
)
10883 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
10885 /* Record this as the current active region. */
10886 dpyinfo
->mouse_face_beg_col
= hpos
;
10887 dpyinfo
->mouse_face_beg_row
= vpos
;
10888 dpyinfo
->mouse_face_beg_x
= x
;
10889 dpyinfo
->mouse_face_beg_y
= row
->y
;
10890 dpyinfo
->mouse_face_past_end
= 0;
10892 dpyinfo
->mouse_face_end_col
= hpos
+ 1;
10893 dpyinfo
->mouse_face_end_row
= vpos
;
10894 dpyinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
10895 dpyinfo
->mouse_face_end_y
= row
->y
;
10896 dpyinfo
->mouse_face_window
= window
;
10897 dpyinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
10899 /* Display it as active. */
10900 show_mouse_face (dpyinfo
, draw
);
10901 dpyinfo
->mouse_face_image_state
= draw
;
10906 /* Set help_echo_string to a help string to display for this tool-bar item.
10907 XTread_socket does the rest. */
10908 help_echo_object
= help_echo_window
= Qnil
;
10909 help_echo_pos
= -1;
10910 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
10911 if (NILP (help_echo_string
))
10912 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
10915 #endif /* HAVE_WINDOW_SYSTEM */
10919 /************************************************************************
10920 Horizontal scrolling
10921 ************************************************************************/
10923 static int hscroll_window_tree (Lisp_Object
);
10924 static int hscroll_windows (Lisp_Object
);
10926 /* For all leaf windows in the window tree rooted at WINDOW, set their
10927 hscroll value so that PT is (i) visible in the window, and (ii) so
10928 that it is not within a certain margin at the window's left and
10929 right border. Value is non-zero if any window's hscroll has been
10933 hscroll_window_tree (Lisp_Object window
)
10935 int hscrolled_p
= 0;
10936 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
10937 int hscroll_step_abs
= 0;
10938 double hscroll_step_rel
= 0;
10940 if (hscroll_relative_p
)
10942 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
10943 if (hscroll_step_rel
< 0)
10945 hscroll_relative_p
= 0;
10946 hscroll_step_abs
= 0;
10949 else if (INTEGERP (Vhscroll_step
))
10951 hscroll_step_abs
= XINT (Vhscroll_step
);
10952 if (hscroll_step_abs
< 0)
10953 hscroll_step_abs
= 0;
10956 hscroll_step_abs
= 0;
10958 while (WINDOWP (window
))
10960 struct window
*w
= XWINDOW (window
);
10962 if (WINDOWP (w
->hchild
))
10963 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
10964 else if (WINDOWP (w
->vchild
))
10965 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
10966 else if (w
->cursor
.vpos
>= 0)
10969 int text_area_width
;
10970 struct glyph_row
*current_cursor_row
10971 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
10972 struct glyph_row
*desired_cursor_row
10973 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
10974 struct glyph_row
*cursor_row
10975 = (desired_cursor_row
->enabled_p
10976 ? desired_cursor_row
10977 : current_cursor_row
);
10979 text_area_width
= window_box_width (w
, TEXT_AREA
);
10981 /* Scroll when cursor is inside this scroll margin. */
10982 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
10984 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
10985 && ((XFASTINT (w
->hscroll
)
10986 && w
->cursor
.x
<= h_margin
)
10987 || (cursor_row
->enabled_p
10988 && cursor_row
->truncated_on_right_p
10989 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
10993 struct buffer
*saved_current_buffer
;
10997 /* Find point in a display of infinite width. */
10998 saved_current_buffer
= current_buffer
;
10999 current_buffer
= XBUFFER (w
->buffer
);
11001 if (w
== XWINDOW (selected_window
))
11002 pt
= BUF_PT (current_buffer
);
11005 pt
= marker_position (w
->pointm
);
11006 pt
= max (BEGV
, pt
);
11010 /* Move iterator to pt starting at cursor_row->start in
11011 a line with infinite width. */
11012 init_to_row_start (&it
, w
, cursor_row
);
11013 it
.last_visible_x
= INFINITY
;
11014 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
11015 current_buffer
= saved_current_buffer
;
11017 /* Position cursor in window. */
11018 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
11019 hscroll
= max (0, (it
.current_x
11020 - (ITERATOR_AT_END_OF_LINE_P (&it
)
11021 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
11022 : (text_area_width
/ 2))))
11023 / FRAME_COLUMN_WIDTH (it
.f
);
11024 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
11026 if (hscroll_relative_p
)
11027 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
11030 wanted_x
= text_area_width
11031 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11034 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11038 if (hscroll_relative_p
)
11039 wanted_x
= text_area_width
* hscroll_step_rel
11042 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11045 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11047 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
11049 /* Don't call Fset_window_hscroll if value hasn't
11050 changed because it will prevent redisplay
11052 if (XFASTINT (w
->hscroll
) != hscroll
)
11054 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
11055 w
->hscroll
= make_number (hscroll
);
11064 /* Value is non-zero if hscroll of any leaf window has been changed. */
11065 return hscrolled_p
;
11069 /* Set hscroll so that cursor is visible and not inside horizontal
11070 scroll margins for all windows in the tree rooted at WINDOW. See
11071 also hscroll_window_tree above. Value is non-zero if any window's
11072 hscroll has been changed. If it has, desired matrices on the frame
11073 of WINDOW are cleared. */
11076 hscroll_windows (Lisp_Object window
)
11078 int hscrolled_p
= hscroll_window_tree (window
);
11080 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
11081 return hscrolled_p
;
11086 /************************************************************************
11088 ************************************************************************/
11090 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
11091 to a non-zero value. This is sometimes handy to have in a debugger
11096 /* First and last unchanged row for try_window_id. */
11098 int debug_first_unchanged_at_end_vpos
;
11099 int debug_last_unchanged_at_beg_vpos
;
11101 /* Delta vpos and y. */
11103 int debug_dvpos
, debug_dy
;
11105 /* Delta in characters and bytes for try_window_id. */
11107 int debug_delta
, debug_delta_bytes
;
11109 /* Values of window_end_pos and window_end_vpos at the end of
11112 EMACS_INT debug_end_pos
, debug_end_vpos
;
11114 /* Append a string to W->desired_matrix->method. FMT is a printf
11115 format string. A1...A9 are a supplement for a variable-length
11116 argument list. If trace_redisplay_p is non-zero also printf the
11117 resulting string to stderr. */
11120 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
11123 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
11126 char *method
= w
->desired_matrix
->method
;
11127 int len
= strlen (method
);
11128 int size
= sizeof w
->desired_matrix
->method
;
11129 int remaining
= size
- len
- 1;
11131 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
11132 if (len
&& remaining
)
11135 --remaining
, ++len
;
11138 strncpy (method
+ len
, buffer
, remaining
);
11140 if (trace_redisplay_p
)
11141 fprintf (stderr
, "%p (%s): %s\n",
11143 ((BUFFERP (w
->buffer
)
11144 && STRINGP (XBUFFER (w
->buffer
)->name
))
11145 ? (char *) SDATA (XBUFFER (w
->buffer
)->name
)
11150 #endif /* GLYPH_DEBUG */
11153 /* Value is non-zero if all changes in window W, which displays
11154 current_buffer, are in the text between START and END. START is a
11155 buffer position, END is given as a distance from Z. Used in
11156 redisplay_internal for display optimization. */
11159 text_outside_line_unchanged_p (struct window
*w
, int start
, int end
)
11161 int unchanged_p
= 1;
11163 /* If text or overlays have changed, see where. */
11164 if (XFASTINT (w
->last_modified
) < MODIFF
11165 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11167 /* Gap in the line? */
11168 if (GPT
< start
|| Z
- GPT
< end
)
11171 /* Changes start in front of the line, or end after it? */
11173 && (BEG_UNCHANGED
< start
- 1
11174 || END_UNCHANGED
< end
))
11177 /* If selective display, can't optimize if changes start at the
11178 beginning of the line. */
11180 && INTEGERP (current_buffer
->selective_display
)
11181 && XINT (current_buffer
->selective_display
) > 0
11182 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
11185 /* If there are overlays at the start or end of the line, these
11186 may have overlay strings with newlines in them. A change at
11187 START, for instance, may actually concern the display of such
11188 overlay strings as well, and they are displayed on different
11189 lines. So, quickly rule out this case. (For the future, it
11190 might be desirable to implement something more telling than
11191 just BEG/END_UNCHANGED.) */
11194 if (BEG
+ BEG_UNCHANGED
== start
11195 && overlay_touches_p (start
))
11197 if (END_UNCHANGED
== end
11198 && overlay_touches_p (Z
- end
))
11202 /* Under bidi reordering, adding or deleting a character in the
11203 beginning of a paragraph, before the first strong directional
11204 character, can change the base direction of the paragraph (unless
11205 the buffer specifies a fixed paragraph direction), which will
11206 require to redisplay the whole paragraph. It might be worthwhile
11207 to find the paragraph limits and widen the range of redisplayed
11208 lines to that, but for now just give up this optimization. */
11209 if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
)
11210 && NILP (XBUFFER (w
->buffer
)->bidi_paragraph_direction
))
11214 return unchanged_p
;
11218 /* Do a frame update, taking possible shortcuts into account. This is
11219 the main external entry point for redisplay.
11221 If the last redisplay displayed an echo area message and that message
11222 is no longer requested, we clear the echo area or bring back the
11223 mini-buffer if that is in use. */
11228 redisplay_internal (0);
11233 overlay_arrow_string_or_property (Lisp_Object var
)
11237 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
11240 return Voverlay_arrow_string
;
11243 /* Return 1 if there are any overlay-arrows in current_buffer. */
11245 overlay_arrow_in_current_buffer_p (void)
11249 for (vlist
= Voverlay_arrow_variable_list
;
11251 vlist
= XCDR (vlist
))
11253 Lisp_Object var
= XCAR (vlist
);
11256 if (!SYMBOLP (var
))
11258 val
= find_symbol_value (var
);
11260 && current_buffer
== XMARKER (val
)->buffer
)
11267 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
11271 overlay_arrows_changed_p (void)
11275 for (vlist
= Voverlay_arrow_variable_list
;
11277 vlist
= XCDR (vlist
))
11279 Lisp_Object var
= XCAR (vlist
);
11280 Lisp_Object val
, pstr
;
11282 if (!SYMBOLP (var
))
11284 val
= find_symbol_value (var
);
11285 if (!MARKERP (val
))
11287 if (! EQ (COERCE_MARKER (val
),
11288 Fget (var
, Qlast_arrow_position
))
11289 || ! (pstr
= overlay_arrow_string_or_property (var
),
11290 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
11296 /* Mark overlay arrows to be updated on next redisplay. */
11299 update_overlay_arrows (int up_to_date
)
11303 for (vlist
= Voverlay_arrow_variable_list
;
11305 vlist
= XCDR (vlist
))
11307 Lisp_Object var
= XCAR (vlist
);
11309 if (!SYMBOLP (var
))
11312 if (up_to_date
> 0)
11314 Lisp_Object val
= find_symbol_value (var
);
11315 Fput (var
, Qlast_arrow_position
,
11316 COERCE_MARKER (val
));
11317 Fput (var
, Qlast_arrow_string
,
11318 overlay_arrow_string_or_property (var
));
11320 else if (up_to_date
< 0
11321 || !NILP (Fget (var
, Qlast_arrow_position
)))
11323 Fput (var
, Qlast_arrow_position
, Qt
);
11324 Fput (var
, Qlast_arrow_string
, Qt
);
11330 /* Return overlay arrow string to display at row.
11331 Return integer (bitmap number) for arrow bitmap in left fringe.
11332 Return nil if no overlay arrow. */
11335 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
11339 for (vlist
= Voverlay_arrow_variable_list
;
11341 vlist
= XCDR (vlist
))
11343 Lisp_Object var
= XCAR (vlist
);
11346 if (!SYMBOLP (var
))
11349 val
= find_symbol_value (var
);
11352 && current_buffer
== XMARKER (val
)->buffer
11353 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
11355 if (FRAME_WINDOW_P (it
->f
)
11356 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
11358 #ifdef HAVE_WINDOW_SYSTEM
11359 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
11362 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
11363 return make_number (fringe_bitmap
);
11366 return make_number (-1); /* Use default arrow bitmap */
11368 return overlay_arrow_string_or_property (var
);
11375 /* Return 1 if point moved out of or into a composition. Otherwise
11376 return 0. PREV_BUF and PREV_PT are the last point buffer and
11377 position. BUF and PT are the current point buffer and position. */
11380 check_point_in_composition (struct buffer
*prev_buf
, int prev_pt
,
11381 struct buffer
*buf
, int pt
)
11383 EMACS_INT start
, end
;
11385 Lisp_Object buffer
;
11387 XSETBUFFER (buffer
, buf
);
11388 /* Check a composition at the last point if point moved within the
11390 if (prev_buf
== buf
)
11393 /* Point didn't move. */
11396 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
11397 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
11398 && COMPOSITION_VALID_P (start
, end
, prop
)
11399 && start
< prev_pt
&& end
> prev_pt
)
11400 /* The last point was within the composition. Return 1 iff
11401 point moved out of the composition. */
11402 return (pt
<= start
|| pt
>= end
);
11405 /* Check a composition at the current point. */
11406 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
11407 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
11408 && COMPOSITION_VALID_P (start
, end
, prop
)
11409 && start
< pt
&& end
> pt
);
11413 /* Reconsider the setting of B->clip_changed which is displayed
11417 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
11419 if (b
->clip_changed
11420 && !NILP (w
->window_end_valid
)
11421 && w
->current_matrix
->buffer
== b
11422 && w
->current_matrix
->zv
== BUF_ZV (b
)
11423 && w
->current_matrix
->begv
== BUF_BEGV (b
))
11424 b
->clip_changed
= 0;
11426 /* If display wasn't paused, and W is not a tool bar window, see if
11427 point has been moved into or out of a composition. In that case,
11428 we set b->clip_changed to 1 to force updating the screen. If
11429 b->clip_changed has already been set to 1, we can skip this
11431 if (!b
->clip_changed
11432 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
11436 if (w
== XWINDOW (selected_window
))
11437 pt
= BUF_PT (current_buffer
);
11439 pt
= marker_position (w
->pointm
);
11441 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
11442 || pt
!= XINT (w
->last_point
))
11443 && check_point_in_composition (w
->current_matrix
->buffer
,
11444 XINT (w
->last_point
),
11445 XBUFFER (w
->buffer
), pt
))
11446 b
->clip_changed
= 1;
11451 /* Select FRAME to forward the values of frame-local variables into C
11452 variables so that the redisplay routines can access those values
11456 select_frame_for_redisplay (Lisp_Object frame
)
11458 Lisp_Object tail
, tem
;
11459 Lisp_Object old
= selected_frame
;
11460 struct Lisp_Symbol
*sym
;
11462 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
11464 selected_frame
= frame
;
11467 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
11468 if (CONSP (XCAR (tail
))
11469 && (tem
= XCAR (XCAR (tail
)),
11471 && (sym
= indirect_variable (XSYMBOL (tem
)),
11472 sym
->redirect
== SYMBOL_LOCALIZED
)
11473 && sym
->val
.blv
->frame_local
)
11474 /* Use find_symbol_value rather than Fsymbol_value
11475 to avoid an error if it is void. */
11476 find_symbol_value (tem
);
11477 } while (!EQ (frame
, old
) && (frame
= old
, 1));
11481 #define STOP_POLLING \
11482 do { if (! polling_stopped_here) stop_polling (); \
11483 polling_stopped_here = 1; } while (0)
11485 #define RESUME_POLLING \
11486 do { if (polling_stopped_here) start_polling (); \
11487 polling_stopped_here = 0; } while (0)
11490 /* If PRESERVE_ECHO_AREA is nonzero, it means this redisplay is not in
11491 response to any user action; therefore, we should preserve the echo
11492 area. (Actually, our caller does that job.) Perhaps in the future
11493 avoid recentering windows if it is not necessary; currently that
11494 causes some problems. */
11497 redisplay_internal (int preserve_echo_area
)
11499 struct window
*w
= XWINDOW (selected_window
);
11502 int must_finish
= 0;
11503 struct text_pos tlbufpos
, tlendpos
;
11504 int number_of_visible_frames
;
11507 int polling_stopped_here
= 0;
11508 Lisp_Object old_frame
= selected_frame
;
11510 /* Non-zero means redisplay has to consider all windows on all
11511 frames. Zero means, only selected_window is considered. */
11512 int consider_all_windows_p
;
11514 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
11516 /* No redisplay if running in batch mode or frame is not yet fully
11517 initialized, or redisplay is explicitly turned off by setting
11518 Vinhibit_redisplay. */
11519 if (FRAME_INITIAL_P (SELECTED_FRAME ())
11520 || !NILP (Vinhibit_redisplay
))
11523 /* Don't examine these until after testing Vinhibit_redisplay.
11524 When Emacs is shutting down, perhaps because its connection to
11525 X has dropped, we should not look at them at all. */
11526 f
= XFRAME (w
->frame
);
11527 sf
= SELECTED_FRAME ();
11529 if (!f
->glyphs_initialized_p
)
11532 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
11533 if (popup_activated ())
11537 /* I don't think this happens but let's be paranoid. */
11538 if (redisplaying_p
)
11541 /* Record a function that resets redisplaying_p to its old value
11542 when we leave this function. */
11543 count
= SPECPDL_INDEX ();
11544 record_unwind_protect (unwind_redisplay
,
11545 Fcons (make_number (redisplaying_p
), selected_frame
));
11547 specbind (Qinhibit_free_realized_faces
, Qnil
);
11550 Lisp_Object tail
, frame
;
11552 FOR_EACH_FRAME (tail
, frame
)
11554 struct frame
*f
= XFRAME (frame
);
11555 f
->already_hscrolled_p
= 0;
11560 if (!EQ (old_frame
, selected_frame
)
11561 && FRAME_LIVE_P (XFRAME (old_frame
)))
11562 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
11563 selected_frame and selected_window to be temporarily out-of-sync so
11564 when we come back here via `goto retry', we need to resync because we
11565 may need to run Elisp code (via prepare_menu_bars). */
11566 select_frame_for_redisplay (old_frame
);
11569 reconsider_clip_changes (w
, current_buffer
);
11570 last_escape_glyph_frame
= NULL
;
11571 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
11573 /* If new fonts have been loaded that make a glyph matrix adjustment
11574 necessary, do it. */
11575 if (fonts_changed_p
)
11577 adjust_glyphs (NULL
);
11578 ++windows_or_buffers_changed
;
11579 fonts_changed_p
= 0;
11582 /* If face_change_count is non-zero, init_iterator will free all
11583 realized faces, which includes the faces referenced from current
11584 matrices. So, we can't reuse current matrices in this case. */
11585 if (face_change_count
)
11586 ++windows_or_buffers_changed
;
11588 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11589 && FRAME_TTY (sf
)->previous_frame
!= sf
)
11591 /* Since frames on a single ASCII terminal share the same
11592 display area, displaying a different frame means redisplay
11593 the whole thing. */
11594 windows_or_buffers_changed
++;
11595 SET_FRAME_GARBAGED (sf
);
11597 set_tty_color_mode (FRAME_TTY (sf
), sf
);
11599 FRAME_TTY (sf
)->previous_frame
= sf
;
11602 /* Set the visible flags for all frames. Do this before checking
11603 for resized or garbaged frames; they want to know if their frames
11604 are visible. See the comment in frame.h for
11605 FRAME_SAMPLE_VISIBILITY. */
11607 Lisp_Object tail
, frame
;
11609 number_of_visible_frames
= 0;
11611 FOR_EACH_FRAME (tail
, frame
)
11613 struct frame
*f
= XFRAME (frame
);
11615 FRAME_SAMPLE_VISIBILITY (f
);
11616 if (FRAME_VISIBLE_P (f
))
11617 ++number_of_visible_frames
;
11618 clear_desired_matrices (f
);
11622 /* Notice any pending interrupt request to change frame size. */
11623 do_pending_window_change (1);
11625 /* Clear frames marked as garbaged. */
11626 if (frame_garbaged
)
11627 clear_garbaged_frames ();
11629 /* Build menubar and tool-bar items. */
11630 if (NILP (Vmemory_full
))
11631 prepare_menu_bars ();
11633 if (windows_or_buffers_changed
)
11634 update_mode_lines
++;
11636 /* Detect case that we need to write or remove a star in the mode line. */
11637 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
11639 w
->update_mode_line
= Qt
;
11640 if (buffer_shared
> 1)
11641 update_mode_lines
++;
11644 /* Avoid invocation of point motion hooks by `current_column' below. */
11645 count1
= SPECPDL_INDEX ();
11646 specbind (Qinhibit_point_motion_hooks
, Qt
);
11648 /* If %c is in the mode line, update it if needed. */
11649 if (!NILP (w
->column_number_displayed
)
11650 /* This alternative quickly identifies a common case
11651 where no change is needed. */
11652 && !(PT
== XFASTINT (w
->last_point
)
11653 && XFASTINT (w
->last_modified
) >= MODIFF
11654 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
11655 && (XFASTINT (w
->column_number_displayed
)
11656 != (int) current_column ())) /* iftc */
11657 w
->update_mode_line
= Qt
;
11659 unbind_to (count1
, Qnil
);
11661 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
11663 /* The variable buffer_shared is set in redisplay_window and
11664 indicates that we redisplay a buffer in different windows. See
11666 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
11667 || cursor_type_changed
);
11669 /* If specs for an arrow have changed, do thorough redisplay
11670 to ensure we remove any arrow that should no longer exist. */
11671 if (overlay_arrows_changed_p ())
11672 consider_all_windows_p
= windows_or_buffers_changed
= 1;
11674 /* Normally the message* functions will have already displayed and
11675 updated the echo area, but the frame may have been trashed, or
11676 the update may have been preempted, so display the echo area
11677 again here. Checking message_cleared_p captures the case that
11678 the echo area should be cleared. */
11679 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
11680 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
11681 || (message_cleared_p
11682 && minibuf_level
== 0
11683 /* If the mini-window is currently selected, this means the
11684 echo-area doesn't show through. */
11685 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
11687 int window_height_changed_p
= echo_area_display (0);
11690 /* If we don't display the current message, don't clear the
11691 message_cleared_p flag, because, if we did, we wouldn't clear
11692 the echo area in the next redisplay which doesn't preserve
11694 if (!display_last_displayed_message_p
)
11695 message_cleared_p
= 0;
11697 if (fonts_changed_p
)
11699 else if (window_height_changed_p
)
11701 consider_all_windows_p
= 1;
11702 ++update_mode_lines
;
11703 ++windows_or_buffers_changed
;
11705 /* If window configuration was changed, frames may have been
11706 marked garbaged. Clear them or we will experience
11707 surprises wrt scrolling. */
11708 if (frame_garbaged
)
11709 clear_garbaged_frames ();
11712 else if (EQ (selected_window
, minibuf_window
)
11713 && (current_buffer
->clip_changed
11714 || XFASTINT (w
->last_modified
) < MODIFF
11715 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11716 && resize_mini_window (w
, 0))
11718 /* Resized active mini-window to fit the size of what it is
11719 showing if its contents might have changed. */
11721 /* FIXME: this causes all frames to be updated, which seems unnecessary
11722 since only the current frame needs to be considered. This function needs
11723 to be rewritten with two variables, consider_all_windows and
11724 consider_all_frames. */
11725 consider_all_windows_p
= 1;
11726 ++windows_or_buffers_changed
;
11727 ++update_mode_lines
;
11729 /* If window configuration was changed, frames may have been
11730 marked garbaged. Clear them or we will experience
11731 surprises wrt scrolling. */
11732 if (frame_garbaged
)
11733 clear_garbaged_frames ();
11737 /* If showing the region, and mark has changed, we must redisplay
11738 the whole window. The assignment to this_line_start_pos prevents
11739 the optimization directly below this if-statement. */
11740 if (((!NILP (Vtransient_mark_mode
)
11741 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
11742 != !NILP (w
->region_showing
))
11743 || (!NILP (w
->region_showing
)
11744 && !EQ (w
->region_showing
,
11745 Fmarker_position (XBUFFER (w
->buffer
)->mark
))))
11746 CHARPOS (this_line_start_pos
) = 0;
11748 /* Optimize the case that only the line containing the cursor in the
11749 selected window has changed. Variables starting with this_ are
11750 set in display_line and record information about the line
11751 containing the cursor. */
11752 tlbufpos
= this_line_start_pos
;
11753 tlendpos
= this_line_end_pos
;
11754 if (!consider_all_windows_p
11755 && CHARPOS (tlbufpos
) > 0
11756 && NILP (w
->update_mode_line
)
11757 && !current_buffer
->clip_changed
11758 && !current_buffer
->prevent_redisplay_optimizations_p
11759 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
11760 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
11761 /* Make sure recorded data applies to current buffer, etc. */
11762 && this_line_buffer
== current_buffer
11763 && current_buffer
== XBUFFER (w
->buffer
)
11764 && NILP (w
->force_start
)
11765 && NILP (w
->optional_new_start
)
11766 /* Point must be on the line that we have info recorded about. */
11767 && PT
>= CHARPOS (tlbufpos
)
11768 && PT
<= Z
- CHARPOS (tlendpos
)
11769 /* All text outside that line, including its final newline,
11770 must be unchanged. */
11771 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
11772 CHARPOS (tlendpos
)))
11774 if (CHARPOS (tlbufpos
) > BEGV
11775 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
11776 && (CHARPOS (tlbufpos
) == ZV
11777 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
11778 /* Former continuation line has disappeared by becoming empty. */
11780 else if (XFASTINT (w
->last_modified
) < MODIFF
11781 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
11782 || MINI_WINDOW_P (w
))
11784 /* We have to handle the case of continuation around a
11785 wide-column character (see the comment in indent.c around
11788 For instance, in the following case:
11790 -------- Insert --------
11791 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
11792 J_I_ ==> J_I_ `^^' are cursors.
11796 As we have to redraw the line above, we cannot use this
11800 int line_height_before
= this_line_pixel_height
;
11802 /* Note that start_display will handle the case that the
11803 line starting at tlbufpos is a continuation line. */
11804 start_display (&it
, w
, tlbufpos
);
11806 /* Implementation note: It this still necessary? */
11807 if (it
.current_x
!= this_line_start_x
)
11810 TRACE ((stderr
, "trying display optimization 1\n"));
11811 w
->cursor
.vpos
= -1;
11812 overlay_arrow_seen
= 0;
11813 it
.vpos
= this_line_vpos
;
11814 it
.current_y
= this_line_y
;
11815 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
11816 display_line (&it
);
11818 /* If line contains point, is not continued,
11819 and ends at same distance from eob as before, we win. */
11820 if (w
->cursor
.vpos
>= 0
11821 /* Line is not continued, otherwise this_line_start_pos
11822 would have been set to 0 in display_line. */
11823 && CHARPOS (this_line_start_pos
)
11824 /* Line ends as before. */
11825 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
11826 /* Line has same height as before. Otherwise other lines
11827 would have to be shifted up or down. */
11828 && this_line_pixel_height
== line_height_before
)
11830 /* If this is not the window's last line, we must adjust
11831 the charstarts of the lines below. */
11832 if (it
.current_y
< it
.last_visible_y
)
11834 struct glyph_row
*row
11835 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
11836 int delta
, delta_bytes
;
11838 /* We used to distinguish between two cases here,
11839 conditioned by Z - CHARPOS (tlendpos) == ZV, for
11840 when the line ends in a newline or the end of the
11841 buffer's accessible portion. But both cases did
11842 the same, so they were collapsed. */
11844 - CHARPOS (tlendpos
)
11845 - MATRIX_ROW_START_CHARPOS (row
));
11846 delta_bytes
= (Z_BYTE
11847 - BYTEPOS (tlendpos
)
11848 - MATRIX_ROW_START_BYTEPOS (row
));
11850 increment_matrix_positions (w
->current_matrix
,
11851 this_line_vpos
+ 1,
11852 w
->current_matrix
->nrows
,
11853 delta
, delta_bytes
);
11856 /* If this row displays text now but previously didn't,
11857 or vice versa, w->window_end_vpos may have to be
11859 if ((it
.glyph_row
- 1)->displays_text_p
)
11861 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
11862 XSETINT (w
->window_end_vpos
, this_line_vpos
);
11864 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
11865 && this_line_vpos
> 0)
11866 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
11867 w
->window_end_valid
= Qnil
;
11869 /* Update hint: No need to try to scroll in update_window. */
11870 w
->desired_matrix
->no_scrolling_p
= 1;
11873 *w
->desired_matrix
->method
= 0;
11874 debug_method_add (w
, "optimization 1");
11876 #ifdef HAVE_WINDOW_SYSTEM
11877 update_window_fringes (w
, 0);
11884 else if (/* Cursor position hasn't changed. */
11885 PT
== XFASTINT (w
->last_point
)
11886 /* Make sure the cursor was last displayed
11887 in this window. Otherwise we have to reposition it. */
11888 && 0 <= w
->cursor
.vpos
11889 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
11893 do_pending_window_change (1);
11895 /* We used to always goto end_of_redisplay here, but this
11896 isn't enough if we have a blinking cursor. */
11897 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
11898 goto end_of_redisplay
;
11902 /* If highlighting the region, or if the cursor is in the echo area,
11903 then we can't just move the cursor. */
11904 else if (! (!NILP (Vtransient_mark_mode
)
11905 && !NILP (current_buffer
->mark_active
))
11906 && (EQ (selected_window
, current_buffer
->last_selected_window
)
11907 || highlight_nonselected_windows
)
11908 && NILP (w
->region_showing
)
11909 && NILP (Vshow_trailing_whitespace
)
11910 && !cursor_in_echo_area
)
11913 struct glyph_row
*row
;
11915 /* Skip from tlbufpos to PT and see where it is. Note that
11916 PT may be in invisible text. If so, we will end at the
11917 next visible position. */
11918 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
11919 NULL
, DEFAULT_FACE_ID
);
11920 it
.current_x
= this_line_start_x
;
11921 it
.current_y
= this_line_y
;
11922 it
.vpos
= this_line_vpos
;
11924 /* The call to move_it_to stops in front of PT, but
11925 moves over before-strings. */
11926 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
11928 if (it
.vpos
== this_line_vpos
11929 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
11932 xassert (this_line_vpos
== it
.vpos
);
11933 xassert (this_line_y
== it
.current_y
);
11934 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
11936 *w
->desired_matrix
->method
= 0;
11937 debug_method_add (w
, "optimization 3");
11946 /* Text changed drastically or point moved off of line. */
11947 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
11950 CHARPOS (this_line_start_pos
) = 0;
11951 consider_all_windows_p
|= buffer_shared
> 1;
11952 ++clear_face_cache_count
;
11953 #ifdef HAVE_WINDOW_SYSTEM
11954 ++clear_image_cache_count
;
11957 /* Build desired matrices, and update the display. If
11958 consider_all_windows_p is non-zero, do it for all windows on all
11959 frames. Otherwise do it for selected_window, only. */
11961 if (consider_all_windows_p
)
11963 Lisp_Object tail
, frame
;
11965 FOR_EACH_FRAME (tail
, frame
)
11966 XFRAME (frame
)->updated_p
= 0;
11968 /* Recompute # windows showing selected buffer. This will be
11969 incremented each time such a window is displayed. */
11972 FOR_EACH_FRAME (tail
, frame
)
11974 struct frame
*f
= XFRAME (frame
);
11976 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
11978 if (! EQ (frame
, selected_frame
))
11979 /* Select the frame, for the sake of frame-local
11981 select_frame_for_redisplay (frame
);
11983 /* Mark all the scroll bars to be removed; we'll redeem
11984 the ones we want when we redisplay their windows. */
11985 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
11986 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
11988 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11989 redisplay_windows (FRAME_ROOT_WINDOW (f
));
11991 /* The X error handler may have deleted that frame. */
11992 if (!FRAME_LIVE_P (f
))
11995 /* Any scroll bars which redisplay_windows should have
11996 nuked should now go away. */
11997 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
11998 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
12000 /* If fonts changed, display again. */
12001 /* ??? rms: I suspect it is a mistake to jump all the way
12002 back to retry here. It should just retry this frame. */
12003 if (fonts_changed_p
)
12006 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12008 /* See if we have to hscroll. */
12009 if (!f
->already_hscrolled_p
)
12011 f
->already_hscrolled_p
= 1;
12012 if (hscroll_windows (f
->root_window
))
12016 /* Prevent various kinds of signals during display
12017 update. stdio is not robust about handling
12018 signals, which can cause an apparent I/O
12020 if (interrupt_input
)
12021 unrequest_sigio ();
12024 /* Update the display. */
12025 set_window_update_flags (XWINDOW (f
->root_window
), 1);
12026 pause
|= update_frame (f
, 0, 0);
12032 if (!EQ (old_frame
, selected_frame
)
12033 && FRAME_LIVE_P (XFRAME (old_frame
)))
12034 /* We played a bit fast-and-loose above and allowed selected_frame
12035 and selected_window to be temporarily out-of-sync but let's make
12036 sure this stays contained. */
12037 select_frame_for_redisplay (old_frame
);
12038 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
12042 /* Do the mark_window_display_accurate after all windows have
12043 been redisplayed because this call resets flags in buffers
12044 which are needed for proper redisplay. */
12045 FOR_EACH_FRAME (tail
, frame
)
12047 struct frame
*f
= XFRAME (frame
);
12050 mark_window_display_accurate (f
->root_window
, 1);
12051 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
12052 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
12057 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12059 Lisp_Object mini_window
;
12060 struct frame
*mini_frame
;
12062 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
12063 /* Use list_of_error, not Qerror, so that
12064 we catch only errors and don't run the debugger. */
12065 internal_condition_case_1 (redisplay_window_1
, selected_window
,
12067 redisplay_window_error
);
12069 /* Compare desired and current matrices, perform output. */
12072 /* If fonts changed, display again. */
12073 if (fonts_changed_p
)
12076 /* Prevent various kinds of signals during display update.
12077 stdio is not robust about handling signals,
12078 which can cause an apparent I/O error. */
12079 if (interrupt_input
)
12080 unrequest_sigio ();
12083 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12085 if (hscroll_windows (selected_window
))
12088 XWINDOW (selected_window
)->must_be_updated_p
= 1;
12089 pause
= update_frame (sf
, 0, 0);
12092 /* We may have called echo_area_display at the top of this
12093 function. If the echo area is on another frame, that may
12094 have put text on a frame other than the selected one, so the
12095 above call to update_frame would not have caught it. Catch
12097 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
12098 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
12100 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
12102 XWINDOW (mini_window
)->must_be_updated_p
= 1;
12103 pause
|= update_frame (mini_frame
, 0, 0);
12104 if (!pause
&& hscroll_windows (mini_window
))
12109 /* If display was paused because of pending input, make sure we do a
12110 thorough update the next time. */
12113 /* Prevent the optimization at the beginning of
12114 redisplay_internal that tries a single-line update of the
12115 line containing the cursor in the selected window. */
12116 CHARPOS (this_line_start_pos
) = 0;
12118 /* Let the overlay arrow be updated the next time. */
12119 update_overlay_arrows (0);
12121 /* If we pause after scrolling, some rows in the current
12122 matrices of some windows are not valid. */
12123 if (!WINDOW_FULL_WIDTH_P (w
)
12124 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
12125 update_mode_lines
= 1;
12129 if (!consider_all_windows_p
)
12131 /* This has already been done above if
12132 consider_all_windows_p is set. */
12133 mark_window_display_accurate_1 (w
, 1);
12135 /* Say overlay arrows are up to date. */
12136 update_overlay_arrows (1);
12138 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
12139 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
12142 update_mode_lines
= 0;
12143 windows_or_buffers_changed
= 0;
12144 cursor_type_changed
= 0;
12147 /* Start SIGIO interrupts coming again. Having them off during the
12148 code above makes it less likely one will discard output, but not
12149 impossible, since there might be stuff in the system buffer here.
12150 But it is much hairier to try to do anything about that. */
12151 if (interrupt_input
)
12155 /* If a frame has become visible which was not before, redisplay
12156 again, so that we display it. Expose events for such a frame
12157 (which it gets when becoming visible) don't call the parts of
12158 redisplay constructing glyphs, so simply exposing a frame won't
12159 display anything in this case. So, we have to display these
12160 frames here explicitly. */
12163 Lisp_Object tail
, frame
;
12166 FOR_EACH_FRAME (tail
, frame
)
12168 int this_is_visible
= 0;
12170 if (XFRAME (frame
)->visible
)
12171 this_is_visible
= 1;
12172 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
12173 if (XFRAME (frame
)->visible
)
12174 this_is_visible
= 1;
12176 if (this_is_visible
)
12180 if (new_count
!= number_of_visible_frames
)
12181 windows_or_buffers_changed
++;
12184 /* Change frame size now if a change is pending. */
12185 do_pending_window_change (1);
12187 /* If we just did a pending size change, or have additional
12188 visible frames, redisplay again. */
12189 if (windows_or_buffers_changed
&& !pause
)
12192 /* Clear the face and image caches.
12194 We used to do this only if consider_all_windows_p. But the cache
12195 needs to be cleared if a timer creates images in the current
12196 buffer (e.g. the test case in Bug#6230). */
12198 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
12200 clear_face_cache (0);
12201 clear_face_cache_count
= 0;
12204 #ifdef HAVE_WINDOW_SYSTEM
12205 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
12207 clear_image_caches (Qnil
);
12208 clear_image_cache_count
= 0;
12210 #endif /* HAVE_WINDOW_SYSTEM */
12213 unbind_to (count
, Qnil
);
12218 /* Redisplay, but leave alone any recent echo area message unless
12219 another message has been requested in its place.
12221 This is useful in situations where you need to redisplay but no
12222 user action has occurred, making it inappropriate for the message
12223 area to be cleared. See tracking_off and
12224 wait_reading_process_output for examples of these situations.
12226 FROM_WHERE is an integer saying from where this function was
12227 called. This is useful for debugging. */
12230 redisplay_preserve_echo_area (int from_where
)
12232 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
12234 if (!NILP (echo_area_buffer
[1]))
12236 /* We have a previously displayed message, but no current
12237 message. Redisplay the previous message. */
12238 display_last_displayed_message_p
= 1;
12239 redisplay_internal (1);
12240 display_last_displayed_message_p
= 0;
12243 redisplay_internal (1);
12245 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
12246 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
12247 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
12251 /* Function registered with record_unwind_protect in
12252 redisplay_internal. Reset redisplaying_p to the value it had
12253 before redisplay_internal was called, and clear
12254 prevent_freeing_realized_faces_p. It also selects the previously
12255 selected frame, unless it has been deleted (by an X connection
12256 failure during redisplay, for example). */
12259 unwind_redisplay (Lisp_Object val
)
12261 Lisp_Object old_redisplaying_p
, old_frame
;
12263 old_redisplaying_p
= XCAR (val
);
12264 redisplaying_p
= XFASTINT (old_redisplaying_p
);
12265 old_frame
= XCDR (val
);
12266 if (! EQ (old_frame
, selected_frame
)
12267 && FRAME_LIVE_P (XFRAME (old_frame
)))
12268 select_frame_for_redisplay (old_frame
);
12273 /* Mark the display of window W as accurate or inaccurate. If
12274 ACCURATE_P is non-zero mark display of W as accurate. If
12275 ACCURATE_P is zero, arrange for W to be redisplayed the next time
12276 redisplay_internal is called. */
12279 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
12281 if (BUFFERP (w
->buffer
))
12283 struct buffer
*b
= XBUFFER (w
->buffer
);
12286 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
12287 w
->last_overlay_modified
12288 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
12290 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
12294 b
->clip_changed
= 0;
12295 b
->prevent_redisplay_optimizations_p
= 0;
12297 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
12298 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
12299 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
12300 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
12302 w
->current_matrix
->buffer
= b
;
12303 w
->current_matrix
->begv
= BUF_BEGV (b
);
12304 w
->current_matrix
->zv
= BUF_ZV (b
);
12306 w
->last_cursor
= w
->cursor
;
12307 w
->last_cursor_off_p
= w
->cursor_off_p
;
12309 if (w
== XWINDOW (selected_window
))
12310 w
->last_point
= make_number (BUF_PT (b
));
12312 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
12318 w
->window_end_valid
= w
->buffer
;
12319 w
->update_mode_line
= Qnil
;
12324 /* Mark the display of windows in the window tree rooted at WINDOW as
12325 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
12326 windows as accurate. If ACCURATE_P is zero, arrange for windows to
12327 be redisplayed the next time redisplay_internal is called. */
12330 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
12334 for (; !NILP (window
); window
= w
->next
)
12336 w
= XWINDOW (window
);
12337 mark_window_display_accurate_1 (w
, accurate_p
);
12339 if (!NILP (w
->vchild
))
12340 mark_window_display_accurate (w
->vchild
, accurate_p
);
12341 if (!NILP (w
->hchild
))
12342 mark_window_display_accurate (w
->hchild
, accurate_p
);
12347 update_overlay_arrows (1);
12351 /* Force a thorough redisplay the next time by setting
12352 last_arrow_position and last_arrow_string to t, which is
12353 unequal to any useful value of Voverlay_arrow_... */
12354 update_overlay_arrows (-1);
12359 /* Return value in display table DP (Lisp_Char_Table *) for character
12360 C. Since a display table doesn't have any parent, we don't have to
12361 follow parent. Do not call this function directly but use the
12362 macro DISP_CHAR_VECTOR. */
12365 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
12369 if (ASCII_CHAR_P (c
))
12372 if (SUB_CHAR_TABLE_P (val
))
12373 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
12379 XSETCHAR_TABLE (table
, dp
);
12380 val
= char_table_ref (table
, c
);
12389 /***********************************************************************
12391 ***********************************************************************/
12393 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
12396 redisplay_windows (Lisp_Object window
)
12398 while (!NILP (window
))
12400 struct window
*w
= XWINDOW (window
);
12402 if (!NILP (w
->hchild
))
12403 redisplay_windows (w
->hchild
);
12404 else if (!NILP (w
->vchild
))
12405 redisplay_windows (w
->vchild
);
12406 else if (!NILP (w
->buffer
))
12408 displayed_buffer
= XBUFFER (w
->buffer
);
12409 /* Use list_of_error, not Qerror, so that
12410 we catch only errors and don't run the debugger. */
12411 internal_condition_case_1 (redisplay_window_0
, window
,
12413 redisplay_window_error
);
12421 redisplay_window_error (Lisp_Object ignore
)
12423 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
12428 redisplay_window_0 (Lisp_Object window
)
12430 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12431 redisplay_window (window
, 0);
12436 redisplay_window_1 (Lisp_Object window
)
12438 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12439 redisplay_window (window
, 1);
12444 /* Increment GLYPH until it reaches END or CONDITION fails while
12445 adding (GLYPH)->pixel_width to X. */
12447 #define SKIP_GLYPHS(glyph, end, x, condition) \
12450 (x) += (glyph)->pixel_width; \
12453 while ((glyph) < (end) && (condition))
12456 /* Set cursor position of W. PT is assumed to be displayed in ROW.
12457 DELTA and DELTA_BYTES are the numbers of characters and bytes by
12458 which positions recorded in ROW differ from current buffer
12461 Return 0 if cursor is not on this row, 1 otherwise. */
12464 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
12465 struct glyph_matrix
*matrix
, int delta
, int delta_bytes
,
12468 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
12469 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
12470 struct glyph
*cursor
= NULL
;
12471 /* The last known character position in row. */
12472 int last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12474 EMACS_INT pt_old
= PT
- delta
;
12475 EMACS_INT pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12476 EMACS_INT pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
12477 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
12478 /* A glyph beyond the edge of TEXT_AREA which we should never
12480 struct glyph
*glyphs_end
= end
;
12481 /* Non-zero means we've found a match for cursor position, but that
12482 glyph has the avoid_cursor_p flag set. */
12483 int match_with_avoid_cursor
= 0;
12484 /* Non-zero means we've seen at least one glyph that came from a
12486 int string_seen
= 0;
12487 /* Largest buffer position seen so far during scan of glyph row. */
12488 EMACS_INT bpos_max
= last_pos
;
12489 /* Last buffer position covered by an overlay string with an integer
12490 `cursor' property. */
12491 EMACS_INT bpos_covered
= 0;
12493 /* Skip over glyphs not having an object at the start and the end of
12494 the row. These are special glyphs like truncation marks on
12495 terminal frames. */
12496 if (row
->displays_text_p
)
12498 if (!row
->reversed_p
)
12501 && INTEGERP (glyph
->object
)
12502 && glyph
->charpos
< 0)
12504 x
+= glyph
->pixel_width
;
12508 && INTEGERP ((end
- 1)->object
)
12509 /* CHARPOS is zero for blanks and stretch glyphs
12510 inserted by extend_face_to_end_of_line. */
12511 && (end
- 1)->charpos
<= 0)
12513 glyph_before
= glyph
- 1;
12520 /* If the glyph row is reversed, we need to process it from back
12521 to front, so swap the edge pointers. */
12522 glyphs_end
= end
= glyph
- 1;
12523 glyph
+= row
->used
[TEXT_AREA
] - 1;
12525 while (glyph
> end
+ 1
12526 && INTEGERP (glyph
->object
)
12527 && glyph
->charpos
< 0)
12530 x
-= glyph
->pixel_width
;
12532 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
12534 /* By default, in reversed rows we put the cursor on the
12535 rightmost (first in the reading order) glyph. */
12536 for (g
= end
+ 1; g
< glyph
; g
++)
12537 x
+= g
->pixel_width
;
12539 && INTEGERP ((end
+ 1)->object
)
12540 && (end
+ 1)->charpos
<= 0)
12542 glyph_before
= glyph
+ 1;
12546 else if (row
->reversed_p
)
12548 /* In R2L rows that don't display text, put the cursor on the
12549 rightmost glyph. Case in point: an empty last line that is
12550 part of an R2L paragraph. */
12552 /* Avoid placing the cursor on the last glyph of the row, where
12553 on terminal frames we hold the vertical border between
12554 adjacent windows. */
12555 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
12556 && !WINDOW_RIGHTMOST_P (w
)
12557 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
12559 x
= -1; /* will be computed below, at label compute_x */
12562 /* Step 1: Try to find the glyph whose character position
12563 corresponds to point. If that's not possible, find 2 glyphs
12564 whose character positions are the closest to point, one before
12565 point, the other after it. */
12566 if (!row
->reversed_p
)
12567 while (/* not marched to end of glyph row */
12569 /* glyph was not inserted by redisplay for internal purposes */
12570 && !INTEGERP (glyph
->object
))
12572 if (BUFFERP (glyph
->object
))
12574 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12576 if (glyph
->charpos
> bpos_max
)
12577 bpos_max
= glyph
->charpos
;
12578 if (!glyph
->avoid_cursor_p
)
12580 /* If we hit point, we've found the glyph on which to
12581 display the cursor. */
12584 match_with_avoid_cursor
= 0;
12587 /* See if we've found a better approximation to
12588 POS_BEFORE or to POS_AFTER. Note that we want the
12589 first (leftmost) glyph of all those that are the
12590 closest from below, and the last (rightmost) of all
12591 those from above. */
12592 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12594 pos_before
= glyph
->charpos
;
12595 glyph_before
= glyph
;
12597 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12599 pos_after
= glyph
->charpos
;
12600 glyph_after
= glyph
;
12603 else if (dpos
== 0)
12604 match_with_avoid_cursor
= 1;
12606 else if (STRINGP (glyph
->object
))
12608 Lisp_Object chprop
;
12609 int glyph_pos
= glyph
->charpos
;
12611 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12613 if (INTEGERP (chprop
))
12615 bpos_covered
= bpos_max
+ XINT (chprop
);
12616 /* If the `cursor' property covers buffer positions up
12617 to and including point, we should display cursor on
12618 this glyph. Note that overlays and text properties
12619 with string values stop bidi reordering, so every
12620 buffer position to the left of the string is always
12621 smaller than any position to the right of the
12622 string. Therefore, if a `cursor' property on one
12623 of the string's characters has an integer value, we
12624 will break out of the loop below _before_ we get to
12625 the position match above. IOW, integer values of
12626 the `cursor' property override the "exact match for
12627 point" strategy of positioning the cursor. */
12628 /* Implementation note: bpos_max == pt_old when, e.g.,
12629 we are in an empty line, where bpos_max is set to
12630 MATRIX_ROW_START_CHARPOS, see above. */
12631 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12640 x
+= glyph
->pixel_width
;
12643 else if (glyph
> end
) /* row is reversed */
12644 while (!INTEGERP (glyph
->object
))
12646 if (BUFFERP (glyph
->object
))
12648 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12650 if (glyph
->charpos
> bpos_max
)
12651 bpos_max
= glyph
->charpos
;
12652 if (!glyph
->avoid_cursor_p
)
12656 match_with_avoid_cursor
= 0;
12659 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12661 pos_before
= glyph
->charpos
;
12662 glyph_before
= glyph
;
12664 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12666 pos_after
= glyph
->charpos
;
12667 glyph_after
= glyph
;
12670 else if (dpos
== 0)
12671 match_with_avoid_cursor
= 1;
12673 else if (STRINGP (glyph
->object
))
12675 Lisp_Object chprop
;
12676 int glyph_pos
= glyph
->charpos
;
12678 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12680 if (INTEGERP (chprop
))
12682 bpos_covered
= bpos_max
+ XINT (chprop
);
12683 /* If the `cursor' property covers buffer positions up
12684 to and including point, we should display cursor on
12686 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12695 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
12697 x
--; /* can't use any pixel_width */
12700 x
-= glyph
->pixel_width
;
12703 /* Step 2: If we didn't find an exact match for point, we need to
12704 look for a proper place to put the cursor among glyphs between
12705 GLYPH_BEFORE and GLYPH_AFTER. */
12706 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
12707 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12708 && bpos_covered
< pt_old
)
12710 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
12712 EMACS_INT ellipsis_pos
;
12714 /* Scan back over the ellipsis glyphs. */
12715 if (!row
->reversed_p
)
12717 ellipsis_pos
= (glyph
- 1)->charpos
;
12718 while (glyph
> row
->glyphs
[TEXT_AREA
]
12719 && (glyph
- 1)->charpos
== ellipsis_pos
)
12720 glyph
--, x
-= glyph
->pixel_width
;
12721 /* That loop always goes one position too far, including
12722 the glyph before the ellipsis. So scan forward over
12724 x
+= glyph
->pixel_width
;
12727 else /* row is reversed */
12729 ellipsis_pos
= (glyph
+ 1)->charpos
;
12730 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
12731 && (glyph
+ 1)->charpos
== ellipsis_pos
)
12732 glyph
++, x
+= glyph
->pixel_width
;
12733 x
-= glyph
->pixel_width
;
12737 else if (match_with_avoid_cursor
12738 /* zero-width characters produce no glyphs */
12739 || ((row
->reversed_p
12740 ? glyph_after
> glyphs_end
12741 : glyph_after
< glyphs_end
)
12742 && eabs (glyph_after
- glyph_before
) == 1))
12744 cursor
= glyph_after
;
12747 else if (string_seen
)
12749 int incr
= row
->reversed_p
? -1 : +1;
12751 /* Need to find the glyph that came out of a string which is
12752 present at point. That glyph is somewhere between
12753 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
12754 positioned between POS_BEFORE and POS_AFTER in the
12756 struct glyph
*stop
= glyph_after
;
12757 EMACS_INT pos
= pos_before
;
12760 for (glyph
= glyph_before
+ incr
;
12761 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
12764 /* Any glyphs that come from the buffer are here because
12765 of bidi reordering. Skip them, and only pay
12766 attention to glyphs that came from some string. */
12767 if (STRINGP (glyph
->object
))
12772 str
= glyph
->object
;
12773 tem
= string_buffer_position_lim (w
, str
, pos
, pos_after
, 0);
12774 if (tem
== 0 /* from overlay */
12777 /* If the string from which this glyph came is
12778 found in the buffer at point, then we've
12779 found the glyph we've been looking for. If
12780 it comes from an overlay (tem == 0), and it
12781 has the `cursor' property on one of its
12782 glyphs, record that glyph as a candidate for
12783 displaying the cursor. (As in the
12784 unidirectional version, we will display the
12785 cursor on the last candidate we find.) */
12786 if (tem
== 0 || tem
== pt_old
)
12788 /* The glyphs from this string could have
12789 been reordered. Find the one with the
12790 smallest string position. Or there could
12791 be a character in the string with the
12792 `cursor' property, which means display
12793 cursor on that character's glyph. */
12794 int strpos
= glyph
->charpos
;
12797 for (glyph
+= incr
;
12798 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
12799 && EQ (glyph
->object
, str
);
12803 int gpos
= glyph
->charpos
;
12805 cprop
= Fget_char_property (make_number (gpos
),
12813 if (glyph
->charpos
< strpos
)
12815 strpos
= glyph
->charpos
;
12824 pos
= tem
+ 1; /* don't find previous instances */
12826 /* This string is not what we want; skip all of the
12827 glyphs that came from it. */
12830 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
12831 && EQ (glyph
->object
, str
));
12837 /* If we reached the end of the line, and END was from a string,
12838 the cursor is not on this line. */
12840 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
12841 && STRINGP (end
->object
)
12842 && row
->continued_p
)
12848 if (cursor
!= NULL
)
12854 /* Need to compute x that corresponds to GLYPH. */
12855 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
12857 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
12859 x
+= g
->pixel_width
;
12863 /* ROW could be part of a continued line, which, under bidi
12864 reordering, might have other rows whose start and end charpos
12865 occlude point. Only set w->cursor if we found a better
12866 approximation to the cursor position than we have from previously
12867 examined candidate rows belonging to the same continued line. */
12868 if (/* we already have a candidate row */
12869 w
->cursor
.vpos
>= 0
12870 /* that candidate is not the row we are processing */
12871 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
12872 /* the row we are processing is part of a continued line */
12873 && (row
->continued_p
|| MATRIX_ROW_CONTINUATION_LINE_P (row
))
12874 /* Make sure cursor.vpos specifies a row whose start and end
12875 charpos occlude point. This is because some callers of this
12876 function leave cursor.vpos at the row where the cursor was
12877 displayed during the last redisplay cycle. */
12878 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
12879 && pt_old
< MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
12882 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
12884 /* Don't consider glyphs that are outside TEXT_AREA. */
12885 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
12887 /* Keep the candidate whose buffer position is the closest to
12889 if (/* previous candidate is a glyph in TEXT_AREA of that row */
12890 w
->cursor
.hpos
>= 0
12891 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
12892 && BUFFERP (g1
->object
)
12893 && (g1
->charpos
== pt_old
/* an exact match always wins */
12894 || (BUFFERP (glyph
->object
)
12895 && eabs (g1
->charpos
- pt_old
)
12896 < eabs (glyph
->charpos
- pt_old
))))
12898 /* If this candidate gives an exact match, use that. */
12899 if (!(BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12900 /* Otherwise, keep the candidate that comes from a row
12901 spanning less buffer positions. This may win when one or
12902 both candidate positions are on glyphs that came from
12903 display strings, for which we cannot compare buffer
12905 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
12906 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
12907 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
12910 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
12912 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
12913 w
->cursor
.y
= row
->y
+ dy
;
12915 if (w
== XWINDOW (selected_window
))
12917 if (!row
->continued_p
12918 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
12921 this_line_buffer
= XBUFFER (w
->buffer
);
12923 CHARPOS (this_line_start_pos
)
12924 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
12925 BYTEPOS (this_line_start_pos
)
12926 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
12928 CHARPOS (this_line_end_pos
)
12929 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
12930 BYTEPOS (this_line_end_pos
)
12931 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
12933 this_line_y
= w
->cursor
.y
;
12934 this_line_pixel_height
= row
->height
;
12935 this_line_vpos
= w
->cursor
.vpos
;
12936 this_line_start_x
= row
->x
;
12939 CHARPOS (this_line_start_pos
) = 0;
12946 /* Run window scroll functions, if any, for WINDOW with new window
12947 start STARTP. Sets the window start of WINDOW to that position.
12949 We assume that the window's buffer is really current. */
12951 static INLINE
struct text_pos
12952 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
12954 struct window
*w
= XWINDOW (window
);
12955 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
12957 if (current_buffer
!= XBUFFER (w
->buffer
))
12960 if (!NILP (Vwindow_scroll_functions
))
12962 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
12963 make_number (CHARPOS (startp
)));
12964 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12965 /* In case the hook functions switch buffers. */
12966 if (current_buffer
!= XBUFFER (w
->buffer
))
12967 set_buffer_internal_1 (XBUFFER (w
->buffer
));
12974 /* Make sure the line containing the cursor is fully visible.
12975 A value of 1 means there is nothing to be done.
12976 (Either the line is fully visible, or it cannot be made so,
12977 or we cannot tell.)
12979 If FORCE_P is non-zero, return 0 even if partial visible cursor row
12980 is higher than window.
12982 A value of 0 means the caller should do scrolling
12983 as if point had gone off the screen. */
12986 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
12988 struct glyph_matrix
*matrix
;
12989 struct glyph_row
*row
;
12992 if (!make_cursor_line_fully_visible_p
)
12995 /* It's not always possible to find the cursor, e.g, when a window
12996 is full of overlay strings. Don't do anything in that case. */
12997 if (w
->cursor
.vpos
< 0)
13000 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
13001 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
13003 /* If the cursor row is not partially visible, there's nothing to do. */
13004 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
13007 /* If the row the cursor is in is taller than the window's height,
13008 it's not clear what to do, so do nothing. */
13009 window_height
= window_box_height (w
);
13010 if (row
->height
>= window_height
)
13012 if (!force_p
|| MINI_WINDOW_P (w
)
13013 || w
->vscroll
|| w
->cursor
.vpos
== 0)
13020 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
13021 non-zero means only WINDOW is redisplayed in redisplay_internal.
13022 TEMP_SCROLL_STEP has the same meaning as scroll_step, and is used
13023 in redisplay_window to bring a partially visible line into view in
13024 the case that only the cursor has moved.
13026 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
13027 last screen line's vertical height extends past the end of the screen.
13031 1 if scrolling succeeded
13033 0 if scrolling didn't find point.
13035 -1 if new fonts have been loaded so that we must interrupt
13036 redisplay, adjust glyph matrices, and try again. */
13042 SCROLLING_NEED_LARGER_MATRICES
13046 try_scrolling (Lisp_Object window
, int just_this_one_p
,
13047 EMACS_INT scroll_conservatively
, EMACS_INT scroll_step
,
13048 int temp_scroll_step
, int last_line_misfit
)
13050 struct window
*w
= XWINDOW (window
);
13051 struct frame
*f
= XFRAME (w
->frame
);
13052 struct text_pos pos
, startp
;
13054 int this_scroll_margin
, scroll_max
, rc
, height
;
13055 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
13056 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
13057 Lisp_Object aggressive
;
13058 int scroll_limit
= INT_MAX
/ FRAME_LINE_HEIGHT (f
);
13061 debug_method_add (w
, "try_scrolling");
13064 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13066 /* Compute scroll margin height in pixels. We scroll when point is
13067 within this distance from the top or bottom of the window. */
13068 if (scroll_margin
> 0)
13069 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
13070 * FRAME_LINE_HEIGHT (f
);
13072 this_scroll_margin
= 0;
13074 /* Force scroll_conservatively to have a reasonable value, to avoid
13075 overflow while computing how much to scroll. Note that the user
13076 can supply scroll-conservatively equal to `most-positive-fixnum',
13077 which can be larger than INT_MAX. */
13078 if (scroll_conservatively
> scroll_limit
)
13080 scroll_conservatively
= scroll_limit
;
13081 scroll_max
= INT_MAX
;
13083 else if (scroll_step
|| scroll_conservatively
|| temp_scroll_step
)
13084 /* Compute how much we should try to scroll maximally to bring
13085 point into view. */
13086 scroll_max
= (max (scroll_step
,
13087 max (scroll_conservatively
, temp_scroll_step
))
13088 * FRAME_LINE_HEIGHT (f
));
13089 else if (NUMBERP (current_buffer
->scroll_down_aggressively
)
13090 || NUMBERP (current_buffer
->scroll_up_aggressively
))
13091 /* We're trying to scroll because of aggressive scrolling but no
13092 scroll_step is set. Choose an arbitrary one. */
13093 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
13099 /* Decide whether to scroll down. */
13100 if (PT
> CHARPOS (startp
))
13102 int scroll_margin_y
;
13104 /* Compute the pixel ypos of the scroll margin, then move it to
13105 either that ypos or PT, whichever comes first. */
13106 start_display (&it
, w
, startp
);
13107 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
13108 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
13109 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
13110 (MOVE_TO_POS
| MOVE_TO_Y
));
13112 if (PT
> CHARPOS (it
.current
.pos
))
13114 int y0
= line_bottom_y (&it
);
13115 /* Compute how many pixels below window bottom to stop searching
13116 for PT. This avoids costly search for PT that is far away if
13117 the user limited scrolling by a small number of lines, but
13118 always finds PT if scroll_conservatively is set to a large
13119 number, such as most-positive-fixnum. */
13120 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
13122 slack
>= INT_MAX
- it
.last_visible_y
13124 : it
.last_visible_y
+ slack
;
13126 /* Compute the distance from the scroll margin to PT or to
13127 the scroll limit, whichever comes first. This should
13128 include the height of the cursor line, to make that line
13130 move_it_to (&it
, PT
, -1, y_to_move
,
13131 -1, MOVE_TO_POS
| MOVE_TO_Y
);
13132 dy
= line_bottom_y (&it
) - y0
;
13134 if (dy
> scroll_max
)
13135 return SCROLLING_FAILED
;
13143 /* Point is in or below the bottom scroll margin, so move the
13144 window start down. If scrolling conservatively, move it just
13145 enough down to make point visible. If scroll_step is set,
13146 move it down by scroll_step. */
13147 if (scroll_conservatively
)
13149 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
13150 FRAME_LINE_HEIGHT (f
) * scroll_conservatively
);
13151 else if (scroll_step
|| temp_scroll_step
)
13152 amount_to_scroll
= scroll_max
;
13155 aggressive
= current_buffer
->scroll_up_aggressively
;
13156 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13157 if (NUMBERP (aggressive
))
13159 double float_amount
= XFLOATINT (aggressive
) * height
;
13160 amount_to_scroll
= float_amount
;
13161 if (amount_to_scroll
== 0 && float_amount
> 0)
13162 amount_to_scroll
= 1;
13166 if (amount_to_scroll
<= 0)
13167 return SCROLLING_FAILED
;
13169 start_display (&it
, w
, startp
);
13170 if (scroll_max
< INT_MAX
)
13171 move_it_vertically (&it
, amount_to_scroll
);
13174 /* Extra precision for users who set scroll-conservatively
13175 to most-positive-fixnum: make sure the amount we scroll
13176 the window start is never less than amount_to_scroll,
13177 which was computed as distance from window bottom to
13178 point. This matters when lines at window top and lines
13179 below window bottom have different height. */
13180 struct it it1
= it
;
13181 /* We use a temporary it1 because line_bottom_y can modify
13182 its argument, if it moves one line down; see there. */
13183 int start_y
= line_bottom_y (&it1
);
13186 move_it_by_lines (&it
, 1, 1);
13188 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
13191 /* If STARTP is unchanged, move it down another screen line. */
13192 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
13193 move_it_by_lines (&it
, 1, 1);
13194 startp
= it
.current
.pos
;
13198 struct text_pos scroll_margin_pos
= startp
;
13200 /* See if point is inside the scroll margin at the top of the
13202 if (this_scroll_margin
)
13204 start_display (&it
, w
, startp
);
13205 move_it_vertically (&it
, this_scroll_margin
);
13206 scroll_margin_pos
= it
.current
.pos
;
13209 if (PT
< CHARPOS (scroll_margin_pos
))
13211 /* Point is in the scroll margin at the top of the window or
13212 above what is displayed in the window. */
13215 /* Compute the vertical distance from PT to the scroll
13216 margin position. Give up if distance is greater than
13218 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
13219 start_display (&it
, w
, pos
);
13221 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
13222 it
.last_visible_y
, -1,
13223 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13224 dy
= it
.current_y
- y0
;
13225 if (dy
> scroll_max
)
13226 return SCROLLING_FAILED
;
13228 /* Compute new window start. */
13229 start_display (&it
, w
, startp
);
13231 if (scroll_conservatively
)
13233 = max (dy
, FRAME_LINE_HEIGHT (f
) * max (scroll_step
, temp_scroll_step
));
13234 else if (scroll_step
|| temp_scroll_step
)
13235 amount_to_scroll
= scroll_max
;
13238 aggressive
= current_buffer
->scroll_down_aggressively
;
13239 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13240 if (NUMBERP (aggressive
))
13242 double float_amount
= XFLOATINT (aggressive
) * height
;
13243 amount_to_scroll
= float_amount
;
13244 if (amount_to_scroll
== 0 && float_amount
> 0)
13245 amount_to_scroll
= 1;
13249 if (amount_to_scroll
<= 0)
13250 return SCROLLING_FAILED
;
13252 move_it_vertically_backward (&it
, amount_to_scroll
);
13253 startp
= it
.current
.pos
;
13257 /* Run window scroll functions. */
13258 startp
= run_window_scroll_functions (window
, startp
);
13260 /* Display the window. Give up if new fonts are loaded, or if point
13262 if (!try_window (window
, startp
, 0))
13263 rc
= SCROLLING_NEED_LARGER_MATRICES
;
13264 else if (w
->cursor
.vpos
< 0)
13266 clear_glyph_matrix (w
->desired_matrix
);
13267 rc
= SCROLLING_FAILED
;
13271 /* Maybe forget recorded base line for line number display. */
13272 if (!just_this_one_p
13273 || current_buffer
->clip_changed
13274 || BEG_UNCHANGED
< CHARPOS (startp
))
13275 w
->base_line_number
= Qnil
;
13277 /* If cursor ends up on a partially visible line,
13278 treat that as being off the bottom of the screen. */
13279 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0))
13281 clear_glyph_matrix (w
->desired_matrix
);
13282 ++extra_scroll_margin_lines
;
13285 rc
= SCROLLING_SUCCESS
;
13292 /* Compute a suitable window start for window W if display of W starts
13293 on a continuation line. Value is non-zero if a new window start
13296 The new window start will be computed, based on W's width, starting
13297 from the start of the continued line. It is the start of the
13298 screen line with the minimum distance from the old start W->start. */
13301 compute_window_start_on_continuation_line (struct window
*w
)
13303 struct text_pos pos
, start_pos
;
13304 int window_start_changed_p
= 0;
13306 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
13308 /* If window start is on a continuation line... Window start may be
13309 < BEGV in case there's invisible text at the start of the
13310 buffer (M-x rmail, for example). */
13311 if (CHARPOS (start_pos
) > BEGV
13312 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
13315 struct glyph_row
*row
;
13317 /* Handle the case that the window start is out of range. */
13318 if (CHARPOS (start_pos
) < BEGV
)
13319 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
13320 else if (CHARPOS (start_pos
) > ZV
)
13321 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
13323 /* Find the start of the continued line. This should be fast
13324 because scan_buffer is fast (newline cache). */
13325 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
13326 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
13327 row
, DEFAULT_FACE_ID
);
13328 reseat_at_previous_visible_line_start (&it
);
13330 /* If the line start is "too far" away from the window start,
13331 say it takes too much time to compute a new window start. */
13332 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
13333 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
13335 int min_distance
, distance
;
13337 /* Move forward by display lines to find the new window
13338 start. If window width was enlarged, the new start can
13339 be expected to be > the old start. If window width was
13340 decreased, the new window start will be < the old start.
13341 So, we're looking for the display line start with the
13342 minimum distance from the old window start. */
13343 pos
= it
.current
.pos
;
13344 min_distance
= INFINITY
;
13345 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
13346 distance
< min_distance
)
13348 min_distance
= distance
;
13349 pos
= it
.current
.pos
;
13350 move_it_by_lines (&it
, 1, 0);
13353 /* Set the window start there. */
13354 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
13355 window_start_changed_p
= 1;
13359 return window_start_changed_p
;
13363 /* Try cursor movement in case text has not changed in window WINDOW,
13364 with window start STARTP. Value is
13366 CURSOR_MOVEMENT_SUCCESS if successful
13368 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
13370 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
13371 display. *SCROLL_STEP is set to 1, under certain circumstances, if
13372 we want to scroll as if scroll-step were set to 1. See the code.
13374 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
13375 which case we have to abort this redisplay, and adjust matrices
13380 CURSOR_MOVEMENT_SUCCESS
,
13381 CURSOR_MOVEMENT_CANNOT_BE_USED
,
13382 CURSOR_MOVEMENT_MUST_SCROLL
,
13383 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
13387 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
13389 struct window
*w
= XWINDOW (window
);
13390 struct frame
*f
= XFRAME (w
->frame
);
13391 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
13394 if (inhibit_try_cursor_movement
)
13398 /* Handle case where text has not changed, only point, and it has
13399 not moved off the frame. */
13400 if (/* Point may be in this window. */
13401 PT
>= CHARPOS (startp
)
13402 /* Selective display hasn't changed. */
13403 && !current_buffer
->clip_changed
13404 /* Function force-mode-line-update is used to force a thorough
13405 redisplay. It sets either windows_or_buffers_changed or
13406 update_mode_lines. So don't take a shortcut here for these
13408 && !update_mode_lines
13409 && !windows_or_buffers_changed
13410 && !cursor_type_changed
13411 /* Can't use this case if highlighting a region. When a
13412 region exists, cursor movement has to do more than just
13414 && !(!NILP (Vtransient_mark_mode
)
13415 && !NILP (current_buffer
->mark_active
))
13416 && NILP (w
->region_showing
)
13417 && NILP (Vshow_trailing_whitespace
)
13418 /* Right after splitting windows, last_point may be nil. */
13419 && INTEGERP (w
->last_point
)
13420 /* This code is not used for mini-buffer for the sake of the case
13421 of redisplaying to replace an echo area message; since in
13422 that case the mini-buffer contents per se are usually
13423 unchanged. This code is of no real use in the mini-buffer
13424 since the handling of this_line_start_pos, etc., in redisplay
13425 handles the same cases. */
13426 && !EQ (window
, minibuf_window
)
13427 /* When splitting windows or for new windows, it happens that
13428 redisplay is called with a nil window_end_vpos or one being
13429 larger than the window. This should really be fixed in
13430 window.c. I don't have this on my list, now, so we do
13431 approximately the same as the old redisplay code. --gerd. */
13432 && INTEGERP (w
->window_end_vpos
)
13433 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
13434 && (FRAME_WINDOW_P (f
)
13435 || !overlay_arrow_in_current_buffer_p ()))
13437 int this_scroll_margin
, top_scroll_margin
;
13438 struct glyph_row
*row
= NULL
;
13441 debug_method_add (w
, "cursor movement");
13444 /* Scroll if point within this distance from the top or bottom
13445 of the window. This is a pixel value. */
13446 if (scroll_margin
> 0)
13448 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
13449 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
13452 this_scroll_margin
= 0;
13454 top_scroll_margin
= this_scroll_margin
;
13455 if (WINDOW_WANTS_HEADER_LINE_P (w
))
13456 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
13458 /* Start with the row the cursor was displayed during the last
13459 not paused redisplay. Give up if that row is not valid. */
13460 if (w
->last_cursor
.vpos
< 0
13461 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
13462 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13465 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
13466 if (row
->mode_line_p
)
13468 if (!row
->enabled_p
)
13469 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13472 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
13474 int scroll_p
= 0, must_scroll
= 0;
13475 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
13477 if (PT
> XFASTINT (w
->last_point
))
13479 /* Point has moved forward. */
13480 while (MATRIX_ROW_END_CHARPOS (row
) < PT
13481 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
13483 xassert (row
->enabled_p
);
13487 /* If the end position of a row equals the start
13488 position of the next row, and PT is at that position,
13489 we would rather display cursor in the next line. */
13490 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13491 && MATRIX_ROW_END_CHARPOS (row
) == PT
13492 && row
< w
->current_matrix
->rows
13493 + w
->current_matrix
->nrows
- 1
13494 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
13495 && !cursor_row_p (w
, row
))
13498 /* If within the scroll margin, scroll. Note that
13499 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
13500 the next line would be drawn, and that
13501 this_scroll_margin can be zero. */
13502 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
13503 || PT
> MATRIX_ROW_END_CHARPOS (row
)
13504 /* Line is completely visible last line in window
13505 and PT is to be set in the next line. */
13506 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
13507 && PT
== MATRIX_ROW_END_CHARPOS (row
)
13508 && !row
->ends_at_zv_p
13509 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
13512 else if (PT
< XFASTINT (w
->last_point
))
13514 /* Cursor has to be moved backward. Note that PT >=
13515 CHARPOS (startp) because of the outer if-statement. */
13516 while (!row
->mode_line_p
13517 && (MATRIX_ROW_START_CHARPOS (row
) > PT
13518 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13519 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
13520 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
13521 row
> w
->current_matrix
->rows
13522 && (row
-1)->ends_in_newline_from_string_p
))))
13523 && (row
->y
> top_scroll_margin
13524 || CHARPOS (startp
) == BEGV
))
13526 xassert (row
->enabled_p
);
13530 /* Consider the following case: Window starts at BEGV,
13531 there is invisible, intangible text at BEGV, so that
13532 display starts at some point START > BEGV. It can
13533 happen that we are called with PT somewhere between
13534 BEGV and START. Try to handle that case. */
13535 if (row
< w
->current_matrix
->rows
13536 || row
->mode_line_p
)
13538 row
= w
->current_matrix
->rows
;
13539 if (row
->mode_line_p
)
13543 /* Due to newlines in overlay strings, we may have to
13544 skip forward over overlay strings. */
13545 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13546 && MATRIX_ROW_END_CHARPOS (row
) == PT
13547 && !cursor_row_p (w
, row
))
13550 /* If within the scroll margin, scroll. */
13551 if (row
->y
< top_scroll_margin
13552 && CHARPOS (startp
) != BEGV
)
13557 /* Cursor did not move. So don't scroll even if cursor line
13558 is partially visible, as it was so before. */
13559 rc
= CURSOR_MOVEMENT_SUCCESS
;
13562 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
13563 || PT
> MATRIX_ROW_END_CHARPOS (row
))
13565 /* if PT is not in the glyph row, give up. */
13566 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13569 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13570 && !NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
13572 /* If rows are bidi-reordered and point moved, back up
13573 until we find a row that does not belong to a
13574 continuation line. This is because we must consider
13575 all rows of a continued line as candidates for the
13576 new cursor positioning, since row start and end
13577 positions change non-linearly with vertical position
13579 /* FIXME: Revisit this when glyph ``spilling'' in
13580 continuation lines' rows is implemented for
13581 bidi-reordered rows. */
13582 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
13584 xassert (row
->enabled_p
);
13586 /* If we hit the beginning of the displayed portion
13587 without finding the first row of a continued
13589 if (row
<= w
->current_matrix
->rows
)
13591 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13599 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13600 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
13601 && make_cursor_line_fully_visible_p
)
13603 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
13604 && !row
->ends_at_zv_p
13605 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
13606 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13607 else if (row
->height
> window_box_height (w
))
13609 /* If we end up in a partially visible line, let's
13610 make it fully visible, except when it's taller
13611 than the window, in which case we can't do much
13614 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13618 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13619 if (!cursor_row_fully_visible_p (w
, 0, 1))
13620 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13622 rc
= CURSOR_MOVEMENT_SUCCESS
;
13626 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13627 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13628 && !NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
13630 /* With bidi-reordered rows, there could be more than
13631 one candidate row whose start and end positions
13632 occlude point. We need to let set_cursor_from_row
13633 find the best candidate. */
13634 /* FIXME: Revisit this when glyph ``spilling'' in
13635 continuation lines' rows is implemented for
13636 bidi-reordered rows. */
13641 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
13642 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
13643 && cursor_row_p (w
, row
))
13644 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
13646 /* As soon as we've found the first suitable row
13647 whose ends_at_zv_p flag is set, we are done. */
13649 && MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
)
13651 rc
= CURSOR_MOVEMENT_SUCCESS
;
13656 while ((MATRIX_ROW_CONTINUATION_LINE_P (row
)
13657 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
13658 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13659 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
13660 /* If we didn't find any candidate rows, or exited the
13661 loop before all the candidates were examined, signal
13662 to the caller that this method failed. */
13663 if (rc
!= CURSOR_MOVEMENT_SUCCESS
13664 && (!rv
|| MATRIX_ROW_CONTINUATION_LINE_P (row
)))
13665 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13667 rc
= CURSOR_MOVEMENT_SUCCESS
;
13673 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
13675 rc
= CURSOR_MOVEMENT_SUCCESS
;
13680 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13681 && MATRIX_ROW_START_CHARPOS (row
) == PT
13682 && cursor_row_p (w
, row
));
13691 set_vertical_scroll_bar (struct window
*w
)
13693 int start
, end
, whole
;
13695 /* Calculate the start and end positions for the current window.
13696 At some point, it would be nice to choose between scrollbars
13697 which reflect the whole buffer size, with special markers
13698 indicating narrowing, and scrollbars which reflect only the
13701 Note that mini-buffers sometimes aren't displaying any text. */
13702 if (!MINI_WINDOW_P (w
)
13703 || (w
== XWINDOW (minibuf_window
)
13704 && NILP (echo_area_buffer
[0])))
13706 struct buffer
*buf
= XBUFFER (w
->buffer
);
13707 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
13708 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
13709 /* I don't think this is guaranteed to be right. For the
13710 moment, we'll pretend it is. */
13711 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
13715 if (whole
< (end
- start
))
13716 whole
= end
- start
;
13719 start
= end
= whole
= 0;
13721 /* Indicate what this scroll bar ought to be displaying now. */
13722 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13723 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13724 (w
, end
- start
, whole
, start
);
13728 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
13729 selected_window is redisplayed.
13731 We can return without actually redisplaying the window if
13732 fonts_changed_p is nonzero. In that case, redisplay_internal will
13736 redisplay_window (Lisp_Object window
, int just_this_one_p
)
13738 struct window
*w
= XWINDOW (window
);
13739 struct frame
*f
= XFRAME (w
->frame
);
13740 struct buffer
*buffer
= XBUFFER (w
->buffer
);
13741 struct buffer
*old
= current_buffer
;
13742 struct text_pos lpoint
, opoint
, startp
;
13743 int update_mode_line
;
13746 /* Record it now because it's overwritten. */
13747 int current_matrix_up_to_date_p
= 0;
13748 int used_current_matrix_p
= 0;
13749 /* This is less strict than current_matrix_up_to_date_p.
13750 It indictes that the buffer contents and narrowing are unchanged. */
13751 int buffer_unchanged_p
= 0;
13752 int temp_scroll_step
= 0;
13753 int count
= SPECPDL_INDEX ();
13755 int centering_position
= -1;
13756 int last_line_misfit
= 0;
13757 int beg_unchanged
, end_unchanged
;
13759 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13762 /* W must be a leaf window here. */
13763 xassert (!NILP (w
->buffer
));
13765 *w
->desired_matrix
->method
= 0;
13769 reconsider_clip_changes (w
, buffer
);
13771 /* Has the mode line to be updated? */
13772 update_mode_line
= (!NILP (w
->update_mode_line
)
13773 || update_mode_lines
13774 || buffer
->clip_changed
13775 || buffer
->prevent_redisplay_optimizations_p
);
13777 if (MINI_WINDOW_P (w
))
13779 if (w
== XWINDOW (echo_area_window
)
13780 && !NILP (echo_area_buffer
[0]))
13782 if (update_mode_line
)
13783 /* We may have to update a tty frame's menu bar or a
13784 tool-bar. Example `M-x C-h C-h C-g'. */
13785 goto finish_menu_bars
;
13787 /* We've already displayed the echo area glyphs in this window. */
13788 goto finish_scroll_bars
;
13790 else if ((w
!= XWINDOW (minibuf_window
)
13791 || minibuf_level
== 0)
13792 /* When buffer is nonempty, redisplay window normally. */
13793 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
13794 /* Quail displays non-mini buffers in minibuffer window.
13795 In that case, redisplay the window normally. */
13796 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
13798 /* W is a mini-buffer window, but it's not active, so clear
13800 int yb
= window_text_bottom_y (w
);
13801 struct glyph_row
*row
;
13804 for (y
= 0, row
= w
->desired_matrix
->rows
;
13806 y
+= row
->height
, ++row
)
13807 blank_row (w
, row
, y
);
13808 goto finish_scroll_bars
;
13811 clear_glyph_matrix (w
->desired_matrix
);
13814 /* Otherwise set up data on this window; select its buffer and point
13816 /* Really select the buffer, for the sake of buffer-local
13818 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13820 current_matrix_up_to_date_p
13821 = (!NILP (w
->window_end_valid
)
13822 && !current_buffer
->clip_changed
13823 && !current_buffer
->prevent_redisplay_optimizations_p
13824 && XFASTINT (w
->last_modified
) >= MODIFF
13825 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13827 /* Run the window-bottom-change-functions
13828 if it is possible that the text on the screen has changed
13829 (either due to modification of the text, or any other reason). */
13830 if (!current_matrix_up_to_date_p
13831 && !NILP (Vwindow_text_change_functions
))
13833 safe_run_hooks (Qwindow_text_change_functions
);
13837 beg_unchanged
= BEG_UNCHANGED
;
13838 end_unchanged
= END_UNCHANGED
;
13840 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
13842 specbind (Qinhibit_point_motion_hooks
, Qt
);
13845 = (!NILP (w
->window_end_valid
)
13846 && !current_buffer
->clip_changed
13847 && XFASTINT (w
->last_modified
) >= MODIFF
13848 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13850 /* When windows_or_buffers_changed is non-zero, we can't rely on
13851 the window end being valid, so set it to nil there. */
13852 if (windows_or_buffers_changed
)
13854 /* If window starts on a continuation line, maybe adjust the
13855 window start in case the window's width changed. */
13856 if (XMARKER (w
->start
)->buffer
== current_buffer
)
13857 compute_window_start_on_continuation_line (w
);
13859 w
->window_end_valid
= Qnil
;
13862 /* Some sanity checks. */
13863 CHECK_WINDOW_END (w
);
13864 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
13866 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
13869 /* If %c is in mode line, update it if needed. */
13870 if (!NILP (w
->column_number_displayed
)
13871 /* This alternative quickly identifies a common case
13872 where no change is needed. */
13873 && !(PT
== XFASTINT (w
->last_point
)
13874 && XFASTINT (w
->last_modified
) >= MODIFF
13875 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
13876 && (XFASTINT (w
->column_number_displayed
)
13877 != (int) current_column ())) /* iftc */
13878 update_mode_line
= 1;
13880 /* Count number of windows showing the selected buffer. An indirect
13881 buffer counts as its base buffer. */
13882 if (!just_this_one_p
)
13884 struct buffer
*current_base
, *window_base
;
13885 current_base
= current_buffer
;
13886 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13887 if (current_base
->base_buffer
)
13888 current_base
= current_base
->base_buffer
;
13889 if (window_base
->base_buffer
)
13890 window_base
= window_base
->base_buffer
;
13891 if (current_base
== window_base
)
13895 /* Point refers normally to the selected window. For any other
13896 window, set up appropriate value. */
13897 if (!EQ (window
, selected_window
))
13899 int new_pt
= XMARKER (w
->pointm
)->charpos
;
13900 int new_pt_byte
= marker_byte_position (w
->pointm
);
13904 new_pt_byte
= BEGV_BYTE
;
13905 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
13907 else if (new_pt
> (ZV
- 1))
13910 new_pt_byte
= ZV_BYTE
;
13911 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
13914 /* We don't use SET_PT so that the point-motion hooks don't run. */
13915 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
13918 /* If any of the character widths specified in the display table
13919 have changed, invalidate the width run cache. It's true that
13920 this may be a bit late to catch such changes, but the rest of
13921 redisplay goes (non-fatally) haywire when the display table is
13922 changed, so why should we worry about doing any better? */
13923 if (current_buffer
->width_run_cache
)
13925 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
13927 if (! disptab_matches_widthtab (disptab
,
13928 XVECTOR (current_buffer
->width_table
)))
13930 invalidate_region_cache (current_buffer
,
13931 current_buffer
->width_run_cache
,
13933 recompute_width_table (current_buffer
, disptab
);
13937 /* If window-start is screwed up, choose a new one. */
13938 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
13941 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13943 /* If someone specified a new starting point but did not insist,
13944 check whether it can be used. */
13945 if (!NILP (w
->optional_new_start
)
13946 && CHARPOS (startp
) >= BEGV
13947 && CHARPOS (startp
) <= ZV
)
13949 w
->optional_new_start
= Qnil
;
13950 start_display (&it
, w
, startp
);
13951 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
13952 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13953 if (IT_CHARPOS (it
) == PT
)
13954 w
->force_start
= Qt
;
13955 /* IT may overshoot PT if text at PT is invisible. */
13956 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
13957 w
->force_start
= Qt
;
13962 /* Handle case where place to start displaying has been specified,
13963 unless the specified location is outside the accessible range. */
13964 if (!NILP (w
->force_start
)
13965 || w
->frozen_window_start_p
)
13967 /* We set this later on if we have to adjust point. */
13970 w
->force_start
= Qnil
;
13972 w
->window_end_valid
= Qnil
;
13974 /* Forget any recorded base line for line number display. */
13975 if (!buffer_unchanged_p
)
13976 w
->base_line_number
= Qnil
;
13978 /* Redisplay the mode line. Select the buffer properly for that.
13979 Also, run the hook window-scroll-functions
13980 because we have scrolled. */
13981 /* Note, we do this after clearing force_start because
13982 if there's an error, it is better to forget about force_start
13983 than to get into an infinite loop calling the hook functions
13984 and having them get more errors. */
13985 if (!update_mode_line
13986 || ! NILP (Vwindow_scroll_functions
))
13988 update_mode_line
= 1;
13989 w
->update_mode_line
= Qt
;
13990 startp
= run_window_scroll_functions (window
, startp
);
13993 w
->last_modified
= make_number (0);
13994 w
->last_overlay_modified
= make_number (0);
13995 if (CHARPOS (startp
) < BEGV
)
13996 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
13997 else if (CHARPOS (startp
) > ZV
)
13998 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
14000 /* Redisplay, then check if cursor has been set during the
14001 redisplay. Give up if new fonts were loaded. */
14002 /* We used to issue a CHECK_MARGINS argument to try_window here,
14003 but this causes scrolling to fail when point begins inside
14004 the scroll margin (bug#148) -- cyd */
14005 if (!try_window (window
, startp
, 0))
14007 w
->force_start
= Qt
;
14008 clear_glyph_matrix (w
->desired_matrix
);
14009 goto need_larger_matrices
;
14012 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
14014 /* If point does not appear, try to move point so it does
14015 appear. The desired matrix has been built above, so we
14016 can use it here. */
14017 new_vpos
= window_box_height (w
) / 2;
14020 if (!cursor_row_fully_visible_p (w
, 0, 0))
14022 /* Point does appear, but on a line partly visible at end of window.
14023 Move it back to a fully-visible line. */
14024 new_vpos
= window_box_height (w
);
14027 /* If we need to move point for either of the above reasons,
14028 now actually do it. */
14031 struct glyph_row
*row
;
14033 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
14034 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
14037 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
14038 MATRIX_ROW_START_BYTEPOS (row
));
14040 if (w
!= XWINDOW (selected_window
))
14041 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
14042 else if (current_buffer
== old
)
14043 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
14045 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
14047 /* If we are highlighting the region, then we just changed
14048 the region, so redisplay to show it. */
14049 if (!NILP (Vtransient_mark_mode
)
14050 && !NILP (current_buffer
->mark_active
))
14052 clear_glyph_matrix (w
->desired_matrix
);
14053 if (!try_window (window
, startp
, 0))
14054 goto need_larger_matrices
;
14059 debug_method_add (w
, "forced window start");
14064 /* Handle case where text has not changed, only point, and it has
14065 not moved off the frame, and we are not retrying after hscroll.
14066 (current_matrix_up_to_date_p is nonzero when retrying.) */
14067 if (current_matrix_up_to_date_p
14068 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
14069 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
14073 case CURSOR_MOVEMENT_SUCCESS
:
14074 used_current_matrix_p
= 1;
14077 case CURSOR_MOVEMENT_MUST_SCROLL
:
14078 goto try_to_scroll
;
14084 /* If current starting point was originally the beginning of a line
14085 but no longer is, find a new starting point. */
14086 else if (!NILP (w
->start_at_line_beg
)
14087 && !(CHARPOS (startp
) <= BEGV
14088 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
14091 debug_method_add (w
, "recenter 1");
14096 /* Try scrolling with try_window_id. Value is > 0 if update has
14097 been done, it is -1 if we know that the same window start will
14098 not work. It is 0 if unsuccessful for some other reason. */
14099 else if ((tem
= try_window_id (w
)) != 0)
14102 debug_method_add (w
, "try_window_id %d", tem
);
14105 if (fonts_changed_p
)
14106 goto need_larger_matrices
;
14110 /* Otherwise try_window_id has returned -1 which means that we
14111 don't want the alternative below this comment to execute. */
14113 else if (CHARPOS (startp
) >= BEGV
14114 && CHARPOS (startp
) <= ZV
14115 && PT
>= CHARPOS (startp
)
14116 && (CHARPOS (startp
) < ZV
14117 /* Avoid starting at end of buffer. */
14118 || CHARPOS (startp
) == BEGV
14119 || (XFASTINT (w
->last_modified
) >= MODIFF
14120 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
14123 /* If first window line is a continuation line, and window start
14124 is inside the modified region, but the first change is before
14125 current window start, we must select a new window start.
14127 However, if this is the result of a down-mouse event (e.g. by
14128 extending the mouse-drag-overlay), we don't want to select a
14129 new window start, since that would change the position under
14130 the mouse, resulting in an unwanted mouse-movement rather
14131 than a simple mouse-click. */
14132 if (NILP (w
->start_at_line_beg
)
14133 && NILP (do_mouse_tracking
)
14134 && CHARPOS (startp
) > BEGV
14135 && CHARPOS (startp
) > BEG
+ beg_unchanged
14136 && CHARPOS (startp
) <= Z
- end_unchanged
14137 /* Even if w->start_at_line_beg is nil, a new window may
14138 start at a line_beg, since that's how set_buffer_window
14139 sets it. So, we need to check the return value of
14140 compute_window_start_on_continuation_line. (See also
14142 && XMARKER (w
->start
)->buffer
== current_buffer
14143 && compute_window_start_on_continuation_line (w
))
14145 w
->force_start
= Qt
;
14146 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14151 debug_method_add (w
, "same window start");
14154 /* Try to redisplay starting at same place as before.
14155 If point has not moved off frame, accept the results. */
14156 if (!current_matrix_up_to_date_p
14157 /* Don't use try_window_reusing_current_matrix in this case
14158 because a window scroll function can have changed the
14160 || !NILP (Vwindow_scroll_functions
)
14161 || MINI_WINDOW_P (w
)
14162 || !(used_current_matrix_p
14163 = try_window_reusing_current_matrix (w
)))
14165 IF_DEBUG (debug_method_add (w
, "1"));
14166 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
14167 /* -1 means we need to scroll.
14168 0 means we need new matrices, but fonts_changed_p
14169 is set in that case, so we will detect it below. */
14170 goto try_to_scroll
;
14173 if (fonts_changed_p
)
14174 goto need_larger_matrices
;
14176 if (w
->cursor
.vpos
>= 0)
14178 if (!just_this_one_p
14179 || current_buffer
->clip_changed
14180 || BEG_UNCHANGED
< CHARPOS (startp
))
14181 /* Forget any recorded base line for line number display. */
14182 w
->base_line_number
= Qnil
;
14184 if (!cursor_row_fully_visible_p (w
, 1, 0))
14186 clear_glyph_matrix (w
->desired_matrix
);
14187 last_line_misfit
= 1;
14189 /* Drop through and scroll. */
14194 clear_glyph_matrix (w
->desired_matrix
);
14199 w
->last_modified
= make_number (0);
14200 w
->last_overlay_modified
= make_number (0);
14202 /* Redisplay the mode line. Select the buffer properly for that. */
14203 if (!update_mode_line
)
14205 update_mode_line
= 1;
14206 w
->update_mode_line
= Qt
;
14209 /* Try to scroll by specified few lines. */
14210 if ((scroll_conservatively
14212 || temp_scroll_step
14213 || NUMBERP (current_buffer
->scroll_up_aggressively
)
14214 || NUMBERP (current_buffer
->scroll_down_aggressively
))
14215 && !current_buffer
->clip_changed
14216 && CHARPOS (startp
) >= BEGV
14217 && CHARPOS (startp
) <= ZV
)
14219 /* The function returns -1 if new fonts were loaded, 1 if
14220 successful, 0 if not successful. */
14221 int rc
= try_scrolling (window
, just_this_one_p
,
14222 scroll_conservatively
,
14224 temp_scroll_step
, last_line_misfit
);
14227 case SCROLLING_SUCCESS
:
14230 case SCROLLING_NEED_LARGER_MATRICES
:
14231 goto need_larger_matrices
;
14233 case SCROLLING_FAILED
:
14241 /* Finally, just choose place to start which centers point */
14244 if (centering_position
< 0)
14245 centering_position
= window_box_height (w
) / 2;
14248 debug_method_add (w
, "recenter");
14251 /* w->vscroll = 0; */
14253 /* Forget any previously recorded base line for line number display. */
14254 if (!buffer_unchanged_p
)
14255 w
->base_line_number
= Qnil
;
14257 /* Move backward half the height of the window. */
14258 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14259 it
.current_y
= it
.last_visible_y
;
14260 move_it_vertically_backward (&it
, centering_position
);
14261 xassert (IT_CHARPOS (it
) >= BEGV
);
14263 /* The function move_it_vertically_backward may move over more
14264 than the specified y-distance. If it->w is small, e.g. a
14265 mini-buffer window, we may end up in front of the window's
14266 display area. Start displaying at the start of the line
14267 containing PT in this case. */
14268 if (it
.current_y
<= 0)
14270 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14271 move_it_vertically_backward (&it
, 0);
14275 it
.current_x
= it
.hpos
= 0;
14277 /* Set startp here explicitly in case that helps avoid an infinite loop
14278 in case the window-scroll-functions functions get errors. */
14279 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
14281 /* Run scroll hooks. */
14282 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
14284 /* Redisplay the window. */
14285 if (!current_matrix_up_to_date_p
14286 || windows_or_buffers_changed
14287 || cursor_type_changed
14288 /* Don't use try_window_reusing_current_matrix in this case
14289 because it can have changed the buffer. */
14290 || !NILP (Vwindow_scroll_functions
)
14291 || !just_this_one_p
14292 || MINI_WINDOW_P (w
)
14293 || !(used_current_matrix_p
14294 = try_window_reusing_current_matrix (w
)))
14295 try_window (window
, startp
, 0);
14297 /* If new fonts have been loaded (due to fontsets), give up. We
14298 have to start a new redisplay since we need to re-adjust glyph
14300 if (fonts_changed_p
)
14301 goto need_larger_matrices
;
14303 /* If cursor did not appear assume that the middle of the window is
14304 in the first line of the window. Do it again with the next line.
14305 (Imagine a window of height 100, displaying two lines of height
14306 60. Moving back 50 from it->last_visible_y will end in the first
14308 if (w
->cursor
.vpos
< 0)
14310 if (!NILP (w
->window_end_valid
)
14311 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
14313 clear_glyph_matrix (w
->desired_matrix
);
14314 move_it_by_lines (&it
, 1, 0);
14315 try_window (window
, it
.current
.pos
, 0);
14317 else if (PT
< IT_CHARPOS (it
))
14319 clear_glyph_matrix (w
->desired_matrix
);
14320 move_it_by_lines (&it
, -1, 0);
14321 try_window (window
, it
.current
.pos
, 0);
14325 /* Not much we can do about it. */
14329 /* Consider the following case: Window starts at BEGV, there is
14330 invisible, intangible text at BEGV, so that display starts at
14331 some point START > BEGV. It can happen that we are called with
14332 PT somewhere between BEGV and START. Try to handle that case. */
14333 if (w
->cursor
.vpos
< 0)
14335 struct glyph_row
*row
= w
->current_matrix
->rows
;
14336 if (row
->mode_line_p
)
14338 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14341 if (!cursor_row_fully_visible_p (w
, 0, 0))
14343 /* If vscroll is enabled, disable it and try again. */
14347 clear_glyph_matrix (w
->desired_matrix
);
14351 /* If centering point failed to make the whole line visible,
14352 put point at the top instead. That has to make the whole line
14353 visible, if it can be done. */
14354 if (centering_position
== 0)
14357 clear_glyph_matrix (w
->desired_matrix
);
14358 centering_position
= 0;
14364 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14365 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
14366 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
14369 /* Display the mode line, if we must. */
14370 if ((update_mode_line
14371 /* If window not full width, must redo its mode line
14372 if (a) the window to its side is being redone and
14373 (b) we do a frame-based redisplay. This is a consequence
14374 of how inverted lines are drawn in frame-based redisplay. */
14375 || (!just_this_one_p
14376 && !FRAME_WINDOW_P (f
)
14377 && !WINDOW_FULL_WIDTH_P (w
))
14378 /* Line number to display. */
14379 || INTEGERP (w
->base_line_pos
)
14380 /* Column number is displayed and different from the one displayed. */
14381 || (!NILP (w
->column_number_displayed
)
14382 && (XFASTINT (w
->column_number_displayed
)
14383 != (int) current_column ()))) /* iftc */
14384 /* This means that the window has a mode line. */
14385 && (WINDOW_WANTS_MODELINE_P (w
)
14386 || WINDOW_WANTS_HEADER_LINE_P (w
)))
14388 display_mode_lines (w
);
14390 /* If mode line height has changed, arrange for a thorough
14391 immediate redisplay using the correct mode line height. */
14392 if (WINDOW_WANTS_MODELINE_P (w
)
14393 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
14395 fonts_changed_p
= 1;
14396 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
14397 = DESIRED_MODE_LINE_HEIGHT (w
);
14400 /* If header line height has changed, arrange for a thorough
14401 immediate redisplay using the correct header line height. */
14402 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14403 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
14405 fonts_changed_p
= 1;
14406 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
14407 = DESIRED_HEADER_LINE_HEIGHT (w
);
14410 if (fonts_changed_p
)
14411 goto need_larger_matrices
;
14414 if (!line_number_displayed
14415 && !BUFFERP (w
->base_line_pos
))
14417 w
->base_line_pos
= Qnil
;
14418 w
->base_line_number
= Qnil
;
14423 /* When we reach a frame's selected window, redo the frame's menu bar. */
14424 if (update_mode_line
14425 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
14427 int redisplay_menu_p
= 0;
14428 int redisplay_tool_bar_p
= 0;
14430 if (FRAME_WINDOW_P (f
))
14432 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
14433 || defined (HAVE_NS) || defined (USE_GTK)
14434 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
14436 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14440 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14442 if (redisplay_menu_p
)
14443 display_menu_bar (w
);
14445 #ifdef HAVE_WINDOW_SYSTEM
14446 if (FRAME_WINDOW_P (f
))
14448 #if defined (USE_GTK) || defined (HAVE_NS)
14449 redisplay_tool_bar_p
= FRAME_EXTERNAL_TOOL_BAR (f
);
14451 redisplay_tool_bar_p
= WINDOWP (f
->tool_bar_window
)
14452 && (FRAME_TOOL_BAR_LINES (f
) > 0
14453 || !NILP (Vauto_resize_tool_bars
));
14456 if (redisplay_tool_bar_p
&& redisplay_tool_bar (f
))
14458 ignore_mouse_drag_p
= 1;
14464 #ifdef HAVE_WINDOW_SYSTEM
14465 if (FRAME_WINDOW_P (f
)
14466 && update_window_fringes (w
, (just_this_one_p
14467 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
14468 || w
->pseudo_window_p
)))
14472 if (draw_window_fringes (w
, 1))
14473 x_draw_vertical_border (w
);
14477 #endif /* HAVE_WINDOW_SYSTEM */
14479 /* We go to this label, with fonts_changed_p nonzero,
14480 if it is necessary to try again using larger glyph matrices.
14481 We have to redeem the scroll bar even in this case,
14482 because the loop in redisplay_internal expects that. */
14483 need_larger_matrices
:
14485 finish_scroll_bars
:
14487 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
14489 /* Set the thumb's position and size. */
14490 set_vertical_scroll_bar (w
);
14492 /* Note that we actually used the scroll bar attached to this
14493 window, so it shouldn't be deleted at the end of redisplay. */
14494 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
14495 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
14498 /* Restore current_buffer and value of point in it. The window
14499 update may have changed the buffer, so first make sure `opoint'
14500 is still valid (Bug#6177). */
14501 if (CHARPOS (opoint
) < BEGV
)
14502 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
14503 else if (CHARPOS (opoint
) > ZV
)
14504 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
14506 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
14508 set_buffer_internal_1 (old
);
14509 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
14510 shorter. This can be caused by log truncation in *Messages*. */
14511 if (CHARPOS (lpoint
) <= ZV
)
14512 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
14514 unbind_to (count
, Qnil
);
14518 /* Build the complete desired matrix of WINDOW with a window start
14519 buffer position POS.
14521 Value is 1 if successful. It is zero if fonts were loaded during
14522 redisplay which makes re-adjusting glyph matrices necessary, and -1
14523 if point would appear in the scroll margins.
14524 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
14525 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
14529 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
14531 struct window
*w
= XWINDOW (window
);
14533 struct glyph_row
*last_text_row
= NULL
;
14534 struct frame
*f
= XFRAME (w
->frame
);
14536 /* Make POS the new window start. */
14537 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
14539 /* Mark cursor position as unknown. No overlay arrow seen. */
14540 w
->cursor
.vpos
= -1;
14541 overlay_arrow_seen
= 0;
14543 /* Initialize iterator and info to start at POS. */
14544 start_display (&it
, w
, pos
);
14546 /* Display all lines of W. */
14547 while (it
.current_y
< it
.last_visible_y
)
14549 if (display_line (&it
))
14550 last_text_row
= it
.glyph_row
- 1;
14551 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
14555 /* Don't let the cursor end in the scroll margins. */
14556 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
14557 && !MINI_WINDOW_P (w
))
14559 int this_scroll_margin
;
14561 if (scroll_margin
> 0)
14563 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14564 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14567 this_scroll_margin
= 0;
14569 if ((w
->cursor
.y
>= 0 /* not vscrolled */
14570 && w
->cursor
.y
< this_scroll_margin
14571 && CHARPOS (pos
) > BEGV
14572 && IT_CHARPOS (it
) < ZV
)
14573 /* rms: considering make_cursor_line_fully_visible_p here
14574 seems to give wrong results. We don't want to recenter
14575 when the last line is partly visible, we want to allow
14576 that case to be handled in the usual way. */
14577 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
14579 w
->cursor
.vpos
= -1;
14580 clear_glyph_matrix (w
->desired_matrix
);
14585 /* If bottom moved off end of frame, change mode line percentage. */
14586 if (XFASTINT (w
->window_end_pos
) <= 0
14587 && Z
!= IT_CHARPOS (it
))
14588 w
->update_mode_line
= Qt
;
14590 /* Set window_end_pos to the offset of the last character displayed
14591 on the window from the end of current_buffer. Set
14592 window_end_vpos to its row number. */
14595 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
14596 w
->window_end_bytepos
14597 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14599 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14601 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14602 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
14603 ->displays_text_p
);
14607 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14608 w
->window_end_pos
= make_number (Z
- ZV
);
14609 w
->window_end_vpos
= make_number (0);
14612 /* But that is not valid info until redisplay finishes. */
14613 w
->window_end_valid
= Qnil
;
14619 /************************************************************************
14620 Window redisplay reusing current matrix when buffer has not changed
14621 ************************************************************************/
14623 /* Try redisplay of window W showing an unchanged buffer with a
14624 different window start than the last time it was displayed by
14625 reusing its current matrix. Value is non-zero if successful.
14626 W->start is the new window start. */
14629 try_window_reusing_current_matrix (struct window
*w
)
14631 struct frame
*f
= XFRAME (w
->frame
);
14632 struct glyph_row
*row
, *bottom_row
;
14635 struct text_pos start
, new_start
;
14636 int nrows_scrolled
, i
;
14637 struct glyph_row
*last_text_row
;
14638 struct glyph_row
*last_reused_text_row
;
14639 struct glyph_row
*start_row
;
14640 int start_vpos
, min_y
, max_y
;
14643 if (inhibit_try_window_reusing
)
14647 if (/* This function doesn't handle terminal frames. */
14648 !FRAME_WINDOW_P (f
)
14649 /* Don't try to reuse the display if windows have been split
14651 || windows_or_buffers_changed
14652 || cursor_type_changed
)
14655 /* Can't do this if region may have changed. */
14656 if ((!NILP (Vtransient_mark_mode
)
14657 && !NILP (current_buffer
->mark_active
))
14658 || !NILP (w
->region_showing
)
14659 || !NILP (Vshow_trailing_whitespace
))
14662 /* If top-line visibility has changed, give up. */
14663 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14664 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
14667 /* Give up if old or new display is scrolled vertically. We could
14668 make this function handle this, but right now it doesn't. */
14669 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14670 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
14673 /* The variable new_start now holds the new window start. The old
14674 start `start' can be determined from the current matrix. */
14675 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
14676 start
= start_row
->minpos
;
14677 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14679 /* Clear the desired matrix for the display below. */
14680 clear_glyph_matrix (w
->desired_matrix
);
14682 if (CHARPOS (new_start
) <= CHARPOS (start
))
14686 /* Don't use this method if the display starts with an ellipsis
14687 displayed for invisible text. It's not easy to handle that case
14688 below, and it's certainly not worth the effort since this is
14689 not a frequent case. */
14690 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
14693 IF_DEBUG (debug_method_add (w
, "twu1"));
14695 /* Display up to a row that can be reused. The variable
14696 last_text_row is set to the last row displayed that displays
14697 text. Note that it.vpos == 0 if or if not there is a
14698 header-line; it's not the same as the MATRIX_ROW_VPOS! */
14699 start_display (&it
, w
, new_start
);
14700 first_row_y
= it
.current_y
;
14701 w
->cursor
.vpos
= -1;
14702 last_text_row
= last_reused_text_row
= NULL
;
14704 while (it
.current_y
< it
.last_visible_y
14705 && !fonts_changed_p
)
14707 /* If we have reached into the characters in the START row,
14708 that means the line boundaries have changed. So we
14709 can't start copying with the row START. Maybe it will
14710 work to start copying with the following row. */
14711 while (IT_CHARPOS (it
) > CHARPOS (start
))
14713 /* Advance to the next row as the "start". */
14715 start
= start_row
->minpos
;
14716 /* If there are no more rows to try, or just one, give up. */
14717 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
14718 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
14719 || CHARPOS (start
) == ZV
)
14721 clear_glyph_matrix (w
->desired_matrix
);
14725 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14727 /* If we have reached alignment,
14728 we can copy the rest of the rows. */
14729 if (IT_CHARPOS (it
) == CHARPOS (start
))
14732 if (display_line (&it
))
14733 last_text_row
= it
.glyph_row
- 1;
14736 /* A value of current_y < last_visible_y means that we stopped
14737 at the previous window start, which in turn means that we
14738 have at least one reusable row. */
14739 if (it
.current_y
< it
.last_visible_y
)
14741 /* IT.vpos always starts from 0; it counts text lines. */
14742 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
14744 /* Find PT if not already found in the lines displayed. */
14745 if (w
->cursor
.vpos
< 0)
14747 int dy
= it
.current_y
- start_row
->y
;
14749 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14750 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
14752 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
14753 dy
, nrows_scrolled
);
14756 clear_glyph_matrix (w
->desired_matrix
);
14761 /* Scroll the display. Do it before the current matrix is
14762 changed. The problem here is that update has not yet
14763 run, i.e. part of the current matrix is not up to date.
14764 scroll_run_hook will clear the cursor, and use the
14765 current matrix to get the height of the row the cursor is
14767 run
.current_y
= start_row
->y
;
14768 run
.desired_y
= it
.current_y
;
14769 run
.height
= it
.last_visible_y
- it
.current_y
;
14771 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
14774 FRAME_RIF (f
)->update_window_begin_hook (w
);
14775 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14776 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14777 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14781 /* Shift current matrix down by nrows_scrolled lines. */
14782 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14783 rotate_matrix (w
->current_matrix
,
14785 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14788 /* Disable lines that must be updated. */
14789 for (i
= 0; i
< nrows_scrolled
; ++i
)
14790 (start_row
+ i
)->enabled_p
= 0;
14792 /* Re-compute Y positions. */
14793 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14794 max_y
= it
.last_visible_y
;
14795 for (row
= start_row
+ nrows_scrolled
;
14799 row
->y
= it
.current_y
;
14800 row
->visible_height
= row
->height
;
14802 if (row
->y
< min_y
)
14803 row
->visible_height
-= min_y
- row
->y
;
14804 if (row
->y
+ row
->height
> max_y
)
14805 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14806 row
->redraw_fringe_bitmaps_p
= 1;
14808 it
.current_y
+= row
->height
;
14810 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14811 last_reused_text_row
= row
;
14812 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
14816 /* Disable lines in the current matrix which are now
14817 below the window. */
14818 for (++row
; row
< bottom_row
; ++row
)
14819 row
->enabled_p
= row
->mode_line_p
= 0;
14822 /* Update window_end_pos etc.; last_reused_text_row is the last
14823 reused row from the current matrix containing text, if any.
14824 The value of last_text_row is the last displayed line
14825 containing text. */
14826 if (last_reused_text_row
)
14828 w
->window_end_bytepos
14829 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
14831 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
14833 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
14834 w
->current_matrix
));
14836 else if (last_text_row
)
14838 w
->window_end_bytepos
14839 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14841 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14843 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14847 /* This window must be completely empty. */
14848 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14849 w
->window_end_pos
= make_number (Z
- ZV
);
14850 w
->window_end_vpos
= make_number (0);
14852 w
->window_end_valid
= Qnil
;
14854 /* Update hint: don't try scrolling again in update_window. */
14855 w
->desired_matrix
->no_scrolling_p
= 1;
14858 debug_method_add (w
, "try_window_reusing_current_matrix 1");
14862 else if (CHARPOS (new_start
) > CHARPOS (start
))
14864 struct glyph_row
*pt_row
, *row
;
14865 struct glyph_row
*first_reusable_row
;
14866 struct glyph_row
*first_row_to_display
;
14868 int yb
= window_text_bottom_y (w
);
14870 /* Find the row starting at new_start, if there is one. Don't
14871 reuse a partially visible line at the end. */
14872 first_reusable_row
= start_row
;
14873 while (first_reusable_row
->enabled_p
14874 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
14875 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14876 < CHARPOS (new_start
)))
14877 ++first_reusable_row
;
14879 /* Give up if there is no row to reuse. */
14880 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
14881 || !first_reusable_row
->enabled_p
14882 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14883 != CHARPOS (new_start
)))
14886 /* We can reuse fully visible rows beginning with
14887 first_reusable_row to the end of the window. Set
14888 first_row_to_display to the first row that cannot be reused.
14889 Set pt_row to the row containing point, if there is any. */
14891 for (first_row_to_display
= first_reusable_row
;
14892 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
14893 ++first_row_to_display
)
14895 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
14896 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
14897 pt_row
= first_row_to_display
;
14900 /* Start displaying at the start of first_row_to_display. */
14901 xassert (first_row_to_display
->y
< yb
);
14902 init_to_row_start (&it
, w
, first_row_to_display
);
14904 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
14906 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
14908 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
14909 + WINDOW_HEADER_LINE_HEIGHT (w
));
14911 /* Display lines beginning with first_row_to_display in the
14912 desired matrix. Set last_text_row to the last row displayed
14913 that displays text. */
14914 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
14915 if (pt_row
== NULL
)
14916 w
->cursor
.vpos
= -1;
14917 last_text_row
= NULL
;
14918 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
14919 if (display_line (&it
))
14920 last_text_row
= it
.glyph_row
- 1;
14922 /* If point is in a reused row, adjust y and vpos of the cursor
14926 w
->cursor
.vpos
-= nrows_scrolled
;
14927 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
14930 /* Give up if point isn't in a row displayed or reused. (This
14931 also handles the case where w->cursor.vpos < nrows_scrolled
14932 after the calls to display_line, which can happen with scroll
14933 margins. See bug#1295.) */
14934 if (w
->cursor
.vpos
< 0)
14936 clear_glyph_matrix (w
->desired_matrix
);
14940 /* Scroll the display. */
14941 run
.current_y
= first_reusable_row
->y
;
14942 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14943 run
.height
= it
.last_visible_y
- run
.current_y
;
14944 dy
= run
.current_y
- run
.desired_y
;
14949 FRAME_RIF (f
)->update_window_begin_hook (w
);
14950 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14951 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14952 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14956 /* Adjust Y positions of reused rows. */
14957 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14958 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14959 max_y
= it
.last_visible_y
;
14960 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
14963 row
->visible_height
= row
->height
;
14964 if (row
->y
< min_y
)
14965 row
->visible_height
-= min_y
- row
->y
;
14966 if (row
->y
+ row
->height
> max_y
)
14967 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14968 row
->redraw_fringe_bitmaps_p
= 1;
14971 /* Scroll the current matrix. */
14972 xassert (nrows_scrolled
> 0);
14973 rotate_matrix (w
->current_matrix
,
14975 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14978 /* Disable rows not reused. */
14979 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
14980 row
->enabled_p
= 0;
14982 /* Point may have moved to a different line, so we cannot assume that
14983 the previous cursor position is valid; locate the correct row. */
14986 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
14987 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
14991 w
->cursor
.y
= row
->y
;
14993 if (row
< bottom_row
)
14995 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
14996 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
14998 /* Can't use this optimization with bidi-reordered glyph
14999 rows, unless cursor is already at point. */
15000 if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
15002 if (!(w
->cursor
.hpos
>= 0
15003 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
15004 && BUFFERP (glyph
->object
)
15005 && glyph
->charpos
== PT
))
15010 && (!BUFFERP (glyph
->object
)
15011 || glyph
->charpos
< PT
);
15015 w
->cursor
.x
+= glyph
->pixel_width
;
15020 /* Adjust window end. A null value of last_text_row means that
15021 the window end is in reused rows which in turn means that
15022 only its vpos can have changed. */
15025 w
->window_end_bytepos
15026 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15028 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15030 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15035 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
15038 w
->window_end_valid
= Qnil
;
15039 w
->desired_matrix
->no_scrolling_p
= 1;
15042 debug_method_add (w
, "try_window_reusing_current_matrix 2");
15052 /************************************************************************
15053 Window redisplay reusing current matrix when buffer has changed
15054 ************************************************************************/
15056 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
15057 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
15059 static struct glyph_row
*
15060 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
15061 struct glyph_row
*);
15064 /* Return the last row in MATRIX displaying text. If row START is
15065 non-null, start searching with that row. IT gives the dimensions
15066 of the display. Value is null if matrix is empty; otherwise it is
15067 a pointer to the row found. */
15069 static struct glyph_row
*
15070 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
15071 struct glyph_row
*start
)
15073 struct glyph_row
*row
, *row_found
;
15075 /* Set row_found to the last row in IT->w's current matrix
15076 displaying text. The loop looks funny but think of partially
15079 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
15080 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15082 xassert (row
->enabled_p
);
15084 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
15093 /* Return the last row in the current matrix of W that is not affected
15094 by changes at the start of current_buffer that occurred since W's
15095 current matrix was built. Value is null if no such row exists.
15097 BEG_UNCHANGED us the number of characters unchanged at the start of
15098 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
15099 first changed character in current_buffer. Characters at positions <
15100 BEG + BEG_UNCHANGED are at the same buffer positions as they were
15101 when the current matrix was built. */
15103 static struct glyph_row
*
15104 find_last_unchanged_at_beg_row (struct window
*w
)
15106 int first_changed_pos
= BEG
+ BEG_UNCHANGED
;
15107 struct glyph_row
*row
;
15108 struct glyph_row
*row_found
= NULL
;
15109 int yb
= window_text_bottom_y (w
);
15111 /* Find the last row displaying unchanged text. */
15112 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15113 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15114 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
15117 if (/* If row ends before first_changed_pos, it is unchanged,
15118 except in some case. */
15119 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
15120 /* When row ends in ZV and we write at ZV it is not
15122 && !row
->ends_at_zv_p
15123 /* When first_changed_pos is the end of a continued line,
15124 row is not unchanged because it may be no longer
15126 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
15127 && (row
->continued_p
15128 || row
->exact_window_width_line_p
)))
15131 /* Stop if last visible row. */
15132 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
15140 /* Find the first glyph row in the current matrix of W that is not
15141 affected by changes at the end of current_buffer since the
15142 time W's current matrix was built.
15144 Return in *DELTA the number of chars by which buffer positions in
15145 unchanged text at the end of current_buffer must be adjusted.
15147 Return in *DELTA_BYTES the corresponding number of bytes.
15149 Value is null if no such row exists, i.e. all rows are affected by
15152 static struct glyph_row
*
15153 find_first_unchanged_at_end_row (struct window
*w
, int *delta
, int *delta_bytes
)
15155 struct glyph_row
*row
;
15156 struct glyph_row
*row_found
= NULL
;
15158 *delta
= *delta_bytes
= 0;
15160 /* Display must not have been paused, otherwise the current matrix
15161 is not up to date. */
15162 eassert (!NILP (w
->window_end_valid
));
15164 /* A value of window_end_pos >= END_UNCHANGED means that the window
15165 end is in the range of changed text. If so, there is no
15166 unchanged row at the end of W's current matrix. */
15167 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
15170 /* Set row to the last row in W's current matrix displaying text. */
15171 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15173 /* If matrix is entirely empty, no unchanged row exists. */
15174 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15176 /* The value of row is the last glyph row in the matrix having a
15177 meaningful buffer position in it. The end position of row
15178 corresponds to window_end_pos. This allows us to translate
15179 buffer positions in the current matrix to current buffer
15180 positions for characters not in changed text. */
15181 int Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15182 int Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15183 int last_unchanged_pos
, last_unchanged_pos_old
;
15184 struct glyph_row
*first_text_row
15185 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15187 *delta
= Z
- Z_old
;
15188 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15190 /* Set last_unchanged_pos to the buffer position of the last
15191 character in the buffer that has not been changed. Z is the
15192 index + 1 of the last character in current_buffer, i.e. by
15193 subtracting END_UNCHANGED we get the index of the last
15194 unchanged character, and we have to add BEG to get its buffer
15196 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
15197 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
15199 /* Search backward from ROW for a row displaying a line that
15200 starts at a minimum position >= last_unchanged_pos_old. */
15201 for (; row
> first_text_row
; --row
)
15203 /* This used to abort, but it can happen.
15204 It is ok to just stop the search instead here. KFS. */
15205 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15208 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
15213 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
15219 /* Make sure that glyph rows in the current matrix of window W
15220 reference the same glyph memory as corresponding rows in the
15221 frame's frame matrix. This function is called after scrolling W's
15222 current matrix on a terminal frame in try_window_id and
15223 try_window_reusing_current_matrix. */
15226 sync_frame_with_window_matrix_rows (struct window
*w
)
15228 struct frame
*f
= XFRAME (w
->frame
);
15229 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
15231 /* Preconditions: W must be a leaf window and full-width. Its frame
15232 must have a frame matrix. */
15233 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
15234 xassert (WINDOW_FULL_WIDTH_P (w
));
15235 xassert (!FRAME_WINDOW_P (f
));
15237 /* If W is a full-width window, glyph pointers in W's current matrix
15238 have, by definition, to be the same as glyph pointers in the
15239 corresponding frame matrix. Note that frame matrices have no
15240 marginal areas (see build_frame_matrix). */
15241 window_row
= w
->current_matrix
->rows
;
15242 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
15243 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
15244 while (window_row
< window_row_end
)
15246 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
15247 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
15249 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
15250 frame_row
->glyphs
[TEXT_AREA
] = start
;
15251 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
15252 frame_row
->glyphs
[LAST_AREA
] = end
;
15254 /* Disable frame rows whose corresponding window rows have
15255 been disabled in try_window_id. */
15256 if (!window_row
->enabled_p
)
15257 frame_row
->enabled_p
= 0;
15259 ++window_row
, ++frame_row
;
15264 /* Find the glyph row in window W containing CHARPOS. Consider all
15265 rows between START and END (not inclusive). END null means search
15266 all rows to the end of the display area of W. Value is the row
15267 containing CHARPOS or null. */
15270 row_containing_pos (struct window
*w
, int charpos
, struct glyph_row
*start
,
15271 struct glyph_row
*end
, int dy
)
15273 struct glyph_row
*row
= start
;
15274 struct glyph_row
*best_row
= NULL
;
15275 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
15278 /* If we happen to start on a header-line, skip that. */
15279 if (row
->mode_line_p
)
15282 if ((end
&& row
>= end
) || !row
->enabled_p
)
15285 last_y
= window_text_bottom_y (w
) - dy
;
15289 /* Give up if we have gone too far. */
15290 if (end
&& row
>= end
)
15292 /* This formerly returned if they were equal.
15293 I think that both quantities are of a "last plus one" type;
15294 if so, when they are equal, the row is within the screen. -- rms. */
15295 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
15298 /* If it is in this row, return this row. */
15299 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
15300 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
15301 /* The end position of a row equals the start
15302 position of the next row. If CHARPOS is there, we
15303 would rather display it in the next line, except
15304 when this line ends in ZV. */
15305 && !row
->ends_at_zv_p
15306 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15307 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
15311 if (NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
15313 /* In bidi-reordered rows, there could be several rows
15314 occluding point. We need to find the one which fits
15315 CHARPOS the best. */
15316 for (g
= row
->glyphs
[TEXT_AREA
];
15317 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
15320 if (!STRINGP (g
->object
))
15322 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
15324 mindif
= eabs (g
->charpos
- charpos
);
15337 /* Try to redisplay window W by reusing its existing display. W's
15338 current matrix must be up to date when this function is called,
15339 i.e. window_end_valid must not be nil.
15343 1 if display has been updated
15344 0 if otherwise unsuccessful
15345 -1 if redisplay with same window start is known not to succeed
15347 The following steps are performed:
15349 1. Find the last row in the current matrix of W that is not
15350 affected by changes at the start of current_buffer. If no such row
15353 2. Find the first row in W's current matrix that is not affected by
15354 changes at the end of current_buffer. Maybe there is no such row.
15356 3. Display lines beginning with the row + 1 found in step 1 to the
15357 row found in step 2 or, if step 2 didn't find a row, to the end of
15360 4. If cursor is not known to appear on the window, give up.
15362 5. If display stopped at the row found in step 2, scroll the
15363 display and current matrix as needed.
15365 6. Maybe display some lines at the end of W, if we must. This can
15366 happen under various circumstances, like a partially visible line
15367 becoming fully visible, or because newly displayed lines are displayed
15368 in smaller font sizes.
15370 7. Update W's window end information. */
15373 try_window_id (struct window
*w
)
15375 struct frame
*f
= XFRAME (w
->frame
);
15376 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
15377 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
15378 struct glyph_row
*last_unchanged_at_beg_row
;
15379 struct glyph_row
*first_unchanged_at_end_row
;
15380 struct glyph_row
*row
;
15381 struct glyph_row
*bottom_row
;
15384 int delta
= 0, delta_bytes
= 0, stop_pos
, dvpos
, dy
;
15385 struct text_pos start_pos
;
15387 int first_unchanged_at_end_vpos
= 0;
15388 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
15389 struct text_pos start
;
15390 int first_changed_charpos
, last_changed_charpos
;
15393 if (inhibit_try_window_id
)
15397 /* This is handy for debugging. */
15399 #define GIVE_UP(X) \
15401 fprintf (stderr, "try_window_id give up %d\n", (X)); \
15405 #define GIVE_UP(X) return 0
15408 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
15410 /* Don't use this for mini-windows because these can show
15411 messages and mini-buffers, and we don't handle that here. */
15412 if (MINI_WINDOW_P (w
))
15415 /* This flag is used to prevent redisplay optimizations. */
15416 if (windows_or_buffers_changed
|| cursor_type_changed
)
15419 /* Verify that narrowing has not changed.
15420 Also verify that we were not told to prevent redisplay optimizations.
15421 It would be nice to further
15422 reduce the number of cases where this prevents try_window_id. */
15423 if (current_buffer
->clip_changed
15424 || current_buffer
->prevent_redisplay_optimizations_p
)
15427 /* Window must either use window-based redisplay or be full width. */
15428 if (!FRAME_WINDOW_P (f
)
15429 && (!FRAME_LINE_INS_DEL_OK (f
)
15430 || !WINDOW_FULL_WIDTH_P (w
)))
15433 /* Give up if point is known NOT to appear in W. */
15434 if (PT
< CHARPOS (start
))
15437 /* Another way to prevent redisplay optimizations. */
15438 if (XFASTINT (w
->last_modified
) == 0)
15441 /* Verify that window is not hscrolled. */
15442 if (XFASTINT (w
->hscroll
) != 0)
15445 /* Verify that display wasn't paused. */
15446 if (NILP (w
->window_end_valid
))
15449 /* Can't use this if highlighting a region because a cursor movement
15450 will do more than just set the cursor. */
15451 if (!NILP (Vtransient_mark_mode
)
15452 && !NILP (current_buffer
->mark_active
))
15455 /* Likewise if highlighting trailing whitespace. */
15456 if (!NILP (Vshow_trailing_whitespace
))
15459 /* Likewise if showing a region. */
15460 if (!NILP (w
->region_showing
))
15463 /* Can't use this if overlay arrow position and/or string have
15465 if (overlay_arrows_changed_p ())
15468 /* When word-wrap is on, adding a space to the first word of a
15469 wrapped line can change the wrap position, altering the line
15470 above it. It might be worthwhile to handle this more
15471 intelligently, but for now just redisplay from scratch. */
15472 if (!NILP (XBUFFER (w
->buffer
)->word_wrap
))
15475 /* Under bidi reordering, adding or deleting a character in the
15476 beginning of a paragraph, before the first strong directional
15477 character, can change the base direction of the paragraph (unless
15478 the buffer specifies a fixed paragraph direction), which will
15479 require to redisplay the whole paragraph. It might be worthwhile
15480 to find the paragraph limits and widen the range of redisplayed
15481 lines to that, but for now just give up this optimization and
15482 redisplay from scratch. */
15483 if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
)
15484 && NILP (XBUFFER (w
->buffer
)->bidi_paragraph_direction
))
15487 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
15488 only if buffer has really changed. The reason is that the gap is
15489 initially at Z for freshly visited files. The code below would
15490 set end_unchanged to 0 in that case. */
15491 if (MODIFF
> SAVE_MODIFF
15492 /* This seems to happen sometimes after saving a buffer. */
15493 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
15495 if (GPT
- BEG
< BEG_UNCHANGED
)
15496 BEG_UNCHANGED
= GPT
- BEG
;
15497 if (Z
- GPT
< END_UNCHANGED
)
15498 END_UNCHANGED
= Z
- GPT
;
15501 /* The position of the first and last character that has been changed. */
15502 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
15503 last_changed_charpos
= Z
- END_UNCHANGED
;
15505 /* If window starts after a line end, and the last change is in
15506 front of that newline, then changes don't affect the display.
15507 This case happens with stealth-fontification. Note that although
15508 the display is unchanged, glyph positions in the matrix have to
15509 be adjusted, of course. */
15510 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15511 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15512 && ((last_changed_charpos
< CHARPOS (start
)
15513 && CHARPOS (start
) == BEGV
)
15514 || (last_changed_charpos
< CHARPOS (start
) - 1
15515 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
15517 int Z_old
, delta
, Z_BYTE_old
, delta_bytes
;
15518 struct glyph_row
*r0
;
15520 /* Compute how many chars/bytes have been added to or removed
15521 from the buffer. */
15522 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15523 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15525 delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15527 /* Give up if PT is not in the window. Note that it already has
15528 been checked at the start of try_window_id that PT is not in
15529 front of the window start. */
15530 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + delta
)
15533 /* If window start is unchanged, we can reuse the whole matrix
15534 as is, after adjusting glyph positions. No need to compute
15535 the window end again, since its offset from Z hasn't changed. */
15536 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15537 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + delta
15538 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + delta_bytes
15539 /* PT must not be in a partially visible line. */
15540 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + delta
15541 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15543 /* Adjust positions in the glyph matrix. */
15544 if (delta
|| delta_bytes
)
15546 struct glyph_row
*r1
15547 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15548 increment_matrix_positions (w
->current_matrix
,
15549 MATRIX_ROW_VPOS (r0
, current_matrix
),
15550 MATRIX_ROW_VPOS (r1
, current_matrix
),
15551 delta
, delta_bytes
);
15554 /* Set the cursor. */
15555 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15557 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15564 /* Handle the case that changes are all below what is displayed in
15565 the window, and that PT is in the window. This shortcut cannot
15566 be taken if ZV is visible in the window, and text has been added
15567 there that is visible in the window. */
15568 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
15569 /* ZV is not visible in the window, or there are no
15570 changes at ZV, actually. */
15571 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
15572 || first_changed_charpos
== last_changed_charpos
))
15574 struct glyph_row
*r0
;
15576 /* Give up if PT is not in the window. Note that it already has
15577 been checked at the start of try_window_id that PT is not in
15578 front of the window start. */
15579 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
15582 /* If window start is unchanged, we can reuse the whole matrix
15583 as is, without changing glyph positions since no text has
15584 been added/removed in front of the window end. */
15585 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15586 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
15587 /* PT must not be in a partially visible line. */
15588 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
15589 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15591 /* We have to compute the window end anew since text
15592 could have been added/removed after it. */
15594 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15595 w
->window_end_bytepos
15596 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15598 /* Set the cursor. */
15599 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15601 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15608 /* Give up if window start is in the changed area.
15610 The condition used to read
15612 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
15614 but why that was tested escapes me at the moment. */
15615 if (CHARPOS (start
) >= first_changed_charpos
15616 && CHARPOS (start
) <= last_changed_charpos
)
15619 /* Check that window start agrees with the start of the first glyph
15620 row in its current matrix. Check this after we know the window
15621 start is not in changed text, otherwise positions would not be
15623 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15624 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
15627 /* Give up if the window ends in strings. Overlay strings
15628 at the end are difficult to handle, so don't try. */
15629 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
15630 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
15633 /* Compute the position at which we have to start displaying new
15634 lines. Some of the lines at the top of the window might be
15635 reusable because they are not displaying changed text. Find the
15636 last row in W's current matrix not affected by changes at the
15637 start of current_buffer. Value is null if changes start in the
15638 first line of window. */
15639 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
15640 if (last_unchanged_at_beg_row
)
15642 /* Avoid starting to display in the moddle of a character, a TAB
15643 for instance. This is easier than to set up the iterator
15644 exactly, and it's not a frequent case, so the additional
15645 effort wouldn't really pay off. */
15646 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
15647 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
15648 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
15649 --last_unchanged_at_beg_row
;
15651 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
15654 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
15656 start_pos
= it
.current
.pos
;
15658 /* Start displaying new lines in the desired matrix at the same
15659 vpos we would use in the current matrix, i.e. below
15660 last_unchanged_at_beg_row. */
15661 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
15663 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15664 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
15666 xassert (it
.hpos
== 0 && it
.current_x
== 0);
15670 /* There are no reusable lines at the start of the window.
15671 Start displaying in the first text line. */
15672 start_display (&it
, w
, start
);
15673 it
.vpos
= it
.first_vpos
;
15674 start_pos
= it
.current
.pos
;
15677 /* Find the first row that is not affected by changes at the end of
15678 the buffer. Value will be null if there is no unchanged row, in
15679 which case we must redisplay to the end of the window. delta
15680 will be set to the value by which buffer positions beginning with
15681 first_unchanged_at_end_row have to be adjusted due to text
15683 first_unchanged_at_end_row
15684 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
15685 IF_DEBUG (debug_delta
= delta
);
15686 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
15688 /* Set stop_pos to the buffer position up to which we will have to
15689 display new lines. If first_unchanged_at_end_row != NULL, this
15690 is the buffer position of the start of the line displayed in that
15691 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
15692 that we don't stop at a buffer position. */
15694 if (first_unchanged_at_end_row
)
15696 xassert (last_unchanged_at_beg_row
== NULL
15697 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
15699 /* If this is a continuation line, move forward to the next one
15700 that isn't. Changes in lines above affect this line.
15701 Caution: this may move first_unchanged_at_end_row to a row
15702 not displaying text. */
15703 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
15704 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15705 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15706 < it
.last_visible_y
))
15707 ++first_unchanged_at_end_row
;
15709 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15710 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15711 >= it
.last_visible_y
))
15712 first_unchanged_at_end_row
= NULL
;
15715 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
15717 first_unchanged_at_end_vpos
15718 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
15719 xassert (stop_pos
>= Z
- END_UNCHANGED
);
15722 else if (last_unchanged_at_beg_row
== NULL
)
15728 /* Either there is no unchanged row at the end, or the one we have
15729 now displays text. This is a necessary condition for the window
15730 end pos calculation at the end of this function. */
15731 xassert (first_unchanged_at_end_row
== NULL
15732 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
15734 debug_last_unchanged_at_beg_vpos
15735 = (last_unchanged_at_beg_row
15736 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
15738 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
15740 #endif /* GLYPH_DEBUG != 0 */
15743 /* Display new lines. Set last_text_row to the last new line
15744 displayed which has text on it, i.e. might end up as being the
15745 line where the window_end_vpos is. */
15746 w
->cursor
.vpos
= -1;
15747 last_text_row
= NULL
;
15748 overlay_arrow_seen
= 0;
15749 while (it
.current_y
< it
.last_visible_y
15750 && !fonts_changed_p
15751 && (first_unchanged_at_end_row
== NULL
15752 || IT_CHARPOS (it
) < stop_pos
))
15754 if (display_line (&it
))
15755 last_text_row
= it
.glyph_row
- 1;
15758 if (fonts_changed_p
)
15762 /* Compute differences in buffer positions, y-positions etc. for
15763 lines reused at the bottom of the window. Compute what we can
15765 if (first_unchanged_at_end_row
15766 /* No lines reused because we displayed everything up to the
15767 bottom of the window. */
15768 && it
.current_y
< it
.last_visible_y
)
15771 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
15773 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
15774 run
.current_y
= first_unchanged_at_end_row
->y
;
15775 run
.desired_y
= run
.current_y
+ dy
;
15776 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
15780 delta
= delta_bytes
= dvpos
= dy
15781 = run
.current_y
= run
.desired_y
= run
.height
= 0;
15782 first_unchanged_at_end_row
= NULL
;
15784 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
15787 /* Find the cursor if not already found. We have to decide whether
15788 PT will appear on this window (it sometimes doesn't, but this is
15789 not a very frequent case.) This decision has to be made before
15790 the current matrix is altered. A value of cursor.vpos < 0 means
15791 that PT is either in one of the lines beginning at
15792 first_unchanged_at_end_row or below the window. Don't care for
15793 lines that might be displayed later at the window end; as
15794 mentioned, this is not a frequent case. */
15795 if (w
->cursor
.vpos
< 0)
15797 /* Cursor in unchanged rows at the top? */
15798 if (PT
< CHARPOS (start_pos
)
15799 && last_unchanged_at_beg_row
)
15801 row
= row_containing_pos (w
, PT
,
15802 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
15803 last_unchanged_at_beg_row
+ 1, 0);
15805 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15808 /* Start from first_unchanged_at_end_row looking for PT. */
15809 else if (first_unchanged_at_end_row
)
15811 row
= row_containing_pos (w
, PT
- delta
,
15812 first_unchanged_at_end_row
, NULL
, 0);
15814 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
15815 delta_bytes
, dy
, dvpos
);
15818 /* Give up if cursor was not found. */
15819 if (w
->cursor
.vpos
< 0)
15821 clear_glyph_matrix (w
->desired_matrix
);
15826 /* Don't let the cursor end in the scroll margins. */
15828 int this_scroll_margin
, cursor_height
;
15830 this_scroll_margin
= max (0, scroll_margin
);
15831 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15832 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
15833 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
15835 if ((w
->cursor
.y
< this_scroll_margin
15836 && CHARPOS (start
) > BEGV
)
15837 /* Old redisplay didn't take scroll margin into account at the bottom,
15838 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
15839 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
15840 ? cursor_height
+ this_scroll_margin
15841 : 1)) > it
.last_visible_y
)
15843 w
->cursor
.vpos
= -1;
15844 clear_glyph_matrix (w
->desired_matrix
);
15849 /* Scroll the display. Do it before changing the current matrix so
15850 that xterm.c doesn't get confused about where the cursor glyph is
15852 if (dy
&& run
.height
)
15856 if (FRAME_WINDOW_P (f
))
15858 FRAME_RIF (f
)->update_window_begin_hook (w
);
15859 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15860 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15861 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15865 /* Terminal frame. In this case, dvpos gives the number of
15866 lines to scroll by; dvpos < 0 means scroll up. */
15867 int first_unchanged_at_end_vpos
15868 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
15869 int from
= WINDOW_TOP_EDGE_LINE (w
) + first_unchanged_at_end_vpos
;
15870 int end
= (WINDOW_TOP_EDGE_LINE (w
)
15871 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
15872 + window_internal_height (w
));
15874 /* Perform the operation on the screen. */
15877 /* Scroll last_unchanged_at_beg_row to the end of the
15878 window down dvpos lines. */
15879 set_terminal_window (f
, end
);
15881 /* On dumb terminals delete dvpos lines at the end
15882 before inserting dvpos empty lines. */
15883 if (!FRAME_SCROLL_REGION_OK (f
))
15884 ins_del_lines (f
, end
- dvpos
, -dvpos
);
15886 /* Insert dvpos empty lines in front of
15887 last_unchanged_at_beg_row. */
15888 ins_del_lines (f
, from
, dvpos
);
15890 else if (dvpos
< 0)
15892 /* Scroll up last_unchanged_at_beg_vpos to the end of
15893 the window to last_unchanged_at_beg_vpos - |dvpos|. */
15894 set_terminal_window (f
, end
);
15896 /* Delete dvpos lines in front of
15897 last_unchanged_at_beg_vpos. ins_del_lines will set
15898 the cursor to the given vpos and emit |dvpos| delete
15900 ins_del_lines (f
, from
+ dvpos
, dvpos
);
15902 /* On a dumb terminal insert dvpos empty lines at the
15904 if (!FRAME_SCROLL_REGION_OK (f
))
15905 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
15908 set_terminal_window (f
, 0);
15914 /* Shift reused rows of the current matrix to the right position.
15915 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
15917 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15918 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
15921 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
15922 bottom_vpos
, dvpos
);
15923 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
15926 else if (dvpos
> 0)
15928 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
15929 bottom_vpos
, dvpos
);
15930 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
15931 first_unchanged_at_end_vpos
+ dvpos
, 0);
15934 /* For frame-based redisplay, make sure that current frame and window
15935 matrix are in sync with respect to glyph memory. */
15936 if (!FRAME_WINDOW_P (f
))
15937 sync_frame_with_window_matrix_rows (w
);
15939 /* Adjust buffer positions in reused rows. */
15940 if (delta
|| delta_bytes
)
15941 increment_matrix_positions (current_matrix
,
15942 first_unchanged_at_end_vpos
+ dvpos
,
15943 bottom_vpos
, delta
, delta_bytes
);
15945 /* Adjust Y positions. */
15947 shift_glyph_matrix (w
, current_matrix
,
15948 first_unchanged_at_end_vpos
+ dvpos
,
15951 if (first_unchanged_at_end_row
)
15953 first_unchanged_at_end_row
+= dvpos
;
15954 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
15955 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
15956 first_unchanged_at_end_row
= NULL
;
15959 /* If scrolling up, there may be some lines to display at the end of
15961 last_text_row_at_end
= NULL
;
15964 /* Scrolling up can leave for example a partially visible line
15965 at the end of the window to be redisplayed. */
15966 /* Set last_row to the glyph row in the current matrix where the
15967 window end line is found. It has been moved up or down in
15968 the matrix by dvpos. */
15969 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
15970 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
15972 /* If last_row is the window end line, it should display text. */
15973 xassert (last_row
->displays_text_p
);
15975 /* If window end line was partially visible before, begin
15976 displaying at that line. Otherwise begin displaying with the
15977 line following it. */
15978 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
15980 init_to_row_start (&it
, w
, last_row
);
15981 it
.vpos
= last_vpos
;
15982 it
.current_y
= last_row
->y
;
15986 init_to_row_end (&it
, w
, last_row
);
15987 it
.vpos
= 1 + last_vpos
;
15988 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
15992 /* We may start in a continuation line. If so, we have to
15993 get the right continuation_lines_width and current_x. */
15994 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
15995 it
.hpos
= it
.current_x
= 0;
15997 /* Display the rest of the lines at the window end. */
15998 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15999 while (it
.current_y
< it
.last_visible_y
16000 && !fonts_changed_p
)
16002 /* Is it always sure that the display agrees with lines in
16003 the current matrix? I don't think so, so we mark rows
16004 displayed invalid in the current matrix by setting their
16005 enabled_p flag to zero. */
16006 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
16007 if (display_line (&it
))
16008 last_text_row_at_end
= it
.glyph_row
- 1;
16012 /* Update window_end_pos and window_end_vpos. */
16013 if (first_unchanged_at_end_row
16014 && !last_text_row_at_end
)
16016 /* Window end line if one of the preserved rows from the current
16017 matrix. Set row to the last row displaying text in current
16018 matrix starting at first_unchanged_at_end_row, after
16020 xassert (first_unchanged_at_end_row
->displays_text_p
);
16021 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
16022 first_unchanged_at_end_row
);
16023 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
16025 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16026 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16028 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
16029 xassert (w
->window_end_bytepos
>= 0);
16030 IF_DEBUG (debug_method_add (w
, "A"));
16032 else if (last_text_row_at_end
)
16035 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
16036 w
->window_end_bytepos
16037 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
16039 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
16040 xassert (w
->window_end_bytepos
>= 0);
16041 IF_DEBUG (debug_method_add (w
, "B"));
16043 else if (last_text_row
)
16045 /* We have displayed either to the end of the window or at the
16046 end of the window, i.e. the last row with text is to be found
16047 in the desired matrix. */
16049 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16050 w
->window_end_bytepos
16051 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16053 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
16054 xassert (w
->window_end_bytepos
>= 0);
16056 else if (first_unchanged_at_end_row
== NULL
16057 && last_text_row
== NULL
16058 && last_text_row_at_end
== NULL
)
16060 /* Displayed to end of window, but no line containing text was
16061 displayed. Lines were deleted at the end of the window. */
16062 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
16063 int vpos
= XFASTINT (w
->window_end_vpos
);
16064 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
16065 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
16068 row
== NULL
&& vpos
>= first_vpos
;
16069 --vpos
, --current_row
, --desired_row
)
16071 if (desired_row
->enabled_p
)
16073 if (desired_row
->displays_text_p
)
16076 else if (current_row
->displays_text_p
)
16080 xassert (row
!= NULL
);
16081 w
->window_end_vpos
= make_number (vpos
+ 1);
16082 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16083 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16084 xassert (w
->window_end_bytepos
>= 0);
16085 IF_DEBUG (debug_method_add (w
, "C"));
16090 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
16091 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
16093 /* Record that display has not been completed. */
16094 w
->window_end_valid
= Qnil
;
16095 w
->desired_matrix
->no_scrolling_p
= 1;
16103 /***********************************************************************
16104 More debugging support
16105 ***********************************************************************/
16109 void dump_glyph_row (struct glyph_row
*, int, int);
16110 void dump_glyph_matrix (struct glyph_matrix
*, int);
16111 void dump_glyph (struct glyph_row
*, struct glyph
*, int);
16114 /* Dump the contents of glyph matrix MATRIX on stderr.
16116 GLYPHS 0 means don't show glyph contents.
16117 GLYPHS 1 means show glyphs in short form
16118 GLYPHS > 1 means show glyphs in long form. */
16121 dump_glyph_matrix (matrix
, glyphs
)
16122 struct glyph_matrix
*matrix
;
16126 for (i
= 0; i
< matrix
->nrows
; ++i
)
16127 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
16131 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
16132 the glyph row and area where the glyph comes from. */
16135 dump_glyph (row
, glyph
, area
)
16136 struct glyph_row
*row
;
16137 struct glyph
*glyph
;
16140 if (glyph
->type
== CHAR_GLYPH
)
16143 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16144 glyph
- row
->glyphs
[TEXT_AREA
],
16147 (BUFFERP (glyph
->object
)
16149 : (STRINGP (glyph
->object
)
16152 glyph
->pixel_width
,
16154 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
16158 glyph
->left_box_line_p
,
16159 glyph
->right_box_line_p
);
16161 else if (glyph
->type
== STRETCH_GLYPH
)
16164 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16165 glyph
- row
->glyphs
[TEXT_AREA
],
16168 (BUFFERP (glyph
->object
)
16170 : (STRINGP (glyph
->object
)
16173 glyph
->pixel_width
,
16177 glyph
->left_box_line_p
,
16178 glyph
->right_box_line_p
);
16180 else if (glyph
->type
== IMAGE_GLYPH
)
16183 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16184 glyph
- row
->glyphs
[TEXT_AREA
],
16187 (BUFFERP (glyph
->object
)
16189 : (STRINGP (glyph
->object
)
16192 glyph
->pixel_width
,
16196 glyph
->left_box_line_p
,
16197 glyph
->right_box_line_p
);
16199 else if (glyph
->type
== COMPOSITE_GLYPH
)
16202 " %5d %4c %6d %c %3d 0x%05x",
16203 glyph
- row
->glyphs
[TEXT_AREA
],
16206 (BUFFERP (glyph
->object
)
16208 : (STRINGP (glyph
->object
)
16211 glyph
->pixel_width
,
16213 if (glyph
->u
.cmp
.automatic
)
16216 glyph
->u
.cmp
.from
, glyph
->u
.cmp
.to
);
16217 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
16219 glyph
->left_box_line_p
,
16220 glyph
->right_box_line_p
);
16225 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
16226 GLYPHS 0 means don't show glyph contents.
16227 GLYPHS 1 means show glyphs in short form
16228 GLYPHS > 1 means show glyphs in long form. */
16231 dump_glyph_row (row
, vpos
, glyphs
)
16232 struct glyph_row
*row
;
16237 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
16238 fprintf (stderr
, "======================================================================\n");
16240 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d\
16241 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
16243 MATRIX_ROW_START_CHARPOS (row
),
16244 MATRIX_ROW_END_CHARPOS (row
),
16245 row
->used
[TEXT_AREA
],
16246 row
->contains_overlapping_glyphs_p
,
16248 row
->truncated_on_left_p
,
16249 row
->truncated_on_right_p
,
16251 MATRIX_ROW_CONTINUATION_LINE_P (row
),
16252 row
->displays_text_p
,
16255 row
->ends_in_middle_of_char_p
,
16256 row
->starts_in_middle_of_char_p
,
16262 row
->visible_height
,
16265 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
16266 row
->end
.overlay_string_index
,
16267 row
->continuation_lines_width
);
16268 fprintf (stderr
, "%9d %5d\n",
16269 CHARPOS (row
->start
.string_pos
),
16270 CHARPOS (row
->end
.string_pos
));
16271 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
16272 row
->end
.dpvec_index
);
16279 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16281 struct glyph
*glyph
= row
->glyphs
[area
];
16282 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
16284 /* Glyph for a line end in text. */
16285 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
16288 if (glyph
< glyph_end
)
16289 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
16291 for (; glyph
< glyph_end
; ++glyph
)
16292 dump_glyph (row
, glyph
, area
);
16295 else if (glyphs
== 1)
16299 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16301 char *s
= (char *) alloca (row
->used
[area
] + 1);
16304 for (i
= 0; i
< row
->used
[area
]; ++i
)
16306 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
16307 if (glyph
->type
== CHAR_GLYPH
16308 && glyph
->u
.ch
< 0x80
16309 && glyph
->u
.ch
>= ' ')
16310 s
[i
] = glyph
->u
.ch
;
16316 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
16322 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
16323 Sdump_glyph_matrix
, 0, 1, "p",
16324 doc
: /* Dump the current matrix of the selected window to stderr.
16325 Shows contents of glyph row structures. With non-nil
16326 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
16327 glyphs in short form, otherwise show glyphs in long form. */)
16328 (Lisp_Object glyphs
)
16330 struct window
*w
= XWINDOW (selected_window
);
16331 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16333 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
16334 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
16335 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
16336 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
16337 fprintf (stderr
, "=============================================\n");
16338 dump_glyph_matrix (w
->current_matrix
,
16339 NILP (glyphs
) ? 0 : XINT (glyphs
));
16344 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
16345 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
16348 struct frame
*f
= XFRAME (selected_frame
);
16349 dump_glyph_matrix (f
->current_matrix
, 1);
16354 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
16355 doc
: /* Dump glyph row ROW to stderr.
16356 GLYPH 0 means don't dump glyphs.
16357 GLYPH 1 means dump glyphs in short form.
16358 GLYPH > 1 or omitted means dump glyphs in long form. */)
16359 (Lisp_Object row
, Lisp_Object glyphs
)
16361 struct glyph_matrix
*matrix
;
16364 CHECK_NUMBER (row
);
16365 matrix
= XWINDOW (selected_window
)->current_matrix
;
16367 if (vpos
>= 0 && vpos
< matrix
->nrows
)
16368 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
16370 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16375 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
16376 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
16377 GLYPH 0 means don't dump glyphs.
16378 GLYPH 1 means dump glyphs in short form.
16379 GLYPH > 1 or omitted means dump glyphs in long form. */)
16380 (Lisp_Object row
, Lisp_Object glyphs
)
16382 struct frame
*sf
= SELECTED_FRAME ();
16383 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
16386 CHECK_NUMBER (row
);
16388 if (vpos
>= 0 && vpos
< m
->nrows
)
16389 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
16390 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16395 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
16396 doc
: /* Toggle tracing of redisplay.
16397 With ARG, turn tracing on if and only if ARG is positive. */)
16401 trace_redisplay_p
= !trace_redisplay_p
;
16404 arg
= Fprefix_numeric_value (arg
);
16405 trace_redisplay_p
= XINT (arg
) > 0;
16412 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
16413 doc
: /* Like `format', but print result to stderr.
16414 usage: (trace-to-stderr STRING &rest OBJECTS) */)
16415 (int nargs
, Lisp_Object
*args
)
16417 Lisp_Object s
= Fformat (nargs
, args
);
16418 fprintf (stderr
, "%s", SDATA (s
));
16422 #endif /* GLYPH_DEBUG */
16426 /***********************************************************************
16427 Building Desired Matrix Rows
16428 ***********************************************************************/
16430 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
16431 Used for non-window-redisplay windows, and for windows w/o left fringe. */
16433 static struct glyph_row
*
16434 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
16436 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
16437 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16438 struct buffer
*old
= current_buffer
;
16439 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
16440 int arrow_len
= SCHARS (overlay_arrow_string
);
16441 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
16442 const unsigned char *p
;
16445 int n_glyphs_before
;
16447 set_buffer_temp (buffer
);
16448 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
16449 it
.glyph_row
->used
[TEXT_AREA
] = 0;
16450 SET_TEXT_POS (it
.position
, 0, 0);
16452 multibyte_p
= !NILP (buffer
->enable_multibyte_characters
);
16454 while (p
< arrow_end
)
16456 Lisp_Object face
, ilisp
;
16458 /* Get the next character. */
16460 it
.c
= string_char_and_length (p
, &it
.len
);
16462 it
.c
= *p
, it
.len
= 1;
16465 /* Get its face. */
16466 ilisp
= make_number (p
- arrow_string
);
16467 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
16468 it
.face_id
= compute_char_face (f
, it
.c
, face
);
16470 /* Compute its width, get its glyphs. */
16471 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
16472 SET_TEXT_POS (it
.position
, -1, -1);
16473 PRODUCE_GLYPHS (&it
);
16475 /* If this character doesn't fit any more in the line, we have
16476 to remove some glyphs. */
16477 if (it
.current_x
> it
.last_visible_x
)
16479 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
16484 set_buffer_temp (old
);
16485 return it
.glyph_row
;
16489 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
16490 glyphs are only inserted for terminal frames since we can't really
16491 win with truncation glyphs when partially visible glyphs are
16492 involved. Which glyphs to insert is determined by
16493 produce_special_glyphs. */
16496 insert_left_trunc_glyphs (struct it
*it
)
16498 struct it truncate_it
;
16499 struct glyph
*from
, *end
, *to
, *toend
;
16501 xassert (!FRAME_WINDOW_P (it
->f
));
16503 /* Get the truncation glyphs. */
16505 truncate_it
.current_x
= 0;
16506 truncate_it
.face_id
= DEFAULT_FACE_ID
;
16507 truncate_it
.glyph_row
= &scratch_glyph_row
;
16508 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
16509 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
16510 truncate_it
.object
= make_number (0);
16511 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
16513 /* Overwrite glyphs from IT with truncation glyphs. */
16514 if (!it
->glyph_row
->reversed_p
)
16516 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16517 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
16518 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16519 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
16524 /* There may be padding glyphs left over. Overwrite them too. */
16525 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
16527 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16533 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
16537 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
16538 that back to front. */
16539 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16540 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16541 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16542 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16544 while (from
>= end
&& to
>= toend
)
16546 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
16549 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
16550 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16551 while (from
>= end
&& to
>= toend
)
16556 /* Need to free some room before prepending additional
16558 int move_by
= from
- end
+ 1;
16559 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16560 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16562 for ( ; g
>= g0
; g
--)
16564 while (from
>= end
)
16566 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
16572 /* Compute the pixel height and width of IT->glyph_row.
16574 Most of the time, ascent and height of a display line will be equal
16575 to the max_ascent and max_height values of the display iterator
16576 structure. This is not the case if
16578 1. We hit ZV without displaying anything. In this case, max_ascent
16579 and max_height will be zero.
16581 2. We have some glyphs that don't contribute to the line height.
16582 (The glyph row flag contributes_to_line_height_p is for future
16583 pixmap extensions).
16585 The first case is easily covered by using default values because in
16586 these cases, the line height does not really matter, except that it
16587 must not be zero. */
16590 compute_line_metrics (struct it
*it
)
16592 struct glyph_row
*row
= it
->glyph_row
;
16595 if (FRAME_WINDOW_P (it
->f
))
16597 int i
, min_y
, max_y
;
16599 /* The line may consist of one space only, that was added to
16600 place the cursor on it. If so, the row's height hasn't been
16602 if (row
->height
== 0)
16604 if (it
->max_ascent
+ it
->max_descent
== 0)
16605 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
16606 row
->ascent
= it
->max_ascent
;
16607 row
->height
= it
->max_ascent
+ it
->max_descent
;
16608 row
->phys_ascent
= it
->max_phys_ascent
;
16609 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16610 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
16613 /* Compute the width of this line. */
16614 row
->pixel_width
= row
->x
;
16615 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
16616 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
16618 xassert (row
->pixel_width
>= 0);
16619 xassert (row
->ascent
>= 0 && row
->height
> 0);
16621 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
16622 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
16624 /* If first line's physical ascent is larger than its logical
16625 ascent, use the physical ascent, and make the row taller.
16626 This makes accented characters fully visible. */
16627 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
16628 && row
->phys_ascent
> row
->ascent
)
16630 row
->height
+= row
->phys_ascent
- row
->ascent
;
16631 row
->ascent
= row
->phys_ascent
;
16634 /* Compute how much of the line is visible. */
16635 row
->visible_height
= row
->height
;
16637 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
16638 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
16640 if (row
->y
< min_y
)
16641 row
->visible_height
-= min_y
- row
->y
;
16642 if (row
->y
+ row
->height
> max_y
)
16643 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16647 row
->pixel_width
= row
->used
[TEXT_AREA
];
16648 if (row
->continued_p
)
16649 row
->pixel_width
-= it
->continuation_pixel_width
;
16650 else if (row
->truncated_on_right_p
)
16651 row
->pixel_width
-= it
->truncation_pixel_width
;
16652 row
->ascent
= row
->phys_ascent
= 0;
16653 row
->height
= row
->phys_height
= row
->visible_height
= 1;
16654 row
->extra_line_spacing
= 0;
16657 /* Compute a hash code for this row. */
16659 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16660 for (i
= 0; i
< row
->used
[area
]; ++i
)
16661 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
16662 + row
->glyphs
[area
][i
].u
.val
16663 + row
->glyphs
[area
][i
].face_id
16664 + row
->glyphs
[area
][i
].padding_p
16665 + (row
->glyphs
[area
][i
].type
<< 2));
16667 it
->max_ascent
= it
->max_descent
= 0;
16668 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
16672 /* Append one space to the glyph row of iterator IT if doing a
16673 window-based redisplay. The space has the same face as
16674 IT->face_id. Value is non-zero if a space was added.
16676 This function is called to make sure that there is always one glyph
16677 at the end of a glyph row that the cursor can be set on under
16678 window-systems. (If there weren't such a glyph we would not know
16679 how wide and tall a box cursor should be displayed).
16681 At the same time this space let's a nicely handle clearing to the
16682 end of the line if the row ends in italic text. */
16685 append_space_for_newline (struct it
*it
, int default_face_p
)
16687 if (FRAME_WINDOW_P (it
->f
))
16689 int n
= it
->glyph_row
->used
[TEXT_AREA
];
16691 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
16692 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
16694 /* Save some values that must not be changed.
16695 Must save IT->c and IT->len because otherwise
16696 ITERATOR_AT_END_P wouldn't work anymore after
16697 append_space_for_newline has been called. */
16698 enum display_element_type saved_what
= it
->what
;
16699 int saved_c
= it
->c
, saved_len
= it
->len
;
16700 int saved_x
= it
->current_x
;
16701 int saved_face_id
= it
->face_id
;
16702 struct text_pos saved_pos
;
16703 Lisp_Object saved_object
;
16706 saved_object
= it
->object
;
16707 saved_pos
= it
->position
;
16709 it
->what
= IT_CHARACTER
;
16710 memset (&it
->position
, 0, sizeof it
->position
);
16711 it
->object
= make_number (0);
16715 if (default_face_p
)
16716 it
->face_id
= DEFAULT_FACE_ID
;
16717 else if (it
->face_before_selective_p
)
16718 it
->face_id
= it
->saved_face_id
;
16719 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
16720 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
16722 PRODUCE_GLYPHS (it
);
16724 it
->override_ascent
= -1;
16725 it
->constrain_row_ascent_descent_p
= 0;
16726 it
->current_x
= saved_x
;
16727 it
->object
= saved_object
;
16728 it
->position
= saved_pos
;
16729 it
->what
= saved_what
;
16730 it
->face_id
= saved_face_id
;
16731 it
->len
= saved_len
;
16741 /* Extend the face of the last glyph in the text area of IT->glyph_row
16742 to the end of the display line. Called from display_line. If the
16743 glyph row is empty, add a space glyph to it so that we know the
16744 face to draw. Set the glyph row flag fill_line_p. If the glyph
16745 row is R2L, prepend a stretch glyph to cover the empty space to the
16746 left of the leftmost glyph. */
16749 extend_face_to_end_of_line (struct it
*it
)
16752 struct frame
*f
= it
->f
;
16754 /* If line is already filled, do nothing. Non window-system frames
16755 get a grace of one more ``pixel'' because their characters are
16756 1-``pixel'' wide, so they hit the equality too early. This grace
16757 is needed only for R2L rows that are not continued, to produce
16758 one extra blank where we could display the cursor. */
16759 if (it
->current_x
>= it
->last_visible_x
16760 + (!FRAME_WINDOW_P (f
)
16761 && it
->glyph_row
->reversed_p
16762 && !it
->glyph_row
->continued_p
))
16765 /* Face extension extends the background and box of IT->face_id
16766 to the end of the line. If the background equals the background
16767 of the frame, we don't have to do anything. */
16768 if (it
->face_before_selective_p
)
16769 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
16771 face
= FACE_FROM_ID (f
, it
->face_id
);
16773 if (FRAME_WINDOW_P (f
)
16774 && it
->glyph_row
->displays_text_p
16775 && face
->box
== FACE_NO_BOX
16776 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
16778 && !it
->glyph_row
->reversed_p
)
16781 /* Set the glyph row flag indicating that the face of the last glyph
16782 in the text area has to be drawn to the end of the text area. */
16783 it
->glyph_row
->fill_line_p
= 1;
16785 /* If current character of IT is not ASCII, make sure we have the
16786 ASCII face. This will be automatically undone the next time
16787 get_next_display_element returns a multibyte character. Note
16788 that the character will always be single byte in unibyte
16790 if (!ASCII_CHAR_P (it
->c
))
16792 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
16795 if (FRAME_WINDOW_P (f
))
16797 /* If the row is empty, add a space with the current face of IT,
16798 so that we know which face to draw. */
16799 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
16801 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
16802 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
16803 it
->glyph_row
->used
[TEXT_AREA
] = 1;
16805 #ifdef HAVE_WINDOW_SYSTEM
16806 if (it
->glyph_row
->reversed_p
)
16808 /* Prepend a stretch glyph to the row, such that the
16809 rightmost glyph will be drawn flushed all the way to the
16810 right margin of the window. The stretch glyph that will
16811 occupy the empty space, if any, to the left of the
16813 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
16814 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16815 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
16817 int row_width
, stretch_ascent
, stretch_width
;
16818 struct text_pos saved_pos
;
16819 int saved_face_id
, saved_avoid_cursor
;
16821 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
16822 row_width
+= g
->pixel_width
;
16823 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
16824 if (stretch_width
> 0)
16827 (((it
->ascent
+ it
->descent
)
16828 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
16829 saved_pos
= it
->position
;
16830 memset (&it
->position
, 0, sizeof it
->position
);
16831 saved_avoid_cursor
= it
->avoid_cursor_p
;
16832 it
->avoid_cursor_p
= 1;
16833 saved_face_id
= it
->face_id
;
16834 /* The last row's stretch glyph should get the default
16835 face, to avoid painting the rest of the window with
16836 the region face, if the region ends at ZV. */
16837 if (it
->glyph_row
->ends_at_zv_p
)
16838 it
->face_id
= DEFAULT_FACE_ID
;
16840 it
->face_id
= face
->id
;
16841 append_stretch_glyph (it
, make_number (0), stretch_width
,
16842 it
->ascent
+ it
->descent
, stretch_ascent
);
16843 it
->position
= saved_pos
;
16844 it
->avoid_cursor_p
= saved_avoid_cursor
;
16845 it
->face_id
= saved_face_id
;
16848 #endif /* HAVE_WINDOW_SYSTEM */
16852 /* Save some values that must not be changed. */
16853 int saved_x
= it
->current_x
;
16854 struct text_pos saved_pos
;
16855 Lisp_Object saved_object
;
16856 enum display_element_type saved_what
= it
->what
;
16857 int saved_face_id
= it
->face_id
;
16859 saved_object
= it
->object
;
16860 saved_pos
= it
->position
;
16862 it
->what
= IT_CHARACTER
;
16863 memset (&it
->position
, 0, sizeof it
->position
);
16864 it
->object
= make_number (0);
16867 /* The last row's blank glyphs should get the default face, to
16868 avoid painting the rest of the window with the region face,
16869 if the region ends at ZV. */
16870 if (it
->glyph_row
->ends_at_zv_p
)
16871 it
->face_id
= DEFAULT_FACE_ID
;
16873 it
->face_id
= face
->id
;
16875 PRODUCE_GLYPHS (it
);
16877 while (it
->current_x
<= it
->last_visible_x
)
16878 PRODUCE_GLYPHS (it
);
16880 /* Don't count these blanks really. It would let us insert a left
16881 truncation glyph below and make us set the cursor on them, maybe. */
16882 it
->current_x
= saved_x
;
16883 it
->object
= saved_object
;
16884 it
->position
= saved_pos
;
16885 it
->what
= saved_what
;
16886 it
->face_id
= saved_face_id
;
16891 /* Value is non-zero if text starting at CHARPOS in current_buffer is
16892 trailing whitespace. */
16895 trailing_whitespace_p (int charpos
)
16897 int bytepos
= CHAR_TO_BYTE (charpos
);
16900 while (bytepos
< ZV_BYTE
16901 && (c
= FETCH_CHAR (bytepos
),
16902 c
== ' ' || c
== '\t'))
16905 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
16907 if (bytepos
!= PT_BYTE
)
16914 /* Highlight trailing whitespace, if any, in ROW. */
16917 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
16919 int used
= row
->used
[TEXT_AREA
];
16923 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
16924 struct glyph
*glyph
= start
+ used
- 1;
16926 if (row
->reversed_p
)
16928 /* Right-to-left rows need to be processed in the opposite
16929 direction, so swap the edge pointers. */
16931 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
16934 /* Skip over glyphs inserted to display the cursor at the
16935 end of a line, for extending the face of the last glyph
16936 to the end of the line on terminals, and for truncation
16937 and continuation glyphs. */
16938 if (!row
->reversed_p
)
16940 while (glyph
>= start
16941 && glyph
->type
== CHAR_GLYPH
16942 && INTEGERP (glyph
->object
))
16947 while (glyph
<= start
16948 && glyph
->type
== CHAR_GLYPH
16949 && INTEGERP (glyph
->object
))
16953 /* If last glyph is a space or stretch, and it's trailing
16954 whitespace, set the face of all trailing whitespace glyphs in
16955 IT->glyph_row to `trailing-whitespace'. */
16956 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
16957 && BUFFERP (glyph
->object
)
16958 && (glyph
->type
== STRETCH_GLYPH
16959 || (glyph
->type
== CHAR_GLYPH
16960 && glyph
->u
.ch
== ' '))
16961 && trailing_whitespace_p (glyph
->charpos
))
16963 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
16967 if (!row
->reversed_p
)
16969 while (glyph
>= start
16970 && BUFFERP (glyph
->object
)
16971 && (glyph
->type
== STRETCH_GLYPH
16972 || (glyph
->type
== CHAR_GLYPH
16973 && glyph
->u
.ch
== ' ')))
16974 (glyph
--)->face_id
= face_id
;
16978 while (glyph
<= start
16979 && BUFFERP (glyph
->object
)
16980 && (glyph
->type
== STRETCH_GLYPH
16981 || (glyph
->type
== CHAR_GLYPH
16982 && glyph
->u
.ch
== ' ')))
16983 (glyph
++)->face_id
= face_id
;
16990 /* Value is non-zero if glyph row ROW in window W should be
16991 used to hold the cursor. */
16994 cursor_row_p (struct window
*w
, struct glyph_row
*row
)
16996 int cursor_row_p
= 1;
16998 if (PT
== CHARPOS (row
->end
.pos
))
17000 /* Suppose the row ends on a string.
17001 Unless the row is continued, that means it ends on a newline
17002 in the string. If it's anything other than a display string
17003 (e.g. a before-string from an overlay), we don't want the
17004 cursor there. (This heuristic seems to give the optimal
17005 behavior for the various types of multi-line strings.) */
17006 if (CHARPOS (row
->end
.string_pos
) >= 0)
17008 if (row
->continued_p
)
17012 /* Check for `display' property. */
17013 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
17014 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
17015 struct glyph
*glyph
;
17018 for (glyph
= end
; glyph
>= beg
; --glyph
)
17019 if (STRINGP (glyph
->object
))
17022 = Fget_char_property (make_number (PT
),
17026 && display_prop_string_p (prop
, glyph
->object
));
17031 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
17033 /* If the row ends in middle of a real character,
17034 and the line is continued, we want the cursor here.
17035 That's because CHARPOS (ROW->end.pos) would equal
17036 PT if PT is before the character. */
17037 if (!row
->ends_in_ellipsis_p
)
17038 cursor_row_p
= row
->continued_p
;
17040 /* If the row ends in an ellipsis, then
17041 CHARPOS (ROW->end.pos) will equal point after the
17042 invisible text. We want that position to be displayed
17043 after the ellipsis. */
17046 /* If the row ends at ZV, display the cursor at the end of that
17047 row instead of at the start of the row below. */
17048 else if (row
->ends_at_zv_p
)
17054 return cursor_row_p
;
17059 /* Push the display property PROP so that it will be rendered at the
17060 current position in IT. Return 1 if PROP was successfully pushed,
17064 push_display_prop (struct it
*it
, Lisp_Object prop
)
17068 if (STRINGP (prop
))
17070 if (SCHARS (prop
) == 0)
17077 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
17078 it
->current
.overlay_string_index
= -1;
17079 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
17080 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
17081 it
->method
= GET_FROM_STRING
;
17082 it
->stop_charpos
= 0;
17084 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
17086 it
->method
= GET_FROM_STRETCH
;
17089 #ifdef HAVE_WINDOW_SYSTEM
17090 else if (IMAGEP (prop
))
17092 it
->what
= IT_IMAGE
;
17093 it
->image_id
= lookup_image (it
->f
, prop
);
17094 it
->method
= GET_FROM_IMAGE
;
17096 #endif /* HAVE_WINDOW_SYSTEM */
17099 pop_it (it
); /* bogus display property, give up */
17106 /* Return the character-property PROP at the current position in IT. */
17109 get_it_property (struct it
*it
, Lisp_Object prop
)
17111 Lisp_Object position
;
17113 if (STRINGP (it
->object
))
17114 position
= make_number (IT_STRING_CHARPOS (*it
));
17115 else if (BUFFERP (it
->object
))
17116 position
= make_number (IT_CHARPOS (*it
));
17120 return Fget_char_property (position
, prop
, it
->object
);
17123 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
17126 handle_line_prefix (struct it
*it
)
17128 Lisp_Object prefix
;
17129 if (it
->continuation_lines_width
> 0)
17131 prefix
= get_it_property (it
, Qwrap_prefix
);
17133 prefix
= Vwrap_prefix
;
17137 prefix
= get_it_property (it
, Qline_prefix
);
17139 prefix
= Vline_prefix
;
17141 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
17143 /* If the prefix is wider than the window, and we try to wrap
17144 it, it would acquire its own wrap prefix, and so on till the
17145 iterator stack overflows. So, don't wrap the prefix. */
17146 it
->line_wrap
= TRUNCATE
;
17147 it
->avoid_cursor_p
= 1;
17153 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
17154 only for R2L lines from display_line, when it decides that too many
17155 glyphs were produced by PRODUCE_GLYPHS, and the line needs to be
17158 unproduce_glyphs (struct it
*it
, int n
)
17160 struct glyph
*glyph
, *end
;
17162 xassert (it
->glyph_row
);
17163 xassert (it
->glyph_row
->reversed_p
);
17164 xassert (it
->area
== TEXT_AREA
);
17165 xassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
17167 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
17168 n
= it
->glyph_row
->used
[TEXT_AREA
];
17169 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
17170 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
17171 for ( ; glyph
< end
; glyph
++)
17172 glyph
[-n
] = *glyph
;
17175 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
17176 and ROW->maxpos. */
17178 find_row_edges (struct it
*it
, struct glyph_row
*row
,
17179 EMACS_INT min_pos
, EMACS_INT min_bpos
,
17180 EMACS_INT max_pos
, EMACS_INT max_bpos
)
17182 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17183 lines' rows is implemented for bidi-reordered rows. */
17185 /* ROW->minpos is the value of min_pos, the minimal buffer position
17188 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
17191 /* We didn't find _any_ valid buffer positions in any of the
17192 glyphs, so we must trust the iterator's computed
17194 row
->minpos
= row
->start
.pos
;
17195 max_pos
= CHARPOS (it
->current
.pos
);
17196 max_bpos
= BYTEPOS (it
->current
.pos
);
17202 /* Here are the various use-cases for ending the row, and the
17203 corresponding values for ROW->maxpos:
17205 Line ends in a newline from buffer eol_pos + 1
17206 Line is continued from buffer max_pos + 1
17207 Line is truncated on right it->current.pos
17208 Line ends in a newline from string max_pos
17209 Line is continued from string max_pos
17210 Line is continued from display vector max_pos
17211 Line is entirely from a string min_pos == max_pos
17212 Line is entirely from a display vector min_pos == max_pos
17213 Line that ends at ZV ZV
17215 If you discover other use-cases, please add them here as
17217 if (row
->ends_at_zv_p
)
17218 row
->maxpos
= it
->current
.pos
;
17219 else if (row
->used
[TEXT_AREA
])
17221 if (row
->ends_in_newline_from_string_p
)
17222 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17223 else if (CHARPOS (it
->eol_pos
) > 0)
17224 SET_TEXT_POS (row
->maxpos
,
17225 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
17226 else if (row
->continued_p
)
17228 /* If max_pos is different from IT's current position, it
17229 means IT->method does not belong to the display element
17230 at max_pos. However, it also means that the display
17231 element at max_pos was displayed in its entirety on this
17232 line, which is equivalent to saying that the next line
17233 starts at the next buffer position. */
17234 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
17235 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17238 INC_BOTH (max_pos
, max_bpos
);
17239 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17242 else if (row
->truncated_on_right_p
)
17243 /* display_line already called reseat_at_next_visible_line_start,
17244 which puts the iterator at the beginning of the next line, in
17245 the logical order. */
17246 row
->maxpos
= it
->current
.pos
;
17247 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
17248 /* A line that is entirely from a string/image/stretch... */
17249 row
->maxpos
= row
->minpos
;
17254 row
->maxpos
= it
->current
.pos
;
17257 /* Construct the glyph row IT->glyph_row in the desired matrix of
17258 IT->w from text at the current position of IT. See dispextern.h
17259 for an overview of struct it. Value is non-zero if
17260 IT->glyph_row displays text, as opposed to a line displaying ZV
17264 display_line (struct it
*it
)
17266 struct glyph_row
*row
= it
->glyph_row
;
17267 Lisp_Object overlay_arrow_string
;
17269 int may_wrap
= 0, wrap_x
;
17270 int wrap_row_used
= -1, wrap_row_ascent
, wrap_row_height
;
17271 int wrap_row_phys_ascent
, wrap_row_phys_height
;
17272 int wrap_row_extra_line_spacing
;
17273 EMACS_INT wrap_row_min_pos
, wrap_row_min_bpos
;
17274 EMACS_INT wrap_row_max_pos
, wrap_row_max_bpos
;
17276 EMACS_INT min_pos
= ZV
+ 1, min_bpos
, max_pos
= 0, max_bpos
;
17278 /* We always start displaying at hpos zero even if hscrolled. */
17279 xassert (it
->hpos
== 0 && it
->current_x
== 0);
17281 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
17282 >= it
->w
->desired_matrix
->nrows
)
17284 it
->w
->nrows_scale_factor
++;
17285 fonts_changed_p
= 1;
17289 /* Is IT->w showing the region? */
17290 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
17292 /* Clear the result glyph row and enable it. */
17293 prepare_desired_row (row
);
17295 row
->y
= it
->current_y
;
17296 row
->start
= it
->start
;
17297 row
->continuation_lines_width
= it
->continuation_lines_width
;
17298 row
->displays_text_p
= 1;
17299 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
17300 it
->starts_in_middle_of_char_p
= 0;
17302 /* Arrange the overlays nicely for our purposes. Usually, we call
17303 display_line on only one line at a time, in which case this
17304 can't really hurt too much, or we call it on lines which appear
17305 one after another in the buffer, in which case all calls to
17306 recenter_overlay_lists but the first will be pretty cheap. */
17307 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
17309 /* Move over display elements that are not visible because we are
17310 hscrolled. This may stop at an x-position < IT->first_visible_x
17311 if the first glyph is partially visible or if we hit a line end. */
17312 if (it
->current_x
< it
->first_visible_x
)
17314 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
17315 MOVE_TO_POS
| MOVE_TO_X
);
17319 /* We only do this when not calling `move_it_in_display_line_to'
17320 above, because move_it_in_display_line_to calls
17321 handle_line_prefix itself. */
17322 handle_line_prefix (it
);
17325 /* Get the initial row height. This is either the height of the
17326 text hscrolled, if there is any, or zero. */
17327 row
->ascent
= it
->max_ascent
;
17328 row
->height
= it
->max_ascent
+ it
->max_descent
;
17329 row
->phys_ascent
= it
->max_phys_ascent
;
17330 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
17331 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
17333 /* Utility macro to record max and min buffer positions seen until now. */
17334 #define RECORD_MAX_MIN_POS(IT) \
17337 if (IT_CHARPOS (*(IT)) < min_pos) \
17339 min_pos = IT_CHARPOS (*(IT)); \
17340 min_bpos = IT_BYTEPOS (*(IT)); \
17342 if (IT_CHARPOS (*(IT)) > max_pos) \
17344 max_pos = IT_CHARPOS (*(IT)); \
17345 max_bpos = IT_BYTEPOS (*(IT)); \
17350 /* Loop generating characters. The loop is left with IT on the next
17351 character to display. */
17354 int n_glyphs_before
, hpos_before
, x_before
;
17356 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
17358 /* Retrieve the next thing to display. Value is zero if end of
17360 if (!get_next_display_element (it
))
17362 /* Maybe add a space at the end of this line that is used to
17363 display the cursor there under X. Set the charpos of the
17364 first glyph of blank lines not corresponding to any text
17366 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17367 row
->exact_window_width_line_p
= 1;
17368 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
17369 || row
->used
[TEXT_AREA
] == 0)
17371 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
17372 row
->displays_text_p
= 0;
17374 if (!NILP (XBUFFER (it
->w
->buffer
)->indicate_empty_lines
)
17375 && (!MINI_WINDOW_P (it
->w
)
17376 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
17377 row
->indicate_empty_line_p
= 1;
17380 it
->continuation_lines_width
= 0;
17381 row
->ends_at_zv_p
= 1;
17382 /* A row that displays right-to-left text must always have
17383 its last face extended all the way to the end of line,
17384 even if this row ends in ZV, because we still write to th
17385 screen left to right. */
17386 if (row
->reversed_p
)
17387 extend_face_to_end_of_line (it
);
17391 /* Now, get the metrics of what we want to display. This also
17392 generates glyphs in `row' (which is IT->glyph_row). */
17393 n_glyphs_before
= row
->used
[TEXT_AREA
];
17396 /* Remember the line height so far in case the next element doesn't
17397 fit on the line. */
17398 if (it
->line_wrap
!= TRUNCATE
)
17400 ascent
= it
->max_ascent
;
17401 descent
= it
->max_descent
;
17402 phys_ascent
= it
->max_phys_ascent
;
17403 phys_descent
= it
->max_phys_descent
;
17405 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
17407 if (IT_DISPLAYING_WHITESPACE (it
))
17413 wrap_row_used
= row
->used
[TEXT_AREA
];
17414 wrap_row_ascent
= row
->ascent
;
17415 wrap_row_height
= row
->height
;
17416 wrap_row_phys_ascent
= row
->phys_ascent
;
17417 wrap_row_phys_height
= row
->phys_height
;
17418 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
17419 wrap_row_min_pos
= min_pos
;
17420 wrap_row_min_bpos
= min_bpos
;
17421 wrap_row_max_pos
= max_pos
;
17422 wrap_row_max_bpos
= max_bpos
;
17428 PRODUCE_GLYPHS (it
);
17430 /* If this display element was in marginal areas, continue with
17432 if (it
->area
!= TEXT_AREA
)
17434 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17435 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17436 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17437 row
->phys_height
= max (row
->phys_height
,
17438 it
->max_phys_ascent
+ it
->max_phys_descent
);
17439 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17440 it
->max_extra_line_spacing
);
17441 set_iterator_to_next (it
, 1);
17445 /* Does the display element fit on the line? If we truncate
17446 lines, we should draw past the right edge of the window. If
17447 we don't truncate, we want to stop so that we can display the
17448 continuation glyph before the right margin. If lines are
17449 continued, there are two possible strategies for characters
17450 resulting in more than 1 glyph (e.g. tabs): Display as many
17451 glyphs as possible in this line and leave the rest for the
17452 continuation line, or display the whole element in the next
17453 line. Original redisplay did the former, so we do it also. */
17454 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
17455 hpos_before
= it
->hpos
;
17458 if (/* Not a newline. */
17460 /* Glyphs produced fit entirely in the line. */
17461 && it
->current_x
< it
->last_visible_x
)
17463 it
->hpos
+= nglyphs
;
17464 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17465 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17466 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17467 row
->phys_height
= max (row
->phys_height
,
17468 it
->max_phys_ascent
+ it
->max_phys_descent
);
17469 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17470 it
->max_extra_line_spacing
);
17471 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
17472 row
->x
= x
- it
->first_visible_x
;
17473 /* Record the maximum and minimum buffer positions seen so
17474 far in glyphs that will be displayed by this row. */
17476 RECORD_MAX_MIN_POS (it
);
17481 struct glyph
*glyph
;
17483 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
17485 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
17486 new_x
= x
+ glyph
->pixel_width
;
17488 if (/* Lines are continued. */
17489 it
->line_wrap
!= TRUNCATE
17490 && (/* Glyph doesn't fit on the line. */
17491 new_x
> it
->last_visible_x
17492 /* Or it fits exactly on a window system frame. */
17493 || (new_x
== it
->last_visible_x
17494 && FRAME_WINDOW_P (it
->f
))))
17496 /* End of a continued line. */
17499 || (new_x
== it
->last_visible_x
17500 && FRAME_WINDOW_P (it
->f
)))
17502 /* Current glyph is the only one on the line or
17503 fits exactly on the line. We must continue
17504 the line because we can't draw the cursor
17505 after the glyph. */
17506 row
->continued_p
= 1;
17507 it
->current_x
= new_x
;
17508 it
->continuation_lines_width
+= new_x
;
17510 /* Record the maximum and minimum buffer
17511 positions seen so far in glyphs that will be
17512 displayed by this row. */
17514 RECORD_MAX_MIN_POS (it
);
17515 if (i
== nglyphs
- 1)
17517 /* If line-wrap is on, check if a previous
17518 wrap point was found. */
17519 if (wrap_row_used
> 0
17520 /* Even if there is a previous wrap
17521 point, continue the line here as
17522 usual, if (i) the previous character
17523 was a space or tab AND (ii) the
17524 current character is not. */
17526 || IT_DISPLAYING_WHITESPACE (it
)))
17529 set_iterator_to_next (it
, 1);
17530 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17532 if (!get_next_display_element (it
))
17534 row
->exact_window_width_line_p
= 1;
17535 it
->continuation_lines_width
= 0;
17536 row
->continued_p
= 0;
17537 row
->ends_at_zv_p
= 1;
17539 else if (ITERATOR_AT_END_OF_LINE_P (it
))
17541 row
->continued_p
= 0;
17542 row
->exact_window_width_line_p
= 1;
17547 else if (CHAR_GLYPH_PADDING_P (*glyph
)
17548 && !FRAME_WINDOW_P (it
->f
))
17550 /* A padding glyph that doesn't fit on this line.
17551 This means the whole character doesn't fit
17553 if (row
->reversed_p
)
17554 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17555 - n_glyphs_before
);
17556 row
->used
[TEXT_AREA
] = n_glyphs_before
;
17558 /* Fill the rest of the row with continuation
17559 glyphs like in 20.x. */
17560 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
17561 < row
->glyphs
[1 + TEXT_AREA
])
17562 produce_special_glyphs (it
, IT_CONTINUATION
);
17564 row
->continued_p
= 1;
17565 it
->current_x
= x_before
;
17566 it
->continuation_lines_width
+= x_before
;
17568 /* Restore the height to what it was before the
17569 element not fitting on the line. */
17570 it
->max_ascent
= ascent
;
17571 it
->max_descent
= descent
;
17572 it
->max_phys_ascent
= phys_ascent
;
17573 it
->max_phys_descent
= phys_descent
;
17575 else if (wrap_row_used
> 0)
17578 if (row
->reversed_p
)
17579 unproduce_glyphs (it
,
17580 row
->used
[TEXT_AREA
] - wrap_row_used
);
17582 it
->continuation_lines_width
+= wrap_x
;
17583 row
->used
[TEXT_AREA
] = wrap_row_used
;
17584 row
->ascent
= wrap_row_ascent
;
17585 row
->height
= wrap_row_height
;
17586 row
->phys_ascent
= wrap_row_phys_ascent
;
17587 row
->phys_height
= wrap_row_phys_height
;
17588 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
17589 min_pos
= wrap_row_min_pos
;
17590 min_bpos
= wrap_row_min_bpos
;
17591 max_pos
= wrap_row_max_pos
;
17592 max_bpos
= wrap_row_max_bpos
;
17593 row
->continued_p
= 1;
17594 row
->ends_at_zv_p
= 0;
17595 row
->exact_window_width_line_p
= 0;
17596 it
->continuation_lines_width
+= x
;
17598 /* Make sure that a non-default face is extended
17599 up to the right margin of the window. */
17600 extend_face_to_end_of_line (it
);
17602 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
17604 /* A TAB that extends past the right edge of the
17605 window. This produces a single glyph on
17606 window system frames. We leave the glyph in
17607 this row and let it fill the row, but don't
17608 consume the TAB. */
17609 it
->continuation_lines_width
+= it
->last_visible_x
;
17610 row
->ends_in_middle_of_char_p
= 1;
17611 row
->continued_p
= 1;
17612 glyph
->pixel_width
= it
->last_visible_x
- x
;
17613 it
->starts_in_middle_of_char_p
= 1;
17617 /* Something other than a TAB that draws past
17618 the right edge of the window. Restore
17619 positions to values before the element. */
17620 if (row
->reversed_p
)
17621 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17622 - (n_glyphs_before
+ i
));
17623 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
17625 /* Display continuation glyphs. */
17626 if (!FRAME_WINDOW_P (it
->f
))
17627 produce_special_glyphs (it
, IT_CONTINUATION
);
17628 row
->continued_p
= 1;
17630 it
->current_x
= x_before
;
17631 it
->continuation_lines_width
+= x
;
17632 extend_face_to_end_of_line (it
);
17634 if (nglyphs
> 1 && i
> 0)
17636 row
->ends_in_middle_of_char_p
= 1;
17637 it
->starts_in_middle_of_char_p
= 1;
17640 /* Restore the height to what it was before the
17641 element not fitting on the line. */
17642 it
->max_ascent
= ascent
;
17643 it
->max_descent
= descent
;
17644 it
->max_phys_ascent
= phys_ascent
;
17645 it
->max_phys_descent
= phys_descent
;
17650 else if (new_x
> it
->first_visible_x
)
17652 /* Increment number of glyphs actually displayed. */
17655 /* Record the maximum and minimum buffer positions
17656 seen so far in glyphs that will be displayed by
17659 RECORD_MAX_MIN_POS (it
);
17661 if (x
< it
->first_visible_x
)
17662 /* Glyph is partially visible, i.e. row starts at
17663 negative X position. */
17664 row
->x
= x
- it
->first_visible_x
;
17668 /* Glyph is completely off the left margin of the
17669 window. This should not happen because of the
17670 move_it_in_display_line at the start of this
17671 function, unless the text display area of the
17672 window is empty. */
17673 xassert (it
->first_visible_x
<= it
->last_visible_x
);
17677 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17678 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17679 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17680 row
->phys_height
= max (row
->phys_height
,
17681 it
->max_phys_ascent
+ it
->max_phys_descent
);
17682 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17683 it
->max_extra_line_spacing
);
17685 /* End of this display line if row is continued. */
17686 if (row
->continued_p
|| row
->ends_at_zv_p
)
17691 /* Is this a line end? If yes, we're also done, after making
17692 sure that a non-default face is extended up to the right
17693 margin of the window. */
17694 if (ITERATOR_AT_END_OF_LINE_P (it
))
17696 int used_before
= row
->used
[TEXT_AREA
];
17698 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
17700 /* Add a space at the end of the line that is used to
17701 display the cursor there. */
17702 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17703 append_space_for_newline (it
, 0);
17705 /* Extend the face to the end of the line. */
17706 extend_face_to_end_of_line (it
);
17708 /* Make sure we have the position. */
17709 if (used_before
== 0)
17710 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
17712 /* Record the position of the newline, for use in
17714 it
->eol_pos
= it
->current
.pos
;
17716 /* Consume the line end. This skips over invisible lines. */
17717 set_iterator_to_next (it
, 1);
17718 it
->continuation_lines_width
= 0;
17722 /* Proceed with next display element. Note that this skips
17723 over lines invisible because of selective display. */
17724 set_iterator_to_next (it
, 1);
17726 /* If we truncate lines, we are done when the last displayed
17727 glyphs reach past the right margin of the window. */
17728 if (it
->line_wrap
== TRUNCATE
17729 && (FRAME_WINDOW_P (it
->f
)
17730 ? (it
->current_x
>= it
->last_visible_x
)
17731 : (it
->current_x
> it
->last_visible_x
)))
17733 /* Maybe add truncation glyphs. */
17734 if (!FRAME_WINDOW_P (it
->f
))
17738 if (!row
->reversed_p
)
17740 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
17741 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17746 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
17747 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17749 /* Remove any padding glyphs at the front of ROW, to
17750 make room for the truncation glyphs we will be
17751 adding below. The loop below always inserts at
17752 least one truncation glyph, so also remove the
17753 last glyph added to ROW. */
17754 unproduce_glyphs (it
, i
+ 1);
17755 /* Adjust i for the loop below. */
17756 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
17759 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
17761 row
->used
[TEXT_AREA
] = i
;
17762 produce_special_glyphs (it
, IT_TRUNCATION
);
17765 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17767 /* Don't truncate if we can overflow newline into fringe. */
17768 if (!get_next_display_element (it
))
17770 it
->continuation_lines_width
= 0;
17771 row
->ends_at_zv_p
= 1;
17772 row
->exact_window_width_line_p
= 1;
17775 if (ITERATOR_AT_END_OF_LINE_P (it
))
17777 row
->exact_window_width_line_p
= 1;
17778 goto at_end_of_line
;
17782 row
->truncated_on_right_p
= 1;
17783 it
->continuation_lines_width
= 0;
17784 reseat_at_next_visible_line_start (it
, 0);
17785 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
17786 it
->hpos
= hpos_before
;
17787 it
->current_x
= x_before
;
17792 /* If line is not empty and hscrolled, maybe insert truncation glyphs
17793 at the left window margin. */
17794 if (it
->first_visible_x
17795 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
17797 if (!FRAME_WINDOW_P (it
->f
))
17798 insert_left_trunc_glyphs (it
);
17799 row
->truncated_on_left_p
= 1;
17802 /* If the start of this line is the overlay arrow-position, then
17803 mark this glyph row as the one containing the overlay arrow.
17804 This is clearly a mess with variable size fonts. It would be
17805 better to let it be displayed like cursors under X. */
17806 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
17807 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
17808 !NILP (overlay_arrow_string
)))
17810 /* Overlay arrow in window redisplay is a fringe bitmap. */
17811 if (STRINGP (overlay_arrow_string
))
17813 struct glyph_row
*arrow_row
17814 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
17815 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
17816 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
17817 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
17818 struct glyph
*p2
, *end
;
17820 /* Copy the arrow glyphs. */
17821 while (glyph
< arrow_end
)
17824 /* Throw away padding glyphs. */
17826 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17827 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
17833 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
17838 xassert (INTEGERP (overlay_arrow_string
));
17839 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
17841 overlay_arrow_seen
= 1;
17844 /* Compute pixel dimensions of this line. */
17845 compute_line_metrics (it
);
17847 /* Remember the position at which this line ends. */
17848 row
->end
= it
->current
;
17851 row
->minpos
= row
->start
.pos
;
17852 row
->maxpos
= row
->end
.pos
;
17856 /* ROW->minpos and ROW->maxpos must be the smallest and
17857 `1 + the largest' buffer positions in ROW. But if ROW was
17858 bidi-reordered, these two positions can be anywhere in the
17859 row, so we must determine them now. */
17860 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
17863 /* Record whether this row ends inside an ellipsis. */
17864 row
->ends_in_ellipsis_p
17865 = (it
->method
== GET_FROM_DISPLAY_VECTOR
17866 && it
->ellipsis_p
);
17868 /* Save fringe bitmaps in this row. */
17869 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
17870 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
17871 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
17872 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
17874 it
->left_user_fringe_bitmap
= 0;
17875 it
->left_user_fringe_face_id
= 0;
17876 it
->right_user_fringe_bitmap
= 0;
17877 it
->right_user_fringe_face_id
= 0;
17879 /* Maybe set the cursor. */
17880 cvpos
= it
->w
->cursor
.vpos
;
17882 /* In bidi-reordered rows, keep checking for proper cursor
17883 position even if one has been found already, because buffer
17884 positions in such rows change non-linearly with ROW->VPOS,
17885 when a line is continued. One exception: when we are at ZV,
17886 display cursor on the first suitable glyph row, since all
17887 the empty rows after that also have their position set to ZV. */
17888 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17889 lines' rows is implemented for bidi-reordered rows. */
17891 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
17892 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
17893 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
17894 && cursor_row_p (it
->w
, row
))
17895 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
17897 /* Highlight trailing whitespace. */
17898 if (!NILP (Vshow_trailing_whitespace
))
17899 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
17901 /* Prepare for the next line. This line starts horizontally at (X
17902 HPOS) = (0 0). Vertical positions are incremented. As a
17903 convenience for the caller, IT->glyph_row is set to the next
17905 it
->current_x
= it
->hpos
= 0;
17906 it
->current_y
+= row
->height
;
17907 SET_TEXT_POS (it
->eol_pos
, 0, 0);
17910 /* The next row should by default use the same value of the
17911 reversed_p flag as this one. set_iterator_to_next decides when
17912 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
17913 the flag accordingly. */
17914 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
17915 it
->glyph_row
->reversed_p
= row
->reversed_p
;
17916 it
->start
= row
->end
;
17917 return row
->displays_text_p
;
17919 #undef RECORD_MAX_MIN_POS
17922 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
17923 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
17924 doc
: /* Return paragraph direction at point in BUFFER.
17925 Value is either `left-to-right' or `right-to-left'.
17926 If BUFFER is omitted or nil, it defaults to the current buffer.
17928 Paragraph direction determines how the text in the paragraph is displayed.
17929 In left-to-right paragraphs, text begins at the left margin of the window
17930 and the reading direction is generally left to right. In right-to-left
17931 paragraphs, text begins at the right margin and is read from right to left.
17933 See also `bidi-paragraph-direction'. */)
17934 (Lisp_Object buffer
)
17936 struct buffer
*buf
;
17937 struct buffer
*old
;
17940 buf
= current_buffer
;
17943 CHECK_BUFFER (buffer
);
17944 buf
= XBUFFER (buffer
);
17945 old
= current_buffer
;
17948 if (NILP (buf
->bidi_display_reordering
))
17949 return Qleft_to_right
;
17950 else if (!NILP (buf
->bidi_paragraph_direction
))
17951 return buf
->bidi_paragraph_direction
;
17954 /* Determine the direction from buffer text. We could try to
17955 use current_matrix if it is up to date, but this seems fast
17956 enough as it is. */
17957 struct bidi_it itb
;
17958 EMACS_INT pos
= BUF_PT (buf
);
17959 EMACS_INT bytepos
= BUF_PT_BYTE (buf
);
17961 if (buf
!= current_buffer
)
17962 set_buffer_temp (buf
);
17963 /* Find previous non-empty line. */
17964 if (pos
>= ZV
&& pos
> BEGV
)
17967 bytepos
= CHAR_TO_BYTE (pos
);
17969 while (FETCH_BYTE (bytepos
) == '\n')
17971 if (bytepos
<= BEGV_BYTE
)
17976 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
17979 itb
.bytepos
= bytepos
;
17982 bidi_paragraph_init (NEUTRAL_DIR
, &itb
);
17983 if (buf
!= current_buffer
)
17984 set_buffer_temp (old
);
17985 switch (itb
.paragraph_dir
)
17988 return Qleft_to_right
;
17991 return Qright_to_left
;
18001 /***********************************************************************
18003 ***********************************************************************/
18005 /* Redisplay the menu bar in the frame for window W.
18007 The menu bar of X frames that don't have X toolkit support is
18008 displayed in a special window W->frame->menu_bar_window.
18010 The menu bar of terminal frames is treated specially as far as
18011 glyph matrices are concerned. Menu bar lines are not part of
18012 windows, so the update is done directly on the frame matrix rows
18013 for the menu bar. */
18016 display_menu_bar (struct window
*w
)
18018 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18023 /* Don't do all this for graphical frames. */
18025 if (FRAME_W32_P (f
))
18028 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
18034 if (FRAME_NS_P (f
))
18036 #endif /* HAVE_NS */
18038 #ifdef USE_X_TOOLKIT
18039 xassert (!FRAME_WINDOW_P (f
));
18040 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
18041 it
.first_visible_x
= 0;
18042 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18043 #else /* not USE_X_TOOLKIT */
18044 if (FRAME_WINDOW_P (f
))
18046 /* Menu bar lines are displayed in the desired matrix of the
18047 dummy window menu_bar_window. */
18048 struct window
*menu_w
;
18049 xassert (WINDOWP (f
->menu_bar_window
));
18050 menu_w
= XWINDOW (f
->menu_bar_window
);
18051 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
18053 it
.first_visible_x
= 0;
18054 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18058 /* This is a TTY frame, i.e. character hpos/vpos are used as
18060 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
18062 it
.first_visible_x
= 0;
18063 it
.last_visible_x
= FRAME_COLS (f
);
18065 #endif /* not USE_X_TOOLKIT */
18067 if (! mode_line_inverse_video
)
18068 /* Force the menu-bar to be displayed in the default face. */
18069 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18071 /* Clear all rows of the menu bar. */
18072 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
18074 struct glyph_row
*row
= it
.glyph_row
+ i
;
18075 clear_glyph_row (row
);
18076 row
->enabled_p
= 1;
18077 row
->full_width_p
= 1;
18080 /* Display all items of the menu bar. */
18081 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
18082 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
18084 Lisp_Object string
;
18086 /* Stop at nil string. */
18087 string
= AREF (items
, i
+ 1);
18091 /* Remember where item was displayed. */
18092 ASET (items
, i
+ 3, make_number (it
.hpos
));
18094 /* Display the item, pad with one space. */
18095 if (it
.current_x
< it
.last_visible_x
)
18096 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
18097 SCHARS (string
) + 1, 0, 0, -1);
18100 /* Fill out the line with spaces. */
18101 if (it
.current_x
< it
.last_visible_x
)
18102 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
18104 /* Compute the total height of the lines. */
18105 compute_line_metrics (&it
);
18110 /***********************************************************************
18112 ***********************************************************************/
18114 /* Redisplay mode lines in the window tree whose root is WINDOW. If
18115 FORCE is non-zero, redisplay mode lines unconditionally.
18116 Otherwise, redisplay only mode lines that are garbaged. Value is
18117 the number of windows whose mode lines were redisplayed. */
18120 redisplay_mode_lines (Lisp_Object window
, int force
)
18124 while (!NILP (window
))
18126 struct window
*w
= XWINDOW (window
);
18128 if (WINDOWP (w
->hchild
))
18129 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
18130 else if (WINDOWP (w
->vchild
))
18131 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
18133 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
18134 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
18136 struct text_pos lpoint
;
18137 struct buffer
*old
= current_buffer
;
18139 /* Set the window's buffer for the mode line display. */
18140 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
18141 set_buffer_internal_1 (XBUFFER (w
->buffer
));
18143 /* Point refers normally to the selected window. For any
18144 other window, set up appropriate value. */
18145 if (!EQ (window
, selected_window
))
18147 struct text_pos pt
;
18149 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
18150 if (CHARPOS (pt
) < BEGV
)
18151 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
18152 else if (CHARPOS (pt
) > (ZV
- 1))
18153 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
18155 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
18158 /* Display mode lines. */
18159 clear_glyph_matrix (w
->desired_matrix
);
18160 if (display_mode_lines (w
))
18163 w
->must_be_updated_p
= 1;
18166 /* Restore old settings. */
18167 set_buffer_internal_1 (old
);
18168 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
18178 /* Display the mode and/or header line of window W. Value is the
18179 sum number of mode lines and header lines displayed. */
18182 display_mode_lines (struct window
*w
)
18184 Lisp_Object old_selected_window
, old_selected_frame
;
18187 old_selected_frame
= selected_frame
;
18188 selected_frame
= w
->frame
;
18189 old_selected_window
= selected_window
;
18190 XSETWINDOW (selected_window
, w
);
18192 /* These will be set while the mode line specs are processed. */
18193 line_number_displayed
= 0;
18194 w
->column_number_displayed
= Qnil
;
18196 if (WINDOW_WANTS_MODELINE_P (w
))
18198 struct window
*sel_w
= XWINDOW (old_selected_window
);
18200 /* Select mode line face based on the real selected window. */
18201 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
18202 current_buffer
->mode_line_format
);
18206 if (WINDOW_WANTS_HEADER_LINE_P (w
))
18208 display_mode_line (w
, HEADER_LINE_FACE_ID
,
18209 current_buffer
->header_line_format
);
18213 selected_frame
= old_selected_frame
;
18214 selected_window
= old_selected_window
;
18219 /* Display mode or header line of window W. FACE_ID specifies which
18220 line to display; it is either MODE_LINE_FACE_ID or
18221 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
18222 display. Value is the pixel height of the mode/header line
18226 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
18230 int count
= SPECPDL_INDEX ();
18232 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
18233 /* Don't extend on a previously drawn mode-line.
18234 This may happen if called from pos_visible_p. */
18235 it
.glyph_row
->enabled_p
= 0;
18236 prepare_desired_row (it
.glyph_row
);
18238 it
.glyph_row
->mode_line_p
= 1;
18240 if (! mode_line_inverse_video
)
18241 /* Force the mode-line to be displayed in the default face. */
18242 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18244 record_unwind_protect (unwind_format_mode_line
,
18245 format_mode_line_unwind_data (NULL
, Qnil
, 0));
18247 mode_line_target
= MODE_LINE_DISPLAY
;
18249 /* Temporarily make frame's keyboard the current kboard so that
18250 kboard-local variables in the mode_line_format will get the right
18252 push_kboard (FRAME_KBOARD (it
.f
));
18253 record_unwind_save_match_data ();
18254 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
18257 unbind_to (count
, Qnil
);
18259 /* Fill up with spaces. */
18260 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
18262 compute_line_metrics (&it
);
18263 it
.glyph_row
->full_width_p
= 1;
18264 it
.glyph_row
->continued_p
= 0;
18265 it
.glyph_row
->truncated_on_left_p
= 0;
18266 it
.glyph_row
->truncated_on_right_p
= 0;
18268 /* Make a 3D mode-line have a shadow at its right end. */
18269 face
= FACE_FROM_ID (it
.f
, face_id
);
18270 extend_face_to_end_of_line (&it
);
18271 if (face
->box
!= FACE_NO_BOX
)
18273 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
18274 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
18275 last
->right_box_line_p
= 1;
18278 return it
.glyph_row
->height
;
18281 /* Move element ELT in LIST to the front of LIST.
18282 Return the updated list. */
18285 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
18287 register Lisp_Object tail
, prev
;
18288 register Lisp_Object tem
;
18292 while (CONSP (tail
))
18298 /* Splice out the link TAIL. */
18300 list
= XCDR (tail
);
18302 Fsetcdr (prev
, XCDR (tail
));
18304 /* Now make it the first. */
18305 Fsetcdr (tail
, list
);
18310 tail
= XCDR (tail
);
18314 /* Not found--return unchanged LIST. */
18318 /* Contribute ELT to the mode line for window IT->w. How it
18319 translates into text depends on its data type.
18321 IT describes the display environment in which we display, as usual.
18323 DEPTH is the depth in recursion. It is used to prevent
18324 infinite recursion here.
18326 FIELD_WIDTH is the number of characters the display of ELT should
18327 occupy in the mode line, and PRECISION is the maximum number of
18328 characters to display from ELT's representation. See
18329 display_string for details.
18331 Returns the hpos of the end of the text generated by ELT.
18333 PROPS is a property list to add to any string we encounter.
18335 If RISKY is nonzero, remove (disregard) any properties in any string
18336 we encounter, and ignore :eval and :propertize.
18338 The global variable `mode_line_target' determines whether the
18339 output is passed to `store_mode_line_noprop',
18340 `store_mode_line_string', or `display_string'. */
18343 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
18344 Lisp_Object elt
, Lisp_Object props
, int risky
)
18346 int n
= 0, field
, prec
;
18351 elt
= build_string ("*too-deep*");
18355 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
18359 /* A string: output it and check for %-constructs within it. */
18363 if (SCHARS (elt
) > 0
18364 && (!NILP (props
) || risky
))
18366 Lisp_Object oprops
, aelt
;
18367 oprops
= Ftext_properties_at (make_number (0), elt
);
18369 /* If the starting string's properties are not what
18370 we want, translate the string. Also, if the string
18371 is risky, do that anyway. */
18373 if (NILP (Fequal (props
, oprops
)) || risky
)
18375 /* If the starting string has properties,
18376 merge the specified ones onto the existing ones. */
18377 if (! NILP (oprops
) && !risky
)
18381 oprops
= Fcopy_sequence (oprops
);
18383 while (CONSP (tem
))
18385 oprops
= Fplist_put (oprops
, XCAR (tem
),
18386 XCAR (XCDR (tem
)));
18387 tem
= XCDR (XCDR (tem
));
18392 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
18393 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
18395 /* AELT is what we want. Move it to the front
18396 without consing. */
18398 mode_line_proptrans_alist
18399 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
18405 /* If AELT has the wrong props, it is useless.
18406 so get rid of it. */
18408 mode_line_proptrans_alist
18409 = Fdelq (aelt
, mode_line_proptrans_alist
);
18411 elt
= Fcopy_sequence (elt
);
18412 Fset_text_properties (make_number (0), Flength (elt
),
18414 /* Add this item to mode_line_proptrans_alist. */
18415 mode_line_proptrans_alist
18416 = Fcons (Fcons (elt
, props
),
18417 mode_line_proptrans_alist
);
18418 /* Truncate mode_line_proptrans_alist
18419 to at most 50 elements. */
18420 tem
= Fnthcdr (make_number (50),
18421 mode_line_proptrans_alist
);
18423 XSETCDR (tem
, Qnil
);
18432 prec
= precision
- n
;
18433 switch (mode_line_target
)
18435 case MODE_LINE_NOPROP
:
18436 case MODE_LINE_TITLE
:
18437 n
+= store_mode_line_noprop (SDATA (elt
), -1, prec
);
18439 case MODE_LINE_STRING
:
18440 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
18442 case MODE_LINE_DISPLAY
:
18443 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
18444 0, prec
, 0, STRING_MULTIBYTE (elt
));
18451 /* Handle the non-literal case. */
18453 while ((precision
<= 0 || n
< precision
)
18454 && SREF (elt
, offset
) != 0
18455 && (mode_line_target
!= MODE_LINE_DISPLAY
18456 || it
->current_x
< it
->last_visible_x
))
18458 int last_offset
= offset
;
18460 /* Advance to end of string or next format specifier. */
18461 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
18464 if (offset
- 1 != last_offset
)
18466 int nchars
, nbytes
;
18468 /* Output to end of string or up to '%'. Field width
18469 is length of string. Don't output more than
18470 PRECISION allows us. */
18473 prec
= c_string_width (SDATA (elt
) + last_offset
,
18474 offset
- last_offset
, precision
- n
,
18477 switch (mode_line_target
)
18479 case MODE_LINE_NOPROP
:
18480 case MODE_LINE_TITLE
:
18481 n
+= store_mode_line_noprop (SDATA (elt
) + last_offset
, 0, prec
);
18483 case MODE_LINE_STRING
:
18485 int bytepos
= last_offset
;
18486 int charpos
= string_byte_to_char (elt
, bytepos
);
18487 int endpos
= (precision
<= 0
18488 ? string_byte_to_char (elt
, offset
)
18489 : charpos
+ nchars
);
18491 n
+= store_mode_line_string (NULL
,
18492 Fsubstring (elt
, make_number (charpos
),
18493 make_number (endpos
)),
18497 case MODE_LINE_DISPLAY
:
18499 int bytepos
= last_offset
;
18500 int charpos
= string_byte_to_char (elt
, bytepos
);
18502 if (precision
<= 0)
18503 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
18504 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
18506 STRING_MULTIBYTE (elt
));
18511 else /* c == '%' */
18513 int percent_position
= offset
;
18515 /* Get the specified minimum width. Zero means
18518 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
18519 field
= field
* 10 + c
- '0';
18521 /* Don't pad beyond the total padding allowed. */
18522 if (field_width
- n
> 0 && field
> field_width
- n
)
18523 field
= field_width
- n
;
18525 /* Note that either PRECISION <= 0 or N < PRECISION. */
18526 prec
= precision
- n
;
18529 n
+= display_mode_element (it
, depth
, field
, prec
,
18530 Vglobal_mode_string
, props
,
18535 int bytepos
, charpos
;
18536 unsigned char *spec
;
18537 Lisp_Object string
;
18539 bytepos
= percent_position
;
18540 charpos
= (STRING_MULTIBYTE (elt
)
18541 ? string_byte_to_char (elt
, bytepos
)
18543 spec
= decode_mode_spec (it
->w
, c
, field
, prec
, &string
);
18544 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
18546 switch (mode_line_target
)
18548 case MODE_LINE_NOPROP
:
18549 case MODE_LINE_TITLE
:
18550 n
+= store_mode_line_noprop (spec
, field
, prec
);
18552 case MODE_LINE_STRING
:
18554 int len
= strlen (spec
);
18555 Lisp_Object tem
= make_string (spec
, len
);
18556 props
= Ftext_properties_at (make_number (charpos
), elt
);
18557 /* Should only keep face property in props */
18558 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
18561 case MODE_LINE_DISPLAY
:
18563 int nglyphs_before
, nwritten
;
18565 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
18566 nwritten
= display_string (spec
, string
, elt
,
18571 /* Assign to the glyphs written above the
18572 string where the `%x' came from, position
18576 struct glyph
*glyph
18577 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
18581 for (i
= 0; i
< nwritten
; ++i
)
18583 glyph
[i
].object
= elt
;
18584 glyph
[i
].charpos
= charpos
;
18601 /* A symbol: process the value of the symbol recursively
18602 as if it appeared here directly. Avoid error if symbol void.
18603 Special case: if value of symbol is a string, output the string
18606 register Lisp_Object tem
;
18608 /* If the variable is not marked as risky to set
18609 then its contents are risky to use. */
18610 if (NILP (Fget (elt
, Qrisky_local_variable
)))
18613 tem
= Fboundp (elt
);
18616 tem
= Fsymbol_value (elt
);
18617 /* If value is a string, output that string literally:
18618 don't check for % within it. */
18622 if (!EQ (tem
, elt
))
18624 /* Give up right away for nil or t. */
18634 register Lisp_Object car
, tem
;
18636 /* A cons cell: five distinct cases.
18637 If first element is :eval or :propertize, do something special.
18638 If first element is a string or a cons, process all the elements
18639 and effectively concatenate them.
18640 If first element is a negative number, truncate displaying cdr to
18641 at most that many characters. If positive, pad (with spaces)
18642 to at least that many characters.
18643 If first element is a symbol, process the cadr or caddr recursively
18644 according to whether the symbol's value is non-nil or nil. */
18646 if (EQ (car
, QCeval
))
18648 /* An element of the form (:eval FORM) means evaluate FORM
18649 and use the result as mode line elements. */
18654 if (CONSP (XCDR (elt
)))
18657 spec
= safe_eval (XCAR (XCDR (elt
)));
18658 n
+= display_mode_element (it
, depth
, field_width
- n
,
18659 precision
- n
, spec
, props
,
18663 else if (EQ (car
, QCpropertize
))
18665 /* An element of the form (:propertize ELT PROPS...)
18666 means display ELT but applying properties PROPS. */
18671 if (CONSP (XCDR (elt
)))
18672 n
+= display_mode_element (it
, depth
, field_width
- n
,
18673 precision
- n
, XCAR (XCDR (elt
)),
18674 XCDR (XCDR (elt
)), risky
);
18676 else if (SYMBOLP (car
))
18678 tem
= Fboundp (car
);
18682 /* elt is now the cdr, and we know it is a cons cell.
18683 Use its car if CAR has a non-nil value. */
18686 tem
= Fsymbol_value (car
);
18693 /* Symbol's value is nil (or symbol is unbound)
18694 Get the cddr of the original list
18695 and if possible find the caddr and use that. */
18699 else if (!CONSP (elt
))
18704 else if (INTEGERP (car
))
18706 register int lim
= XINT (car
);
18710 /* Negative int means reduce maximum width. */
18711 if (precision
<= 0)
18714 precision
= min (precision
, -lim
);
18718 /* Padding specified. Don't let it be more than
18719 current maximum. */
18721 lim
= min (precision
, lim
);
18723 /* If that's more padding than already wanted, queue it.
18724 But don't reduce padding already specified even if
18725 that is beyond the current truncation point. */
18726 field_width
= max (lim
, field_width
);
18730 else if (STRINGP (car
) || CONSP (car
))
18732 Lisp_Object halftail
= elt
;
18736 && (precision
<= 0 || n
< precision
))
18738 n
+= display_mode_element (it
, depth
,
18739 /* Do padding only after the last
18740 element in the list. */
18741 (! CONSP (XCDR (elt
))
18744 precision
- n
, XCAR (elt
),
18748 if ((len
& 1) == 0)
18749 halftail
= XCDR (halftail
);
18750 /* Check for cycle. */
18751 if (EQ (halftail
, elt
))
18760 elt
= build_string ("*invalid*");
18764 /* Pad to FIELD_WIDTH. */
18765 if (field_width
> 0 && n
< field_width
)
18767 switch (mode_line_target
)
18769 case MODE_LINE_NOPROP
:
18770 case MODE_LINE_TITLE
:
18771 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
18773 case MODE_LINE_STRING
:
18774 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
18776 case MODE_LINE_DISPLAY
:
18777 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
18786 /* Store a mode-line string element in mode_line_string_list.
18788 If STRING is non-null, display that C string. Otherwise, the Lisp
18789 string LISP_STRING is displayed.
18791 FIELD_WIDTH is the minimum number of output glyphs to produce.
18792 If STRING has fewer characters than FIELD_WIDTH, pad to the right
18793 with spaces. FIELD_WIDTH <= 0 means don't pad.
18795 PRECISION is the maximum number of characters to output from
18796 STRING. PRECISION <= 0 means don't truncate the string.
18798 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
18799 properties to the string.
18801 PROPS are the properties to add to the string.
18802 The mode_line_string_face face property is always added to the string.
18806 store_mode_line_string (char *string
, Lisp_Object lisp_string
, int copy_string
,
18807 int field_width
, int precision
, Lisp_Object props
)
18812 if (string
!= NULL
)
18814 len
= strlen (string
);
18815 if (precision
> 0 && len
> precision
)
18817 lisp_string
= make_string (string
, len
);
18819 props
= mode_line_string_face_prop
;
18820 else if (!NILP (mode_line_string_face
))
18822 Lisp_Object face
= Fplist_get (props
, Qface
);
18823 props
= Fcopy_sequence (props
);
18825 face
= mode_line_string_face
;
18827 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
18828 props
= Fplist_put (props
, Qface
, face
);
18830 Fadd_text_properties (make_number (0), make_number (len
),
18831 props
, lisp_string
);
18835 len
= XFASTINT (Flength (lisp_string
));
18836 if (precision
> 0 && len
> precision
)
18839 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
18842 if (!NILP (mode_line_string_face
))
18846 props
= Ftext_properties_at (make_number (0), lisp_string
);
18847 face
= Fplist_get (props
, Qface
);
18849 face
= mode_line_string_face
;
18851 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
18852 props
= Fcons (Qface
, Fcons (face
, Qnil
));
18854 lisp_string
= Fcopy_sequence (lisp_string
);
18857 Fadd_text_properties (make_number (0), make_number (len
),
18858 props
, lisp_string
);
18863 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
18867 if (field_width
> len
)
18869 field_width
-= len
;
18870 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
18872 Fadd_text_properties (make_number (0), make_number (field_width
),
18873 props
, lisp_string
);
18874 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
18882 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
18884 doc
: /* Format a string out of a mode line format specification.
18885 First arg FORMAT specifies the mode line format (see `mode-line-format'
18886 for details) to use.
18888 Optional second arg FACE specifies the face property to put
18889 on all characters for which no face is specified.
18890 The value t means whatever face the window's mode line currently uses
18891 \(either `mode-line' or `mode-line-inactive', depending).
18892 A value of nil means the default is no face property.
18893 If FACE is an integer, the value string has no text properties.
18895 Optional third and fourth args WINDOW and BUFFER specify the window
18896 and buffer to use as the context for the formatting (defaults
18897 are the selected window and the window's buffer). */)
18898 (Lisp_Object format
, Lisp_Object face
, Lisp_Object window
, Lisp_Object buffer
)
18903 struct buffer
*old_buffer
= NULL
;
18905 int no_props
= INTEGERP (face
);
18906 int count
= SPECPDL_INDEX ();
18908 int string_start
= 0;
18911 window
= selected_window
;
18912 CHECK_WINDOW (window
);
18913 w
= XWINDOW (window
);
18916 buffer
= w
->buffer
;
18917 CHECK_BUFFER (buffer
);
18919 /* Make formatting the modeline a non-op when noninteractive, otherwise
18920 there will be problems later caused by a partially initialized frame. */
18921 if (NILP (format
) || noninteractive
)
18922 return empty_unibyte_string
;
18930 face
= (EQ (window
, selected_window
) ? Qmode_line
: Qmode_line_inactive
);
18931 face_id
= lookup_named_face (XFRAME (WINDOW_FRAME (w
)), face
, 0);
18935 face_id
= DEFAULT_FACE_ID
;
18937 if (XBUFFER (buffer
) != current_buffer
)
18938 old_buffer
= current_buffer
;
18940 /* Save things including mode_line_proptrans_alist,
18941 and set that to nil so that we don't alter the outer value. */
18942 record_unwind_protect (unwind_format_mode_line
,
18943 format_mode_line_unwind_data
18944 (old_buffer
, selected_window
, 1));
18945 mode_line_proptrans_alist
= Qnil
;
18947 Fselect_window (window
, Qt
);
18949 set_buffer_internal_1 (XBUFFER (buffer
));
18951 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
18955 mode_line_target
= MODE_LINE_NOPROP
;
18956 mode_line_string_face_prop
= Qnil
;
18957 mode_line_string_list
= Qnil
;
18958 string_start
= MODE_LINE_NOPROP_LEN (0);
18962 mode_line_target
= MODE_LINE_STRING
;
18963 mode_line_string_list
= Qnil
;
18964 mode_line_string_face
= face
;
18965 mode_line_string_face_prop
18966 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
18969 push_kboard (FRAME_KBOARD (it
.f
));
18970 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
18975 len
= MODE_LINE_NOPROP_LEN (string_start
);
18976 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
18980 mode_line_string_list
= Fnreverse (mode_line_string_list
);
18981 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
18982 empty_unibyte_string
);
18985 unbind_to (count
, Qnil
);
18989 /* Write a null-terminated, right justified decimal representation of
18990 the positive integer D to BUF using a minimal field width WIDTH. */
18993 pint2str (register char *buf
, register int width
, register int d
)
18995 register char *p
= buf
;
19003 *p
++ = d
% 10 + '0';
19008 for (width
-= (int) (p
- buf
); width
> 0; --width
)
19019 /* Write a null-terminated, right justified decimal and "human
19020 readable" representation of the nonnegative integer D to BUF using
19021 a minimal field width WIDTH. D should be smaller than 999.5e24. */
19023 static const char power_letter
[] =
19037 pint2hrstr (char *buf
, int width
, int d
)
19039 /* We aim to represent the nonnegative integer D as
19040 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
19043 /* -1 means: do not use TENTHS. */
19047 /* Length of QUOTIENT.TENTHS as a string. */
19053 if (1000 <= quotient
)
19055 /* Scale to the appropriate EXPONENT. */
19058 remainder
= quotient
% 1000;
19062 while (1000 <= quotient
);
19064 /* Round to nearest and decide whether to use TENTHS or not. */
19067 tenths
= remainder
/ 100;
19068 if (50 <= remainder
% 100)
19075 if (quotient
== 10)
19083 if (500 <= remainder
)
19085 if (quotient
< 999)
19096 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
19097 if (tenths
== -1 && quotient
<= 99)
19104 p
= psuffix
= buf
+ max (width
, length
);
19106 /* Print EXPONENT. */
19108 *psuffix
++ = power_letter
[exponent
];
19111 /* Print TENTHS. */
19114 *--p
= '0' + tenths
;
19118 /* Print QUOTIENT. */
19121 int digit
= quotient
% 10;
19122 *--p
= '0' + digit
;
19124 while ((quotient
/= 10) != 0);
19126 /* Print leading spaces. */
19131 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
19132 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
19133 type of CODING_SYSTEM. Return updated pointer into BUF. */
19135 static unsigned char invalid_eol_type
[] = "(*invalid*)";
19138 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
19141 int multibyte
= !NILP (current_buffer
->enable_multibyte_characters
);
19142 const unsigned char *eol_str
;
19144 /* The EOL conversion we are using. */
19145 Lisp_Object eoltype
;
19147 val
= CODING_SYSTEM_SPEC (coding_system
);
19150 if (!VECTORP (val
)) /* Not yet decided. */
19155 eoltype
= eol_mnemonic_undecided
;
19156 /* Don't mention EOL conversion if it isn't decided. */
19161 Lisp_Object eolvalue
;
19163 attrs
= AREF (val
, 0);
19164 eolvalue
= AREF (val
, 2);
19167 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
19171 /* The EOL conversion that is normal on this system. */
19173 if (NILP (eolvalue
)) /* Not yet decided. */
19174 eoltype
= eol_mnemonic_undecided
;
19175 else if (VECTORP (eolvalue
)) /* Not yet decided. */
19176 eoltype
= eol_mnemonic_undecided
;
19177 else /* eolvalue is Qunix, Qdos, or Qmac. */
19178 eoltype
= (EQ (eolvalue
, Qunix
)
19179 ? eol_mnemonic_unix
19180 : (EQ (eolvalue
, Qdos
) == 1
19181 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
19187 /* Mention the EOL conversion if it is not the usual one. */
19188 if (STRINGP (eoltype
))
19190 eol_str
= SDATA (eoltype
);
19191 eol_str_len
= SBYTES (eoltype
);
19193 else if (CHARACTERP (eoltype
))
19195 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
19196 eol_str_len
= CHAR_STRING (XINT (eoltype
), tmp
);
19201 eol_str
= invalid_eol_type
;
19202 eol_str_len
= sizeof (invalid_eol_type
) - 1;
19204 memcpy (buf
, eol_str
, eol_str_len
);
19205 buf
+= eol_str_len
;
19211 /* Return a string for the output of a mode line %-spec for window W,
19212 generated by character C. PRECISION >= 0 means don't return a
19213 string longer than that value. FIELD_WIDTH > 0 means pad the
19214 string returned with spaces to that value. Return a Lisp string in
19215 *STRING if the resulting string is taken from that Lisp string.
19217 Note we operate on the current buffer for most purposes,
19218 the exception being w->base_line_pos. */
19220 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
19223 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
19224 int precision
, Lisp_Object
*string
)
19227 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19228 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
19229 struct buffer
*b
= current_buffer
;
19237 if (!NILP (b
->read_only
))
19239 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19244 /* This differs from %* only for a modified read-only buffer. */
19245 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19247 if (!NILP (b
->read_only
))
19252 /* This differs from %* in ignoring read-only-ness. */
19253 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19265 if (command_loop_level
> 5)
19267 p
= decode_mode_spec_buf
;
19268 for (i
= 0; i
< command_loop_level
; i
++)
19271 return decode_mode_spec_buf
;
19279 if (command_loop_level
> 5)
19281 p
= decode_mode_spec_buf
;
19282 for (i
= 0; i
< command_loop_level
; i
++)
19285 return decode_mode_spec_buf
;
19292 /* Let lots_of_dashes be a string of infinite length. */
19293 if (mode_line_target
== MODE_LINE_NOPROP
||
19294 mode_line_target
== MODE_LINE_STRING
)
19296 if (field_width
<= 0
19297 || field_width
> sizeof (lots_of_dashes
))
19299 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
19300 decode_mode_spec_buf
[i
] = '-';
19301 decode_mode_spec_buf
[i
] = '\0';
19302 return decode_mode_spec_buf
;
19305 return lots_of_dashes
;
19313 /* %c and %l are ignored in `frame-title-format'.
19314 (In redisplay_internal, the frame title is drawn _before_ the
19315 windows are updated, so the stuff which depends on actual
19316 window contents (such as %l) may fail to render properly, or
19317 even crash emacs.) */
19318 if (mode_line_target
== MODE_LINE_TITLE
)
19322 int col
= (int) current_column (); /* iftc */
19323 w
->column_number_displayed
= make_number (col
);
19324 pint2str (decode_mode_spec_buf
, field_width
, col
);
19325 return decode_mode_spec_buf
;
19329 #ifndef SYSTEM_MALLOC
19331 if (NILP (Vmemory_full
))
19334 return "!MEM FULL! ";
19341 /* %F displays the frame name. */
19342 if (!NILP (f
->title
))
19343 return (char *) SDATA (f
->title
);
19344 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
19345 return (char *) SDATA (f
->name
);
19354 int size
= ZV
- BEGV
;
19355 pint2str (decode_mode_spec_buf
, field_width
, size
);
19356 return decode_mode_spec_buf
;
19361 int size
= ZV
- BEGV
;
19362 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
19363 return decode_mode_spec_buf
;
19368 int startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
19369 int topline
, nlines
, junk
, height
;
19371 /* %c and %l are ignored in `frame-title-format'. */
19372 if (mode_line_target
== MODE_LINE_TITLE
)
19375 startpos
= XMARKER (w
->start
)->charpos
;
19376 startpos_byte
= marker_byte_position (w
->start
);
19377 height
= WINDOW_TOTAL_LINES (w
);
19379 /* If we decided that this buffer isn't suitable for line numbers,
19380 don't forget that too fast. */
19381 if (EQ (w
->base_line_pos
, w
->buffer
))
19383 /* But do forget it, if the window shows a different buffer now. */
19384 else if (BUFFERP (w
->base_line_pos
))
19385 w
->base_line_pos
= Qnil
;
19387 /* If the buffer is very big, don't waste time. */
19388 if (INTEGERP (Vline_number_display_limit
)
19389 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
19391 w
->base_line_pos
= Qnil
;
19392 w
->base_line_number
= Qnil
;
19396 if (INTEGERP (w
->base_line_number
)
19397 && INTEGERP (w
->base_line_pos
)
19398 && XFASTINT (w
->base_line_pos
) <= startpos
)
19400 line
= XFASTINT (w
->base_line_number
);
19401 linepos
= XFASTINT (w
->base_line_pos
);
19402 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
19407 linepos
= BUF_BEGV (b
);
19408 linepos_byte
= BUF_BEGV_BYTE (b
);
19411 /* Count lines from base line to window start position. */
19412 nlines
= display_count_lines (linepos
, linepos_byte
,
19416 topline
= nlines
+ line
;
19418 /* Determine a new base line, if the old one is too close
19419 or too far away, or if we did not have one.
19420 "Too close" means it's plausible a scroll-down would
19421 go back past it. */
19422 if (startpos
== BUF_BEGV (b
))
19424 w
->base_line_number
= make_number (topline
);
19425 w
->base_line_pos
= make_number (BUF_BEGV (b
));
19427 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
19428 || linepos
== BUF_BEGV (b
))
19430 int limit
= BUF_BEGV (b
);
19431 int limit_byte
= BUF_BEGV_BYTE (b
);
19433 int distance
= (height
* 2 + 30) * line_number_display_limit_width
;
19435 if (startpos
- distance
> limit
)
19437 limit
= startpos
- distance
;
19438 limit_byte
= CHAR_TO_BYTE (limit
);
19441 nlines
= display_count_lines (startpos
, startpos_byte
,
19443 - (height
* 2 + 30),
19445 /* If we couldn't find the lines we wanted within
19446 line_number_display_limit_width chars per line,
19447 give up on line numbers for this window. */
19448 if (position
== limit_byte
&& limit
== startpos
- distance
)
19450 w
->base_line_pos
= w
->buffer
;
19451 w
->base_line_number
= Qnil
;
19455 w
->base_line_number
= make_number (topline
- nlines
);
19456 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
19459 /* Now count lines from the start pos to point. */
19460 nlines
= display_count_lines (startpos
, startpos_byte
,
19461 PT_BYTE
, PT
, &junk
);
19463 /* Record that we did display the line number. */
19464 line_number_displayed
= 1;
19466 /* Make the string to show. */
19467 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
19468 return decode_mode_spec_buf
;
19471 char* p
= decode_mode_spec_buf
;
19472 int pad
= field_width
- 2;
19478 return decode_mode_spec_buf
;
19484 obj
= b
->mode_name
;
19488 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
19494 int pos
= marker_position (w
->start
);
19495 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
19497 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
19499 if (pos
<= BUF_BEGV (b
))
19504 else if (pos
<= BUF_BEGV (b
))
19508 if (total
> 1000000)
19509 /* Do it differently for a large value, to avoid overflow. */
19510 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19512 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19513 /* We can't normally display a 3-digit number,
19514 so get us a 2-digit number that is close. */
19517 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
19518 return decode_mode_spec_buf
;
19522 /* Display percentage of size above the bottom of the screen. */
19525 int toppos
= marker_position (w
->start
);
19526 int botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
19527 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
19529 if (botpos
>= BUF_ZV (b
))
19531 if (toppos
<= BUF_BEGV (b
))
19538 if (total
> 1000000)
19539 /* Do it differently for a large value, to avoid overflow. */
19540 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19542 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19543 /* We can't normally display a 3-digit number,
19544 so get us a 2-digit number that is close. */
19547 if (toppos
<= BUF_BEGV (b
))
19548 sprintf (decode_mode_spec_buf
, "Top%2d%%", total
);
19550 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
19551 return decode_mode_spec_buf
;
19556 /* status of process */
19557 obj
= Fget_buffer_process (Fcurrent_buffer ());
19559 return "no process";
19561 obj
= Fsymbol_name (Fprocess_status (obj
));
19567 int count
= inhibit_garbage_collection ();
19568 Lisp_Object val
= call1 (intern ("file-remote-p"),
19569 current_buffer
->directory
);
19570 unbind_to (count
, Qnil
);
19578 case 't': /* indicate TEXT or BINARY */
19579 #ifdef MODE_LINE_BINARY_TEXT
19580 return MODE_LINE_BINARY_TEXT (b
);
19586 /* coding-system (not including end-of-line format) */
19588 /* coding-system (including end-of-line type) */
19590 int eol_flag
= (c
== 'Z');
19591 char *p
= decode_mode_spec_buf
;
19593 if (! FRAME_WINDOW_P (f
))
19595 /* No need to mention EOL here--the terminal never needs
19596 to do EOL conversion. */
19597 p
= decode_mode_spec_coding (CODING_ID_NAME
19598 (FRAME_KEYBOARD_CODING (f
)->id
),
19600 p
= decode_mode_spec_coding (CODING_ID_NAME
19601 (FRAME_TERMINAL_CODING (f
)->id
),
19604 p
= decode_mode_spec_coding (b
->buffer_file_coding_system
,
19607 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
19608 #ifdef subprocesses
19609 obj
= Fget_buffer_process (Fcurrent_buffer ());
19610 if (PROCESSP (obj
))
19612 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
19614 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
19617 #endif /* subprocesses */
19620 return decode_mode_spec_buf
;
19627 return (char *) SDATA (obj
);
19634 /* Count up to COUNT lines starting from START / START_BYTE.
19635 But don't go beyond LIMIT_BYTE.
19636 Return the number of lines thus found (always nonnegative).
19638 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
19641 display_count_lines (int start
, int start_byte
, int limit_byte
, int count
,
19644 register unsigned char *cursor
;
19645 unsigned char *base
;
19647 register int ceiling
;
19648 register unsigned char *ceiling_addr
;
19649 int orig_count
= count
;
19651 /* If we are not in selective display mode,
19652 check only for newlines. */
19653 int selective_display
= (!NILP (current_buffer
->selective_display
)
19654 && !INTEGERP (current_buffer
->selective_display
));
19658 while (start_byte
< limit_byte
)
19660 ceiling
= BUFFER_CEILING_OF (start_byte
);
19661 ceiling
= min (limit_byte
- 1, ceiling
);
19662 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
19663 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
19666 if (selective_display
)
19667 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
19670 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
19673 if (cursor
!= ceiling_addr
)
19677 start_byte
+= cursor
- base
+ 1;
19678 *byte_pos_ptr
= start_byte
;
19682 if (++cursor
== ceiling_addr
)
19688 start_byte
+= cursor
- base
;
19693 while (start_byte
> limit_byte
)
19695 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
19696 ceiling
= max (limit_byte
, ceiling
);
19697 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
19698 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
19701 if (selective_display
)
19702 while (--cursor
!= ceiling_addr
19703 && *cursor
!= '\n' && *cursor
!= 015)
19706 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
19709 if (cursor
!= ceiling_addr
)
19713 start_byte
+= cursor
- base
+ 1;
19714 *byte_pos_ptr
= start_byte
;
19715 /* When scanning backwards, we should
19716 not count the newline posterior to which we stop. */
19717 return - orig_count
- 1;
19723 /* Here we add 1 to compensate for the last decrement
19724 of CURSOR, which took it past the valid range. */
19725 start_byte
+= cursor
- base
+ 1;
19729 *byte_pos_ptr
= limit_byte
;
19732 return - orig_count
+ count
;
19733 return orig_count
- count
;
19739 /***********************************************************************
19741 ***********************************************************************/
19743 /* Display a NUL-terminated string, starting with index START.
19745 If STRING is non-null, display that C string. Otherwise, the Lisp
19746 string LISP_STRING is displayed. There's a case that STRING is
19747 non-null and LISP_STRING is not nil. It means STRING is a string
19748 data of LISP_STRING. In that case, we display LISP_STRING while
19749 ignoring its text properties.
19751 If FACE_STRING is not nil, FACE_STRING_POS is a position in
19752 FACE_STRING. Display STRING or LISP_STRING with the face at
19753 FACE_STRING_POS in FACE_STRING:
19755 Display the string in the environment given by IT, but use the
19756 standard display table, temporarily.
19758 FIELD_WIDTH is the minimum number of output glyphs to produce.
19759 If STRING has fewer characters than FIELD_WIDTH, pad to the right
19760 with spaces. If STRING has more characters, more than FIELD_WIDTH
19761 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
19763 PRECISION is the maximum number of characters to output from
19764 STRING. PRECISION < 0 means don't truncate the string.
19766 This is roughly equivalent to printf format specifiers:
19768 FIELD_WIDTH PRECISION PRINTF
19769 ----------------------------------------
19775 MULTIBYTE zero means do not display multibyte chars, > 0 means do
19776 display them, and < 0 means obey the current buffer's value of
19777 enable_multibyte_characters.
19779 Value is the number of columns displayed. */
19782 display_string (unsigned char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
19783 EMACS_INT face_string_pos
, EMACS_INT start
, struct it
*it
,
19784 int field_width
, int precision
, int max_x
, int multibyte
)
19786 int hpos_at_start
= it
->hpos
;
19787 int saved_face_id
= it
->face_id
;
19788 struct glyph_row
*row
= it
->glyph_row
;
19790 /* Initialize the iterator IT for iteration over STRING beginning
19791 with index START. */
19792 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
19793 precision
, field_width
, multibyte
);
19794 if (string
&& STRINGP (lisp_string
))
19795 /* LISP_STRING is the one returned by decode_mode_spec. We should
19796 ignore its text properties. */
19797 it
->stop_charpos
= -1;
19799 /* If displaying STRING, set up the face of the iterator
19800 from LISP_STRING, if that's given. */
19801 if (STRINGP (face_string
))
19807 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
19808 0, it
->region_beg_charpos
,
19809 it
->region_end_charpos
,
19810 &endptr
, it
->base_face_id
, 0);
19811 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19812 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
19815 /* Set max_x to the maximum allowed X position. Don't let it go
19816 beyond the right edge of the window. */
19818 max_x
= it
->last_visible_x
;
19820 max_x
= min (max_x
, it
->last_visible_x
);
19822 /* Skip over display elements that are not visible. because IT->w is
19824 if (it
->current_x
< it
->first_visible_x
)
19825 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
19826 MOVE_TO_POS
| MOVE_TO_X
);
19828 row
->ascent
= it
->max_ascent
;
19829 row
->height
= it
->max_ascent
+ it
->max_descent
;
19830 row
->phys_ascent
= it
->max_phys_ascent
;
19831 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19832 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19834 /* This condition is for the case that we are called with current_x
19835 past last_visible_x. */
19836 while (it
->current_x
< max_x
)
19838 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
19840 /* Get the next display element. */
19841 if (!get_next_display_element (it
))
19844 /* Produce glyphs. */
19845 x_before
= it
->current_x
;
19846 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
19847 PRODUCE_GLYPHS (it
);
19849 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
19852 while (i
< nglyphs
)
19854 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
19856 if (it
->line_wrap
!= TRUNCATE
19857 && x
+ glyph
->pixel_width
> max_x
)
19859 /* End of continued line or max_x reached. */
19860 if (CHAR_GLYPH_PADDING_P (*glyph
))
19862 /* A wide character is unbreakable. */
19863 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
19864 it
->current_x
= x_before
;
19868 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
19873 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
19875 /* Glyph is at least partially visible. */
19877 if (x
< it
->first_visible_x
)
19878 it
->glyph_row
->x
= x
- it
->first_visible_x
;
19882 /* Glyph is off the left margin of the display area.
19883 Should not happen. */
19887 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19888 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19889 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19890 row
->phys_height
= max (row
->phys_height
,
19891 it
->max_phys_ascent
+ it
->max_phys_descent
);
19892 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19893 it
->max_extra_line_spacing
);
19894 x
+= glyph
->pixel_width
;
19898 /* Stop if max_x reached. */
19902 /* Stop at line ends. */
19903 if (ITERATOR_AT_END_OF_LINE_P (it
))
19905 it
->continuation_lines_width
= 0;
19909 set_iterator_to_next (it
, 1);
19911 /* Stop if truncating at the right edge. */
19912 if (it
->line_wrap
== TRUNCATE
19913 && it
->current_x
>= it
->last_visible_x
)
19915 /* Add truncation mark, but don't do it if the line is
19916 truncated at a padding space. */
19917 if (IT_CHARPOS (*it
) < it
->string_nchars
)
19919 if (!FRAME_WINDOW_P (it
->f
))
19923 if (it
->current_x
> it
->last_visible_x
)
19925 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
19926 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19928 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
19930 row
->used
[TEXT_AREA
] = i
;
19931 produce_special_glyphs (it
, IT_TRUNCATION
);
19934 produce_special_glyphs (it
, IT_TRUNCATION
);
19936 it
->glyph_row
->truncated_on_right_p
= 1;
19942 /* Maybe insert a truncation at the left. */
19943 if (it
->first_visible_x
19944 && IT_CHARPOS (*it
) > 0)
19946 if (!FRAME_WINDOW_P (it
->f
))
19947 insert_left_trunc_glyphs (it
);
19948 it
->glyph_row
->truncated_on_left_p
= 1;
19951 it
->face_id
= saved_face_id
;
19953 /* Value is number of columns displayed. */
19954 return it
->hpos
- hpos_at_start
;
19959 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
19960 appears as an element of LIST or as the car of an element of LIST.
19961 If PROPVAL is a list, compare each element against LIST in that
19962 way, and return 1/2 if any element of PROPVAL is found in LIST.
19963 Otherwise return 0. This function cannot quit.
19964 The return value is 2 if the text is invisible but with an ellipsis
19965 and 1 if it's invisible and without an ellipsis. */
19968 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
19970 register Lisp_Object tail
, proptail
;
19972 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
19974 register Lisp_Object tem
;
19976 if (EQ (propval
, tem
))
19978 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
19979 return NILP (XCDR (tem
)) ? 1 : 2;
19982 if (CONSP (propval
))
19984 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
19986 Lisp_Object propelt
;
19987 propelt
= XCAR (proptail
);
19988 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
19990 register Lisp_Object tem
;
19992 if (EQ (propelt
, tem
))
19994 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
19995 return NILP (XCDR (tem
)) ? 1 : 2;
20003 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
20004 doc
: /* Non-nil if the property makes the text invisible.
20005 POS-OR-PROP can be a marker or number, in which case it is taken to be
20006 a position in the current buffer and the value of the `invisible' property
20007 is checked; or it can be some other value, which is then presumed to be the
20008 value of the `invisible' property of the text of interest.
20009 The non-nil value returned can be t for truly invisible text or something
20010 else if the text is replaced by an ellipsis. */)
20011 (Lisp_Object pos_or_prop
)
20014 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
20015 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
20017 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
20018 return (invis
== 0 ? Qnil
20020 : make_number (invis
));
20023 /* Calculate a width or height in pixels from a specification using
20024 the following elements:
20027 NUM - a (fractional) multiple of the default font width/height
20028 (NUM) - specifies exactly NUM pixels
20029 UNIT - a fixed number of pixels, see below.
20030 ELEMENT - size of a display element in pixels, see below.
20031 (NUM . SPEC) - equals NUM * SPEC
20032 (+ SPEC SPEC ...) - add pixel values
20033 (- SPEC SPEC ...) - subtract pixel values
20034 (- SPEC) - negate pixel value
20037 INT or FLOAT - a number constant
20038 SYMBOL - use symbol's (buffer local) variable binding.
20041 in - pixels per inch *)
20042 mm - pixels per 1/1000 meter *)
20043 cm - pixels per 1/100 meter *)
20044 width - width of current font in pixels.
20045 height - height of current font in pixels.
20047 *) using the ratio(s) defined in display-pixels-per-inch.
20051 left-fringe - left fringe width in pixels
20052 right-fringe - right fringe width in pixels
20054 left-margin - left margin width in pixels
20055 right-margin - right margin width in pixels
20057 scroll-bar - scroll-bar area width in pixels
20061 Pixels corresponding to 5 inches:
20064 Total width of non-text areas on left side of window (if scroll-bar is on left):
20065 '(space :width (+ left-fringe left-margin scroll-bar))
20067 Align to first text column (in header line):
20068 '(space :align-to 0)
20070 Align to middle of text area minus half the width of variable `my-image'
20071 containing a loaded image:
20072 '(space :align-to (0.5 . (- text my-image)))
20074 Width of left margin minus width of 1 character in the default font:
20075 '(space :width (- left-margin 1))
20077 Width of left margin minus width of 2 characters in the current font:
20078 '(space :width (- left-margin (2 . width)))
20080 Center 1 character over left-margin (in header line):
20081 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
20083 Different ways to express width of left fringe plus left margin minus one pixel:
20084 '(space :width (- (+ left-fringe left-margin) (1)))
20085 '(space :width (+ left-fringe left-margin (- (1))))
20086 '(space :width (+ left-fringe left-margin (-1)))
20090 #define NUMVAL(X) \
20091 ((INTEGERP (X) || FLOATP (X)) \
20096 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
20097 struct font
*font
, int width_p
, int *align_to
)
20101 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
20102 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
20105 return OK_PIXELS (0);
20107 xassert (FRAME_LIVE_P (it
->f
));
20109 if (SYMBOLP (prop
))
20111 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
20113 char *unit
= SDATA (SYMBOL_NAME (prop
));
20115 if (unit
[0] == 'i' && unit
[1] == 'n')
20117 else if (unit
[0] == 'm' && unit
[1] == 'm')
20119 else if (unit
[0] == 'c' && unit
[1] == 'm')
20126 #ifdef HAVE_WINDOW_SYSTEM
20127 if (FRAME_WINDOW_P (it
->f
)
20129 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
20130 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
20132 return OK_PIXELS (ppi
/ pixels
);
20135 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
20136 || (CONSP (Vdisplay_pixels_per_inch
)
20138 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
20139 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
20141 return OK_PIXELS (ppi
/ pixels
);
20147 #ifdef HAVE_WINDOW_SYSTEM
20148 if (EQ (prop
, Qheight
))
20149 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
20150 if (EQ (prop
, Qwidth
))
20151 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
20153 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
20154 return OK_PIXELS (1);
20157 if (EQ (prop
, Qtext
))
20158 return OK_PIXELS (width_p
20159 ? window_box_width (it
->w
, TEXT_AREA
)
20160 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
20162 if (align_to
&& *align_to
< 0)
20165 if (EQ (prop
, Qleft
))
20166 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
20167 if (EQ (prop
, Qright
))
20168 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
20169 if (EQ (prop
, Qcenter
))
20170 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
20171 + window_box_width (it
->w
, TEXT_AREA
) / 2);
20172 if (EQ (prop
, Qleft_fringe
))
20173 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20174 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
20175 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
20176 if (EQ (prop
, Qright_fringe
))
20177 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20178 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20179 : window_box_right_offset (it
->w
, TEXT_AREA
));
20180 if (EQ (prop
, Qleft_margin
))
20181 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
20182 if (EQ (prop
, Qright_margin
))
20183 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
20184 if (EQ (prop
, Qscroll_bar
))
20185 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
20187 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20188 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20189 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20194 if (EQ (prop
, Qleft_fringe
))
20195 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
20196 if (EQ (prop
, Qright_fringe
))
20197 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
20198 if (EQ (prop
, Qleft_margin
))
20199 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
20200 if (EQ (prop
, Qright_margin
))
20201 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
20202 if (EQ (prop
, Qscroll_bar
))
20203 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
20206 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
20209 if (INTEGERP (prop
) || FLOATP (prop
))
20211 int base_unit
= (width_p
20212 ? FRAME_COLUMN_WIDTH (it
->f
)
20213 : FRAME_LINE_HEIGHT (it
->f
));
20214 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
20219 Lisp_Object car
= XCAR (prop
);
20220 Lisp_Object cdr
= XCDR (prop
);
20224 #ifdef HAVE_WINDOW_SYSTEM
20225 if (FRAME_WINDOW_P (it
->f
)
20226 && valid_image_p (prop
))
20228 int id
= lookup_image (it
->f
, prop
);
20229 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
20231 return OK_PIXELS (width_p
? img
->width
: img
->height
);
20234 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
20240 while (CONSP (cdr
))
20242 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
20243 font
, width_p
, align_to
))
20246 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
20251 if (EQ (car
, Qminus
))
20253 return OK_PIXELS (pixels
);
20256 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
20259 if (INTEGERP (car
) || FLOATP (car
))
20262 pixels
= XFLOATINT (car
);
20264 return OK_PIXELS (pixels
);
20265 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
20266 font
, width_p
, align_to
))
20267 return OK_PIXELS (pixels
* fact
);
20278 /***********************************************************************
20280 ***********************************************************************/
20282 #ifdef HAVE_WINDOW_SYSTEM
20287 dump_glyph_string (s
)
20288 struct glyph_string
*s
;
20290 fprintf (stderr
, "glyph string\n");
20291 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
20292 s
->x
, s
->y
, s
->width
, s
->height
);
20293 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
20294 fprintf (stderr
, " hl = %d\n", s
->hl
);
20295 fprintf (stderr
, " left overhang = %d, right = %d\n",
20296 s
->left_overhang
, s
->right_overhang
);
20297 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
20298 fprintf (stderr
, " extends to end of line = %d\n",
20299 s
->extends_to_end_of_line_p
);
20300 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
20301 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
20304 #endif /* GLYPH_DEBUG */
20306 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
20307 of XChar2b structures for S; it can't be allocated in
20308 init_glyph_string because it must be allocated via `alloca'. W
20309 is the window on which S is drawn. ROW and AREA are the glyph row
20310 and area within the row from which S is constructed. START is the
20311 index of the first glyph structure covered by S. HL is a
20312 face-override for drawing S. */
20315 #define OPTIONAL_HDC(hdc) HDC hdc,
20316 #define DECLARE_HDC(hdc) HDC hdc;
20317 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
20318 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
20321 #ifndef OPTIONAL_HDC
20322 #define OPTIONAL_HDC(hdc)
20323 #define DECLARE_HDC(hdc)
20324 #define ALLOCATE_HDC(hdc, f)
20325 #define RELEASE_HDC(hdc, f)
20329 init_glyph_string (struct glyph_string
*s
,
20331 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
20332 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
20334 memset (s
, 0, sizeof *s
);
20336 s
->f
= XFRAME (w
->frame
);
20340 s
->display
= FRAME_X_DISPLAY (s
->f
);
20341 s
->window
= FRAME_X_WINDOW (s
->f
);
20342 s
->char2b
= char2b
;
20346 s
->first_glyph
= row
->glyphs
[area
] + start
;
20347 s
->height
= row
->height
;
20348 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
20349 s
->ybase
= s
->y
+ row
->ascent
;
20353 /* Append the list of glyph strings with head H and tail T to the list
20354 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
20357 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
20358 struct glyph_string
*h
, struct glyph_string
*t
)
20372 /* Prepend the list of glyph strings with head H and tail T to the
20373 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
20377 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
20378 struct glyph_string
*h
, struct glyph_string
*t
)
20392 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
20393 Set *HEAD and *TAIL to the resulting list. */
20396 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
20397 struct glyph_string
*s
)
20399 s
->next
= s
->prev
= NULL
;
20400 append_glyph_string_lists (head
, tail
, s
, s
);
20404 /* Get face and two-byte form of character C in face FACE_ID on frame
20405 F. The encoding of C is returned in *CHAR2B. MULTIBYTE_P non-zero
20406 means we want to display multibyte text. DISPLAY_P non-zero means
20407 make sure that X resources for the face returned are allocated.
20408 Value is a pointer to a realized face that is ready for display if
20409 DISPLAY_P is non-zero. */
20411 static INLINE
struct face
*
20412 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
20413 XChar2b
*char2b
, int multibyte_p
, int display_p
)
20415 struct face
*face
= FACE_FROM_ID (f
, face_id
);
20419 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
20421 if (code
!= FONT_INVALID_CODE
)
20422 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20424 STORE_XCHAR2B (char2b
, 0, 0);
20427 /* Make sure X resources of the face are allocated. */
20428 #ifdef HAVE_X_WINDOWS
20432 xassert (face
!= NULL
);
20433 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20440 /* Get face and two-byte form of character glyph GLYPH on frame F.
20441 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
20442 a pointer to a realized face that is ready for display. */
20444 static INLINE
struct face
*
20445 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
20446 XChar2b
*char2b
, int *two_byte_p
)
20450 xassert (glyph
->type
== CHAR_GLYPH
);
20451 face
= FACE_FROM_ID (f
, glyph
->face_id
);
20458 unsigned code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
20460 if (code
!= FONT_INVALID_CODE
)
20461 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20463 STORE_XCHAR2B (char2b
, 0, 0);
20466 /* Make sure X resources of the face are allocated. */
20467 xassert (face
!= NULL
);
20468 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20473 /* Fill glyph string S with composition components specified by S->cmp.
20475 BASE_FACE is the base face of the composition.
20476 S->cmp_from is the index of the first component for S.
20478 OVERLAPS non-zero means S should draw the foreground only, and use
20479 its physical height for clipping. See also draw_glyphs.
20481 Value is the index of a component not in S. */
20484 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
20488 /* For all glyphs of this composition, starting at the offset
20489 S->cmp_from, until we reach the end of the definition or encounter a
20490 glyph that requires the different face, add it to S. */
20495 s
->for_overlaps
= overlaps
;
20498 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
20500 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
20504 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
20507 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
20508 s
->char2b
+ i
, 1, 1);
20514 s
->font
= s
->face
->font
;
20516 else if (s
->face
!= face
)
20524 /* All glyph strings for the same composition has the same width,
20525 i.e. the width set for the first component of the composition. */
20526 s
->width
= s
->first_glyph
->pixel_width
;
20528 /* If the specified font could not be loaded, use the frame's
20529 default font, but record the fact that we couldn't load it in
20530 the glyph string so that we can draw rectangles for the
20531 characters of the glyph string. */
20532 if (s
->font
== NULL
)
20534 s
->font_not_found_p
= 1;
20535 s
->font
= FRAME_FONT (s
->f
);
20538 /* Adjust base line for subscript/superscript text. */
20539 s
->ybase
+= s
->first_glyph
->voffset
;
20541 /* This glyph string must always be drawn with 16-bit functions. */
20548 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
20549 int start
, int end
, int overlaps
)
20551 struct glyph
*glyph
, *last
;
20552 Lisp_Object lgstring
;
20555 s
->for_overlaps
= overlaps
;
20556 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20557 last
= s
->row
->glyphs
[s
->area
] + end
;
20558 s
->cmp_id
= glyph
->u
.cmp
.id
;
20559 s
->cmp_from
= glyph
->u
.cmp
.from
;
20560 s
->cmp_to
= glyph
->u
.cmp
.to
+ 1;
20561 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20562 lgstring
= composition_gstring_from_id (s
->cmp_id
);
20563 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
20565 while (glyph
< last
20566 && glyph
->u
.cmp
.automatic
20567 && glyph
->u
.cmp
.id
== s
->cmp_id
20568 && s
->cmp_to
== glyph
->u
.cmp
.from
)
20569 s
->cmp_to
= (glyph
++)->u
.cmp
.to
+ 1;
20571 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
20573 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
20574 unsigned code
= LGLYPH_CODE (lglyph
);
20576 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
20578 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
20579 return glyph
- s
->row
->glyphs
[s
->area
];
20583 /* Fill glyph string S from a sequence of character glyphs.
20585 FACE_ID is the face id of the string. START is the index of the
20586 first glyph to consider, END is the index of the last + 1.
20587 OVERLAPS non-zero means S should draw the foreground only, and use
20588 its physical height for clipping. See also draw_glyphs.
20590 Value is the index of the first glyph not in S. */
20593 fill_glyph_string (struct glyph_string
*s
, int face_id
,
20594 int start
, int end
, int overlaps
)
20596 struct glyph
*glyph
, *last
;
20598 int glyph_not_available_p
;
20600 xassert (s
->f
== XFRAME (s
->w
->frame
));
20601 xassert (s
->nchars
== 0);
20602 xassert (start
>= 0 && end
> start
);
20604 s
->for_overlaps
= overlaps
;
20605 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20606 last
= s
->row
->glyphs
[s
->area
] + end
;
20607 voffset
= glyph
->voffset
;
20608 s
->padding_p
= glyph
->padding_p
;
20609 glyph_not_available_p
= glyph
->glyph_not_available_p
;
20611 while (glyph
< last
20612 && glyph
->type
== CHAR_GLYPH
20613 && glyph
->voffset
== voffset
20614 /* Same face id implies same font, nowadays. */
20615 && glyph
->face_id
== face_id
20616 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
20620 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
20621 s
->char2b
+ s
->nchars
,
20623 s
->two_byte_p
= two_byte_p
;
20625 xassert (s
->nchars
<= end
- start
);
20626 s
->width
+= glyph
->pixel_width
;
20627 if (glyph
++->padding_p
!= s
->padding_p
)
20631 s
->font
= s
->face
->font
;
20633 /* If the specified font could not be loaded, use the frame's font,
20634 but record the fact that we couldn't load it in
20635 S->font_not_found_p so that we can draw rectangles for the
20636 characters of the glyph string. */
20637 if (s
->font
== NULL
|| glyph_not_available_p
)
20639 s
->font_not_found_p
= 1;
20640 s
->font
= FRAME_FONT (s
->f
);
20643 /* Adjust base line for subscript/superscript text. */
20644 s
->ybase
+= voffset
;
20646 xassert (s
->face
&& s
->face
->gc
);
20647 return glyph
- s
->row
->glyphs
[s
->area
];
20651 /* Fill glyph string S from image glyph S->first_glyph. */
20654 fill_image_glyph_string (struct glyph_string
*s
)
20656 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
20657 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
20659 s
->slice
= s
->first_glyph
->slice
;
20660 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
20661 s
->font
= s
->face
->font
;
20662 s
->width
= s
->first_glyph
->pixel_width
;
20664 /* Adjust base line for subscript/superscript text. */
20665 s
->ybase
+= s
->first_glyph
->voffset
;
20669 /* Fill glyph string S from a sequence of stretch glyphs.
20671 ROW is the glyph row in which the glyphs are found, AREA is the
20672 area within the row. START is the index of the first glyph to
20673 consider, END is the index of the last + 1.
20675 Value is the index of the first glyph not in S. */
20678 fill_stretch_glyph_string (struct glyph_string
*s
, struct glyph_row
*row
,
20679 enum glyph_row_area area
, int start
, int end
)
20681 struct glyph
*glyph
, *last
;
20682 int voffset
, face_id
;
20684 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
20686 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20687 last
= s
->row
->glyphs
[s
->area
] + end
;
20688 face_id
= glyph
->face_id
;
20689 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20690 s
->font
= s
->face
->font
;
20691 s
->width
= glyph
->pixel_width
;
20693 voffset
= glyph
->voffset
;
20697 && glyph
->type
== STRETCH_GLYPH
20698 && glyph
->voffset
== voffset
20699 && glyph
->face_id
== face_id
);
20701 s
->width
+= glyph
->pixel_width
;
20703 /* Adjust base line for subscript/superscript text. */
20704 s
->ybase
+= voffset
;
20706 /* The case that face->gc == 0 is handled when drawing the glyph
20707 string by calling PREPARE_FACE_FOR_DISPLAY. */
20709 return glyph
- s
->row
->glyphs
[s
->area
];
20712 static struct font_metrics
*
20713 get_per_char_metric (struct frame
*f
, struct font
*font
, XChar2b
*char2b
)
20715 static struct font_metrics metrics
;
20716 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
20718 if (! font
|| code
== FONT_INVALID_CODE
)
20720 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
20725 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
20726 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
20727 assumed to be zero. */
20730 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
20732 *left
= *right
= 0;
20734 if (glyph
->type
== CHAR_GLYPH
)
20738 struct font_metrics
*pcm
;
20740 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
20741 if (face
->font
&& (pcm
= get_per_char_metric (f
, face
->font
, &char2b
)))
20743 if (pcm
->rbearing
> pcm
->width
)
20744 *right
= pcm
->rbearing
- pcm
->width
;
20745 if (pcm
->lbearing
< 0)
20746 *left
= -pcm
->lbearing
;
20749 else if (glyph
->type
== COMPOSITE_GLYPH
)
20751 if (! glyph
->u
.cmp
.automatic
)
20753 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
20755 if (cmp
->rbearing
> cmp
->pixel_width
)
20756 *right
= cmp
->rbearing
- cmp
->pixel_width
;
20757 if (cmp
->lbearing
< 0)
20758 *left
= - cmp
->lbearing
;
20762 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
20763 struct font_metrics metrics
;
20765 composition_gstring_width (gstring
, glyph
->u
.cmp
.from
,
20766 glyph
->u
.cmp
.to
+ 1, &metrics
);
20767 if (metrics
.rbearing
> metrics
.width
)
20768 *right
= metrics
.rbearing
- metrics
.width
;
20769 if (metrics
.lbearing
< 0)
20770 *left
= - metrics
.lbearing
;
20776 /* Return the index of the first glyph preceding glyph string S that
20777 is overwritten by S because of S's left overhang. Value is -1
20778 if no glyphs are overwritten. */
20781 left_overwritten (struct glyph_string
*s
)
20785 if (s
->left_overhang
)
20788 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20789 int first
= s
->first_glyph
- glyphs
;
20791 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
20792 x
-= glyphs
[i
].pixel_width
;
20803 /* Return the index of the first glyph preceding glyph string S that
20804 is overwriting S because of its right overhang. Value is -1 if no
20805 glyph in front of S overwrites S. */
20808 left_overwriting (struct glyph_string
*s
)
20811 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20812 int first
= s
->first_glyph
- glyphs
;
20816 for (i
= first
- 1; i
>= 0; --i
)
20819 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
20822 x
-= glyphs
[i
].pixel_width
;
20829 /* Return the index of the last glyph following glyph string S that is
20830 overwritten by S because of S's right overhang. Value is -1 if
20831 no such glyph is found. */
20834 right_overwritten (struct glyph_string
*s
)
20838 if (s
->right_overhang
)
20841 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20842 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
20843 int end
= s
->row
->used
[s
->area
];
20845 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
20846 x
+= glyphs
[i
].pixel_width
;
20855 /* Return the index of the last glyph following glyph string S that
20856 overwrites S because of its left overhang. Value is negative
20857 if no such glyph is found. */
20860 right_overwriting (struct glyph_string
*s
)
20863 int end
= s
->row
->used
[s
->area
];
20864 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20865 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
20869 for (i
= first
; i
< end
; ++i
)
20872 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
20875 x
+= glyphs
[i
].pixel_width
;
20882 /* Set background width of glyph string S. START is the index of the
20883 first glyph following S. LAST_X is the right-most x-position + 1
20884 in the drawing area. */
20887 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
20889 /* If the face of this glyph string has to be drawn to the end of
20890 the drawing area, set S->extends_to_end_of_line_p. */
20892 if (start
== s
->row
->used
[s
->area
]
20893 && s
->area
== TEXT_AREA
20894 && ((s
->row
->fill_line_p
20895 && (s
->hl
== DRAW_NORMAL_TEXT
20896 || s
->hl
== DRAW_IMAGE_RAISED
20897 || s
->hl
== DRAW_IMAGE_SUNKEN
))
20898 || s
->hl
== DRAW_MOUSE_FACE
))
20899 s
->extends_to_end_of_line_p
= 1;
20901 /* If S extends its face to the end of the line, set its
20902 background_width to the distance to the right edge of the drawing
20904 if (s
->extends_to_end_of_line_p
)
20905 s
->background_width
= last_x
- s
->x
+ 1;
20907 s
->background_width
= s
->width
;
20911 /* Compute overhangs and x-positions for glyph string S and its
20912 predecessors, or successors. X is the starting x-position for S.
20913 BACKWARD_P non-zero means process predecessors. */
20916 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
20922 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
20923 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
20933 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
20934 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
20944 /* The following macros are only called from draw_glyphs below.
20945 They reference the following parameters of that function directly:
20946 `w', `row', `area', and `overlap_p'
20947 as well as the following local variables:
20948 `s', `f', and `hdc' (in W32) */
20951 /* On W32, silently add local `hdc' variable to argument list of
20952 init_glyph_string. */
20953 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
20954 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
20956 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
20957 init_glyph_string (s, char2b, w, row, area, start, hl)
20960 /* Add a glyph string for a stretch glyph to the list of strings
20961 between HEAD and TAIL. START is the index of the stretch glyph in
20962 row area AREA of glyph row ROW. END is the index of the last glyph
20963 in that glyph row area. X is the current output position assigned
20964 to the new glyph string constructed. HL overrides that face of the
20965 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
20966 is the right-most x-position of the drawing area. */
20968 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
20969 and below -- keep them on one line. */
20970 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
20973 s = (struct glyph_string *) alloca (sizeof *s); \
20974 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
20975 START = fill_stretch_glyph_string (s, row, area, START, END); \
20976 append_glyph_string (&HEAD, &TAIL, s); \
20982 /* Add a glyph string for an image glyph to the list of strings
20983 between HEAD and TAIL. START is the index of the image glyph in
20984 row area AREA of glyph row ROW. END is the index of the last glyph
20985 in that glyph row area. X is the current output position assigned
20986 to the new glyph string constructed. HL overrides that face of the
20987 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
20988 is the right-most x-position of the drawing area. */
20990 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
20993 s = (struct glyph_string *) alloca (sizeof *s); \
20994 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
20995 fill_image_glyph_string (s); \
20996 append_glyph_string (&HEAD, &TAIL, s); \
21003 /* Add a glyph string for a sequence of character glyphs to the list
21004 of strings between HEAD and TAIL. START is the index of the first
21005 glyph in row area AREA of glyph row ROW that is part of the new
21006 glyph string. END is the index of the last glyph in that glyph row
21007 area. X is the current output position assigned to the new glyph
21008 string constructed. HL overrides that face of the glyph; e.g. it
21009 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
21010 right-most x-position of the drawing area. */
21012 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21018 face_id = (row)->glyphs[area][START].face_id; \
21020 s = (struct glyph_string *) alloca (sizeof *s); \
21021 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
21022 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21023 append_glyph_string (&HEAD, &TAIL, s); \
21025 START = fill_glyph_string (s, face_id, START, END, overlaps); \
21030 /* Add a glyph string for a composite sequence to the list of strings
21031 between HEAD and TAIL. START is the index of the first glyph in
21032 row area AREA of glyph row ROW that is part of the new glyph
21033 string. END is the index of the last glyph in that glyph row area.
21034 X is the current output position assigned to the new glyph string
21035 constructed. HL overrides that face of the glyph; e.g. it is
21036 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
21037 x-position of the drawing area. */
21039 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21041 int face_id = (row)->glyphs[area][START].face_id; \
21042 struct face *base_face = FACE_FROM_ID (f, face_id); \
21043 int cmp_id = (row)->glyphs[area][START].u.cmp.id; \
21044 struct composition *cmp = composition_table[cmp_id]; \
21046 struct glyph_string *first_s; \
21049 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
21051 /* Make glyph_strings for each glyph sequence that is drawable by \
21052 the same face, and append them to HEAD/TAIL. */ \
21053 for (n = 0; n < cmp->glyph_len;) \
21055 s = (struct glyph_string *) alloca (sizeof *s); \
21056 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21057 append_glyph_string (&(HEAD), &(TAIL), s); \
21063 n = fill_composite_glyph_string (s, base_face, overlaps); \
21071 /* Add a glyph string for a glyph-string sequence to the list of strings
21072 between HEAD and TAIL. */
21074 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21078 Lisp_Object gstring; \
21080 face_id = (row)->glyphs[area][START].face_id; \
21081 gstring = (composition_gstring_from_id \
21082 ((row)->glyphs[area][START].u.cmp.id)); \
21083 s = (struct glyph_string *) alloca (sizeof *s); \
21084 char2b = (XChar2b *) alloca ((sizeof *char2b) \
21085 * LGSTRING_GLYPH_LEN (gstring)); \
21086 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21087 append_glyph_string (&(HEAD), &(TAIL), s); \
21089 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
21093 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
21094 of AREA of glyph row ROW on window W between indices START and END.
21095 HL overrides the face for drawing glyph strings, e.g. it is
21096 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
21097 x-positions of the drawing area.
21099 This is an ugly monster macro construct because we must use alloca
21100 to allocate glyph strings (because draw_glyphs can be called
21101 asynchronously). */
21103 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21106 HEAD = TAIL = NULL; \
21107 while (START < END) \
21109 struct glyph *first_glyph = (row)->glyphs[area] + START; \
21110 switch (first_glyph->type) \
21113 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
21117 case COMPOSITE_GLYPH: \
21118 if (first_glyph->u.cmp.automatic) \
21119 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
21122 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
21126 case STRETCH_GLYPH: \
21127 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
21131 case IMAGE_GLYPH: \
21132 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
21142 set_glyph_string_background_width (s, START, LAST_X); \
21149 /* Draw glyphs between START and END in AREA of ROW on window W,
21150 starting at x-position X. X is relative to AREA in W. HL is a
21151 face-override with the following meaning:
21153 DRAW_NORMAL_TEXT draw normally
21154 DRAW_CURSOR draw in cursor face
21155 DRAW_MOUSE_FACE draw in mouse face.
21156 DRAW_INVERSE_VIDEO draw in mode line face
21157 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
21158 DRAW_IMAGE_RAISED draw an image with a raised relief around it
21160 If OVERLAPS is non-zero, draw only the foreground of characters and
21161 clip to the physical height of ROW. Non-zero value also defines
21162 the overlapping part to be drawn:
21164 OVERLAPS_PRED overlap with preceding rows
21165 OVERLAPS_SUCC overlap with succeeding rows
21166 OVERLAPS_BOTH overlap with both preceding/succeeding rows
21167 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
21169 Value is the x-position reached, relative to AREA of W. */
21172 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
21173 enum glyph_row_area area
, EMACS_INT start
, EMACS_INT end
,
21174 enum draw_glyphs_face hl
, int overlaps
)
21176 struct glyph_string
*head
, *tail
;
21177 struct glyph_string
*s
;
21178 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
21179 int i
, j
, x_reached
, last_x
, area_left
= 0;
21180 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21183 ALLOCATE_HDC (hdc
, f
);
21185 /* Let's rather be paranoid than getting a SEGV. */
21186 end
= min (end
, row
->used
[area
]);
21187 start
= max (0, start
);
21188 start
= min (end
, start
);
21190 /* Translate X to frame coordinates. Set last_x to the right
21191 end of the drawing area. */
21192 if (row
->full_width_p
)
21194 /* X is relative to the left edge of W, without scroll bars
21196 area_left
= WINDOW_LEFT_EDGE_X (w
);
21197 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
21201 area_left
= window_box_left (w
, area
);
21202 last_x
= area_left
+ window_box_width (w
, area
);
21206 /* Build a doubly-linked list of glyph_string structures between
21207 head and tail from what we have to draw. Note that the macro
21208 BUILD_GLYPH_STRINGS will modify its start parameter. That's
21209 the reason we use a separate variable `i'. */
21211 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
21213 x_reached
= tail
->x
+ tail
->background_width
;
21217 /* If there are any glyphs with lbearing < 0 or rbearing > width in
21218 the row, redraw some glyphs in front or following the glyph
21219 strings built above. */
21220 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
21222 struct glyph_string
*h
, *t
;
21223 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
21224 int mouse_beg_col
, mouse_end_col
, check_mouse_face
= 0;
21227 /* If mouse highlighting is on, we may need to draw adjacent
21228 glyphs using mouse-face highlighting. */
21229 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
21231 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
21233 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
21234 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
21236 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
21238 check_mouse_face
= 1;
21239 mouse_beg_col
= (row
== mouse_beg_row
)
21240 ? dpyinfo
->mouse_face_beg_col
: 0;
21241 mouse_end_col
= (row
== mouse_end_row
)
21242 ? dpyinfo
->mouse_face_end_col
21243 : row
->used
[TEXT_AREA
];
21247 /* Compute overhangs for all glyph strings. */
21248 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
21249 for (s
= head
; s
; s
= s
->next
)
21250 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
21252 /* Prepend glyph strings for glyphs in front of the first glyph
21253 string that are overwritten because of the first glyph
21254 string's left overhang. The background of all strings
21255 prepended must be drawn because the first glyph string
21257 i
= left_overwritten (head
);
21260 enum draw_glyphs_face overlap_hl
;
21262 /* If this row contains mouse highlighting, attempt to draw
21263 the overlapped glyphs with the correct highlight. This
21264 code fails if the overlap encompasses more than one glyph
21265 and mouse-highlight spans only some of these glyphs.
21266 However, making it work perfectly involves a lot more
21267 code, and I don't know if the pathological case occurs in
21268 practice, so we'll stick to this for now. --- cyd */
21269 if (check_mouse_face
21270 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21271 overlap_hl
= DRAW_MOUSE_FACE
;
21273 overlap_hl
= DRAW_NORMAL_TEXT
;
21276 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
21277 overlap_hl
, dummy_x
, last_x
);
21279 compute_overhangs_and_x (t
, head
->x
, 1);
21280 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21284 /* Prepend glyph strings for glyphs in front of the first glyph
21285 string that overwrite that glyph string because of their
21286 right overhang. For these strings, only the foreground must
21287 be drawn, because it draws over the glyph string at `head'.
21288 The background must not be drawn because this would overwrite
21289 right overhangs of preceding glyphs for which no glyph
21291 i
= left_overwriting (head
);
21294 enum draw_glyphs_face overlap_hl
;
21296 if (check_mouse_face
21297 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21298 overlap_hl
= DRAW_MOUSE_FACE
;
21300 overlap_hl
= DRAW_NORMAL_TEXT
;
21303 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
21304 overlap_hl
, dummy_x
, last_x
);
21305 for (s
= h
; s
; s
= s
->next
)
21306 s
->background_filled_p
= 1;
21307 compute_overhangs_and_x (t
, head
->x
, 1);
21308 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21311 /* Append glyphs strings for glyphs following the last glyph
21312 string tail that are overwritten by tail. The background of
21313 these strings has to be drawn because tail's foreground draws
21315 i
= right_overwritten (tail
);
21318 enum draw_glyphs_face overlap_hl
;
21320 if (check_mouse_face
21321 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21322 overlap_hl
= DRAW_MOUSE_FACE
;
21324 overlap_hl
= DRAW_NORMAL_TEXT
;
21326 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21327 overlap_hl
, x
, last_x
);
21328 /* Because BUILD_GLYPH_STRINGS updates the first argument,
21329 we don't have `end = i;' here. */
21330 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21331 append_glyph_string_lists (&head
, &tail
, h
, t
);
21335 /* Append glyph strings for glyphs following the last glyph
21336 string tail that overwrite tail. The foreground of such
21337 glyphs has to be drawn because it writes into the background
21338 of tail. The background must not be drawn because it could
21339 paint over the foreground of following glyphs. */
21340 i
= right_overwriting (tail
);
21343 enum draw_glyphs_face overlap_hl
;
21344 if (check_mouse_face
21345 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21346 overlap_hl
= DRAW_MOUSE_FACE
;
21348 overlap_hl
= DRAW_NORMAL_TEXT
;
21351 i
++; /* We must include the Ith glyph. */
21352 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21353 overlap_hl
, x
, last_x
);
21354 for (s
= h
; s
; s
= s
->next
)
21355 s
->background_filled_p
= 1;
21356 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21357 append_glyph_string_lists (&head
, &tail
, h
, t
);
21359 if (clip_head
|| clip_tail
)
21360 for (s
= head
; s
; s
= s
->next
)
21362 s
->clip_head
= clip_head
;
21363 s
->clip_tail
= clip_tail
;
21367 /* Draw all strings. */
21368 for (s
= head
; s
; s
= s
->next
)
21369 FRAME_RIF (f
)->draw_glyph_string (s
);
21372 /* When focus a sole frame and move horizontally, this sets on_p to 0
21373 causing a failure to erase prev cursor position. */
21374 if (area
== TEXT_AREA
21375 && !row
->full_width_p
21376 /* When drawing overlapping rows, only the glyph strings'
21377 foreground is drawn, which doesn't erase a cursor
21381 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
21382 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
21383 : (tail
? tail
->x
+ tail
->background_width
: x
));
21387 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
21388 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
21392 /* Value is the x-position up to which drawn, relative to AREA of W.
21393 This doesn't include parts drawn because of overhangs. */
21394 if (row
->full_width_p
)
21395 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
21397 x_reached
-= area_left
;
21399 RELEASE_HDC (hdc
, f
);
21404 /* Expand row matrix if too narrow. Don't expand if area
21407 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
21409 if (!fonts_changed_p \
21410 && (it->glyph_row->glyphs[area] \
21411 < it->glyph_row->glyphs[area + 1])) \
21413 it->w->ncols_scale_factor++; \
21414 fonts_changed_p = 1; \
21418 /* Store one glyph for IT->char_to_display in IT->glyph_row.
21419 Called from x_produce_glyphs when IT->glyph_row is non-null. */
21422 append_glyph (struct it
*it
)
21424 struct glyph
*glyph
;
21425 enum glyph_row_area area
= it
->area
;
21427 xassert (it
->glyph_row
);
21428 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
21430 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21431 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21433 /* If the glyph row is reversed, we need to prepend the glyph
21434 rather than append it. */
21435 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
21439 /* Make room for the additional glyph. */
21440 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
21442 glyph
= it
->glyph_row
->glyphs
[area
];
21444 glyph
->charpos
= CHARPOS (it
->position
);
21445 glyph
->object
= it
->object
;
21446 if (it
->pixel_width
> 0)
21448 glyph
->pixel_width
= it
->pixel_width
;
21449 glyph
->padding_p
= 0;
21453 /* Assure at least 1-pixel width. Otherwise, cursor can't
21454 be displayed correctly. */
21455 glyph
->pixel_width
= 1;
21456 glyph
->padding_p
= 1;
21458 glyph
->ascent
= it
->ascent
;
21459 glyph
->descent
= it
->descent
;
21460 glyph
->voffset
= it
->voffset
;
21461 glyph
->type
= CHAR_GLYPH
;
21462 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21463 glyph
->multibyte_p
= it
->multibyte_p
;
21464 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21465 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21466 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21467 || it
->phys_descent
> it
->descent
);
21468 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
21469 glyph
->face_id
= it
->face_id
;
21470 glyph
->u
.ch
= it
->char_to_display
;
21471 glyph
->slice
= null_glyph_slice
;
21472 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21475 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21476 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21478 glyph
->bidi_type
= it
->bidi_it
.type
;
21482 glyph
->resolved_level
= 0;
21483 glyph
->bidi_type
= UNKNOWN_BT
;
21485 ++it
->glyph_row
->used
[area
];
21488 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21491 /* Store one glyph for the composition IT->cmp_it.id in
21492 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
21496 append_composite_glyph (struct it
*it
)
21498 struct glyph
*glyph
;
21499 enum glyph_row_area area
= it
->area
;
21501 xassert (it
->glyph_row
);
21503 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21504 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21506 /* If the glyph row is reversed, we need to prepend the glyph
21507 rather than append it. */
21508 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
21512 /* Make room for the new glyph. */
21513 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
21515 glyph
= it
->glyph_row
->glyphs
[it
->area
];
21517 glyph
->charpos
= it
->cmp_it
.charpos
;
21518 glyph
->object
= it
->object
;
21519 glyph
->pixel_width
= it
->pixel_width
;
21520 glyph
->ascent
= it
->ascent
;
21521 glyph
->descent
= it
->descent
;
21522 glyph
->voffset
= it
->voffset
;
21523 glyph
->type
= COMPOSITE_GLYPH
;
21524 if (it
->cmp_it
.ch
< 0)
21526 glyph
->u
.cmp
.automatic
= 0;
21527 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21531 glyph
->u
.cmp
.automatic
= 1;
21532 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21533 glyph
->u
.cmp
.from
= it
->cmp_it
.from
;
21534 glyph
->u
.cmp
.to
= it
->cmp_it
.to
- 1;
21536 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21537 glyph
->multibyte_p
= it
->multibyte_p
;
21538 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21539 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21540 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21541 || it
->phys_descent
> it
->descent
);
21542 glyph
->padding_p
= 0;
21543 glyph
->glyph_not_available_p
= 0;
21544 glyph
->face_id
= it
->face_id
;
21545 glyph
->slice
= null_glyph_slice
;
21546 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21549 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21550 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21552 glyph
->bidi_type
= it
->bidi_it
.type
;
21554 ++it
->glyph_row
->used
[area
];
21557 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21561 /* Change IT->ascent and IT->height according to the setting of
21565 take_vertical_position_into_account (struct it
*it
)
21569 if (it
->voffset
< 0)
21570 /* Increase the ascent so that we can display the text higher
21572 it
->ascent
-= it
->voffset
;
21574 /* Increase the descent so that we can display the text lower
21576 it
->descent
+= it
->voffset
;
21581 /* Produce glyphs/get display metrics for the image IT is loaded with.
21582 See the description of struct display_iterator in dispextern.h for
21583 an overview of struct display_iterator. */
21586 produce_image_glyph (struct it
*it
)
21590 int glyph_ascent
, crop
;
21591 struct glyph_slice slice
;
21593 xassert (it
->what
== IT_IMAGE
);
21595 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21597 /* Make sure X resources of the face is loaded. */
21598 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21600 if (it
->image_id
< 0)
21602 /* Fringe bitmap. */
21603 it
->ascent
= it
->phys_ascent
= 0;
21604 it
->descent
= it
->phys_descent
= 0;
21605 it
->pixel_width
= 0;
21610 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
21612 /* Make sure X resources of the image is loaded. */
21613 prepare_image_for_display (it
->f
, img
);
21615 slice
.x
= slice
.y
= 0;
21616 slice
.width
= img
->width
;
21617 slice
.height
= img
->height
;
21619 if (INTEGERP (it
->slice
.x
))
21620 slice
.x
= XINT (it
->slice
.x
);
21621 else if (FLOATP (it
->slice
.x
))
21622 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
21624 if (INTEGERP (it
->slice
.y
))
21625 slice
.y
= XINT (it
->slice
.y
);
21626 else if (FLOATP (it
->slice
.y
))
21627 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
21629 if (INTEGERP (it
->slice
.width
))
21630 slice
.width
= XINT (it
->slice
.width
);
21631 else if (FLOATP (it
->slice
.width
))
21632 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
21634 if (INTEGERP (it
->slice
.height
))
21635 slice
.height
= XINT (it
->slice
.height
);
21636 else if (FLOATP (it
->slice
.height
))
21637 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
21639 if (slice
.x
>= img
->width
)
21640 slice
.x
= img
->width
;
21641 if (slice
.y
>= img
->height
)
21642 slice
.y
= img
->height
;
21643 if (slice
.x
+ slice
.width
>= img
->width
)
21644 slice
.width
= img
->width
- slice
.x
;
21645 if (slice
.y
+ slice
.height
> img
->height
)
21646 slice
.height
= img
->height
- slice
.y
;
21648 if (slice
.width
== 0 || slice
.height
== 0)
21651 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
21653 it
->descent
= slice
.height
- glyph_ascent
;
21655 it
->descent
+= img
->vmargin
;
21656 if (slice
.y
+ slice
.height
== img
->height
)
21657 it
->descent
+= img
->vmargin
;
21658 it
->phys_descent
= it
->descent
;
21660 it
->pixel_width
= slice
.width
;
21662 it
->pixel_width
+= img
->hmargin
;
21663 if (slice
.x
+ slice
.width
== img
->width
)
21664 it
->pixel_width
+= img
->hmargin
;
21666 /* It's quite possible for images to have an ascent greater than
21667 their height, so don't get confused in that case. */
21668 if (it
->descent
< 0)
21673 if (face
->box
!= FACE_NO_BOX
)
21675 if (face
->box_line_width
> 0)
21678 it
->ascent
+= face
->box_line_width
;
21679 if (slice
.y
+ slice
.height
== img
->height
)
21680 it
->descent
+= face
->box_line_width
;
21683 if (it
->start_of_box_run_p
&& slice
.x
== 0)
21684 it
->pixel_width
+= eabs (face
->box_line_width
);
21685 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
21686 it
->pixel_width
+= eabs (face
->box_line_width
);
21689 take_vertical_position_into_account (it
);
21691 /* Automatically crop wide image glyphs at right edge so we can
21692 draw the cursor on same display row. */
21693 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
21694 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
21696 it
->pixel_width
-= crop
;
21697 slice
.width
-= crop
;
21702 struct glyph
*glyph
;
21703 enum glyph_row_area area
= it
->area
;
21705 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21706 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21708 glyph
->charpos
= CHARPOS (it
->position
);
21709 glyph
->object
= it
->object
;
21710 glyph
->pixel_width
= it
->pixel_width
;
21711 glyph
->ascent
= glyph_ascent
;
21712 glyph
->descent
= it
->descent
;
21713 glyph
->voffset
= it
->voffset
;
21714 glyph
->type
= IMAGE_GLYPH
;
21715 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21716 glyph
->multibyte_p
= it
->multibyte_p
;
21717 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21718 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21719 glyph
->overlaps_vertically_p
= 0;
21720 glyph
->padding_p
= 0;
21721 glyph
->glyph_not_available_p
= 0;
21722 glyph
->face_id
= it
->face_id
;
21723 glyph
->u
.img_id
= img
->id
;
21724 glyph
->slice
= slice
;
21725 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21728 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21729 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21731 glyph
->bidi_type
= it
->bidi_it
.type
;
21733 ++it
->glyph_row
->used
[area
];
21736 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21741 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
21742 of the glyph, WIDTH and HEIGHT are the width and height of the
21743 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
21746 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
21747 int width
, int height
, int ascent
)
21749 struct glyph
*glyph
;
21750 enum glyph_row_area area
= it
->area
;
21752 xassert (ascent
>= 0 && ascent
<= height
);
21754 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21755 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21757 /* If the glyph row is reversed, we need to prepend the glyph
21758 rather than append it. */
21759 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
21763 /* Make room for the additional glyph. */
21764 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
21766 glyph
= it
->glyph_row
->glyphs
[area
];
21768 glyph
->charpos
= CHARPOS (it
->position
);
21769 glyph
->object
= object
;
21770 glyph
->pixel_width
= width
;
21771 glyph
->ascent
= ascent
;
21772 glyph
->descent
= height
- ascent
;
21773 glyph
->voffset
= it
->voffset
;
21774 glyph
->type
= STRETCH_GLYPH
;
21775 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21776 glyph
->multibyte_p
= it
->multibyte_p
;
21777 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21778 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21779 glyph
->overlaps_vertically_p
= 0;
21780 glyph
->padding_p
= 0;
21781 glyph
->glyph_not_available_p
= 0;
21782 glyph
->face_id
= it
->face_id
;
21783 glyph
->u
.stretch
.ascent
= ascent
;
21784 glyph
->u
.stretch
.height
= height
;
21785 glyph
->slice
= null_glyph_slice
;
21786 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21789 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21790 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21792 glyph
->bidi_type
= it
->bidi_it
.type
;
21796 glyph
->resolved_level
= 0;
21797 glyph
->bidi_type
= UNKNOWN_BT
;
21799 ++it
->glyph_row
->used
[area
];
21802 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21806 /* Produce a stretch glyph for iterator IT. IT->object is the value
21807 of the glyph property displayed. The value must be a list
21808 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
21811 1. `:width WIDTH' specifies that the space should be WIDTH *
21812 canonical char width wide. WIDTH may be an integer or floating
21815 2. `:relative-width FACTOR' specifies that the width of the stretch
21816 should be computed from the width of the first character having the
21817 `glyph' property, and should be FACTOR times that width.
21819 3. `:align-to HPOS' specifies that the space should be wide enough
21820 to reach HPOS, a value in canonical character units.
21822 Exactly one of the above pairs must be present.
21824 4. `:height HEIGHT' specifies that the height of the stretch produced
21825 should be HEIGHT, measured in canonical character units.
21827 5. `:relative-height FACTOR' specifies that the height of the
21828 stretch should be FACTOR times the height of the characters having
21829 the glyph property.
21831 Either none or exactly one of 4 or 5 must be present.
21833 6. `:ascent ASCENT' specifies that ASCENT percent of the height
21834 of the stretch should be used for the ascent of the stretch.
21835 ASCENT must be in the range 0 <= ASCENT <= 100. */
21838 produce_stretch_glyph (struct it
*it
)
21840 /* (space :width WIDTH :height HEIGHT ...) */
21841 Lisp_Object prop
, plist
;
21842 int width
= 0, height
= 0, align_to
= -1;
21843 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
21846 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21847 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
21849 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21851 /* List should start with `space'. */
21852 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
21853 plist
= XCDR (it
->object
);
21855 /* Compute the width of the stretch. */
21856 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
21857 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
21859 /* Absolute width `:width WIDTH' specified and valid. */
21860 zero_width_ok_p
= 1;
21863 else if (prop
= Fplist_get (plist
, QCrelative_width
),
21866 /* Relative width `:relative-width FACTOR' specified and valid.
21867 Compute the width of the characters having the `glyph'
21870 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
21873 if (it
->multibyte_p
)
21875 int maxlen
= ((IT_BYTEPOS (*it
) >= GPT
? ZV
: GPT
)
21876 - IT_BYTEPOS (*it
));
21877 it2
.c
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
21880 it2
.c
= *p
, it2
.len
= 1;
21882 it2
.glyph_row
= NULL
;
21883 it2
.what
= IT_CHARACTER
;
21884 x_produce_glyphs (&it2
);
21885 width
= NUMVAL (prop
) * it2
.pixel_width
;
21887 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
21888 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
21890 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
21891 align_to
= (align_to
< 0
21893 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
21894 else if (align_to
< 0)
21895 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
21896 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
21897 zero_width_ok_p
= 1;
21900 /* Nothing specified -> width defaults to canonical char width. */
21901 width
= FRAME_COLUMN_WIDTH (it
->f
);
21903 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
21906 /* Compute height. */
21907 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
21908 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
21911 zero_height_ok_p
= 1;
21913 else if (prop
= Fplist_get (plist
, QCrelative_height
),
21915 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
21917 height
= FONT_HEIGHT (font
);
21919 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
21922 /* Compute percentage of height used for ascent. If
21923 `:ascent ASCENT' is present and valid, use that. Otherwise,
21924 derive the ascent from the font in use. */
21925 if (prop
= Fplist_get (plist
, QCascent
),
21926 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
21927 ascent
= height
* NUMVAL (prop
) / 100.0;
21928 else if (!NILP (prop
)
21929 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
21930 ascent
= min (max (0, (int)tem
), height
);
21932 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
21934 if (width
> 0 && it
->line_wrap
!= TRUNCATE
21935 && it
->current_x
+ width
> it
->last_visible_x
)
21936 width
= it
->last_visible_x
- it
->current_x
- 1;
21938 if (width
> 0 && height
> 0 && it
->glyph_row
)
21940 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
21941 if (!STRINGP (object
))
21942 object
= it
->w
->buffer
;
21943 append_stretch_glyph (it
, object
, width
, height
, ascent
);
21946 it
->pixel_width
= width
;
21947 it
->ascent
= it
->phys_ascent
= ascent
;
21948 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
21949 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
21951 take_vertical_position_into_account (it
);
21954 /* Calculate line-height and line-spacing properties.
21955 An integer value specifies explicit pixel value.
21956 A float value specifies relative value to current face height.
21957 A cons (float . face-name) specifies relative value to
21958 height of specified face font.
21960 Returns height in pixels, or nil. */
21964 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
21965 int boff
, int override
)
21967 Lisp_Object face_name
= Qnil
;
21968 int ascent
, descent
, height
;
21970 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
21975 face_name
= XCAR (val
);
21977 if (!NUMBERP (val
))
21978 val
= make_number (1);
21979 if (NILP (face_name
))
21981 height
= it
->ascent
+ it
->descent
;
21986 if (NILP (face_name
))
21988 font
= FRAME_FONT (it
->f
);
21989 boff
= FRAME_BASELINE_OFFSET (it
->f
);
21991 else if (EQ (face_name
, Qt
))
22000 face_id
= lookup_named_face (it
->f
, face_name
, 0);
22002 return make_number (-1);
22004 face
= FACE_FROM_ID (it
->f
, face_id
);
22007 return make_number (-1);
22008 boff
= font
->baseline_offset
;
22009 if (font
->vertical_centering
)
22010 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22013 ascent
= FONT_BASE (font
) + boff
;
22014 descent
= FONT_DESCENT (font
) - boff
;
22018 it
->override_ascent
= ascent
;
22019 it
->override_descent
= descent
;
22020 it
->override_boff
= boff
;
22023 height
= ascent
+ descent
;
22027 height
= (int)(XFLOAT_DATA (val
) * height
);
22028 else if (INTEGERP (val
))
22029 height
*= XINT (val
);
22031 return make_number (height
);
22036 Produce glyphs/get display metrics for the display element IT is
22037 loaded with. See the description of struct it in dispextern.h
22038 for an overview of struct it. */
22041 x_produce_glyphs (struct it
*it
)
22043 int extra_line_spacing
= it
->extra_line_spacing
;
22045 it
->glyph_not_available_p
= 0;
22047 if (it
->what
== IT_CHARACTER
)
22051 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22052 struct font_metrics
*pcm
;
22053 int font_not_found_p
;
22054 int boff
; /* baseline offset */
22055 /* We may change it->multibyte_p upon unibyte<->multibyte
22056 conversion. So, save the current value now and restore it
22059 Note: It seems that we don't have to record multibyte_p in
22060 struct glyph because the character code itself tells whether
22061 or not the character is multibyte. Thus, in the future, we
22062 must consider eliminating the field `multibyte_p' in the
22064 int saved_multibyte_p
= it
->multibyte_p
;
22066 /* Maybe translate single-byte characters to multibyte, or the
22068 it
->char_to_display
= it
->c
;
22069 if (!ASCII_BYTE_P (it
->c
)
22070 && ! it
->multibyte_p
)
22072 if (SINGLE_BYTE_CHAR_P (it
->c
)
22073 && unibyte_display_via_language_environment
)
22075 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
22077 /* get_next_display_element assures that this decoding
22079 it
->char_to_display
= DECODE_CHAR (unibyte
, it
->c
);
22080 it
->multibyte_p
= 1;
22081 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
,
22083 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22087 /* Get font to use. Encode IT->char_to_display. */
22088 get_char_face_and_encoding (it
->f
, it
->char_to_display
, it
->face_id
,
22089 &char2b
, it
->multibyte_p
, 0);
22092 font_not_found_p
= font
== NULL
;
22093 if (font_not_found_p
)
22095 /* When no suitable font found, display an empty box based
22096 on the metrics of the font of the default face (or what
22098 struct face
*no_font_face
22099 = FACE_FROM_ID (it
->f
,
22100 NILP (Vface_remapping_alist
) ? DEFAULT_FACE_ID
22101 : lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
22102 font
= no_font_face
->font
;
22103 boff
= font
->baseline_offset
;
22107 boff
= font
->baseline_offset
;
22108 if (font
->vertical_centering
)
22109 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22112 if (it
->char_to_display
>= ' '
22113 && (!it
->multibyte_p
|| it
->char_to_display
< 128))
22115 /* Either unibyte or ASCII. */
22120 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22122 if (it
->override_ascent
>= 0)
22124 it
->ascent
= it
->override_ascent
;
22125 it
->descent
= it
->override_descent
;
22126 boff
= it
->override_boff
;
22130 it
->ascent
= FONT_BASE (font
) + boff
;
22131 it
->descent
= FONT_DESCENT (font
) - boff
;
22136 it
->phys_ascent
= pcm
->ascent
+ boff
;
22137 it
->phys_descent
= pcm
->descent
- boff
;
22138 it
->pixel_width
= pcm
->width
;
22142 it
->glyph_not_available_p
= 1;
22143 it
->phys_ascent
= it
->ascent
;
22144 it
->phys_descent
= it
->descent
;
22145 it
->pixel_width
= FONT_WIDTH (font
);
22148 if (it
->constrain_row_ascent_descent_p
)
22150 if (it
->descent
> it
->max_descent
)
22152 it
->ascent
+= it
->descent
- it
->max_descent
;
22153 it
->descent
= it
->max_descent
;
22155 if (it
->ascent
> it
->max_ascent
)
22157 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22158 it
->ascent
= it
->max_ascent
;
22160 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22161 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22162 extra_line_spacing
= 0;
22165 /* If this is a space inside a region of text with
22166 `space-width' property, change its width. */
22167 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
22169 it
->pixel_width
*= XFLOATINT (it
->space_width
);
22171 /* If face has a box, add the box thickness to the character
22172 height. If character has a box line to the left and/or
22173 right, add the box line width to the character's width. */
22174 if (face
->box
!= FACE_NO_BOX
)
22176 int thick
= face
->box_line_width
;
22180 it
->ascent
+= thick
;
22181 it
->descent
+= thick
;
22186 if (it
->start_of_box_run_p
)
22187 it
->pixel_width
+= thick
;
22188 if (it
->end_of_box_run_p
)
22189 it
->pixel_width
+= thick
;
22192 /* If face has an overline, add the height of the overline
22193 (1 pixel) and a 1 pixel margin to the character height. */
22194 if (face
->overline_p
)
22195 it
->ascent
+= overline_margin
;
22197 if (it
->constrain_row_ascent_descent_p
)
22199 if (it
->ascent
> it
->max_ascent
)
22200 it
->ascent
= it
->max_ascent
;
22201 if (it
->descent
> it
->max_descent
)
22202 it
->descent
= it
->max_descent
;
22205 take_vertical_position_into_account (it
);
22207 /* If we have to actually produce glyphs, do it. */
22212 /* Translate a space with a `space-width' property
22213 into a stretch glyph. */
22214 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
22215 / FONT_HEIGHT (font
));
22216 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22217 it
->ascent
+ it
->descent
, ascent
);
22222 /* If characters with lbearing or rbearing are displayed
22223 in this line, record that fact in a flag of the
22224 glyph row. This is used to optimize X output code. */
22225 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
22226 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22228 if (! stretched_p
&& it
->pixel_width
== 0)
22229 /* We assure that all visible glyphs have at least 1-pixel
22231 it
->pixel_width
= 1;
22233 else if (it
->char_to_display
== '\n')
22235 /* A newline has no width, but we need the height of the
22236 line. But if previous part of the line sets a height,
22237 don't increase that height */
22239 Lisp_Object height
;
22240 Lisp_Object total_height
= Qnil
;
22242 it
->override_ascent
= -1;
22243 it
->pixel_width
= 0;
22246 height
= get_it_property (it
, Qline_height
);
22247 /* Split (line-height total-height) list */
22249 && CONSP (XCDR (height
))
22250 && NILP (XCDR (XCDR (height
))))
22252 total_height
= XCAR (XCDR (height
));
22253 height
= XCAR (height
);
22255 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
22257 if (it
->override_ascent
>= 0)
22259 it
->ascent
= it
->override_ascent
;
22260 it
->descent
= it
->override_descent
;
22261 boff
= it
->override_boff
;
22265 it
->ascent
= FONT_BASE (font
) + boff
;
22266 it
->descent
= FONT_DESCENT (font
) - boff
;
22269 if (EQ (height
, Qt
))
22271 if (it
->descent
> it
->max_descent
)
22273 it
->ascent
+= it
->descent
- it
->max_descent
;
22274 it
->descent
= it
->max_descent
;
22276 if (it
->ascent
> it
->max_ascent
)
22278 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22279 it
->ascent
= it
->max_ascent
;
22281 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22282 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22283 it
->constrain_row_ascent_descent_p
= 1;
22284 extra_line_spacing
= 0;
22288 Lisp_Object spacing
;
22290 it
->phys_ascent
= it
->ascent
;
22291 it
->phys_descent
= it
->descent
;
22293 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
22294 && face
->box
!= FACE_NO_BOX
22295 && face
->box_line_width
> 0)
22297 it
->ascent
+= face
->box_line_width
;
22298 it
->descent
+= face
->box_line_width
;
22301 && XINT (height
) > it
->ascent
+ it
->descent
)
22302 it
->ascent
= XINT (height
) - it
->descent
;
22304 if (!NILP (total_height
))
22305 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
22308 spacing
= get_it_property (it
, Qline_spacing
);
22309 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
22311 if (INTEGERP (spacing
))
22313 extra_line_spacing
= XINT (spacing
);
22314 if (!NILP (total_height
))
22315 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
22319 else if (it
->char_to_display
== '\t')
22321 if (font
->space_width
> 0)
22323 int tab_width
= it
->tab_width
* font
->space_width
;
22324 int x
= it
->current_x
+ it
->continuation_lines_width
;
22325 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
22327 /* If the distance from the current position to the next tab
22328 stop is less than a space character width, use the
22329 tab stop after that. */
22330 if (next_tab_x
- x
< font
->space_width
)
22331 next_tab_x
+= tab_width
;
22333 it
->pixel_width
= next_tab_x
- x
;
22335 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
22336 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
22340 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22341 it
->ascent
+ it
->descent
, it
->ascent
);
22346 it
->pixel_width
= 0;
22352 /* A multi-byte character. Assume that the display width of the
22353 character is the width of the character multiplied by the
22354 width of the font. */
22356 /* If we found a font, this font should give us the right
22357 metrics. If we didn't find a font, use the frame's
22358 default font and calculate the width of the character by
22359 multiplying the width of font by the width of the
22362 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22364 if (font_not_found_p
|| !pcm
)
22366 int char_width
= CHAR_WIDTH (it
->char_to_display
);
22368 if (char_width
== 0)
22369 /* This is a non spacing character. But, as we are
22370 going to display an empty box, the box must occupy
22371 at least one column. */
22373 it
->glyph_not_available_p
= 1;
22374 it
->pixel_width
= font
->space_width
* char_width
;
22375 it
->phys_ascent
= FONT_BASE (font
) + boff
;
22376 it
->phys_descent
= FONT_DESCENT (font
) - boff
;
22380 it
->pixel_width
= pcm
->width
;
22381 it
->phys_ascent
= pcm
->ascent
+ boff
;
22382 it
->phys_descent
= pcm
->descent
- boff
;
22384 && (pcm
->lbearing
< 0
22385 || pcm
->rbearing
> pcm
->width
))
22386 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22389 it
->ascent
= FONT_BASE (font
) + boff
;
22390 it
->descent
= FONT_DESCENT (font
) - boff
;
22391 if (face
->box
!= FACE_NO_BOX
)
22393 int thick
= face
->box_line_width
;
22397 it
->ascent
+= thick
;
22398 it
->descent
+= thick
;
22403 if (it
->start_of_box_run_p
)
22404 it
->pixel_width
+= thick
;
22405 if (it
->end_of_box_run_p
)
22406 it
->pixel_width
+= thick
;
22409 /* If face has an overline, add the height of the overline
22410 (1 pixel) and a 1 pixel margin to the character height. */
22411 if (face
->overline_p
)
22412 it
->ascent
+= overline_margin
;
22414 take_vertical_position_into_account (it
);
22416 if (it
->ascent
< 0)
22418 if (it
->descent
< 0)
22423 if (it
->pixel_width
== 0)
22424 /* We assure that all visible glyphs have at least 1-pixel
22426 it
->pixel_width
= 1;
22428 it
->multibyte_p
= saved_multibyte_p
;
22430 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
22432 /* A static composition.
22434 Note: A composition is represented as one glyph in the
22435 glyph matrix. There are no padding glyphs.
22437 Important note: pixel_width, ascent, and descent are the
22438 values of what is drawn by draw_glyphs (i.e. the values of
22439 the overall glyphs composed). */
22440 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22441 int boff
; /* baseline offset */
22442 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
22443 int glyph_len
= cmp
->glyph_len
;
22444 struct font
*font
= face
->font
;
22448 /* If we have not yet calculated pixel size data of glyphs of
22449 the composition for the current face font, calculate them
22450 now. Theoretically, we have to check all fonts for the
22451 glyphs, but that requires much time and memory space. So,
22452 here we check only the font of the first glyph. This may
22453 lead to incorrect display, but it's very rare, and C-l
22454 (recenter-top-bottom) can correct the display anyway. */
22455 if (! cmp
->font
|| cmp
->font
!= font
)
22457 /* Ascent and descent of the font of the first character
22458 of this composition (adjusted by baseline offset).
22459 Ascent and descent of overall glyphs should not be less
22460 than these, respectively. */
22461 int font_ascent
, font_descent
, font_height
;
22462 /* Bounding box of the overall glyphs. */
22463 int leftmost
, rightmost
, lowest
, highest
;
22464 int lbearing
, rbearing
;
22465 int i
, width
, ascent
, descent
;
22466 int left_padded
= 0, right_padded
= 0;
22469 struct font_metrics
*pcm
;
22470 int font_not_found_p
;
22473 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
22474 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
22476 if (glyph_len
< cmp
->glyph_len
)
22478 for (i
= 0; i
< glyph_len
; i
++)
22480 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
22482 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22487 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
22488 : IT_CHARPOS (*it
));
22489 /* If no suitable font is found, use the default font. */
22490 font_not_found_p
= font
== NULL
;
22491 if (font_not_found_p
)
22493 face
= face
->ascii_face
;
22496 boff
= font
->baseline_offset
;
22497 if (font
->vertical_centering
)
22498 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22499 font_ascent
= FONT_BASE (font
) + boff
;
22500 font_descent
= FONT_DESCENT (font
) - boff
;
22501 font_height
= FONT_HEIGHT (font
);
22503 cmp
->font
= (void *) font
;
22506 if (! font_not_found_p
)
22508 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
22509 &char2b
, it
->multibyte_p
, 0);
22510 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22513 /* Initialize the bounding box. */
22516 width
= pcm
->width
;
22517 ascent
= pcm
->ascent
;
22518 descent
= pcm
->descent
;
22519 lbearing
= pcm
->lbearing
;
22520 rbearing
= pcm
->rbearing
;
22524 width
= FONT_WIDTH (font
);
22525 ascent
= FONT_BASE (font
);
22526 descent
= FONT_DESCENT (font
);
22533 lowest
= - descent
+ boff
;
22534 highest
= ascent
+ boff
;
22536 if (! font_not_found_p
22537 && font
->default_ascent
22538 && CHAR_TABLE_P (Vuse_default_ascent
)
22539 && !NILP (Faref (Vuse_default_ascent
,
22540 make_number (it
->char_to_display
))))
22541 highest
= font
->default_ascent
+ boff
;
22543 /* Draw the first glyph at the normal position. It may be
22544 shifted to right later if some other glyphs are drawn
22546 cmp
->offsets
[i
* 2] = 0;
22547 cmp
->offsets
[i
* 2 + 1] = boff
;
22548 cmp
->lbearing
= lbearing
;
22549 cmp
->rbearing
= rbearing
;
22551 /* Set cmp->offsets for the remaining glyphs. */
22552 for (i
++; i
< glyph_len
; i
++)
22554 int left
, right
, btm
, top
;
22555 int ch
= COMPOSITION_GLYPH (cmp
, i
);
22557 struct face
*this_face
;
22562 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
22563 this_face
= FACE_FROM_ID (it
->f
, face_id
);
22564 font
= this_face
->font
;
22570 this_boff
= font
->baseline_offset
;
22571 if (font
->vertical_centering
)
22572 this_boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22573 get_char_face_and_encoding (it
->f
, ch
, face_id
,
22574 &char2b
, it
->multibyte_p
, 0);
22575 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22578 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22581 width
= pcm
->width
;
22582 ascent
= pcm
->ascent
;
22583 descent
= pcm
->descent
;
22584 lbearing
= pcm
->lbearing
;
22585 rbearing
= pcm
->rbearing
;
22586 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
22588 /* Relative composition with or without
22589 alternate chars. */
22590 left
= (leftmost
+ rightmost
- width
) / 2;
22591 btm
= - descent
+ boff
;
22592 if (font
->relative_compose
22593 && (! CHAR_TABLE_P (Vignore_relative_composition
)
22594 || NILP (Faref (Vignore_relative_composition
,
22595 make_number (ch
)))))
22598 if (- descent
>= font
->relative_compose
)
22599 /* One extra pixel between two glyphs. */
22601 else if (ascent
<= 0)
22602 /* One extra pixel between two glyphs. */
22603 btm
= lowest
- 1 - ascent
- descent
;
22608 /* A composition rule is specified by an integer
22609 value that encodes global and new reference
22610 points (GREF and NREF). GREF and NREF are
22611 specified by numbers as below:
22613 0---1---2 -- ascent
22617 9--10--11 -- center
22619 ---3---4---5--- baseline
22621 6---7---8 -- descent
22623 int rule
= COMPOSITION_RULE (cmp
, i
);
22624 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
22626 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
22627 grefx
= gref
% 3, nrefx
= nref
% 3;
22628 grefy
= gref
/ 3, nrefy
= nref
/ 3;
22630 xoff
= font_height
* (xoff
- 128) / 256;
22632 yoff
= font_height
* (yoff
- 128) / 256;
22635 + grefx
* (rightmost
- leftmost
) / 2
22636 - nrefx
* width
/ 2
22639 btm
= ((grefy
== 0 ? highest
22641 : grefy
== 2 ? lowest
22642 : (highest
+ lowest
) / 2)
22643 - (nrefy
== 0 ? ascent
+ descent
22644 : nrefy
== 1 ? descent
- boff
22646 : (ascent
+ descent
) / 2)
22650 cmp
->offsets
[i
* 2] = left
;
22651 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
22653 /* Update the bounding box of the overall glyphs. */
22656 right
= left
+ width
;
22657 if (left
< leftmost
)
22659 if (right
> rightmost
)
22662 top
= btm
+ descent
+ ascent
;
22668 if (cmp
->lbearing
> left
+ lbearing
)
22669 cmp
->lbearing
= left
+ lbearing
;
22670 if (cmp
->rbearing
< left
+ rbearing
)
22671 cmp
->rbearing
= left
+ rbearing
;
22675 /* If there are glyphs whose x-offsets are negative,
22676 shift all glyphs to the right and make all x-offsets
22680 for (i
= 0; i
< cmp
->glyph_len
; i
++)
22681 cmp
->offsets
[i
* 2] -= leftmost
;
22682 rightmost
-= leftmost
;
22683 cmp
->lbearing
-= leftmost
;
22684 cmp
->rbearing
-= leftmost
;
22687 if (left_padded
&& cmp
->lbearing
< 0)
22689 for (i
= 0; i
< cmp
->glyph_len
; i
++)
22690 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
22691 rightmost
-= cmp
->lbearing
;
22692 cmp
->rbearing
-= cmp
->lbearing
;
22695 if (right_padded
&& rightmost
< cmp
->rbearing
)
22697 rightmost
= cmp
->rbearing
;
22700 cmp
->pixel_width
= rightmost
;
22701 cmp
->ascent
= highest
;
22702 cmp
->descent
= - lowest
;
22703 if (cmp
->ascent
< font_ascent
)
22704 cmp
->ascent
= font_ascent
;
22705 if (cmp
->descent
< font_descent
)
22706 cmp
->descent
= font_descent
;
22710 && (cmp
->lbearing
< 0
22711 || cmp
->rbearing
> cmp
->pixel_width
))
22712 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22714 it
->pixel_width
= cmp
->pixel_width
;
22715 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
22716 it
->descent
= it
->phys_descent
= cmp
->descent
;
22717 if (face
->box
!= FACE_NO_BOX
)
22719 int thick
= face
->box_line_width
;
22723 it
->ascent
+= thick
;
22724 it
->descent
+= thick
;
22729 if (it
->start_of_box_run_p
)
22730 it
->pixel_width
+= thick
;
22731 if (it
->end_of_box_run_p
)
22732 it
->pixel_width
+= thick
;
22735 /* If face has an overline, add the height of the overline
22736 (1 pixel) and a 1 pixel margin to the character height. */
22737 if (face
->overline_p
)
22738 it
->ascent
+= overline_margin
;
22740 take_vertical_position_into_account (it
);
22741 if (it
->ascent
< 0)
22743 if (it
->descent
< 0)
22747 append_composite_glyph (it
);
22749 else if (it
->what
== IT_COMPOSITION
)
22751 /* A dynamic (automatic) composition. */
22752 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22753 Lisp_Object gstring
;
22754 struct font_metrics metrics
;
22756 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
22758 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
22761 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
22762 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22763 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
22764 it
->descent
= it
->phys_descent
= metrics
.descent
;
22765 if (face
->box
!= FACE_NO_BOX
)
22767 int thick
= face
->box_line_width
;
22771 it
->ascent
+= thick
;
22772 it
->descent
+= thick
;
22777 if (it
->start_of_box_run_p
)
22778 it
->pixel_width
+= thick
;
22779 if (it
->end_of_box_run_p
)
22780 it
->pixel_width
+= thick
;
22782 /* If face has an overline, add the height of the overline
22783 (1 pixel) and a 1 pixel margin to the character height. */
22784 if (face
->overline_p
)
22785 it
->ascent
+= overline_margin
;
22786 take_vertical_position_into_account (it
);
22787 if (it
->ascent
< 0)
22789 if (it
->descent
< 0)
22793 append_composite_glyph (it
);
22795 else if (it
->what
== IT_IMAGE
)
22796 produce_image_glyph (it
);
22797 else if (it
->what
== IT_STRETCH
)
22798 produce_stretch_glyph (it
);
22800 /* Accumulate dimensions. Note: can't assume that it->descent > 0
22801 because this isn't true for images with `:ascent 100'. */
22802 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
22803 if (it
->area
== TEXT_AREA
)
22804 it
->current_x
+= it
->pixel_width
;
22806 if (extra_line_spacing
> 0)
22808 it
->descent
+= extra_line_spacing
;
22809 if (extra_line_spacing
> it
->max_extra_line_spacing
)
22810 it
->max_extra_line_spacing
= extra_line_spacing
;
22813 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
22814 it
->max_descent
= max (it
->max_descent
, it
->descent
);
22815 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
22816 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
22820 Output LEN glyphs starting at START at the nominal cursor position.
22821 Advance the nominal cursor over the text. The global variable
22822 updated_window contains the window being updated, updated_row is
22823 the glyph row being updated, and updated_area is the area of that
22824 row being updated. */
22827 x_write_glyphs (struct glyph
*start
, int len
)
22831 xassert (updated_window
&& updated_row
);
22834 /* Write glyphs. */
22836 hpos
= start
- updated_row
->glyphs
[updated_area
];
22837 x
= draw_glyphs (updated_window
, output_cursor
.x
,
22838 updated_row
, updated_area
,
22840 DRAW_NORMAL_TEXT
, 0);
22842 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
22843 if (updated_area
== TEXT_AREA
22844 && updated_window
->phys_cursor_on_p
22845 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
22846 && updated_window
->phys_cursor
.hpos
>= hpos
22847 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
22848 updated_window
->phys_cursor_on_p
= 0;
22852 /* Advance the output cursor. */
22853 output_cursor
.hpos
+= len
;
22854 output_cursor
.x
= x
;
22859 Insert LEN glyphs from START at the nominal cursor position. */
22862 x_insert_glyphs (struct glyph
*start
, int len
)
22866 int line_height
, shift_by_width
, shifted_region_width
;
22867 struct glyph_row
*row
;
22868 struct glyph
*glyph
;
22869 int frame_x
, frame_y
;
22872 xassert (updated_window
&& updated_row
);
22874 w
= updated_window
;
22875 f
= XFRAME (WINDOW_FRAME (w
));
22877 /* Get the height of the line we are in. */
22879 line_height
= row
->height
;
22881 /* Get the width of the glyphs to insert. */
22882 shift_by_width
= 0;
22883 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
22884 shift_by_width
+= glyph
->pixel_width
;
22886 /* Get the width of the region to shift right. */
22887 shifted_region_width
= (window_box_width (w
, updated_area
)
22892 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
22893 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
22895 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
22896 line_height
, shift_by_width
);
22898 /* Write the glyphs. */
22899 hpos
= start
- row
->glyphs
[updated_area
];
22900 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
22902 DRAW_NORMAL_TEXT
, 0);
22904 /* Advance the output cursor. */
22905 output_cursor
.hpos
+= len
;
22906 output_cursor
.x
+= shift_by_width
;
22912 Erase the current text line from the nominal cursor position
22913 (inclusive) to pixel column TO_X (exclusive). The idea is that
22914 everything from TO_X onward is already erased.
22916 TO_X is a pixel position relative to updated_area of
22917 updated_window. TO_X == -1 means clear to the end of this area. */
22920 x_clear_end_of_line (int to_x
)
22923 struct window
*w
= updated_window
;
22924 int max_x
, min_y
, max_y
;
22925 int from_x
, from_y
, to_y
;
22927 xassert (updated_window
&& updated_row
);
22928 f
= XFRAME (w
->frame
);
22930 if (updated_row
->full_width_p
)
22931 max_x
= WINDOW_TOTAL_WIDTH (w
);
22933 max_x
= window_box_width (w
, updated_area
);
22934 max_y
= window_text_bottom_y (w
);
22936 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
22937 of window. For TO_X > 0, truncate to end of drawing area. */
22943 to_x
= min (to_x
, max_x
);
22945 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
22947 /* Notice if the cursor will be cleared by this operation. */
22948 if (!updated_row
->full_width_p
)
22949 notice_overwritten_cursor (w
, updated_area
,
22950 output_cursor
.x
, -1,
22952 MATRIX_ROW_BOTTOM_Y (updated_row
));
22954 from_x
= output_cursor
.x
;
22956 /* Translate to frame coordinates. */
22957 if (updated_row
->full_width_p
)
22959 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
22960 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
22964 int area_left
= window_box_left (w
, updated_area
);
22965 from_x
+= area_left
;
22969 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
22970 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
22971 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
22973 /* Prevent inadvertently clearing to end of the X window. */
22974 if (to_x
> from_x
&& to_y
> from_y
)
22977 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
22978 to_x
- from_x
, to_y
- from_y
);
22983 #endif /* HAVE_WINDOW_SYSTEM */
22987 /***********************************************************************
22989 ***********************************************************************/
22991 /* Value is the internal representation of the specified cursor type
22992 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
22993 of the bar cursor. */
22995 static enum text_cursor_kinds
22996 get_specified_cursor_type (Lisp_Object arg
, int *width
)
22998 enum text_cursor_kinds type
;
23003 if (EQ (arg
, Qbox
))
23004 return FILLED_BOX_CURSOR
;
23006 if (EQ (arg
, Qhollow
))
23007 return HOLLOW_BOX_CURSOR
;
23009 if (EQ (arg
, Qbar
))
23016 && EQ (XCAR (arg
), Qbar
)
23017 && INTEGERP (XCDR (arg
))
23018 && XINT (XCDR (arg
)) >= 0)
23020 *width
= XINT (XCDR (arg
));
23024 if (EQ (arg
, Qhbar
))
23027 return HBAR_CURSOR
;
23031 && EQ (XCAR (arg
), Qhbar
)
23032 && INTEGERP (XCDR (arg
))
23033 && XINT (XCDR (arg
)) >= 0)
23035 *width
= XINT (XCDR (arg
));
23036 return HBAR_CURSOR
;
23039 /* Treat anything unknown as "hollow box cursor".
23040 It was bad to signal an error; people have trouble fixing
23041 .Xdefaults with Emacs, when it has something bad in it. */
23042 type
= HOLLOW_BOX_CURSOR
;
23047 /* Set the default cursor types for specified frame. */
23049 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
23054 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
23055 FRAME_CURSOR_WIDTH (f
) = width
;
23057 /* By default, set up the blink-off state depending on the on-state. */
23059 tem
= Fassoc (arg
, Vblink_cursor_alist
);
23062 FRAME_BLINK_OFF_CURSOR (f
)
23063 = get_specified_cursor_type (XCDR (tem
), &width
);
23064 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
23067 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
23071 /* Return the cursor we want to be displayed in window W. Return
23072 width of bar/hbar cursor through WIDTH arg. Return with
23073 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
23074 (i.e. if the `system caret' should track this cursor).
23076 In a mini-buffer window, we want the cursor only to appear if we
23077 are reading input from this window. For the selected window, we
23078 want the cursor type given by the frame parameter or buffer local
23079 setting of cursor-type. If explicitly marked off, draw no cursor.
23080 In all other cases, we want a hollow box cursor. */
23082 static enum text_cursor_kinds
23083 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
23084 int *active_cursor
)
23086 struct frame
*f
= XFRAME (w
->frame
);
23087 struct buffer
*b
= XBUFFER (w
->buffer
);
23088 int cursor_type
= DEFAULT_CURSOR
;
23089 Lisp_Object alt_cursor
;
23090 int non_selected
= 0;
23092 *active_cursor
= 1;
23095 if (cursor_in_echo_area
23096 && FRAME_HAS_MINIBUF_P (f
)
23097 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
23099 if (w
== XWINDOW (echo_area_window
))
23101 if (EQ (b
->cursor_type
, Qt
) || NILP (b
->cursor_type
))
23103 *width
= FRAME_CURSOR_WIDTH (f
);
23104 return FRAME_DESIRED_CURSOR (f
);
23107 return get_specified_cursor_type (b
->cursor_type
, width
);
23110 *active_cursor
= 0;
23114 /* Detect a nonselected window or nonselected frame. */
23115 else if (w
!= XWINDOW (f
->selected_window
)
23116 #ifdef HAVE_WINDOW_SYSTEM
23117 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
23121 *active_cursor
= 0;
23123 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
23129 /* Never display a cursor in a window in which cursor-type is nil. */
23130 if (NILP (b
->cursor_type
))
23133 /* Get the normal cursor type for this window. */
23134 if (EQ (b
->cursor_type
, Qt
))
23136 cursor_type
= FRAME_DESIRED_CURSOR (f
);
23137 *width
= FRAME_CURSOR_WIDTH (f
);
23140 cursor_type
= get_specified_cursor_type (b
->cursor_type
, width
);
23142 /* Use cursor-in-non-selected-windows instead
23143 for non-selected window or frame. */
23146 alt_cursor
= b
->cursor_in_non_selected_windows
;
23147 if (!EQ (Qt
, alt_cursor
))
23148 return get_specified_cursor_type (alt_cursor
, width
);
23149 /* t means modify the normal cursor type. */
23150 if (cursor_type
== FILLED_BOX_CURSOR
)
23151 cursor_type
= HOLLOW_BOX_CURSOR
;
23152 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
23154 return cursor_type
;
23157 /* Use normal cursor if not blinked off. */
23158 if (!w
->cursor_off_p
)
23160 #ifdef HAVE_WINDOW_SYSTEM
23161 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
23163 if (cursor_type
== FILLED_BOX_CURSOR
)
23165 /* Using a block cursor on large images can be very annoying.
23166 So use a hollow cursor for "large" images.
23167 If image is not transparent (no mask), also use hollow cursor. */
23168 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
23169 if (img
!= NULL
&& IMAGEP (img
->spec
))
23171 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
23172 where N = size of default frame font size.
23173 This should cover most of the "tiny" icons people may use. */
23175 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
23176 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
23177 cursor_type
= HOLLOW_BOX_CURSOR
;
23180 else if (cursor_type
!= NO_CURSOR
)
23182 /* Display current only supports BOX and HOLLOW cursors for images.
23183 So for now, unconditionally use a HOLLOW cursor when cursor is
23184 not a solid box cursor. */
23185 cursor_type
= HOLLOW_BOX_CURSOR
;
23189 return cursor_type
;
23192 /* Cursor is blinked off, so determine how to "toggle" it. */
23194 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
23195 if ((alt_cursor
= Fassoc (b
->cursor_type
, Vblink_cursor_alist
), !NILP (alt_cursor
)))
23196 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
23198 /* Then see if frame has specified a specific blink off cursor type. */
23199 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
23201 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
23202 return FRAME_BLINK_OFF_CURSOR (f
);
23206 /* Some people liked having a permanently visible blinking cursor,
23207 while others had very strong opinions against it. So it was
23208 decided to remove it. KFS 2003-09-03 */
23210 /* Finally perform built-in cursor blinking:
23211 filled box <-> hollow box
23212 wide [h]bar <-> narrow [h]bar
23213 narrow [h]bar <-> no cursor
23214 other type <-> no cursor */
23216 if (cursor_type
== FILLED_BOX_CURSOR
)
23217 return HOLLOW_BOX_CURSOR
;
23219 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
23222 return cursor_type
;
23230 #ifdef HAVE_WINDOW_SYSTEM
23232 /* Notice when the text cursor of window W has been completely
23233 overwritten by a drawing operation that outputs glyphs in AREA
23234 starting at X0 and ending at X1 in the line starting at Y0 and
23235 ending at Y1. X coordinates are area-relative. X1 < 0 means all
23236 the rest of the line after X0 has been written. Y coordinates
23237 are window-relative. */
23240 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
23241 int x0
, int x1
, int y0
, int y1
)
23243 int cx0
, cx1
, cy0
, cy1
;
23244 struct glyph_row
*row
;
23246 if (!w
->phys_cursor_on_p
)
23248 if (area
!= TEXT_AREA
)
23251 if (w
->phys_cursor
.vpos
< 0
23252 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
23253 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
23254 !(row
->enabled_p
&& row
->displays_text_p
)))
23257 if (row
->cursor_in_fringe_p
)
23259 row
->cursor_in_fringe_p
= 0;
23260 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
23261 w
->phys_cursor_on_p
= 0;
23265 cx0
= w
->phys_cursor
.x
;
23266 cx1
= cx0
+ w
->phys_cursor_width
;
23267 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
23270 /* The cursor image will be completely removed from the
23271 screen if the output area intersects the cursor area in
23272 y-direction. When we draw in [y0 y1[, and some part of
23273 the cursor is at y < y0, that part must have been drawn
23274 before. When scrolling, the cursor is erased before
23275 actually scrolling, so we don't come here. When not
23276 scrolling, the rows above the old cursor row must have
23277 changed, and in this case these rows must have written
23278 over the cursor image.
23280 Likewise if part of the cursor is below y1, with the
23281 exception of the cursor being in the first blank row at
23282 the buffer and window end because update_text_area
23283 doesn't draw that row. (Except when it does, but
23284 that's handled in update_text_area.) */
23286 cy0
= w
->phys_cursor
.y
;
23287 cy1
= cy0
+ w
->phys_cursor_height
;
23288 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
23291 w
->phys_cursor_on_p
= 0;
23294 #endif /* HAVE_WINDOW_SYSTEM */
23297 /************************************************************************
23299 ************************************************************************/
23301 #ifdef HAVE_WINDOW_SYSTEM
23304 Fix the display of area AREA of overlapping row ROW in window W
23305 with respect to the overlapping part OVERLAPS. */
23308 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
23309 enum glyph_row_area area
, int overlaps
)
23316 for (i
= 0; i
< row
->used
[area
];)
23318 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
23320 int start
= i
, start_x
= x
;
23324 x
+= row
->glyphs
[area
][i
].pixel_width
;
23327 while (i
< row
->used
[area
]
23328 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
23330 draw_glyphs (w
, start_x
, row
, area
,
23332 DRAW_NORMAL_TEXT
, overlaps
);
23336 x
+= row
->glyphs
[area
][i
].pixel_width
;
23346 Draw the cursor glyph of window W in glyph row ROW. See the
23347 comment of draw_glyphs for the meaning of HL. */
23350 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
23351 enum draw_glyphs_face hl
)
23353 /* If cursor hpos is out of bounds, don't draw garbage. This can
23354 happen in mini-buffer windows when switching between echo area
23355 glyphs and mini-buffer. */
23356 if ((row
->reversed_p
23357 ? (w
->phys_cursor
.hpos
>= 0)
23358 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
23360 int on_p
= w
->phys_cursor_on_p
;
23362 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
23363 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
23365 w
->phys_cursor_on_p
= on_p
;
23367 if (hl
== DRAW_CURSOR
)
23368 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23369 /* When we erase the cursor, and ROW is overlapped by other
23370 rows, make sure that these overlapping parts of other rows
23372 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
23374 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23376 if (row
> w
->current_matrix
->rows
23377 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
23378 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
23379 OVERLAPS_ERASED_CURSOR
);
23381 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
23382 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
23383 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
23384 OVERLAPS_ERASED_CURSOR
);
23391 Erase the image of a cursor of window W from the screen. */
23394 erase_phys_cursor (struct window
*w
)
23396 struct frame
*f
= XFRAME (w
->frame
);
23397 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
23398 int hpos
= w
->phys_cursor
.hpos
;
23399 int vpos
= w
->phys_cursor
.vpos
;
23400 int mouse_face_here_p
= 0;
23401 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
23402 struct glyph_row
*cursor_row
;
23403 struct glyph
*cursor_glyph
;
23404 enum draw_glyphs_face hl
;
23406 /* No cursor displayed or row invalidated => nothing to do on the
23408 if (w
->phys_cursor_type
== NO_CURSOR
)
23409 goto mark_cursor_off
;
23411 /* VPOS >= active_glyphs->nrows means that window has been resized.
23412 Don't bother to erase the cursor. */
23413 if (vpos
>= active_glyphs
->nrows
)
23414 goto mark_cursor_off
;
23416 /* If row containing cursor is marked invalid, there is nothing we
23418 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
23419 if (!cursor_row
->enabled_p
)
23420 goto mark_cursor_off
;
23422 /* If line spacing is > 0, old cursor may only be partially visible in
23423 window after split-window. So adjust visible height. */
23424 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
23425 window_text_bottom_y (w
) - cursor_row
->y
);
23427 /* If row is completely invisible, don't attempt to delete a cursor which
23428 isn't there. This can happen if cursor is at top of a window, and
23429 we switch to a buffer with a header line in that window. */
23430 if (cursor_row
->visible_height
<= 0)
23431 goto mark_cursor_off
;
23433 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
23434 if (cursor_row
->cursor_in_fringe_p
)
23436 cursor_row
->cursor_in_fringe_p
= 0;
23437 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
23438 goto mark_cursor_off
;
23441 /* This can happen when the new row is shorter than the old one.
23442 In this case, either draw_glyphs or clear_end_of_line
23443 should have cleared the cursor. Note that we wouldn't be
23444 able to erase the cursor in this case because we don't have a
23445 cursor glyph at hand. */
23446 if ((cursor_row
->reversed_p
23447 ? (w
->phys_cursor
.hpos
< 0)
23448 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
23449 goto mark_cursor_off
;
23451 /* If the cursor is in the mouse face area, redisplay that when
23452 we clear the cursor. */
23453 if (! NILP (dpyinfo
->mouse_face_window
)
23454 && w
== XWINDOW (dpyinfo
->mouse_face_window
)
23455 && (vpos
> dpyinfo
->mouse_face_beg_row
23456 || (vpos
== dpyinfo
->mouse_face_beg_row
23457 && hpos
>= dpyinfo
->mouse_face_beg_col
))
23458 && (vpos
< dpyinfo
->mouse_face_end_row
23459 || (vpos
== dpyinfo
->mouse_face_end_row
23460 && hpos
< dpyinfo
->mouse_face_end_col
))
23461 /* Don't redraw the cursor's spot in mouse face if it is at the
23462 end of a line (on a newline). The cursor appears there, but
23463 mouse highlighting does not. */
23464 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
23465 mouse_face_here_p
= 1;
23467 /* Maybe clear the display under the cursor. */
23468 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
23471 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
23474 cursor_glyph
= get_phys_cursor_glyph (w
);
23475 if (cursor_glyph
== NULL
)
23476 goto mark_cursor_off
;
23478 width
= cursor_glyph
->pixel_width
;
23479 left_x
= window_box_left_offset (w
, TEXT_AREA
);
23480 x
= w
->phys_cursor
.x
;
23482 width
-= left_x
- x
;
23483 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
23484 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
23485 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
23488 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
23491 /* Erase the cursor by redrawing the character underneath it. */
23492 if (mouse_face_here_p
)
23493 hl
= DRAW_MOUSE_FACE
;
23495 hl
= DRAW_NORMAL_TEXT
;
23496 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
23499 w
->phys_cursor_on_p
= 0;
23500 w
->phys_cursor_type
= NO_CURSOR
;
23505 Display or clear cursor of window W. If ON is zero, clear the
23506 cursor. If it is non-zero, display the cursor. If ON is nonzero,
23507 where to put the cursor is specified by HPOS, VPOS, X and Y. */
23510 display_and_set_cursor (struct window
*w
, int on
,
23511 int hpos
, int vpos
, int x
, int y
)
23513 struct frame
*f
= XFRAME (w
->frame
);
23514 int new_cursor_type
;
23515 int new_cursor_width
;
23517 struct glyph_row
*glyph_row
;
23518 struct glyph
*glyph
;
23520 /* This is pointless on invisible frames, and dangerous on garbaged
23521 windows and frames; in the latter case, the frame or window may
23522 be in the midst of changing its size, and x and y may be off the
23524 if (! FRAME_VISIBLE_P (f
)
23525 || FRAME_GARBAGED_P (f
)
23526 || vpos
>= w
->current_matrix
->nrows
23527 || hpos
>= w
->current_matrix
->matrix_w
)
23530 /* If cursor is off and we want it off, return quickly. */
23531 if (!on
&& !w
->phys_cursor_on_p
)
23534 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
23535 /* If cursor row is not enabled, we don't really know where to
23536 display the cursor. */
23537 if (!glyph_row
->enabled_p
)
23539 w
->phys_cursor_on_p
= 0;
23544 if (!glyph_row
->exact_window_width_line_p
23545 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
23546 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
23548 xassert (interrupt_input_blocked
);
23550 /* Set new_cursor_type to the cursor we want to be displayed. */
23551 new_cursor_type
= get_window_cursor_type (w
, glyph
,
23552 &new_cursor_width
, &active_cursor
);
23554 /* If cursor is currently being shown and we don't want it to be or
23555 it is in the wrong place, or the cursor type is not what we want,
23557 if (w
->phys_cursor_on_p
23559 || w
->phys_cursor
.x
!= x
23560 || w
->phys_cursor
.y
!= y
23561 || new_cursor_type
!= w
->phys_cursor_type
23562 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
23563 && new_cursor_width
!= w
->phys_cursor_width
)))
23564 erase_phys_cursor (w
);
23566 /* Don't check phys_cursor_on_p here because that flag is only set
23567 to zero in some cases where we know that the cursor has been
23568 completely erased, to avoid the extra work of erasing the cursor
23569 twice. In other words, phys_cursor_on_p can be 1 and the cursor
23570 still not be visible, or it has only been partly erased. */
23573 w
->phys_cursor_ascent
= glyph_row
->ascent
;
23574 w
->phys_cursor_height
= glyph_row
->height
;
23576 /* Set phys_cursor_.* before x_draw_.* is called because some
23577 of them may need the information. */
23578 w
->phys_cursor
.x
= x
;
23579 w
->phys_cursor
.y
= glyph_row
->y
;
23580 w
->phys_cursor
.hpos
= hpos
;
23581 w
->phys_cursor
.vpos
= vpos
;
23584 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
23585 new_cursor_type
, new_cursor_width
,
23586 on
, active_cursor
);
23590 /* Switch the display of W's cursor on or off, according to the value
23594 update_window_cursor (struct window
*w
, int on
)
23596 /* Don't update cursor in windows whose frame is in the process
23597 of being deleted. */
23598 if (w
->current_matrix
)
23601 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
23602 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
23608 /* Call update_window_cursor with parameter ON_P on all leaf windows
23609 in the window tree rooted at W. */
23612 update_cursor_in_window_tree (struct window
*w
, int on_p
)
23616 if (!NILP (w
->hchild
))
23617 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
23618 else if (!NILP (w
->vchild
))
23619 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
23621 update_window_cursor (w
, on_p
);
23623 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
23629 Display the cursor on window W, or clear it, according to ON_P.
23630 Don't change the cursor's position. */
23633 x_update_cursor (struct frame
*f
, int on_p
)
23635 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
23640 Clear the cursor of window W to background color, and mark the
23641 cursor as not shown. This is used when the text where the cursor
23642 is about to be rewritten. */
23645 x_clear_cursor (struct window
*w
)
23647 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
23648 update_window_cursor (w
, 0);
23653 Display the active region described by mouse_face_* according to DRAW. */
23656 show_mouse_face (Display_Info
*dpyinfo
, enum draw_glyphs_face draw
)
23658 struct window
*w
= XWINDOW (dpyinfo
->mouse_face_window
);
23659 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23661 if (/* If window is in the process of being destroyed, don't bother
23663 w
->current_matrix
!= NULL
23664 /* Don't update mouse highlight if hidden */
23665 && (draw
!= DRAW_MOUSE_FACE
|| !dpyinfo
->mouse_face_hidden
)
23666 /* Recognize when we are called to operate on rows that don't exist
23667 anymore. This can happen when a window is split. */
23668 && dpyinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
23670 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
23671 struct glyph_row
*row
, *first
, *last
;
23673 first
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
23674 last
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
23676 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
23678 int start_hpos
, end_hpos
, start_x
;
23680 /* For all but the first row, the highlight starts at column 0. */
23683 start_hpos
= dpyinfo
->mouse_face_beg_col
;
23684 start_x
= dpyinfo
->mouse_face_beg_x
;
23693 end_hpos
= dpyinfo
->mouse_face_end_col
;
23696 end_hpos
= row
->used
[TEXT_AREA
];
23697 if (draw
== DRAW_NORMAL_TEXT
)
23698 row
->fill_line_p
= 1; /* Clear to end of line */
23701 if (end_hpos
> start_hpos
)
23703 draw_glyphs (w
, start_x
, row
, TEXT_AREA
,
23704 start_hpos
, end_hpos
,
23708 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
23712 /* When we've written over the cursor, arrange for it to
23713 be displayed again. */
23714 if (phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
23717 display_and_set_cursor (w
, 1,
23718 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
23719 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
23724 /* Change the mouse cursor. */
23725 if (draw
== DRAW_NORMAL_TEXT
&& !EQ (dpyinfo
->mouse_face_window
, f
->tool_bar_window
))
23726 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
23727 else if (draw
== DRAW_MOUSE_FACE
)
23728 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
23730 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
23734 Clear out the mouse-highlighted active region.
23735 Redraw it un-highlighted first. Value is non-zero if mouse
23736 face was actually drawn unhighlighted. */
23739 clear_mouse_face (Display_Info
*dpyinfo
)
23743 if (!dpyinfo
->mouse_face_hidden
&& !NILP (dpyinfo
->mouse_face_window
))
23745 show_mouse_face (dpyinfo
, DRAW_NORMAL_TEXT
);
23749 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
23750 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
23751 dpyinfo
->mouse_face_window
= Qnil
;
23752 dpyinfo
->mouse_face_overlay
= Qnil
;
23758 Non-zero if physical cursor of window W is within mouse face. */
23761 cursor_in_mouse_face_p (struct window
*w
)
23763 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
23764 int in_mouse_face
= 0;
23766 if (WINDOWP (dpyinfo
->mouse_face_window
)
23767 && XWINDOW (dpyinfo
->mouse_face_window
) == w
)
23769 int hpos
= w
->phys_cursor
.hpos
;
23770 int vpos
= w
->phys_cursor
.vpos
;
23772 if (vpos
>= dpyinfo
->mouse_face_beg_row
23773 && vpos
<= dpyinfo
->mouse_face_end_row
23774 && (vpos
> dpyinfo
->mouse_face_beg_row
23775 || hpos
>= dpyinfo
->mouse_face_beg_col
)
23776 && (vpos
< dpyinfo
->mouse_face_end_row
23777 || hpos
< dpyinfo
->mouse_face_end_col
23778 || dpyinfo
->mouse_face_past_end
))
23782 return in_mouse_face
;
23788 /* This function sets the mouse_face_* elements of DPYINFO, assuming
23789 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
23790 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
23791 for the overlay or run of text properties specifying the mouse
23792 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
23793 before-string and after-string that must also be highlighted.
23794 DISPLAY_STRING, if non-nil, is a display string that may cover some
23795 or all of the highlighted text. */
23798 mouse_face_from_buffer_pos (Lisp_Object window
,
23799 Display_Info
*dpyinfo
,
23800 EMACS_INT mouse_charpos
,
23801 EMACS_INT start_charpos
,
23802 EMACS_INT end_charpos
,
23803 Lisp_Object before_string
,
23804 Lisp_Object after_string
,
23805 Lisp_Object display_string
)
23807 struct window
*w
= XWINDOW (window
);
23808 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
23809 struct glyph_row
*row
;
23810 struct glyph
*glyph
, *end
;
23814 xassert (NILP (display_string
) || STRINGP (display_string
));
23815 xassert (NILP (before_string
) || STRINGP (before_string
));
23816 xassert (NILP (after_string
) || STRINGP (after_string
));
23818 /* Find the first highlighted glyph. */
23819 if (start_charpos
< MATRIX_ROW_START_CHARPOS (first
))
23821 dpyinfo
->mouse_face_beg_col
= 0;
23822 dpyinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (first
, w
->current_matrix
);
23823 dpyinfo
->mouse_face_beg_x
= first
->x
;
23824 dpyinfo
->mouse_face_beg_y
= first
->y
;
23828 row
= row_containing_pos (w
, start_charpos
, first
, NULL
, 0);
23830 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
23832 /* If the before-string or display-string contains newlines,
23833 row_containing_pos skips to its last row. Move back. */
23834 if (!NILP (before_string
) || !NILP (display_string
))
23836 struct glyph_row
*prev
;
23837 while ((prev
= row
- 1, prev
>= first
)
23838 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
23839 && prev
->used
[TEXT_AREA
] > 0)
23841 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
23842 glyph
= beg
+ prev
->used
[TEXT_AREA
];
23843 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
23845 || !(EQ (glyph
->object
, before_string
)
23846 || EQ (glyph
->object
, display_string
)))
23852 glyph
= row
->glyphs
[TEXT_AREA
];
23853 end
= glyph
+ row
->used
[TEXT_AREA
];
23855 dpyinfo
->mouse_face_beg_y
= row
->y
;
23856 dpyinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
23858 /* Skip truncation glyphs at the start of the glyph row. */
23859 if (row
->displays_text_p
)
23861 && INTEGERP (glyph
->object
)
23862 && glyph
->charpos
< 0;
23864 x
+= glyph
->pixel_width
;
23866 /* Scan the glyph row, stopping before BEFORE_STRING or
23867 DISPLAY_STRING or START_CHARPOS. */
23869 && !INTEGERP (glyph
->object
)
23870 && !EQ (glyph
->object
, before_string
)
23871 && !EQ (glyph
->object
, display_string
)
23872 && !(BUFFERP (glyph
->object
)
23873 && glyph
->charpos
>= start_charpos
);
23875 x
+= glyph
->pixel_width
;
23877 dpyinfo
->mouse_face_beg_x
= x
;
23878 dpyinfo
->mouse_face_beg_col
= glyph
- row
->glyphs
[TEXT_AREA
];
23881 /* Find the last highlighted glyph. */
23882 row
= row_containing_pos (w
, end_charpos
, first
, NULL
, 0);
23885 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
23886 dpyinfo
->mouse_face_past_end
= 1;
23888 else if (!NILP (after_string
))
23890 /* If the after-string has newlines, advance to its last row. */
23891 struct glyph_row
*next
;
23892 struct glyph_row
*last
23893 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
23895 for (next
= row
+ 1;
23897 && next
->used
[TEXT_AREA
] > 0
23898 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
23903 glyph
= row
->glyphs
[TEXT_AREA
];
23904 end
= glyph
+ row
->used
[TEXT_AREA
];
23906 dpyinfo
->mouse_face_end_y
= row
->y
;
23907 dpyinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
23909 /* Skip truncation glyphs at the start of the row. */
23910 if (row
->displays_text_p
)
23912 && INTEGERP (glyph
->object
)
23913 && glyph
->charpos
< 0;
23915 x
+= glyph
->pixel_width
;
23917 /* Scan the glyph row, stopping at END_CHARPOS or when we encounter
23920 && !INTEGERP (glyph
->object
)
23921 && !EQ (glyph
->object
, after_string
)
23922 && !(BUFFERP (glyph
->object
) && glyph
->charpos
>= end_charpos
);
23924 x
+= glyph
->pixel_width
;
23926 /* If we found AFTER_STRING, consume it and stop. */
23927 if (EQ (glyph
->object
, after_string
))
23929 for (; EQ (glyph
->object
, after_string
) && glyph
< end
; ++glyph
)
23930 x
+= glyph
->pixel_width
;
23934 /* If there's no after-string, we must check if we overshot,
23935 which might be the case if we stopped after a string glyph.
23936 That glyph may belong to a before-string or display-string
23937 associated with the end position, which must not be
23939 Lisp_Object prev_object
;
23942 while (glyph
> row
->glyphs
[TEXT_AREA
])
23944 prev_object
= (glyph
- 1)->object
;
23945 if (!STRINGP (prev_object
) || EQ (prev_object
, display_string
))
23948 pos
= string_buffer_position (w
, prev_object
, end_charpos
);
23949 if (pos
&& pos
< end_charpos
)
23952 for (; glyph
> row
->glyphs
[TEXT_AREA
]
23953 && EQ ((glyph
- 1)->object
, prev_object
);
23955 x
-= (glyph
- 1)->pixel_width
;
23959 dpyinfo
->mouse_face_end_x
= x
;
23960 dpyinfo
->mouse_face_end_col
= glyph
- row
->glyphs
[TEXT_AREA
];
23961 dpyinfo
->mouse_face_window
= window
;
23962 dpyinfo
->mouse_face_face_id
23963 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
23965 !dpyinfo
->mouse_face_hidden
, -1);
23966 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23970 /* Find the position of the glyph for position POS in OBJECT in
23971 window W's current matrix, and return in *X, *Y the pixel
23972 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
23974 RIGHT_P non-zero means return the position of the right edge of the
23975 glyph, RIGHT_P zero means return the left edge position.
23977 If no glyph for POS exists in the matrix, return the position of
23978 the glyph with the next smaller position that is in the matrix, if
23979 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
23980 exists in the matrix, return the position of the glyph with the
23981 next larger position in OBJECT.
23983 Value is non-zero if a glyph was found. */
23986 fast_find_string_pos (struct window
*w
, EMACS_INT pos
, Lisp_Object object
,
23987 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
23989 int yb
= window_text_bottom_y (w
);
23990 struct glyph_row
*r
;
23991 struct glyph
*best_glyph
= NULL
;
23992 struct glyph_row
*best_row
= NULL
;
23995 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
23996 r
->enabled_p
&& r
->y
< yb
;
23999 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
24000 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
24003 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
24004 if (EQ (g
->object
, object
))
24006 if (g
->charpos
== pos
)
24013 else if (best_glyph
== NULL
24014 || ((eabs (g
->charpos
- pos
)
24015 < eabs (best_glyph
->charpos
- pos
))
24018 : g
->charpos
> pos
)))
24032 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
24036 *x
+= best_glyph
->pixel_width
;
24041 *vpos
= best_row
- w
->current_matrix
->rows
;
24044 return best_glyph
!= NULL
;
24048 /* See if position X, Y is within a hot-spot of an image. */
24051 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
24053 if (!CONSP (hot_spot
))
24056 if (EQ (XCAR (hot_spot
), Qrect
))
24058 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
24059 Lisp_Object rect
= XCDR (hot_spot
);
24063 if (!CONSP (XCAR (rect
)))
24065 if (!CONSP (XCDR (rect
)))
24067 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
24069 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
24071 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
24073 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
24077 else if (EQ (XCAR (hot_spot
), Qcircle
))
24079 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
24080 Lisp_Object circ
= XCDR (hot_spot
);
24081 Lisp_Object lr
, lx0
, ly0
;
24083 && CONSP (XCAR (circ
))
24084 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
24085 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
24086 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
24088 double r
= XFLOATINT (lr
);
24089 double dx
= XINT (lx0
) - x
;
24090 double dy
= XINT (ly0
) - y
;
24091 return (dx
* dx
+ dy
* dy
<= r
* r
);
24094 else if (EQ (XCAR (hot_spot
), Qpoly
))
24096 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
24097 if (VECTORP (XCDR (hot_spot
)))
24099 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
24100 Lisp_Object
*poly
= v
->contents
;
24104 Lisp_Object lx
, ly
;
24107 /* Need an even number of coordinates, and at least 3 edges. */
24108 if (n
< 6 || n
& 1)
24111 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
24112 If count is odd, we are inside polygon. Pixels on edges
24113 may or may not be included depending on actual geometry of the
24115 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
24116 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
24118 x0
= XINT (lx
), y0
= XINT (ly
);
24119 for (i
= 0; i
< n
; i
+= 2)
24121 int x1
= x0
, y1
= y0
;
24122 if ((lx
= poly
[i
], !INTEGERP (lx
))
24123 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
24125 x0
= XINT (lx
), y0
= XINT (ly
);
24127 /* Does this segment cross the X line? */
24135 if (y
> y0
&& y
> y1
)
24137 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
24147 find_hot_spot (Lisp_Object map
, int x
, int y
)
24149 while (CONSP (map
))
24151 if (CONSP (XCAR (map
))
24152 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
24160 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
24162 doc
: /* Lookup in image map MAP coordinates X and Y.
24163 An image map is an alist where each element has the format (AREA ID PLIST).
24164 An AREA is specified as either a rectangle, a circle, or a polygon:
24165 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
24166 pixel coordinates of the upper left and bottom right corners.
24167 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
24168 and the radius of the circle; r may be a float or integer.
24169 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
24170 vector describes one corner in the polygon.
24171 Returns the alist element for the first matching AREA in MAP. */)
24172 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
24180 return find_hot_spot (map
, XINT (x
), XINT (y
));
24184 /* Display frame CURSOR, optionally using shape defined by POINTER. */
24186 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
24188 /* Do not change cursor shape while dragging mouse. */
24189 if (!NILP (do_mouse_tracking
))
24192 if (!NILP (pointer
))
24194 if (EQ (pointer
, Qarrow
))
24195 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24196 else if (EQ (pointer
, Qhand
))
24197 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
24198 else if (EQ (pointer
, Qtext
))
24199 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
24200 else if (EQ (pointer
, intern ("hdrag")))
24201 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
24202 #ifdef HAVE_X_WINDOWS
24203 else if (EQ (pointer
, intern ("vdrag")))
24204 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
24206 else if (EQ (pointer
, intern ("hourglass")))
24207 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
24208 else if (EQ (pointer
, Qmodeline
))
24209 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
24211 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24214 if (cursor
!= No_Cursor
)
24215 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
24218 /* Take proper action when mouse has moved to the mode or header line
24219 or marginal area AREA of window W, x-position X and y-position Y.
24220 X is relative to the start of the text display area of W, so the
24221 width of bitmap areas and scroll bars must be subtracted to get a
24222 position relative to the start of the mode line. */
24225 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
24226 enum window_part area
)
24228 struct window
*w
= XWINDOW (window
);
24229 struct frame
*f
= XFRAME (w
->frame
);
24230 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24231 Cursor cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24232 Lisp_Object pointer
= Qnil
;
24233 int charpos
, dx
, dy
, width
, height
;
24234 Lisp_Object string
, object
= Qnil
;
24235 Lisp_Object pos
, help
;
24237 Lisp_Object mouse_face
;
24238 int original_x_pixel
= x
;
24239 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
24240 struct glyph_row
*row
;
24242 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
24247 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
24248 &object
, &dx
, &dy
, &width
, &height
);
24250 row
= (area
== ON_MODE_LINE
24251 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
24252 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
24255 if (row
->mode_line_p
&& row
->enabled_p
)
24257 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
24258 end
= glyph
+ row
->used
[TEXT_AREA
];
24260 for (x0
= original_x_pixel
;
24261 glyph
< end
&& x0
>= glyph
->pixel_width
;
24263 x0
-= glyph
->pixel_width
;
24271 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
24272 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
24273 &object
, &dx
, &dy
, &width
, &height
);
24278 if (IMAGEP (object
))
24280 Lisp_Object image_map
, hotspot
;
24281 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
24283 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
24285 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
24287 Lisp_Object area_id
, plist
;
24289 area_id
= XCAR (hotspot
);
24290 /* Could check AREA_ID to see if we enter/leave this hot-spot.
24291 If so, we could look for mouse-enter, mouse-leave
24292 properties in PLIST (and do something...). */
24293 hotspot
= XCDR (hotspot
);
24294 if (CONSP (hotspot
)
24295 && (plist
= XCAR (hotspot
), CONSP (plist
)))
24297 pointer
= Fplist_get (plist
, Qpointer
);
24298 if (NILP (pointer
))
24300 help
= Fplist_get (plist
, Qhelp_echo
);
24303 help_echo_string
= help
;
24304 /* Is this correct? ++kfs */
24305 XSETWINDOW (help_echo_window
, w
);
24306 help_echo_object
= w
->buffer
;
24307 help_echo_pos
= charpos
;
24311 if (NILP (pointer
))
24312 pointer
= Fplist_get (XCDR (object
), QCpointer
);
24315 if (STRINGP (string
))
24317 pos
= make_number (charpos
);
24318 /* If we're on a string with `help-echo' text property, arrange
24319 for the help to be displayed. This is done by setting the
24320 global variable help_echo_string to the help string. */
24323 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
24326 help_echo_string
= help
;
24327 XSETWINDOW (help_echo_window
, w
);
24328 help_echo_object
= string
;
24329 help_echo_pos
= charpos
;
24333 if (NILP (pointer
))
24334 pointer
= Fget_text_property (pos
, Qpointer
, string
);
24336 /* Change the mouse pointer according to what is under X/Y. */
24337 if (NILP (pointer
) && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
24340 map
= Fget_text_property (pos
, Qlocal_map
, string
);
24341 if (!KEYMAPP (map
))
24342 map
= Fget_text_property (pos
, Qkeymap
, string
);
24343 if (!KEYMAPP (map
))
24344 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
24347 /* Change the mouse face according to what is under X/Y. */
24348 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
24349 if (!NILP (mouse_face
)
24350 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
24355 struct glyph
* tmp_glyph
;
24359 int total_pixel_width
;
24364 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
24365 Qmouse_face
, string
, Qnil
);
24367 b
= make_number (0);
24369 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
24371 e
= make_number (SCHARS (string
));
24373 /* Calculate the position(glyph position: GPOS) of GLYPH in
24374 displayed string. GPOS is different from CHARPOS.
24376 CHARPOS is the position of glyph in internal string
24377 object. A mode line string format has structures which
24378 is converted to a flatten by emacs lisp interpreter.
24379 The internal string is an element of the structures.
24380 The displayed string is the flatten string. */
24382 if (glyph
> row_start_glyph
)
24384 tmp_glyph
= glyph
- 1;
24385 while (tmp_glyph
>= row_start_glyph
24386 && tmp_glyph
->charpos
>= XINT (b
)
24387 && EQ (tmp_glyph
->object
, glyph
->object
))
24394 /* Calculate the lenght(glyph sequence length: GSEQ_LENGTH) of
24395 displayed string holding GLYPH.
24397 GSEQ_LENGTH is different from SCHARS (STRING).
24398 SCHARS (STRING) returns the length of the internal string. */
24399 for (tmp_glyph
= glyph
, gseq_length
= gpos
;
24400 tmp_glyph
->charpos
< XINT (e
);
24401 tmp_glyph
++, gseq_length
++)
24403 if (!EQ (tmp_glyph
->object
, glyph
->object
))
24407 total_pixel_width
= 0;
24408 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
24409 total_pixel_width
+= tmp_glyph
->pixel_width
;
24411 /* Pre calculation of re-rendering position */
24413 hpos
= (area
== ON_MODE_LINE
24414 ? (w
->current_matrix
)->nrows
- 1
24417 /* If the re-rendering position is included in the last
24418 re-rendering area, we should do nothing. */
24419 if ( EQ (window
, dpyinfo
->mouse_face_window
)
24420 && dpyinfo
->mouse_face_beg_col
<= vpos
24421 && vpos
< dpyinfo
->mouse_face_end_col
24422 && dpyinfo
->mouse_face_beg_row
== hpos
)
24425 if (clear_mouse_face (dpyinfo
))
24426 cursor
= No_Cursor
;
24428 dpyinfo
->mouse_face_beg_col
= vpos
;
24429 dpyinfo
->mouse_face_beg_row
= hpos
;
24431 dpyinfo
->mouse_face_beg_x
= original_x_pixel
- (total_pixel_width
+ dx
);
24432 dpyinfo
->mouse_face_beg_y
= 0;
24434 dpyinfo
->mouse_face_end_col
= vpos
+ gseq_length
;
24435 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_beg_row
;
24437 dpyinfo
->mouse_face_end_x
= 0;
24438 dpyinfo
->mouse_face_end_y
= 0;
24440 dpyinfo
->mouse_face_past_end
= 0;
24441 dpyinfo
->mouse_face_window
= window
;
24443 dpyinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
24446 glyph
->face_id
, 1);
24447 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
24449 if (NILP (pointer
))
24452 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
24453 clear_mouse_face (dpyinfo
);
24455 define_frame_cursor1 (f
, cursor
, pointer
);
24460 Take proper action when the mouse has moved to position X, Y on
24461 frame F as regards highlighting characters that have mouse-face
24462 properties. Also de-highlighting chars where the mouse was before.
24463 X and Y can be negative or out of range. */
24466 note_mouse_highlight (struct frame
*f
, int x
, int y
)
24468 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24469 enum window_part part
;
24470 Lisp_Object window
;
24472 Cursor cursor
= No_Cursor
;
24473 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
24476 /* When a menu is active, don't highlight because this looks odd. */
24477 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
24478 if (popup_activated ())
24482 if (NILP (Vmouse_highlight
)
24483 || !f
->glyphs_initialized_p
24484 || f
->pointer_invisible
)
24487 dpyinfo
->mouse_face_mouse_x
= x
;
24488 dpyinfo
->mouse_face_mouse_y
= y
;
24489 dpyinfo
->mouse_face_mouse_frame
= f
;
24491 if (dpyinfo
->mouse_face_defer
)
24494 if (gc_in_progress
)
24496 dpyinfo
->mouse_face_deferred_gc
= 1;
24500 /* Which window is that in? */
24501 window
= window_from_coordinates (f
, x
, y
, &part
, 0, 0, 1);
24503 /* If we were displaying active text in another window, clear that.
24504 Also clear if we move out of text area in same window. */
24505 if (! EQ (window
, dpyinfo
->mouse_face_window
)
24506 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
24507 && !NILP (dpyinfo
->mouse_face_window
)))
24508 clear_mouse_face (dpyinfo
);
24510 /* Not on a window -> return. */
24511 if (!WINDOWP (window
))
24514 /* Reset help_echo_string. It will get recomputed below. */
24515 help_echo_string
= Qnil
;
24517 /* Convert to window-relative pixel coordinates. */
24518 w
= XWINDOW (window
);
24519 frame_to_window_pixel_xy (w
, &x
, &y
);
24521 /* Handle tool-bar window differently since it doesn't display a
24523 if (EQ (window
, f
->tool_bar_window
))
24525 note_tool_bar_highlight (f
, x
, y
);
24529 /* Mouse is on the mode, header line or margin? */
24530 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
24531 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
24533 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
24537 if (part
== ON_VERTICAL_BORDER
)
24539 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
24540 help_echo_string
= build_string ("drag-mouse-1: resize");
24542 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
24543 || part
== ON_SCROLL_BAR
)
24544 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24546 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
24548 /* Are we in a window whose display is up to date?
24549 And verify the buffer's text has not changed. */
24550 b
= XBUFFER (w
->buffer
);
24551 if (part
== ON_TEXT
24552 && EQ (w
->window_end_valid
, w
->buffer
)
24553 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
24554 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
24556 int hpos
, vpos
, i
, dx
, dy
, area
;
24558 struct glyph
*glyph
;
24559 Lisp_Object object
;
24560 Lisp_Object mouse_face
= Qnil
, overlay
= Qnil
, position
;
24561 Lisp_Object
*overlay_vec
= NULL
;
24563 struct buffer
*obuf
;
24564 int obegv
, ozv
, same_region
;
24566 /* Find the glyph under X/Y. */
24567 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
24569 /* Look for :pointer property on image. */
24570 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
24572 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
24573 if (img
!= NULL
&& IMAGEP (img
->spec
))
24575 Lisp_Object image_map
, hotspot
;
24576 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
24578 && (hotspot
= find_hot_spot (image_map
,
24579 glyph
->slice
.x
+ dx
,
24580 glyph
->slice
.y
+ dy
),
24582 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
24584 Lisp_Object area_id
, plist
;
24586 area_id
= XCAR (hotspot
);
24587 /* Could check AREA_ID to see if we enter/leave this hot-spot.
24588 If so, we could look for mouse-enter, mouse-leave
24589 properties in PLIST (and do something...). */
24590 hotspot
= XCDR (hotspot
);
24591 if (CONSP (hotspot
)
24592 && (plist
= XCAR (hotspot
), CONSP (plist
)))
24594 pointer
= Fplist_get (plist
, Qpointer
);
24595 if (NILP (pointer
))
24597 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
24598 if (!NILP (help_echo_string
))
24600 help_echo_window
= window
;
24601 help_echo_object
= glyph
->object
;
24602 help_echo_pos
= glyph
->charpos
;
24606 if (NILP (pointer
))
24607 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
24611 /* Clear mouse face if X/Y not over text. */
24613 || area
!= TEXT_AREA
24614 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
)
24616 if (clear_mouse_face (dpyinfo
))
24617 cursor
= No_Cursor
;
24618 if (NILP (pointer
))
24620 if (area
!= TEXT_AREA
)
24621 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24623 pointer
= Vvoid_text_area_pointer
;
24628 pos
= glyph
->charpos
;
24629 object
= glyph
->object
;
24630 if (!STRINGP (object
) && !BUFFERP (object
))
24633 /* If we get an out-of-range value, return now; avoid an error. */
24634 if (BUFFERP (object
) && pos
> BUF_Z (b
))
24637 /* Make the window's buffer temporarily current for
24638 overlays_at and compute_char_face. */
24639 obuf
= current_buffer
;
24640 current_buffer
= b
;
24646 /* Is this char mouse-active or does it have help-echo? */
24647 position
= make_number (pos
);
24649 if (BUFFERP (object
))
24651 /* Put all the overlays we want in a vector in overlay_vec. */
24652 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
24653 /* Sort overlays into increasing priority order. */
24654 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
24659 same_region
= (EQ (window
, dpyinfo
->mouse_face_window
)
24660 && vpos
>= dpyinfo
->mouse_face_beg_row
24661 && vpos
<= dpyinfo
->mouse_face_end_row
24662 && (vpos
> dpyinfo
->mouse_face_beg_row
24663 || hpos
>= dpyinfo
->mouse_face_beg_col
)
24664 && (vpos
< dpyinfo
->mouse_face_end_row
24665 || hpos
< dpyinfo
->mouse_face_end_col
24666 || dpyinfo
->mouse_face_past_end
));
24669 cursor
= No_Cursor
;
24671 /* Check mouse-face highlighting. */
24673 /* If there exists an overlay with mouse-face overlapping
24674 the one we are currently highlighting, we have to
24675 check if we enter the overlapping overlay, and then
24676 highlight only that. */
24677 || (OVERLAYP (dpyinfo
->mouse_face_overlay
)
24678 && mouse_face_overlay_overlaps (dpyinfo
->mouse_face_overlay
)))
24680 /* Find the highest priority overlay with a mouse-face. */
24682 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
24684 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
24685 if (!NILP (mouse_face
))
24686 overlay
= overlay_vec
[i
];
24689 /* If we're highlighting the same overlay as before, there's
24690 no need to do that again. */
24691 if (!NILP (overlay
) && EQ (overlay
, dpyinfo
->mouse_face_overlay
))
24692 goto check_help_echo
;
24693 dpyinfo
->mouse_face_overlay
= overlay
;
24695 /* Clear the display of the old active region, if any. */
24696 if (clear_mouse_face (dpyinfo
))
24697 cursor
= No_Cursor
;
24699 /* If no overlay applies, get a text property. */
24700 if (NILP (overlay
))
24701 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
24703 /* Next, compute the bounds of the mouse highlighting and
24705 if (!NILP (mouse_face
) && STRINGP (object
))
24707 /* The mouse-highlighting comes from a display string
24708 with a mouse-face. */
24712 b
= Fprevious_single_property_change
24713 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
24714 e
= Fnext_single_property_change
24715 (position
, Qmouse_face
, object
, Qnil
);
24717 b
= make_number (0);
24719 e
= make_number (SCHARS (object
) - 1);
24721 fast_find_string_pos (w
, XINT (b
), object
,
24722 &dpyinfo
->mouse_face_beg_col
,
24723 &dpyinfo
->mouse_face_beg_row
,
24724 &dpyinfo
->mouse_face_beg_x
,
24725 &dpyinfo
->mouse_face_beg_y
, 0);
24726 fast_find_string_pos (w
, XINT (e
), object
,
24727 &dpyinfo
->mouse_face_end_col
,
24728 &dpyinfo
->mouse_face_end_row
,
24729 &dpyinfo
->mouse_face_end_x
,
24730 &dpyinfo
->mouse_face_end_y
, 1);
24731 dpyinfo
->mouse_face_past_end
= 0;
24732 dpyinfo
->mouse_face_window
= window
;
24733 dpyinfo
->mouse_face_face_id
24734 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
24735 glyph
->face_id
, 1);
24736 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
24737 cursor
= No_Cursor
;
24741 /* The mouse-highlighting, if any, comes from an overlay
24742 or text property in the buffer. */
24743 Lisp_Object buffer
, display_string
;
24745 if (STRINGP (object
))
24747 /* If we are on a display string with no mouse-face,
24748 check if the text under it has one. */
24749 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
24750 int start
= MATRIX_ROW_START_CHARPOS (r
);
24751 pos
= string_buffer_position (w
, object
, start
);
24754 mouse_face
= get_char_property_and_overlay
24755 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
24756 buffer
= w
->buffer
;
24757 display_string
= object
;
24763 display_string
= Qnil
;
24766 if (!NILP (mouse_face
))
24768 Lisp_Object before
, after
;
24769 Lisp_Object before_string
, after_string
;
24771 if (NILP (overlay
))
24773 /* Handle the text property case. */
24774 before
= Fprevious_single_property_change
24775 (make_number (pos
+ 1), Qmouse_face
, buffer
,
24776 Fmarker_position (w
->start
));
24777 after
= Fnext_single_property_change
24778 (make_number (pos
), Qmouse_face
, buffer
,
24779 make_number (BUF_Z (XBUFFER (buffer
))
24780 - XFASTINT (w
->window_end_pos
)));
24781 before_string
= after_string
= Qnil
;
24785 /* Handle the overlay case. */
24786 before
= Foverlay_start (overlay
);
24787 after
= Foverlay_end (overlay
);
24788 before_string
= Foverlay_get (overlay
, Qbefore_string
);
24789 after_string
= Foverlay_get (overlay
, Qafter_string
);
24791 if (!STRINGP (before_string
)) before_string
= Qnil
;
24792 if (!STRINGP (after_string
)) after_string
= Qnil
;
24795 mouse_face_from_buffer_pos (window
, dpyinfo
, pos
,
24798 before_string
, after_string
,
24800 cursor
= No_Cursor
;
24807 /* Look for a `help-echo' property. */
24808 if (NILP (help_echo_string
)) {
24809 Lisp_Object help
, overlay
;
24811 /* Check overlays first. */
24812 help
= overlay
= Qnil
;
24813 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
24815 overlay
= overlay_vec
[i
];
24816 help
= Foverlay_get (overlay
, Qhelp_echo
);
24821 help_echo_string
= help
;
24822 help_echo_window
= window
;
24823 help_echo_object
= overlay
;
24824 help_echo_pos
= pos
;
24828 Lisp_Object object
= glyph
->object
;
24829 int charpos
= glyph
->charpos
;
24831 /* Try text properties. */
24832 if (STRINGP (object
)
24834 && charpos
< SCHARS (object
))
24836 help
= Fget_text_property (make_number (charpos
),
24837 Qhelp_echo
, object
);
24840 /* If the string itself doesn't specify a help-echo,
24841 see if the buffer text ``under'' it does. */
24842 struct glyph_row
*r
24843 = MATRIX_ROW (w
->current_matrix
, vpos
);
24844 int start
= MATRIX_ROW_START_CHARPOS (r
);
24845 EMACS_INT pos
= string_buffer_position (w
, object
, start
);
24848 help
= Fget_char_property (make_number (pos
),
24849 Qhelp_echo
, w
->buffer
);
24853 object
= w
->buffer
;
24858 else if (BUFFERP (object
)
24861 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
24866 help_echo_string
= help
;
24867 help_echo_window
= window
;
24868 help_echo_object
= object
;
24869 help_echo_pos
= charpos
;
24874 /* Look for a `pointer' property. */
24875 if (NILP (pointer
))
24877 /* Check overlays first. */
24878 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
24879 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
24881 if (NILP (pointer
))
24883 Lisp_Object object
= glyph
->object
;
24884 int charpos
= glyph
->charpos
;
24886 /* Try text properties. */
24887 if (STRINGP (object
)
24889 && charpos
< SCHARS (object
))
24891 pointer
= Fget_text_property (make_number (charpos
),
24893 if (NILP (pointer
))
24895 /* If the string itself doesn't specify a pointer,
24896 see if the buffer text ``under'' it does. */
24897 struct glyph_row
*r
24898 = MATRIX_ROW (w
->current_matrix
, vpos
);
24899 int start
= MATRIX_ROW_START_CHARPOS (r
);
24900 EMACS_INT pos
= string_buffer_position (w
, object
,
24903 pointer
= Fget_char_property (make_number (pos
),
24904 Qpointer
, w
->buffer
);
24907 else if (BUFFERP (object
)
24910 pointer
= Fget_text_property (make_number (charpos
),
24917 current_buffer
= obuf
;
24922 define_frame_cursor1 (f
, cursor
, pointer
);
24927 Clear any mouse-face on window W. This function is part of the
24928 redisplay interface, and is called from try_window_id and similar
24929 functions to ensure the mouse-highlight is off. */
24932 x_clear_window_mouse_face (struct window
*w
)
24934 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
24935 Lisp_Object window
;
24938 XSETWINDOW (window
, w
);
24939 if (EQ (window
, dpyinfo
->mouse_face_window
))
24940 clear_mouse_face (dpyinfo
);
24946 Just discard the mouse face information for frame F, if any.
24947 This is used when the size of F is changed. */
24950 cancel_mouse_face (struct frame
*f
)
24952 Lisp_Object window
;
24953 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24955 window
= dpyinfo
->mouse_face_window
;
24956 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
24958 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
24959 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
24960 dpyinfo
->mouse_face_window
= Qnil
;
24965 #endif /* HAVE_WINDOW_SYSTEM */
24968 /***********************************************************************
24970 ***********************************************************************/
24972 #ifdef HAVE_WINDOW_SYSTEM
24974 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
24975 which intersects rectangle R. R is in window-relative coordinates. */
24978 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
24979 enum glyph_row_area area
)
24981 struct glyph
*first
= row
->glyphs
[area
];
24982 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
24983 struct glyph
*last
;
24984 int first_x
, start_x
, x
;
24986 if (area
== TEXT_AREA
&& row
->fill_line_p
)
24987 /* If row extends face to end of line write the whole line. */
24988 draw_glyphs (w
, 0, row
, area
,
24989 0, row
->used
[area
],
24990 DRAW_NORMAL_TEXT
, 0);
24993 /* Set START_X to the window-relative start position for drawing glyphs of
24994 AREA. The first glyph of the text area can be partially visible.
24995 The first glyphs of other areas cannot. */
24996 start_x
= window_box_left_offset (w
, area
);
24998 if (area
== TEXT_AREA
)
25001 /* Find the first glyph that must be redrawn. */
25003 && x
+ first
->pixel_width
< r
->x
)
25005 x
+= first
->pixel_width
;
25009 /* Find the last one. */
25013 && x
< r
->x
+ r
->width
)
25015 x
+= last
->pixel_width
;
25021 draw_glyphs (w
, first_x
- start_x
, row
, area
,
25022 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
25023 DRAW_NORMAL_TEXT
, 0);
25028 /* Redraw the parts of the glyph row ROW on window W intersecting
25029 rectangle R. R is in window-relative coordinates. Value is
25030 non-zero if mouse-face was overwritten. */
25033 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
25035 xassert (row
->enabled_p
);
25037 if (row
->mode_line_p
|| w
->pseudo_window_p
)
25038 draw_glyphs (w
, 0, row
, TEXT_AREA
,
25039 0, row
->used
[TEXT_AREA
],
25040 DRAW_NORMAL_TEXT
, 0);
25043 if (row
->used
[LEFT_MARGIN_AREA
])
25044 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
25045 if (row
->used
[TEXT_AREA
])
25046 expose_area (w
, row
, r
, TEXT_AREA
);
25047 if (row
->used
[RIGHT_MARGIN_AREA
])
25048 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
25049 draw_row_fringe_bitmaps (w
, row
);
25052 return row
->mouse_face_p
;
25056 /* Redraw those parts of glyphs rows during expose event handling that
25057 overlap other rows. Redrawing of an exposed line writes over parts
25058 of lines overlapping that exposed line; this function fixes that.
25060 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
25061 row in W's current matrix that is exposed and overlaps other rows.
25062 LAST_OVERLAPPING_ROW is the last such row. */
25065 expose_overlaps (struct window
*w
,
25066 struct glyph_row
*first_overlapping_row
,
25067 struct glyph_row
*last_overlapping_row
,
25070 struct glyph_row
*row
;
25072 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
25073 if (row
->overlapping_p
)
25075 xassert (row
->enabled_p
&& !row
->mode_line_p
);
25078 if (row
->used
[LEFT_MARGIN_AREA
])
25079 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
25081 if (row
->used
[TEXT_AREA
])
25082 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
25084 if (row
->used
[RIGHT_MARGIN_AREA
])
25085 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
25091 /* Return non-zero if W's cursor intersects rectangle R. */
25094 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
25096 XRectangle cr
, result
;
25097 struct glyph
*cursor_glyph
;
25098 struct glyph_row
*row
;
25100 if (w
->phys_cursor
.vpos
>= 0
25101 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
25102 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
25104 && row
->cursor_in_fringe_p
)
25106 /* Cursor is in the fringe. */
25107 cr
.x
= window_box_right_offset (w
,
25108 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
25109 ? RIGHT_MARGIN_AREA
25112 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
25113 cr
.height
= row
->height
;
25114 return x_intersect_rectangles (&cr
, r
, &result
);
25117 cursor_glyph
= get_phys_cursor_glyph (w
);
25120 /* r is relative to W's box, but w->phys_cursor.x is relative
25121 to left edge of W's TEXT area. Adjust it. */
25122 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
25123 cr
.y
= w
->phys_cursor
.y
;
25124 cr
.width
= cursor_glyph
->pixel_width
;
25125 cr
.height
= w
->phys_cursor_height
;
25126 /* ++KFS: W32 version used W32-specific IntersectRect here, but
25127 I assume the effect is the same -- and this is portable. */
25128 return x_intersect_rectangles (&cr
, r
, &result
);
25130 /* If we don't understand the format, pretend we're not in the hot-spot. */
25136 Draw a vertical window border to the right of window W if W doesn't
25137 have vertical scroll bars. */
25140 x_draw_vertical_border (struct window
*w
)
25142 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25144 /* We could do better, if we knew what type of scroll-bar the adjacent
25145 windows (on either side) have... But we don't :-(
25146 However, I think this works ok. ++KFS 2003-04-25 */
25148 /* Redraw borders between horizontally adjacent windows. Don't
25149 do it for frames with vertical scroll bars because either the
25150 right scroll bar of a window, or the left scroll bar of its
25151 neighbor will suffice as a border. */
25152 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
25155 if (!WINDOW_RIGHTMOST_P (w
)
25156 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
25158 int x0
, x1
, y0
, y1
;
25160 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
25163 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
25166 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
25168 else if (!WINDOW_LEFTMOST_P (w
)
25169 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
25171 int x0
, x1
, y0
, y1
;
25173 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
25176 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
25179 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
25184 /* Redraw the part of window W intersection rectangle FR. Pixel
25185 coordinates in FR are frame-relative. Call this function with
25186 input blocked. Value is non-zero if the exposure overwrites
25190 expose_window (struct window
*w
, XRectangle
*fr
)
25192 struct frame
*f
= XFRAME (w
->frame
);
25194 int mouse_face_overwritten_p
= 0;
25196 /* If window is not yet fully initialized, do nothing. This can
25197 happen when toolkit scroll bars are used and a window is split.
25198 Reconfiguring the scroll bar will generate an expose for a newly
25200 if (w
->current_matrix
== NULL
)
25203 /* When we're currently updating the window, display and current
25204 matrix usually don't agree. Arrange for a thorough display
25206 if (w
== updated_window
)
25208 SET_FRAME_GARBAGED (f
);
25212 /* Frame-relative pixel rectangle of W. */
25213 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
25214 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
25215 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
25216 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
25218 if (x_intersect_rectangles (fr
, &wr
, &r
))
25220 int yb
= window_text_bottom_y (w
);
25221 struct glyph_row
*row
;
25222 int cursor_cleared_p
;
25223 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
25225 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
25226 r
.x
, r
.y
, r
.width
, r
.height
));
25228 /* Convert to window coordinates. */
25229 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
25230 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
25232 /* Turn off the cursor. */
25233 if (!w
->pseudo_window_p
25234 && phys_cursor_in_rect_p (w
, &r
))
25236 x_clear_cursor (w
);
25237 cursor_cleared_p
= 1;
25240 cursor_cleared_p
= 0;
25242 /* Update lines intersecting rectangle R. */
25243 first_overlapping_row
= last_overlapping_row
= NULL
;
25244 for (row
= w
->current_matrix
->rows
;
25249 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
25251 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
25252 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
25253 || (r
.y
>= y0
&& r
.y
< y1
)
25254 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
25256 /* A header line may be overlapping, but there is no need
25257 to fix overlapping areas for them. KFS 2005-02-12 */
25258 if (row
->overlapping_p
&& !row
->mode_line_p
)
25260 if (first_overlapping_row
== NULL
)
25261 first_overlapping_row
= row
;
25262 last_overlapping_row
= row
;
25266 if (expose_line (w
, row
, &r
))
25267 mouse_face_overwritten_p
= 1;
25270 else if (row
->overlapping_p
)
25272 /* We must redraw a row overlapping the exposed area. */
25274 ? y0
+ row
->phys_height
> r
.y
25275 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
25277 if (first_overlapping_row
== NULL
)
25278 first_overlapping_row
= row
;
25279 last_overlapping_row
= row
;
25287 /* Display the mode line if there is one. */
25288 if (WINDOW_WANTS_MODELINE_P (w
)
25289 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
25291 && row
->y
< r
.y
+ r
.height
)
25293 if (expose_line (w
, row
, &r
))
25294 mouse_face_overwritten_p
= 1;
25297 if (!w
->pseudo_window_p
)
25299 /* Fix the display of overlapping rows. */
25300 if (first_overlapping_row
)
25301 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
25304 /* Draw border between windows. */
25305 x_draw_vertical_border (w
);
25307 /* Turn the cursor on again. */
25308 if (cursor_cleared_p
)
25309 update_window_cursor (w
, 1);
25313 return mouse_face_overwritten_p
;
25318 /* Redraw (parts) of all windows in the window tree rooted at W that
25319 intersect R. R contains frame pixel coordinates. Value is
25320 non-zero if the exposure overwrites mouse-face. */
25323 expose_window_tree (struct window
*w
, XRectangle
*r
)
25325 struct frame
*f
= XFRAME (w
->frame
);
25326 int mouse_face_overwritten_p
= 0;
25328 while (w
&& !FRAME_GARBAGED_P (f
))
25330 if (!NILP (w
->hchild
))
25331 mouse_face_overwritten_p
25332 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
25333 else if (!NILP (w
->vchild
))
25334 mouse_face_overwritten_p
25335 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
25337 mouse_face_overwritten_p
|= expose_window (w
, r
);
25339 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
25342 return mouse_face_overwritten_p
;
25347 Redisplay an exposed area of frame F. X and Y are the upper-left
25348 corner of the exposed rectangle. W and H are width and height of
25349 the exposed area. All are pixel values. W or H zero means redraw
25350 the entire frame. */
25353 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
25356 int mouse_face_overwritten_p
= 0;
25358 TRACE ((stderr
, "expose_frame "));
25360 /* No need to redraw if frame will be redrawn soon. */
25361 if (FRAME_GARBAGED_P (f
))
25363 TRACE ((stderr
, " garbaged\n"));
25367 /* If basic faces haven't been realized yet, there is no point in
25368 trying to redraw anything. This can happen when we get an expose
25369 event while Emacs is starting, e.g. by moving another window. */
25370 if (FRAME_FACE_CACHE (f
) == NULL
25371 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
25373 TRACE ((stderr
, " no faces\n"));
25377 if (w
== 0 || h
== 0)
25380 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
25381 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
25391 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
25392 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
25394 if (WINDOWP (f
->tool_bar_window
))
25395 mouse_face_overwritten_p
25396 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
25398 #ifdef HAVE_X_WINDOWS
25400 #ifndef USE_X_TOOLKIT
25401 if (WINDOWP (f
->menu_bar_window
))
25402 mouse_face_overwritten_p
25403 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
25404 #endif /* not USE_X_TOOLKIT */
25408 /* Some window managers support a focus-follows-mouse style with
25409 delayed raising of frames. Imagine a partially obscured frame,
25410 and moving the mouse into partially obscured mouse-face on that
25411 frame. The visible part of the mouse-face will be highlighted,
25412 then the WM raises the obscured frame. With at least one WM, KDE
25413 2.1, Emacs is not getting any event for the raising of the frame
25414 (even tried with SubstructureRedirectMask), only Expose events.
25415 These expose events will draw text normally, i.e. not
25416 highlighted. Which means we must redo the highlight here.
25417 Subsume it under ``we love X''. --gerd 2001-08-15 */
25418 /* Included in Windows version because Windows most likely does not
25419 do the right thing if any third party tool offers
25420 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
25421 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
25423 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
25424 if (f
== dpyinfo
->mouse_face_mouse_frame
)
25426 int x
= dpyinfo
->mouse_face_mouse_x
;
25427 int y
= dpyinfo
->mouse_face_mouse_y
;
25428 clear_mouse_face (dpyinfo
);
25429 note_mouse_highlight (f
, x
, y
);
25436 Determine the intersection of two rectangles R1 and R2. Return
25437 the intersection in *RESULT. Value is non-zero if RESULT is not
25441 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
25443 XRectangle
*left
, *right
;
25444 XRectangle
*upper
, *lower
;
25445 int intersection_p
= 0;
25447 /* Rearrange so that R1 is the left-most rectangle. */
25449 left
= r1
, right
= r2
;
25451 left
= r2
, right
= r1
;
25453 /* X0 of the intersection is right.x0, if this is inside R1,
25454 otherwise there is no intersection. */
25455 if (right
->x
<= left
->x
+ left
->width
)
25457 result
->x
= right
->x
;
25459 /* The right end of the intersection is the minimum of the
25460 the right ends of left and right. */
25461 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
25464 /* Same game for Y. */
25466 upper
= r1
, lower
= r2
;
25468 upper
= r2
, lower
= r1
;
25470 /* The upper end of the intersection is lower.y0, if this is inside
25471 of upper. Otherwise, there is no intersection. */
25472 if (lower
->y
<= upper
->y
+ upper
->height
)
25474 result
->y
= lower
->y
;
25476 /* The lower end of the intersection is the minimum of the lower
25477 ends of upper and lower. */
25478 result
->height
= (min (lower
->y
+ lower
->height
,
25479 upper
->y
+ upper
->height
)
25481 intersection_p
= 1;
25485 return intersection_p
;
25488 #endif /* HAVE_WINDOW_SYSTEM */
25491 /***********************************************************************
25493 ***********************************************************************/
25496 syms_of_xdisp (void)
25498 Vwith_echo_area_save_vector
= Qnil
;
25499 staticpro (&Vwith_echo_area_save_vector
);
25501 Vmessage_stack
= Qnil
;
25502 staticpro (&Vmessage_stack
);
25504 Qinhibit_redisplay
= intern_c_string ("inhibit-redisplay");
25505 staticpro (&Qinhibit_redisplay
);
25507 message_dolog_marker1
= Fmake_marker ();
25508 staticpro (&message_dolog_marker1
);
25509 message_dolog_marker2
= Fmake_marker ();
25510 staticpro (&message_dolog_marker2
);
25511 message_dolog_marker3
= Fmake_marker ();
25512 staticpro (&message_dolog_marker3
);
25515 defsubr (&Sdump_frame_glyph_matrix
);
25516 defsubr (&Sdump_glyph_matrix
);
25517 defsubr (&Sdump_glyph_row
);
25518 defsubr (&Sdump_tool_bar_row
);
25519 defsubr (&Strace_redisplay
);
25520 defsubr (&Strace_to_stderr
);
25522 #ifdef HAVE_WINDOW_SYSTEM
25523 defsubr (&Stool_bar_lines_needed
);
25524 defsubr (&Slookup_image_map
);
25526 defsubr (&Sformat_mode_line
);
25527 defsubr (&Sinvisible_p
);
25528 defsubr (&Scurrent_bidi_paragraph_direction
);
25530 staticpro (&Qmenu_bar_update_hook
);
25531 Qmenu_bar_update_hook
= intern_c_string ("menu-bar-update-hook");
25533 staticpro (&Qoverriding_terminal_local_map
);
25534 Qoverriding_terminal_local_map
= intern_c_string ("overriding-terminal-local-map");
25536 staticpro (&Qoverriding_local_map
);
25537 Qoverriding_local_map
= intern_c_string ("overriding-local-map");
25539 staticpro (&Qwindow_scroll_functions
);
25540 Qwindow_scroll_functions
= intern_c_string ("window-scroll-functions");
25542 staticpro (&Qwindow_text_change_functions
);
25543 Qwindow_text_change_functions
= intern_c_string ("window-text-change-functions");
25545 staticpro (&Qredisplay_end_trigger_functions
);
25546 Qredisplay_end_trigger_functions
= intern_c_string ("redisplay-end-trigger-functions");
25548 staticpro (&Qinhibit_point_motion_hooks
);
25549 Qinhibit_point_motion_hooks
= intern_c_string ("inhibit-point-motion-hooks");
25551 Qeval
= intern_c_string ("eval");
25552 staticpro (&Qeval
);
25554 QCdata
= intern_c_string (":data");
25555 staticpro (&QCdata
);
25556 Qdisplay
= intern_c_string ("display");
25557 staticpro (&Qdisplay
);
25558 Qspace_width
= intern_c_string ("space-width");
25559 staticpro (&Qspace_width
);
25560 Qraise
= intern_c_string ("raise");
25561 staticpro (&Qraise
);
25562 Qslice
= intern_c_string ("slice");
25563 staticpro (&Qslice
);
25564 Qspace
= intern_c_string ("space");
25565 staticpro (&Qspace
);
25566 Qmargin
= intern_c_string ("margin");
25567 staticpro (&Qmargin
);
25568 Qpointer
= intern_c_string ("pointer");
25569 staticpro (&Qpointer
);
25570 Qleft_margin
= intern_c_string ("left-margin");
25571 staticpro (&Qleft_margin
);
25572 Qright_margin
= intern_c_string ("right-margin");
25573 staticpro (&Qright_margin
);
25574 Qcenter
= intern_c_string ("center");
25575 staticpro (&Qcenter
);
25576 Qline_height
= intern_c_string ("line-height");
25577 staticpro (&Qline_height
);
25578 QCalign_to
= intern_c_string (":align-to");
25579 staticpro (&QCalign_to
);
25580 QCrelative_width
= intern_c_string (":relative-width");
25581 staticpro (&QCrelative_width
);
25582 QCrelative_height
= intern_c_string (":relative-height");
25583 staticpro (&QCrelative_height
);
25584 QCeval
= intern_c_string (":eval");
25585 staticpro (&QCeval
);
25586 QCpropertize
= intern_c_string (":propertize");
25587 staticpro (&QCpropertize
);
25588 QCfile
= intern_c_string (":file");
25589 staticpro (&QCfile
);
25590 Qfontified
= intern_c_string ("fontified");
25591 staticpro (&Qfontified
);
25592 Qfontification_functions
= intern_c_string ("fontification-functions");
25593 staticpro (&Qfontification_functions
);
25594 Qtrailing_whitespace
= intern_c_string ("trailing-whitespace");
25595 staticpro (&Qtrailing_whitespace
);
25596 Qescape_glyph
= intern_c_string ("escape-glyph");
25597 staticpro (&Qescape_glyph
);
25598 Qnobreak_space
= intern_c_string ("nobreak-space");
25599 staticpro (&Qnobreak_space
);
25600 Qimage
= intern_c_string ("image");
25601 staticpro (&Qimage
);
25602 Qtext
= intern_c_string ("text");
25603 staticpro (&Qtext
);
25604 Qboth
= intern_c_string ("both");
25605 staticpro (&Qboth
);
25606 Qboth_horiz
= intern_c_string ("both-horiz");
25607 staticpro (&Qboth_horiz
);
25608 Qtext_image_horiz
= intern_c_string ("text-image-horiz");
25609 staticpro (&Qtext_image_horiz
);
25610 QCmap
= intern_c_string (":map");
25611 staticpro (&QCmap
);
25612 QCpointer
= intern_c_string (":pointer");
25613 staticpro (&QCpointer
);
25614 Qrect
= intern_c_string ("rect");
25615 staticpro (&Qrect
);
25616 Qcircle
= intern_c_string ("circle");
25617 staticpro (&Qcircle
);
25618 Qpoly
= intern_c_string ("poly");
25619 staticpro (&Qpoly
);
25620 Qmessage_truncate_lines
= intern_c_string ("message-truncate-lines");
25621 staticpro (&Qmessage_truncate_lines
);
25622 Qgrow_only
= intern_c_string ("grow-only");
25623 staticpro (&Qgrow_only
);
25624 Qinhibit_menubar_update
= intern_c_string ("inhibit-menubar-update");
25625 staticpro (&Qinhibit_menubar_update
);
25626 Qinhibit_eval_during_redisplay
= intern_c_string ("inhibit-eval-during-redisplay");
25627 staticpro (&Qinhibit_eval_during_redisplay
);
25628 Qposition
= intern_c_string ("position");
25629 staticpro (&Qposition
);
25630 Qbuffer_position
= intern_c_string ("buffer-position");
25631 staticpro (&Qbuffer_position
);
25632 Qobject
= intern_c_string ("object");
25633 staticpro (&Qobject
);
25634 Qbar
= intern_c_string ("bar");
25636 Qhbar
= intern_c_string ("hbar");
25637 staticpro (&Qhbar
);
25638 Qbox
= intern_c_string ("box");
25640 Qhollow
= intern_c_string ("hollow");
25641 staticpro (&Qhollow
);
25642 Qhand
= intern_c_string ("hand");
25643 staticpro (&Qhand
);
25644 Qarrow
= intern_c_string ("arrow");
25645 staticpro (&Qarrow
);
25646 Qtext
= intern_c_string ("text");
25647 staticpro (&Qtext
);
25648 Qrisky_local_variable
= intern_c_string ("risky-local-variable");
25649 staticpro (&Qrisky_local_variable
);
25650 Qinhibit_free_realized_faces
= intern_c_string ("inhibit-free-realized-faces");
25651 staticpro (&Qinhibit_free_realized_faces
);
25653 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
25654 Fcons (intern_c_string ("void-variable"), Qnil
)),
25656 staticpro (&list_of_error
);
25658 Qlast_arrow_position
= intern_c_string ("last-arrow-position");
25659 staticpro (&Qlast_arrow_position
);
25660 Qlast_arrow_string
= intern_c_string ("last-arrow-string");
25661 staticpro (&Qlast_arrow_string
);
25663 Qoverlay_arrow_string
= intern_c_string ("overlay-arrow-string");
25664 staticpro (&Qoverlay_arrow_string
);
25665 Qoverlay_arrow_bitmap
= intern_c_string ("overlay-arrow-bitmap");
25666 staticpro (&Qoverlay_arrow_bitmap
);
25668 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
25669 staticpro (&echo_buffer
[0]);
25670 staticpro (&echo_buffer
[1]);
25672 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
25673 staticpro (&echo_area_buffer
[0]);
25674 staticpro (&echo_area_buffer
[1]);
25676 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
25677 staticpro (&Vmessages_buffer_name
);
25679 mode_line_proptrans_alist
= Qnil
;
25680 staticpro (&mode_line_proptrans_alist
);
25681 mode_line_string_list
= Qnil
;
25682 staticpro (&mode_line_string_list
);
25683 mode_line_string_face
= Qnil
;
25684 staticpro (&mode_line_string_face
);
25685 mode_line_string_face_prop
= Qnil
;
25686 staticpro (&mode_line_string_face_prop
);
25687 Vmode_line_unwind_vector
= Qnil
;
25688 staticpro (&Vmode_line_unwind_vector
);
25690 help_echo_string
= Qnil
;
25691 staticpro (&help_echo_string
);
25692 help_echo_object
= Qnil
;
25693 staticpro (&help_echo_object
);
25694 help_echo_window
= Qnil
;
25695 staticpro (&help_echo_window
);
25696 previous_help_echo_string
= Qnil
;
25697 staticpro (&previous_help_echo_string
);
25698 help_echo_pos
= -1;
25700 Qright_to_left
= intern_c_string ("right-to-left");
25701 staticpro (&Qright_to_left
);
25702 Qleft_to_right
= intern_c_string ("left-to-right");
25703 staticpro (&Qleft_to_right
);
25705 #ifdef HAVE_WINDOW_SYSTEM
25706 DEFVAR_BOOL ("x-stretch-cursor", &x_stretch_cursor_p
,
25707 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
25708 For example, if a block cursor is over a tab, it will be drawn as
25709 wide as that tab on the display. */);
25710 x_stretch_cursor_p
= 0;
25713 DEFVAR_LISP ("show-trailing-whitespace", &Vshow_trailing_whitespace
,
25714 doc
: /* *Non-nil means highlight trailing whitespace.
25715 The face used for trailing whitespace is `trailing-whitespace'. */);
25716 Vshow_trailing_whitespace
= Qnil
;
25718 DEFVAR_LISP ("nobreak-char-display", &Vnobreak_char_display
,
25719 doc
: /* *Control highlighting of nobreak space and soft hyphen.
25720 A value of t means highlight the character itself (for nobreak space,
25721 use face `nobreak-space').
25722 A value of nil means no highlighting.
25723 Other values mean display the escape glyph followed by an ordinary
25724 space or ordinary hyphen. */);
25725 Vnobreak_char_display
= Qt
;
25727 DEFVAR_LISP ("void-text-area-pointer", &Vvoid_text_area_pointer
,
25728 doc
: /* *The pointer shape to show in void text areas.
25729 A value of nil means to show the text pointer. Other options are `arrow',
25730 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
25731 Vvoid_text_area_pointer
= Qarrow
;
25733 DEFVAR_LISP ("inhibit-redisplay", &Vinhibit_redisplay
,
25734 doc
: /* Non-nil means don't actually do any redisplay.
25735 This is used for internal purposes. */);
25736 Vinhibit_redisplay
= Qnil
;
25738 DEFVAR_LISP ("global-mode-string", &Vglobal_mode_string
,
25739 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
25740 Vglobal_mode_string
= Qnil
;
25742 DEFVAR_LISP ("overlay-arrow-position", &Voverlay_arrow_position
,
25743 doc
: /* Marker for where to display an arrow on top of the buffer text.
25744 This must be the beginning of a line in order to work.
25745 See also `overlay-arrow-string'. */);
25746 Voverlay_arrow_position
= Qnil
;
25748 DEFVAR_LISP ("overlay-arrow-string", &Voverlay_arrow_string
,
25749 doc
: /* String to display as an arrow in non-window frames.
25750 See also `overlay-arrow-position'. */);
25751 Voverlay_arrow_string
= make_pure_c_string ("=>");
25753 DEFVAR_LISP ("overlay-arrow-variable-list", &Voverlay_arrow_variable_list
,
25754 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
25755 The symbols on this list are examined during redisplay to determine
25756 where to display overlay arrows. */);
25757 Voverlay_arrow_variable_list
25758 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
25760 DEFVAR_INT ("scroll-step", &scroll_step
,
25761 doc
: /* *The number of lines to try scrolling a window by when point moves out.
25762 If that fails to bring point back on frame, point is centered instead.
25763 If this is zero, point is always centered after it moves off frame.
25764 If you want scrolling to always be a line at a time, you should set
25765 `scroll-conservatively' to a large value rather than set this to 1. */);
25767 DEFVAR_INT ("scroll-conservatively", &scroll_conservatively
,
25768 doc
: /* *Scroll up to this many lines, to bring point back on screen.
25769 If point moves off-screen, redisplay will scroll by up to
25770 `scroll-conservatively' lines in order to bring point just barely
25771 onto the screen again. If that cannot be done, then redisplay
25772 recenters point as usual.
25774 A value of zero means always recenter point if it moves off screen. */);
25775 scroll_conservatively
= 0;
25777 DEFVAR_INT ("scroll-margin", &scroll_margin
,
25778 doc
: /* *Number of lines of margin at the top and bottom of a window.
25779 Recenter the window whenever point gets within this many lines
25780 of the top or bottom of the window. */);
25783 DEFVAR_LISP ("display-pixels-per-inch", &Vdisplay_pixels_per_inch
,
25784 doc
: /* Pixels per inch value for non-window system displays.
25785 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
25786 Vdisplay_pixels_per_inch
= make_float (72.0);
25789 DEFVAR_INT ("debug-end-pos", &debug_end_pos
, doc
: /* Don't ask. */);
25792 DEFVAR_LISP ("truncate-partial-width-windows",
25793 &Vtruncate_partial_width_windows
,
25794 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
25795 For an integer value, truncate lines in each window narrower than the
25796 full frame width, provided the window width is less than that integer;
25797 otherwise, respect the value of `truncate-lines'.
25799 For any other non-nil value, truncate lines in all windows that do
25800 not span the full frame width.
25802 A value of nil means to respect the value of `truncate-lines'.
25804 If `word-wrap' is enabled, you might want to reduce this. */);
25805 Vtruncate_partial_width_windows
= make_number (50);
25807 DEFVAR_BOOL ("mode-line-inverse-video", &mode_line_inverse_video
,
25808 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
25809 Any other value means to use the appropriate face, `mode-line',
25810 `header-line', or `menu' respectively. */);
25811 mode_line_inverse_video
= 1;
25813 DEFVAR_LISP ("line-number-display-limit", &Vline_number_display_limit
,
25814 doc
: /* *Maximum buffer size for which line number should be displayed.
25815 If the buffer is bigger than this, the line number does not appear
25816 in the mode line. A value of nil means no limit. */);
25817 Vline_number_display_limit
= Qnil
;
25819 DEFVAR_INT ("line-number-display-limit-width",
25820 &line_number_display_limit_width
,
25821 doc
: /* *Maximum line width (in characters) for line number display.
25822 If the average length of the lines near point is bigger than this, then the
25823 line number may be omitted from the mode line. */);
25824 line_number_display_limit_width
= 200;
25826 DEFVAR_BOOL ("highlight-nonselected-windows", &highlight_nonselected_windows
,
25827 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
25828 highlight_nonselected_windows
= 0;
25830 DEFVAR_BOOL ("multiple-frames", &multiple_frames
,
25831 doc
: /* Non-nil if more than one frame is visible on this display.
25832 Minibuffer-only frames don't count, but iconified frames do.
25833 This variable is not guaranteed to be accurate except while processing
25834 `frame-title-format' and `icon-title-format'. */);
25836 DEFVAR_LISP ("frame-title-format", &Vframe_title_format
,
25837 doc
: /* Template for displaying the title bar of visible frames.
25838 \(Assuming the window manager supports this feature.)
25840 This variable has the same structure as `mode-line-format', except that
25841 the %c and %l constructs are ignored. It is used only on frames for
25842 which no explicit name has been set \(see `modify-frame-parameters'). */);
25844 DEFVAR_LISP ("icon-title-format", &Vicon_title_format
,
25845 doc
: /* Template for displaying the title bar of an iconified frame.
25846 \(Assuming the window manager supports this feature.)
25847 This variable has the same structure as `mode-line-format' (which see),
25848 and is used only on frames for which no explicit name has been set
25849 \(see `modify-frame-parameters'). */);
25851 = Vframe_title_format
25852 = pure_cons (intern_c_string ("multiple-frames"),
25853 pure_cons (make_pure_c_string ("%b"),
25854 pure_cons (pure_cons (empty_unibyte_string
,
25855 pure_cons (intern_c_string ("invocation-name"),
25856 pure_cons (make_pure_c_string ("@"),
25857 pure_cons (intern_c_string ("system-name"),
25861 DEFVAR_LISP ("message-log-max", &Vmessage_log_max
,
25862 doc
: /* Maximum number of lines to keep in the message log buffer.
25863 If nil, disable message logging. If t, log messages but don't truncate
25864 the buffer when it becomes large. */);
25865 Vmessage_log_max
= make_number (100);
25867 DEFVAR_LISP ("window-size-change-functions", &Vwindow_size_change_functions
,
25868 doc
: /* Functions called before redisplay, if window sizes have changed.
25869 The value should be a list of functions that take one argument.
25870 Just before redisplay, for each frame, if any of its windows have changed
25871 size since the last redisplay, or have been split or deleted,
25872 all the functions in the list are called, with the frame as argument. */);
25873 Vwindow_size_change_functions
= Qnil
;
25875 DEFVAR_LISP ("window-scroll-functions", &Vwindow_scroll_functions
,
25876 doc
: /* List of functions to call before redisplaying a window with scrolling.
25877 Each function is called with two arguments, the window and its new
25878 display-start position. Note that these functions are also called by
25879 `set-window-buffer'. Also note that the value of `window-end' is not
25880 valid when these functions are called. */);
25881 Vwindow_scroll_functions
= Qnil
;
25883 DEFVAR_LISP ("window-text-change-functions",
25884 &Vwindow_text_change_functions
,
25885 doc
: /* Functions to call in redisplay when text in the window might change. */);
25886 Vwindow_text_change_functions
= Qnil
;
25888 DEFVAR_LISP ("redisplay-end-trigger-functions", &Vredisplay_end_trigger_functions
,
25889 doc
: /* Functions called when redisplay of a window reaches the end trigger.
25890 Each function is called with two arguments, the window and the end trigger value.
25891 See `set-window-redisplay-end-trigger'. */);
25892 Vredisplay_end_trigger_functions
= Qnil
;
25894 DEFVAR_LISP ("mouse-autoselect-window", &Vmouse_autoselect_window
,
25895 doc
: /* *Non-nil means autoselect window with mouse pointer.
25896 If nil, do not autoselect windows.
25897 A positive number means delay autoselection by that many seconds: a
25898 window is autoselected only after the mouse has remained in that
25899 window for the duration of the delay.
25900 A negative number has a similar effect, but causes windows to be
25901 autoselected only after the mouse has stopped moving. \(Because of
25902 the way Emacs compares mouse events, you will occasionally wait twice
25903 that time before the window gets selected.\)
25904 Any other value means to autoselect window instantaneously when the
25905 mouse pointer enters it.
25907 Autoselection selects the minibuffer only if it is active, and never
25908 unselects the minibuffer if it is active.
25910 When customizing this variable make sure that the actual value of
25911 `focus-follows-mouse' matches the behavior of your window manager. */);
25912 Vmouse_autoselect_window
= Qnil
;
25914 DEFVAR_LISP ("auto-resize-tool-bars", &Vauto_resize_tool_bars
,
25915 doc
: /* *Non-nil means automatically resize tool-bars.
25916 This dynamically changes the tool-bar's height to the minimum height
25917 that is needed to make all tool-bar items visible.
25918 If value is `grow-only', the tool-bar's height is only increased
25919 automatically; to decrease the tool-bar height, use \\[recenter]. */);
25920 Vauto_resize_tool_bars
= Qt
;
25922 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", &auto_raise_tool_bar_buttons_p
,
25923 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
25924 auto_raise_tool_bar_buttons_p
= 1;
25926 DEFVAR_BOOL ("make-cursor-line-fully-visible", &make_cursor_line_fully_visible_p
,
25927 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
25928 make_cursor_line_fully_visible_p
= 1;
25930 DEFVAR_LISP ("tool-bar-border", &Vtool_bar_border
,
25931 doc
: /* *Border below tool-bar in pixels.
25932 If an integer, use it as the height of the border.
25933 If it is one of `internal-border-width' or `border-width', use the
25934 value of the corresponding frame parameter.
25935 Otherwise, no border is added below the tool-bar. */);
25936 Vtool_bar_border
= Qinternal_border_width
;
25938 DEFVAR_LISP ("tool-bar-button-margin", &Vtool_bar_button_margin
,
25939 doc
: /* *Margin around tool-bar buttons in pixels.
25940 If an integer, use that for both horizontal and vertical margins.
25941 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
25942 HORZ specifying the horizontal margin, and VERT specifying the
25943 vertical margin. */);
25944 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
25946 DEFVAR_INT ("tool-bar-button-relief", &tool_bar_button_relief
,
25947 doc
: /* *Relief thickness of tool-bar buttons. */);
25948 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
25950 DEFVAR_LISP ("tool-bar-style", &Vtool_bar_style
,
25951 doc
: /* *Tool bar style to use.
25953 image - show images only
25954 text - show text only
25955 both - show both, text below image
25956 both-horiz - show text to the right of the image
25957 text-image-horiz - show text to the left of the image
25958 any other - use system default or image if no system default. */);
25959 Vtool_bar_style
= Qnil
;
25961 DEFVAR_INT ("tool-bar-max-label-size", &tool_bar_max_label_size
,
25962 doc
: /* *Maximum number of characters a label can have to be shown.
25963 The tool bar style must also show labels for this to have any effect, see
25964 `tool-bar-style'. */);
25965 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
25967 DEFVAR_LISP ("fontification-functions", &Vfontification_functions
,
25968 doc
: /* List of functions to call to fontify regions of text.
25969 Each function is called with one argument POS. Functions must
25970 fontify a region starting at POS in the current buffer, and give
25971 fontified regions the property `fontified'. */);
25972 Vfontification_functions
= Qnil
;
25973 Fmake_variable_buffer_local (Qfontification_functions
);
25975 DEFVAR_BOOL ("unibyte-display-via-language-environment",
25976 &unibyte_display_via_language_environment
,
25977 doc
: /* *Non-nil means display unibyte text according to language environment.
25978 Specifically, this means that raw bytes in the range 160-255 decimal
25979 are displayed by converting them to the equivalent multibyte characters
25980 according to the current language environment. As a result, they are
25981 displayed according to the current fontset.
25983 Note that this variable affects only how these bytes are displayed,
25984 but does not change the fact they are interpreted as raw bytes. */);
25985 unibyte_display_via_language_environment
= 0;
25987 DEFVAR_LISP ("max-mini-window-height", &Vmax_mini_window_height
,
25988 doc
: /* *Maximum height for resizing mini-windows.
25989 If a float, it specifies a fraction of the mini-window frame's height.
25990 If an integer, it specifies a number of lines. */);
25991 Vmax_mini_window_height
= make_float (0.25);
25993 DEFVAR_LISP ("resize-mini-windows", &Vresize_mini_windows
,
25994 doc
: /* *How to resize mini-windows.
25995 A value of nil means don't automatically resize mini-windows.
25996 A value of t means resize them to fit the text displayed in them.
25997 A value of `grow-only', the default, means let mini-windows grow
25998 only, until their display becomes empty, at which point the windows
25999 go back to their normal size. */);
26000 Vresize_mini_windows
= Qgrow_only
;
26002 DEFVAR_LISP ("blink-cursor-alist", &Vblink_cursor_alist
,
26003 doc
: /* Alist specifying how to blink the cursor off.
26004 Each element has the form (ON-STATE . OFF-STATE). Whenever the
26005 `cursor-type' frame-parameter or variable equals ON-STATE,
26006 comparing using `equal', Emacs uses OFF-STATE to specify
26007 how to blink it off. ON-STATE and OFF-STATE are values for
26008 the `cursor-type' frame parameter.
26010 If a frame's ON-STATE has no entry in this list,
26011 the frame's other specifications determine how to blink the cursor off. */);
26012 Vblink_cursor_alist
= Qnil
;
26014 DEFVAR_BOOL ("auto-hscroll-mode", &automatic_hscrolling_p
,
26015 doc
: /* *Non-nil means scroll the display automatically to make point visible. */);
26016 automatic_hscrolling_p
= 1;
26017 Qauto_hscroll_mode
= intern_c_string ("auto-hscroll-mode");
26018 staticpro (&Qauto_hscroll_mode
);
26020 DEFVAR_INT ("hscroll-margin", &hscroll_margin
,
26021 doc
: /* *How many columns away from the window edge point is allowed to get
26022 before automatic hscrolling will horizontally scroll the window. */);
26023 hscroll_margin
= 5;
26025 DEFVAR_LISP ("hscroll-step", &Vhscroll_step
,
26026 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
26027 When point is less than `hscroll-margin' columns from the window
26028 edge, automatic hscrolling will scroll the window by the amount of columns
26029 determined by this variable. If its value is a positive integer, scroll that
26030 many columns. If it's a positive floating-point number, it specifies the
26031 fraction of the window's width to scroll. If it's nil or zero, point will be
26032 centered horizontally after the scroll. Any other value, including negative
26033 numbers, are treated as if the value were zero.
26035 Automatic hscrolling always moves point outside the scroll margin, so if
26036 point was more than scroll step columns inside the margin, the window will
26037 scroll more than the value given by the scroll step.
26039 Note that the lower bound for automatic hscrolling specified by `scroll-left'
26040 and `scroll-right' overrides this variable's effect. */);
26041 Vhscroll_step
= make_number (0);
26043 DEFVAR_BOOL ("message-truncate-lines", &message_truncate_lines
,
26044 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
26045 Bind this around calls to `message' to let it take effect. */);
26046 message_truncate_lines
= 0;
26048 DEFVAR_LISP ("menu-bar-update-hook", &Vmenu_bar_update_hook
,
26049 doc
: /* Normal hook run to update the menu bar definitions.
26050 Redisplay runs this hook before it redisplays the menu bar.
26051 This is used to update submenus such as Buffers,
26052 whose contents depend on various data. */);
26053 Vmenu_bar_update_hook
= Qnil
;
26055 DEFVAR_LISP ("menu-updating-frame", &Vmenu_updating_frame
,
26056 doc
: /* Frame for which we are updating a menu.
26057 The enable predicate for a menu binding should check this variable. */);
26058 Vmenu_updating_frame
= Qnil
;
26060 DEFVAR_BOOL ("inhibit-menubar-update", &inhibit_menubar_update
,
26061 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
26062 inhibit_menubar_update
= 0;
26064 DEFVAR_LISP ("wrap-prefix", &Vwrap_prefix
,
26065 doc
: /* Prefix prepended to all continuation lines at display time.
26066 The value may be a string, an image, or a stretch-glyph; it is
26067 interpreted in the same way as the value of a `display' text property.
26069 This variable is overridden by any `wrap-prefix' text or overlay
26072 To add a prefix to non-continuation lines, use `line-prefix'. */);
26073 Vwrap_prefix
= Qnil
;
26074 staticpro (&Qwrap_prefix
);
26075 Qwrap_prefix
= intern_c_string ("wrap-prefix");
26076 Fmake_variable_buffer_local (Qwrap_prefix
);
26078 DEFVAR_LISP ("line-prefix", &Vline_prefix
,
26079 doc
: /* Prefix prepended to all non-continuation lines at display time.
26080 The value may be a string, an image, or a stretch-glyph; it is
26081 interpreted in the same way as the value of a `display' text property.
26083 This variable is overridden by any `line-prefix' text or overlay
26086 To add a prefix to continuation lines, use `wrap-prefix'. */);
26087 Vline_prefix
= Qnil
;
26088 staticpro (&Qline_prefix
);
26089 Qline_prefix
= intern_c_string ("line-prefix");
26090 Fmake_variable_buffer_local (Qline_prefix
);
26092 DEFVAR_BOOL ("inhibit-eval-during-redisplay", &inhibit_eval_during_redisplay
,
26093 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
26094 inhibit_eval_during_redisplay
= 0;
26096 DEFVAR_BOOL ("inhibit-free-realized-faces", &inhibit_free_realized_faces
,
26097 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
26098 inhibit_free_realized_faces
= 0;
26101 DEFVAR_BOOL ("inhibit-try-window-id", &inhibit_try_window_id
,
26102 doc
: /* Inhibit try_window_id display optimization. */);
26103 inhibit_try_window_id
= 0;
26105 DEFVAR_BOOL ("inhibit-try-window-reusing", &inhibit_try_window_reusing
,
26106 doc
: /* Inhibit try_window_reusing display optimization. */);
26107 inhibit_try_window_reusing
= 0;
26109 DEFVAR_BOOL ("inhibit-try-cursor-movement", &inhibit_try_cursor_movement
,
26110 doc
: /* Inhibit try_cursor_movement display optimization. */);
26111 inhibit_try_cursor_movement
= 0;
26112 #endif /* GLYPH_DEBUG */
26114 DEFVAR_INT ("overline-margin", &overline_margin
,
26115 doc
: /* *Space between overline and text, in pixels.
26116 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
26117 margin to the caracter height. */);
26118 overline_margin
= 2;
26120 DEFVAR_INT ("underline-minimum-offset",
26121 &underline_minimum_offset
,
26122 doc
: /* Minimum distance between baseline and underline.
26123 This can improve legibility of underlined text at small font sizes,
26124 particularly when using variable `x-use-underline-position-properties'
26125 with fonts that specify an UNDERLINE_POSITION relatively close to the
26126 baseline. The default value is 1. */);
26127 underline_minimum_offset
= 1;
26129 DEFVAR_BOOL ("display-hourglass", &display_hourglass_p
,
26130 doc
: /* Non-zero means Emacs displays an hourglass pointer on window systems. */);
26131 display_hourglass_p
= 1;
26133 DEFVAR_LISP ("hourglass-delay", &Vhourglass_delay
,
26134 doc
: /* *Seconds to wait before displaying an hourglass pointer.
26135 Value must be an integer or float. */);
26136 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
26138 hourglass_atimer
= NULL
;
26139 hourglass_shown_p
= 0;
26143 /* Initialize this module when Emacs starts. */
26148 Lisp_Object root_window
;
26149 struct window
*mini_w
;
26151 current_header_line_height
= current_mode_line_height
= -1;
26153 CHARPOS (this_line_start_pos
) = 0;
26155 mini_w
= XWINDOW (minibuf_window
);
26156 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
26158 if (!noninteractive
)
26160 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
26163 XWINDOW (root_window
)->top_line
= make_number (FRAME_TOP_MARGIN (f
));
26164 set_window_height (root_window
,
26165 FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
),
26167 mini_w
->top_line
= make_number (FRAME_LINES (f
) - 1);
26168 set_window_height (minibuf_window
, 1, 0);
26170 XWINDOW (root_window
)->total_cols
= make_number (FRAME_COLS (f
));
26171 mini_w
->total_cols
= make_number (FRAME_COLS (f
));
26173 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
26174 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
26175 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
26177 /* The default ellipsis glyphs `...'. */
26178 for (i
= 0; i
< 3; ++i
)
26179 default_invis_vector
[i
] = make_number ('.');
26183 /* Allocate the buffer for frame titles.
26184 Also used for `format-mode-line'. */
26186 mode_line_noprop_buf
= (char *) xmalloc (size
);
26187 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
26188 mode_line_noprop_ptr
= mode_line_noprop_buf
;
26189 mode_line_target
= MODE_LINE_DISPLAY
;
26192 help_echo_showing_p
= 0;
26195 /* Since w32 does not support atimers, it defines its own implementation of
26196 the following three functions in w32fns.c. */
26199 /* Platform-independent portion of hourglass implementation. */
26201 /* Return non-zero if houglass timer has been started or hourglass is shown. */
26203 hourglass_started (void)
26205 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
26208 /* Cancel a currently active hourglass timer, and start a new one. */
26210 start_hourglass (void)
26212 #if defined (HAVE_WINDOW_SYSTEM)
26214 int secs
, usecs
= 0;
26216 cancel_hourglass ();
26218 if (INTEGERP (Vhourglass_delay
)
26219 && XINT (Vhourglass_delay
) > 0)
26220 secs
= XFASTINT (Vhourglass_delay
);
26221 else if (FLOATP (Vhourglass_delay
)
26222 && XFLOAT_DATA (Vhourglass_delay
) > 0)
26225 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
26226 secs
= XFASTINT (tem
);
26227 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
26230 secs
= DEFAULT_HOURGLASS_DELAY
;
26232 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
26233 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
26234 show_hourglass
, NULL
);
26239 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
26242 cancel_hourglass (void)
26244 #if defined (HAVE_WINDOW_SYSTEM)
26245 if (hourglass_atimer
)
26247 cancel_atimer (hourglass_atimer
);
26248 hourglass_atimer
= NULL
;
26251 if (hourglass_shown_p
)
26255 #endif /* ! WINDOWSNT */
26257 /* arch-tag: eacc864d-bb6a-4b74-894a-1a4399a1358b
26258 (do not change this comment) */