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 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
21 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>.
25 Emacs separates the task of updating the display from code
26 modifying global state, e.g. buffer text. This way functions
27 operating on buffers don't also have to be concerned with updating
30 Updating the display is triggered by the Lisp interpreter when it
31 decides it's time to do it. This is done either automatically for
32 you as part of the interpreter's command loop or as the result of
33 calling Lisp functions like `sit-for'. The C function `redisplay'
34 in xdisp.c is the only entry into the inner redisplay code. (Or,
35 let's say almost---see the description of direct update
38 The following diagram shows how redisplay code is invoked. As you
39 can see, Lisp calls redisplay and vice versa. Under window systems
40 like X, some portions of the redisplay code are also called
41 asynchronously during mouse movement or expose events. It is very
42 important that these code parts do NOT use the C library (malloc,
43 free) because many C libraries under Unix are not reentrant. They
44 may also NOT call functions of the Lisp interpreter which could
45 change the interpreter's state. If you don't follow these rules,
46 you will encounter bugs which are very hard to explain.
48 (Direct functions, see below)
49 direct_output_for_insert,
50 direct_forward_char (dispnew.c)
51 +---------------------------------+
54 +--------------+ redisplay +----------------+
55 | Lisp machine |---------------->| Redisplay code |<--+
56 +--------------+ (xdisp.c) +----------------+ |
58 +----------------------------------+ |
59 Don't use this path when called |
62 expose_window (asynchronous) |
64 X expose events -----+
66 What does redisplay do? Obviously, it has to figure out somehow what
67 has been changed since the last time the display has been updated,
68 and to make these changes visible. Preferably it would do that in
69 a moderately intelligent way, i.e. fast.
71 Changes in buffer text can be deduced from window and buffer
72 structures, and from some global variables like `beg_unchanged' and
73 `end_unchanged'. The contents of the display are additionally
74 recorded in a `glyph matrix', a two-dimensional matrix of glyph
75 structures. Each row in such a matrix corresponds to a line on the
76 display, and each glyph in a row corresponds to a column displaying
77 a character, an image, or what else. This matrix is called the
78 `current glyph matrix' or `current matrix' in redisplay
81 For buffer parts that have been changed since the last update, a
82 second glyph matrix is constructed, the so called `desired glyph
83 matrix' or short `desired matrix'. Current and desired matrix are
84 then compared to find a cheap way to update the display, e.g. by
85 reusing part of the display by scrolling lines.
90 You will find a lot of redisplay optimizations when you start
91 looking at the innards of redisplay. The overall goal of all these
92 optimizations is to make redisplay fast because it is done
95 Two optimizations are not found in xdisp.c. These are the direct
96 operations mentioned above. As the name suggests they follow a
97 different principle than the rest of redisplay. Instead of
98 building a desired matrix and then comparing it with the current
99 display, they perform their actions directly on the display and on
102 One direct operation updates the display after one character has
103 been entered. The other one moves the cursor by one position
104 forward or backward. You find these functions under the names
105 `direct_output_for_insert' and `direct_output_forward_char' in
111 Desired matrices are always built per Emacs window. The function
112 `display_line' is the central function to look at if you are
113 interested. It constructs one row in a desired matrix given an
114 iterator structure containing both a buffer position and a
115 description of the environment in which the text is to be
116 displayed. But this is too early, read on.
118 Characters and pixmaps displayed for a range of buffer text depend
119 on various settings of buffers and windows, on overlays and text
120 properties, on display tables, on selective display. The good news
121 is that all this hairy stuff is hidden behind a small set of
122 interface functions taking an iterator structure (struct it)
125 Iteration over things to be displayed is then simple. It is
126 started by initializing an iterator with a call to init_iterator.
127 Calls to get_next_display_element fill the iterator structure with
128 relevant information about the next thing to display. Calls to
129 set_iterator_to_next move the iterator to the next thing.
131 Besides this, an iterator also contains information about the
132 display environment in which glyphs for display elements are to be
133 produced. It has fields for the width and height of the display,
134 the information whether long lines are truncated or continued, a
135 current X and Y position, and lots of other stuff you can better
138 Glyphs in a desired matrix are normally constructed in a loop
139 calling get_next_display_element and then produce_glyphs. The call
140 to produce_glyphs will fill the iterator structure with pixel
141 information about the element being displayed and at the same time
142 produce glyphs for it. If the display element fits on the line
143 being displayed, set_iterator_to_next is called next, otherwise the
144 glyphs produced are discarded.
149 That just couldn't be all, could it? What about terminal types not
150 supporting operations on sub-windows of the screen? To update the
151 display on such a terminal, window-based glyph matrices are not
152 well suited. To be able to reuse part of the display (scrolling
153 lines up and down), we must instead have a view of the whole
154 screen. This is what `frame matrices' are for. They are a trick.
156 Frames on terminals like above have a glyph pool. Windows on such
157 a frame sub-allocate their glyph memory from their frame's glyph
158 pool. The frame itself is given its own glyph matrices. By
159 coincidence---or maybe something else---rows in window glyph
160 matrices are slices of corresponding rows in frame matrices. Thus
161 writing to window matrices implicitly updates a frame matrix which
162 provides us with the view of the whole screen that we originally
163 wanted to have without having to move many bytes around. To be
164 honest, there is a little bit more done, but not much more. If you
165 plan to extend that code, take a look at dispnew.c. The function
166 build_frame_matrix is a good starting point. */
172 #include "keyboard.h"
175 #include "termchar.h"
176 #include "dispextern.h"
178 #include "character.h"
181 #include "commands.h"
185 #include "termhooks.h"
186 #include "intervals.h"
189 #include "region-cache.h"
191 #include "blockinput.h"
193 #ifdef HAVE_X_WINDOWS
205 #ifndef FRAME_X_OUTPUT
206 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
209 #define INFINITY 10000000
211 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
213 extern void set_frame_menubar
P_ ((struct frame
*f
, int, int));
214 extern int pending_menu_activation
;
217 extern int interrupt_input
;
218 extern int command_loop_level
;
220 extern Lisp_Object do_mouse_tracking
;
222 extern int minibuffer_auto_raise
;
223 extern Lisp_Object Vminibuffer_list
;
225 extern Lisp_Object Qface
;
226 extern Lisp_Object Qmode_line
, Qmode_line_inactive
, Qheader_line
;
228 extern Lisp_Object Voverriding_local_map
;
229 extern Lisp_Object Voverriding_local_map_menu_flag
;
230 extern Lisp_Object Qmenu_item
;
231 extern Lisp_Object Qwhen
;
232 extern Lisp_Object Qhelp_echo
;
234 Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
235 Lisp_Object Qwindow_scroll_functions
, Vwindow_scroll_functions
;
236 Lisp_Object Qwindow_text_change_functions
, Vwindow_text_change_functions
;
237 Lisp_Object Qredisplay_end_trigger_functions
, Vredisplay_end_trigger_functions
;
238 Lisp_Object Qinhibit_point_motion_hooks
;
239 Lisp_Object QCeval
, QCfile
, QCdata
, QCpropertize
;
240 Lisp_Object Qfontified
;
241 Lisp_Object Qgrow_only
;
242 Lisp_Object Qinhibit_eval_during_redisplay
;
243 Lisp_Object Qbuffer_position
, Qposition
, Qobject
;
246 Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
249 Lisp_Object Qarrow
, Qhand
, Qtext
;
251 Lisp_Object Qrisky_local_variable
;
253 /* Holds the list (error). */
254 Lisp_Object list_of_error
;
256 /* Functions called to fontify regions of text. */
258 Lisp_Object Vfontification_functions
;
259 Lisp_Object Qfontification_functions
;
261 /* Non-nil means automatically select any window when the mouse
262 cursor moves into it. */
263 Lisp_Object Vmouse_autoselect_window
;
265 /* Non-zero means draw tool bar buttons raised when the mouse moves
268 int auto_raise_tool_bar_buttons_p
;
270 /* Non-zero means to reposition window if cursor line is only partially visible. */
272 int make_cursor_line_fully_visible_p
;
274 /* Margin below tool bar in pixels. 0 or nil means no margin.
275 If value is `internal-border-width' or `border-width',
276 the corresponding frame parameter is used. */
278 Lisp_Object Vtool_bar_border
;
280 /* Margin around tool bar buttons in pixels. */
282 Lisp_Object Vtool_bar_button_margin
;
284 /* Thickness of shadow to draw around tool bar buttons. */
286 EMACS_INT tool_bar_button_relief
;
288 /* Non-nil means automatically resize tool-bars so that all tool-bar
289 items are visible, and no blank lines remain.
291 If value is `grow-only', only make tool-bar bigger. */
293 Lisp_Object Vauto_resize_tool_bars
;
295 /* Non-zero means draw block and hollow cursor as wide as the glyph
296 under it. For example, if a block cursor is over a tab, it will be
297 drawn as wide as that tab on the display. */
299 int x_stretch_cursor_p
;
301 /* Non-nil means don't actually do any redisplay. */
303 Lisp_Object Vinhibit_redisplay
, Qinhibit_redisplay
;
305 /* Non-zero means Lisp evaluation during redisplay is inhibited. */
307 int inhibit_eval_during_redisplay
;
309 /* Names of text properties relevant for redisplay. */
311 Lisp_Object Qdisplay
;
312 extern Lisp_Object Qface
, Qinvisible
, Qwidth
;
314 /* Symbols used in text property values. */
316 Lisp_Object Vdisplay_pixels_per_inch
;
317 Lisp_Object Qspace
, QCalign_to
, QCrelative_width
, QCrelative_height
;
318 Lisp_Object Qleft_margin
, Qright_margin
, Qspace_width
, Qraise
;
321 Lisp_Object Qmargin
, Qpointer
;
322 Lisp_Object Qline_height
;
323 extern Lisp_Object Qheight
;
324 extern Lisp_Object QCwidth
, QCheight
, QCascent
;
325 extern Lisp_Object Qscroll_bar
;
326 extern Lisp_Object Qcursor
;
328 /* Non-nil means highlight trailing whitespace. */
330 Lisp_Object Vshow_trailing_whitespace
;
332 /* Non-nil means escape non-break space and hyphens. */
334 Lisp_Object Vnobreak_char_display
;
336 #ifdef HAVE_WINDOW_SYSTEM
337 extern Lisp_Object Voverflow_newline_into_fringe
;
339 /* Test if overflow newline into fringe. Called with iterator IT
340 at or past right window margin, and with IT->current_x set. */
342 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) \
343 (!NILP (Voverflow_newline_into_fringe) \
344 && FRAME_WINDOW_P (it->f) \
345 && WINDOW_RIGHT_FRINGE_WIDTH (it->w) > 0 \
346 && it->current_x == it->last_visible_x)
348 #endif /* HAVE_WINDOW_SYSTEM */
350 /* Non-nil means show the text cursor in void text areas
351 i.e. in blank areas after eol and eob. This used to be
352 the default in 21.3. */
354 Lisp_Object Vvoid_text_area_pointer
;
356 /* Name of the face used to highlight trailing whitespace. */
358 Lisp_Object Qtrailing_whitespace
;
360 /* Name and number of the face used to highlight escape glyphs. */
362 Lisp_Object Qescape_glyph
;
364 /* Name and number of the face used to highlight non-breaking spaces. */
366 Lisp_Object Qnobreak_space
;
368 /* The symbol `image' which is the car of the lists used to represent
373 /* The image map types. */
374 Lisp_Object QCmap
, QCpointer
;
375 Lisp_Object Qrect
, Qcircle
, Qpoly
;
377 /* Non-zero means print newline to stdout before next mini-buffer
380 int noninteractive_need_newline
;
382 /* Non-zero means print newline to message log before next message. */
384 static int message_log_need_newline
;
386 /* Three markers that message_dolog uses.
387 It could allocate them itself, but that causes trouble
388 in handling memory-full errors. */
389 static Lisp_Object message_dolog_marker1
;
390 static Lisp_Object message_dolog_marker2
;
391 static Lisp_Object message_dolog_marker3
;
393 /* The buffer position of the first character appearing entirely or
394 partially on the line of the selected window which contains the
395 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
396 redisplay optimization in redisplay_internal. */
398 static struct text_pos this_line_start_pos
;
400 /* Number of characters past the end of the line above, including the
401 terminating newline. */
403 static struct text_pos this_line_end_pos
;
405 /* The vertical positions and the height of this line. */
407 static int this_line_vpos
;
408 static int this_line_y
;
409 static int this_line_pixel_height
;
411 /* X position at which this display line starts. Usually zero;
412 negative if first character is partially visible. */
414 static int this_line_start_x
;
416 /* Buffer that this_line_.* variables are referring to. */
418 static struct buffer
*this_line_buffer
;
420 /* Nonzero means truncate lines in all windows less wide than the
423 Lisp_Object Vtruncate_partial_width_windows
;
425 /* A flag to control how to display unibyte 8-bit character. */
427 int unibyte_display_via_language_environment
;
429 /* Nonzero means we have more than one non-mini-buffer-only frame.
430 Not guaranteed to be accurate except while parsing
431 frame-title-format. */
435 Lisp_Object Vglobal_mode_string
;
438 /* List of variables (symbols) which hold markers for overlay arrows.
439 The symbols on this list are examined during redisplay to determine
440 where to display overlay arrows. */
442 Lisp_Object Voverlay_arrow_variable_list
;
444 /* Marker for where to display an arrow on top of the buffer text. */
446 Lisp_Object Voverlay_arrow_position
;
448 /* String to display for the arrow. Only used on terminal frames. */
450 Lisp_Object Voverlay_arrow_string
;
452 /* Values of those variables at last redisplay are stored as
453 properties on `overlay-arrow-position' symbol. However, if
454 Voverlay_arrow_position is a marker, last-arrow-position is its
455 numerical position. */
457 Lisp_Object Qlast_arrow_position
, Qlast_arrow_string
;
459 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
460 properties on a symbol in overlay-arrow-variable-list. */
462 Lisp_Object Qoverlay_arrow_string
, Qoverlay_arrow_bitmap
;
464 /* Like mode-line-format, but for the title bar on a visible frame. */
466 Lisp_Object Vframe_title_format
;
468 /* Like mode-line-format, but for the title bar on an iconified frame. */
470 Lisp_Object Vicon_title_format
;
472 /* List of functions to call when a window's size changes. These
473 functions get one arg, a frame on which one or more windows' sizes
476 static Lisp_Object Vwindow_size_change_functions
;
478 Lisp_Object Qmenu_bar_update_hook
, Vmenu_bar_update_hook
;
480 /* Nonzero if an overlay arrow has been displayed in this window. */
482 static int overlay_arrow_seen
;
484 /* Nonzero means highlight the region even in nonselected windows. */
486 int highlight_nonselected_windows
;
488 /* If cursor motion alone moves point off frame, try scrolling this
489 many lines up or down if that will bring it back. */
491 static EMACS_INT scroll_step
;
493 /* Nonzero means scroll just far enough to bring point back on the
494 screen, when appropriate. */
496 static EMACS_INT scroll_conservatively
;
498 /* Recenter the window whenever point gets within this many lines of
499 the top or bottom of the window. This value is translated into a
500 pixel value by multiplying it with FRAME_LINE_HEIGHT, which means
501 that there is really a fixed pixel height scroll margin. */
503 EMACS_INT scroll_margin
;
505 /* Number of windows showing the buffer of the selected window (or
506 another buffer with the same base buffer). keyboard.c refers to
511 /* Vector containing glyphs for an ellipsis `...'. */
513 static Lisp_Object default_invis_vector
[3];
515 /* Zero means display the mode-line/header-line/menu-bar in the default face
516 (this slightly odd definition is for compatibility with previous versions
517 of emacs), non-zero means display them using their respective faces.
519 This variable is deprecated. */
521 int mode_line_inverse_video
;
523 /* Prompt to display in front of the mini-buffer contents. */
525 Lisp_Object minibuf_prompt
;
527 /* Width of current mini-buffer prompt. Only set after display_line
528 of the line that contains the prompt. */
530 int minibuf_prompt_width
;
532 /* This is the window where the echo area message was displayed. It
533 is always a mini-buffer window, but it may not be the same window
534 currently active as a mini-buffer. */
536 Lisp_Object echo_area_window
;
538 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
539 pushes the current message and the value of
540 message_enable_multibyte on the stack, the function restore_message
541 pops the stack and displays MESSAGE again. */
543 Lisp_Object Vmessage_stack
;
545 /* Nonzero means multibyte characters were enabled when the echo area
546 message was specified. */
548 int message_enable_multibyte
;
550 /* Nonzero if we should redraw the mode lines on the next redisplay. */
552 int update_mode_lines
;
554 /* Nonzero if window sizes or contents have changed since last
555 redisplay that finished. */
557 int windows_or_buffers_changed
;
559 /* Nonzero means a frame's cursor type has been changed. */
561 int cursor_type_changed
;
563 /* Nonzero after display_mode_line if %l was used and it displayed a
566 int line_number_displayed
;
568 /* Maximum buffer size for which to display line numbers. */
570 Lisp_Object Vline_number_display_limit
;
572 /* Line width to consider when repositioning for line number display. */
574 static EMACS_INT line_number_display_limit_width
;
576 /* Number of lines to keep in the message log buffer. t means
577 infinite. nil means don't log at all. */
579 Lisp_Object Vmessage_log_max
;
581 /* The name of the *Messages* buffer, a string. */
583 static Lisp_Object Vmessages_buffer_name
;
585 /* Current, index 0, and last displayed echo area message. Either
586 buffers from echo_buffers, or nil to indicate no message. */
588 Lisp_Object echo_area_buffer
[2];
590 /* The buffers referenced from echo_area_buffer. */
592 static Lisp_Object echo_buffer
[2];
594 /* A vector saved used in with_area_buffer to reduce consing. */
596 static Lisp_Object Vwith_echo_area_save_vector
;
598 /* Non-zero means display_echo_area should display the last echo area
599 message again. Set by redisplay_preserve_echo_area. */
601 static int display_last_displayed_message_p
;
603 /* Nonzero if echo area is being used by print; zero if being used by
606 int message_buf_print
;
608 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
610 Lisp_Object Qinhibit_menubar_update
;
611 int inhibit_menubar_update
;
613 /* When evaluating expressions from menu bar items (enable conditions,
614 for instance), this is the frame they are being processed for. */
616 Lisp_Object Vmenu_updating_frame
;
618 /* Maximum height for resizing mini-windows. Either a float
619 specifying a fraction of the available height, or an integer
620 specifying a number of lines. */
622 Lisp_Object Vmax_mini_window_height
;
624 /* Non-zero means messages should be displayed with truncated
625 lines instead of being continued. */
627 int message_truncate_lines
;
628 Lisp_Object Qmessage_truncate_lines
;
630 /* Set to 1 in clear_message to make redisplay_internal aware
631 of an emptied echo area. */
633 static int message_cleared_p
;
635 /* How to blink the default frame cursor off. */
636 Lisp_Object Vblink_cursor_alist
;
638 /* A scratch glyph row with contents used for generating truncation
639 glyphs. Also used in direct_output_for_insert. */
641 #define MAX_SCRATCH_GLYPHS 100
642 struct glyph_row scratch_glyph_row
;
643 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
645 /* Ascent and height of the last line processed by move_it_to. */
647 static int last_max_ascent
, last_height
;
649 /* Non-zero if there's a help-echo in the echo area. */
651 int help_echo_showing_p
;
653 /* If >= 0, computed, exact values of mode-line and header-line height
654 to use in the macros CURRENT_MODE_LINE_HEIGHT and
655 CURRENT_HEADER_LINE_HEIGHT. */
657 int current_mode_line_height
, current_header_line_height
;
659 /* The maximum distance to look ahead for text properties. Values
660 that are too small let us call compute_char_face and similar
661 functions too often which is expensive. Values that are too large
662 let us call compute_char_face and alike too often because we
663 might not be interested in text properties that far away. */
665 #define TEXT_PROP_DISTANCE_LIMIT 100
669 /* Variables to turn off display optimizations from Lisp. */
671 int inhibit_try_window_id
, inhibit_try_window_reusing
;
672 int inhibit_try_cursor_movement
;
674 /* Non-zero means print traces of redisplay if compiled with
677 int trace_redisplay_p
;
679 #endif /* GLYPH_DEBUG */
681 #ifdef DEBUG_TRACE_MOVE
682 /* Non-zero means trace with TRACE_MOVE to stderr. */
685 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
687 #define TRACE_MOVE(x) (void) 0
690 /* Non-zero means automatically scroll windows horizontally to make
693 int automatic_hscrolling_p
;
694 Lisp_Object Qauto_hscroll_mode
;
696 /* How close to the margin can point get before the window is scrolled
698 EMACS_INT hscroll_margin
;
700 /* How much to scroll horizontally when point is inside the above margin. */
701 Lisp_Object Vhscroll_step
;
703 /* The variable `resize-mini-windows'. If nil, don't resize
704 mini-windows. If t, always resize them to fit the text they
705 display. If `grow-only', let mini-windows grow only until they
708 Lisp_Object Vresize_mini_windows
;
710 /* Buffer being redisplayed -- for redisplay_window_error. */
712 struct buffer
*displayed_buffer
;
714 /* Space between overline and text. */
716 EMACS_INT overline_margin
;
718 /* Require underline to be at least this many screen pixels below baseline
719 This to avoid underline "merging" with the base of letters at small
720 font sizes, particularly when x_use_underline_position_properties is on. */
722 EMACS_INT underline_minimum_offset
;
724 /* Value returned from text property handlers (see below). */
729 HANDLED_RECOMPUTE_PROPS
,
730 HANDLED_OVERLAY_STRING_CONSUMED
,
734 /* A description of text properties that redisplay is interested
739 /* The name of the property. */
742 /* A unique index for the property. */
745 /* A handler function called to set up iterator IT from the property
746 at IT's current position. Value is used to steer handle_stop. */
747 enum prop_handled (*handler
) P_ ((struct it
*it
));
750 static enum prop_handled handle_face_prop
P_ ((struct it
*));
751 static enum prop_handled handle_invisible_prop
P_ ((struct it
*));
752 static enum prop_handled handle_display_prop
P_ ((struct it
*));
753 static enum prop_handled handle_composition_prop
P_ ((struct it
*));
754 static enum prop_handled handle_overlay_change
P_ ((struct it
*));
755 static enum prop_handled handle_fontified_prop
P_ ((struct it
*));
756 static enum prop_handled handle_auto_composed_prop
P_ ((struct it
*));
758 /* Properties handled by iterators. */
760 static struct props it_props
[] =
762 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
763 /* Handle `face' before `display' because some sub-properties of
764 `display' need to know the face. */
765 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
766 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
767 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
768 {&Qauto_composed
, AUTO_COMPOSED_PROP_IDX
, handle_auto_composed_prop
},
769 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
773 /* Value is the position described by X. If X is a marker, value is
774 the marker_position of X. Otherwise, value is X. */
776 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
778 /* Enumeration returned by some move_it_.* functions internally. */
782 /* Not used. Undefined value. */
785 /* Move ended at the requested buffer position or ZV. */
786 MOVE_POS_MATCH_OR_ZV
,
788 /* Move ended at the requested X pixel position. */
791 /* Move within a line ended at the end of a line that must be
795 /* Move within a line ended at the end of a line that would
796 be displayed truncated. */
799 /* Move within a line ended at a line end. */
803 /* This counter is used to clear the face cache every once in a while
804 in redisplay_internal. It is incremented for each redisplay.
805 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
808 #define CLEAR_FACE_CACHE_COUNT 500
809 static int clear_face_cache_count
;
811 /* Similarly for the image cache. */
813 #ifdef HAVE_WINDOW_SYSTEM
814 #define CLEAR_IMAGE_CACHE_COUNT 101
815 static int clear_image_cache_count
;
818 /* Non-zero while redisplay_internal is in progress. */
822 /* Non-zero means don't free realized faces. Bound while freeing
823 realized faces is dangerous because glyph matrices might still
826 int inhibit_free_realized_faces
;
827 Lisp_Object Qinhibit_free_realized_faces
;
829 /* If a string, XTread_socket generates an event to display that string.
830 (The display is done in read_char.) */
832 Lisp_Object help_echo_string
;
833 Lisp_Object help_echo_window
;
834 Lisp_Object help_echo_object
;
837 /* Temporary variable for XTread_socket. */
839 Lisp_Object previous_help_echo_string
;
841 /* Null glyph slice */
843 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
846 /* Function prototypes. */
848 static void setup_for_ellipsis
P_ ((struct it
*, int));
849 static void mark_window_display_accurate_1
P_ ((struct window
*, int));
850 static int single_display_spec_string_p
P_ ((Lisp_Object
, Lisp_Object
));
851 static int display_prop_string_p
P_ ((Lisp_Object
, Lisp_Object
));
852 static int cursor_row_p
P_ ((struct window
*, struct glyph_row
*));
853 static int redisplay_mode_lines
P_ ((Lisp_Object
, int));
854 static char *decode_mode_spec_coding
P_ ((Lisp_Object
, char *, int));
857 static int invisible_text_between_p
P_ ((struct it
*, int, int));
860 static void pint2str
P_ ((char *, int, int));
861 static void pint2hrstr
P_ ((char *, int, int));
862 static struct text_pos run_window_scroll_functions
P_ ((Lisp_Object
,
864 static void reconsider_clip_changes
P_ ((struct window
*, struct buffer
*));
865 static int text_outside_line_unchanged_p
P_ ((struct window
*, int, int));
866 static void store_mode_line_noprop_char
P_ ((char));
867 static int store_mode_line_noprop
P_ ((const unsigned char *, int, int));
868 static void x_consider_frame_title
P_ ((Lisp_Object
));
869 static void handle_stop
P_ ((struct it
*));
870 static int tool_bar_lines_needed
P_ ((struct frame
*, int *));
871 static int single_display_spec_intangible_p
P_ ((Lisp_Object
));
872 static void ensure_echo_area_buffers
P_ ((void));
873 static Lisp_Object unwind_with_echo_area_buffer
P_ ((Lisp_Object
));
874 static Lisp_Object with_echo_area_buffer_unwind_data
P_ ((struct window
*));
875 static int with_echo_area_buffer
P_ ((struct window
*, int,
876 int (*) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
877 EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
878 static void clear_garbaged_frames
P_ ((void));
879 static int current_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
880 static int truncate_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
881 static int set_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
882 static int display_echo_area
P_ ((struct window
*));
883 static int display_echo_area_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
884 static int resize_mini_window_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
885 static Lisp_Object unwind_redisplay
P_ ((Lisp_Object
));
886 static int string_char_and_length
P_ ((const unsigned char *, int, int *));
887 static struct text_pos display_prop_end
P_ ((struct it
*, Lisp_Object
,
889 static int compute_window_start_on_continuation_line
P_ ((struct window
*));
890 static Lisp_Object safe_eval_handler
P_ ((Lisp_Object
));
891 static void insert_left_trunc_glyphs
P_ ((struct it
*));
892 static struct glyph_row
*get_overlay_arrow_glyph_row
P_ ((struct window
*,
894 static void extend_face_to_end_of_line
P_ ((struct it
*));
895 static int append_space_for_newline
P_ ((struct it
*, int));
896 static int cursor_row_fully_visible_p
P_ ((struct window
*, int, int));
897 static int try_scrolling
P_ ((Lisp_Object
, int, EMACS_INT
, EMACS_INT
, int, int));
898 static int try_cursor_movement
P_ ((Lisp_Object
, struct text_pos
, int *));
899 static int trailing_whitespace_p
P_ ((int));
900 static int message_log_check_duplicate
P_ ((int, int, int, int));
901 static void push_it
P_ ((struct it
*));
902 static void pop_it
P_ ((struct it
*));
903 static void sync_frame_with_window_matrix_rows
P_ ((struct window
*));
904 static void select_frame_for_redisplay
P_ ((Lisp_Object
));
905 static void redisplay_internal
P_ ((int));
906 static int echo_area_display
P_ ((int));
907 static void redisplay_windows
P_ ((Lisp_Object
));
908 static void redisplay_window
P_ ((Lisp_Object
, int));
909 static Lisp_Object
redisplay_window_error ();
910 static Lisp_Object redisplay_window_0
P_ ((Lisp_Object
));
911 static Lisp_Object redisplay_window_1
P_ ((Lisp_Object
));
912 static int update_menu_bar
P_ ((struct frame
*, int, int));
913 static int try_window_reusing_current_matrix
P_ ((struct window
*));
914 static int try_window_id
P_ ((struct window
*));
915 static int display_line
P_ ((struct it
*));
916 static int display_mode_lines
P_ ((struct window
*));
917 static int display_mode_line
P_ ((struct window
*, enum face_id
, Lisp_Object
));
918 static int display_mode_element
P_ ((struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int));
919 static int store_mode_line_string
P_ ((char *, Lisp_Object
, int, int, int, Lisp_Object
));
920 static char *decode_mode_spec
P_ ((struct window
*, int, int, int, int *));
921 static void display_menu_bar
P_ ((struct window
*));
922 static int display_count_lines
P_ ((int, int, int, int, int *));
923 static int display_string
P_ ((unsigned char *, Lisp_Object
, Lisp_Object
,
924 EMACS_INT
, EMACS_INT
, struct it
*, int, int, int, int));
925 static void compute_line_metrics
P_ ((struct it
*));
926 static void run_redisplay_end_trigger_hook
P_ ((struct it
*));
927 static int get_overlay_strings
P_ ((struct it
*, int));
928 static int get_overlay_strings_1
P_ ((struct it
*, int, int));
929 static void next_overlay_string
P_ ((struct it
*));
930 static void reseat
P_ ((struct it
*, struct text_pos
, int));
931 static void reseat_1
P_ ((struct it
*, struct text_pos
, int));
932 static void back_to_previous_visible_line_start
P_ ((struct it
*));
933 void reseat_at_previous_visible_line_start
P_ ((struct it
*));
934 static void reseat_at_next_visible_line_start
P_ ((struct it
*, int));
935 static int next_element_from_ellipsis
P_ ((struct it
*));
936 static int next_element_from_display_vector
P_ ((struct it
*));
937 static int next_element_from_string
P_ ((struct it
*));
938 static int next_element_from_c_string
P_ ((struct it
*));
939 static int next_element_from_buffer
P_ ((struct it
*));
940 static int next_element_from_composition
P_ ((struct it
*));
941 static int next_element_from_image
P_ ((struct it
*));
942 static int next_element_from_stretch
P_ ((struct it
*));
943 static void load_overlay_strings
P_ ((struct it
*, int));
944 static int init_from_display_pos
P_ ((struct it
*, struct window
*,
945 struct display_pos
*));
946 static void reseat_to_string
P_ ((struct it
*, unsigned char *,
947 Lisp_Object
, int, int, int, int));
948 static enum move_it_result
949 move_it_in_display_line_to (struct it
*, EMACS_INT
, int,
950 enum move_operation_enum
);
951 void move_it_vertically_backward
P_ ((struct it
*, int));
952 static void init_to_row_start
P_ ((struct it
*, struct window
*,
953 struct glyph_row
*));
954 static int init_to_row_end
P_ ((struct it
*, struct window
*,
955 struct glyph_row
*));
956 static void back_to_previous_line_start
P_ ((struct it
*));
957 static int forward_to_next_line_start
P_ ((struct it
*, int *));
958 static struct text_pos string_pos_nchars_ahead
P_ ((struct text_pos
,
960 static struct text_pos string_pos
P_ ((int, Lisp_Object
));
961 static struct text_pos c_string_pos
P_ ((int, unsigned char *, int));
962 static int number_of_chars
P_ ((unsigned char *, int));
963 static void compute_stop_pos
P_ ((struct it
*));
964 static void compute_string_pos
P_ ((struct text_pos
*, struct text_pos
,
966 static int face_before_or_after_it_pos
P_ ((struct it
*, int));
967 static EMACS_INT next_overlay_change
P_ ((EMACS_INT
));
968 static int handle_single_display_spec
P_ ((struct it
*, Lisp_Object
,
969 Lisp_Object
, Lisp_Object
,
970 struct text_pos
*, int));
971 static int underlying_face_id
P_ ((struct it
*));
972 static int in_ellipses_for_invisible_text_p
P_ ((struct display_pos
*,
975 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
976 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
978 #ifdef HAVE_WINDOW_SYSTEM
980 static void update_tool_bar
P_ ((struct frame
*, int));
981 static void build_desired_tool_bar_string
P_ ((struct frame
*f
));
982 static int redisplay_tool_bar
P_ ((struct frame
*));
983 static void display_tool_bar_line
P_ ((struct it
*, int));
984 static void notice_overwritten_cursor
P_ ((struct window
*,
986 int, int, int, int));
990 #endif /* HAVE_WINDOW_SYSTEM */
993 /***********************************************************************
994 Window display dimensions
995 ***********************************************************************/
997 /* Return the bottom boundary y-position for text lines in window W.
998 This is the first y position at which a line cannot start.
999 It is relative to the top of the window.
1001 This is the height of W minus the height of a mode line, if any. */
1004 window_text_bottom_y (w
)
1007 int height
= WINDOW_TOTAL_HEIGHT (w
);
1009 if (WINDOW_WANTS_MODELINE_P (w
))
1010 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
1014 /* Return the pixel width of display area AREA of window W. AREA < 0
1015 means return the total width of W, not including fringes to
1016 the left and right of the window. */
1019 window_box_width (w
, area
)
1023 int cols
= XFASTINT (w
->total_cols
);
1026 if (!w
->pseudo_window_p
)
1028 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
1030 if (area
== TEXT_AREA
)
1032 if (INTEGERP (w
->left_margin_cols
))
1033 cols
-= XFASTINT (w
->left_margin_cols
);
1034 if (INTEGERP (w
->right_margin_cols
))
1035 cols
-= XFASTINT (w
->right_margin_cols
);
1036 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
1038 else if (area
== LEFT_MARGIN_AREA
)
1040 cols
= (INTEGERP (w
->left_margin_cols
)
1041 ? XFASTINT (w
->left_margin_cols
) : 0);
1044 else if (area
== RIGHT_MARGIN_AREA
)
1046 cols
= (INTEGERP (w
->right_margin_cols
)
1047 ? XFASTINT (w
->right_margin_cols
) : 0);
1052 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
1056 /* Return the pixel height of the display area of window W, not
1057 including mode lines of W, if any. */
1060 window_box_height (w
)
1063 struct frame
*f
= XFRAME (w
->frame
);
1064 int height
= WINDOW_TOTAL_HEIGHT (w
);
1066 xassert (height
>= 0);
1068 /* Note: the code below that determines the mode-line/header-line
1069 height is essentially the same as that contained in the macro
1070 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
1071 the appropriate glyph row has its `mode_line_p' flag set,
1072 and if it doesn't, uses estimate_mode_line_height instead. */
1074 if (WINDOW_WANTS_MODELINE_P (w
))
1076 struct glyph_row
*ml_row
1077 = (w
->current_matrix
&& w
->current_matrix
->rows
1078 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1080 if (ml_row
&& ml_row
->mode_line_p
)
1081 height
-= ml_row
->height
;
1083 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1086 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1088 struct glyph_row
*hl_row
1089 = (w
->current_matrix
&& w
->current_matrix
->rows
1090 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1092 if (hl_row
&& hl_row
->mode_line_p
)
1093 height
-= hl_row
->height
;
1095 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1098 /* With a very small font and a mode-line that's taller than
1099 default, we might end up with a negative height. */
1100 return max (0, height
);
1103 /* Return the window-relative coordinate of the left edge of display
1104 area AREA of window W. AREA < 0 means return the left edge of the
1105 whole window, to the right of the left fringe of W. */
1108 window_box_left_offset (w
, area
)
1114 if (w
->pseudo_window_p
)
1117 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1119 if (area
== TEXT_AREA
)
1120 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1121 + window_box_width (w
, LEFT_MARGIN_AREA
));
1122 else if (area
== RIGHT_MARGIN_AREA
)
1123 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1124 + window_box_width (w
, LEFT_MARGIN_AREA
)
1125 + window_box_width (w
, TEXT_AREA
)
1126 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1128 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1129 else if (area
== LEFT_MARGIN_AREA
1130 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1131 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1137 /* Return the window-relative coordinate of the right edge of display
1138 area AREA of window W. AREA < 0 means return the left edge of the
1139 whole window, to the left of the right fringe of W. */
1142 window_box_right_offset (w
, area
)
1146 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1149 /* Return the frame-relative coordinate of the left edge of display
1150 area AREA of window W. AREA < 0 means return the left edge of the
1151 whole window, to the right of the left fringe of W. */
1154 window_box_left (w
, area
)
1158 struct frame
*f
= XFRAME (w
->frame
);
1161 if (w
->pseudo_window_p
)
1162 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1164 x
= (WINDOW_LEFT_EDGE_X (w
)
1165 + window_box_left_offset (w
, area
));
1171 /* Return the frame-relative coordinate of the right edge of display
1172 area AREA of window W. AREA < 0 means return the left edge of the
1173 whole window, to the left of the right fringe of W. */
1176 window_box_right (w
, area
)
1180 return window_box_left (w
, area
) + window_box_width (w
, area
);
1183 /* Get the bounding box of the display area AREA of window W, without
1184 mode lines, in frame-relative coordinates. AREA < 0 means the
1185 whole window, not including the left and right fringes of
1186 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1187 coordinates of the upper-left corner of the box. Return in
1188 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1191 window_box (w
, area
, box_x
, box_y
, box_width
, box_height
)
1194 int *box_x
, *box_y
, *box_width
, *box_height
;
1197 *box_width
= window_box_width (w
, area
);
1199 *box_height
= window_box_height (w
);
1201 *box_x
= window_box_left (w
, area
);
1204 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1205 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1206 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1211 /* Get the bounding box of the display area AREA of window W, without
1212 mode lines. AREA < 0 means the whole window, not including the
1213 left and right fringe of the window. Return in *TOP_LEFT_X
1214 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1215 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1216 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1220 window_box_edges (w
, area
, top_left_x
, top_left_y
,
1221 bottom_right_x
, bottom_right_y
)
1224 int *top_left_x
, *top_left_y
, *bottom_right_x
, *bottom_right_y
;
1226 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1228 *bottom_right_x
+= *top_left_x
;
1229 *bottom_right_y
+= *top_left_y
;
1234 /***********************************************************************
1236 ***********************************************************************/
1238 /* Return the bottom y-position of the line the iterator IT is in.
1239 This can modify IT's settings. */
1245 int line_height
= it
->max_ascent
+ it
->max_descent
;
1246 int line_top_y
= it
->current_y
;
1248 if (line_height
== 0)
1251 line_height
= last_height
;
1252 else if (IT_CHARPOS (*it
) < ZV
)
1254 move_it_by_lines (it
, 1, 1);
1255 line_height
= (it
->max_ascent
|| it
->max_descent
1256 ? it
->max_ascent
+ it
->max_descent
1261 struct glyph_row
*row
= it
->glyph_row
;
1263 /* Use the default character height. */
1264 it
->glyph_row
= NULL
;
1265 it
->what
= IT_CHARACTER
;
1268 PRODUCE_GLYPHS (it
);
1269 line_height
= it
->ascent
+ it
->descent
;
1270 it
->glyph_row
= row
;
1274 return line_top_y
+ line_height
;
1278 /* Return 1 if position CHARPOS is visible in window W.
1279 CHARPOS < 0 means return info about WINDOW_END position.
1280 If visible, set *X and *Y to pixel coordinates of top left corner.
1281 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1282 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1285 pos_visible_p (w
, charpos
, x
, y
, rtop
, rbot
, rowh
, vpos
)
1287 int charpos
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
;
1290 struct text_pos top
;
1292 struct buffer
*old_buffer
= NULL
;
1297 if (XBUFFER (w
->buffer
) != current_buffer
)
1299 old_buffer
= current_buffer
;
1300 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1303 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1305 /* Compute exact mode line heights. */
1306 if (WINDOW_WANTS_MODELINE_P (w
))
1307 current_mode_line_height
1308 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1309 current_buffer
->mode_line_format
);
1311 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1312 current_header_line_height
1313 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1314 current_buffer
->header_line_format
);
1316 start_display (&it
, w
, top
);
1317 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1318 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1320 /* Note that we may overshoot because of invisible text. */
1321 if (charpos
>= 0 && IT_CHARPOS (it
) >= charpos
)
1323 int top_x
= it
.current_x
;
1324 int top_y
= it
.current_y
;
1325 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1326 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1328 if (top_y
< window_top_y
)
1329 visible_p
= bottom_y
> window_top_y
;
1330 else if (top_y
< it
.last_visible_y
)
1334 if (it
.method
== GET_FROM_BUFFER
)
1336 Lisp_Object window
, prop
;
1338 XSETWINDOW (window
, w
);
1339 prop
= Fget_char_property (make_number (it
.position
.charpos
),
1340 Qinvisible
, window
);
1342 /* If charpos coincides with invisible text covered with an
1343 ellipsis, use the first glyph of the ellipsis to compute
1344 the pixel positions. */
1345 if (TEXT_PROP_MEANS_INVISIBLE (prop
) == 2)
1347 struct glyph_row
*row
= it
.glyph_row
;
1348 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1349 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
1352 for (; glyph
< end
&& glyph
->charpos
< charpos
; glyph
++)
1353 x
+= glyph
->pixel_width
;
1360 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1361 *rtop
= max (0, window_top_y
- top_y
);
1362 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1363 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1364 - max (top_y
, window_top_y
)));
1373 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1374 move_it_by_lines (&it
, 1, 0);
1375 if (charpos
< IT_CHARPOS (it
)
1376 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1379 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1381 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1382 *rtop
= max (0, -it2
.current_y
);
1383 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1384 - it
.last_visible_y
));
1385 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1387 - max (it2
.current_y
,
1388 WINDOW_HEADER_LINE_HEIGHT (w
))));
1394 set_buffer_internal_1 (old_buffer
);
1396 current_header_line_height
= current_mode_line_height
= -1;
1398 if (visible_p
&& XFASTINT (w
->hscroll
) > 0)
1399 *x
-= XFASTINT (w
->hscroll
) * WINDOW_FRAME_COLUMN_WIDTH (w
);
1402 /* Debugging code. */
1404 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1405 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1407 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1414 /* Return the next character from STR which is MAXLEN bytes long.
1415 Return in *LEN the length of the character. This is like
1416 STRING_CHAR_AND_LENGTH but never returns an invalid character. If
1417 we find one, we return a `?', but with the length of the invalid
1421 string_char_and_length (str
, maxlen
, len
)
1422 const unsigned char *str
;
1427 c
= STRING_CHAR_AND_LENGTH (str
, maxlen
, *len
);
1428 if (!CHAR_VALID_P (c
, 1))
1429 /* We may not change the length here because other places in Emacs
1430 don't use this function, i.e. they silently accept invalid
1439 /* Given a position POS containing a valid character and byte position
1440 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1442 static struct text_pos
1443 string_pos_nchars_ahead (pos
, string
, nchars
)
1444 struct text_pos pos
;
1448 xassert (STRINGP (string
) && nchars
>= 0);
1450 if (STRING_MULTIBYTE (string
))
1452 int rest
= SBYTES (string
) - BYTEPOS (pos
);
1453 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1458 string_char_and_length (p
, rest
, &len
);
1459 p
+= len
, rest
-= len
;
1460 xassert (rest
>= 0);
1462 BYTEPOS (pos
) += len
;
1466 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1472 /* Value is the text position, i.e. character and byte position,
1473 for character position CHARPOS in STRING. */
1475 static INLINE
struct text_pos
1476 string_pos (charpos
, string
)
1480 struct text_pos pos
;
1481 xassert (STRINGP (string
));
1482 xassert (charpos
>= 0);
1483 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1488 /* Value is a text position, i.e. character and byte position, for
1489 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1490 means recognize multibyte characters. */
1492 static struct text_pos
1493 c_string_pos (charpos
, s
, multibyte_p
)
1498 struct text_pos pos
;
1500 xassert (s
!= NULL
);
1501 xassert (charpos
>= 0);
1505 int rest
= strlen (s
), len
;
1507 SET_TEXT_POS (pos
, 0, 0);
1510 string_char_and_length (s
, rest
, &len
);
1511 s
+= len
, rest
-= len
;
1512 xassert (rest
>= 0);
1514 BYTEPOS (pos
) += len
;
1518 SET_TEXT_POS (pos
, charpos
, charpos
);
1524 /* Value is the number of characters in C string S. MULTIBYTE_P
1525 non-zero means recognize multibyte characters. */
1528 number_of_chars (s
, multibyte_p
)
1536 int rest
= strlen (s
), len
;
1537 unsigned char *p
= (unsigned char *) s
;
1539 for (nchars
= 0; rest
> 0; ++nchars
)
1541 string_char_and_length (p
, rest
, &len
);
1542 rest
-= len
, p
+= len
;
1546 nchars
= strlen (s
);
1552 /* Compute byte position NEWPOS->bytepos corresponding to
1553 NEWPOS->charpos. POS is a known position in string STRING.
1554 NEWPOS->charpos must be >= POS.charpos. */
1557 compute_string_pos (newpos
, pos
, string
)
1558 struct text_pos
*newpos
, pos
;
1561 xassert (STRINGP (string
));
1562 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1564 if (STRING_MULTIBYTE (string
))
1565 *newpos
= string_pos_nchars_ahead (pos
, string
,
1566 CHARPOS (*newpos
) - CHARPOS (pos
));
1568 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1572 Return an estimation of the pixel height of mode or top lines on
1573 frame F. FACE_ID specifies what line's height to estimate. */
1576 estimate_mode_line_height (f
, face_id
)
1578 enum face_id face_id
;
1580 #ifdef HAVE_WINDOW_SYSTEM
1581 if (FRAME_WINDOW_P (f
))
1583 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1585 /* This function is called so early when Emacs starts that the face
1586 cache and mode line face are not yet initialized. */
1587 if (FRAME_FACE_CACHE (f
))
1589 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1593 height
= FONT_HEIGHT (face
->font
);
1594 if (face
->box_line_width
> 0)
1595 height
+= 2 * face
->box_line_width
;
1606 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1607 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1608 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1609 not force the value into range. */
1612 pixel_to_glyph_coords (f
, pix_x
, pix_y
, x
, y
, bounds
, noclip
)
1614 register int pix_x
, pix_y
;
1616 NativeRectangle
*bounds
;
1620 #ifdef HAVE_WINDOW_SYSTEM
1621 if (FRAME_WINDOW_P (f
))
1623 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1624 even for negative values. */
1626 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1628 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1630 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1631 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1634 STORE_NATIVE_RECT (*bounds
,
1635 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1636 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1637 FRAME_COLUMN_WIDTH (f
) - 1,
1638 FRAME_LINE_HEIGHT (f
) - 1);
1644 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1645 pix_x
= FRAME_TOTAL_COLS (f
);
1649 else if (pix_y
> FRAME_LINES (f
))
1650 pix_y
= FRAME_LINES (f
);
1660 /* Given HPOS/VPOS in the current matrix of W, return corresponding
1661 frame-relative pixel positions in *FRAME_X and *FRAME_Y. If we
1662 can't tell the positions because W's display is not up to date,
1666 glyph_to_pixel_coords (w
, hpos
, vpos
, frame_x
, frame_y
)
1669 int *frame_x
, *frame_y
;
1671 #ifdef HAVE_WINDOW_SYSTEM
1672 if (FRAME_WINDOW_P (XFRAME (WINDOW_FRAME (w
))))
1676 xassert (hpos
>= 0 && hpos
< w
->current_matrix
->matrix_w
);
1677 xassert (vpos
>= 0 && vpos
< w
->current_matrix
->matrix_h
);
1679 if (display_completed
)
1681 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
1682 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1683 struct glyph
*end
= glyph
+ min (hpos
, row
->used
[TEXT_AREA
]);
1689 hpos
+= glyph
->pixel_width
;
1693 /* If first glyph is partially visible, its first visible position is still 0. */
1705 *frame_x
= WINDOW_TO_FRAME_PIXEL_X (w
, hpos
);
1706 *frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, vpos
);
1717 #ifdef HAVE_WINDOW_SYSTEM
1719 /* Find the glyph under window-relative coordinates X/Y in window W.
1720 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1721 strings. Return in *HPOS and *VPOS the row and column number of
1722 the glyph found. Return in *AREA the glyph area containing X.
1723 Value is a pointer to the glyph found or null if X/Y is not on
1724 text, or we can't tell because W's current matrix is not up to
1731 x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, dx
, dy
, area
)
1734 int *hpos
, *vpos
, *dx
, *dy
, *area
;
1736 struct glyph
*glyph
, *end
;
1737 struct glyph_row
*row
= NULL
;
1740 /* Find row containing Y. Give up if some row is not enabled. */
1741 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1743 row
= MATRIX_ROW (w
->current_matrix
, i
);
1744 if (!row
->enabled_p
)
1746 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1753 /* Give up if Y is not in the window. */
1754 if (i
== w
->current_matrix
->nrows
)
1757 /* Get the glyph area containing X. */
1758 if (w
->pseudo_window_p
)
1765 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1767 *area
= LEFT_MARGIN_AREA
;
1768 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1770 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1773 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1777 *area
= RIGHT_MARGIN_AREA
;
1778 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1782 /* Find glyph containing X. */
1783 glyph
= row
->glyphs
[*area
];
1784 end
= glyph
+ row
->used
[*area
];
1786 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1788 x
-= glyph
->pixel_width
;
1798 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1801 *hpos
= glyph
- row
->glyphs
[*area
];
1807 Convert frame-relative x/y to coordinates relative to window W.
1808 Takes pseudo-windows into account. */
1811 frame_to_window_pixel_xy (w
, x
, y
)
1815 if (w
->pseudo_window_p
)
1817 /* A pseudo-window is always full-width, and starts at the
1818 left edge of the frame, plus a frame border. */
1819 struct frame
*f
= XFRAME (w
->frame
);
1820 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1821 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1825 *x
-= WINDOW_LEFT_EDGE_X (w
);
1826 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1831 Return in RECTS[] at most N clipping rectangles for glyph string S.
1832 Return the number of stored rectangles. */
1835 get_glyph_string_clip_rects (s
, rects
, n
)
1836 struct glyph_string
*s
;
1837 NativeRectangle
*rects
;
1845 if (s
->row
->full_width_p
)
1847 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1848 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1849 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1851 /* Unless displaying a mode or menu bar line, which are always
1852 fully visible, clip to the visible part of the row. */
1853 if (s
->w
->pseudo_window_p
)
1854 r
.height
= s
->row
->visible_height
;
1856 r
.height
= s
->height
;
1860 /* This is a text line that may be partially visible. */
1861 r
.x
= window_box_left (s
->w
, s
->area
);
1862 r
.width
= window_box_width (s
->w
, s
->area
);
1863 r
.height
= s
->row
->visible_height
;
1867 if (r
.x
< s
->clip_head
->x
)
1869 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1870 r
.width
-= s
->clip_head
->x
- r
.x
;
1873 r
.x
= s
->clip_head
->x
;
1876 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1878 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1879 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1884 /* If S draws overlapping rows, it's sufficient to use the top and
1885 bottom of the window for clipping because this glyph string
1886 intentionally draws over other lines. */
1887 if (s
->for_overlaps
)
1889 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1890 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1892 /* Alas, the above simple strategy does not work for the
1893 environments with anti-aliased text: if the same text is
1894 drawn onto the same place multiple times, it gets thicker.
1895 If the overlap we are processing is for the erased cursor, we
1896 take the intersection with the rectagle of the cursor. */
1897 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
1899 XRectangle rc
, r_save
= r
;
1901 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
1902 rc
.y
= s
->w
->phys_cursor
.y
;
1903 rc
.width
= s
->w
->phys_cursor_width
;
1904 rc
.height
= s
->w
->phys_cursor_height
;
1906 x_intersect_rectangles (&r_save
, &rc
, &r
);
1911 /* Don't use S->y for clipping because it doesn't take partially
1912 visible lines into account. For example, it can be negative for
1913 partially visible lines at the top of a window. */
1914 if (!s
->row
->full_width_p
1915 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
1916 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1918 r
.y
= max (0, s
->row
->y
);
1920 /* If drawing a tool-bar window, draw it over the internal border
1921 at the top of the window. */
1922 if (WINDOWP (s
->f
->tool_bar_window
)
1923 && s
->w
== XWINDOW (s
->f
->tool_bar_window
))
1924 r
.y
-= FRAME_INTERNAL_BORDER_WIDTH (s
->f
);
1927 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
1929 /* If drawing the cursor, don't let glyph draw outside its
1930 advertised boundaries. Cleartype does this under some circumstances. */
1931 if (s
->hl
== DRAW_CURSOR
)
1933 struct glyph
*glyph
= s
->first_glyph
;
1938 r
.width
-= s
->x
- r
.x
;
1941 r
.width
= min (r
.width
, glyph
->pixel_width
);
1943 /* If r.y is below window bottom, ensure that we still see a cursor. */
1944 height
= min (glyph
->ascent
+ glyph
->descent
,
1945 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
1946 max_y
= window_text_bottom_y (s
->w
) - height
;
1947 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
1948 if (s
->ybase
- glyph
->ascent
> max_y
)
1955 /* Don't draw cursor glyph taller than our actual glyph. */
1956 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
1957 if (height
< r
.height
)
1959 max_y
= r
.y
+ r
.height
;
1960 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
1961 r
.height
= min (max_y
- r
.y
, height
);
1968 XRectangle r_save
= r
;
1970 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
1974 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
1975 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
1977 #ifdef CONVERT_FROM_XRECT
1978 CONVERT_FROM_XRECT (r
, *rects
);
1986 /* If we are processing overlapping and allowed to return
1987 multiple clipping rectangles, we exclude the row of the glyph
1988 string from the clipping rectangle. This is to avoid drawing
1989 the same text on the environment with anti-aliasing. */
1990 #ifdef CONVERT_FROM_XRECT
1993 XRectangle
*rs
= rects
;
1995 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
1997 if (s
->for_overlaps
& OVERLAPS_PRED
)
2000 if (r
.y
+ r
.height
> row_y
)
2003 rs
[i
].height
= row_y
- r
.y
;
2009 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2012 if (r
.y
< row_y
+ s
->row
->visible_height
)
2014 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2016 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2017 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2026 #ifdef CONVERT_FROM_XRECT
2027 for (i
= 0; i
< n
; i
++)
2028 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2035 Return in *NR the clipping rectangle for glyph string S. */
2038 get_glyph_string_clip_rect (s
, nr
)
2039 struct glyph_string
*s
;
2040 NativeRectangle
*nr
;
2042 get_glyph_string_clip_rects (s
, nr
, 1);
2047 Return the position and height of the phys cursor in window W.
2048 Set w->phys_cursor_width to width of phys cursor.
2052 get_phys_cursor_geometry (w
, row
, glyph
, xp
, yp
, heightp
)
2054 struct glyph_row
*row
;
2055 struct glyph
*glyph
;
2056 int *xp
, *yp
, *heightp
;
2058 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2059 int x
, y
, wd
, h
, h0
, y0
;
2061 /* Compute the width of the rectangle to draw. If on a stretch
2062 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2063 rectangle as wide as the glyph, but use a canonical character
2065 wd
= glyph
->pixel_width
- 1;
2070 x
= w
->phys_cursor
.x
;
2077 if (glyph
->type
== STRETCH_GLYPH
2078 && !x_stretch_cursor_p
)
2079 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2080 w
->phys_cursor_width
= wd
;
2082 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
2084 /* If y is below window bottom, ensure that we still see a cursor. */
2085 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2087 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
2088 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
2090 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2093 h
= max (h
- (y0
- y
) + 1, h0
);
2098 y0
= window_text_bottom_y (w
) - h0
;
2106 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2107 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2112 * Remember which glyph the mouse is over.
2116 remember_mouse_glyph (f
, gx
, gy
, rect
)
2119 NativeRectangle
*rect
;
2123 struct glyph_row
*r
, *gr
, *end_row
;
2124 enum window_part part
;
2125 enum glyph_row_area area
;
2126 int x
, y
, width
, height
;
2128 /* Try to determine frame pixel position and size of the glyph under
2129 frame pixel coordinates X/Y on frame F. */
2131 if (!f
->glyphs_initialized_p
2132 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, &x
, &y
, 0),
2135 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2136 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2140 w
= XWINDOW (window
);
2141 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2142 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2144 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2145 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2147 if (w
->pseudo_window_p
)
2150 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2156 case ON_LEFT_MARGIN
:
2157 area
= LEFT_MARGIN_AREA
;
2160 case ON_RIGHT_MARGIN
:
2161 area
= RIGHT_MARGIN_AREA
;
2164 case ON_HEADER_LINE
:
2166 gr
= (part
== ON_HEADER_LINE
2167 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2168 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2171 goto text_glyph_row_found
;
2178 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2179 if (r
->y
+ r
->height
> y
)
2185 text_glyph_row_found
:
2188 struct glyph
*g
= gr
->glyphs
[area
];
2189 struct glyph
*end
= g
+ gr
->used
[area
];
2191 height
= gr
->height
;
2192 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2193 if (gx
+ g
->pixel_width
> x
)
2198 if (g
->type
== IMAGE_GLYPH
)
2200 /* Don't remember when mouse is over image, as
2201 image may have hot-spots. */
2202 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2205 width
= g
->pixel_width
;
2209 /* Use nominal char spacing at end of line. */
2211 gx
+= (x
/ width
) * width
;
2214 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2215 gx
+= window_box_left_offset (w
, area
);
2219 /* Use nominal line height at end of window. */
2220 gx
= (x
/ width
) * width
;
2222 gy
+= (y
/ height
) * height
;
2226 case ON_LEFT_FRINGE
:
2227 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2228 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2229 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2230 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2233 case ON_RIGHT_FRINGE
:
2234 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2235 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2236 : window_box_right_offset (w
, TEXT_AREA
));
2237 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2241 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2243 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2244 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2245 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2247 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2251 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2252 if (r
->y
+ r
->height
> y
)
2259 height
= gr
->height
;
2262 /* Use nominal line height at end of window. */
2264 gy
+= (y
/ height
) * height
;
2271 /* If there is no glyph under the mouse, then we divide the screen
2272 into a grid of the smallest glyph in the frame, and use that
2275 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2276 round down even for negative values. */
2282 gx
= (gx
/ width
) * width
;
2283 gy
= (gy
/ height
) * height
;
2288 gx
+= WINDOW_LEFT_EDGE_X (w
);
2289 gy
+= WINDOW_TOP_EDGE_Y (w
);
2292 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2294 /* Visible feedback for debugging. */
2297 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2298 f
->output_data
.x
->normal_gc
,
2299 gx
, gy
, width
, height
);
2305 #endif /* HAVE_WINDOW_SYSTEM */
2308 /***********************************************************************
2309 Lisp form evaluation
2310 ***********************************************************************/
2312 /* Error handler for safe_eval and safe_call. */
2315 safe_eval_handler (arg
)
2318 add_to_log ("Error during redisplay: %s", arg
, Qnil
);
2323 /* Evaluate SEXPR and return the result, or nil if something went
2324 wrong. Prevent redisplay during the evaluation. */
2326 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
2327 Return the result, or nil if something went wrong. Prevent
2328 redisplay during the evaluation. */
2331 safe_call (nargs
, args
)
2337 if (inhibit_eval_during_redisplay
)
2341 int count
= SPECPDL_INDEX ();
2342 struct gcpro gcpro1
;
2345 gcpro1
.nvars
= nargs
;
2346 specbind (Qinhibit_redisplay
, Qt
);
2347 /* Use Qt to ensure debugger does not run,
2348 so there is no possibility of wanting to redisplay. */
2349 val
= internal_condition_case_2 (Ffuncall
, nargs
, args
, Qt
,
2352 val
= unbind_to (count
, val
);
2359 /* Call function FN with one argument ARG.
2360 Return the result, or nil if something went wrong. */
2363 safe_call1 (fn
, arg
)
2364 Lisp_Object fn
, arg
;
2366 Lisp_Object args
[2];
2369 return safe_call (2, args
);
2372 static Lisp_Object Qeval
;
2375 safe_eval (Lisp_Object sexpr
)
2377 return safe_call1 (Qeval
, sexpr
);
2380 /* Call function FN with one argument ARG.
2381 Return the result, or nil if something went wrong. */
2384 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2386 Lisp_Object args
[3];
2390 return safe_call (3, args
);
2395 /***********************************************************************
2397 ***********************************************************************/
2401 /* Define CHECK_IT to perform sanity checks on iterators.
2402 This is for debugging. It is too slow to do unconditionally. */
2408 if (it
->method
== GET_FROM_STRING
)
2410 xassert (STRINGP (it
->string
));
2411 xassert (IT_STRING_CHARPOS (*it
) >= 0);
2415 xassert (IT_STRING_CHARPOS (*it
) < 0);
2416 if (it
->method
== GET_FROM_BUFFER
)
2418 /* Check that character and byte positions agree. */
2419 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2424 xassert (it
->current
.dpvec_index
>= 0);
2426 xassert (it
->current
.dpvec_index
< 0);
2429 #define CHECK_IT(IT) check_it ((IT))
2433 #define CHECK_IT(IT) (void) 0
2440 /* Check that the window end of window W is what we expect it
2441 to be---the last row in the current matrix displaying text. */
2444 check_window_end (w
)
2447 if (!MINI_WINDOW_P (w
)
2448 && !NILP (w
->window_end_valid
))
2450 struct glyph_row
*row
;
2451 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
2452 XFASTINT (w
->window_end_vpos
)),
2454 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2455 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2459 #define CHECK_WINDOW_END(W) check_window_end ((W))
2461 #else /* not GLYPH_DEBUG */
2463 #define CHECK_WINDOW_END(W) (void) 0
2465 #endif /* not GLYPH_DEBUG */
2469 /***********************************************************************
2470 Iterator initialization
2471 ***********************************************************************/
2473 /* Initialize IT for displaying current_buffer in window W, starting
2474 at character position CHARPOS. CHARPOS < 0 means that no buffer
2475 position is specified which is useful when the iterator is assigned
2476 a position later. BYTEPOS is the byte position corresponding to
2477 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2479 If ROW is not null, calls to produce_glyphs with IT as parameter
2480 will produce glyphs in that row.
2482 BASE_FACE_ID is the id of a base face to use. It must be one of
2483 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2484 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2485 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2487 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2488 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2489 will be initialized to use the corresponding mode line glyph row of
2490 the desired matrix of W. */
2493 init_iterator (it
, w
, charpos
, bytepos
, row
, base_face_id
)
2496 int charpos
, bytepos
;
2497 struct glyph_row
*row
;
2498 enum face_id base_face_id
;
2500 int highlight_region_p
;
2501 enum face_id remapped_base_face_id
= base_face_id
;
2503 /* Some precondition checks. */
2504 xassert (w
!= NULL
&& it
!= NULL
);
2505 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2508 /* If face attributes have been changed since the last redisplay,
2509 free realized faces now because they depend on face definitions
2510 that might have changed. Don't free faces while there might be
2511 desired matrices pending which reference these faces. */
2512 if (face_change_count
&& !inhibit_free_realized_faces
)
2514 face_change_count
= 0;
2515 free_all_realized_faces (Qnil
);
2518 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2519 if (! NILP (Vface_remapping_alist
))
2520 remapped_base_face_id
= lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2522 /* Use one of the mode line rows of W's desired matrix if
2526 if (base_face_id
== MODE_LINE_FACE_ID
2527 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2528 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2529 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2530 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2534 bzero (it
, sizeof *it
);
2535 it
->current
.overlay_string_index
= -1;
2536 it
->current
.dpvec_index
= -1;
2537 it
->base_face_id
= remapped_base_face_id
;
2539 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2541 /* The window in which we iterate over current_buffer: */
2542 XSETWINDOW (it
->window
, w
);
2544 it
->f
= XFRAME (w
->frame
);
2546 /* Extra space between lines (on window systems only). */
2547 if (base_face_id
== DEFAULT_FACE_ID
2548 && FRAME_WINDOW_P (it
->f
))
2550 if (NATNUMP (current_buffer
->extra_line_spacing
))
2551 it
->extra_line_spacing
= XFASTINT (current_buffer
->extra_line_spacing
);
2552 else if (FLOATP (current_buffer
->extra_line_spacing
))
2553 it
->extra_line_spacing
= (XFLOAT_DATA (current_buffer
->extra_line_spacing
)
2554 * FRAME_LINE_HEIGHT (it
->f
));
2555 else if (it
->f
->extra_line_spacing
> 0)
2556 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2557 it
->max_extra_line_spacing
= 0;
2560 /* If realized faces have been removed, e.g. because of face
2561 attribute changes of named faces, recompute them. When running
2562 in batch mode, the face cache of the initial frame is null. If
2563 we happen to get called, make a dummy face cache. */
2564 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2565 init_frame_faces (it
->f
);
2566 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2567 recompute_basic_faces (it
->f
);
2569 /* Current value of the `slice', `space-width', and 'height' properties. */
2570 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2571 it
->space_width
= Qnil
;
2572 it
->font_height
= Qnil
;
2573 it
->override_ascent
= -1;
2575 /* Are control characters displayed as `^C'? */
2576 it
->ctl_arrow_p
= !NILP (current_buffer
->ctl_arrow
);
2578 /* -1 means everything between a CR and the following line end
2579 is invisible. >0 means lines indented more than this value are
2581 it
->selective
= (INTEGERP (current_buffer
->selective_display
)
2582 ? XFASTINT (current_buffer
->selective_display
)
2583 : (!NILP (current_buffer
->selective_display
)
2585 it
->selective_display_ellipsis_p
2586 = !NILP (current_buffer
->selective_display_ellipses
);
2588 /* Display table to use. */
2589 it
->dp
= window_display_table (w
);
2591 /* Are multibyte characters enabled in current_buffer? */
2592 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
2594 /* Non-zero if we should highlight the region. */
2596 = (!NILP (Vtransient_mark_mode
)
2597 && !NILP (current_buffer
->mark_active
)
2598 && XMARKER (current_buffer
->mark
)->buffer
!= 0);
2600 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2601 start and end of a visible region in window IT->w. Set both to
2602 -1 to indicate no region. */
2603 if (highlight_region_p
2604 /* Maybe highlight only in selected window. */
2605 && (/* Either show region everywhere. */
2606 highlight_nonselected_windows
2607 /* Or show region in the selected window. */
2608 || w
== XWINDOW (selected_window
)
2609 /* Or show the region if we are in the mini-buffer and W is
2610 the window the mini-buffer refers to. */
2611 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2612 && WINDOWP (minibuf_selected_window
)
2613 && w
== XWINDOW (minibuf_selected_window
))))
2615 int charpos
= marker_position (current_buffer
->mark
);
2616 it
->region_beg_charpos
= min (PT
, charpos
);
2617 it
->region_end_charpos
= max (PT
, charpos
);
2620 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2622 /* Get the position at which the redisplay_end_trigger hook should
2623 be run, if it is to be run at all. */
2624 if (MARKERP (w
->redisplay_end_trigger
)
2625 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2626 it
->redisplay_end_trigger_charpos
2627 = marker_position (w
->redisplay_end_trigger
);
2628 else if (INTEGERP (w
->redisplay_end_trigger
))
2629 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
2631 /* Correct bogus values of tab_width. */
2632 it
->tab_width
= XINT (current_buffer
->tab_width
);
2633 if (it
->tab_width
<= 0 || it
->tab_width
> 1000)
2636 /* Are lines in the display truncated? */
2637 if (base_face_id
!= DEFAULT_FACE_ID
2638 || XINT (it
->w
->hscroll
)
2639 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2640 && ((!NILP (Vtruncate_partial_width_windows
)
2641 && !INTEGERP (Vtruncate_partial_width_windows
))
2642 || (INTEGERP (Vtruncate_partial_width_windows
)
2643 && (WINDOW_TOTAL_COLS (it
->w
)
2644 < XINT (Vtruncate_partial_width_windows
))))))
2645 it
->line_wrap
= TRUNCATE
;
2646 else if (NILP (current_buffer
->truncate_lines
))
2647 it
->line_wrap
= NILP (current_buffer
->word_wrap
)
2648 ? WINDOW_WRAP
: WORD_WRAP
;
2650 it
->line_wrap
= TRUNCATE
;
2652 /* Get dimensions of truncation and continuation glyphs. These are
2653 displayed as fringe bitmaps under X, so we don't need them for such
2655 if (!FRAME_WINDOW_P (it
->f
))
2657 if (it
->line_wrap
== TRUNCATE
)
2659 /* We will need the truncation glyph. */
2660 xassert (it
->glyph_row
== NULL
);
2661 produce_special_glyphs (it
, IT_TRUNCATION
);
2662 it
->truncation_pixel_width
= it
->pixel_width
;
2666 /* We will need the continuation glyph. */
2667 xassert (it
->glyph_row
== NULL
);
2668 produce_special_glyphs (it
, IT_CONTINUATION
);
2669 it
->continuation_pixel_width
= it
->pixel_width
;
2672 /* Reset these values to zero because the produce_special_glyphs
2673 above has changed them. */
2674 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2675 it
->phys_ascent
= it
->phys_descent
= 0;
2678 /* Set this after getting the dimensions of truncation and
2679 continuation glyphs, so that we don't produce glyphs when calling
2680 produce_special_glyphs, above. */
2681 it
->glyph_row
= row
;
2682 it
->area
= TEXT_AREA
;
2684 /* Get the dimensions of the display area. The display area
2685 consists of the visible window area plus a horizontally scrolled
2686 part to the left of the window. All x-values are relative to the
2687 start of this total display area. */
2688 if (base_face_id
!= DEFAULT_FACE_ID
)
2690 /* Mode lines, menu bar in terminal frames. */
2691 it
->first_visible_x
= 0;
2692 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2697 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2698 it
->last_visible_x
= (it
->first_visible_x
2699 + window_box_width (w
, TEXT_AREA
));
2701 /* If we truncate lines, leave room for the truncator glyph(s) at
2702 the right margin. Otherwise, leave room for the continuation
2703 glyph(s). Truncation and continuation glyphs are not inserted
2704 for window-based redisplay. */
2705 if (!FRAME_WINDOW_P (it
->f
))
2707 if (it
->line_wrap
== TRUNCATE
)
2708 it
->last_visible_x
-= it
->truncation_pixel_width
;
2710 it
->last_visible_x
-= it
->continuation_pixel_width
;
2713 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2714 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2717 /* Leave room for a border glyph. */
2718 if (!FRAME_WINDOW_P (it
->f
)
2719 && !WINDOW_RIGHTMOST_P (it
->w
))
2720 it
->last_visible_x
-= 1;
2722 it
->last_visible_y
= window_text_bottom_y (w
);
2724 /* For mode lines and alike, arrange for the first glyph having a
2725 left box line if the face specifies a box. */
2726 if (base_face_id
!= DEFAULT_FACE_ID
)
2730 it
->face_id
= remapped_base_face_id
;
2732 /* If we have a boxed mode line, make the first character appear
2733 with a left box line. */
2734 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2735 if (face
->box
!= FACE_NO_BOX
)
2736 it
->start_of_box_run_p
= 1;
2739 /* If a buffer position was specified, set the iterator there,
2740 getting overlays and face properties from that position. */
2741 if (charpos
>= BUF_BEG (current_buffer
))
2743 it
->end_charpos
= ZV
;
2745 IT_CHARPOS (*it
) = charpos
;
2747 /* Compute byte position if not specified. */
2748 if (bytepos
< charpos
)
2749 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2751 IT_BYTEPOS (*it
) = bytepos
;
2753 it
->start
= it
->current
;
2755 /* Compute faces etc. */
2756 reseat (it
, it
->current
.pos
, 1);
2763 /* Initialize IT for the display of window W with window start POS. */
2766 start_display (it
, w
, pos
)
2769 struct text_pos pos
;
2771 struct glyph_row
*row
;
2772 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2774 row
= w
->desired_matrix
->rows
+ first_vpos
;
2775 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2776 it
->first_vpos
= first_vpos
;
2778 /* Don't reseat to previous visible line start if current start
2779 position is in a string or image. */
2780 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2782 int start_at_line_beg_p
;
2783 int first_y
= it
->current_y
;
2785 /* If window start is not at a line start, skip forward to POS to
2786 get the correct continuation lines width. */
2787 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2788 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2789 if (!start_at_line_beg_p
)
2793 reseat_at_previous_visible_line_start (it
);
2794 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2796 new_x
= it
->current_x
+ it
->pixel_width
;
2798 /* If lines are continued, this line may end in the middle
2799 of a multi-glyph character (e.g. a control character
2800 displayed as \003, or in the middle of an overlay
2801 string). In this case move_it_to above will not have
2802 taken us to the start of the continuation line but to the
2803 end of the continued line. */
2804 if (it
->current_x
> 0
2805 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2806 && (/* And glyph doesn't fit on the line. */
2807 new_x
> it
->last_visible_x
2808 /* Or it fits exactly and we're on a window
2810 || (new_x
== it
->last_visible_x
2811 && FRAME_WINDOW_P (it
->f
))))
2813 if (it
->current
.dpvec_index
>= 0
2814 || it
->current
.overlay_string_index
>= 0)
2816 set_iterator_to_next (it
, 1);
2817 move_it_in_display_line_to (it
, -1, -1, 0);
2820 it
->continuation_lines_width
+= it
->current_x
;
2823 /* We're starting a new display line, not affected by the
2824 height of the continued line, so clear the appropriate
2825 fields in the iterator structure. */
2826 it
->max_ascent
= it
->max_descent
= 0;
2827 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2829 it
->current_y
= first_y
;
2831 it
->current_x
= it
->hpos
= 0;
2835 #if 0 /* Don't assert the following because start_display is sometimes
2836 called intentionally with a window start that is not at a
2837 line start. Please leave this code in as a comment. */
2839 /* Window start should be on a line start, now. */
2840 xassert (it
->continuation_lines_width
2841 || IT_CHARPOS (it
) == BEGV
2842 || FETCH_BYTE (IT_BYTEPOS (it
) - 1) == '\n');
2847 /* Return 1 if POS is a position in ellipses displayed for invisible
2848 text. W is the window we display, for text property lookup. */
2851 in_ellipses_for_invisible_text_p (pos
, w
)
2852 struct display_pos
*pos
;
2855 Lisp_Object prop
, window
;
2857 int charpos
= CHARPOS (pos
->pos
);
2859 /* If POS specifies a position in a display vector, this might
2860 be for an ellipsis displayed for invisible text. We won't
2861 get the iterator set up for delivering that ellipsis unless
2862 we make sure that it gets aware of the invisible text. */
2863 if (pos
->dpvec_index
>= 0
2864 && pos
->overlay_string_index
< 0
2865 && CHARPOS (pos
->string_pos
) < 0
2867 && (XSETWINDOW (window
, w
),
2868 prop
= Fget_char_property (make_number (charpos
),
2869 Qinvisible
, window
),
2870 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2872 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2874 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2881 /* Initialize IT for stepping through current_buffer in window W,
2882 starting at position POS that includes overlay string and display
2883 vector/ control character translation position information. Value
2884 is zero if there are overlay strings with newlines at POS. */
2887 init_from_display_pos (it
, w
, pos
)
2890 struct display_pos
*pos
;
2892 int charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
2893 int i
, overlay_strings_with_newlines
= 0;
2895 /* If POS specifies a position in a display vector, this might
2896 be for an ellipsis displayed for invisible text. We won't
2897 get the iterator set up for delivering that ellipsis unless
2898 we make sure that it gets aware of the invisible text. */
2899 if (in_ellipses_for_invisible_text_p (pos
, w
))
2905 /* Keep in mind: the call to reseat in init_iterator skips invisible
2906 text, so we might end up at a position different from POS. This
2907 is only a problem when POS is a row start after a newline and an
2908 overlay starts there with an after-string, and the overlay has an
2909 invisible property. Since we don't skip invisible text in
2910 display_line and elsewhere immediately after consuming the
2911 newline before the row start, such a POS will not be in a string,
2912 but the call to init_iterator below will move us to the
2914 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
2916 /* This only scans the current chunk -- it should scan all chunks.
2917 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
2918 to 16 in 22.1 to make this a lesser problem. */
2919 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
2921 const char *s
= SDATA (it
->overlay_strings
[i
]);
2922 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
2924 while (s
< e
&& *s
!= '\n')
2929 overlay_strings_with_newlines
= 1;
2934 /* If position is within an overlay string, set up IT to the right
2936 if (pos
->overlay_string_index
>= 0)
2940 /* If the first overlay string happens to have a `display'
2941 property for an image, the iterator will be set up for that
2942 image, and we have to undo that setup first before we can
2943 correct the overlay string index. */
2944 if (it
->method
== GET_FROM_IMAGE
)
2947 /* We already have the first chunk of overlay strings in
2948 IT->overlay_strings. Load more until the one for
2949 pos->overlay_string_index is in IT->overlay_strings. */
2950 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
2952 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
2953 it
->current
.overlay_string_index
= 0;
2956 load_overlay_strings (it
, 0);
2957 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
2961 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
2962 relative_index
= (it
->current
.overlay_string_index
2963 % OVERLAY_STRING_CHUNK_SIZE
);
2964 it
->string
= it
->overlay_strings
[relative_index
];
2965 xassert (STRINGP (it
->string
));
2966 it
->current
.string_pos
= pos
->string_pos
;
2967 it
->method
= GET_FROM_STRING
;
2970 #if 0 /* This is bogus because POS not having an overlay string
2971 position does not mean it's after the string. Example: A
2972 line starting with a before-string and initialization of IT
2973 to the previous row's end position. */
2974 else if (it
->current
.overlay_string_index
>= 0)
2976 /* If POS says we're already after an overlay string ending at
2977 POS, make sure to pop the iterator because it will be in
2978 front of that overlay string. When POS is ZV, we've thereby
2979 also ``processed'' overlay strings at ZV. */
2982 xassert (it
->current
.overlay_string_index
== -1);
2983 xassert (it
->method
== GET_FROM_BUFFER
);
2984 if (CHARPOS (pos
->pos
) == ZV
)
2985 it
->overlay_strings_at_end_processed_p
= 1;
2989 if (CHARPOS (pos
->string_pos
) >= 0)
2991 /* Recorded position is not in an overlay string, but in another
2992 string. This can only be a string from a `display' property.
2993 IT should already be filled with that string. */
2994 it
->current
.string_pos
= pos
->string_pos
;
2995 xassert (STRINGP (it
->string
));
2998 /* Restore position in display vector translations, control
2999 character translations or ellipses. */
3000 if (pos
->dpvec_index
>= 0)
3002 if (it
->dpvec
== NULL
)
3003 get_next_display_element (it
);
3004 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3005 it
->current
.dpvec_index
= pos
->dpvec_index
;
3009 return !overlay_strings_with_newlines
;
3013 /* Initialize IT for stepping through current_buffer in window W
3014 starting at ROW->start. */
3017 init_to_row_start (it
, w
, row
)
3020 struct glyph_row
*row
;
3022 init_from_display_pos (it
, w
, &row
->start
);
3023 it
->start
= row
->start
;
3024 it
->continuation_lines_width
= row
->continuation_lines_width
;
3029 /* Initialize IT for stepping through current_buffer in window W
3030 starting in the line following ROW, i.e. starting at ROW->end.
3031 Value is zero if there are overlay strings with newlines at ROW's
3035 init_to_row_end (it
, w
, row
)
3038 struct glyph_row
*row
;
3042 if (init_from_display_pos (it
, w
, &row
->end
))
3044 if (row
->continued_p
)
3045 it
->continuation_lines_width
3046 = row
->continuation_lines_width
+ row
->pixel_width
;
3057 /***********************************************************************
3059 ***********************************************************************/
3061 /* Called when IT reaches IT->stop_charpos. Handle text property and
3062 overlay changes. Set IT->stop_charpos to the next position where
3069 enum prop_handled handled
;
3070 int handle_overlay_change_p
;
3074 it
->current
.dpvec_index
= -1;
3075 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3076 it
->ignore_overlay_strings_at_pos_p
= 0;
3078 /* Use face of preceding text for ellipsis (if invisible) */
3079 if (it
->selective_display_ellipsis_p
)
3080 it
->saved_face_id
= it
->face_id
;
3084 handled
= HANDLED_NORMALLY
;
3086 /* Call text property handlers. */
3087 for (p
= it_props
; p
->handler
; ++p
)
3089 handled
= p
->handler (it
);
3091 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3093 else if (handled
== HANDLED_RETURN
)
3095 /* We still want to show before and after strings from
3096 overlays even if the actual buffer text is replaced. */
3097 if (!handle_overlay_change_p
|| it
->sp
> 1)
3099 if (!get_overlay_strings_1 (it
, 0, 0))
3101 it
->ignore_overlay_strings_at_pos_p
= 1;
3102 it
->string_from_display_prop_p
= 0;
3103 handle_overlay_change_p
= 0;
3104 handled
= HANDLED_RECOMPUTE_PROPS
;
3107 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3108 handle_overlay_change_p
= 0;
3111 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3113 /* Don't check for overlay strings below when set to deliver
3114 characters from a display vector. */
3115 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3116 handle_overlay_change_p
= 0;
3118 /* Handle overlay changes.
3119 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3120 if it finds overlays. */
3121 if (handle_overlay_change_p
)
3122 handled
= handle_overlay_change (it
);
3125 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3127 /* Determine where to stop next. */
3128 if (handled
== HANDLED_NORMALLY
)
3129 compute_stop_pos (it
);
3133 /* Compute IT->stop_charpos from text property and overlay change
3134 information for IT's current position. */
3137 compute_stop_pos (it
)
3140 register INTERVAL iv
, next_iv
;
3141 Lisp_Object object
, limit
, position
;
3143 /* If nowhere else, stop at the end. */
3144 it
->stop_charpos
= it
->end_charpos
;
3146 if (STRINGP (it
->string
))
3148 /* Strings are usually short, so don't limit the search for
3150 object
= it
->string
;
3152 position
= make_number (IT_STRING_CHARPOS (*it
));
3158 /* If next overlay change is in front of the current stop pos
3159 (which is IT->end_charpos), stop there. Note: value of
3160 next_overlay_change is point-max if no overlay change
3162 charpos
= next_overlay_change (IT_CHARPOS (*it
));
3163 if (charpos
< it
->stop_charpos
)
3164 it
->stop_charpos
= charpos
;
3166 /* If showing the region, we have to stop at the region
3167 start or end because the face might change there. */
3168 if (it
->region_beg_charpos
> 0)
3170 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3171 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3172 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3173 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3176 /* Set up variables for computing the stop position from text
3177 property changes. */
3178 XSETBUFFER (object
, current_buffer
);
3179 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3180 position
= make_number (IT_CHARPOS (*it
));
3184 /* Get the interval containing IT's position. Value is a null
3185 interval if there isn't such an interval. */
3186 iv
= validate_interval_range (object
, &position
, &position
, 0);
3187 if (!NULL_INTERVAL_P (iv
))
3189 Lisp_Object values_here
[LAST_PROP_IDX
];
3192 /* Get properties here. */
3193 for (p
= it_props
; p
->handler
; ++p
)
3194 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3196 /* Look for an interval following iv that has different
3198 for (next_iv
= next_interval (iv
);
3199 (!NULL_INTERVAL_P (next_iv
)
3201 || XFASTINT (limit
) > next_iv
->position
));
3202 next_iv
= next_interval (next_iv
))
3204 for (p
= it_props
; p
->handler
; ++p
)
3206 Lisp_Object new_value
;
3208 new_value
= textget (next_iv
->plist
, *p
->name
);
3209 if (!EQ (values_here
[p
->idx
], new_value
))
3217 if (!NULL_INTERVAL_P (next_iv
))
3219 if (INTEGERP (limit
)
3220 && next_iv
->position
>= XFASTINT (limit
))
3221 /* No text property change up to limit. */
3222 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3224 /* Text properties change in next_iv. */
3225 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3229 xassert (STRINGP (it
->string
)
3230 || (it
->stop_charpos
>= BEGV
3231 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3235 /* Return the position of the next overlay change after POS in
3236 current_buffer. Value is point-max if no overlay change
3237 follows. This is like `next-overlay-change' but doesn't use
3241 next_overlay_change (pos
)
3246 Lisp_Object
*overlays
;
3249 /* Get all overlays at the given position. */
3250 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3252 /* If any of these overlays ends before endpos,
3253 use its ending point instead. */
3254 for (i
= 0; i
< noverlays
; ++i
)
3259 oend
= OVERLAY_END (overlays
[i
]);
3260 oendpos
= OVERLAY_POSITION (oend
);
3261 endpos
= min (endpos
, oendpos
);
3269 /***********************************************************************
3271 ***********************************************************************/
3273 /* Handle changes in the `fontified' property of the current buffer by
3274 calling hook functions from Qfontification_functions to fontify
3277 static enum prop_handled
3278 handle_fontified_prop (it
)
3281 Lisp_Object prop
, pos
;
3282 enum prop_handled handled
= HANDLED_NORMALLY
;
3284 if (!NILP (Vmemory_full
))
3287 /* Get the value of the `fontified' property at IT's current buffer
3288 position. (The `fontified' property doesn't have a special
3289 meaning in strings.) If the value is nil, call functions from
3290 Qfontification_functions. */
3291 if (!STRINGP (it
->string
)
3293 && !NILP (Vfontification_functions
)
3294 && !NILP (Vrun_hooks
)
3295 && (pos
= make_number (IT_CHARPOS (*it
)),
3296 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3297 /* Ignore the special cased nil value always present at EOB since
3298 no amount of fontifying will be able to change it. */
3299 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3301 int count
= SPECPDL_INDEX ();
3304 val
= Vfontification_functions
;
3305 specbind (Qfontification_functions
, Qnil
);
3307 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3308 safe_call1 (val
, pos
);
3311 Lisp_Object globals
, fn
;
3312 struct gcpro gcpro1
, gcpro2
;
3315 GCPRO2 (val
, globals
);
3317 for (; CONSP (val
); val
= XCDR (val
))
3323 /* A value of t indicates this hook has a local
3324 binding; it means to run the global binding too.
3325 In a global value, t should not occur. If it
3326 does, we must ignore it to avoid an endless
3328 for (globals
= Fdefault_value (Qfontification_functions
);
3330 globals
= XCDR (globals
))
3332 fn
= XCAR (globals
);
3334 safe_call1 (fn
, pos
);
3338 safe_call1 (fn
, pos
);
3344 unbind_to (count
, Qnil
);
3346 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3347 something. This avoids an endless loop if they failed to
3348 fontify the text for which reason ever. */
3349 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3350 handled
= HANDLED_RECOMPUTE_PROPS
;
3358 /***********************************************************************
3360 ***********************************************************************/
3362 /* Set up iterator IT from face properties at its current position.
3363 Called from handle_stop. */
3365 static enum prop_handled
3366 handle_face_prop (it
)
3370 EMACS_INT next_stop
;
3372 if (!STRINGP (it
->string
))
3375 = face_at_buffer_position (it
->w
,
3377 it
->region_beg_charpos
,
3378 it
->region_end_charpos
,
3381 + TEXT_PROP_DISTANCE_LIMIT
),
3384 /* Is this a start of a run of characters with box face?
3385 Caveat: this can be called for a freshly initialized
3386 iterator; face_id is -1 in this case. We know that the new
3387 face will not change until limit, i.e. if the new face has a
3388 box, all characters up to limit will have one. But, as
3389 usual, we don't know whether limit is really the end. */
3390 if (new_face_id
!= it
->face_id
)
3392 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3394 /* If new face has a box but old face has not, this is
3395 the start of a run of characters with box, i.e. it has
3396 a shadow on the left side. The value of face_id of the
3397 iterator will be -1 if this is the initial call that gets
3398 the face. In this case, we have to look in front of IT's
3399 position and see whether there is a face != new_face_id. */
3400 it
->start_of_box_run_p
3401 = (new_face
->box
!= FACE_NO_BOX
3402 && (it
->face_id
>= 0
3403 || IT_CHARPOS (*it
) == BEG
3404 || new_face_id
!= face_before_it_pos (it
)));
3405 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3410 int base_face_id
, bufpos
;
3412 Lisp_Object from_overlay
3413 = (it
->current
.overlay_string_index
>= 0
3414 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3417 /* See if we got to this string directly or indirectly from
3418 an overlay property. That includes the before-string or
3419 after-string of an overlay, strings in display properties
3420 provided by an overlay, their text properties, etc.
3422 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3423 if (! NILP (from_overlay
))
3424 for (i
= it
->sp
- 1; i
>= 0; i
--)
3426 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3428 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3429 else if (! NILP (it
->stack
[i
].from_overlay
))
3430 from_overlay
= it
->stack
[i
].from_overlay
;
3432 if (!NILP (from_overlay
))
3436 if (! NILP (from_overlay
))
3438 bufpos
= IT_CHARPOS (*it
);
3439 /* For a string from an overlay, the base face depends
3440 only on text properties and ignores overlays. */
3442 = face_for_overlay_string (it
->w
,
3444 it
->region_beg_charpos
,
3445 it
->region_end_charpos
,
3448 + TEXT_PROP_DISTANCE_LIMIT
),
3456 /* For strings from a `display' property, use the face at
3457 IT's current buffer position as the base face to merge
3458 with, so that overlay strings appear in the same face as
3459 surrounding text, unless they specify their own
3461 base_face_id
= underlying_face_id (it
);
3464 new_face_id
= face_at_string_position (it
->w
,
3466 IT_STRING_CHARPOS (*it
),
3468 it
->region_beg_charpos
,
3469 it
->region_end_charpos
,
3473 #if 0 /* This shouldn't be neccessary. Let's check it. */
3474 /* If IT is used to display a mode line we would really like to
3475 use the mode line face instead of the frame's default face. */
3476 if (it
->glyph_row
== MATRIX_MODE_LINE_ROW (it
->w
->desired_matrix
)
3477 && new_face_id
== DEFAULT_FACE_ID
)
3478 new_face_id
= CURRENT_MODE_LINE_FACE_ID (it
->w
);
3481 /* Is this a start of a run of characters with box? Caveat:
3482 this can be called for a freshly allocated iterator; face_id
3483 is -1 is this case. We know that the new face will not
3484 change until the next check pos, i.e. if the new face has a
3485 box, all characters up to that position will have a
3486 box. But, as usual, we don't know whether that position
3487 is really the end. */
3488 if (new_face_id
!= it
->face_id
)
3490 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3491 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3493 /* If new face has a box but old face hasn't, this is the
3494 start of a run of characters with box, i.e. it has a
3495 shadow on the left side. */
3496 it
->start_of_box_run_p
3497 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3498 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3502 it
->face_id
= new_face_id
;
3503 return HANDLED_NORMALLY
;
3507 /* Return the ID of the face ``underlying'' IT's current position,
3508 which is in a string. If the iterator is associated with a
3509 buffer, return the face at IT's current buffer position.
3510 Otherwise, use the iterator's base_face_id. */
3513 underlying_face_id (it
)
3516 int face_id
= it
->base_face_id
, i
;
3518 xassert (STRINGP (it
->string
));
3520 for (i
= it
->sp
- 1; i
>= 0; --i
)
3521 if (NILP (it
->stack
[i
].string
))
3522 face_id
= it
->stack
[i
].face_id
;
3528 /* Compute the face one character before or after the current position
3529 of IT. BEFORE_P non-zero means get the face in front of IT's
3530 position. Value is the id of the face. */
3533 face_before_or_after_it_pos (it
, before_p
)
3538 EMACS_INT next_check_charpos
;
3539 struct text_pos pos
;
3541 xassert (it
->s
== NULL
);
3543 if (STRINGP (it
->string
))
3545 int bufpos
, base_face_id
;
3547 /* No face change past the end of the string (for the case
3548 we are padding with spaces). No face change before the
3550 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3551 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3554 /* Set pos to the position before or after IT's current position. */
3556 pos
= string_pos (IT_STRING_CHARPOS (*it
) - 1, it
->string
);
3558 /* For composition, we must check the character after the
3560 pos
= (it
->what
== IT_COMPOSITION
3561 ? string_pos (IT_STRING_CHARPOS (*it
) + it
->cmp_len
, it
->string
)
3562 : string_pos (IT_STRING_CHARPOS (*it
) + 1, it
->string
));
3564 if (it
->current
.overlay_string_index
>= 0)
3565 bufpos
= IT_CHARPOS (*it
);
3569 base_face_id
= underlying_face_id (it
);
3571 /* Get the face for ASCII, or unibyte. */
3572 face_id
= face_at_string_position (it
->w
,
3576 it
->region_beg_charpos
,
3577 it
->region_end_charpos
,
3578 &next_check_charpos
,
3581 /* Correct the face for charsets different from ASCII. Do it
3582 for the multibyte case only. The face returned above is
3583 suitable for unibyte text if IT->string is unibyte. */
3584 if (STRING_MULTIBYTE (it
->string
))
3586 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos
);
3587 int rest
= SBYTES (it
->string
) - BYTEPOS (pos
);
3589 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3591 c
= string_char_and_length (p
, rest
, &len
);
3592 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), it
->string
);
3597 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3598 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3601 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3602 pos
= it
->current
.pos
;
3605 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3608 if (it
->what
== IT_COMPOSITION
)
3609 /* For composition, we must check the position after the
3611 pos
.charpos
+= it
->cmp_len
, pos
.bytepos
+= it
->len
;
3613 INC_TEXT_POS (pos
, it
->multibyte_p
);
3616 /* Determine face for CHARSET_ASCII, or unibyte. */
3617 face_id
= face_at_buffer_position (it
->w
,
3619 it
->region_beg_charpos
,
3620 it
->region_end_charpos
,
3621 &next_check_charpos
,
3624 /* Correct the face for charsets different from ASCII. Do it
3625 for the multibyte case only. The face returned above is
3626 suitable for unibyte text if current_buffer is unibyte. */
3627 if (it
->multibyte_p
)
3629 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3630 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3631 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3640 /***********************************************************************
3642 ***********************************************************************/
3644 /* Set up iterator IT from invisible properties at its current
3645 position. Called from handle_stop. */
3647 static enum prop_handled
3648 handle_invisible_prop (it
)
3651 enum prop_handled handled
= HANDLED_NORMALLY
;
3653 if (STRINGP (it
->string
))
3655 extern Lisp_Object Qinvisible
;
3656 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3658 /* Get the value of the invisible text property at the
3659 current position. Value will be nil if there is no such
3661 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3662 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3665 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3667 handled
= HANDLED_RECOMPUTE_PROPS
;
3669 /* Get the position at which the next change of the
3670 invisible text property can be found in IT->string.
3671 Value will be nil if the property value is the same for
3672 all the rest of IT->string. */
3673 XSETINT (limit
, SCHARS (it
->string
));
3674 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3677 /* Text at current position is invisible. The next
3678 change in the property is at position end_charpos.
3679 Move IT's current position to that position. */
3680 if (INTEGERP (end_charpos
)
3681 && XFASTINT (end_charpos
) < XFASTINT (limit
))
3683 struct text_pos old
;
3684 old
= it
->current
.string_pos
;
3685 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3686 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
3690 /* The rest of the string is invisible. If this is an
3691 overlay string, proceed with the next overlay string
3692 or whatever comes and return a character from there. */
3693 if (it
->current
.overlay_string_index
>= 0)
3695 next_overlay_string (it
);
3696 /* Don't check for overlay strings when we just
3697 finished processing them. */
3698 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
3702 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
3703 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
3711 EMACS_INT newpos
, next_stop
, start_charpos
;
3712 Lisp_Object pos
, prop
, overlay
;
3714 /* First of all, is there invisible text at this position? */
3715 start_charpos
= IT_CHARPOS (*it
);
3716 pos
= make_number (IT_CHARPOS (*it
));
3717 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
3719 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3721 /* If we are on invisible text, skip over it. */
3722 if (invis_p
&& IT_CHARPOS (*it
) < it
->end_charpos
)
3724 /* Record whether we have to display an ellipsis for the
3726 int display_ellipsis_p
= invis_p
== 2;
3728 handled
= HANDLED_RECOMPUTE_PROPS
;
3730 /* Loop skipping over invisible text. The loop is left at
3731 ZV or with IT on the first char being visible again. */
3734 /* Try to skip some invisible text. Return value is the
3735 position reached which can be equal to IT's position
3736 if there is nothing invisible here. This skips both
3737 over invisible text properties and overlays with
3738 invisible property. */
3739 newpos
= skip_invisible (IT_CHARPOS (*it
),
3740 &next_stop
, ZV
, it
->window
);
3742 /* If we skipped nothing at all we weren't at invisible
3743 text in the first place. If everything to the end of
3744 the buffer was skipped, end the loop. */
3745 if (newpos
== IT_CHARPOS (*it
) || newpos
>= ZV
)
3749 /* We skipped some characters but not necessarily
3750 all there are. Check if we ended up on visible
3751 text. Fget_char_property returns the property of
3752 the char before the given position, i.e. if we
3753 get invis_p = 0, this means that the char at
3754 newpos is visible. */
3755 pos
= make_number (newpos
);
3756 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
3757 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3760 /* If we ended up on invisible text, proceed to
3761 skip starting with next_stop. */
3763 IT_CHARPOS (*it
) = next_stop
;
3765 /* If there are adjacent invisible texts, don't lose the
3766 second one's ellipsis. */
3768 display_ellipsis_p
= 1;
3772 /* The position newpos is now either ZV or on visible text. */
3773 IT_CHARPOS (*it
) = newpos
;
3774 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
3776 /* If there are before-strings at the start of invisible
3777 text, and the text is invisible because of a text
3778 property, arrange to show before-strings because 20.x did
3779 it that way. (If the text is invisible because of an
3780 overlay property instead of a text property, this is
3781 already handled in the overlay code.) */
3783 && get_overlay_strings (it
, start_charpos
))
3785 handled
= HANDLED_RECOMPUTE_PROPS
;
3786 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
3788 else if (display_ellipsis_p
)
3790 /* Make sure that the glyphs of the ellipsis will get
3791 correct `charpos' values. If we would not update
3792 it->position here, the glyphs would belong to the
3793 last visible character _before_ the invisible
3794 text, which confuses `set_cursor_from_row'.
3796 We use the last invisible position instead of the
3797 first because this way the cursor is always drawn on
3798 the first "." of the ellipsis, whenever PT is inside
3799 the invisible text. Otherwise the cursor would be
3800 placed _after_ the ellipsis when the point is after the
3801 first invisible character. */
3802 if (!STRINGP (it
->object
))
3804 it
->position
.charpos
= IT_CHARPOS (*it
) - 1;
3805 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
3807 setup_for_ellipsis (it
, 0);
3808 /* Let the ellipsis display before
3809 considering any properties of the following char.
3810 Fixes jasonr@gnu.org 01 Oct 07 bug. */
3811 handled
= HANDLED_RETURN
;
3820 /* Make iterator IT return `...' next.
3821 Replaces LEN characters from buffer. */
3824 setup_for_ellipsis (it
, len
)
3828 /* Use the display table definition for `...'. Invalid glyphs
3829 will be handled by the method returning elements from dpvec. */
3830 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
3832 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
3833 it
->dpvec
= v
->contents
;
3834 it
->dpend
= v
->contents
+ v
->size
;
3838 /* Default `...'. */
3839 it
->dpvec
= default_invis_vector
;
3840 it
->dpend
= default_invis_vector
+ 3;
3843 it
->dpvec_char_len
= len
;
3844 it
->current
.dpvec_index
= 0;
3845 it
->dpvec_face_id
= -1;
3847 /* Remember the current face id in case glyphs specify faces.
3848 IT's face is restored in set_iterator_to_next.
3849 saved_face_id was set to preceding char's face in handle_stop. */
3850 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
3851 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
3853 it
->method
= GET_FROM_DISPLAY_VECTOR
;
3859 /***********************************************************************
3861 ***********************************************************************/
3863 /* Set up iterator IT from `display' property at its current position.
3864 Called from handle_stop.
3865 We return HANDLED_RETURN if some part of the display property
3866 overrides the display of the buffer text itself.
3867 Otherwise we return HANDLED_NORMALLY. */
3869 static enum prop_handled
3870 handle_display_prop (it
)
3873 Lisp_Object prop
, object
, overlay
;
3874 struct text_pos
*position
;
3875 /* Nonzero if some property replaces the display of the text itself. */
3876 int display_replaced_p
= 0;
3878 if (STRINGP (it
->string
))
3880 object
= it
->string
;
3881 position
= &it
->current
.string_pos
;
3885 XSETWINDOW (object
, it
->w
);
3886 position
= &it
->current
.pos
;
3889 /* Reset those iterator values set from display property values. */
3890 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
3891 it
->space_width
= Qnil
;
3892 it
->font_height
= Qnil
;
3895 /* We don't support recursive `display' properties, i.e. string
3896 values that have a string `display' property, that have a string
3897 `display' property etc. */
3898 if (!it
->string_from_display_prop_p
)
3899 it
->area
= TEXT_AREA
;
3901 prop
= get_char_property_and_overlay (make_number (position
->charpos
),
3902 Qdisplay
, object
, &overlay
);
3904 return HANDLED_NORMALLY
;
3905 /* Now OVERLAY is the overlay that gave us this property, or nil
3906 if it was a text property. */
3908 if (!STRINGP (it
->string
))
3909 object
= it
->w
->buffer
;
3912 /* Simple properties. */
3913 && !EQ (XCAR (prop
), Qimage
)
3914 && !EQ (XCAR (prop
), Qspace
)
3915 && !EQ (XCAR (prop
), Qwhen
)
3916 && !EQ (XCAR (prop
), Qslice
)
3917 && !EQ (XCAR (prop
), Qspace_width
)
3918 && !EQ (XCAR (prop
), Qheight
)
3919 && !EQ (XCAR (prop
), Qraise
)
3920 /* Marginal area specifications. */
3921 && !(CONSP (XCAR (prop
)) && EQ (XCAR (XCAR (prop
)), Qmargin
))
3922 && !EQ (XCAR (prop
), Qleft_fringe
)
3923 && !EQ (XCAR (prop
), Qright_fringe
)
3924 && !NILP (XCAR (prop
)))
3926 for (; CONSP (prop
); prop
= XCDR (prop
))
3928 if (handle_single_display_spec (it
, XCAR (prop
), object
, overlay
,
3929 position
, display_replaced_p
))
3931 display_replaced_p
= 1;
3932 /* If some text in a string is replaced, `position' no
3933 longer points to the position of `object'. */
3934 if (STRINGP (object
))
3939 else if (VECTORP (prop
))
3942 for (i
= 0; i
< ASIZE (prop
); ++i
)
3943 if (handle_single_display_spec (it
, AREF (prop
, i
), object
, overlay
,
3944 position
, display_replaced_p
))
3946 display_replaced_p
= 1;
3947 /* If some text in a string is replaced, `position' no
3948 longer points to the position of `object'. */
3949 if (STRINGP (object
))
3955 int ret
= handle_single_display_spec (it
, prop
, object
, overlay
,
3957 if (ret
< 0) /* Replaced by "", i.e. nothing. */
3958 return HANDLED_RECOMPUTE_PROPS
;
3960 display_replaced_p
= 1;
3963 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
3967 /* Value is the position of the end of the `display' property starting
3968 at START_POS in OBJECT. */
3970 static struct text_pos
3971 display_prop_end (it
, object
, start_pos
)
3974 struct text_pos start_pos
;
3977 struct text_pos end_pos
;
3979 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
3980 Qdisplay
, object
, Qnil
);
3981 CHARPOS (end_pos
) = XFASTINT (end
);
3982 if (STRINGP (object
))
3983 compute_string_pos (&end_pos
, start_pos
, it
->string
);
3985 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
3991 /* Set up IT from a single `display' specification PROP. OBJECT
3992 is the object in which the `display' property was found. *POSITION
3993 is the position at which it was found. DISPLAY_REPLACED_P non-zero
3994 means that we previously saw a display specification which already
3995 replaced text display with something else, for example an image;
3996 we ignore such properties after the first one has been processed.
3998 OVERLAY is the overlay this `display' property came from,
3999 or nil if it was a text property.
4001 If PROP is a `space' or `image' specification, and in some other
4002 cases too, set *POSITION to the position where the `display'
4005 Value is non-zero if something was found which replaces the display
4006 of buffer or string text. Specifically, the value is -1 if that
4007 "something" is "nothing". */
4010 handle_single_display_spec (it
, spec
, object
, overlay
, position
,
4011 display_replaced_before_p
)
4015 Lisp_Object overlay
;
4016 struct text_pos
*position
;
4017 int display_replaced_before_p
;
4020 Lisp_Object location
, value
;
4021 struct text_pos start_pos
, save_pos
;
4024 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4025 If the result is non-nil, use VALUE instead of SPEC. */
4027 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4036 if (!NILP (form
) && !EQ (form
, Qt
))
4038 int count
= SPECPDL_INDEX ();
4039 struct gcpro gcpro1
;
4041 /* Bind `object' to the object having the `display' property, a
4042 buffer or string. Bind `position' to the position in the
4043 object where the property was found, and `buffer-position'
4044 to the current position in the buffer. */
4045 specbind (Qobject
, object
);
4046 specbind (Qposition
, make_number (CHARPOS (*position
)));
4047 specbind (Qbuffer_position
,
4048 make_number (STRINGP (object
)
4049 ? IT_CHARPOS (*it
) : CHARPOS (*position
)));
4051 form
= safe_eval (form
);
4053 unbind_to (count
, Qnil
);
4059 /* Handle `(height HEIGHT)' specifications. */
4061 && EQ (XCAR (spec
), Qheight
)
4062 && CONSP (XCDR (spec
)))
4064 if (!FRAME_WINDOW_P (it
->f
))
4067 it
->font_height
= XCAR (XCDR (spec
));
4068 if (!NILP (it
->font_height
))
4070 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4071 int new_height
= -1;
4073 if (CONSP (it
->font_height
)
4074 && (EQ (XCAR (it
->font_height
), Qplus
)
4075 || EQ (XCAR (it
->font_height
), Qminus
))
4076 && CONSP (XCDR (it
->font_height
))
4077 && INTEGERP (XCAR (XCDR (it
->font_height
))))
4079 /* `(+ N)' or `(- N)' where N is an integer. */
4080 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4081 if (EQ (XCAR (it
->font_height
), Qplus
))
4083 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4085 else if (FUNCTIONP (it
->font_height
))
4087 /* Call function with current height as argument.
4088 Value is the new height. */
4090 height
= safe_call1 (it
->font_height
,
4091 face
->lface
[LFACE_HEIGHT_INDEX
]);
4092 if (NUMBERP (height
))
4093 new_height
= XFLOATINT (height
);
4095 else if (NUMBERP (it
->font_height
))
4097 /* Value is a multiple of the canonical char height. */
4100 face
= FACE_FROM_ID (it
->f
,
4101 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4102 new_height
= (XFLOATINT (it
->font_height
)
4103 * XINT (face
->lface
[LFACE_HEIGHT_INDEX
]));
4107 /* Evaluate IT->font_height with `height' bound to the
4108 current specified height to get the new height. */
4109 int count
= SPECPDL_INDEX ();
4111 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4112 value
= safe_eval (it
->font_height
);
4113 unbind_to (count
, Qnil
);
4115 if (NUMBERP (value
))
4116 new_height
= XFLOATINT (value
);
4120 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4126 /* Handle `(space-width WIDTH)'. */
4128 && EQ (XCAR (spec
), Qspace_width
)
4129 && CONSP (XCDR (spec
)))
4131 if (!FRAME_WINDOW_P (it
->f
))
4134 value
= XCAR (XCDR (spec
));
4135 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4136 it
->space_width
= value
;
4141 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4143 && EQ (XCAR (spec
), Qslice
))
4147 if (!FRAME_WINDOW_P (it
->f
))
4150 if (tem
= XCDR (spec
), CONSP (tem
))
4152 it
->slice
.x
= XCAR (tem
);
4153 if (tem
= XCDR (tem
), CONSP (tem
))
4155 it
->slice
.y
= XCAR (tem
);
4156 if (tem
= XCDR (tem
), CONSP (tem
))
4158 it
->slice
.width
= XCAR (tem
);
4159 if (tem
= XCDR (tem
), CONSP (tem
))
4160 it
->slice
.height
= XCAR (tem
);
4168 /* Handle `(raise FACTOR)'. */
4170 && EQ (XCAR (spec
), Qraise
)
4171 && CONSP (XCDR (spec
)))
4173 if (!FRAME_WINDOW_P (it
->f
))
4176 #ifdef HAVE_WINDOW_SYSTEM
4177 value
= XCAR (XCDR (spec
));
4178 if (NUMBERP (value
))
4180 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4181 it
->voffset
= - (XFLOATINT (value
)
4182 * (FONT_HEIGHT (face
->font
)));
4184 #endif /* HAVE_WINDOW_SYSTEM */
4189 /* Don't handle the other kinds of display specifications
4190 inside a string that we got from a `display' property. */
4191 if (it
->string_from_display_prop_p
)
4194 /* Characters having this form of property are not displayed, so
4195 we have to find the end of the property. */
4196 start_pos
= *position
;
4197 *position
= display_prop_end (it
, object
, start_pos
);
4200 /* Stop the scan at that end position--we assume that all
4201 text properties change there. */
4202 it
->stop_charpos
= position
->charpos
;
4204 /* Handle `(left-fringe BITMAP [FACE])'
4205 and `(right-fringe BITMAP [FACE])'. */
4207 && (EQ (XCAR (spec
), Qleft_fringe
)
4208 || EQ (XCAR (spec
), Qright_fringe
))
4209 && CONSP (XCDR (spec
)))
4211 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
4214 if (!FRAME_WINDOW_P (it
->f
))
4215 /* If we return here, POSITION has been advanced
4216 across the text with this property. */
4219 #ifdef HAVE_WINDOW_SYSTEM
4220 value
= XCAR (XCDR (spec
));
4221 if (!SYMBOLP (value
)
4222 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4223 /* If we return here, POSITION has been advanced
4224 across the text with this property. */
4227 if (CONSP (XCDR (XCDR (spec
))))
4229 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4230 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4236 /* Save current settings of IT so that we can restore them
4237 when we are finished with the glyph property value. */
4239 save_pos
= it
->position
;
4240 it
->position
= *position
;
4242 it
->position
= save_pos
;
4244 it
->area
= TEXT_AREA
;
4245 it
->what
= IT_IMAGE
;
4246 it
->image_id
= -1; /* no image */
4247 it
->position
= start_pos
;
4248 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4249 it
->method
= GET_FROM_IMAGE
;
4250 it
->from_overlay
= Qnil
;
4251 it
->face_id
= face_id
;
4253 /* Say that we haven't consumed the characters with
4254 `display' property yet. The call to pop_it in
4255 set_iterator_to_next will clean this up. */
4256 *position
= start_pos
;
4258 if (EQ (XCAR (spec
), Qleft_fringe
))
4260 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4261 it
->left_user_fringe_face_id
= face_id
;
4265 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4266 it
->right_user_fringe_face_id
= face_id
;
4268 #endif /* HAVE_WINDOW_SYSTEM */
4272 /* Prepare to handle `((margin left-margin) ...)',
4273 `((margin right-margin) ...)' and `((margin nil) ...)'
4274 prefixes for display specifications. */
4275 location
= Qunbound
;
4276 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4280 value
= XCDR (spec
);
4282 value
= XCAR (value
);
4285 if (EQ (XCAR (tem
), Qmargin
)
4286 && (tem
= XCDR (tem
),
4287 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4289 || EQ (tem
, Qleft_margin
)
4290 || EQ (tem
, Qright_margin
))))
4294 if (EQ (location
, Qunbound
))
4300 /* After this point, VALUE is the property after any
4301 margin prefix has been stripped. It must be a string,
4302 an image specification, or `(space ...)'.
4304 LOCATION specifies where to display: `left-margin',
4305 `right-margin' or nil. */
4307 valid_p
= (STRINGP (value
)
4308 #ifdef HAVE_WINDOW_SYSTEM
4309 || (FRAME_WINDOW_P (it
->f
) && valid_image_p (value
))
4310 #endif /* not HAVE_WINDOW_SYSTEM */
4311 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4313 if (valid_p
&& !display_replaced_before_p
)
4315 /* Save current settings of IT so that we can restore them
4316 when we are finished with the glyph property value. */
4317 save_pos
= it
->position
;
4318 it
->position
= *position
;
4320 it
->position
= save_pos
;
4321 it
->from_overlay
= overlay
;
4323 if (NILP (location
))
4324 it
->area
= TEXT_AREA
;
4325 else if (EQ (location
, Qleft_margin
))
4326 it
->area
= LEFT_MARGIN_AREA
;
4328 it
->area
= RIGHT_MARGIN_AREA
;
4330 if (STRINGP (value
))
4332 if (SCHARS (value
) == 0)
4335 return -1; /* Replaced by "", i.e. nothing. */
4338 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4339 it
->current
.overlay_string_index
= -1;
4340 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4341 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4342 it
->method
= GET_FROM_STRING
;
4343 it
->stop_charpos
= 0;
4344 it
->string_from_display_prop_p
= 1;
4345 /* Say that we haven't consumed the characters with
4346 `display' property yet. The call to pop_it in
4347 set_iterator_to_next will clean this up. */
4348 if (BUFFERP (object
))
4349 *position
= start_pos
;
4351 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4353 it
->method
= GET_FROM_STRETCH
;
4355 *position
= it
->position
= start_pos
;
4357 #ifdef HAVE_WINDOW_SYSTEM
4360 it
->what
= IT_IMAGE
;
4361 it
->image_id
= lookup_image (it
->f
, value
);
4362 it
->position
= start_pos
;
4363 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4364 it
->method
= GET_FROM_IMAGE
;
4366 /* Say that we haven't consumed the characters with
4367 `display' property yet. The call to pop_it in
4368 set_iterator_to_next will clean this up. */
4369 *position
= start_pos
;
4371 #endif /* HAVE_WINDOW_SYSTEM */
4376 /* Invalid property or property not supported. Restore
4377 POSITION to what it was before. */
4378 *position
= start_pos
;
4383 /* Check if SPEC is a display sub-property value whose text should be
4384 treated as intangible. */
4387 single_display_spec_intangible_p (prop
)
4390 /* Skip over `when FORM'. */
4391 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4405 /* Skip over `margin LOCATION'. If LOCATION is in the margins,
4406 we don't need to treat text as intangible. */
4407 if (EQ (XCAR (prop
), Qmargin
))
4415 || EQ (XCAR (prop
), Qleft_margin
)
4416 || EQ (XCAR (prop
), Qright_margin
))
4420 return (CONSP (prop
)
4421 && (EQ (XCAR (prop
), Qimage
)
4422 || EQ (XCAR (prop
), Qspace
)));
4426 /* Check if PROP is a display property value whose text should be
4427 treated as intangible. */
4430 display_prop_intangible_p (prop
)
4434 && CONSP (XCAR (prop
))
4435 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4437 /* A list of sub-properties. */
4438 while (CONSP (prop
))
4440 if (single_display_spec_intangible_p (XCAR (prop
)))
4445 else if (VECTORP (prop
))
4447 /* A vector of sub-properties. */
4449 for (i
= 0; i
< ASIZE (prop
); ++i
)
4450 if (single_display_spec_intangible_p (AREF (prop
, i
)))
4454 return single_display_spec_intangible_p (prop
);
4460 /* Return 1 if PROP is a display sub-property value containing STRING. */
4463 single_display_spec_string_p (prop
, string
)
4464 Lisp_Object prop
, string
;
4466 if (EQ (string
, prop
))
4469 /* Skip over `when FORM'. */
4470 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4479 /* Skip over `margin LOCATION'. */
4480 if (EQ (XCAR (prop
), Qmargin
))
4491 return CONSP (prop
) && EQ (XCAR (prop
), string
);
4495 /* Return 1 if STRING appears in the `display' property PROP. */
4498 display_prop_string_p (prop
, string
)
4499 Lisp_Object prop
, string
;
4502 && CONSP (XCAR (prop
))
4503 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4505 /* A list of sub-properties. */
4506 while (CONSP (prop
))
4508 if (single_display_spec_string_p (XCAR (prop
), string
))
4513 else if (VECTORP (prop
))
4515 /* A vector of sub-properties. */
4517 for (i
= 0; i
< ASIZE (prop
); ++i
)
4518 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4522 return single_display_spec_string_p (prop
, string
);
4528 /* Determine from which buffer position in W's buffer STRING comes
4529 from. AROUND_CHARPOS is an approximate position where it could
4530 be from. Value is the buffer position or 0 if it couldn't be
4533 W's buffer must be current.
4535 This function is necessary because we don't record buffer positions
4536 in glyphs generated from strings (to keep struct glyph small).
4537 This function may only use code that doesn't eval because it is
4538 called asynchronously from note_mouse_highlight. */
4541 string_buffer_position (w
, string
, around_charpos
)
4546 Lisp_Object limit
, prop
, pos
;
4547 const int MAX_DISTANCE
= 1000;
4550 pos
= make_number (around_charpos
);
4551 limit
= make_number (min (XINT (pos
) + MAX_DISTANCE
, ZV
));
4552 while (!found
&& !EQ (pos
, limit
))
4554 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4555 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4558 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
, limit
);
4563 pos
= make_number (around_charpos
);
4564 limit
= make_number (max (XINT (pos
) - MAX_DISTANCE
, BEGV
));
4565 while (!found
&& !EQ (pos
, limit
))
4567 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4568 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4571 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
4576 return found
? XINT (pos
) : 0;
4581 /***********************************************************************
4582 `composition' property
4583 ***********************************************************************/
4585 static enum prop_handled
4586 handle_auto_composed_prop (it
)
4589 enum prop_handled handled
= HANDLED_NORMALLY
;
4591 if (FRAME_WINDOW_P (it
->f
) && FUNCTIONP (Vauto_composition_function
))
4593 Lisp_Object val
= Qnil
;
4594 EMACS_INT pos
, limit
= -1;
4596 if (STRINGP (it
->string
))
4597 pos
= IT_STRING_CHARPOS (*it
);
4599 pos
= IT_CHARPOS (*it
);
4601 val
= Fget_text_property (make_number (pos
), Qauto_composed
, it
->string
);
4604 Lisp_Object cmp_prop
;
4605 EMACS_INT cmp_start
, cmp_end
;
4607 if (get_property_and_range (pos
, Qcomposition
, &cmp_prop
,
4608 &cmp_start
, &cmp_end
, it
->string
)
4610 && COMPOSITION_METHOD (cmp_prop
) == COMPOSITION_WITH_GLYPH_STRING
)
4612 Lisp_Object gstring
= COMPOSITION_COMPONENTS (cmp_prop
);
4613 Lisp_Object font_object
= LGSTRING_FONT (gstring
);
4615 if (! EQ (font_object
,
4616 font_at (-1, pos
, FACE_FROM_ID (it
->f
, it
->face_id
),
4617 it
->w
, it
->string
)))
4618 /* We must re-compute the composition for the
4627 /* As Fnext_single_char_property_change is very slow, we
4628 limit the search to the current line. */
4629 if (STRINGP (it
->string
))
4630 limit
= SCHARS (it
->string
);
4632 limit
= find_next_newline_no_quit (pos
, 1);
4633 end
= Fnext_single_char_property_change (make_number (pos
),
4636 make_number (limit
));
4638 if (XINT (end
) < limit
)
4639 /* The current point is auto-composed, but there exist
4640 characters not yet composed beyond the
4641 auto-composed region. There's a possiblity that
4642 the last characters in the region may be newly
4647 if (NILP (val
) && ! STRINGP (it
->string
))
4650 limit
= (STRINGP (it
->string
) ? SCHARS (it
->string
)
4651 : find_next_newline_no_quit (pos
, 1));
4654 int count
= SPECPDL_INDEX ();
4655 Lisp_Object args
[5];
4657 limit
= font_range (pos
, limit
, FACE_FROM_ID (it
->f
, it
->face_id
),
4659 args
[0] = Vauto_composition_function
;
4660 specbind (Qauto_composition_function
, Qnil
);
4661 args
[1] = make_number (pos
);
4662 args
[2] = make_number (limit
);
4663 args
[3] = it
->window
;
4664 args
[4] = it
->string
;
4665 safe_call (5, args
);
4666 unbind_to (count
, Qnil
);
4674 /* Set up iterator IT from `composition' property at its current
4675 position. Called from handle_stop. */
4677 static enum prop_handled
4678 handle_composition_prop (it
)
4681 Lisp_Object prop
, string
;
4682 EMACS_INT pos
, pos_byte
, start
, end
;
4683 enum prop_handled handled
= HANDLED_NORMALLY
;
4685 if (STRINGP (it
->string
))
4689 pos
= IT_STRING_CHARPOS (*it
);
4690 pos_byte
= IT_STRING_BYTEPOS (*it
);
4691 string
= it
->string
;
4692 s
= SDATA (string
) + pos_byte
;
4693 it
->c
= STRING_CHAR (s
, 0);
4697 pos
= IT_CHARPOS (*it
);
4698 pos_byte
= IT_BYTEPOS (*it
);
4700 it
->c
= FETCH_CHAR (pos_byte
);
4703 /* If there's a valid composition and point is not inside of the
4704 composition (in the case that the composition is from the current
4705 buffer), draw a glyph composed from the composition components. */
4706 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
4707 && COMPOSITION_VALID_P (start
, end
, prop
)
4708 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
4714 if (STRINGP (it
->string
))
4715 pos_byte
= string_char_to_byte (it
->string
, start
);
4717 pos_byte
= CHAR_TO_BYTE (start
);
4719 id
= get_composition_id (start
, pos_byte
, end
- start
, prop
, string
);
4723 struct composition
*cmp
= composition_table
[id
];
4725 if (cmp
->glyph_len
== 0)
4728 if (STRINGP (it
->string
))
4730 IT_STRING_CHARPOS (*it
) = end
;
4731 IT_STRING_BYTEPOS (*it
) = string_char_to_byte (it
->string
,
4736 IT_CHARPOS (*it
) = end
;
4737 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (end
);
4739 return HANDLED_RECOMPUTE_PROPS
;
4742 it
->stop_charpos
= end
;
4745 it
->method
= GET_FROM_COMPOSITION
;
4747 it
->cmp_len
= COMPOSITION_LENGTH (prop
);
4748 /* For a terminal, draw only the first (non-TAB) character
4749 of the components. */
4750 if (composition_table
[id
]->method
== COMPOSITION_WITH_GLYPH_STRING
)
4752 /* FIXME: This doesn't do anything!?! */
4753 Lisp_Object lgstring
= AREF (XHASH_TABLE (composition_hash_table
)
4755 cmp
->hash_index
* 2);
4761 for (i
= 0; i
< cmp
->glyph_len
; i
++)
4762 if ((it
->c
= COMPOSITION_GLYPH (composition_table
[id
], i
))
4768 it
->len
= (STRINGP (it
->string
)
4769 ? string_char_to_byte (it
->string
, end
)
4770 : CHAR_TO_BYTE (end
)) - pos_byte
;
4771 handled
= HANDLED_RETURN
;
4780 /***********************************************************************
4782 ***********************************************************************/
4784 /* The following structure is used to record overlay strings for
4785 later sorting in load_overlay_strings. */
4787 struct overlay_entry
4789 Lisp_Object overlay
;
4796 /* Set up iterator IT from overlay strings at its current position.
4797 Called from handle_stop. */
4799 static enum prop_handled
4800 handle_overlay_change (it
)
4803 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
4804 return HANDLED_RECOMPUTE_PROPS
;
4806 return HANDLED_NORMALLY
;
4810 /* Set up the next overlay string for delivery by IT, if there is an
4811 overlay string to deliver. Called by set_iterator_to_next when the
4812 end of the current overlay string is reached. If there are more
4813 overlay strings to display, IT->string and
4814 IT->current.overlay_string_index are set appropriately here.
4815 Otherwise IT->string is set to nil. */
4818 next_overlay_string (it
)
4821 ++it
->current
.overlay_string_index
;
4822 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
4824 /* No more overlay strings. Restore IT's settings to what
4825 they were before overlay strings were processed, and
4826 continue to deliver from current_buffer. */
4827 int display_ellipsis_p
= it
->stack
[it
->sp
- 1].display_ellipsis_p
;
4831 || it
->method
== GET_FROM_COMPOSITION
4832 || (NILP (it
->string
)
4833 && it
->method
== GET_FROM_BUFFER
4834 && it
->stop_charpos
>= BEGV
4835 && it
->stop_charpos
<= it
->end_charpos
));
4836 it
->current
.overlay_string_index
= -1;
4837 it
->n_overlay_strings
= 0;
4839 /* If we're at the end of the buffer, record that we have
4840 processed the overlay strings there already, so that
4841 next_element_from_buffer doesn't try it again. */
4842 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
4843 it
->overlay_strings_at_end_processed_p
= 1;
4845 /* If we have to display `...' for invisible text, set
4846 the iterator up for that. */
4847 if (display_ellipsis_p
)
4848 setup_for_ellipsis (it
, 0);
4852 /* There are more overlay strings to process. If
4853 IT->current.overlay_string_index has advanced to a position
4854 where we must load IT->overlay_strings with more strings, do
4856 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
4858 if (it
->current
.overlay_string_index
&& i
== 0)
4859 load_overlay_strings (it
, 0);
4861 /* Initialize IT to deliver display elements from the overlay
4863 it
->string
= it
->overlay_strings
[i
];
4864 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4865 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
4866 it
->method
= GET_FROM_STRING
;
4867 it
->stop_charpos
= 0;
4874 /* Compare two overlay_entry structures E1 and E2. Used as a
4875 comparison function for qsort in load_overlay_strings. Overlay
4876 strings for the same position are sorted so that
4878 1. All after-strings come in front of before-strings, except
4879 when they come from the same overlay.
4881 2. Within after-strings, strings are sorted so that overlay strings
4882 from overlays with higher priorities come first.
4884 2. Within before-strings, strings are sorted so that overlay
4885 strings from overlays with higher priorities come last.
4887 Value is analogous to strcmp. */
4891 compare_overlay_entries (e1
, e2
)
4894 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
4895 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
4898 if (entry1
->after_string_p
!= entry2
->after_string_p
)
4900 /* Let after-strings appear in front of before-strings if
4901 they come from different overlays. */
4902 if (EQ (entry1
->overlay
, entry2
->overlay
))
4903 result
= entry1
->after_string_p
? 1 : -1;
4905 result
= entry1
->after_string_p
? -1 : 1;
4907 else if (entry1
->after_string_p
)
4908 /* After-strings sorted in order of decreasing priority. */
4909 result
= entry2
->priority
- entry1
->priority
;
4911 /* Before-strings sorted in order of increasing priority. */
4912 result
= entry1
->priority
- entry2
->priority
;
4918 /* Load the vector IT->overlay_strings with overlay strings from IT's
4919 current buffer position, or from CHARPOS if that is > 0. Set
4920 IT->n_overlays to the total number of overlay strings found.
4922 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
4923 a time. On entry into load_overlay_strings,
4924 IT->current.overlay_string_index gives the number of overlay
4925 strings that have already been loaded by previous calls to this
4928 IT->add_overlay_start contains an additional overlay start
4929 position to consider for taking overlay strings from, if non-zero.
4930 This position comes into play when the overlay has an `invisible'
4931 property, and both before and after-strings. When we've skipped to
4932 the end of the overlay, because of its `invisible' property, we
4933 nevertheless want its before-string to appear.
4934 IT->add_overlay_start will contain the overlay start position
4937 Overlay strings are sorted so that after-string strings come in
4938 front of before-string strings. Within before and after-strings,
4939 strings are sorted by overlay priority. See also function
4940 compare_overlay_entries. */
4943 load_overlay_strings (it
, charpos
)
4947 extern Lisp_Object Qafter_string
, Qbefore_string
, Qwindow
, Qpriority
;
4948 Lisp_Object overlay
, window
, str
, invisible
;
4949 struct Lisp_Overlay
*ov
;
4952 int n
= 0, i
, j
, invis_p
;
4953 struct overlay_entry
*entries
4954 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
4957 charpos
= IT_CHARPOS (*it
);
4959 /* Append the overlay string STRING of overlay OVERLAY to vector
4960 `entries' which has size `size' and currently contains `n'
4961 elements. AFTER_P non-zero means STRING is an after-string of
4963 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
4966 Lisp_Object priority; \
4970 int new_size = 2 * size; \
4971 struct overlay_entry *old = entries; \
4973 (struct overlay_entry *) alloca (new_size \
4974 * sizeof *entries); \
4975 bcopy (old, entries, size * sizeof *entries); \
4979 entries[n].string = (STRING); \
4980 entries[n].overlay = (OVERLAY); \
4981 priority = Foverlay_get ((OVERLAY), Qpriority); \
4982 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
4983 entries[n].after_string_p = (AFTER_P); \
4988 /* Process overlay before the overlay center. */
4989 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
4991 XSETMISC (overlay
, ov
);
4992 xassert (OVERLAYP (overlay
));
4993 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4994 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4999 /* Skip this overlay if it doesn't start or end at IT's current
5001 if (end
!= charpos
&& start
!= charpos
)
5004 /* Skip this overlay if it doesn't apply to IT->w. */
5005 window
= Foverlay_get (overlay
, Qwindow
);
5006 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5009 /* If the text ``under'' the overlay is invisible, both before-
5010 and after-strings from this overlay are visible; start and
5011 end position are indistinguishable. */
5012 invisible
= Foverlay_get (overlay
, Qinvisible
);
5013 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5015 /* If overlay has a non-empty before-string, record it. */
5016 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5017 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5019 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5021 /* If overlay has a non-empty after-string, record it. */
5022 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5023 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5025 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5028 /* Process overlays after the overlay center. */
5029 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5031 XSETMISC (overlay
, ov
);
5032 xassert (OVERLAYP (overlay
));
5033 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5034 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5036 if (start
> charpos
)
5039 /* Skip this overlay if it doesn't start or end at IT's current
5041 if (end
!= charpos
&& start
!= charpos
)
5044 /* Skip this overlay if it doesn't apply to IT->w. */
5045 window
= Foverlay_get (overlay
, Qwindow
);
5046 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5049 /* If the text ``under'' the overlay is invisible, it has a zero
5050 dimension, and both before- and after-strings apply. */
5051 invisible
= Foverlay_get (overlay
, Qinvisible
);
5052 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5054 /* If overlay has a non-empty before-string, record it. */
5055 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5056 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5058 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5060 /* If overlay has a non-empty after-string, record it. */
5061 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5062 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5064 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5067 #undef RECORD_OVERLAY_STRING
5071 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5073 /* Record the total number of strings to process. */
5074 it
->n_overlay_strings
= n
;
5076 /* IT->current.overlay_string_index is the number of overlay strings
5077 that have already been consumed by IT. Copy some of the
5078 remaining overlay strings to IT->overlay_strings. */
5080 j
= it
->current
.overlay_string_index
;
5081 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5083 it
->overlay_strings
[i
] = entries
[j
].string
;
5084 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5091 /* Get the first chunk of overlay strings at IT's current buffer
5092 position, or at CHARPOS if that is > 0. Value is non-zero if at
5093 least one overlay string was found. */
5096 get_overlay_strings_1 (it
, charpos
, compute_stop_p
)
5101 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5102 process. This fills IT->overlay_strings with strings, and sets
5103 IT->n_overlay_strings to the total number of strings to process.
5104 IT->pos.overlay_string_index has to be set temporarily to zero
5105 because load_overlay_strings needs this; it must be set to -1
5106 when no overlay strings are found because a zero value would
5107 indicate a position in the first overlay string. */
5108 it
->current
.overlay_string_index
= 0;
5109 load_overlay_strings (it
, charpos
);
5111 /* If we found overlay strings, set up IT to deliver display
5112 elements from the first one. Otherwise set up IT to deliver
5113 from current_buffer. */
5114 if (it
->n_overlay_strings
)
5116 /* Make sure we know settings in current_buffer, so that we can
5117 restore meaningful values when we're done with the overlay
5120 compute_stop_pos (it
);
5121 xassert (it
->face_id
>= 0);
5123 /* Save IT's settings. They are restored after all overlay
5124 strings have been processed. */
5125 xassert (!compute_stop_p
|| it
->sp
== 0);
5128 /* Set up IT to deliver display elements from the first overlay
5130 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5131 it
->string
= it
->overlay_strings
[0];
5132 it
->from_overlay
= Qnil
;
5133 it
->stop_charpos
= 0;
5134 xassert (STRINGP (it
->string
));
5135 it
->end_charpos
= SCHARS (it
->string
);
5136 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5137 it
->method
= GET_FROM_STRING
;
5141 it
->current
.overlay_string_index
= -1;
5146 get_overlay_strings (it
, charpos
)
5151 it
->method
= GET_FROM_BUFFER
;
5153 (void) get_overlay_strings_1 (it
, charpos
, 1);
5157 /* Value is non-zero if we found at least one overlay string. */
5158 return STRINGP (it
->string
);
5163 /***********************************************************************
5164 Saving and restoring state
5165 ***********************************************************************/
5167 /* Save current settings of IT on IT->stack. Called, for example,
5168 before setting up IT for an overlay string, to be able to restore
5169 IT's settings to what they were after the overlay string has been
5176 struct iterator_stack_entry
*p
;
5178 xassert (it
->sp
< IT_STACK_SIZE
);
5179 p
= it
->stack
+ it
->sp
;
5181 p
->stop_charpos
= it
->stop_charpos
;
5182 xassert (it
->face_id
>= 0);
5183 p
->face_id
= it
->face_id
;
5184 p
->string
= it
->string
;
5185 p
->method
= it
->method
;
5186 p
->from_overlay
= it
->from_overlay
;
5189 case GET_FROM_IMAGE
:
5190 p
->u
.image
.object
= it
->object
;
5191 p
->u
.image
.image_id
= it
->image_id
;
5192 p
->u
.image
.slice
= it
->slice
;
5194 case GET_FROM_COMPOSITION
:
5195 p
->u
.comp
.object
= it
->object
;
5196 p
->u
.comp
.c
= it
->c
;
5197 p
->u
.comp
.len
= it
->len
;
5198 p
->u
.comp
.cmp_id
= it
->cmp_id
;
5199 p
->u
.comp
.cmp_len
= it
->cmp_len
;
5201 case GET_FROM_STRETCH
:
5202 p
->u
.stretch
.object
= it
->object
;
5205 p
->position
= it
->position
;
5206 p
->current
= it
->current
;
5207 p
->end_charpos
= it
->end_charpos
;
5208 p
->string_nchars
= it
->string_nchars
;
5210 p
->multibyte_p
= it
->multibyte_p
;
5211 p
->space_width
= it
->space_width
;
5212 p
->font_height
= it
->font_height
;
5213 p
->voffset
= it
->voffset
;
5214 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5215 p
->display_ellipsis_p
= 0;
5220 /* Restore IT's settings from IT->stack. Called, for example, when no
5221 more overlay strings must be processed, and we return to delivering
5222 display elements from a buffer, or when the end of a string from a
5223 `display' property is reached and we return to delivering display
5224 elements from an overlay string, or from a buffer. */
5230 struct iterator_stack_entry
*p
;
5232 xassert (it
->sp
> 0);
5234 p
= it
->stack
+ it
->sp
;
5235 it
->stop_charpos
= p
->stop_charpos
;
5236 it
->face_id
= p
->face_id
;
5237 it
->current
= p
->current
;
5238 it
->position
= p
->position
;
5239 it
->string
= p
->string
;
5240 it
->from_overlay
= p
->from_overlay
;
5241 if (NILP (it
->string
))
5242 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5243 it
->method
= p
->method
;
5246 case GET_FROM_IMAGE
:
5247 it
->image_id
= p
->u
.image
.image_id
;
5248 it
->object
= p
->u
.image
.object
;
5249 it
->slice
= p
->u
.image
.slice
;
5251 case GET_FROM_COMPOSITION
:
5252 it
->object
= p
->u
.comp
.object
;
5253 it
->c
= p
->u
.comp
.c
;
5254 it
->len
= p
->u
.comp
.len
;
5255 it
->cmp_id
= p
->u
.comp
.cmp_id
;
5256 it
->cmp_len
= p
->u
.comp
.cmp_len
;
5258 case GET_FROM_STRETCH
:
5259 it
->object
= p
->u
.comp
.object
;
5261 case GET_FROM_BUFFER
:
5262 it
->object
= it
->w
->buffer
;
5264 case GET_FROM_STRING
:
5265 it
->object
= it
->string
;
5268 it
->end_charpos
= p
->end_charpos
;
5269 it
->string_nchars
= p
->string_nchars
;
5271 it
->multibyte_p
= p
->multibyte_p
;
5272 it
->space_width
= p
->space_width
;
5273 it
->font_height
= p
->font_height
;
5274 it
->voffset
= p
->voffset
;
5275 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5280 /***********************************************************************
5282 ***********************************************************************/
5284 /* Set IT's current position to the previous line start. */
5287 back_to_previous_line_start (it
)
5290 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5291 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5295 /* Move IT to the next line start.
5297 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5298 we skipped over part of the text (as opposed to moving the iterator
5299 continuously over the text). Otherwise, don't change the value
5302 Newlines may come from buffer text, overlay strings, or strings
5303 displayed via the `display' property. That's the reason we can't
5304 simply use find_next_newline_no_quit.
5306 Note that this function may not skip over invisible text that is so
5307 because of text properties and immediately follows a newline. If
5308 it would, function reseat_at_next_visible_line_start, when called
5309 from set_iterator_to_next, would effectively make invisible
5310 characters following a newline part of the wrong glyph row, which
5311 leads to wrong cursor motion. */
5314 forward_to_next_line_start (it
, skipped_p
)
5318 int old_selective
, newline_found_p
, n
;
5319 const int MAX_NEWLINE_DISTANCE
= 500;
5321 /* If already on a newline, just consume it to avoid unintended
5322 skipping over invisible text below. */
5323 if (it
->what
== IT_CHARACTER
5325 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5327 set_iterator_to_next (it
, 0);
5332 /* Don't handle selective display in the following. It's (a)
5333 unnecessary because it's done by the caller, and (b) leads to an
5334 infinite recursion because next_element_from_ellipsis indirectly
5335 calls this function. */
5336 old_selective
= it
->selective
;
5339 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5340 from buffer text. */
5341 for (n
= newline_found_p
= 0;
5342 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5343 n
+= STRINGP (it
->string
) ? 0 : 1)
5345 if (!get_next_display_element (it
))
5347 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5348 set_iterator_to_next (it
, 0);
5351 /* If we didn't find a newline near enough, see if we can use a
5353 if (!newline_found_p
)
5355 int start
= IT_CHARPOS (*it
);
5356 int limit
= find_next_newline_no_quit (start
, 1);
5359 xassert (!STRINGP (it
->string
));
5361 /* If there isn't any `display' property in sight, and no
5362 overlays, we can just use the position of the newline in
5364 if (it
->stop_charpos
>= limit
5365 || ((pos
= Fnext_single_property_change (make_number (start
),
5367 Qnil
, make_number (limit
)),
5369 && next_overlay_change (start
) == ZV
))
5371 IT_CHARPOS (*it
) = limit
;
5372 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5373 *skipped_p
= newline_found_p
= 1;
5377 while (get_next_display_element (it
)
5378 && !newline_found_p
)
5380 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5381 set_iterator_to_next (it
, 0);
5386 it
->selective
= old_selective
;
5387 return newline_found_p
;
5391 /* Set IT's current position to the previous visible line start. Skip
5392 invisible text that is so either due to text properties or due to
5393 selective display. Caution: this does not change IT->current_x and
5397 back_to_previous_visible_line_start (it
)
5400 while (IT_CHARPOS (*it
) > BEGV
)
5402 back_to_previous_line_start (it
);
5404 if (IT_CHARPOS (*it
) <= BEGV
)
5407 /* If selective > 0, then lines indented more than that values
5409 if (it
->selective
> 0
5410 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5411 (double) it
->selective
)) /* iftc */
5414 /* Check the newline before point for invisibility. */
5417 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5418 Qinvisible
, it
->window
);
5419 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5423 if (IT_CHARPOS (*it
) <= BEGV
)
5430 Lisp_Object val
, overlay
;
5432 /* If newline is part of a composition, continue from start of composition */
5433 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5434 && beg
< IT_CHARPOS (*it
))
5437 /* If newline is replaced by a display property, find start of overlay
5438 or interval and continue search from that point. */
5440 pos
= --IT_CHARPOS (it2
);
5443 it2
.string_from_display_prop_p
= 0;
5444 if (handle_display_prop (&it2
) == HANDLED_RETURN
5445 && !NILP (val
= get_char_property_and_overlay
5446 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5447 && (OVERLAYP (overlay
)
5448 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5449 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5452 /* Newline is not replaced by anything -- so we are done. */
5458 IT_CHARPOS (*it
) = beg
;
5459 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5463 it
->continuation_lines_width
= 0;
5465 xassert (IT_CHARPOS (*it
) >= BEGV
);
5466 xassert (IT_CHARPOS (*it
) == BEGV
5467 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5472 /* Reseat iterator IT at the previous visible line start. Skip
5473 invisible text that is so either due to text properties or due to
5474 selective display. At the end, update IT's overlay information,
5475 face information etc. */
5478 reseat_at_previous_visible_line_start (it
)
5481 back_to_previous_visible_line_start (it
);
5482 reseat (it
, it
->current
.pos
, 1);
5487 /* Reseat iterator IT on the next visible line start in the current
5488 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5489 preceding the line start. Skip over invisible text that is so
5490 because of selective display. Compute faces, overlays etc at the
5491 new position. Note that this function does not skip over text that
5492 is invisible because of text properties. */
5495 reseat_at_next_visible_line_start (it
, on_newline_p
)
5499 int newline_found_p
, skipped_p
= 0;
5501 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5503 /* Skip over lines that are invisible because they are indented
5504 more than the value of IT->selective. */
5505 if (it
->selective
> 0)
5506 while (IT_CHARPOS (*it
) < ZV
5507 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5508 (double) it
->selective
)) /* iftc */
5510 xassert (IT_BYTEPOS (*it
) == BEGV
5511 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5512 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5515 /* Position on the newline if that's what's requested. */
5516 if (on_newline_p
&& newline_found_p
)
5518 if (STRINGP (it
->string
))
5520 if (IT_STRING_CHARPOS (*it
) > 0)
5522 --IT_STRING_CHARPOS (*it
);
5523 --IT_STRING_BYTEPOS (*it
);
5526 else if (IT_CHARPOS (*it
) > BEGV
)
5530 reseat (it
, it
->current
.pos
, 0);
5534 reseat (it
, it
->current
.pos
, 0);
5541 /***********************************************************************
5542 Changing an iterator's position
5543 ***********************************************************************/
5545 /* Change IT's current position to POS in current_buffer. If FORCE_P
5546 is non-zero, always check for text properties at the new position.
5547 Otherwise, text properties are only looked up if POS >=
5548 IT->check_charpos of a property. */
5551 reseat (it
, pos
, force_p
)
5553 struct text_pos pos
;
5556 int original_pos
= IT_CHARPOS (*it
);
5558 reseat_1 (it
, pos
, 0);
5560 /* Determine where to check text properties. Avoid doing it
5561 where possible because text property lookup is very expensive. */
5563 || CHARPOS (pos
) > it
->stop_charpos
5564 || CHARPOS (pos
) < original_pos
)
5571 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
5572 IT->stop_pos to POS, also. */
5575 reseat_1 (it
, pos
, set_stop_p
)
5577 struct text_pos pos
;
5580 /* Don't call this function when scanning a C string. */
5581 xassert (it
->s
== NULL
);
5583 /* POS must be a reasonable value. */
5584 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
5586 it
->current
.pos
= it
->position
= pos
;
5587 it
->end_charpos
= ZV
;
5589 it
->current
.dpvec_index
= -1;
5590 it
->current
.overlay_string_index
= -1;
5591 IT_STRING_CHARPOS (*it
) = -1;
5592 IT_STRING_BYTEPOS (*it
) = -1;
5594 it
->string_from_display_prop_p
= 0;
5595 it
->method
= GET_FROM_BUFFER
;
5596 it
->object
= it
->w
->buffer
;
5597 it
->area
= TEXT_AREA
;
5598 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
5600 it
->string_from_display_prop_p
= 0;
5601 it
->face_before_selective_p
= 0;
5604 it
->stop_charpos
= CHARPOS (pos
);
5608 /* Set up IT for displaying a string, starting at CHARPOS in window W.
5609 If S is non-null, it is a C string to iterate over. Otherwise,
5610 STRING gives a Lisp string to iterate over.
5612 If PRECISION > 0, don't return more then PRECISION number of
5613 characters from the string.
5615 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
5616 characters have been returned. FIELD_WIDTH < 0 means an infinite
5619 MULTIBYTE = 0 means disable processing of multibyte characters,
5620 MULTIBYTE > 0 means enable it,
5621 MULTIBYTE < 0 means use IT->multibyte_p.
5623 IT must be initialized via a prior call to init_iterator before
5624 calling this function. */
5627 reseat_to_string (it
, s
, string
, charpos
, precision
, field_width
, multibyte
)
5632 int precision
, field_width
, multibyte
;
5634 /* No region in strings. */
5635 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
5637 /* No text property checks performed by default, but see below. */
5638 it
->stop_charpos
= -1;
5640 /* Set iterator position and end position. */
5641 bzero (&it
->current
, sizeof it
->current
);
5642 it
->current
.overlay_string_index
= -1;
5643 it
->current
.dpvec_index
= -1;
5644 xassert (charpos
>= 0);
5646 /* If STRING is specified, use its multibyteness, otherwise use the
5647 setting of MULTIBYTE, if specified. */
5649 it
->multibyte_p
= multibyte
> 0;
5653 xassert (STRINGP (string
));
5654 it
->string
= string
;
5656 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
5657 it
->method
= GET_FROM_STRING
;
5658 it
->current
.string_pos
= string_pos (charpos
, string
);
5665 /* Note that we use IT->current.pos, not it->current.string_pos,
5666 for displaying C strings. */
5667 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
5668 if (it
->multibyte_p
)
5670 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
5671 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
5675 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
5676 it
->end_charpos
= it
->string_nchars
= strlen (s
);
5679 it
->method
= GET_FROM_C_STRING
;
5682 /* PRECISION > 0 means don't return more than PRECISION characters
5684 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
5685 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
5687 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
5688 characters have been returned. FIELD_WIDTH == 0 means don't pad,
5689 FIELD_WIDTH < 0 means infinite field width. This is useful for
5690 padding with `-' at the end of a mode line. */
5691 if (field_width
< 0)
5692 field_width
= INFINITY
;
5693 if (field_width
> it
->end_charpos
- charpos
)
5694 it
->end_charpos
= charpos
+ field_width
;
5696 /* Use the standard display table for displaying strings. */
5697 if (DISP_TABLE_P (Vstandard_display_table
))
5698 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
5700 it
->stop_charpos
= charpos
;
5706 /***********************************************************************
5708 ***********************************************************************/
5710 /* Map enum it_method value to corresponding next_element_from_* function. */
5712 static int (* get_next_element
[NUM_IT_METHODS
]) P_ ((struct it
*it
)) =
5714 next_element_from_buffer
,
5715 next_element_from_display_vector
,
5716 next_element_from_composition
,
5717 next_element_from_string
,
5718 next_element_from_c_string
,
5719 next_element_from_image
,
5720 next_element_from_stretch
5723 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
5725 /* Load IT's display element fields with information about the next
5726 display element from the current position of IT. Value is zero if
5727 end of buffer (or C string) is reached. */
5729 static struct frame
*last_escape_glyph_frame
= NULL
;
5730 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
5731 static int last_escape_glyph_merged_face_id
= 0;
5734 get_next_display_element (it
)
5737 /* Non-zero means that we found a display element. Zero means that
5738 we hit the end of what we iterate over. Performance note: the
5739 function pointer `method' used here turns out to be faster than
5740 using a sequence of if-statements. */
5744 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
5746 if (it
->what
== IT_CHARACTER
)
5748 /* Map via display table or translate control characters.
5749 IT->c, IT->len etc. have been set to the next character by
5750 the function call above. If we have a display table, and it
5751 contains an entry for IT->c, translate it. Don't do this if
5752 IT->c itself comes from a display table, otherwise we could
5753 end up in an infinite recursion. (An alternative could be to
5754 count the recursion depth of this function and signal an
5755 error when a certain maximum depth is reached.) Is it worth
5757 if (success_p
&& it
->dpvec
== NULL
)
5762 && (dv
= DISP_CHAR_VECTOR (it
->dp
, it
->c
),
5765 struct Lisp_Vector
*v
= XVECTOR (dv
);
5767 /* Return the first character from the display table
5768 entry, if not empty. If empty, don't display the
5769 current character. */
5772 it
->dpvec_char_len
= it
->len
;
5773 it
->dpvec
= v
->contents
;
5774 it
->dpend
= v
->contents
+ v
->size
;
5775 it
->current
.dpvec_index
= 0;
5776 it
->dpvec_face_id
= -1;
5777 it
->saved_face_id
= it
->face_id
;
5778 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5783 set_iterator_to_next (it
, 0);
5788 /* Translate control characters into `\003' or `^C' form.
5789 Control characters coming from a display table entry are
5790 currently not translated because we use IT->dpvec to hold
5791 the translation. This could easily be changed but I
5792 don't believe that it is worth doing.
5794 If it->multibyte_p is nonzero, non-printable non-ASCII
5795 characters are also translated to octal form.
5797 If it->multibyte_p is zero, eight-bit characters that
5798 don't have corresponding multibyte char code are also
5799 translated to octal form. */
5800 else if ((it
->c
< ' '
5801 ? (it
->area
!= TEXT_AREA
5802 /* In mode line, treat \n, \t like other crl chars. */
5804 && it
->glyph_row
&& it
->glyph_row
->mode_line_p
)
5805 || (it
->c
!= '\n' && it
->c
!= '\t'))
5807 ? (!CHAR_PRINTABLE_P (it
->c
)
5808 || (!NILP (Vnobreak_char_display
)
5809 && (it
->c
== 0xA0 /* NO-BREAK SPACE */
5810 || it
->c
== 0xAD /* SOFT HYPHEN */)))
5812 && (! unibyte_display_via_language_environment
5813 || (UNIBYTE_CHAR_HAS_MULTIBYTE_P (it
->c
)))))))
5815 /* IT->c is a control character which must be displayed
5816 either as '\003' or as `^C' where the '\\' and '^'
5817 can be defined in the display table. Fill
5818 IT->ctl_chars with glyphs for what we have to
5819 display. Then, set IT->dpvec to these glyphs. */
5822 int face_id
, lface_id
= 0 ;
5825 /* Handle control characters with ^. */
5827 if (it
->c
< 128 && it
->ctl_arrow_p
)
5831 g
= '^'; /* default glyph for Control */
5832 /* Set IT->ctl_chars[0] to the glyph for `^'. */
5834 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5835 && GLYPH_CODE_CHAR_VALID_P (gc
))
5837 g
= GLYPH_CODE_CHAR (gc
);
5838 lface_id
= GLYPH_CODE_FACE (gc
);
5842 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
5844 else if (it
->f
== last_escape_glyph_frame
5845 && it
->face_id
== last_escape_glyph_face_id
)
5847 face_id
= last_escape_glyph_merged_face_id
;
5851 /* Merge the escape-glyph face into the current face. */
5852 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5854 last_escape_glyph_frame
= it
->f
;
5855 last_escape_glyph_face_id
= it
->face_id
;
5856 last_escape_glyph_merged_face_id
= face_id
;
5859 XSETINT (it
->ctl_chars
[0], g
);
5860 XSETINT (it
->ctl_chars
[1], it
->c
^ 0100);
5862 goto display_control
;
5865 /* Handle non-break space in the mode where it only gets
5868 if (EQ (Vnobreak_char_display
, Qt
)
5871 /* Merge the no-break-space face into the current face. */
5872 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
5876 XSETINT (it
->ctl_chars
[0], ' ');
5878 goto display_control
;
5881 /* Handle sequences that start with the "escape glyph". */
5883 /* the default escape glyph is \. */
5884 escape_glyph
= '\\';
5887 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5888 && GLYPH_CODE_CHAR_VALID_P (gc
))
5890 escape_glyph
= GLYPH_CODE_CHAR (gc
);
5891 lface_id
= GLYPH_CODE_FACE (gc
);
5895 /* The display table specified a face.
5896 Merge it into face_id and also into escape_glyph. */
5897 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
5900 else if (it
->f
== last_escape_glyph_frame
5901 && it
->face_id
== last_escape_glyph_face_id
)
5903 face_id
= last_escape_glyph_merged_face_id
;
5907 /* Merge the escape-glyph face into the current face. */
5908 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5910 last_escape_glyph_frame
= it
->f
;
5911 last_escape_glyph_face_id
= it
->face_id
;
5912 last_escape_glyph_merged_face_id
= face_id
;
5915 /* Handle soft hyphens in the mode where they only get
5918 if (EQ (Vnobreak_char_display
, Qt
)
5922 XSETINT (it
->ctl_chars
[0], '-');
5924 goto display_control
;
5927 /* Handle non-break space and soft hyphen
5928 with the escape glyph. */
5930 if (it
->c
== 0xA0 || it
->c
== 0xAD)
5932 XSETINT (it
->ctl_chars
[0], escape_glyph
);
5933 it
->c
= (it
->c
== 0xA0 ? ' ' : '-');
5934 XSETINT (it
->ctl_chars
[1], it
->c
);
5936 goto display_control
;
5940 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
5944 /* Set IT->ctl_chars[0] to the glyph for `\\'. */
5945 if (CHAR_BYTE8_P (it
->c
))
5947 str
[0] = CHAR_TO_BYTE8 (it
->c
);
5950 else if (it
->c
< 256)
5957 /* It's an invalid character, which shouldn't
5958 happen actually, but due to bugs it may
5959 happen. Let's print the char as is, there's
5960 not much meaningful we can do with it. */
5962 str
[1] = it
->c
>> 8;
5963 str
[2] = it
->c
>> 16;
5964 str
[3] = it
->c
>> 24;
5968 for (i
= 0; i
< len
; i
++)
5971 XSETINT (it
->ctl_chars
[i
* 4], escape_glyph
);
5972 /* Insert three more glyphs into IT->ctl_chars for
5973 the octal display of the character. */
5974 g
= ((str
[i
] >> 6) & 7) + '0';
5975 XSETINT (it
->ctl_chars
[i
* 4 + 1], g
);
5976 g
= ((str
[i
] >> 3) & 7) + '0';
5977 XSETINT (it
->ctl_chars
[i
* 4 + 2], g
);
5978 g
= (str
[i
] & 7) + '0';
5979 XSETINT (it
->ctl_chars
[i
* 4 + 3], g
);
5985 /* Set up IT->dpvec and return first character from it. */
5986 it
->dpvec_char_len
= it
->len
;
5987 it
->dpvec
= it
->ctl_chars
;
5988 it
->dpend
= it
->dpvec
+ ctl_len
;
5989 it
->current
.dpvec_index
= 0;
5990 it
->dpvec_face_id
= face_id
;
5991 it
->saved_face_id
= it
->face_id
;
5992 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5999 /* Adjust face id for a multibyte character. There are no multibyte
6000 character in unibyte text. */
6001 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
6004 && FRAME_WINDOW_P (it
->f
))
6006 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6007 int pos
= (it
->s
? -1
6008 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
6009 : IT_CHARPOS (*it
));
6011 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->c
, pos
, it
->string
);
6014 /* Is this character the last one of a run of characters with
6015 box? If yes, set IT->end_of_box_run_p to 1. */
6022 it
->end_of_box_run_p
6023 = ((face_id
= face_after_it_pos (it
),
6024 face_id
!= it
->face_id
)
6025 && (face
= FACE_FROM_ID (it
->f
, face_id
),
6026 face
->box
== FACE_NO_BOX
));
6029 /* Value is 0 if end of buffer or string reached. */
6034 /* Move IT to the next display element.
6036 RESEAT_P non-zero means if called on a newline in buffer text,
6037 skip to the next visible line start.
6039 Functions get_next_display_element and set_iterator_to_next are
6040 separate because I find this arrangement easier to handle than a
6041 get_next_display_element function that also increments IT's
6042 position. The way it is we can first look at an iterator's current
6043 display element, decide whether it fits on a line, and if it does,
6044 increment the iterator position. The other way around we probably
6045 would either need a flag indicating whether the iterator has to be
6046 incremented the next time, or we would have to implement a
6047 decrement position function which would not be easy to write. */
6050 set_iterator_to_next (it
, reseat_p
)
6054 /* Reset flags indicating start and end of a sequence of characters
6055 with box. Reset them at the start of this function because
6056 moving the iterator to a new position might set them. */
6057 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6061 case GET_FROM_BUFFER
:
6062 /* The current display element of IT is a character from
6063 current_buffer. Advance in the buffer, and maybe skip over
6064 invisible lines that are so because of selective display. */
6065 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6066 reseat_at_next_visible_line_start (it
, 0);
6069 xassert (it
->len
!= 0);
6070 IT_BYTEPOS (*it
) += it
->len
;
6071 IT_CHARPOS (*it
) += 1;
6072 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6076 case GET_FROM_COMPOSITION
:
6077 xassert (it
->cmp_id
>= 0 && it
->cmp_id
< n_compositions
);
6078 xassert (it
->sp
> 0);
6080 if (it
->method
== GET_FROM_STRING
)
6082 IT_STRING_BYTEPOS (*it
) += it
->len
;
6083 IT_STRING_CHARPOS (*it
) += it
->cmp_len
;
6084 goto consider_string_end
;
6086 else if (it
->method
== GET_FROM_BUFFER
)
6088 IT_BYTEPOS (*it
) += it
->len
;
6089 IT_CHARPOS (*it
) += it
->cmp_len
;
6093 case GET_FROM_C_STRING
:
6094 /* Current display element of IT is from a C string. */
6095 IT_BYTEPOS (*it
) += it
->len
;
6096 IT_CHARPOS (*it
) += 1;
6099 case GET_FROM_DISPLAY_VECTOR
:
6100 /* Current display element of IT is from a display table entry.
6101 Advance in the display table definition. Reset it to null if
6102 end reached, and continue with characters from buffers/
6104 ++it
->current
.dpvec_index
;
6106 /* Restore face of the iterator to what they were before the
6107 display vector entry (these entries may contain faces). */
6108 it
->face_id
= it
->saved_face_id
;
6110 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6112 int recheck_faces
= it
->ellipsis_p
;
6115 it
->method
= GET_FROM_C_STRING
;
6116 else if (STRINGP (it
->string
))
6117 it
->method
= GET_FROM_STRING
;
6120 it
->method
= GET_FROM_BUFFER
;
6121 it
->object
= it
->w
->buffer
;
6125 it
->current
.dpvec_index
= -1;
6127 /* Skip over characters which were displayed via IT->dpvec. */
6128 if (it
->dpvec_char_len
< 0)
6129 reseat_at_next_visible_line_start (it
, 1);
6130 else if (it
->dpvec_char_len
> 0)
6132 if (it
->method
== GET_FROM_STRING
6133 && it
->n_overlay_strings
> 0)
6134 it
->ignore_overlay_strings_at_pos_p
= 1;
6135 it
->len
= it
->dpvec_char_len
;
6136 set_iterator_to_next (it
, reseat_p
);
6139 /* Maybe recheck faces after display vector */
6141 it
->stop_charpos
= IT_CHARPOS (*it
);
6145 case GET_FROM_STRING
:
6146 /* Current display element is a character from a Lisp string. */
6147 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6148 IT_STRING_BYTEPOS (*it
) += it
->len
;
6149 IT_STRING_CHARPOS (*it
) += 1;
6151 consider_string_end
:
6153 if (it
->current
.overlay_string_index
>= 0)
6155 /* IT->string is an overlay string. Advance to the
6156 next, if there is one. */
6157 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6158 next_overlay_string (it
);
6162 /* IT->string is not an overlay string. If we reached
6163 its end, and there is something on IT->stack, proceed
6164 with what is on the stack. This can be either another
6165 string, this time an overlay string, or a buffer. */
6166 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
6170 if (it
->method
== GET_FROM_STRING
)
6171 goto consider_string_end
;
6176 case GET_FROM_IMAGE
:
6177 case GET_FROM_STRETCH
:
6178 /* The position etc with which we have to proceed are on
6179 the stack. The position may be at the end of a string,
6180 if the `display' property takes up the whole string. */
6181 xassert (it
->sp
> 0);
6183 if (it
->method
== GET_FROM_STRING
)
6184 goto consider_string_end
;
6188 /* There are no other methods defined, so this should be a bug. */
6192 xassert (it
->method
!= GET_FROM_STRING
6193 || (STRINGP (it
->string
)
6194 && IT_STRING_CHARPOS (*it
) >= 0));
6197 /* Load IT's display element fields with information about the next
6198 display element which comes from a display table entry or from the
6199 result of translating a control character to one of the forms `^C'
6202 IT->dpvec holds the glyphs to return as characters.
6203 IT->saved_face_id holds the face id before the display vector--
6204 it is restored into IT->face_idin set_iterator_to_next. */
6207 next_element_from_display_vector (it
)
6213 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
6215 it
->face_id
= it
->saved_face_id
;
6217 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
6218 That seemed totally bogus - so I changed it... */
6220 if ((gc
= it
->dpvec
[it
->current
.dpvec_index
], GLYPH_CODE_P (gc
))
6221 && GLYPH_CODE_CHAR_VALID_P (gc
))
6223 it
->c
= GLYPH_CODE_CHAR (gc
);
6224 it
->len
= CHAR_BYTES (it
->c
);
6226 /* The entry may contain a face id to use. Such a face id is
6227 the id of a Lisp face, not a realized face. A face id of
6228 zero means no face is specified. */
6229 if (it
->dpvec_face_id
>= 0)
6230 it
->face_id
= it
->dpvec_face_id
;
6233 int lface_id
= GLYPH_CODE_FACE (gc
);
6235 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6240 /* Display table entry is invalid. Return a space. */
6241 it
->c
= ' ', it
->len
= 1;
6243 /* Don't change position and object of the iterator here. They are
6244 still the values of the character that had this display table
6245 entry or was translated, and that's what we want. */
6246 it
->what
= IT_CHARACTER
;
6251 /* Load IT with the next display element from Lisp string IT->string.
6252 IT->current.string_pos is the current position within the string.
6253 If IT->current.overlay_string_index >= 0, the Lisp string is an
6257 next_element_from_string (it
)
6260 struct text_pos position
;
6262 xassert (STRINGP (it
->string
));
6263 xassert (IT_STRING_CHARPOS (*it
) >= 0);
6264 position
= it
->current
.string_pos
;
6266 /* Time to check for invisible text? */
6267 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
6268 && IT_STRING_CHARPOS (*it
) == it
->stop_charpos
)
6272 /* Since a handler may have changed IT->method, we must
6274 return GET_NEXT_DISPLAY_ELEMENT (it
);
6277 if (it
->current
.overlay_string_index
>= 0)
6279 /* Get the next character from an overlay string. In overlay
6280 strings, There is no field width or padding with spaces to
6282 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6287 else if (STRING_MULTIBYTE (it
->string
))
6289 int remaining
= SBYTES (it
->string
) - IT_STRING_BYTEPOS (*it
);
6290 const unsigned char *s
= (SDATA (it
->string
)
6291 + IT_STRING_BYTEPOS (*it
));
6292 it
->c
= string_char_and_length (s
, remaining
, &it
->len
);
6296 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6302 /* Get the next character from a Lisp string that is not an
6303 overlay string. Such strings come from the mode line, for
6304 example. We may have to pad with spaces, or truncate the
6305 string. See also next_element_from_c_string. */
6306 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
6311 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
6313 /* Pad with spaces. */
6314 it
->c
= ' ', it
->len
= 1;
6315 CHARPOS (position
) = BYTEPOS (position
) = -1;
6317 else if (STRING_MULTIBYTE (it
->string
))
6319 int maxlen
= SBYTES (it
->string
) - IT_STRING_BYTEPOS (*it
);
6320 const unsigned char *s
= (SDATA (it
->string
)
6321 + IT_STRING_BYTEPOS (*it
));
6322 it
->c
= string_char_and_length (s
, maxlen
, &it
->len
);
6326 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6331 /* Record what we have and where it came from. */
6332 it
->what
= IT_CHARACTER
;
6333 it
->object
= it
->string
;
6334 it
->position
= position
;
6339 /* Load IT with next display element from C string IT->s.
6340 IT->string_nchars is the maximum number of characters to return
6341 from the string. IT->end_charpos may be greater than
6342 IT->string_nchars when this function is called, in which case we
6343 may have to return padding spaces. Value is zero if end of string
6344 reached, including padding spaces. */
6347 next_element_from_c_string (it
)
6353 it
->what
= IT_CHARACTER
;
6354 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
6357 /* IT's position can be greater IT->string_nchars in case a field
6358 width or precision has been specified when the iterator was
6360 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6362 /* End of the game. */
6366 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
6368 /* Pad with spaces. */
6369 it
->c
= ' ', it
->len
= 1;
6370 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
6372 else if (it
->multibyte_p
)
6374 /* Implementation note: The calls to strlen apparently aren't a
6375 performance problem because there is no noticeable performance
6376 difference between Emacs running in unibyte or multibyte mode. */
6377 int maxlen
= strlen (it
->s
) - IT_BYTEPOS (*it
);
6378 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
),
6382 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
6388 /* Set up IT to return characters from an ellipsis, if appropriate.
6389 The definition of the ellipsis glyphs may come from a display table
6390 entry. This function Fills IT with the first glyph from the
6391 ellipsis if an ellipsis is to be displayed. */
6394 next_element_from_ellipsis (it
)
6397 if (it
->selective_display_ellipsis_p
)
6398 setup_for_ellipsis (it
, it
->len
);
6401 /* The face at the current position may be different from the
6402 face we find after the invisible text. Remember what it
6403 was in IT->saved_face_id, and signal that it's there by
6404 setting face_before_selective_p. */
6405 it
->saved_face_id
= it
->face_id
;
6406 it
->method
= GET_FROM_BUFFER
;
6407 it
->object
= it
->w
->buffer
;
6408 reseat_at_next_visible_line_start (it
, 1);
6409 it
->face_before_selective_p
= 1;
6412 return GET_NEXT_DISPLAY_ELEMENT (it
);
6416 /* Deliver an image display element. The iterator IT is already
6417 filled with image information (done in handle_display_prop). Value
6422 next_element_from_image (it
)
6425 it
->what
= IT_IMAGE
;
6430 /* Fill iterator IT with next display element from a stretch glyph
6431 property. IT->object is the value of the text property. Value is
6435 next_element_from_stretch (it
)
6438 it
->what
= IT_STRETCH
;
6443 /* Load IT with the next display element from current_buffer. Value
6444 is zero if end of buffer reached. IT->stop_charpos is the next
6445 position at which to stop and check for text properties or buffer
6449 next_element_from_buffer (it
)
6454 /* Check this assumption, otherwise, we would never enter the
6455 if-statement, below. */
6456 xassert (IT_CHARPOS (*it
) >= BEGV
6457 && IT_CHARPOS (*it
) <= it
->stop_charpos
);
6459 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
6461 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6463 int overlay_strings_follow_p
;
6465 /* End of the game, except when overlay strings follow that
6466 haven't been returned yet. */
6467 if (it
->overlay_strings_at_end_processed_p
)
6468 overlay_strings_follow_p
= 0;
6471 it
->overlay_strings_at_end_processed_p
= 1;
6472 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
6475 if (overlay_strings_follow_p
)
6476 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6480 it
->position
= it
->current
.pos
;
6487 return GET_NEXT_DISPLAY_ELEMENT (it
);
6492 /* No face changes, overlays etc. in sight, so just return a
6493 character from current_buffer. */
6496 /* Maybe run the redisplay end trigger hook. Performance note:
6497 This doesn't seem to cost measurable time. */
6498 if (it
->redisplay_end_trigger_charpos
6500 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
6501 run_redisplay_end_trigger_hook (it
);
6503 /* Get the next character, maybe multibyte. */
6504 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
6505 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
6507 int maxlen
= ((IT_BYTEPOS (*it
) >= GPT_BYTE
? ZV_BYTE
: GPT_BYTE
)
6508 - IT_BYTEPOS (*it
));
6509 it
->c
= string_char_and_length (p
, maxlen
, &it
->len
);
6512 it
->c
= *p
, it
->len
= 1;
6514 /* Record what we have and where it came from. */
6515 it
->what
= IT_CHARACTER
;
6516 it
->object
= it
->w
->buffer
;
6517 it
->position
= it
->current
.pos
;
6519 /* Normally we return the character found above, except when we
6520 really want to return an ellipsis for selective display. */
6525 /* A value of selective > 0 means hide lines indented more
6526 than that number of columns. */
6527 if (it
->selective
> 0
6528 && IT_CHARPOS (*it
) + 1 < ZV
6529 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
6530 IT_BYTEPOS (*it
) + 1,
6531 (double) it
->selective
)) /* iftc */
6533 success_p
= next_element_from_ellipsis (it
);
6534 it
->dpvec_char_len
= -1;
6537 else if (it
->c
== '\r' && it
->selective
== -1)
6539 /* A value of selective == -1 means that everything from the
6540 CR to the end of the line is invisible, with maybe an
6541 ellipsis displayed for it. */
6542 success_p
= next_element_from_ellipsis (it
);
6543 it
->dpvec_char_len
= -1;
6548 /* Value is zero if end of buffer reached. */
6549 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
6554 /* Run the redisplay end trigger hook for IT. */
6557 run_redisplay_end_trigger_hook (it
)
6560 Lisp_Object args
[3];
6562 /* IT->glyph_row should be non-null, i.e. we should be actually
6563 displaying something, or otherwise we should not run the hook. */
6564 xassert (it
->glyph_row
);
6566 /* Set up hook arguments. */
6567 args
[0] = Qredisplay_end_trigger_functions
;
6568 args
[1] = it
->window
;
6569 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
6570 it
->redisplay_end_trigger_charpos
= 0;
6572 /* Since we are *trying* to run these functions, don't try to run
6573 them again, even if they get an error. */
6574 it
->w
->redisplay_end_trigger
= Qnil
;
6575 Frun_hook_with_args (3, args
);
6577 /* Notice if it changed the face of the character we are on. */
6578 handle_face_prop (it
);
6582 /* Deliver a composition display element. The iterator IT is already
6583 filled with composition information (done in
6584 handle_composition_prop). Value is always 1. */
6587 next_element_from_composition (it
)
6590 it
->what
= IT_COMPOSITION
;
6591 it
->position
= (STRINGP (it
->string
)
6592 ? it
->current
.string_pos
6594 if (STRINGP (it
->string
))
6595 it
->object
= it
->string
;
6597 it
->object
= it
->w
->buffer
;
6603 /***********************************************************************
6604 Moving an iterator without producing glyphs
6605 ***********************************************************************/
6607 /* Check if iterator is at a position corresponding to a valid buffer
6608 position after some move_it_ call. */
6610 #define IT_POS_VALID_AFTER_MOVE_P(it) \
6611 ((it)->method == GET_FROM_STRING \
6612 ? IT_STRING_CHARPOS (*it) == 0 \
6616 /* Move iterator IT to a specified buffer or X position within one
6617 line on the display without producing glyphs.
6619 OP should be a bit mask including some or all of these bits:
6620 MOVE_TO_X: Stop on reaching x-position TO_X.
6621 MOVE_TO_POS: Stop on reaching buffer or string position TO_CHARPOS.
6622 Regardless of OP's value, stop in reaching the end of the display line.
6624 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
6625 This means, in particular, that TO_X includes window's horizontal
6628 The return value has several possible values that
6629 say what condition caused the scan to stop:
6631 MOVE_POS_MATCH_OR_ZV
6632 - when TO_POS or ZV was reached.
6635 -when TO_X was reached before TO_POS or ZV were reached.
6638 - when we reached the end of the display area and the line must
6642 - when we reached the end of the display area and the line is
6646 - when we stopped at a line end, i.e. a newline or a CR and selective
6649 static enum move_it_result
6650 move_it_in_display_line_to (struct it
*it
,
6651 EMACS_INT to_charpos
, int to_x
,
6652 enum move_operation_enum op
)
6654 enum move_it_result result
= MOVE_UNDEFINED
;
6655 struct glyph_row
*saved_glyph_row
;
6656 struct it wrap_it
, atpos_it
;
6659 /* Don't produce glyphs in produce_glyphs. */
6660 saved_glyph_row
= it
->glyph_row
;
6661 it
->glyph_row
= NULL
;
6663 /* Use wrap_it to save a copy of IT wherever a word wrap could
6664 occur. Use atpos_it to save a copy of IT at the desired
6665 position, if found, so that we can scan ahead and check if the
6666 word later overshoots the window edge. */
6670 #define BUFFER_POS_REACHED_P() \
6671 ((op & MOVE_TO_POS) != 0 \
6672 && BUFFERP (it->object) \
6673 && IT_CHARPOS (*it) >= to_charpos \
6674 && (it->method == GET_FROM_BUFFER \
6675 || (it->method == GET_FROM_DISPLAY_VECTOR \
6676 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
6681 int x
, i
, ascent
= 0, descent
= 0;
6683 /* Stop if we move beyond TO_CHARPOS (after an image or stretch glyph). */
6684 if ((op
& MOVE_TO_POS
) != 0
6685 && BUFFERP (it
->object
)
6686 && it
->method
== GET_FROM_BUFFER
6687 && IT_CHARPOS (*it
) > to_charpos
)
6689 if (it
->line_wrap
== WORD_WRAP
)
6691 /* If wrap_it is valid, the current position might be in
6692 a word that is wrapped to the next line, so continue
6693 to see if that happens. */
6696 result
= MOVE_POS_MATCH_OR_ZV
;
6699 if (atpos_it
.sp
< 0)
6704 result
= MOVE_POS_MATCH_OR_ZV
;
6709 /* Stop when ZV reached.
6710 We used to stop here when TO_CHARPOS reached as well, but that is
6711 too soon if this glyph does not fit on this line. So we handle it
6712 explicitly below. */
6713 if (!get_next_display_element (it
))
6715 result
= MOVE_POS_MATCH_OR_ZV
;
6719 if (it
->line_wrap
== TRUNCATE
)
6721 if (BUFFER_POS_REACHED_P ())
6723 result
= MOVE_POS_MATCH_OR_ZV
;
6729 /* Remember the line height so far in case the next element
6730 doesn't fit on the line. */
6731 ascent
= it
->max_ascent
;
6732 descent
= it
->max_descent
;
6734 if (it
->line_wrap
== WORD_WRAP
)
6736 if (it
->what
== IT_CHARACTER
6737 && (it
->c
== ' ' || it
->c
== '\t'))
6741 /* We are done if the position is already found. */
6742 if (atpos_it
.sp
>= 0)
6746 goto buffer_pos_reached
;
6754 /* The call to produce_glyphs will get the metrics of the
6755 display element IT is loaded with. Record the x-position
6756 before this display element, in case it doesn't fit on the
6760 PRODUCE_GLYPHS (it
);
6762 if (it
->area
!= TEXT_AREA
)
6764 set_iterator_to_next (it
, 1);
6768 /* The number of glyphs we get back in IT->nglyphs will normally
6769 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
6770 character on a terminal frame, or (iii) a line end. For the
6771 second case, IT->nglyphs - 1 padding glyphs will be present
6772 (on X frames, there is only one glyph produced for a
6773 composite character.
6775 The behavior implemented below means, for continuation lines,
6776 that as many spaces of a TAB as fit on the current line are
6777 displayed there. For terminal frames, as many glyphs of a
6778 multi-glyph character are displayed in the current line, too.
6779 This is what the old redisplay code did, and we keep it that
6780 way. Under X, the whole shape of a complex character must
6781 fit on the line or it will be completely displayed in the
6784 Note that both for tabs and padding glyphs, all glyphs have
6788 /* More than one glyph or glyph doesn't fit on line. All
6789 glyphs have the same width. */
6790 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
6792 int x_before_this_char
= x
;
6793 int hpos_before_this_char
= it
->hpos
;
6795 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
6797 new_x
= x
+ single_glyph_width
;
6799 /* We want to leave anything reaching TO_X to the caller. */
6800 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
6802 if (BUFFER_POS_REACHED_P ())
6804 if (it
->line_wrap
== WORD_WRAP
)
6807 goto buffer_pos_reached
;
6808 if (atpos_it
.sp
< 0)
6812 goto buffer_pos_reached
;
6815 result
= MOVE_X_REACHED
;
6819 if (/* Lines are continued. */
6820 it
->line_wrap
!= TRUNCATE
6821 && (/* And glyph doesn't fit on the line. */
6822 new_x
> it
->last_visible_x
6823 /* Or it fits exactly and we're on a window
6825 || (new_x
== it
->last_visible_x
6826 && FRAME_WINDOW_P (it
->f
))))
6828 if (/* IT->hpos == 0 means the very first glyph
6829 doesn't fit on the line, e.g. a wide image. */
6831 || (new_x
== it
->last_visible_x
6832 && FRAME_WINDOW_P (it
->f
)))
6835 it
->current_x
= new_x
;
6837 /* The character's last glyph just barely fits
6839 if (i
== it
->nglyphs
- 1)
6841 /* If this is the destination position,
6842 return a position *before* it in this row,
6843 now that we know it fits in this row. */
6844 if (BUFFER_POS_REACHED_P ())
6846 it
->hpos
= hpos_before_this_char
;
6847 it
->current_x
= x_before_this_char
;
6848 result
= MOVE_POS_MATCH_OR_ZV
;
6852 set_iterator_to_next (it
, 1);
6853 #ifdef HAVE_WINDOW_SYSTEM
6854 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
6856 if (!get_next_display_element (it
))
6858 result
= MOVE_POS_MATCH_OR_ZV
;
6861 if (BUFFER_POS_REACHED_P ())
6863 if (ITERATOR_AT_END_OF_LINE_P (it
))
6864 result
= MOVE_POS_MATCH_OR_ZV
;
6866 result
= MOVE_LINE_CONTINUED
;
6869 if (ITERATOR_AT_END_OF_LINE_P (it
))
6871 result
= MOVE_NEWLINE_OR_CR
;
6875 #endif /* HAVE_WINDOW_SYSTEM */
6881 it
->max_ascent
= ascent
;
6882 it
->max_descent
= descent
;
6885 if (wrap_it
.sp
>= 0)
6891 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
6893 result
= MOVE_LINE_CONTINUED
;
6897 if (BUFFER_POS_REACHED_P ())
6899 if (it
->line_wrap
== WORD_WRAP
)
6902 goto buffer_pos_reached
;
6903 if (atpos_it
.sp
< 0)
6907 goto buffer_pos_reached
;
6910 if (new_x
> it
->first_visible_x
)
6912 /* Glyph is visible. Increment number of glyphs that
6913 would be displayed. */
6918 if (result
!= MOVE_UNDEFINED
)
6921 else if (BUFFER_POS_REACHED_P ())
6925 it
->max_ascent
= ascent
;
6926 it
->max_descent
= descent
;
6927 result
= MOVE_POS_MATCH_OR_ZV
;
6930 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
6932 /* Stop when TO_X specified and reached. This check is
6933 necessary here because of lines consisting of a line end,
6934 only. The line end will not produce any glyphs and we
6935 would never get MOVE_X_REACHED. */
6936 xassert (it
->nglyphs
== 0);
6937 result
= MOVE_X_REACHED
;
6941 /* Is this a line end? If yes, we're done. */
6942 if (ITERATOR_AT_END_OF_LINE_P (it
))
6944 result
= MOVE_NEWLINE_OR_CR
;
6948 /* The current display element has been consumed. Advance
6950 set_iterator_to_next (it
, 1);
6952 /* Stop if lines are truncated and IT's current x-position is
6953 past the right edge of the window now. */
6954 if (it
->line_wrap
== TRUNCATE
6955 && it
->current_x
>= it
->last_visible_x
)
6957 #ifdef HAVE_WINDOW_SYSTEM
6958 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
6960 if (!get_next_display_element (it
)
6961 || BUFFER_POS_REACHED_P ())
6963 result
= MOVE_POS_MATCH_OR_ZV
;
6966 if (ITERATOR_AT_END_OF_LINE_P (it
))
6968 result
= MOVE_NEWLINE_OR_CR
;
6972 #endif /* HAVE_WINDOW_SYSTEM */
6973 result
= MOVE_LINE_TRUNCATED
;
6978 #undef BUFFER_POS_REACHED_P
6980 /* If we scanned beyond to_pos and didn't find a point to wrap at,
6981 return iterator at to_pos. */
6982 if (atpos_it
.sp
>= 0)
6985 /* Restore the iterator settings altered at the beginning of this
6987 it
->glyph_row
= saved_glyph_row
;
6991 /* For external use. */
6993 move_it_in_display_line (struct it
*it
,
6994 EMACS_INT to_charpos
, int to_x
,
6995 enum move_operation_enum op
)
6997 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7001 /* Move IT forward until it satisfies one or more of the criteria in
7002 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
7004 OP is a bit-mask that specifies where to stop, and in particular,
7005 which of those four position arguments makes a difference. See the
7006 description of enum move_operation_enum.
7008 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
7009 screen line, this function will set IT to the next position >
7013 move_it_to (it
, to_charpos
, to_x
, to_y
, to_vpos
, op
)
7015 int to_charpos
, to_x
, to_y
, to_vpos
;
7018 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
7024 if (op
& MOVE_TO_VPOS
)
7026 /* If no TO_CHARPOS and no TO_X specified, stop at the
7027 start of the line TO_VPOS. */
7028 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
7030 if (it
->vpos
== to_vpos
)
7036 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
7040 /* TO_VPOS >= 0 means stop at TO_X in the line at
7041 TO_VPOS, or at TO_POS, whichever comes first. */
7042 if (it
->vpos
== to_vpos
)
7048 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7050 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
7055 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
7057 /* We have reached TO_X but not in the line we want. */
7058 skip
= move_it_in_display_line_to (it
, to_charpos
,
7060 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7068 else if (op
& MOVE_TO_Y
)
7070 struct it it_backup
;
7072 /* TO_Y specified means stop at TO_X in the line containing
7073 TO_Y---or at TO_CHARPOS if this is reached first. The
7074 problem is that we can't really tell whether the line
7075 contains TO_Y before we have completely scanned it, and
7076 this may skip past TO_X. What we do is to first scan to
7079 If TO_X is not specified, use a TO_X of zero. The reason
7080 is to make the outcome of this function more predictable.
7081 If we didn't use TO_X == 0, we would stop at the end of
7082 the line which is probably not what a caller would expect
7084 skip
= move_it_in_display_line_to (it
, to_charpos
,
7088 | (op
& MOVE_TO_POS
)));
7090 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
7091 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7097 /* If TO_X was reached, we would like to know whether TO_Y
7098 is in the line. This can only be said if we know the
7099 total line height which requires us to scan the rest of
7101 if (skip
== MOVE_X_REACHED
)
7103 /* Wait! We can conclude that TO_Y is in the line if
7104 the already scanned glyphs make the line tall enough
7105 because further scanning doesn't make it shorter. */
7106 line_height
= it
->max_ascent
+ it
->max_descent
;
7107 if (to_y
>= it
->current_y
7108 && to_y
< it
->current_y
+ line_height
)
7114 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
7115 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
7117 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
7120 /* Now, decide whether TO_Y is in this line. */
7121 line_height
= it
->max_ascent
+ it
->max_descent
;
7122 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7124 if (to_y
>= it
->current_y
7125 && to_y
< it
->current_y
+ line_height
)
7127 if (skip
== MOVE_X_REACHED
)
7128 /* If TO_Y is in this line and TO_X was reached above,
7129 we scanned too far. We have to restore IT's settings
7130 to the ones before skipping. */
7134 else if (skip
== MOVE_X_REACHED
)
7137 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7144 else if (BUFFERP (it
->object
)
7145 && it
->method
== GET_FROM_BUFFER
7146 && IT_CHARPOS (*it
) >= to_charpos
)
7147 skip
= MOVE_POS_MATCH_OR_ZV
;
7149 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
7153 case MOVE_POS_MATCH_OR_ZV
:
7157 case MOVE_NEWLINE_OR_CR
:
7158 set_iterator_to_next (it
, 1);
7159 it
->continuation_lines_width
= 0;
7162 case MOVE_LINE_TRUNCATED
:
7163 it
->continuation_lines_width
= 0;
7164 reseat_at_next_visible_line_start (it
, 0);
7165 if ((op
& MOVE_TO_POS
) != 0
7166 && IT_CHARPOS (*it
) > to_charpos
)
7173 case MOVE_LINE_CONTINUED
:
7174 /* For continued lines ending in a tab, some of the glyphs
7175 associated with the tab are displayed on the current
7176 line. Since it->current_x does not include these glyphs,
7177 we use it->last_visible_x instead. */
7178 it
->continuation_lines_width
+=
7179 (it
->c
== '\t') ? it
->last_visible_x
: it
->current_x
;
7186 /* Reset/increment for the next run. */
7187 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
7188 it
->current_x
= it
->hpos
= 0;
7189 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7191 last_height
= it
->max_ascent
+ it
->max_descent
;
7192 last_max_ascent
= it
->max_ascent
;
7193 it
->max_ascent
= it
->max_descent
= 0;
7198 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
7202 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
7204 If DY > 0, move IT backward at least that many pixels. DY = 0
7205 means move IT backward to the preceding line start or BEGV. This
7206 function may move over more than DY pixels if IT->current_y - DY
7207 ends up in the middle of a line; in this case IT->current_y will be
7208 set to the top of the line moved to. */
7211 move_it_vertically_backward (it
, dy
)
7222 start_pos
= IT_CHARPOS (*it
);
7224 /* Estimate how many newlines we must move back. */
7225 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
7227 /* Set the iterator's position that many lines back. */
7228 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
7229 back_to_previous_visible_line_start (it
);
7231 /* Reseat the iterator here. When moving backward, we don't want
7232 reseat to skip forward over invisible text, set up the iterator
7233 to deliver from overlay strings at the new position etc. So,
7234 use reseat_1 here. */
7235 reseat_1 (it
, it
->current
.pos
, 1);
7237 /* We are now surely at a line start. */
7238 it
->current_x
= it
->hpos
= 0;
7239 it
->continuation_lines_width
= 0;
7241 /* Move forward and see what y-distance we moved. First move to the
7242 start of the next line so that we get its height. We need this
7243 height to be able to tell whether we reached the specified
7246 it2
.max_ascent
= it2
.max_descent
= 0;
7249 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
7250 MOVE_TO_POS
| MOVE_TO_VPOS
);
7252 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
7253 xassert (IT_CHARPOS (*it
) >= BEGV
);
7256 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
7257 xassert (IT_CHARPOS (*it
) >= BEGV
);
7258 /* H is the actual vertical distance from the position in *IT
7259 and the starting position. */
7260 h
= it2
.current_y
- it
->current_y
;
7261 /* NLINES is the distance in number of lines. */
7262 nlines
= it2
.vpos
- it
->vpos
;
7264 /* Correct IT's y and vpos position
7265 so that they are relative to the starting point. */
7271 /* DY == 0 means move to the start of the screen line. The
7272 value of nlines is > 0 if continuation lines were involved. */
7274 move_it_by_lines (it
, nlines
, 1);
7276 /* I think this assert is bogus if buffer contains
7277 invisible text or images. KFS. */
7278 xassert (IT_CHARPOS (*it
) <= start_pos
);
7283 /* The y-position we try to reach, relative to *IT.
7284 Note that H has been subtracted in front of the if-statement. */
7285 int target_y
= it
->current_y
+ h
- dy
;
7286 int y0
= it3
.current_y
;
7287 int y1
= line_bottom_y (&it3
);
7288 int line_height
= y1
- y0
;
7290 /* If we did not reach target_y, try to move further backward if
7291 we can. If we moved too far backward, try to move forward. */
7292 if (target_y
< it
->current_y
7293 /* This is heuristic. In a window that's 3 lines high, with
7294 a line height of 13 pixels each, recentering with point
7295 on the bottom line will try to move -39/2 = 19 pixels
7296 backward. Try to avoid moving into the first line. */
7297 && (it
->current_y
- target_y
7298 > min (window_box_height (it
->w
), line_height
* 2 / 3))
7299 && IT_CHARPOS (*it
) > BEGV
)
7301 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
7302 target_y
- it
->current_y
));
7303 dy
= it
->current_y
- target_y
;
7304 goto move_further_back
;
7306 else if (target_y
>= it
->current_y
+ line_height
7307 && IT_CHARPOS (*it
) < ZV
)
7309 /* Should move forward by at least one line, maybe more.
7311 Note: Calling move_it_by_lines can be expensive on
7312 terminal frames, where compute_motion is used (via
7313 vmotion) to do the job, when there are very long lines
7314 and truncate-lines is nil. That's the reason for
7315 treating terminal frames specially here. */
7317 if (!FRAME_WINDOW_P (it
->f
))
7318 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
7323 move_it_by_lines (it
, 1, 1);
7325 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
7329 /* I think this assert is bogus if buffer contains
7330 invisible text or images. KFS. */
7331 xassert (IT_CHARPOS (*it
) >= BEGV
);
7338 /* Move IT by a specified amount of pixel lines DY. DY negative means
7339 move backwards. DY = 0 means move to start of screen line. At the
7340 end, IT will be on the start of a screen line. */
7343 move_it_vertically (it
, dy
)
7348 move_it_vertically_backward (it
, -dy
);
7351 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
7352 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
7353 MOVE_TO_POS
| MOVE_TO_Y
);
7354 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
7356 /* If buffer ends in ZV without a newline, move to the start of
7357 the line to satisfy the post-condition. */
7358 if (IT_CHARPOS (*it
) == ZV
7360 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
7361 move_it_by_lines (it
, 0, 0);
7366 /* Move iterator IT past the end of the text line it is in. */
7369 move_it_past_eol (it
)
7372 enum move_it_result rc
;
7374 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
7375 if (rc
== MOVE_NEWLINE_OR_CR
)
7376 set_iterator_to_next (it
, 0);
7380 #if 0 /* Currently not used. */
7382 /* Return non-zero if some text between buffer positions START_CHARPOS
7383 and END_CHARPOS is invisible. IT->window is the window for text
7387 invisible_text_between_p (it
, start_charpos
, end_charpos
)
7389 int start_charpos
, end_charpos
;
7391 Lisp_Object prop
, limit
;
7392 int invisible_found_p
;
7394 xassert (it
!= NULL
&& start_charpos
<= end_charpos
);
7396 /* Is text at START invisible? */
7397 prop
= Fget_char_property (make_number (start_charpos
), Qinvisible
,
7399 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
7400 invisible_found_p
= 1;
7403 limit
= Fnext_single_char_property_change (make_number (start_charpos
),
7405 make_number (end_charpos
));
7406 invisible_found_p
= XFASTINT (limit
) < end_charpos
;
7409 return invisible_found_p
;
7415 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
7416 negative means move up. DVPOS == 0 means move to the start of the
7417 screen line. NEED_Y_P non-zero means calculate IT->current_y. If
7418 NEED_Y_P is zero, IT->current_y will be left unchanged.
7420 Further optimization ideas: If we would know that IT->f doesn't use
7421 a face with proportional font, we could be faster for
7422 truncate-lines nil. */
7425 move_it_by_lines (it
, dvpos
, need_y_p
)
7427 int dvpos
, need_y_p
;
7429 struct position pos
;
7431 /* The commented-out optimization uses vmotion on terminals. This
7432 gives bad results, because elements like it->what, on which
7433 callers such as pos_visible_p rely, aren't updated. */
7434 /* if (!FRAME_WINDOW_P (it->f))
7436 struct text_pos textpos;
7438 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
7439 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
7440 reseat (it, textpos, 1);
7441 it->vpos += pos.vpos;
7442 it->current_y += pos.vpos;
7448 /* DVPOS == 0 means move to the start of the screen line. */
7449 move_it_vertically_backward (it
, 0);
7450 xassert (it
->current_x
== 0 && it
->hpos
== 0);
7451 /* Let next call to line_bottom_y calculate real line height */
7456 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
7457 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
7458 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
7463 int start_charpos
, i
;
7465 /* Start at the beginning of the screen line containing IT's
7466 position. This may actually move vertically backwards,
7467 in case of overlays, so adjust dvpos accordingly. */
7469 move_it_vertically_backward (it
, 0);
7472 /* Go back -DVPOS visible lines and reseat the iterator there. */
7473 start_charpos
= IT_CHARPOS (*it
);
7474 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
7475 back_to_previous_visible_line_start (it
);
7476 reseat (it
, it
->current
.pos
, 1);
7478 /* Move further back if we end up in a string or an image. */
7479 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
7481 /* First try to move to start of display line. */
7483 move_it_vertically_backward (it
, 0);
7485 if (IT_POS_VALID_AFTER_MOVE_P (it
))
7487 /* If start of line is still in string or image,
7488 move further back. */
7489 back_to_previous_visible_line_start (it
);
7490 reseat (it
, it
->current
.pos
, 1);
7494 it
->current_x
= it
->hpos
= 0;
7496 /* Above call may have moved too far if continuation lines
7497 are involved. Scan forward and see if it did. */
7499 it2
.vpos
= it2
.current_y
= 0;
7500 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
7501 it
->vpos
-= it2
.vpos
;
7502 it
->current_y
-= it2
.current_y
;
7503 it
->current_x
= it
->hpos
= 0;
7505 /* If we moved too far back, move IT some lines forward. */
7506 if (it2
.vpos
> -dvpos
)
7508 int delta
= it2
.vpos
+ dvpos
;
7510 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
7511 /* Move back again if we got too far ahead. */
7512 if (IT_CHARPOS (*it
) >= start_charpos
)
7518 /* Return 1 if IT points into the middle of a display vector. */
7521 in_display_vector_p (it
)
7524 return (it
->method
== GET_FROM_DISPLAY_VECTOR
7525 && it
->current
.dpvec_index
> 0
7526 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
7530 /***********************************************************************
7532 ***********************************************************************/
7535 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
7539 add_to_log (format
, arg1
, arg2
)
7541 Lisp_Object arg1
, arg2
;
7543 Lisp_Object args
[3];
7544 Lisp_Object msg
, fmt
;
7547 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
7550 /* Do nothing if called asynchronously. Inserting text into
7551 a buffer may call after-change-functions and alike and
7552 that would means running Lisp asynchronously. */
7553 if (handling_signal
)
7557 GCPRO4 (fmt
, msg
, arg1
, arg2
);
7559 args
[0] = fmt
= build_string (format
);
7562 msg
= Fformat (3, args
);
7564 len
= SBYTES (msg
) + 1;
7565 SAFE_ALLOCA (buffer
, char *, len
);
7566 bcopy (SDATA (msg
), buffer
, len
);
7568 message_dolog (buffer
, len
- 1, 1, 0);
7575 /* Output a newline in the *Messages* buffer if "needs" one. */
7578 message_log_maybe_newline ()
7580 if (message_log_need_newline
)
7581 message_dolog ("", 0, 1, 0);
7585 /* Add a string M of length NBYTES to the message log, optionally
7586 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
7587 nonzero, means interpret the contents of M as multibyte. This
7588 function calls low-level routines in order to bypass text property
7589 hooks, etc. which might not be safe to run.
7591 This may GC (insert may run before/after change hooks),
7592 so the buffer M must NOT point to a Lisp string. */
7595 message_dolog (m
, nbytes
, nlflag
, multibyte
)
7597 int nbytes
, nlflag
, multibyte
;
7599 if (!NILP (Vmemory_full
))
7602 if (!NILP (Vmessage_log_max
))
7604 struct buffer
*oldbuf
;
7605 Lisp_Object oldpoint
, oldbegv
, oldzv
;
7606 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
7607 int point_at_end
= 0;
7609 Lisp_Object old_deactivate_mark
, tem
;
7610 struct gcpro gcpro1
;
7612 old_deactivate_mark
= Vdeactivate_mark
;
7613 oldbuf
= current_buffer
;
7614 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
7615 current_buffer
->undo_list
= Qt
;
7617 oldpoint
= message_dolog_marker1
;
7618 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
7619 oldbegv
= message_dolog_marker2
;
7620 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
7621 oldzv
= message_dolog_marker3
;
7622 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
7623 GCPRO1 (old_deactivate_mark
);
7631 BEGV_BYTE
= BEG_BYTE
;
7634 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
7636 /* Insert the string--maybe converting multibyte to single byte
7637 or vice versa, so that all the text fits the buffer. */
7639 && NILP (current_buffer
->enable_multibyte_characters
))
7641 int i
, c
, char_bytes
;
7642 unsigned char work
[1];
7644 /* Convert a multibyte string to single-byte
7645 for the *Message* buffer. */
7646 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
7648 c
= string_char_and_length (m
+ i
, nbytes
- i
, &char_bytes
);
7649 work
[0] = (ASCII_CHAR_P (c
)
7651 : multibyte_char_to_unibyte (c
, Qnil
));
7652 insert_1_both (work
, 1, 1, 1, 0, 0);
7655 else if (! multibyte
7656 && ! NILP (current_buffer
->enable_multibyte_characters
))
7658 int i
, c
, char_bytes
;
7659 unsigned char *msg
= (unsigned char *) m
;
7660 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
7661 /* Convert a single-byte string to multibyte
7662 for the *Message* buffer. */
7663 for (i
= 0; i
< nbytes
; i
++)
7666 c
= unibyte_char_to_multibyte (c
);
7667 char_bytes
= CHAR_STRING (c
, str
);
7668 insert_1_both (str
, 1, char_bytes
, 1, 0, 0);
7672 insert_1 (m
, nbytes
, 1, 0, 0);
7676 int this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
, dup
;
7677 insert_1 ("\n", 1, 1, 0, 0);
7679 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
7681 this_bol_byte
= PT_BYTE
;
7683 /* See if this line duplicates the previous one.
7684 If so, combine duplicates. */
7687 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
7689 prev_bol_byte
= PT_BYTE
;
7691 dup
= message_log_check_duplicate (prev_bol
, prev_bol_byte
,
7692 this_bol
, this_bol_byte
);
7695 del_range_both (prev_bol
, prev_bol_byte
,
7696 this_bol
, this_bol_byte
, 0);
7702 /* If you change this format, don't forget to also
7703 change message_log_check_duplicate. */
7704 sprintf (dupstr
, " [%d times]", dup
);
7705 duplen
= strlen (dupstr
);
7706 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
7707 insert_1 (dupstr
, duplen
, 1, 0, 1);
7712 /* If we have more than the desired maximum number of lines
7713 in the *Messages* buffer now, delete the oldest ones.
7714 This is safe because we don't have undo in this buffer. */
7716 if (NATNUMP (Vmessage_log_max
))
7718 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
7719 -XFASTINT (Vmessage_log_max
) - 1, 0);
7720 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
7723 BEGV
= XMARKER (oldbegv
)->charpos
;
7724 BEGV_BYTE
= marker_byte_position (oldbegv
);
7733 ZV
= XMARKER (oldzv
)->charpos
;
7734 ZV_BYTE
= marker_byte_position (oldzv
);
7738 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
7740 /* We can't do Fgoto_char (oldpoint) because it will run some
7742 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
7743 XMARKER (oldpoint
)->bytepos
);
7746 unchain_marker (XMARKER (oldpoint
));
7747 unchain_marker (XMARKER (oldbegv
));
7748 unchain_marker (XMARKER (oldzv
));
7750 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
7751 set_buffer_internal (oldbuf
);
7753 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
7754 message_log_need_newline
= !nlflag
;
7755 Vdeactivate_mark
= old_deactivate_mark
;
7760 /* We are at the end of the buffer after just having inserted a newline.
7761 (Note: We depend on the fact we won't be crossing the gap.)
7762 Check to see if the most recent message looks a lot like the previous one.
7763 Return 0 if different, 1 if the new one should just replace it, or a
7764 value N > 1 if we should also append " [N times]". */
7767 message_log_check_duplicate (prev_bol
, prev_bol_byte
, this_bol
, this_bol_byte
)
7768 int prev_bol
, this_bol
;
7769 int prev_bol_byte
, this_bol_byte
;
7772 int len
= Z_BYTE
- 1 - this_bol_byte
;
7774 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
7775 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
7777 for (i
= 0; i
< len
; i
++)
7779 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
7787 if (*p1
++ == ' ' && *p1
++ == '[')
7790 while (*p1
>= '0' && *p1
<= '9')
7791 n
= n
* 10 + *p1
++ - '0';
7792 if (strncmp (p1
, " times]\n", 8) == 0)
7799 /* Display an echo area message M with a specified length of NBYTES
7800 bytes. The string may include null characters. If M is 0, clear
7801 out any existing message, and let the mini-buffer text show
7804 This may GC, so the buffer M must NOT point to a Lisp string. */
7807 message2 (m
, nbytes
, multibyte
)
7812 /* First flush out any partial line written with print. */
7813 message_log_maybe_newline ();
7815 message_dolog (m
, nbytes
, 1, multibyte
);
7816 message2_nolog (m
, nbytes
, multibyte
);
7820 /* The non-logging counterpart of message2. */
7823 message2_nolog (m
, nbytes
, multibyte
)
7825 int nbytes
, multibyte
;
7827 struct frame
*sf
= SELECTED_FRAME ();
7828 message_enable_multibyte
= multibyte
;
7832 if (noninteractive_need_newline
)
7833 putc ('\n', stderr
);
7834 noninteractive_need_newline
= 0;
7836 fwrite (m
, nbytes
, 1, stderr
);
7837 if (cursor_in_echo_area
== 0)
7838 fprintf (stderr
, "\n");
7841 /* A null message buffer means that the frame hasn't really been
7842 initialized yet. Error messages get reported properly by
7843 cmd_error, so this must be just an informative message; toss it. */
7844 else if (INTERACTIVE
7845 && sf
->glyphs_initialized_p
7846 && FRAME_MESSAGE_BUF (sf
))
7848 Lisp_Object mini_window
;
7851 /* Get the frame containing the mini-buffer
7852 that the selected frame is using. */
7853 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
7854 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
7856 FRAME_SAMPLE_VISIBILITY (f
);
7857 if (FRAME_VISIBLE_P (sf
)
7858 && ! FRAME_VISIBLE_P (f
))
7859 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
7863 set_message (m
, Qnil
, nbytes
, multibyte
);
7864 if (minibuffer_auto_raise
)
7865 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
7868 clear_message (1, 1);
7870 do_pending_window_change (0);
7871 echo_area_display (1);
7872 do_pending_window_change (0);
7873 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
7874 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
7879 /* Display an echo area message M with a specified length of NBYTES
7880 bytes. The string may include null characters. If M is not a
7881 string, clear out any existing message, and let the mini-buffer
7884 This function cancels echoing. */
7887 message3 (m
, nbytes
, multibyte
)
7892 struct gcpro gcpro1
;
7895 clear_message (1,1);
7898 /* First flush out any partial line written with print. */
7899 message_log_maybe_newline ();
7905 SAFE_ALLOCA (buffer
, char *, nbytes
);
7906 bcopy (SDATA (m
), buffer
, nbytes
);
7907 message_dolog (buffer
, nbytes
, 1, multibyte
);
7910 message3_nolog (m
, nbytes
, multibyte
);
7916 /* The non-logging version of message3.
7917 This does not cancel echoing, because it is used for echoing.
7918 Perhaps we need to make a separate function for echoing
7919 and make this cancel echoing. */
7922 message3_nolog (m
, nbytes
, multibyte
)
7924 int nbytes
, multibyte
;
7926 struct frame
*sf
= SELECTED_FRAME ();
7927 message_enable_multibyte
= multibyte
;
7931 if (noninteractive_need_newline
)
7932 putc ('\n', stderr
);
7933 noninteractive_need_newline
= 0;
7935 fwrite (SDATA (m
), nbytes
, 1, stderr
);
7936 if (cursor_in_echo_area
== 0)
7937 fprintf (stderr
, "\n");
7940 /* A null message buffer means that the frame hasn't really been
7941 initialized yet. Error messages get reported properly by
7942 cmd_error, so this must be just an informative message; toss it. */
7943 else if (INTERACTIVE
7944 && sf
->glyphs_initialized_p
7945 && FRAME_MESSAGE_BUF (sf
))
7947 Lisp_Object mini_window
;
7951 /* Get the frame containing the mini-buffer
7952 that the selected frame is using. */
7953 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
7954 frame
= XWINDOW (mini_window
)->frame
;
7957 FRAME_SAMPLE_VISIBILITY (f
);
7958 if (FRAME_VISIBLE_P (sf
)
7959 && !FRAME_VISIBLE_P (f
))
7960 Fmake_frame_visible (frame
);
7962 if (STRINGP (m
) && SCHARS (m
) > 0)
7964 set_message (NULL
, m
, nbytes
, multibyte
);
7965 if (minibuffer_auto_raise
)
7966 Fraise_frame (frame
);
7967 /* Assume we are not echoing.
7968 (If we are, echo_now will override this.) */
7969 echo_message_buffer
= Qnil
;
7972 clear_message (1, 1);
7974 do_pending_window_change (0);
7975 echo_area_display (1);
7976 do_pending_window_change (0);
7977 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
7978 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
7983 /* Display a null-terminated echo area message M. If M is 0, clear
7984 out any existing message, and let the mini-buffer text show through.
7986 The buffer M must continue to exist until after the echo area gets
7987 cleared or some other message gets displayed there. Do not pass
7988 text that is stored in a Lisp string. Do not pass text in a buffer
7989 that was alloca'd. */
7995 message2 (m
, (m
? strlen (m
) : 0), 0);
7999 /* The non-logging counterpart of message1. */
8005 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
8008 /* Display a message M which contains a single %s
8009 which gets replaced with STRING. */
8012 message_with_string (m
, string
, log
)
8017 CHECK_STRING (string
);
8023 if (noninteractive_need_newline
)
8024 putc ('\n', stderr
);
8025 noninteractive_need_newline
= 0;
8026 fprintf (stderr
, m
, SDATA (string
));
8027 if (cursor_in_echo_area
== 0)
8028 fprintf (stderr
, "\n");
8032 else if (INTERACTIVE
)
8034 /* The frame whose minibuffer we're going to display the message on.
8035 It may be larger than the selected frame, so we need
8036 to use its buffer, not the selected frame's buffer. */
8037 Lisp_Object mini_window
;
8038 struct frame
*f
, *sf
= SELECTED_FRAME ();
8040 /* Get the frame containing the minibuffer
8041 that the selected frame is using. */
8042 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8043 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8045 /* A null message buffer means that the frame hasn't really been
8046 initialized yet. Error messages get reported properly by
8047 cmd_error, so this must be just an informative message; toss it. */
8048 if (FRAME_MESSAGE_BUF (f
))
8050 Lisp_Object args
[2], message
;
8051 struct gcpro gcpro1
, gcpro2
;
8053 args
[0] = build_string (m
);
8054 args
[1] = message
= string
;
8055 GCPRO2 (args
[0], message
);
8058 message
= Fformat (2, args
);
8061 message3 (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
8063 message3_nolog (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
8067 /* Print should start at the beginning of the message
8068 buffer next time. */
8069 message_buf_print
= 0;
8075 /* Dump an informative message to the minibuf. If M is 0, clear out
8076 any existing message, and let the mini-buffer text show through. */
8080 message (m
, a1
, a2
, a3
)
8082 EMACS_INT a1
, a2
, a3
;
8088 if (noninteractive_need_newline
)
8089 putc ('\n', stderr
);
8090 noninteractive_need_newline
= 0;
8091 fprintf (stderr
, m
, a1
, a2
, a3
);
8092 if (cursor_in_echo_area
== 0)
8093 fprintf (stderr
, "\n");
8097 else if (INTERACTIVE
)
8099 /* The frame whose mini-buffer we're going to display the message
8100 on. It may be larger than the selected frame, so we need to
8101 use its buffer, not the selected frame's buffer. */
8102 Lisp_Object mini_window
;
8103 struct frame
*f
, *sf
= SELECTED_FRAME ();
8105 /* Get the frame containing the mini-buffer
8106 that the selected frame is using. */
8107 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8108 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8110 /* A null message buffer means that the frame hasn't really been
8111 initialized yet. Error messages get reported properly by
8112 cmd_error, so this must be just an informative message; toss
8114 if (FRAME_MESSAGE_BUF (f
))
8125 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8126 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3, a
);
8128 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8129 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3,
8131 #endif /* NO_ARG_ARRAY */
8133 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
8138 /* Print should start at the beginning of the message
8139 buffer next time. */
8140 message_buf_print
= 0;
8146 /* The non-logging version of message. */
8149 message_nolog (m
, a1
, a2
, a3
)
8151 EMACS_INT a1
, a2
, a3
;
8153 Lisp_Object old_log_max
;
8154 old_log_max
= Vmessage_log_max
;
8155 Vmessage_log_max
= Qnil
;
8156 message (m
, a1
, a2
, a3
);
8157 Vmessage_log_max
= old_log_max
;
8161 /* Display the current message in the current mini-buffer. This is
8162 only called from error handlers in process.c, and is not time
8168 if (!NILP (echo_area_buffer
[0]))
8171 string
= Fcurrent_message ();
8172 message3 (string
, SBYTES (string
),
8173 !NILP (current_buffer
->enable_multibyte_characters
));
8178 /* Make sure echo area buffers in `echo_buffers' are live.
8179 If they aren't, make new ones. */
8182 ensure_echo_area_buffers ()
8186 for (i
= 0; i
< 2; ++i
)
8187 if (!BUFFERP (echo_buffer
[i
])
8188 || NILP (XBUFFER (echo_buffer
[i
])->name
))
8191 Lisp_Object old_buffer
;
8194 old_buffer
= echo_buffer
[i
];
8195 sprintf (name
, " *Echo Area %d*", i
);
8196 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
8197 XBUFFER (echo_buffer
[i
])->truncate_lines
= Qnil
;
8199 for (j
= 0; j
< 2; ++j
)
8200 if (EQ (old_buffer
, echo_area_buffer
[j
]))
8201 echo_area_buffer
[j
] = echo_buffer
[i
];
8206 /* Call FN with args A1..A4 with either the current or last displayed
8207 echo_area_buffer as current buffer.
8209 WHICH zero means use the current message buffer
8210 echo_area_buffer[0]. If that is nil, choose a suitable buffer
8211 from echo_buffer[] and clear it.
8213 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
8214 suitable buffer from echo_buffer[] and clear it.
8216 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
8217 that the current message becomes the last displayed one, make
8218 choose a suitable buffer for echo_area_buffer[0], and clear it.
8220 Value is what FN returns. */
8223 with_echo_area_buffer (w
, which
, fn
, a1
, a2
, a3
, a4
)
8226 int (*fn
) P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
8232 int this_one
, the_other
, clear_buffer_p
, rc
;
8233 int count
= SPECPDL_INDEX ();
8235 /* If buffers aren't live, make new ones. */
8236 ensure_echo_area_buffers ();
8241 this_one
= 0, the_other
= 1;
8243 this_one
= 1, the_other
= 0;
8246 this_one
= 0, the_other
= 1;
8249 /* We need a fresh one in case the current echo buffer equals
8250 the one containing the last displayed echo area message. */
8251 if (!NILP (echo_area_buffer
[this_one
])
8252 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
8253 echo_area_buffer
[this_one
] = Qnil
;
8256 /* Choose a suitable buffer from echo_buffer[] is we don't
8258 if (NILP (echo_area_buffer
[this_one
]))
8260 echo_area_buffer
[this_one
]
8261 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
8262 ? echo_buffer
[the_other
]
8263 : echo_buffer
[this_one
]);
8267 buffer
= echo_area_buffer
[this_one
];
8269 /* Don't get confused by reusing the buffer used for echoing
8270 for a different purpose. */
8271 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
8274 record_unwind_protect (unwind_with_echo_area_buffer
,
8275 with_echo_area_buffer_unwind_data (w
));
8277 /* Make the echo area buffer current. Note that for display
8278 purposes, it is not necessary that the displayed window's buffer
8279 == current_buffer, except for text property lookup. So, let's
8280 only set that buffer temporarily here without doing a full
8281 Fset_window_buffer. We must also change w->pointm, though,
8282 because otherwise an assertions in unshow_buffer fails, and Emacs
8284 set_buffer_internal_1 (XBUFFER (buffer
));
8288 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
8291 current_buffer
->undo_list
= Qt
;
8292 current_buffer
->read_only
= Qnil
;
8293 specbind (Qinhibit_read_only
, Qt
);
8294 specbind (Qinhibit_modification_hooks
, Qt
);
8296 if (clear_buffer_p
&& Z
> BEG
)
8299 xassert (BEGV
>= BEG
);
8300 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8302 rc
= fn (a1
, a2
, a3
, a4
);
8304 xassert (BEGV
>= BEG
);
8305 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8307 unbind_to (count
, Qnil
);
8312 /* Save state that should be preserved around the call to the function
8313 FN called in with_echo_area_buffer. */
8316 with_echo_area_buffer_unwind_data (w
)
8320 Lisp_Object vector
, tmp
;
8322 /* Reduce consing by keeping one vector in
8323 Vwith_echo_area_save_vector. */
8324 vector
= Vwith_echo_area_save_vector
;
8325 Vwith_echo_area_save_vector
= Qnil
;
8328 vector
= Fmake_vector (make_number (7), Qnil
);
8330 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
8331 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
8332 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
8336 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
8337 ASET (vector
, i
, w
->buffer
); ++i
;
8338 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
8339 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
8344 for (; i
< end
; ++i
)
8345 ASET (vector
, i
, Qnil
);
8348 xassert (i
== ASIZE (vector
));
8353 /* Restore global state from VECTOR which was created by
8354 with_echo_area_buffer_unwind_data. */
8357 unwind_with_echo_area_buffer (vector
)
8360 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
8361 Vdeactivate_mark
= AREF (vector
, 1);
8362 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
8364 if (WINDOWP (AREF (vector
, 3)))
8367 Lisp_Object buffer
, charpos
, bytepos
;
8369 w
= XWINDOW (AREF (vector
, 3));
8370 buffer
= AREF (vector
, 4);
8371 charpos
= AREF (vector
, 5);
8372 bytepos
= AREF (vector
, 6);
8375 set_marker_both (w
->pointm
, buffer
,
8376 XFASTINT (charpos
), XFASTINT (bytepos
));
8379 Vwith_echo_area_save_vector
= vector
;
8384 /* Set up the echo area for use by print functions. MULTIBYTE_P
8385 non-zero means we will print multibyte. */
8388 setup_echo_area_for_printing (multibyte_p
)
8391 /* If we can't find an echo area any more, exit. */
8392 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8395 ensure_echo_area_buffers ();
8397 if (!message_buf_print
)
8399 /* A message has been output since the last time we printed.
8400 Choose a fresh echo area buffer. */
8401 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8402 echo_area_buffer
[0] = echo_buffer
[1];
8404 echo_area_buffer
[0] = echo_buffer
[0];
8406 /* Switch to that buffer and clear it. */
8407 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8408 current_buffer
->truncate_lines
= Qnil
;
8412 int count
= SPECPDL_INDEX ();
8413 specbind (Qinhibit_read_only
, Qt
);
8414 /* Note that undo recording is always disabled. */
8416 unbind_to (count
, Qnil
);
8418 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8420 /* Set up the buffer for the multibyteness we need. */
8422 != !NILP (current_buffer
->enable_multibyte_characters
))
8423 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
8425 /* Raise the frame containing the echo area. */
8426 if (minibuffer_auto_raise
)
8428 struct frame
*sf
= SELECTED_FRAME ();
8429 Lisp_Object mini_window
;
8430 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8431 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8434 message_log_maybe_newline ();
8435 message_buf_print
= 1;
8439 if (NILP (echo_area_buffer
[0]))
8441 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8442 echo_area_buffer
[0] = echo_buffer
[1];
8444 echo_area_buffer
[0] = echo_buffer
[0];
8447 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
8449 /* Someone switched buffers between print requests. */
8450 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8451 current_buffer
->truncate_lines
= Qnil
;
8457 /* Display an echo area message in window W. Value is non-zero if W's
8458 height is changed. If display_last_displayed_message_p is
8459 non-zero, display the message that was last displayed, otherwise
8460 display the current message. */
8463 display_echo_area (w
)
8466 int i
, no_message_p
, window_height_changed_p
, count
;
8468 /* Temporarily disable garbage collections while displaying the echo
8469 area. This is done because a GC can print a message itself.
8470 That message would modify the echo area buffer's contents while a
8471 redisplay of the buffer is going on, and seriously confuse
8473 count
= inhibit_garbage_collection ();
8475 /* If there is no message, we must call display_echo_area_1
8476 nevertheless because it resizes the window. But we will have to
8477 reset the echo_area_buffer in question to nil at the end because
8478 with_echo_area_buffer will sets it to an empty buffer. */
8479 i
= display_last_displayed_message_p
? 1 : 0;
8480 no_message_p
= NILP (echo_area_buffer
[i
]);
8482 window_height_changed_p
8483 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
8484 display_echo_area_1
,
8485 (EMACS_INT
) w
, Qnil
, 0, 0);
8488 echo_area_buffer
[i
] = Qnil
;
8490 unbind_to (count
, Qnil
);
8491 return window_height_changed_p
;
8495 /* Helper for display_echo_area. Display the current buffer which
8496 contains the current echo area message in window W, a mini-window,
8497 a pointer to which is passed in A1. A2..A4 are currently not used.
8498 Change the height of W so that all of the message is displayed.
8499 Value is non-zero if height of W was changed. */
8502 display_echo_area_1 (a1
, a2
, a3
, a4
)
8507 struct window
*w
= (struct window
*) a1
;
8509 struct text_pos start
;
8510 int window_height_changed_p
= 0;
8512 /* Do this before displaying, so that we have a large enough glyph
8513 matrix for the display. If we can't get enough space for the
8514 whole text, display the last N lines. That works by setting w->start. */
8515 window_height_changed_p
= resize_mini_window (w
, 0);
8517 /* Use the starting position chosen by resize_mini_window. */
8518 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
8521 clear_glyph_matrix (w
->desired_matrix
);
8522 XSETWINDOW (window
, w
);
8523 try_window (window
, start
, 0);
8525 return window_height_changed_p
;
8529 /* Resize the echo area window to exactly the size needed for the
8530 currently displayed message, if there is one. If a mini-buffer
8531 is active, don't shrink it. */
8534 resize_echo_area_exactly ()
8536 if (BUFFERP (echo_area_buffer
[0])
8537 && WINDOWP (echo_area_window
))
8539 struct window
*w
= XWINDOW (echo_area_window
);
8541 Lisp_Object resize_exactly
;
8543 if (minibuf_level
== 0)
8544 resize_exactly
= Qt
;
8546 resize_exactly
= Qnil
;
8548 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
8549 (EMACS_INT
) w
, resize_exactly
, 0, 0);
8552 ++windows_or_buffers_changed
;
8553 ++update_mode_lines
;
8554 redisplay_internal (0);
8560 /* Callback function for with_echo_area_buffer, when used from
8561 resize_echo_area_exactly. A1 contains a pointer to the window to
8562 resize, EXACTLY non-nil means resize the mini-window exactly to the
8563 size of the text displayed. A3 and A4 are not used. Value is what
8564 resize_mini_window returns. */
8567 resize_mini_window_1 (a1
, exactly
, a3
, a4
)
8569 Lisp_Object exactly
;
8572 return resize_mini_window ((struct window
*) a1
, !NILP (exactly
));
8576 /* Resize mini-window W to fit the size of its contents. EXACT_P
8577 means size the window exactly to the size needed. Otherwise, it's
8578 only enlarged until W's buffer is empty.
8580 Set W->start to the right place to begin display. If the whole
8581 contents fit, start at the beginning. Otherwise, start so as
8582 to make the end of the contents appear. This is particularly
8583 important for y-or-n-p, but seems desirable generally.
8585 Value is non-zero if the window height has been changed. */
8588 resize_mini_window (w
, exact_p
)
8592 struct frame
*f
= XFRAME (w
->frame
);
8593 int window_height_changed_p
= 0;
8595 xassert (MINI_WINDOW_P (w
));
8597 /* By default, start display at the beginning. */
8598 set_marker_both (w
->start
, w
->buffer
,
8599 BUF_BEGV (XBUFFER (w
->buffer
)),
8600 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
8602 /* Don't resize windows while redisplaying a window; it would
8603 confuse redisplay functions when the size of the window they are
8604 displaying changes from under them. Such a resizing can happen,
8605 for instance, when which-func prints a long message while
8606 we are running fontification-functions. We're running these
8607 functions with safe_call which binds inhibit-redisplay to t. */
8608 if (!NILP (Vinhibit_redisplay
))
8611 /* Nil means don't try to resize. */
8612 if (NILP (Vresize_mini_windows
)
8613 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
8616 if (!FRAME_MINIBUF_ONLY_P (f
))
8619 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
8620 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
8621 int height
, max_height
;
8622 int unit
= FRAME_LINE_HEIGHT (f
);
8623 struct text_pos start
;
8624 struct buffer
*old_current_buffer
= NULL
;
8626 if (current_buffer
!= XBUFFER (w
->buffer
))
8628 old_current_buffer
= current_buffer
;
8629 set_buffer_internal (XBUFFER (w
->buffer
));
8632 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8634 /* Compute the max. number of lines specified by the user. */
8635 if (FLOATP (Vmax_mini_window_height
))
8636 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
8637 else if (INTEGERP (Vmax_mini_window_height
))
8638 max_height
= XINT (Vmax_mini_window_height
);
8640 max_height
= total_height
/ 4;
8642 /* Correct that max. height if it's bogus. */
8643 max_height
= max (1, max_height
);
8644 max_height
= min (total_height
, max_height
);
8646 /* Find out the height of the text in the window. */
8647 if (it
.line_wrap
== TRUNCATE
)
8652 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
8653 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
8654 height
= it
.current_y
+ last_height
;
8656 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
8657 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
8658 height
= (height
+ unit
- 1) / unit
;
8661 /* Compute a suitable window start. */
8662 if (height
> max_height
)
8664 height
= max_height
;
8665 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8666 move_it_vertically_backward (&it
, (height
- 1) * unit
);
8667 start
= it
.current
.pos
;
8670 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
8671 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
8673 if (EQ (Vresize_mini_windows
, Qgrow_only
))
8675 /* Let it grow only, until we display an empty message, in which
8676 case the window shrinks again. */
8677 if (height
> WINDOW_TOTAL_LINES (w
))
8679 int old_height
= WINDOW_TOTAL_LINES (w
);
8680 freeze_window_starts (f
, 1);
8681 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8682 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8684 else if (height
< WINDOW_TOTAL_LINES (w
)
8685 && (exact_p
|| BEGV
== ZV
))
8687 int old_height
= WINDOW_TOTAL_LINES (w
);
8688 freeze_window_starts (f
, 0);
8689 shrink_mini_window (w
);
8690 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8695 /* Always resize to exact size needed. */
8696 if (height
> WINDOW_TOTAL_LINES (w
))
8698 int old_height
= WINDOW_TOTAL_LINES (w
);
8699 freeze_window_starts (f
, 1);
8700 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8701 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8703 else if (height
< WINDOW_TOTAL_LINES (w
))
8705 int old_height
= WINDOW_TOTAL_LINES (w
);
8706 freeze_window_starts (f
, 0);
8707 shrink_mini_window (w
);
8711 freeze_window_starts (f
, 1);
8712 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8715 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8719 if (old_current_buffer
)
8720 set_buffer_internal (old_current_buffer
);
8723 return window_height_changed_p
;
8727 /* Value is the current message, a string, or nil if there is no
8735 if (!BUFFERP (echo_area_buffer
[0]))
8739 with_echo_area_buffer (0, 0, current_message_1
,
8740 (EMACS_INT
) &msg
, Qnil
, 0, 0);
8742 echo_area_buffer
[0] = Qnil
;
8750 current_message_1 (a1
, a2
, a3
, a4
)
8755 Lisp_Object
*msg
= (Lisp_Object
*) a1
;
8758 *msg
= make_buffer_string (BEG
, Z
, 1);
8765 /* Push the current message on Vmessage_stack for later restauration
8766 by restore_message. Value is non-zero if the current message isn't
8767 empty. This is a relatively infrequent operation, so it's not
8768 worth optimizing. */
8774 msg
= current_message ();
8775 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
8776 return STRINGP (msg
);
8780 /* Restore message display from the top of Vmessage_stack. */
8787 xassert (CONSP (Vmessage_stack
));
8788 msg
= XCAR (Vmessage_stack
);
8790 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
8792 message3_nolog (msg
, 0, 0);
8796 /* Handler for record_unwind_protect calling pop_message. */
8799 pop_message_unwind (dummy
)
8806 /* Pop the top-most entry off Vmessage_stack. */
8811 xassert (CONSP (Vmessage_stack
));
8812 Vmessage_stack
= XCDR (Vmessage_stack
);
8816 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
8817 exits. If the stack is not empty, we have a missing pop_message
8821 check_message_stack ()
8823 if (!NILP (Vmessage_stack
))
8828 /* Truncate to NCHARS what will be displayed in the echo area the next
8829 time we display it---but don't redisplay it now. */
8832 truncate_echo_area (nchars
)
8836 echo_area_buffer
[0] = Qnil
;
8837 /* A null message buffer means that the frame hasn't really been
8838 initialized yet. Error messages get reported properly by
8839 cmd_error, so this must be just an informative message; toss it. */
8840 else if (!noninteractive
8842 && !NILP (echo_area_buffer
[0]))
8844 struct frame
*sf
= SELECTED_FRAME ();
8845 if (FRAME_MESSAGE_BUF (sf
))
8846 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
8851 /* Helper function for truncate_echo_area. Truncate the current
8852 message to at most NCHARS characters. */
8855 truncate_message_1 (nchars
, a2
, a3
, a4
)
8860 if (BEG
+ nchars
< Z
)
8861 del_range (BEG
+ nchars
, Z
);
8863 echo_area_buffer
[0] = Qnil
;
8868 /* Set the current message to a substring of S or STRING.
8870 If STRING is a Lisp string, set the message to the first NBYTES
8871 bytes from STRING. NBYTES zero means use the whole string. If
8872 STRING is multibyte, the message will be displayed multibyte.
8874 If S is not null, set the message to the first LEN bytes of S. LEN
8875 zero means use the whole string. MULTIBYTE_P non-zero means S is
8876 multibyte. Display the message multibyte in that case.
8878 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
8879 to t before calling set_message_1 (which calls insert).
8883 set_message (s
, string
, nbytes
, multibyte_p
)
8886 int nbytes
, multibyte_p
;
8888 message_enable_multibyte
8889 = ((s
&& multibyte_p
)
8890 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
8892 with_echo_area_buffer (0, -1, set_message_1
,
8893 (EMACS_INT
) s
, string
, nbytes
, multibyte_p
);
8894 message_buf_print
= 0;
8895 help_echo_showing_p
= 0;
8899 /* Helper function for set_message. Arguments have the same meaning
8900 as there, with A1 corresponding to S and A2 corresponding to STRING
8901 This function is called with the echo area buffer being
8905 set_message_1 (a1
, a2
, nbytes
, multibyte_p
)
8908 EMACS_INT nbytes
, multibyte_p
;
8910 const char *s
= (const char *) a1
;
8911 Lisp_Object string
= a2
;
8913 /* Change multibyteness of the echo buffer appropriately. */
8914 if (message_enable_multibyte
8915 != !NILP (current_buffer
->enable_multibyte_characters
))
8916 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
8918 current_buffer
->truncate_lines
= message_truncate_lines
? Qt
: Qnil
;
8920 /* Insert new message at BEG. */
8921 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8923 if (STRINGP (string
))
8928 nbytes
= SBYTES (string
);
8929 nchars
= string_byte_to_char (string
, nbytes
);
8931 /* This function takes care of single/multibyte conversion. We
8932 just have to ensure that the echo area buffer has the right
8933 setting of enable_multibyte_characters. */
8934 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
8939 nbytes
= strlen (s
);
8941 if (multibyte_p
&& NILP (current_buffer
->enable_multibyte_characters
))
8943 /* Convert from multi-byte to single-byte. */
8945 unsigned char work
[1];
8947 /* Convert a multibyte string to single-byte. */
8948 for (i
= 0; i
< nbytes
; i
+= n
)
8950 c
= string_char_and_length (s
+ i
, nbytes
- i
, &n
);
8951 work
[0] = (ASCII_CHAR_P (c
)
8953 : multibyte_char_to_unibyte (c
, Qnil
));
8954 insert_1_both (work
, 1, 1, 1, 0, 0);
8957 else if (!multibyte_p
8958 && !NILP (current_buffer
->enable_multibyte_characters
))
8960 /* Convert from single-byte to multi-byte. */
8962 const unsigned char *msg
= (const unsigned char *) s
;
8963 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
8965 /* Convert a single-byte string to multibyte. */
8966 for (i
= 0; i
< nbytes
; i
++)
8969 c
= unibyte_char_to_multibyte (c
);
8970 n
= CHAR_STRING (c
, str
);
8971 insert_1_both (str
, 1, n
, 1, 0, 0);
8975 insert_1 (s
, nbytes
, 1, 0, 0);
8982 /* Clear messages. CURRENT_P non-zero means clear the current
8983 message. LAST_DISPLAYED_P non-zero means clear the message
8987 clear_message (current_p
, last_displayed_p
)
8988 int current_p
, last_displayed_p
;
8992 echo_area_buffer
[0] = Qnil
;
8993 message_cleared_p
= 1;
8996 if (last_displayed_p
)
8997 echo_area_buffer
[1] = Qnil
;
8999 message_buf_print
= 0;
9002 /* Clear garbaged frames.
9004 This function is used where the old redisplay called
9005 redraw_garbaged_frames which in turn called redraw_frame which in
9006 turn called clear_frame. The call to clear_frame was a source of
9007 flickering. I believe a clear_frame is not necessary. It should
9008 suffice in the new redisplay to invalidate all current matrices,
9009 and ensure a complete redisplay of all windows. */
9012 clear_garbaged_frames ()
9016 Lisp_Object tail
, frame
;
9017 int changed_count
= 0;
9019 FOR_EACH_FRAME (tail
, frame
)
9021 struct frame
*f
= XFRAME (frame
);
9023 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
9027 Fredraw_frame (frame
);
9028 f
->force_flush_display_p
= 1;
9030 clear_current_matrices (f
);
9039 ++windows_or_buffers_changed
;
9044 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
9045 is non-zero update selected_frame. Value is non-zero if the
9046 mini-windows height has been changed. */
9049 echo_area_display (update_frame_p
)
9052 Lisp_Object mini_window
;
9055 int window_height_changed_p
= 0;
9056 struct frame
*sf
= SELECTED_FRAME ();
9058 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9059 w
= XWINDOW (mini_window
);
9060 f
= XFRAME (WINDOW_FRAME (w
));
9062 /* Don't display if frame is invisible or not yet initialized. */
9063 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
9066 #ifdef HAVE_WINDOW_SYSTEM
9067 /* When Emacs starts, selected_frame may be the initial terminal
9068 frame. If we let this through, a message would be displayed on
9070 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
9072 #endif /* HAVE_WINDOW_SYSTEM */
9074 /* Redraw garbaged frames. */
9076 clear_garbaged_frames ();
9078 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
9080 echo_area_window
= mini_window
;
9081 window_height_changed_p
= display_echo_area (w
);
9082 w
->must_be_updated_p
= 1;
9084 /* Update the display, unless called from redisplay_internal.
9085 Also don't update the screen during redisplay itself. The
9086 update will happen at the end of redisplay, and an update
9087 here could cause confusion. */
9088 if (update_frame_p
&& !redisplaying_p
)
9092 /* If the display update has been interrupted by pending
9093 input, update mode lines in the frame. Due to the
9094 pending input, it might have been that redisplay hasn't
9095 been called, so that mode lines above the echo area are
9096 garbaged. This looks odd, so we prevent it here. */
9097 if (!display_completed
)
9098 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
9100 if (window_height_changed_p
9101 /* Don't do this if Emacs is shutting down. Redisplay
9102 needs to run hooks. */
9103 && !NILP (Vrun_hooks
))
9105 /* Must update other windows. Likewise as in other
9106 cases, don't let this update be interrupted by
9108 int count
= SPECPDL_INDEX ();
9109 specbind (Qredisplay_dont_pause
, Qt
);
9110 windows_or_buffers_changed
= 1;
9111 redisplay_internal (0);
9112 unbind_to (count
, Qnil
);
9114 else if (FRAME_WINDOW_P (f
) && n
== 0)
9116 /* Window configuration is the same as before.
9117 Can do with a display update of the echo area,
9118 unless we displayed some mode lines. */
9119 update_single_window (w
, 1);
9120 FRAME_RIF (f
)->flush_display (f
);
9123 update_frame (f
, 1, 1);
9125 /* If cursor is in the echo area, make sure that the next
9126 redisplay displays the minibuffer, so that the cursor will
9127 be replaced with what the minibuffer wants. */
9128 if (cursor_in_echo_area
)
9129 ++windows_or_buffers_changed
;
9132 else if (!EQ (mini_window
, selected_window
))
9133 windows_or_buffers_changed
++;
9135 /* Last displayed message is now the current message. */
9136 echo_area_buffer
[1] = echo_area_buffer
[0];
9137 /* Inform read_char that we're not echoing. */
9138 echo_message_buffer
= Qnil
;
9140 /* Prevent redisplay optimization in redisplay_internal by resetting
9141 this_line_start_pos. This is done because the mini-buffer now
9142 displays the message instead of its buffer text. */
9143 if (EQ (mini_window
, selected_window
))
9144 CHARPOS (this_line_start_pos
) = 0;
9146 return window_height_changed_p
;
9151 /***********************************************************************
9152 Mode Lines and Frame Titles
9153 ***********************************************************************/
9155 /* A buffer for constructing non-propertized mode-line strings and
9156 frame titles in it; allocated from the heap in init_xdisp and
9157 resized as needed in store_mode_line_noprop_char. */
9159 static char *mode_line_noprop_buf
;
9161 /* The buffer's end, and a current output position in it. */
9163 static char *mode_line_noprop_buf_end
;
9164 static char *mode_line_noprop_ptr
;
9166 #define MODE_LINE_NOPROP_LEN(start) \
9167 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
9170 MODE_LINE_DISPLAY
= 0,
9176 /* Alist that caches the results of :propertize.
9177 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
9178 static Lisp_Object mode_line_proptrans_alist
;
9180 /* List of strings making up the mode-line. */
9181 static Lisp_Object mode_line_string_list
;
9183 /* Base face property when building propertized mode line string. */
9184 static Lisp_Object mode_line_string_face
;
9185 static Lisp_Object mode_line_string_face_prop
;
9188 /* Unwind data for mode line strings */
9190 static Lisp_Object Vmode_line_unwind_vector
;
9193 format_mode_line_unwind_data (struct buffer
*obuf
,
9197 Lisp_Object vector
, tmp
;
9199 /* Reduce consing by keeping one vector in
9200 Vwith_echo_area_save_vector. */
9201 vector
= Vmode_line_unwind_vector
;
9202 Vmode_line_unwind_vector
= Qnil
;
9205 vector
= Fmake_vector (make_number (8), Qnil
);
9207 ASET (vector
, 0, make_number (mode_line_target
));
9208 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
9209 ASET (vector
, 2, mode_line_string_list
);
9210 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
9211 ASET (vector
, 4, mode_line_string_face
);
9212 ASET (vector
, 5, mode_line_string_face_prop
);
9215 XSETBUFFER (tmp
, obuf
);
9218 ASET (vector
, 6, tmp
);
9219 ASET (vector
, 7, owin
);
9225 unwind_format_mode_line (vector
)
9228 mode_line_target
= XINT (AREF (vector
, 0));
9229 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
9230 mode_line_string_list
= AREF (vector
, 2);
9231 if (! EQ (AREF (vector
, 3), Qt
))
9232 mode_line_proptrans_alist
= AREF (vector
, 3);
9233 mode_line_string_face
= AREF (vector
, 4);
9234 mode_line_string_face_prop
= AREF (vector
, 5);
9236 if (!NILP (AREF (vector
, 7)))
9237 /* Select window before buffer, since it may change the buffer. */
9238 Fselect_window (AREF (vector
, 7), Qt
);
9240 if (!NILP (AREF (vector
, 6)))
9242 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
9243 ASET (vector
, 6, Qnil
);
9246 Vmode_line_unwind_vector
= vector
;
9251 /* Store a single character C for the frame title in mode_line_noprop_buf.
9252 Re-allocate mode_line_noprop_buf if necessary. */
9256 store_mode_line_noprop_char (char c
)
9258 store_mode_line_noprop_char (c
)
9262 /* If output position has reached the end of the allocated buffer,
9263 double the buffer's size. */
9264 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
9266 int len
= MODE_LINE_NOPROP_LEN (0);
9267 int new_size
= 2 * len
* sizeof *mode_line_noprop_buf
;
9268 mode_line_noprop_buf
= (char *) xrealloc (mode_line_noprop_buf
, new_size
);
9269 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ new_size
;
9270 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
9273 *mode_line_noprop_ptr
++ = c
;
9277 /* Store part of a frame title in mode_line_noprop_buf, beginning at
9278 mode_line_noprop_ptr. STR is the string to store. Do not copy
9279 characters that yield more columns than PRECISION; PRECISION <= 0
9280 means copy the whole string. Pad with spaces until FIELD_WIDTH
9281 number of characters have been copied; FIELD_WIDTH <= 0 means don't
9282 pad. Called from display_mode_element when it is used to build a
9286 store_mode_line_noprop (str
, field_width
, precision
)
9287 const unsigned char *str
;
9288 int field_width
, precision
;
9293 /* Copy at most PRECISION chars from STR. */
9294 nbytes
= strlen (str
);
9295 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
9297 store_mode_line_noprop_char (*str
++);
9299 /* Fill up with spaces until FIELD_WIDTH reached. */
9300 while (field_width
> 0
9303 store_mode_line_noprop_char (' ');
9310 /***********************************************************************
9312 ***********************************************************************/
9314 #ifdef HAVE_WINDOW_SYSTEM
9316 /* Set the title of FRAME, if it has changed. The title format is
9317 Vicon_title_format if FRAME is iconified, otherwise it is
9318 frame_title_format. */
9321 x_consider_frame_title (frame
)
9324 struct frame
*f
= XFRAME (frame
);
9326 if (FRAME_WINDOW_P (f
)
9327 || FRAME_MINIBUF_ONLY_P (f
)
9328 || f
->explicit_name
)
9330 /* Do we have more than one visible frame on this X display? */
9337 int count
= SPECPDL_INDEX ();
9339 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
9341 Lisp_Object other_frame
= XCAR (tail
);
9342 struct frame
*tf
= XFRAME (other_frame
);
9345 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
9346 && !FRAME_MINIBUF_ONLY_P (tf
)
9347 && !EQ (other_frame
, tip_frame
)
9348 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
9352 /* Set global variable indicating that multiple frames exist. */
9353 multiple_frames
= CONSP (tail
);
9355 /* Switch to the buffer of selected window of the frame. Set up
9356 mode_line_target so that display_mode_element will output into
9357 mode_line_noprop_buf; then display the title. */
9358 record_unwind_protect (unwind_format_mode_line
,
9359 format_mode_line_unwind_data
9360 (current_buffer
, selected_window
, 0));
9362 Fselect_window (f
->selected_window
, Qt
);
9363 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
9364 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
9366 mode_line_target
= MODE_LINE_TITLE
;
9367 title_start
= MODE_LINE_NOPROP_LEN (0);
9368 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
9369 NULL
, DEFAULT_FACE_ID
);
9370 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
9371 len
= MODE_LINE_NOPROP_LEN (title_start
);
9372 title
= mode_line_noprop_buf
+ title_start
;
9373 unbind_to (count
, Qnil
);
9375 /* Set the title only if it's changed. This avoids consing in
9376 the common case where it hasn't. (If it turns out that we've
9377 already wasted too much time by walking through the list with
9378 display_mode_element, then we might need to optimize at a
9379 higher level than this.) */
9380 if (! STRINGP (f
->name
)
9381 || SBYTES (f
->name
) != len
9382 || bcmp (title
, SDATA (f
->name
), len
) != 0)
9383 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
9387 #endif /* not HAVE_WINDOW_SYSTEM */
9392 /***********************************************************************
9394 ***********************************************************************/
9397 /* Prepare for redisplay by updating menu-bar item lists when
9398 appropriate. This can call eval. */
9401 prepare_menu_bars ()
9404 struct gcpro gcpro1
, gcpro2
;
9406 Lisp_Object tooltip_frame
;
9408 #ifdef HAVE_WINDOW_SYSTEM
9409 tooltip_frame
= tip_frame
;
9411 tooltip_frame
= Qnil
;
9414 /* Update all frame titles based on their buffer names, etc. We do
9415 this before the menu bars so that the buffer-menu will show the
9416 up-to-date frame titles. */
9417 #ifdef HAVE_WINDOW_SYSTEM
9418 if (windows_or_buffers_changed
|| update_mode_lines
)
9420 Lisp_Object tail
, frame
;
9422 FOR_EACH_FRAME (tail
, frame
)
9425 if (!EQ (frame
, tooltip_frame
)
9426 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
9427 x_consider_frame_title (frame
);
9430 #endif /* HAVE_WINDOW_SYSTEM */
9432 /* Update the menu bar item lists, if appropriate. This has to be
9433 done before any actual redisplay or generation of display lines. */
9434 all_windows
= (update_mode_lines
9435 || buffer_shared
> 1
9436 || windows_or_buffers_changed
);
9439 Lisp_Object tail
, frame
;
9440 int count
= SPECPDL_INDEX ();
9441 /* 1 means that update_menu_bar has run its hooks
9442 so any further calls to update_menu_bar shouldn't do so again. */
9443 int menu_bar_hooks_run
= 0;
9445 record_unwind_save_match_data ();
9447 FOR_EACH_FRAME (tail
, frame
)
9451 /* Ignore tooltip frame. */
9452 if (EQ (frame
, tooltip_frame
))
9455 /* If a window on this frame changed size, report that to
9456 the user and clear the size-change flag. */
9457 if (FRAME_WINDOW_SIZES_CHANGED (f
))
9459 Lisp_Object functions
;
9461 /* Clear flag first in case we get an error below. */
9462 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
9463 functions
= Vwindow_size_change_functions
;
9464 GCPRO2 (tail
, functions
);
9466 while (CONSP (functions
))
9468 call1 (XCAR (functions
), frame
);
9469 functions
= XCDR (functions
);
9475 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
9476 #ifdef HAVE_WINDOW_SYSTEM
9477 update_tool_bar (f
, 0);
9479 mac_update_title_bar (f
, 0);
9485 unbind_to (count
, Qnil
);
9489 struct frame
*sf
= SELECTED_FRAME ();
9490 update_menu_bar (sf
, 1, 0);
9491 #ifdef HAVE_WINDOW_SYSTEM
9492 update_tool_bar (sf
, 1);
9494 mac_update_title_bar (sf
, 1);
9499 /* Motif needs this. See comment in xmenu.c. Turn it off when
9500 pending_menu_activation is not defined. */
9501 #ifdef USE_X_TOOLKIT
9502 pending_menu_activation
= 0;
9507 /* Update the menu bar item list for frame F. This has to be done
9508 before we start to fill in any display lines, because it can call
9511 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
9513 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
9514 already ran the menu bar hooks for this redisplay, so there
9515 is no need to run them again. The return value is the
9516 updated value of this flag, to pass to the next call. */
9519 update_menu_bar (f
, save_match_data
, hooks_run
)
9521 int save_match_data
;
9525 register struct window
*w
;
9527 /* If called recursively during a menu update, do nothing. This can
9528 happen when, for instance, an activate-menubar-hook causes a
9530 if (inhibit_menubar_update
)
9533 window
= FRAME_SELECTED_WINDOW (f
);
9534 w
= XWINDOW (window
);
9536 #if 0 /* The if statement below this if statement used to include the
9537 condition !NILP (w->update_mode_line), rather than using
9538 update_mode_lines directly, and this if statement may have
9539 been added to make that condition work. Now the if
9540 statement below matches its comment, this isn't needed. */
9541 if (update_mode_lines
)
9542 w
->update_mode_line
= Qt
;
9545 if (FRAME_WINDOW_P (f
)
9547 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
9548 || defined (USE_GTK)
9549 FRAME_EXTERNAL_MENU_BAR (f
)
9551 FRAME_MENU_BAR_LINES (f
) > 0
9553 : FRAME_MENU_BAR_LINES (f
) > 0)
9555 /* If the user has switched buffers or windows, we need to
9556 recompute to reflect the new bindings. But we'll
9557 recompute when update_mode_lines is set too; that means
9558 that people can use force-mode-line-update to request
9559 that the menu bar be recomputed. The adverse effect on
9560 the rest of the redisplay algorithm is about the same as
9561 windows_or_buffers_changed anyway. */
9562 if (windows_or_buffers_changed
9563 /* This used to test w->update_mode_line, but we believe
9564 there is no need to recompute the menu in that case. */
9565 || update_mode_lines
9566 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9567 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9568 != !NILP (w
->last_had_star
))
9569 || ((!NILP (Vtransient_mark_mode
)
9570 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
9571 != !NILP (w
->region_showing
)))
9573 struct buffer
*prev
= current_buffer
;
9574 int count
= SPECPDL_INDEX ();
9576 specbind (Qinhibit_menubar_update
, Qt
);
9578 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9579 if (save_match_data
)
9580 record_unwind_save_match_data ();
9581 if (NILP (Voverriding_local_map_menu_flag
))
9583 specbind (Qoverriding_terminal_local_map
, Qnil
);
9584 specbind (Qoverriding_local_map
, Qnil
);
9589 /* Run the Lucid hook. */
9590 safe_run_hooks (Qactivate_menubar_hook
);
9592 /* If it has changed current-menubar from previous value,
9593 really recompute the menu-bar from the value. */
9594 if (! NILP (Vlucid_menu_bar_dirty_flag
))
9595 call0 (Qrecompute_lucid_menubar
);
9597 safe_run_hooks (Qmenu_bar_update_hook
);
9602 XSETFRAME (Vmenu_updating_frame
, f
);
9603 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
9605 /* Redisplay the menu bar in case we changed it. */
9606 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
9607 || defined (USE_GTK)
9608 if (FRAME_WINDOW_P (f
))
9611 /* All frames on Mac OS share the same menubar. So only
9612 the selected frame should be allowed to set it. */
9613 if (f
== SELECTED_FRAME ())
9615 set_frame_menubar (f
, 0, 0);
9618 /* On a terminal screen, the menu bar is an ordinary screen
9619 line, and this makes it get updated. */
9620 w
->update_mode_line
= Qt
;
9621 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || MAC_OS || USE_GTK) */
9622 /* In the non-toolkit version, the menu bar is an ordinary screen
9623 line, and this makes it get updated. */
9624 w
->update_mode_line
= Qt
;
9625 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || MAC_OS || USE_GTK) */
9627 unbind_to (count
, Qnil
);
9628 set_buffer_internal_1 (prev
);
9637 /***********************************************************************
9639 ***********************************************************************/
9641 #ifdef HAVE_WINDOW_SYSTEM
9644 Nominal cursor position -- where to draw output.
9645 HPOS and VPOS are window relative glyph matrix coordinates.
9646 X and Y are window relative pixel coordinates. */
9648 struct cursor_pos output_cursor
;
9652 Set the global variable output_cursor to CURSOR. All cursor
9653 positions are relative to updated_window. */
9656 set_output_cursor (cursor
)
9657 struct cursor_pos
*cursor
;
9659 output_cursor
.hpos
= cursor
->hpos
;
9660 output_cursor
.vpos
= cursor
->vpos
;
9661 output_cursor
.x
= cursor
->x
;
9662 output_cursor
.y
= cursor
->y
;
9667 Set a nominal cursor position.
9669 HPOS and VPOS are column/row positions in a window glyph matrix. X
9670 and Y are window text area relative pixel positions.
9672 If this is done during an update, updated_window will contain the
9673 window that is being updated and the position is the future output
9674 cursor position for that window. If updated_window is null, use
9675 selected_window and display the cursor at the given position. */
9678 x_cursor_to (vpos
, hpos
, y
, x
)
9679 int vpos
, hpos
, y
, x
;
9683 /* If updated_window is not set, work on selected_window. */
9687 w
= XWINDOW (selected_window
);
9689 /* Set the output cursor. */
9690 output_cursor
.hpos
= hpos
;
9691 output_cursor
.vpos
= vpos
;
9692 output_cursor
.x
= x
;
9693 output_cursor
.y
= y
;
9695 /* If not called as part of an update, really display the cursor.
9696 This will also set the cursor position of W. */
9697 if (updated_window
== NULL
)
9700 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
9701 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
9702 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
9707 #endif /* HAVE_WINDOW_SYSTEM */
9710 /***********************************************************************
9712 ***********************************************************************/
9714 #ifdef HAVE_WINDOW_SYSTEM
9716 /* Where the mouse was last time we reported a mouse event. */
9718 FRAME_PTR last_mouse_frame
;
9720 /* Tool-bar item index of the item on which a mouse button was pressed
9723 int last_tool_bar_item
;
9726 /* Update the tool-bar item list for frame F. This has to be done
9727 before we start to fill in any display lines. Called from
9728 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
9729 and restore it here. */
9732 update_tool_bar (f
, save_match_data
)
9734 int save_match_data
;
9736 #if defined (USE_GTK) || USE_MAC_TOOLBAR
9737 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
9739 int do_update
= WINDOWP (f
->tool_bar_window
)
9740 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
9748 window
= FRAME_SELECTED_WINDOW (f
);
9749 w
= XWINDOW (window
);
9751 /* If the user has switched buffers or windows, we need to
9752 recompute to reflect the new bindings. But we'll
9753 recompute when update_mode_lines is set too; that means
9754 that people can use force-mode-line-update to request
9755 that the menu bar be recomputed. The adverse effect on
9756 the rest of the redisplay algorithm is about the same as
9757 windows_or_buffers_changed anyway. */
9758 if (windows_or_buffers_changed
9759 || !NILP (w
->update_mode_line
)
9760 || update_mode_lines
9761 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9762 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9763 != !NILP (w
->last_had_star
))
9764 || ((!NILP (Vtransient_mark_mode
)
9765 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
9766 != !NILP (w
->region_showing
)))
9768 struct buffer
*prev
= current_buffer
;
9769 int count
= SPECPDL_INDEX ();
9770 Lisp_Object new_tool_bar
;
9772 struct gcpro gcpro1
;
9774 /* Set current_buffer to the buffer of the selected
9775 window of the frame, so that we get the right local
9777 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9779 /* Save match data, if we must. */
9780 if (save_match_data
)
9781 record_unwind_save_match_data ();
9783 /* Make sure that we don't accidentally use bogus keymaps. */
9784 if (NILP (Voverriding_local_map_menu_flag
))
9786 specbind (Qoverriding_terminal_local_map
, Qnil
);
9787 specbind (Qoverriding_local_map
, Qnil
);
9790 GCPRO1 (new_tool_bar
);
9792 /* Build desired tool-bar items from keymaps. */
9793 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
9796 /* Redisplay the tool-bar if we changed it. */
9797 if (new_n_tool_bar
!= f
->n_tool_bar_items
9798 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
9800 /* Redisplay that happens asynchronously due to an expose event
9801 may access f->tool_bar_items. Make sure we update both
9802 variables within BLOCK_INPUT so no such event interrupts. */
9804 f
->tool_bar_items
= new_tool_bar
;
9805 f
->n_tool_bar_items
= new_n_tool_bar
;
9806 w
->update_mode_line
= Qt
;
9812 unbind_to (count
, Qnil
);
9813 set_buffer_internal_1 (prev
);
9819 /* Set F->desired_tool_bar_string to a Lisp string representing frame
9820 F's desired tool-bar contents. F->tool_bar_items must have
9821 been set up previously by calling prepare_menu_bars. */
9824 build_desired_tool_bar_string (f
)
9827 int i
, size
, size_needed
;
9828 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9829 Lisp_Object image
, plist
, props
;
9831 image
= plist
= props
= Qnil
;
9832 GCPRO3 (image
, plist
, props
);
9834 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
9835 Otherwise, make a new string. */
9837 /* The size of the string we might be able to reuse. */
9838 size
= (STRINGP (f
->desired_tool_bar_string
)
9839 ? SCHARS (f
->desired_tool_bar_string
)
9842 /* We need one space in the string for each image. */
9843 size_needed
= f
->n_tool_bar_items
;
9845 /* Reuse f->desired_tool_bar_string, if possible. */
9846 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
9847 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
9851 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
9852 Fremove_text_properties (make_number (0), make_number (size
),
9853 props
, f
->desired_tool_bar_string
);
9856 /* Put a `display' property on the string for the images to display,
9857 put a `menu_item' property on tool-bar items with a value that
9858 is the index of the item in F's tool-bar item vector. */
9859 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
9861 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
9863 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
9864 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
9865 int hmargin
, vmargin
, relief
, idx
, end
;
9866 extern Lisp_Object QCrelief
, QCmargin
, QCconversion
;
9868 /* If image is a vector, choose the image according to the
9870 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
9871 if (VECTORP (image
))
9875 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
9876 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
9879 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
9880 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
9882 xassert (ASIZE (image
) >= idx
);
9883 image
= AREF (image
, idx
);
9888 /* Ignore invalid image specifications. */
9889 if (!valid_image_p (image
))
9892 /* Display the tool-bar button pressed, or depressed. */
9893 plist
= Fcopy_sequence (XCDR (image
));
9895 /* Compute margin and relief to draw. */
9896 relief
= (tool_bar_button_relief
>= 0
9897 ? tool_bar_button_relief
9898 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
9899 hmargin
= vmargin
= relief
;
9901 if (INTEGERP (Vtool_bar_button_margin
)
9902 && XINT (Vtool_bar_button_margin
) > 0)
9904 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
9905 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
9907 else if (CONSP (Vtool_bar_button_margin
))
9909 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
9910 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
9911 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
9913 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
9914 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
9915 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
9918 if (auto_raise_tool_bar_buttons_p
)
9920 /* Add a `:relief' property to the image spec if the item is
9924 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
9931 /* If image is selected, display it pressed, i.e. with a
9932 negative relief. If it's not selected, display it with a
9934 plist
= Fplist_put (plist
, QCrelief
,
9936 ? make_number (-relief
)
9937 : make_number (relief
)));
9942 /* Put a margin around the image. */
9943 if (hmargin
|| vmargin
)
9945 if (hmargin
== vmargin
)
9946 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
9948 plist
= Fplist_put (plist
, QCmargin
,
9949 Fcons (make_number (hmargin
),
9950 make_number (vmargin
)));
9953 /* If button is not enabled, and we don't have special images
9954 for the disabled state, make the image appear disabled by
9955 applying an appropriate algorithm to it. */
9956 if (!enabled_p
&& idx
< 0)
9957 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
9959 /* Put a `display' text property on the string for the image to
9960 display. Put a `menu-item' property on the string that gives
9961 the start of this item's properties in the tool-bar items
9963 image
= Fcons (Qimage
, plist
);
9964 props
= list4 (Qdisplay
, image
,
9965 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
9967 /* Let the last image hide all remaining spaces in the tool bar
9968 string. The string can be longer than needed when we reuse a
9970 if (i
+ 1 == f
->n_tool_bar_items
)
9971 end
= SCHARS (f
->desired_tool_bar_string
);
9974 Fadd_text_properties (make_number (i
), make_number (end
),
9975 props
, f
->desired_tool_bar_string
);
9983 /* Display one line of the tool-bar of frame IT->f.
9985 HEIGHT specifies the desired height of the tool-bar line.
9986 If the actual height of the glyph row is less than HEIGHT, the
9987 row's height is increased to HEIGHT, and the icons are centered
9988 vertically in the new height.
9990 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
9991 count a final empty row in case the tool-bar width exactly matches
9996 display_tool_bar_line (it
, height
)
10000 struct glyph_row
*row
= it
->glyph_row
;
10001 int max_x
= it
->last_visible_x
;
10002 struct glyph
*last
;
10004 prepare_desired_row (row
);
10005 row
->y
= it
->current_y
;
10007 /* Note that this isn't made use of if the face hasn't a box,
10008 so there's no need to check the face here. */
10009 it
->start_of_box_run_p
= 1;
10011 while (it
->current_x
< max_x
)
10013 int x
, n_glyphs_before
, i
, nglyphs
;
10014 struct it it_before
;
10016 /* Get the next display element. */
10017 if (!get_next_display_element (it
))
10019 /* Don't count empty row if we are counting needed tool-bar lines. */
10020 if (height
< 0 && !it
->hpos
)
10025 /* Produce glyphs. */
10026 n_glyphs_before
= row
->used
[TEXT_AREA
];
10029 PRODUCE_GLYPHS (it
);
10031 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
10033 x
= it_before
.current_x
;
10034 while (i
< nglyphs
)
10036 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
10038 if (x
+ glyph
->pixel_width
> max_x
)
10040 /* Glyph doesn't fit on line. Backtrack. */
10041 row
->used
[TEXT_AREA
] = n_glyphs_before
;
10043 /* If this is the only glyph on this line, it will never fit on the
10044 toolbar, so skip it. But ensure there is at least one glyph,
10045 so we don't accidentally disable the tool-bar. */
10046 if (n_glyphs_before
== 0
10047 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
10053 x
+= glyph
->pixel_width
;
10057 /* Stop at line ends. */
10058 if (ITERATOR_AT_END_OF_LINE_P (it
))
10061 set_iterator_to_next (it
, 1);
10066 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
10068 /* Use default face for the border below the tool bar.
10070 FIXME: When auto-resize-tool-bars is grow-only, there is
10071 no additional border below the possibly empty tool-bar lines.
10072 So to make the extra empty lines look "normal", we have to
10073 use the tool-bar face for the border too. */
10074 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
10075 it
->face_id
= DEFAULT_FACE_ID
;
10077 extend_face_to_end_of_line (it
);
10078 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
10079 last
->right_box_line_p
= 1;
10080 if (last
== row
->glyphs
[TEXT_AREA
])
10081 last
->left_box_line_p
= 1;
10083 /* Make line the desired height and center it vertically. */
10084 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
10086 /* Don't add more than one line height. */
10087 height
%= FRAME_LINE_HEIGHT (it
->f
);
10088 it
->max_ascent
+= height
/ 2;
10089 it
->max_descent
+= (height
+ 1) / 2;
10092 compute_line_metrics (it
);
10094 /* If line is empty, make it occupy the rest of the tool-bar. */
10095 if (!row
->displays_text_p
)
10097 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
10098 row
->visible_height
= row
->height
;
10099 row
->ascent
= row
->phys_ascent
= 0;
10100 row
->extra_line_spacing
= 0;
10103 row
->full_width_p
= 1;
10104 row
->continued_p
= 0;
10105 row
->truncated_on_left_p
= 0;
10106 row
->truncated_on_right_p
= 0;
10108 it
->current_x
= it
->hpos
= 0;
10109 it
->current_y
+= row
->height
;
10115 /* Max tool-bar height. */
10117 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
10118 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
10120 /* Value is the number of screen lines needed to make all tool-bar
10121 items of frame F visible. The number of actual rows needed is
10122 returned in *N_ROWS if non-NULL. */
10125 tool_bar_lines_needed (f
, n_rows
)
10129 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10131 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
10132 the desired matrix, so use (unused) mode-line row as temporary row to
10133 avoid destroying the first tool-bar row. */
10134 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
10136 /* Initialize an iterator for iteration over
10137 F->desired_tool_bar_string in the tool-bar window of frame F. */
10138 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
10139 it
.first_visible_x
= 0;
10140 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10141 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10143 while (!ITERATOR_AT_END_P (&it
))
10145 clear_glyph_row (temp_row
);
10146 it
.glyph_row
= temp_row
;
10147 display_tool_bar_line (&it
, -1);
10149 clear_glyph_row (temp_row
);
10151 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
10153 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
10155 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
10159 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
10161 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
10170 frame
= selected_frame
;
10172 CHECK_FRAME (frame
);
10173 f
= XFRAME (frame
);
10175 if (WINDOWP (f
->tool_bar_window
)
10176 || (w
= XWINDOW (f
->tool_bar_window
),
10177 WINDOW_TOTAL_LINES (w
) > 0))
10179 update_tool_bar (f
, 1);
10180 if (f
->n_tool_bar_items
)
10182 build_desired_tool_bar_string (f
);
10183 nlines
= tool_bar_lines_needed (f
, NULL
);
10187 return make_number (nlines
);
10191 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
10192 height should be changed. */
10195 redisplay_tool_bar (f
)
10200 struct glyph_row
*row
;
10202 #if defined (USE_GTK) || USE_MAC_TOOLBAR
10203 if (FRAME_EXTERNAL_TOOL_BAR (f
))
10204 update_frame_tool_bar (f
);
10208 /* If frame hasn't a tool-bar window or if it is zero-height, don't
10209 do anything. This means you must start with tool-bar-lines
10210 non-zero to get the auto-sizing effect. Or in other words, you
10211 can turn off tool-bars by specifying tool-bar-lines zero. */
10212 if (!WINDOWP (f
->tool_bar_window
)
10213 || (w
= XWINDOW (f
->tool_bar_window
),
10214 WINDOW_TOTAL_LINES (w
) == 0))
10217 /* Set up an iterator for the tool-bar window. */
10218 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
10219 it
.first_visible_x
= 0;
10220 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10221 row
= it
.glyph_row
;
10223 /* Build a string that represents the contents of the tool-bar. */
10224 build_desired_tool_bar_string (f
);
10225 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10227 if (f
->n_tool_bar_rows
== 0)
10231 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
10232 nlines
!= WINDOW_TOTAL_LINES (w
)))
10234 extern Lisp_Object Qtool_bar_lines
;
10236 int old_height
= WINDOW_TOTAL_LINES (w
);
10238 XSETFRAME (frame
, f
);
10239 Fmodify_frame_parameters (frame
,
10240 Fcons (Fcons (Qtool_bar_lines
,
10241 make_number (nlines
)),
10243 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10245 clear_glyph_matrix (w
->desired_matrix
);
10246 fonts_changed_p
= 1;
10252 /* Display as many lines as needed to display all tool-bar items. */
10254 if (f
->n_tool_bar_rows
> 0)
10256 int border
, rows
, height
, extra
;
10258 if (INTEGERP (Vtool_bar_border
))
10259 border
= XINT (Vtool_bar_border
);
10260 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
10261 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
10262 else if (EQ (Vtool_bar_border
, Qborder_width
))
10263 border
= f
->border_width
;
10269 rows
= f
->n_tool_bar_rows
;
10270 height
= max (1, (it
.last_visible_y
- border
) / rows
);
10271 extra
= it
.last_visible_y
- border
- height
* rows
;
10273 while (it
.current_y
< it
.last_visible_y
)
10276 if (extra
> 0 && rows
-- > 0)
10278 h
= (extra
+ rows
- 1) / rows
;
10281 display_tool_bar_line (&it
, height
+ h
);
10286 while (it
.current_y
< it
.last_visible_y
)
10287 display_tool_bar_line (&it
, 0);
10290 /* It doesn't make much sense to try scrolling in the tool-bar
10291 window, so don't do it. */
10292 w
->desired_matrix
->no_scrolling_p
= 1;
10293 w
->must_be_updated_p
= 1;
10295 if (!NILP (Vauto_resize_tool_bars
))
10297 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
10298 int change_height_p
= 0;
10300 /* If we couldn't display everything, change the tool-bar's
10301 height if there is room for more. */
10302 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
10303 && it
.current_y
< max_tool_bar_height
)
10304 change_height_p
= 1;
10306 row
= it
.glyph_row
- 1;
10308 /* If there are blank lines at the end, except for a partially
10309 visible blank line at the end that is smaller than
10310 FRAME_LINE_HEIGHT, change the tool-bar's height. */
10311 if (!row
->displays_text_p
10312 && row
->height
>= FRAME_LINE_HEIGHT (f
))
10313 change_height_p
= 1;
10315 /* If row displays tool-bar items, but is partially visible,
10316 change the tool-bar's height. */
10317 if (row
->displays_text_p
10318 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
10319 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
10320 change_height_p
= 1;
10322 /* Resize windows as needed by changing the `tool-bar-lines'
10323 frame parameter. */
10324 if (change_height_p
)
10326 extern Lisp_Object Qtool_bar_lines
;
10328 int old_height
= WINDOW_TOTAL_LINES (w
);
10330 int nlines
= tool_bar_lines_needed (f
, &nrows
);
10332 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
10333 && !f
->minimize_tool_bar_window_p
)
10334 ? (nlines
> old_height
)
10335 : (nlines
!= old_height
));
10336 f
->minimize_tool_bar_window_p
= 0;
10338 if (change_height_p
)
10340 XSETFRAME (frame
, f
);
10341 Fmodify_frame_parameters (frame
,
10342 Fcons (Fcons (Qtool_bar_lines
,
10343 make_number (nlines
)),
10345 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10347 clear_glyph_matrix (w
->desired_matrix
);
10348 f
->n_tool_bar_rows
= nrows
;
10349 fonts_changed_p
= 1;
10356 f
->minimize_tool_bar_window_p
= 0;
10361 /* Get information about the tool-bar item which is displayed in GLYPH
10362 on frame F. Return in *PROP_IDX the index where tool-bar item
10363 properties start in F->tool_bar_items. Value is zero if
10364 GLYPH doesn't display a tool-bar item. */
10367 tool_bar_item_info (f
, glyph
, prop_idx
)
10369 struct glyph
*glyph
;
10376 /* This function can be called asynchronously, which means we must
10377 exclude any possibility that Fget_text_property signals an
10379 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
10380 charpos
= max (0, charpos
);
10382 /* Get the text property `menu-item' at pos. The value of that
10383 property is the start index of this item's properties in
10384 F->tool_bar_items. */
10385 prop
= Fget_text_property (make_number (charpos
),
10386 Qmenu_item
, f
->current_tool_bar_string
);
10387 if (INTEGERP (prop
))
10389 *prop_idx
= XINT (prop
);
10399 /* Get information about the tool-bar item at position X/Y on frame F.
10400 Return in *GLYPH a pointer to the glyph of the tool-bar item in
10401 the current matrix of the tool-bar window of F, or NULL if not
10402 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
10403 item in F->tool_bar_items. Value is
10405 -1 if X/Y is not on a tool-bar item
10406 0 if X/Y is on the same item that was highlighted before.
10410 get_tool_bar_item (f
, x
, y
, glyph
, hpos
, vpos
, prop_idx
)
10413 struct glyph
**glyph
;
10414 int *hpos
, *vpos
, *prop_idx
;
10416 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10417 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10420 /* Find the glyph under X/Y. */
10421 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
10422 if (*glyph
== NULL
)
10425 /* Get the start of this tool-bar item's properties in
10426 f->tool_bar_items. */
10427 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
10430 /* Is mouse on the highlighted item? */
10431 if (EQ (f
->tool_bar_window
, dpyinfo
->mouse_face_window
)
10432 && *vpos
>= dpyinfo
->mouse_face_beg_row
10433 && *vpos
<= dpyinfo
->mouse_face_end_row
10434 && (*vpos
> dpyinfo
->mouse_face_beg_row
10435 || *hpos
>= dpyinfo
->mouse_face_beg_col
)
10436 && (*vpos
< dpyinfo
->mouse_face_end_row
10437 || *hpos
< dpyinfo
->mouse_face_end_col
10438 || dpyinfo
->mouse_face_past_end
))
10446 Handle mouse button event on the tool-bar of frame F, at
10447 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
10448 0 for button release. MODIFIERS is event modifiers for button
10452 handle_tool_bar_click (f
, x
, y
, down_p
, modifiers
)
10455 unsigned int modifiers
;
10457 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10458 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10459 int hpos
, vpos
, prop_idx
;
10460 struct glyph
*glyph
;
10461 Lisp_Object enabled_p
;
10463 /* If not on the highlighted tool-bar item, return. */
10464 frame_to_window_pixel_xy (w
, &x
, &y
);
10465 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
10468 /* If item is disabled, do nothing. */
10469 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10470 if (NILP (enabled_p
))
10475 /* Show item in pressed state. */
10476 show_mouse_face (dpyinfo
, DRAW_IMAGE_SUNKEN
);
10477 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
10478 last_tool_bar_item
= prop_idx
;
10482 Lisp_Object key
, frame
;
10483 struct input_event event
;
10484 EVENT_INIT (event
);
10486 /* Show item in released state. */
10487 show_mouse_face (dpyinfo
, DRAW_IMAGE_RAISED
);
10488 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
10490 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
10492 XSETFRAME (frame
, f
);
10493 event
.kind
= TOOL_BAR_EVENT
;
10494 event
.frame_or_window
= frame
;
10496 kbd_buffer_store_event (&event
);
10498 event
.kind
= TOOL_BAR_EVENT
;
10499 event
.frame_or_window
= frame
;
10501 event
.modifiers
= modifiers
;
10502 kbd_buffer_store_event (&event
);
10503 last_tool_bar_item
= -1;
10508 /* Possibly highlight a tool-bar item on frame F when mouse moves to
10509 tool-bar window-relative coordinates X/Y. Called from
10510 note_mouse_highlight. */
10513 note_tool_bar_highlight (f
, x
, y
)
10517 Lisp_Object window
= f
->tool_bar_window
;
10518 struct window
*w
= XWINDOW (window
);
10519 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10521 struct glyph
*glyph
;
10522 struct glyph_row
*row
;
10524 Lisp_Object enabled_p
;
10526 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
10527 int mouse_down_p
, rc
;
10529 /* Function note_mouse_highlight is called with negative x(y
10530 values when mouse moves outside of the frame. */
10531 if (x
<= 0 || y
<= 0)
10533 clear_mouse_face (dpyinfo
);
10537 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
10540 /* Not on tool-bar item. */
10541 clear_mouse_face (dpyinfo
);
10545 /* On same tool-bar item as before. */
10546 goto set_help_echo
;
10548 clear_mouse_face (dpyinfo
);
10550 /* Mouse is down, but on different tool-bar item? */
10551 mouse_down_p
= (dpyinfo
->grabbed
10552 && f
== last_mouse_frame
10553 && FRAME_LIVE_P (f
));
10555 && last_tool_bar_item
!= prop_idx
)
10558 dpyinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
10559 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
10561 /* If tool-bar item is not enabled, don't highlight it. */
10562 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10563 if (!NILP (enabled_p
))
10565 /* Compute the x-position of the glyph. In front and past the
10566 image is a space. We include this in the highlighted area. */
10567 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
10568 for (i
= x
= 0; i
< hpos
; ++i
)
10569 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
10571 /* Record this as the current active region. */
10572 dpyinfo
->mouse_face_beg_col
= hpos
;
10573 dpyinfo
->mouse_face_beg_row
= vpos
;
10574 dpyinfo
->mouse_face_beg_x
= x
;
10575 dpyinfo
->mouse_face_beg_y
= row
->y
;
10576 dpyinfo
->mouse_face_past_end
= 0;
10578 dpyinfo
->mouse_face_end_col
= hpos
+ 1;
10579 dpyinfo
->mouse_face_end_row
= vpos
;
10580 dpyinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
10581 dpyinfo
->mouse_face_end_y
= row
->y
;
10582 dpyinfo
->mouse_face_window
= window
;
10583 dpyinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
10585 /* Display it as active. */
10586 show_mouse_face (dpyinfo
, draw
);
10587 dpyinfo
->mouse_face_image_state
= draw
;
10592 /* Set help_echo_string to a help string to display for this tool-bar item.
10593 XTread_socket does the rest. */
10594 help_echo_object
= help_echo_window
= Qnil
;
10595 help_echo_pos
= -1;
10596 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
10597 if (NILP (help_echo_string
))
10598 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
10601 #endif /* HAVE_WINDOW_SYSTEM */
10605 /************************************************************************
10606 Horizontal scrolling
10607 ************************************************************************/
10609 static int hscroll_window_tree
P_ ((Lisp_Object
));
10610 static int hscroll_windows
P_ ((Lisp_Object
));
10612 /* For all leaf windows in the window tree rooted at WINDOW, set their
10613 hscroll value so that PT is (i) visible in the window, and (ii) so
10614 that it is not within a certain margin at the window's left and
10615 right border. Value is non-zero if any window's hscroll has been
10619 hscroll_window_tree (window
)
10620 Lisp_Object window
;
10622 int hscrolled_p
= 0;
10623 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
10624 int hscroll_step_abs
= 0;
10625 double hscroll_step_rel
= 0;
10627 if (hscroll_relative_p
)
10629 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
10630 if (hscroll_step_rel
< 0)
10632 hscroll_relative_p
= 0;
10633 hscroll_step_abs
= 0;
10636 else if (INTEGERP (Vhscroll_step
))
10638 hscroll_step_abs
= XINT (Vhscroll_step
);
10639 if (hscroll_step_abs
< 0)
10640 hscroll_step_abs
= 0;
10643 hscroll_step_abs
= 0;
10645 while (WINDOWP (window
))
10647 struct window
*w
= XWINDOW (window
);
10649 if (WINDOWP (w
->hchild
))
10650 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
10651 else if (WINDOWP (w
->vchild
))
10652 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
10653 else if (w
->cursor
.vpos
>= 0)
10656 int text_area_width
;
10657 struct glyph_row
*current_cursor_row
10658 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
10659 struct glyph_row
*desired_cursor_row
10660 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
10661 struct glyph_row
*cursor_row
10662 = (desired_cursor_row
->enabled_p
10663 ? desired_cursor_row
10664 : current_cursor_row
);
10666 text_area_width
= window_box_width (w
, TEXT_AREA
);
10668 /* Scroll when cursor is inside this scroll margin. */
10669 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
10671 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
10672 && ((XFASTINT (w
->hscroll
)
10673 && w
->cursor
.x
<= h_margin
)
10674 || (cursor_row
->enabled_p
10675 && cursor_row
->truncated_on_right_p
10676 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
10680 struct buffer
*saved_current_buffer
;
10684 /* Find point in a display of infinite width. */
10685 saved_current_buffer
= current_buffer
;
10686 current_buffer
= XBUFFER (w
->buffer
);
10688 if (w
== XWINDOW (selected_window
))
10689 pt
= BUF_PT (current_buffer
);
10692 pt
= marker_position (w
->pointm
);
10693 pt
= max (BEGV
, pt
);
10697 /* Move iterator to pt starting at cursor_row->start in
10698 a line with infinite width. */
10699 init_to_row_start (&it
, w
, cursor_row
);
10700 it
.last_visible_x
= INFINITY
;
10701 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
10702 current_buffer
= saved_current_buffer
;
10704 /* Position cursor in window. */
10705 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
10706 hscroll
= max (0, (it
.current_x
10707 - (ITERATOR_AT_END_OF_LINE_P (&it
)
10708 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
10709 : (text_area_width
/ 2))))
10710 / FRAME_COLUMN_WIDTH (it
.f
);
10711 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
10713 if (hscroll_relative_p
)
10714 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
10717 wanted_x
= text_area_width
10718 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10721 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10725 if (hscroll_relative_p
)
10726 wanted_x
= text_area_width
* hscroll_step_rel
10729 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10732 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10734 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
10736 /* Don't call Fset_window_hscroll if value hasn't
10737 changed because it will prevent redisplay
10739 if (XFASTINT (w
->hscroll
) != hscroll
)
10741 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
10742 w
->hscroll
= make_number (hscroll
);
10751 /* Value is non-zero if hscroll of any leaf window has been changed. */
10752 return hscrolled_p
;
10756 /* Set hscroll so that cursor is visible and not inside horizontal
10757 scroll margins for all windows in the tree rooted at WINDOW. See
10758 also hscroll_window_tree above. Value is non-zero if any window's
10759 hscroll has been changed. If it has, desired matrices on the frame
10760 of WINDOW are cleared. */
10763 hscroll_windows (window
)
10764 Lisp_Object window
;
10766 int hscrolled_p
= hscroll_window_tree (window
);
10768 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
10769 return hscrolled_p
;
10774 /************************************************************************
10776 ************************************************************************/
10778 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
10779 to a non-zero value. This is sometimes handy to have in a debugger
10784 /* First and last unchanged row for try_window_id. */
10786 int debug_first_unchanged_at_end_vpos
;
10787 int debug_last_unchanged_at_beg_vpos
;
10789 /* Delta vpos and y. */
10791 int debug_dvpos
, debug_dy
;
10793 /* Delta in characters and bytes for try_window_id. */
10795 int debug_delta
, debug_delta_bytes
;
10797 /* Values of window_end_pos and window_end_vpos at the end of
10800 EMACS_INT debug_end_pos
, debug_end_vpos
;
10802 /* Append a string to W->desired_matrix->method. FMT is a printf
10803 format string. A1...A9 are a supplement for a variable-length
10804 argument list. If trace_redisplay_p is non-zero also printf the
10805 resulting string to stderr. */
10808 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
10811 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
10814 char *method
= w
->desired_matrix
->method
;
10815 int len
= strlen (method
);
10816 int size
= sizeof w
->desired_matrix
->method
;
10817 int remaining
= size
- len
- 1;
10819 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
10820 if (len
&& remaining
)
10823 --remaining
, ++len
;
10826 strncpy (method
+ len
, buffer
, remaining
);
10828 if (trace_redisplay_p
)
10829 fprintf (stderr
, "%p (%s): %s\n",
10831 ((BUFFERP (w
->buffer
)
10832 && STRINGP (XBUFFER (w
->buffer
)->name
))
10833 ? (char *) SDATA (XBUFFER (w
->buffer
)->name
)
10838 #endif /* GLYPH_DEBUG */
10841 /* Value is non-zero if all changes in window W, which displays
10842 current_buffer, are in the text between START and END. START is a
10843 buffer position, END is given as a distance from Z. Used in
10844 redisplay_internal for display optimization. */
10847 text_outside_line_unchanged_p (w
, start
, end
)
10851 int unchanged_p
= 1;
10853 /* If text or overlays have changed, see where. */
10854 if (XFASTINT (w
->last_modified
) < MODIFF
10855 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
10857 /* Gap in the line? */
10858 if (GPT
< start
|| Z
- GPT
< end
)
10861 /* Changes start in front of the line, or end after it? */
10863 && (BEG_UNCHANGED
< start
- 1
10864 || END_UNCHANGED
< end
))
10867 /* If selective display, can't optimize if changes start at the
10868 beginning of the line. */
10870 && INTEGERP (current_buffer
->selective_display
)
10871 && XINT (current_buffer
->selective_display
) > 0
10872 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
10875 /* If there are overlays at the start or end of the line, these
10876 may have overlay strings with newlines in them. A change at
10877 START, for instance, may actually concern the display of such
10878 overlay strings as well, and they are displayed on different
10879 lines. So, quickly rule out this case. (For the future, it
10880 might be desirable to implement something more telling than
10881 just BEG/END_UNCHANGED.) */
10884 if (BEG
+ BEG_UNCHANGED
== start
10885 && overlay_touches_p (start
))
10887 if (END_UNCHANGED
== end
10888 && overlay_touches_p (Z
- end
))
10893 return unchanged_p
;
10897 /* Do a frame update, taking possible shortcuts into account. This is
10898 the main external entry point for redisplay.
10900 If the last redisplay displayed an echo area message and that message
10901 is no longer requested, we clear the echo area or bring back the
10902 mini-buffer if that is in use. */
10907 redisplay_internal (0);
10912 overlay_arrow_string_or_property (var
)
10917 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
10920 return Voverlay_arrow_string
;
10923 /* Return 1 if there are any overlay-arrows in current_buffer. */
10925 overlay_arrow_in_current_buffer_p ()
10929 for (vlist
= Voverlay_arrow_variable_list
;
10931 vlist
= XCDR (vlist
))
10933 Lisp_Object var
= XCAR (vlist
);
10936 if (!SYMBOLP (var
))
10938 val
= find_symbol_value (var
);
10940 && current_buffer
== XMARKER (val
)->buffer
)
10947 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
10951 overlay_arrows_changed_p ()
10955 for (vlist
= Voverlay_arrow_variable_list
;
10957 vlist
= XCDR (vlist
))
10959 Lisp_Object var
= XCAR (vlist
);
10960 Lisp_Object val
, pstr
;
10962 if (!SYMBOLP (var
))
10964 val
= find_symbol_value (var
);
10965 if (!MARKERP (val
))
10967 if (! EQ (COERCE_MARKER (val
),
10968 Fget (var
, Qlast_arrow_position
))
10969 || ! (pstr
= overlay_arrow_string_or_property (var
),
10970 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
10976 /* Mark overlay arrows to be updated on next redisplay. */
10979 update_overlay_arrows (up_to_date
)
10984 for (vlist
= Voverlay_arrow_variable_list
;
10986 vlist
= XCDR (vlist
))
10988 Lisp_Object var
= XCAR (vlist
);
10990 if (!SYMBOLP (var
))
10993 if (up_to_date
> 0)
10995 Lisp_Object val
= find_symbol_value (var
);
10996 Fput (var
, Qlast_arrow_position
,
10997 COERCE_MARKER (val
));
10998 Fput (var
, Qlast_arrow_string
,
10999 overlay_arrow_string_or_property (var
));
11001 else if (up_to_date
< 0
11002 || !NILP (Fget (var
, Qlast_arrow_position
)))
11004 Fput (var
, Qlast_arrow_position
, Qt
);
11005 Fput (var
, Qlast_arrow_string
, Qt
);
11011 /* Return overlay arrow string to display at row.
11012 Return integer (bitmap number) for arrow bitmap in left fringe.
11013 Return nil if no overlay arrow. */
11016 overlay_arrow_at_row (it
, row
)
11018 struct glyph_row
*row
;
11022 for (vlist
= Voverlay_arrow_variable_list
;
11024 vlist
= XCDR (vlist
))
11026 Lisp_Object var
= XCAR (vlist
);
11029 if (!SYMBOLP (var
))
11032 val
= find_symbol_value (var
);
11035 && current_buffer
== XMARKER (val
)->buffer
11036 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
11038 if (FRAME_WINDOW_P (it
->f
)
11039 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
11041 #ifdef HAVE_WINDOW_SYSTEM
11042 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
11045 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
11046 return make_number (fringe_bitmap
);
11049 return make_number (-1); /* Use default arrow bitmap */
11051 return overlay_arrow_string_or_property (var
);
11058 /* Return 1 if point moved out of or into a composition. Otherwise
11059 return 0. PREV_BUF and PREV_PT are the last point buffer and
11060 position. BUF and PT are the current point buffer and position. */
11063 check_point_in_composition (prev_buf
, prev_pt
, buf
, pt
)
11064 struct buffer
*prev_buf
, *buf
;
11067 EMACS_INT start
, end
;
11069 Lisp_Object buffer
;
11071 XSETBUFFER (buffer
, buf
);
11072 /* Check a composition at the last point if point moved within the
11074 if (prev_buf
== buf
)
11077 /* Point didn't move. */
11080 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
11081 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
11082 && COMPOSITION_VALID_P (start
, end
, prop
)
11083 && start
< prev_pt
&& end
> prev_pt
)
11084 /* The last point was within the composition. Return 1 iff
11085 point moved out of the composition. */
11086 return (pt
<= start
|| pt
>= end
);
11089 /* Check a composition at the current point. */
11090 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
11091 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
11092 && COMPOSITION_VALID_P (start
, end
, prop
)
11093 && start
< pt
&& end
> pt
);
11097 /* Reconsider the setting of B->clip_changed which is displayed
11101 reconsider_clip_changes (w
, b
)
11105 if (b
->clip_changed
11106 && !NILP (w
->window_end_valid
)
11107 && w
->current_matrix
->buffer
== b
11108 && w
->current_matrix
->zv
== BUF_ZV (b
)
11109 && w
->current_matrix
->begv
== BUF_BEGV (b
))
11110 b
->clip_changed
= 0;
11112 /* If display wasn't paused, and W is not a tool bar window, see if
11113 point has been moved into or out of a composition. In that case,
11114 we set b->clip_changed to 1 to force updating the screen. If
11115 b->clip_changed has already been set to 1, we can skip this
11117 if (!b
->clip_changed
11118 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
11122 if (w
== XWINDOW (selected_window
))
11123 pt
= BUF_PT (current_buffer
);
11125 pt
= marker_position (w
->pointm
);
11127 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
11128 || pt
!= XINT (w
->last_point
))
11129 && check_point_in_composition (w
->current_matrix
->buffer
,
11130 XINT (w
->last_point
),
11131 XBUFFER (w
->buffer
), pt
))
11132 b
->clip_changed
= 1;
11137 /* Select FRAME to forward the values of frame-local variables into C
11138 variables so that the redisplay routines can access those values
11142 select_frame_for_redisplay (frame
)
11145 Lisp_Object tail
, symbol
, val
;
11146 Lisp_Object old
= selected_frame
;
11147 struct Lisp_Symbol
*sym
;
11149 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
11151 selected_frame
= frame
;
11155 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
11156 if (CONSP (XCAR (tail
))
11157 && (symbol
= XCAR (XCAR (tail
)),
11159 && (sym
= indirect_variable (XSYMBOL (symbol
)),
11161 (BUFFER_LOCAL_VALUEP (val
)))
11162 && XBUFFER_LOCAL_VALUE (val
)->check_frame
)
11163 /* Use find_symbol_value rather than Fsymbol_value
11164 to avoid an error if it is void. */
11165 find_symbol_value (symbol
);
11166 } while (!EQ (frame
, old
) && (frame
= old
, 1));
11170 #define STOP_POLLING \
11171 do { if (! polling_stopped_here) stop_polling (); \
11172 polling_stopped_here = 1; } while (0)
11174 #define RESUME_POLLING \
11175 do { if (polling_stopped_here) start_polling (); \
11176 polling_stopped_here = 0; } while (0)
11179 /* If PRESERVE_ECHO_AREA is nonzero, it means this redisplay is not in
11180 response to any user action; therefore, we should preserve the echo
11181 area. (Actually, our caller does that job.) Perhaps in the future
11182 avoid recentering windows if it is not necessary; currently that
11183 causes some problems. */
11186 redisplay_internal (preserve_echo_area
)
11187 int preserve_echo_area
;
11189 struct window
*w
= XWINDOW (selected_window
);
11192 int must_finish
= 0;
11193 struct text_pos tlbufpos
, tlendpos
;
11194 int number_of_visible_frames
;
11197 int polling_stopped_here
= 0;
11198 Lisp_Object old_frame
= selected_frame
;
11200 /* Non-zero means redisplay has to consider all windows on all
11201 frames. Zero means, only selected_window is considered. */
11202 int consider_all_windows_p
;
11204 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
11206 /* No redisplay if running in batch mode or frame is not yet fully
11207 initialized, or redisplay is explicitly turned off by setting
11208 Vinhibit_redisplay. */
11210 || !NILP (Vinhibit_redisplay
))
11213 /* Don't examine these until after testing Vinhibit_redisplay.
11214 When Emacs is shutting down, perhaps because its connection to
11215 X has dropped, we should not look at them at all. */
11216 f
= XFRAME (w
->frame
);
11217 sf
= SELECTED_FRAME ();
11219 if (!f
->glyphs_initialized_p
)
11222 /* The flag redisplay_performed_directly_p is set by
11223 direct_output_for_insert when it already did the whole screen
11224 update necessary. */
11225 if (redisplay_performed_directly_p
)
11227 redisplay_performed_directly_p
= 0;
11228 if (!hscroll_windows (selected_window
))
11232 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (MAC_OS)
11233 if (popup_activated ())
11237 /* I don't think this happens but let's be paranoid. */
11238 if (redisplaying_p
)
11241 /* Record a function that resets redisplaying_p to its old value
11242 when we leave this function. */
11243 count
= SPECPDL_INDEX ();
11244 record_unwind_protect (unwind_redisplay
,
11245 Fcons (make_number (redisplaying_p
), selected_frame
));
11247 specbind (Qinhibit_free_realized_faces
, Qnil
);
11250 Lisp_Object tail
, frame
;
11252 FOR_EACH_FRAME (tail
, frame
)
11254 struct frame
*f
= XFRAME (frame
);
11255 f
->already_hscrolled_p
= 0;
11260 if (!EQ (old_frame
, selected_frame
)
11261 && FRAME_LIVE_P (XFRAME (old_frame
)))
11262 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
11263 selected_frame and selected_window to be temporarily out-of-sync so
11264 when we come back here via `goto retry', we need to resync because we
11265 may need to run Elisp code (via prepare_menu_bars). */
11266 select_frame_for_redisplay (old_frame
);
11269 reconsider_clip_changes (w
, current_buffer
);
11270 last_escape_glyph_frame
= NULL
;
11271 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
11273 /* If new fonts have been loaded that make a glyph matrix adjustment
11274 necessary, do it. */
11275 if (fonts_changed_p
)
11277 adjust_glyphs (NULL
);
11278 ++windows_or_buffers_changed
;
11279 fonts_changed_p
= 0;
11282 /* If face_change_count is non-zero, init_iterator will free all
11283 realized faces, which includes the faces referenced from current
11284 matrices. So, we can't reuse current matrices in this case. */
11285 if (face_change_count
)
11286 ++windows_or_buffers_changed
;
11288 if (FRAME_TERMCAP_P (sf
)
11289 && FRAME_TTY (sf
)->previous_frame
!= sf
)
11291 /* Since frames on a single ASCII terminal share the same
11292 display area, displaying a different frame means redisplay
11293 the whole thing. */
11294 windows_or_buffers_changed
++;
11295 SET_FRAME_GARBAGED (sf
);
11297 set_tty_color_mode (FRAME_TTY (sf
), sf
);
11299 FRAME_TTY (sf
)->previous_frame
= sf
;
11302 /* Set the visible flags for all frames. Do this before checking
11303 for resized or garbaged frames; they want to know if their frames
11304 are visible. See the comment in frame.h for
11305 FRAME_SAMPLE_VISIBILITY. */
11307 Lisp_Object tail
, frame
;
11309 number_of_visible_frames
= 0;
11311 FOR_EACH_FRAME (tail
, frame
)
11313 struct frame
*f
= XFRAME (frame
);
11315 FRAME_SAMPLE_VISIBILITY (f
);
11316 if (FRAME_VISIBLE_P (f
))
11317 ++number_of_visible_frames
;
11318 clear_desired_matrices (f
);
11323 /* Notice any pending interrupt request to change frame size. */
11324 do_pending_window_change (1);
11326 /* Clear frames marked as garbaged. */
11327 if (frame_garbaged
)
11328 clear_garbaged_frames ();
11330 /* Build menubar and tool-bar items. */
11331 if (NILP (Vmemory_full
))
11332 prepare_menu_bars ();
11334 if (windows_or_buffers_changed
)
11335 update_mode_lines
++;
11337 /* Detect case that we need to write or remove a star in the mode line. */
11338 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
11340 w
->update_mode_line
= Qt
;
11341 if (buffer_shared
> 1)
11342 update_mode_lines
++;
11345 /* Avoid invocation of point motion hooks by `current_column' below. */
11346 count1
= SPECPDL_INDEX ();
11347 specbind (Qinhibit_point_motion_hooks
, Qt
);
11349 /* If %c is in the mode line, update it if needed. */
11350 if (!NILP (w
->column_number_displayed
)
11351 /* This alternative quickly identifies a common case
11352 where no change is needed. */
11353 && !(PT
== XFASTINT (w
->last_point
)
11354 && XFASTINT (w
->last_modified
) >= MODIFF
11355 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
11356 && (XFASTINT (w
->column_number_displayed
)
11357 != (int) current_column ())) /* iftc */
11358 w
->update_mode_line
= Qt
;
11360 unbind_to (count1
, Qnil
);
11362 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
11364 /* The variable buffer_shared is set in redisplay_window and
11365 indicates that we redisplay a buffer in different windows. See
11367 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
11368 || cursor_type_changed
);
11370 /* If specs for an arrow have changed, do thorough redisplay
11371 to ensure we remove any arrow that should no longer exist. */
11372 if (overlay_arrows_changed_p ())
11373 consider_all_windows_p
= windows_or_buffers_changed
= 1;
11375 /* Normally the message* functions will have already displayed and
11376 updated the echo area, but the frame may have been trashed, or
11377 the update may have been preempted, so display the echo area
11378 again here. Checking message_cleared_p captures the case that
11379 the echo area should be cleared. */
11380 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
11381 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
11382 || (message_cleared_p
11383 && minibuf_level
== 0
11384 /* If the mini-window is currently selected, this means the
11385 echo-area doesn't show through. */
11386 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
11388 int window_height_changed_p
= echo_area_display (0);
11391 /* If we don't display the current message, don't clear the
11392 message_cleared_p flag, because, if we did, we wouldn't clear
11393 the echo area in the next redisplay which doesn't preserve
11395 if (!display_last_displayed_message_p
)
11396 message_cleared_p
= 0;
11398 if (fonts_changed_p
)
11400 else if (window_height_changed_p
)
11402 consider_all_windows_p
= 1;
11403 ++update_mode_lines
;
11404 ++windows_or_buffers_changed
;
11406 /* If window configuration was changed, frames may have been
11407 marked garbaged. Clear them or we will experience
11408 surprises wrt scrolling. */
11409 if (frame_garbaged
)
11410 clear_garbaged_frames ();
11413 else if (EQ (selected_window
, minibuf_window
)
11414 && (current_buffer
->clip_changed
11415 || XFASTINT (w
->last_modified
) < MODIFF
11416 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11417 && resize_mini_window (w
, 0))
11419 /* Resized active mini-window to fit the size of what it is
11420 showing if its contents might have changed. */
11422 consider_all_windows_p
= 1;
11423 ++windows_or_buffers_changed
;
11424 ++update_mode_lines
;
11426 /* If window configuration was changed, frames may have been
11427 marked garbaged. Clear them or we will experience
11428 surprises wrt scrolling. */
11429 if (frame_garbaged
)
11430 clear_garbaged_frames ();
11434 /* If showing the region, and mark has changed, we must redisplay
11435 the whole window. The assignment to this_line_start_pos prevents
11436 the optimization directly below this if-statement. */
11437 if (((!NILP (Vtransient_mark_mode
)
11438 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
11439 != !NILP (w
->region_showing
))
11440 || (!NILP (w
->region_showing
)
11441 && !EQ (w
->region_showing
,
11442 Fmarker_position (XBUFFER (w
->buffer
)->mark
))))
11443 CHARPOS (this_line_start_pos
) = 0;
11445 /* Optimize the case that only the line containing the cursor in the
11446 selected window has changed. Variables starting with this_ are
11447 set in display_line and record information about the line
11448 containing the cursor. */
11449 tlbufpos
= this_line_start_pos
;
11450 tlendpos
= this_line_end_pos
;
11451 if (!consider_all_windows_p
11452 && CHARPOS (tlbufpos
) > 0
11453 && NILP (w
->update_mode_line
)
11454 && !current_buffer
->clip_changed
11455 && !current_buffer
->prevent_redisplay_optimizations_p
11456 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
11457 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
11458 /* Make sure recorded data applies to current buffer, etc. */
11459 && this_line_buffer
== current_buffer
11460 && current_buffer
== XBUFFER (w
->buffer
)
11461 && NILP (w
->force_start
)
11462 && NILP (w
->optional_new_start
)
11463 /* Point must be on the line that we have info recorded about. */
11464 && PT
>= CHARPOS (tlbufpos
)
11465 && PT
<= Z
- CHARPOS (tlendpos
)
11466 /* All text outside that line, including its final newline,
11467 must be unchanged */
11468 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
11469 CHARPOS (tlendpos
)))
11471 if (CHARPOS (tlbufpos
) > BEGV
11472 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
11473 && (CHARPOS (tlbufpos
) == ZV
11474 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
11475 /* Former continuation line has disappeared by becoming empty */
11477 else if (XFASTINT (w
->last_modified
) < MODIFF
11478 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
11479 || MINI_WINDOW_P (w
))
11481 /* We have to handle the case of continuation around a
11482 wide-column character (See the comment in indent.c around
11485 For instance, in the following case:
11487 -------- Insert --------
11488 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
11489 J_I_ ==> J_I_ `^^' are cursors.
11493 As we have to redraw the line above, we should goto cancel. */
11496 int line_height_before
= this_line_pixel_height
;
11498 /* Note that start_display will handle the case that the
11499 line starting at tlbufpos is a continuation lines. */
11500 start_display (&it
, w
, tlbufpos
);
11502 /* Implementation note: It this still necessary? */
11503 if (it
.current_x
!= this_line_start_x
)
11506 TRACE ((stderr
, "trying display optimization 1\n"));
11507 w
->cursor
.vpos
= -1;
11508 overlay_arrow_seen
= 0;
11509 it
.vpos
= this_line_vpos
;
11510 it
.current_y
= this_line_y
;
11511 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
11512 display_line (&it
);
11514 /* If line contains point, is not continued,
11515 and ends at same distance from eob as before, we win */
11516 if (w
->cursor
.vpos
>= 0
11517 /* Line is not continued, otherwise this_line_start_pos
11518 would have been set to 0 in display_line. */
11519 && CHARPOS (this_line_start_pos
)
11520 /* Line ends as before. */
11521 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
11522 /* Line has same height as before. Otherwise other lines
11523 would have to be shifted up or down. */
11524 && this_line_pixel_height
== line_height_before
)
11526 /* If this is not the window's last line, we must adjust
11527 the charstarts of the lines below. */
11528 if (it
.current_y
< it
.last_visible_y
)
11530 struct glyph_row
*row
11531 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
11532 int delta
, delta_bytes
;
11534 if (Z
- CHARPOS (tlendpos
) == ZV
)
11536 /* This line ends at end of (accessible part of)
11537 buffer. There is no newline to count. */
11539 - CHARPOS (tlendpos
)
11540 - MATRIX_ROW_START_CHARPOS (row
));
11541 delta_bytes
= (Z_BYTE
11542 - BYTEPOS (tlendpos
)
11543 - MATRIX_ROW_START_BYTEPOS (row
));
11547 /* This line ends in a newline. Must take
11548 account of the newline and the rest of the
11549 text that follows. */
11551 - CHARPOS (tlendpos
)
11552 - MATRIX_ROW_START_CHARPOS (row
));
11553 delta_bytes
= (Z_BYTE
11554 - BYTEPOS (tlendpos
)
11555 - MATRIX_ROW_START_BYTEPOS (row
));
11558 increment_matrix_positions (w
->current_matrix
,
11559 this_line_vpos
+ 1,
11560 w
->current_matrix
->nrows
,
11561 delta
, delta_bytes
);
11564 /* If this row displays text now but previously didn't,
11565 or vice versa, w->window_end_vpos may have to be
11567 if ((it
.glyph_row
- 1)->displays_text_p
)
11569 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
11570 XSETINT (w
->window_end_vpos
, this_line_vpos
);
11572 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
11573 && this_line_vpos
> 0)
11574 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
11575 w
->window_end_valid
= Qnil
;
11577 /* Update hint: No need to try to scroll in update_window. */
11578 w
->desired_matrix
->no_scrolling_p
= 1;
11581 *w
->desired_matrix
->method
= 0;
11582 debug_method_add (w
, "optimization 1");
11584 #ifdef HAVE_WINDOW_SYSTEM
11585 update_window_fringes (w
, 0);
11592 else if (/* Cursor position hasn't changed. */
11593 PT
== XFASTINT (w
->last_point
)
11594 /* Make sure the cursor was last displayed
11595 in this window. Otherwise we have to reposition it. */
11596 && 0 <= w
->cursor
.vpos
11597 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
11601 do_pending_window_change (1);
11603 /* We used to always goto end_of_redisplay here, but this
11604 isn't enough if we have a blinking cursor. */
11605 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
11606 goto end_of_redisplay
;
11610 /* If highlighting the region, or if the cursor is in the echo area,
11611 then we can't just move the cursor. */
11612 else if (! (!NILP (Vtransient_mark_mode
)
11613 && !NILP (current_buffer
->mark_active
))
11614 && (EQ (selected_window
, current_buffer
->last_selected_window
)
11615 || highlight_nonselected_windows
)
11616 && NILP (w
->region_showing
)
11617 && NILP (Vshow_trailing_whitespace
)
11618 && !cursor_in_echo_area
)
11621 struct glyph_row
*row
;
11623 /* Skip from tlbufpos to PT and see where it is. Note that
11624 PT may be in invisible text. If so, we will end at the
11625 next visible position. */
11626 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
11627 NULL
, DEFAULT_FACE_ID
);
11628 it
.current_x
= this_line_start_x
;
11629 it
.current_y
= this_line_y
;
11630 it
.vpos
= this_line_vpos
;
11632 /* The call to move_it_to stops in front of PT, but
11633 moves over before-strings. */
11634 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
11636 if (it
.vpos
== this_line_vpos
11637 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
11640 xassert (this_line_vpos
== it
.vpos
);
11641 xassert (this_line_y
== it
.current_y
);
11642 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
11644 *w
->desired_matrix
->method
= 0;
11645 debug_method_add (w
, "optimization 3");
11654 /* Text changed drastically or point moved off of line. */
11655 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
11658 CHARPOS (this_line_start_pos
) = 0;
11659 consider_all_windows_p
|= buffer_shared
> 1;
11660 ++clear_face_cache_count
;
11661 #ifdef HAVE_WINDOW_SYSTEM
11662 ++clear_image_cache_count
;
11665 /* Build desired matrices, and update the display. If
11666 consider_all_windows_p is non-zero, do it for all windows on all
11667 frames. Otherwise do it for selected_window, only. */
11669 if (consider_all_windows_p
)
11671 Lisp_Object tail
, frame
;
11673 FOR_EACH_FRAME (tail
, frame
)
11674 XFRAME (frame
)->updated_p
= 0;
11676 /* Recompute # windows showing selected buffer. This will be
11677 incremented each time such a window is displayed. */
11680 FOR_EACH_FRAME (tail
, frame
)
11682 struct frame
*f
= XFRAME (frame
);
11684 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
11686 if (! EQ (frame
, selected_frame
))
11687 /* Select the frame, for the sake of frame-local
11689 select_frame_for_redisplay (frame
);
11691 /* Mark all the scroll bars to be removed; we'll redeem
11692 the ones we want when we redisplay their windows. */
11693 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
11694 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
11696 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11697 redisplay_windows (FRAME_ROOT_WINDOW (f
));
11699 /* Any scroll bars which redisplay_windows should have
11700 nuked should now go away. */
11701 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
11702 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
11704 /* If fonts changed, display again. */
11705 /* ??? rms: I suspect it is a mistake to jump all the way
11706 back to retry here. It should just retry this frame. */
11707 if (fonts_changed_p
)
11710 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11712 /* See if we have to hscroll. */
11713 if (!f
->already_hscrolled_p
)
11715 f
->already_hscrolled_p
= 1;
11716 if (hscroll_windows (f
->root_window
))
11720 /* Prevent various kinds of signals during display
11721 update. stdio is not robust about handling
11722 signals, which can cause an apparent I/O
11724 if (interrupt_input
)
11725 unrequest_sigio ();
11728 /* Update the display. */
11729 set_window_update_flags (XWINDOW (f
->root_window
), 1);
11730 pause
|= update_frame (f
, 0, 0);
11731 #if 0 /* Exiting the loop can leave the wrong value for buffer_shared. */
11741 if (!EQ (old_frame
, selected_frame
)
11742 && FRAME_LIVE_P (XFRAME (old_frame
)))
11743 /* We played a bit fast-and-loose above and allowed selected_frame
11744 and selected_window to be temporarily out-of-sync but let's make
11745 sure this stays contained. */
11746 select_frame_for_redisplay (old_frame
);
11747 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
11751 /* Do the mark_window_display_accurate after all windows have
11752 been redisplayed because this call resets flags in buffers
11753 which are needed for proper redisplay. */
11754 FOR_EACH_FRAME (tail
, frame
)
11756 struct frame
*f
= XFRAME (frame
);
11759 mark_window_display_accurate (f
->root_window
, 1);
11760 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
11761 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
11766 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
11768 Lisp_Object mini_window
;
11769 struct frame
*mini_frame
;
11771 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
11772 /* Use list_of_error, not Qerror, so that
11773 we catch only errors and don't run the debugger. */
11774 internal_condition_case_1 (redisplay_window_1
, selected_window
,
11776 redisplay_window_error
);
11778 /* Compare desired and current matrices, perform output. */
11781 /* If fonts changed, display again. */
11782 if (fonts_changed_p
)
11785 /* Prevent various kinds of signals during display update.
11786 stdio is not robust about handling signals,
11787 which can cause an apparent I/O error. */
11788 if (interrupt_input
)
11789 unrequest_sigio ();
11792 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
11794 if (hscroll_windows (selected_window
))
11797 XWINDOW (selected_window
)->must_be_updated_p
= 1;
11798 pause
= update_frame (sf
, 0, 0);
11801 /* We may have called echo_area_display at the top of this
11802 function. If the echo area is on another frame, that may
11803 have put text on a frame other than the selected one, so the
11804 above call to update_frame would not have caught it. Catch
11806 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
11807 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
11809 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
11811 XWINDOW (mini_window
)->must_be_updated_p
= 1;
11812 pause
|= update_frame (mini_frame
, 0, 0);
11813 if (!pause
&& hscroll_windows (mini_window
))
11818 /* If display was paused because of pending input, make sure we do a
11819 thorough update the next time. */
11822 /* Prevent the optimization at the beginning of
11823 redisplay_internal that tries a single-line update of the
11824 line containing the cursor in the selected window. */
11825 CHARPOS (this_line_start_pos
) = 0;
11827 /* Let the overlay arrow be updated the next time. */
11828 update_overlay_arrows (0);
11830 /* If we pause after scrolling, some rows in the current
11831 matrices of some windows are not valid. */
11832 if (!WINDOW_FULL_WIDTH_P (w
)
11833 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
11834 update_mode_lines
= 1;
11838 if (!consider_all_windows_p
)
11840 /* This has already been done above if
11841 consider_all_windows_p is set. */
11842 mark_window_display_accurate_1 (w
, 1);
11844 /* Say overlay arrows are up to date. */
11845 update_overlay_arrows (1);
11847 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
11848 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
11851 update_mode_lines
= 0;
11852 windows_or_buffers_changed
= 0;
11853 cursor_type_changed
= 0;
11856 /* Start SIGIO interrupts coming again. Having them off during the
11857 code above makes it less likely one will discard output, but not
11858 impossible, since there might be stuff in the system buffer here.
11859 But it is much hairier to try to do anything about that. */
11860 if (interrupt_input
)
11864 /* If a frame has become visible which was not before, redisplay
11865 again, so that we display it. Expose events for such a frame
11866 (which it gets when becoming visible) don't call the parts of
11867 redisplay constructing glyphs, so simply exposing a frame won't
11868 display anything in this case. So, we have to display these
11869 frames here explicitly. */
11872 Lisp_Object tail
, frame
;
11875 FOR_EACH_FRAME (tail
, frame
)
11877 int this_is_visible
= 0;
11879 if (XFRAME (frame
)->visible
)
11880 this_is_visible
= 1;
11881 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
11882 if (XFRAME (frame
)->visible
)
11883 this_is_visible
= 1;
11885 if (this_is_visible
)
11889 if (new_count
!= number_of_visible_frames
)
11890 windows_or_buffers_changed
++;
11893 /* Change frame size now if a change is pending. */
11894 do_pending_window_change (1);
11896 /* If we just did a pending size change, or have additional
11897 visible frames, redisplay again. */
11898 if (windows_or_buffers_changed
&& !pause
)
11901 /* Clear the face cache eventually. */
11902 if (consider_all_windows_p
)
11904 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
11906 clear_face_cache (0);
11907 clear_face_cache_count
= 0;
11909 #ifdef HAVE_WINDOW_SYSTEM
11910 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
11912 clear_image_caches (Qnil
);
11913 clear_image_cache_count
= 0;
11915 #endif /* HAVE_WINDOW_SYSTEM */
11919 unbind_to (count
, Qnil
);
11924 /* Redisplay, but leave alone any recent echo area message unless
11925 another message has been requested in its place.
11927 This is useful in situations where you need to redisplay but no
11928 user action has occurred, making it inappropriate for the message
11929 area to be cleared. See tracking_off and
11930 wait_reading_process_output for examples of these situations.
11932 FROM_WHERE is an integer saying from where this function was
11933 called. This is useful for debugging. */
11936 redisplay_preserve_echo_area (from_where
)
11939 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
11941 if (!NILP (echo_area_buffer
[1]))
11943 /* We have a previously displayed message, but no current
11944 message. Redisplay the previous message. */
11945 display_last_displayed_message_p
= 1;
11946 redisplay_internal (1);
11947 display_last_displayed_message_p
= 0;
11950 redisplay_internal (1);
11952 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
11953 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
11954 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
11958 /* Function registered with record_unwind_protect in
11959 redisplay_internal. Reset redisplaying_p to the value it had
11960 before redisplay_internal was called, and clear
11961 prevent_freeing_realized_faces_p. It also selects the previously
11962 selected frame, unless it has been deleted (by an X connection
11963 failure during redisplay, for example). */
11966 unwind_redisplay (val
)
11969 Lisp_Object old_redisplaying_p
, old_frame
;
11971 old_redisplaying_p
= XCAR (val
);
11972 redisplaying_p
= XFASTINT (old_redisplaying_p
);
11973 old_frame
= XCDR (val
);
11974 if (! EQ (old_frame
, selected_frame
)
11975 && FRAME_LIVE_P (XFRAME (old_frame
)))
11976 select_frame_for_redisplay (old_frame
);
11981 /* Mark the display of window W as accurate or inaccurate. If
11982 ACCURATE_P is non-zero mark display of W as accurate. If
11983 ACCURATE_P is zero, arrange for W to be redisplayed the next time
11984 redisplay_internal is called. */
11987 mark_window_display_accurate_1 (w
, accurate_p
)
11991 if (BUFFERP (w
->buffer
))
11993 struct buffer
*b
= XBUFFER (w
->buffer
);
11996 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
11997 w
->last_overlay_modified
11998 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
12000 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
12004 b
->clip_changed
= 0;
12005 b
->prevent_redisplay_optimizations_p
= 0;
12007 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
12008 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
12009 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
12010 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
12012 w
->current_matrix
->buffer
= b
;
12013 w
->current_matrix
->begv
= BUF_BEGV (b
);
12014 w
->current_matrix
->zv
= BUF_ZV (b
);
12016 w
->last_cursor
= w
->cursor
;
12017 w
->last_cursor_off_p
= w
->cursor_off_p
;
12019 if (w
== XWINDOW (selected_window
))
12020 w
->last_point
= make_number (BUF_PT (b
));
12022 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
12028 w
->window_end_valid
= w
->buffer
;
12029 #if 0 /* This is incorrect with variable-height lines. */
12030 xassert (XINT (w
->window_end_vpos
)
12031 < (WINDOW_TOTAL_LINES (w
)
12032 - (WINDOW_WANTS_MODELINE_P (w
) ? 1 : 0)));
12034 w
->update_mode_line
= Qnil
;
12039 /* Mark the display of windows in the window tree rooted at WINDOW as
12040 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
12041 windows as accurate. If ACCURATE_P is zero, arrange for windows to
12042 be redisplayed the next time redisplay_internal is called. */
12045 mark_window_display_accurate (window
, accurate_p
)
12046 Lisp_Object window
;
12051 for (; !NILP (window
); window
= w
->next
)
12053 w
= XWINDOW (window
);
12054 mark_window_display_accurate_1 (w
, accurate_p
);
12056 if (!NILP (w
->vchild
))
12057 mark_window_display_accurate (w
->vchild
, accurate_p
);
12058 if (!NILP (w
->hchild
))
12059 mark_window_display_accurate (w
->hchild
, accurate_p
);
12064 update_overlay_arrows (1);
12068 /* Force a thorough redisplay the next time by setting
12069 last_arrow_position and last_arrow_string to t, which is
12070 unequal to any useful value of Voverlay_arrow_... */
12071 update_overlay_arrows (-1);
12076 /* Return value in display table DP (Lisp_Char_Table *) for character
12077 C. Since a display table doesn't have any parent, we don't have to
12078 follow parent. Do not call this function directly but use the
12079 macro DISP_CHAR_VECTOR. */
12082 disp_char_vector (dp
, c
)
12083 struct Lisp_Char_Table
*dp
;
12088 if (ASCII_CHAR_P (c
))
12091 if (SUB_CHAR_TABLE_P (val
))
12092 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
12098 XSETCHAR_TABLE (table
, dp
);
12099 val
= char_table_ref (table
, c
);
12108 /***********************************************************************
12110 ***********************************************************************/
12112 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
12115 redisplay_windows (window
)
12116 Lisp_Object window
;
12118 while (!NILP (window
))
12120 struct window
*w
= XWINDOW (window
);
12122 if (!NILP (w
->hchild
))
12123 redisplay_windows (w
->hchild
);
12124 else if (!NILP (w
->vchild
))
12125 redisplay_windows (w
->vchild
);
12128 displayed_buffer
= XBUFFER (w
->buffer
);
12129 /* Use list_of_error, not Qerror, so that
12130 we catch only errors and don't run the debugger. */
12131 internal_condition_case_1 (redisplay_window_0
, window
,
12133 redisplay_window_error
);
12141 redisplay_window_error ()
12143 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
12148 redisplay_window_0 (window
)
12149 Lisp_Object window
;
12151 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12152 redisplay_window (window
, 0);
12157 redisplay_window_1 (window
)
12158 Lisp_Object window
;
12160 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12161 redisplay_window (window
, 1);
12166 /* Increment GLYPH until it reaches END or CONDITION fails while
12167 adding (GLYPH)->pixel_width to X. */
12169 #define SKIP_GLYPHS(glyph, end, x, condition) \
12172 (x) += (glyph)->pixel_width; \
12175 while ((glyph) < (end) && (condition))
12178 /* Set cursor position of W. PT is assumed to be displayed in ROW.
12179 DELTA is the number of bytes by which positions recorded in ROW
12180 differ from current buffer positions.
12182 Return 0 if cursor is not on this row. 1 otherwise. */
12185 set_cursor_from_row (w
, row
, matrix
, delta
, delta_bytes
, dy
, dvpos
)
12187 struct glyph_row
*row
;
12188 struct glyph_matrix
*matrix
;
12189 int delta
, delta_bytes
, dy
, dvpos
;
12191 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
12192 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
12193 struct glyph
*cursor
= NULL
;
12194 /* The first glyph that starts a sequence of glyphs from string. */
12195 struct glyph
*string_start
;
12196 /* The X coordinate of string_start. */
12197 int string_start_x
;
12198 /* The last known character position. */
12199 int last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12200 /* The last known character position before string_start. */
12201 int string_before_pos
;
12204 int cursor_from_overlay_pos
= 0;
12205 int pt_old
= PT
- delta
;
12207 /* Skip over glyphs not having an object at the start of the row.
12208 These are special glyphs like truncation marks on terminal
12210 if (row
->displays_text_p
)
12212 && INTEGERP (glyph
->object
)
12213 && glyph
->charpos
< 0)
12215 x
+= glyph
->pixel_width
;
12219 string_start
= NULL
;
12221 && !INTEGERP (glyph
->object
)
12222 && (!BUFFERP (glyph
->object
)
12223 || (last_pos
= glyph
->charpos
) < pt_old
))
12225 if (! STRINGP (glyph
->object
))
12227 string_start
= NULL
;
12228 x
+= glyph
->pixel_width
;
12230 if (cursor_from_overlay_pos
12231 && last_pos
>= cursor_from_overlay_pos
)
12233 cursor_from_overlay_pos
= 0;
12239 if (string_start
== NULL
)
12241 string_before_pos
= last_pos
;
12242 string_start
= glyph
;
12243 string_start_x
= x
;
12245 /* Skip all glyphs from string. */
12250 if ((cursor
== NULL
|| glyph
> cursor
)
12251 && (cprop
= Fget_char_property (make_number ((glyph
)->charpos
),
12252 Qcursor
, (glyph
)->object
),
12254 && (pos
= string_buffer_position (w
, glyph
->object
,
12255 string_before_pos
),
12256 (pos
== 0 /* From overlay */
12257 || pos
== pt_old
)))
12259 /* Estimate overlay buffer position from the buffer
12260 positions of the glyphs before and after the overlay.
12261 Add 1 to last_pos so that if point corresponds to the
12262 glyph right after the overlay, we still use a 'cursor'
12263 property found in that overlay. */
12264 cursor_from_overlay_pos
= (pos
? 0 : last_pos
12265 + (INTEGERP (cprop
) ? XINT (cprop
) : 0));
12269 x
+= glyph
->pixel_width
;
12272 while (glyph
< end
&& EQ (glyph
->object
, string_start
->object
));
12276 if (cursor
!= NULL
)
12281 else if (row
->ends_in_ellipsis_p
&& glyph
== end
)
12283 /* Scan back over the ellipsis glyphs, decrementing positions. */
12284 while (glyph
> row
->glyphs
[TEXT_AREA
]
12285 && (glyph
- 1)->charpos
== last_pos
)
12286 glyph
--, x
-= glyph
->pixel_width
;
12287 /* That loop always goes one position too far,
12288 including the glyph before the ellipsis.
12289 So scan forward over that one. */
12290 x
+= glyph
->pixel_width
;
12293 else if (string_start
12294 && (glyph
== end
|| !BUFFERP (glyph
->object
) || last_pos
> pt_old
))
12296 /* We may have skipped over point because the previous glyphs
12297 are from string. As there's no easy way to know the
12298 character position of the current glyph, find the correct
12299 glyph on point by scanning from string_start again. */
12301 Lisp_Object string
;
12302 struct glyph
*stop
= glyph
;
12305 limit
= make_number (pt_old
+ 1);
12306 glyph
= string_start
;
12307 x
= string_start_x
;
12308 string
= glyph
->object
;
12309 pos
= string_buffer_position (w
, string
, string_before_pos
);
12310 /* If STRING is from overlay, LAST_POS == 0. We skip such glyphs
12311 because we always put cursor after overlay strings. */
12312 while (pos
== 0 && glyph
< stop
)
12314 string
= glyph
->object
;
12315 SKIP_GLYPHS (glyph
, stop
, x
, EQ (glyph
->object
, string
));
12317 pos
= string_buffer_position (w
, glyph
->object
, string_before_pos
);
12320 while (glyph
< stop
)
12322 pos
= XINT (Fnext_single_char_property_change
12323 (make_number (pos
), Qdisplay
, Qnil
, limit
));
12326 /* Skip glyphs from the same string. */
12327 string
= glyph
->object
;
12328 SKIP_GLYPHS (glyph
, stop
, x
, EQ (glyph
->object
, string
));
12329 /* Skip glyphs from an overlay. */
12330 while (glyph
< stop
12331 && ! string_buffer_position (w
, glyph
->object
, pos
))
12333 string
= glyph
->object
;
12334 SKIP_GLYPHS (glyph
, stop
, x
, EQ (glyph
->object
, string
));
12338 /* If we reached the end of the line, and end was from a string,
12339 cursor is not on this line. */
12340 if (glyph
== end
&& row
->continued_p
)
12344 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
12346 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
12347 w
->cursor
.y
= row
->y
+ dy
;
12349 if (w
== XWINDOW (selected_window
))
12351 if (!row
->continued_p
12352 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
12355 this_line_buffer
= XBUFFER (w
->buffer
);
12357 CHARPOS (this_line_start_pos
)
12358 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
12359 BYTEPOS (this_line_start_pos
)
12360 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
12362 CHARPOS (this_line_end_pos
)
12363 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
12364 BYTEPOS (this_line_end_pos
)
12365 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
12367 this_line_y
= w
->cursor
.y
;
12368 this_line_pixel_height
= row
->height
;
12369 this_line_vpos
= w
->cursor
.vpos
;
12370 this_line_start_x
= row
->x
;
12373 CHARPOS (this_line_start_pos
) = 0;
12380 /* Run window scroll functions, if any, for WINDOW with new window
12381 start STARTP. Sets the window start of WINDOW to that position.
12383 We assume that the window's buffer is really current. */
12385 static INLINE
struct text_pos
12386 run_window_scroll_functions (window
, startp
)
12387 Lisp_Object window
;
12388 struct text_pos startp
;
12390 struct window
*w
= XWINDOW (window
);
12391 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
12393 if (current_buffer
!= XBUFFER (w
->buffer
))
12396 if (!NILP (Vwindow_scroll_functions
))
12398 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
12399 make_number (CHARPOS (startp
)));
12400 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12401 /* In case the hook functions switch buffers. */
12402 if (current_buffer
!= XBUFFER (w
->buffer
))
12403 set_buffer_internal_1 (XBUFFER (w
->buffer
));
12410 /* Make sure the line containing the cursor is fully visible.
12411 A value of 1 means there is nothing to be done.
12412 (Either the line is fully visible, or it cannot be made so,
12413 or we cannot tell.)
12415 If FORCE_P is non-zero, return 0 even if partial visible cursor row
12416 is higher than window.
12418 A value of 0 means the caller should do scrolling
12419 as if point had gone off the screen. */
12422 cursor_row_fully_visible_p (w
, force_p
, current_matrix_p
)
12425 int current_matrix_p
;
12427 struct glyph_matrix
*matrix
;
12428 struct glyph_row
*row
;
12431 if (!make_cursor_line_fully_visible_p
)
12434 /* It's not always possible to find the cursor, e.g, when a window
12435 is full of overlay strings. Don't do anything in that case. */
12436 if (w
->cursor
.vpos
< 0)
12439 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
12440 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
12442 /* If the cursor row is not partially visible, there's nothing to do. */
12443 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
12446 /* If the row the cursor is in is taller than the window's height,
12447 it's not clear what to do, so do nothing. */
12448 window_height
= window_box_height (w
);
12449 if (row
->height
>= window_height
)
12451 if (!force_p
|| MINI_WINDOW_P (w
)
12452 || w
->vscroll
|| w
->cursor
.vpos
== 0)
12458 /* This code used to try to scroll the window just enough to make
12459 the line visible. It returned 0 to say that the caller should
12460 allocate larger glyph matrices. */
12462 if (MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (w
, row
))
12464 int dy
= row
->height
- row
->visible_height
;
12467 shift_glyph_matrix (w
, matrix
, 0, matrix
->nrows
, dy
);
12469 else /* MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P (w, row)) */
12471 int dy
= - (row
->height
- row
->visible_height
);
12474 shift_glyph_matrix (w
, matrix
, 0, matrix
->nrows
, dy
);
12477 /* When we change the cursor y-position of the selected window,
12478 change this_line_y as well so that the display optimization for
12479 the cursor line of the selected window in redisplay_internal uses
12480 the correct y-position. */
12481 if (w
== XWINDOW (selected_window
))
12482 this_line_y
= w
->cursor
.y
;
12484 /* If vscrolling requires a larger glyph matrix, arrange for a fresh
12485 redisplay with larger matrices. */
12486 if (matrix
->nrows
< required_matrix_height (w
))
12488 fonts_changed_p
= 1;
12497 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
12498 non-zero means only WINDOW is redisplayed in redisplay_internal.
12499 TEMP_SCROLL_STEP has the same meaning as scroll_step, and is used
12500 in redisplay_window to bring a partially visible line into view in
12501 the case that only the cursor has moved.
12503 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
12504 last screen line's vertical height extends past the end of the screen.
12508 1 if scrolling succeeded
12510 0 if scrolling didn't find point.
12512 -1 if new fonts have been loaded so that we must interrupt
12513 redisplay, adjust glyph matrices, and try again. */
12519 SCROLLING_NEED_LARGER_MATRICES
12523 try_scrolling (window
, just_this_one_p
, scroll_conservatively
,
12524 scroll_step
, temp_scroll_step
, last_line_misfit
)
12525 Lisp_Object window
;
12526 int just_this_one_p
;
12527 EMACS_INT scroll_conservatively
, scroll_step
;
12528 int temp_scroll_step
;
12529 int last_line_misfit
;
12531 struct window
*w
= XWINDOW (window
);
12532 struct frame
*f
= XFRAME (w
->frame
);
12533 struct text_pos scroll_margin_pos
;
12534 struct text_pos pos
;
12535 struct text_pos startp
;
12537 Lisp_Object window_end
;
12538 int this_scroll_margin
;
12542 int amount_to_scroll
= 0;
12543 Lisp_Object aggressive
;
12545 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
12548 debug_method_add (w
, "try_scrolling");
12551 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12553 /* Compute scroll margin height in pixels. We scroll when point is
12554 within this distance from the top or bottom of the window. */
12555 if (scroll_margin
> 0)
12557 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
12558 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
12561 this_scroll_margin
= 0;
12563 /* Force scroll_conservatively to have a reasonable value so it doesn't
12564 cause an overflow while computing how much to scroll. */
12565 if (scroll_conservatively
)
12566 scroll_conservatively
= min (scroll_conservatively
,
12567 MOST_POSITIVE_FIXNUM
/ FRAME_LINE_HEIGHT (f
));
12569 /* Compute how much we should try to scroll maximally to bring point
12571 if (scroll_step
|| scroll_conservatively
|| temp_scroll_step
)
12572 scroll_max
= max (scroll_step
,
12573 max (scroll_conservatively
, temp_scroll_step
));
12574 else if (NUMBERP (current_buffer
->scroll_down_aggressively
)
12575 || NUMBERP (current_buffer
->scroll_up_aggressively
))
12576 /* We're trying to scroll because of aggressive scrolling
12577 but no scroll_step is set. Choose an arbitrary one. Maybe
12578 there should be a variable for this. */
12582 scroll_max
*= FRAME_LINE_HEIGHT (f
);
12584 /* Decide whether we have to scroll down. Start at the window end
12585 and move this_scroll_margin up to find the position of the scroll
12587 window_end
= Fwindow_end (window
, Qt
);
12591 CHARPOS (scroll_margin_pos
) = XINT (window_end
);
12592 BYTEPOS (scroll_margin_pos
) = CHAR_TO_BYTE (CHARPOS (scroll_margin_pos
));
12594 if (this_scroll_margin
|| extra_scroll_margin_lines
)
12596 start_display (&it
, w
, scroll_margin_pos
);
12597 if (this_scroll_margin
)
12598 move_it_vertically_backward (&it
, this_scroll_margin
);
12599 if (extra_scroll_margin_lines
)
12600 move_it_by_lines (&it
, - extra_scroll_margin_lines
, 0);
12601 scroll_margin_pos
= it
.current
.pos
;
12604 if (PT
>= CHARPOS (scroll_margin_pos
))
12608 /* Point is in the scroll margin at the bottom of the window, or
12609 below. Compute a new window start that makes point visible. */
12611 /* Compute the distance from the scroll margin to PT.
12612 Give up if the distance is greater than scroll_max. */
12613 start_display (&it
, w
, scroll_margin_pos
);
12615 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
12616 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
12618 /* To make point visible, we have to move the window start
12619 down so that the line the cursor is in is visible, which
12620 means we have to add in the height of the cursor line. */
12621 dy
= line_bottom_y (&it
) - y0
;
12623 if (dy
> scroll_max
)
12624 return SCROLLING_FAILED
;
12626 /* Move the window start down. If scrolling conservatively,
12627 move it just enough down to make point visible. If
12628 scroll_step is set, move it down by scroll_step. */
12629 start_display (&it
, w
, startp
);
12631 if (scroll_conservatively
)
12632 /* Set AMOUNT_TO_SCROLL to at least one line,
12633 and at most scroll_conservatively lines. */
12635 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
12636 FRAME_LINE_HEIGHT (f
) * scroll_conservatively
);
12637 else if (scroll_step
|| temp_scroll_step
)
12638 amount_to_scroll
= scroll_max
;
12641 aggressive
= current_buffer
->scroll_up_aggressively
;
12642 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
12643 if (NUMBERP (aggressive
))
12645 double float_amount
= XFLOATINT (aggressive
) * height
;
12646 amount_to_scroll
= float_amount
;
12647 if (amount_to_scroll
== 0 && float_amount
> 0)
12648 amount_to_scroll
= 1;
12652 if (amount_to_scroll
<= 0)
12653 return SCROLLING_FAILED
;
12655 /* If moving by amount_to_scroll leaves STARTP unchanged,
12656 move it down one screen line. */
12658 move_it_vertically (&it
, amount_to_scroll
);
12659 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
12660 move_it_by_lines (&it
, 1, 1);
12661 startp
= it
.current
.pos
;
12665 /* See if point is inside the scroll margin at the top of the
12667 scroll_margin_pos
= startp
;
12668 if (this_scroll_margin
)
12670 start_display (&it
, w
, startp
);
12671 move_it_vertically (&it
, this_scroll_margin
);
12672 scroll_margin_pos
= it
.current
.pos
;
12675 if (PT
< CHARPOS (scroll_margin_pos
))
12677 /* Point is in the scroll margin at the top of the window or
12678 above what is displayed in the window. */
12681 /* Compute the vertical distance from PT to the scroll
12682 margin position. Give up if distance is greater than
12684 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
12685 start_display (&it
, w
, pos
);
12687 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
12688 it
.last_visible_y
, -1,
12689 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
12690 dy
= it
.current_y
- y0
;
12691 if (dy
> scroll_max
)
12692 return SCROLLING_FAILED
;
12694 /* Compute new window start. */
12695 start_display (&it
, w
, startp
);
12697 if (scroll_conservatively
)
12699 = max (dy
, FRAME_LINE_HEIGHT (f
) * max (scroll_step
, temp_scroll_step
));
12700 else if (scroll_step
|| temp_scroll_step
)
12701 amount_to_scroll
= scroll_max
;
12704 aggressive
= current_buffer
->scroll_down_aggressively
;
12705 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
12706 if (NUMBERP (aggressive
))
12708 double float_amount
= XFLOATINT (aggressive
) * height
;
12709 amount_to_scroll
= float_amount
;
12710 if (amount_to_scroll
== 0 && float_amount
> 0)
12711 amount_to_scroll
= 1;
12715 if (amount_to_scroll
<= 0)
12716 return SCROLLING_FAILED
;
12718 move_it_vertically_backward (&it
, amount_to_scroll
);
12719 startp
= it
.current
.pos
;
12723 /* Run window scroll functions. */
12724 startp
= run_window_scroll_functions (window
, startp
);
12726 /* Display the window. Give up if new fonts are loaded, or if point
12728 if (!try_window (window
, startp
, 0))
12729 rc
= SCROLLING_NEED_LARGER_MATRICES
;
12730 else if (w
->cursor
.vpos
< 0)
12732 clear_glyph_matrix (w
->desired_matrix
);
12733 rc
= SCROLLING_FAILED
;
12737 /* Maybe forget recorded base line for line number display. */
12738 if (!just_this_one_p
12739 || current_buffer
->clip_changed
12740 || BEG_UNCHANGED
< CHARPOS (startp
))
12741 w
->base_line_number
= Qnil
;
12743 /* If cursor ends up on a partially visible line,
12744 treat that as being off the bottom of the screen. */
12745 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0))
12747 clear_glyph_matrix (w
->desired_matrix
);
12748 ++extra_scroll_margin_lines
;
12751 rc
= SCROLLING_SUCCESS
;
12758 /* Compute a suitable window start for window W if display of W starts
12759 on a continuation line. Value is non-zero if a new window start
12762 The new window start will be computed, based on W's width, starting
12763 from the start of the continued line. It is the start of the
12764 screen line with the minimum distance from the old start W->start. */
12767 compute_window_start_on_continuation_line (w
)
12770 struct text_pos pos
, start_pos
;
12771 int window_start_changed_p
= 0;
12773 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
12775 /* If window start is on a continuation line... Window start may be
12776 < BEGV in case there's invisible text at the start of the
12777 buffer (M-x rmail, for example). */
12778 if (CHARPOS (start_pos
) > BEGV
12779 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
12782 struct glyph_row
*row
;
12784 /* Handle the case that the window start is out of range. */
12785 if (CHARPOS (start_pos
) < BEGV
)
12786 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
12787 else if (CHARPOS (start_pos
) > ZV
)
12788 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
12790 /* Find the start of the continued line. This should be fast
12791 because scan_buffer is fast (newline cache). */
12792 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
12793 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
12794 row
, DEFAULT_FACE_ID
);
12795 reseat_at_previous_visible_line_start (&it
);
12797 /* If the line start is "too far" away from the window start,
12798 say it takes too much time to compute a new window start. */
12799 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
12800 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
12802 int min_distance
, distance
;
12804 /* Move forward by display lines to find the new window
12805 start. If window width was enlarged, the new start can
12806 be expected to be > the old start. If window width was
12807 decreased, the new window start will be < the old start.
12808 So, we're looking for the display line start with the
12809 minimum distance from the old window start. */
12810 pos
= it
.current
.pos
;
12811 min_distance
= INFINITY
;
12812 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
12813 distance
< min_distance
)
12815 min_distance
= distance
;
12816 pos
= it
.current
.pos
;
12817 move_it_by_lines (&it
, 1, 0);
12820 /* Set the window start there. */
12821 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
12822 window_start_changed_p
= 1;
12826 return window_start_changed_p
;
12830 /* Try cursor movement in case text has not changed in window WINDOW,
12831 with window start STARTP. Value is
12833 CURSOR_MOVEMENT_SUCCESS if successful
12835 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
12837 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
12838 display. *SCROLL_STEP is set to 1, under certain circumstances, if
12839 we want to scroll as if scroll-step were set to 1. See the code.
12841 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
12842 which case we have to abort this redisplay, and adjust matrices
12847 CURSOR_MOVEMENT_SUCCESS
,
12848 CURSOR_MOVEMENT_CANNOT_BE_USED
,
12849 CURSOR_MOVEMENT_MUST_SCROLL
,
12850 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
12854 try_cursor_movement (window
, startp
, scroll_step
)
12855 Lisp_Object window
;
12856 struct text_pos startp
;
12859 struct window
*w
= XWINDOW (window
);
12860 struct frame
*f
= XFRAME (w
->frame
);
12861 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
12864 if (inhibit_try_cursor_movement
)
12868 /* Handle case where text has not changed, only point, and it has
12869 not moved off the frame. */
12870 if (/* Point may be in this window. */
12871 PT
>= CHARPOS (startp
)
12872 /* Selective display hasn't changed. */
12873 && !current_buffer
->clip_changed
12874 /* Function force-mode-line-update is used to force a thorough
12875 redisplay. It sets either windows_or_buffers_changed or
12876 update_mode_lines. So don't take a shortcut here for these
12878 && !update_mode_lines
12879 && !windows_or_buffers_changed
12880 && !cursor_type_changed
12881 /* Can't use this case if highlighting a region. When a
12882 region exists, cursor movement has to do more than just
12884 && !(!NILP (Vtransient_mark_mode
)
12885 && !NILP (current_buffer
->mark_active
))
12886 && NILP (w
->region_showing
)
12887 && NILP (Vshow_trailing_whitespace
)
12888 /* Right after splitting windows, last_point may be nil. */
12889 && INTEGERP (w
->last_point
)
12890 /* This code is not used for mini-buffer for the sake of the case
12891 of redisplaying to replace an echo area message; since in
12892 that case the mini-buffer contents per se are usually
12893 unchanged. This code is of no real use in the mini-buffer
12894 since the handling of this_line_start_pos, etc., in redisplay
12895 handles the same cases. */
12896 && !EQ (window
, minibuf_window
)
12897 /* When splitting windows or for new windows, it happens that
12898 redisplay is called with a nil window_end_vpos or one being
12899 larger than the window. This should really be fixed in
12900 window.c. I don't have this on my list, now, so we do
12901 approximately the same as the old redisplay code. --gerd. */
12902 && INTEGERP (w
->window_end_vpos
)
12903 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
12904 && (FRAME_WINDOW_P (f
)
12905 || !overlay_arrow_in_current_buffer_p ()))
12907 int this_scroll_margin
, top_scroll_margin
;
12908 struct glyph_row
*row
= NULL
;
12911 debug_method_add (w
, "cursor movement");
12914 /* Scroll if point within this distance from the top or bottom
12915 of the window. This is a pixel value. */
12916 this_scroll_margin
= max (0, scroll_margin
);
12917 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
12918 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
12920 top_scroll_margin
= this_scroll_margin
;
12921 if (WINDOW_WANTS_HEADER_LINE_P (w
))
12922 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
12924 /* Start with the row the cursor was displayed during the last
12925 not paused redisplay. Give up if that row is not valid. */
12926 if (w
->last_cursor
.vpos
< 0
12927 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
12928 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
12931 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
12932 if (row
->mode_line_p
)
12934 if (!row
->enabled_p
)
12935 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
12938 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
12941 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
12943 if (PT
> XFASTINT (w
->last_point
))
12945 /* Point has moved forward. */
12946 while (MATRIX_ROW_END_CHARPOS (row
) < PT
12947 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
12949 xassert (row
->enabled_p
);
12953 /* The end position of a row equals the start position
12954 of the next row. If PT is there, we would rather
12955 display it in the next line. */
12956 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
12957 && MATRIX_ROW_END_CHARPOS (row
) == PT
12958 && !cursor_row_p (w
, row
))
12961 /* If within the scroll margin, scroll. Note that
12962 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
12963 the next line would be drawn, and that
12964 this_scroll_margin can be zero. */
12965 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
12966 || PT
> MATRIX_ROW_END_CHARPOS (row
)
12967 /* Line is completely visible last line in window
12968 and PT is to be set in the next line. */
12969 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
12970 && PT
== MATRIX_ROW_END_CHARPOS (row
)
12971 && !row
->ends_at_zv_p
12972 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
12975 else if (PT
< XFASTINT (w
->last_point
))
12977 /* Cursor has to be moved backward. Note that PT >=
12978 CHARPOS (startp) because of the outer if-statement. */
12979 while (!row
->mode_line_p
12980 && (MATRIX_ROW_START_CHARPOS (row
) > PT
12981 || (MATRIX_ROW_START_CHARPOS (row
) == PT
12982 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
12983 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
12984 row
> w
->current_matrix
->rows
12985 && (row
-1)->ends_in_newline_from_string_p
))))
12986 && (row
->y
> top_scroll_margin
12987 || CHARPOS (startp
) == BEGV
))
12989 xassert (row
->enabled_p
);
12993 /* Consider the following case: Window starts at BEGV,
12994 there is invisible, intangible text at BEGV, so that
12995 display starts at some point START > BEGV. It can
12996 happen that we are called with PT somewhere between
12997 BEGV and START. Try to handle that case. */
12998 if (row
< w
->current_matrix
->rows
12999 || row
->mode_line_p
)
13001 row
= w
->current_matrix
->rows
;
13002 if (row
->mode_line_p
)
13006 /* Due to newlines in overlay strings, we may have to
13007 skip forward over overlay strings. */
13008 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13009 && MATRIX_ROW_END_CHARPOS (row
) == PT
13010 && !cursor_row_p (w
, row
))
13013 /* If within the scroll margin, scroll. */
13014 if (row
->y
< top_scroll_margin
13015 && CHARPOS (startp
) != BEGV
)
13020 /* Cursor did not move. So don't scroll even if cursor line
13021 is partially visible, as it was so before. */
13022 rc
= CURSOR_MOVEMENT_SUCCESS
;
13025 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
13026 || PT
> MATRIX_ROW_END_CHARPOS (row
))
13028 /* if PT is not in the glyph row, give up. */
13029 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13031 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13032 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
13033 && make_cursor_line_fully_visible_p
)
13035 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
13036 && !row
->ends_at_zv_p
13037 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
13038 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13039 else if (row
->height
> window_box_height (w
))
13041 /* If we end up in a partially visible line, let's
13042 make it fully visible, except when it's taller
13043 than the window, in which case we can't do much
13046 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13050 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13051 if (!cursor_row_fully_visible_p (w
, 0, 1))
13052 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13054 rc
= CURSOR_MOVEMENT_SUCCESS
;
13058 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13063 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
13065 rc
= CURSOR_MOVEMENT_SUCCESS
;
13070 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13071 && MATRIX_ROW_START_CHARPOS (row
) == PT
13072 && cursor_row_p (w
, row
));
13081 set_vertical_scroll_bar (w
)
13084 int start
, end
, whole
;
13086 /* Calculate the start and end positions for the current window.
13087 At some point, it would be nice to choose between scrollbars
13088 which reflect the whole buffer size, with special markers
13089 indicating narrowing, and scrollbars which reflect only the
13092 Note that mini-buffers sometimes aren't displaying any text. */
13093 if (!MINI_WINDOW_P (w
)
13094 || (w
== XWINDOW (minibuf_window
)
13095 && NILP (echo_area_buffer
[0])))
13097 struct buffer
*buf
= XBUFFER (w
->buffer
);
13098 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
13099 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
13100 /* I don't think this is guaranteed to be right. For the
13101 moment, we'll pretend it is. */
13102 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
13106 if (whole
< (end
- start
))
13107 whole
= end
- start
;
13110 start
= end
= whole
= 0;
13112 /* Indicate what this scroll bar ought to be displaying now. */
13113 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13114 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13115 (w
, end
- start
, whole
, start
);
13119 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
13120 selected_window is redisplayed.
13122 We can return without actually redisplaying the window if
13123 fonts_changed_p is nonzero. In that case, redisplay_internal will
13127 redisplay_window (window
, just_this_one_p
)
13128 Lisp_Object window
;
13129 int just_this_one_p
;
13131 struct window
*w
= XWINDOW (window
);
13132 struct frame
*f
= XFRAME (w
->frame
);
13133 struct buffer
*buffer
= XBUFFER (w
->buffer
);
13134 struct buffer
*old
= current_buffer
;
13135 struct text_pos lpoint
, opoint
, startp
;
13136 int update_mode_line
;
13139 /* Record it now because it's overwritten. */
13140 int current_matrix_up_to_date_p
= 0;
13141 int used_current_matrix_p
= 0;
13142 /* This is less strict than current_matrix_up_to_date_p.
13143 It indictes that the buffer contents and narrowing are unchanged. */
13144 int buffer_unchanged_p
= 0;
13145 int temp_scroll_step
= 0;
13146 int count
= SPECPDL_INDEX ();
13148 int centering_position
= -1;
13149 int last_line_misfit
= 0;
13150 int beg_unchanged
, end_unchanged
;
13152 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13155 /* W must be a leaf window here. */
13156 xassert (!NILP (w
->buffer
));
13158 *w
->desired_matrix
->method
= 0;
13162 reconsider_clip_changes (w
, buffer
);
13164 /* Has the mode line to be updated? */
13165 update_mode_line
= (!NILP (w
->update_mode_line
)
13166 || update_mode_lines
13167 || buffer
->clip_changed
13168 || buffer
->prevent_redisplay_optimizations_p
);
13170 if (MINI_WINDOW_P (w
))
13172 if (w
== XWINDOW (echo_area_window
)
13173 && !NILP (echo_area_buffer
[0]))
13175 if (update_mode_line
)
13176 /* We may have to update a tty frame's menu bar or a
13177 tool-bar. Example `M-x C-h C-h C-g'. */
13178 goto finish_menu_bars
;
13180 /* We've already displayed the echo area glyphs in this window. */
13181 goto finish_scroll_bars
;
13183 else if ((w
!= XWINDOW (minibuf_window
)
13184 || minibuf_level
== 0)
13185 /* When buffer is nonempty, redisplay window normally. */
13186 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
13187 /* Quail displays non-mini buffers in minibuffer window.
13188 In that case, redisplay the window normally. */
13189 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
13191 /* W is a mini-buffer window, but it's not active, so clear
13193 int yb
= window_text_bottom_y (w
);
13194 struct glyph_row
*row
;
13197 for (y
= 0, row
= w
->desired_matrix
->rows
;
13199 y
+= row
->height
, ++row
)
13200 blank_row (w
, row
, y
);
13201 goto finish_scroll_bars
;
13204 clear_glyph_matrix (w
->desired_matrix
);
13207 /* Otherwise set up data on this window; select its buffer and point
13209 /* Really select the buffer, for the sake of buffer-local
13211 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13213 current_matrix_up_to_date_p
13214 = (!NILP (w
->window_end_valid
)
13215 && !current_buffer
->clip_changed
13216 && !current_buffer
->prevent_redisplay_optimizations_p
13217 && XFASTINT (w
->last_modified
) >= MODIFF
13218 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13220 /* Run the window-bottom-change-functions
13221 if it is possible that the text on the screen has changed
13222 (either due to modification of the text, or any other reason). */
13223 if (!current_matrix_up_to_date_p
13224 && !NILP (Vwindow_text_change_functions
))
13226 safe_run_hooks (Qwindow_text_change_functions
);
13230 beg_unchanged
= BEG_UNCHANGED
;
13231 end_unchanged
= END_UNCHANGED
;
13233 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
13235 specbind (Qinhibit_point_motion_hooks
, Qt
);
13238 = (!NILP (w
->window_end_valid
)
13239 && !current_buffer
->clip_changed
13240 && XFASTINT (w
->last_modified
) >= MODIFF
13241 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13243 /* When windows_or_buffers_changed is non-zero, we can't rely on
13244 the window end being valid, so set it to nil there. */
13245 if (windows_or_buffers_changed
)
13247 /* If window starts on a continuation line, maybe adjust the
13248 window start in case the window's width changed. */
13249 if (XMARKER (w
->start
)->buffer
== current_buffer
)
13250 compute_window_start_on_continuation_line (w
);
13252 w
->window_end_valid
= Qnil
;
13255 /* Some sanity checks. */
13256 CHECK_WINDOW_END (w
);
13257 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
13259 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
13262 /* If %c is in mode line, update it if needed. */
13263 if (!NILP (w
->column_number_displayed
)
13264 /* This alternative quickly identifies a common case
13265 where no change is needed. */
13266 && !(PT
== XFASTINT (w
->last_point
)
13267 && XFASTINT (w
->last_modified
) >= MODIFF
13268 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
13269 && (XFASTINT (w
->column_number_displayed
)
13270 != (int) current_column ())) /* iftc */
13271 update_mode_line
= 1;
13273 /* Count number of windows showing the selected buffer. An indirect
13274 buffer counts as its base buffer. */
13275 if (!just_this_one_p
)
13277 struct buffer
*current_base
, *window_base
;
13278 current_base
= current_buffer
;
13279 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13280 if (current_base
->base_buffer
)
13281 current_base
= current_base
->base_buffer
;
13282 if (window_base
->base_buffer
)
13283 window_base
= window_base
->base_buffer
;
13284 if (current_base
== window_base
)
13288 /* Point refers normally to the selected window. For any other
13289 window, set up appropriate value. */
13290 if (!EQ (window
, selected_window
))
13292 int new_pt
= XMARKER (w
->pointm
)->charpos
;
13293 int new_pt_byte
= marker_byte_position (w
->pointm
);
13297 new_pt_byte
= BEGV_BYTE
;
13298 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
13300 else if (new_pt
> (ZV
- 1))
13303 new_pt_byte
= ZV_BYTE
;
13304 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
13307 /* We don't use SET_PT so that the point-motion hooks don't run. */
13308 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
13311 /* If any of the character widths specified in the display table
13312 have changed, invalidate the width run cache. It's true that
13313 this may be a bit late to catch such changes, but the rest of
13314 redisplay goes (non-fatally) haywire when the display table is
13315 changed, so why should we worry about doing any better? */
13316 if (current_buffer
->width_run_cache
)
13318 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
13320 if (! disptab_matches_widthtab (disptab
,
13321 XVECTOR (current_buffer
->width_table
)))
13323 invalidate_region_cache (current_buffer
,
13324 current_buffer
->width_run_cache
,
13326 recompute_width_table (current_buffer
, disptab
);
13330 /* If window-start is screwed up, choose a new one. */
13331 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
13334 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13336 /* If someone specified a new starting point but did not insist,
13337 check whether it can be used. */
13338 if (!NILP (w
->optional_new_start
)
13339 && CHARPOS (startp
) >= BEGV
13340 && CHARPOS (startp
) <= ZV
)
13342 w
->optional_new_start
= Qnil
;
13343 start_display (&it
, w
, startp
);
13344 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
13345 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13346 if (IT_CHARPOS (it
) == PT
)
13347 w
->force_start
= Qt
;
13348 /* IT may overshoot PT if text at PT is invisible. */
13349 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
13350 w
->force_start
= Qt
;
13355 /* Handle case where place to start displaying has been specified,
13356 unless the specified location is outside the accessible range. */
13357 if (!NILP (w
->force_start
)
13358 || w
->frozen_window_start_p
)
13360 /* We set this later on if we have to adjust point. */
13364 w
->force_start
= Qnil
;
13366 w
->window_end_valid
= Qnil
;
13368 /* Forget any recorded base line for line number display. */
13369 if (!buffer_unchanged_p
)
13370 w
->base_line_number
= Qnil
;
13372 /* Redisplay the mode line. Select the buffer properly for that.
13373 Also, run the hook window-scroll-functions
13374 because we have scrolled. */
13375 /* Note, we do this after clearing force_start because
13376 if there's an error, it is better to forget about force_start
13377 than to get into an infinite loop calling the hook functions
13378 and having them get more errors. */
13379 if (!update_mode_line
13380 || ! NILP (Vwindow_scroll_functions
))
13382 update_mode_line
= 1;
13383 w
->update_mode_line
= Qt
;
13384 startp
= run_window_scroll_functions (window
, startp
);
13387 w
->last_modified
= make_number (0);
13388 w
->last_overlay_modified
= make_number (0);
13389 if (CHARPOS (startp
) < BEGV
)
13390 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
13391 else if (CHARPOS (startp
) > ZV
)
13392 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
13394 /* Redisplay, then check if cursor has been set during the
13395 redisplay. Give up if new fonts were loaded. */
13396 val
= try_window (window
, startp
, 1);
13399 w
->force_start
= Qt
;
13400 clear_glyph_matrix (w
->desired_matrix
);
13401 goto need_larger_matrices
;
13403 /* Point was outside the scroll margins. */
13405 new_vpos
= window_box_height (w
) / 2;
13407 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
13409 /* If point does not appear, try to move point so it does
13410 appear. The desired matrix has been built above, so we
13411 can use it here. */
13412 new_vpos
= window_box_height (w
) / 2;
13415 if (!cursor_row_fully_visible_p (w
, 0, 0))
13417 /* Point does appear, but on a line partly visible at end of window.
13418 Move it back to a fully-visible line. */
13419 new_vpos
= window_box_height (w
);
13422 /* If we need to move point for either of the above reasons,
13423 now actually do it. */
13426 struct glyph_row
*row
;
13428 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
13429 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
13432 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
13433 MATRIX_ROW_START_BYTEPOS (row
));
13435 if (w
!= XWINDOW (selected_window
))
13436 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
13437 else if (current_buffer
== old
)
13438 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13440 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
13442 /* If we are highlighting the region, then we just changed
13443 the region, so redisplay to show it. */
13444 if (!NILP (Vtransient_mark_mode
)
13445 && !NILP (current_buffer
->mark_active
))
13447 clear_glyph_matrix (w
->desired_matrix
);
13448 if (!try_window (window
, startp
, 0))
13449 goto need_larger_matrices
;
13454 debug_method_add (w
, "forced window start");
13459 /* Handle case where text has not changed, only point, and it has
13460 not moved off the frame, and we are not retrying after hscroll.
13461 (current_matrix_up_to_date_p is nonzero when retrying.) */
13462 if (current_matrix_up_to_date_p
13463 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
13464 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
13468 case CURSOR_MOVEMENT_SUCCESS
:
13469 used_current_matrix_p
= 1;
13472 #if 0 /* try_cursor_movement never returns this value. */
13473 case CURSOR_MOVEMENT_NEED_LARGER_MATRICES
:
13474 goto need_larger_matrices
;
13477 case CURSOR_MOVEMENT_MUST_SCROLL
:
13478 goto try_to_scroll
;
13484 /* If current starting point was originally the beginning of a line
13485 but no longer is, find a new starting point. */
13486 else if (!NILP (w
->start_at_line_beg
)
13487 && !(CHARPOS (startp
) <= BEGV
13488 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
13491 debug_method_add (w
, "recenter 1");
13496 /* Try scrolling with try_window_id. Value is > 0 if update has
13497 been done, it is -1 if we know that the same window start will
13498 not work. It is 0 if unsuccessful for some other reason. */
13499 else if ((tem
= try_window_id (w
)) != 0)
13502 debug_method_add (w
, "try_window_id %d", tem
);
13505 if (fonts_changed_p
)
13506 goto need_larger_matrices
;
13510 /* Otherwise try_window_id has returned -1 which means that we
13511 don't want the alternative below this comment to execute. */
13513 else if (CHARPOS (startp
) >= BEGV
13514 && CHARPOS (startp
) <= ZV
13515 && PT
>= CHARPOS (startp
)
13516 && (CHARPOS (startp
) < ZV
13517 /* Avoid starting at end of buffer. */
13518 || CHARPOS (startp
) == BEGV
13519 || (XFASTINT (w
->last_modified
) >= MODIFF
13520 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
13523 /* If first window line is a continuation line, and window start
13524 is inside the modified region, but the first change is before
13525 current window start, we must select a new window start.
13527 However, if this is the result of a down-mouse event (e.g. by
13528 extending the mouse-drag-overlay), we don't want to select a
13529 new window start, since that would change the position under
13530 the mouse, resulting in an unwanted mouse-movement rather
13531 than a simple mouse-click. */
13532 if (NILP (w
->start_at_line_beg
)
13533 && NILP (do_mouse_tracking
)
13534 && CHARPOS (startp
) > BEGV
13535 && CHARPOS (startp
) > BEG
+ beg_unchanged
13536 && CHARPOS (startp
) <= Z
- end_unchanged
)
13538 w
->force_start
= Qt
;
13539 if (XMARKER (w
->start
)->buffer
== current_buffer
)
13540 compute_window_start_on_continuation_line (w
);
13541 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13546 debug_method_add (w
, "same window start");
13549 /* Try to redisplay starting at same place as before.
13550 If point has not moved off frame, accept the results. */
13551 if (!current_matrix_up_to_date_p
13552 /* Don't use try_window_reusing_current_matrix in this case
13553 because a window scroll function can have changed the
13555 || !NILP (Vwindow_scroll_functions
)
13556 || MINI_WINDOW_P (w
)
13557 || !(used_current_matrix_p
13558 = try_window_reusing_current_matrix (w
)))
13560 IF_DEBUG (debug_method_add (w
, "1"));
13561 if (try_window (window
, startp
, 1) < 0)
13562 /* -1 means we need to scroll.
13563 0 means we need new matrices, but fonts_changed_p
13564 is set in that case, so we will detect it below. */
13565 goto try_to_scroll
;
13568 if (fonts_changed_p
)
13569 goto need_larger_matrices
;
13571 if (w
->cursor
.vpos
>= 0)
13573 if (!just_this_one_p
13574 || current_buffer
->clip_changed
13575 || BEG_UNCHANGED
< CHARPOS (startp
))
13576 /* Forget any recorded base line for line number display. */
13577 w
->base_line_number
= Qnil
;
13579 if (!cursor_row_fully_visible_p (w
, 1, 0))
13581 clear_glyph_matrix (w
->desired_matrix
);
13582 last_line_misfit
= 1;
13584 /* Drop through and scroll. */
13589 clear_glyph_matrix (w
->desired_matrix
);
13594 w
->last_modified
= make_number (0);
13595 w
->last_overlay_modified
= make_number (0);
13597 /* Redisplay the mode line. Select the buffer properly for that. */
13598 if (!update_mode_line
)
13600 update_mode_line
= 1;
13601 w
->update_mode_line
= Qt
;
13604 /* Try to scroll by specified few lines. */
13605 if ((scroll_conservatively
13607 || temp_scroll_step
13608 || NUMBERP (current_buffer
->scroll_up_aggressively
)
13609 || NUMBERP (current_buffer
->scroll_down_aggressively
))
13610 && !current_buffer
->clip_changed
13611 && CHARPOS (startp
) >= BEGV
13612 && CHARPOS (startp
) <= ZV
)
13614 /* The function returns -1 if new fonts were loaded, 1 if
13615 successful, 0 if not successful. */
13616 int rc
= try_scrolling (window
, just_this_one_p
,
13617 scroll_conservatively
,
13619 temp_scroll_step
, last_line_misfit
);
13622 case SCROLLING_SUCCESS
:
13625 case SCROLLING_NEED_LARGER_MATRICES
:
13626 goto need_larger_matrices
;
13628 case SCROLLING_FAILED
:
13636 /* Finally, just choose place to start which centers point */
13639 if (centering_position
< 0)
13640 centering_position
= window_box_height (w
) / 2;
13643 debug_method_add (w
, "recenter");
13646 /* w->vscroll = 0; */
13648 /* Forget any previously recorded base line for line number display. */
13649 if (!buffer_unchanged_p
)
13650 w
->base_line_number
= Qnil
;
13652 /* Move backward half the height of the window. */
13653 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
13654 it
.current_y
= it
.last_visible_y
;
13655 move_it_vertically_backward (&it
, centering_position
);
13656 xassert (IT_CHARPOS (it
) >= BEGV
);
13658 /* The function move_it_vertically_backward may move over more
13659 than the specified y-distance. If it->w is small, e.g. a
13660 mini-buffer window, we may end up in front of the window's
13661 display area. Start displaying at the start of the line
13662 containing PT in this case. */
13663 if (it
.current_y
<= 0)
13665 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
13666 move_it_vertically_backward (&it
, 0);
13668 /* I think this assert is bogus if buffer contains
13669 invisible text or images. KFS. */
13670 xassert (IT_CHARPOS (it
) <= PT
);
13675 it
.current_x
= it
.hpos
= 0;
13677 /* Set startp here explicitly in case that helps avoid an infinite loop
13678 in case the window-scroll-functions functions get errors. */
13679 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
13681 /* Run scroll hooks. */
13682 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
13684 /* Redisplay the window. */
13685 if (!current_matrix_up_to_date_p
13686 || windows_or_buffers_changed
13687 || cursor_type_changed
13688 /* Don't use try_window_reusing_current_matrix in this case
13689 because it can have changed the buffer. */
13690 || !NILP (Vwindow_scroll_functions
)
13691 || !just_this_one_p
13692 || MINI_WINDOW_P (w
)
13693 || !(used_current_matrix_p
13694 = try_window_reusing_current_matrix (w
)))
13695 try_window (window
, startp
, 0);
13697 /* If new fonts have been loaded (due to fontsets), give up. We
13698 have to start a new redisplay since we need to re-adjust glyph
13700 if (fonts_changed_p
)
13701 goto need_larger_matrices
;
13703 /* If cursor did not appear assume that the middle of the window is
13704 in the first line of the window. Do it again with the next line.
13705 (Imagine a window of height 100, displaying two lines of height
13706 60. Moving back 50 from it->last_visible_y will end in the first
13708 if (w
->cursor
.vpos
< 0)
13710 if (!NILP (w
->window_end_valid
)
13711 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
13713 clear_glyph_matrix (w
->desired_matrix
);
13714 move_it_by_lines (&it
, 1, 0);
13715 try_window (window
, it
.current
.pos
, 0);
13717 else if (PT
< IT_CHARPOS (it
))
13719 clear_glyph_matrix (w
->desired_matrix
);
13720 move_it_by_lines (&it
, -1, 0);
13721 try_window (window
, it
.current
.pos
, 0);
13725 /* Not much we can do about it. */
13729 /* Consider the following case: Window starts at BEGV, there is
13730 invisible, intangible text at BEGV, so that display starts at
13731 some point START > BEGV. It can happen that we are called with
13732 PT somewhere between BEGV and START. Try to handle that case. */
13733 if (w
->cursor
.vpos
< 0)
13735 struct glyph_row
*row
= w
->current_matrix
->rows
;
13736 if (row
->mode_line_p
)
13738 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13741 if (!cursor_row_fully_visible_p (w
, 0, 0))
13743 /* If vscroll is enabled, disable it and try again. */
13747 clear_glyph_matrix (w
->desired_matrix
);
13751 /* If centering point failed to make the whole line visible,
13752 put point at the top instead. That has to make the whole line
13753 visible, if it can be done. */
13754 if (centering_position
== 0)
13757 clear_glyph_matrix (w
->desired_matrix
);
13758 centering_position
= 0;
13764 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13765 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
13766 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
13769 /* Display the mode line, if we must. */
13770 if ((update_mode_line
13771 /* If window not full width, must redo its mode line
13772 if (a) the window to its side is being redone and
13773 (b) we do a frame-based redisplay. This is a consequence
13774 of how inverted lines are drawn in frame-based redisplay. */
13775 || (!just_this_one_p
13776 && !FRAME_WINDOW_P (f
)
13777 && !WINDOW_FULL_WIDTH_P (w
))
13778 /* Line number to display. */
13779 || INTEGERP (w
->base_line_pos
)
13780 /* Column number is displayed and different from the one displayed. */
13781 || (!NILP (w
->column_number_displayed
)
13782 && (XFASTINT (w
->column_number_displayed
)
13783 != (int) current_column ()))) /* iftc */
13784 /* This means that the window has a mode line. */
13785 && (WINDOW_WANTS_MODELINE_P (w
)
13786 || WINDOW_WANTS_HEADER_LINE_P (w
)))
13788 display_mode_lines (w
);
13790 /* If mode line height has changed, arrange for a thorough
13791 immediate redisplay using the correct mode line height. */
13792 if (WINDOW_WANTS_MODELINE_P (w
)
13793 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
13795 fonts_changed_p
= 1;
13796 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
13797 = DESIRED_MODE_LINE_HEIGHT (w
);
13800 /* If top line height has changed, arrange for a thorough
13801 immediate redisplay using the correct mode line height. */
13802 if (WINDOW_WANTS_HEADER_LINE_P (w
)
13803 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
13805 fonts_changed_p
= 1;
13806 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
13807 = DESIRED_HEADER_LINE_HEIGHT (w
);
13810 if (fonts_changed_p
)
13811 goto need_larger_matrices
;
13814 if (!line_number_displayed
13815 && !BUFFERP (w
->base_line_pos
))
13817 w
->base_line_pos
= Qnil
;
13818 w
->base_line_number
= Qnil
;
13823 /* When we reach a frame's selected window, redo the frame's menu bar. */
13824 if (update_mode_line
13825 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
13827 int redisplay_menu_p
= 0;
13828 int redisplay_tool_bar_p
= 0;
13830 if (FRAME_WINDOW_P (f
))
13832 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
13833 || defined (USE_GTK)
13834 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
13836 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
13840 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
13842 if (redisplay_menu_p
)
13843 display_menu_bar (w
);
13845 #ifdef HAVE_WINDOW_SYSTEM
13846 if (FRAME_WINDOW_P (f
))
13848 #if defined (USE_GTK) || USE_MAC_TOOLBAR
13849 redisplay_tool_bar_p
= FRAME_EXTERNAL_TOOL_BAR (f
);
13851 redisplay_tool_bar_p
= WINDOWP (f
->tool_bar_window
)
13852 && (FRAME_TOOL_BAR_LINES (f
) > 0
13853 || !NILP (Vauto_resize_tool_bars
));
13856 if (redisplay_tool_bar_p
&& redisplay_tool_bar (f
))
13858 extern int ignore_mouse_drag_p
;
13859 ignore_mouse_drag_p
= 1;
13865 #ifdef HAVE_WINDOW_SYSTEM
13866 if (FRAME_WINDOW_P (f
)
13867 && update_window_fringes (w
, (just_this_one_p
13868 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
13869 || w
->pseudo_window_p
)))
13873 if (draw_window_fringes (w
, 1))
13874 x_draw_vertical_border (w
);
13878 #endif /* HAVE_WINDOW_SYSTEM */
13880 /* We go to this label, with fonts_changed_p nonzero,
13881 if it is necessary to try again using larger glyph matrices.
13882 We have to redeem the scroll bar even in this case,
13883 because the loop in redisplay_internal expects that. */
13884 need_larger_matrices
:
13886 finish_scroll_bars
:
13888 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
13890 /* Set the thumb's position and size. */
13891 set_vertical_scroll_bar (w
);
13893 /* Note that we actually used the scroll bar attached to this
13894 window, so it shouldn't be deleted at the end of redisplay. */
13895 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
13896 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
13899 /* Restore current_buffer and value of point in it. */
13900 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
13901 set_buffer_internal_1 (old
);
13902 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
13903 shorter. This can be caused by log truncation in *Messages*. */
13904 if (CHARPOS (lpoint
) <= ZV
)
13905 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
13907 unbind_to (count
, Qnil
);
13911 /* Build the complete desired matrix of WINDOW with a window start
13912 buffer position POS.
13914 Value is 1 if successful. It is zero if fonts were loaded during
13915 redisplay which makes re-adjusting glyph matrices necessary, and -1
13916 if point would appear in the scroll margins.
13917 (We check that only if CHECK_MARGINS is nonzero. */
13920 try_window (window
, pos
, check_margins
)
13921 Lisp_Object window
;
13922 struct text_pos pos
;
13925 struct window
*w
= XWINDOW (window
);
13927 struct glyph_row
*last_text_row
= NULL
;
13928 struct frame
*f
= XFRAME (w
->frame
);
13930 /* Make POS the new window start. */
13931 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
13933 /* Mark cursor position as unknown. No overlay arrow seen. */
13934 w
->cursor
.vpos
= -1;
13935 overlay_arrow_seen
= 0;
13937 /* Initialize iterator and info to start at POS. */
13938 start_display (&it
, w
, pos
);
13940 /* Display all lines of W. */
13941 while (it
.current_y
< it
.last_visible_y
)
13943 if (display_line (&it
))
13944 last_text_row
= it
.glyph_row
- 1;
13945 if (fonts_changed_p
)
13949 /* Don't let the cursor end in the scroll margins. */
13951 && !MINI_WINDOW_P (w
))
13953 int this_scroll_margin
;
13955 this_scroll_margin
= max (0, scroll_margin
);
13956 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
13957 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
13959 if ((w
->cursor
.y
>= 0 /* not vscrolled */
13960 && w
->cursor
.y
< this_scroll_margin
13961 && CHARPOS (pos
) > BEGV
13962 && IT_CHARPOS (it
) < ZV
)
13963 /* rms: considering make_cursor_line_fully_visible_p here
13964 seems to give wrong results. We don't want to recenter
13965 when the last line is partly visible, we want to allow
13966 that case to be handled in the usual way. */
13967 || (w
->cursor
.y
+ 1) > it
.last_visible_y
)
13969 w
->cursor
.vpos
= -1;
13970 clear_glyph_matrix (w
->desired_matrix
);
13975 /* If bottom moved off end of frame, change mode line percentage. */
13976 if (XFASTINT (w
->window_end_pos
) <= 0
13977 && Z
!= IT_CHARPOS (it
))
13978 w
->update_mode_line
= Qt
;
13980 /* Set window_end_pos to the offset of the last character displayed
13981 on the window from the end of current_buffer. Set
13982 window_end_vpos to its row number. */
13985 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
13986 w
->window_end_bytepos
13987 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
13989 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
13991 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
13992 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
13993 ->displays_text_p
);
13997 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
13998 w
->window_end_pos
= make_number (Z
- ZV
);
13999 w
->window_end_vpos
= make_number (0);
14002 /* But that is not valid info until redisplay finishes. */
14003 w
->window_end_valid
= Qnil
;
14009 /************************************************************************
14010 Window redisplay reusing current matrix when buffer has not changed
14011 ************************************************************************/
14013 /* Try redisplay of window W showing an unchanged buffer with a
14014 different window start than the last time it was displayed by
14015 reusing its current matrix. Value is non-zero if successful.
14016 W->start is the new window start. */
14019 try_window_reusing_current_matrix (w
)
14022 struct frame
*f
= XFRAME (w
->frame
);
14023 struct glyph_row
*row
, *bottom_row
;
14026 struct text_pos start
, new_start
;
14027 int nrows_scrolled
, i
;
14028 struct glyph_row
*last_text_row
;
14029 struct glyph_row
*last_reused_text_row
;
14030 struct glyph_row
*start_row
;
14031 int start_vpos
, min_y
, max_y
;
14034 if (inhibit_try_window_reusing
)
14038 if (/* This function doesn't handle terminal frames. */
14039 !FRAME_WINDOW_P (f
)
14040 /* Don't try to reuse the display if windows have been split
14042 || windows_or_buffers_changed
14043 || cursor_type_changed
)
14046 /* Can't do this if region may have changed. */
14047 if ((!NILP (Vtransient_mark_mode
)
14048 && !NILP (current_buffer
->mark_active
))
14049 || !NILP (w
->region_showing
)
14050 || !NILP (Vshow_trailing_whitespace
))
14053 /* If top-line visibility has changed, give up. */
14054 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14055 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
14058 /* Give up if old or new display is scrolled vertically. We could
14059 make this function handle this, but right now it doesn't. */
14060 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14061 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
14064 /* The variable new_start now holds the new window start. The old
14065 start `start' can be determined from the current matrix. */
14066 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
14067 start
= start_row
->start
.pos
;
14068 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14070 /* Clear the desired matrix for the display below. */
14071 clear_glyph_matrix (w
->desired_matrix
);
14073 if (CHARPOS (new_start
) <= CHARPOS (start
))
14077 /* Don't use this method if the display starts with an ellipsis
14078 displayed for invisible text. It's not easy to handle that case
14079 below, and it's certainly not worth the effort since this is
14080 not a frequent case. */
14081 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
14084 IF_DEBUG (debug_method_add (w
, "twu1"));
14086 /* Display up to a row that can be reused. The variable
14087 last_text_row is set to the last row displayed that displays
14088 text. Note that it.vpos == 0 if or if not there is a
14089 header-line; it's not the same as the MATRIX_ROW_VPOS! */
14090 start_display (&it
, w
, new_start
);
14091 first_row_y
= it
.current_y
;
14092 w
->cursor
.vpos
= -1;
14093 last_text_row
= last_reused_text_row
= NULL
;
14095 while (it
.current_y
< it
.last_visible_y
14096 && !fonts_changed_p
)
14098 /* If we have reached into the characters in the START row,
14099 that means the line boundaries have changed. So we
14100 can't start copying with the row START. Maybe it will
14101 work to start copying with the following row. */
14102 while (IT_CHARPOS (it
) > CHARPOS (start
))
14104 /* Advance to the next row as the "start". */
14106 start
= start_row
->start
.pos
;
14107 /* If there are no more rows to try, or just one, give up. */
14108 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
14109 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
14110 || CHARPOS (start
) == ZV
)
14112 clear_glyph_matrix (w
->desired_matrix
);
14116 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14118 /* If we have reached alignment,
14119 we can copy the rest of the rows. */
14120 if (IT_CHARPOS (it
) == CHARPOS (start
))
14123 if (display_line (&it
))
14124 last_text_row
= it
.glyph_row
- 1;
14127 /* A value of current_y < last_visible_y means that we stopped
14128 at the previous window start, which in turn means that we
14129 have at least one reusable row. */
14130 if (it
.current_y
< it
.last_visible_y
)
14132 /* IT.vpos always starts from 0; it counts text lines. */
14133 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
14135 /* Find PT if not already found in the lines displayed. */
14136 if (w
->cursor
.vpos
< 0)
14138 int dy
= it
.current_y
- start_row
->y
;
14140 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14141 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
14143 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
14144 dy
, nrows_scrolled
);
14147 clear_glyph_matrix (w
->desired_matrix
);
14152 /* Scroll the display. Do it before the current matrix is
14153 changed. The problem here is that update has not yet
14154 run, i.e. part of the current matrix is not up to date.
14155 scroll_run_hook will clear the cursor, and use the
14156 current matrix to get the height of the row the cursor is
14158 run
.current_y
= start_row
->y
;
14159 run
.desired_y
= it
.current_y
;
14160 run
.height
= it
.last_visible_y
- it
.current_y
;
14162 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
14165 FRAME_RIF (f
)->update_window_begin_hook (w
);
14166 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14167 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14168 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14172 /* Shift current matrix down by nrows_scrolled lines. */
14173 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14174 rotate_matrix (w
->current_matrix
,
14176 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14179 /* Disable lines that must be updated. */
14180 for (i
= 0; i
< nrows_scrolled
; ++i
)
14181 (start_row
+ i
)->enabled_p
= 0;
14183 /* Re-compute Y positions. */
14184 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14185 max_y
= it
.last_visible_y
;
14186 for (row
= start_row
+ nrows_scrolled
;
14190 row
->y
= it
.current_y
;
14191 row
->visible_height
= row
->height
;
14193 if (row
->y
< min_y
)
14194 row
->visible_height
-= min_y
- row
->y
;
14195 if (row
->y
+ row
->height
> max_y
)
14196 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14197 row
->redraw_fringe_bitmaps_p
= 1;
14199 it
.current_y
+= row
->height
;
14201 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14202 last_reused_text_row
= row
;
14203 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
14207 /* Disable lines in the current matrix which are now
14208 below the window. */
14209 for (++row
; row
< bottom_row
; ++row
)
14210 row
->enabled_p
= row
->mode_line_p
= 0;
14213 /* Update window_end_pos etc.; last_reused_text_row is the last
14214 reused row from the current matrix containing text, if any.
14215 The value of last_text_row is the last displayed line
14216 containing text. */
14217 if (last_reused_text_row
)
14219 w
->window_end_bytepos
14220 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
14222 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
14224 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
14225 w
->current_matrix
));
14227 else if (last_text_row
)
14229 w
->window_end_bytepos
14230 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14232 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14234 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14238 /* This window must be completely empty. */
14239 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14240 w
->window_end_pos
= make_number (Z
- ZV
);
14241 w
->window_end_vpos
= make_number (0);
14243 w
->window_end_valid
= Qnil
;
14245 /* Update hint: don't try scrolling again in update_window. */
14246 w
->desired_matrix
->no_scrolling_p
= 1;
14249 debug_method_add (w
, "try_window_reusing_current_matrix 1");
14253 else if (CHARPOS (new_start
) > CHARPOS (start
))
14255 struct glyph_row
*pt_row
, *row
;
14256 struct glyph_row
*first_reusable_row
;
14257 struct glyph_row
*first_row_to_display
;
14259 int yb
= window_text_bottom_y (w
);
14261 /* Find the row starting at new_start, if there is one. Don't
14262 reuse a partially visible line at the end. */
14263 first_reusable_row
= start_row
;
14264 while (first_reusable_row
->enabled_p
14265 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
14266 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14267 < CHARPOS (new_start
)))
14268 ++first_reusable_row
;
14270 /* Give up if there is no row to reuse. */
14271 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
14272 || !first_reusable_row
->enabled_p
14273 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14274 != CHARPOS (new_start
)))
14277 /* We can reuse fully visible rows beginning with
14278 first_reusable_row to the end of the window. Set
14279 first_row_to_display to the first row that cannot be reused.
14280 Set pt_row to the row containing point, if there is any. */
14282 for (first_row_to_display
= first_reusable_row
;
14283 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
14284 ++first_row_to_display
)
14286 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
14287 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
14288 pt_row
= first_row_to_display
;
14291 /* Start displaying at the start of first_row_to_display. */
14292 xassert (first_row_to_display
->y
< yb
);
14293 init_to_row_start (&it
, w
, first_row_to_display
);
14295 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
14297 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
14299 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
14300 + WINDOW_HEADER_LINE_HEIGHT (w
));
14302 /* Display lines beginning with first_row_to_display in the
14303 desired matrix. Set last_text_row to the last row displayed
14304 that displays text. */
14305 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
14306 if (pt_row
== NULL
)
14307 w
->cursor
.vpos
= -1;
14308 last_text_row
= NULL
;
14309 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
14310 if (display_line (&it
))
14311 last_text_row
= it
.glyph_row
- 1;
14313 /* Give up If point isn't in a row displayed or reused. */
14314 if (w
->cursor
.vpos
< 0)
14316 clear_glyph_matrix (w
->desired_matrix
);
14320 /* If point is in a reused row, adjust y and vpos of the cursor
14324 w
->cursor
.vpos
-= nrows_scrolled
;
14325 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
14328 /* Scroll the display. */
14329 run
.current_y
= first_reusable_row
->y
;
14330 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14331 run
.height
= it
.last_visible_y
- run
.current_y
;
14332 dy
= run
.current_y
- run
.desired_y
;
14337 FRAME_RIF (f
)->update_window_begin_hook (w
);
14338 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14339 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14340 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14344 /* Adjust Y positions of reused rows. */
14345 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14346 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14347 max_y
= it
.last_visible_y
;
14348 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
14351 row
->visible_height
= row
->height
;
14352 if (row
->y
< min_y
)
14353 row
->visible_height
-= min_y
- row
->y
;
14354 if (row
->y
+ row
->height
> max_y
)
14355 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14356 row
->redraw_fringe_bitmaps_p
= 1;
14359 /* Scroll the current matrix. */
14360 xassert (nrows_scrolled
> 0);
14361 rotate_matrix (w
->current_matrix
,
14363 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14366 /* Disable rows not reused. */
14367 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
14368 row
->enabled_p
= 0;
14370 /* Point may have moved to a different line, so we cannot assume that
14371 the previous cursor position is valid; locate the correct row. */
14374 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
14375 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
14379 w
->cursor
.y
= row
->y
;
14381 if (row
< bottom_row
)
14383 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
14384 while (glyph
->charpos
< PT
)
14387 w
->cursor
.x
+= glyph
->pixel_width
;
14393 /* Adjust window end. A null value of last_text_row means that
14394 the window end is in reused rows which in turn means that
14395 only its vpos can have changed. */
14398 w
->window_end_bytepos
14399 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14401 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14403 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14408 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
14411 w
->window_end_valid
= Qnil
;
14412 w
->desired_matrix
->no_scrolling_p
= 1;
14415 debug_method_add (w
, "try_window_reusing_current_matrix 2");
14425 /************************************************************************
14426 Window redisplay reusing current matrix when buffer has changed
14427 ************************************************************************/
14429 static struct glyph_row
*find_last_unchanged_at_beg_row
P_ ((struct window
*));
14430 static struct glyph_row
*find_first_unchanged_at_end_row
P_ ((struct window
*,
14432 static struct glyph_row
*
14433 find_last_row_displaying_text
P_ ((struct glyph_matrix
*, struct it
*,
14434 struct glyph_row
*));
14437 /* Return the last row in MATRIX displaying text. If row START is
14438 non-null, start searching with that row. IT gives the dimensions
14439 of the display. Value is null if matrix is empty; otherwise it is
14440 a pointer to the row found. */
14442 static struct glyph_row
*
14443 find_last_row_displaying_text (matrix
, it
, start
)
14444 struct glyph_matrix
*matrix
;
14446 struct glyph_row
*start
;
14448 struct glyph_row
*row
, *row_found
;
14450 /* Set row_found to the last row in IT->w's current matrix
14451 displaying text. The loop looks funny but think of partially
14454 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
14455 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14457 xassert (row
->enabled_p
);
14459 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
14468 /* Return the last row in the current matrix of W that is not affected
14469 by changes at the start of current_buffer that occurred since W's
14470 current matrix was built. Value is null if no such row exists.
14472 BEG_UNCHANGED us the number of characters unchanged at the start of
14473 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
14474 first changed character in current_buffer. Characters at positions <
14475 BEG + BEG_UNCHANGED are at the same buffer positions as they were
14476 when the current matrix was built. */
14478 static struct glyph_row
*
14479 find_last_unchanged_at_beg_row (w
)
14482 int first_changed_pos
= BEG
+ BEG_UNCHANGED
;
14483 struct glyph_row
*row
;
14484 struct glyph_row
*row_found
= NULL
;
14485 int yb
= window_text_bottom_y (w
);
14487 /* Find the last row displaying unchanged text. */
14488 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14489 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
14490 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
)
14492 if (/* If row ends before first_changed_pos, it is unchanged,
14493 except in some case. */
14494 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
14495 /* When row ends in ZV and we write at ZV it is not
14497 && !row
->ends_at_zv_p
14498 /* When first_changed_pos is the end of a continued line,
14499 row is not unchanged because it may be no longer
14501 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
14502 && (row
->continued_p
14503 || row
->exact_window_width_line_p
)))
14506 /* Stop if last visible row. */
14507 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
14517 /* Find the first glyph row in the current matrix of W that is not
14518 affected by changes at the end of current_buffer since the
14519 time W's current matrix was built.
14521 Return in *DELTA the number of chars by which buffer positions in
14522 unchanged text at the end of current_buffer must be adjusted.
14524 Return in *DELTA_BYTES the corresponding number of bytes.
14526 Value is null if no such row exists, i.e. all rows are affected by
14529 static struct glyph_row
*
14530 find_first_unchanged_at_end_row (w
, delta
, delta_bytes
)
14532 int *delta
, *delta_bytes
;
14534 struct glyph_row
*row
;
14535 struct glyph_row
*row_found
= NULL
;
14537 *delta
= *delta_bytes
= 0;
14539 /* Display must not have been paused, otherwise the current matrix
14540 is not up to date. */
14541 eassert (!NILP (w
->window_end_valid
));
14543 /* A value of window_end_pos >= END_UNCHANGED means that the window
14544 end is in the range of changed text. If so, there is no
14545 unchanged row at the end of W's current matrix. */
14546 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
14549 /* Set row to the last row in W's current matrix displaying text. */
14550 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
14552 /* If matrix is entirely empty, no unchanged row exists. */
14553 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14555 /* The value of row is the last glyph row in the matrix having a
14556 meaningful buffer position in it. The end position of row
14557 corresponds to window_end_pos. This allows us to translate
14558 buffer positions in the current matrix to current buffer
14559 positions for characters not in changed text. */
14560 int Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
14561 int Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
14562 int last_unchanged_pos
, last_unchanged_pos_old
;
14563 struct glyph_row
*first_text_row
14564 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14566 *delta
= Z
- Z_old
;
14567 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
14569 /* Set last_unchanged_pos to the buffer position of the last
14570 character in the buffer that has not been changed. Z is the
14571 index + 1 of the last character in current_buffer, i.e. by
14572 subtracting END_UNCHANGED we get the index of the last
14573 unchanged character, and we have to add BEG to get its buffer
14575 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
14576 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
14578 /* Search backward from ROW for a row displaying a line that
14579 starts at a minimum position >= last_unchanged_pos_old. */
14580 for (; row
> first_text_row
; --row
)
14582 /* This used to abort, but it can happen.
14583 It is ok to just stop the search instead here. KFS. */
14584 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14587 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
14592 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
14598 /* Make sure that glyph rows in the current matrix of window W
14599 reference the same glyph memory as corresponding rows in the
14600 frame's frame matrix. This function is called after scrolling W's
14601 current matrix on a terminal frame in try_window_id and
14602 try_window_reusing_current_matrix. */
14605 sync_frame_with_window_matrix_rows (w
)
14608 struct frame
*f
= XFRAME (w
->frame
);
14609 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
14611 /* Preconditions: W must be a leaf window and full-width. Its frame
14612 must have a frame matrix. */
14613 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
14614 xassert (WINDOW_FULL_WIDTH_P (w
));
14615 xassert (!FRAME_WINDOW_P (f
));
14617 /* If W is a full-width window, glyph pointers in W's current matrix
14618 have, by definition, to be the same as glyph pointers in the
14619 corresponding frame matrix. Note that frame matrices have no
14620 marginal areas (see build_frame_matrix). */
14621 window_row
= w
->current_matrix
->rows
;
14622 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
14623 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
14624 while (window_row
< window_row_end
)
14626 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
14627 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
14629 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
14630 frame_row
->glyphs
[TEXT_AREA
] = start
;
14631 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
14632 frame_row
->glyphs
[LAST_AREA
] = end
;
14634 /* Disable frame rows whose corresponding window rows have
14635 been disabled in try_window_id. */
14636 if (!window_row
->enabled_p
)
14637 frame_row
->enabled_p
= 0;
14639 ++window_row
, ++frame_row
;
14644 /* Find the glyph row in window W containing CHARPOS. Consider all
14645 rows between START and END (not inclusive). END null means search
14646 all rows to the end of the display area of W. Value is the row
14647 containing CHARPOS or null. */
14650 row_containing_pos (w
, charpos
, start
, end
, dy
)
14653 struct glyph_row
*start
, *end
;
14656 struct glyph_row
*row
= start
;
14659 /* If we happen to start on a header-line, skip that. */
14660 if (row
->mode_line_p
)
14663 if ((end
&& row
>= end
) || !row
->enabled_p
)
14666 last_y
= window_text_bottom_y (w
) - dy
;
14670 /* Give up if we have gone too far. */
14671 if (end
&& row
>= end
)
14673 /* This formerly returned if they were equal.
14674 I think that both quantities are of a "last plus one" type;
14675 if so, when they are equal, the row is within the screen. -- rms. */
14676 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
14679 /* If it is in this row, return this row. */
14680 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
14681 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
14682 /* The end position of a row equals the start
14683 position of the next row. If CHARPOS is there, we
14684 would rather display it in the next line, except
14685 when this line ends in ZV. */
14686 && !row
->ends_at_zv_p
14687 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
14688 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
14695 /* Try to redisplay window W by reusing its existing display. W's
14696 current matrix must be up to date when this function is called,
14697 i.e. window_end_valid must not be nil.
14701 1 if display has been updated
14702 0 if otherwise unsuccessful
14703 -1 if redisplay with same window start is known not to succeed
14705 The following steps are performed:
14707 1. Find the last row in the current matrix of W that is not
14708 affected by changes at the start of current_buffer. If no such row
14711 2. Find the first row in W's current matrix that is not affected by
14712 changes at the end of current_buffer. Maybe there is no such row.
14714 3. Display lines beginning with the row + 1 found in step 1 to the
14715 row found in step 2 or, if step 2 didn't find a row, to the end of
14718 4. If cursor is not known to appear on the window, give up.
14720 5. If display stopped at the row found in step 2, scroll the
14721 display and current matrix as needed.
14723 6. Maybe display some lines at the end of W, if we must. This can
14724 happen under various circumstances, like a partially visible line
14725 becoming fully visible, or because newly displayed lines are displayed
14726 in smaller font sizes.
14728 7. Update W's window end information. */
14734 struct frame
*f
= XFRAME (w
->frame
);
14735 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
14736 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
14737 struct glyph_row
*last_unchanged_at_beg_row
;
14738 struct glyph_row
*first_unchanged_at_end_row
;
14739 struct glyph_row
*row
;
14740 struct glyph_row
*bottom_row
;
14743 int delta
= 0, delta_bytes
= 0, stop_pos
, dvpos
, dy
;
14744 struct text_pos start_pos
;
14746 int first_unchanged_at_end_vpos
= 0;
14747 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
14748 struct text_pos start
;
14749 int first_changed_charpos
, last_changed_charpos
;
14752 if (inhibit_try_window_id
)
14756 /* This is handy for debugging. */
14758 #define GIVE_UP(X) \
14760 fprintf (stderr, "try_window_id give up %d\n", (X)); \
14764 #define GIVE_UP(X) return 0
14767 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
14769 /* Don't use this for mini-windows because these can show
14770 messages and mini-buffers, and we don't handle that here. */
14771 if (MINI_WINDOW_P (w
))
14774 /* This flag is used to prevent redisplay optimizations. */
14775 if (windows_or_buffers_changed
|| cursor_type_changed
)
14778 /* Verify that narrowing has not changed.
14779 Also verify that we were not told to prevent redisplay optimizations.
14780 It would be nice to further
14781 reduce the number of cases where this prevents try_window_id. */
14782 if (current_buffer
->clip_changed
14783 || current_buffer
->prevent_redisplay_optimizations_p
)
14786 /* Window must either use window-based redisplay or be full width. */
14787 if (!FRAME_WINDOW_P (f
)
14788 && (!FRAME_LINE_INS_DEL_OK (f
)
14789 || !WINDOW_FULL_WIDTH_P (w
)))
14792 /* Give up if point is not known NOT to appear in W. */
14793 if (PT
< CHARPOS (start
))
14796 /* Another way to prevent redisplay optimizations. */
14797 if (XFASTINT (w
->last_modified
) == 0)
14800 /* Verify that window is not hscrolled. */
14801 if (XFASTINT (w
->hscroll
) != 0)
14804 /* Verify that display wasn't paused. */
14805 if (NILP (w
->window_end_valid
))
14808 /* Can't use this if highlighting a region because a cursor movement
14809 will do more than just set the cursor. */
14810 if (!NILP (Vtransient_mark_mode
)
14811 && !NILP (current_buffer
->mark_active
))
14814 /* Likewise if highlighting trailing whitespace. */
14815 if (!NILP (Vshow_trailing_whitespace
))
14818 /* Likewise if showing a region. */
14819 if (!NILP (w
->region_showing
))
14822 /* Can use this if overlay arrow position and or string have changed. */
14823 if (overlay_arrows_changed_p ())
14827 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
14828 only if buffer has really changed. The reason is that the gap is
14829 initially at Z for freshly visited files. The code below would
14830 set end_unchanged to 0 in that case. */
14831 if (MODIFF
> SAVE_MODIFF
14832 /* This seems to happen sometimes after saving a buffer. */
14833 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
14835 if (GPT
- BEG
< BEG_UNCHANGED
)
14836 BEG_UNCHANGED
= GPT
- BEG
;
14837 if (Z
- GPT
< END_UNCHANGED
)
14838 END_UNCHANGED
= Z
- GPT
;
14841 /* The position of the first and last character that has been changed. */
14842 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
14843 last_changed_charpos
= Z
- END_UNCHANGED
;
14845 /* If window starts after a line end, and the last change is in
14846 front of that newline, then changes don't affect the display.
14847 This case happens with stealth-fontification. Note that although
14848 the display is unchanged, glyph positions in the matrix have to
14849 be adjusted, of course. */
14850 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
14851 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
14852 && ((last_changed_charpos
< CHARPOS (start
)
14853 && CHARPOS (start
) == BEGV
)
14854 || (last_changed_charpos
< CHARPOS (start
) - 1
14855 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
14857 int Z_old
, delta
, Z_BYTE_old
, delta_bytes
;
14858 struct glyph_row
*r0
;
14860 /* Compute how many chars/bytes have been added to or removed
14861 from the buffer. */
14862 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
14863 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
14865 delta_bytes
= Z_BYTE
- Z_BYTE_old
;
14867 /* Give up if PT is not in the window. Note that it already has
14868 been checked at the start of try_window_id that PT is not in
14869 front of the window start. */
14870 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + delta
)
14873 /* If window start is unchanged, we can reuse the whole matrix
14874 as is, after adjusting glyph positions. No need to compute
14875 the window end again, since its offset from Z hasn't changed. */
14876 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
14877 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + delta
14878 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + delta_bytes
14879 /* PT must not be in a partially visible line. */
14880 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + delta
14881 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
14883 /* Adjust positions in the glyph matrix. */
14884 if (delta
|| delta_bytes
)
14886 struct glyph_row
*r1
14887 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
14888 increment_matrix_positions (w
->current_matrix
,
14889 MATRIX_ROW_VPOS (r0
, current_matrix
),
14890 MATRIX_ROW_VPOS (r1
, current_matrix
),
14891 delta
, delta_bytes
);
14894 /* Set the cursor. */
14895 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
14897 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
14904 /* Handle the case that changes are all below what is displayed in
14905 the window, and that PT is in the window. This shortcut cannot
14906 be taken if ZV is visible in the window, and text has been added
14907 there that is visible in the window. */
14908 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
14909 /* ZV is not visible in the window, or there are no
14910 changes at ZV, actually. */
14911 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
14912 || first_changed_charpos
== last_changed_charpos
))
14914 struct glyph_row
*r0
;
14916 /* Give up if PT is not in the window. Note that it already has
14917 been checked at the start of try_window_id that PT is not in
14918 front of the window start. */
14919 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
14922 /* If window start is unchanged, we can reuse the whole matrix
14923 as is, without changing glyph positions since no text has
14924 been added/removed in front of the window end. */
14925 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
14926 if (TEXT_POS_EQUAL_P (start
, r0
->start
.pos
)
14927 /* PT must not be in a partially visible line. */
14928 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
14929 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
14931 /* We have to compute the window end anew since text
14932 can have been added/removed after it. */
14934 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
14935 w
->window_end_bytepos
14936 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
14938 /* Set the cursor. */
14939 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
14941 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
14948 /* Give up if window start is in the changed area.
14950 The condition used to read
14952 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
14954 but why that was tested escapes me at the moment. */
14955 if (CHARPOS (start
) >= first_changed_charpos
14956 && CHARPOS (start
) <= last_changed_charpos
)
14959 /* Check that window start agrees with the start of the first glyph
14960 row in its current matrix. Check this after we know the window
14961 start is not in changed text, otherwise positions would not be
14963 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
14964 if (!TEXT_POS_EQUAL_P (start
, row
->start
.pos
))
14967 /* Give up if the window ends in strings. Overlay strings
14968 at the end are difficult to handle, so don't try. */
14969 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
14970 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
14973 /* Compute the position at which we have to start displaying new
14974 lines. Some of the lines at the top of the window might be
14975 reusable because they are not displaying changed text. Find the
14976 last row in W's current matrix not affected by changes at the
14977 start of current_buffer. Value is null if changes start in the
14978 first line of window. */
14979 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
14980 if (last_unchanged_at_beg_row
)
14982 /* Avoid starting to display in the moddle of a character, a TAB
14983 for instance. This is easier than to set up the iterator
14984 exactly, and it's not a frequent case, so the additional
14985 effort wouldn't really pay off. */
14986 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
14987 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
14988 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
14989 --last_unchanged_at_beg_row
;
14991 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
14994 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
14996 start_pos
= it
.current
.pos
;
14998 /* Start displaying new lines in the desired matrix at the same
14999 vpos we would use in the current matrix, i.e. below
15000 last_unchanged_at_beg_row. */
15001 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
15003 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15004 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
15006 xassert (it
.hpos
== 0 && it
.current_x
== 0);
15010 /* There are no reusable lines at the start of the window.
15011 Start displaying in the first text line. */
15012 start_display (&it
, w
, start
);
15013 it
.vpos
= it
.first_vpos
;
15014 start_pos
= it
.current
.pos
;
15017 /* Find the first row that is not affected by changes at the end of
15018 the buffer. Value will be null if there is no unchanged row, in
15019 which case we must redisplay to the end of the window. delta
15020 will be set to the value by which buffer positions beginning with
15021 first_unchanged_at_end_row have to be adjusted due to text
15023 first_unchanged_at_end_row
15024 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
15025 IF_DEBUG (debug_delta
= delta
);
15026 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
15028 /* Set stop_pos to the buffer position up to which we will have to
15029 display new lines. If first_unchanged_at_end_row != NULL, this
15030 is the buffer position of the start of the line displayed in that
15031 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
15032 that we don't stop at a buffer position. */
15034 if (first_unchanged_at_end_row
)
15036 xassert (last_unchanged_at_beg_row
== NULL
15037 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
15039 /* If this is a continuation line, move forward to the next one
15040 that isn't. Changes in lines above affect this line.
15041 Caution: this may move first_unchanged_at_end_row to a row
15042 not displaying text. */
15043 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
15044 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15045 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15046 < it
.last_visible_y
))
15047 ++first_unchanged_at_end_row
;
15049 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15050 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15051 >= it
.last_visible_y
))
15052 first_unchanged_at_end_row
= NULL
;
15055 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
15057 first_unchanged_at_end_vpos
15058 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
15059 xassert (stop_pos
>= Z
- END_UNCHANGED
);
15062 else if (last_unchanged_at_beg_row
== NULL
)
15068 /* Either there is no unchanged row at the end, or the one we have
15069 now displays text. This is a necessary condition for the window
15070 end pos calculation at the end of this function. */
15071 xassert (first_unchanged_at_end_row
== NULL
15072 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
15074 debug_last_unchanged_at_beg_vpos
15075 = (last_unchanged_at_beg_row
15076 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
15078 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
15080 #endif /* GLYPH_DEBUG != 0 */
15083 /* Display new lines. Set last_text_row to the last new line
15084 displayed which has text on it, i.e. might end up as being the
15085 line where the window_end_vpos is. */
15086 w
->cursor
.vpos
= -1;
15087 last_text_row
= NULL
;
15088 overlay_arrow_seen
= 0;
15089 while (it
.current_y
< it
.last_visible_y
15090 && !fonts_changed_p
15091 && (first_unchanged_at_end_row
== NULL
15092 || IT_CHARPOS (it
) < stop_pos
))
15094 if (display_line (&it
))
15095 last_text_row
= it
.glyph_row
- 1;
15098 if (fonts_changed_p
)
15102 /* Compute differences in buffer positions, y-positions etc. for
15103 lines reused at the bottom of the window. Compute what we can
15105 if (first_unchanged_at_end_row
15106 /* No lines reused because we displayed everything up to the
15107 bottom of the window. */
15108 && it
.current_y
< it
.last_visible_y
)
15111 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
15113 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
15114 run
.current_y
= first_unchanged_at_end_row
->y
;
15115 run
.desired_y
= run
.current_y
+ dy
;
15116 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
15120 delta
= delta_bytes
= dvpos
= dy
15121 = run
.current_y
= run
.desired_y
= run
.height
= 0;
15122 first_unchanged_at_end_row
= NULL
;
15124 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
15127 /* Find the cursor if not already found. We have to decide whether
15128 PT will appear on this window (it sometimes doesn't, but this is
15129 not a very frequent case.) This decision has to be made before
15130 the current matrix is altered. A value of cursor.vpos < 0 means
15131 that PT is either in one of the lines beginning at
15132 first_unchanged_at_end_row or below the window. Don't care for
15133 lines that might be displayed later at the window end; as
15134 mentioned, this is not a frequent case. */
15135 if (w
->cursor
.vpos
< 0)
15137 /* Cursor in unchanged rows at the top? */
15138 if (PT
< CHARPOS (start_pos
)
15139 && last_unchanged_at_beg_row
)
15141 row
= row_containing_pos (w
, PT
,
15142 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
15143 last_unchanged_at_beg_row
+ 1, 0);
15145 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15148 /* Start from first_unchanged_at_end_row looking for PT. */
15149 else if (first_unchanged_at_end_row
)
15151 row
= row_containing_pos (w
, PT
- delta
,
15152 first_unchanged_at_end_row
, NULL
, 0);
15154 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
15155 delta_bytes
, dy
, dvpos
);
15158 /* Give up if cursor was not found. */
15159 if (w
->cursor
.vpos
< 0)
15161 clear_glyph_matrix (w
->desired_matrix
);
15166 /* Don't let the cursor end in the scroll margins. */
15168 int this_scroll_margin
, cursor_height
;
15170 this_scroll_margin
= max (0, scroll_margin
);
15171 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15172 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
15173 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
15175 if ((w
->cursor
.y
< this_scroll_margin
15176 && CHARPOS (start
) > BEGV
)
15177 /* Old redisplay didn't take scroll margin into account at the bottom,
15178 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
15179 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
15180 ? cursor_height
+ this_scroll_margin
15181 : 1)) > it
.last_visible_y
)
15183 w
->cursor
.vpos
= -1;
15184 clear_glyph_matrix (w
->desired_matrix
);
15189 /* Scroll the display. Do it before changing the current matrix so
15190 that xterm.c doesn't get confused about where the cursor glyph is
15192 if (dy
&& run
.height
)
15196 if (FRAME_WINDOW_P (f
))
15198 FRAME_RIF (f
)->update_window_begin_hook (w
);
15199 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15200 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15201 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15205 /* Terminal frame. In this case, dvpos gives the number of
15206 lines to scroll by; dvpos < 0 means scroll up. */
15207 int first_unchanged_at_end_vpos
15208 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
15209 int from
= WINDOW_TOP_EDGE_LINE (w
) + first_unchanged_at_end_vpos
;
15210 int end
= (WINDOW_TOP_EDGE_LINE (w
)
15211 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
15212 + window_internal_height (w
));
15214 /* Perform the operation on the screen. */
15217 /* Scroll last_unchanged_at_beg_row to the end of the
15218 window down dvpos lines. */
15219 set_terminal_window (f
, end
);
15221 /* On dumb terminals delete dvpos lines at the end
15222 before inserting dvpos empty lines. */
15223 if (!FRAME_SCROLL_REGION_OK (f
))
15224 ins_del_lines (f
, end
- dvpos
, -dvpos
);
15226 /* Insert dvpos empty lines in front of
15227 last_unchanged_at_beg_row. */
15228 ins_del_lines (f
, from
, dvpos
);
15230 else if (dvpos
< 0)
15232 /* Scroll up last_unchanged_at_beg_vpos to the end of
15233 the window to last_unchanged_at_beg_vpos - |dvpos|. */
15234 set_terminal_window (f
, end
);
15236 /* Delete dvpos lines in front of
15237 last_unchanged_at_beg_vpos. ins_del_lines will set
15238 the cursor to the given vpos and emit |dvpos| delete
15240 ins_del_lines (f
, from
+ dvpos
, dvpos
);
15242 /* On a dumb terminal insert dvpos empty lines at the
15244 if (!FRAME_SCROLL_REGION_OK (f
))
15245 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
15248 set_terminal_window (f
, 0);
15254 /* Shift reused rows of the current matrix to the right position.
15255 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
15257 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15258 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
15261 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
15262 bottom_vpos
, dvpos
);
15263 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
15266 else if (dvpos
> 0)
15268 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
15269 bottom_vpos
, dvpos
);
15270 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
15271 first_unchanged_at_end_vpos
+ dvpos
, 0);
15274 /* For frame-based redisplay, make sure that current frame and window
15275 matrix are in sync with respect to glyph memory. */
15276 if (!FRAME_WINDOW_P (f
))
15277 sync_frame_with_window_matrix_rows (w
);
15279 /* Adjust buffer positions in reused rows. */
15280 if (delta
|| delta_bytes
)
15281 increment_matrix_positions (current_matrix
,
15282 first_unchanged_at_end_vpos
+ dvpos
,
15283 bottom_vpos
, delta
, delta_bytes
);
15285 /* Adjust Y positions. */
15287 shift_glyph_matrix (w
, current_matrix
,
15288 first_unchanged_at_end_vpos
+ dvpos
,
15291 if (first_unchanged_at_end_row
)
15293 first_unchanged_at_end_row
+= dvpos
;
15294 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
15295 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
15296 first_unchanged_at_end_row
= NULL
;
15299 /* If scrolling up, there may be some lines to display at the end of
15301 last_text_row_at_end
= NULL
;
15304 /* Scrolling up can leave for example a partially visible line
15305 at the end of the window to be redisplayed. */
15306 /* Set last_row to the glyph row in the current matrix where the
15307 window end line is found. It has been moved up or down in
15308 the matrix by dvpos. */
15309 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
15310 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
15312 /* If last_row is the window end line, it should display text. */
15313 xassert (last_row
->displays_text_p
);
15315 /* If window end line was partially visible before, begin
15316 displaying at that line. Otherwise begin displaying with the
15317 line following it. */
15318 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
15320 init_to_row_start (&it
, w
, last_row
);
15321 it
.vpos
= last_vpos
;
15322 it
.current_y
= last_row
->y
;
15326 init_to_row_end (&it
, w
, last_row
);
15327 it
.vpos
= 1 + last_vpos
;
15328 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
15332 /* We may start in a continuation line. If so, we have to
15333 get the right continuation_lines_width and current_x. */
15334 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
15335 it
.hpos
= it
.current_x
= 0;
15337 /* Display the rest of the lines at the window end. */
15338 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15339 while (it
.current_y
< it
.last_visible_y
15340 && !fonts_changed_p
)
15342 /* Is it always sure that the display agrees with lines in
15343 the current matrix? I don't think so, so we mark rows
15344 displayed invalid in the current matrix by setting their
15345 enabled_p flag to zero. */
15346 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
15347 if (display_line (&it
))
15348 last_text_row_at_end
= it
.glyph_row
- 1;
15352 /* Update window_end_pos and window_end_vpos. */
15353 if (first_unchanged_at_end_row
15354 && !last_text_row_at_end
)
15356 /* Window end line if one of the preserved rows from the current
15357 matrix. Set row to the last row displaying text in current
15358 matrix starting at first_unchanged_at_end_row, after
15360 xassert (first_unchanged_at_end_row
->displays_text_p
);
15361 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
15362 first_unchanged_at_end_row
);
15363 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
15365 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15366 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15368 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
15369 xassert (w
->window_end_bytepos
>= 0);
15370 IF_DEBUG (debug_method_add (w
, "A"));
15372 else if (last_text_row_at_end
)
15375 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
15376 w
->window_end_bytepos
15377 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
15379 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
15380 xassert (w
->window_end_bytepos
>= 0);
15381 IF_DEBUG (debug_method_add (w
, "B"));
15383 else if (last_text_row
)
15385 /* We have displayed either to the end of the window or at the
15386 end of the window, i.e. the last row with text is to be found
15387 in the desired matrix. */
15389 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15390 w
->window_end_bytepos
15391 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15393 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
15394 xassert (w
->window_end_bytepos
>= 0);
15396 else if (first_unchanged_at_end_row
== NULL
15397 && last_text_row
== NULL
15398 && last_text_row_at_end
== NULL
)
15400 /* Displayed to end of window, but no line containing text was
15401 displayed. Lines were deleted at the end of the window. */
15402 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
15403 int vpos
= XFASTINT (w
->window_end_vpos
);
15404 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
15405 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
15408 row
== NULL
&& vpos
>= first_vpos
;
15409 --vpos
, --current_row
, --desired_row
)
15411 if (desired_row
->enabled_p
)
15413 if (desired_row
->displays_text_p
)
15416 else if (current_row
->displays_text_p
)
15420 xassert (row
!= NULL
);
15421 w
->window_end_vpos
= make_number (vpos
+ 1);
15422 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15423 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15424 xassert (w
->window_end_bytepos
>= 0);
15425 IF_DEBUG (debug_method_add (w
, "C"));
15430 #if 0 /* This leads to problems, for instance when the cursor is
15431 at ZV, and the cursor line displays no text. */
15432 /* Disable rows below what's displayed in the window. This makes
15433 debugging easier. */
15434 enable_glyph_matrix_rows (current_matrix
,
15435 XFASTINT (w
->window_end_vpos
) + 1,
15439 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
15440 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
15442 /* Record that display has not been completed. */
15443 w
->window_end_valid
= Qnil
;
15444 w
->desired_matrix
->no_scrolling_p
= 1;
15452 /***********************************************************************
15453 More debugging support
15454 ***********************************************************************/
15458 void dump_glyph_row
P_ ((struct glyph_row
*, int, int));
15459 void dump_glyph_matrix
P_ ((struct glyph_matrix
*, int));
15460 void dump_glyph
P_ ((struct glyph_row
*, struct glyph
*, int));
15463 /* Dump the contents of glyph matrix MATRIX on stderr.
15465 GLYPHS 0 means don't show glyph contents.
15466 GLYPHS 1 means show glyphs in short form
15467 GLYPHS > 1 means show glyphs in long form. */
15470 dump_glyph_matrix (matrix
, glyphs
)
15471 struct glyph_matrix
*matrix
;
15475 for (i
= 0; i
< matrix
->nrows
; ++i
)
15476 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
15480 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
15481 the glyph row and area where the glyph comes from. */
15484 dump_glyph (row
, glyph
, area
)
15485 struct glyph_row
*row
;
15486 struct glyph
*glyph
;
15489 if (glyph
->type
== CHAR_GLYPH
)
15492 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15493 glyph
- row
->glyphs
[TEXT_AREA
],
15496 (BUFFERP (glyph
->object
)
15498 : (STRINGP (glyph
->object
)
15501 glyph
->pixel_width
,
15503 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
15507 glyph
->left_box_line_p
,
15508 glyph
->right_box_line_p
);
15510 else if (glyph
->type
== STRETCH_GLYPH
)
15513 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15514 glyph
- row
->glyphs
[TEXT_AREA
],
15517 (BUFFERP (glyph
->object
)
15519 : (STRINGP (glyph
->object
)
15522 glyph
->pixel_width
,
15526 glyph
->left_box_line_p
,
15527 glyph
->right_box_line_p
);
15529 else if (glyph
->type
== IMAGE_GLYPH
)
15532 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15533 glyph
- row
->glyphs
[TEXT_AREA
],
15536 (BUFFERP (glyph
->object
)
15538 : (STRINGP (glyph
->object
)
15541 glyph
->pixel_width
,
15545 glyph
->left_box_line_p
,
15546 glyph
->right_box_line_p
);
15548 else if (glyph
->type
== COMPOSITE_GLYPH
)
15551 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15552 glyph
- row
->glyphs
[TEXT_AREA
],
15555 (BUFFERP (glyph
->object
)
15557 : (STRINGP (glyph
->object
)
15560 glyph
->pixel_width
,
15564 glyph
->left_box_line_p
,
15565 glyph
->right_box_line_p
);
15570 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
15571 GLYPHS 0 means don't show glyph contents.
15572 GLYPHS 1 means show glyphs in short form
15573 GLYPHS > 1 means show glyphs in long form. */
15576 dump_glyph_row (row
, vpos
, glyphs
)
15577 struct glyph_row
*row
;
15582 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
15583 fprintf (stderr
, "======================================================================\n");
15585 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d\
15586 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
15588 MATRIX_ROW_START_CHARPOS (row
),
15589 MATRIX_ROW_END_CHARPOS (row
),
15590 row
->used
[TEXT_AREA
],
15591 row
->contains_overlapping_glyphs_p
,
15593 row
->truncated_on_left_p
,
15594 row
->truncated_on_right_p
,
15596 MATRIX_ROW_CONTINUATION_LINE_P (row
),
15597 row
->displays_text_p
,
15600 row
->ends_in_middle_of_char_p
,
15601 row
->starts_in_middle_of_char_p
,
15607 row
->visible_height
,
15610 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
15611 row
->end
.overlay_string_index
,
15612 row
->continuation_lines_width
);
15613 fprintf (stderr
, "%9d %5d\n",
15614 CHARPOS (row
->start
.string_pos
),
15615 CHARPOS (row
->end
.string_pos
));
15616 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
15617 row
->end
.dpvec_index
);
15624 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
15626 struct glyph
*glyph
= row
->glyphs
[area
];
15627 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
15629 /* Glyph for a line end in text. */
15630 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
15633 if (glyph
< glyph_end
)
15634 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
15636 for (; glyph
< glyph_end
; ++glyph
)
15637 dump_glyph (row
, glyph
, area
);
15640 else if (glyphs
== 1)
15644 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
15646 char *s
= (char *) alloca (row
->used
[area
] + 1);
15649 for (i
= 0; i
< row
->used
[area
]; ++i
)
15651 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
15652 if (glyph
->type
== CHAR_GLYPH
15653 && glyph
->u
.ch
< 0x80
15654 && glyph
->u
.ch
>= ' ')
15655 s
[i
] = glyph
->u
.ch
;
15661 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
15667 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
15668 Sdump_glyph_matrix
, 0, 1, "p",
15669 doc
: /* Dump the current matrix of the selected window to stderr.
15670 Shows contents of glyph row structures. With non-nil
15671 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
15672 glyphs in short form, otherwise show glyphs in long form. */)
15674 Lisp_Object glyphs
;
15676 struct window
*w
= XWINDOW (selected_window
);
15677 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15679 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
15680 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
15681 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
15682 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
15683 fprintf (stderr
, "=============================================\n");
15684 dump_glyph_matrix (w
->current_matrix
,
15685 NILP (glyphs
) ? 0 : XINT (glyphs
));
15690 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
15691 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
15694 struct frame
*f
= XFRAME (selected_frame
);
15695 dump_glyph_matrix (f
->current_matrix
, 1);
15700 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
15701 doc
: /* Dump glyph row ROW to stderr.
15702 GLYPH 0 means don't dump glyphs.
15703 GLYPH 1 means dump glyphs in short form.
15704 GLYPH > 1 or omitted means dump glyphs in long form. */)
15706 Lisp_Object row
, glyphs
;
15708 struct glyph_matrix
*matrix
;
15711 CHECK_NUMBER (row
);
15712 matrix
= XWINDOW (selected_window
)->current_matrix
;
15714 if (vpos
>= 0 && vpos
< matrix
->nrows
)
15715 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
15717 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
15722 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
15723 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
15724 GLYPH 0 means don't dump glyphs.
15725 GLYPH 1 means dump glyphs in short form.
15726 GLYPH > 1 or omitted means dump glyphs in long form. */)
15728 Lisp_Object row
, glyphs
;
15730 struct frame
*sf
= SELECTED_FRAME ();
15731 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
15734 CHECK_NUMBER (row
);
15736 if (vpos
>= 0 && vpos
< m
->nrows
)
15737 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
15738 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
15743 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
15744 doc
: /* Toggle tracing of redisplay.
15745 With ARG, turn tracing on if and only if ARG is positive. */)
15750 trace_redisplay_p
= !trace_redisplay_p
;
15753 arg
= Fprefix_numeric_value (arg
);
15754 trace_redisplay_p
= XINT (arg
) > 0;
15761 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
15762 doc
: /* Like `format', but print result to stderr.
15763 usage: (trace-to-stderr STRING &rest OBJECTS) */)
15768 Lisp_Object s
= Fformat (nargs
, args
);
15769 fprintf (stderr
, "%s", SDATA (s
));
15773 #endif /* GLYPH_DEBUG */
15777 /***********************************************************************
15778 Building Desired Matrix Rows
15779 ***********************************************************************/
15781 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
15782 Used for non-window-redisplay windows, and for windows w/o left fringe. */
15784 static struct glyph_row
*
15785 get_overlay_arrow_glyph_row (w
, overlay_arrow_string
)
15787 Lisp_Object overlay_arrow_string
;
15789 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
15790 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15791 struct buffer
*old
= current_buffer
;
15792 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
15793 int arrow_len
= SCHARS (overlay_arrow_string
);
15794 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
15795 const unsigned char *p
;
15798 int n_glyphs_before
;
15800 set_buffer_temp (buffer
);
15801 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
15802 it
.glyph_row
->used
[TEXT_AREA
] = 0;
15803 SET_TEXT_POS (it
.position
, 0, 0);
15805 multibyte_p
= !NILP (buffer
->enable_multibyte_characters
);
15807 while (p
< arrow_end
)
15809 Lisp_Object face
, ilisp
;
15811 /* Get the next character. */
15813 it
.c
= string_char_and_length (p
, arrow_len
, &it
.len
);
15815 it
.c
= *p
, it
.len
= 1;
15818 /* Get its face. */
15819 ilisp
= make_number (p
- arrow_string
);
15820 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
15821 it
.face_id
= compute_char_face (f
, it
.c
, face
);
15823 /* Compute its width, get its glyphs. */
15824 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
15825 SET_TEXT_POS (it
.position
, -1, -1);
15826 PRODUCE_GLYPHS (&it
);
15828 /* If this character doesn't fit any more in the line, we have
15829 to remove some glyphs. */
15830 if (it
.current_x
> it
.last_visible_x
)
15832 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
15837 set_buffer_temp (old
);
15838 return it
.glyph_row
;
15842 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
15843 glyphs are only inserted for terminal frames since we can't really
15844 win with truncation glyphs when partially visible glyphs are
15845 involved. Which glyphs to insert is determined by
15846 produce_special_glyphs. */
15849 insert_left_trunc_glyphs (it
)
15852 struct it truncate_it
;
15853 struct glyph
*from
, *end
, *to
, *toend
;
15855 xassert (!FRAME_WINDOW_P (it
->f
));
15857 /* Get the truncation glyphs. */
15859 truncate_it
.current_x
= 0;
15860 truncate_it
.face_id
= DEFAULT_FACE_ID
;
15861 truncate_it
.glyph_row
= &scratch_glyph_row
;
15862 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
15863 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
15864 truncate_it
.object
= make_number (0);
15865 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
15867 /* Overwrite glyphs from IT with truncation glyphs. */
15868 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
15869 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
15870 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
15871 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
15876 /* There may be padding glyphs left over. Overwrite them too. */
15877 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
15879 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
15885 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
15889 /* Compute the pixel height and width of IT->glyph_row.
15891 Most of the time, ascent and height of a display line will be equal
15892 to the max_ascent and max_height values of the display iterator
15893 structure. This is not the case if
15895 1. We hit ZV without displaying anything. In this case, max_ascent
15896 and max_height will be zero.
15898 2. We have some glyphs that don't contribute to the line height.
15899 (The glyph row flag contributes_to_line_height_p is for future
15900 pixmap extensions).
15902 The first case is easily covered by using default values because in
15903 these cases, the line height does not really matter, except that it
15904 must not be zero. */
15907 compute_line_metrics (it
)
15910 struct glyph_row
*row
= it
->glyph_row
;
15913 if (FRAME_WINDOW_P (it
->f
))
15915 int i
, min_y
, max_y
;
15917 /* The line may consist of one space only, that was added to
15918 place the cursor on it. If so, the row's height hasn't been
15920 if (row
->height
== 0)
15922 if (it
->max_ascent
+ it
->max_descent
== 0)
15923 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
15924 row
->ascent
= it
->max_ascent
;
15925 row
->height
= it
->max_ascent
+ it
->max_descent
;
15926 row
->phys_ascent
= it
->max_phys_ascent
;
15927 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
15928 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
15931 /* Compute the width of this line. */
15932 row
->pixel_width
= row
->x
;
15933 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
15934 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
15936 xassert (row
->pixel_width
>= 0);
15937 xassert (row
->ascent
>= 0 && row
->height
> 0);
15939 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
15940 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
15942 /* If first line's physical ascent is larger than its logical
15943 ascent, use the physical ascent, and make the row taller.
15944 This makes accented characters fully visible. */
15945 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
15946 && row
->phys_ascent
> row
->ascent
)
15948 row
->height
+= row
->phys_ascent
- row
->ascent
;
15949 row
->ascent
= row
->phys_ascent
;
15952 /* Compute how much of the line is visible. */
15953 row
->visible_height
= row
->height
;
15955 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
15956 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
15958 if (row
->y
< min_y
)
15959 row
->visible_height
-= min_y
- row
->y
;
15960 if (row
->y
+ row
->height
> max_y
)
15961 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
15965 row
->pixel_width
= row
->used
[TEXT_AREA
];
15966 if (row
->continued_p
)
15967 row
->pixel_width
-= it
->continuation_pixel_width
;
15968 else if (row
->truncated_on_right_p
)
15969 row
->pixel_width
-= it
->truncation_pixel_width
;
15970 row
->ascent
= row
->phys_ascent
= 0;
15971 row
->height
= row
->phys_height
= row
->visible_height
= 1;
15972 row
->extra_line_spacing
= 0;
15975 /* Compute a hash code for this row. */
15977 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
15978 for (i
= 0; i
< row
->used
[area
]; ++i
)
15979 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
15980 + row
->glyphs
[area
][i
].u
.val
15981 + row
->glyphs
[area
][i
].face_id
15982 + row
->glyphs
[area
][i
].padding_p
15983 + (row
->glyphs
[area
][i
].type
<< 2));
15985 it
->max_ascent
= it
->max_descent
= 0;
15986 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
15990 /* Append one space to the glyph row of iterator IT if doing a
15991 window-based redisplay. The space has the same face as
15992 IT->face_id. Value is non-zero if a space was added.
15994 This function is called to make sure that there is always one glyph
15995 at the end of a glyph row that the cursor can be set on under
15996 window-systems. (If there weren't such a glyph we would not know
15997 how wide and tall a box cursor should be displayed).
15999 At the same time this space let's a nicely handle clearing to the
16000 end of the line if the row ends in italic text. */
16003 append_space_for_newline (it
, default_face_p
)
16005 int default_face_p
;
16007 if (FRAME_WINDOW_P (it
->f
))
16009 int n
= it
->glyph_row
->used
[TEXT_AREA
];
16011 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
16012 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
16014 /* Save some values that must not be changed.
16015 Must save IT->c and IT->len because otherwise
16016 ITERATOR_AT_END_P wouldn't work anymore after
16017 append_space_for_newline has been called. */
16018 enum display_element_type saved_what
= it
->what
;
16019 int saved_c
= it
->c
, saved_len
= it
->len
;
16020 int saved_x
= it
->current_x
;
16021 int saved_face_id
= it
->face_id
;
16022 struct text_pos saved_pos
;
16023 Lisp_Object saved_object
;
16026 saved_object
= it
->object
;
16027 saved_pos
= it
->position
;
16029 it
->what
= IT_CHARACTER
;
16030 bzero (&it
->position
, sizeof it
->position
);
16031 it
->object
= make_number (0);
16035 if (default_face_p
)
16036 it
->face_id
= DEFAULT_FACE_ID
;
16037 else if (it
->face_before_selective_p
)
16038 it
->face_id
= it
->saved_face_id
;
16039 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
16040 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
16042 PRODUCE_GLYPHS (it
);
16044 it
->override_ascent
= -1;
16045 it
->constrain_row_ascent_descent_p
= 0;
16046 it
->current_x
= saved_x
;
16047 it
->object
= saved_object
;
16048 it
->position
= saved_pos
;
16049 it
->what
= saved_what
;
16050 it
->face_id
= saved_face_id
;
16051 it
->len
= saved_len
;
16061 /* Extend the face of the last glyph in the text area of IT->glyph_row
16062 to the end of the display line. Called from display_line.
16063 If the glyph row is empty, add a space glyph to it so that we
16064 know the face to draw. Set the glyph row flag fill_line_p. */
16067 extend_face_to_end_of_line (it
)
16071 struct frame
*f
= it
->f
;
16073 /* If line is already filled, do nothing. */
16074 if (it
->current_x
>= it
->last_visible_x
)
16077 /* Face extension extends the background and box of IT->face_id
16078 to the end of the line. If the background equals the background
16079 of the frame, we don't have to do anything. */
16080 if (it
->face_before_selective_p
)
16081 face
= FACE_FROM_ID (it
->f
, it
->saved_face_id
);
16083 face
= FACE_FROM_ID (f
, it
->face_id
);
16085 if (FRAME_WINDOW_P (f
)
16086 && it
->glyph_row
->displays_text_p
16087 && face
->box
== FACE_NO_BOX
16088 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
16090 && it
->line_wrap
!= WORD_WRAP
)
16093 /* Set the glyph row flag indicating that the face of the last glyph
16094 in the text area has to be drawn to the end of the text area. */
16095 it
->glyph_row
->fill_line_p
= 1;
16097 /* If current character of IT is not ASCII, make sure we have the
16098 ASCII face. This will be automatically undone the next time
16099 get_next_display_element returns a multibyte character. Note
16100 that the character will always be single byte in unibyte text. */
16101 if (!ASCII_CHAR_P (it
->c
))
16103 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
16106 if (FRAME_WINDOW_P (f
))
16108 /* If the row is empty, add a space with the current face of IT,
16109 so that we know which face to draw. */
16110 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
16112 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
16113 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
16114 it
->glyph_row
->used
[TEXT_AREA
] = 1;
16119 /* Save some values that must not be changed. */
16120 int saved_x
= it
->current_x
;
16121 struct text_pos saved_pos
;
16122 Lisp_Object saved_object
;
16123 enum display_element_type saved_what
= it
->what
;
16124 int saved_face_id
= it
->face_id
;
16126 saved_object
= it
->object
;
16127 saved_pos
= it
->position
;
16129 it
->what
= IT_CHARACTER
;
16130 bzero (&it
->position
, sizeof it
->position
);
16131 it
->object
= make_number (0);
16134 it
->face_id
= face
->id
;
16136 PRODUCE_GLYPHS (it
);
16138 while (it
->current_x
<= it
->last_visible_x
)
16139 PRODUCE_GLYPHS (it
);
16141 /* Don't count these blanks really. It would let us insert a left
16142 truncation glyph below and make us set the cursor on them, maybe. */
16143 it
->current_x
= saved_x
;
16144 it
->object
= saved_object
;
16145 it
->position
= saved_pos
;
16146 it
->what
= saved_what
;
16147 it
->face_id
= saved_face_id
;
16152 /* Value is non-zero if text starting at CHARPOS in current_buffer is
16153 trailing whitespace. */
16156 trailing_whitespace_p (charpos
)
16159 int bytepos
= CHAR_TO_BYTE (charpos
);
16162 while (bytepos
< ZV_BYTE
16163 && (c
= FETCH_CHAR (bytepos
),
16164 c
== ' ' || c
== '\t'))
16167 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
16169 if (bytepos
!= PT_BYTE
)
16176 /* Highlight trailing whitespace, if any, in ROW. */
16179 highlight_trailing_whitespace (f
, row
)
16181 struct glyph_row
*row
;
16183 int used
= row
->used
[TEXT_AREA
];
16187 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
16188 struct glyph
*glyph
= start
+ used
- 1;
16190 /* Skip over glyphs inserted to display the cursor at the
16191 end of a line, for extending the face of the last glyph
16192 to the end of the line on terminals, and for truncation
16193 and continuation glyphs. */
16194 while (glyph
>= start
16195 && glyph
->type
== CHAR_GLYPH
16196 && INTEGERP (glyph
->object
))
16199 /* If last glyph is a space or stretch, and it's trailing
16200 whitespace, set the face of all trailing whitespace glyphs in
16201 IT->glyph_row to `trailing-whitespace'. */
16203 && BUFFERP (glyph
->object
)
16204 && (glyph
->type
== STRETCH_GLYPH
16205 || (glyph
->type
== CHAR_GLYPH
16206 && glyph
->u
.ch
== ' '))
16207 && trailing_whitespace_p (glyph
->charpos
))
16209 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
16213 while (glyph
>= start
16214 && BUFFERP (glyph
->object
)
16215 && (glyph
->type
== STRETCH_GLYPH
16216 || (glyph
->type
== CHAR_GLYPH
16217 && glyph
->u
.ch
== ' ')))
16218 (glyph
--)->face_id
= face_id
;
16224 /* Value is non-zero if glyph row ROW in window W should be
16225 used to hold the cursor. */
16228 cursor_row_p (w
, row
)
16230 struct glyph_row
*row
;
16232 int cursor_row_p
= 1;
16234 if (PT
== MATRIX_ROW_END_CHARPOS (row
))
16236 /* Suppose the row ends on a string.
16237 Unless the row is continued, that means it ends on a newline
16238 in the string. If it's anything other than a display string
16239 (e.g. a before-string from an overlay), we don't want the
16240 cursor there. (This heuristic seems to give the optimal
16241 behavior for the various types of multi-line strings.) */
16242 if (CHARPOS (row
->end
.string_pos
) >= 0)
16244 if (row
->continued_p
)
16248 /* Check for `display' property. */
16249 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
16250 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
16251 struct glyph
*glyph
;
16254 for (glyph
= end
; glyph
>= beg
; --glyph
)
16255 if (STRINGP (glyph
->object
))
16258 = Fget_char_property (make_number (PT
),
16262 && display_prop_string_p (prop
, glyph
->object
));
16267 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
16269 /* If the row ends in middle of a real character,
16270 and the line is continued, we want the cursor here.
16271 That's because MATRIX_ROW_END_CHARPOS would equal
16272 PT if PT is before the character. */
16273 if (!row
->ends_in_ellipsis_p
)
16274 cursor_row_p
= row
->continued_p
;
16276 /* If the row ends in an ellipsis, then
16277 MATRIX_ROW_END_CHARPOS will equal point after the invisible text.
16278 We want that position to be displayed after the ellipsis. */
16281 /* If the row ends at ZV, display the cursor at the end of that
16282 row instead of at the start of the row below. */
16283 else if (row
->ends_at_zv_p
)
16289 return cursor_row_p
;
16293 /* Construct the glyph row IT->glyph_row in the desired matrix of
16294 IT->w from text at the current position of IT. See dispextern.h
16295 for an overview of struct it. Value is non-zero if
16296 IT->glyph_row displays text, as opposed to a line displaying ZV
16303 struct glyph_row
*row
= it
->glyph_row
;
16304 Lisp_Object overlay_arrow_string
;
16306 int may_wrap
= 0, wrap_x
;
16307 int wrap_row_used
= -1, wrap_row_ascent
, wrap_row_height
;
16308 int wrap_row_phys_ascent
, wrap_row_phys_height
;
16309 int wrap_row_extra_line_spacing
;
16311 /* We always start displaying at hpos zero even if hscrolled. */
16312 xassert (it
->hpos
== 0 && it
->current_x
== 0);
16314 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
16315 >= it
->w
->desired_matrix
->nrows
)
16317 it
->w
->nrows_scale_factor
++;
16318 fonts_changed_p
= 1;
16322 /* Is IT->w showing the region? */
16323 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
16325 /* Clear the result glyph row and enable it. */
16326 prepare_desired_row (row
);
16328 row
->y
= it
->current_y
;
16329 row
->start
= it
->start
;
16330 row
->continuation_lines_width
= it
->continuation_lines_width
;
16331 row
->displays_text_p
= 1;
16332 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
16333 it
->starts_in_middle_of_char_p
= 0;
16335 /* Arrange the overlays nicely for our purposes. Usually, we call
16336 display_line on only one line at a time, in which case this
16337 can't really hurt too much, or we call it on lines which appear
16338 one after another in the buffer, in which case all calls to
16339 recenter_overlay_lists but the first will be pretty cheap. */
16340 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
16342 /* Move over display elements that are not visible because we are
16343 hscrolled. This may stop at an x-position < IT->first_visible_x
16344 if the first glyph is partially visible or if we hit a line end. */
16345 if (it
->current_x
< it
->first_visible_x
)
16347 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
16348 MOVE_TO_POS
| MOVE_TO_X
);
16351 /* Get the initial row height. This is either the height of the
16352 text hscrolled, if there is any, or zero. */
16353 row
->ascent
= it
->max_ascent
;
16354 row
->height
= it
->max_ascent
+ it
->max_descent
;
16355 row
->phys_ascent
= it
->max_phys_ascent
;
16356 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16357 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
16359 /* Loop generating characters. The loop is left with IT on the next
16360 character to display. */
16363 int n_glyphs_before
, hpos_before
, x_before
;
16365 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
16367 /* Retrieve the next thing to display. Value is zero if end of
16369 if (!get_next_display_element (it
))
16371 /* Maybe add a space at the end of this line that is used to
16372 display the cursor there under X. Set the charpos of the
16373 first glyph of blank lines not corresponding to any text
16375 #ifdef HAVE_WINDOW_SYSTEM
16376 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16377 row
->exact_window_width_line_p
= 1;
16379 #endif /* HAVE_WINDOW_SYSTEM */
16380 if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
16381 || row
->used
[TEXT_AREA
] == 0)
16383 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
16384 row
->displays_text_p
= 0;
16386 if (!NILP (XBUFFER (it
->w
->buffer
)->indicate_empty_lines
)
16387 && (!MINI_WINDOW_P (it
->w
)
16388 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
16389 row
->indicate_empty_line_p
= 1;
16392 it
->continuation_lines_width
= 0;
16393 row
->ends_at_zv_p
= 1;
16397 /* Now, get the metrics of what we want to display. This also
16398 generates glyphs in `row' (which is IT->glyph_row). */
16399 n_glyphs_before
= row
->used
[TEXT_AREA
];
16402 /* Remember the line height so far in case the next element doesn't
16403 fit on the line. */
16404 if (it
->line_wrap
!= TRUNCATE
)
16406 ascent
= it
->max_ascent
;
16407 descent
= it
->max_descent
;
16408 phys_ascent
= it
->max_phys_ascent
;
16409 phys_descent
= it
->max_phys_descent
;
16411 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
16413 if (it
->what
== IT_CHARACTER
16414 && (it
->c
== ' ' || it
->c
== '\t'))
16420 wrap_row_used
= row
->used
[TEXT_AREA
];
16421 wrap_row_ascent
= row
->ascent
;
16422 wrap_row_height
= row
->height
;
16423 wrap_row_phys_ascent
= row
->phys_ascent
;
16424 wrap_row_phys_height
= row
->phys_height
;
16425 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
16431 PRODUCE_GLYPHS (it
);
16433 /* If this display element was in marginal areas, continue with
16435 if (it
->area
!= TEXT_AREA
)
16437 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
16438 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
16439 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
16440 row
->phys_height
= max (row
->phys_height
,
16441 it
->max_phys_ascent
+ it
->max_phys_descent
);
16442 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
16443 it
->max_extra_line_spacing
);
16444 set_iterator_to_next (it
, 1);
16448 /* Does the display element fit on the line? If we truncate
16449 lines, we should draw past the right edge of the window. If
16450 we don't truncate, we want to stop so that we can display the
16451 continuation glyph before the right margin. If lines are
16452 continued, there are two possible strategies for characters
16453 resulting in more than 1 glyph (e.g. tabs): Display as many
16454 glyphs as possible in this line and leave the rest for the
16455 continuation line, or display the whole element in the next
16456 line. Original redisplay did the former, so we do it also. */
16457 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
16458 hpos_before
= it
->hpos
;
16461 if (/* Not a newline. */
16463 /* Glyphs produced fit entirely in the line. */
16464 && it
->current_x
< it
->last_visible_x
)
16466 it
->hpos
+= nglyphs
;
16467 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
16468 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
16469 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
16470 row
->phys_height
= max (row
->phys_height
,
16471 it
->max_phys_ascent
+ it
->max_phys_descent
);
16472 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
16473 it
->max_extra_line_spacing
);
16474 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
16475 row
->x
= x
- it
->first_visible_x
;
16480 struct glyph
*glyph
;
16482 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
16484 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
16485 new_x
= x
+ glyph
->pixel_width
;
16487 if (/* Lines are continued. */
16488 it
->line_wrap
!= TRUNCATE
16489 && (/* Glyph doesn't fit on the line. */
16490 new_x
> it
->last_visible_x
16491 /* Or it fits exactly on a window system frame. */
16492 || (new_x
== it
->last_visible_x
16493 && FRAME_WINDOW_P (it
->f
))))
16495 /* End of a continued line. */
16498 || (new_x
== it
->last_visible_x
16499 && FRAME_WINDOW_P (it
->f
)))
16501 /* Current glyph is the only one on the line or
16502 fits exactly on the line. We must continue
16503 the line because we can't draw the cursor
16504 after the glyph. */
16505 row
->continued_p
= 1;
16506 it
->current_x
= new_x
;
16507 it
->continuation_lines_width
+= new_x
;
16509 if (i
== nglyphs
- 1)
16511 set_iterator_to_next (it
, 1);
16512 #ifdef HAVE_WINDOW_SYSTEM
16513 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16515 if (!get_next_display_element (it
))
16517 row
->exact_window_width_line_p
= 1;
16518 it
->continuation_lines_width
= 0;
16519 row
->continued_p
= 0;
16520 row
->ends_at_zv_p
= 1;
16522 else if (ITERATOR_AT_END_OF_LINE_P (it
))
16524 row
->continued_p
= 0;
16525 row
->exact_window_width_line_p
= 1;
16528 #endif /* HAVE_WINDOW_SYSTEM */
16529 if (wrap_row_used
> 0)
16533 else if (CHAR_GLYPH_PADDING_P (*glyph
)
16534 && !FRAME_WINDOW_P (it
->f
))
16536 /* A padding glyph that doesn't fit on this line.
16537 This means the whole character doesn't fit
16539 row
->used
[TEXT_AREA
] = n_glyphs_before
;
16541 /* Fill the rest of the row with continuation
16542 glyphs like in 20.x. */
16543 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
16544 < row
->glyphs
[1 + TEXT_AREA
])
16545 produce_special_glyphs (it
, IT_CONTINUATION
);
16547 row
->continued_p
= 1;
16548 it
->current_x
= x_before
;
16549 it
->continuation_lines_width
+= x_before
;
16551 /* Restore the height to what it was before the
16552 element not fitting on the line. */
16553 it
->max_ascent
= ascent
;
16554 it
->max_descent
= descent
;
16555 it
->max_phys_ascent
= phys_ascent
;
16556 it
->max_phys_descent
= phys_descent
;
16558 else if (wrap_row_used
> 0)
16562 it
->continuation_lines_width
+= wrap_x
;
16563 row
->used
[TEXT_AREA
] = wrap_row_used
;
16564 row
->ascent
= wrap_row_ascent
;
16565 row
->height
= wrap_row_height
;
16566 row
->phys_ascent
= wrap_row_phys_ascent
;
16567 row
->phys_height
= wrap_row_phys_height
;
16568 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
16569 row
->continued_p
= 1;
16570 row
->ends_at_zv_p
= 0;
16571 row
->exact_window_width_line_p
= 0;
16572 it
->continuation_lines_width
+= x
;
16574 /* Make sure that a non-default face is extended
16575 up to the right margin of the window. */
16576 extend_face_to_end_of_line (it
);
16578 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
16580 /* A TAB that extends past the right edge of the
16581 window. This produces a single glyph on
16582 window system frames. We leave the glyph in
16583 this row and let it fill the row, but don't
16584 consume the TAB. */
16585 it
->continuation_lines_width
+= it
->last_visible_x
;
16586 row
->ends_in_middle_of_char_p
= 1;
16587 row
->continued_p
= 1;
16588 glyph
->pixel_width
= it
->last_visible_x
- x
;
16589 it
->starts_in_middle_of_char_p
= 1;
16593 /* Something other than a TAB that draws past
16594 the right edge of the window. Restore
16595 positions to values before the element. */
16596 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
16598 /* Display continuation glyphs. */
16599 if (!FRAME_WINDOW_P (it
->f
))
16600 produce_special_glyphs (it
, IT_CONTINUATION
);
16601 row
->continued_p
= 1;
16603 it
->current_x
= x_before
;
16604 it
->continuation_lines_width
+= x
;
16605 extend_face_to_end_of_line (it
);
16607 if (nglyphs
> 1 && i
> 0)
16609 row
->ends_in_middle_of_char_p
= 1;
16610 it
->starts_in_middle_of_char_p
= 1;
16613 /* Restore the height to what it was before the
16614 element not fitting on the line. */
16615 it
->max_ascent
= ascent
;
16616 it
->max_descent
= descent
;
16617 it
->max_phys_ascent
= phys_ascent
;
16618 it
->max_phys_descent
= phys_descent
;
16623 else if (new_x
> it
->first_visible_x
)
16625 /* Increment number of glyphs actually displayed. */
16628 if (x
< it
->first_visible_x
)
16629 /* Glyph is partially visible, i.e. row starts at
16630 negative X position. */
16631 row
->x
= x
- it
->first_visible_x
;
16635 /* Glyph is completely off the left margin of the
16636 window. This should not happen because of the
16637 move_it_in_display_line at the start of this
16638 function, unless the text display area of the
16639 window is empty. */
16640 xassert (it
->first_visible_x
<= it
->last_visible_x
);
16644 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
16645 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
16646 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
16647 row
->phys_height
= max (row
->phys_height
,
16648 it
->max_phys_ascent
+ it
->max_phys_descent
);
16649 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
16650 it
->max_extra_line_spacing
);
16652 /* End of this display line if row is continued. */
16653 if (row
->continued_p
|| row
->ends_at_zv_p
)
16658 /* Is this a line end? If yes, we're also done, after making
16659 sure that a non-default face is extended up to the right
16660 margin of the window. */
16661 if (ITERATOR_AT_END_OF_LINE_P (it
))
16663 int used_before
= row
->used
[TEXT_AREA
];
16665 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
16667 #ifdef HAVE_WINDOW_SYSTEM
16668 /* Add a space at the end of the line that is used to
16669 display the cursor there. */
16670 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16671 append_space_for_newline (it
, 0);
16672 #endif /* HAVE_WINDOW_SYSTEM */
16674 /* Extend the face to the end of the line. */
16675 extend_face_to_end_of_line (it
);
16677 /* Make sure we have the position. */
16678 if (used_before
== 0)
16679 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
16681 /* Consume the line end. This skips over invisible lines. */
16682 set_iterator_to_next (it
, 1);
16683 it
->continuation_lines_width
= 0;
16687 /* Proceed with next display element. Note that this skips
16688 over lines invisible because of selective display. */
16689 set_iterator_to_next (it
, 1);
16691 /* If we truncate lines, we are done when the last displayed
16692 glyphs reach past the right margin of the window. */
16693 if (it
->line_wrap
== TRUNCATE
16694 && (FRAME_WINDOW_P (it
->f
)
16695 ? (it
->current_x
>= it
->last_visible_x
)
16696 : (it
->current_x
> it
->last_visible_x
)))
16698 /* Maybe add truncation glyphs. */
16699 if (!FRAME_WINDOW_P (it
->f
))
16703 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
16704 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
16707 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
16709 row
->used
[TEXT_AREA
] = i
;
16710 produce_special_glyphs (it
, IT_TRUNCATION
);
16713 #ifdef HAVE_WINDOW_SYSTEM
16716 /* Don't truncate if we can overflow newline into fringe. */
16717 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16719 if (!get_next_display_element (it
))
16721 it
->continuation_lines_width
= 0;
16722 row
->ends_at_zv_p
= 1;
16723 row
->exact_window_width_line_p
= 1;
16726 if (ITERATOR_AT_END_OF_LINE_P (it
))
16728 row
->exact_window_width_line_p
= 1;
16729 goto at_end_of_line
;
16733 #endif /* HAVE_WINDOW_SYSTEM */
16735 row
->truncated_on_right_p
= 1;
16736 it
->continuation_lines_width
= 0;
16737 reseat_at_next_visible_line_start (it
, 0);
16738 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
16739 it
->hpos
= hpos_before
;
16740 it
->current_x
= x_before
;
16745 /* If line is not empty and hscrolled, maybe insert truncation glyphs
16746 at the left window margin. */
16747 if (it
->first_visible_x
16748 && IT_CHARPOS (*it
) != MATRIX_ROW_START_CHARPOS (row
))
16750 if (!FRAME_WINDOW_P (it
->f
))
16751 insert_left_trunc_glyphs (it
);
16752 row
->truncated_on_left_p
= 1;
16755 /* If the start of this line is the overlay arrow-position, then
16756 mark this glyph row as the one containing the overlay arrow.
16757 This is clearly a mess with variable size fonts. It would be
16758 better to let it be displayed like cursors under X. */
16759 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
16760 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
16761 !NILP (overlay_arrow_string
)))
16763 /* Overlay arrow in window redisplay is a fringe bitmap. */
16764 if (STRINGP (overlay_arrow_string
))
16766 struct glyph_row
*arrow_row
16767 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
16768 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
16769 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
16770 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
16771 struct glyph
*p2
, *end
;
16773 /* Copy the arrow glyphs. */
16774 while (glyph
< arrow_end
)
16777 /* Throw away padding glyphs. */
16779 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16780 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
16786 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
16791 xassert (INTEGERP (overlay_arrow_string
));
16792 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
16794 overlay_arrow_seen
= 1;
16797 /* Compute pixel dimensions of this line. */
16798 compute_line_metrics (it
);
16800 /* Remember the position at which this line ends. */
16801 row
->end
= it
->current
;
16803 /* Record whether this row ends inside an ellipsis. */
16804 row
->ends_in_ellipsis_p
16805 = (it
->method
== GET_FROM_DISPLAY_VECTOR
16806 && it
->ellipsis_p
);
16808 /* Save fringe bitmaps in this row. */
16809 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
16810 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
16811 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
16812 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
16814 it
->left_user_fringe_bitmap
= 0;
16815 it
->left_user_fringe_face_id
= 0;
16816 it
->right_user_fringe_bitmap
= 0;
16817 it
->right_user_fringe_face_id
= 0;
16819 /* Maybe set the cursor. */
16820 if (it
->w
->cursor
.vpos
< 0
16821 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
16822 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
16823 && cursor_row_p (it
->w
, row
))
16824 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
16826 /* Highlight trailing whitespace. */
16827 if (!NILP (Vshow_trailing_whitespace
))
16828 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
16830 /* Prepare for the next line. This line starts horizontally at (X
16831 HPOS) = (0 0). Vertical positions are incremented. As a
16832 convenience for the caller, IT->glyph_row is set to the next
16834 it
->current_x
= it
->hpos
= 0;
16835 it
->current_y
+= row
->height
;
16838 it
->start
= it
->current
;
16839 return row
->displays_text_p
;
16844 /***********************************************************************
16846 ***********************************************************************/
16848 /* Redisplay the menu bar in the frame for window W.
16850 The menu bar of X frames that don't have X toolkit support is
16851 displayed in a special window W->frame->menu_bar_window.
16853 The menu bar of terminal frames is treated specially as far as
16854 glyph matrices are concerned. Menu bar lines are not part of
16855 windows, so the update is done directly on the frame matrix rows
16856 for the menu bar. */
16859 display_menu_bar (w
)
16862 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
16867 /* Don't do all this for graphical frames. */
16869 if (FRAME_W32_P (f
))
16872 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
16877 if (FRAME_MAC_P (f
))
16881 #ifdef USE_X_TOOLKIT
16882 xassert (!FRAME_WINDOW_P (f
));
16883 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
16884 it
.first_visible_x
= 0;
16885 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
16886 #else /* not USE_X_TOOLKIT */
16887 if (FRAME_WINDOW_P (f
))
16889 /* Menu bar lines are displayed in the desired matrix of the
16890 dummy window menu_bar_window. */
16891 struct window
*menu_w
;
16892 xassert (WINDOWP (f
->menu_bar_window
));
16893 menu_w
= XWINDOW (f
->menu_bar_window
);
16894 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
16896 it
.first_visible_x
= 0;
16897 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
16901 /* This is a TTY frame, i.e. character hpos/vpos are used as
16903 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
16905 it
.first_visible_x
= 0;
16906 it
.last_visible_x
= FRAME_COLS (f
);
16908 #endif /* not USE_X_TOOLKIT */
16910 if (! mode_line_inverse_video
)
16911 /* Force the menu-bar to be displayed in the default face. */
16912 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
16914 /* Clear all rows of the menu bar. */
16915 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
16917 struct glyph_row
*row
= it
.glyph_row
+ i
;
16918 clear_glyph_row (row
);
16919 row
->enabled_p
= 1;
16920 row
->full_width_p
= 1;
16923 /* Display all items of the menu bar. */
16924 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
16925 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
16927 Lisp_Object string
;
16929 /* Stop at nil string. */
16930 string
= AREF (items
, i
+ 1);
16934 /* Remember where item was displayed. */
16935 ASET (items
, i
+ 3, make_number (it
.hpos
));
16937 /* Display the item, pad with one space. */
16938 if (it
.current_x
< it
.last_visible_x
)
16939 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
16940 SCHARS (string
) + 1, 0, 0, -1);
16943 /* Fill out the line with spaces. */
16944 if (it
.current_x
< it
.last_visible_x
)
16945 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
16947 /* Compute the total height of the lines. */
16948 compute_line_metrics (&it
);
16953 /***********************************************************************
16955 ***********************************************************************/
16957 /* Redisplay mode lines in the window tree whose root is WINDOW. If
16958 FORCE is non-zero, redisplay mode lines unconditionally.
16959 Otherwise, redisplay only mode lines that are garbaged. Value is
16960 the number of windows whose mode lines were redisplayed. */
16963 redisplay_mode_lines (window
, force
)
16964 Lisp_Object window
;
16969 while (!NILP (window
))
16971 struct window
*w
= XWINDOW (window
);
16973 if (WINDOWP (w
->hchild
))
16974 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
16975 else if (WINDOWP (w
->vchild
))
16976 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
16978 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
16979 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
16981 struct text_pos lpoint
;
16982 struct buffer
*old
= current_buffer
;
16984 /* Set the window's buffer for the mode line display. */
16985 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16986 set_buffer_internal_1 (XBUFFER (w
->buffer
));
16988 /* Point refers normally to the selected window. For any
16989 other window, set up appropriate value. */
16990 if (!EQ (window
, selected_window
))
16992 struct text_pos pt
;
16994 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
16995 if (CHARPOS (pt
) < BEGV
)
16996 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
16997 else if (CHARPOS (pt
) > (ZV
- 1))
16998 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
17000 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
17003 /* Display mode lines. */
17004 clear_glyph_matrix (w
->desired_matrix
);
17005 if (display_mode_lines (w
))
17008 w
->must_be_updated_p
= 1;
17011 /* Restore old settings. */
17012 set_buffer_internal_1 (old
);
17013 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
17023 /* Display the mode and/or top line of window W. Value is the number
17024 of mode lines displayed. */
17027 display_mode_lines (w
)
17030 Lisp_Object old_selected_window
, old_selected_frame
;
17033 old_selected_frame
= selected_frame
;
17034 selected_frame
= w
->frame
;
17035 old_selected_window
= selected_window
;
17036 XSETWINDOW (selected_window
, w
);
17038 /* These will be set while the mode line specs are processed. */
17039 line_number_displayed
= 0;
17040 w
->column_number_displayed
= Qnil
;
17042 if (WINDOW_WANTS_MODELINE_P (w
))
17044 struct window
*sel_w
= XWINDOW (old_selected_window
);
17046 /* Select mode line face based on the real selected window. */
17047 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
17048 current_buffer
->mode_line_format
);
17052 if (WINDOW_WANTS_HEADER_LINE_P (w
))
17054 display_mode_line (w
, HEADER_LINE_FACE_ID
,
17055 current_buffer
->header_line_format
);
17059 selected_frame
= old_selected_frame
;
17060 selected_window
= old_selected_window
;
17065 /* Display mode or top line of window W. FACE_ID specifies which line
17066 to display; it is either MODE_LINE_FACE_ID or HEADER_LINE_FACE_ID.
17067 FORMAT is the mode line format to display. Value is the pixel
17068 height of the mode line displayed. */
17071 display_mode_line (w
, face_id
, format
)
17073 enum face_id face_id
;
17074 Lisp_Object format
;
17078 int count
= SPECPDL_INDEX ();
17080 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
17081 /* Don't extend on a previously drawn mode-line.
17082 This may happen if called from pos_visible_p. */
17083 it
.glyph_row
->enabled_p
= 0;
17084 prepare_desired_row (it
.glyph_row
);
17086 it
.glyph_row
->mode_line_p
= 1;
17088 if (! mode_line_inverse_video
)
17089 /* Force the mode-line to be displayed in the default face. */
17090 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
17092 record_unwind_protect (unwind_format_mode_line
,
17093 format_mode_line_unwind_data (NULL
, Qnil
, 0));
17095 mode_line_target
= MODE_LINE_DISPLAY
;
17097 /* Temporarily make frame's keyboard the current kboard so that
17098 kboard-local variables in the mode_line_format will get the right
17100 push_kboard (FRAME_KBOARD (it
.f
));
17101 record_unwind_save_match_data ();
17102 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
17105 unbind_to (count
, Qnil
);
17107 /* Fill up with spaces. */
17108 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
17110 compute_line_metrics (&it
);
17111 it
.glyph_row
->full_width_p
= 1;
17112 it
.glyph_row
->continued_p
= 0;
17113 it
.glyph_row
->truncated_on_left_p
= 0;
17114 it
.glyph_row
->truncated_on_right_p
= 0;
17116 /* Make a 3D mode-line have a shadow at its right end. */
17117 face
= FACE_FROM_ID (it
.f
, face_id
);
17118 extend_face_to_end_of_line (&it
);
17119 if (face
->box
!= FACE_NO_BOX
)
17121 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
17122 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
17123 last
->right_box_line_p
= 1;
17126 return it
.glyph_row
->height
;
17129 /* Move element ELT in LIST to the front of LIST.
17130 Return the updated list. */
17133 move_elt_to_front (elt
, list
)
17134 Lisp_Object elt
, list
;
17136 register Lisp_Object tail
, prev
;
17137 register Lisp_Object tem
;
17141 while (CONSP (tail
))
17147 /* Splice out the link TAIL. */
17149 list
= XCDR (tail
);
17151 Fsetcdr (prev
, XCDR (tail
));
17153 /* Now make it the first. */
17154 Fsetcdr (tail
, list
);
17159 tail
= XCDR (tail
);
17163 /* Not found--return unchanged LIST. */
17167 /* Contribute ELT to the mode line for window IT->w. How it
17168 translates into text depends on its data type.
17170 IT describes the display environment in which we display, as usual.
17172 DEPTH is the depth in recursion. It is used to prevent
17173 infinite recursion here.
17175 FIELD_WIDTH is the number of characters the display of ELT should
17176 occupy in the mode line, and PRECISION is the maximum number of
17177 characters to display from ELT's representation. See
17178 display_string for details.
17180 Returns the hpos of the end of the text generated by ELT.
17182 PROPS is a property list to add to any string we encounter.
17184 If RISKY is nonzero, remove (disregard) any properties in any string
17185 we encounter, and ignore :eval and :propertize.
17187 The global variable `mode_line_target' determines whether the
17188 output is passed to `store_mode_line_noprop',
17189 `store_mode_line_string', or `display_string'. */
17192 display_mode_element (it
, depth
, field_width
, precision
, elt
, props
, risky
)
17195 int field_width
, precision
;
17196 Lisp_Object elt
, props
;
17199 int n
= 0, field
, prec
;
17204 elt
= build_string ("*too-deep*");
17208 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
17212 /* A string: output it and check for %-constructs within it. */
17216 if (SCHARS (elt
) > 0
17217 && (!NILP (props
) || risky
))
17219 Lisp_Object oprops
, aelt
;
17220 oprops
= Ftext_properties_at (make_number (0), elt
);
17222 /* If the starting string's properties are not what
17223 we want, translate the string. Also, if the string
17224 is risky, do that anyway. */
17226 if (NILP (Fequal (props
, oprops
)) || risky
)
17228 /* If the starting string has properties,
17229 merge the specified ones onto the existing ones. */
17230 if (! NILP (oprops
) && !risky
)
17234 oprops
= Fcopy_sequence (oprops
);
17236 while (CONSP (tem
))
17238 oprops
= Fplist_put (oprops
, XCAR (tem
),
17239 XCAR (XCDR (tem
)));
17240 tem
= XCDR (XCDR (tem
));
17245 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
17246 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
17248 /* AELT is what we want. Move it to the front
17249 without consing. */
17251 mode_line_proptrans_alist
17252 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
17258 /* If AELT has the wrong props, it is useless.
17259 so get rid of it. */
17261 mode_line_proptrans_alist
17262 = Fdelq (aelt
, mode_line_proptrans_alist
);
17264 elt
= Fcopy_sequence (elt
);
17265 Fset_text_properties (make_number (0), Flength (elt
),
17267 /* Add this item to mode_line_proptrans_alist. */
17268 mode_line_proptrans_alist
17269 = Fcons (Fcons (elt
, props
),
17270 mode_line_proptrans_alist
);
17271 /* Truncate mode_line_proptrans_alist
17272 to at most 50 elements. */
17273 tem
= Fnthcdr (make_number (50),
17274 mode_line_proptrans_alist
);
17276 XSETCDR (tem
, Qnil
);
17285 prec
= precision
- n
;
17286 switch (mode_line_target
)
17288 case MODE_LINE_NOPROP
:
17289 case MODE_LINE_TITLE
:
17290 n
+= store_mode_line_noprop (SDATA (elt
), -1, prec
);
17292 case MODE_LINE_STRING
:
17293 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
17295 case MODE_LINE_DISPLAY
:
17296 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
17297 0, prec
, 0, STRING_MULTIBYTE (elt
));
17304 /* Handle the non-literal case. */
17306 while ((precision
<= 0 || n
< precision
)
17307 && SREF (elt
, offset
) != 0
17308 && (mode_line_target
!= MODE_LINE_DISPLAY
17309 || it
->current_x
< it
->last_visible_x
))
17311 int last_offset
= offset
;
17313 /* Advance to end of string or next format specifier. */
17314 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
17317 if (offset
- 1 != last_offset
)
17319 int nchars
, nbytes
;
17321 /* Output to end of string or up to '%'. Field width
17322 is length of string. Don't output more than
17323 PRECISION allows us. */
17326 prec
= c_string_width (SDATA (elt
) + last_offset
,
17327 offset
- last_offset
, precision
- n
,
17330 switch (mode_line_target
)
17332 case MODE_LINE_NOPROP
:
17333 case MODE_LINE_TITLE
:
17334 n
+= store_mode_line_noprop (SDATA (elt
) + last_offset
, 0, prec
);
17336 case MODE_LINE_STRING
:
17338 int bytepos
= last_offset
;
17339 int charpos
= string_byte_to_char (elt
, bytepos
);
17340 int endpos
= (precision
<= 0
17341 ? string_byte_to_char (elt
, offset
)
17342 : charpos
+ nchars
);
17344 n
+= store_mode_line_string (NULL
,
17345 Fsubstring (elt
, make_number (charpos
),
17346 make_number (endpos
)),
17350 case MODE_LINE_DISPLAY
:
17352 int bytepos
= last_offset
;
17353 int charpos
= string_byte_to_char (elt
, bytepos
);
17355 if (precision
<= 0)
17356 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
17357 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
17359 STRING_MULTIBYTE (elt
));
17364 else /* c == '%' */
17366 int percent_position
= offset
;
17368 /* Get the specified minimum width. Zero means
17371 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
17372 field
= field
* 10 + c
- '0';
17374 /* Don't pad beyond the total padding allowed. */
17375 if (field_width
- n
> 0 && field
> field_width
- n
)
17376 field
= field_width
- n
;
17378 /* Note that either PRECISION <= 0 or N < PRECISION. */
17379 prec
= precision
- n
;
17382 n
+= display_mode_element (it
, depth
, field
, prec
,
17383 Vglobal_mode_string
, props
,
17388 int bytepos
, charpos
;
17389 unsigned char *spec
;
17391 bytepos
= percent_position
;
17392 charpos
= (STRING_MULTIBYTE (elt
)
17393 ? string_byte_to_char (elt
, bytepos
)
17396 = decode_mode_spec (it
->w
, c
, field
, prec
, &multibyte
);
17398 switch (mode_line_target
)
17400 case MODE_LINE_NOPROP
:
17401 case MODE_LINE_TITLE
:
17402 n
+= store_mode_line_noprop (spec
, field
, prec
);
17404 case MODE_LINE_STRING
:
17406 int len
= strlen (spec
);
17407 Lisp_Object tem
= make_string (spec
, len
);
17408 props
= Ftext_properties_at (make_number (charpos
), elt
);
17409 /* Should only keep face property in props */
17410 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
17413 case MODE_LINE_DISPLAY
:
17415 int nglyphs_before
, nwritten
;
17417 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
17418 nwritten
= display_string (spec
, Qnil
, elt
,
17423 /* Assign to the glyphs written above the
17424 string where the `%x' came from, position
17428 struct glyph
*glyph
17429 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
17433 for (i
= 0; i
< nwritten
; ++i
)
17435 glyph
[i
].object
= elt
;
17436 glyph
[i
].charpos
= charpos
;
17453 /* A symbol: process the value of the symbol recursively
17454 as if it appeared here directly. Avoid error if symbol void.
17455 Special case: if value of symbol is a string, output the string
17458 register Lisp_Object tem
;
17460 /* If the variable is not marked as risky to set
17461 then its contents are risky to use. */
17462 if (NILP (Fget (elt
, Qrisky_local_variable
)))
17465 tem
= Fboundp (elt
);
17468 tem
= Fsymbol_value (elt
);
17469 /* If value is a string, output that string literally:
17470 don't check for % within it. */
17474 if (!EQ (tem
, elt
))
17476 /* Give up right away for nil or t. */
17486 register Lisp_Object car
, tem
;
17488 /* A cons cell: five distinct cases.
17489 If first element is :eval or :propertize, do something special.
17490 If first element is a string or a cons, process all the elements
17491 and effectively concatenate them.
17492 If first element is a negative number, truncate displaying cdr to
17493 at most that many characters. If positive, pad (with spaces)
17494 to at least that many characters.
17495 If first element is a symbol, process the cadr or caddr recursively
17496 according to whether the symbol's value is non-nil or nil. */
17498 if (EQ (car
, QCeval
))
17500 /* An element of the form (:eval FORM) means evaluate FORM
17501 and use the result as mode line elements. */
17506 if (CONSP (XCDR (elt
)))
17509 spec
= safe_eval (XCAR (XCDR (elt
)));
17510 n
+= display_mode_element (it
, depth
, field_width
- n
,
17511 precision
- n
, spec
, props
,
17515 else if (EQ (car
, QCpropertize
))
17517 /* An element of the form (:propertize ELT PROPS...)
17518 means display ELT but applying properties PROPS. */
17523 if (CONSP (XCDR (elt
)))
17524 n
+= display_mode_element (it
, depth
, field_width
- n
,
17525 precision
- n
, XCAR (XCDR (elt
)),
17526 XCDR (XCDR (elt
)), risky
);
17528 else if (SYMBOLP (car
))
17530 tem
= Fboundp (car
);
17534 /* elt is now the cdr, and we know it is a cons cell.
17535 Use its car if CAR has a non-nil value. */
17538 tem
= Fsymbol_value (car
);
17545 /* Symbol's value is nil (or symbol is unbound)
17546 Get the cddr of the original list
17547 and if possible find the caddr and use that. */
17551 else if (!CONSP (elt
))
17556 else if (INTEGERP (car
))
17558 register int lim
= XINT (car
);
17562 /* Negative int means reduce maximum width. */
17563 if (precision
<= 0)
17566 precision
= min (precision
, -lim
);
17570 /* Padding specified. Don't let it be more than
17571 current maximum. */
17573 lim
= min (precision
, lim
);
17575 /* If that's more padding than already wanted, queue it.
17576 But don't reduce padding already specified even if
17577 that is beyond the current truncation point. */
17578 field_width
= max (lim
, field_width
);
17582 else if (STRINGP (car
) || CONSP (car
))
17584 register int limit
= 50;
17585 /* Limit is to protect against circular lists. */
17588 && (precision
<= 0 || n
< precision
))
17590 n
+= display_mode_element (it
, depth
,
17591 /* Do padding only after the last
17592 element in the list. */
17593 (! CONSP (XCDR (elt
))
17596 precision
- n
, XCAR (elt
),
17606 elt
= build_string ("*invalid*");
17610 /* Pad to FIELD_WIDTH. */
17611 if (field_width
> 0 && n
< field_width
)
17613 switch (mode_line_target
)
17615 case MODE_LINE_NOPROP
:
17616 case MODE_LINE_TITLE
:
17617 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
17619 case MODE_LINE_STRING
:
17620 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
17622 case MODE_LINE_DISPLAY
:
17623 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
17632 /* Store a mode-line string element in mode_line_string_list.
17634 If STRING is non-null, display that C string. Otherwise, the Lisp
17635 string LISP_STRING is displayed.
17637 FIELD_WIDTH is the minimum number of output glyphs to produce.
17638 If STRING has fewer characters than FIELD_WIDTH, pad to the right
17639 with spaces. FIELD_WIDTH <= 0 means don't pad.
17641 PRECISION is the maximum number of characters to output from
17642 STRING. PRECISION <= 0 means don't truncate the string.
17644 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
17645 properties to the string.
17647 PROPS are the properties to add to the string.
17648 The mode_line_string_face face property is always added to the string.
17652 store_mode_line_string (string
, lisp_string
, copy_string
, field_width
, precision
, props
)
17654 Lisp_Object lisp_string
;
17663 if (string
!= NULL
)
17665 len
= strlen (string
);
17666 if (precision
> 0 && len
> precision
)
17668 lisp_string
= make_string (string
, len
);
17670 props
= mode_line_string_face_prop
;
17671 else if (!NILP (mode_line_string_face
))
17673 Lisp_Object face
= Fplist_get (props
, Qface
);
17674 props
= Fcopy_sequence (props
);
17676 face
= mode_line_string_face
;
17678 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
17679 props
= Fplist_put (props
, Qface
, face
);
17681 Fadd_text_properties (make_number (0), make_number (len
),
17682 props
, lisp_string
);
17686 len
= XFASTINT (Flength (lisp_string
));
17687 if (precision
> 0 && len
> precision
)
17690 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
17693 if (!NILP (mode_line_string_face
))
17697 props
= Ftext_properties_at (make_number (0), lisp_string
);
17698 face
= Fplist_get (props
, Qface
);
17700 face
= mode_line_string_face
;
17702 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
17703 props
= Fcons (Qface
, Fcons (face
, Qnil
));
17705 lisp_string
= Fcopy_sequence (lisp_string
);
17708 Fadd_text_properties (make_number (0), make_number (len
),
17709 props
, lisp_string
);
17714 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
17718 if (field_width
> len
)
17720 field_width
-= len
;
17721 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
17723 Fadd_text_properties (make_number (0), make_number (field_width
),
17724 props
, lisp_string
);
17725 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
17733 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
17735 doc
: /* Format a string out of a mode line format specification.
17736 First arg FORMAT specifies the mode line format (see `mode-line-format'
17737 for details) to use.
17739 Optional second arg FACE specifies the face property to put
17740 on all characters for which no face is specified.
17741 The value t means whatever face the window's mode line currently uses
17742 \(either `mode-line' or `mode-line-inactive', depending).
17743 A value of nil means the default is no face property.
17744 If FACE is an integer, the value string has no text properties.
17746 Optional third and fourth args WINDOW and BUFFER specify the window
17747 and buffer to use as the context for the formatting (defaults
17748 are the selected window and the window's buffer). */)
17749 (format
, face
, window
, buffer
)
17750 Lisp_Object format
, face
, window
, buffer
;
17755 struct buffer
*old_buffer
= NULL
;
17757 int no_props
= INTEGERP (face
);
17758 int count
= SPECPDL_INDEX ();
17760 int string_start
= 0;
17763 window
= selected_window
;
17764 CHECK_WINDOW (window
);
17765 w
= XWINDOW (window
);
17768 buffer
= w
->buffer
;
17769 CHECK_BUFFER (buffer
);
17771 /* Make formatting the modeline a non-op when noninteractive, otherwise
17772 there will be problems later caused by a partially initialized frame. */
17773 if (NILP (format
) || noninteractive
)
17774 return empty_unibyte_string
;
17782 face
= (EQ (window
, selected_window
) ? Qmode_line
: Qmode_line_inactive
);
17783 face_id
= lookup_named_face (XFRAME (WINDOW_FRAME (w
)), face
, 0);
17787 face_id
= DEFAULT_FACE_ID
;
17789 if (XBUFFER (buffer
) != current_buffer
)
17790 old_buffer
= current_buffer
;
17792 /* Save things including mode_line_proptrans_alist,
17793 and set that to nil so that we don't alter the outer value. */
17794 record_unwind_protect (unwind_format_mode_line
,
17795 format_mode_line_unwind_data
17796 (old_buffer
, selected_window
, 1));
17797 mode_line_proptrans_alist
= Qnil
;
17799 Fselect_window (window
, Qt
);
17801 set_buffer_internal_1 (XBUFFER (buffer
));
17803 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
17807 mode_line_target
= MODE_LINE_NOPROP
;
17808 mode_line_string_face_prop
= Qnil
;
17809 mode_line_string_list
= Qnil
;
17810 string_start
= MODE_LINE_NOPROP_LEN (0);
17814 mode_line_target
= MODE_LINE_STRING
;
17815 mode_line_string_list
= Qnil
;
17816 mode_line_string_face
= face
;
17817 mode_line_string_face_prop
17818 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
17821 push_kboard (FRAME_KBOARD (it
.f
));
17822 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
17827 len
= MODE_LINE_NOPROP_LEN (string_start
);
17828 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
17832 mode_line_string_list
= Fnreverse (mode_line_string_list
);
17833 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
17834 empty_unibyte_string
);
17837 unbind_to (count
, Qnil
);
17841 /* Write a null-terminated, right justified decimal representation of
17842 the positive integer D to BUF using a minimal field width WIDTH. */
17845 pint2str (buf
, width
, d
)
17846 register char *buf
;
17847 register int width
;
17850 register char *p
= buf
;
17858 *p
++ = d
% 10 + '0';
17863 for (width
-= (int) (p
- buf
); width
> 0; --width
)
17874 /* Write a null-terminated, right justified decimal and "human
17875 readable" representation of the nonnegative integer D to BUF using
17876 a minimal field width WIDTH. D should be smaller than 999.5e24. */
17878 static const char power_letter
[] =
17892 pint2hrstr (buf
, width
, d
)
17897 /* We aim to represent the nonnegative integer D as
17898 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
17901 /* -1 means: do not use TENTHS. */
17905 /* Length of QUOTIENT.TENTHS as a string. */
17911 if (1000 <= quotient
)
17913 /* Scale to the appropriate EXPONENT. */
17916 remainder
= quotient
% 1000;
17920 while (1000 <= quotient
);
17922 /* Round to nearest and decide whether to use TENTHS or not. */
17925 tenths
= remainder
/ 100;
17926 if (50 <= remainder
% 100)
17933 if (quotient
== 10)
17941 if (500 <= remainder
)
17943 if (quotient
< 999)
17954 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
17955 if (tenths
== -1 && quotient
<= 99)
17962 p
= psuffix
= buf
+ max (width
, length
);
17964 /* Print EXPONENT. */
17966 *psuffix
++ = power_letter
[exponent
];
17969 /* Print TENTHS. */
17972 *--p
= '0' + tenths
;
17976 /* Print QUOTIENT. */
17979 int digit
= quotient
% 10;
17980 *--p
= '0' + digit
;
17982 while ((quotient
/= 10) != 0);
17984 /* Print leading spaces. */
17989 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
17990 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
17991 type of CODING_SYSTEM. Return updated pointer into BUF. */
17993 static unsigned char invalid_eol_type
[] = "(*invalid*)";
17996 decode_mode_spec_coding (coding_system
, buf
, eol_flag
)
17997 Lisp_Object coding_system
;
17998 register char *buf
;
18002 int multibyte
= !NILP (current_buffer
->enable_multibyte_characters
);
18003 const unsigned char *eol_str
;
18005 /* The EOL conversion we are using. */
18006 Lisp_Object eoltype
;
18008 val
= CODING_SYSTEM_SPEC (coding_system
);
18011 if (!VECTORP (val
)) /* Not yet decided. */
18016 eoltype
= eol_mnemonic_undecided
;
18017 /* Don't mention EOL conversion if it isn't decided. */
18022 Lisp_Object eolvalue
;
18024 attrs
= AREF (val
, 0);
18025 eolvalue
= AREF (val
, 2);
18028 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
18032 /* The EOL conversion that is normal on this system. */
18034 if (NILP (eolvalue
)) /* Not yet decided. */
18035 eoltype
= eol_mnemonic_undecided
;
18036 else if (VECTORP (eolvalue
)) /* Not yet decided. */
18037 eoltype
= eol_mnemonic_undecided
;
18038 else /* eolvalue is Qunix, Qdos, or Qmac. */
18039 eoltype
= (EQ (eolvalue
, Qunix
)
18040 ? eol_mnemonic_unix
18041 : (EQ (eolvalue
, Qdos
) == 1
18042 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
18048 /* Mention the EOL conversion if it is not the usual one. */
18049 if (STRINGP (eoltype
))
18051 eol_str
= SDATA (eoltype
);
18052 eol_str_len
= SBYTES (eoltype
);
18054 else if (CHARACTERP (eoltype
))
18056 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
18057 eol_str_len
= CHAR_STRING (XINT (eoltype
), tmp
);
18062 eol_str
= invalid_eol_type
;
18063 eol_str_len
= sizeof (invalid_eol_type
) - 1;
18065 bcopy (eol_str
, buf
, eol_str_len
);
18066 buf
+= eol_str_len
;
18072 /* Return a string for the output of a mode line %-spec for window W,
18073 generated by character C. PRECISION >= 0 means don't return a
18074 string longer than that value. FIELD_WIDTH > 0 means pad the
18075 string returned with spaces to that value. Return 1 in *MULTIBYTE
18076 if the result is multibyte text.
18078 Note we operate on the current buffer for most purposes,
18079 the exception being w->base_line_pos. */
18081 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
18084 decode_mode_spec (w
, c
, field_width
, precision
, multibyte
)
18087 int field_width
, precision
;
18091 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18092 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
18093 struct buffer
*b
= current_buffer
;
18101 if (!NILP (b
->read_only
))
18103 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
18108 /* This differs from %* only for a modified read-only buffer. */
18109 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
18111 if (!NILP (b
->read_only
))
18116 /* This differs from %* in ignoring read-only-ness. */
18117 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
18129 if (command_loop_level
> 5)
18131 p
= decode_mode_spec_buf
;
18132 for (i
= 0; i
< command_loop_level
; i
++)
18135 return decode_mode_spec_buf
;
18143 if (command_loop_level
> 5)
18145 p
= decode_mode_spec_buf
;
18146 for (i
= 0; i
< command_loop_level
; i
++)
18149 return decode_mode_spec_buf
;
18156 /* Let lots_of_dashes be a string of infinite length. */
18157 if (mode_line_target
== MODE_LINE_NOPROP
||
18158 mode_line_target
== MODE_LINE_STRING
)
18160 if (field_width
<= 0
18161 || field_width
> sizeof (lots_of_dashes
))
18163 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
18164 decode_mode_spec_buf
[i
] = '-';
18165 decode_mode_spec_buf
[i
] = '\0';
18166 return decode_mode_spec_buf
;
18169 return lots_of_dashes
;
18177 /* %c and %l are ignored in `frame-title-format'.
18178 (In redisplay_internal, the frame title is drawn _before_ the
18179 windows are updated, so the stuff which depends on actual
18180 window contents (such as %l) may fail to render properly, or
18181 even crash emacs.) */
18182 if (mode_line_target
== MODE_LINE_TITLE
)
18186 int col
= (int) current_column (); /* iftc */
18187 w
->column_number_displayed
= make_number (col
);
18188 pint2str (decode_mode_spec_buf
, field_width
, col
);
18189 return decode_mode_spec_buf
;
18193 #ifndef SYSTEM_MALLOC
18195 if (NILP (Vmemory_full
))
18198 return "!MEM FULL! ";
18205 /* %F displays the frame name. */
18206 if (!NILP (f
->title
))
18207 return (char *) SDATA (f
->title
);
18208 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
18209 return (char *) SDATA (f
->name
);
18218 int size
= ZV
- BEGV
;
18219 pint2str (decode_mode_spec_buf
, field_width
, size
);
18220 return decode_mode_spec_buf
;
18225 int size
= ZV
- BEGV
;
18226 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
18227 return decode_mode_spec_buf
;
18232 int startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
18233 int topline
, nlines
, junk
, height
;
18235 /* %c and %l are ignored in `frame-title-format'. */
18236 if (mode_line_target
== MODE_LINE_TITLE
)
18239 startpos
= XMARKER (w
->start
)->charpos
;
18240 startpos_byte
= marker_byte_position (w
->start
);
18241 height
= WINDOW_TOTAL_LINES (w
);
18243 /* If we decided that this buffer isn't suitable for line numbers,
18244 don't forget that too fast. */
18245 if (EQ (w
->base_line_pos
, w
->buffer
))
18247 /* But do forget it, if the window shows a different buffer now. */
18248 else if (BUFFERP (w
->base_line_pos
))
18249 w
->base_line_pos
= Qnil
;
18251 /* If the buffer is very big, don't waste time. */
18252 if (INTEGERP (Vline_number_display_limit
)
18253 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
18255 w
->base_line_pos
= Qnil
;
18256 w
->base_line_number
= Qnil
;
18260 if (INTEGERP (w
->base_line_number
)
18261 && INTEGERP (w
->base_line_pos
)
18262 && XFASTINT (w
->base_line_pos
) <= startpos
)
18264 line
= XFASTINT (w
->base_line_number
);
18265 linepos
= XFASTINT (w
->base_line_pos
);
18266 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
18271 linepos
= BUF_BEGV (b
);
18272 linepos_byte
= BUF_BEGV_BYTE (b
);
18275 /* Count lines from base line to window start position. */
18276 nlines
= display_count_lines (linepos
, linepos_byte
,
18280 topline
= nlines
+ line
;
18282 /* Determine a new base line, if the old one is too close
18283 or too far away, or if we did not have one.
18284 "Too close" means it's plausible a scroll-down would
18285 go back past it. */
18286 if (startpos
== BUF_BEGV (b
))
18288 w
->base_line_number
= make_number (topline
);
18289 w
->base_line_pos
= make_number (BUF_BEGV (b
));
18291 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
18292 || linepos
== BUF_BEGV (b
))
18294 int limit
= BUF_BEGV (b
);
18295 int limit_byte
= BUF_BEGV_BYTE (b
);
18297 int distance
= (height
* 2 + 30) * line_number_display_limit_width
;
18299 if (startpos
- distance
> limit
)
18301 limit
= startpos
- distance
;
18302 limit_byte
= CHAR_TO_BYTE (limit
);
18305 nlines
= display_count_lines (startpos
, startpos_byte
,
18307 - (height
* 2 + 30),
18309 /* If we couldn't find the lines we wanted within
18310 line_number_display_limit_width chars per line,
18311 give up on line numbers for this window. */
18312 if (position
== limit_byte
&& limit
== startpos
- distance
)
18314 w
->base_line_pos
= w
->buffer
;
18315 w
->base_line_number
= Qnil
;
18319 w
->base_line_number
= make_number (topline
- nlines
);
18320 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
18323 /* Now count lines from the start pos to point. */
18324 nlines
= display_count_lines (startpos
, startpos_byte
,
18325 PT_BYTE
, PT
, &junk
);
18327 /* Record that we did display the line number. */
18328 line_number_displayed
= 1;
18330 /* Make the string to show. */
18331 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
18332 return decode_mode_spec_buf
;
18335 char* p
= decode_mode_spec_buf
;
18336 int pad
= field_width
- 2;
18342 return decode_mode_spec_buf
;
18348 obj
= b
->mode_name
;
18352 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
18358 int pos
= marker_position (w
->start
);
18359 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
18361 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
18363 if (pos
<= BUF_BEGV (b
))
18368 else if (pos
<= BUF_BEGV (b
))
18372 if (total
> 1000000)
18373 /* Do it differently for a large value, to avoid overflow. */
18374 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
18376 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
18377 /* We can't normally display a 3-digit number,
18378 so get us a 2-digit number that is close. */
18381 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
18382 return decode_mode_spec_buf
;
18386 /* Display percentage of size above the bottom of the screen. */
18389 int toppos
= marker_position (w
->start
);
18390 int botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
18391 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
18393 if (botpos
>= BUF_ZV (b
))
18395 if (toppos
<= BUF_BEGV (b
))
18402 if (total
> 1000000)
18403 /* Do it differently for a large value, to avoid overflow. */
18404 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
18406 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
18407 /* We can't normally display a 3-digit number,
18408 so get us a 2-digit number that is close. */
18411 if (toppos
<= BUF_BEGV (b
))
18412 sprintf (decode_mode_spec_buf
, "Top%2d%%", total
);
18414 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
18415 return decode_mode_spec_buf
;
18420 /* status of process */
18421 obj
= Fget_buffer_process (Fcurrent_buffer ());
18423 return "no process";
18424 #ifdef subprocesses
18425 obj
= Fsymbol_name (Fprocess_status (obj
));
18432 val
= call1 (intern ("file-remote-p"), current_buffer
->directory
);
18439 case 't': /* indicate TEXT or BINARY */
18440 #ifdef MODE_LINE_BINARY_TEXT
18441 return MODE_LINE_BINARY_TEXT (b
);
18447 /* coding-system (not including end-of-line format) */
18449 /* coding-system (including end-of-line type) */
18451 int eol_flag
= (c
== 'Z');
18452 char *p
= decode_mode_spec_buf
;
18454 if (! FRAME_WINDOW_P (f
))
18456 /* No need to mention EOL here--the terminal never needs
18457 to do EOL conversion. */
18458 p
= decode_mode_spec_coding (CODING_ID_NAME
18459 (FRAME_KEYBOARD_CODING (f
)->id
),
18461 p
= decode_mode_spec_coding (CODING_ID_NAME
18462 (FRAME_TERMINAL_CODING (f
)->id
),
18465 p
= decode_mode_spec_coding (b
->buffer_file_coding_system
,
18468 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
18469 #ifdef subprocesses
18470 obj
= Fget_buffer_process (Fcurrent_buffer ());
18471 if (PROCESSP (obj
))
18473 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
18475 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
18478 #endif /* subprocesses */
18481 return decode_mode_spec_buf
;
18487 *multibyte
= STRING_MULTIBYTE (obj
);
18488 return (char *) SDATA (obj
);
18495 /* Count up to COUNT lines starting from START / START_BYTE.
18496 But don't go beyond LIMIT_BYTE.
18497 Return the number of lines thus found (always nonnegative).
18499 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
18502 display_count_lines (start
, start_byte
, limit_byte
, count
, byte_pos_ptr
)
18503 int start
, start_byte
, limit_byte
, count
;
18506 register unsigned char *cursor
;
18507 unsigned char *base
;
18509 register int ceiling
;
18510 register unsigned char *ceiling_addr
;
18511 int orig_count
= count
;
18513 /* If we are not in selective display mode,
18514 check only for newlines. */
18515 int selective_display
= (!NILP (current_buffer
->selective_display
)
18516 && !INTEGERP (current_buffer
->selective_display
));
18520 while (start_byte
< limit_byte
)
18522 ceiling
= BUFFER_CEILING_OF (start_byte
);
18523 ceiling
= min (limit_byte
- 1, ceiling
);
18524 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
18525 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
18528 if (selective_display
)
18529 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
18532 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
18535 if (cursor
!= ceiling_addr
)
18539 start_byte
+= cursor
- base
+ 1;
18540 *byte_pos_ptr
= start_byte
;
18544 if (++cursor
== ceiling_addr
)
18550 start_byte
+= cursor
- base
;
18555 while (start_byte
> limit_byte
)
18557 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
18558 ceiling
= max (limit_byte
, ceiling
);
18559 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
18560 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
18563 if (selective_display
)
18564 while (--cursor
!= ceiling_addr
18565 && *cursor
!= '\n' && *cursor
!= 015)
18568 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
18571 if (cursor
!= ceiling_addr
)
18575 start_byte
+= cursor
- base
+ 1;
18576 *byte_pos_ptr
= start_byte
;
18577 /* When scanning backwards, we should
18578 not count the newline posterior to which we stop. */
18579 return - orig_count
- 1;
18585 /* Here we add 1 to compensate for the last decrement
18586 of CURSOR, which took it past the valid range. */
18587 start_byte
+= cursor
- base
+ 1;
18591 *byte_pos_ptr
= limit_byte
;
18594 return - orig_count
+ count
;
18595 return orig_count
- count
;
18601 /***********************************************************************
18603 ***********************************************************************/
18605 /* Display a NUL-terminated string, starting with index START.
18607 If STRING is non-null, display that C string. Otherwise, the Lisp
18608 string LISP_STRING is displayed.
18610 If FACE_STRING is not nil, FACE_STRING_POS is a position in
18611 FACE_STRING. Display STRING or LISP_STRING with the face at
18612 FACE_STRING_POS in FACE_STRING:
18614 Display the string in the environment given by IT, but use the
18615 standard display table, temporarily.
18617 FIELD_WIDTH is the minimum number of output glyphs to produce.
18618 If STRING has fewer characters than FIELD_WIDTH, pad to the right
18619 with spaces. If STRING has more characters, more than FIELD_WIDTH
18620 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
18622 PRECISION is the maximum number of characters to output from
18623 STRING. PRECISION < 0 means don't truncate the string.
18625 This is roughly equivalent to printf format specifiers:
18627 FIELD_WIDTH PRECISION PRINTF
18628 ----------------------------------------
18634 MULTIBYTE zero means do not display multibyte chars, > 0 means do
18635 display them, and < 0 means obey the current buffer's value of
18636 enable_multibyte_characters.
18638 Value is the number of columns displayed. */
18641 display_string (string
, lisp_string
, face_string
, face_string_pos
,
18642 start
, it
, field_width
, precision
, max_x
, multibyte
)
18643 unsigned char *string
;
18644 Lisp_Object lisp_string
;
18645 Lisp_Object face_string
;
18646 EMACS_INT face_string_pos
;
18649 int field_width
, precision
, max_x
;
18652 int hpos_at_start
= it
->hpos
;
18653 int saved_face_id
= it
->face_id
;
18654 struct glyph_row
*row
= it
->glyph_row
;
18656 /* Initialize the iterator IT for iteration over STRING beginning
18657 with index START. */
18658 reseat_to_string (it
, string
, lisp_string
, start
,
18659 precision
, field_width
, multibyte
);
18661 /* If displaying STRING, set up the face of the iterator
18662 from LISP_STRING, if that's given. */
18663 if (STRINGP (face_string
))
18669 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
18670 0, it
->region_beg_charpos
,
18671 it
->region_end_charpos
,
18672 &endptr
, it
->base_face_id
, 0);
18673 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18674 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
18677 /* Set max_x to the maximum allowed X position. Don't let it go
18678 beyond the right edge of the window. */
18680 max_x
= it
->last_visible_x
;
18682 max_x
= min (max_x
, it
->last_visible_x
);
18684 /* Skip over display elements that are not visible. because IT->w is
18686 if (it
->current_x
< it
->first_visible_x
)
18687 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
18688 MOVE_TO_POS
| MOVE_TO_X
);
18690 row
->ascent
= it
->max_ascent
;
18691 row
->height
= it
->max_ascent
+ it
->max_descent
;
18692 row
->phys_ascent
= it
->max_phys_ascent
;
18693 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18694 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18696 /* This condition is for the case that we are called with current_x
18697 past last_visible_x. */
18698 while (it
->current_x
< max_x
)
18700 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
18702 /* Get the next display element. */
18703 if (!get_next_display_element (it
))
18706 /* Produce glyphs. */
18707 x_before
= it
->current_x
;
18708 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
18709 PRODUCE_GLYPHS (it
);
18711 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
18714 while (i
< nglyphs
)
18716 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
18718 if (it
->line_wrap
!= TRUNCATE
18719 && x
+ glyph
->pixel_width
> max_x
)
18721 /* End of continued line or max_x reached. */
18722 if (CHAR_GLYPH_PADDING_P (*glyph
))
18724 /* A wide character is unbreakable. */
18725 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18726 it
->current_x
= x_before
;
18730 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
18735 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
18737 /* Glyph is at least partially visible. */
18739 if (x
< it
->first_visible_x
)
18740 it
->glyph_row
->x
= x
- it
->first_visible_x
;
18744 /* Glyph is off the left margin of the display area.
18745 Should not happen. */
18749 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18750 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18751 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18752 row
->phys_height
= max (row
->phys_height
,
18753 it
->max_phys_ascent
+ it
->max_phys_descent
);
18754 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18755 it
->max_extra_line_spacing
);
18756 x
+= glyph
->pixel_width
;
18760 /* Stop if max_x reached. */
18764 /* Stop at line ends. */
18765 if (ITERATOR_AT_END_OF_LINE_P (it
))
18767 it
->continuation_lines_width
= 0;
18771 set_iterator_to_next (it
, 1);
18773 /* Stop if truncating at the right edge. */
18774 if (it
->line_wrap
== TRUNCATE
18775 && it
->current_x
>= it
->last_visible_x
)
18777 /* Add truncation mark, but don't do it if the line is
18778 truncated at a padding space. */
18779 if (IT_CHARPOS (*it
) < it
->string_nchars
)
18781 if (!FRAME_WINDOW_P (it
->f
))
18785 if (it
->current_x
> it
->last_visible_x
)
18787 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
18788 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
18790 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
18792 row
->used
[TEXT_AREA
] = i
;
18793 produce_special_glyphs (it
, IT_TRUNCATION
);
18796 produce_special_glyphs (it
, IT_TRUNCATION
);
18798 it
->glyph_row
->truncated_on_right_p
= 1;
18804 /* Maybe insert a truncation at the left. */
18805 if (it
->first_visible_x
18806 && IT_CHARPOS (*it
) > 0)
18808 if (!FRAME_WINDOW_P (it
->f
))
18809 insert_left_trunc_glyphs (it
);
18810 it
->glyph_row
->truncated_on_left_p
= 1;
18813 it
->face_id
= saved_face_id
;
18815 /* Value is number of columns displayed. */
18816 return it
->hpos
- hpos_at_start
;
18821 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
18822 appears as an element of LIST or as the car of an element of LIST.
18823 If PROPVAL is a list, compare each element against LIST in that
18824 way, and return 1/2 if any element of PROPVAL is found in LIST.
18825 Otherwise return 0. This function cannot quit.
18826 The return value is 2 if the text is invisible but with an ellipsis
18827 and 1 if it's invisible and without an ellipsis. */
18830 invisible_p (propval
, list
)
18831 register Lisp_Object propval
;
18834 register Lisp_Object tail
, proptail
;
18836 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
18838 register Lisp_Object tem
;
18840 if (EQ (propval
, tem
))
18842 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
18843 return NILP (XCDR (tem
)) ? 1 : 2;
18846 if (CONSP (propval
))
18848 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
18850 Lisp_Object propelt
;
18851 propelt
= XCAR (proptail
);
18852 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
18854 register Lisp_Object tem
;
18856 if (EQ (propelt
, tem
))
18858 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
18859 return NILP (XCDR (tem
)) ? 1 : 2;
18867 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
18868 doc
: /* Non-nil if the property makes the text invisible.
18869 POS-OR-PROP can be a marker or number, in which case it is taken to be
18870 a position in the current buffer and the value of the `invisible' property
18871 is checked; or it can be some other value, which is then presumed to be the
18872 value of the `invisible' property of the text of interest.
18873 The non-nil value returned can be t for truly invisible text or something
18874 else if the text is replaced by an ellipsis. */)
18876 Lisp_Object pos_or_prop
;
18879 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
18880 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
18882 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
18883 return (invis
== 0 ? Qnil
18885 : make_number (invis
));
18888 /* Calculate a width or height in pixels from a specification using
18889 the following elements:
18892 NUM - a (fractional) multiple of the default font width/height
18893 (NUM) - specifies exactly NUM pixels
18894 UNIT - a fixed number of pixels, see below.
18895 ELEMENT - size of a display element in pixels, see below.
18896 (NUM . SPEC) - equals NUM * SPEC
18897 (+ SPEC SPEC ...) - add pixel values
18898 (- SPEC SPEC ...) - subtract pixel values
18899 (- SPEC) - negate pixel value
18902 INT or FLOAT - a number constant
18903 SYMBOL - use symbol's (buffer local) variable binding.
18906 in - pixels per inch *)
18907 mm - pixels per 1/1000 meter *)
18908 cm - pixels per 1/100 meter *)
18909 width - width of current font in pixels.
18910 height - height of current font in pixels.
18912 *) using the ratio(s) defined in display-pixels-per-inch.
18916 left-fringe - left fringe width in pixels
18917 right-fringe - right fringe width in pixels
18919 left-margin - left margin width in pixels
18920 right-margin - right margin width in pixels
18922 scroll-bar - scroll-bar area width in pixels
18926 Pixels corresponding to 5 inches:
18929 Total width of non-text areas on left side of window (if scroll-bar is on left):
18930 '(space :width (+ left-fringe left-margin scroll-bar))
18932 Align to first text column (in header line):
18933 '(space :align-to 0)
18935 Align to middle of text area minus half the width of variable `my-image'
18936 containing a loaded image:
18937 '(space :align-to (0.5 . (- text my-image)))
18939 Width of left margin minus width of 1 character in the default font:
18940 '(space :width (- left-margin 1))
18942 Width of left margin minus width of 2 characters in the current font:
18943 '(space :width (- left-margin (2 . width)))
18945 Center 1 character over left-margin (in header line):
18946 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
18948 Different ways to express width of left fringe plus left margin minus one pixel:
18949 '(space :width (- (+ left-fringe left-margin) (1)))
18950 '(space :width (+ left-fringe left-margin (- (1))))
18951 '(space :width (+ left-fringe left-margin (-1)))
18955 #define NUMVAL(X) \
18956 ((INTEGERP (X) || FLOATP (X)) \
18961 calc_pixel_width_or_height (res
, it
, prop
, font
, width_p
, align_to
)
18966 int width_p
, *align_to
;
18970 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
18971 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
18974 return OK_PIXELS (0);
18976 xassert (FRAME_LIVE_P (it
->f
));
18978 if (SYMBOLP (prop
))
18980 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
18982 char *unit
= SDATA (SYMBOL_NAME (prop
));
18984 if (unit
[0] == 'i' && unit
[1] == 'n')
18986 else if (unit
[0] == 'm' && unit
[1] == 'm')
18988 else if (unit
[0] == 'c' && unit
[1] == 'm')
18995 #ifdef HAVE_WINDOW_SYSTEM
18996 if (FRAME_WINDOW_P (it
->f
)
18998 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
18999 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
19001 return OK_PIXELS (ppi
/ pixels
);
19004 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
19005 || (CONSP (Vdisplay_pixels_per_inch
)
19007 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
19008 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
19010 return OK_PIXELS (ppi
/ pixels
);
19016 #ifdef HAVE_WINDOW_SYSTEM
19017 if (EQ (prop
, Qheight
))
19018 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
19019 if (EQ (prop
, Qwidth
))
19020 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
19022 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
19023 return OK_PIXELS (1);
19026 if (EQ (prop
, Qtext
))
19027 return OK_PIXELS (width_p
19028 ? window_box_width (it
->w
, TEXT_AREA
)
19029 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
19031 if (align_to
&& *align_to
< 0)
19034 if (EQ (prop
, Qleft
))
19035 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
19036 if (EQ (prop
, Qright
))
19037 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
19038 if (EQ (prop
, Qcenter
))
19039 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
19040 + window_box_width (it
->w
, TEXT_AREA
) / 2);
19041 if (EQ (prop
, Qleft_fringe
))
19042 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
19043 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
19044 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
19045 if (EQ (prop
, Qright_fringe
))
19046 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
19047 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
19048 : window_box_right_offset (it
->w
, TEXT_AREA
));
19049 if (EQ (prop
, Qleft_margin
))
19050 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
19051 if (EQ (prop
, Qright_margin
))
19052 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
19053 if (EQ (prop
, Qscroll_bar
))
19054 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
19056 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
19057 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
19058 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
19063 if (EQ (prop
, Qleft_fringe
))
19064 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
19065 if (EQ (prop
, Qright_fringe
))
19066 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
19067 if (EQ (prop
, Qleft_margin
))
19068 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
19069 if (EQ (prop
, Qright_margin
))
19070 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
19071 if (EQ (prop
, Qscroll_bar
))
19072 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
19075 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
19078 if (INTEGERP (prop
) || FLOATP (prop
))
19080 int base_unit
= (width_p
19081 ? FRAME_COLUMN_WIDTH (it
->f
)
19082 : FRAME_LINE_HEIGHT (it
->f
));
19083 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
19088 Lisp_Object car
= XCAR (prop
);
19089 Lisp_Object cdr
= XCDR (prop
);
19093 #ifdef HAVE_WINDOW_SYSTEM
19094 if (FRAME_WINDOW_P (it
->f
)
19095 && valid_image_p (prop
))
19097 int id
= lookup_image (it
->f
, prop
);
19098 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
19100 return OK_PIXELS (width_p
? img
->width
: img
->height
);
19103 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
19109 while (CONSP (cdr
))
19111 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
19112 font
, width_p
, align_to
))
19115 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
19120 if (EQ (car
, Qminus
))
19122 return OK_PIXELS (pixels
);
19125 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
19128 if (INTEGERP (car
) || FLOATP (car
))
19131 pixels
= XFLOATINT (car
);
19133 return OK_PIXELS (pixels
);
19134 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
19135 font
, width_p
, align_to
))
19136 return OK_PIXELS (pixels
* fact
);
19147 /***********************************************************************
19149 ***********************************************************************/
19151 #ifdef HAVE_WINDOW_SYSTEM
19156 dump_glyph_string (s
)
19157 struct glyph_string
*s
;
19159 fprintf (stderr
, "glyph string\n");
19160 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
19161 s
->x
, s
->y
, s
->width
, s
->height
);
19162 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
19163 fprintf (stderr
, " hl = %d\n", s
->hl
);
19164 fprintf (stderr
, " left overhang = %d, right = %d\n",
19165 s
->left_overhang
, s
->right_overhang
);
19166 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
19167 fprintf (stderr
, " extends to end of line = %d\n",
19168 s
->extends_to_end_of_line_p
);
19169 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
19170 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
19173 #endif /* GLYPH_DEBUG */
19175 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
19176 of XChar2b structures for S; it can't be allocated in
19177 init_glyph_string because it must be allocated via `alloca'. W
19178 is the window on which S is drawn. ROW and AREA are the glyph row
19179 and area within the row from which S is constructed. START is the
19180 index of the first glyph structure covered by S. HL is a
19181 face-override for drawing S. */
19184 #define OPTIONAL_HDC(hdc) hdc,
19185 #define DECLARE_HDC(hdc) HDC hdc;
19186 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
19187 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
19190 #ifndef OPTIONAL_HDC
19191 #define OPTIONAL_HDC(hdc)
19192 #define DECLARE_HDC(hdc)
19193 #define ALLOCATE_HDC(hdc, f)
19194 #define RELEASE_HDC(hdc, f)
19198 init_glyph_string (s
, OPTIONAL_HDC (hdc
) char2b
, w
, row
, area
, start
, hl
)
19199 struct glyph_string
*s
;
19203 struct glyph_row
*row
;
19204 enum glyph_row_area area
;
19206 enum draw_glyphs_face hl
;
19208 bzero (s
, sizeof *s
);
19210 s
->f
= XFRAME (w
->frame
);
19214 s
->display
= FRAME_X_DISPLAY (s
->f
);
19215 s
->window
= FRAME_X_WINDOW (s
->f
);
19216 s
->char2b
= char2b
;
19220 s
->first_glyph
= row
->glyphs
[area
] + start
;
19221 s
->height
= row
->height
;
19222 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
19224 /* Display the internal border below the tool-bar window. */
19225 if (WINDOWP (s
->f
->tool_bar_window
)
19226 && s
->w
== XWINDOW (s
->f
->tool_bar_window
))
19227 s
->y
-= FRAME_INTERNAL_BORDER_WIDTH (s
->f
);
19229 s
->ybase
= s
->y
+ row
->ascent
;
19233 /* Append the list of glyph strings with head H and tail T to the list
19234 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
19237 append_glyph_string_lists (head
, tail
, h
, t
)
19238 struct glyph_string
**head
, **tail
;
19239 struct glyph_string
*h
, *t
;
19253 /* Prepend the list of glyph strings with head H and tail T to the
19254 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
19258 prepend_glyph_string_lists (head
, tail
, h
, t
)
19259 struct glyph_string
**head
, **tail
;
19260 struct glyph_string
*h
, *t
;
19274 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
19275 Set *HEAD and *TAIL to the resulting list. */
19278 append_glyph_string (head
, tail
, s
)
19279 struct glyph_string
**head
, **tail
;
19280 struct glyph_string
*s
;
19282 s
->next
= s
->prev
= NULL
;
19283 append_glyph_string_lists (head
, tail
, s
, s
);
19287 /* Get face and two-byte form of character C in face FACE_ID on frame
19288 F. The encoding of C is returned in *CHAR2B. MULTIBYTE_P non-zero
19289 means we want to display multibyte text. DISPLAY_P non-zero means
19290 make sure that X resources for the face returned are allocated.
19291 Value is a pointer to a realized face that is ready for display if
19292 DISPLAY_P is non-zero. */
19294 static INLINE
struct face
*
19295 get_char_face_and_encoding (f
, c
, face_id
, char2b
, multibyte_p
, display_p
)
19299 int multibyte_p
, display_p
;
19301 struct face
*face
= FACE_FROM_ID (f
, face_id
);
19305 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
19307 if (code
!= FONT_INVALID_CODE
)
19308 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
19310 STORE_XCHAR2B (char2b
, 0, 0);
19313 /* Make sure X resources of the face are allocated. */
19314 #ifdef HAVE_X_WINDOWS
19318 xassert (face
!= NULL
);
19319 PREPARE_FACE_FOR_DISPLAY (f
, face
);
19326 /* Get face and two-byte form of character glyph GLYPH on frame F.
19327 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
19328 a pointer to a realized face that is ready for display. */
19330 static INLINE
struct face
*
19331 get_glyph_face_and_encoding (f
, glyph
, char2b
, two_byte_p
)
19333 struct glyph
*glyph
;
19339 xassert (glyph
->type
== CHAR_GLYPH
);
19340 face
= FACE_FROM_ID (f
, glyph
->face_id
);
19347 unsigned code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
19349 if (code
!= FONT_INVALID_CODE
)
19350 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
19352 STORE_XCHAR2B (char2b
, 0, code
);
19355 /* Make sure X resources of the face are allocated. */
19356 xassert (face
!= NULL
);
19357 PREPARE_FACE_FOR_DISPLAY (f
, face
);
19362 /* Fill glyph string S with composition components specified by S->cmp.
19364 BASE_FACE is the base face of the composition.
19365 S->gidx is the index of the first component for S.
19367 OVERLAPS non-zero means S should draw the foreground only, and use
19368 its physical height for clipping. See also draw_glyphs.
19370 Value is the index of a component not in S. */
19373 fill_composite_glyph_string (s
, base_face
, overlaps
)
19374 struct glyph_string
*s
;
19375 struct face
*base_face
;
19382 s
->for_overlaps
= overlaps
;
19384 if (s
->cmp
->method
== COMPOSITION_WITH_GLYPH_STRING
)
19386 Lisp_Object gstring
19387 = AREF (XHASH_TABLE (composition_hash_table
)->key_and_value
,
19388 s
->cmp
->hash_index
* 2);
19390 s
->face
= base_face
;
19391 s
->font
= base_face
->font
;
19392 for (i
= 0, s
->nchars
= 0; i
< s
->cmp
->glyph_len
; i
++, s
->nchars
++)
19394 Lisp_Object g
= LGSTRING_GLYPH (gstring
, i
);
19396 XChar2b
* store_pos
;
19399 code
= LGLYPH_CODE (g
);
19400 store_pos
= s
->char2b
+ i
;
19401 STORE_XCHAR2B (store_pos
, code
>> 8, code
& 0xFF);
19403 s
->width
= s
->cmp
->pixel_width
;
19407 /* For all glyphs of this composition, starting at the offset
19408 S->gidx, until we reach the end of the definition or encounter a
19409 glyph that requires the different face, add it to S. */
19414 for (i
= s
->gidx
; i
< s
->cmp
->glyph_len
; i
++)
19416 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
19420 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
19423 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
19424 s
->char2b
+ i
, 1, 1);
19430 s
->font
= s
->face
->font
;
19432 else if (s
->face
!= face
)
19439 /* All glyph strings for the same composition has the same width,
19440 i.e. the width set for the first component of the composition. */
19441 s
->width
= s
->first_glyph
->pixel_width
;
19444 /* If the specified font could not be loaded, use the frame's
19445 default font, but record the fact that we couldn't load it in
19446 the glyph string so that we can draw rectangles for the
19447 characters of the glyph string. */
19448 if (s
->font
== NULL
)
19450 s
->font_not_found_p
= 1;
19451 s
->font
= FRAME_FONT (s
->f
);
19454 /* Adjust base line for subscript/superscript text. */
19455 s
->ybase
+= s
->first_glyph
->voffset
;
19457 /* This glyph string must always be drawn with 16-bit functions. */
19460 return s
->gidx
+ s
->nchars
;
19464 /* Fill glyph string S from a sequence of character glyphs.
19466 FACE_ID is the face id of the string. START is the index of the
19467 first glyph to consider, END is the index of the last + 1.
19468 OVERLAPS non-zero means S should draw the foreground only, and use
19469 its physical height for clipping. See also draw_glyphs.
19471 Value is the index of the first glyph not in S. */
19474 fill_glyph_string (s
, face_id
, start
, end
, overlaps
)
19475 struct glyph_string
*s
;
19477 int start
, end
, overlaps
;
19479 struct glyph
*glyph
, *last
;
19481 int glyph_not_available_p
;
19483 xassert (s
->f
== XFRAME (s
->w
->frame
));
19484 xassert (s
->nchars
== 0);
19485 xassert (start
>= 0 && end
> start
);
19487 s
->for_overlaps
= overlaps
,
19488 glyph
= s
->row
->glyphs
[s
->area
] + start
;
19489 last
= s
->row
->glyphs
[s
->area
] + end
;
19490 voffset
= glyph
->voffset
;
19491 s
->padding_p
= glyph
->padding_p
;
19492 glyph_not_available_p
= glyph
->glyph_not_available_p
;
19494 while (glyph
< last
19495 && glyph
->type
== CHAR_GLYPH
19496 && glyph
->voffset
== voffset
19497 /* Same face id implies same font, nowadays. */
19498 && glyph
->face_id
== face_id
19499 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
19503 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
19504 s
->char2b
+ s
->nchars
,
19506 s
->two_byte_p
= two_byte_p
;
19508 xassert (s
->nchars
<= end
- start
);
19509 s
->width
+= glyph
->pixel_width
;
19510 if (glyph
++->padding_p
!= s
->padding_p
)
19514 s
->font
= s
->face
->font
;
19516 /* If the specified font could not be loaded, use the frame's font,
19517 but record the fact that we couldn't load it in
19518 S->font_not_found_p so that we can draw rectangles for the
19519 characters of the glyph string. */
19520 if (s
->font
== NULL
|| glyph_not_available_p
)
19522 s
->font_not_found_p
= 1;
19523 s
->font
= FRAME_FONT (s
->f
);
19526 /* Adjust base line for subscript/superscript text. */
19527 s
->ybase
+= voffset
;
19529 xassert (s
->face
&& s
->face
->gc
);
19530 return glyph
- s
->row
->glyphs
[s
->area
];
19534 /* Fill glyph string S from image glyph S->first_glyph. */
19537 fill_image_glyph_string (s
)
19538 struct glyph_string
*s
;
19540 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
19541 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
19543 s
->slice
= s
->first_glyph
->slice
;
19544 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
19545 s
->font
= s
->face
->font
;
19546 s
->width
= s
->first_glyph
->pixel_width
;
19548 /* Adjust base line for subscript/superscript text. */
19549 s
->ybase
+= s
->first_glyph
->voffset
;
19553 /* Fill glyph string S from a sequence of stretch glyphs.
19555 ROW is the glyph row in which the glyphs are found, AREA is the
19556 area within the row. START is the index of the first glyph to
19557 consider, END is the index of the last + 1.
19559 Value is the index of the first glyph not in S. */
19562 fill_stretch_glyph_string (s
, row
, area
, start
, end
)
19563 struct glyph_string
*s
;
19564 struct glyph_row
*row
;
19565 enum glyph_row_area area
;
19568 struct glyph
*glyph
, *last
;
19569 int voffset
, face_id
;
19571 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
19573 glyph
= s
->row
->glyphs
[s
->area
] + start
;
19574 last
= s
->row
->glyphs
[s
->area
] + end
;
19575 face_id
= glyph
->face_id
;
19576 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
19577 s
->font
= s
->face
->font
;
19578 s
->width
= glyph
->pixel_width
;
19580 voffset
= glyph
->voffset
;
19584 && glyph
->type
== STRETCH_GLYPH
19585 && glyph
->voffset
== voffset
19586 && glyph
->face_id
== face_id
);
19588 s
->width
+= glyph
->pixel_width
;
19590 /* Adjust base line for subscript/superscript text. */
19591 s
->ybase
+= voffset
;
19593 /* The case that face->gc == 0 is handled when drawing the glyph
19594 string by calling PREPARE_FACE_FOR_DISPLAY. */
19596 return glyph
- s
->row
->glyphs
[s
->area
];
19599 static struct font_metrics
*
19600 get_per_char_metric (f
, font
, char2b
)
19605 static struct font_metrics metrics
;
19606 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
19607 struct font
*fontp
;
19609 if (! font
|| code
== FONT_INVALID_CODE
)
19611 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
19616 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
19617 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
19618 assumed to be zero. */
19621 x_get_glyph_overhangs (glyph
, f
, left
, right
)
19622 struct glyph
*glyph
;
19626 *left
= *right
= 0;
19628 if (glyph
->type
== CHAR_GLYPH
)
19632 struct font_metrics
*pcm
;
19634 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
19635 if (face
->font
&& (pcm
= get_per_char_metric (f
, face
->font
, &char2b
)))
19637 if (pcm
->rbearing
> pcm
->width
)
19638 *right
= pcm
->rbearing
- pcm
->width
;
19639 if (pcm
->lbearing
< 0)
19640 *left
= -pcm
->lbearing
;
19643 else if (glyph
->type
== COMPOSITE_GLYPH
)
19645 struct composition
*cmp
= composition_table
[glyph
->u
.cmp_id
];
19647 *right
= cmp
->rbearing
- cmp
->pixel_width
;
19648 *left
= - cmp
->lbearing
;
19653 /* Return the index of the first glyph preceding glyph string S that
19654 is overwritten by S because of S's left overhang. Value is -1
19655 if no glyphs are overwritten. */
19658 left_overwritten (s
)
19659 struct glyph_string
*s
;
19663 if (s
->left_overhang
)
19666 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19667 int first
= s
->first_glyph
- glyphs
;
19669 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
19670 x
-= glyphs
[i
].pixel_width
;
19681 /* Return the index of the first glyph preceding glyph string S that
19682 is overwriting S because of its right overhang. Value is -1 if no
19683 glyph in front of S overwrites S. */
19686 left_overwriting (s
)
19687 struct glyph_string
*s
;
19690 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19691 int first
= s
->first_glyph
- glyphs
;
19695 for (i
= first
- 1; i
>= 0; --i
)
19698 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
19701 x
-= glyphs
[i
].pixel_width
;
19708 /* Return the index of the last glyph following glyph string S that is
19709 not overwritten by S because of S's right overhang. Value is -1 if
19710 no such glyph is found. */
19713 right_overwritten (s
)
19714 struct glyph_string
*s
;
19718 if (s
->right_overhang
)
19721 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19722 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
19723 int end
= s
->row
->used
[s
->area
];
19725 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
19726 x
+= glyphs
[i
].pixel_width
;
19735 /* Return the index of the last glyph following glyph string S that
19736 overwrites S because of its left overhang. Value is negative
19737 if no such glyph is found. */
19740 right_overwriting (s
)
19741 struct glyph_string
*s
;
19744 int end
= s
->row
->used
[s
->area
];
19745 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19746 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
19750 for (i
= first
; i
< end
; ++i
)
19753 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
19756 x
+= glyphs
[i
].pixel_width
;
19763 /* Set background width of glyph string S. START is the index of the
19764 first glyph following S. LAST_X is the right-most x-position + 1
19765 in the drawing area. */
19768 set_glyph_string_background_width (s
, start
, last_x
)
19769 struct glyph_string
*s
;
19773 /* If the face of this glyph string has to be drawn to the end of
19774 the drawing area, set S->extends_to_end_of_line_p. */
19776 if (start
== s
->row
->used
[s
->area
]
19777 && s
->area
== TEXT_AREA
19778 && ((s
->row
->fill_line_p
19779 && (s
->hl
== DRAW_NORMAL_TEXT
19780 || s
->hl
== DRAW_IMAGE_RAISED
19781 || s
->hl
== DRAW_IMAGE_SUNKEN
))
19782 || s
->hl
== DRAW_MOUSE_FACE
))
19783 s
->extends_to_end_of_line_p
= 1;
19785 /* If S extends its face to the end of the line, set its
19786 background_width to the distance to the right edge of the drawing
19788 if (s
->extends_to_end_of_line_p
)
19789 s
->background_width
= last_x
- s
->x
+ 1;
19791 s
->background_width
= s
->width
;
19795 /* Compute overhangs and x-positions for glyph string S and its
19796 predecessors, or successors. X is the starting x-position for S.
19797 BACKWARD_P non-zero means process predecessors. */
19800 compute_overhangs_and_x (s
, x
, backward_p
)
19801 struct glyph_string
*s
;
19809 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
19810 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
19820 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
19821 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
19831 /* The following macros are only called from draw_glyphs below.
19832 They reference the following parameters of that function directly:
19833 `w', `row', `area', and `overlap_p'
19834 as well as the following local variables:
19835 `s', `f', and `hdc' (in W32) */
19838 /* On W32, silently add local `hdc' variable to argument list of
19839 init_glyph_string. */
19840 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
19841 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
19843 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
19844 init_glyph_string (s, char2b, w, row, area, start, hl)
19847 /* Add a glyph string for a stretch glyph to the list of strings
19848 between HEAD and TAIL. START is the index of the stretch glyph in
19849 row area AREA of glyph row ROW. END is the index of the last glyph
19850 in that glyph row area. X is the current output position assigned
19851 to the new glyph string constructed. HL overrides that face of the
19852 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
19853 is the right-most x-position of the drawing area. */
19855 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
19856 and below -- keep them on one line. */
19857 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
19860 s = (struct glyph_string *) alloca (sizeof *s); \
19861 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
19862 START = fill_stretch_glyph_string (s, row, area, START, END); \
19863 append_glyph_string (&HEAD, &TAIL, s); \
19869 /* Add a glyph string for an image glyph to the list of strings
19870 between HEAD and TAIL. START is the index of the image glyph in
19871 row area AREA of glyph row ROW. END is the index of the last glyph
19872 in that glyph row area. X is the current output position assigned
19873 to the new glyph string constructed. HL overrides that face of the
19874 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
19875 is the right-most x-position of the drawing area. */
19877 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
19880 s = (struct glyph_string *) alloca (sizeof *s); \
19881 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
19882 fill_image_glyph_string (s); \
19883 append_glyph_string (&HEAD, &TAIL, s); \
19890 /* Add a glyph string for a sequence of character glyphs to the list
19891 of strings between HEAD and TAIL. START is the index of the first
19892 glyph in row area AREA of glyph row ROW that is part of the new
19893 glyph string. END is the index of the last glyph in that glyph row
19894 area. X is the current output position assigned to the new glyph
19895 string constructed. HL overrides that face of the glyph; e.g. it
19896 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
19897 right-most x-position of the drawing area. */
19899 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
19905 face_id = (row)->glyphs[area][START].face_id; \
19907 s = (struct glyph_string *) alloca (sizeof *s); \
19908 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
19909 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
19910 append_glyph_string (&HEAD, &TAIL, s); \
19912 START = fill_glyph_string (s, face_id, START, END, overlaps); \
19917 /* Add a glyph string for a composite sequence to the list of strings
19918 between HEAD and TAIL. START is the index of the first glyph in
19919 row area AREA of glyph row ROW that is part of the new glyph
19920 string. END is the index of the last glyph in that glyph row area.
19921 X is the current output position assigned to the new glyph string
19922 constructed. HL overrides that face of the glyph; e.g. it is
19923 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
19924 x-position of the drawing area. */
19926 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
19928 int face_id = (row)->glyphs[area][START].face_id; \
19929 struct face *base_face = FACE_FROM_ID (f, face_id); \
19930 int cmp_id = (row)->glyphs[area][START].u.cmp_id; \
19931 struct composition *cmp = composition_table[cmp_id]; \
19933 struct glyph_string *first_s; \
19936 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
19938 /* Make glyph_strings for each glyph sequence that is drawable by \
19939 the same face, and append them to HEAD/TAIL. */ \
19940 for (n = 0; n < cmp->glyph_len;) \
19942 s = (struct glyph_string *) alloca (sizeof *s); \
19943 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
19944 append_glyph_string (&(HEAD), &(TAIL), s); \
19950 n = fill_composite_glyph_string (s, base_face, overlaps); \
19958 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
19959 of AREA of glyph row ROW on window W between indices START and END.
19960 HL overrides the face for drawing glyph strings, e.g. it is
19961 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
19962 x-positions of the drawing area.
19964 This is an ugly monster macro construct because we must use alloca
19965 to allocate glyph strings (because draw_glyphs can be called
19966 asynchronously). */
19968 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
19971 HEAD = TAIL = NULL; \
19972 while (START < END) \
19974 struct glyph *first_glyph = (row)->glyphs[area] + START; \
19975 switch (first_glyph->type) \
19978 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
19982 case COMPOSITE_GLYPH: \
19983 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
19987 case STRETCH_GLYPH: \
19988 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
19992 case IMAGE_GLYPH: \
19993 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
20003 set_glyph_string_background_width (s, START, LAST_X); \
20011 /* Draw glyphs between START and END in AREA of ROW on window W,
20012 starting at x-position X. X is relative to AREA in W. HL is a
20013 face-override with the following meaning:
20015 DRAW_NORMAL_TEXT draw normally
20016 DRAW_CURSOR draw in cursor face
20017 DRAW_MOUSE_FACE draw in mouse face.
20018 DRAW_INVERSE_VIDEO draw in mode line face
20019 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
20020 DRAW_IMAGE_RAISED draw an image with a raised relief around it
20022 If OVERLAPS is non-zero, draw only the foreground of characters and
20023 clip to the physical height of ROW. Non-zero value also defines
20024 the overlapping part to be drawn:
20026 OVERLAPS_PRED overlap with preceding rows
20027 OVERLAPS_SUCC overlap with succeeding rows
20028 OVERLAPS_BOTH overlap with both preceding/succeeding rows
20029 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
20031 Value is the x-position reached, relative to AREA of W. */
20034 draw_glyphs (w
, x
, row
, area
, start
, end
, hl
, overlaps
)
20037 struct glyph_row
*row
;
20038 enum glyph_row_area area
;
20039 EMACS_INT start
, end
;
20040 enum draw_glyphs_face hl
;
20043 struct glyph_string
*head
, *tail
;
20044 struct glyph_string
*s
;
20045 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
20046 int i
, j
, x_reached
, last_x
, area_left
= 0;
20047 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
20050 ALLOCATE_HDC (hdc
, f
);
20052 /* Let's rather be paranoid than getting a SEGV. */
20053 end
= min (end
, row
->used
[area
]);
20054 start
= max (0, start
);
20055 start
= min (end
, start
);
20057 /* Translate X to frame coordinates. Set last_x to the right
20058 end of the drawing area. */
20059 if (row
->full_width_p
)
20061 /* X is relative to the left edge of W, without scroll bars
20063 area_left
= WINDOW_LEFT_EDGE_X (w
);
20064 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
20068 area_left
= window_box_left (w
, area
);
20069 last_x
= area_left
+ window_box_width (w
, area
);
20073 /* Build a doubly-linked list of glyph_string structures between
20074 head and tail from what we have to draw. Note that the macro
20075 BUILD_GLYPH_STRINGS will modify its start parameter. That's
20076 the reason we use a separate variable `i'. */
20078 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
20080 x_reached
= tail
->x
+ tail
->background_width
;
20084 /* If there are any glyphs with lbearing < 0 or rbearing > width in
20085 the row, redraw some glyphs in front or following the glyph
20086 strings built above. */
20087 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
20089 struct glyph_string
*h
, *t
;
20090 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
20091 int mouse_beg_col
, mouse_end_col
, check_mouse_face
= 0;
20094 /* If mouse highlighting is on, we may need to draw adjacent
20095 glyphs using mouse-face highlighting. */
20096 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
20098 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
20100 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
20101 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
20103 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
20105 check_mouse_face
= 1;
20106 mouse_beg_col
= (row
== mouse_beg_row
)
20107 ? dpyinfo
->mouse_face_beg_col
: 0;
20108 mouse_end_col
= (row
== mouse_end_row
)
20109 ? dpyinfo
->mouse_face_end_col
20110 : row
->used
[TEXT_AREA
];
20114 /* Compute overhangs for all glyph strings. */
20115 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
20116 for (s
= head
; s
; s
= s
->next
)
20117 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
20119 /* Prepend glyph strings for glyphs in front of the first glyph
20120 string that are overwritten because of the first glyph
20121 string's left overhang. The background of all strings
20122 prepended must be drawn because the first glyph string
20124 i
= left_overwritten (head
);
20127 enum draw_glyphs_face overlap_hl
;
20129 /* If this row contains mouse highlighting, attempt to draw
20130 the overlapped glyphs with the correct highlight. This
20131 code fails if the overlap encompasses more than one glyph
20132 and mouse-highlight spans only some of these glyphs.
20133 However, making it work perfectly involves a lot more
20134 code, and I don't know if the pathological case occurs in
20135 practice, so we'll stick to this for now. --- cyd */
20136 if (check_mouse_face
20137 && mouse_beg_col
< start
&& mouse_end_col
> i
)
20138 overlap_hl
= DRAW_MOUSE_FACE
;
20140 overlap_hl
= DRAW_NORMAL_TEXT
;
20143 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
20144 overlap_hl
, dummy_x
, last_x
);
20145 compute_overhangs_and_x (t
, head
->x
, 1);
20146 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
20150 /* Prepend glyph strings for glyphs in front of the first glyph
20151 string that overwrite that glyph string because of their
20152 right overhang. For these strings, only the foreground must
20153 be drawn, because it draws over the glyph string at `head'.
20154 The background must not be drawn because this would overwrite
20155 right overhangs of preceding glyphs for which no glyph
20157 i
= left_overwriting (head
);
20160 enum draw_glyphs_face overlap_hl
;
20162 if (check_mouse_face
20163 && mouse_beg_col
< start
&& mouse_end_col
> i
)
20164 overlap_hl
= DRAW_MOUSE_FACE
;
20166 overlap_hl
= DRAW_NORMAL_TEXT
;
20169 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
20170 overlap_hl
, dummy_x
, last_x
);
20171 for (s
= h
; s
; s
= s
->next
)
20172 s
->background_filled_p
= 1;
20173 compute_overhangs_and_x (t
, head
->x
, 1);
20174 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
20177 /* Append glyphs strings for glyphs following the last glyph
20178 string tail that are overwritten by tail. The background of
20179 these strings has to be drawn because tail's foreground draws
20181 i
= right_overwritten (tail
);
20184 enum draw_glyphs_face overlap_hl
;
20186 if (check_mouse_face
20187 && mouse_beg_col
< i
&& mouse_end_col
> end
)
20188 overlap_hl
= DRAW_MOUSE_FACE
;
20190 overlap_hl
= DRAW_NORMAL_TEXT
;
20192 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
20193 overlap_hl
, x
, last_x
);
20194 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
20195 append_glyph_string_lists (&head
, &tail
, h
, t
);
20199 /* Append glyph strings for glyphs following the last glyph
20200 string tail that overwrite tail. The foreground of such
20201 glyphs has to be drawn because it writes into the background
20202 of tail. The background must not be drawn because it could
20203 paint over the foreground of following glyphs. */
20204 i
= right_overwriting (tail
);
20207 enum draw_glyphs_face overlap_hl
;
20208 if (check_mouse_face
20209 && mouse_beg_col
< i
&& mouse_end_col
> end
)
20210 overlap_hl
= DRAW_MOUSE_FACE
;
20212 overlap_hl
= DRAW_NORMAL_TEXT
;
20215 i
++; /* We must include the Ith glyph. */
20216 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
20217 overlap_hl
, x
, last_x
);
20218 for (s
= h
; s
; s
= s
->next
)
20219 s
->background_filled_p
= 1;
20220 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
20221 append_glyph_string_lists (&head
, &tail
, h
, t
);
20223 if (clip_head
|| clip_tail
)
20224 for (s
= head
; s
; s
= s
->next
)
20226 s
->clip_head
= clip_head
;
20227 s
->clip_tail
= clip_tail
;
20231 /* Draw all strings. */
20232 for (s
= head
; s
; s
= s
->next
)
20233 FRAME_RIF (f
)->draw_glyph_string (s
);
20235 if (area
== TEXT_AREA
20236 && !row
->full_width_p
20237 /* When drawing overlapping rows, only the glyph strings'
20238 foreground is drawn, which doesn't erase a cursor
20242 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
20243 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
20244 : (tail
? tail
->x
+ tail
->background_width
: x
));
20248 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
20249 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
20252 /* Value is the x-position up to which drawn, relative to AREA of W.
20253 This doesn't include parts drawn because of overhangs. */
20254 if (row
->full_width_p
)
20255 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
20257 x_reached
-= area_left
;
20259 RELEASE_HDC (hdc
, f
);
20264 /* Expand row matrix if too narrow. Don't expand if area
20267 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
20269 if (!fonts_changed_p \
20270 && (it->glyph_row->glyphs[area] \
20271 < it->glyph_row->glyphs[area + 1])) \
20273 it->w->ncols_scale_factor++; \
20274 fonts_changed_p = 1; \
20278 /* Store one glyph for IT->char_to_display in IT->glyph_row.
20279 Called from x_produce_glyphs when IT->glyph_row is non-null. */
20285 struct glyph
*glyph
;
20286 enum glyph_row_area area
= it
->area
;
20288 xassert (it
->glyph_row
);
20289 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
20291 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20292 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20294 glyph
->charpos
= CHARPOS (it
->position
);
20295 glyph
->object
= it
->object
;
20296 if (it
->pixel_width
> 0)
20298 glyph
->pixel_width
= it
->pixel_width
;
20299 glyph
->padding_p
= 0;
20303 /* Assure at least 1-pixel width. Otherwise, cursor can't
20304 be displayed correctly. */
20305 glyph
->pixel_width
= 1;
20306 glyph
->padding_p
= 1;
20308 glyph
->ascent
= it
->ascent
;
20309 glyph
->descent
= it
->descent
;
20310 glyph
->voffset
= it
->voffset
;
20311 glyph
->type
= CHAR_GLYPH
;
20312 glyph
->multibyte_p
= it
->multibyte_p
;
20313 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20314 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20315 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
20316 || it
->phys_descent
> it
->descent
);
20317 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
20318 glyph
->face_id
= it
->face_id
;
20319 glyph
->u
.ch
= it
->char_to_display
;
20320 glyph
->slice
= null_glyph_slice
;
20321 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20322 ++it
->glyph_row
->used
[area
];
20325 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20328 /* Store one glyph for the composition IT->cmp_id in IT->glyph_row.
20329 Called from x_produce_glyphs when IT->glyph_row is non-null. */
20332 append_composite_glyph (it
)
20335 struct glyph
*glyph
;
20336 enum glyph_row_area area
= it
->area
;
20338 xassert (it
->glyph_row
);
20340 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20341 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20343 glyph
->charpos
= CHARPOS (it
->position
);
20344 glyph
->object
= it
->object
;
20345 glyph
->pixel_width
= it
->pixel_width
;
20346 glyph
->ascent
= it
->ascent
;
20347 glyph
->descent
= it
->descent
;
20348 glyph
->voffset
= it
->voffset
;
20349 glyph
->type
= COMPOSITE_GLYPH
;
20350 glyph
->multibyte_p
= it
->multibyte_p
;
20351 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20352 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20353 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
20354 || it
->phys_descent
> it
->descent
);
20355 glyph
->padding_p
= 0;
20356 glyph
->glyph_not_available_p
= 0;
20357 glyph
->face_id
= it
->face_id
;
20358 glyph
->u
.cmp_id
= it
->cmp_id
;
20359 glyph
->slice
= null_glyph_slice
;
20360 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20361 ++it
->glyph_row
->used
[area
];
20364 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20368 /* Change IT->ascent and IT->height according to the setting of
20372 take_vertical_position_into_account (it
)
20377 if (it
->voffset
< 0)
20378 /* Increase the ascent so that we can display the text higher
20380 it
->ascent
-= it
->voffset
;
20382 /* Increase the descent so that we can display the text lower
20384 it
->descent
+= it
->voffset
;
20389 /* Produce glyphs/get display metrics for the image IT is loaded with.
20390 See the description of struct display_iterator in dispextern.h for
20391 an overview of struct display_iterator. */
20394 produce_image_glyph (it
)
20399 int glyph_ascent
, crop
;
20400 struct glyph_slice slice
;
20402 xassert (it
->what
== IT_IMAGE
);
20404 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20406 /* Make sure X resources of the face is loaded. */
20407 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
20409 if (it
->image_id
< 0)
20411 /* Fringe bitmap. */
20412 it
->ascent
= it
->phys_ascent
= 0;
20413 it
->descent
= it
->phys_descent
= 0;
20414 it
->pixel_width
= 0;
20419 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
20421 /* Make sure X resources of the image is loaded. */
20422 prepare_image_for_display (it
->f
, img
);
20424 slice
.x
= slice
.y
= 0;
20425 slice
.width
= img
->width
;
20426 slice
.height
= img
->height
;
20428 if (INTEGERP (it
->slice
.x
))
20429 slice
.x
= XINT (it
->slice
.x
);
20430 else if (FLOATP (it
->slice
.x
))
20431 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
20433 if (INTEGERP (it
->slice
.y
))
20434 slice
.y
= XINT (it
->slice
.y
);
20435 else if (FLOATP (it
->slice
.y
))
20436 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
20438 if (INTEGERP (it
->slice
.width
))
20439 slice
.width
= XINT (it
->slice
.width
);
20440 else if (FLOATP (it
->slice
.width
))
20441 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
20443 if (INTEGERP (it
->slice
.height
))
20444 slice
.height
= XINT (it
->slice
.height
);
20445 else if (FLOATP (it
->slice
.height
))
20446 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
20448 if (slice
.x
>= img
->width
)
20449 slice
.x
= img
->width
;
20450 if (slice
.y
>= img
->height
)
20451 slice
.y
= img
->height
;
20452 if (slice
.x
+ slice
.width
>= img
->width
)
20453 slice
.width
= img
->width
- slice
.x
;
20454 if (slice
.y
+ slice
.height
> img
->height
)
20455 slice
.height
= img
->height
- slice
.y
;
20457 if (slice
.width
== 0 || slice
.height
== 0)
20460 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
20462 it
->descent
= slice
.height
- glyph_ascent
;
20464 it
->descent
+= img
->vmargin
;
20465 if (slice
.y
+ slice
.height
== img
->height
)
20466 it
->descent
+= img
->vmargin
;
20467 it
->phys_descent
= it
->descent
;
20469 it
->pixel_width
= slice
.width
;
20471 it
->pixel_width
+= img
->hmargin
;
20472 if (slice
.x
+ slice
.width
== img
->width
)
20473 it
->pixel_width
+= img
->hmargin
;
20475 /* It's quite possible for images to have an ascent greater than
20476 their height, so don't get confused in that case. */
20477 if (it
->descent
< 0)
20480 #if 0 /* this breaks image tiling */
20481 /* If this glyph is alone on the last line, adjust it.ascent to minimum row ascent. */
20482 int face_ascent
= face
->font
? FONT_BASE (face
->font
) : FRAME_BASELINE_OFFSET (it
->f
);
20483 if (face_ascent
> it
->ascent
)
20484 it
->ascent
= it
->phys_ascent
= face_ascent
;
20489 if (face
->box
!= FACE_NO_BOX
)
20491 if (face
->box_line_width
> 0)
20494 it
->ascent
+= face
->box_line_width
;
20495 if (slice
.y
+ slice
.height
== img
->height
)
20496 it
->descent
+= face
->box_line_width
;
20499 if (it
->start_of_box_run_p
&& slice
.x
== 0)
20500 it
->pixel_width
+= eabs (face
->box_line_width
);
20501 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
20502 it
->pixel_width
+= eabs (face
->box_line_width
);
20505 take_vertical_position_into_account (it
);
20507 /* Automatically crop wide image glyphs at right edge so we can
20508 draw the cursor on same display row. */
20509 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
20510 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
20512 it
->pixel_width
-= crop
;
20513 slice
.width
-= crop
;
20518 struct glyph
*glyph
;
20519 enum glyph_row_area area
= it
->area
;
20521 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20522 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20524 glyph
->charpos
= CHARPOS (it
->position
);
20525 glyph
->object
= it
->object
;
20526 glyph
->pixel_width
= it
->pixel_width
;
20527 glyph
->ascent
= glyph_ascent
;
20528 glyph
->descent
= it
->descent
;
20529 glyph
->voffset
= it
->voffset
;
20530 glyph
->type
= IMAGE_GLYPH
;
20531 glyph
->multibyte_p
= it
->multibyte_p
;
20532 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20533 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20534 glyph
->overlaps_vertically_p
= 0;
20535 glyph
->padding_p
= 0;
20536 glyph
->glyph_not_available_p
= 0;
20537 glyph
->face_id
= it
->face_id
;
20538 glyph
->u
.img_id
= img
->id
;
20539 glyph
->slice
= slice
;
20540 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20541 ++it
->glyph_row
->used
[area
];
20544 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20549 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
20550 of the glyph, WIDTH and HEIGHT are the width and height of the
20551 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
20554 append_stretch_glyph (it
, object
, width
, height
, ascent
)
20556 Lisp_Object object
;
20560 struct glyph
*glyph
;
20561 enum glyph_row_area area
= it
->area
;
20563 xassert (ascent
>= 0 && ascent
<= height
);
20565 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20566 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20568 glyph
->charpos
= CHARPOS (it
->position
);
20569 glyph
->object
= object
;
20570 glyph
->pixel_width
= width
;
20571 glyph
->ascent
= ascent
;
20572 glyph
->descent
= height
- ascent
;
20573 glyph
->voffset
= it
->voffset
;
20574 glyph
->type
= STRETCH_GLYPH
;
20575 glyph
->multibyte_p
= it
->multibyte_p
;
20576 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20577 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20578 glyph
->overlaps_vertically_p
= 0;
20579 glyph
->padding_p
= 0;
20580 glyph
->glyph_not_available_p
= 0;
20581 glyph
->face_id
= it
->face_id
;
20582 glyph
->u
.stretch
.ascent
= ascent
;
20583 glyph
->u
.stretch
.height
= height
;
20584 glyph
->slice
= null_glyph_slice
;
20585 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20586 ++it
->glyph_row
->used
[area
];
20589 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20593 /* Produce a stretch glyph for iterator IT. IT->object is the value
20594 of the glyph property displayed. The value must be a list
20595 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
20598 1. `:width WIDTH' specifies that the space should be WIDTH *
20599 canonical char width wide. WIDTH may be an integer or floating
20602 2. `:relative-width FACTOR' specifies that the width of the stretch
20603 should be computed from the width of the first character having the
20604 `glyph' property, and should be FACTOR times that width.
20606 3. `:align-to HPOS' specifies that the space should be wide enough
20607 to reach HPOS, a value in canonical character units.
20609 Exactly one of the above pairs must be present.
20611 4. `:height HEIGHT' specifies that the height of the stretch produced
20612 should be HEIGHT, measured in canonical character units.
20614 5. `:relative-height FACTOR' specifies that the height of the
20615 stretch should be FACTOR times the height of the characters having
20616 the glyph property.
20618 Either none or exactly one of 4 or 5 must be present.
20620 6. `:ascent ASCENT' specifies that ASCENT percent of the height
20621 of the stretch should be used for the ascent of the stretch.
20622 ASCENT must be in the range 0 <= ASCENT <= 100. */
20625 produce_stretch_glyph (it
)
20628 /* (space :width WIDTH :height HEIGHT ...) */
20629 Lisp_Object prop
, plist
;
20630 int width
= 0, height
= 0, align_to
= -1;
20631 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
20634 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20635 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
20637 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
20639 /* List should start with `space'. */
20640 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
20641 plist
= XCDR (it
->object
);
20643 /* Compute the width of the stretch. */
20644 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
20645 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
20647 /* Absolute width `:width WIDTH' specified and valid. */
20648 zero_width_ok_p
= 1;
20651 else if (prop
= Fplist_get (plist
, QCrelative_width
),
20654 /* Relative width `:relative-width FACTOR' specified and valid.
20655 Compute the width of the characters having the `glyph'
20658 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
20661 if (it
->multibyte_p
)
20663 int maxlen
= ((IT_BYTEPOS (*it
) >= GPT
? ZV
: GPT
)
20664 - IT_BYTEPOS (*it
));
20665 it2
.c
= STRING_CHAR_AND_LENGTH (p
, maxlen
, it2
.len
);
20668 it2
.c
= *p
, it2
.len
= 1;
20670 it2
.glyph_row
= NULL
;
20671 it2
.what
= IT_CHARACTER
;
20672 x_produce_glyphs (&it2
);
20673 width
= NUMVAL (prop
) * it2
.pixel_width
;
20675 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
20676 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
20678 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
20679 align_to
= (align_to
< 0
20681 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
20682 else if (align_to
< 0)
20683 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
20684 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
20685 zero_width_ok_p
= 1;
20688 /* Nothing specified -> width defaults to canonical char width. */
20689 width
= FRAME_COLUMN_WIDTH (it
->f
);
20691 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
20694 /* Compute height. */
20695 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
20696 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
20699 zero_height_ok_p
= 1;
20701 else if (prop
= Fplist_get (plist
, QCrelative_height
),
20703 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
20705 height
= FONT_HEIGHT (font
);
20707 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
20710 /* Compute percentage of height used for ascent. If
20711 `:ascent ASCENT' is present and valid, use that. Otherwise,
20712 derive the ascent from the font in use. */
20713 if (prop
= Fplist_get (plist
, QCascent
),
20714 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
20715 ascent
= height
* NUMVAL (prop
) / 100.0;
20716 else if (!NILP (prop
)
20717 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
20718 ascent
= min (max (0, (int)tem
), height
);
20720 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
20722 if (width
> 0 && it
->line_wrap
!= TRUNCATE
20723 && it
->current_x
+ width
> it
->last_visible_x
)
20724 width
= it
->last_visible_x
- it
->current_x
- 1;
20726 if (width
> 0 && height
> 0 && it
->glyph_row
)
20728 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
20729 if (!STRINGP (object
))
20730 object
= it
->w
->buffer
;
20731 append_stretch_glyph (it
, object
, width
, height
, ascent
);
20734 it
->pixel_width
= width
;
20735 it
->ascent
= it
->phys_ascent
= ascent
;
20736 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
20737 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
20739 take_vertical_position_into_account (it
);
20742 /* Get line-height and line-spacing property at point.
20743 If line-height has format (HEIGHT TOTAL), return TOTAL
20744 in TOTAL_HEIGHT. */
20747 get_line_height_property (it
, prop
)
20751 Lisp_Object position
;
20753 if (STRINGP (it
->object
))
20754 position
= make_number (IT_STRING_CHARPOS (*it
));
20755 else if (BUFFERP (it
->object
))
20756 position
= make_number (IT_CHARPOS (*it
));
20760 return Fget_char_property (position
, prop
, it
->object
);
20763 /* Calculate line-height and line-spacing properties.
20764 An integer value specifies explicit pixel value.
20765 A float value specifies relative value to current face height.
20766 A cons (float . face-name) specifies relative value to
20767 height of specified face font.
20769 Returns height in pixels, or nil. */
20773 calc_line_height_property (it
, val
, font
, boff
, override
)
20777 int boff
, override
;
20779 Lisp_Object face_name
= Qnil
;
20780 int ascent
, descent
, height
;
20782 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
20787 face_name
= XCAR (val
);
20789 if (!NUMBERP (val
))
20790 val
= make_number (1);
20791 if (NILP (face_name
))
20793 height
= it
->ascent
+ it
->descent
;
20798 if (NILP (face_name
))
20800 font
= FRAME_FONT (it
->f
);
20801 boff
= FRAME_BASELINE_OFFSET (it
->f
);
20803 else if (EQ (face_name
, Qt
))
20812 face_id
= lookup_named_face (it
->f
, face_name
, 0);
20814 return make_number (-1);
20816 face
= FACE_FROM_ID (it
->f
, face_id
);
20819 return make_number (-1);
20820 boff
= font
->baseline_offset
;
20821 if (font
->vertical_centering
)
20822 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
20825 ascent
= FONT_BASE (font
) + boff
;
20826 descent
= FONT_DESCENT (font
) - boff
;
20830 it
->override_ascent
= ascent
;
20831 it
->override_descent
= descent
;
20832 it
->override_boff
= boff
;
20835 height
= ascent
+ descent
;
20839 height
= (int)(XFLOAT_DATA (val
) * height
);
20840 else if (INTEGERP (val
))
20841 height
*= XINT (val
);
20843 return make_number (height
);
20848 Produce glyphs/get display metrics for the display element IT is
20849 loaded with. See the description of struct it in dispextern.h
20850 for an overview of struct it. */
20853 x_produce_glyphs (it
)
20856 int extra_line_spacing
= it
->extra_line_spacing
;
20858 it
->glyph_not_available_p
= 0;
20860 if (it
->what
== IT_CHARACTER
)
20864 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20865 struct font_metrics
*pcm
;
20866 int font_not_found_p
;
20867 int boff
; /* baseline offset */
20868 /* We may change it->multibyte_p upon unibyte<->multibyte
20869 conversion. So, save the current value now and restore it
20872 Note: It seems that we don't have to record multibyte_p in
20873 struct glyph because the character code itself tells if or
20874 not the character is multibyte. Thus, in the future, we must
20875 consider eliminating the field `multibyte_p' in the struct
20877 int saved_multibyte_p
= it
->multibyte_p
;
20879 /* Maybe translate single-byte characters to multibyte, or the
20881 it
->char_to_display
= it
->c
;
20882 if (!ASCII_BYTE_P (it
->c
)
20883 && ! it
->multibyte_p
)
20885 if (SINGLE_BYTE_CHAR_P (it
->c
)
20886 && unibyte_display_via_language_environment
)
20887 it
->char_to_display
= unibyte_char_to_multibyte (it
->c
);
20888 if (! SINGLE_BYTE_CHAR_P (it
->char_to_display
))
20890 it
->multibyte_p
= 1;
20891 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
,
20893 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20897 /* Get font to use. Encode IT->char_to_display. */
20898 get_char_face_and_encoding (it
->f
, it
->char_to_display
, it
->face_id
,
20899 &char2b
, it
->multibyte_p
, 0);
20902 /* When no suitable font found, use the default font. */
20903 font_not_found_p
= font
== NULL
;
20904 if (font_not_found_p
)
20906 font
= FRAME_FONT (it
->f
);
20907 boff
= FRAME_BASELINE_OFFSET (it
->f
);
20911 boff
= font
->baseline_offset
;
20912 if (font
->vertical_centering
)
20913 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
20916 if (it
->char_to_display
>= ' '
20917 && (!it
->multibyte_p
|| it
->char_to_display
< 128))
20919 /* Either unibyte or ASCII. */
20924 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
20926 if (it
->override_ascent
>= 0)
20928 it
->ascent
= it
->override_ascent
;
20929 it
->descent
= it
->override_descent
;
20930 boff
= it
->override_boff
;
20934 it
->ascent
= FONT_BASE (font
) + boff
;
20935 it
->descent
= FONT_DESCENT (font
) - boff
;
20940 it
->phys_ascent
= pcm
->ascent
+ boff
;
20941 it
->phys_descent
= pcm
->descent
- boff
;
20942 it
->pixel_width
= pcm
->width
;
20946 it
->glyph_not_available_p
= 1;
20947 it
->phys_ascent
= it
->ascent
;
20948 it
->phys_descent
= it
->descent
;
20949 it
->pixel_width
= FONT_WIDTH (font
);
20952 if (it
->constrain_row_ascent_descent_p
)
20954 if (it
->descent
> it
->max_descent
)
20956 it
->ascent
+= it
->descent
- it
->max_descent
;
20957 it
->descent
= it
->max_descent
;
20959 if (it
->ascent
> it
->max_ascent
)
20961 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
20962 it
->ascent
= it
->max_ascent
;
20964 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
20965 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
20966 extra_line_spacing
= 0;
20969 /* If this is a space inside a region of text with
20970 `space-width' property, change its width. */
20971 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
20973 it
->pixel_width
*= XFLOATINT (it
->space_width
);
20975 /* If face has a box, add the box thickness to the character
20976 height. If character has a box line to the left and/or
20977 right, add the box line width to the character's width. */
20978 if (face
->box
!= FACE_NO_BOX
)
20980 int thick
= face
->box_line_width
;
20984 it
->ascent
+= thick
;
20985 it
->descent
+= thick
;
20990 if (it
->start_of_box_run_p
)
20991 it
->pixel_width
+= thick
;
20992 if (it
->end_of_box_run_p
)
20993 it
->pixel_width
+= thick
;
20996 /* If face has an overline, add the height of the overline
20997 (1 pixel) and a 1 pixel margin to the character height. */
20998 if (face
->overline_p
)
20999 it
->ascent
+= overline_margin
;
21001 if (it
->constrain_row_ascent_descent_p
)
21003 if (it
->ascent
> it
->max_ascent
)
21004 it
->ascent
= it
->max_ascent
;
21005 if (it
->descent
> it
->max_descent
)
21006 it
->descent
= it
->max_descent
;
21009 take_vertical_position_into_account (it
);
21011 /* If we have to actually produce glyphs, do it. */
21016 /* Translate a space with a `space-width' property
21017 into a stretch glyph. */
21018 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
21019 / FONT_HEIGHT (font
));
21020 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
21021 it
->ascent
+ it
->descent
, ascent
);
21026 /* If characters with lbearing or rbearing are displayed
21027 in this line, record that fact in a flag of the
21028 glyph row. This is used to optimize X output code. */
21029 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
21030 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
21032 if (! stretched_p
&& it
->pixel_width
== 0)
21033 /* We assure that all visible glyphs have at least 1-pixel
21035 it
->pixel_width
= 1;
21037 else if (it
->char_to_display
== '\n')
21039 /* A newline has no width but we need the height of the line.
21040 But if previous part of the line set a height, don't
21041 increase that height */
21043 Lisp_Object height
;
21044 Lisp_Object total_height
= Qnil
;
21046 it
->override_ascent
= -1;
21047 it
->pixel_width
= 0;
21050 height
= get_line_height_property(it
, Qline_height
);
21051 /* Split (line-height total-height) list */
21053 && CONSP (XCDR (height
))
21054 && NILP (XCDR (XCDR (height
))))
21056 total_height
= XCAR (XCDR (height
));
21057 height
= XCAR (height
);
21059 height
= calc_line_height_property(it
, height
, font
, boff
, 1);
21061 if (it
->override_ascent
>= 0)
21063 it
->ascent
= it
->override_ascent
;
21064 it
->descent
= it
->override_descent
;
21065 boff
= it
->override_boff
;
21069 it
->ascent
= FONT_BASE (font
) + boff
;
21070 it
->descent
= FONT_DESCENT (font
) - boff
;
21073 if (EQ (height
, Qt
))
21075 if (it
->descent
> it
->max_descent
)
21077 it
->ascent
+= it
->descent
- it
->max_descent
;
21078 it
->descent
= it
->max_descent
;
21080 if (it
->ascent
> it
->max_ascent
)
21082 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
21083 it
->ascent
= it
->max_ascent
;
21085 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
21086 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
21087 it
->constrain_row_ascent_descent_p
= 1;
21088 extra_line_spacing
= 0;
21092 Lisp_Object spacing
;
21094 it
->phys_ascent
= it
->ascent
;
21095 it
->phys_descent
= it
->descent
;
21097 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
21098 && face
->box
!= FACE_NO_BOX
21099 && face
->box_line_width
> 0)
21101 it
->ascent
+= face
->box_line_width
;
21102 it
->descent
+= face
->box_line_width
;
21105 && XINT (height
) > it
->ascent
+ it
->descent
)
21106 it
->ascent
= XINT (height
) - it
->descent
;
21108 if (!NILP (total_height
))
21109 spacing
= calc_line_height_property(it
, total_height
, font
, boff
, 0);
21112 spacing
= get_line_height_property(it
, Qline_spacing
);
21113 spacing
= calc_line_height_property(it
, spacing
, font
, boff
, 0);
21115 if (INTEGERP (spacing
))
21117 extra_line_spacing
= XINT (spacing
);
21118 if (!NILP (total_height
))
21119 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
21123 else if (it
->char_to_display
== '\t')
21125 int tab_width
= it
->tab_width
* font
->space_width
;
21126 int x
= it
->current_x
+ it
->continuation_lines_width
;
21127 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
21129 /* If the distance from the current position to the next tab
21130 stop is less than a space character width, use the
21131 tab stop after that. */
21132 if (next_tab_x
- x
< font
->space_width
)
21133 next_tab_x
+= tab_width
;
21135 it
->pixel_width
= next_tab_x
- x
;
21137 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
21138 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
21142 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
21143 it
->ascent
+ it
->descent
, it
->ascent
);
21148 /* A multi-byte character. Assume that the display width of the
21149 character is the width of the character multiplied by the
21150 width of the font. */
21152 /* If we found a font, this font should give us the right
21153 metrics. If we didn't find a font, use the frame's
21154 default font and calculate the width of the character by
21155 multiplying the width of font by the width of the
21158 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
21160 if (font_not_found_p
|| !pcm
)
21162 int char_width
= CHAR_WIDTH (it
->char_to_display
);
21164 if (char_width
== 0)
21165 /* This is a non spacing character. But, as we are
21166 going to display an empty box, the box must occupy
21167 at least one column. */
21169 it
->glyph_not_available_p
= 1;
21170 it
->pixel_width
= FRAME_COLUMN_WIDTH (it
->f
) * char_width
;
21171 it
->phys_ascent
= FONT_BASE (font
) + boff
;
21172 it
->phys_descent
= FONT_DESCENT (font
) - boff
;
21176 it
->pixel_width
= pcm
->width
;
21177 it
->phys_ascent
= pcm
->ascent
+ boff
;
21178 it
->phys_descent
= pcm
->descent
- boff
;
21180 && (pcm
->lbearing
< 0
21181 || pcm
->rbearing
> pcm
->width
))
21182 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
21185 it
->ascent
= FONT_BASE (font
) + boff
;
21186 it
->descent
= FONT_DESCENT (font
) - boff
;
21187 if (face
->box
!= FACE_NO_BOX
)
21189 int thick
= face
->box_line_width
;
21193 it
->ascent
+= thick
;
21194 it
->descent
+= thick
;
21199 if (it
->start_of_box_run_p
)
21200 it
->pixel_width
+= thick
;
21201 if (it
->end_of_box_run_p
)
21202 it
->pixel_width
+= thick
;
21205 /* If face has an overline, add the height of the overline
21206 (1 pixel) and a 1 pixel margin to the character height. */
21207 if (face
->overline_p
)
21208 it
->ascent
+= overline_margin
;
21210 take_vertical_position_into_account (it
);
21212 if (it
->ascent
< 0)
21214 if (it
->descent
< 0)
21219 if (it
->pixel_width
== 0)
21220 /* We assure that all visible glyphs have at least 1-pixel
21222 it
->pixel_width
= 1;
21224 it
->multibyte_p
= saved_multibyte_p
;
21226 else if (it
->what
== IT_COMPOSITION
)
21228 /* Note: A composition is represented as one glyph in the
21229 glyph matrix. There are no padding glyphs.
21231 Important is that pixel_width, ascent, and descent are the
21232 values of what is drawn by draw_glyphs (i.e. the values of
21233 the overall glyphs composed). */
21234 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21235 int boff
; /* baseline offset */
21236 struct composition
*cmp
= composition_table
[it
->cmp_id
];
21237 int glyph_len
= cmp
->glyph_len
;
21238 struct font
*font
= face
->font
;
21242 if (cmp
->method
== COMPOSITION_WITH_GLYPH_STRING
)
21244 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21245 font_prepare_composition (cmp
, it
->f
);
21248 /* If we have not yet calculated pixel size data of glyphs of
21249 the composition for the current face font, calculate them
21250 now. Theoretically, we have to check all fonts for the
21251 glyphs, but that requires much time and memory space. So,
21252 here we check only the font of the first glyph. This leads
21253 to incorrect display, but it's very rare, and C-l (recenter)
21254 can correct the display anyway. */
21255 if (! cmp
->font
|| cmp
->font
!= font
)
21257 /* Ascent and descent of the font of the first character
21258 of this composition (adjusted by baseline offset).
21259 Ascent and descent of overall glyphs should not be less
21260 than them respectively. */
21261 int font_ascent
, font_descent
, font_height
;
21262 /* Bounding box of the overall glyphs. */
21263 int leftmost
, rightmost
, lowest
, highest
;
21264 int lbearing
, rbearing
;
21265 int i
, width
, ascent
, descent
;
21266 int left_padded
= 0, right_padded
= 0;
21270 struct font_metrics
*pcm
;
21271 int font_not_found_p
;
21274 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
21275 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
21277 if (glyph_len
< cmp
->glyph_len
)
21279 for (i
= 0; i
< glyph_len
; i
++)
21281 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
21283 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
21288 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
21289 : IT_CHARPOS (*it
));
21290 /* When no suitable font found, use the default font. */
21291 font_not_found_p
= font
== NULL
;
21292 if (font_not_found_p
)
21294 face
= face
->ascii_face
;
21297 boff
= font
->baseline_offset
;
21298 if (font
->vertical_centering
)
21299 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
21300 font_ascent
= FONT_BASE (font
) + boff
;
21301 font_descent
= FONT_DESCENT (font
) - boff
;
21302 font_height
= FONT_HEIGHT (font
);
21304 cmp
->font
= (void *) font
;
21307 if (! font_not_found_p
)
21309 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
21310 &char2b
, it
->multibyte_p
, 0);
21311 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
21314 /* Initialize the bounding box. */
21317 width
= pcm
->width
;
21318 ascent
= pcm
->ascent
;
21319 descent
= pcm
->descent
;
21320 lbearing
= pcm
->lbearing
;
21321 rbearing
= pcm
->rbearing
;
21325 width
= FONT_WIDTH (font
);
21326 ascent
= FONT_BASE (font
);
21327 descent
= FONT_DESCENT (font
);
21334 lowest
= - descent
+ boff
;
21335 highest
= ascent
+ boff
;
21337 if (! font_not_found_p
21338 && font
->default_ascent
21339 && CHAR_TABLE_P (Vuse_default_ascent
)
21340 && !NILP (Faref (Vuse_default_ascent
,
21341 make_number (it
->char_to_display
))))
21342 highest
= font
->default_ascent
+ boff
;
21344 /* Draw the first glyph at the normal position. It may be
21345 shifted to right later if some other glyphs are drawn
21347 cmp
->offsets
[i
* 2] = 0;
21348 cmp
->offsets
[i
* 2 + 1] = boff
;
21349 cmp
->lbearing
= lbearing
;
21350 cmp
->rbearing
= rbearing
;
21352 /* Set cmp->offsets for the remaining glyphs. */
21353 for (i
++; i
< glyph_len
; i
++)
21355 int left
, right
, btm
, top
;
21356 int ch
= COMPOSITION_GLYPH (cmp
, i
);
21358 struct face
*this_face
;
21363 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
21364 this_face
= FACE_FROM_ID (it
->f
, face_id
);
21365 font
= this_face
->font
;
21371 this_boff
= font
->baseline_offset
;
21372 if (font
->vertical_centering
)
21373 this_boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
21374 get_char_face_and_encoding (it
->f
, ch
, face_id
,
21375 &char2b
, it
->multibyte_p
, 0);
21376 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
21379 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
21382 width
= pcm
->width
;
21383 ascent
= pcm
->ascent
;
21384 descent
= pcm
->descent
;
21385 lbearing
= pcm
->lbearing
;
21386 rbearing
= pcm
->rbearing
;
21387 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
21389 /* Relative composition with or without
21390 alternate chars. */
21391 left
= (leftmost
+ rightmost
- width
) / 2;
21392 btm
= - descent
+ boff
;
21393 if (font
->relative_compose
21394 && (! CHAR_TABLE_P (Vignore_relative_composition
)
21395 || NILP (Faref (Vignore_relative_composition
,
21396 make_number (ch
)))))
21399 if (- descent
>= font
->relative_compose
)
21400 /* One extra pixel between two glyphs. */
21402 else if (ascent
<= 0)
21403 /* One extra pixel between two glyphs. */
21404 btm
= lowest
- 1 - ascent
- descent
;
21409 /* A composition rule is specified by an integer
21410 value that encodes global and new reference
21411 points (GREF and NREF). GREF and NREF are
21412 specified by numbers as below:
21414 0---1---2 -- ascent
21418 9--10--11 -- center
21420 ---3---4---5--- baseline
21422 6---7---8 -- descent
21424 int rule
= COMPOSITION_RULE (cmp
, i
);
21425 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
21427 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
21428 grefx
= gref
% 3, nrefx
= nref
% 3;
21429 grefy
= gref
/ 3, nrefy
= nref
/ 3;
21431 xoff
= font_height
* (xoff
- 128) / 256;
21433 yoff
= font_height
* (yoff
- 128) / 256;
21436 + grefx
* (rightmost
- leftmost
) / 2
21437 - nrefx
* width
/ 2
21440 btm
= ((grefy
== 0 ? highest
21442 : grefy
== 2 ? lowest
21443 : (highest
+ lowest
) / 2)
21444 - (nrefy
== 0 ? ascent
+ descent
21445 : nrefy
== 1 ? descent
- boff
21447 : (ascent
+ descent
) / 2)
21451 cmp
->offsets
[i
* 2] = left
;
21452 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
21454 /* Update the bounding box of the overall glyphs. */
21457 right
= left
+ width
;
21458 if (left
< leftmost
)
21460 if (right
> rightmost
)
21463 top
= btm
+ descent
+ ascent
;
21469 if (cmp
->lbearing
> left
+ lbearing
)
21470 cmp
->lbearing
= left
+ lbearing
;
21471 if (cmp
->rbearing
< left
+ rbearing
)
21472 cmp
->rbearing
= left
+ rbearing
;
21476 /* If there are glyphs whose x-offsets are negative,
21477 shift all glyphs to the right and make all x-offsets
21481 for (i
= 0; i
< cmp
->glyph_len
; i
++)
21482 cmp
->offsets
[i
* 2] -= leftmost
;
21483 rightmost
-= leftmost
;
21484 cmp
->lbearing
-= leftmost
;
21485 cmp
->rbearing
-= leftmost
;
21488 if (left_padded
&& cmp
->lbearing
< 0)
21490 for (i
= 0; i
< cmp
->glyph_len
; i
++)
21491 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
21492 rightmost
-= cmp
->lbearing
;
21493 cmp
->rbearing
-= cmp
->lbearing
;
21496 if (right_padded
&& rightmost
< cmp
->rbearing
)
21498 rightmost
= cmp
->rbearing
;
21501 cmp
->pixel_width
= rightmost
;
21502 cmp
->ascent
= highest
;
21503 cmp
->descent
= - lowest
;
21504 if (cmp
->ascent
< font_ascent
)
21505 cmp
->ascent
= font_ascent
;
21506 if (cmp
->descent
< font_descent
)
21507 cmp
->descent
= font_descent
;
21511 && (cmp
->lbearing
< 0
21512 || cmp
->rbearing
> cmp
->pixel_width
))
21513 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
21515 it
->pixel_width
= cmp
->pixel_width
;
21516 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
21517 it
->descent
= it
->phys_descent
= cmp
->descent
;
21518 if (face
->box
!= FACE_NO_BOX
)
21520 int thick
= face
->box_line_width
;
21524 it
->ascent
+= thick
;
21525 it
->descent
+= thick
;
21530 if (it
->start_of_box_run_p
)
21531 it
->pixel_width
+= thick
;
21532 if (it
->end_of_box_run_p
)
21533 it
->pixel_width
+= thick
;
21536 /* If face has an overline, add the height of the overline
21537 (1 pixel) and a 1 pixel margin to the character height. */
21538 if (face
->overline_p
)
21539 it
->ascent
+= overline_margin
;
21541 take_vertical_position_into_account (it
);
21542 if (it
->ascent
< 0)
21544 if (it
->descent
< 0)
21548 append_composite_glyph (it
);
21550 else if (it
->what
== IT_IMAGE
)
21551 produce_image_glyph (it
);
21552 else if (it
->what
== IT_STRETCH
)
21553 produce_stretch_glyph (it
);
21555 /* Accumulate dimensions. Note: can't assume that it->descent > 0
21556 because this isn't true for images with `:ascent 100'. */
21557 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
21558 if (it
->area
== TEXT_AREA
)
21559 it
->current_x
+= it
->pixel_width
;
21561 if (extra_line_spacing
> 0)
21563 it
->descent
+= extra_line_spacing
;
21564 if (extra_line_spacing
> it
->max_extra_line_spacing
)
21565 it
->max_extra_line_spacing
= extra_line_spacing
;
21568 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
21569 it
->max_descent
= max (it
->max_descent
, it
->descent
);
21570 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
21571 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
21575 Output LEN glyphs starting at START at the nominal cursor position.
21576 Advance the nominal cursor over the text. The global variable
21577 updated_window contains the window being updated, updated_row is
21578 the glyph row being updated, and updated_area is the area of that
21579 row being updated. */
21582 x_write_glyphs (start
, len
)
21583 struct glyph
*start
;
21588 xassert (updated_window
&& updated_row
);
21591 /* Write glyphs. */
21593 hpos
= start
- updated_row
->glyphs
[updated_area
];
21594 x
= draw_glyphs (updated_window
, output_cursor
.x
,
21595 updated_row
, updated_area
,
21597 DRAW_NORMAL_TEXT
, 0);
21599 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
21600 if (updated_area
== TEXT_AREA
21601 && updated_window
->phys_cursor_on_p
21602 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
21603 && updated_window
->phys_cursor
.hpos
>= hpos
21604 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
21605 updated_window
->phys_cursor_on_p
= 0;
21609 /* Advance the output cursor. */
21610 output_cursor
.hpos
+= len
;
21611 output_cursor
.x
= x
;
21616 Insert LEN glyphs from START at the nominal cursor position. */
21619 x_insert_glyphs (start
, len
)
21620 struct glyph
*start
;
21625 int line_height
, shift_by_width
, shifted_region_width
;
21626 struct glyph_row
*row
;
21627 struct glyph
*glyph
;
21628 int frame_x
, frame_y
;
21631 xassert (updated_window
&& updated_row
);
21633 w
= updated_window
;
21634 f
= XFRAME (WINDOW_FRAME (w
));
21636 /* Get the height of the line we are in. */
21638 line_height
= row
->height
;
21640 /* Get the width of the glyphs to insert. */
21641 shift_by_width
= 0;
21642 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
21643 shift_by_width
+= glyph
->pixel_width
;
21645 /* Get the width of the region to shift right. */
21646 shifted_region_width
= (window_box_width (w
, updated_area
)
21651 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
21652 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
21654 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
21655 line_height
, shift_by_width
);
21657 /* Write the glyphs. */
21658 hpos
= start
- row
->glyphs
[updated_area
];
21659 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
21661 DRAW_NORMAL_TEXT
, 0);
21663 /* Advance the output cursor. */
21664 output_cursor
.hpos
+= len
;
21665 output_cursor
.x
+= shift_by_width
;
21671 Erase the current text line from the nominal cursor position
21672 (inclusive) to pixel column TO_X (exclusive). The idea is that
21673 everything from TO_X onward is already erased.
21675 TO_X is a pixel position relative to updated_area of
21676 updated_window. TO_X == -1 means clear to the end of this area. */
21679 x_clear_end_of_line (to_x
)
21683 struct window
*w
= updated_window
;
21684 int max_x
, min_y
, max_y
;
21685 int from_x
, from_y
, to_y
;
21687 xassert (updated_window
&& updated_row
);
21688 f
= XFRAME (w
->frame
);
21690 if (updated_row
->full_width_p
)
21691 max_x
= WINDOW_TOTAL_WIDTH (w
);
21693 max_x
= window_box_width (w
, updated_area
);
21694 max_y
= window_text_bottom_y (w
);
21696 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
21697 of window. For TO_X > 0, truncate to end of drawing area. */
21703 to_x
= min (to_x
, max_x
);
21705 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
21707 /* Notice if the cursor will be cleared by this operation. */
21708 if (!updated_row
->full_width_p
)
21709 notice_overwritten_cursor (w
, updated_area
,
21710 output_cursor
.x
, -1,
21712 MATRIX_ROW_BOTTOM_Y (updated_row
));
21714 from_x
= output_cursor
.x
;
21716 /* Translate to frame coordinates. */
21717 if (updated_row
->full_width_p
)
21719 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
21720 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
21724 int area_left
= window_box_left (w
, updated_area
);
21725 from_x
+= area_left
;
21729 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
21730 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
21731 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
21733 /* Prevent inadvertently clearing to end of the X window. */
21734 if (to_x
> from_x
&& to_y
> from_y
)
21737 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
21738 to_x
- from_x
, to_y
- from_y
);
21743 #endif /* HAVE_WINDOW_SYSTEM */
21747 /***********************************************************************
21749 ***********************************************************************/
21751 /* Value is the internal representation of the specified cursor type
21752 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
21753 of the bar cursor. */
21755 static enum text_cursor_kinds
21756 get_specified_cursor_type (arg
, width
)
21760 enum text_cursor_kinds type
;
21765 if (EQ (arg
, Qbox
))
21766 return FILLED_BOX_CURSOR
;
21768 if (EQ (arg
, Qhollow
))
21769 return HOLLOW_BOX_CURSOR
;
21771 if (EQ (arg
, Qbar
))
21778 && EQ (XCAR (arg
), Qbar
)
21779 && INTEGERP (XCDR (arg
))
21780 && XINT (XCDR (arg
)) >= 0)
21782 *width
= XINT (XCDR (arg
));
21786 if (EQ (arg
, Qhbar
))
21789 return HBAR_CURSOR
;
21793 && EQ (XCAR (arg
), Qhbar
)
21794 && INTEGERP (XCDR (arg
))
21795 && XINT (XCDR (arg
)) >= 0)
21797 *width
= XINT (XCDR (arg
));
21798 return HBAR_CURSOR
;
21801 /* Treat anything unknown as "hollow box cursor".
21802 It was bad to signal an error; people have trouble fixing
21803 .Xdefaults with Emacs, when it has something bad in it. */
21804 type
= HOLLOW_BOX_CURSOR
;
21809 /* Set the default cursor types for specified frame. */
21811 set_frame_cursor_types (f
, arg
)
21818 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
21819 FRAME_CURSOR_WIDTH (f
) = width
;
21821 /* By default, set up the blink-off state depending on the on-state. */
21823 tem
= Fassoc (arg
, Vblink_cursor_alist
);
21826 FRAME_BLINK_OFF_CURSOR (f
)
21827 = get_specified_cursor_type (XCDR (tem
), &width
);
21828 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
21831 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
21835 /* Return the cursor we want to be displayed in window W. Return
21836 width of bar/hbar cursor through WIDTH arg. Return with
21837 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
21838 (i.e. if the `system caret' should track this cursor).
21840 In a mini-buffer window, we want the cursor only to appear if we
21841 are reading input from this window. For the selected window, we
21842 want the cursor type given by the frame parameter or buffer local
21843 setting of cursor-type. If explicitly marked off, draw no cursor.
21844 In all other cases, we want a hollow box cursor. */
21846 static enum text_cursor_kinds
21847 get_window_cursor_type (w
, glyph
, width
, active_cursor
)
21849 struct glyph
*glyph
;
21851 int *active_cursor
;
21853 struct frame
*f
= XFRAME (w
->frame
);
21854 struct buffer
*b
= XBUFFER (w
->buffer
);
21855 int cursor_type
= DEFAULT_CURSOR
;
21856 Lisp_Object alt_cursor
;
21857 int non_selected
= 0;
21859 *active_cursor
= 1;
21862 if (cursor_in_echo_area
21863 && FRAME_HAS_MINIBUF_P (f
)
21864 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
21866 if (w
== XWINDOW (echo_area_window
))
21868 if (EQ (b
->cursor_type
, Qt
) || NILP (b
->cursor_type
))
21870 *width
= FRAME_CURSOR_WIDTH (f
);
21871 return FRAME_DESIRED_CURSOR (f
);
21874 return get_specified_cursor_type (b
->cursor_type
, width
);
21877 *active_cursor
= 0;
21881 /* Detect a nonselected window or nonselected frame. */
21882 else if (w
!= XWINDOW (f
->selected_window
)
21883 #ifdef HAVE_WINDOW_SYSTEM
21884 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
21888 *active_cursor
= 0;
21890 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
21896 /* Never display a cursor in a window in which cursor-type is nil. */
21897 if (NILP (b
->cursor_type
))
21900 /* Get the normal cursor type for this window. */
21901 if (EQ (b
->cursor_type
, Qt
))
21903 cursor_type
= FRAME_DESIRED_CURSOR (f
);
21904 *width
= FRAME_CURSOR_WIDTH (f
);
21907 cursor_type
= get_specified_cursor_type (b
->cursor_type
, width
);
21909 /* Use cursor-in-non-selected-windows instead
21910 for non-selected window or frame. */
21913 alt_cursor
= b
->cursor_in_non_selected_windows
;
21914 if (!EQ (Qt
, alt_cursor
))
21915 return get_specified_cursor_type (alt_cursor
, width
);
21916 /* t means modify the normal cursor type. */
21917 if (cursor_type
== FILLED_BOX_CURSOR
)
21918 cursor_type
= HOLLOW_BOX_CURSOR
;
21919 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
21921 return cursor_type
;
21924 /* Use normal cursor if not blinked off. */
21925 if (!w
->cursor_off_p
)
21927 #ifdef HAVE_WINDOW_SYSTEM
21928 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
21930 if (cursor_type
== FILLED_BOX_CURSOR
)
21932 /* Using a block cursor on large images can be very annoying.
21933 So use a hollow cursor for "large" images.
21934 If image is not transparent (no mask), also use hollow cursor. */
21935 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
21936 if (img
!= NULL
&& IMAGEP (img
->spec
))
21938 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
21939 where N = size of default frame font size.
21940 This should cover most of the "tiny" icons people may use. */
21942 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
21943 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
21944 cursor_type
= HOLLOW_BOX_CURSOR
;
21947 else if (cursor_type
!= NO_CURSOR
)
21949 /* Display current only supports BOX and HOLLOW cursors for images.
21950 So for now, unconditionally use a HOLLOW cursor when cursor is
21951 not a solid box cursor. */
21952 cursor_type
= HOLLOW_BOX_CURSOR
;
21956 return cursor_type
;
21959 /* Cursor is blinked off, so determine how to "toggle" it. */
21961 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
21962 if ((alt_cursor
= Fassoc (b
->cursor_type
, Vblink_cursor_alist
), !NILP (alt_cursor
)))
21963 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
21965 /* Then see if frame has specified a specific blink off cursor type. */
21966 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
21968 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
21969 return FRAME_BLINK_OFF_CURSOR (f
);
21973 /* Some people liked having a permanently visible blinking cursor,
21974 while others had very strong opinions against it. So it was
21975 decided to remove it. KFS 2003-09-03 */
21977 /* Finally perform built-in cursor blinking:
21978 filled box <-> hollow box
21979 wide [h]bar <-> narrow [h]bar
21980 narrow [h]bar <-> no cursor
21981 other type <-> no cursor */
21983 if (cursor_type
== FILLED_BOX_CURSOR
)
21984 return HOLLOW_BOX_CURSOR
;
21986 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
21989 return cursor_type
;
21997 #ifdef HAVE_WINDOW_SYSTEM
21999 /* Notice when the text cursor of window W has been completely
22000 overwritten by a drawing operation that outputs glyphs in AREA
22001 starting at X0 and ending at X1 in the line starting at Y0 and
22002 ending at Y1. X coordinates are area-relative. X1 < 0 means all
22003 the rest of the line after X0 has been written. Y coordinates
22004 are window-relative. */
22007 notice_overwritten_cursor (w
, area
, x0
, x1
, y0
, y1
)
22009 enum glyph_row_area area
;
22010 int x0
, y0
, x1
, y1
;
22012 int cx0
, cx1
, cy0
, cy1
;
22013 struct glyph_row
*row
;
22015 if (!w
->phys_cursor_on_p
)
22017 if (area
!= TEXT_AREA
)
22020 if (w
->phys_cursor
.vpos
< 0
22021 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
22022 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
22023 !(row
->enabled_p
&& row
->displays_text_p
)))
22026 if (row
->cursor_in_fringe_p
)
22028 row
->cursor_in_fringe_p
= 0;
22029 draw_fringe_bitmap (w
, row
, 0);
22030 w
->phys_cursor_on_p
= 0;
22034 cx0
= w
->phys_cursor
.x
;
22035 cx1
= cx0
+ w
->phys_cursor_width
;
22036 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
22039 /* The cursor image will be completely removed from the
22040 screen if the output area intersects the cursor area in
22041 y-direction. When we draw in [y0 y1[, and some part of
22042 the cursor is at y < y0, that part must have been drawn
22043 before. When scrolling, the cursor is erased before
22044 actually scrolling, so we don't come here. When not
22045 scrolling, the rows above the old cursor row must have
22046 changed, and in this case these rows must have written
22047 over the cursor image.
22049 Likewise if part of the cursor is below y1, with the
22050 exception of the cursor being in the first blank row at
22051 the buffer and window end because update_text_area
22052 doesn't draw that row. (Except when it does, but
22053 that's handled in update_text_area.) */
22055 cy0
= w
->phys_cursor
.y
;
22056 cy1
= cy0
+ w
->phys_cursor_height
;
22057 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
22060 w
->phys_cursor_on_p
= 0;
22063 #endif /* HAVE_WINDOW_SYSTEM */
22066 /************************************************************************
22068 ************************************************************************/
22070 #ifdef HAVE_WINDOW_SYSTEM
22073 Fix the display of area AREA of overlapping row ROW in window W
22074 with respect to the overlapping part OVERLAPS. */
22077 x_fix_overlapping_area (w
, row
, area
, overlaps
)
22079 struct glyph_row
*row
;
22080 enum glyph_row_area area
;
22088 for (i
= 0; i
< row
->used
[area
];)
22090 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
22092 int start
= i
, start_x
= x
;
22096 x
+= row
->glyphs
[area
][i
].pixel_width
;
22099 while (i
< row
->used
[area
]
22100 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
22102 draw_glyphs (w
, start_x
, row
, area
,
22104 DRAW_NORMAL_TEXT
, overlaps
);
22108 x
+= row
->glyphs
[area
][i
].pixel_width
;
22118 Draw the cursor glyph of window W in glyph row ROW. See the
22119 comment of draw_glyphs for the meaning of HL. */
22122 draw_phys_cursor_glyph (w
, row
, hl
)
22124 struct glyph_row
*row
;
22125 enum draw_glyphs_face hl
;
22127 /* If cursor hpos is out of bounds, don't draw garbage. This can
22128 happen in mini-buffer windows when switching between echo area
22129 glyphs and mini-buffer. */
22130 if (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])
22132 int on_p
= w
->phys_cursor_on_p
;
22134 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
22135 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
22137 w
->phys_cursor_on_p
= on_p
;
22139 if (hl
== DRAW_CURSOR
)
22140 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
22141 /* When we erase the cursor, and ROW is overlapped by other
22142 rows, make sure that these overlapping parts of other rows
22144 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
22146 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
22148 if (row
> w
->current_matrix
->rows
22149 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
22150 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
22151 OVERLAPS_ERASED_CURSOR
);
22153 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
22154 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
22155 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
22156 OVERLAPS_ERASED_CURSOR
);
22163 Erase the image of a cursor of window W from the screen. */
22166 erase_phys_cursor (w
)
22169 struct frame
*f
= XFRAME (w
->frame
);
22170 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
22171 int hpos
= w
->phys_cursor
.hpos
;
22172 int vpos
= w
->phys_cursor
.vpos
;
22173 int mouse_face_here_p
= 0;
22174 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
22175 struct glyph_row
*cursor_row
;
22176 struct glyph
*cursor_glyph
;
22177 enum draw_glyphs_face hl
;
22179 /* No cursor displayed or row invalidated => nothing to do on the
22181 if (w
->phys_cursor_type
== NO_CURSOR
)
22182 goto mark_cursor_off
;
22184 /* VPOS >= active_glyphs->nrows means that window has been resized.
22185 Don't bother to erase the cursor. */
22186 if (vpos
>= active_glyphs
->nrows
)
22187 goto mark_cursor_off
;
22189 /* If row containing cursor is marked invalid, there is nothing we
22191 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
22192 if (!cursor_row
->enabled_p
)
22193 goto mark_cursor_off
;
22195 /* If line spacing is > 0, old cursor may only be partially visible in
22196 window after split-window. So adjust visible height. */
22197 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
22198 window_text_bottom_y (w
) - cursor_row
->y
);
22200 /* If row is completely invisible, don't attempt to delete a cursor which
22201 isn't there. This can happen if cursor is at top of a window, and
22202 we switch to a buffer with a header line in that window. */
22203 if (cursor_row
->visible_height
<= 0)
22204 goto mark_cursor_off
;
22206 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
22207 if (cursor_row
->cursor_in_fringe_p
)
22209 cursor_row
->cursor_in_fringe_p
= 0;
22210 draw_fringe_bitmap (w
, cursor_row
, 0);
22211 goto mark_cursor_off
;
22214 /* This can happen when the new row is shorter than the old one.
22215 In this case, either draw_glyphs or clear_end_of_line
22216 should have cleared the cursor. Note that we wouldn't be
22217 able to erase the cursor in this case because we don't have a
22218 cursor glyph at hand. */
22219 if (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])
22220 goto mark_cursor_off
;
22222 /* If the cursor is in the mouse face area, redisplay that when
22223 we clear the cursor. */
22224 if (! NILP (dpyinfo
->mouse_face_window
)
22225 && w
== XWINDOW (dpyinfo
->mouse_face_window
)
22226 && (vpos
> dpyinfo
->mouse_face_beg_row
22227 || (vpos
== dpyinfo
->mouse_face_beg_row
22228 && hpos
>= dpyinfo
->mouse_face_beg_col
))
22229 && (vpos
< dpyinfo
->mouse_face_end_row
22230 || (vpos
== dpyinfo
->mouse_face_end_row
22231 && hpos
< dpyinfo
->mouse_face_end_col
))
22232 /* Don't redraw the cursor's spot in mouse face if it is at the
22233 end of a line (on a newline). The cursor appears there, but
22234 mouse highlighting does not. */
22235 && cursor_row
->used
[TEXT_AREA
] > hpos
)
22236 mouse_face_here_p
= 1;
22238 /* Maybe clear the display under the cursor. */
22239 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
22242 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
22245 cursor_glyph
= get_phys_cursor_glyph (w
);
22246 if (cursor_glyph
== NULL
)
22247 goto mark_cursor_off
;
22249 width
= cursor_glyph
->pixel_width
;
22250 left_x
= window_box_left_offset (w
, TEXT_AREA
);
22251 x
= w
->phys_cursor
.x
;
22253 width
-= left_x
- x
;
22254 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
22255 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
22256 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
22259 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
22262 /* Erase the cursor by redrawing the character underneath it. */
22263 if (mouse_face_here_p
)
22264 hl
= DRAW_MOUSE_FACE
;
22266 hl
= DRAW_NORMAL_TEXT
;
22267 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
22270 w
->phys_cursor_on_p
= 0;
22271 w
->phys_cursor_type
= NO_CURSOR
;
22276 Display or clear cursor of window W. If ON is zero, clear the
22277 cursor. If it is non-zero, display the cursor. If ON is nonzero,
22278 where to put the cursor is specified by HPOS, VPOS, X and Y. */
22281 display_and_set_cursor (w
, on
, hpos
, vpos
, x
, y
)
22283 int on
, hpos
, vpos
, x
, y
;
22285 struct frame
*f
= XFRAME (w
->frame
);
22286 int new_cursor_type
;
22287 int new_cursor_width
;
22289 struct glyph_row
*glyph_row
;
22290 struct glyph
*glyph
;
22292 /* This is pointless on invisible frames, and dangerous on garbaged
22293 windows and frames; in the latter case, the frame or window may
22294 be in the midst of changing its size, and x and y may be off the
22296 if (! FRAME_VISIBLE_P (f
)
22297 || FRAME_GARBAGED_P (f
)
22298 || vpos
>= w
->current_matrix
->nrows
22299 || hpos
>= w
->current_matrix
->matrix_w
)
22302 /* If cursor is off and we want it off, return quickly. */
22303 if (!on
&& !w
->phys_cursor_on_p
)
22306 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
22307 /* If cursor row is not enabled, we don't really know where to
22308 display the cursor. */
22309 if (!glyph_row
->enabled_p
)
22311 w
->phys_cursor_on_p
= 0;
22316 if (!glyph_row
->exact_window_width_line_p
22317 || hpos
< glyph_row
->used
[TEXT_AREA
])
22318 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
22320 xassert (interrupt_input_blocked
);
22322 /* Set new_cursor_type to the cursor we want to be displayed. */
22323 new_cursor_type
= get_window_cursor_type (w
, glyph
,
22324 &new_cursor_width
, &active_cursor
);
22326 /* If cursor is currently being shown and we don't want it to be or
22327 it is in the wrong place, or the cursor type is not what we want,
22329 if (w
->phys_cursor_on_p
22331 || w
->phys_cursor
.x
!= x
22332 || w
->phys_cursor
.y
!= y
22333 || new_cursor_type
!= w
->phys_cursor_type
22334 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
22335 && new_cursor_width
!= w
->phys_cursor_width
)))
22336 erase_phys_cursor (w
);
22338 /* Don't check phys_cursor_on_p here because that flag is only set
22339 to zero in some cases where we know that the cursor has been
22340 completely erased, to avoid the extra work of erasing the cursor
22341 twice. In other words, phys_cursor_on_p can be 1 and the cursor
22342 still not be visible, or it has only been partly erased. */
22345 w
->phys_cursor_ascent
= glyph_row
->ascent
;
22346 w
->phys_cursor_height
= glyph_row
->height
;
22348 /* Set phys_cursor_.* before x_draw_.* is called because some
22349 of them may need the information. */
22350 w
->phys_cursor
.x
= x
;
22351 w
->phys_cursor
.y
= glyph_row
->y
;
22352 w
->phys_cursor
.hpos
= hpos
;
22353 w
->phys_cursor
.vpos
= vpos
;
22356 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
22357 new_cursor_type
, new_cursor_width
,
22358 on
, active_cursor
);
22362 /* Switch the display of W's cursor on or off, according to the value
22366 update_window_cursor (w
, on
)
22370 /* Don't update cursor in windows whose frame is in the process
22371 of being deleted. */
22372 if (w
->current_matrix
)
22375 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
22376 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
22382 /* Call update_window_cursor with parameter ON_P on all leaf windows
22383 in the window tree rooted at W. */
22386 update_cursor_in_window_tree (w
, on_p
)
22392 if (!NILP (w
->hchild
))
22393 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
22394 else if (!NILP (w
->vchild
))
22395 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
22397 update_window_cursor (w
, on_p
);
22399 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
22405 Display the cursor on window W, or clear it, according to ON_P.
22406 Don't change the cursor's position. */
22409 x_update_cursor (f
, on_p
)
22413 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
22418 Clear the cursor of window W to background color, and mark the
22419 cursor as not shown. This is used when the text where the cursor
22420 is is about to be rewritten. */
22426 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
22427 update_window_cursor (w
, 0);
22432 Display the active region described by mouse_face_* according to DRAW. */
22435 show_mouse_face (dpyinfo
, draw
)
22436 Display_Info
*dpyinfo
;
22437 enum draw_glyphs_face draw
;
22439 struct window
*w
= XWINDOW (dpyinfo
->mouse_face_window
);
22440 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22442 if (/* If window is in the process of being destroyed, don't bother
22444 w
->current_matrix
!= NULL
22445 /* Don't update mouse highlight if hidden */
22446 && (draw
!= DRAW_MOUSE_FACE
|| !dpyinfo
->mouse_face_hidden
)
22447 /* Recognize when we are called to operate on rows that don't exist
22448 anymore. This can happen when a window is split. */
22449 && dpyinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
22451 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
22452 struct glyph_row
*row
, *first
, *last
;
22454 first
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
22455 last
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
22457 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
22459 int start_hpos
, end_hpos
, start_x
;
22461 /* For all but the first row, the highlight starts at column 0. */
22464 start_hpos
= dpyinfo
->mouse_face_beg_col
;
22465 start_x
= dpyinfo
->mouse_face_beg_x
;
22474 end_hpos
= dpyinfo
->mouse_face_end_col
;
22477 end_hpos
= row
->used
[TEXT_AREA
];
22478 if (draw
== DRAW_NORMAL_TEXT
)
22479 row
->fill_line_p
= 1; /* Clear to end of line */
22482 if (end_hpos
> start_hpos
)
22484 draw_glyphs (w
, start_x
, row
, TEXT_AREA
,
22485 start_hpos
, end_hpos
,
22489 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
22493 /* When we've written over the cursor, arrange for it to
22494 be displayed again. */
22495 if (phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
22498 display_and_set_cursor (w
, 1,
22499 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
22500 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
22505 /* Change the mouse cursor. */
22506 if (draw
== DRAW_NORMAL_TEXT
&& !EQ (dpyinfo
->mouse_face_window
, f
->tool_bar_window
))
22507 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
22508 else if (draw
== DRAW_MOUSE_FACE
)
22509 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
22511 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
22515 Clear out the mouse-highlighted active region.
22516 Redraw it un-highlighted first. Value is non-zero if mouse
22517 face was actually drawn unhighlighted. */
22520 clear_mouse_face (dpyinfo
)
22521 Display_Info
*dpyinfo
;
22525 if (!dpyinfo
->mouse_face_hidden
&& !NILP (dpyinfo
->mouse_face_window
))
22527 show_mouse_face (dpyinfo
, DRAW_NORMAL_TEXT
);
22531 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
22532 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
22533 dpyinfo
->mouse_face_window
= Qnil
;
22534 dpyinfo
->mouse_face_overlay
= Qnil
;
22540 Non-zero if physical cursor of window W is within mouse face. */
22543 cursor_in_mouse_face_p (w
)
22546 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
22547 int in_mouse_face
= 0;
22549 if (WINDOWP (dpyinfo
->mouse_face_window
)
22550 && XWINDOW (dpyinfo
->mouse_face_window
) == w
)
22552 int hpos
= w
->phys_cursor
.hpos
;
22553 int vpos
= w
->phys_cursor
.vpos
;
22555 if (vpos
>= dpyinfo
->mouse_face_beg_row
22556 && vpos
<= dpyinfo
->mouse_face_end_row
22557 && (vpos
> dpyinfo
->mouse_face_beg_row
22558 || hpos
>= dpyinfo
->mouse_face_beg_col
)
22559 && (vpos
< dpyinfo
->mouse_face_end_row
22560 || hpos
< dpyinfo
->mouse_face_end_col
22561 || dpyinfo
->mouse_face_past_end
))
22565 return in_mouse_face
;
22571 /* Find the glyph matrix position of buffer position CHARPOS in window
22572 *W. HPOS, *VPOS, *X, and *Y are set to the positions found. W's
22573 current glyphs must be up to date. If CHARPOS is above window
22574 start return (0, 0, 0, 0). If CHARPOS is after end of W, return end
22575 of last line in W. In the row containing CHARPOS, stop before glyphs
22576 having STOP as object. */
22578 #if 1 /* This is a version of fast_find_position that's more correct
22579 in the presence of hscrolling, for example. I didn't install
22580 it right away because the problem fixed is minor, it failed
22581 in 20.x as well, and I think it's too risky to install
22582 so near the release of 21.1. 2001-09-25 gerd. */
22584 #ifndef HAVE_CARBON
22588 fast_find_position (w
, charpos
, hpos
, vpos
, x
, y
, stop
)
22591 int *hpos
, *vpos
, *x
, *y
;
22594 struct glyph_row
*row
, *first
;
22595 struct glyph
*glyph
, *end
;
22598 first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
22599 if (charpos
< MATRIX_ROW_START_CHARPOS (first
))
22604 *vpos
= MATRIX_ROW_VPOS (first
, w
->current_matrix
);
22608 row
= row_containing_pos (w
, charpos
, first
, NULL
, 0);
22611 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
22615 /* If whole rows or last part of a row came from a display overlay,
22616 row_containing_pos will skip over such rows because their end pos
22617 equals the start pos of the overlay or interval.
22619 Move back if we have a STOP object and previous row's
22620 end glyph came from STOP. */
22623 struct glyph_row
*prev
;
22624 while ((prev
= row
- 1, prev
>= first
)
22625 && MATRIX_ROW_END_CHARPOS (prev
) == charpos
22626 && prev
->used
[TEXT_AREA
] > 0)
22628 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
22629 glyph
= beg
+ prev
->used
[TEXT_AREA
];
22630 while (--glyph
>= beg
22631 && INTEGERP (glyph
->object
));
22633 || !EQ (stop
, glyph
->object
))
22641 *vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
22643 glyph
= row
->glyphs
[TEXT_AREA
];
22644 end
= glyph
+ row
->used
[TEXT_AREA
];
22646 /* Skip over glyphs not having an object at the start of the row.
22647 These are special glyphs like truncation marks on terminal
22649 if (row
->displays_text_p
)
22651 && INTEGERP (glyph
->object
)
22652 && !EQ (stop
, glyph
->object
)
22653 && glyph
->charpos
< 0)
22655 *x
+= glyph
->pixel_width
;
22660 && !INTEGERP (glyph
->object
)
22661 && !EQ (stop
, glyph
->object
)
22662 && (!BUFFERP (glyph
->object
)
22663 || glyph
->charpos
< charpos
))
22665 *x
+= glyph
->pixel_width
;
22669 *hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
22676 fast_find_position (w
, pos
, hpos
, vpos
, x
, y
, stop
)
22679 int *hpos
, *vpos
, *x
, *y
;
22684 int maybe_next_line_p
= 0;
22685 int line_start_position
;
22686 int yb
= window_text_bottom_y (w
);
22687 struct glyph_row
*row
, *best_row
;
22688 int row_vpos
, best_row_vpos
;
22691 row
= best_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
22692 row_vpos
= best_row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
22694 while (row
->y
< yb
)
22696 if (row
->used
[TEXT_AREA
])
22697 line_start_position
= row
->glyphs
[TEXT_AREA
]->charpos
;
22699 line_start_position
= 0;
22701 if (line_start_position
> pos
)
22703 /* If the position sought is the end of the buffer,
22704 don't include the blank lines at the bottom of the window. */
22705 else if (line_start_position
== pos
22706 && pos
== BUF_ZV (XBUFFER (w
->buffer
)))
22708 maybe_next_line_p
= 1;
22711 else if (line_start_position
> 0)
22714 best_row_vpos
= row_vpos
;
22717 if (row
->y
+ row
->height
>= yb
)
22724 /* Find the right column within BEST_ROW. */
22726 current_x
= best_row
->x
;
22727 for (i
= 0; i
< best_row
->used
[TEXT_AREA
]; i
++)
22729 struct glyph
*glyph
= best_row
->glyphs
[TEXT_AREA
] + i
;
22730 int charpos
= glyph
->charpos
;
22732 if (BUFFERP (glyph
->object
))
22734 if (charpos
== pos
)
22737 *vpos
= best_row_vpos
;
22742 else if (charpos
> pos
)
22745 else if (EQ (glyph
->object
, stop
))
22750 current_x
+= glyph
->pixel_width
;
22753 /* If we're looking for the end of the buffer,
22754 and we didn't find it in the line we scanned,
22755 use the start of the following line. */
22756 if (maybe_next_line_p
)
22761 current_x
= best_row
->x
;
22764 *vpos
= best_row_vpos
;
22765 *hpos
= lastcol
+ 1;
22774 /* Find the position of the glyph for position POS in OBJECT in
22775 window W's current matrix, and return in *X, *Y the pixel
22776 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
22778 RIGHT_P non-zero means return the position of the right edge of the
22779 glyph, RIGHT_P zero means return the left edge position.
22781 If no glyph for POS exists in the matrix, return the position of
22782 the glyph with the next smaller position that is in the matrix, if
22783 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
22784 exists in the matrix, return the position of the glyph with the
22785 next larger position in OBJECT.
22787 Value is non-zero if a glyph was found. */
22790 fast_find_string_pos (w
, pos
, object
, hpos
, vpos
, x
, y
, right_p
)
22793 Lisp_Object object
;
22794 int *hpos
, *vpos
, *x
, *y
;
22797 int yb
= window_text_bottom_y (w
);
22798 struct glyph_row
*r
;
22799 struct glyph
*best_glyph
= NULL
;
22800 struct glyph_row
*best_row
= NULL
;
22803 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
22804 r
->enabled_p
&& r
->y
< yb
;
22807 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
22808 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
22811 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
22812 if (EQ (g
->object
, object
))
22814 if (g
->charpos
== pos
)
22821 else if (best_glyph
== NULL
22822 || ((eabs (g
->charpos
- pos
)
22823 < eabs (best_glyph
->charpos
- pos
))
22826 : g
->charpos
> pos
)))
22840 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
22844 *x
+= best_glyph
->pixel_width
;
22849 *vpos
= best_row
- w
->current_matrix
->rows
;
22852 return best_glyph
!= NULL
;
22856 /* See if position X, Y is within a hot-spot of an image. */
22859 on_hot_spot_p (hot_spot
, x
, y
)
22860 Lisp_Object hot_spot
;
22863 if (!CONSP (hot_spot
))
22866 if (EQ (XCAR (hot_spot
), Qrect
))
22868 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
22869 Lisp_Object rect
= XCDR (hot_spot
);
22873 if (!CONSP (XCAR (rect
)))
22875 if (!CONSP (XCDR (rect
)))
22877 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
22879 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
22881 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
22883 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
22887 else if (EQ (XCAR (hot_spot
), Qcircle
))
22889 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
22890 Lisp_Object circ
= XCDR (hot_spot
);
22891 Lisp_Object lr
, lx0
, ly0
;
22893 && CONSP (XCAR (circ
))
22894 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
22895 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
22896 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
22898 double r
= XFLOATINT (lr
);
22899 double dx
= XINT (lx0
) - x
;
22900 double dy
= XINT (ly0
) - y
;
22901 return (dx
* dx
+ dy
* dy
<= r
* r
);
22904 else if (EQ (XCAR (hot_spot
), Qpoly
))
22906 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
22907 if (VECTORP (XCDR (hot_spot
)))
22909 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
22910 Lisp_Object
*poly
= v
->contents
;
22914 Lisp_Object lx
, ly
;
22917 /* Need an even number of coordinates, and at least 3 edges. */
22918 if (n
< 6 || n
& 1)
22921 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
22922 If count is odd, we are inside polygon. Pixels on edges
22923 may or may not be included depending on actual geometry of the
22925 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
22926 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
22928 x0
= XINT (lx
), y0
= XINT (ly
);
22929 for (i
= 0; i
< n
; i
+= 2)
22931 int x1
= x0
, y1
= y0
;
22932 if ((lx
= poly
[i
], !INTEGERP (lx
))
22933 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
22935 x0
= XINT (lx
), y0
= XINT (ly
);
22937 /* Does this segment cross the X line? */
22945 if (y
> y0
&& y
> y1
)
22947 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
22957 find_hot_spot (map
, x
, y
)
22961 while (CONSP (map
))
22963 if (CONSP (XCAR (map
))
22964 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
22972 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
22974 doc
: /* Lookup in image map MAP coordinates X and Y.
22975 An image map is an alist where each element has the format (AREA ID PLIST).
22976 An AREA is specified as either a rectangle, a circle, or a polygon:
22977 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
22978 pixel coordinates of the upper left and bottom right corners.
22979 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
22980 and the radius of the circle; r may be a float or integer.
22981 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
22982 vector describes one corner in the polygon.
22983 Returns the alist element for the first matching AREA in MAP. */)
22994 return find_hot_spot (map
, XINT (x
), XINT (y
));
22998 /* Display frame CURSOR, optionally using shape defined by POINTER. */
23000 define_frame_cursor1 (f
, cursor
, pointer
)
23003 Lisp_Object pointer
;
23005 /* Do not change cursor shape while dragging mouse. */
23006 if (!NILP (do_mouse_tracking
))
23009 if (!NILP (pointer
))
23011 if (EQ (pointer
, Qarrow
))
23012 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23013 else if (EQ (pointer
, Qhand
))
23014 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
23015 else if (EQ (pointer
, Qtext
))
23016 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
23017 else if (EQ (pointer
, intern ("hdrag")))
23018 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
23019 #ifdef HAVE_X_WINDOWS
23020 else if (EQ (pointer
, intern ("vdrag")))
23021 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
23023 else if (EQ (pointer
, intern ("hourglass")))
23024 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
23025 else if (EQ (pointer
, Qmodeline
))
23026 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
23028 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23031 if (cursor
!= No_Cursor
)
23032 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
23035 /* Take proper action when mouse has moved to the mode or header line
23036 or marginal area AREA of window W, x-position X and y-position Y.
23037 X is relative to the start of the text display area of W, so the
23038 width of bitmap areas and scroll bars must be subtracted to get a
23039 position relative to the start of the mode line. */
23042 note_mode_line_or_margin_highlight (window
, x
, y
, area
)
23043 Lisp_Object window
;
23045 enum window_part area
;
23047 struct window
*w
= XWINDOW (window
);
23048 struct frame
*f
= XFRAME (w
->frame
);
23049 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
23050 Cursor cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23051 Lisp_Object pointer
= Qnil
;
23052 int charpos
, dx
, dy
, width
, height
;
23053 Lisp_Object string
, object
= Qnil
;
23054 Lisp_Object pos
, help
;
23056 Lisp_Object mouse_face
;
23057 int original_x_pixel
= x
;
23058 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
23059 struct glyph_row
*row
;
23061 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
23066 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
23067 &object
, &dx
, &dy
, &width
, &height
);
23069 row
= (area
== ON_MODE_LINE
23070 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
23071 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
23074 if (row
->mode_line_p
&& row
->enabled_p
)
23076 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
23077 end
= glyph
+ row
->used
[TEXT_AREA
];
23079 for (x0
= original_x_pixel
;
23080 glyph
< end
&& x0
>= glyph
->pixel_width
;
23082 x0
-= glyph
->pixel_width
;
23090 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
23091 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
23092 &object
, &dx
, &dy
, &width
, &height
);
23097 if (IMAGEP (object
))
23099 Lisp_Object image_map
, hotspot
;
23100 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
23102 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
23104 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
23106 Lisp_Object area_id
, plist
;
23108 area_id
= XCAR (hotspot
);
23109 /* Could check AREA_ID to see if we enter/leave this hot-spot.
23110 If so, we could look for mouse-enter, mouse-leave
23111 properties in PLIST (and do something...). */
23112 hotspot
= XCDR (hotspot
);
23113 if (CONSP (hotspot
)
23114 && (plist
= XCAR (hotspot
), CONSP (plist
)))
23116 pointer
= Fplist_get (plist
, Qpointer
);
23117 if (NILP (pointer
))
23119 help
= Fplist_get (plist
, Qhelp_echo
);
23122 help_echo_string
= help
;
23123 /* Is this correct? ++kfs */
23124 XSETWINDOW (help_echo_window
, w
);
23125 help_echo_object
= w
->buffer
;
23126 help_echo_pos
= charpos
;
23130 if (NILP (pointer
))
23131 pointer
= Fplist_get (XCDR (object
), QCpointer
);
23134 if (STRINGP (string
))
23136 pos
= make_number (charpos
);
23137 /* If we're on a string with `help-echo' text property, arrange
23138 for the help to be displayed. This is done by setting the
23139 global variable help_echo_string to the help string. */
23142 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
23145 help_echo_string
= help
;
23146 XSETWINDOW (help_echo_window
, w
);
23147 help_echo_object
= string
;
23148 help_echo_pos
= charpos
;
23152 if (NILP (pointer
))
23153 pointer
= Fget_text_property (pos
, Qpointer
, string
);
23155 /* Change the mouse pointer according to what is under X/Y. */
23156 if (NILP (pointer
) && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
23159 map
= Fget_text_property (pos
, Qlocal_map
, string
);
23160 if (!KEYMAPP (map
))
23161 map
= Fget_text_property (pos
, Qkeymap
, string
);
23162 if (!KEYMAPP (map
))
23163 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
23166 /* Change the mouse face according to what is under X/Y. */
23167 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
23168 if (!NILP (mouse_face
)
23169 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
23174 struct glyph
* tmp_glyph
;
23178 int total_pixel_width
;
23183 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
23184 Qmouse_face
, string
, Qnil
);
23186 b
= make_number (0);
23188 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
23190 e
= make_number (SCHARS (string
));
23192 /* Calculate the position(glyph position: GPOS) of GLYPH in
23193 displayed string. GPOS is different from CHARPOS.
23195 CHARPOS is the position of glyph in internal string
23196 object. A mode line string format has structures which
23197 is converted to a flatten by emacs lisp interpreter.
23198 The internal string is an element of the structures.
23199 The displayed string is the flatten string. */
23201 if (glyph
> row_start_glyph
)
23203 tmp_glyph
= glyph
- 1;
23204 while (tmp_glyph
>= row_start_glyph
23205 && tmp_glyph
->charpos
>= XINT (b
)
23206 && EQ (tmp_glyph
->object
, glyph
->object
))
23213 /* Calculate the lenght(glyph sequence length: GSEQ_LENGTH) of
23214 displayed string holding GLYPH.
23216 GSEQ_LENGTH is different from SCHARS (STRING).
23217 SCHARS (STRING) returns the length of the internal string. */
23218 for (tmp_glyph
= glyph
, gseq_length
= gpos
;
23219 tmp_glyph
->charpos
< XINT (e
);
23220 tmp_glyph
++, gseq_length
++)
23222 if (!EQ (tmp_glyph
->object
, glyph
->object
))
23226 total_pixel_width
= 0;
23227 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
23228 total_pixel_width
+= tmp_glyph
->pixel_width
;
23230 /* Pre calculation of re-rendering position */
23232 hpos
= (area
== ON_MODE_LINE
23233 ? (w
->current_matrix
)->nrows
- 1
23236 /* If the re-rendering position is included in the last
23237 re-rendering area, we should do nothing. */
23238 if ( EQ (window
, dpyinfo
->mouse_face_window
)
23239 && dpyinfo
->mouse_face_beg_col
<= vpos
23240 && vpos
< dpyinfo
->mouse_face_end_col
23241 && dpyinfo
->mouse_face_beg_row
== hpos
)
23244 if (clear_mouse_face (dpyinfo
))
23245 cursor
= No_Cursor
;
23247 dpyinfo
->mouse_face_beg_col
= vpos
;
23248 dpyinfo
->mouse_face_beg_row
= hpos
;
23250 dpyinfo
->mouse_face_beg_x
= original_x_pixel
- (total_pixel_width
+ dx
);
23251 dpyinfo
->mouse_face_beg_y
= 0;
23253 dpyinfo
->mouse_face_end_col
= vpos
+ gseq_length
;
23254 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_beg_row
;
23256 dpyinfo
->mouse_face_end_x
= 0;
23257 dpyinfo
->mouse_face_end_y
= 0;
23259 dpyinfo
->mouse_face_past_end
= 0;
23260 dpyinfo
->mouse_face_window
= window
;
23262 dpyinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
23265 glyph
->face_id
, 1);
23266 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23268 if (NILP (pointer
))
23271 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
23272 clear_mouse_face (dpyinfo
);
23274 define_frame_cursor1 (f
, cursor
, pointer
);
23279 Take proper action when the mouse has moved to position X, Y on
23280 frame F as regards highlighting characters that have mouse-face
23281 properties. Also de-highlighting chars where the mouse was before.
23282 X and Y can be negative or out of range. */
23285 note_mouse_highlight (f
, x
, y
)
23289 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
23290 enum window_part part
;
23291 Lisp_Object window
;
23293 Cursor cursor
= No_Cursor
;
23294 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
23297 /* When a menu is active, don't highlight because this looks odd. */
23298 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (MAC_OS)
23299 if (popup_activated ())
23303 if (NILP (Vmouse_highlight
)
23304 || !f
->glyphs_initialized_p
)
23307 dpyinfo
->mouse_face_mouse_x
= x
;
23308 dpyinfo
->mouse_face_mouse_y
= y
;
23309 dpyinfo
->mouse_face_mouse_frame
= f
;
23311 if (dpyinfo
->mouse_face_defer
)
23314 if (gc_in_progress
)
23316 dpyinfo
->mouse_face_deferred_gc
= 1;
23320 /* Which window is that in? */
23321 window
= window_from_coordinates (f
, x
, y
, &part
, 0, 0, 1);
23323 /* If we were displaying active text in another window, clear that.
23324 Also clear if we move out of text area in same window. */
23325 if (! EQ (window
, dpyinfo
->mouse_face_window
)
23326 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
23327 && !NILP (dpyinfo
->mouse_face_window
)))
23328 clear_mouse_face (dpyinfo
);
23330 /* Not on a window -> return. */
23331 if (!WINDOWP (window
))
23334 /* Reset help_echo_string. It will get recomputed below. */
23335 help_echo_string
= Qnil
;
23337 /* Convert to window-relative pixel coordinates. */
23338 w
= XWINDOW (window
);
23339 frame_to_window_pixel_xy (w
, &x
, &y
);
23341 /* Handle tool-bar window differently since it doesn't display a
23343 if (EQ (window
, f
->tool_bar_window
))
23345 note_tool_bar_highlight (f
, x
, y
);
23349 /* Mouse is on the mode, header line or margin? */
23350 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
23351 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
23353 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
23357 if (part
== ON_VERTICAL_BORDER
)
23359 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
23360 help_echo_string
= build_string ("drag-mouse-1: resize");
23362 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
23363 || part
== ON_SCROLL_BAR
)
23364 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23366 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
23368 /* Are we in a window whose display is up to date?
23369 And verify the buffer's text has not changed. */
23370 b
= XBUFFER (w
->buffer
);
23371 if (part
== ON_TEXT
23372 && EQ (w
->window_end_valid
, w
->buffer
)
23373 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
23374 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
23376 int hpos
, vpos
, pos
, i
, dx
, dy
, area
;
23377 struct glyph
*glyph
;
23378 Lisp_Object object
;
23379 Lisp_Object mouse_face
= Qnil
, overlay
= Qnil
, position
;
23380 Lisp_Object
*overlay_vec
= NULL
;
23382 struct buffer
*obuf
;
23383 int obegv
, ozv
, same_region
;
23385 /* Find the glyph under X/Y. */
23386 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
23388 /* Look for :pointer property on image. */
23389 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
23391 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
23392 if (img
!= NULL
&& IMAGEP (img
->spec
))
23394 Lisp_Object image_map
, hotspot
;
23395 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
23397 && (hotspot
= find_hot_spot (image_map
,
23398 glyph
->slice
.x
+ dx
,
23399 glyph
->slice
.y
+ dy
),
23401 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
23403 Lisp_Object area_id
, plist
;
23405 area_id
= XCAR (hotspot
);
23406 /* Could check AREA_ID to see if we enter/leave this hot-spot.
23407 If so, we could look for mouse-enter, mouse-leave
23408 properties in PLIST (and do something...). */
23409 hotspot
= XCDR (hotspot
);
23410 if (CONSP (hotspot
)
23411 && (plist
= XCAR (hotspot
), CONSP (plist
)))
23413 pointer
= Fplist_get (plist
, Qpointer
);
23414 if (NILP (pointer
))
23416 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
23417 if (!NILP (help_echo_string
))
23419 help_echo_window
= window
;
23420 help_echo_object
= glyph
->object
;
23421 help_echo_pos
= glyph
->charpos
;
23425 if (NILP (pointer
))
23426 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
23430 /* Clear mouse face if X/Y not over text. */
23432 || area
!= TEXT_AREA
23433 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
)
23435 if (clear_mouse_face (dpyinfo
))
23436 cursor
= No_Cursor
;
23437 if (NILP (pointer
))
23439 if (area
!= TEXT_AREA
)
23440 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23442 pointer
= Vvoid_text_area_pointer
;
23447 pos
= glyph
->charpos
;
23448 object
= glyph
->object
;
23449 if (!STRINGP (object
) && !BUFFERP (object
))
23452 /* If we get an out-of-range value, return now; avoid an error. */
23453 if (BUFFERP (object
) && pos
> BUF_Z (b
))
23456 /* Make the window's buffer temporarily current for
23457 overlays_at and compute_char_face. */
23458 obuf
= current_buffer
;
23459 current_buffer
= b
;
23465 /* Is this char mouse-active or does it have help-echo? */
23466 position
= make_number (pos
);
23468 if (BUFFERP (object
))
23470 /* Put all the overlays we want in a vector in overlay_vec. */
23471 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
23472 /* Sort overlays into increasing priority order. */
23473 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
23478 same_region
= (EQ (window
, dpyinfo
->mouse_face_window
)
23479 && vpos
>= dpyinfo
->mouse_face_beg_row
23480 && vpos
<= dpyinfo
->mouse_face_end_row
23481 && (vpos
> dpyinfo
->mouse_face_beg_row
23482 || hpos
>= dpyinfo
->mouse_face_beg_col
)
23483 && (vpos
< dpyinfo
->mouse_face_end_row
23484 || hpos
< dpyinfo
->mouse_face_end_col
23485 || dpyinfo
->mouse_face_past_end
));
23488 cursor
= No_Cursor
;
23490 /* Check mouse-face highlighting. */
23492 /* If there exists an overlay with mouse-face overlapping
23493 the one we are currently highlighting, we have to
23494 check if we enter the overlapping overlay, and then
23495 highlight only that. */
23496 || (OVERLAYP (dpyinfo
->mouse_face_overlay
)
23497 && mouse_face_overlay_overlaps (dpyinfo
->mouse_face_overlay
)))
23499 /* Find the highest priority overlay that has a mouse-face
23502 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
23504 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
23505 if (!NILP (mouse_face
))
23506 overlay
= overlay_vec
[i
];
23509 /* If we're actually highlighting the same overlay as
23510 before, there's no need to do that again. */
23511 if (!NILP (overlay
)
23512 && EQ (overlay
, dpyinfo
->mouse_face_overlay
))
23513 goto check_help_echo
;
23515 dpyinfo
->mouse_face_overlay
= overlay
;
23517 /* Clear the display of the old active region, if any. */
23518 if (clear_mouse_face (dpyinfo
))
23519 cursor
= No_Cursor
;
23521 /* If no overlay applies, get a text property. */
23522 if (NILP (overlay
))
23523 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
23525 /* Handle the overlay case. */
23526 if (!NILP (overlay
))
23528 /* Find the range of text around this char that
23529 should be active. */
23530 Lisp_Object before
, after
;
23533 before
= Foverlay_start (overlay
);
23534 after
= Foverlay_end (overlay
);
23535 /* Record this as the current active region. */
23536 fast_find_position (w
, XFASTINT (before
),
23537 &dpyinfo
->mouse_face_beg_col
,
23538 &dpyinfo
->mouse_face_beg_row
,
23539 &dpyinfo
->mouse_face_beg_x
,
23540 &dpyinfo
->mouse_face_beg_y
, Qnil
);
23542 dpyinfo
->mouse_face_past_end
23543 = !fast_find_position (w
, XFASTINT (after
),
23544 &dpyinfo
->mouse_face_end_col
,
23545 &dpyinfo
->mouse_face_end_row
,
23546 &dpyinfo
->mouse_face_end_x
,
23547 &dpyinfo
->mouse_face_end_y
, Qnil
);
23548 dpyinfo
->mouse_face_window
= window
;
23550 dpyinfo
->mouse_face_face_id
23551 = face_at_buffer_position (w
, pos
, 0, 0,
23553 !dpyinfo
->mouse_face_hidden
);
23555 /* Display it as active. */
23556 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23557 cursor
= No_Cursor
;
23559 /* Handle the text property case. */
23560 else if (!NILP (mouse_face
) && BUFFERP (object
))
23562 /* Find the range of text around this char that
23563 should be active. */
23564 Lisp_Object before
, after
, beginning
, end
;
23567 beginning
= Fmarker_position (w
->start
);
23568 end
= make_number (BUF_Z (XBUFFER (object
))
23569 - XFASTINT (w
->window_end_pos
));
23571 = Fprevious_single_property_change (make_number (pos
+ 1),
23573 object
, beginning
);
23575 = Fnext_single_property_change (position
, Qmouse_face
,
23578 /* Record this as the current active region. */
23579 fast_find_position (w
, XFASTINT (before
),
23580 &dpyinfo
->mouse_face_beg_col
,
23581 &dpyinfo
->mouse_face_beg_row
,
23582 &dpyinfo
->mouse_face_beg_x
,
23583 &dpyinfo
->mouse_face_beg_y
, Qnil
);
23584 dpyinfo
->mouse_face_past_end
23585 = !fast_find_position (w
, XFASTINT (after
),
23586 &dpyinfo
->mouse_face_end_col
,
23587 &dpyinfo
->mouse_face_end_row
,
23588 &dpyinfo
->mouse_face_end_x
,
23589 &dpyinfo
->mouse_face_end_y
, Qnil
);
23590 dpyinfo
->mouse_face_window
= window
;
23592 if (BUFFERP (object
))
23593 dpyinfo
->mouse_face_face_id
23594 = face_at_buffer_position (w
, pos
, 0, 0,
23596 !dpyinfo
->mouse_face_hidden
);
23598 /* Display it as active. */
23599 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23600 cursor
= No_Cursor
;
23602 else if (!NILP (mouse_face
) && STRINGP (object
))
23607 b
= Fprevious_single_property_change (make_number (pos
+ 1),
23610 e
= Fnext_single_property_change (position
, Qmouse_face
,
23613 b
= make_number (0);
23615 e
= make_number (SCHARS (object
) - 1);
23617 fast_find_string_pos (w
, XINT (b
), object
,
23618 &dpyinfo
->mouse_face_beg_col
,
23619 &dpyinfo
->mouse_face_beg_row
,
23620 &dpyinfo
->mouse_face_beg_x
,
23621 &dpyinfo
->mouse_face_beg_y
, 0);
23622 fast_find_string_pos (w
, XINT (e
), object
,
23623 &dpyinfo
->mouse_face_end_col
,
23624 &dpyinfo
->mouse_face_end_row
,
23625 &dpyinfo
->mouse_face_end_x
,
23626 &dpyinfo
->mouse_face_end_y
, 1);
23627 dpyinfo
->mouse_face_past_end
= 0;
23628 dpyinfo
->mouse_face_window
= window
;
23629 dpyinfo
->mouse_face_face_id
23630 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
23631 glyph
->face_id
, 1);
23632 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23633 cursor
= No_Cursor
;
23635 else if (STRINGP (object
) && NILP (mouse_face
))
23637 /* A string which doesn't have mouse-face, but
23638 the text ``under'' it might have. */
23639 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
23640 int start
= MATRIX_ROW_START_CHARPOS (r
);
23642 pos
= string_buffer_position (w
, object
, start
);
23644 mouse_face
= get_char_property_and_overlay (make_number (pos
),
23648 if (!NILP (mouse_face
) && !NILP (overlay
))
23650 Lisp_Object before
= Foverlay_start (overlay
);
23651 Lisp_Object after
= Foverlay_end (overlay
);
23654 /* Note that we might not be able to find position
23655 BEFORE in the glyph matrix if the overlay is
23656 entirely covered by a `display' property. In
23657 this case, we overshoot. So let's stop in
23658 the glyph matrix before glyphs for OBJECT. */
23659 fast_find_position (w
, XFASTINT (before
),
23660 &dpyinfo
->mouse_face_beg_col
,
23661 &dpyinfo
->mouse_face_beg_row
,
23662 &dpyinfo
->mouse_face_beg_x
,
23663 &dpyinfo
->mouse_face_beg_y
,
23666 dpyinfo
->mouse_face_past_end
23667 = !fast_find_position (w
, XFASTINT (after
),
23668 &dpyinfo
->mouse_face_end_col
,
23669 &dpyinfo
->mouse_face_end_row
,
23670 &dpyinfo
->mouse_face_end_x
,
23671 &dpyinfo
->mouse_face_end_y
,
23673 dpyinfo
->mouse_face_window
= window
;
23674 dpyinfo
->mouse_face_face_id
23675 = face_at_buffer_position (w
, pos
, 0, 0,
23677 !dpyinfo
->mouse_face_hidden
);
23679 /* Display it as active. */
23680 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23681 cursor
= No_Cursor
;
23688 /* Look for a `help-echo' property. */
23689 if (NILP (help_echo_string
)) {
23690 Lisp_Object help
, overlay
;
23692 /* Check overlays first. */
23693 help
= overlay
= Qnil
;
23694 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
23696 overlay
= overlay_vec
[i
];
23697 help
= Foverlay_get (overlay
, Qhelp_echo
);
23702 help_echo_string
= help
;
23703 help_echo_window
= window
;
23704 help_echo_object
= overlay
;
23705 help_echo_pos
= pos
;
23709 Lisp_Object object
= glyph
->object
;
23710 int charpos
= glyph
->charpos
;
23712 /* Try text properties. */
23713 if (STRINGP (object
)
23715 && charpos
< SCHARS (object
))
23717 help
= Fget_text_property (make_number (charpos
),
23718 Qhelp_echo
, object
);
23721 /* If the string itself doesn't specify a help-echo,
23722 see if the buffer text ``under'' it does. */
23723 struct glyph_row
*r
23724 = MATRIX_ROW (w
->current_matrix
, vpos
);
23725 int start
= MATRIX_ROW_START_CHARPOS (r
);
23726 int pos
= string_buffer_position (w
, object
, start
);
23729 help
= Fget_char_property (make_number (pos
),
23730 Qhelp_echo
, w
->buffer
);
23734 object
= w
->buffer
;
23739 else if (BUFFERP (object
)
23742 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
23747 help_echo_string
= help
;
23748 help_echo_window
= window
;
23749 help_echo_object
= object
;
23750 help_echo_pos
= charpos
;
23755 /* Look for a `pointer' property. */
23756 if (NILP (pointer
))
23758 /* Check overlays first. */
23759 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
23760 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
23762 if (NILP (pointer
))
23764 Lisp_Object object
= glyph
->object
;
23765 int charpos
= glyph
->charpos
;
23767 /* Try text properties. */
23768 if (STRINGP (object
)
23770 && charpos
< SCHARS (object
))
23772 pointer
= Fget_text_property (make_number (charpos
),
23774 if (NILP (pointer
))
23776 /* If the string itself doesn't specify a pointer,
23777 see if the buffer text ``under'' it does. */
23778 struct glyph_row
*r
23779 = MATRIX_ROW (w
->current_matrix
, vpos
);
23780 int start
= MATRIX_ROW_START_CHARPOS (r
);
23781 int pos
= string_buffer_position (w
, object
, start
);
23783 pointer
= Fget_char_property (make_number (pos
),
23784 Qpointer
, w
->buffer
);
23787 else if (BUFFERP (object
)
23790 pointer
= Fget_text_property (make_number (charpos
),
23797 current_buffer
= obuf
;
23802 define_frame_cursor1 (f
, cursor
, pointer
);
23807 Clear any mouse-face on window W. This function is part of the
23808 redisplay interface, and is called from try_window_id and similar
23809 functions to ensure the mouse-highlight is off. */
23812 x_clear_window_mouse_face (w
)
23815 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
23816 Lisp_Object window
;
23819 XSETWINDOW (window
, w
);
23820 if (EQ (window
, dpyinfo
->mouse_face_window
))
23821 clear_mouse_face (dpyinfo
);
23827 Just discard the mouse face information for frame F, if any.
23828 This is used when the size of F is changed. */
23831 cancel_mouse_face (f
)
23834 Lisp_Object window
;
23835 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
23837 window
= dpyinfo
->mouse_face_window
;
23838 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
23840 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
23841 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
23842 dpyinfo
->mouse_face_window
= Qnil
;
23847 #endif /* HAVE_WINDOW_SYSTEM */
23850 /***********************************************************************
23852 ***********************************************************************/
23854 #ifdef HAVE_WINDOW_SYSTEM
23856 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
23857 which intersects rectangle R. R is in window-relative coordinates. */
23860 expose_area (w
, row
, r
, area
)
23862 struct glyph_row
*row
;
23864 enum glyph_row_area area
;
23866 struct glyph
*first
= row
->glyphs
[area
];
23867 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
23868 struct glyph
*last
;
23869 int first_x
, start_x
, x
;
23871 if (area
== TEXT_AREA
&& row
->fill_line_p
)
23872 /* If row extends face to end of line write the whole line. */
23873 draw_glyphs (w
, 0, row
, area
,
23874 0, row
->used
[area
],
23875 DRAW_NORMAL_TEXT
, 0);
23878 /* Set START_X to the window-relative start position for drawing glyphs of
23879 AREA. The first glyph of the text area can be partially visible.
23880 The first glyphs of other areas cannot. */
23881 start_x
= window_box_left_offset (w
, area
);
23883 if (area
== TEXT_AREA
)
23886 /* Find the first glyph that must be redrawn. */
23888 && x
+ first
->pixel_width
< r
->x
)
23890 x
+= first
->pixel_width
;
23894 /* Find the last one. */
23898 && x
< r
->x
+ r
->width
)
23900 x
+= last
->pixel_width
;
23906 draw_glyphs (w
, first_x
- start_x
, row
, area
,
23907 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
23908 DRAW_NORMAL_TEXT
, 0);
23913 /* Redraw the parts of the glyph row ROW on window W intersecting
23914 rectangle R. R is in window-relative coordinates. Value is
23915 non-zero if mouse-face was overwritten. */
23918 expose_line (w
, row
, r
)
23920 struct glyph_row
*row
;
23923 xassert (row
->enabled_p
);
23925 if (row
->mode_line_p
|| w
->pseudo_window_p
)
23926 draw_glyphs (w
, 0, row
, TEXT_AREA
,
23927 0, row
->used
[TEXT_AREA
],
23928 DRAW_NORMAL_TEXT
, 0);
23931 if (row
->used
[LEFT_MARGIN_AREA
])
23932 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
23933 if (row
->used
[TEXT_AREA
])
23934 expose_area (w
, row
, r
, TEXT_AREA
);
23935 if (row
->used
[RIGHT_MARGIN_AREA
])
23936 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
23937 draw_row_fringe_bitmaps (w
, row
);
23940 return row
->mouse_face_p
;
23944 /* Redraw those parts of glyphs rows during expose event handling that
23945 overlap other rows. Redrawing of an exposed line writes over parts
23946 of lines overlapping that exposed line; this function fixes that.
23948 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
23949 row in W's current matrix that is exposed and overlaps other rows.
23950 LAST_OVERLAPPING_ROW is the last such row. */
23953 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
, r
)
23955 struct glyph_row
*first_overlapping_row
;
23956 struct glyph_row
*last_overlapping_row
;
23959 struct glyph_row
*row
;
23961 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
23962 if (row
->overlapping_p
)
23964 xassert (row
->enabled_p
&& !row
->mode_line_p
);
23967 if (row
->used
[LEFT_MARGIN_AREA
])
23968 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
23970 if (row
->used
[TEXT_AREA
])
23971 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
23973 if (row
->used
[RIGHT_MARGIN_AREA
])
23974 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
23980 /* Return non-zero if W's cursor intersects rectangle R. */
23983 phys_cursor_in_rect_p (w
, r
)
23987 XRectangle cr
, result
;
23988 struct glyph
*cursor_glyph
;
23989 struct glyph_row
*row
;
23991 if (w
->phys_cursor
.vpos
>= 0
23992 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
23993 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
23995 && row
->cursor_in_fringe_p
)
23997 /* Cursor is in the fringe. */
23998 cr
.x
= window_box_right_offset (w
,
23999 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
24000 ? RIGHT_MARGIN_AREA
24003 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
24004 cr
.height
= row
->height
;
24005 return x_intersect_rectangles (&cr
, r
, &result
);
24008 cursor_glyph
= get_phys_cursor_glyph (w
);
24011 /* r is relative to W's box, but w->phys_cursor.x is relative
24012 to left edge of W's TEXT area. Adjust it. */
24013 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
24014 cr
.y
= w
->phys_cursor
.y
;
24015 cr
.width
= cursor_glyph
->pixel_width
;
24016 cr
.height
= w
->phys_cursor_height
;
24017 /* ++KFS: W32 version used W32-specific IntersectRect here, but
24018 I assume the effect is the same -- and this is portable. */
24019 return x_intersect_rectangles (&cr
, r
, &result
);
24021 /* If we don't understand the format, pretend we're not in the hot-spot. */
24027 Draw a vertical window border to the right of window W if W doesn't
24028 have vertical scroll bars. */
24031 x_draw_vertical_border (w
)
24034 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
24036 /* We could do better, if we knew what type of scroll-bar the adjacent
24037 windows (on either side) have... But we don't :-(
24038 However, I think this works ok. ++KFS 2003-04-25 */
24040 /* Redraw borders between horizontally adjacent windows. Don't
24041 do it for frames with vertical scroll bars because either the
24042 right scroll bar of a window, or the left scroll bar of its
24043 neighbor will suffice as a border. */
24044 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
24047 if (!WINDOW_RIGHTMOST_P (w
)
24048 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
24050 int x0
, x1
, y0
, y1
;
24052 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
24055 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
24058 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
24060 else if (!WINDOW_LEFTMOST_P (w
)
24061 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
24063 int x0
, x1
, y0
, y1
;
24065 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
24068 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
24071 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
24076 /* Redraw the part of window W intersection rectangle FR. Pixel
24077 coordinates in FR are frame-relative. Call this function with
24078 input blocked. Value is non-zero if the exposure overwrites
24082 expose_window (w
, fr
)
24086 struct frame
*f
= XFRAME (w
->frame
);
24088 int mouse_face_overwritten_p
= 0;
24090 /* If window is not yet fully initialized, do nothing. This can
24091 happen when toolkit scroll bars are used and a window is split.
24092 Reconfiguring the scroll bar will generate an expose for a newly
24094 if (w
->current_matrix
== NULL
)
24097 /* When we're currently updating the window, display and current
24098 matrix usually don't agree. Arrange for a thorough display
24100 if (w
== updated_window
)
24102 SET_FRAME_GARBAGED (f
);
24106 /* Frame-relative pixel rectangle of W. */
24107 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
24108 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
24109 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
24110 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
24112 if (x_intersect_rectangles (fr
, &wr
, &r
))
24114 int yb
= window_text_bottom_y (w
);
24115 struct glyph_row
*row
;
24116 int cursor_cleared_p
;
24117 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
24119 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
24120 r
.x
, r
.y
, r
.width
, r
.height
));
24122 /* Convert to window coordinates. */
24123 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
24124 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
24126 /* Turn off the cursor. */
24127 if (!w
->pseudo_window_p
24128 && phys_cursor_in_rect_p (w
, &r
))
24130 x_clear_cursor (w
);
24131 cursor_cleared_p
= 1;
24134 cursor_cleared_p
= 0;
24136 /* Update lines intersecting rectangle R. */
24137 first_overlapping_row
= last_overlapping_row
= NULL
;
24138 for (row
= w
->current_matrix
->rows
;
24143 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
24145 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
24146 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
24147 || (r
.y
>= y0
&& r
.y
< y1
)
24148 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
24150 /* A header line may be overlapping, but there is no need
24151 to fix overlapping areas for them. KFS 2005-02-12 */
24152 if (row
->overlapping_p
&& !row
->mode_line_p
)
24154 if (first_overlapping_row
== NULL
)
24155 first_overlapping_row
= row
;
24156 last_overlapping_row
= row
;
24160 if (expose_line (w
, row
, &r
))
24161 mouse_face_overwritten_p
= 1;
24164 else if (row
->overlapping_p
)
24166 /* We must redraw a row overlapping the exposed area. */
24168 ? y0
+ row
->phys_height
> r
.y
24169 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
24171 if (first_overlapping_row
== NULL
)
24172 first_overlapping_row
= row
;
24173 last_overlapping_row
= row
;
24181 /* Display the mode line if there is one. */
24182 if (WINDOW_WANTS_MODELINE_P (w
)
24183 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
24185 && row
->y
< r
.y
+ r
.height
)
24187 if (expose_line (w
, row
, &r
))
24188 mouse_face_overwritten_p
= 1;
24191 if (!w
->pseudo_window_p
)
24193 /* Fix the display of overlapping rows. */
24194 if (first_overlapping_row
)
24195 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
24198 /* Draw border between windows. */
24199 x_draw_vertical_border (w
);
24201 /* Turn the cursor on again. */
24202 if (cursor_cleared_p
)
24203 update_window_cursor (w
, 1);
24207 return mouse_face_overwritten_p
;
24212 /* Redraw (parts) of all windows in the window tree rooted at W that
24213 intersect R. R contains frame pixel coordinates. Value is
24214 non-zero if the exposure overwrites mouse-face. */
24217 expose_window_tree (w
, r
)
24221 struct frame
*f
= XFRAME (w
->frame
);
24222 int mouse_face_overwritten_p
= 0;
24224 while (w
&& !FRAME_GARBAGED_P (f
))
24226 if (!NILP (w
->hchild
))
24227 mouse_face_overwritten_p
24228 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
24229 else if (!NILP (w
->vchild
))
24230 mouse_face_overwritten_p
24231 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
24233 mouse_face_overwritten_p
|= expose_window (w
, r
);
24235 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
24238 return mouse_face_overwritten_p
;
24243 Redisplay an exposed area of frame F. X and Y are the upper-left
24244 corner of the exposed rectangle. W and H are width and height of
24245 the exposed area. All are pixel values. W or H zero means redraw
24246 the entire frame. */
24249 expose_frame (f
, x
, y
, w
, h
)
24254 int mouse_face_overwritten_p
= 0;
24256 TRACE ((stderr
, "expose_frame "));
24258 /* No need to redraw if frame will be redrawn soon. */
24259 if (FRAME_GARBAGED_P (f
))
24261 TRACE ((stderr
, " garbaged\n"));
24265 /* If basic faces haven't been realized yet, there is no point in
24266 trying to redraw anything. This can happen when we get an expose
24267 event while Emacs is starting, e.g. by moving another window. */
24268 if (FRAME_FACE_CACHE (f
) == NULL
24269 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
24271 TRACE ((stderr
, " no faces\n"));
24275 if (w
== 0 || h
== 0)
24278 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
24279 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
24289 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
24290 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
24292 if (WINDOWP (f
->tool_bar_window
))
24293 mouse_face_overwritten_p
24294 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
24296 #ifdef HAVE_X_WINDOWS
24298 #ifndef USE_X_TOOLKIT
24299 if (WINDOWP (f
->menu_bar_window
))
24300 mouse_face_overwritten_p
24301 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
24302 #endif /* not USE_X_TOOLKIT */
24306 /* Some window managers support a focus-follows-mouse style with
24307 delayed raising of frames. Imagine a partially obscured frame,
24308 and moving the mouse into partially obscured mouse-face on that
24309 frame. The visible part of the mouse-face will be highlighted,
24310 then the WM raises the obscured frame. With at least one WM, KDE
24311 2.1, Emacs is not getting any event for the raising of the frame
24312 (even tried with SubstructureRedirectMask), only Expose events.
24313 These expose events will draw text normally, i.e. not
24314 highlighted. Which means we must redo the highlight here.
24315 Subsume it under ``we love X''. --gerd 2001-08-15 */
24316 /* Included in Windows version because Windows most likely does not
24317 do the right thing if any third party tool offers
24318 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
24319 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
24321 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24322 if (f
== dpyinfo
->mouse_face_mouse_frame
)
24324 int x
= dpyinfo
->mouse_face_mouse_x
;
24325 int y
= dpyinfo
->mouse_face_mouse_y
;
24326 clear_mouse_face (dpyinfo
);
24327 note_mouse_highlight (f
, x
, y
);
24334 Determine the intersection of two rectangles R1 and R2. Return
24335 the intersection in *RESULT. Value is non-zero if RESULT is not
24339 x_intersect_rectangles (r1
, r2
, result
)
24340 XRectangle
*r1
, *r2
, *result
;
24342 XRectangle
*left
, *right
;
24343 XRectangle
*upper
, *lower
;
24344 int intersection_p
= 0;
24346 /* Rearrange so that R1 is the left-most rectangle. */
24348 left
= r1
, right
= r2
;
24350 left
= r2
, right
= r1
;
24352 /* X0 of the intersection is right.x0, if this is inside R1,
24353 otherwise there is no intersection. */
24354 if (right
->x
<= left
->x
+ left
->width
)
24356 result
->x
= right
->x
;
24358 /* The right end of the intersection is the minimum of the
24359 the right ends of left and right. */
24360 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
24363 /* Same game for Y. */
24365 upper
= r1
, lower
= r2
;
24367 upper
= r2
, lower
= r1
;
24369 /* The upper end of the intersection is lower.y0, if this is inside
24370 of upper. Otherwise, there is no intersection. */
24371 if (lower
->y
<= upper
->y
+ upper
->height
)
24373 result
->y
= lower
->y
;
24375 /* The lower end of the intersection is the minimum of the lower
24376 ends of upper and lower. */
24377 result
->height
= (min (lower
->y
+ lower
->height
,
24378 upper
->y
+ upper
->height
)
24380 intersection_p
= 1;
24384 return intersection_p
;
24387 #endif /* HAVE_WINDOW_SYSTEM */
24390 /***********************************************************************
24392 ***********************************************************************/
24397 Vwith_echo_area_save_vector
= Qnil
;
24398 staticpro (&Vwith_echo_area_save_vector
);
24400 Vmessage_stack
= Qnil
;
24401 staticpro (&Vmessage_stack
);
24403 Qinhibit_redisplay
= intern ("inhibit-redisplay");
24404 staticpro (&Qinhibit_redisplay
);
24406 message_dolog_marker1
= Fmake_marker ();
24407 staticpro (&message_dolog_marker1
);
24408 message_dolog_marker2
= Fmake_marker ();
24409 staticpro (&message_dolog_marker2
);
24410 message_dolog_marker3
= Fmake_marker ();
24411 staticpro (&message_dolog_marker3
);
24414 defsubr (&Sdump_frame_glyph_matrix
);
24415 defsubr (&Sdump_glyph_matrix
);
24416 defsubr (&Sdump_glyph_row
);
24417 defsubr (&Sdump_tool_bar_row
);
24418 defsubr (&Strace_redisplay
);
24419 defsubr (&Strace_to_stderr
);
24421 #ifdef HAVE_WINDOW_SYSTEM
24422 defsubr (&Stool_bar_lines_needed
);
24423 defsubr (&Slookup_image_map
);
24425 defsubr (&Sformat_mode_line
);
24426 defsubr (&Sinvisible_p
);
24428 staticpro (&Qmenu_bar_update_hook
);
24429 Qmenu_bar_update_hook
= intern ("menu-bar-update-hook");
24431 staticpro (&Qoverriding_terminal_local_map
);
24432 Qoverriding_terminal_local_map
= intern ("overriding-terminal-local-map");
24434 staticpro (&Qoverriding_local_map
);
24435 Qoverriding_local_map
= intern ("overriding-local-map");
24437 staticpro (&Qwindow_scroll_functions
);
24438 Qwindow_scroll_functions
= intern ("window-scroll-functions");
24440 staticpro (&Qwindow_text_change_functions
);
24441 Qwindow_text_change_functions
= intern ("window-text-change-functions");
24443 staticpro (&Qredisplay_end_trigger_functions
);
24444 Qredisplay_end_trigger_functions
= intern ("redisplay-end-trigger-functions");
24446 staticpro (&Qinhibit_point_motion_hooks
);
24447 Qinhibit_point_motion_hooks
= intern ("inhibit-point-motion-hooks");
24449 Qeval
= intern ("eval");
24450 staticpro (&Qeval
);
24452 QCdata
= intern (":data");
24453 staticpro (&QCdata
);
24454 Qdisplay
= intern ("display");
24455 staticpro (&Qdisplay
);
24456 Qspace_width
= intern ("space-width");
24457 staticpro (&Qspace_width
);
24458 Qraise
= intern ("raise");
24459 staticpro (&Qraise
);
24460 Qslice
= intern ("slice");
24461 staticpro (&Qslice
);
24462 Qspace
= intern ("space");
24463 staticpro (&Qspace
);
24464 Qmargin
= intern ("margin");
24465 staticpro (&Qmargin
);
24466 Qpointer
= intern ("pointer");
24467 staticpro (&Qpointer
);
24468 Qleft_margin
= intern ("left-margin");
24469 staticpro (&Qleft_margin
);
24470 Qright_margin
= intern ("right-margin");
24471 staticpro (&Qright_margin
);
24472 Qcenter
= intern ("center");
24473 staticpro (&Qcenter
);
24474 Qline_height
= intern ("line-height");
24475 staticpro (&Qline_height
);
24476 QCalign_to
= intern (":align-to");
24477 staticpro (&QCalign_to
);
24478 QCrelative_width
= intern (":relative-width");
24479 staticpro (&QCrelative_width
);
24480 QCrelative_height
= intern (":relative-height");
24481 staticpro (&QCrelative_height
);
24482 QCeval
= intern (":eval");
24483 staticpro (&QCeval
);
24484 QCpropertize
= intern (":propertize");
24485 staticpro (&QCpropertize
);
24486 QCfile
= intern (":file");
24487 staticpro (&QCfile
);
24488 Qfontified
= intern ("fontified");
24489 staticpro (&Qfontified
);
24490 Qfontification_functions
= intern ("fontification-functions");
24491 staticpro (&Qfontification_functions
);
24492 Qtrailing_whitespace
= intern ("trailing-whitespace");
24493 staticpro (&Qtrailing_whitespace
);
24494 Qescape_glyph
= intern ("escape-glyph");
24495 staticpro (&Qescape_glyph
);
24496 Qnobreak_space
= intern ("nobreak-space");
24497 staticpro (&Qnobreak_space
);
24498 Qimage
= intern ("image");
24499 staticpro (&Qimage
);
24500 QCmap
= intern (":map");
24501 staticpro (&QCmap
);
24502 QCpointer
= intern (":pointer");
24503 staticpro (&QCpointer
);
24504 Qrect
= intern ("rect");
24505 staticpro (&Qrect
);
24506 Qcircle
= intern ("circle");
24507 staticpro (&Qcircle
);
24508 Qpoly
= intern ("poly");
24509 staticpro (&Qpoly
);
24510 Qmessage_truncate_lines
= intern ("message-truncate-lines");
24511 staticpro (&Qmessage_truncate_lines
);
24512 Qgrow_only
= intern ("grow-only");
24513 staticpro (&Qgrow_only
);
24514 Qinhibit_menubar_update
= intern ("inhibit-menubar-update");
24515 staticpro (&Qinhibit_menubar_update
);
24516 Qinhibit_eval_during_redisplay
= intern ("inhibit-eval-during-redisplay");
24517 staticpro (&Qinhibit_eval_during_redisplay
);
24518 Qposition
= intern ("position");
24519 staticpro (&Qposition
);
24520 Qbuffer_position
= intern ("buffer-position");
24521 staticpro (&Qbuffer_position
);
24522 Qobject
= intern ("object");
24523 staticpro (&Qobject
);
24524 Qbar
= intern ("bar");
24526 Qhbar
= intern ("hbar");
24527 staticpro (&Qhbar
);
24528 Qbox
= intern ("box");
24530 Qhollow
= intern ("hollow");
24531 staticpro (&Qhollow
);
24532 Qhand
= intern ("hand");
24533 staticpro (&Qhand
);
24534 Qarrow
= intern ("arrow");
24535 staticpro (&Qarrow
);
24536 Qtext
= intern ("text");
24537 staticpro (&Qtext
);
24538 Qrisky_local_variable
= intern ("risky-local-variable");
24539 staticpro (&Qrisky_local_variable
);
24540 Qinhibit_free_realized_faces
= intern ("inhibit-free-realized-faces");
24541 staticpro (&Qinhibit_free_realized_faces
);
24543 list_of_error
= Fcons (Fcons (intern ("error"),
24544 Fcons (intern ("void-variable"), Qnil
)),
24546 staticpro (&list_of_error
);
24548 Qlast_arrow_position
= intern ("last-arrow-position");
24549 staticpro (&Qlast_arrow_position
);
24550 Qlast_arrow_string
= intern ("last-arrow-string");
24551 staticpro (&Qlast_arrow_string
);
24553 Qoverlay_arrow_string
= intern ("overlay-arrow-string");
24554 staticpro (&Qoverlay_arrow_string
);
24555 Qoverlay_arrow_bitmap
= intern ("overlay-arrow-bitmap");
24556 staticpro (&Qoverlay_arrow_bitmap
);
24558 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
24559 staticpro (&echo_buffer
[0]);
24560 staticpro (&echo_buffer
[1]);
24562 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
24563 staticpro (&echo_area_buffer
[0]);
24564 staticpro (&echo_area_buffer
[1]);
24566 Vmessages_buffer_name
= build_string ("*Messages*");
24567 staticpro (&Vmessages_buffer_name
);
24569 mode_line_proptrans_alist
= Qnil
;
24570 staticpro (&mode_line_proptrans_alist
);
24571 mode_line_string_list
= Qnil
;
24572 staticpro (&mode_line_string_list
);
24573 mode_line_string_face
= Qnil
;
24574 staticpro (&mode_line_string_face
);
24575 mode_line_string_face_prop
= Qnil
;
24576 staticpro (&mode_line_string_face_prop
);
24577 Vmode_line_unwind_vector
= Qnil
;
24578 staticpro (&Vmode_line_unwind_vector
);
24580 help_echo_string
= Qnil
;
24581 staticpro (&help_echo_string
);
24582 help_echo_object
= Qnil
;
24583 staticpro (&help_echo_object
);
24584 help_echo_window
= Qnil
;
24585 staticpro (&help_echo_window
);
24586 previous_help_echo_string
= Qnil
;
24587 staticpro (&previous_help_echo_string
);
24588 help_echo_pos
= -1;
24590 #ifdef HAVE_WINDOW_SYSTEM
24591 DEFVAR_BOOL ("x-stretch-cursor", &x_stretch_cursor_p
,
24592 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
24593 For example, if a block cursor is over a tab, it will be drawn as
24594 wide as that tab on the display. */);
24595 x_stretch_cursor_p
= 0;
24598 DEFVAR_LISP ("show-trailing-whitespace", &Vshow_trailing_whitespace
,
24599 doc
: /* *Non-nil means highlight trailing whitespace.
24600 The face used for trailing whitespace is `trailing-whitespace'. */);
24601 Vshow_trailing_whitespace
= Qnil
;
24603 DEFVAR_LISP ("nobreak-char-display", &Vnobreak_char_display
,
24604 doc
: /* *Control highlighting of nobreak space and soft hyphen.
24605 A value of t means highlight the character itself (for nobreak space,
24606 use face `nobreak-space').
24607 A value of nil means no highlighting.
24608 Other values mean display the escape glyph followed by an ordinary
24609 space or ordinary hyphen. */);
24610 Vnobreak_char_display
= Qt
;
24612 DEFVAR_LISP ("void-text-area-pointer", &Vvoid_text_area_pointer
,
24613 doc
: /* *The pointer shape to show in void text areas.
24614 A value of nil means to show the text pointer. Other options are `arrow',
24615 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
24616 Vvoid_text_area_pointer
= Qarrow
;
24618 DEFVAR_LISP ("inhibit-redisplay", &Vinhibit_redisplay
,
24619 doc
: /* Non-nil means don't actually do any redisplay.
24620 This is used for internal purposes. */);
24621 Vinhibit_redisplay
= Qnil
;
24623 DEFVAR_LISP ("global-mode-string", &Vglobal_mode_string
,
24624 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
24625 Vglobal_mode_string
= Qnil
;
24627 DEFVAR_LISP ("overlay-arrow-position", &Voverlay_arrow_position
,
24628 doc
: /* Marker for where to display an arrow on top of the buffer text.
24629 This must be the beginning of a line in order to work.
24630 See also `overlay-arrow-string'. */);
24631 Voverlay_arrow_position
= Qnil
;
24633 DEFVAR_LISP ("overlay-arrow-string", &Voverlay_arrow_string
,
24634 doc
: /* String to display as an arrow in non-window frames.
24635 See also `overlay-arrow-position'. */);
24636 Voverlay_arrow_string
= build_string ("=>");
24638 DEFVAR_LISP ("overlay-arrow-variable-list", &Voverlay_arrow_variable_list
,
24639 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
24640 The symbols on this list are examined during redisplay to determine
24641 where to display overlay arrows. */);
24642 Voverlay_arrow_variable_list
24643 = Fcons (intern ("overlay-arrow-position"), Qnil
);
24645 DEFVAR_INT ("scroll-step", &scroll_step
,
24646 doc
: /* *The number of lines to try scrolling a window by when point moves out.
24647 If that fails to bring point back on frame, point is centered instead.
24648 If this is zero, point is always centered after it moves off frame.
24649 If you want scrolling to always be a line at a time, you should set
24650 `scroll-conservatively' to a large value rather than set this to 1. */);
24652 DEFVAR_INT ("scroll-conservatively", &scroll_conservatively
,
24653 doc
: /* *Scroll up to this many lines, to bring point back on screen.
24654 If point moves off-screen, redisplay will scroll by up to
24655 `scroll-conservatively' lines in order to bring point just barely
24656 onto the screen again. If that cannot be done, then redisplay
24657 recenters point as usual.
24659 A value of zero means always recenter point if it moves off screen. */);
24660 scroll_conservatively
= 0;
24662 DEFVAR_INT ("scroll-margin", &scroll_margin
,
24663 doc
: /* *Number of lines of margin at the top and bottom of a window.
24664 Recenter the window whenever point gets within this many lines
24665 of the top or bottom of the window. */);
24668 DEFVAR_LISP ("display-pixels-per-inch", &Vdisplay_pixels_per_inch
,
24669 doc
: /* Pixels per inch value for non-window system displays.
24670 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
24671 Vdisplay_pixels_per_inch
= make_float (72.0);
24674 DEFVAR_INT ("debug-end-pos", &debug_end_pos
, doc
: /* Don't ask. */);
24677 DEFVAR_LISP ("truncate-partial-width-windows",
24678 &Vtruncate_partial_width_windows
,
24679 doc
: /* Non-nil means truncate lines in windows with less than the frame width.
24680 For an integer value, truncate lines in each window with less than the
24681 full frame width, provided the window width is less than that integer;
24682 otherwise, respect the value of `truncate-lines'.
24684 For any other non-nil value, truncate lines in all windows with
24685 less than the full frame width.
24687 Nil means to respect the value of `truncate-lines'. */);
24688 Vtruncate_partial_width_windows
= make_number (30);
24690 DEFVAR_BOOL ("mode-line-inverse-video", &mode_line_inverse_video
,
24691 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
24692 Any other value means to use the appropriate face, `mode-line',
24693 `header-line', or `menu' respectively. */);
24694 mode_line_inverse_video
= 1;
24696 DEFVAR_LISP ("line-number-display-limit", &Vline_number_display_limit
,
24697 doc
: /* *Maximum buffer size for which line number should be displayed.
24698 If the buffer is bigger than this, the line number does not appear
24699 in the mode line. A value of nil means no limit. */);
24700 Vline_number_display_limit
= Qnil
;
24702 DEFVAR_INT ("line-number-display-limit-width",
24703 &line_number_display_limit_width
,
24704 doc
: /* *Maximum line width (in characters) for line number display.
24705 If the average length of the lines near point is bigger than this, then the
24706 line number may be omitted from the mode line. */);
24707 line_number_display_limit_width
= 200;
24709 DEFVAR_BOOL ("highlight-nonselected-windows", &highlight_nonselected_windows
,
24710 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
24711 highlight_nonselected_windows
= 0;
24713 DEFVAR_BOOL ("multiple-frames", &multiple_frames
,
24714 doc
: /* Non-nil if more than one frame is visible on this display.
24715 Minibuffer-only frames don't count, but iconified frames do.
24716 This variable is not guaranteed to be accurate except while processing
24717 `frame-title-format' and `icon-title-format'. */);
24719 DEFVAR_LISP ("frame-title-format", &Vframe_title_format
,
24720 doc
: /* Template for displaying the title bar of visible frames.
24721 \(Assuming the window manager supports this feature.)
24723 This variable has the same structure as `mode-line-format', except that
24724 the %c and %l constructs are ignored. It is used only on frames for
24725 which no explicit name has been set \(see `modify-frame-parameters'). */);
24727 DEFVAR_LISP ("icon-title-format", &Vicon_title_format
,
24728 doc
: /* Template for displaying the title bar of an iconified frame.
24729 \(Assuming the window manager supports this feature.)
24730 This variable has the same structure as `mode-line-format' (which see),
24731 and is used only on frames for which no explicit name has been set
24732 \(see `modify-frame-parameters'). */);
24734 = Vframe_title_format
24735 = Fcons (intern ("multiple-frames"),
24736 Fcons (build_string ("%b"),
24737 Fcons (Fcons (empty_unibyte_string
,
24738 Fcons (intern ("invocation-name"),
24739 Fcons (build_string ("@"),
24740 Fcons (intern ("system-name"),
24744 DEFVAR_LISP ("message-log-max", &Vmessage_log_max
,
24745 doc
: /* Maximum number of lines to keep in the message log buffer.
24746 If nil, disable message logging. If t, log messages but don't truncate
24747 the buffer when it becomes large. */);
24748 Vmessage_log_max
= make_number (100);
24750 DEFVAR_LISP ("window-size-change-functions", &Vwindow_size_change_functions
,
24751 doc
: /* Functions called before redisplay, if window sizes have changed.
24752 The value should be a list of functions that take one argument.
24753 Just before redisplay, for each frame, if any of its windows have changed
24754 size since the last redisplay, or have been split or deleted,
24755 all the functions in the list are called, with the frame as argument. */);
24756 Vwindow_size_change_functions
= Qnil
;
24758 DEFVAR_LISP ("window-scroll-functions", &Vwindow_scroll_functions
,
24759 doc
: /* List of functions to call before redisplaying a window with scrolling.
24760 Each function is called with two arguments, the window
24761 and its new display-start position. Note that the value of `window-end'
24762 is not valid when these functions are called. */);
24763 Vwindow_scroll_functions
= Qnil
;
24765 DEFVAR_LISP ("window-text-change-functions",
24766 &Vwindow_text_change_functions
,
24767 doc
: /* Functions to call in redisplay when text in the window might change. */);
24768 Vwindow_text_change_functions
= Qnil
;
24770 DEFVAR_LISP ("redisplay-end-trigger-functions", &Vredisplay_end_trigger_functions
,
24771 doc
: /* Functions called when redisplay of a window reaches the end trigger.
24772 Each function is called with two arguments, the window and the end trigger value.
24773 See `set-window-redisplay-end-trigger'. */);
24774 Vredisplay_end_trigger_functions
= Qnil
;
24776 DEFVAR_LISP ("mouse-autoselect-window", &Vmouse_autoselect_window
,
24777 doc
: /* *Non-nil means autoselect window with mouse pointer.
24778 If nil, do not autoselect windows.
24779 A positive number means delay autoselection by that many seconds: a
24780 window is autoselected only after the mouse has remained in that
24781 window for the duration of the delay.
24782 A negative number has a similar effect, but causes windows to be
24783 autoselected only after the mouse has stopped moving. \(Because of
24784 the way Emacs compares mouse events, you will occasionally wait twice
24785 that time before the window gets selected.\)
24786 Any other value means to autoselect window instantaneously when the
24787 mouse pointer enters it.
24789 Autoselection selects the minibuffer only if it is active, and never
24790 unselects the minibuffer if it is active.
24792 When customizing this variable make sure that the actual value of
24793 `focus-follows-mouse' matches the behavior of your window manager. */);
24794 Vmouse_autoselect_window
= Qnil
;
24796 DEFVAR_LISP ("auto-resize-tool-bars", &Vauto_resize_tool_bars
,
24797 doc
: /* *Non-nil means automatically resize tool-bars.
24798 This dynamically changes the tool-bar's height to the minimum height
24799 that is needed to make all tool-bar items visible.
24800 If value is `grow-only', the tool-bar's height is only increased
24801 automatically; to decrease the tool-bar height, use \\[recenter]. */);
24802 Vauto_resize_tool_bars
= Qt
;
24804 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", &auto_raise_tool_bar_buttons_p
,
24805 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
24806 auto_raise_tool_bar_buttons_p
= 1;
24808 DEFVAR_BOOL ("make-cursor-line-fully-visible", &make_cursor_line_fully_visible_p
,
24809 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
24810 make_cursor_line_fully_visible_p
= 1;
24812 DEFVAR_LISP ("tool-bar-border", &Vtool_bar_border
,
24813 doc
: /* *Border below tool-bar in pixels.
24814 If an integer, use it as the height of the border.
24815 If it is one of `internal-border-width' or `border-width', use the
24816 value of the corresponding frame parameter.
24817 Otherwise, no border is added below the tool-bar. */);
24818 Vtool_bar_border
= Qinternal_border_width
;
24820 DEFVAR_LISP ("tool-bar-button-margin", &Vtool_bar_button_margin
,
24821 doc
: /* *Margin around tool-bar buttons in pixels.
24822 If an integer, use that for both horizontal and vertical margins.
24823 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
24824 HORZ specifying the horizontal margin, and VERT specifying the
24825 vertical margin. */);
24826 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
24828 DEFVAR_INT ("tool-bar-button-relief", &tool_bar_button_relief
,
24829 doc
: /* *Relief thickness of tool-bar buttons. */);
24830 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
24832 DEFVAR_LISP ("fontification-functions", &Vfontification_functions
,
24833 doc
: /* List of functions to call to fontify regions of text.
24834 Each function is called with one argument POS. Functions must
24835 fontify a region starting at POS in the current buffer, and give
24836 fontified regions the property `fontified'. */);
24837 Vfontification_functions
= Qnil
;
24838 Fmake_variable_buffer_local (Qfontification_functions
);
24840 DEFVAR_BOOL ("unibyte-display-via-language-environment",
24841 &unibyte_display_via_language_environment
,
24842 doc
: /* *Non-nil means display unibyte text according to language environment.
24843 Specifically this means that unibyte non-ASCII characters
24844 are displayed by converting them to the equivalent multibyte characters
24845 according to the current language environment. As a result, they are
24846 displayed according to the current fontset. */);
24847 unibyte_display_via_language_environment
= 0;
24849 DEFVAR_LISP ("max-mini-window-height", &Vmax_mini_window_height
,
24850 doc
: /* *Maximum height for resizing mini-windows.
24851 If a float, it specifies a fraction of the mini-window frame's height.
24852 If an integer, it specifies a number of lines. */);
24853 Vmax_mini_window_height
= make_float (0.25);
24855 DEFVAR_LISP ("resize-mini-windows", &Vresize_mini_windows
,
24856 doc
: /* *How to resize mini-windows.
24857 A value of nil means don't automatically resize mini-windows.
24858 A value of t means resize them to fit the text displayed in them.
24859 A value of `grow-only', the default, means let mini-windows grow
24860 only, until their display becomes empty, at which point the windows
24861 go back to their normal size. */);
24862 Vresize_mini_windows
= Qgrow_only
;
24864 DEFVAR_LISP ("blink-cursor-alist", &Vblink_cursor_alist
,
24865 doc
: /* Alist specifying how to blink the cursor off.
24866 Each element has the form (ON-STATE . OFF-STATE). Whenever the
24867 `cursor-type' frame-parameter or variable equals ON-STATE,
24868 comparing using `equal', Emacs uses OFF-STATE to specify
24869 how to blink it off. ON-STATE and OFF-STATE are values for
24870 the `cursor-type' frame parameter.
24872 If a frame's ON-STATE has no entry in this list,
24873 the frame's other specifications determine how to blink the cursor off. */);
24874 Vblink_cursor_alist
= Qnil
;
24876 DEFVAR_BOOL ("auto-hscroll-mode", &automatic_hscrolling_p
,
24877 doc
: /* *Non-nil means scroll the display automatically to make point visible. */);
24878 automatic_hscrolling_p
= 1;
24879 Qauto_hscroll_mode
= intern ("auto-hscroll-mode");
24880 staticpro (&Qauto_hscroll_mode
);
24882 DEFVAR_INT ("hscroll-margin", &hscroll_margin
,
24883 doc
: /* *How many columns away from the window edge point is allowed to get
24884 before automatic hscrolling will horizontally scroll the window. */);
24885 hscroll_margin
= 5;
24887 DEFVAR_LISP ("hscroll-step", &Vhscroll_step
,
24888 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
24889 When point is less than `hscroll-margin' columns from the window
24890 edge, automatic hscrolling will scroll the window by the amount of columns
24891 determined by this variable. If its value is a positive integer, scroll that
24892 many columns. If it's a positive floating-point number, it specifies the
24893 fraction of the window's width to scroll. If it's nil or zero, point will be
24894 centered horizontally after the scroll. Any other value, including negative
24895 numbers, are treated as if the value were zero.
24897 Automatic hscrolling always moves point outside the scroll margin, so if
24898 point was more than scroll step columns inside the margin, the window will
24899 scroll more than the value given by the scroll step.
24901 Note that the lower bound for automatic hscrolling specified by `scroll-left'
24902 and `scroll-right' overrides this variable's effect. */);
24903 Vhscroll_step
= make_number (0);
24905 DEFVAR_BOOL ("message-truncate-lines", &message_truncate_lines
,
24906 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
24907 Bind this around calls to `message' to let it take effect. */);
24908 message_truncate_lines
= 0;
24910 DEFVAR_LISP ("menu-bar-update-hook", &Vmenu_bar_update_hook
,
24911 doc
: /* Normal hook run to update the menu bar definitions.
24912 Redisplay runs this hook before it redisplays the menu bar.
24913 This is used to update submenus such as Buffers,
24914 whose contents depend on various data. */);
24915 Vmenu_bar_update_hook
= Qnil
;
24917 DEFVAR_LISP ("menu-updating-frame", &Vmenu_updating_frame
,
24918 doc
: /* Frame for which we are updating a menu.
24919 The enable predicate for a menu binding should check this variable. */);
24920 Vmenu_updating_frame
= Qnil
;
24922 DEFVAR_BOOL ("inhibit-menubar-update", &inhibit_menubar_update
,
24923 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
24924 inhibit_menubar_update
= 0;
24926 DEFVAR_BOOL ("inhibit-eval-during-redisplay", &inhibit_eval_during_redisplay
,
24927 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
24928 inhibit_eval_during_redisplay
= 0;
24930 DEFVAR_BOOL ("inhibit-free-realized-faces", &inhibit_free_realized_faces
,
24931 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
24932 inhibit_free_realized_faces
= 0;
24935 DEFVAR_BOOL ("inhibit-try-window-id", &inhibit_try_window_id
,
24936 doc
: /* Inhibit try_window_id display optimization. */);
24937 inhibit_try_window_id
= 0;
24939 DEFVAR_BOOL ("inhibit-try-window-reusing", &inhibit_try_window_reusing
,
24940 doc
: /* Inhibit try_window_reusing display optimization. */);
24941 inhibit_try_window_reusing
= 0;
24943 DEFVAR_BOOL ("inhibit-try-cursor-movement", &inhibit_try_cursor_movement
,
24944 doc
: /* Inhibit try_cursor_movement display optimization. */);
24945 inhibit_try_cursor_movement
= 0;
24946 #endif /* GLYPH_DEBUG */
24948 DEFVAR_INT ("overline-margin", &overline_margin
,
24949 doc
: /* *Space between overline and text, in pixels.
24950 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
24951 margin to the caracter height. */);
24952 overline_margin
= 2;
24954 DEFVAR_INT ("underline-minimum-offset",
24955 &underline_minimum_offset
,
24956 doc
: /* Minimum distance between baseline and underline.
24957 This can improve legibility of underlined text at small font sizes,
24958 particularly when using variable `x-use-underline-position-properties'
24959 with fonts that specify an UNDERLINE_POSITION relatively close to the
24960 baseline. The default value is 1. */);
24961 underline_minimum_offset
= 1;
24965 /* Initialize this module when Emacs starts. */
24970 Lisp_Object root_window
;
24971 struct window
*mini_w
;
24973 current_header_line_height
= current_mode_line_height
= -1;
24975 CHARPOS (this_line_start_pos
) = 0;
24977 mini_w
= XWINDOW (minibuf_window
);
24978 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
24980 if (!noninteractive
)
24982 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
24985 XWINDOW (root_window
)->top_line
= make_number (FRAME_TOP_MARGIN (f
));
24986 set_window_height (root_window
,
24987 FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
),
24989 mini_w
->top_line
= make_number (FRAME_LINES (f
) - 1);
24990 set_window_height (minibuf_window
, 1, 0);
24992 XWINDOW (root_window
)->total_cols
= make_number (FRAME_COLS (f
));
24993 mini_w
->total_cols
= make_number (FRAME_COLS (f
));
24995 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
24996 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
24997 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
24999 /* The default ellipsis glyphs `...'. */
25000 for (i
= 0; i
< 3; ++i
)
25001 default_invis_vector
[i
] = make_number ('.');
25005 /* Allocate the buffer for frame titles.
25006 Also used for `format-mode-line'. */
25008 mode_line_noprop_buf
= (char *) xmalloc (size
);
25009 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
25010 mode_line_noprop_ptr
= mode_line_noprop_buf
;
25011 mode_line_target
= MODE_LINE_DISPLAY
;
25014 help_echo_showing_p
= 0;
25018 /* arch-tag: eacc864d-bb6a-4b74-894a-1a4399a1358b
25019 (do not change this comment) */