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 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 2, or (at your option)
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; see the file COPYING. If not, write to
20 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21 Boston, MA 02110-1301, USA. */
23 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>.
27 Emacs separates the task of updating the display from code
28 modifying global state, e.g. buffer text. This way functions
29 operating on buffers don't also have to be concerned with updating
32 Updating the display is triggered by the Lisp interpreter when it
33 decides it's time to do it. This is done either automatically for
34 you as part of the interpreter's command loop or as the result of
35 calling Lisp functions like `sit-for'. The C function `redisplay'
36 in xdisp.c is the only entry into the inner redisplay code. (Or,
37 let's say almost---see the description of direct update
40 The following diagram shows how redisplay code is invoked. As you
41 can see, Lisp calls redisplay and vice versa. Under window systems
42 like X, some portions of the redisplay code are also called
43 asynchronously during mouse movement or expose events. It is very
44 important that these code parts do NOT use the C library (malloc,
45 free) because many C libraries under Unix are not reentrant. They
46 may also NOT call functions of the Lisp interpreter which could
47 change the interpreter's state. If you don't follow these rules,
48 you will encounter bugs which are very hard to explain.
50 (Direct functions, see below)
51 direct_output_for_insert,
52 direct_forward_char (dispnew.c)
53 +---------------------------------+
56 +--------------+ redisplay +----------------+
57 | Lisp machine |---------------->| Redisplay code |<--+
58 +--------------+ (xdisp.c) +----------------+ |
60 +----------------------------------+ |
61 Don't use this path when called |
64 expose_window (asynchronous) |
66 X expose events -----+
68 What does redisplay do? Obviously, it has to figure out somehow what
69 has been changed since the last time the display has been updated,
70 and to make these changes visible. Preferably it would do that in
71 a moderately intelligent way, i.e. fast.
73 Changes in buffer text can be deduced from window and buffer
74 structures, and from some global variables like `beg_unchanged' and
75 `end_unchanged'. The contents of the display are additionally
76 recorded in a `glyph matrix', a two-dimensional matrix of glyph
77 structures. Each row in such a matrix corresponds to a line on the
78 display, and each glyph in a row corresponds to a column displaying
79 a character, an image, or what else. This matrix is called the
80 `current glyph matrix' or `current matrix' in redisplay
83 For buffer parts that have been changed since the last update, a
84 second glyph matrix is constructed, the so called `desired glyph
85 matrix' or short `desired matrix'. Current and desired matrix are
86 then compared to find a cheap way to update the display, e.g. by
87 reusing part of the display by scrolling lines.
92 You will find a lot of redisplay optimizations when you start
93 looking at the innards of redisplay. The overall goal of all these
94 optimizations is to make redisplay fast because it is done
97 Two optimizations are not found in xdisp.c. These are the direct
98 operations mentioned above. As the name suggests they follow a
99 different principle than the rest of redisplay. Instead of
100 building a desired matrix and then comparing it with the current
101 display, they perform their actions directly on the display and on
104 One direct operation updates the display after one character has
105 been entered. The other one moves the cursor by one position
106 forward or backward. You find these functions under the names
107 `direct_output_for_insert' and `direct_output_forward_char' in
113 Desired matrices are always built per Emacs window. The function
114 `display_line' is the central function to look at if you are
115 interested. It constructs one row in a desired matrix given an
116 iterator structure containing both a buffer position and a
117 description of the environment in which the text is to be
118 displayed. But this is too early, read on.
120 Characters and pixmaps displayed for a range of buffer text depend
121 on various settings of buffers and windows, on overlays and text
122 properties, on display tables, on selective display. The good news
123 is that all this hairy stuff is hidden behind a small set of
124 interface functions taking an iterator structure (struct it)
127 Iteration over things to be displayed is then simple. It is
128 started by initializing an iterator with a call to init_iterator.
129 Calls to get_next_display_element fill the iterator structure with
130 relevant information about the next thing to display. Calls to
131 set_iterator_to_next move the iterator to the next thing.
133 Besides this, an iterator also contains information about the
134 display environment in which glyphs for display elements are to be
135 produced. It has fields for the width and height of the display,
136 the information whether long lines are truncated or continued, a
137 current X and Y position, and lots of other stuff you can better
140 Glyphs in a desired matrix are normally constructed in a loop
141 calling get_next_display_element and then produce_glyphs. The call
142 to produce_glyphs will fill the iterator structure with pixel
143 information about the element being displayed and at the same time
144 produce glyphs for it. If the display element fits on the line
145 being displayed, set_iterator_to_next is called next, otherwise the
146 glyphs produced are discarded.
151 That just couldn't be all, could it? What about terminal types not
152 supporting operations on sub-windows of the screen? To update the
153 display on such a terminal, window-based glyph matrices are not
154 well suited. To be able to reuse part of the display (scrolling
155 lines up and down), we must instead have a view of the whole
156 screen. This is what `frame matrices' are for. They are a trick.
158 Frames on terminals like above have a glyph pool. Windows on such
159 a frame sub-allocate their glyph memory from their frame's glyph
160 pool. The frame itself is given its own glyph matrices. By
161 coincidence---or maybe something else---rows in window glyph
162 matrices are slices of corresponding rows in frame matrices. Thus
163 writing to window matrices implicitly updates a frame matrix which
164 provides us with the view of the whole screen that we originally
165 wanted to have without having to move many bytes around. To be
166 honest, there is a little bit more done, but not much more. If you
167 plan to extend that code, take a look at dispnew.c. The function
168 build_frame_matrix is a good starting point. */
174 #include "keyboard.h"
177 #include "termchar.h"
178 #include "dispextern.h"
182 #include "commands.h"
186 #include "termhooks.h"
187 #include "intervals.h"
190 #include "region-cache.h"
192 #include "blockinput.h"
194 #ifdef HAVE_X_WINDOWS
204 #ifndef FRAME_X_OUTPUT
205 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
208 #define INFINITY 10000000
210 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
212 extern void set_frame_menubar
P_ ((struct frame
*f
, int, int));
213 extern int pending_menu_activation
;
216 extern int interrupt_input
;
217 extern int command_loop_level
;
219 extern Lisp_Object do_mouse_tracking
;
221 extern int minibuffer_auto_raise
;
222 extern Lisp_Object Vminibuffer_list
;
224 extern Lisp_Object Qface
;
225 extern Lisp_Object Qmode_line
, Qmode_line_inactive
, Qheader_line
;
227 extern Lisp_Object Voverriding_local_map
;
228 extern Lisp_Object Voverriding_local_map_menu_flag
;
229 extern Lisp_Object Qmenu_item
;
230 extern Lisp_Object Qwhen
;
231 extern Lisp_Object Qhelp_echo
;
233 Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
234 Lisp_Object Qwindow_scroll_functions
, Vwindow_scroll_functions
;
235 Lisp_Object Qredisplay_end_trigger_functions
, Vredisplay_end_trigger_functions
;
236 Lisp_Object Qinhibit_point_motion_hooks
;
237 Lisp_Object QCeval
, QCfile
, QCdata
, QCpropertize
;
238 Lisp_Object Qfontified
;
239 Lisp_Object Qgrow_only
;
240 Lisp_Object Qinhibit_eval_during_redisplay
;
241 Lisp_Object Qbuffer_position
, Qposition
, Qobject
;
244 Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
247 Lisp_Object Qarrow
, Qhand
, Qtext
;
249 Lisp_Object Qrisky_local_variable
;
251 /* Holds the list (error). */
252 Lisp_Object list_of_error
;
254 /* Functions called to fontify regions of text. */
256 Lisp_Object Vfontification_functions
;
257 Lisp_Object Qfontification_functions
;
259 /* Non-zero means automatically select any window when the mouse
260 cursor moves into it. */
261 int mouse_autoselect_window
;
263 /* Non-zero means draw tool bar buttons raised when the mouse moves
266 int auto_raise_tool_bar_buttons_p
;
268 /* Non-zero means to reposition window if cursor line is only partially visible. */
270 int make_cursor_line_fully_visible_p
;
272 /* Margin below tool bar in pixels. 0 or nil means no margin.
273 If value is `internal-border-width' or `border-width',
274 the corresponding frame parameter is used. */
276 Lisp_Object Vtool_bar_border
;
278 /* Margin around tool bar buttons in pixels. */
280 Lisp_Object Vtool_bar_button_margin
;
282 /* Thickness of shadow to draw around tool bar buttons. */
284 EMACS_INT tool_bar_button_relief
;
286 /* Non-zero means automatically resize tool-bars so that all tool-bar
287 items are visible, and no blank lines remain. */
289 int auto_resize_tool_bars_p
;
291 /* Non-zero means draw block and hollow cursor as wide as the glyph
292 under it. For example, if a block cursor is over a tab, it will be
293 drawn as wide as that tab on the display. */
295 int x_stretch_cursor_p
;
297 /* Non-nil means don't actually do any redisplay. */
299 Lisp_Object Vinhibit_redisplay
, Qinhibit_redisplay
;
301 /* Non-zero means Lisp evaluation during redisplay is inhibited. */
303 int inhibit_eval_during_redisplay
;
305 /* Names of text properties relevant for redisplay. */
307 Lisp_Object Qdisplay
;
308 extern Lisp_Object Qface
, Qinvisible
, Qwidth
;
310 /* Symbols used in text property values. */
312 Lisp_Object Vdisplay_pixels_per_inch
;
313 Lisp_Object Qspace
, QCalign_to
, QCrelative_width
, QCrelative_height
;
314 Lisp_Object Qleft_margin
, Qright_margin
, Qspace_width
, Qraise
;
317 Lisp_Object Qmargin
, Qpointer
;
318 Lisp_Object Qline_height
;
319 extern Lisp_Object Qheight
;
320 extern Lisp_Object QCwidth
, QCheight
, QCascent
;
321 extern Lisp_Object Qscroll_bar
;
322 extern Lisp_Object Qcursor
;
324 /* Non-nil means highlight trailing whitespace. */
326 Lisp_Object Vshow_trailing_whitespace
;
328 /* Non-nil means escape non-break space and hyphens. */
330 Lisp_Object Vnobreak_char_display
;
332 #ifdef HAVE_WINDOW_SYSTEM
333 extern Lisp_Object Voverflow_newline_into_fringe
;
335 /* Test if overflow newline into fringe. Called with iterator IT
336 at or past right window margin, and with IT->current_x set. */
338 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) \
339 (!NILP (Voverflow_newline_into_fringe) \
340 && FRAME_WINDOW_P (it->f) \
341 && WINDOW_RIGHT_FRINGE_WIDTH (it->w) > 0 \
342 && it->current_x == it->last_visible_x)
344 #endif /* HAVE_WINDOW_SYSTEM */
346 /* Non-nil means show the text cursor in void text areas
347 i.e. in blank areas after eol and eob. This used to be
348 the default in 21.3. */
350 Lisp_Object Vvoid_text_area_pointer
;
352 /* Name of the face used to highlight trailing whitespace. */
354 Lisp_Object Qtrailing_whitespace
;
356 /* Name and number of the face used to highlight escape glyphs. */
358 Lisp_Object Qescape_glyph
;
360 /* Name and number of the face used to highlight non-breaking spaces. */
362 Lisp_Object Qnobreak_space
;
364 /* The symbol `image' which is the car of the lists used to represent
369 /* The image map types. */
370 Lisp_Object QCmap
, QCpointer
;
371 Lisp_Object Qrect
, Qcircle
, Qpoly
;
373 /* Non-zero means print newline to stdout before next mini-buffer
376 int noninteractive_need_newline
;
378 /* Non-zero means print newline to message log before next message. */
380 static int message_log_need_newline
;
382 /* Three markers that message_dolog uses.
383 It could allocate them itself, but that causes trouble
384 in handling memory-full errors. */
385 static Lisp_Object message_dolog_marker1
;
386 static Lisp_Object message_dolog_marker2
;
387 static Lisp_Object message_dolog_marker3
;
389 /* The buffer position of the first character appearing entirely or
390 partially on the line of the selected window which contains the
391 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
392 redisplay optimization in redisplay_internal. */
394 static struct text_pos this_line_start_pos
;
396 /* Number of characters past the end of the line above, including the
397 terminating newline. */
399 static struct text_pos this_line_end_pos
;
401 /* The vertical positions and the height of this line. */
403 static int this_line_vpos
;
404 static int this_line_y
;
405 static int this_line_pixel_height
;
407 /* X position at which this display line starts. Usually zero;
408 negative if first character is partially visible. */
410 static int this_line_start_x
;
412 /* Buffer that this_line_.* variables are referring to. */
414 static struct buffer
*this_line_buffer
;
416 /* Nonzero means truncate lines in all windows less wide than the
419 int truncate_partial_width_windows
;
421 /* A flag to control how to display unibyte 8-bit character. */
423 int unibyte_display_via_language_environment
;
425 /* Nonzero means we have more than one non-mini-buffer-only frame.
426 Not guaranteed to be accurate except while parsing
427 frame-title-format. */
431 Lisp_Object Vglobal_mode_string
;
434 /* List of variables (symbols) which hold markers for overlay arrows.
435 The symbols on this list are examined during redisplay to determine
436 where to display overlay arrows. */
438 Lisp_Object Voverlay_arrow_variable_list
;
440 /* Marker for where to display an arrow on top of the buffer text. */
442 Lisp_Object Voverlay_arrow_position
;
444 /* String to display for the arrow. Only used on terminal frames. */
446 Lisp_Object Voverlay_arrow_string
;
448 /* Values of those variables at last redisplay are stored as
449 properties on `overlay-arrow-position' symbol. However, if
450 Voverlay_arrow_position is a marker, last-arrow-position is its
451 numerical position. */
453 Lisp_Object Qlast_arrow_position
, Qlast_arrow_string
;
455 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
456 properties on a symbol in overlay-arrow-variable-list. */
458 Lisp_Object Qoverlay_arrow_string
, Qoverlay_arrow_bitmap
;
460 /* Like mode-line-format, but for the title bar on a visible frame. */
462 Lisp_Object Vframe_title_format
;
464 /* Like mode-line-format, but for the title bar on an iconified frame. */
466 Lisp_Object Vicon_title_format
;
468 /* List of functions to call when a window's size changes. These
469 functions get one arg, a frame on which one or more windows' sizes
472 static Lisp_Object Vwindow_size_change_functions
;
474 Lisp_Object Qmenu_bar_update_hook
, Vmenu_bar_update_hook
;
476 /* Nonzero if an overlay arrow has been displayed in this window. */
478 static int overlay_arrow_seen
;
480 /* Nonzero means highlight the region even in nonselected windows. */
482 int highlight_nonselected_windows
;
484 /* If cursor motion alone moves point off frame, try scrolling this
485 many lines up or down if that will bring it back. */
487 static EMACS_INT scroll_step
;
489 /* Nonzero means scroll just far enough to bring point back on the
490 screen, when appropriate. */
492 static EMACS_INT scroll_conservatively
;
494 /* Recenter the window whenever point gets within this many lines of
495 the top or bottom of the window. This value is translated into a
496 pixel value by multiplying it with FRAME_LINE_HEIGHT, which means
497 that there is really a fixed pixel height scroll margin. */
499 EMACS_INT scroll_margin
;
501 /* Number of windows showing the buffer of the selected window (or
502 another buffer with the same base buffer). keyboard.c refers to
507 /* Vector containing glyphs for an ellipsis `...'. */
509 static Lisp_Object default_invis_vector
[3];
511 /* Zero means display the mode-line/header-line/menu-bar in the default face
512 (this slightly odd definition is for compatibility with previous versions
513 of emacs), non-zero means display them using their respective faces.
515 This variable is deprecated. */
517 int mode_line_inverse_video
;
519 /* Prompt to display in front of the mini-buffer contents. */
521 Lisp_Object minibuf_prompt
;
523 /* Width of current mini-buffer prompt. Only set after display_line
524 of the line that contains the prompt. */
526 int minibuf_prompt_width
;
528 /* This is the window where the echo area message was displayed. It
529 is always a mini-buffer window, but it may not be the same window
530 currently active as a mini-buffer. */
532 Lisp_Object echo_area_window
;
534 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
535 pushes the current message and the value of
536 message_enable_multibyte on the stack, the function restore_message
537 pops the stack and displays MESSAGE again. */
539 Lisp_Object Vmessage_stack
;
541 /* Nonzero means multibyte characters were enabled when the echo area
542 message was specified. */
544 int message_enable_multibyte
;
546 /* Nonzero if we should redraw the mode lines on the next redisplay. */
548 int update_mode_lines
;
550 /* Nonzero if window sizes or contents have changed since last
551 redisplay that finished. */
553 int windows_or_buffers_changed
;
555 /* Nonzero means a frame's cursor type has been changed. */
557 int cursor_type_changed
;
559 /* Nonzero after display_mode_line if %l was used and it displayed a
562 int line_number_displayed
;
564 /* Maximum buffer size for which to display line numbers. */
566 Lisp_Object Vline_number_display_limit
;
568 /* Line width to consider when repositioning for line number display. */
570 static EMACS_INT line_number_display_limit_width
;
572 /* Number of lines to keep in the message log buffer. t means
573 infinite. nil means don't log at all. */
575 Lisp_Object Vmessage_log_max
;
577 /* The name of the *Messages* buffer, a string. */
579 static Lisp_Object Vmessages_buffer_name
;
581 /* Index 0 is the buffer that holds the current (desired) echo area message,
582 or nil if none is desired right now.
584 Index 1 is the buffer that holds the previously displayed echo area message,
585 or nil to indicate no message. This is normally what's on the screen now.
587 These two can point to the same buffer. That happens when the last
588 message output by the user (or made by echoing) has been displayed. */
590 Lisp_Object echo_area_buffer
[2];
592 /* Permanent pointers to the two buffers that are used for echo area
593 purposes. Once the two buffers are made, and their pointers are
594 placed here, these two slots remain unchanged unless those buffers
595 need to be created afresh. */
597 static Lisp_Object echo_buffer
[2];
599 /* A vector saved used in with_area_buffer to reduce consing. */
601 static Lisp_Object Vwith_echo_area_save_vector
;
603 /* Non-zero means display_echo_area should display the last echo area
604 message again. Set by redisplay_preserve_echo_area. */
606 static int display_last_displayed_message_p
;
608 /* Nonzero if echo area is being used by print; zero if being used by
611 int message_buf_print
;
613 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
615 Lisp_Object Qinhibit_menubar_update
;
616 int inhibit_menubar_update
;
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
;
695 /* How close to the margin can point get before the window is scrolled
697 EMACS_INT hscroll_margin
;
699 /* How much to scroll horizontally when point is inside the above margin. */
700 Lisp_Object Vhscroll_step
;
702 /* The variable `resize-mini-windows'. If nil, don't resize
703 mini-windows. If t, always resize them to fit the text they
704 display. If `grow-only', let mini-windows grow only until they
707 Lisp_Object Vresize_mini_windows
;
709 /* Buffer being redisplayed -- for redisplay_window_error. */
711 struct buffer
*displayed_buffer
;
713 /* Value returned from text property handlers (see below). */
718 HANDLED_RECOMPUTE_PROPS
,
719 HANDLED_OVERLAY_STRING_CONSUMED
,
723 /* A description of text properties that redisplay is interested
728 /* The name of the property. */
731 /* A unique index for the property. */
734 /* A handler function called to set up iterator IT from the property
735 at IT's current position. Value is used to steer handle_stop. */
736 enum prop_handled (*handler
) P_ ((struct it
*it
));
739 static enum prop_handled handle_face_prop
P_ ((struct it
*));
740 static enum prop_handled handle_invisible_prop
P_ ((struct it
*));
741 static enum prop_handled handle_display_prop
P_ ((struct it
*));
742 static enum prop_handled handle_composition_prop
P_ ((struct it
*));
743 static enum prop_handled handle_overlay_change
P_ ((struct it
*));
744 static enum prop_handled handle_fontified_prop
P_ ((struct it
*));
746 /* Properties handled by iterators. */
748 static struct props it_props
[] =
750 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
751 /* Handle `face' before `display' because some sub-properties of
752 `display' need to know the face. */
753 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
754 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
755 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
756 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
760 /* Value is the position described by X. If X is a marker, value is
761 the marker_position of X. Otherwise, value is X. */
763 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
765 /* Enumeration returned by some move_it_.* functions internally. */
769 /* Not used. Undefined value. */
772 /* Move ended at the requested buffer position or ZV. */
773 MOVE_POS_MATCH_OR_ZV
,
775 /* Move ended at the requested X pixel position. */
778 /* Move within a line ended at the end of a line that must be
782 /* Move within a line ended at the end of a line that would
783 be displayed truncated. */
786 /* Move within a line ended at a line end. */
790 /* This counter is used to clear the face cache every once in a while
791 in redisplay_internal. It is incremented for each redisplay.
792 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
795 #define CLEAR_FACE_CACHE_COUNT 500
796 static int clear_face_cache_count
;
798 /* Similarly for the image cache. */
800 #ifdef HAVE_WINDOW_SYSTEM
801 #define CLEAR_IMAGE_CACHE_COUNT 101
802 static int clear_image_cache_count
;
805 /* Record the previous terminal frame we displayed. */
807 static struct frame
*previous_terminal_frame
;
809 /* Non-zero while redisplay_internal is in progress. */
813 /* Non-zero means don't free realized faces. Bound while freeing
814 realized faces is dangerous because glyph matrices might still
817 int inhibit_free_realized_faces
;
818 Lisp_Object Qinhibit_free_realized_faces
;
820 /* If a string, XTread_socket generates an event to display that string.
821 (The display is done in read_char.) */
823 Lisp_Object help_echo_string
;
824 Lisp_Object help_echo_window
;
825 Lisp_Object help_echo_object
;
828 /* Temporary variable for XTread_socket. */
830 Lisp_Object previous_help_echo_string
;
832 /* Null glyph slice */
834 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
837 /* Function prototypes. */
839 static void setup_for_ellipsis
P_ ((struct it
*, int));
840 static void mark_window_display_accurate_1
P_ ((struct window
*, int));
841 static int single_display_spec_string_p
P_ ((Lisp_Object
, Lisp_Object
));
842 static int display_prop_string_p
P_ ((Lisp_Object
, Lisp_Object
));
843 static int cursor_row_p
P_ ((struct window
*, struct glyph_row
*));
844 static int redisplay_mode_lines
P_ ((Lisp_Object
, int));
845 static char *decode_mode_spec_coding
P_ ((Lisp_Object
, char *, int));
848 static int invisible_text_between_p
P_ ((struct it
*, int, int));
851 static void pint2str
P_ ((char *, int, int));
852 static void pint2hrstr
P_ ((char *, int, int));
853 static struct text_pos run_window_scroll_functions
P_ ((Lisp_Object
,
855 static void reconsider_clip_changes
P_ ((struct window
*, struct buffer
*));
856 static int text_outside_line_unchanged_p
P_ ((struct window
*, int, int));
857 static void store_mode_line_noprop_char
P_ ((char));
858 static int store_mode_line_noprop
P_ ((const unsigned char *, int, int));
859 static void x_consider_frame_title
P_ ((Lisp_Object
));
860 static void handle_stop
P_ ((struct it
*));
861 static int tool_bar_lines_needed
P_ ((struct frame
*, int *));
862 static int single_display_spec_intangible_p
P_ ((Lisp_Object
));
863 static void ensure_echo_area_buffers
P_ ((void));
864 static Lisp_Object unwind_with_echo_area_buffer
P_ ((Lisp_Object
));
865 static Lisp_Object with_echo_area_buffer_unwind_data
P_ ((struct window
*));
866 static int with_echo_area_buffer
P_ ((struct window
*, int,
867 int (*) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
868 EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
869 static void clear_garbaged_frames
P_ ((void));
870 static int current_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
871 static int truncate_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
872 static int set_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
873 static int display_echo_area
P_ ((struct window
*));
874 static int display_echo_area_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
875 static int resize_mini_window_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
876 static Lisp_Object unwind_redisplay
P_ ((Lisp_Object
));
877 static int string_char_and_length
P_ ((const unsigned char *, int, int *));
878 static struct text_pos display_prop_end
P_ ((struct it
*, Lisp_Object
,
880 static int compute_window_start_on_continuation_line
P_ ((struct window
*));
881 static Lisp_Object safe_eval_handler
P_ ((Lisp_Object
));
882 static void insert_left_trunc_glyphs
P_ ((struct it
*));
883 static struct glyph_row
*get_overlay_arrow_glyph_row
P_ ((struct window
*,
885 static void extend_face_to_end_of_line
P_ ((struct it
*));
886 static int append_space_for_newline
P_ ((struct it
*, int));
887 static int cursor_row_fully_visible_p
P_ ((struct window
*, int, int));
888 static int try_scrolling
P_ ((Lisp_Object
, int, EMACS_INT
, EMACS_INT
, int, int));
889 static int try_cursor_movement
P_ ((Lisp_Object
, struct text_pos
, int *));
890 static int trailing_whitespace_p
P_ ((int));
891 static int message_log_check_duplicate
P_ ((int, int, int, int));
892 static void push_it
P_ ((struct it
*));
893 static void pop_it
P_ ((struct it
*));
894 static void sync_frame_with_window_matrix_rows
P_ ((struct window
*));
895 static void select_frame_for_redisplay
P_ ((Lisp_Object
));
896 static void redisplay_internal
P_ ((int));
897 static int echo_area_display
P_ ((int));
898 static void redisplay_windows
P_ ((Lisp_Object
));
899 static void redisplay_window
P_ ((Lisp_Object
, int));
900 static Lisp_Object
redisplay_window_error ();
901 static Lisp_Object redisplay_window_0
P_ ((Lisp_Object
));
902 static Lisp_Object redisplay_window_1
P_ ((Lisp_Object
));
903 static void update_menu_bar
P_ ((struct frame
*, int));
904 static int try_window_reusing_current_matrix
P_ ((struct window
*));
905 static int try_window_id
P_ ((struct window
*));
906 static int display_line
P_ ((struct it
*));
907 static int display_mode_lines
P_ ((struct window
*));
908 static int display_mode_line
P_ ((struct window
*, enum face_id
, Lisp_Object
));
909 static int display_mode_element
P_ ((struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int));
910 static int store_mode_line_string
P_ ((char *, Lisp_Object
, int, int, int, Lisp_Object
));
911 static char *decode_mode_spec
P_ ((struct window
*, int, int, int, int *));
912 static void display_menu_bar
P_ ((struct window
*));
913 static int display_count_lines
P_ ((int, int, int, int, int *));
914 static int display_string
P_ ((unsigned char *, Lisp_Object
, Lisp_Object
,
915 int, int, struct it
*, int, int, int, int));
916 static void compute_line_metrics
P_ ((struct it
*));
917 static void run_redisplay_end_trigger_hook
P_ ((struct it
*));
918 static int get_overlay_strings
P_ ((struct it
*, int));
919 static int get_overlay_strings_1
P_ ((struct it
*, int, int));
920 static void next_overlay_string
P_ ((struct it
*));
921 static void reseat
P_ ((struct it
*, struct text_pos
, int));
922 static void reseat_1
P_ ((struct it
*, struct text_pos
, int));
923 static void back_to_previous_visible_line_start
P_ ((struct it
*));
924 void reseat_at_previous_visible_line_start
P_ ((struct it
*));
925 static void reseat_at_next_visible_line_start
P_ ((struct it
*, int));
926 static int next_element_from_ellipsis
P_ ((struct it
*));
927 static int next_element_from_display_vector
P_ ((struct it
*));
928 static int next_element_from_string
P_ ((struct it
*));
929 static int next_element_from_c_string
P_ ((struct it
*));
930 static int next_element_from_buffer
P_ ((struct it
*));
931 static int next_element_from_composition
P_ ((struct it
*));
932 static int next_element_from_image
P_ ((struct it
*));
933 static int next_element_from_stretch
P_ ((struct it
*));
934 static void load_overlay_strings
P_ ((struct it
*, int));
935 static int init_from_display_pos
P_ ((struct it
*, struct window
*,
936 struct display_pos
*));
937 static void reseat_to_string
P_ ((struct it
*, unsigned char *,
938 Lisp_Object
, int, int, int, int));
939 static enum move_it_result move_it_in_display_line_to
P_ ((struct it
*,
941 void move_it_vertically_backward
P_ ((struct it
*, int));
942 static void init_to_row_start
P_ ((struct it
*, struct window
*,
943 struct glyph_row
*));
944 static int init_to_row_end
P_ ((struct it
*, struct window
*,
945 struct glyph_row
*));
946 static void back_to_previous_line_start
P_ ((struct it
*));
947 static int forward_to_next_line_start
P_ ((struct it
*, int *));
948 static struct text_pos string_pos_nchars_ahead
P_ ((struct text_pos
,
950 static struct text_pos string_pos
P_ ((int, Lisp_Object
));
951 static struct text_pos c_string_pos
P_ ((int, unsigned char *, int));
952 static int number_of_chars
P_ ((unsigned char *, int));
953 static void compute_stop_pos
P_ ((struct it
*));
954 static void compute_string_pos
P_ ((struct text_pos
*, struct text_pos
,
956 static int face_before_or_after_it_pos
P_ ((struct it
*, int));
957 static int next_overlay_change
P_ ((int));
958 static int handle_single_display_spec
P_ ((struct it
*, Lisp_Object
,
959 Lisp_Object
, struct text_pos
*,
961 static int underlying_face_id
P_ ((struct it
*));
962 static int in_ellipses_for_invisible_text_p
P_ ((struct display_pos
*,
965 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
966 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
968 #ifdef HAVE_WINDOW_SYSTEM
970 static void update_tool_bar
P_ ((struct frame
*, int));
971 static void build_desired_tool_bar_string
P_ ((struct frame
*f
));
972 static int redisplay_tool_bar
P_ ((struct frame
*));
973 static void display_tool_bar_line
P_ ((struct it
*, int));
974 static void notice_overwritten_cursor
P_ ((struct window
*,
976 int, int, int, int));
980 #endif /* HAVE_WINDOW_SYSTEM */
983 /***********************************************************************
984 Window display dimensions
985 ***********************************************************************/
987 /* Return the bottom boundary y-position for text lines in window W.
988 This is the first y position at which a line cannot start.
989 It is relative to the top of the window.
991 This is the height of W minus the height of a mode line, if any. */
994 window_text_bottom_y (w
)
997 int height
= WINDOW_TOTAL_HEIGHT (w
);
999 if (WINDOW_WANTS_MODELINE_P (w
))
1000 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
1004 /* Return the pixel width of display area AREA of window W. AREA < 0
1005 means return the total width of W, not including fringes to
1006 the left and right of the window. */
1009 window_box_width (w
, area
)
1013 int cols
= XFASTINT (w
->total_cols
);
1016 if (!w
->pseudo_window_p
)
1018 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
1020 if (area
== TEXT_AREA
)
1022 if (INTEGERP (w
->left_margin_cols
))
1023 cols
-= XFASTINT (w
->left_margin_cols
);
1024 if (INTEGERP (w
->right_margin_cols
))
1025 cols
-= XFASTINT (w
->right_margin_cols
);
1026 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
1028 else if (area
== LEFT_MARGIN_AREA
)
1030 cols
= (INTEGERP (w
->left_margin_cols
)
1031 ? XFASTINT (w
->left_margin_cols
) : 0);
1034 else if (area
== RIGHT_MARGIN_AREA
)
1036 cols
= (INTEGERP (w
->right_margin_cols
)
1037 ? XFASTINT (w
->right_margin_cols
) : 0);
1042 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
1046 /* Return the pixel height of the display area of window W, not
1047 including mode lines of W, if any. */
1050 window_box_height (w
)
1053 struct frame
*f
= XFRAME (w
->frame
);
1054 int height
= WINDOW_TOTAL_HEIGHT (w
);
1056 xassert (height
>= 0);
1058 /* Note: the code below that determines the mode-line/header-line
1059 height is essentially the same as that contained in the macro
1060 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
1061 the appropriate glyph row has its `mode_line_p' flag set,
1062 and if it doesn't, uses estimate_mode_line_height instead. */
1064 if (WINDOW_WANTS_MODELINE_P (w
))
1066 struct glyph_row
*ml_row
1067 = (w
->current_matrix
&& w
->current_matrix
->rows
1068 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1070 if (ml_row
&& ml_row
->mode_line_p
)
1071 height
-= ml_row
->height
;
1073 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1076 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1078 struct glyph_row
*hl_row
1079 = (w
->current_matrix
&& w
->current_matrix
->rows
1080 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1082 if (hl_row
&& hl_row
->mode_line_p
)
1083 height
-= hl_row
->height
;
1085 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1088 /* With a very small font and a mode-line that's taller than
1089 default, we might end up with a negative height. */
1090 return max (0, height
);
1093 /* Return the window-relative coordinate of the left edge of display
1094 area AREA of window W. AREA < 0 means return the left edge of the
1095 whole window, to the right of the left fringe of W. */
1098 window_box_left_offset (w
, area
)
1104 if (w
->pseudo_window_p
)
1107 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1109 if (area
== TEXT_AREA
)
1110 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1111 + window_box_width (w
, LEFT_MARGIN_AREA
));
1112 else if (area
== RIGHT_MARGIN_AREA
)
1113 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1114 + window_box_width (w
, LEFT_MARGIN_AREA
)
1115 + window_box_width (w
, TEXT_AREA
)
1116 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1118 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1119 else if (area
== LEFT_MARGIN_AREA
1120 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1121 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1127 /* Return the window-relative coordinate of the right edge of display
1128 area AREA of window W. AREA < 0 means return the left edge of the
1129 whole window, to the left of the right fringe of W. */
1132 window_box_right_offset (w
, area
)
1136 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1139 /* Return the frame-relative coordinate of the left edge of display
1140 area AREA of window W. AREA < 0 means return the left edge of the
1141 whole window, to the right of the left fringe of W. */
1144 window_box_left (w
, area
)
1148 struct frame
*f
= XFRAME (w
->frame
);
1151 if (w
->pseudo_window_p
)
1152 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1154 x
= (WINDOW_LEFT_EDGE_X (w
)
1155 + window_box_left_offset (w
, area
));
1161 /* Return the frame-relative coordinate of the right edge of display
1162 area AREA of window W. AREA < 0 means return the left edge of the
1163 whole window, to the left of the right fringe of W. */
1166 window_box_right (w
, area
)
1170 return window_box_left (w
, area
) + window_box_width (w
, area
);
1173 /* Get the bounding box of the display area AREA of window W, without
1174 mode lines, in frame-relative coordinates. AREA < 0 means the
1175 whole window, not including the left and right fringes of
1176 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1177 coordinates of the upper-left corner of the box. Return in
1178 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1181 window_box (w
, area
, box_x
, box_y
, box_width
, box_height
)
1184 int *box_x
, *box_y
, *box_width
, *box_height
;
1187 *box_width
= window_box_width (w
, area
);
1189 *box_height
= window_box_height (w
);
1191 *box_x
= window_box_left (w
, area
);
1194 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1195 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1196 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1201 /* Get the bounding box of the display area AREA of window W, without
1202 mode lines. AREA < 0 means the whole window, not including the
1203 left and right fringe of the window. Return in *TOP_LEFT_X
1204 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1205 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1206 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1210 window_box_edges (w
, area
, top_left_x
, top_left_y
,
1211 bottom_right_x
, bottom_right_y
)
1214 int *top_left_x
, *top_left_y
, *bottom_right_x
, *bottom_right_y
;
1216 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1218 *bottom_right_x
+= *top_left_x
;
1219 *bottom_right_y
+= *top_left_y
;
1224 /***********************************************************************
1226 ***********************************************************************/
1228 /* Return the bottom y-position of the line the iterator IT is in.
1229 This can modify IT's settings. */
1235 int line_height
= it
->max_ascent
+ it
->max_descent
;
1236 int line_top_y
= it
->current_y
;
1238 if (line_height
== 0)
1241 line_height
= last_height
;
1242 else if (IT_CHARPOS (*it
) < ZV
)
1244 move_it_by_lines (it
, 1, 1);
1245 line_height
= (it
->max_ascent
|| it
->max_descent
1246 ? it
->max_ascent
+ it
->max_descent
1251 struct glyph_row
*row
= it
->glyph_row
;
1253 /* Use the default character height. */
1254 it
->glyph_row
= NULL
;
1255 it
->what
= IT_CHARACTER
;
1258 PRODUCE_GLYPHS (it
);
1259 line_height
= it
->ascent
+ it
->descent
;
1260 it
->glyph_row
= row
;
1264 return line_top_y
+ line_height
;
1268 /* Return 1 if position CHARPOS is visible in window W.
1269 If visible, set *X and *Y to pixel coordinates of top left corner.
1270 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1271 EXACT_MODE_LINE_HEIGHTS_P non-zero means compute exact mode-line
1272 and header-lines heights. */
1275 pos_visible_p (w
, charpos
, x
, y
, rtop
, rbot
, exact_mode_line_heights_p
)
1277 int charpos
, *x
, *y
, *rtop
, *rbot
, exact_mode_line_heights_p
;
1280 struct text_pos top
;
1282 struct buffer
*old_buffer
= NULL
;
1287 if (XBUFFER (w
->buffer
) != current_buffer
)
1289 old_buffer
= current_buffer
;
1290 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1293 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1295 /* Compute exact mode line heights, if requested. */
1296 if (exact_mode_line_heights_p
)
1298 if (WINDOW_WANTS_MODELINE_P (w
))
1299 current_mode_line_height
1300 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1301 current_buffer
->mode_line_format
);
1303 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1304 current_header_line_height
1305 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1306 current_buffer
->header_line_format
);
1309 start_display (&it
, w
, top
);
1310 move_it_to (&it
, charpos
, -1, it
.last_visible_y
, -1,
1311 MOVE_TO_POS
| MOVE_TO_Y
);
1313 /* Note that we may overshoot because of invisible text. */
1314 if (IT_CHARPOS (it
) >= charpos
)
1316 int top_x
= it
.current_x
;
1317 int top_y
= it
.current_y
;
1318 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1319 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1321 if (top_y
< window_top_y
)
1322 visible_p
= bottom_y
> window_top_y
;
1323 else if (top_y
< it
.last_visible_y
)
1328 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1329 *rtop
= max (0, window_top_y
- top_y
);
1330 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1338 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1339 move_it_by_lines (&it
, 1, 0);
1340 if (charpos
< IT_CHARPOS (it
))
1343 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1345 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1346 *rtop
= max (0, -it2
.current_y
);
1347 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1348 - it
.last_visible_y
));
1353 set_buffer_internal_1 (old_buffer
);
1355 current_header_line_height
= current_mode_line_height
= -1;
1357 if (visible_p
&& XFASTINT (w
->hscroll
) > 0)
1358 *x
-= XFASTINT (w
->hscroll
) * WINDOW_FRAME_COLUMN_WIDTH (w
);
1364 /* Return the next character from STR which is MAXLEN bytes long.
1365 Return in *LEN the length of the character. This is like
1366 STRING_CHAR_AND_LENGTH but never returns an invalid character. If
1367 we find one, we return a `?', but with the length of the invalid
1371 string_char_and_length (str
, maxlen
, len
)
1372 const unsigned char *str
;
1377 c
= STRING_CHAR_AND_LENGTH (str
, maxlen
, *len
);
1378 if (!CHAR_VALID_P (c
, 1))
1379 /* We may not change the length here because other places in Emacs
1380 don't use this function, i.e. they silently accept invalid
1389 /* Given a position POS containing a valid character and byte position
1390 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1392 static struct text_pos
1393 string_pos_nchars_ahead (pos
, string
, nchars
)
1394 struct text_pos pos
;
1398 xassert (STRINGP (string
) && nchars
>= 0);
1400 if (STRING_MULTIBYTE (string
))
1402 int rest
= SBYTES (string
) - BYTEPOS (pos
);
1403 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1408 string_char_and_length (p
, rest
, &len
);
1409 p
+= len
, rest
-= len
;
1410 xassert (rest
>= 0);
1412 BYTEPOS (pos
) += len
;
1416 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1422 /* Value is the text position, i.e. character and byte position,
1423 for character position CHARPOS in STRING. */
1425 static INLINE
struct text_pos
1426 string_pos (charpos
, string
)
1430 struct text_pos pos
;
1431 xassert (STRINGP (string
));
1432 xassert (charpos
>= 0);
1433 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1438 /* Value is a text position, i.e. character and byte position, for
1439 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1440 means recognize multibyte characters. */
1442 static struct text_pos
1443 c_string_pos (charpos
, s
, multibyte_p
)
1448 struct text_pos pos
;
1450 xassert (s
!= NULL
);
1451 xassert (charpos
>= 0);
1455 int rest
= strlen (s
), len
;
1457 SET_TEXT_POS (pos
, 0, 0);
1460 string_char_and_length (s
, rest
, &len
);
1461 s
+= len
, rest
-= len
;
1462 xassert (rest
>= 0);
1464 BYTEPOS (pos
) += len
;
1468 SET_TEXT_POS (pos
, charpos
, charpos
);
1474 /* Value is the number of characters in C string S. MULTIBYTE_P
1475 non-zero means recognize multibyte characters. */
1478 number_of_chars (s
, multibyte_p
)
1486 int rest
= strlen (s
), len
;
1487 unsigned char *p
= (unsigned char *) s
;
1489 for (nchars
= 0; rest
> 0; ++nchars
)
1491 string_char_and_length (p
, rest
, &len
);
1492 rest
-= len
, p
+= len
;
1496 nchars
= strlen (s
);
1502 /* Compute byte position NEWPOS->bytepos corresponding to
1503 NEWPOS->charpos. POS is a known position in string STRING.
1504 NEWPOS->charpos must be >= POS.charpos. */
1507 compute_string_pos (newpos
, pos
, string
)
1508 struct text_pos
*newpos
, pos
;
1511 xassert (STRINGP (string
));
1512 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1514 if (STRING_MULTIBYTE (string
))
1515 *newpos
= string_pos_nchars_ahead (pos
, string
,
1516 CHARPOS (*newpos
) - CHARPOS (pos
));
1518 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1522 Return an estimation of the pixel height of mode or top lines on
1523 frame F. FACE_ID specifies what line's height to estimate. */
1526 estimate_mode_line_height (f
, face_id
)
1528 enum face_id face_id
;
1530 #ifdef HAVE_WINDOW_SYSTEM
1531 if (FRAME_WINDOW_P (f
))
1533 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1535 /* This function is called so early when Emacs starts that the face
1536 cache and mode line face are not yet initialized. */
1537 if (FRAME_FACE_CACHE (f
))
1539 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1543 height
= FONT_HEIGHT (face
->font
);
1544 if (face
->box_line_width
> 0)
1545 height
+= 2 * face
->box_line_width
;
1556 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1557 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1558 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1559 not force the value into range. */
1562 pixel_to_glyph_coords (f
, pix_x
, pix_y
, x
, y
, bounds
, noclip
)
1564 register int pix_x
, pix_y
;
1566 NativeRectangle
*bounds
;
1570 #ifdef HAVE_WINDOW_SYSTEM
1571 if (FRAME_WINDOW_P (f
))
1573 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1574 even for negative values. */
1576 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1578 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1580 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1581 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1584 STORE_NATIVE_RECT (*bounds
,
1585 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1586 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1587 FRAME_COLUMN_WIDTH (f
) - 1,
1588 FRAME_LINE_HEIGHT (f
) - 1);
1594 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1595 pix_x
= FRAME_TOTAL_COLS (f
);
1599 else if (pix_y
> FRAME_LINES (f
))
1600 pix_y
= FRAME_LINES (f
);
1610 /* Given HPOS/VPOS in the current matrix of W, return corresponding
1611 frame-relative pixel positions in *FRAME_X and *FRAME_Y. If we
1612 can't tell the positions because W's display is not up to date,
1616 glyph_to_pixel_coords (w
, hpos
, vpos
, frame_x
, frame_y
)
1619 int *frame_x
, *frame_y
;
1621 #ifdef HAVE_WINDOW_SYSTEM
1622 if (FRAME_WINDOW_P (XFRAME (WINDOW_FRAME (w
))))
1626 xassert (hpos
>= 0 && hpos
< w
->current_matrix
->matrix_w
);
1627 xassert (vpos
>= 0 && vpos
< w
->current_matrix
->matrix_h
);
1629 if (display_completed
)
1631 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
1632 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1633 struct glyph
*end
= glyph
+ min (hpos
, row
->used
[TEXT_AREA
]);
1639 hpos
+= glyph
->pixel_width
;
1643 /* If first glyph is partially visible, its first visible position is still 0. */
1655 *frame_x
= WINDOW_TO_FRAME_PIXEL_X (w
, hpos
);
1656 *frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, vpos
);
1667 #ifdef HAVE_WINDOW_SYSTEM
1669 /* Find the glyph under window-relative coordinates X/Y in window W.
1670 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1671 strings. Return in *HPOS and *VPOS the row and column number of
1672 the glyph found. Return in *AREA the glyph area containing X.
1673 Value is a pointer to the glyph found or null if X/Y is not on
1674 text, or we can't tell because W's current matrix is not up to
1677 static struct glyph
*
1678 x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, dx
, dy
, area
)
1681 int *hpos
, *vpos
, *dx
, *dy
, *area
;
1683 struct glyph
*glyph
, *end
;
1684 struct glyph_row
*row
= NULL
;
1687 /* Find row containing Y. Give up if some row is not enabled. */
1688 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1690 row
= MATRIX_ROW (w
->current_matrix
, i
);
1691 if (!row
->enabled_p
)
1693 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1700 /* Give up if Y is not in the window. */
1701 if (i
== w
->current_matrix
->nrows
)
1704 /* Get the glyph area containing X. */
1705 if (w
->pseudo_window_p
)
1712 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1714 *area
= LEFT_MARGIN_AREA
;
1715 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1717 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1720 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1724 *area
= RIGHT_MARGIN_AREA
;
1725 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1729 /* Find glyph containing X. */
1730 glyph
= row
->glyphs
[*area
];
1731 end
= glyph
+ row
->used
[*area
];
1733 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1735 x
-= glyph
->pixel_width
;
1745 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1748 *hpos
= glyph
- row
->glyphs
[*area
];
1754 Convert frame-relative x/y to coordinates relative to window W.
1755 Takes pseudo-windows into account. */
1758 frame_to_window_pixel_xy (w
, x
, y
)
1762 if (w
->pseudo_window_p
)
1764 /* A pseudo-window is always full-width, and starts at the
1765 left edge of the frame, plus a frame border. */
1766 struct frame
*f
= XFRAME (w
->frame
);
1767 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1768 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1772 *x
-= WINDOW_LEFT_EDGE_X (w
);
1773 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1778 Return in RECTS[] at most N clipping rectangles for glyph string S.
1779 Return the number of stored rectangles. */
1782 get_glyph_string_clip_rects (s
, rects
, n
)
1783 struct glyph_string
*s
;
1784 NativeRectangle
*rects
;
1792 if (s
->row
->full_width_p
)
1794 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1795 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1796 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1798 /* Unless displaying a mode or menu bar line, which are always
1799 fully visible, clip to the visible part of the row. */
1800 if (s
->w
->pseudo_window_p
)
1801 r
.height
= s
->row
->visible_height
;
1803 r
.height
= s
->height
;
1807 /* This is a text line that may be partially visible. */
1808 r
.x
= window_box_left (s
->w
, s
->area
);
1809 r
.width
= window_box_width (s
->w
, s
->area
);
1810 r
.height
= s
->row
->visible_height
;
1814 if (r
.x
< s
->clip_head
->x
)
1816 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1817 r
.width
-= s
->clip_head
->x
- r
.x
;
1820 r
.x
= s
->clip_head
->x
;
1823 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1825 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1826 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1831 /* If S draws overlapping rows, it's sufficient to use the top and
1832 bottom of the window for clipping because this glyph string
1833 intentionally draws over other lines. */
1834 if (s
->for_overlaps
)
1836 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1837 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1839 /* Alas, the above simple strategy does not work for the
1840 environments with anti-aliased text: if the same text is
1841 drawn onto the same place multiple times, it gets thicker.
1842 If the overlap we are processing is for the erased cursor, we
1843 take the intersection with the rectagle of the cursor. */
1844 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
1846 XRectangle rc
, r_save
= r
;
1848 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
1849 rc
.y
= s
->w
->phys_cursor
.y
;
1850 rc
.width
= s
->w
->phys_cursor_width
;
1851 rc
.height
= s
->w
->phys_cursor_height
;
1853 x_intersect_rectangles (&r_save
, &rc
, &r
);
1858 /* Don't use S->y for clipping because it doesn't take partially
1859 visible lines into account. For example, it can be negative for
1860 partially visible lines at the top of a window. */
1861 if (!s
->row
->full_width_p
1862 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
1863 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1865 r
.y
= max (0, s
->row
->y
);
1867 /* If drawing a tool-bar window, draw it over the internal border
1868 at the top of the window. */
1869 if (WINDOWP (s
->f
->tool_bar_window
)
1870 && s
->w
== XWINDOW (s
->f
->tool_bar_window
))
1871 r
.y
-= FRAME_INTERNAL_BORDER_WIDTH (s
->f
);
1874 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
1876 /* If drawing the cursor, don't let glyph draw outside its
1877 advertised boundaries. Cleartype does this under some circumstances. */
1878 if (s
->hl
== DRAW_CURSOR
)
1880 struct glyph
*glyph
= s
->first_glyph
;
1885 r
.width
-= s
->x
- r
.x
;
1888 r
.width
= min (r
.width
, glyph
->pixel_width
);
1890 /* If r.y is below window bottom, ensure that we still see a cursor. */
1891 height
= min (glyph
->ascent
+ glyph
->descent
,
1892 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
1893 max_y
= window_text_bottom_y (s
->w
) - height
;
1894 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
1895 if (s
->ybase
- glyph
->ascent
> max_y
)
1902 /* Don't draw cursor glyph taller than our actual glyph. */
1903 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
1904 if (height
< r
.height
)
1906 max_y
= r
.y
+ r
.height
;
1907 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
1908 r
.height
= min (max_y
- r
.y
, height
);
1913 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
1914 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
1916 #ifdef CONVERT_FROM_XRECT
1917 CONVERT_FROM_XRECT (r
, *rects
);
1925 /* If we are processing overlapping and allowed to return
1926 multiple clipping rectangles, we exclude the row of the glyph
1927 string from the clipping rectangle. This is to avoid drawing
1928 the same text on the environment with anti-aliasing. */
1929 #ifdef CONVERT_FROM_XRECT
1932 XRectangle
*rs
= rects
;
1934 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
1936 if (s
->for_overlaps
& OVERLAPS_PRED
)
1939 if (r
.y
+ r
.height
> row_y
)
1942 rs
[i
].height
= row_y
- r
.y
;
1948 if (s
->for_overlaps
& OVERLAPS_SUCC
)
1951 if (r
.y
< row_y
+ s
->row
->visible_height
)
1953 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
1955 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
1956 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
1965 #ifdef CONVERT_FROM_XRECT
1966 for (i
= 0; i
< n
; i
++)
1967 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
1974 Return in *NR the clipping rectangle for glyph string S. */
1977 get_glyph_string_clip_rect (s
, nr
)
1978 struct glyph_string
*s
;
1979 NativeRectangle
*nr
;
1981 get_glyph_string_clip_rects (s
, nr
, 1);
1986 Return the position and height of the phys cursor in window W.
1987 Set w->phys_cursor_width to width of phys cursor.
1991 get_phys_cursor_geometry (w
, row
, glyph
, xp
, yp
, heightp
)
1993 struct glyph_row
*row
;
1994 struct glyph
*glyph
;
1995 int *xp
, *yp
, *heightp
;
1997 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
1998 int x
, y
, wd
, h
, h0
, y0
;
2000 /* Compute the width of the rectangle to draw. If on a stretch
2001 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2002 rectangle as wide as the glyph, but use a canonical character
2004 wd
= glyph
->pixel_width
- 1;
2009 x
= w
->phys_cursor
.x
;
2016 if (glyph
->type
== STRETCH_GLYPH
2017 && !x_stretch_cursor_p
)
2018 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2019 w
->phys_cursor_width
= wd
;
2021 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
2023 /* If y is below window bottom, ensure that we still see a cursor. */
2024 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2026 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
2027 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
2029 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2032 h
= max (h
- (y0
- y
) + 1, h0
);
2037 y0
= window_text_bottom_y (w
) - h0
;
2045 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2046 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2051 * Remember which glyph the mouse is over.
2055 remember_mouse_glyph (f
, gx
, gy
, rect
)
2058 NativeRectangle
*rect
;
2062 struct glyph_row
*r
, *gr
, *end_row
;
2063 enum window_part part
;
2064 enum glyph_row_area area
;
2065 int x
, y
, width
, height
;
2067 /* Try to determine frame pixel position and size of the glyph under
2068 frame pixel coordinates X/Y on frame F. */
2070 window
= window_from_coordinates (f
, gx
, gy
, &part
, &x
, &y
, 0);
2073 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2074 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2078 w
= XWINDOW (window
);
2079 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2080 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2082 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2083 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2085 if (w
->pseudo_window_p
)
2088 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2094 case ON_LEFT_MARGIN
:
2095 area
= LEFT_MARGIN_AREA
;
2098 case ON_RIGHT_MARGIN
:
2099 area
= RIGHT_MARGIN_AREA
;
2102 case ON_HEADER_LINE
:
2104 gr
= (part
== ON_HEADER_LINE
2105 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2106 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2109 goto text_glyph_row_found
;
2116 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2117 if (r
->y
+ r
->height
> y
)
2123 text_glyph_row_found
:
2126 struct glyph
*g
= gr
->glyphs
[area
];
2127 struct glyph
*end
= g
+ gr
->used
[area
];
2129 height
= gr
->height
;
2130 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2131 if (gx
+ g
->pixel_width
> x
)
2136 if (g
->type
== IMAGE_GLYPH
)
2138 /* Don't remember when mouse is over image, as
2139 image may have hot-spots. */
2140 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2143 width
= g
->pixel_width
;
2147 /* Use nominal char spacing at end of line. */
2149 gx
+= (x
/ width
) * width
;
2152 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2153 gx
+= window_box_left_offset (w
, area
);
2157 /* Use nominal line height at end of window. */
2158 gx
= (x
/ width
) * width
;
2160 gy
+= (y
/ height
) * height
;
2164 case ON_LEFT_FRINGE
:
2165 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2166 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2167 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2168 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2171 case ON_RIGHT_FRINGE
:
2172 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2173 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2174 : window_box_right_offset (w
, TEXT_AREA
));
2175 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2179 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2181 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2182 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2183 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2185 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2189 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2190 if (r
->y
+ r
->height
> y
)
2197 height
= gr
->height
;
2200 /* Use nominal line height at end of window. */
2202 gy
+= (y
/ height
) * height
;
2209 /* If there is no glyph under the mouse, then we divide the screen
2210 into a grid of the smallest glyph in the frame, and use that
2213 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2214 round down even for negative values. */
2220 gx
= (gx
/ width
) * width
;
2221 gy
= (gy
/ height
) * height
;
2226 gx
+= WINDOW_LEFT_EDGE_X (w
);
2227 gy
+= WINDOW_TOP_EDGE_Y (w
);
2230 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2232 /* Visible feedback for debugging. */
2235 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2236 f
->output_data
.x
->normal_gc
,
2237 gx
, gy
, width
, height
);
2243 #endif /* HAVE_WINDOW_SYSTEM */
2246 /***********************************************************************
2247 Lisp form evaluation
2248 ***********************************************************************/
2250 /* Error handler for safe_eval and safe_call. */
2253 safe_eval_handler (arg
)
2256 add_to_log ("Error during redisplay: %s", arg
, Qnil
);
2261 /* Evaluate SEXPR and return the result, or nil if something went
2262 wrong. Prevent redisplay during the evaluation. */
2270 if (inhibit_eval_during_redisplay
)
2274 int count
= SPECPDL_INDEX ();
2275 struct gcpro gcpro1
;
2278 specbind (Qinhibit_redisplay
, Qt
);
2279 /* Use Qt to ensure debugger does not run,
2280 so there is no possibility of wanting to redisplay. */
2281 val
= internal_condition_case_1 (Feval
, sexpr
, Qt
,
2284 val
= unbind_to (count
, val
);
2291 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
2292 Return the result, or nil if something went wrong. Prevent
2293 redisplay during the evaluation. */
2296 safe_call (nargs
, args
)
2302 if (inhibit_eval_during_redisplay
)
2306 int count
= SPECPDL_INDEX ();
2307 struct gcpro gcpro1
;
2310 gcpro1
.nvars
= nargs
;
2311 specbind (Qinhibit_redisplay
, Qt
);
2312 /* Use Qt to ensure debugger does not run,
2313 so there is no possibility of wanting to redisplay. */
2314 val
= internal_condition_case_2 (Ffuncall
, nargs
, args
, Qt
,
2317 val
= unbind_to (count
, val
);
2324 /* Call function FN with one argument ARG.
2325 Return the result, or nil if something went wrong. */
2328 safe_call1 (fn
, arg
)
2329 Lisp_Object fn
, arg
;
2331 Lisp_Object args
[2];
2334 return safe_call (2, args
);
2339 /***********************************************************************
2341 ***********************************************************************/
2345 /* Define CHECK_IT to perform sanity checks on iterators.
2346 This is for debugging. It is too slow to do unconditionally. */
2352 if (it
->method
== GET_FROM_STRING
)
2354 xassert (STRINGP (it
->string
));
2355 xassert (IT_STRING_CHARPOS (*it
) >= 0);
2359 xassert (IT_STRING_CHARPOS (*it
) < 0);
2360 if (it
->method
== GET_FROM_BUFFER
)
2362 /* Check that character and byte positions agree. */
2363 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2368 xassert (it
->current
.dpvec_index
>= 0);
2370 xassert (it
->current
.dpvec_index
< 0);
2373 #define CHECK_IT(IT) check_it ((IT))
2377 #define CHECK_IT(IT) (void) 0
2384 /* Check that the window end of window W is what we expect it
2385 to be---the last row in the current matrix displaying text. */
2388 check_window_end (w
)
2391 if (!MINI_WINDOW_P (w
)
2392 && !NILP (w
->window_end_valid
))
2394 struct glyph_row
*row
;
2395 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
2396 XFASTINT (w
->window_end_vpos
)),
2398 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2399 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2403 #define CHECK_WINDOW_END(W) check_window_end ((W))
2405 #else /* not GLYPH_DEBUG */
2407 #define CHECK_WINDOW_END(W) (void) 0
2409 #endif /* not GLYPH_DEBUG */
2413 /***********************************************************************
2414 Iterator initialization
2415 ***********************************************************************/
2417 /* Initialize IT for displaying current_buffer in window W, starting
2418 at character position CHARPOS. CHARPOS < 0 means that no buffer
2419 position is specified which is useful when the iterator is assigned
2420 a position later. BYTEPOS is the byte position corresponding to
2421 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2423 If ROW is not null, calls to produce_glyphs with IT as parameter
2424 will produce glyphs in that row.
2426 BASE_FACE_ID is the id of a base face to use. It must be one of
2427 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2428 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2429 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2431 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2432 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2433 will be initialized to use the corresponding mode line glyph row of
2434 the desired matrix of W. */
2437 init_iterator (it
, w
, charpos
, bytepos
, row
, base_face_id
)
2440 int charpos
, bytepos
;
2441 struct glyph_row
*row
;
2442 enum face_id base_face_id
;
2444 int highlight_region_p
;
2446 /* Some precondition checks. */
2447 xassert (w
!= NULL
&& it
!= NULL
);
2448 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2451 /* If face attributes have been changed since the last redisplay,
2452 free realized faces now because they depend on face definitions
2453 that might have changed. Don't free faces while there might be
2454 desired matrices pending which reference these faces. */
2455 if (face_change_count
&& !inhibit_free_realized_faces
)
2457 face_change_count
= 0;
2458 free_all_realized_faces (Qnil
);
2461 /* Use one of the mode line rows of W's desired matrix if
2465 if (base_face_id
== MODE_LINE_FACE_ID
2466 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2467 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2468 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2469 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2473 bzero (it
, sizeof *it
);
2474 it
->current
.overlay_string_index
= -1;
2475 it
->current
.dpvec_index
= -1;
2476 it
->base_face_id
= base_face_id
;
2478 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2480 /* The window in which we iterate over current_buffer: */
2481 XSETWINDOW (it
->window
, w
);
2483 it
->f
= XFRAME (w
->frame
);
2485 /* Extra space between lines (on window systems only). */
2486 if (base_face_id
== DEFAULT_FACE_ID
2487 && FRAME_WINDOW_P (it
->f
))
2489 if (NATNUMP (current_buffer
->extra_line_spacing
))
2490 it
->extra_line_spacing
= XFASTINT (current_buffer
->extra_line_spacing
);
2491 else if (FLOATP (current_buffer
->extra_line_spacing
))
2492 it
->extra_line_spacing
= (XFLOAT_DATA (current_buffer
->extra_line_spacing
)
2493 * FRAME_LINE_HEIGHT (it
->f
));
2494 else if (it
->f
->extra_line_spacing
> 0)
2495 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2496 it
->max_extra_line_spacing
= 0;
2499 /* If realized faces have been removed, e.g. because of face
2500 attribute changes of named faces, recompute them. When running
2501 in batch mode, the face cache of Vterminal_frame is null. If
2502 we happen to get called, make a dummy face cache. */
2503 if (noninteractive
&& FRAME_FACE_CACHE (it
->f
) == NULL
)
2504 init_frame_faces (it
->f
);
2505 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2506 recompute_basic_faces (it
->f
);
2508 /* Current value of the `slice', `space-width', and 'height' properties. */
2509 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2510 it
->space_width
= Qnil
;
2511 it
->font_height
= Qnil
;
2512 it
->override_ascent
= -1;
2514 /* Are control characters displayed as `^C'? */
2515 it
->ctl_arrow_p
= !NILP (current_buffer
->ctl_arrow
);
2517 /* -1 means everything between a CR and the following line end
2518 is invisible. >0 means lines indented more than this value are
2520 it
->selective
= (INTEGERP (current_buffer
->selective_display
)
2521 ? XFASTINT (current_buffer
->selective_display
)
2522 : (!NILP (current_buffer
->selective_display
)
2524 it
->selective_display_ellipsis_p
2525 = !NILP (current_buffer
->selective_display_ellipses
);
2527 /* Display table to use. */
2528 it
->dp
= window_display_table (w
);
2530 /* Are multibyte characters enabled in current_buffer? */
2531 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
2533 /* Non-zero if we should highlight the region. */
2535 = (!NILP (Vtransient_mark_mode
)
2536 && !NILP (current_buffer
->mark_active
)
2537 && XMARKER (current_buffer
->mark
)->buffer
!= 0);
2539 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2540 start and end of a visible region in window IT->w. Set both to
2541 -1 to indicate no region. */
2542 if (highlight_region_p
2543 /* Maybe highlight only in selected window. */
2544 && (/* Either show region everywhere. */
2545 highlight_nonselected_windows
2546 /* Or show region in the selected window. */
2547 || w
== XWINDOW (selected_window
)
2548 /* Or show the region if we are in the mini-buffer and W is
2549 the window the mini-buffer refers to. */
2550 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2551 && WINDOWP (minibuf_selected_window
)
2552 && w
== XWINDOW (minibuf_selected_window
))))
2554 int charpos
= marker_position (current_buffer
->mark
);
2555 it
->region_beg_charpos
= min (PT
, charpos
);
2556 it
->region_end_charpos
= max (PT
, charpos
);
2559 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2561 /* Get the position at which the redisplay_end_trigger hook should
2562 be run, if it is to be run at all. */
2563 if (MARKERP (w
->redisplay_end_trigger
)
2564 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2565 it
->redisplay_end_trigger_charpos
2566 = marker_position (w
->redisplay_end_trigger
);
2567 else if (INTEGERP (w
->redisplay_end_trigger
))
2568 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
2570 /* Correct bogus values of tab_width. */
2571 it
->tab_width
= XINT (current_buffer
->tab_width
);
2572 if (it
->tab_width
<= 0 || it
->tab_width
> 1000)
2575 /* Are lines in the display truncated? */
2576 it
->truncate_lines_p
2577 = (base_face_id
!= DEFAULT_FACE_ID
2578 || XINT (it
->w
->hscroll
)
2579 || (truncate_partial_width_windows
2580 && !WINDOW_FULL_WIDTH_P (it
->w
))
2581 || !NILP (current_buffer
->truncate_lines
));
2583 /* Get dimensions of truncation and continuation glyphs. These are
2584 displayed as fringe bitmaps under X, so we don't need them for such
2586 if (!FRAME_WINDOW_P (it
->f
))
2588 if (it
->truncate_lines_p
)
2590 /* We will need the truncation glyph. */
2591 xassert (it
->glyph_row
== NULL
);
2592 produce_special_glyphs (it
, IT_TRUNCATION
);
2593 it
->truncation_pixel_width
= it
->pixel_width
;
2597 /* We will need the continuation glyph. */
2598 xassert (it
->glyph_row
== NULL
);
2599 produce_special_glyphs (it
, IT_CONTINUATION
);
2600 it
->continuation_pixel_width
= it
->pixel_width
;
2603 /* Reset these values to zero because the produce_special_glyphs
2604 above has changed them. */
2605 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2606 it
->phys_ascent
= it
->phys_descent
= 0;
2609 /* Set this after getting the dimensions of truncation and
2610 continuation glyphs, so that we don't produce glyphs when calling
2611 produce_special_glyphs, above. */
2612 it
->glyph_row
= row
;
2613 it
->area
= TEXT_AREA
;
2615 /* Get the dimensions of the display area. The display area
2616 consists of the visible window area plus a horizontally scrolled
2617 part to the left of the window. All x-values are relative to the
2618 start of this total display area. */
2619 if (base_face_id
!= DEFAULT_FACE_ID
)
2621 /* Mode lines, menu bar in terminal frames. */
2622 it
->first_visible_x
= 0;
2623 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2628 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2629 it
->last_visible_x
= (it
->first_visible_x
2630 + window_box_width (w
, TEXT_AREA
));
2632 /* If we truncate lines, leave room for the truncator glyph(s) at
2633 the right margin. Otherwise, leave room for the continuation
2634 glyph(s). Truncation and continuation glyphs are not inserted
2635 for window-based redisplay. */
2636 if (!FRAME_WINDOW_P (it
->f
))
2638 if (it
->truncate_lines_p
)
2639 it
->last_visible_x
-= it
->truncation_pixel_width
;
2641 it
->last_visible_x
-= it
->continuation_pixel_width
;
2644 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2645 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2648 /* Leave room for a border glyph. */
2649 if (!FRAME_WINDOW_P (it
->f
)
2650 && !WINDOW_RIGHTMOST_P (it
->w
))
2651 it
->last_visible_x
-= 1;
2653 it
->last_visible_y
= window_text_bottom_y (w
);
2655 /* For mode lines and alike, arrange for the first glyph having a
2656 left box line if the face specifies a box. */
2657 if (base_face_id
!= DEFAULT_FACE_ID
)
2661 it
->face_id
= base_face_id
;
2663 /* If we have a boxed mode line, make the first character appear
2664 with a left box line. */
2665 face
= FACE_FROM_ID (it
->f
, base_face_id
);
2666 if (face
->box
!= FACE_NO_BOX
)
2667 it
->start_of_box_run_p
= 1;
2670 /* If a buffer position was specified, set the iterator there,
2671 getting overlays and face properties from that position. */
2672 if (charpos
>= BUF_BEG (current_buffer
))
2674 it
->end_charpos
= ZV
;
2676 IT_CHARPOS (*it
) = charpos
;
2678 /* Compute byte position if not specified. */
2679 if (bytepos
< charpos
)
2680 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2682 IT_BYTEPOS (*it
) = bytepos
;
2684 it
->start
= it
->current
;
2686 /* Compute faces etc. */
2687 reseat (it
, it
->current
.pos
, 1);
2694 /* Initialize IT for the display of window W with window start POS. */
2697 start_display (it
, w
, pos
)
2700 struct text_pos pos
;
2702 struct glyph_row
*row
;
2703 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2705 row
= w
->desired_matrix
->rows
+ first_vpos
;
2706 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2707 it
->first_vpos
= first_vpos
;
2709 /* Don't reseat to previous visible line start if current start
2710 position is in a string or image. */
2711 if (it
->method
== GET_FROM_BUFFER
&& !it
->truncate_lines_p
)
2713 int start_at_line_beg_p
;
2714 int first_y
= it
->current_y
;
2716 /* If window start is not at a line start, skip forward to POS to
2717 get the correct continuation lines width. */
2718 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2719 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2720 if (!start_at_line_beg_p
)
2724 reseat_at_previous_visible_line_start (it
);
2725 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2727 new_x
= it
->current_x
+ it
->pixel_width
;
2729 /* If lines are continued, this line may end in the middle
2730 of a multi-glyph character (e.g. a control character
2731 displayed as \003, or in the middle of an overlay
2732 string). In this case move_it_to above will not have
2733 taken us to the start of the continuation line but to the
2734 end of the continued line. */
2735 if (it
->current_x
> 0
2736 && !it
->truncate_lines_p
/* Lines are continued. */
2737 && (/* And glyph doesn't fit on the line. */
2738 new_x
> it
->last_visible_x
2739 /* Or it fits exactly and we're on a window
2741 || (new_x
== it
->last_visible_x
2742 && FRAME_WINDOW_P (it
->f
))))
2744 if (it
->current
.dpvec_index
>= 0
2745 || it
->current
.overlay_string_index
>= 0)
2747 set_iterator_to_next (it
, 1);
2748 move_it_in_display_line_to (it
, -1, -1, 0);
2751 it
->continuation_lines_width
+= it
->current_x
;
2754 /* We're starting a new display line, not affected by the
2755 height of the continued line, so clear the appropriate
2756 fields in the iterator structure. */
2757 it
->max_ascent
= it
->max_descent
= 0;
2758 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2760 it
->current_y
= first_y
;
2762 it
->current_x
= it
->hpos
= 0;
2766 #if 0 /* Don't assert the following because start_display is sometimes
2767 called intentionally with a window start that is not at a
2768 line start. Please leave this code in as a comment. */
2770 /* Window start should be on a line start, now. */
2771 xassert (it
->continuation_lines_width
2772 || IT_CHARPOS (it
) == BEGV
2773 || FETCH_BYTE (IT_BYTEPOS (it
) - 1) == '\n');
2778 /* Return 1 if POS is a position in ellipses displayed for invisible
2779 text. W is the window we display, for text property lookup. */
2782 in_ellipses_for_invisible_text_p (pos
, w
)
2783 struct display_pos
*pos
;
2786 Lisp_Object prop
, window
;
2788 int charpos
= CHARPOS (pos
->pos
);
2790 /* If POS specifies a position in a display vector, this might
2791 be for an ellipsis displayed for invisible text. We won't
2792 get the iterator set up for delivering that ellipsis unless
2793 we make sure that it gets aware of the invisible text. */
2794 if (pos
->dpvec_index
>= 0
2795 && pos
->overlay_string_index
< 0
2796 && CHARPOS (pos
->string_pos
) < 0
2798 && (XSETWINDOW (window
, w
),
2799 prop
= Fget_char_property (make_number (charpos
),
2800 Qinvisible
, window
),
2801 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2803 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2805 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2812 /* Initialize IT for stepping through current_buffer in window W,
2813 starting at position POS that includes overlay string and display
2814 vector/ control character translation position information. Value
2815 is zero if there are overlay strings with newlines at POS. */
2818 init_from_display_pos (it
, w
, pos
)
2821 struct display_pos
*pos
;
2823 int charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
2824 int i
, overlay_strings_with_newlines
= 0;
2826 /* If POS specifies a position in a display vector, this might
2827 be for an ellipsis displayed for invisible text. We won't
2828 get the iterator set up for delivering that ellipsis unless
2829 we make sure that it gets aware of the invisible text. */
2830 if (in_ellipses_for_invisible_text_p (pos
, w
))
2836 /* Keep in mind: the call to reseat in init_iterator skips invisible
2837 text, so we might end up at a position different from POS. This
2838 is only a problem when POS is a row start after a newline and an
2839 overlay starts there with an after-string, and the overlay has an
2840 invisible property. Since we don't skip invisible text in
2841 display_line and elsewhere immediately after consuming the
2842 newline before the row start, such a POS will not be in a string,
2843 but the call to init_iterator below will move us to the
2845 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
2847 /* This only scans the current chunk -- it should scan all chunks.
2848 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
2849 to 16 in 22.1 to make this a lesser problem. */
2850 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
2852 const char *s
= SDATA (it
->overlay_strings
[i
]);
2853 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
2855 while (s
< e
&& *s
!= '\n')
2860 overlay_strings_with_newlines
= 1;
2865 /* If position is within an overlay string, set up IT to the right
2867 if (pos
->overlay_string_index
>= 0)
2871 /* If the first overlay string happens to have a `display'
2872 property for an image, the iterator will be set up for that
2873 image, and we have to undo that setup first before we can
2874 correct the overlay string index. */
2875 if (it
->method
== GET_FROM_IMAGE
)
2878 /* We already have the first chunk of overlay strings in
2879 IT->overlay_strings. Load more until the one for
2880 pos->overlay_string_index is in IT->overlay_strings. */
2881 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
2883 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
2884 it
->current
.overlay_string_index
= 0;
2887 load_overlay_strings (it
, 0);
2888 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
2892 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
2893 relative_index
= (it
->current
.overlay_string_index
2894 % OVERLAY_STRING_CHUNK_SIZE
);
2895 it
->string
= it
->overlay_strings
[relative_index
];
2896 xassert (STRINGP (it
->string
));
2897 it
->current
.string_pos
= pos
->string_pos
;
2898 it
->method
= GET_FROM_STRING
;
2901 #if 0 /* This is bogus because POS not having an overlay string
2902 position does not mean it's after the string. Example: A
2903 line starting with a before-string and initialization of IT
2904 to the previous row's end position. */
2905 else if (it
->current
.overlay_string_index
>= 0)
2907 /* If POS says we're already after an overlay string ending at
2908 POS, make sure to pop the iterator because it will be in
2909 front of that overlay string. When POS is ZV, we've thereby
2910 also ``processed'' overlay strings at ZV. */
2913 xassert (it
->current
.overlay_string_index
== -1);
2914 xassert (it
->method
== GET_FROM_BUFFER
);
2915 if (CHARPOS (pos
->pos
) == ZV
)
2916 it
->overlay_strings_at_end_processed_p
= 1;
2920 if (CHARPOS (pos
->string_pos
) >= 0)
2922 /* Recorded position is not in an overlay string, but in another
2923 string. This can only be a string from a `display' property.
2924 IT should already be filled with that string. */
2925 it
->current
.string_pos
= pos
->string_pos
;
2926 xassert (STRINGP (it
->string
));
2929 /* Restore position in display vector translations, control
2930 character translations or ellipses. */
2931 if (pos
->dpvec_index
>= 0)
2933 if (it
->dpvec
== NULL
)
2934 get_next_display_element (it
);
2935 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
2936 it
->current
.dpvec_index
= pos
->dpvec_index
;
2940 return !overlay_strings_with_newlines
;
2944 /* Initialize IT for stepping through current_buffer in window W
2945 starting at ROW->start. */
2948 init_to_row_start (it
, w
, row
)
2951 struct glyph_row
*row
;
2953 init_from_display_pos (it
, w
, &row
->start
);
2954 it
->start
= row
->start
;
2955 it
->continuation_lines_width
= row
->continuation_lines_width
;
2960 /* Initialize IT for stepping through current_buffer in window W
2961 starting in the line following ROW, i.e. starting at ROW->end.
2962 Value is zero if there are overlay strings with newlines at ROW's
2966 init_to_row_end (it
, w
, row
)
2969 struct glyph_row
*row
;
2973 if (init_from_display_pos (it
, w
, &row
->end
))
2975 if (row
->continued_p
)
2976 it
->continuation_lines_width
2977 = row
->continuation_lines_width
+ row
->pixel_width
;
2988 /***********************************************************************
2990 ***********************************************************************/
2992 /* Called when IT reaches IT->stop_charpos. Handle text property and
2993 overlay changes. Set IT->stop_charpos to the next position where
3000 enum prop_handled handled
;
3001 int handle_overlay_change_p
;
3005 it
->current
.dpvec_index
= -1;
3006 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3007 it
->ignore_overlay_strings_at_pos_p
= 0;
3009 /* Use face of preceding text for ellipsis (if invisible) */
3010 if (it
->selective_display_ellipsis_p
)
3011 it
->saved_face_id
= it
->face_id
;
3015 handled
= HANDLED_NORMALLY
;
3017 /* Call text property handlers. */
3018 for (p
= it_props
; p
->handler
; ++p
)
3020 handled
= p
->handler (it
);
3022 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3024 else if (handled
== HANDLED_RETURN
)
3026 /* We still want to show before and after strings from
3027 overlays even if the actual buffer text is replaced. */
3028 if (!handle_overlay_change_p
|| it
->sp
> 1)
3030 if (!get_overlay_strings_1 (it
, 0, 0))
3032 it
->ignore_overlay_strings_at_pos_p
= 1;
3033 it
->string_from_display_prop_p
= 0;
3034 handle_overlay_change_p
= 0;
3035 handled
= HANDLED_RECOMPUTE_PROPS
;
3038 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3039 handle_overlay_change_p
= 0;
3042 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3044 /* Don't check for overlay strings below when set to deliver
3045 characters from a display vector. */
3046 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3047 handle_overlay_change_p
= 0;
3049 /* Handle overlay changes. */
3050 if (handle_overlay_change_p
)
3051 handled
= handle_overlay_change (it
);
3053 /* Determine where to stop next. */
3054 if (handled
== HANDLED_NORMALLY
)
3055 compute_stop_pos (it
);
3058 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3062 /* Compute IT->stop_charpos from text property and overlay change
3063 information for IT's current position. */
3066 compute_stop_pos (it
)
3069 register INTERVAL iv
, next_iv
;
3070 Lisp_Object object
, limit
, position
;
3072 /* If nowhere else, stop at the end. */
3073 it
->stop_charpos
= it
->end_charpos
;
3075 if (STRINGP (it
->string
))
3077 /* Strings are usually short, so don't limit the search for
3079 object
= it
->string
;
3081 position
= make_number (IT_STRING_CHARPOS (*it
));
3087 /* If next overlay change is in front of the current stop pos
3088 (which is IT->end_charpos), stop there. Note: value of
3089 next_overlay_change is point-max if no overlay change
3091 charpos
= next_overlay_change (IT_CHARPOS (*it
));
3092 if (charpos
< it
->stop_charpos
)
3093 it
->stop_charpos
= charpos
;
3095 /* If showing the region, we have to stop at the region
3096 start or end because the face might change there. */
3097 if (it
->region_beg_charpos
> 0)
3099 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3100 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3101 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3102 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3105 /* Set up variables for computing the stop position from text
3106 property changes. */
3107 XSETBUFFER (object
, current_buffer
);
3108 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3109 position
= make_number (IT_CHARPOS (*it
));
3113 /* Get the interval containing IT's position. Value is a null
3114 interval if there isn't such an interval. */
3115 iv
= validate_interval_range (object
, &position
, &position
, 0);
3116 if (!NULL_INTERVAL_P (iv
))
3118 Lisp_Object values_here
[LAST_PROP_IDX
];
3121 /* Get properties here. */
3122 for (p
= it_props
; p
->handler
; ++p
)
3123 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3125 /* Look for an interval following iv that has different
3127 for (next_iv
= next_interval (iv
);
3128 (!NULL_INTERVAL_P (next_iv
)
3130 || XFASTINT (limit
) > next_iv
->position
));
3131 next_iv
= next_interval (next_iv
))
3133 for (p
= it_props
; p
->handler
; ++p
)
3135 Lisp_Object new_value
;
3137 new_value
= textget (next_iv
->plist
, *p
->name
);
3138 if (!EQ (values_here
[p
->idx
], new_value
))
3146 if (!NULL_INTERVAL_P (next_iv
))
3148 if (INTEGERP (limit
)
3149 && next_iv
->position
>= XFASTINT (limit
))
3150 /* No text property change up to limit. */
3151 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3153 /* Text properties change in next_iv. */
3154 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3158 xassert (STRINGP (it
->string
)
3159 || (it
->stop_charpos
>= BEGV
3160 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3164 /* Return the position of the next overlay change after POS in
3165 current_buffer. Value is point-max if no overlay change
3166 follows. This is like `next-overlay-change' but doesn't use
3170 next_overlay_change (pos
)
3175 Lisp_Object
*overlays
;
3178 /* Get all overlays at the given position. */
3179 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3181 /* If any of these overlays ends before endpos,
3182 use its ending point instead. */
3183 for (i
= 0; i
< noverlays
; ++i
)
3188 oend
= OVERLAY_END (overlays
[i
]);
3189 oendpos
= OVERLAY_POSITION (oend
);
3190 endpos
= min (endpos
, oendpos
);
3198 /***********************************************************************
3200 ***********************************************************************/
3202 /* Handle changes in the `fontified' property of the current buffer by
3203 calling hook functions from Qfontification_functions to fontify
3206 static enum prop_handled
3207 handle_fontified_prop (it
)
3210 Lisp_Object prop
, pos
;
3211 enum prop_handled handled
= HANDLED_NORMALLY
;
3213 if (!NILP (Vmemory_full
))
3216 /* Get the value of the `fontified' property at IT's current buffer
3217 position. (The `fontified' property doesn't have a special
3218 meaning in strings.) If the value is nil, call functions from
3219 Qfontification_functions. */
3220 if (!STRINGP (it
->string
)
3222 && !NILP (Vfontification_functions
)
3223 && !NILP (Vrun_hooks
)
3224 && (pos
= make_number (IT_CHARPOS (*it
)),
3225 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3228 int count
= SPECPDL_INDEX ();
3231 val
= Vfontification_functions
;
3232 specbind (Qfontification_functions
, Qnil
);
3234 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3235 safe_call1 (val
, pos
);
3238 Lisp_Object globals
, fn
;
3239 struct gcpro gcpro1
, gcpro2
;
3242 GCPRO2 (val
, globals
);
3244 for (; CONSP (val
); val
= XCDR (val
))
3250 /* A value of t indicates this hook has a local
3251 binding; it means to run the global binding too.
3252 In a global value, t should not occur. If it
3253 does, we must ignore it to avoid an endless
3255 for (globals
= Fdefault_value (Qfontification_functions
);
3257 globals
= XCDR (globals
))
3259 fn
= XCAR (globals
);
3261 safe_call1 (fn
, pos
);
3265 safe_call1 (fn
, pos
);
3271 unbind_to (count
, Qnil
);
3273 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3274 something. This avoids an endless loop if they failed to
3275 fontify the text for which reason ever. */
3276 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3277 handled
= HANDLED_RECOMPUTE_PROPS
;
3285 /***********************************************************************
3287 ***********************************************************************/
3289 /* Set up iterator IT from face properties at its current position.
3290 Called from handle_stop. */
3292 static enum prop_handled
3293 handle_face_prop (it
)
3296 int new_face_id
, next_stop
;
3298 if (!STRINGP (it
->string
))
3301 = face_at_buffer_position (it
->w
,
3303 it
->region_beg_charpos
,
3304 it
->region_end_charpos
,
3307 + TEXT_PROP_DISTANCE_LIMIT
),
3310 /* Is this a start of a run of characters with box face?
3311 Caveat: this can be called for a freshly initialized
3312 iterator; face_id is -1 in this case. We know that the new
3313 face will not change until limit, i.e. if the new face has a
3314 box, all characters up to limit will have one. But, as
3315 usual, we don't know whether limit is really the end. */
3316 if (new_face_id
!= it
->face_id
)
3318 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3320 /* If new face has a box but old face has not, this is
3321 the start of a run of characters with box, i.e. it has
3322 a shadow on the left side. The value of face_id of the
3323 iterator will be -1 if this is the initial call that gets
3324 the face. In this case, we have to look in front of IT's
3325 position and see whether there is a face != new_face_id. */
3326 it
->start_of_box_run_p
3327 = (new_face
->box
!= FACE_NO_BOX
3328 && (it
->face_id
>= 0
3329 || IT_CHARPOS (*it
) == BEG
3330 || new_face_id
!= face_before_it_pos (it
)));
3331 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3336 int base_face_id
, bufpos
;
3338 if (it
->current
.overlay_string_index
>= 0)
3339 bufpos
= IT_CHARPOS (*it
);
3343 /* For strings from a buffer, i.e. overlay strings or strings
3344 from a `display' property, use the face at IT's current
3345 buffer position as the base face to merge with, so that
3346 overlay strings appear in the same face as surrounding
3347 text, unless they specify their own faces. */
3348 base_face_id
= underlying_face_id (it
);
3350 new_face_id
= face_at_string_position (it
->w
,
3352 IT_STRING_CHARPOS (*it
),
3354 it
->region_beg_charpos
,
3355 it
->region_end_charpos
,
3359 #if 0 /* This shouldn't be neccessary. Let's check it. */
3360 /* If IT is used to display a mode line we would really like to
3361 use the mode line face instead of the frame's default face. */
3362 if (it
->glyph_row
== MATRIX_MODE_LINE_ROW (it
->w
->desired_matrix
)
3363 && new_face_id
== DEFAULT_FACE_ID
)
3364 new_face_id
= CURRENT_MODE_LINE_FACE_ID (it
->w
);
3367 /* Is this a start of a run of characters with box? Caveat:
3368 this can be called for a freshly allocated iterator; face_id
3369 is -1 is this case. We know that the new face will not
3370 change until the next check pos, i.e. if the new face has a
3371 box, all characters up to that position will have a
3372 box. But, as usual, we don't know whether that position
3373 is really the end. */
3374 if (new_face_id
!= it
->face_id
)
3376 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3377 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3379 /* If new face has a box but old face hasn't, this is the
3380 start of a run of characters with box, i.e. it has a
3381 shadow on the left side. */
3382 it
->start_of_box_run_p
3383 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3384 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3388 it
->face_id
= new_face_id
;
3389 return HANDLED_NORMALLY
;
3393 /* Return the ID of the face ``underlying'' IT's current position,
3394 which is in a string. If the iterator is associated with a
3395 buffer, return the face at IT's current buffer position.
3396 Otherwise, use the iterator's base_face_id. */
3399 underlying_face_id (it
)
3402 int face_id
= it
->base_face_id
, i
;
3404 xassert (STRINGP (it
->string
));
3406 for (i
= it
->sp
- 1; i
>= 0; --i
)
3407 if (NILP (it
->stack
[i
].string
))
3408 face_id
= it
->stack
[i
].face_id
;
3414 /* Compute the face one character before or after the current position
3415 of IT. BEFORE_P non-zero means get the face in front of IT's
3416 position. Value is the id of the face. */
3419 face_before_or_after_it_pos (it
, before_p
)
3424 int next_check_charpos
;
3425 struct text_pos pos
;
3427 xassert (it
->s
== NULL
);
3429 if (STRINGP (it
->string
))
3431 int bufpos
, base_face_id
;
3433 /* No face change past the end of the string (for the case
3434 we are padding with spaces). No face change before the
3436 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3437 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3440 /* Set pos to the position before or after IT's current position. */
3442 pos
= string_pos (IT_STRING_CHARPOS (*it
) - 1, it
->string
);
3444 /* For composition, we must check the character after the
3446 pos
= (it
->what
== IT_COMPOSITION
3447 ? string_pos (IT_STRING_CHARPOS (*it
) + it
->cmp_len
, it
->string
)
3448 : string_pos (IT_STRING_CHARPOS (*it
) + 1, it
->string
));
3450 if (it
->current
.overlay_string_index
>= 0)
3451 bufpos
= IT_CHARPOS (*it
);
3455 base_face_id
= underlying_face_id (it
);
3457 /* Get the face for ASCII, or unibyte. */
3458 face_id
= face_at_string_position (it
->w
,
3462 it
->region_beg_charpos
,
3463 it
->region_end_charpos
,
3464 &next_check_charpos
,
3467 /* Correct the face for charsets different from ASCII. Do it
3468 for the multibyte case only. The face returned above is
3469 suitable for unibyte text if IT->string is unibyte. */
3470 if (STRING_MULTIBYTE (it
->string
))
3472 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos
);
3473 int rest
= SBYTES (it
->string
) - BYTEPOS (pos
);
3475 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3477 c
= string_char_and_length (p
, rest
, &len
);
3478 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
);
3483 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3484 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3487 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3488 pos
= it
->current
.pos
;
3491 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3494 if (it
->what
== IT_COMPOSITION
)
3495 /* For composition, we must check the position after the
3497 pos
.charpos
+= it
->cmp_len
, pos
.bytepos
+= it
->len
;
3499 INC_TEXT_POS (pos
, it
->multibyte_p
);
3502 /* Determine face for CHARSET_ASCII, or unibyte. */
3503 face_id
= face_at_buffer_position (it
->w
,
3505 it
->region_beg_charpos
,
3506 it
->region_end_charpos
,
3507 &next_check_charpos
,
3510 /* Correct the face for charsets different from ASCII. Do it
3511 for the multibyte case only. The face returned above is
3512 suitable for unibyte text if current_buffer is unibyte. */
3513 if (it
->multibyte_p
)
3515 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3516 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3517 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
);
3526 /***********************************************************************
3528 ***********************************************************************/
3530 /* Set up iterator IT from invisible properties at its current
3531 position. Called from handle_stop. */
3533 static enum prop_handled
3534 handle_invisible_prop (it
)
3537 enum prop_handled handled
= HANDLED_NORMALLY
;
3539 if (STRINGP (it
->string
))
3541 extern Lisp_Object Qinvisible
;
3542 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3544 /* Get the value of the invisible text property at the
3545 current position. Value will be nil if there is no such
3547 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3548 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3551 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3553 handled
= HANDLED_RECOMPUTE_PROPS
;
3555 /* Get the position at which the next change of the
3556 invisible text property can be found in IT->string.
3557 Value will be nil if the property value is the same for
3558 all the rest of IT->string. */
3559 XSETINT (limit
, SCHARS (it
->string
));
3560 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3563 /* Text at current position is invisible. The next
3564 change in the property is at position end_charpos.
3565 Move IT's current position to that position. */
3566 if (INTEGERP (end_charpos
)
3567 && XFASTINT (end_charpos
) < XFASTINT (limit
))
3569 struct text_pos old
;
3570 old
= it
->current
.string_pos
;
3571 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3572 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
3576 /* The rest of the string is invisible. If this is an
3577 overlay string, proceed with the next overlay string
3578 or whatever comes and return a character from there. */
3579 if (it
->current
.overlay_string_index
>= 0)
3581 next_overlay_string (it
);
3582 /* Don't check for overlay strings when we just
3583 finished processing them. */
3584 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
3588 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
3589 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
3596 int invis_p
, newpos
, next_stop
, start_charpos
;
3597 Lisp_Object pos
, prop
, overlay
;
3599 /* First of all, is there invisible text at this position? */
3600 start_charpos
= IT_CHARPOS (*it
);
3601 pos
= make_number (IT_CHARPOS (*it
));
3602 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
3604 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3606 /* If we are on invisible text, skip over it. */
3607 if (invis_p
&& IT_CHARPOS (*it
) < it
->end_charpos
)
3609 /* Record whether we have to display an ellipsis for the
3611 int display_ellipsis_p
= invis_p
== 2;
3613 handled
= HANDLED_RECOMPUTE_PROPS
;
3615 /* Loop skipping over invisible text. The loop is left at
3616 ZV or with IT on the first char being visible again. */
3619 /* Try to skip some invisible text. Return value is the
3620 position reached which can be equal to IT's position
3621 if there is nothing invisible here. This skips both
3622 over invisible text properties and overlays with
3623 invisible property. */
3624 newpos
= skip_invisible (IT_CHARPOS (*it
),
3625 &next_stop
, ZV
, it
->window
);
3627 /* If we skipped nothing at all we weren't at invisible
3628 text in the first place. If everything to the end of
3629 the buffer was skipped, end the loop. */
3630 if (newpos
== IT_CHARPOS (*it
) || newpos
>= ZV
)
3634 /* We skipped some characters but not necessarily
3635 all there are. Check if we ended up on visible
3636 text. Fget_char_property returns the property of
3637 the char before the given position, i.e. if we
3638 get invis_p = 0, this means that the char at
3639 newpos is visible. */
3640 pos
= make_number (newpos
);
3641 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
3642 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3645 /* If we ended up on invisible text, proceed to
3646 skip starting with next_stop. */
3648 IT_CHARPOS (*it
) = next_stop
;
3650 /* If there are adjacent invisible texts, don't lose the
3651 second one's ellipsis. */
3653 display_ellipsis_p
= 1;
3657 /* The position newpos is now either ZV or on visible text. */
3658 IT_CHARPOS (*it
) = newpos
;
3659 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
3661 /* If there are before-strings at the start of invisible
3662 text, and the text is invisible because of a text
3663 property, arrange to show before-strings because 20.x did
3664 it that way. (If the text is invisible because of an
3665 overlay property instead of a text property, this is
3666 already handled in the overlay code.) */
3668 && get_overlay_strings (it
, start_charpos
))
3670 handled
= HANDLED_RECOMPUTE_PROPS
;
3671 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
3673 else if (display_ellipsis_p
)
3675 /* Make sure that the glyphs of the ellipsis will get
3676 correct `charpos' values. If we would not update
3677 it->position here, the glyphs would belong to the
3678 last visible character _before_ the invisible
3679 text, which confuses `set_cursor_from_row'.
3681 We use the last invisible position instead of the
3682 first because this way the cursor is always drawn on
3683 the first "." of the ellipsis, whenever PT is inside
3684 the invisible text. Otherwise the cursor would be
3685 placed _after_ the ellipsis when the point is after the
3686 first invisible character. */
3687 if (!STRINGP (it
->object
))
3689 it
->position
.charpos
= IT_CHARPOS (*it
) - 1;
3690 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
3692 setup_for_ellipsis (it
, 0);
3701 /* Make iterator IT return `...' next.
3702 Replaces LEN characters from buffer. */
3705 setup_for_ellipsis (it
, len
)
3709 /* Use the display table definition for `...'. Invalid glyphs
3710 will be handled by the method returning elements from dpvec. */
3711 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
3713 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
3714 it
->dpvec
= v
->contents
;
3715 it
->dpend
= v
->contents
+ v
->size
;
3719 /* Default `...'. */
3720 it
->dpvec
= default_invis_vector
;
3721 it
->dpend
= default_invis_vector
+ 3;
3724 it
->dpvec_char_len
= len
;
3725 it
->current
.dpvec_index
= 0;
3726 it
->dpvec_face_id
= -1;
3728 /* Remember the current face id in case glyphs specify faces.
3729 IT's face is restored in set_iterator_to_next.
3730 saved_face_id was set to preceding char's face in handle_stop. */
3731 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
3732 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
3734 it
->method
= GET_FROM_DISPLAY_VECTOR
;
3740 /***********************************************************************
3742 ***********************************************************************/
3744 /* Set up iterator IT from `display' property at its current position.
3745 Called from handle_stop.
3746 We return HANDLED_RETURN if some part of the display property
3747 overrides the display of the buffer text itself.
3748 Otherwise we return HANDLED_NORMALLY. */
3750 static enum prop_handled
3751 handle_display_prop (it
)
3754 Lisp_Object prop
, object
;
3755 struct text_pos
*position
;
3756 /* Nonzero if some property replaces the display of the text itself. */
3757 int display_replaced_p
= 0;
3759 if (STRINGP (it
->string
))
3761 object
= it
->string
;
3762 position
= &it
->current
.string_pos
;
3766 XSETWINDOW (object
, it
->w
);
3767 position
= &it
->current
.pos
;
3770 /* Reset those iterator values set from display property values. */
3771 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
3772 it
->space_width
= Qnil
;
3773 it
->font_height
= Qnil
;
3776 /* We don't support recursive `display' properties, i.e. string
3777 values that have a string `display' property, that have a string
3778 `display' property etc. */
3779 if (!it
->string_from_display_prop_p
)
3780 it
->area
= TEXT_AREA
;
3782 prop
= Fget_char_property (make_number (position
->charpos
),
3785 return HANDLED_NORMALLY
;
3787 if (!STRINGP (it
->string
))
3788 object
= it
->w
->buffer
;
3791 /* Simple properties. */
3792 && !EQ (XCAR (prop
), Qimage
)
3793 && !EQ (XCAR (prop
), Qspace
)
3794 && !EQ (XCAR (prop
), Qwhen
)
3795 && !EQ (XCAR (prop
), Qslice
)
3796 && !EQ (XCAR (prop
), Qspace_width
)
3797 && !EQ (XCAR (prop
), Qheight
)
3798 && !EQ (XCAR (prop
), Qraise
)
3799 /* Marginal area specifications. */
3800 && !(CONSP (XCAR (prop
)) && EQ (XCAR (XCAR (prop
)), Qmargin
))
3801 && !EQ (XCAR (prop
), Qleft_fringe
)
3802 && !EQ (XCAR (prop
), Qright_fringe
)
3803 && !NILP (XCAR (prop
)))
3805 for (; CONSP (prop
); prop
= XCDR (prop
))
3807 if (handle_single_display_spec (it
, XCAR (prop
), object
,
3808 position
, display_replaced_p
))
3809 display_replaced_p
= 1;
3812 else if (VECTORP (prop
))
3815 for (i
= 0; i
< ASIZE (prop
); ++i
)
3816 if (handle_single_display_spec (it
, AREF (prop
, i
), object
,
3817 position
, display_replaced_p
))
3818 display_replaced_p
= 1;
3822 int ret
= handle_single_display_spec (it
, prop
, object
, position
, 0);
3823 if (ret
< 0) /* Replaced by "", i.e. nothing. */
3824 return HANDLED_RECOMPUTE_PROPS
;
3826 display_replaced_p
= 1;
3829 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
3833 /* Value is the position of the end of the `display' property starting
3834 at START_POS in OBJECT. */
3836 static struct text_pos
3837 display_prop_end (it
, object
, start_pos
)
3840 struct text_pos start_pos
;
3843 struct text_pos end_pos
;
3845 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
3846 Qdisplay
, object
, Qnil
);
3847 CHARPOS (end_pos
) = XFASTINT (end
);
3848 if (STRINGP (object
))
3849 compute_string_pos (&end_pos
, start_pos
, it
->string
);
3851 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
3857 /* Set up IT from a single `display' specification PROP. OBJECT
3858 is the object in which the `display' property was found. *POSITION
3859 is the position at which it was found. DISPLAY_REPLACED_P non-zero
3860 means that we previously saw a display specification which already
3861 replaced text display with something else, for example an image;
3862 we ignore such properties after the first one has been processed.
3864 If PROP is a `space' or `image' specification, and in some other
3865 cases too, set *POSITION to the position where the `display'
3868 Value is non-zero if something was found which replaces the display
3869 of buffer or string text. Specifically, the value is -1 if that
3870 "something" is "nothing". */
3873 handle_single_display_spec (it
, spec
, object
, position
,
3874 display_replaced_before_p
)
3878 struct text_pos
*position
;
3879 int display_replaced_before_p
;
3882 Lisp_Object location
, value
;
3883 struct text_pos start_pos
;
3886 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
3887 If the result is non-nil, use VALUE instead of SPEC. */
3889 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
3898 if (!NILP (form
) && !EQ (form
, Qt
))
3900 int count
= SPECPDL_INDEX ();
3901 struct gcpro gcpro1
;
3903 /* Bind `object' to the object having the `display' property, a
3904 buffer or string. Bind `position' to the position in the
3905 object where the property was found, and `buffer-position'
3906 to the current position in the buffer. */
3907 specbind (Qobject
, object
);
3908 specbind (Qposition
, make_number (CHARPOS (*position
)));
3909 specbind (Qbuffer_position
,
3910 make_number (STRINGP (object
)
3911 ? IT_CHARPOS (*it
) : CHARPOS (*position
)));
3913 form
= safe_eval (form
);
3915 unbind_to (count
, Qnil
);
3921 /* Handle `(height HEIGHT)' specifications. */
3923 && EQ (XCAR (spec
), Qheight
)
3924 && CONSP (XCDR (spec
)))
3926 if (FRAME_TERMCAP_P (it
->f
) || FRAME_MSDOS_P (it
->f
))
3929 it
->font_height
= XCAR (XCDR (spec
));
3930 if (!NILP (it
->font_height
))
3932 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3933 int new_height
= -1;
3935 if (CONSP (it
->font_height
)
3936 && (EQ (XCAR (it
->font_height
), Qplus
)
3937 || EQ (XCAR (it
->font_height
), Qminus
))
3938 && CONSP (XCDR (it
->font_height
))
3939 && INTEGERP (XCAR (XCDR (it
->font_height
))))
3941 /* `(+ N)' or `(- N)' where N is an integer. */
3942 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
3943 if (EQ (XCAR (it
->font_height
), Qplus
))
3945 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
3947 else if (FUNCTIONP (it
->font_height
))
3949 /* Call function with current height as argument.
3950 Value is the new height. */
3952 height
= safe_call1 (it
->font_height
,
3953 face
->lface
[LFACE_HEIGHT_INDEX
]);
3954 if (NUMBERP (height
))
3955 new_height
= XFLOATINT (height
);
3957 else if (NUMBERP (it
->font_height
))
3959 /* Value is a multiple of the canonical char height. */
3962 face
= FACE_FROM_ID (it
->f
, DEFAULT_FACE_ID
);
3963 new_height
= (XFLOATINT (it
->font_height
)
3964 * XINT (face
->lface
[LFACE_HEIGHT_INDEX
]));
3968 /* Evaluate IT->font_height with `height' bound to the
3969 current specified height to get the new height. */
3970 int count
= SPECPDL_INDEX ();
3972 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
3973 value
= safe_eval (it
->font_height
);
3974 unbind_to (count
, Qnil
);
3976 if (NUMBERP (value
))
3977 new_height
= XFLOATINT (value
);
3981 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
3987 /* Handle `(space_width WIDTH)'. */
3989 && EQ (XCAR (spec
), Qspace_width
)
3990 && CONSP (XCDR (spec
)))
3992 if (FRAME_TERMCAP_P (it
->f
) || FRAME_MSDOS_P (it
->f
))
3995 value
= XCAR (XCDR (spec
));
3996 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
3997 it
->space_width
= value
;
4002 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4004 && EQ (XCAR (spec
), Qslice
))
4008 if (FRAME_TERMCAP_P (it
->f
) || FRAME_MSDOS_P (it
->f
))
4011 if (tem
= XCDR (spec
), CONSP (tem
))
4013 it
->slice
.x
= XCAR (tem
);
4014 if (tem
= XCDR (tem
), CONSP (tem
))
4016 it
->slice
.y
= XCAR (tem
);
4017 if (tem
= XCDR (tem
), CONSP (tem
))
4019 it
->slice
.width
= XCAR (tem
);
4020 if (tem
= XCDR (tem
), CONSP (tem
))
4021 it
->slice
.height
= XCAR (tem
);
4029 /* Handle `(raise FACTOR)'. */
4031 && EQ (XCAR (spec
), Qraise
)
4032 && CONSP (XCDR (spec
)))
4034 if (FRAME_TERMCAP_P (it
->f
) || FRAME_MSDOS_P (it
->f
))
4037 #ifdef HAVE_WINDOW_SYSTEM
4038 value
= XCAR (XCDR (spec
));
4039 if (NUMBERP (value
))
4041 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4042 it
->voffset
= - (XFLOATINT (value
)
4043 * (FONT_HEIGHT (face
->font
)));
4045 #endif /* HAVE_WINDOW_SYSTEM */
4050 /* Don't handle the other kinds of display specifications
4051 inside a string that we got from a `display' property. */
4052 if (it
->string_from_display_prop_p
)
4055 /* Characters having this form of property are not displayed, so
4056 we have to find the end of the property. */
4057 start_pos
= *position
;
4058 *position
= display_prop_end (it
, object
, start_pos
);
4061 /* Stop the scan at that end position--we assume that all
4062 text properties change there. */
4063 it
->stop_charpos
= position
->charpos
;
4065 /* Handle `(left-fringe BITMAP [FACE])'
4066 and `(right-fringe BITMAP [FACE])'. */
4068 && (EQ (XCAR (spec
), Qleft_fringe
)
4069 || EQ (XCAR (spec
), Qright_fringe
))
4070 && CONSP (XCDR (spec
)))
4072 int face_id
= DEFAULT_FACE_ID
;
4075 if (FRAME_TERMCAP_P (it
->f
) || FRAME_MSDOS_P (it
->f
))
4076 /* If we return here, POSITION has been advanced
4077 across the text with this property. */
4080 #ifdef HAVE_WINDOW_SYSTEM
4081 value
= XCAR (XCDR (spec
));
4082 if (!SYMBOLP (value
)
4083 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4084 /* If we return here, POSITION has been advanced
4085 across the text with this property. */
4088 if (CONSP (XCDR (XCDR (spec
))))
4090 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4091 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4092 'A', FRINGE_FACE_ID
, 0);
4097 /* Save current settings of IT so that we can restore them
4098 when we are finished with the glyph property value. */
4102 it
->area
= TEXT_AREA
;
4103 it
->what
= IT_IMAGE
;
4104 it
->image_id
= -1; /* no image */
4105 it
->position
= start_pos
;
4106 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4107 it
->method
= GET_FROM_IMAGE
;
4108 it
->face_id
= face_id
;
4110 /* Say that we haven't consumed the characters with
4111 `display' property yet. The call to pop_it in
4112 set_iterator_to_next will clean this up. */
4113 *position
= start_pos
;
4115 if (EQ (XCAR (spec
), Qleft_fringe
))
4117 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4118 it
->left_user_fringe_face_id
= face_id
;
4122 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4123 it
->right_user_fringe_face_id
= face_id
;
4125 #endif /* HAVE_WINDOW_SYSTEM */
4129 /* Prepare to handle `((margin left-margin) ...)',
4130 `((margin right-margin) ...)' and `((margin nil) ...)'
4131 prefixes for display specifications. */
4132 location
= Qunbound
;
4133 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4137 value
= XCDR (spec
);
4139 value
= XCAR (value
);
4142 if (EQ (XCAR (tem
), Qmargin
)
4143 && (tem
= XCDR (tem
),
4144 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4146 || EQ (tem
, Qleft_margin
)
4147 || EQ (tem
, Qright_margin
))))
4151 if (EQ (location
, Qunbound
))
4157 /* After this point, VALUE is the property after any
4158 margin prefix has been stripped. It must be a string,
4159 an image specification, or `(space ...)'.
4161 LOCATION specifies where to display: `left-margin',
4162 `right-margin' or nil. */
4164 valid_p
= (STRINGP (value
)
4165 #ifdef HAVE_WINDOW_SYSTEM
4166 || (!FRAME_TERMCAP_P (it
->f
) && valid_image_p (value
))
4167 #endif /* not HAVE_WINDOW_SYSTEM */
4168 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4170 if (valid_p
&& !display_replaced_before_p
)
4172 /* Save current settings of IT so that we can restore them
4173 when we are finished with the glyph property value. */
4176 if (NILP (location
))
4177 it
->area
= TEXT_AREA
;
4178 else if (EQ (location
, Qleft_margin
))
4179 it
->area
= LEFT_MARGIN_AREA
;
4181 it
->area
= RIGHT_MARGIN_AREA
;
4183 if (STRINGP (value
))
4185 if (SCHARS (value
) == 0)
4188 return -1; /* Replaced by "", i.e. nothing. */
4191 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4192 it
->current
.overlay_string_index
= -1;
4193 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4194 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4195 it
->method
= GET_FROM_STRING
;
4196 it
->stop_charpos
= 0;
4197 it
->string_from_display_prop_p
= 1;
4198 /* Say that we haven't consumed the characters with
4199 `display' property yet. The call to pop_it in
4200 set_iterator_to_next will clean this up. */
4201 *position
= start_pos
;
4203 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4205 it
->method
= GET_FROM_STRETCH
;
4207 *position
= it
->position
= start_pos
;
4209 #ifdef HAVE_WINDOW_SYSTEM
4212 it
->what
= IT_IMAGE
;
4213 it
->image_id
= lookup_image (it
->f
, value
);
4214 it
->position
= start_pos
;
4215 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4216 it
->method
= GET_FROM_IMAGE
;
4218 /* Say that we haven't consumed the characters with
4219 `display' property yet. The call to pop_it in
4220 set_iterator_to_next will clean this up. */
4221 *position
= start_pos
;
4223 #endif /* HAVE_WINDOW_SYSTEM */
4228 /* Invalid property or property not supported. Restore
4229 POSITION to what it was before. */
4230 *position
= start_pos
;
4235 /* Check if SPEC is a display specification value whose text should be
4236 treated as intangible. */
4239 single_display_spec_intangible_p (prop
)
4242 /* Skip over `when FORM'. */
4243 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4257 /* Skip over `margin LOCATION'. If LOCATION is in the margins,
4258 we don't need to treat text as intangible. */
4259 if (EQ (XCAR (prop
), Qmargin
))
4267 || EQ (XCAR (prop
), Qleft_margin
)
4268 || EQ (XCAR (prop
), Qright_margin
))
4272 return (CONSP (prop
)
4273 && (EQ (XCAR (prop
), Qimage
)
4274 || EQ (XCAR (prop
), Qspace
)));
4278 /* Check if PROP is a display property value whose text should be
4279 treated as intangible. */
4282 display_prop_intangible_p (prop
)
4286 && CONSP (XCAR (prop
))
4287 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4289 /* A list of sub-properties. */
4290 while (CONSP (prop
))
4292 if (single_display_spec_intangible_p (XCAR (prop
)))
4297 else if (VECTORP (prop
))
4299 /* A vector of sub-properties. */
4301 for (i
= 0; i
< ASIZE (prop
); ++i
)
4302 if (single_display_spec_intangible_p (AREF (prop
, i
)))
4306 return single_display_spec_intangible_p (prop
);
4312 /* Return 1 if PROP is a display sub-property value containing STRING. */
4315 single_display_spec_string_p (prop
, string
)
4316 Lisp_Object prop
, string
;
4318 if (EQ (string
, prop
))
4321 /* Skip over `when FORM'. */
4322 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4331 /* Skip over `margin LOCATION'. */
4332 if (EQ (XCAR (prop
), Qmargin
))
4343 return CONSP (prop
) && EQ (XCAR (prop
), string
);
4347 /* Return 1 if STRING appears in the `display' property PROP. */
4350 display_prop_string_p (prop
, string
)
4351 Lisp_Object prop
, string
;
4354 && CONSP (XCAR (prop
))
4355 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4357 /* A list of sub-properties. */
4358 while (CONSP (prop
))
4360 if (single_display_spec_string_p (XCAR (prop
), string
))
4365 else if (VECTORP (prop
))
4367 /* A vector of sub-properties. */
4369 for (i
= 0; i
< ASIZE (prop
); ++i
)
4370 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4374 return single_display_spec_string_p (prop
, string
);
4380 /* Determine from which buffer position in W's buffer STRING comes
4381 from. AROUND_CHARPOS is an approximate position where it could
4382 be from. Value is the buffer position or 0 if it couldn't be
4385 W's buffer must be current.
4387 This function is necessary because we don't record buffer positions
4388 in glyphs generated from strings (to keep struct glyph small).
4389 This function may only use code that doesn't eval because it is
4390 called asynchronously from note_mouse_highlight. */
4393 string_buffer_position (w
, string
, around_charpos
)
4398 Lisp_Object limit
, prop
, pos
;
4399 const int MAX_DISTANCE
= 1000;
4402 pos
= make_number (around_charpos
);
4403 limit
= make_number (min (XINT (pos
) + MAX_DISTANCE
, ZV
));
4404 while (!found
&& !EQ (pos
, limit
))
4406 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4407 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4410 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
, limit
);
4415 pos
= make_number (around_charpos
);
4416 limit
= make_number (max (XINT (pos
) - MAX_DISTANCE
, BEGV
));
4417 while (!found
&& !EQ (pos
, limit
))
4419 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4420 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4423 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
4428 return found
? XINT (pos
) : 0;
4433 /***********************************************************************
4434 `composition' property
4435 ***********************************************************************/
4437 /* Set up iterator IT from `composition' property at its current
4438 position. Called from handle_stop. */
4440 static enum prop_handled
4441 handle_composition_prop (it
)
4444 Lisp_Object prop
, string
;
4445 int pos
, pos_byte
, end
;
4446 enum prop_handled handled
= HANDLED_NORMALLY
;
4448 if (STRINGP (it
->string
))
4450 pos
= IT_STRING_CHARPOS (*it
);
4451 pos_byte
= IT_STRING_BYTEPOS (*it
);
4452 string
= it
->string
;
4456 pos
= IT_CHARPOS (*it
);
4457 pos_byte
= IT_BYTEPOS (*it
);
4461 /* If there's a valid composition and point is not inside of the
4462 composition (in the case that the composition is from the current
4463 buffer), draw a glyph composed from the composition components. */
4464 if (find_composition (pos
, -1, &pos
, &end
, &prop
, string
)
4465 && COMPOSITION_VALID_P (pos
, end
, prop
)
4466 && (STRINGP (it
->string
) || (PT
<= pos
|| PT
>= end
)))
4468 int id
= get_composition_id (pos
, pos_byte
, end
- pos
, prop
, string
);
4472 struct composition
*cmp
= composition_table
[id
];
4474 if (cmp
->glyph_len
== 0)
4477 if (STRINGP (it
->string
))
4479 IT_STRING_CHARPOS (*it
) = end
;
4480 IT_STRING_BYTEPOS (*it
) = string_char_to_byte (it
->string
,
4485 IT_CHARPOS (*it
) = end
;
4486 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (end
);
4488 return HANDLED_RECOMPUTE_PROPS
;
4491 it
->stop_charpos
= end
;
4494 it
->method
= GET_FROM_COMPOSITION
;
4496 it
->cmp_len
= COMPOSITION_LENGTH (prop
);
4497 /* For a terminal, draw only the first character of the
4499 it
->c
= COMPOSITION_GLYPH (composition_table
[id
], 0);
4500 it
->len
= (STRINGP (it
->string
)
4501 ? string_char_to_byte (it
->string
, end
)
4502 : CHAR_TO_BYTE (end
)) - pos_byte
;
4503 handled
= HANDLED_RETURN
;
4512 /***********************************************************************
4514 ***********************************************************************/
4516 /* The following structure is used to record overlay strings for
4517 later sorting in load_overlay_strings. */
4519 struct overlay_entry
4521 Lisp_Object overlay
;
4528 /* Set up iterator IT from overlay strings at its current position.
4529 Called from handle_stop. */
4531 static enum prop_handled
4532 handle_overlay_change (it
)
4535 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
4536 return HANDLED_RECOMPUTE_PROPS
;
4538 return HANDLED_NORMALLY
;
4542 /* Set up the next overlay string for delivery by IT, if there is an
4543 overlay string to deliver. Called by set_iterator_to_next when the
4544 end of the current overlay string is reached. If there are more
4545 overlay strings to display, IT->string and
4546 IT->current.overlay_string_index are set appropriately here.
4547 Otherwise IT->string is set to nil. */
4550 next_overlay_string (it
)
4553 ++it
->current
.overlay_string_index
;
4554 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
4556 /* No more overlay strings. Restore IT's settings to what
4557 they were before overlay strings were processed, and
4558 continue to deliver from current_buffer. */
4559 int display_ellipsis_p
= it
->stack
[it
->sp
- 1].display_ellipsis_p
;
4563 || it
->method
== GET_FROM_COMPOSITION
4564 || (NILP (it
->string
)
4565 && it
->method
== GET_FROM_BUFFER
4566 && it
->stop_charpos
>= BEGV
4567 && it
->stop_charpos
<= it
->end_charpos
));
4568 it
->current
.overlay_string_index
= -1;
4569 it
->n_overlay_strings
= 0;
4571 /* If we're at the end of the buffer, record that we have
4572 processed the overlay strings there already, so that
4573 next_element_from_buffer doesn't try it again. */
4574 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
4575 it
->overlay_strings_at_end_processed_p
= 1;
4577 /* If we have to display `...' for invisible text, set
4578 the iterator up for that. */
4579 if (display_ellipsis_p
)
4580 setup_for_ellipsis (it
, 0);
4584 /* There are more overlay strings to process. If
4585 IT->current.overlay_string_index has advanced to a position
4586 where we must load IT->overlay_strings with more strings, do
4588 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
4590 if (it
->current
.overlay_string_index
&& i
== 0)
4591 load_overlay_strings (it
, 0);
4593 /* Initialize IT to deliver display elements from the overlay
4595 it
->string
= it
->overlay_strings
[i
];
4596 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4597 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
4598 it
->method
= GET_FROM_STRING
;
4599 it
->stop_charpos
= 0;
4606 /* Compare two overlay_entry structures E1 and E2. Used as a
4607 comparison function for qsort in load_overlay_strings. Overlay
4608 strings for the same position are sorted so that
4610 1. All after-strings come in front of before-strings, except
4611 when they come from the same overlay.
4613 2. Within after-strings, strings are sorted so that overlay strings
4614 from overlays with higher priorities come first.
4616 2. Within before-strings, strings are sorted so that overlay
4617 strings from overlays with higher priorities come last.
4619 Value is analogous to strcmp. */
4623 compare_overlay_entries (e1
, e2
)
4626 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
4627 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
4630 if (entry1
->after_string_p
!= entry2
->after_string_p
)
4632 /* Let after-strings appear in front of before-strings if
4633 they come from different overlays. */
4634 if (EQ (entry1
->overlay
, entry2
->overlay
))
4635 result
= entry1
->after_string_p
? 1 : -1;
4637 result
= entry1
->after_string_p
? -1 : 1;
4639 else if (entry1
->after_string_p
)
4640 /* After-strings sorted in order of decreasing priority. */
4641 result
= entry2
->priority
- entry1
->priority
;
4643 /* Before-strings sorted in order of increasing priority. */
4644 result
= entry1
->priority
- entry2
->priority
;
4650 /* Load the vector IT->overlay_strings with overlay strings from IT's
4651 current buffer position, or from CHARPOS if that is > 0. Set
4652 IT->n_overlays to the total number of overlay strings found.
4654 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
4655 a time. On entry into load_overlay_strings,
4656 IT->current.overlay_string_index gives the number of overlay
4657 strings that have already been loaded by previous calls to this
4660 IT->add_overlay_start contains an additional overlay start
4661 position to consider for taking overlay strings from, if non-zero.
4662 This position comes into play when the overlay has an `invisible'
4663 property, and both before and after-strings. When we've skipped to
4664 the end of the overlay, because of its `invisible' property, we
4665 nevertheless want its before-string to appear.
4666 IT->add_overlay_start will contain the overlay start position
4669 Overlay strings are sorted so that after-string strings come in
4670 front of before-string strings. Within before and after-strings,
4671 strings are sorted by overlay priority. See also function
4672 compare_overlay_entries. */
4675 load_overlay_strings (it
, charpos
)
4679 extern Lisp_Object Qafter_string
, Qbefore_string
, Qwindow
, Qpriority
;
4680 Lisp_Object overlay
, window
, str
, invisible
;
4681 struct Lisp_Overlay
*ov
;
4684 int n
= 0, i
, j
, invis_p
;
4685 struct overlay_entry
*entries
4686 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
4689 charpos
= IT_CHARPOS (*it
);
4691 /* Append the overlay string STRING of overlay OVERLAY to vector
4692 `entries' which has size `size' and currently contains `n'
4693 elements. AFTER_P non-zero means STRING is an after-string of
4695 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
4698 Lisp_Object priority; \
4702 int new_size = 2 * size; \
4703 struct overlay_entry *old = entries; \
4705 (struct overlay_entry *) alloca (new_size \
4706 * sizeof *entries); \
4707 bcopy (old, entries, size * sizeof *entries); \
4711 entries[n].string = (STRING); \
4712 entries[n].overlay = (OVERLAY); \
4713 priority = Foverlay_get ((OVERLAY), Qpriority); \
4714 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
4715 entries[n].after_string_p = (AFTER_P); \
4720 /* Process overlay before the overlay center. */
4721 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
4723 XSETMISC (overlay
, ov
);
4724 xassert (OVERLAYP (overlay
));
4725 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4726 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4731 /* Skip this overlay if it doesn't start or end at IT's current
4733 if (end
!= charpos
&& start
!= charpos
)
4736 /* Skip this overlay if it doesn't apply to IT->w. */
4737 window
= Foverlay_get (overlay
, Qwindow
);
4738 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4741 /* If the text ``under'' the overlay is invisible, both before-
4742 and after-strings from this overlay are visible; start and
4743 end position are indistinguishable. */
4744 invisible
= Foverlay_get (overlay
, Qinvisible
);
4745 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4747 /* If overlay has a non-empty before-string, record it. */
4748 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4749 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4751 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4753 /* If overlay has a non-empty after-string, record it. */
4754 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4755 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4757 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4760 /* Process overlays after the overlay center. */
4761 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
4763 XSETMISC (overlay
, ov
);
4764 xassert (OVERLAYP (overlay
));
4765 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4766 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4768 if (start
> charpos
)
4771 /* Skip this overlay if it doesn't start or end at IT's current
4773 if (end
!= charpos
&& start
!= charpos
)
4776 /* Skip this overlay if it doesn't apply to IT->w. */
4777 window
= Foverlay_get (overlay
, Qwindow
);
4778 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4781 /* If the text ``under'' the overlay is invisible, it has a zero
4782 dimension, and both before- and after-strings apply. */
4783 invisible
= Foverlay_get (overlay
, Qinvisible
);
4784 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4786 /* If overlay has a non-empty before-string, record it. */
4787 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4788 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4790 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4792 /* If overlay has a non-empty after-string, record it. */
4793 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4794 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4796 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4799 #undef RECORD_OVERLAY_STRING
4803 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
4805 /* Record the total number of strings to process. */
4806 it
->n_overlay_strings
= n
;
4808 /* IT->current.overlay_string_index is the number of overlay strings
4809 that have already been consumed by IT. Copy some of the
4810 remaining overlay strings to IT->overlay_strings. */
4812 j
= it
->current
.overlay_string_index
;
4813 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
4814 it
->overlay_strings
[i
++] = entries
[j
++].string
;
4820 /* Get the first chunk of overlay strings at IT's current buffer
4821 position, or at CHARPOS if that is > 0. Value is non-zero if at
4822 least one overlay string was found. */
4825 get_overlay_strings_1 (it
, charpos
, compute_stop_p
)
4829 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
4830 process. This fills IT->overlay_strings with strings, and sets
4831 IT->n_overlay_strings to the total number of strings to process.
4832 IT->pos.overlay_string_index has to be set temporarily to zero
4833 because load_overlay_strings needs this; it must be set to -1
4834 when no overlay strings are found because a zero value would
4835 indicate a position in the first overlay string. */
4836 it
->current
.overlay_string_index
= 0;
4837 load_overlay_strings (it
, charpos
);
4839 /* If we found overlay strings, set up IT to deliver display
4840 elements from the first one. Otherwise set up IT to deliver
4841 from current_buffer. */
4842 if (it
->n_overlay_strings
)
4844 /* Make sure we know settings in current_buffer, so that we can
4845 restore meaningful values when we're done with the overlay
4848 compute_stop_pos (it
);
4849 xassert (it
->face_id
>= 0);
4851 /* Save IT's settings. They are restored after all overlay
4852 strings have been processed. */
4853 xassert (!compute_stop_p
|| it
->sp
== 0);
4856 /* Set up IT to deliver display elements from the first overlay
4858 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4859 it
->string
= it
->overlay_strings
[0];
4860 it
->stop_charpos
= 0;
4861 xassert (STRINGP (it
->string
));
4862 it
->end_charpos
= SCHARS (it
->string
);
4863 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4864 it
->method
= GET_FROM_STRING
;
4868 it
->current
.overlay_string_index
= -1;
4873 get_overlay_strings (it
, charpos
)
4878 it
->method
= GET_FROM_BUFFER
;
4880 (void) get_overlay_strings_1 (it
, charpos
, 1);
4884 /* Value is non-zero if we found at least one overlay string. */
4885 return STRINGP (it
->string
);
4890 /***********************************************************************
4891 Saving and restoring state
4892 ***********************************************************************/
4894 /* Save current settings of IT on IT->stack. Called, for example,
4895 before setting up IT for an overlay string, to be able to restore
4896 IT's settings to what they were after the overlay string has been
4903 struct iterator_stack_entry
*p
;
4905 xassert (it
->sp
< IT_STACK_SIZE
);
4906 p
= it
->stack
+ it
->sp
;
4908 p
->stop_charpos
= it
->stop_charpos
;
4909 xassert (it
->face_id
>= 0);
4910 p
->face_id
= it
->face_id
;
4911 p
->string
= it
->string
;
4912 p
->method
= it
->method
;
4915 case GET_FROM_IMAGE
:
4916 p
->u
.image
.object
= it
->object
;
4917 p
->u
.image
.image_id
= it
->image_id
;
4918 p
->u
.image
.slice
= it
->slice
;
4920 case GET_FROM_COMPOSITION
:
4921 p
->u
.comp
.object
= it
->object
;
4922 p
->u
.comp
.c
= it
->c
;
4923 p
->u
.comp
.len
= it
->len
;
4924 p
->u
.comp
.cmp_id
= it
->cmp_id
;
4925 p
->u
.comp
.cmp_len
= it
->cmp_len
;
4927 case GET_FROM_STRETCH
:
4928 p
->u
.stretch
.object
= it
->object
;
4931 p
->position
= it
->position
;
4932 p
->current
= it
->current
;
4933 p
->end_charpos
= it
->end_charpos
;
4934 p
->string_nchars
= it
->string_nchars
;
4936 p
->multibyte_p
= it
->multibyte_p
;
4937 p
->space_width
= it
->space_width
;
4938 p
->font_height
= it
->font_height
;
4939 p
->voffset
= it
->voffset
;
4940 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
4941 p
->display_ellipsis_p
= 0;
4946 /* Restore IT's settings from IT->stack. Called, for example, when no
4947 more overlay strings must be processed, and we return to delivering
4948 display elements from a buffer, or when the end of a string from a
4949 `display' property is reached and we return to delivering display
4950 elements from an overlay string, or from a buffer. */
4956 struct iterator_stack_entry
*p
;
4958 xassert (it
->sp
> 0);
4960 p
= it
->stack
+ it
->sp
;
4961 it
->stop_charpos
= p
->stop_charpos
;
4962 it
->face_id
= p
->face_id
;
4963 it
->current
= p
->current
;
4964 it
->position
= p
->position
;
4965 it
->string
= p
->string
;
4966 if (NILP (it
->string
))
4967 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
4968 it
->method
= p
->method
;
4971 case GET_FROM_IMAGE
:
4972 it
->image_id
= p
->u
.image
.image_id
;
4973 it
->object
= p
->u
.image
.object
;
4974 it
->slice
= p
->u
.image
.slice
;
4976 case GET_FROM_COMPOSITION
:
4977 it
->object
= p
->u
.comp
.object
;
4978 it
->c
= p
->u
.comp
.c
;
4979 it
->len
= p
->u
.comp
.len
;
4980 it
->cmp_id
= p
->u
.comp
.cmp_id
;
4981 it
->cmp_len
= p
->u
.comp
.cmp_len
;
4983 case GET_FROM_STRETCH
:
4984 it
->object
= p
->u
.comp
.object
;
4987 it
->end_charpos
= p
->end_charpos
;
4988 it
->string_nchars
= p
->string_nchars
;
4990 it
->multibyte_p
= p
->multibyte_p
;
4991 it
->space_width
= p
->space_width
;
4992 it
->font_height
= p
->font_height
;
4993 it
->voffset
= p
->voffset
;
4994 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
4999 /***********************************************************************
5001 ***********************************************************************/
5003 /* Set IT's current position to the previous line start. */
5006 back_to_previous_line_start (it
)
5009 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5010 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5014 /* Move IT to the next line start.
5016 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5017 we skipped over part of the text (as opposed to moving the iterator
5018 continuously over the text). Otherwise, don't change the value
5021 Newlines may come from buffer text, overlay strings, or strings
5022 displayed via the `display' property. That's the reason we can't
5023 simply use find_next_newline_no_quit.
5025 Note that this function may not skip over invisible text that is so
5026 because of text properties and immediately follows a newline. If
5027 it would, function reseat_at_next_visible_line_start, when called
5028 from set_iterator_to_next, would effectively make invisible
5029 characters following a newline part of the wrong glyph row, which
5030 leads to wrong cursor motion. */
5033 forward_to_next_line_start (it
, skipped_p
)
5037 int old_selective
, newline_found_p
, n
;
5038 const int MAX_NEWLINE_DISTANCE
= 500;
5040 /* If already on a newline, just consume it to avoid unintended
5041 skipping over invisible text below. */
5042 if (it
->what
== IT_CHARACTER
5044 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5046 set_iterator_to_next (it
, 0);
5051 /* Don't handle selective display in the following. It's (a)
5052 unnecessary because it's done by the caller, and (b) leads to an
5053 infinite recursion because next_element_from_ellipsis indirectly
5054 calls this function. */
5055 old_selective
= it
->selective
;
5058 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5059 from buffer text. */
5060 for (n
= newline_found_p
= 0;
5061 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5062 n
+= STRINGP (it
->string
) ? 0 : 1)
5064 if (!get_next_display_element (it
))
5066 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5067 set_iterator_to_next (it
, 0);
5070 /* If we didn't find a newline near enough, see if we can use a
5072 if (!newline_found_p
)
5074 int start
= IT_CHARPOS (*it
);
5075 int limit
= find_next_newline_no_quit (start
, 1);
5078 xassert (!STRINGP (it
->string
));
5080 /* If there isn't any `display' property in sight, and no
5081 overlays, we can just use the position of the newline in
5083 if (it
->stop_charpos
>= limit
5084 || ((pos
= Fnext_single_property_change (make_number (start
),
5086 Qnil
, make_number (limit
)),
5088 && next_overlay_change (start
) == ZV
))
5090 IT_CHARPOS (*it
) = limit
;
5091 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5092 *skipped_p
= newline_found_p
= 1;
5096 while (get_next_display_element (it
)
5097 && !newline_found_p
)
5099 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5100 set_iterator_to_next (it
, 0);
5105 it
->selective
= old_selective
;
5106 return newline_found_p
;
5110 /* Set IT's current position to the previous visible line start. Skip
5111 invisible text that is so either due to text properties or due to
5112 selective display. Caution: this does not change IT->current_x and
5116 back_to_previous_visible_line_start (it
)
5119 while (IT_CHARPOS (*it
) > BEGV
)
5121 back_to_previous_line_start (it
);
5123 if (IT_CHARPOS (*it
) <= BEGV
)
5126 /* If selective > 0, then lines indented more than that values
5128 if (it
->selective
> 0
5129 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5130 (double) it
->selective
)) /* iftc */
5133 /* Check the newline before point for invisibility. */
5136 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5137 Qinvisible
, it
->window
);
5138 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5142 if (IT_CHARPOS (*it
) <= BEGV
)
5149 Lisp_Object val
, overlay
;
5151 /* If newline is part of a composition, continue from start of composition */
5152 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5153 && beg
< IT_CHARPOS (*it
))
5156 /* If newline is replaced by a display property, find start of overlay
5157 or interval and continue search from that point. */
5159 pos
= --IT_CHARPOS (it2
);
5162 if (handle_display_prop (&it2
) == HANDLED_RETURN
5163 && !NILP (val
= get_char_property_and_overlay
5164 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5165 && (OVERLAYP (overlay
)
5166 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5167 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5170 /* Newline is not replaced by anything -- so we are done. */
5176 IT_CHARPOS (*it
) = beg
;
5177 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5181 it
->continuation_lines_width
= 0;
5183 xassert (IT_CHARPOS (*it
) >= BEGV
);
5184 xassert (IT_CHARPOS (*it
) == BEGV
5185 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5190 /* Reseat iterator IT at the previous visible line start. Skip
5191 invisible text that is so either due to text properties or due to
5192 selective display. At the end, update IT's overlay information,
5193 face information etc. */
5196 reseat_at_previous_visible_line_start (it
)
5199 back_to_previous_visible_line_start (it
);
5200 reseat (it
, it
->current
.pos
, 1);
5205 /* Reseat iterator IT on the next visible line start in the current
5206 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5207 preceding the line start. Skip over invisible text that is so
5208 because of selective display. Compute faces, overlays etc at the
5209 new position. Note that this function does not skip over text that
5210 is invisible because of text properties. */
5213 reseat_at_next_visible_line_start (it
, on_newline_p
)
5217 int newline_found_p
, skipped_p
= 0;
5219 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5221 /* Skip over lines that are invisible because they are indented
5222 more than the value of IT->selective. */
5223 if (it
->selective
> 0)
5224 while (IT_CHARPOS (*it
) < ZV
5225 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5226 (double) it
->selective
)) /* iftc */
5228 xassert (IT_BYTEPOS (*it
) == BEGV
5229 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5230 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5233 /* Position on the newline if that's what's requested. */
5234 if (on_newline_p
&& newline_found_p
)
5236 if (STRINGP (it
->string
))
5238 if (IT_STRING_CHARPOS (*it
) > 0)
5240 --IT_STRING_CHARPOS (*it
);
5241 --IT_STRING_BYTEPOS (*it
);
5244 else if (IT_CHARPOS (*it
) > BEGV
)
5248 reseat (it
, it
->current
.pos
, 0);
5252 reseat (it
, it
->current
.pos
, 0);
5259 /***********************************************************************
5260 Changing an iterator's position
5261 ***********************************************************************/
5263 /* Change IT's current position to POS in current_buffer. If FORCE_P
5264 is non-zero, always check for text properties at the new position.
5265 Otherwise, text properties are only looked up if POS >=
5266 IT->check_charpos of a property. */
5269 reseat (it
, pos
, force_p
)
5271 struct text_pos pos
;
5274 int original_pos
= IT_CHARPOS (*it
);
5276 reseat_1 (it
, pos
, 0);
5278 /* Determine where to check text properties. Avoid doing it
5279 where possible because text property lookup is very expensive. */
5281 || CHARPOS (pos
) > it
->stop_charpos
5282 || CHARPOS (pos
) < original_pos
)
5289 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
5290 IT->stop_pos to POS, also. */
5293 reseat_1 (it
, pos
, set_stop_p
)
5295 struct text_pos pos
;
5298 /* Don't call this function when scanning a C string. */
5299 xassert (it
->s
== NULL
);
5301 /* POS must be a reasonable value. */
5302 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
5304 it
->current
.pos
= it
->position
= pos
;
5305 XSETBUFFER (it
->object
, current_buffer
);
5306 it
->end_charpos
= ZV
;
5308 it
->current
.dpvec_index
= -1;
5309 it
->current
.overlay_string_index
= -1;
5310 IT_STRING_CHARPOS (*it
) = -1;
5311 IT_STRING_BYTEPOS (*it
) = -1;
5313 it
->method
= GET_FROM_BUFFER
;
5314 it
->object
= it
->w
->buffer
;
5315 it
->area
= TEXT_AREA
;
5316 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
5318 it
->string_from_display_prop_p
= 0;
5319 it
->face_before_selective_p
= 0;
5322 it
->stop_charpos
= CHARPOS (pos
);
5326 /* Set up IT for displaying a string, starting at CHARPOS in window W.
5327 If S is non-null, it is a C string to iterate over. Otherwise,
5328 STRING gives a Lisp string to iterate over.
5330 If PRECISION > 0, don't return more then PRECISION number of
5331 characters from the string.
5333 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
5334 characters have been returned. FIELD_WIDTH < 0 means an infinite
5337 MULTIBYTE = 0 means disable processing of multibyte characters,
5338 MULTIBYTE > 0 means enable it,
5339 MULTIBYTE < 0 means use IT->multibyte_p.
5341 IT must be initialized via a prior call to init_iterator before
5342 calling this function. */
5345 reseat_to_string (it
, s
, string
, charpos
, precision
, field_width
, multibyte
)
5350 int precision
, field_width
, multibyte
;
5352 /* No region in strings. */
5353 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
5355 /* No text property checks performed by default, but see below. */
5356 it
->stop_charpos
= -1;
5358 /* Set iterator position and end position. */
5359 bzero (&it
->current
, sizeof it
->current
);
5360 it
->current
.overlay_string_index
= -1;
5361 it
->current
.dpvec_index
= -1;
5362 xassert (charpos
>= 0);
5364 /* If STRING is specified, use its multibyteness, otherwise use the
5365 setting of MULTIBYTE, if specified. */
5367 it
->multibyte_p
= multibyte
> 0;
5371 xassert (STRINGP (string
));
5372 it
->string
= string
;
5374 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
5375 it
->method
= GET_FROM_STRING
;
5376 it
->current
.string_pos
= string_pos (charpos
, string
);
5383 /* Note that we use IT->current.pos, not it->current.string_pos,
5384 for displaying C strings. */
5385 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
5386 if (it
->multibyte_p
)
5388 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
5389 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
5393 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
5394 it
->end_charpos
= it
->string_nchars
= strlen (s
);
5397 it
->method
= GET_FROM_C_STRING
;
5400 /* PRECISION > 0 means don't return more than PRECISION characters
5402 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
5403 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
5405 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
5406 characters have been returned. FIELD_WIDTH == 0 means don't pad,
5407 FIELD_WIDTH < 0 means infinite field width. This is useful for
5408 padding with `-' at the end of a mode line. */
5409 if (field_width
< 0)
5410 field_width
= INFINITY
;
5411 if (field_width
> it
->end_charpos
- charpos
)
5412 it
->end_charpos
= charpos
+ field_width
;
5414 /* Use the standard display table for displaying strings. */
5415 if (DISP_TABLE_P (Vstandard_display_table
))
5416 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
5418 it
->stop_charpos
= charpos
;
5424 /***********************************************************************
5426 ***********************************************************************/
5428 /* Map enum it_method value to corresponding next_element_from_* function. */
5430 static int (* get_next_element
[NUM_IT_METHODS
]) P_ ((struct it
*it
)) =
5432 next_element_from_buffer
,
5433 next_element_from_display_vector
,
5434 next_element_from_composition
,
5435 next_element_from_string
,
5436 next_element_from_c_string
,
5437 next_element_from_image
,
5438 next_element_from_stretch
5442 /* Load IT's display element fields with information about the next
5443 display element from the current position of IT. Value is zero if
5444 end of buffer (or C string) is reached. */
5446 static struct frame
*last_escape_glyph_frame
= NULL
;
5447 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
5448 static int last_escape_glyph_merged_face_id
= 0;
5451 get_next_display_element (it
)
5454 /* Non-zero means that we found a display element. Zero means that
5455 we hit the end of what we iterate over. Performance note: the
5456 function pointer `method' used here turns out to be faster than
5457 using a sequence of if-statements. */
5461 success_p
= (*get_next_element
[it
->method
]) (it
);
5463 if (it
->what
== IT_CHARACTER
)
5465 /* Map via display table or translate control characters.
5466 IT->c, IT->len etc. have been set to the next character by
5467 the function call above. If we have a display table, and it
5468 contains an entry for IT->c, translate it. Don't do this if
5469 IT->c itself comes from a display table, otherwise we could
5470 end up in an infinite recursion. (An alternative could be to
5471 count the recursion depth of this function and signal an
5472 error when a certain maximum depth is reached.) Is it worth
5474 if (success_p
&& it
->dpvec
== NULL
)
5479 && (dv
= DISP_CHAR_VECTOR (it
->dp
, it
->c
),
5482 struct Lisp_Vector
*v
= XVECTOR (dv
);
5484 /* Return the first character from the display table
5485 entry, if not empty. If empty, don't display the
5486 current character. */
5489 it
->dpvec_char_len
= it
->len
;
5490 it
->dpvec
= v
->contents
;
5491 it
->dpend
= v
->contents
+ v
->size
;
5492 it
->current
.dpvec_index
= 0;
5493 it
->dpvec_face_id
= -1;
5494 it
->saved_face_id
= it
->face_id
;
5495 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5500 set_iterator_to_next (it
, 0);
5505 /* Translate control characters into `\003' or `^C' form.
5506 Control characters coming from a display table entry are
5507 currently not translated because we use IT->dpvec to hold
5508 the translation. This could easily be changed but I
5509 don't believe that it is worth doing.
5511 If it->multibyte_p is nonzero, eight-bit characters and
5512 non-printable multibyte characters are also translated to
5515 If it->multibyte_p is zero, eight-bit characters that
5516 don't have corresponding multibyte char code are also
5517 translated to octal form. */
5518 else if ((it
->c
< ' '
5519 && (it
->area
!= TEXT_AREA
5520 /* In mode line, treat \n like other crl chars. */
5522 && it
->glyph_row
&& it
->glyph_row
->mode_line_p
)
5523 || (it
->c
!= '\n' && it
->c
!= '\t')))
5527 || !CHAR_PRINTABLE_P (it
->c
)
5528 || (!NILP (Vnobreak_char_display
)
5529 && (it
->c
== 0x8a0 || it
->c
== 0x8ad
5530 || it
->c
== 0x920 || it
->c
== 0x92d
5531 || it
->c
== 0xe20 || it
->c
== 0xe2d
5532 || it
->c
== 0xf20 || it
->c
== 0xf2d)))
5534 && (!unibyte_display_via_language_environment
5535 || it
->c
== unibyte_char_to_multibyte (it
->c
)))))
5537 /* IT->c is a control character which must be displayed
5538 either as '\003' or as `^C' where the '\\' and '^'
5539 can be defined in the display table. Fill
5540 IT->ctl_chars with glyphs for what we have to
5541 display. Then, set IT->dpvec to these glyphs. */
5544 int face_id
, lface_id
= 0 ;
5547 /* Handle control characters with ^. */
5549 if (it
->c
< 128 && it
->ctl_arrow_p
)
5551 g
= '^'; /* default glyph for Control */
5552 /* Set IT->ctl_chars[0] to the glyph for `^'. */
5554 && INTEGERP (DISP_CTRL_GLYPH (it
->dp
))
5555 && GLYPH_CHAR_VALID_P (XINT (DISP_CTRL_GLYPH (it
->dp
))))
5557 g
= XINT (DISP_CTRL_GLYPH (it
->dp
));
5558 lface_id
= FAST_GLYPH_FACE (g
);
5562 g
= FAST_GLYPH_CHAR (g
);
5563 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
5566 else if (it
->f
== last_escape_glyph_frame
5567 && it
->face_id
== last_escape_glyph_face_id
)
5569 face_id
= last_escape_glyph_merged_face_id
;
5573 /* Merge the escape-glyph face into the current face. */
5574 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5576 last_escape_glyph_frame
= it
->f
;
5577 last_escape_glyph_face_id
= it
->face_id
;
5578 last_escape_glyph_merged_face_id
= face_id
;
5581 XSETINT (it
->ctl_chars
[0], g
);
5583 XSETINT (it
->ctl_chars
[1], g
);
5585 goto display_control
;
5588 /* Handle non-break space in the mode where it only gets
5591 if (EQ (Vnobreak_char_display
, Qt
)
5592 && (it
->c
== 0x8a0 || it
->c
== 0x920
5593 || it
->c
== 0xe20 || it
->c
== 0xf20))
5595 /* Merge the no-break-space face into the current face. */
5596 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
5600 XSETINT (it
->ctl_chars
[0], g
);
5602 goto display_control
;
5605 /* Handle sequences that start with the "escape glyph". */
5607 /* the default escape glyph is \. */
5608 escape_glyph
= '\\';
5611 && INTEGERP (DISP_ESCAPE_GLYPH (it
->dp
))
5612 && GLYPH_CHAR_VALID_P (XFASTINT (DISP_ESCAPE_GLYPH (it
->dp
))))
5614 escape_glyph
= XFASTINT (DISP_ESCAPE_GLYPH (it
->dp
));
5615 lface_id
= FAST_GLYPH_FACE (escape_glyph
);
5619 /* The display table specified a face.
5620 Merge it into face_id and also into escape_glyph. */
5621 escape_glyph
= FAST_GLYPH_CHAR (escape_glyph
);
5622 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
5625 else if (it
->f
== last_escape_glyph_frame
5626 && it
->face_id
== last_escape_glyph_face_id
)
5628 face_id
= last_escape_glyph_merged_face_id
;
5632 /* Merge the escape-glyph face into the current face. */
5633 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5635 last_escape_glyph_frame
= it
->f
;
5636 last_escape_glyph_face_id
= it
->face_id
;
5637 last_escape_glyph_merged_face_id
= face_id
;
5640 /* Handle soft hyphens in the mode where they only get
5643 if (EQ (Vnobreak_char_display
, Qt
)
5644 && (it
->c
== 0x8ad || it
->c
== 0x92d
5645 || it
->c
== 0xe2d || it
->c
== 0xf2d))
5648 XSETINT (it
->ctl_chars
[0], g
);
5650 goto display_control
;
5653 /* Handle non-break space and soft hyphen
5654 with the escape glyph. */
5656 if (it
->c
== 0x8a0 || it
->c
== 0x8ad
5657 || it
->c
== 0x920 || it
->c
== 0x92d
5658 || it
->c
== 0xe20 || it
->c
== 0xe2d
5659 || it
->c
== 0xf20 || it
->c
== 0xf2d)
5661 XSETINT (it
->ctl_chars
[0], escape_glyph
);
5662 g
= it
->c
= ((it
->c
& 0xf) == 0 ? ' ' : '-');
5663 XSETINT (it
->ctl_chars
[1], g
);
5665 goto display_control
;
5669 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
5673 /* Set IT->ctl_chars[0] to the glyph for `\\'. */
5674 if (SINGLE_BYTE_CHAR_P (it
->c
))
5675 str
[0] = it
->c
, len
= 1;
5678 len
= CHAR_STRING_NO_SIGNAL (it
->c
, str
);
5681 /* It's an invalid character, which shouldn't
5682 happen actually, but due to bugs it may
5683 happen. Let's print the char as is, there's
5684 not much meaningful we can do with it. */
5686 str
[1] = it
->c
>> 8;
5687 str
[2] = it
->c
>> 16;
5688 str
[3] = it
->c
>> 24;
5693 for (i
= 0; i
< len
; i
++)
5695 XSETINT (it
->ctl_chars
[i
* 4], escape_glyph
);
5696 /* Insert three more glyphs into IT->ctl_chars for
5697 the octal display of the character. */
5698 g
= ((str
[i
] >> 6) & 7) + '0';
5699 XSETINT (it
->ctl_chars
[i
* 4 + 1], g
);
5700 g
= ((str
[i
] >> 3) & 7) + '0';
5701 XSETINT (it
->ctl_chars
[i
* 4 + 2], g
);
5702 g
= (str
[i
] & 7) + '0';
5703 XSETINT (it
->ctl_chars
[i
* 4 + 3], g
);
5709 /* Set up IT->dpvec and return first character from it. */
5710 it
->dpvec_char_len
= it
->len
;
5711 it
->dpvec
= it
->ctl_chars
;
5712 it
->dpend
= it
->dpvec
+ ctl_len
;
5713 it
->current
.dpvec_index
= 0;
5714 it
->dpvec_face_id
= face_id
;
5715 it
->saved_face_id
= it
->face_id
;
5716 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5722 /* Adjust face id for a multibyte character. There are no
5723 multibyte character in unibyte text. */
5726 && FRAME_WINDOW_P (it
->f
))
5728 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
5729 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->c
);
5733 /* Is this character the last one of a run of characters with
5734 box? If yes, set IT->end_of_box_run_p to 1. */
5741 it
->end_of_box_run_p
5742 = ((face_id
= face_after_it_pos (it
),
5743 face_id
!= it
->face_id
)
5744 && (face
= FACE_FROM_ID (it
->f
, face_id
),
5745 face
->box
== FACE_NO_BOX
));
5748 /* Value is 0 if end of buffer or string reached. */
5753 /* Move IT to the next display element.
5755 RESEAT_P non-zero means if called on a newline in buffer text,
5756 skip to the next visible line start.
5758 Functions get_next_display_element and set_iterator_to_next are
5759 separate because I find this arrangement easier to handle than a
5760 get_next_display_element function that also increments IT's
5761 position. The way it is we can first look at an iterator's current
5762 display element, decide whether it fits on a line, and if it does,
5763 increment the iterator position. The other way around we probably
5764 would either need a flag indicating whether the iterator has to be
5765 incremented the next time, or we would have to implement a
5766 decrement position function which would not be easy to write. */
5769 set_iterator_to_next (it
, reseat_p
)
5773 /* Reset flags indicating start and end of a sequence of characters
5774 with box. Reset them at the start of this function because
5775 moving the iterator to a new position might set them. */
5776 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
5780 case GET_FROM_BUFFER
:
5781 /* The current display element of IT is a character from
5782 current_buffer. Advance in the buffer, and maybe skip over
5783 invisible lines that are so because of selective display. */
5784 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
5785 reseat_at_next_visible_line_start (it
, 0);
5788 xassert (it
->len
!= 0);
5789 IT_BYTEPOS (*it
) += it
->len
;
5790 IT_CHARPOS (*it
) += 1;
5791 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
5795 case GET_FROM_COMPOSITION
:
5796 xassert (it
->cmp_id
>= 0 && it
->cmp_id
< n_compositions
);
5797 xassert (it
->sp
> 0);
5799 if (it
->method
== GET_FROM_STRING
)
5801 IT_STRING_BYTEPOS (*it
) += it
->len
;
5802 IT_STRING_CHARPOS (*it
) += it
->cmp_len
;
5803 it
->object
= it
->string
;
5804 goto consider_string_end
;
5806 else if (it
->method
== GET_FROM_BUFFER
)
5808 IT_BYTEPOS (*it
) += it
->len
;
5809 IT_CHARPOS (*it
) += it
->cmp_len
;
5810 it
->object
= it
->w
->buffer
;
5814 case GET_FROM_C_STRING
:
5815 /* Current display element of IT is from a C string. */
5816 IT_BYTEPOS (*it
) += it
->len
;
5817 IT_CHARPOS (*it
) += 1;
5820 case GET_FROM_DISPLAY_VECTOR
:
5821 /* Current display element of IT is from a display table entry.
5822 Advance in the display table definition. Reset it to null if
5823 end reached, and continue with characters from buffers/
5825 ++it
->current
.dpvec_index
;
5827 /* Restore face of the iterator to what they were before the
5828 display vector entry (these entries may contain faces). */
5829 it
->face_id
= it
->saved_face_id
;
5831 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
5833 int recheck_faces
= it
->ellipsis_p
;
5836 it
->method
= GET_FROM_C_STRING
;
5837 else if (STRINGP (it
->string
))
5838 it
->method
= GET_FROM_STRING
;
5841 it
->method
= GET_FROM_BUFFER
;
5842 it
->object
= it
->w
->buffer
;
5846 it
->current
.dpvec_index
= -1;
5848 /* Skip over characters which were displayed via IT->dpvec. */
5849 if (it
->dpvec_char_len
< 0)
5850 reseat_at_next_visible_line_start (it
, 1);
5851 else if (it
->dpvec_char_len
> 0)
5853 if (it
->method
== GET_FROM_STRING
5854 && it
->n_overlay_strings
> 0)
5855 it
->ignore_overlay_strings_at_pos_p
= 1;
5856 it
->len
= it
->dpvec_char_len
;
5857 set_iterator_to_next (it
, reseat_p
);
5860 /* Maybe recheck faces after display vector */
5862 it
->stop_charpos
= IT_CHARPOS (*it
);
5866 case GET_FROM_STRING
:
5867 /* Current display element is a character from a Lisp string. */
5868 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
5869 IT_STRING_BYTEPOS (*it
) += it
->len
;
5870 IT_STRING_CHARPOS (*it
) += 1;
5872 consider_string_end
:
5874 if (it
->current
.overlay_string_index
>= 0)
5876 /* IT->string is an overlay string. Advance to the
5877 next, if there is one. */
5878 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
5879 next_overlay_string (it
);
5883 /* IT->string is not an overlay string. If we reached
5884 its end, and there is something on IT->stack, proceed
5885 with what is on the stack. This can be either another
5886 string, this time an overlay string, or a buffer. */
5887 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
5891 if (it
->method
== GET_FROM_STRING
)
5892 goto consider_string_end
;
5897 case GET_FROM_IMAGE
:
5898 case GET_FROM_STRETCH
:
5899 /* The position etc with which we have to proceed are on
5900 the stack. The position may be at the end of a string,
5901 if the `display' property takes up the whole string. */
5902 xassert (it
->sp
> 0);
5904 if (it
->method
== GET_FROM_STRING
)
5905 goto consider_string_end
;
5909 /* There are no other methods defined, so this should be a bug. */
5913 xassert (it
->method
!= GET_FROM_STRING
5914 || (STRINGP (it
->string
)
5915 && IT_STRING_CHARPOS (*it
) >= 0));
5918 /* Load IT's display element fields with information about the next
5919 display element which comes from a display table entry or from the
5920 result of translating a control character to one of the forms `^C'
5923 IT->dpvec holds the glyphs to return as characters.
5924 IT->saved_face_id holds the face id before the display vector--
5925 it is restored into IT->face_idin set_iterator_to_next. */
5928 next_element_from_display_vector (it
)
5932 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
5934 it
->face_id
= it
->saved_face_id
;
5936 if (INTEGERP (*it
->dpvec
)
5937 && GLYPH_CHAR_VALID_P (XFASTINT (*it
->dpvec
)))
5941 g
= XFASTINT (it
->dpvec
[it
->current
.dpvec_index
]);
5942 it
->c
= FAST_GLYPH_CHAR (g
);
5943 it
->len
= CHAR_BYTES (it
->c
);
5945 /* The entry may contain a face id to use. Such a face id is
5946 the id of a Lisp face, not a realized face. A face id of
5947 zero means no face is specified. */
5948 if (it
->dpvec_face_id
>= 0)
5949 it
->face_id
= it
->dpvec_face_id
;
5952 int lface_id
= FAST_GLYPH_FACE (g
);
5954 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
5959 /* Display table entry is invalid. Return a space. */
5960 it
->c
= ' ', it
->len
= 1;
5962 /* Don't change position and object of the iterator here. They are
5963 still the values of the character that had this display table
5964 entry or was translated, and that's what we want. */
5965 it
->what
= IT_CHARACTER
;
5970 /* Load IT with the next display element from Lisp string IT->string.
5971 IT->current.string_pos is the current position within the string.
5972 If IT->current.overlay_string_index >= 0, the Lisp string is an
5976 next_element_from_string (it
)
5979 struct text_pos position
;
5981 xassert (STRINGP (it
->string
));
5982 xassert (IT_STRING_CHARPOS (*it
) >= 0);
5983 position
= it
->current
.string_pos
;
5985 /* Time to check for invisible text? */
5986 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
5987 && IT_STRING_CHARPOS (*it
) == it
->stop_charpos
)
5991 /* Since a handler may have changed IT->method, we must
5993 return get_next_display_element (it
);
5996 if (it
->current
.overlay_string_index
>= 0)
5998 /* Get the next character from an overlay string. In overlay
5999 strings, There is no field width or padding with spaces to
6001 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6006 else if (STRING_MULTIBYTE (it
->string
))
6008 int remaining
= SBYTES (it
->string
) - IT_STRING_BYTEPOS (*it
);
6009 const unsigned char *s
= (SDATA (it
->string
)
6010 + IT_STRING_BYTEPOS (*it
));
6011 it
->c
= string_char_and_length (s
, remaining
, &it
->len
);
6015 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6021 /* Get the next character from a Lisp string that is not an
6022 overlay string. Such strings come from the mode line, for
6023 example. We may have to pad with spaces, or truncate the
6024 string. See also next_element_from_c_string. */
6025 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
6030 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
6032 /* Pad with spaces. */
6033 it
->c
= ' ', it
->len
= 1;
6034 CHARPOS (position
) = BYTEPOS (position
) = -1;
6036 else if (STRING_MULTIBYTE (it
->string
))
6038 int maxlen
= SBYTES (it
->string
) - IT_STRING_BYTEPOS (*it
);
6039 const unsigned char *s
= (SDATA (it
->string
)
6040 + IT_STRING_BYTEPOS (*it
));
6041 it
->c
= string_char_and_length (s
, maxlen
, &it
->len
);
6045 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6050 /* Record what we have and where it came from. Note that we store a
6051 buffer position in IT->position although it could arguably be a
6053 it
->what
= IT_CHARACTER
;
6054 it
->object
= it
->string
;
6055 it
->position
= position
;
6060 /* Load IT with next display element from C string IT->s.
6061 IT->string_nchars is the maximum number of characters to return
6062 from the string. IT->end_charpos may be greater than
6063 IT->string_nchars when this function is called, in which case we
6064 may have to return padding spaces. Value is zero if end of string
6065 reached, including padding spaces. */
6068 next_element_from_c_string (it
)
6074 it
->what
= IT_CHARACTER
;
6075 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
6078 /* IT's position can be greater IT->string_nchars in case a field
6079 width or precision has been specified when the iterator was
6081 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6083 /* End of the game. */
6087 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
6089 /* Pad with spaces. */
6090 it
->c
= ' ', it
->len
= 1;
6091 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
6093 else if (it
->multibyte_p
)
6095 /* Implementation note: The calls to strlen apparently aren't a
6096 performance problem because there is no noticeable performance
6097 difference between Emacs running in unibyte or multibyte mode. */
6098 int maxlen
= strlen (it
->s
) - IT_BYTEPOS (*it
);
6099 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
),
6103 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
6109 /* Set up IT to return characters from an ellipsis, if appropriate.
6110 The definition of the ellipsis glyphs may come from a display table
6111 entry. This function Fills IT with the first glyph from the
6112 ellipsis if an ellipsis is to be displayed. */
6115 next_element_from_ellipsis (it
)
6118 if (it
->selective_display_ellipsis_p
)
6119 setup_for_ellipsis (it
, it
->len
);
6122 /* The face at the current position may be different from the
6123 face we find after the invisible text. Remember what it
6124 was in IT->saved_face_id, and signal that it's there by
6125 setting face_before_selective_p. */
6126 it
->saved_face_id
= it
->face_id
;
6127 it
->method
= GET_FROM_BUFFER
;
6128 it
->object
= it
->w
->buffer
;
6129 reseat_at_next_visible_line_start (it
, 1);
6130 it
->face_before_selective_p
= 1;
6133 return get_next_display_element (it
);
6137 /* Deliver an image display element. The iterator IT is already
6138 filled with image information (done in handle_display_prop). Value
6143 next_element_from_image (it
)
6146 it
->what
= IT_IMAGE
;
6151 /* Fill iterator IT with next display element from a stretch glyph
6152 property. IT->object is the value of the text property. Value is
6156 next_element_from_stretch (it
)
6159 it
->what
= IT_STRETCH
;
6164 /* Load IT with the next display element from current_buffer. Value
6165 is zero if end of buffer reached. IT->stop_charpos is the next
6166 position at which to stop and check for text properties or buffer
6170 next_element_from_buffer (it
)
6175 /* Check this assumption, otherwise, we would never enter the
6176 if-statement, below. */
6177 xassert (IT_CHARPOS (*it
) >= BEGV
6178 && IT_CHARPOS (*it
) <= it
->stop_charpos
);
6180 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
6182 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6184 int overlay_strings_follow_p
;
6186 /* End of the game, except when overlay strings follow that
6187 haven't been returned yet. */
6188 if (it
->overlay_strings_at_end_processed_p
)
6189 overlay_strings_follow_p
= 0;
6192 it
->overlay_strings_at_end_processed_p
= 1;
6193 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
6196 if (overlay_strings_follow_p
)
6197 success_p
= get_next_display_element (it
);
6201 it
->position
= it
->current
.pos
;
6208 return get_next_display_element (it
);
6213 /* No face changes, overlays etc. in sight, so just return a
6214 character from current_buffer. */
6217 /* Maybe run the redisplay end trigger hook. Performance note:
6218 This doesn't seem to cost measurable time. */
6219 if (it
->redisplay_end_trigger_charpos
6221 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
6222 run_redisplay_end_trigger_hook (it
);
6224 /* Get the next character, maybe multibyte. */
6225 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
6226 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
6228 int maxlen
= ((IT_BYTEPOS (*it
) >= GPT_BYTE
? ZV_BYTE
: GPT_BYTE
)
6229 - IT_BYTEPOS (*it
));
6230 it
->c
= string_char_and_length (p
, maxlen
, &it
->len
);
6233 it
->c
= *p
, it
->len
= 1;
6235 /* Record what we have and where it came from. */
6236 it
->what
= IT_CHARACTER
;;
6237 it
->object
= it
->w
->buffer
;
6238 it
->position
= it
->current
.pos
;
6240 /* Normally we return the character found above, except when we
6241 really want to return an ellipsis for selective display. */
6246 /* A value of selective > 0 means hide lines indented more
6247 than that number of columns. */
6248 if (it
->selective
> 0
6249 && IT_CHARPOS (*it
) + 1 < ZV
6250 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
6251 IT_BYTEPOS (*it
) + 1,
6252 (double) it
->selective
)) /* iftc */
6254 success_p
= next_element_from_ellipsis (it
);
6255 it
->dpvec_char_len
= -1;
6258 else if (it
->c
== '\r' && it
->selective
== -1)
6260 /* A value of selective == -1 means that everything from the
6261 CR to the end of the line is invisible, with maybe an
6262 ellipsis displayed for it. */
6263 success_p
= next_element_from_ellipsis (it
);
6264 it
->dpvec_char_len
= -1;
6269 /* Value is zero if end of buffer reached. */
6270 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
6275 /* Run the redisplay end trigger hook for IT. */
6278 run_redisplay_end_trigger_hook (it
)
6281 Lisp_Object args
[3];
6283 /* IT->glyph_row should be non-null, i.e. we should be actually
6284 displaying something, or otherwise we should not run the hook. */
6285 xassert (it
->glyph_row
);
6287 /* Set up hook arguments. */
6288 args
[0] = Qredisplay_end_trigger_functions
;
6289 args
[1] = it
->window
;
6290 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
6291 it
->redisplay_end_trigger_charpos
= 0;
6293 /* Since we are *trying* to run these functions, don't try to run
6294 them again, even if they get an error. */
6295 it
->w
->redisplay_end_trigger
= Qnil
;
6296 Frun_hook_with_args (3, args
);
6298 /* Notice if it changed the face of the character we are on. */
6299 handle_face_prop (it
);
6303 /* Deliver a composition display element. The iterator IT is already
6304 filled with composition information (done in
6305 handle_composition_prop). Value is always 1. */
6308 next_element_from_composition (it
)
6311 it
->what
= IT_COMPOSITION
;
6312 it
->position
= (STRINGP (it
->string
)
6313 ? it
->current
.string_pos
6315 if (STRINGP (it
->string
))
6316 it
->object
= it
->string
;
6318 it
->object
= it
->w
->buffer
;
6324 /***********************************************************************
6325 Moving an iterator without producing glyphs
6326 ***********************************************************************/
6328 /* Check if iterator is at a position corresponding to a valid buffer
6329 position after some move_it_ call. */
6331 #define IT_POS_VALID_AFTER_MOVE_P(it) \
6332 ((it)->method == GET_FROM_STRING \
6333 ? IT_STRING_CHARPOS (*it) == 0 \
6337 /* Move iterator IT to a specified buffer or X position within one
6338 line on the display without producing glyphs.
6340 OP should be a bit mask including some or all of these bits:
6341 MOVE_TO_X: Stop on reaching x-position TO_X.
6342 MOVE_TO_POS: Stop on reaching buffer or string position TO_CHARPOS.
6343 Regardless of OP's value, stop in reaching the end of the display line.
6345 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
6346 This means, in particular, that TO_X includes window's horizontal
6349 The return value has several possible values that
6350 say what condition caused the scan to stop:
6352 MOVE_POS_MATCH_OR_ZV
6353 - when TO_POS or ZV was reached.
6356 -when TO_X was reached before TO_POS or ZV were reached.
6359 - when we reached the end of the display area and the line must
6363 - when we reached the end of the display area and the line is
6367 - when we stopped at a line end, i.e. a newline or a CR and selective
6370 static enum move_it_result
6371 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
)
6373 int to_charpos
, to_x
, op
;
6375 enum move_it_result result
= MOVE_UNDEFINED
;
6376 struct glyph_row
*saved_glyph_row
;
6378 /* Don't produce glyphs in produce_glyphs. */
6379 saved_glyph_row
= it
->glyph_row
;
6380 it
->glyph_row
= NULL
;
6382 #define BUFFER_POS_REACHED_P() \
6383 ((op & MOVE_TO_POS) != 0 \
6384 && BUFFERP (it->object) \
6385 && IT_CHARPOS (*it) >= to_charpos \
6386 && (it->method == GET_FROM_BUFFER \
6387 || (it->method == GET_FROM_DISPLAY_VECTOR \
6388 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
6393 int x
, i
, ascent
= 0, descent
= 0;
6395 /* Stop if we move beyond TO_CHARPOS (after an image or stretch glyph). */
6396 if ((op
& MOVE_TO_POS
) != 0
6397 && BUFFERP (it
->object
)
6398 && it
->method
== GET_FROM_BUFFER
6399 && IT_CHARPOS (*it
) > to_charpos
)
6401 result
= MOVE_POS_MATCH_OR_ZV
;
6405 /* Stop when ZV reached.
6406 We used to stop here when TO_CHARPOS reached as well, but that is
6407 too soon if this glyph does not fit on this line. So we handle it
6408 explicitly below. */
6409 if (!get_next_display_element (it
)
6410 || (it
->truncate_lines_p
6411 && BUFFER_POS_REACHED_P ()))
6413 result
= MOVE_POS_MATCH_OR_ZV
;
6417 /* The call to produce_glyphs will get the metrics of the
6418 display element IT is loaded with. We record in x the
6419 x-position before this display element in case it does not
6423 /* Remember the line height so far in case the next element doesn't
6425 if (!it
->truncate_lines_p
)
6427 ascent
= it
->max_ascent
;
6428 descent
= it
->max_descent
;
6431 PRODUCE_GLYPHS (it
);
6433 if (it
->area
!= TEXT_AREA
)
6435 set_iterator_to_next (it
, 1);
6439 /* The number of glyphs we get back in IT->nglyphs will normally
6440 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
6441 character on a terminal frame, or (iii) a line end. For the
6442 second case, IT->nglyphs - 1 padding glyphs will be present
6443 (on X frames, there is only one glyph produced for a
6444 composite character.
6446 The behavior implemented below means, for continuation lines,
6447 that as many spaces of a TAB as fit on the current line are
6448 displayed there. For terminal frames, as many glyphs of a
6449 multi-glyph character are displayed in the current line, too.
6450 This is what the old redisplay code did, and we keep it that
6451 way. Under X, the whole shape of a complex character must
6452 fit on the line or it will be completely displayed in the
6455 Note that both for tabs and padding glyphs, all glyphs have
6459 /* More than one glyph or glyph doesn't fit on line. All
6460 glyphs have the same width. */
6461 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
6463 int x_before_this_char
= x
;
6464 int hpos_before_this_char
= it
->hpos
;
6466 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
6468 new_x
= x
+ single_glyph_width
;
6470 /* We want to leave anything reaching TO_X to the caller. */
6471 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
6473 if (BUFFER_POS_REACHED_P ())
6474 goto buffer_pos_reached
;
6476 result
= MOVE_X_REACHED
;
6479 else if (/* Lines are continued. */
6480 !it
->truncate_lines_p
6481 && (/* And glyph doesn't fit on the line. */
6482 new_x
> it
->last_visible_x
6483 /* Or it fits exactly and we're on a window
6485 || (new_x
== it
->last_visible_x
6486 && FRAME_WINDOW_P (it
->f
))))
6488 if (/* IT->hpos == 0 means the very first glyph
6489 doesn't fit on the line, e.g. a wide image. */
6491 || (new_x
== it
->last_visible_x
6492 && FRAME_WINDOW_P (it
->f
)))
6495 it
->current_x
= new_x
;
6497 /* The character's last glyph just barely fits
6499 if (i
== it
->nglyphs
- 1)
6501 /* If this is the destination position,
6502 return a position *before* it in this row,
6503 now that we know it fits in this row. */
6504 if (BUFFER_POS_REACHED_P ())
6506 it
->hpos
= hpos_before_this_char
;
6507 it
->current_x
= x_before_this_char
;
6508 result
= MOVE_POS_MATCH_OR_ZV
;
6512 set_iterator_to_next (it
, 1);
6513 #ifdef HAVE_WINDOW_SYSTEM
6514 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
6516 if (!get_next_display_element (it
))
6518 result
= MOVE_POS_MATCH_OR_ZV
;
6521 if (BUFFER_POS_REACHED_P ())
6523 if (ITERATOR_AT_END_OF_LINE_P (it
))
6524 result
= MOVE_POS_MATCH_OR_ZV
;
6526 result
= MOVE_LINE_CONTINUED
;
6529 if (ITERATOR_AT_END_OF_LINE_P (it
))
6531 result
= MOVE_NEWLINE_OR_CR
;
6535 #endif /* HAVE_WINDOW_SYSTEM */
6541 it
->max_ascent
= ascent
;
6542 it
->max_descent
= descent
;
6545 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
6547 result
= MOVE_LINE_CONTINUED
;
6550 else if (BUFFER_POS_REACHED_P ())
6551 goto buffer_pos_reached
;
6552 else if (new_x
> it
->first_visible_x
)
6554 /* Glyph is visible. Increment number of glyphs that
6555 would be displayed. */
6560 /* Glyph is completely off the left margin of the display
6561 area. Nothing to do. */
6565 if (result
!= MOVE_UNDEFINED
)
6568 else if (BUFFER_POS_REACHED_P ())
6572 it
->max_ascent
= ascent
;
6573 it
->max_descent
= descent
;
6574 result
= MOVE_POS_MATCH_OR_ZV
;
6577 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
6579 /* Stop when TO_X specified and reached. This check is
6580 necessary here because of lines consisting of a line end,
6581 only. The line end will not produce any glyphs and we
6582 would never get MOVE_X_REACHED. */
6583 xassert (it
->nglyphs
== 0);
6584 result
= MOVE_X_REACHED
;
6588 /* Is this a line end? If yes, we're done. */
6589 if (ITERATOR_AT_END_OF_LINE_P (it
))
6591 result
= MOVE_NEWLINE_OR_CR
;
6595 /* The current display element has been consumed. Advance
6597 set_iterator_to_next (it
, 1);
6599 /* Stop if lines are truncated and IT's current x-position is
6600 past the right edge of the window now. */
6601 if (it
->truncate_lines_p
6602 && it
->current_x
>= it
->last_visible_x
)
6604 #ifdef HAVE_WINDOW_SYSTEM
6605 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
6607 if (!get_next_display_element (it
)
6608 || BUFFER_POS_REACHED_P ())
6610 result
= MOVE_POS_MATCH_OR_ZV
;
6613 if (ITERATOR_AT_END_OF_LINE_P (it
))
6615 result
= MOVE_NEWLINE_OR_CR
;
6619 #endif /* HAVE_WINDOW_SYSTEM */
6620 result
= MOVE_LINE_TRUNCATED
;
6625 #undef BUFFER_POS_REACHED_P
6627 /* Restore the iterator settings altered at the beginning of this
6629 it
->glyph_row
= saved_glyph_row
;
6634 /* Move IT forward until it satisfies one or more of the criteria in
6635 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
6637 OP is a bit-mask that specifies where to stop, and in particular,
6638 which of those four position arguments makes a difference. See the
6639 description of enum move_operation_enum.
6641 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
6642 screen line, this function will set IT to the next position >
6646 move_it_to (it
, to_charpos
, to_x
, to_y
, to_vpos
, op
)
6648 int to_charpos
, to_x
, to_y
, to_vpos
;
6651 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
6657 if (op
& MOVE_TO_VPOS
)
6659 /* If no TO_CHARPOS and no TO_X specified, stop at the
6660 start of the line TO_VPOS. */
6661 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
6663 if (it
->vpos
== to_vpos
)
6669 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
6673 /* TO_VPOS >= 0 means stop at TO_X in the line at
6674 TO_VPOS, or at TO_POS, whichever comes first. */
6675 if (it
->vpos
== to_vpos
)
6681 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
6683 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
6688 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
6690 /* We have reached TO_X but not in the line we want. */
6691 skip
= move_it_in_display_line_to (it
, to_charpos
,
6693 if (skip
== MOVE_POS_MATCH_OR_ZV
)
6701 else if (op
& MOVE_TO_Y
)
6703 struct it it_backup
;
6705 /* TO_Y specified means stop at TO_X in the line containing
6706 TO_Y---or at TO_CHARPOS if this is reached first. The
6707 problem is that we can't really tell whether the line
6708 contains TO_Y before we have completely scanned it, and
6709 this may skip past TO_X. What we do is to first scan to
6712 If TO_X is not specified, use a TO_X of zero. The reason
6713 is to make the outcome of this function more predictable.
6714 If we didn't use TO_X == 0, we would stop at the end of
6715 the line which is probably not what a caller would expect
6717 skip
= move_it_in_display_line_to (it
, to_charpos
,
6721 | (op
& MOVE_TO_POS
)));
6723 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
6724 if (skip
== MOVE_POS_MATCH_OR_ZV
)
6730 /* If TO_X was reached, we would like to know whether TO_Y
6731 is in the line. This can only be said if we know the
6732 total line height which requires us to scan the rest of
6734 if (skip
== MOVE_X_REACHED
)
6737 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
6738 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
6740 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
6743 /* Now, decide whether TO_Y is in this line. */
6744 line_height
= it
->max_ascent
+ it
->max_descent
;
6745 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
6747 if (to_y
>= it
->current_y
6748 && to_y
< it
->current_y
+ line_height
)
6750 if (skip
== MOVE_X_REACHED
)
6751 /* If TO_Y is in this line and TO_X was reached above,
6752 we scanned too far. We have to restore IT's settings
6753 to the ones before skipping. */
6757 else if (skip
== MOVE_X_REACHED
)
6760 if (skip
== MOVE_POS_MATCH_OR_ZV
)
6768 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
6772 case MOVE_POS_MATCH_OR_ZV
:
6776 case MOVE_NEWLINE_OR_CR
:
6777 set_iterator_to_next (it
, 1);
6778 it
->continuation_lines_width
= 0;
6781 case MOVE_LINE_TRUNCATED
:
6782 it
->continuation_lines_width
= 0;
6783 reseat_at_next_visible_line_start (it
, 0);
6784 if ((op
& MOVE_TO_POS
) != 0
6785 && IT_CHARPOS (*it
) > to_charpos
)
6792 case MOVE_LINE_CONTINUED
:
6793 it
->continuation_lines_width
+= it
->current_x
;
6800 /* Reset/increment for the next run. */
6801 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
6802 it
->current_x
= it
->hpos
= 0;
6803 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
6805 last_height
= it
->max_ascent
+ it
->max_descent
;
6806 last_max_ascent
= it
->max_ascent
;
6807 it
->max_ascent
= it
->max_descent
= 0;
6812 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
6816 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
6818 If DY > 0, move IT backward at least that many pixels. DY = 0
6819 means move IT backward to the preceding line start or BEGV. This
6820 function may move over more than DY pixels if IT->current_y - DY
6821 ends up in the middle of a line; in this case IT->current_y will be
6822 set to the top of the line moved to. */
6825 move_it_vertically_backward (it
, dy
)
6836 start_pos
= IT_CHARPOS (*it
);
6838 /* Estimate how many newlines we must move back. */
6839 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
6841 /* Set the iterator's position that many lines back. */
6842 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
6843 back_to_previous_visible_line_start (it
);
6845 /* Reseat the iterator here. When moving backward, we don't want
6846 reseat to skip forward over invisible text, set up the iterator
6847 to deliver from overlay strings at the new position etc. So,
6848 use reseat_1 here. */
6849 reseat_1 (it
, it
->current
.pos
, 1);
6851 /* We are now surely at a line start. */
6852 it
->current_x
= it
->hpos
= 0;
6853 it
->continuation_lines_width
= 0;
6855 /* Move forward and see what y-distance we moved. First move to the
6856 start of the next line so that we get its height. We need this
6857 height to be able to tell whether we reached the specified
6860 it2
.max_ascent
= it2
.max_descent
= 0;
6863 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
6864 MOVE_TO_POS
| MOVE_TO_VPOS
);
6866 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
6867 xassert (IT_CHARPOS (*it
) >= BEGV
);
6870 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
6871 xassert (IT_CHARPOS (*it
) >= BEGV
);
6872 /* H is the actual vertical distance from the position in *IT
6873 and the starting position. */
6874 h
= it2
.current_y
- it
->current_y
;
6875 /* NLINES is the distance in number of lines. */
6876 nlines
= it2
.vpos
- it
->vpos
;
6878 /* Correct IT's y and vpos position
6879 so that they are relative to the starting point. */
6885 /* DY == 0 means move to the start of the screen line. The
6886 value of nlines is > 0 if continuation lines were involved. */
6888 move_it_by_lines (it
, nlines
, 1);
6890 /* I think this assert is bogus if buffer contains
6891 invisible text or images. KFS. */
6892 xassert (IT_CHARPOS (*it
) <= start_pos
);
6897 /* The y-position we try to reach, relative to *IT.
6898 Note that H has been subtracted in front of the if-statement. */
6899 int target_y
= it
->current_y
+ h
- dy
;
6900 int y0
= it3
.current_y
;
6901 int y1
= line_bottom_y (&it3
);
6902 int line_height
= y1
- y0
;
6904 /* If we did not reach target_y, try to move further backward if
6905 we can. If we moved too far backward, try to move forward. */
6906 if (target_y
< it
->current_y
6907 /* This is heuristic. In a window that's 3 lines high, with
6908 a line height of 13 pixels each, recentering with point
6909 on the bottom line will try to move -39/2 = 19 pixels
6910 backward. Try to avoid moving into the first line. */
6911 && (it
->current_y
- target_y
6912 > min (window_box_height (it
->w
), line_height
* 2 / 3))
6913 && IT_CHARPOS (*it
) > BEGV
)
6915 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
6916 target_y
- it
->current_y
));
6917 dy
= it
->current_y
- target_y
;
6918 goto move_further_back
;
6920 else if (target_y
>= it
->current_y
+ line_height
6921 && IT_CHARPOS (*it
) < ZV
)
6923 /* Should move forward by at least one line, maybe more.
6925 Note: Calling move_it_by_lines can be expensive on
6926 terminal frames, where compute_motion is used (via
6927 vmotion) to do the job, when there are very long lines
6928 and truncate-lines is nil. That's the reason for
6929 treating terminal frames specially here. */
6931 if (!FRAME_WINDOW_P (it
->f
))
6932 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
6937 move_it_by_lines (it
, 1, 1);
6939 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
6943 /* I think this assert is bogus if buffer contains
6944 invisible text or images. KFS. */
6945 xassert (IT_CHARPOS (*it
) >= BEGV
);
6952 /* Move IT by a specified amount of pixel lines DY. DY negative means
6953 move backwards. DY = 0 means move to start of screen line. At the
6954 end, IT will be on the start of a screen line. */
6957 move_it_vertically (it
, dy
)
6962 move_it_vertically_backward (it
, -dy
);
6965 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
6966 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
6967 MOVE_TO_POS
| MOVE_TO_Y
);
6968 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
6970 /* If buffer ends in ZV without a newline, move to the start of
6971 the line to satisfy the post-condition. */
6972 if (IT_CHARPOS (*it
) == ZV
6974 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
6975 move_it_by_lines (it
, 0, 0);
6980 /* Move iterator IT past the end of the text line it is in. */
6983 move_it_past_eol (it
)
6986 enum move_it_result rc
;
6988 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
6989 if (rc
== MOVE_NEWLINE_OR_CR
)
6990 set_iterator_to_next (it
, 0);
6994 #if 0 /* Currently not used. */
6996 /* Return non-zero if some text between buffer positions START_CHARPOS
6997 and END_CHARPOS is invisible. IT->window is the window for text
7001 invisible_text_between_p (it
, start_charpos
, end_charpos
)
7003 int start_charpos
, end_charpos
;
7005 Lisp_Object prop
, limit
;
7006 int invisible_found_p
;
7008 xassert (it
!= NULL
&& start_charpos
<= end_charpos
);
7010 /* Is text at START invisible? */
7011 prop
= Fget_char_property (make_number (start_charpos
), Qinvisible
,
7013 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
7014 invisible_found_p
= 1;
7017 limit
= Fnext_single_char_property_change (make_number (start_charpos
),
7019 make_number (end_charpos
));
7020 invisible_found_p
= XFASTINT (limit
) < end_charpos
;
7023 return invisible_found_p
;
7029 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
7030 negative means move up. DVPOS == 0 means move to the start of the
7031 screen line. NEED_Y_P non-zero means calculate IT->current_y. If
7032 NEED_Y_P is zero, IT->current_y will be left unchanged.
7034 Further optimization ideas: If we would know that IT->f doesn't use
7035 a face with proportional font, we could be faster for
7036 truncate-lines nil. */
7039 move_it_by_lines (it
, dvpos
, need_y_p
)
7041 int dvpos
, need_y_p
;
7043 struct position pos
;
7045 if (!FRAME_WINDOW_P (it
->f
))
7047 struct text_pos textpos
;
7049 /* We can use vmotion on frames without proportional fonts. */
7050 pos
= *vmotion (IT_CHARPOS (*it
), dvpos
, it
->w
);
7051 SET_TEXT_POS (textpos
, pos
.bufpos
, pos
.bytepos
);
7052 reseat (it
, textpos
, 1);
7053 it
->vpos
+= pos
.vpos
;
7054 it
->current_y
+= pos
.vpos
;
7056 else if (dvpos
== 0)
7058 /* DVPOS == 0 means move to the start of the screen line. */
7059 move_it_vertically_backward (it
, 0);
7060 xassert (it
->current_x
== 0 && it
->hpos
== 0);
7061 /* Let next call to line_bottom_y calculate real line height */
7066 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
7067 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
7068 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
7073 int start_charpos
, i
;
7075 /* Start at the beginning of the screen line containing IT's
7076 position. This may actually move vertically backwards,
7077 in case of overlays, so adjust dvpos accordingly. */
7079 move_it_vertically_backward (it
, 0);
7082 /* Go back -DVPOS visible lines and reseat the iterator there. */
7083 start_charpos
= IT_CHARPOS (*it
);
7084 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
7085 back_to_previous_visible_line_start (it
);
7086 reseat (it
, it
->current
.pos
, 1);
7088 /* Move further back if we end up in a string or an image. */
7089 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
7091 /* First try to move to start of display line. */
7093 move_it_vertically_backward (it
, 0);
7095 if (IT_POS_VALID_AFTER_MOVE_P (it
))
7097 /* If start of line is still in string or image,
7098 move further back. */
7099 back_to_previous_visible_line_start (it
);
7100 reseat (it
, it
->current
.pos
, 1);
7104 it
->current_x
= it
->hpos
= 0;
7106 /* Above call may have moved too far if continuation lines
7107 are involved. Scan forward and see if it did. */
7109 it2
.vpos
= it2
.current_y
= 0;
7110 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
7111 it
->vpos
-= it2
.vpos
;
7112 it
->current_y
-= it2
.current_y
;
7113 it
->current_x
= it
->hpos
= 0;
7115 /* If we moved too far back, move IT some lines forward. */
7116 if (it2
.vpos
> -dvpos
)
7118 int delta
= it2
.vpos
+ dvpos
;
7120 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
7121 /* Move back again if we got too far ahead. */
7122 if (IT_CHARPOS (*it
) >= start_charpos
)
7128 /* Return 1 if IT points into the middle of a display vector. */
7131 in_display_vector_p (it
)
7134 return (it
->method
== GET_FROM_DISPLAY_VECTOR
7135 && it
->current
.dpvec_index
> 0
7136 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
7140 /***********************************************************************
7142 ***********************************************************************/
7145 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
7149 add_to_log (format
, arg1
, arg2
)
7151 Lisp_Object arg1
, arg2
;
7153 Lisp_Object args
[3];
7154 Lisp_Object msg
, fmt
;
7157 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
7160 /* Do nothing if called asynchronously. Inserting text into
7161 a buffer may call after-change-functions and alike and
7162 that would means running Lisp asynchronously. */
7163 if (handling_signal
)
7167 GCPRO4 (fmt
, msg
, arg1
, arg2
);
7169 args
[0] = fmt
= build_string (format
);
7172 msg
= Fformat (3, args
);
7174 len
= SBYTES (msg
) + 1;
7175 SAFE_ALLOCA (buffer
, char *, len
);
7176 bcopy (SDATA (msg
), buffer
, len
);
7178 message_dolog (buffer
, len
- 1, 1, 0);
7185 /* Output a newline in the *Messages* buffer if "needs" one. */
7188 message_log_maybe_newline ()
7190 if (message_log_need_newline
)
7191 message_dolog ("", 0, 1, 0);
7195 /* Add a string M of length NBYTES to the message log, optionally
7196 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
7197 nonzero, means interpret the contents of M as multibyte. This
7198 function calls low-level routines in order to bypass text property
7199 hooks, etc. which might not be safe to run.
7201 This may GC (insert may run before/after change hooks),
7202 so the buffer M must NOT point to a Lisp string. */
7205 message_dolog (m
, nbytes
, nlflag
, multibyte
)
7207 int nbytes
, nlflag
, multibyte
;
7209 if (!NILP (Vmemory_full
))
7212 if (!NILP (Vmessage_log_max
))
7214 struct buffer
*oldbuf
;
7215 Lisp_Object oldpoint
, oldbegv
, oldzv
;
7216 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
7217 int point_at_end
= 0;
7219 Lisp_Object old_deactivate_mark
, tem
;
7220 struct gcpro gcpro1
;
7222 old_deactivate_mark
= Vdeactivate_mark
;
7223 oldbuf
= current_buffer
;
7224 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
7225 current_buffer
->undo_list
= Qt
;
7227 oldpoint
= message_dolog_marker1
;
7228 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
7229 oldbegv
= message_dolog_marker2
;
7230 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
7231 oldzv
= message_dolog_marker3
;
7232 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
7233 GCPRO1 (old_deactivate_mark
);
7241 BEGV_BYTE
= BEG_BYTE
;
7244 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
7246 /* Insert the string--maybe converting multibyte to single byte
7247 or vice versa, so that all the text fits the buffer. */
7249 && NILP (current_buffer
->enable_multibyte_characters
))
7251 int i
, c
, char_bytes
;
7252 unsigned char work
[1];
7254 /* Convert a multibyte string to single-byte
7255 for the *Message* buffer. */
7256 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
7258 c
= string_char_and_length (m
+ i
, nbytes
- i
, &char_bytes
);
7259 work
[0] = (SINGLE_BYTE_CHAR_P (c
)
7261 : multibyte_char_to_unibyte (c
, Qnil
));
7262 insert_1_both (work
, 1, 1, 1, 0, 0);
7265 else if (! multibyte
7266 && ! NILP (current_buffer
->enable_multibyte_characters
))
7268 int i
, c
, char_bytes
;
7269 unsigned char *msg
= (unsigned char *) m
;
7270 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
7271 /* Convert a single-byte string to multibyte
7272 for the *Message* buffer. */
7273 for (i
= 0; i
< nbytes
; i
++)
7275 c
= unibyte_char_to_multibyte (msg
[i
]);
7276 char_bytes
= CHAR_STRING (c
, str
);
7277 insert_1_both (str
, 1, char_bytes
, 1, 0, 0);
7281 insert_1 (m
, nbytes
, 1, 0, 0);
7285 int this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
, dup
;
7286 insert_1 ("\n", 1, 1, 0, 0);
7288 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
7290 this_bol_byte
= PT_BYTE
;
7292 /* See if this line duplicates the previous one.
7293 If so, combine duplicates. */
7296 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
7298 prev_bol_byte
= PT_BYTE
;
7300 dup
= message_log_check_duplicate (prev_bol
, prev_bol_byte
,
7301 this_bol
, this_bol_byte
);
7304 del_range_both (prev_bol
, prev_bol_byte
,
7305 this_bol
, this_bol_byte
, 0);
7311 /* If you change this format, don't forget to also
7312 change message_log_check_duplicate. */
7313 sprintf (dupstr
, " [%d times]", dup
);
7314 duplen
= strlen (dupstr
);
7315 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
7316 insert_1 (dupstr
, duplen
, 1, 0, 1);
7321 /* If we have more than the desired maximum number of lines
7322 in the *Messages* buffer now, delete the oldest ones.
7323 This is safe because we don't have undo in this buffer. */
7325 if (NATNUMP (Vmessage_log_max
))
7327 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
7328 -XFASTINT (Vmessage_log_max
) - 1, 0);
7329 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
7332 BEGV
= XMARKER (oldbegv
)->charpos
;
7333 BEGV_BYTE
= marker_byte_position (oldbegv
);
7342 ZV
= XMARKER (oldzv
)->charpos
;
7343 ZV_BYTE
= marker_byte_position (oldzv
);
7347 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
7349 /* We can't do Fgoto_char (oldpoint) because it will run some
7351 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
7352 XMARKER (oldpoint
)->bytepos
);
7355 unchain_marker (XMARKER (oldpoint
));
7356 unchain_marker (XMARKER (oldbegv
));
7357 unchain_marker (XMARKER (oldzv
));
7359 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
7360 set_buffer_internal (oldbuf
);
7362 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
7363 message_log_need_newline
= !nlflag
;
7364 Vdeactivate_mark
= old_deactivate_mark
;
7369 /* We are at the end of the buffer after just having inserted a newline.
7370 (Note: We depend on the fact we won't be crossing the gap.)
7371 Check to see if the most recent message looks a lot like the previous one.
7372 Return 0 if different, 1 if the new one should just replace it, or a
7373 value N > 1 if we should also append " [N times]". */
7376 message_log_check_duplicate (prev_bol
, prev_bol_byte
, this_bol
, this_bol_byte
)
7377 int prev_bol
, this_bol
;
7378 int prev_bol_byte
, this_bol_byte
;
7381 int len
= Z_BYTE
- 1 - this_bol_byte
;
7383 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
7384 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
7386 for (i
= 0; i
< len
; i
++)
7388 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
7396 if (*p1
++ == ' ' && *p1
++ == '[')
7399 while (*p1
>= '0' && *p1
<= '9')
7400 n
= n
* 10 + *p1
++ - '0';
7401 if (strncmp (p1
, " times]\n", 8) == 0)
7408 /* Display an echo area message M with a specified length of NBYTES
7409 bytes. The string may include null characters. If M is 0, clear
7410 out any existing message, and let the mini-buffer text show
7413 This may GC, so the buffer M must NOT point to a Lisp string. */
7416 message2 (m
, nbytes
, multibyte
)
7421 /* First flush out any partial line written with print. */
7422 message_log_maybe_newline ();
7424 message_dolog (m
, nbytes
, 1, multibyte
);
7425 message2_nolog (m
, nbytes
, multibyte
);
7429 /* The non-logging counterpart of message2. */
7432 message2_nolog (m
, nbytes
, multibyte
)
7434 int nbytes
, multibyte
;
7436 struct frame
*sf
= SELECTED_FRAME ();
7437 message_enable_multibyte
= multibyte
;
7441 if (noninteractive_need_newline
)
7442 putc ('\n', stderr
);
7443 noninteractive_need_newline
= 0;
7445 fwrite (m
, nbytes
, 1, stderr
);
7446 if (cursor_in_echo_area
== 0)
7447 fprintf (stderr
, "\n");
7450 /* A null message buffer means that the frame hasn't really been
7451 initialized yet. Error messages get reported properly by
7452 cmd_error, so this must be just an informative message; toss it. */
7453 else if (INTERACTIVE
7454 && sf
->glyphs_initialized_p
7455 && FRAME_MESSAGE_BUF (sf
))
7457 Lisp_Object mini_window
;
7460 /* Get the frame containing the mini-buffer
7461 that the selected frame is using. */
7462 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
7463 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
7465 FRAME_SAMPLE_VISIBILITY (f
);
7466 if (FRAME_VISIBLE_P (sf
)
7467 && ! FRAME_VISIBLE_P (f
))
7468 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
7472 set_message (m
, Qnil
, nbytes
, multibyte
);
7473 if (minibuffer_auto_raise
)
7474 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
7477 clear_message (1, 1);
7479 do_pending_window_change (0);
7480 echo_area_display (1);
7481 do_pending_window_change (0);
7482 if (frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
7483 (*frame_up_to_date_hook
) (f
);
7488 /* Display an echo area message M with a specified length of NBYTES
7489 bytes. The string may include null characters. If M is not a
7490 string, clear out any existing message, and let the mini-buffer
7493 This function cancels echoing. */
7496 message3 (m
, nbytes
, multibyte
)
7501 struct gcpro gcpro1
;
7504 clear_message (1,1);
7507 /* First flush out any partial line written with print. */
7508 message_log_maybe_newline ();
7514 SAFE_ALLOCA (buffer
, char *, nbytes
);
7515 bcopy (SDATA (m
), buffer
, nbytes
);
7516 message_dolog (buffer
, nbytes
, 1, multibyte
);
7519 message3_nolog (m
, nbytes
, multibyte
);
7525 /* The non-logging version of message3.
7526 This does not cancel echoing, because it is used for echoing.
7527 Perhaps we need to make a separate function for echoing
7528 and make this cancel echoing. */
7531 message3_nolog (m
, nbytes
, multibyte
)
7533 int nbytes
, multibyte
;
7535 struct frame
*sf
= SELECTED_FRAME ();
7536 message_enable_multibyte
= multibyte
;
7540 if (noninteractive_need_newline
)
7541 putc ('\n', stderr
);
7542 noninteractive_need_newline
= 0;
7544 fwrite (SDATA (m
), nbytes
, 1, stderr
);
7545 if (cursor_in_echo_area
== 0)
7546 fprintf (stderr
, "\n");
7549 /* A null message buffer means that the frame hasn't really been
7550 initialized yet. Error messages get reported properly by
7551 cmd_error, so this must be just an informative message; toss it. */
7552 else if (INTERACTIVE
7553 && sf
->glyphs_initialized_p
7554 && FRAME_MESSAGE_BUF (sf
))
7556 Lisp_Object mini_window
;
7560 /* Get the frame containing the mini-buffer
7561 that the selected frame is using. */
7562 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
7563 frame
= XWINDOW (mini_window
)->frame
;
7566 FRAME_SAMPLE_VISIBILITY (f
);
7567 if (FRAME_VISIBLE_P (sf
)
7568 && !FRAME_VISIBLE_P (f
))
7569 Fmake_frame_visible (frame
);
7571 if (STRINGP (m
) && SCHARS (m
) > 0)
7573 set_message (NULL
, m
, nbytes
, multibyte
);
7574 if (minibuffer_auto_raise
)
7575 Fraise_frame (frame
);
7576 /* Assume we are not echoing.
7577 (If we are, echo_now will override this.) */
7578 echo_message_buffer
= Qnil
;
7581 clear_message (1, 1);
7583 do_pending_window_change (0);
7584 echo_area_display (1);
7585 do_pending_window_change (0);
7586 if (frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
7587 (*frame_up_to_date_hook
) (f
);
7592 /* Display a null-terminated echo area message M. If M is 0, clear
7593 out any existing message, and let the mini-buffer text show through.
7595 The buffer M must continue to exist until after the echo area gets
7596 cleared or some other message gets displayed there. Do not pass
7597 text that is stored in a Lisp string. Do not pass text in a buffer
7598 that was alloca'd. */
7604 message2 (m
, (m
? strlen (m
) : 0), 0);
7608 /* The non-logging counterpart of message1. */
7614 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
7617 /* Display a message M which contains a single %s
7618 which gets replaced with STRING. */
7621 message_with_string (m
, string
, log
)
7626 CHECK_STRING (string
);
7632 if (noninteractive_need_newline
)
7633 putc ('\n', stderr
);
7634 noninteractive_need_newline
= 0;
7635 fprintf (stderr
, m
, SDATA (string
));
7636 if (cursor_in_echo_area
== 0)
7637 fprintf (stderr
, "\n");
7641 else if (INTERACTIVE
)
7643 /* The frame whose minibuffer we're going to display the message on.
7644 It may be larger than the selected frame, so we need
7645 to use its buffer, not the selected frame's buffer. */
7646 Lisp_Object mini_window
;
7647 struct frame
*f
, *sf
= SELECTED_FRAME ();
7649 /* Get the frame containing the minibuffer
7650 that the selected frame is using. */
7651 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
7652 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
7654 /* A null message buffer means that the frame hasn't really been
7655 initialized yet. Error messages get reported properly by
7656 cmd_error, so this must be just an informative message; toss it. */
7657 if (FRAME_MESSAGE_BUF (f
))
7659 Lisp_Object args
[2], message
;
7660 struct gcpro gcpro1
, gcpro2
;
7662 args
[0] = build_string (m
);
7663 args
[1] = message
= string
;
7664 GCPRO2 (args
[0], message
);
7667 message
= Fformat (2, args
);
7670 message3 (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
7672 message3_nolog (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
7676 /* Print should start at the beginning of the message
7677 buffer next time. */
7678 message_buf_print
= 0;
7684 /* Dump an informative message to the minibuf. If M is 0, clear out
7685 any existing message, and let the mini-buffer text show through. */
7689 message (m
, a1
, a2
, a3
)
7691 EMACS_INT a1
, a2
, a3
;
7697 if (noninteractive_need_newline
)
7698 putc ('\n', stderr
);
7699 noninteractive_need_newline
= 0;
7700 fprintf (stderr
, m
, a1
, a2
, a3
);
7701 if (cursor_in_echo_area
== 0)
7702 fprintf (stderr
, "\n");
7706 else if (INTERACTIVE
)
7708 /* The frame whose mini-buffer we're going to display the message
7709 on. It may be larger than the selected frame, so we need to
7710 use its buffer, not the selected frame's buffer. */
7711 Lisp_Object mini_window
;
7712 struct frame
*f
, *sf
= SELECTED_FRAME ();
7714 /* Get the frame containing the mini-buffer
7715 that the selected frame is using. */
7716 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
7717 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
7719 /* A null message buffer means that the frame hasn't really been
7720 initialized yet. Error messages get reported properly by
7721 cmd_error, so this must be just an informative message; toss
7723 if (FRAME_MESSAGE_BUF (f
))
7734 len
= doprnt (FRAME_MESSAGE_BUF (f
),
7735 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3, a
);
7737 len
= doprnt (FRAME_MESSAGE_BUF (f
),
7738 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3,
7740 #endif /* NO_ARG_ARRAY */
7742 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
7747 /* Print should start at the beginning of the message
7748 buffer next time. */
7749 message_buf_print
= 0;
7755 /* The non-logging version of message. */
7758 message_nolog (m
, a1
, a2
, a3
)
7760 EMACS_INT a1
, a2
, a3
;
7762 Lisp_Object old_log_max
;
7763 old_log_max
= Vmessage_log_max
;
7764 Vmessage_log_max
= Qnil
;
7765 message (m
, a1
, a2
, a3
);
7766 Vmessage_log_max
= old_log_max
;
7770 /* Display the current message in the current mini-buffer. This is
7771 only called from error handlers in process.c, and is not time
7777 if (!NILP (echo_area_buffer
[0]))
7780 string
= Fcurrent_message ();
7781 message3 (string
, SBYTES (string
),
7782 !NILP (current_buffer
->enable_multibyte_characters
));
7787 /* Make sure echo area buffers in `echo_buffers' are live.
7788 If they aren't, make new ones. */
7791 ensure_echo_area_buffers ()
7795 for (i
= 0; i
< 2; ++i
)
7796 if (!BUFFERP (echo_buffer
[i
])
7797 || NILP (XBUFFER (echo_buffer
[i
])->name
))
7800 Lisp_Object old_buffer
;
7803 old_buffer
= echo_buffer
[i
];
7804 sprintf (name
, " *Echo Area %d*", i
);
7805 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
7806 XBUFFER (echo_buffer
[i
])->truncate_lines
= Qnil
;
7808 for (j
= 0; j
< 2; ++j
)
7809 if (EQ (old_buffer
, echo_area_buffer
[j
]))
7810 echo_area_buffer
[j
] = echo_buffer
[i
];
7815 /* Call FN with args A1..A4 with either the current or last displayed
7816 echo_area_buffer as current buffer.
7818 WHICH zero means use the current message buffer
7819 echo_area_buffer[0]. If that is nil, choose a suitable buffer
7820 from echo_buffer[] and clear it.
7822 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
7823 suitable buffer from echo_buffer[] and clear it.
7825 Value is what FN returns. */
7828 with_echo_area_buffer (w
, which
, fn
, a1
, a2
, a3
, a4
)
7831 int (*fn
) P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
7837 int this_one
, the_other
, clear_buffer_p
, rc
;
7838 int count
= SPECPDL_INDEX ();
7840 /* If buffers aren't live, make new ones. */
7841 ensure_echo_area_buffers ();
7846 this_one
= 0, the_other
= 1;
7848 this_one
= 1, the_other
= 0;
7850 /* Choose a suitable buffer from echo_buffer[] is we don't
7852 if (NILP (echo_area_buffer
[this_one
]))
7854 echo_area_buffer
[this_one
]
7855 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
7856 ? echo_buffer
[the_other
]
7857 : echo_buffer
[this_one
]);
7861 buffer
= echo_area_buffer
[this_one
];
7863 /* Don't get confused by reusing the buffer used for echoing
7864 for a different purpose. */
7865 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
7868 record_unwind_protect (unwind_with_echo_area_buffer
,
7869 with_echo_area_buffer_unwind_data (w
));
7871 /* Make the echo area buffer current. Note that for display
7872 purposes, it is not necessary that the displayed window's buffer
7873 == current_buffer, except for text property lookup. So, let's
7874 only set that buffer temporarily here without doing a full
7875 Fset_window_buffer. We must also change w->pointm, though,
7876 because otherwise an assertions in unshow_buffer fails, and Emacs
7878 set_buffer_internal_1 (XBUFFER (buffer
));
7882 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
7885 current_buffer
->undo_list
= Qt
;
7886 current_buffer
->read_only
= Qnil
;
7887 specbind (Qinhibit_read_only
, Qt
);
7888 specbind (Qinhibit_modification_hooks
, Qt
);
7890 if (clear_buffer_p
&& Z
> BEG
)
7893 xassert (BEGV
>= BEG
);
7894 xassert (ZV
<= Z
&& ZV
>= BEGV
);
7896 rc
= fn (a1
, a2
, a3
, a4
);
7898 xassert (BEGV
>= BEG
);
7899 xassert (ZV
<= Z
&& ZV
>= BEGV
);
7901 unbind_to (count
, Qnil
);
7906 /* Save state that should be preserved around the call to the function
7907 FN called in with_echo_area_buffer. */
7910 with_echo_area_buffer_unwind_data (w
)
7916 /* Reduce consing by keeping one vector in
7917 Vwith_echo_area_save_vector. */
7918 vector
= Vwith_echo_area_save_vector
;
7919 Vwith_echo_area_save_vector
= Qnil
;
7922 vector
= Fmake_vector (make_number (7), Qnil
);
7924 XSETBUFFER (AREF (vector
, i
), current_buffer
); ++i
;
7925 AREF (vector
, i
) = Vdeactivate_mark
, ++i
;
7926 AREF (vector
, i
) = make_number (windows_or_buffers_changed
), ++i
;
7930 XSETWINDOW (AREF (vector
, i
), w
); ++i
;
7931 AREF (vector
, i
) = w
->buffer
; ++i
;
7932 AREF (vector
, i
) = make_number (XMARKER (w
->pointm
)->charpos
); ++i
;
7933 AREF (vector
, i
) = make_number (XMARKER (w
->pointm
)->bytepos
); ++i
;
7938 for (; i
< end
; ++i
)
7939 AREF (vector
, i
) = Qnil
;
7942 xassert (i
== ASIZE (vector
));
7947 /* Restore global state from VECTOR which was created by
7948 with_echo_area_buffer_unwind_data. */
7951 unwind_with_echo_area_buffer (vector
)
7954 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
7955 Vdeactivate_mark
= AREF (vector
, 1);
7956 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
7958 if (WINDOWP (AREF (vector
, 3)))
7961 Lisp_Object buffer
, charpos
, bytepos
;
7963 w
= XWINDOW (AREF (vector
, 3));
7964 buffer
= AREF (vector
, 4);
7965 charpos
= AREF (vector
, 5);
7966 bytepos
= AREF (vector
, 6);
7969 set_marker_both (w
->pointm
, buffer
,
7970 XFASTINT (charpos
), XFASTINT (bytepos
));
7973 Vwith_echo_area_save_vector
= vector
;
7978 /* Set up the echo area for use by print functions. MULTIBYTE_P
7979 non-zero means we will print multibyte. */
7982 setup_echo_area_for_printing (multibyte_p
)
7985 /* If we can't find an echo area any more, exit. */
7986 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
7989 ensure_echo_area_buffers ();
7991 if (!message_buf_print
)
7993 /* A message has been output since the last time we printed.
7994 Choose a fresh echo area buffer. */
7995 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
7996 echo_area_buffer
[0] = echo_buffer
[1];
7998 echo_area_buffer
[0] = echo_buffer
[0];
8000 /* Switch to that buffer and clear it. */
8001 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8002 current_buffer
->truncate_lines
= Qnil
;
8006 int count
= SPECPDL_INDEX ();
8007 specbind (Qinhibit_read_only
, Qt
);
8008 /* Note that undo recording is always disabled. */
8010 unbind_to (count
, Qnil
);
8012 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8014 /* Set up the buffer for the multibyteness we need. */
8016 != !NILP (current_buffer
->enable_multibyte_characters
))
8017 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
8019 /* Raise the frame containing the echo area. */
8020 if (minibuffer_auto_raise
)
8022 struct frame
*sf
= SELECTED_FRAME ();
8023 Lisp_Object mini_window
;
8024 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8025 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8028 message_log_maybe_newline ();
8029 message_buf_print
= 1;
8033 if (NILP (echo_area_buffer
[0]))
8035 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8036 echo_area_buffer
[0] = echo_buffer
[1];
8038 echo_area_buffer
[0] = echo_buffer
[0];
8041 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
8043 /* Someone switched buffers between print requests. */
8044 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8045 current_buffer
->truncate_lines
= Qnil
;
8051 /* Display an echo area message in window W. Value is non-zero if W's
8052 height is changed. If display_last_displayed_message_p is
8053 non-zero, display the message that was last displayed, otherwise
8054 display the current message. */
8057 display_echo_area (w
)
8060 int i
, no_message_p
, window_height_changed_p
, count
;
8062 /* Temporarily disable garbage collections while displaying the echo
8063 area. This is done because a GC can print a message itself.
8064 That message would modify the echo area buffer's contents while a
8065 redisplay of the buffer is going on, and seriously confuse
8067 count
= inhibit_garbage_collection ();
8069 /* If there is no message, we must call display_echo_area_1
8070 nevertheless because it resizes the window. But we will have to
8071 reset the echo_area_buffer in question to nil at the end because
8072 with_echo_area_buffer will sets it to an empty buffer. */
8073 i
= display_last_displayed_message_p
? 1 : 0;
8074 no_message_p
= NILP (echo_area_buffer
[i
]);
8076 window_height_changed_p
8077 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
8078 display_echo_area_1
,
8079 (EMACS_INT
) w
, Qnil
, 0, 0);
8082 echo_area_buffer
[i
] = Qnil
;
8084 unbind_to (count
, Qnil
);
8085 return window_height_changed_p
;
8089 /* Helper for display_echo_area. Display the current buffer which
8090 contains the current echo area message in window W, a mini-window,
8091 a pointer to which is passed in A1. A2..A4 are currently not used.
8092 Change the height of W so that all of the message is displayed.
8093 Value is non-zero if height of W was changed. */
8096 display_echo_area_1 (a1
, a2
, a3
, a4
)
8101 struct window
*w
= (struct window
*) a1
;
8103 struct text_pos start
;
8104 int window_height_changed_p
= 0;
8106 /* Do this before displaying, so that we have a large enough glyph
8107 matrix for the display. If we can't get enough space for the
8108 whole text, display the last N lines. That works by setting w->start. */
8109 window_height_changed_p
= resize_mini_window (w
, 0);
8111 /* Use the starting position chosen by resize_mini_window. */
8112 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
8115 clear_glyph_matrix (w
->desired_matrix
);
8116 XSETWINDOW (window
, w
);
8117 try_window (window
, start
, 0);
8119 return window_height_changed_p
;
8123 /* Resize the echo area window to exactly the size needed for the
8124 currently displayed message, if there is one. If a mini-buffer
8125 is active, don't shrink it. */
8128 resize_echo_area_exactly ()
8130 if (BUFFERP (echo_area_buffer
[0])
8131 && WINDOWP (echo_area_window
))
8133 struct window
*w
= XWINDOW (echo_area_window
);
8135 Lisp_Object resize_exactly
;
8137 if (minibuf_level
== 0)
8138 resize_exactly
= Qt
;
8140 resize_exactly
= Qnil
;
8142 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
8143 (EMACS_INT
) w
, resize_exactly
, 0, 0);
8146 ++windows_or_buffers_changed
;
8147 ++update_mode_lines
;
8148 redisplay_internal (0);
8154 /* Callback function for with_echo_area_buffer, when used from
8155 resize_echo_area_exactly. A1 contains a pointer to the window to
8156 resize, EXACTLY non-nil means resize the mini-window exactly to the
8157 size of the text displayed. A3 and A4 are not used. Value is what
8158 resize_mini_window returns. */
8161 resize_mini_window_1 (a1
, exactly
, a3
, a4
)
8163 Lisp_Object exactly
;
8166 return resize_mini_window ((struct window
*) a1
, !NILP (exactly
));
8170 /* Resize mini-window W to fit the size of its contents. EXACT:P
8171 means size the window exactly to the size needed. Otherwise, it's
8172 only enlarged until W's buffer is empty.
8174 Set W->start to the right place to begin display. If the whole
8175 contents fit, start at the beginning. Otherwise, start so as
8176 to make the end of the contents appear. This is particularly
8177 important for y-or-n-p, but seems desirable generally.
8179 Value is non-zero if the window height has been changed. */
8182 resize_mini_window (w
, exact_p
)
8186 struct frame
*f
= XFRAME (w
->frame
);
8187 int window_height_changed_p
= 0;
8189 xassert (MINI_WINDOW_P (w
));
8191 /* By default, start display at the beginning. */
8192 set_marker_both (w
->start
, w
->buffer
,
8193 BUF_BEGV (XBUFFER (w
->buffer
)),
8194 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
8196 /* Don't resize windows while redisplaying a window; it would
8197 confuse redisplay functions when the size of the window they are
8198 displaying changes from under them. Such a resizing can happen,
8199 for instance, when which-func prints a long message while
8200 we are running fontification-functions. We're running these
8201 functions with safe_call which binds inhibit-redisplay to t. */
8202 if (!NILP (Vinhibit_redisplay
))
8205 /* Nil means don't try to resize. */
8206 if (NILP (Vresize_mini_windows
)
8207 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
8210 if (!FRAME_MINIBUF_ONLY_P (f
))
8213 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
8214 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
8215 int height
, max_height
;
8216 int unit
= FRAME_LINE_HEIGHT (f
);
8217 struct text_pos start
;
8218 struct buffer
*old_current_buffer
= NULL
;
8220 if (current_buffer
!= XBUFFER (w
->buffer
))
8222 old_current_buffer
= current_buffer
;
8223 set_buffer_internal (XBUFFER (w
->buffer
));
8226 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8228 /* Compute the max. number of lines specified by the user. */
8229 if (FLOATP (Vmax_mini_window_height
))
8230 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
8231 else if (INTEGERP (Vmax_mini_window_height
))
8232 max_height
= XINT (Vmax_mini_window_height
);
8234 max_height
= total_height
/ 4;
8236 /* Correct that max. height if it's bogus. */
8237 max_height
= max (1, max_height
);
8238 max_height
= min (total_height
, max_height
);
8240 /* Find out the height of the text in the window. */
8241 if (it
.truncate_lines_p
)
8246 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
8247 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
8248 height
= it
.current_y
+ last_height
;
8250 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
8251 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
8252 height
= (height
+ unit
- 1) / unit
;
8255 /* Compute a suitable window start. */
8256 if (height
> max_height
)
8258 height
= max_height
;
8259 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8260 move_it_vertically_backward (&it
, (height
- 1) * unit
);
8261 start
= it
.current
.pos
;
8264 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
8265 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
8267 if (EQ (Vresize_mini_windows
, Qgrow_only
))
8269 /* Let it grow only, until we display an empty message, in which
8270 case the window shrinks again. */
8271 if (height
> WINDOW_TOTAL_LINES (w
))
8273 int old_height
= WINDOW_TOTAL_LINES (w
);
8274 freeze_window_starts (f
, 1);
8275 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8276 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8278 else if (height
< WINDOW_TOTAL_LINES (w
)
8279 && (exact_p
|| BEGV
== ZV
))
8281 int old_height
= WINDOW_TOTAL_LINES (w
);
8282 freeze_window_starts (f
, 0);
8283 shrink_mini_window (w
);
8284 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8289 /* Always resize to exact size needed. */
8290 if (height
> WINDOW_TOTAL_LINES (w
))
8292 int old_height
= WINDOW_TOTAL_LINES (w
);
8293 freeze_window_starts (f
, 1);
8294 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8295 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8297 else if (height
< WINDOW_TOTAL_LINES (w
))
8299 int old_height
= WINDOW_TOTAL_LINES (w
);
8300 freeze_window_starts (f
, 0);
8301 shrink_mini_window (w
);
8305 freeze_window_starts (f
, 1);
8306 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8309 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8313 if (old_current_buffer
)
8314 set_buffer_internal (old_current_buffer
);
8317 return window_height_changed_p
;
8321 /* Value is the current message, a string, or nil if there is no
8329 if (NILP (echo_area_buffer
[0]))
8333 with_echo_area_buffer (0, 0, current_message_1
,
8334 (EMACS_INT
) &msg
, Qnil
, 0, 0);
8336 echo_area_buffer
[0] = Qnil
;
8344 current_message_1 (a1
, a2
, a3
, a4
)
8349 Lisp_Object
*msg
= (Lisp_Object
*) a1
;
8352 *msg
= make_buffer_string (BEG
, Z
, 1);
8359 /* Push the current message on Vmessage_stack for later restauration
8360 by restore_message. Value is non-zero if the current message isn't
8361 empty. This is a relatively infrequent operation, so it's not
8362 worth optimizing. */
8368 msg
= current_message ();
8369 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
8370 return STRINGP (msg
);
8374 /* Restore message display from the top of Vmessage_stack. */
8381 xassert (CONSP (Vmessage_stack
));
8382 msg
= XCAR (Vmessage_stack
);
8384 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
8386 message3_nolog (msg
, 0, 0);
8390 /* Handler for record_unwind_protect calling pop_message. */
8393 pop_message_unwind (dummy
)
8400 /* Pop the top-most entry off Vmessage_stack. */
8405 xassert (CONSP (Vmessage_stack
));
8406 Vmessage_stack
= XCDR (Vmessage_stack
);
8410 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
8411 exits. If the stack is not empty, we have a missing pop_message
8415 check_message_stack ()
8417 if (!NILP (Vmessage_stack
))
8422 /* Truncate to NCHARS what will be displayed in the echo area the next
8423 time we display it---but don't redisplay it now. */
8426 truncate_echo_area (nchars
)
8430 echo_area_buffer
[0] = Qnil
;
8431 /* A null message buffer means that the frame hasn't really been
8432 initialized yet. Error messages get reported properly by
8433 cmd_error, so this must be just an informative message; toss it. */
8434 else if (!noninteractive
8436 && !NILP (echo_area_buffer
[0]))
8438 struct frame
*sf
= SELECTED_FRAME ();
8439 if (FRAME_MESSAGE_BUF (sf
))
8440 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
8445 /* Helper function for truncate_echo_area. Truncate the current
8446 message to at most NCHARS characters. */
8449 truncate_message_1 (nchars
, a2
, a3
, a4
)
8454 if (BEG
+ nchars
< Z
)
8455 del_range (BEG
+ nchars
, Z
);
8457 echo_area_buffer
[0] = Qnil
;
8462 /* Set the current message to a substring of S or STRING.
8464 If STRING is a Lisp string, set the message to the first NBYTES
8465 bytes from STRING. NBYTES zero means use the whole string. If
8466 STRING is multibyte, the message will be displayed multibyte.
8468 If S is not null, set the message to the first LEN bytes of S. LEN
8469 zero means use the whole string. MULTIBYTE_P non-zero means S is
8470 multibyte. Display the message multibyte in that case.
8472 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
8473 to t before calling set_message_1 (which calls insert).
8477 set_message (s
, string
, nbytes
, multibyte_p
)
8480 int nbytes
, multibyte_p
;
8482 message_enable_multibyte
8483 = ((s
&& multibyte_p
)
8484 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
8486 with_echo_area_buffer (0, 0, set_message_1
,
8487 (EMACS_INT
) s
, string
, nbytes
, multibyte_p
);
8488 message_buf_print
= 0;
8489 help_echo_showing_p
= 0;
8493 /* Helper function for set_message. Arguments have the same meaning
8494 as there, with A1 corresponding to S and A2 corresponding to STRING
8495 This function is called with the echo area buffer being
8499 set_message_1 (a1
, a2
, nbytes
, multibyte_p
)
8502 EMACS_INT nbytes
, multibyte_p
;
8504 const char *s
= (const char *) a1
;
8505 Lisp_Object string
= a2
;
8507 /* Change multibyteness of the echo buffer appropriately. */
8508 if (message_enable_multibyte
8509 != !NILP (current_buffer
->enable_multibyte_characters
))
8510 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
8512 current_buffer
->truncate_lines
= message_truncate_lines
? Qt
: Qnil
;
8514 /* Insert new message at BEG. */
8515 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8518 if (STRINGP (string
))
8523 nbytes
= SBYTES (string
);
8524 nchars
= string_byte_to_char (string
, nbytes
);
8526 /* This function takes care of single/multibyte conversion. We
8527 just have to ensure that the echo area buffer has the right
8528 setting of enable_multibyte_characters. */
8529 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
8534 nbytes
= strlen (s
);
8536 if (multibyte_p
&& NILP (current_buffer
->enable_multibyte_characters
))
8538 /* Convert from multi-byte to single-byte. */
8540 unsigned char work
[1];
8542 /* Convert a multibyte string to single-byte. */
8543 for (i
= 0; i
< nbytes
; i
+= n
)
8545 c
= string_char_and_length (s
+ i
, nbytes
- i
, &n
);
8546 work
[0] = (SINGLE_BYTE_CHAR_P (c
)
8548 : multibyte_char_to_unibyte (c
, Qnil
));
8549 insert_1_both (work
, 1, 1, 1, 0, 0);
8552 else if (!multibyte_p
8553 && !NILP (current_buffer
->enable_multibyte_characters
))
8555 /* Convert from single-byte to multi-byte. */
8557 const unsigned char *msg
= (const unsigned char *) s
;
8558 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
8560 /* Convert a single-byte string to multibyte. */
8561 for (i
= 0; i
< nbytes
; i
++)
8563 c
= unibyte_char_to_multibyte (msg
[i
]);
8564 n
= CHAR_STRING (c
, str
);
8565 insert_1_both (str
, 1, n
, 1, 0, 0);
8569 insert_1 (s
, nbytes
, 1, 0, 0);
8576 /* Clear messages. CURRENT_P non-zero means clear the current
8577 message. LAST_DISPLAYED_P non-zero means clear the message
8581 clear_message (current_p
, last_displayed_p
)
8582 int current_p
, last_displayed_p
;
8586 echo_area_buffer
[0] = Qnil
;
8587 message_cleared_p
= 1;
8590 if (last_displayed_p
)
8591 echo_area_buffer
[1] = Qnil
;
8593 message_buf_print
= 0;
8596 /* Clear garbaged frames.
8598 This function is used where the old redisplay called
8599 redraw_garbaged_frames which in turn called redraw_frame which in
8600 turn called clear_frame. The call to clear_frame was a source of
8601 flickering. I believe a clear_frame is not necessary. It should
8602 suffice in the new redisplay to invalidate all current matrices,
8603 and ensure a complete redisplay of all windows. */
8606 clear_garbaged_frames ()
8610 Lisp_Object tail
, frame
;
8611 int changed_count
= 0;
8613 FOR_EACH_FRAME (tail
, frame
)
8615 struct frame
*f
= XFRAME (frame
);
8617 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
8621 Fredraw_frame (frame
);
8622 f
->force_flush_display_p
= 1;
8624 clear_current_matrices (f
);
8633 ++windows_or_buffers_changed
;
8638 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
8639 is non-zero update selected_frame. Value is non-zero if the
8640 mini-windows height has been changed. */
8643 echo_area_display (update_frame_p
)
8646 Lisp_Object mini_window
;
8649 int window_height_changed_p
= 0;
8650 struct frame
*sf
= SELECTED_FRAME ();
8652 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8653 w
= XWINDOW (mini_window
);
8654 f
= XFRAME (WINDOW_FRAME (w
));
8656 /* Don't display if frame is invisible or not yet initialized. */
8657 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
8660 /* The terminal frame is used as the first Emacs frame on the Mac OS. */
8662 #ifdef HAVE_WINDOW_SYSTEM
8663 /* When Emacs starts, selected_frame may be a visible terminal
8664 frame, even if we run under a window system. If we let this
8665 through, a message would be displayed on the terminal. */
8666 if (EQ (selected_frame
, Vterminal_frame
)
8667 && !NILP (Vwindow_system
))
8669 #endif /* HAVE_WINDOW_SYSTEM */
8672 /* Redraw garbaged frames. */
8674 clear_garbaged_frames ();
8676 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
8678 echo_area_window
= mini_window
;
8679 window_height_changed_p
= display_echo_area (w
);
8680 w
->must_be_updated_p
= 1;
8682 /* Update the display, unless called from redisplay_internal.
8683 Also don't update the screen during redisplay itself. The
8684 update will happen at the end of redisplay, and an update
8685 here could cause confusion. */
8686 if (update_frame_p
&& !redisplaying_p
)
8690 /* If the display update has been interrupted by pending
8691 input, update mode lines in the frame. Due to the
8692 pending input, it might have been that redisplay hasn't
8693 been called, so that mode lines above the echo area are
8694 garbaged. This looks odd, so we prevent it here. */
8695 if (!display_completed
)
8696 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
8698 if (window_height_changed_p
8699 /* Don't do this if Emacs is shutting down. Redisplay
8700 needs to run hooks. */
8701 && !NILP (Vrun_hooks
))
8703 /* Must update other windows. Likewise as in other
8704 cases, don't let this update be interrupted by
8706 int count
= SPECPDL_INDEX ();
8707 specbind (Qredisplay_dont_pause
, Qt
);
8708 windows_or_buffers_changed
= 1;
8709 redisplay_internal (0);
8710 unbind_to (count
, Qnil
);
8712 else if (FRAME_WINDOW_P (f
) && n
== 0)
8714 /* Window configuration is the same as before.
8715 Can do with a display update of the echo area,
8716 unless we displayed some mode lines. */
8717 update_single_window (w
, 1);
8718 rif
->flush_display (f
);
8721 update_frame (f
, 1, 1);
8723 /* If cursor is in the echo area, make sure that the next
8724 redisplay displays the minibuffer, so that the cursor will
8725 be replaced with what the minibuffer wants. */
8726 if (cursor_in_echo_area
)
8727 ++windows_or_buffers_changed
;
8730 else if (!EQ (mini_window
, selected_window
))
8731 windows_or_buffers_changed
++;
8733 /* The current message is now also the last one displayed. */
8734 echo_area_buffer
[1] = echo_area_buffer
[0];
8736 /* Prevent redisplay optimization in redisplay_internal by resetting
8737 this_line_start_pos. This is done because the mini-buffer now
8738 displays the message instead of its buffer text. */
8739 if (EQ (mini_window
, selected_window
))
8740 CHARPOS (this_line_start_pos
) = 0;
8742 return window_height_changed_p
;
8747 /***********************************************************************
8748 Mode Lines and Frame Titles
8749 ***********************************************************************/
8751 /* A buffer for constructing non-propertized mode-line strings and
8752 frame titles in it; allocated from the heap in init_xdisp and
8753 resized as needed in store_mode_line_noprop_char. */
8755 static char *mode_line_noprop_buf
;
8757 /* The buffer's end, and a current output position in it. */
8759 static char *mode_line_noprop_buf_end
;
8760 static char *mode_line_noprop_ptr
;
8762 #define MODE_LINE_NOPROP_LEN(start) \
8763 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
8766 MODE_LINE_DISPLAY
= 0,
8772 /* Alist that caches the results of :propertize.
8773 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
8774 static Lisp_Object mode_line_proptrans_alist
;
8776 /* List of strings making up the mode-line. */
8777 static Lisp_Object mode_line_string_list
;
8779 /* Base face property when building propertized mode line string. */
8780 static Lisp_Object mode_line_string_face
;
8781 static Lisp_Object mode_line_string_face_prop
;
8784 /* Unwind data for mode line strings */
8786 static Lisp_Object Vmode_line_unwind_vector
;
8789 format_mode_line_unwind_data (obuf
, save_proptrans
)
8790 struct buffer
*obuf
;
8794 /* Reduce consing by keeping one vector in
8795 Vwith_echo_area_save_vector. */
8796 vector
= Vmode_line_unwind_vector
;
8797 Vmode_line_unwind_vector
= Qnil
;
8800 vector
= Fmake_vector (make_number (7), Qnil
);
8802 AREF (vector
, 0) = make_number (mode_line_target
);
8803 AREF (vector
, 1) = make_number (MODE_LINE_NOPROP_LEN (0));
8804 AREF (vector
, 2) = mode_line_string_list
;
8805 AREF (vector
, 3) = (save_proptrans
? mode_line_proptrans_alist
: Qt
);
8806 AREF (vector
, 4) = mode_line_string_face
;
8807 AREF (vector
, 5) = mode_line_string_face_prop
;
8810 XSETBUFFER (AREF (vector
, 6), obuf
);
8812 AREF (vector
, 6) = Qnil
;
8818 unwind_format_mode_line (vector
)
8821 mode_line_target
= XINT (AREF (vector
, 0));
8822 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
8823 mode_line_string_list
= AREF (vector
, 2);
8824 if (! EQ (AREF (vector
, 3), Qt
))
8825 mode_line_proptrans_alist
= AREF (vector
, 3);
8826 mode_line_string_face
= AREF (vector
, 4);
8827 mode_line_string_face_prop
= AREF (vector
, 5);
8829 if (!NILP (AREF (vector
, 6)))
8831 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
8832 AREF (vector
, 6) = Qnil
;
8835 Vmode_line_unwind_vector
= vector
;
8840 /* Store a single character C for the frame title in mode_line_noprop_buf.
8841 Re-allocate mode_line_noprop_buf if necessary. */
8845 store_mode_line_noprop_char (char c
)
8847 store_mode_line_noprop_char (c
)
8851 /* If output position has reached the end of the allocated buffer,
8852 double the buffer's size. */
8853 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
8855 int len
= MODE_LINE_NOPROP_LEN (0);
8856 int new_size
= 2 * len
* sizeof *mode_line_noprop_buf
;
8857 mode_line_noprop_buf
= (char *) xrealloc (mode_line_noprop_buf
, new_size
);
8858 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ new_size
;
8859 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
8862 *mode_line_noprop_ptr
++ = c
;
8866 /* Store part of a frame title in mode_line_noprop_buf, beginning at
8867 mode_line_noprop_ptr. STR is the string to store. Do not copy
8868 characters that yield more columns than PRECISION; PRECISION <= 0
8869 means copy the whole string. Pad with spaces until FIELD_WIDTH
8870 number of characters have been copied; FIELD_WIDTH <= 0 means don't
8871 pad. Called from display_mode_element when it is used to build a
8875 store_mode_line_noprop (str
, field_width
, precision
)
8876 const unsigned char *str
;
8877 int field_width
, precision
;
8882 /* Copy at most PRECISION chars from STR. */
8883 nbytes
= strlen (str
);
8884 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
8886 store_mode_line_noprop_char (*str
++);
8888 /* Fill up with spaces until FIELD_WIDTH reached. */
8889 while (field_width
> 0
8892 store_mode_line_noprop_char (' ');
8899 /***********************************************************************
8901 ***********************************************************************/
8903 #ifdef HAVE_WINDOW_SYSTEM
8905 /* Set the title of FRAME, if it has changed. The title format is
8906 Vicon_title_format if FRAME is iconified, otherwise it is
8907 frame_title_format. */
8910 x_consider_frame_title (frame
)
8913 struct frame
*f
= XFRAME (frame
);
8915 if (FRAME_WINDOW_P (f
)
8916 || FRAME_MINIBUF_ONLY_P (f
)
8917 || f
->explicit_name
)
8919 /* Do we have more than one visible frame on this X display? */
8926 int count
= SPECPDL_INDEX ();
8928 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
8930 Lisp_Object other_frame
= XCAR (tail
);
8931 struct frame
*tf
= XFRAME (other_frame
);
8934 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
8935 && !FRAME_MINIBUF_ONLY_P (tf
)
8936 && !EQ (other_frame
, tip_frame
)
8937 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
8941 /* Set global variable indicating that multiple frames exist. */
8942 multiple_frames
= CONSP (tail
);
8944 /* Switch to the buffer of selected window of the frame. Set up
8945 mode_line_target so that display_mode_element will output into
8946 mode_line_noprop_buf; then display the title. */
8947 record_unwind_protect (unwind_format_mode_line
,
8948 format_mode_line_unwind_data (current_buffer
, 0));
8950 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
8951 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
8953 mode_line_target
= MODE_LINE_TITLE
;
8954 title_start
= MODE_LINE_NOPROP_LEN (0);
8955 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
8956 NULL
, DEFAULT_FACE_ID
);
8957 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
8958 len
= MODE_LINE_NOPROP_LEN (title_start
);
8959 title
= mode_line_noprop_buf
+ title_start
;
8960 unbind_to (count
, Qnil
);
8962 /* Set the title only if it's changed. This avoids consing in
8963 the common case where it hasn't. (If it turns out that we've
8964 already wasted too much time by walking through the list with
8965 display_mode_element, then we might need to optimize at a
8966 higher level than this.) */
8967 if (! STRINGP (f
->name
)
8968 || SBYTES (f
->name
) != len
8969 || bcmp (title
, SDATA (f
->name
), len
) != 0)
8970 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
8974 #endif /* not HAVE_WINDOW_SYSTEM */
8979 /***********************************************************************
8981 ***********************************************************************/
8984 /* Prepare for redisplay by updating menu-bar item lists when
8985 appropriate. This can call eval. */
8988 prepare_menu_bars ()
8991 struct gcpro gcpro1
, gcpro2
;
8993 Lisp_Object tooltip_frame
;
8995 #ifdef HAVE_WINDOW_SYSTEM
8996 tooltip_frame
= tip_frame
;
8998 tooltip_frame
= Qnil
;
9001 /* Update all frame titles based on their buffer names, etc. We do
9002 this before the menu bars so that the buffer-menu will show the
9003 up-to-date frame titles. */
9004 #ifdef HAVE_WINDOW_SYSTEM
9005 if (windows_or_buffers_changed
|| update_mode_lines
)
9007 Lisp_Object tail
, frame
;
9009 FOR_EACH_FRAME (tail
, frame
)
9012 if (!EQ (frame
, tooltip_frame
)
9013 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
9014 x_consider_frame_title (frame
);
9017 #endif /* HAVE_WINDOW_SYSTEM */
9019 /* Update the menu bar item lists, if appropriate. This has to be
9020 done before any actual redisplay or generation of display lines. */
9021 all_windows
= (update_mode_lines
9022 || buffer_shared
> 1
9023 || windows_or_buffers_changed
);
9026 Lisp_Object tail
, frame
;
9027 int count
= SPECPDL_INDEX ();
9029 record_unwind_save_match_data ();
9031 FOR_EACH_FRAME (tail
, frame
)
9035 /* Ignore tooltip frame. */
9036 if (EQ (frame
, tooltip_frame
))
9039 /* If a window on this frame changed size, report that to
9040 the user and clear the size-change flag. */
9041 if (FRAME_WINDOW_SIZES_CHANGED (f
))
9043 Lisp_Object functions
;
9045 /* Clear flag first in case we get an error below. */
9046 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
9047 functions
= Vwindow_size_change_functions
;
9048 GCPRO2 (tail
, functions
);
9050 while (CONSP (functions
))
9052 call1 (XCAR (functions
), frame
);
9053 functions
= XCDR (functions
);
9059 update_menu_bar (f
, 0);
9060 #ifdef HAVE_WINDOW_SYSTEM
9061 update_tool_bar (f
, 0);
9063 mac_update_title_bar (f
, 0);
9069 unbind_to (count
, Qnil
);
9073 struct frame
*sf
= SELECTED_FRAME ();
9074 update_menu_bar (sf
, 1);
9075 #ifdef HAVE_WINDOW_SYSTEM
9076 update_tool_bar (sf
, 1);
9078 mac_update_title_bar (sf
, 1);
9083 /* Motif needs this. See comment in xmenu.c. Turn it off when
9084 pending_menu_activation is not defined. */
9085 #ifdef USE_X_TOOLKIT
9086 pending_menu_activation
= 0;
9091 /* Update the menu bar item list for frame F. This has to be done
9092 before we start to fill in any display lines, because it can call
9095 If SAVE_MATCH_DATA is non-zero, we must save and restore it here. */
9098 update_menu_bar (f
, save_match_data
)
9100 int save_match_data
;
9103 register struct window
*w
;
9105 /* If called recursively during a menu update, do nothing. This can
9106 happen when, for instance, an activate-menubar-hook causes a
9108 if (inhibit_menubar_update
)
9111 window
= FRAME_SELECTED_WINDOW (f
);
9112 w
= XWINDOW (window
);
9114 #if 0 /* The if statement below this if statement used to include the
9115 condition !NILP (w->update_mode_line), rather than using
9116 update_mode_lines directly, and this if statement may have
9117 been added to make that condition work. Now the if
9118 statement below matches its comment, this isn't needed. */
9119 if (update_mode_lines
)
9120 w
->update_mode_line
= Qt
;
9123 if (FRAME_WINDOW_P (f
)
9125 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
9126 || defined (USE_GTK)
9127 FRAME_EXTERNAL_MENU_BAR (f
)
9129 FRAME_MENU_BAR_LINES (f
) > 0
9131 : FRAME_MENU_BAR_LINES (f
) > 0)
9133 /* If the user has switched buffers or windows, we need to
9134 recompute to reflect the new bindings. But we'll
9135 recompute when update_mode_lines is set too; that means
9136 that people can use force-mode-line-update to request
9137 that the menu bar be recomputed. The adverse effect on
9138 the rest of the redisplay algorithm is about the same as
9139 windows_or_buffers_changed anyway. */
9140 if (windows_or_buffers_changed
9141 /* This used to test w->update_mode_line, but we believe
9142 there is no need to recompute the menu in that case. */
9143 || update_mode_lines
9144 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9145 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9146 != !NILP (w
->last_had_star
))
9147 || ((!NILP (Vtransient_mark_mode
)
9148 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
9149 != !NILP (w
->region_showing
)))
9151 struct buffer
*prev
= current_buffer
;
9152 int count
= SPECPDL_INDEX ();
9154 specbind (Qinhibit_menubar_update
, Qt
);
9156 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9157 if (save_match_data
)
9158 record_unwind_save_match_data ();
9159 if (NILP (Voverriding_local_map_menu_flag
))
9161 specbind (Qoverriding_terminal_local_map
, Qnil
);
9162 specbind (Qoverriding_local_map
, Qnil
);
9165 /* Run the Lucid hook. */
9166 safe_run_hooks (Qactivate_menubar_hook
);
9168 /* If it has changed current-menubar from previous value,
9169 really recompute the menu-bar from the value. */
9170 if (! NILP (Vlucid_menu_bar_dirty_flag
))
9171 call0 (Qrecompute_lucid_menubar
);
9173 safe_run_hooks (Qmenu_bar_update_hook
);
9174 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
9176 /* Redisplay the menu bar in case we changed it. */
9177 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
9178 || defined (USE_GTK)
9179 if (FRAME_WINDOW_P (f
))
9182 /* All frames on Mac OS share the same menubar. So only
9183 the selected frame should be allowed to set it. */
9184 if (f
== SELECTED_FRAME ())
9186 set_frame_menubar (f
, 0, 0);
9189 /* On a terminal screen, the menu bar is an ordinary screen
9190 line, and this makes it get updated. */
9191 w
->update_mode_line
= Qt
;
9192 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || MAC_OS || USE_GTK) */
9193 /* In the non-toolkit version, the menu bar is an ordinary screen
9194 line, and this makes it get updated. */
9195 w
->update_mode_line
= Qt
;
9196 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || MAC_OS || USE_GTK) */
9198 unbind_to (count
, Qnil
);
9199 set_buffer_internal_1 (prev
);
9206 /***********************************************************************
9208 ***********************************************************************/
9210 #ifdef HAVE_WINDOW_SYSTEM
9213 Nominal cursor position -- where to draw output.
9214 HPOS and VPOS are window relative glyph matrix coordinates.
9215 X and Y are window relative pixel coordinates. */
9217 struct cursor_pos output_cursor
;
9221 Set the global variable output_cursor to CURSOR. All cursor
9222 positions are relative to updated_window. */
9225 set_output_cursor (cursor
)
9226 struct cursor_pos
*cursor
;
9228 output_cursor
.hpos
= cursor
->hpos
;
9229 output_cursor
.vpos
= cursor
->vpos
;
9230 output_cursor
.x
= cursor
->x
;
9231 output_cursor
.y
= cursor
->y
;
9236 Set a nominal cursor position.
9238 HPOS and VPOS are column/row positions in a window glyph matrix. X
9239 and Y are window text area relative pixel positions.
9241 If this is done during an update, updated_window will contain the
9242 window that is being updated and the position is the future output
9243 cursor position for that window. If updated_window is null, use
9244 selected_window and display the cursor at the given position. */
9247 x_cursor_to (vpos
, hpos
, y
, x
)
9248 int vpos
, hpos
, y
, x
;
9252 /* If updated_window is not set, work on selected_window. */
9256 w
= XWINDOW (selected_window
);
9258 /* Set the output cursor. */
9259 output_cursor
.hpos
= hpos
;
9260 output_cursor
.vpos
= vpos
;
9261 output_cursor
.x
= x
;
9262 output_cursor
.y
= y
;
9264 /* If not called as part of an update, really display the cursor.
9265 This will also set the cursor position of W. */
9266 if (updated_window
== NULL
)
9269 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
9270 if (rif
->flush_display_optional
)
9271 rif
->flush_display_optional (SELECTED_FRAME ());
9276 #endif /* HAVE_WINDOW_SYSTEM */
9279 /***********************************************************************
9281 ***********************************************************************/
9283 #ifdef HAVE_WINDOW_SYSTEM
9285 /* Where the mouse was last time we reported a mouse event. */
9287 FRAME_PTR last_mouse_frame
;
9289 /* Tool-bar item index of the item on which a mouse button was pressed
9292 int last_tool_bar_item
;
9295 /* Update the tool-bar item list for frame F. This has to be done
9296 before we start to fill in any display lines. Called from
9297 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
9298 and restore it here. */
9301 update_tool_bar (f
, save_match_data
)
9303 int save_match_data
;
9306 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
9308 int do_update
= WINDOWP (f
->tool_bar_window
)
9309 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
9317 window
= FRAME_SELECTED_WINDOW (f
);
9318 w
= XWINDOW (window
);
9320 /* If the user has switched buffers or windows, we need to
9321 recompute to reflect the new bindings. But we'll
9322 recompute when update_mode_lines is set too; that means
9323 that people can use force-mode-line-update to request
9324 that the menu bar be recomputed. The adverse effect on
9325 the rest of the redisplay algorithm is about the same as
9326 windows_or_buffers_changed anyway. */
9327 if (windows_or_buffers_changed
9328 || !NILP (w
->update_mode_line
)
9329 || update_mode_lines
9330 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9331 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9332 != !NILP (w
->last_had_star
))
9333 || ((!NILP (Vtransient_mark_mode
)
9334 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
9335 != !NILP (w
->region_showing
)))
9337 struct buffer
*prev
= current_buffer
;
9338 int count
= SPECPDL_INDEX ();
9339 Lisp_Object new_tool_bar
;
9341 struct gcpro gcpro1
;
9343 /* Set current_buffer to the buffer of the selected
9344 window of the frame, so that we get the right local
9346 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9348 /* Save match data, if we must. */
9349 if (save_match_data
)
9350 record_unwind_save_match_data ();
9352 /* Make sure that we don't accidentally use bogus keymaps. */
9353 if (NILP (Voverriding_local_map_menu_flag
))
9355 specbind (Qoverriding_terminal_local_map
, Qnil
);
9356 specbind (Qoverriding_local_map
, Qnil
);
9359 GCPRO1 (new_tool_bar
);
9361 /* Build desired tool-bar items from keymaps. */
9362 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
9365 /* Redisplay the tool-bar if we changed it. */
9366 if (NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
9368 /* Redisplay that happens asynchronously due to an expose event
9369 may access f->tool_bar_items. Make sure we update both
9370 variables within BLOCK_INPUT so no such event interrupts. */
9372 f
->tool_bar_items
= new_tool_bar
;
9373 f
->n_tool_bar_items
= new_n_tool_bar
;
9374 w
->update_mode_line
= Qt
;
9380 unbind_to (count
, Qnil
);
9381 set_buffer_internal_1 (prev
);
9387 /* Set F->desired_tool_bar_string to a Lisp string representing frame
9388 F's desired tool-bar contents. F->tool_bar_items must have
9389 been set up previously by calling prepare_menu_bars. */
9392 build_desired_tool_bar_string (f
)
9395 int i
, size
, size_needed
;
9396 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9397 Lisp_Object image
, plist
, props
;
9399 image
= plist
= props
= Qnil
;
9400 GCPRO3 (image
, plist
, props
);
9402 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
9403 Otherwise, make a new string. */
9405 /* The size of the string we might be able to reuse. */
9406 size
= (STRINGP (f
->desired_tool_bar_string
)
9407 ? SCHARS (f
->desired_tool_bar_string
)
9410 /* We need one space in the string for each image. */
9411 size_needed
= f
->n_tool_bar_items
;
9413 /* Reuse f->desired_tool_bar_string, if possible. */
9414 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
9415 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
9419 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
9420 Fremove_text_properties (make_number (0), make_number (size
),
9421 props
, f
->desired_tool_bar_string
);
9424 /* Put a `display' property on the string for the images to display,
9425 put a `menu_item' property on tool-bar items with a value that
9426 is the index of the item in F's tool-bar item vector. */
9427 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
9429 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
9431 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
9432 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
9433 int hmargin
, vmargin
, relief
, idx
, end
;
9434 extern Lisp_Object QCrelief
, QCmargin
, QCconversion
;
9436 /* If image is a vector, choose the image according to the
9438 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
9439 if (VECTORP (image
))
9443 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
9444 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
9447 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
9448 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
9450 xassert (ASIZE (image
) >= idx
);
9451 image
= AREF (image
, idx
);
9456 /* Ignore invalid image specifications. */
9457 if (!valid_image_p (image
))
9460 /* Display the tool-bar button pressed, or depressed. */
9461 plist
= Fcopy_sequence (XCDR (image
));
9463 /* Compute margin and relief to draw. */
9464 relief
= (tool_bar_button_relief
>= 0
9465 ? tool_bar_button_relief
9466 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
9467 hmargin
= vmargin
= relief
;
9469 if (INTEGERP (Vtool_bar_button_margin
)
9470 && XINT (Vtool_bar_button_margin
) > 0)
9472 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
9473 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
9475 else if (CONSP (Vtool_bar_button_margin
))
9477 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
9478 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
9479 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
9481 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
9482 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
9483 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
9486 if (auto_raise_tool_bar_buttons_p
)
9488 /* Add a `:relief' property to the image spec if the item is
9492 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
9499 /* If image is selected, display it pressed, i.e. with a
9500 negative relief. If it's not selected, display it with a
9502 plist
= Fplist_put (plist
, QCrelief
,
9504 ? make_number (-relief
)
9505 : make_number (relief
)));
9510 /* Put a margin around the image. */
9511 if (hmargin
|| vmargin
)
9513 if (hmargin
== vmargin
)
9514 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
9516 plist
= Fplist_put (plist
, QCmargin
,
9517 Fcons (make_number (hmargin
),
9518 make_number (vmargin
)));
9521 /* If button is not enabled, and we don't have special images
9522 for the disabled state, make the image appear disabled by
9523 applying an appropriate algorithm to it. */
9524 if (!enabled_p
&& idx
< 0)
9525 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
9527 /* Put a `display' text property on the string for the image to
9528 display. Put a `menu-item' property on the string that gives
9529 the start of this item's properties in the tool-bar items
9531 image
= Fcons (Qimage
, plist
);
9532 props
= list4 (Qdisplay
, image
,
9533 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
9535 /* Let the last image hide all remaining spaces in the tool bar
9536 string. The string can be longer than needed when we reuse a
9538 if (i
+ 1 == f
->n_tool_bar_items
)
9539 end
= SCHARS (f
->desired_tool_bar_string
);
9542 Fadd_text_properties (make_number (i
), make_number (end
),
9543 props
, f
->desired_tool_bar_string
);
9551 /* Display one line of the tool-bar of frame IT->f.
9553 HEIGHT specifies the desired height of the tool-bar line.
9554 If the actual height of the glyph row is less than HEIGHT, the
9555 row's height is increased to HEIGHT, and the icons are centered
9556 vertically in the new height.
9558 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
9559 count a final empty row in case the tool-bar width exactly matches
9564 display_tool_bar_line (it
, height
)
9568 struct glyph_row
*row
= it
->glyph_row
;
9569 int max_x
= it
->last_visible_x
;
9572 prepare_desired_row (row
);
9573 row
->y
= it
->current_y
;
9575 /* Note that this isn't made use of if the face hasn't a box,
9576 so there's no need to check the face here. */
9577 it
->start_of_box_run_p
= 1;
9579 while (it
->current_x
< max_x
)
9581 int x
, n_glyphs_before
, i
, nglyphs
;
9582 struct it it_before
;
9584 /* Get the next display element. */
9585 if (!get_next_display_element (it
))
9587 /* Don't count empty row if we are counting needed tool-bar lines. */
9588 if (height
< 0 && !it
->hpos
)
9593 /* Produce glyphs. */
9594 n_glyphs_before
= row
->used
[TEXT_AREA
];
9597 PRODUCE_GLYPHS (it
);
9599 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
9601 x
= it_before
.current_x
;
9604 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
9606 if (x
+ glyph
->pixel_width
> max_x
)
9608 /* Glyph doesn't fit on line. Backtrack. */
9609 row
->used
[TEXT_AREA
] = n_glyphs_before
;
9611 /* If this is the only glyph on this line, it will never fit on the
9612 toolbar, so skip it. But ensure there is at least one glyph,
9613 so we don't accidentally disable the tool-bar. */
9614 if (n_glyphs_before
== 0
9615 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
9621 x
+= glyph
->pixel_width
;
9625 /* Stop at line ends. */
9626 if (ITERATOR_AT_END_OF_LINE_P (it
))
9629 set_iterator_to_next (it
, 1);
9634 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
9635 /* Use default face for the border below the tool bar. */
9636 if (!row
->displays_text_p
)
9637 it
->face_id
= DEFAULT_FACE_ID
;
9638 extend_face_to_end_of_line (it
);
9639 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
9640 last
->right_box_line_p
= 1;
9641 if (last
== row
->glyphs
[TEXT_AREA
])
9642 last
->left_box_line_p
= 1;
9644 /* Make line the desired height and center it vertically. */
9645 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
9647 /* Don't add more than one line height. */
9648 height
%= FRAME_LINE_HEIGHT (it
->f
);
9649 it
->max_ascent
+= height
/ 2;
9650 it
->max_descent
+= (height
+ 1) / 2;
9653 compute_line_metrics (it
);
9655 /* If line is empty, make it occupy the rest of the tool-bar. */
9656 if (!row
->displays_text_p
)
9658 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
9659 row
->ascent
= row
->phys_ascent
= 0;
9660 row
->extra_line_spacing
= 0;
9663 row
->full_width_p
= 1;
9664 row
->continued_p
= 0;
9665 row
->truncated_on_left_p
= 0;
9666 row
->truncated_on_right_p
= 0;
9668 it
->current_x
= it
->hpos
= 0;
9669 it
->current_y
+= row
->height
;
9675 /* Max tool-bar height. */
9677 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
9678 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
9680 /* Value is the number of screen lines needed to make all tool-bar
9681 items of frame F visible. The number of actual rows needed is
9682 returned in *N_ROWS if non-NULL. */
9685 tool_bar_lines_needed (f
, n_rows
)
9689 struct window
*w
= XWINDOW (f
->tool_bar_window
);
9691 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
9692 the desired matrix, so use (unused) mode-line row as temporary row to
9693 avoid destroying the first tool-bar row. */
9694 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
9696 /* Initialize an iterator for iteration over
9697 F->desired_tool_bar_string in the tool-bar window of frame F. */
9698 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
9699 it
.first_visible_x
= 0;
9700 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
9701 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
9703 while (!ITERATOR_AT_END_P (&it
))
9705 clear_glyph_row (temp_row
);
9706 it
.glyph_row
= temp_row
;
9707 display_tool_bar_line (&it
, -1);
9709 clear_glyph_row (temp_row
);
9711 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
9713 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
9715 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
9719 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
9721 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
9730 frame
= selected_frame
;
9732 CHECK_FRAME (frame
);
9735 if (WINDOWP (f
->tool_bar_window
)
9736 || (w
= XWINDOW (f
->tool_bar_window
),
9737 WINDOW_TOTAL_LINES (w
) > 0))
9739 update_tool_bar (f
, 1);
9740 if (f
->n_tool_bar_items
)
9742 build_desired_tool_bar_string (f
);
9743 nlines
= tool_bar_lines_needed (f
, NULL
);
9747 return make_number (nlines
);
9751 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
9752 height should be changed. */
9755 redisplay_tool_bar (f
)
9760 struct glyph_row
*row
;
9761 int change_height_p
= 0;
9764 if (FRAME_EXTERNAL_TOOL_BAR (f
))
9765 update_frame_tool_bar (f
);
9769 /* If frame hasn't a tool-bar window or if it is zero-height, don't
9770 do anything. This means you must start with tool-bar-lines
9771 non-zero to get the auto-sizing effect. Or in other words, you
9772 can turn off tool-bars by specifying tool-bar-lines zero. */
9773 if (!WINDOWP (f
->tool_bar_window
)
9774 || (w
= XWINDOW (f
->tool_bar_window
),
9775 WINDOW_TOTAL_LINES (w
) == 0))
9778 /* Set up an iterator for the tool-bar window. */
9779 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
9780 it
.first_visible_x
= 0;
9781 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
9784 /* Build a string that represents the contents of the tool-bar. */
9785 build_desired_tool_bar_string (f
);
9786 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
9788 if (f
->n_tool_bar_rows
== 0)
9792 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
9793 nlines
!= WINDOW_TOTAL_LINES (w
)))
9795 extern Lisp_Object Qtool_bar_lines
;
9797 int old_height
= WINDOW_TOTAL_LINES (w
);
9799 XSETFRAME (frame
, f
);
9800 Fmodify_frame_parameters (frame
,
9801 Fcons (Fcons (Qtool_bar_lines
,
9802 make_number (nlines
)),
9804 if (WINDOW_TOTAL_LINES (w
) != old_height
)
9806 clear_glyph_matrix (w
->desired_matrix
);
9807 fonts_changed_p
= 1;
9813 /* Display as many lines as needed to display all tool-bar items. */
9815 if (f
->n_tool_bar_rows
> 0)
9817 int border
, rows
, height
, extra
;
9819 if (INTEGERP (Vtool_bar_border
))
9820 border
= XINT (Vtool_bar_border
);
9821 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
9822 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
9823 else if (EQ (Vtool_bar_border
, Qborder_width
))
9824 border
= f
->border_width
;
9830 rows
= f
->n_tool_bar_rows
;
9831 height
= max (1, (it
.last_visible_y
- border
) / rows
);
9832 extra
= it
.last_visible_y
- border
- height
* rows
;
9834 while (it
.current_y
< it
.last_visible_y
)
9837 if (extra
> 0 && rows
-- > 0)
9839 h
= (extra
+ rows
- 1) / rows
;
9842 display_tool_bar_line (&it
, height
+ h
);
9847 while (it
.current_y
< it
.last_visible_y
)
9848 display_tool_bar_line (&it
, 0);
9851 /* It doesn't make much sense to try scrolling in the tool-bar
9852 window, so don't do it. */
9853 w
->desired_matrix
->no_scrolling_p
= 1;
9854 w
->must_be_updated_p
= 1;
9856 if (auto_resize_tool_bars_p
)
9859 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
9861 /* If we couldn't display everything, change the tool-bar's
9862 height if there is room for more. */
9863 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
9864 && it
.current_y
< max_tool_bar_height
)
9865 change_height_p
= 1;
9867 row
= it
.glyph_row
- 1;
9869 /* If there are blank lines at the end, except for a partially
9870 visible blank line at the end that is smaller than
9871 FRAME_LINE_HEIGHT, change the tool-bar's height. */
9872 if (!row
->displays_text_p
9873 && row
->height
>= FRAME_LINE_HEIGHT (f
))
9874 change_height_p
= 1;
9876 /* If row displays tool-bar items, but is partially visible,
9877 change the tool-bar's height. */
9878 if (row
->displays_text_p
9879 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
9880 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
9881 change_height_p
= 1;
9883 /* Resize windows as needed by changing the `tool-bar-lines'
9886 && (nlines
= tool_bar_lines_needed (f
, &nrows
),
9887 nlines
!= WINDOW_TOTAL_LINES (w
)))
9889 extern Lisp_Object Qtool_bar_lines
;
9891 int old_height
= WINDOW_TOTAL_LINES (w
);
9893 XSETFRAME (frame
, f
);
9894 Fmodify_frame_parameters (frame
,
9895 Fcons (Fcons (Qtool_bar_lines
,
9896 make_number (nlines
)),
9898 if (WINDOW_TOTAL_LINES (w
) != old_height
)
9900 clear_glyph_matrix (w
->desired_matrix
);
9901 f
->n_tool_bar_rows
= nrows
;
9902 fonts_changed_p
= 1;
9907 return change_height_p
;
9911 /* Get information about the tool-bar item which is displayed in GLYPH
9912 on frame F. Return in *PROP_IDX the index where tool-bar item
9913 properties start in F->tool_bar_items. Value is zero if
9914 GLYPH doesn't display a tool-bar item. */
9917 tool_bar_item_info (f
, glyph
, prop_idx
)
9919 struct glyph
*glyph
;
9926 /* This function can be called asynchronously, which means we must
9927 exclude any possibility that Fget_text_property signals an
9929 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
9930 charpos
= max (0, charpos
);
9932 /* Get the text property `menu-item' at pos. The value of that
9933 property is the start index of this item's properties in
9934 F->tool_bar_items. */
9935 prop
= Fget_text_property (make_number (charpos
),
9936 Qmenu_item
, f
->current_tool_bar_string
);
9937 if (INTEGERP (prop
))
9939 *prop_idx
= XINT (prop
);
9949 /* Get information about the tool-bar item at position X/Y on frame F.
9950 Return in *GLYPH a pointer to the glyph of the tool-bar item in
9951 the current matrix of the tool-bar window of F, or NULL if not
9952 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
9953 item in F->tool_bar_items. Value is
9955 -1 if X/Y is not on a tool-bar item
9956 0 if X/Y is on the same item that was highlighted before.
9960 get_tool_bar_item (f
, x
, y
, glyph
, hpos
, vpos
, prop_idx
)
9963 struct glyph
**glyph
;
9964 int *hpos
, *vpos
, *prop_idx
;
9966 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
9967 struct window
*w
= XWINDOW (f
->tool_bar_window
);
9970 /* Find the glyph under X/Y. */
9971 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
9975 /* Get the start of this tool-bar item's properties in
9976 f->tool_bar_items. */
9977 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
9980 /* Is mouse on the highlighted item? */
9981 if (EQ (f
->tool_bar_window
, dpyinfo
->mouse_face_window
)
9982 && *vpos
>= dpyinfo
->mouse_face_beg_row
9983 && *vpos
<= dpyinfo
->mouse_face_end_row
9984 && (*vpos
> dpyinfo
->mouse_face_beg_row
9985 || *hpos
>= dpyinfo
->mouse_face_beg_col
)
9986 && (*vpos
< dpyinfo
->mouse_face_end_row
9987 || *hpos
< dpyinfo
->mouse_face_end_col
9988 || dpyinfo
->mouse_face_past_end
))
9996 Handle mouse button event on the tool-bar of frame F, at
9997 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
9998 0 for button release. MODIFIERS is event modifiers for button
10002 handle_tool_bar_click (f
, x
, y
, down_p
, modifiers
)
10005 unsigned int modifiers
;
10007 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10008 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10009 int hpos
, vpos
, prop_idx
;
10010 struct glyph
*glyph
;
10011 Lisp_Object enabled_p
;
10013 /* If not on the highlighted tool-bar item, return. */
10014 frame_to_window_pixel_xy (w
, &x
, &y
);
10015 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
10018 /* If item is disabled, do nothing. */
10019 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10020 if (NILP (enabled_p
))
10025 /* Show item in pressed state. */
10026 show_mouse_face (dpyinfo
, DRAW_IMAGE_SUNKEN
);
10027 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
10028 last_tool_bar_item
= prop_idx
;
10032 Lisp_Object key
, frame
;
10033 struct input_event event
;
10034 EVENT_INIT (event
);
10036 /* Show item in released state. */
10037 show_mouse_face (dpyinfo
, DRAW_IMAGE_RAISED
);
10038 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
10040 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
10042 XSETFRAME (frame
, f
);
10043 event
.kind
= TOOL_BAR_EVENT
;
10044 event
.frame_or_window
= frame
;
10046 kbd_buffer_store_event (&event
);
10048 event
.kind
= TOOL_BAR_EVENT
;
10049 event
.frame_or_window
= frame
;
10051 event
.modifiers
= modifiers
;
10052 kbd_buffer_store_event (&event
);
10053 last_tool_bar_item
= -1;
10058 /* Possibly highlight a tool-bar item on frame F when mouse moves to
10059 tool-bar window-relative coordinates X/Y. Called from
10060 note_mouse_highlight. */
10063 note_tool_bar_highlight (f
, x
, y
)
10067 Lisp_Object window
= f
->tool_bar_window
;
10068 struct window
*w
= XWINDOW (window
);
10069 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10071 struct glyph
*glyph
;
10072 struct glyph_row
*row
;
10074 Lisp_Object enabled_p
;
10076 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
10077 int mouse_down_p
, rc
;
10079 /* Function note_mouse_highlight is called with negative x(y
10080 values when mouse moves outside of the frame. */
10081 if (x
<= 0 || y
<= 0)
10083 clear_mouse_face (dpyinfo
);
10087 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
10090 /* Not on tool-bar item. */
10091 clear_mouse_face (dpyinfo
);
10095 /* On same tool-bar item as before. */
10096 goto set_help_echo
;
10098 clear_mouse_face (dpyinfo
);
10100 /* Mouse is down, but on different tool-bar item? */
10101 mouse_down_p
= (dpyinfo
->grabbed
10102 && f
== last_mouse_frame
10103 && FRAME_LIVE_P (f
));
10105 && last_tool_bar_item
!= prop_idx
)
10108 dpyinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
10109 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
10111 /* If tool-bar item is not enabled, don't highlight it. */
10112 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10113 if (!NILP (enabled_p
))
10115 /* Compute the x-position of the glyph. In front and past the
10116 image is a space. We include this in the highlighted area. */
10117 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
10118 for (i
= x
= 0; i
< hpos
; ++i
)
10119 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
10121 /* Record this as the current active region. */
10122 dpyinfo
->mouse_face_beg_col
= hpos
;
10123 dpyinfo
->mouse_face_beg_row
= vpos
;
10124 dpyinfo
->mouse_face_beg_x
= x
;
10125 dpyinfo
->mouse_face_beg_y
= row
->y
;
10126 dpyinfo
->mouse_face_past_end
= 0;
10128 dpyinfo
->mouse_face_end_col
= hpos
+ 1;
10129 dpyinfo
->mouse_face_end_row
= vpos
;
10130 dpyinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
10131 dpyinfo
->mouse_face_end_y
= row
->y
;
10132 dpyinfo
->mouse_face_window
= window
;
10133 dpyinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
10135 /* Display it as active. */
10136 show_mouse_face (dpyinfo
, draw
);
10137 dpyinfo
->mouse_face_image_state
= draw
;
10142 /* Set help_echo_string to a help string to display for this tool-bar item.
10143 XTread_socket does the rest. */
10144 help_echo_object
= help_echo_window
= Qnil
;
10145 help_echo_pos
= -1;
10146 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
10147 if (NILP (help_echo_string
))
10148 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
10151 #endif /* HAVE_WINDOW_SYSTEM */
10155 /************************************************************************
10156 Horizontal scrolling
10157 ************************************************************************/
10159 static int hscroll_window_tree
P_ ((Lisp_Object
));
10160 static int hscroll_windows
P_ ((Lisp_Object
));
10162 /* For all leaf windows in the window tree rooted at WINDOW, set their
10163 hscroll value so that PT is (i) visible in the window, and (ii) so
10164 that it is not within a certain margin at the window's left and
10165 right border. Value is non-zero if any window's hscroll has been
10169 hscroll_window_tree (window
)
10170 Lisp_Object window
;
10172 int hscrolled_p
= 0;
10173 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
10174 int hscroll_step_abs
= 0;
10175 double hscroll_step_rel
= 0;
10177 if (hscroll_relative_p
)
10179 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
10180 if (hscroll_step_rel
< 0)
10182 hscroll_relative_p
= 0;
10183 hscroll_step_abs
= 0;
10186 else if (INTEGERP (Vhscroll_step
))
10188 hscroll_step_abs
= XINT (Vhscroll_step
);
10189 if (hscroll_step_abs
< 0)
10190 hscroll_step_abs
= 0;
10193 hscroll_step_abs
= 0;
10195 while (WINDOWP (window
))
10197 struct window
*w
= XWINDOW (window
);
10199 if (WINDOWP (w
->hchild
))
10200 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
10201 else if (WINDOWP (w
->vchild
))
10202 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
10203 else if (w
->cursor
.vpos
>= 0)
10206 int text_area_width
;
10207 struct glyph_row
*current_cursor_row
10208 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
10209 struct glyph_row
*desired_cursor_row
10210 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
10211 struct glyph_row
*cursor_row
10212 = (desired_cursor_row
->enabled_p
10213 ? desired_cursor_row
10214 : current_cursor_row
);
10216 text_area_width
= window_box_width (w
, TEXT_AREA
);
10218 /* Scroll when cursor is inside this scroll margin. */
10219 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
10221 if ((XFASTINT (w
->hscroll
)
10222 && w
->cursor
.x
<= h_margin
)
10223 || (cursor_row
->enabled_p
10224 && cursor_row
->truncated_on_right_p
10225 && (w
->cursor
.x
>= text_area_width
- h_margin
)))
10229 struct buffer
*saved_current_buffer
;
10233 /* Find point in a display of infinite width. */
10234 saved_current_buffer
= current_buffer
;
10235 current_buffer
= XBUFFER (w
->buffer
);
10237 if (w
== XWINDOW (selected_window
))
10238 pt
= BUF_PT (current_buffer
);
10241 pt
= marker_position (w
->pointm
);
10242 pt
= max (BEGV
, pt
);
10246 /* Move iterator to pt starting at cursor_row->start in
10247 a line with infinite width. */
10248 init_to_row_start (&it
, w
, cursor_row
);
10249 it
.last_visible_x
= INFINITY
;
10250 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
10251 current_buffer
= saved_current_buffer
;
10253 /* Position cursor in window. */
10254 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
10255 hscroll
= max (0, (it
.current_x
10256 - (ITERATOR_AT_END_OF_LINE_P (&it
)
10257 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
10258 : (text_area_width
/ 2))))
10259 / FRAME_COLUMN_WIDTH (it
.f
);
10260 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
10262 if (hscroll_relative_p
)
10263 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
10266 wanted_x
= text_area_width
10267 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10270 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10274 if (hscroll_relative_p
)
10275 wanted_x
= text_area_width
* hscroll_step_rel
10278 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10281 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10283 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
10285 /* Don't call Fset_window_hscroll if value hasn't
10286 changed because it will prevent redisplay
10288 if (XFASTINT (w
->hscroll
) != hscroll
)
10290 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
10291 w
->hscroll
= make_number (hscroll
);
10300 /* Value is non-zero if hscroll of any leaf window has been changed. */
10301 return hscrolled_p
;
10305 /* Set hscroll so that cursor is visible and not inside horizontal
10306 scroll margins for all windows in the tree rooted at WINDOW. See
10307 also hscroll_window_tree above. Value is non-zero if any window's
10308 hscroll has been changed. If it has, desired matrices on the frame
10309 of WINDOW are cleared. */
10312 hscroll_windows (window
)
10313 Lisp_Object window
;
10317 if (automatic_hscrolling_p
)
10319 hscrolled_p
= hscroll_window_tree (window
);
10321 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
10325 return hscrolled_p
;
10330 /************************************************************************
10332 ************************************************************************/
10334 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
10335 to a non-zero value. This is sometimes handy to have in a debugger
10340 /* First and last unchanged row for try_window_id. */
10342 int debug_first_unchanged_at_end_vpos
;
10343 int debug_last_unchanged_at_beg_vpos
;
10345 /* Delta vpos and y. */
10347 int debug_dvpos
, debug_dy
;
10349 /* Delta in characters and bytes for try_window_id. */
10351 int debug_delta
, debug_delta_bytes
;
10353 /* Values of window_end_pos and window_end_vpos at the end of
10356 EMACS_INT debug_end_pos
, debug_end_vpos
;
10358 /* Append a string to W->desired_matrix->method. FMT is a printf
10359 format string. A1...A9 are a supplement for a variable-length
10360 argument list. If trace_redisplay_p is non-zero also printf the
10361 resulting string to stderr. */
10364 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
10367 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
10370 char *method
= w
->desired_matrix
->method
;
10371 int len
= strlen (method
);
10372 int size
= sizeof w
->desired_matrix
->method
;
10373 int remaining
= size
- len
- 1;
10375 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
10376 if (len
&& remaining
)
10379 --remaining
, ++len
;
10382 strncpy (method
+ len
, buffer
, remaining
);
10384 if (trace_redisplay_p
)
10385 fprintf (stderr
, "%p (%s): %s\n",
10387 ((BUFFERP (w
->buffer
)
10388 && STRINGP (XBUFFER (w
->buffer
)->name
))
10389 ? (char *) SDATA (XBUFFER (w
->buffer
)->name
)
10394 #endif /* GLYPH_DEBUG */
10397 /* Value is non-zero if all changes in window W, which displays
10398 current_buffer, are in the text between START and END. START is a
10399 buffer position, END is given as a distance from Z. Used in
10400 redisplay_internal for display optimization. */
10403 text_outside_line_unchanged_p (w
, start
, end
)
10407 int unchanged_p
= 1;
10409 /* If text or overlays have changed, see where. */
10410 if (XFASTINT (w
->last_modified
) < MODIFF
10411 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
10413 /* Gap in the line? */
10414 if (GPT
< start
|| Z
- GPT
< end
)
10417 /* Changes start in front of the line, or end after it? */
10419 && (BEG_UNCHANGED
< start
- 1
10420 || END_UNCHANGED
< end
))
10423 /* If selective display, can't optimize if changes start at the
10424 beginning of the line. */
10426 && INTEGERP (current_buffer
->selective_display
)
10427 && XINT (current_buffer
->selective_display
) > 0
10428 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
10431 /* If there are overlays at the start or end of the line, these
10432 may have overlay strings with newlines in them. A change at
10433 START, for instance, may actually concern the display of such
10434 overlay strings as well, and they are displayed on different
10435 lines. So, quickly rule out this case. (For the future, it
10436 might be desirable to implement something more telling than
10437 just BEG/END_UNCHANGED.) */
10440 if (BEG
+ BEG_UNCHANGED
== start
10441 && overlay_touches_p (start
))
10443 if (END_UNCHANGED
== end
10444 && overlay_touches_p (Z
- end
))
10449 return unchanged_p
;
10453 /* Do a frame update, taking possible shortcuts into account. This is
10454 the main external entry point for redisplay.
10456 If the last redisplay displayed an echo area message and that message
10457 is no longer requested, we clear the echo area or bring back the
10458 mini-buffer if that is in use. */
10463 redisplay_internal (0);
10468 overlay_arrow_string_or_property (var
)
10473 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
10476 return Voverlay_arrow_string
;
10479 /* Return 1 if there are any overlay-arrows in current_buffer. */
10481 overlay_arrow_in_current_buffer_p ()
10485 for (vlist
= Voverlay_arrow_variable_list
;
10487 vlist
= XCDR (vlist
))
10489 Lisp_Object var
= XCAR (vlist
);
10492 if (!SYMBOLP (var
))
10494 val
= find_symbol_value (var
);
10496 && current_buffer
== XMARKER (val
)->buffer
)
10503 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
10507 overlay_arrows_changed_p ()
10511 for (vlist
= Voverlay_arrow_variable_list
;
10513 vlist
= XCDR (vlist
))
10515 Lisp_Object var
= XCAR (vlist
);
10516 Lisp_Object val
, pstr
;
10518 if (!SYMBOLP (var
))
10520 val
= find_symbol_value (var
);
10521 if (!MARKERP (val
))
10523 if (! EQ (COERCE_MARKER (val
),
10524 Fget (var
, Qlast_arrow_position
))
10525 || ! (pstr
= overlay_arrow_string_or_property (var
),
10526 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
10532 /* Mark overlay arrows to be updated on next redisplay. */
10535 update_overlay_arrows (up_to_date
)
10540 for (vlist
= Voverlay_arrow_variable_list
;
10542 vlist
= XCDR (vlist
))
10544 Lisp_Object var
= XCAR (vlist
);
10546 if (!SYMBOLP (var
))
10549 if (up_to_date
> 0)
10551 Lisp_Object val
= find_symbol_value (var
);
10552 Fput (var
, Qlast_arrow_position
,
10553 COERCE_MARKER (val
));
10554 Fput (var
, Qlast_arrow_string
,
10555 overlay_arrow_string_or_property (var
));
10557 else if (up_to_date
< 0
10558 || !NILP (Fget (var
, Qlast_arrow_position
)))
10560 Fput (var
, Qlast_arrow_position
, Qt
);
10561 Fput (var
, Qlast_arrow_string
, Qt
);
10567 /* Return overlay arrow string to display at row.
10568 Return integer (bitmap number) for arrow bitmap in left fringe.
10569 Return nil if no overlay arrow. */
10572 overlay_arrow_at_row (it
, row
)
10574 struct glyph_row
*row
;
10578 for (vlist
= Voverlay_arrow_variable_list
;
10580 vlist
= XCDR (vlist
))
10582 Lisp_Object var
= XCAR (vlist
);
10585 if (!SYMBOLP (var
))
10588 val
= find_symbol_value (var
);
10591 && current_buffer
== XMARKER (val
)->buffer
10592 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
10594 if (FRAME_WINDOW_P (it
->f
)
10595 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
10597 #ifdef HAVE_WINDOW_SYSTEM
10598 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
10601 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
10602 return make_number (fringe_bitmap
);
10605 return make_number (-1); /* Use default arrow bitmap */
10607 return overlay_arrow_string_or_property (var
);
10614 /* Return 1 if point moved out of or into a composition. Otherwise
10615 return 0. PREV_BUF and PREV_PT are the last point buffer and
10616 position. BUF and PT are the current point buffer and position. */
10619 check_point_in_composition (prev_buf
, prev_pt
, buf
, pt
)
10620 struct buffer
*prev_buf
, *buf
;
10625 Lisp_Object buffer
;
10627 XSETBUFFER (buffer
, buf
);
10628 /* Check a composition at the last point if point moved within the
10630 if (prev_buf
== buf
)
10633 /* Point didn't move. */
10636 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
10637 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
10638 && COMPOSITION_VALID_P (start
, end
, prop
)
10639 && start
< prev_pt
&& end
> prev_pt
)
10640 /* The last point was within the composition. Return 1 iff
10641 point moved out of the composition. */
10642 return (pt
<= start
|| pt
>= end
);
10645 /* Check a composition at the current point. */
10646 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
10647 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
10648 && COMPOSITION_VALID_P (start
, end
, prop
)
10649 && start
< pt
&& end
> pt
);
10653 /* Reconsider the setting of B->clip_changed which is displayed
10657 reconsider_clip_changes (w
, b
)
10661 if (b
->clip_changed
10662 && !NILP (w
->window_end_valid
)
10663 && w
->current_matrix
->buffer
== b
10664 && w
->current_matrix
->zv
== BUF_ZV (b
)
10665 && w
->current_matrix
->begv
== BUF_BEGV (b
))
10666 b
->clip_changed
= 0;
10668 /* If display wasn't paused, and W is not a tool bar window, see if
10669 point has been moved into or out of a composition. In that case,
10670 we set b->clip_changed to 1 to force updating the screen. If
10671 b->clip_changed has already been set to 1, we can skip this
10673 if (!b
->clip_changed
10674 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
10678 if (w
== XWINDOW (selected_window
))
10679 pt
= BUF_PT (current_buffer
);
10681 pt
= marker_position (w
->pointm
);
10683 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
10684 || pt
!= XINT (w
->last_point
))
10685 && check_point_in_composition (w
->current_matrix
->buffer
,
10686 XINT (w
->last_point
),
10687 XBUFFER (w
->buffer
), pt
))
10688 b
->clip_changed
= 1;
10693 /* Select FRAME to forward the values of frame-local variables into C
10694 variables so that the redisplay routines can access those values
10698 select_frame_for_redisplay (frame
)
10701 Lisp_Object tail
, sym
, val
;
10702 Lisp_Object old
= selected_frame
;
10704 selected_frame
= frame
;
10706 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
10707 if (CONSP (XCAR (tail
))
10708 && (sym
= XCAR (XCAR (tail
)),
10710 && (sym
= indirect_variable (sym
),
10711 val
= SYMBOL_VALUE (sym
),
10712 (BUFFER_LOCAL_VALUEP (val
)
10713 || SOME_BUFFER_LOCAL_VALUEP (val
)))
10714 && XBUFFER_LOCAL_VALUE (val
)->check_frame
)
10715 /* Use find_symbol_value rather than Fsymbol_value
10716 to avoid an error if it is void. */
10717 find_symbol_value (sym
);
10719 for (tail
= XFRAME (old
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
10720 if (CONSP (XCAR (tail
))
10721 && (sym
= XCAR (XCAR (tail
)),
10723 && (sym
= indirect_variable (sym
),
10724 val
= SYMBOL_VALUE (sym
),
10725 (BUFFER_LOCAL_VALUEP (val
)
10726 || SOME_BUFFER_LOCAL_VALUEP (val
)))
10727 && XBUFFER_LOCAL_VALUE (val
)->check_frame
)
10728 find_symbol_value (sym
);
10732 #define STOP_POLLING \
10733 do { if (! polling_stopped_here) stop_polling (); \
10734 polling_stopped_here = 1; } while (0)
10736 #define RESUME_POLLING \
10737 do { if (polling_stopped_here) start_polling (); \
10738 polling_stopped_here = 0; } while (0)
10741 /* If PRESERVE_ECHO_AREA is nonzero, it means this redisplay is not in
10742 response to any user action; therefore, we should preserve the echo
10743 area. (Actually, our caller does that job.) Perhaps in the future
10744 avoid recentering windows if it is not necessary; currently that
10745 causes some problems. */
10748 redisplay_internal (preserve_echo_area
)
10749 int preserve_echo_area
;
10751 struct window
*w
= XWINDOW (selected_window
);
10752 struct frame
*f
= XFRAME (w
->frame
);
10754 int must_finish
= 0;
10755 struct text_pos tlbufpos
, tlendpos
;
10756 int number_of_visible_frames
;
10758 struct frame
*sf
= SELECTED_FRAME ();
10759 int polling_stopped_here
= 0;
10761 /* Non-zero means redisplay has to consider all windows on all
10762 frames. Zero means, only selected_window is considered. */
10763 int consider_all_windows_p
;
10765 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
10767 /* No redisplay if running in batch mode or frame is not yet fully
10768 initialized, or redisplay is explicitly turned off by setting
10769 Vinhibit_redisplay. */
10771 || !NILP (Vinhibit_redisplay
)
10772 || !f
->glyphs_initialized_p
)
10775 /* The flag redisplay_performed_directly_p is set by
10776 direct_output_for_insert when it already did the whole screen
10777 update necessary. */
10778 if (redisplay_performed_directly_p
)
10780 redisplay_performed_directly_p
= 0;
10781 if (!hscroll_windows (selected_window
))
10785 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
10786 if (popup_activated ())
10790 /* I don't think this happens but let's be paranoid. */
10791 if (redisplaying_p
)
10794 /* Record a function that resets redisplaying_p to its old value
10795 when we leave this function. */
10796 count
= SPECPDL_INDEX ();
10797 record_unwind_protect (unwind_redisplay
,
10798 Fcons (make_number (redisplaying_p
), selected_frame
));
10800 specbind (Qinhibit_free_realized_faces
, Qnil
);
10803 Lisp_Object tail
, frame
;
10805 FOR_EACH_FRAME (tail
, frame
)
10807 struct frame
*f
= XFRAME (frame
);
10808 f
->already_hscrolled_p
= 0;
10814 reconsider_clip_changes (w
, current_buffer
);
10815 last_escape_glyph_frame
= NULL
;
10816 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
10818 /* If new fonts have been loaded that make a glyph matrix adjustment
10819 necessary, do it. */
10820 if (fonts_changed_p
)
10822 adjust_glyphs (NULL
);
10823 ++windows_or_buffers_changed
;
10824 fonts_changed_p
= 0;
10827 /* If face_change_count is non-zero, init_iterator will free all
10828 realized faces, which includes the faces referenced from current
10829 matrices. So, we can't reuse current matrices in this case. */
10830 if (face_change_count
)
10831 ++windows_or_buffers_changed
;
10833 if (! FRAME_WINDOW_P (sf
)
10834 && previous_terminal_frame
!= sf
)
10836 /* Since frames on an ASCII terminal share the same display
10837 area, displaying a different frame means redisplay the whole
10839 windows_or_buffers_changed
++;
10840 SET_FRAME_GARBAGED (sf
);
10841 XSETFRAME (Vterminal_frame
, sf
);
10843 previous_terminal_frame
= sf
;
10845 /* Set the visible flags for all frames. Do this before checking
10846 for resized or garbaged frames; they want to know if their frames
10847 are visible. See the comment in frame.h for
10848 FRAME_SAMPLE_VISIBILITY. */
10850 Lisp_Object tail
, frame
;
10852 number_of_visible_frames
= 0;
10854 FOR_EACH_FRAME (tail
, frame
)
10856 struct frame
*f
= XFRAME (frame
);
10858 FRAME_SAMPLE_VISIBILITY (f
);
10859 if (FRAME_VISIBLE_P (f
))
10860 ++number_of_visible_frames
;
10861 clear_desired_matrices (f
);
10865 /* Notice any pending interrupt request to change frame size. */
10866 do_pending_window_change (1);
10868 /* Clear frames marked as garbaged. */
10869 if (frame_garbaged
)
10870 clear_garbaged_frames ();
10872 /* Build menubar and tool-bar items. */
10873 if (NILP (Vmemory_full
))
10874 prepare_menu_bars ();
10876 if (windows_or_buffers_changed
)
10877 update_mode_lines
++;
10879 /* Detect case that we need to write or remove a star in the mode line. */
10880 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
10882 w
->update_mode_line
= Qt
;
10883 if (buffer_shared
> 1)
10884 update_mode_lines
++;
10887 /* If %c is in the mode line, update it if needed. */
10888 if (!NILP (w
->column_number_displayed
)
10889 /* This alternative quickly identifies a common case
10890 where no change is needed. */
10891 && !(PT
== XFASTINT (w
->last_point
)
10892 && XFASTINT (w
->last_modified
) >= MODIFF
10893 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
10894 && (XFASTINT (w
->column_number_displayed
)
10895 != (int) current_column ())) /* iftc */
10896 w
->update_mode_line
= Qt
;
10898 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
10900 /* The variable buffer_shared is set in redisplay_window and
10901 indicates that we redisplay a buffer in different windows. See
10903 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
10904 || cursor_type_changed
);
10906 /* If specs for an arrow have changed, do thorough redisplay
10907 to ensure we remove any arrow that should no longer exist. */
10908 if (overlay_arrows_changed_p ())
10909 consider_all_windows_p
= windows_or_buffers_changed
= 1;
10911 /* Normally the message* functions will have already displayed and
10912 updated the echo area, but the frame may have been trashed, or
10913 the update may have been preempted, so display the echo area
10914 again here. Checking message_cleared_p captures the case that
10915 the echo area should be cleared. */
10916 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
10917 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
10918 || (message_cleared_p
10919 && minibuf_level
== 0
10920 /* If the mini-window is currently selected, this means the
10921 echo-area doesn't show through. */
10922 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
10924 int window_height_changed_p
= echo_area_display (0);
10927 /* If we don't display the current message, don't clear the
10928 message_cleared_p flag, because, if we did, we wouldn't clear
10929 the echo area in the next redisplay which doesn't preserve
10931 if (!display_last_displayed_message_p
)
10932 message_cleared_p
= 0;
10934 if (fonts_changed_p
)
10936 else if (window_height_changed_p
)
10938 consider_all_windows_p
= 1;
10939 ++update_mode_lines
;
10940 ++windows_or_buffers_changed
;
10942 /* If window configuration was changed, frames may have been
10943 marked garbaged. Clear them or we will experience
10944 surprises wrt scrolling. */
10945 if (frame_garbaged
)
10946 clear_garbaged_frames ();
10949 else if (EQ (selected_window
, minibuf_window
)
10950 && (current_buffer
->clip_changed
10951 || XFASTINT (w
->last_modified
) < MODIFF
10952 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
10953 && resize_mini_window (w
, 0))
10955 /* Resized active mini-window to fit the size of what it is
10956 showing if its contents might have changed. */
10958 consider_all_windows_p
= 1;
10959 ++windows_or_buffers_changed
;
10960 ++update_mode_lines
;
10962 /* If window configuration was changed, frames may have been
10963 marked garbaged. Clear them or we will experience
10964 surprises wrt scrolling. */
10965 if (frame_garbaged
)
10966 clear_garbaged_frames ();
10970 /* If showing the region, and mark has changed, we must redisplay
10971 the whole window. The assignment to this_line_start_pos prevents
10972 the optimization directly below this if-statement. */
10973 if (((!NILP (Vtransient_mark_mode
)
10974 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
10975 != !NILP (w
->region_showing
))
10976 || (!NILP (w
->region_showing
)
10977 && !EQ (w
->region_showing
,
10978 Fmarker_position (XBUFFER (w
->buffer
)->mark
))))
10979 CHARPOS (this_line_start_pos
) = 0;
10981 /* Optimize the case that only the line containing the cursor in the
10982 selected window has changed. Variables starting with this_ are
10983 set in display_line and record information about the line
10984 containing the cursor. */
10985 tlbufpos
= this_line_start_pos
;
10986 tlendpos
= this_line_end_pos
;
10987 if (!consider_all_windows_p
10988 && CHARPOS (tlbufpos
) > 0
10989 && NILP (w
->update_mode_line
)
10990 && !current_buffer
->clip_changed
10991 && !current_buffer
->prevent_redisplay_optimizations_p
10992 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
10993 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
10994 /* Make sure recorded data applies to current buffer, etc. */
10995 && this_line_buffer
== current_buffer
10996 && current_buffer
== XBUFFER (w
->buffer
)
10997 && NILP (w
->force_start
)
10998 && NILP (w
->optional_new_start
)
10999 /* Point must be on the line that we have info recorded about. */
11000 && PT
>= CHARPOS (tlbufpos
)
11001 && PT
<= Z
- CHARPOS (tlendpos
)
11002 /* All text outside that line, including its final newline,
11003 must be unchanged */
11004 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
11005 CHARPOS (tlendpos
)))
11007 if (CHARPOS (tlbufpos
) > BEGV
11008 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
11009 && (CHARPOS (tlbufpos
) == ZV
11010 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
11011 /* Former continuation line has disappeared by becoming empty */
11013 else if (XFASTINT (w
->last_modified
) < MODIFF
11014 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
11015 || MINI_WINDOW_P (w
))
11017 /* We have to handle the case of continuation around a
11018 wide-column character (See the comment in indent.c around
11021 For instance, in the following case:
11023 -------- Insert --------
11024 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
11025 J_I_ ==> J_I_ `^^' are cursors.
11029 As we have to redraw the line above, we should goto cancel. */
11032 int line_height_before
= this_line_pixel_height
;
11034 /* Note that start_display will handle the case that the
11035 line starting at tlbufpos is a continuation lines. */
11036 start_display (&it
, w
, tlbufpos
);
11038 /* Implementation note: It this still necessary? */
11039 if (it
.current_x
!= this_line_start_x
)
11042 TRACE ((stderr
, "trying display optimization 1\n"));
11043 w
->cursor
.vpos
= -1;
11044 overlay_arrow_seen
= 0;
11045 it
.vpos
= this_line_vpos
;
11046 it
.current_y
= this_line_y
;
11047 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
11048 display_line (&it
);
11050 /* If line contains point, is not continued,
11051 and ends at same distance from eob as before, we win */
11052 if (w
->cursor
.vpos
>= 0
11053 /* Line is not continued, otherwise this_line_start_pos
11054 would have been set to 0 in display_line. */
11055 && CHARPOS (this_line_start_pos
)
11056 /* Line ends as before. */
11057 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
11058 /* Line has same height as before. Otherwise other lines
11059 would have to be shifted up or down. */
11060 && this_line_pixel_height
== line_height_before
)
11062 /* If this is not the window's last line, we must adjust
11063 the charstarts of the lines below. */
11064 if (it
.current_y
< it
.last_visible_y
)
11066 struct glyph_row
*row
11067 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
11068 int delta
, delta_bytes
;
11070 if (Z
- CHARPOS (tlendpos
) == ZV
)
11072 /* This line ends at end of (accessible part of)
11073 buffer. There is no newline to count. */
11075 - CHARPOS (tlendpos
)
11076 - MATRIX_ROW_START_CHARPOS (row
));
11077 delta_bytes
= (Z_BYTE
11078 - BYTEPOS (tlendpos
)
11079 - MATRIX_ROW_START_BYTEPOS (row
));
11083 /* This line ends in a newline. Must take
11084 account of the newline and the rest of the
11085 text that follows. */
11087 - CHARPOS (tlendpos
)
11088 - MATRIX_ROW_START_CHARPOS (row
));
11089 delta_bytes
= (Z_BYTE
11090 - BYTEPOS (tlendpos
)
11091 - MATRIX_ROW_START_BYTEPOS (row
));
11094 increment_matrix_positions (w
->current_matrix
,
11095 this_line_vpos
+ 1,
11096 w
->current_matrix
->nrows
,
11097 delta
, delta_bytes
);
11100 /* If this row displays text now but previously didn't,
11101 or vice versa, w->window_end_vpos may have to be
11103 if ((it
.glyph_row
- 1)->displays_text_p
)
11105 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
11106 XSETINT (w
->window_end_vpos
, this_line_vpos
);
11108 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
11109 && this_line_vpos
> 0)
11110 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
11111 w
->window_end_valid
= Qnil
;
11113 /* Update hint: No need to try to scroll in update_window. */
11114 w
->desired_matrix
->no_scrolling_p
= 1;
11117 *w
->desired_matrix
->method
= 0;
11118 debug_method_add (w
, "optimization 1");
11120 #ifdef HAVE_WINDOW_SYSTEM
11121 update_window_fringes (w
, 0);
11128 else if (/* Cursor position hasn't changed. */
11129 PT
== XFASTINT (w
->last_point
)
11130 /* Make sure the cursor was last displayed
11131 in this window. Otherwise we have to reposition it. */
11132 && 0 <= w
->cursor
.vpos
11133 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
11137 do_pending_window_change (1);
11139 /* We used to always goto end_of_redisplay here, but this
11140 isn't enough if we have a blinking cursor. */
11141 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
11142 goto end_of_redisplay
;
11146 /* If highlighting the region, or if the cursor is in the echo area,
11147 then we can't just move the cursor. */
11148 else if (! (!NILP (Vtransient_mark_mode
)
11149 && !NILP (current_buffer
->mark_active
))
11150 && (EQ (selected_window
, current_buffer
->last_selected_window
)
11151 || highlight_nonselected_windows
)
11152 && NILP (w
->region_showing
)
11153 && NILP (Vshow_trailing_whitespace
)
11154 && !cursor_in_echo_area
)
11157 struct glyph_row
*row
;
11159 /* Skip from tlbufpos to PT and see where it is. Note that
11160 PT may be in invisible text. If so, we will end at the
11161 next visible position. */
11162 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
11163 NULL
, DEFAULT_FACE_ID
);
11164 it
.current_x
= this_line_start_x
;
11165 it
.current_y
= this_line_y
;
11166 it
.vpos
= this_line_vpos
;
11168 /* The call to move_it_to stops in front of PT, but
11169 moves over before-strings. */
11170 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
11172 if (it
.vpos
== this_line_vpos
11173 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
11176 xassert (this_line_vpos
== it
.vpos
);
11177 xassert (this_line_y
== it
.current_y
);
11178 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
11180 *w
->desired_matrix
->method
= 0;
11181 debug_method_add (w
, "optimization 3");
11190 /* Text changed drastically or point moved off of line. */
11191 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
11194 CHARPOS (this_line_start_pos
) = 0;
11195 consider_all_windows_p
|= buffer_shared
> 1;
11196 ++clear_face_cache_count
;
11197 #ifdef HAVE_WINDOW_SYSTEM
11198 ++clear_image_cache_count
;
11201 /* Build desired matrices, and update the display. If
11202 consider_all_windows_p is non-zero, do it for all windows on all
11203 frames. Otherwise do it for selected_window, only. */
11205 if (consider_all_windows_p
)
11207 Lisp_Object tail
, frame
;
11209 FOR_EACH_FRAME (tail
, frame
)
11210 XFRAME (frame
)->updated_p
= 0;
11212 /* Recompute # windows showing selected buffer. This will be
11213 incremented each time such a window is displayed. */
11216 FOR_EACH_FRAME (tail
, frame
)
11218 struct frame
*f
= XFRAME (frame
);
11220 if (FRAME_WINDOW_P (f
) || f
== sf
)
11222 if (! EQ (frame
, selected_frame
))
11223 /* Select the frame, for the sake of frame-local
11225 select_frame_for_redisplay (frame
);
11227 /* Mark all the scroll bars to be removed; we'll redeem
11228 the ones we want when we redisplay their windows. */
11229 if (condemn_scroll_bars_hook
)
11230 condemn_scroll_bars_hook (f
);
11232 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11233 redisplay_windows (FRAME_ROOT_WINDOW (f
));
11235 /* Any scroll bars which redisplay_windows should have
11236 nuked should now go away. */
11237 if (judge_scroll_bars_hook
)
11238 judge_scroll_bars_hook (f
);
11240 /* If fonts changed, display again. */
11241 /* ??? rms: I suspect it is a mistake to jump all the way
11242 back to retry here. It should just retry this frame. */
11243 if (fonts_changed_p
)
11246 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11248 /* See if we have to hscroll. */
11249 if (!f
->already_hscrolled_p
)
11251 f
->already_hscrolled_p
= 1;
11252 if (hscroll_windows (f
->root_window
))
11256 /* Prevent various kinds of signals during display
11257 update. stdio is not robust about handling
11258 signals, which can cause an apparent I/O
11260 if (interrupt_input
)
11261 unrequest_sigio ();
11264 /* Update the display. */
11265 set_window_update_flags (XWINDOW (f
->root_window
), 1);
11266 pause
|= update_frame (f
, 0, 0);
11267 #if 0 /* Exiting the loop can leave the wrong value for buffer_shared. */
11279 /* Do the mark_window_display_accurate after all windows have
11280 been redisplayed because this call resets flags in buffers
11281 which are needed for proper redisplay. */
11282 FOR_EACH_FRAME (tail
, frame
)
11284 struct frame
*f
= XFRAME (frame
);
11287 mark_window_display_accurate (f
->root_window
, 1);
11288 if (frame_up_to_date_hook
)
11289 frame_up_to_date_hook (f
);
11294 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
11296 Lisp_Object mini_window
;
11297 struct frame
*mini_frame
;
11299 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
11300 /* Use list_of_error, not Qerror, so that
11301 we catch only errors and don't run the debugger. */
11302 internal_condition_case_1 (redisplay_window_1
, selected_window
,
11304 redisplay_window_error
);
11306 /* Compare desired and current matrices, perform output. */
11309 /* If fonts changed, display again. */
11310 if (fonts_changed_p
)
11313 /* Prevent various kinds of signals during display update.
11314 stdio is not robust about handling signals,
11315 which can cause an apparent I/O error. */
11316 if (interrupt_input
)
11317 unrequest_sigio ();
11320 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
11322 if (hscroll_windows (selected_window
))
11325 XWINDOW (selected_window
)->must_be_updated_p
= 1;
11326 pause
= update_frame (sf
, 0, 0);
11329 /* We may have called echo_area_display at the top of this
11330 function. If the echo area is on another frame, that may
11331 have put text on a frame other than the selected one, so the
11332 above call to update_frame would not have caught it. Catch
11334 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
11335 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
11337 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
11339 XWINDOW (mini_window
)->must_be_updated_p
= 1;
11340 pause
|= update_frame (mini_frame
, 0, 0);
11341 if (!pause
&& hscroll_windows (mini_window
))
11346 /* If display was paused because of pending input, make sure we do a
11347 thorough update the next time. */
11350 /* Prevent the optimization at the beginning of
11351 redisplay_internal that tries a single-line update of the
11352 line containing the cursor in the selected window. */
11353 CHARPOS (this_line_start_pos
) = 0;
11355 /* Let the overlay arrow be updated the next time. */
11356 update_overlay_arrows (0);
11358 /* If we pause after scrolling, some rows in the current
11359 matrices of some windows are not valid. */
11360 if (!WINDOW_FULL_WIDTH_P (w
)
11361 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
11362 update_mode_lines
= 1;
11366 if (!consider_all_windows_p
)
11368 /* This has already been done above if
11369 consider_all_windows_p is set. */
11370 mark_window_display_accurate_1 (w
, 1);
11372 /* Say overlay arrows are up to date. */
11373 update_overlay_arrows (1);
11375 if (frame_up_to_date_hook
!= 0)
11376 frame_up_to_date_hook (sf
);
11379 update_mode_lines
= 0;
11380 windows_or_buffers_changed
= 0;
11381 cursor_type_changed
= 0;
11384 /* Start SIGIO interrupts coming again. Having them off during the
11385 code above makes it less likely one will discard output, but not
11386 impossible, since there might be stuff in the system buffer here.
11387 But it is much hairier to try to do anything about that. */
11388 if (interrupt_input
)
11392 /* If a frame has become visible which was not before, redisplay
11393 again, so that we display it. Expose events for such a frame
11394 (which it gets when becoming visible) don't call the parts of
11395 redisplay constructing glyphs, so simply exposing a frame won't
11396 display anything in this case. So, we have to display these
11397 frames here explicitly. */
11400 Lisp_Object tail
, frame
;
11403 FOR_EACH_FRAME (tail
, frame
)
11405 int this_is_visible
= 0;
11407 if (XFRAME (frame
)->visible
)
11408 this_is_visible
= 1;
11409 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
11410 if (XFRAME (frame
)->visible
)
11411 this_is_visible
= 1;
11413 if (this_is_visible
)
11417 if (new_count
!= number_of_visible_frames
)
11418 windows_or_buffers_changed
++;
11421 /* Change frame size now if a change is pending. */
11422 do_pending_window_change (1);
11424 /* If we just did a pending size change, or have additional
11425 visible frames, redisplay again. */
11426 if (windows_or_buffers_changed
&& !pause
)
11429 /* Clear the face cache eventually. */
11430 if (consider_all_windows_p
)
11432 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
11434 clear_face_cache (0);
11435 clear_face_cache_count
= 0;
11437 #ifdef HAVE_WINDOW_SYSTEM
11438 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
11440 Lisp_Object tail
, frame
;
11441 FOR_EACH_FRAME (tail
, frame
)
11443 struct frame
*f
= XFRAME (frame
);
11444 if (FRAME_WINDOW_P (f
))
11445 clear_image_cache (f
, 0);
11447 clear_image_cache_count
= 0;
11449 #endif /* HAVE_WINDOW_SYSTEM */
11453 unbind_to (count
, Qnil
);
11458 /* Redisplay, but leave alone any recent echo area message unless
11459 another message has been requested in its place.
11461 This is useful in situations where you need to redisplay but no
11462 user action has occurred, making it inappropriate for the message
11463 area to be cleared. See tracking_off and
11464 wait_reading_process_output for examples of these situations.
11466 FROM_WHERE is an integer saying from where this function was
11467 called. This is useful for debugging. */
11470 redisplay_preserve_echo_area (from_where
)
11473 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
11475 if (!NILP (echo_area_buffer
[1]))
11477 /* We have a previously displayed message, but no current
11478 message. Redisplay the previous message. */
11479 display_last_displayed_message_p
= 1;
11480 redisplay_internal (1);
11481 display_last_displayed_message_p
= 0;
11484 redisplay_internal (1);
11486 if (rif
!= NULL
&& rif
->flush_display_optional
)
11487 rif
->flush_display_optional (NULL
);
11491 /* Function registered with record_unwind_protect in
11492 redisplay_internal. Reset redisplaying_p to the value it had
11493 before redisplay_internal was called, and clear
11494 prevent_freeing_realized_faces_p. It also selects the previously
11498 unwind_redisplay (val
)
11501 Lisp_Object old_redisplaying_p
, old_frame
;
11503 old_redisplaying_p
= XCAR (val
);
11504 redisplaying_p
= XFASTINT (old_redisplaying_p
);
11505 old_frame
= XCDR (val
);
11506 if (! EQ (old_frame
, selected_frame
))
11507 select_frame_for_redisplay (old_frame
);
11512 /* Mark the display of window W as accurate or inaccurate. If
11513 ACCURATE_P is non-zero mark display of W as accurate. If
11514 ACCURATE_P is zero, arrange for W to be redisplayed the next time
11515 redisplay_internal is called. */
11518 mark_window_display_accurate_1 (w
, accurate_p
)
11522 if (BUFFERP (w
->buffer
))
11524 struct buffer
*b
= XBUFFER (w
->buffer
);
11527 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
11528 w
->last_overlay_modified
11529 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
11531 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
11535 b
->clip_changed
= 0;
11536 b
->prevent_redisplay_optimizations_p
= 0;
11538 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
11539 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
11540 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
11541 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
11543 w
->current_matrix
->buffer
= b
;
11544 w
->current_matrix
->begv
= BUF_BEGV (b
);
11545 w
->current_matrix
->zv
= BUF_ZV (b
);
11547 w
->last_cursor
= w
->cursor
;
11548 w
->last_cursor_off_p
= w
->cursor_off_p
;
11550 if (w
== XWINDOW (selected_window
))
11551 w
->last_point
= make_number (BUF_PT (b
));
11553 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
11559 w
->window_end_valid
= w
->buffer
;
11560 #if 0 /* This is incorrect with variable-height lines. */
11561 xassert (XINT (w
->window_end_vpos
)
11562 < (WINDOW_TOTAL_LINES (w
)
11563 - (WINDOW_WANTS_MODELINE_P (w
) ? 1 : 0)));
11565 w
->update_mode_line
= Qnil
;
11570 /* Mark the display of windows in the window tree rooted at WINDOW as
11571 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
11572 windows as accurate. If ACCURATE_P is zero, arrange for windows to
11573 be redisplayed the next time redisplay_internal is called. */
11576 mark_window_display_accurate (window
, accurate_p
)
11577 Lisp_Object window
;
11582 for (; !NILP (window
); window
= w
->next
)
11584 w
= XWINDOW (window
);
11585 mark_window_display_accurate_1 (w
, accurate_p
);
11587 if (!NILP (w
->vchild
))
11588 mark_window_display_accurate (w
->vchild
, accurate_p
);
11589 if (!NILP (w
->hchild
))
11590 mark_window_display_accurate (w
->hchild
, accurate_p
);
11595 update_overlay_arrows (1);
11599 /* Force a thorough redisplay the next time by setting
11600 last_arrow_position and last_arrow_string to t, which is
11601 unequal to any useful value of Voverlay_arrow_... */
11602 update_overlay_arrows (-1);
11607 /* Return value in display table DP (Lisp_Char_Table *) for character
11608 C. Since a display table doesn't have any parent, we don't have to
11609 follow parent. Do not call this function directly but use the
11610 macro DISP_CHAR_VECTOR. */
11613 disp_char_vector (dp
, c
)
11614 struct Lisp_Char_Table
*dp
;
11620 if (SINGLE_BYTE_CHAR_P (c
))
11621 return (dp
->contents
[c
]);
11623 SPLIT_CHAR (c
, code
[0], code
[1], code
[2]);
11626 else if (code
[2] < 32)
11629 /* Here, the possible range of code[0] (== charset ID) is
11630 128..max_charset. Since the top level char table contains data
11631 for multibyte characters after 256th element, we must increment
11632 code[0] by 128 to get a correct index. */
11634 code
[3] = -1; /* anchor */
11636 for (i
= 0; code
[i
] >= 0; i
++, dp
= XCHAR_TABLE (val
))
11638 val
= dp
->contents
[code
[i
]];
11639 if (!SUB_CHAR_TABLE_P (val
))
11640 return (NILP (val
) ? dp
->defalt
: val
);
11643 /* Here, val is a sub char table. We return the default value of
11645 return (dp
->defalt
);
11650 /***********************************************************************
11652 ***********************************************************************/
11654 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
11657 redisplay_windows (window
)
11658 Lisp_Object window
;
11660 while (!NILP (window
))
11662 struct window
*w
= XWINDOW (window
);
11664 if (!NILP (w
->hchild
))
11665 redisplay_windows (w
->hchild
);
11666 else if (!NILP (w
->vchild
))
11667 redisplay_windows (w
->vchild
);
11670 displayed_buffer
= XBUFFER (w
->buffer
);
11671 /* Use list_of_error, not Qerror, so that
11672 we catch only errors and don't run the debugger. */
11673 internal_condition_case_1 (redisplay_window_0
, window
,
11675 redisplay_window_error
);
11683 redisplay_window_error ()
11685 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
11690 redisplay_window_0 (window
)
11691 Lisp_Object window
;
11693 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
11694 redisplay_window (window
, 0);
11699 redisplay_window_1 (window
)
11700 Lisp_Object window
;
11702 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
11703 redisplay_window (window
, 1);
11708 /* Increment GLYPH until it reaches END or CONDITION fails while
11709 adding (GLYPH)->pixel_width to X. */
11711 #define SKIP_GLYPHS(glyph, end, x, condition) \
11714 (x) += (glyph)->pixel_width; \
11717 while ((glyph) < (end) && (condition))
11720 /* Set cursor position of W. PT is assumed to be displayed in ROW.
11721 DELTA is the number of bytes by which positions recorded in ROW
11722 differ from current buffer positions.
11724 Return 0 if cursor is not on this row. 1 otherwise. */
11727 set_cursor_from_row (w
, row
, matrix
, delta
, delta_bytes
, dy
, dvpos
)
11729 struct glyph_row
*row
;
11730 struct glyph_matrix
*matrix
;
11731 int delta
, delta_bytes
, dy
, dvpos
;
11733 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
11734 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
11735 struct glyph
*cursor
= NULL
;
11736 /* The first glyph that starts a sequence of glyphs from string. */
11737 struct glyph
*string_start
;
11738 /* The X coordinate of string_start. */
11739 int string_start_x
;
11740 /* The last known character position. */
11741 int last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
11742 /* The last known character position before string_start. */
11743 int string_before_pos
;
11746 int cursor_from_overlay_pos
= 0;
11747 int pt_old
= PT
- delta
;
11749 /* Skip over glyphs not having an object at the start of the row.
11750 These are special glyphs like truncation marks on terminal
11752 if (row
->displays_text_p
)
11754 && INTEGERP (glyph
->object
)
11755 && glyph
->charpos
< 0)
11757 x
+= glyph
->pixel_width
;
11761 string_start
= NULL
;
11763 && !INTEGERP (glyph
->object
)
11764 && (!BUFFERP (glyph
->object
)
11765 || (last_pos
= glyph
->charpos
) < pt_old
))
11767 if (! STRINGP (glyph
->object
))
11769 string_start
= NULL
;
11770 x
+= glyph
->pixel_width
;
11772 if (cursor_from_overlay_pos
11773 && last_pos
>= cursor_from_overlay_pos
)
11775 cursor_from_overlay_pos
= 0;
11781 if (string_start
== NULL
)
11783 string_before_pos
= last_pos
;
11784 string_start
= glyph
;
11785 string_start_x
= x
;
11787 /* Skip all glyphs from string. */
11792 if ((cursor
== NULL
|| glyph
> cursor
)
11793 && (cprop
= Fget_char_property (make_number ((glyph
)->charpos
),
11794 Qcursor
, (glyph
)->object
),
11796 && (pos
= string_buffer_position (w
, glyph
->object
,
11797 string_before_pos
),
11798 (pos
== 0 /* From overlay */
11799 || pos
== pt_old
)))
11801 /* Estimate overlay buffer position from the buffer
11802 positions of the glyphs before and after the overlay.
11803 Add 1 to last_pos so that if point corresponds to the
11804 glyph right after the overlay, we still use a 'cursor'
11805 property found in that overlay. */
11806 cursor_from_overlay_pos
= (pos
? 0 : last_pos
11807 + (INTEGERP (cprop
) ? XINT (cprop
) : 0));
11811 x
+= glyph
->pixel_width
;
11814 while (glyph
< end
&& EQ (glyph
->object
, string_start
->object
));
11818 if (cursor
!= NULL
)
11823 else if (row
->ends_in_ellipsis_p
&& glyph
== end
)
11825 /* Scan back over the ellipsis glyphs, decrementing positions. */
11826 while (glyph
> row
->glyphs
[TEXT_AREA
]
11827 && (glyph
- 1)->charpos
== last_pos
)
11828 glyph
--, x
-= glyph
->pixel_width
;
11829 /* That loop always goes one position too far,
11830 including the glyph before the ellipsis.
11831 So scan forward over that one. */
11832 x
+= glyph
->pixel_width
;
11835 else if (string_start
11836 && (glyph
== end
|| !BUFFERP (glyph
->object
) || last_pos
> pt_old
))
11838 /* We may have skipped over point because the previous glyphs
11839 are from string. As there's no easy way to know the
11840 character position of the current glyph, find the correct
11841 glyph on point by scanning from string_start again. */
11843 Lisp_Object string
;
11844 struct glyph
*stop
= glyph
;
11847 limit
= make_number (pt_old
+ 1);
11848 glyph
= string_start
;
11849 x
= string_start_x
;
11850 string
= glyph
->object
;
11851 pos
= string_buffer_position (w
, string
, string_before_pos
);
11852 /* If STRING is from overlay, LAST_POS == 0. We skip such glyphs
11853 because we always put cursor after overlay strings. */
11854 while (pos
== 0 && glyph
< stop
)
11856 string
= glyph
->object
;
11857 SKIP_GLYPHS (glyph
, stop
, x
, EQ (glyph
->object
, string
));
11859 pos
= string_buffer_position (w
, glyph
->object
, string_before_pos
);
11862 while (glyph
< stop
)
11864 pos
= XINT (Fnext_single_char_property_change
11865 (make_number (pos
), Qdisplay
, Qnil
, limit
));
11868 /* Skip glyphs from the same string. */
11869 string
= glyph
->object
;
11870 SKIP_GLYPHS (glyph
, stop
, x
, EQ (glyph
->object
, string
));
11871 /* Skip glyphs from an overlay. */
11872 while (glyph
< stop
11873 && ! string_buffer_position (w
, glyph
->object
, pos
))
11875 string
= glyph
->object
;
11876 SKIP_GLYPHS (glyph
, stop
, x
, EQ (glyph
->object
, string
));
11880 /* If we reached the end of the line, and end was from a string,
11881 cursor is not on this line. */
11882 if (glyph
== end
&& row
->continued_p
)
11886 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
11888 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
11889 w
->cursor
.y
= row
->y
+ dy
;
11891 if (w
== XWINDOW (selected_window
))
11893 if (!row
->continued_p
11894 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
11897 this_line_buffer
= XBUFFER (w
->buffer
);
11899 CHARPOS (this_line_start_pos
)
11900 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
11901 BYTEPOS (this_line_start_pos
)
11902 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
11904 CHARPOS (this_line_end_pos
)
11905 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
11906 BYTEPOS (this_line_end_pos
)
11907 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
11909 this_line_y
= w
->cursor
.y
;
11910 this_line_pixel_height
= row
->height
;
11911 this_line_vpos
= w
->cursor
.vpos
;
11912 this_line_start_x
= row
->x
;
11915 CHARPOS (this_line_start_pos
) = 0;
11922 /* Run window scroll functions, if any, for WINDOW with new window
11923 start STARTP. Sets the window start of WINDOW to that position.
11925 We assume that the window's buffer is really current. */
11927 static INLINE
struct text_pos
11928 run_window_scroll_functions (window
, startp
)
11929 Lisp_Object window
;
11930 struct text_pos startp
;
11932 struct window
*w
= XWINDOW (window
);
11933 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
11935 if (current_buffer
!= XBUFFER (w
->buffer
))
11938 if (!NILP (Vwindow_scroll_functions
))
11940 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
11941 make_number (CHARPOS (startp
)));
11942 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
11943 /* In case the hook functions switch buffers. */
11944 if (current_buffer
!= XBUFFER (w
->buffer
))
11945 set_buffer_internal_1 (XBUFFER (w
->buffer
));
11952 /* Make sure the line containing the cursor is fully visible.
11953 A value of 1 means there is nothing to be done.
11954 (Either the line is fully visible, or it cannot be made so,
11955 or we cannot tell.)
11957 If FORCE_P is non-zero, return 0 even if partial visible cursor row
11958 is higher than window.
11960 A value of 0 means the caller should do scrolling
11961 as if point had gone off the screen. */
11964 cursor_row_fully_visible_p (w
, force_p
, current_matrix_p
)
11967 int current_matrix_p
;
11969 struct glyph_matrix
*matrix
;
11970 struct glyph_row
*row
;
11973 if (!make_cursor_line_fully_visible_p
)
11976 /* It's not always possible to find the cursor, e.g, when a window
11977 is full of overlay strings. Don't do anything in that case. */
11978 if (w
->cursor
.vpos
< 0)
11981 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
11982 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
11984 /* If the cursor row is not partially visible, there's nothing to do. */
11985 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
11988 /* If the row the cursor is in is taller than the window's height,
11989 it's not clear what to do, so do nothing. */
11990 window_height
= window_box_height (w
);
11991 if (row
->height
>= window_height
)
11993 if (!force_p
|| MINI_WINDOW_P (w
) || w
->vscroll
)
11999 /* This code used to try to scroll the window just enough to make
12000 the line visible. It returned 0 to say that the caller should
12001 allocate larger glyph matrices. */
12003 if (MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (w
, row
))
12005 int dy
= row
->height
- row
->visible_height
;
12008 shift_glyph_matrix (w
, matrix
, 0, matrix
->nrows
, dy
);
12010 else /* MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P (w, row)) */
12012 int dy
= - (row
->height
- row
->visible_height
);
12015 shift_glyph_matrix (w
, matrix
, 0, matrix
->nrows
, dy
);
12018 /* When we change the cursor y-position of the selected window,
12019 change this_line_y as well so that the display optimization for
12020 the cursor line of the selected window in redisplay_internal uses
12021 the correct y-position. */
12022 if (w
== XWINDOW (selected_window
))
12023 this_line_y
= w
->cursor
.y
;
12025 /* If vscrolling requires a larger glyph matrix, arrange for a fresh
12026 redisplay with larger matrices. */
12027 if (matrix
->nrows
< required_matrix_height (w
))
12029 fonts_changed_p
= 1;
12038 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
12039 non-zero means only WINDOW is redisplayed in redisplay_internal.
12040 TEMP_SCROLL_STEP has the same meaning as scroll_step, and is used
12041 in redisplay_window to bring a partially visible line into view in
12042 the case that only the cursor has moved.
12044 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
12045 last screen line's vertical height extends past the end of the screen.
12049 1 if scrolling succeeded
12051 0 if scrolling didn't find point.
12053 -1 if new fonts have been loaded so that we must interrupt
12054 redisplay, adjust glyph matrices, and try again. */
12060 SCROLLING_NEED_LARGER_MATRICES
12064 try_scrolling (window
, just_this_one_p
, scroll_conservatively
,
12065 scroll_step
, temp_scroll_step
, last_line_misfit
)
12066 Lisp_Object window
;
12067 int just_this_one_p
;
12068 EMACS_INT scroll_conservatively
, scroll_step
;
12069 int temp_scroll_step
;
12070 int last_line_misfit
;
12072 struct window
*w
= XWINDOW (window
);
12073 struct frame
*f
= XFRAME (w
->frame
);
12074 struct text_pos scroll_margin_pos
;
12075 struct text_pos pos
;
12076 struct text_pos startp
;
12078 Lisp_Object window_end
;
12079 int this_scroll_margin
;
12083 int amount_to_scroll
= 0;
12084 Lisp_Object aggressive
;
12086 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
12089 debug_method_add (w
, "try_scrolling");
12092 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12094 /* Compute scroll margin height in pixels. We scroll when point is
12095 within this distance from the top or bottom of the window. */
12096 if (scroll_margin
> 0)
12098 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
12099 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
12102 this_scroll_margin
= 0;
12104 /* Force scroll_conservatively to have a reasonable value so it doesn't
12105 cause an overflow while computing how much to scroll. */
12106 if (scroll_conservatively
)
12107 scroll_conservatively
= min (scroll_conservatively
,
12108 MOST_POSITIVE_FIXNUM
/ FRAME_LINE_HEIGHT (f
));
12110 /* Compute how much we should try to scroll maximally to bring point
12112 if (scroll_step
|| scroll_conservatively
|| temp_scroll_step
)
12113 scroll_max
= max (scroll_step
,
12114 max (scroll_conservatively
, temp_scroll_step
));
12115 else if (NUMBERP (current_buffer
->scroll_down_aggressively
)
12116 || NUMBERP (current_buffer
->scroll_up_aggressively
))
12117 /* We're trying to scroll because of aggressive scrolling
12118 but no scroll_step is set. Choose an arbitrary one. Maybe
12119 there should be a variable for this. */
12123 scroll_max
*= FRAME_LINE_HEIGHT (f
);
12125 /* Decide whether we have to scroll down. Start at the window end
12126 and move this_scroll_margin up to find the position of the scroll
12128 window_end
= Fwindow_end (window
, Qt
);
12132 CHARPOS (scroll_margin_pos
) = XINT (window_end
);
12133 BYTEPOS (scroll_margin_pos
) = CHAR_TO_BYTE (CHARPOS (scroll_margin_pos
));
12135 if (this_scroll_margin
|| extra_scroll_margin_lines
)
12137 start_display (&it
, w
, scroll_margin_pos
);
12138 if (this_scroll_margin
)
12139 move_it_vertically_backward (&it
, this_scroll_margin
);
12140 if (extra_scroll_margin_lines
)
12141 move_it_by_lines (&it
, - extra_scroll_margin_lines
, 0);
12142 scroll_margin_pos
= it
.current
.pos
;
12145 if (PT
>= CHARPOS (scroll_margin_pos
))
12149 /* Point is in the scroll margin at the bottom of the window, or
12150 below. Compute a new window start that makes point visible. */
12152 /* Compute the distance from the scroll margin to PT.
12153 Give up if the distance is greater than scroll_max. */
12154 start_display (&it
, w
, scroll_margin_pos
);
12156 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
12157 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
12159 /* To make point visible, we have to move the window start
12160 down so that the line the cursor is in is visible, which
12161 means we have to add in the height of the cursor line. */
12162 dy
= line_bottom_y (&it
) - y0
;
12164 if (dy
> scroll_max
)
12165 return SCROLLING_FAILED
;
12167 /* Move the window start down. If scrolling conservatively,
12168 move it just enough down to make point visible. If
12169 scroll_step is set, move it down by scroll_step. */
12170 start_display (&it
, w
, startp
);
12172 if (scroll_conservatively
)
12173 /* Set AMOUNT_TO_SCROLL to at least one line,
12174 and at most scroll_conservatively lines. */
12176 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
12177 FRAME_LINE_HEIGHT (f
) * scroll_conservatively
);
12178 else if (scroll_step
|| temp_scroll_step
)
12179 amount_to_scroll
= scroll_max
;
12182 aggressive
= current_buffer
->scroll_up_aggressively
;
12183 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
12184 if (NUMBERP (aggressive
))
12186 double float_amount
= XFLOATINT (aggressive
) * height
;
12187 amount_to_scroll
= float_amount
;
12188 if (amount_to_scroll
== 0 && float_amount
> 0)
12189 amount_to_scroll
= 1;
12193 if (amount_to_scroll
<= 0)
12194 return SCROLLING_FAILED
;
12196 /* If moving by amount_to_scroll leaves STARTP unchanged,
12197 move it down one screen line. */
12199 move_it_vertically (&it
, amount_to_scroll
);
12200 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
12201 move_it_by_lines (&it
, 1, 1);
12202 startp
= it
.current
.pos
;
12206 /* See if point is inside the scroll margin at the top of the
12208 scroll_margin_pos
= startp
;
12209 if (this_scroll_margin
)
12211 start_display (&it
, w
, startp
);
12212 move_it_vertically (&it
, this_scroll_margin
);
12213 scroll_margin_pos
= it
.current
.pos
;
12216 if (PT
< CHARPOS (scroll_margin_pos
))
12218 /* Point is in the scroll margin at the top of the window or
12219 above what is displayed in the window. */
12222 /* Compute the vertical distance from PT to the scroll
12223 margin position. Give up if distance is greater than
12225 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
12226 start_display (&it
, w
, pos
);
12228 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
12229 it
.last_visible_y
, -1,
12230 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
12231 dy
= it
.current_y
- y0
;
12232 if (dy
> scroll_max
)
12233 return SCROLLING_FAILED
;
12235 /* Compute new window start. */
12236 start_display (&it
, w
, startp
);
12238 if (scroll_conservatively
)
12240 = max (dy
, FRAME_LINE_HEIGHT (f
) * max (scroll_step
, temp_scroll_step
));
12241 else if (scroll_step
|| temp_scroll_step
)
12242 amount_to_scroll
= scroll_max
;
12245 aggressive
= current_buffer
->scroll_down_aggressively
;
12246 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
12247 if (NUMBERP (aggressive
))
12249 double float_amount
= XFLOATINT (aggressive
) * height
;
12250 amount_to_scroll
= float_amount
;
12251 if (amount_to_scroll
== 0 && float_amount
> 0)
12252 amount_to_scroll
= 1;
12256 if (amount_to_scroll
<= 0)
12257 return SCROLLING_FAILED
;
12259 move_it_vertically_backward (&it
, amount_to_scroll
);
12260 startp
= it
.current
.pos
;
12264 /* Run window scroll functions. */
12265 startp
= run_window_scroll_functions (window
, startp
);
12267 /* Display the window. Give up if new fonts are loaded, or if point
12269 if (!try_window (window
, startp
, 0))
12270 rc
= SCROLLING_NEED_LARGER_MATRICES
;
12271 else if (w
->cursor
.vpos
< 0)
12273 clear_glyph_matrix (w
->desired_matrix
);
12274 rc
= SCROLLING_FAILED
;
12278 /* Maybe forget recorded base line for line number display. */
12279 if (!just_this_one_p
12280 || current_buffer
->clip_changed
12281 || BEG_UNCHANGED
< CHARPOS (startp
))
12282 w
->base_line_number
= Qnil
;
12284 /* If cursor ends up on a partially visible line,
12285 treat that as being off the bottom of the screen. */
12286 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0))
12288 clear_glyph_matrix (w
->desired_matrix
);
12289 ++extra_scroll_margin_lines
;
12292 rc
= SCROLLING_SUCCESS
;
12299 /* Compute a suitable window start for window W if display of W starts
12300 on a continuation line. Value is non-zero if a new window start
12303 The new window start will be computed, based on W's width, starting
12304 from the start of the continued line. It is the start of the
12305 screen line with the minimum distance from the old start W->start. */
12308 compute_window_start_on_continuation_line (w
)
12311 struct text_pos pos
, start_pos
;
12312 int window_start_changed_p
= 0;
12314 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
12316 /* If window start is on a continuation line... Window start may be
12317 < BEGV in case there's invisible text at the start of the
12318 buffer (M-x rmail, for example). */
12319 if (CHARPOS (start_pos
) > BEGV
12320 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
12323 struct glyph_row
*row
;
12325 /* Handle the case that the window start is out of range. */
12326 if (CHARPOS (start_pos
) < BEGV
)
12327 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
12328 else if (CHARPOS (start_pos
) > ZV
)
12329 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
12331 /* Find the start of the continued line. This should be fast
12332 because scan_buffer is fast (newline cache). */
12333 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
12334 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
12335 row
, DEFAULT_FACE_ID
);
12336 reseat_at_previous_visible_line_start (&it
);
12338 /* If the line start is "too far" away from the window start,
12339 say it takes too much time to compute a new window start. */
12340 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
12341 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
12343 int min_distance
, distance
;
12345 /* Move forward by display lines to find the new window
12346 start. If window width was enlarged, the new start can
12347 be expected to be > the old start. If window width was
12348 decreased, the new window start will be < the old start.
12349 So, we're looking for the display line start with the
12350 minimum distance from the old window start. */
12351 pos
= it
.current
.pos
;
12352 min_distance
= INFINITY
;
12353 while ((distance
= abs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
12354 distance
< min_distance
)
12356 min_distance
= distance
;
12357 pos
= it
.current
.pos
;
12358 move_it_by_lines (&it
, 1, 0);
12361 /* Set the window start there. */
12362 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
12363 window_start_changed_p
= 1;
12367 return window_start_changed_p
;
12371 /* Try cursor movement in case text has not changed in window WINDOW,
12372 with window start STARTP. Value is
12374 CURSOR_MOVEMENT_SUCCESS if successful
12376 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
12378 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
12379 display. *SCROLL_STEP is set to 1, under certain circumstances, if
12380 we want to scroll as if scroll-step were set to 1. See the code.
12382 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
12383 which case we have to abort this redisplay, and adjust matrices
12388 CURSOR_MOVEMENT_SUCCESS
,
12389 CURSOR_MOVEMENT_CANNOT_BE_USED
,
12390 CURSOR_MOVEMENT_MUST_SCROLL
,
12391 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
12395 try_cursor_movement (window
, startp
, scroll_step
)
12396 Lisp_Object window
;
12397 struct text_pos startp
;
12400 struct window
*w
= XWINDOW (window
);
12401 struct frame
*f
= XFRAME (w
->frame
);
12402 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
12405 if (inhibit_try_cursor_movement
)
12409 /* Handle case where text has not changed, only point, and it has
12410 not moved off the frame. */
12411 if (/* Point may be in this window. */
12412 PT
>= CHARPOS (startp
)
12413 /* Selective display hasn't changed. */
12414 && !current_buffer
->clip_changed
12415 /* Function force-mode-line-update is used to force a thorough
12416 redisplay. It sets either windows_or_buffers_changed or
12417 update_mode_lines. So don't take a shortcut here for these
12419 && !update_mode_lines
12420 && !windows_or_buffers_changed
12421 && !cursor_type_changed
12422 /* Can't use this case if highlighting a region. When a
12423 region exists, cursor movement has to do more than just
12425 && !(!NILP (Vtransient_mark_mode
)
12426 && !NILP (current_buffer
->mark_active
))
12427 && NILP (w
->region_showing
)
12428 && NILP (Vshow_trailing_whitespace
)
12429 /* Right after splitting windows, last_point may be nil. */
12430 && INTEGERP (w
->last_point
)
12431 /* This code is not used for mini-buffer for the sake of the case
12432 of redisplaying to replace an echo area message; since in
12433 that case the mini-buffer contents per se are usually
12434 unchanged. This code is of no real use in the mini-buffer
12435 since the handling of this_line_start_pos, etc., in redisplay
12436 handles the same cases. */
12437 && !EQ (window
, minibuf_window
)
12438 /* When splitting windows or for new windows, it happens that
12439 redisplay is called with a nil window_end_vpos or one being
12440 larger than the window. This should really be fixed in
12441 window.c. I don't have this on my list, now, so we do
12442 approximately the same as the old redisplay code. --gerd. */
12443 && INTEGERP (w
->window_end_vpos
)
12444 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
12445 && (FRAME_WINDOW_P (f
)
12446 || !overlay_arrow_in_current_buffer_p ()))
12448 int this_scroll_margin
, top_scroll_margin
;
12449 struct glyph_row
*row
= NULL
;
12452 debug_method_add (w
, "cursor movement");
12455 /* Scroll if point within this distance from the top or bottom
12456 of the window. This is a pixel value. */
12457 this_scroll_margin
= max (0, scroll_margin
);
12458 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
12459 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
12461 top_scroll_margin
= this_scroll_margin
;
12462 if (WINDOW_WANTS_HEADER_LINE_P (w
))
12463 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
12465 /* Start with the row the cursor was displayed during the last
12466 not paused redisplay. Give up if that row is not valid. */
12467 if (w
->last_cursor
.vpos
< 0
12468 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
12469 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
12472 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
12473 if (row
->mode_line_p
)
12475 if (!row
->enabled_p
)
12476 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
12479 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
12482 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
12484 if (PT
> XFASTINT (w
->last_point
))
12486 /* Point has moved forward. */
12487 while (MATRIX_ROW_END_CHARPOS (row
) < PT
12488 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
12490 xassert (row
->enabled_p
);
12494 /* The end position of a row equals the start position
12495 of the next row. If PT is there, we would rather
12496 display it in the next line. */
12497 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
12498 && MATRIX_ROW_END_CHARPOS (row
) == PT
12499 && !cursor_row_p (w
, row
))
12502 /* If within the scroll margin, scroll. Note that
12503 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
12504 the next line would be drawn, and that
12505 this_scroll_margin can be zero. */
12506 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
12507 || PT
> MATRIX_ROW_END_CHARPOS (row
)
12508 /* Line is completely visible last line in window
12509 and PT is to be set in the next line. */
12510 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
12511 && PT
== MATRIX_ROW_END_CHARPOS (row
)
12512 && !row
->ends_at_zv_p
12513 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
12516 else if (PT
< XFASTINT (w
->last_point
))
12518 /* Cursor has to be moved backward. Note that PT >=
12519 CHARPOS (startp) because of the outer if-statement. */
12520 while (!row
->mode_line_p
12521 && (MATRIX_ROW_START_CHARPOS (row
) > PT
12522 || (MATRIX_ROW_START_CHARPOS (row
) == PT
12523 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
12524 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
12525 row
> w
->current_matrix
->rows
12526 && (row
-1)->ends_in_newline_from_string_p
))))
12527 && (row
->y
> top_scroll_margin
12528 || CHARPOS (startp
) == BEGV
))
12530 xassert (row
->enabled_p
);
12534 /* Consider the following case: Window starts at BEGV,
12535 there is invisible, intangible text at BEGV, so that
12536 display starts at some point START > BEGV. It can
12537 happen that we are called with PT somewhere between
12538 BEGV and START. Try to handle that case. */
12539 if (row
< w
->current_matrix
->rows
12540 || row
->mode_line_p
)
12542 row
= w
->current_matrix
->rows
;
12543 if (row
->mode_line_p
)
12547 /* Due to newlines in overlay strings, we may have to
12548 skip forward over overlay strings. */
12549 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
12550 && MATRIX_ROW_END_CHARPOS (row
) == PT
12551 && !cursor_row_p (w
, row
))
12554 /* If within the scroll margin, scroll. */
12555 if (row
->y
< top_scroll_margin
12556 && CHARPOS (startp
) != BEGV
)
12561 /* Cursor did not move. So don't scroll even if cursor line
12562 is partially visible, as it was so before. */
12563 rc
= CURSOR_MOVEMENT_SUCCESS
;
12566 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
12567 || PT
> MATRIX_ROW_END_CHARPOS (row
))
12569 /* if PT is not in the glyph row, give up. */
12570 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
12572 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
12573 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
12574 && make_cursor_line_fully_visible_p
)
12576 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
12577 && !row
->ends_at_zv_p
12578 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
12579 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
12580 else if (row
->height
> window_box_height (w
))
12582 /* If we end up in a partially visible line, let's
12583 make it fully visible, except when it's taller
12584 than the window, in which case we can't do much
12587 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
12591 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
12592 if (!cursor_row_fully_visible_p (w
, 0, 1))
12593 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
12595 rc
= CURSOR_MOVEMENT_SUCCESS
;
12599 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
12604 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
12606 rc
= CURSOR_MOVEMENT_SUCCESS
;
12611 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
12612 && MATRIX_ROW_START_CHARPOS (row
) == PT
12613 && cursor_row_p (w
, row
));
12622 set_vertical_scroll_bar (w
)
12625 int start
, end
, whole
;
12627 /* Calculate the start and end positions for the current window.
12628 At some point, it would be nice to choose between scrollbars
12629 which reflect the whole buffer size, with special markers
12630 indicating narrowing, and scrollbars which reflect only the
12633 Note that mini-buffers sometimes aren't displaying any text. */
12634 if (!MINI_WINDOW_P (w
)
12635 || (w
== XWINDOW (minibuf_window
)
12636 && NILP (echo_area_buffer
[0])))
12638 struct buffer
*buf
= XBUFFER (w
->buffer
);
12639 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
12640 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
12641 /* I don't think this is guaranteed to be right. For the
12642 moment, we'll pretend it is. */
12643 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
12647 if (whole
< (end
- start
))
12648 whole
= end
- start
;
12651 start
= end
= whole
= 0;
12653 /* Indicate what this scroll bar ought to be displaying now. */
12654 set_vertical_scroll_bar_hook (w
, end
- start
, whole
, start
);
12658 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
12659 selected_window is redisplayed.
12661 We can return without actually redisplaying the window if
12662 fonts_changed_p is nonzero. In that case, redisplay_internal will
12666 redisplay_window (window
, just_this_one_p
)
12667 Lisp_Object window
;
12668 int just_this_one_p
;
12670 struct window
*w
= XWINDOW (window
);
12671 struct frame
*f
= XFRAME (w
->frame
);
12672 struct buffer
*buffer
= XBUFFER (w
->buffer
);
12673 struct buffer
*old
= current_buffer
;
12674 struct text_pos lpoint
, opoint
, startp
;
12675 int update_mode_line
;
12678 /* Record it now because it's overwritten. */
12679 int current_matrix_up_to_date_p
= 0;
12680 int used_current_matrix_p
= 0;
12681 /* This is less strict than current_matrix_up_to_date_p.
12682 It indictes that the buffer contents and narrowing are unchanged. */
12683 int buffer_unchanged_p
= 0;
12684 int temp_scroll_step
= 0;
12685 int count
= SPECPDL_INDEX ();
12687 int centering_position
= -1;
12688 int last_line_misfit
= 0;
12690 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
12693 /* W must be a leaf window here. */
12694 xassert (!NILP (w
->buffer
));
12696 *w
->desired_matrix
->method
= 0;
12699 specbind (Qinhibit_point_motion_hooks
, Qt
);
12701 reconsider_clip_changes (w
, buffer
);
12703 /* Has the mode line to be updated? */
12704 update_mode_line
= (!NILP (w
->update_mode_line
)
12705 || update_mode_lines
12706 || buffer
->clip_changed
12707 || buffer
->prevent_redisplay_optimizations_p
);
12709 if (MINI_WINDOW_P (w
))
12711 if (w
== XWINDOW (echo_area_window
)
12712 && !NILP (echo_area_buffer
[0]))
12714 if (update_mode_line
)
12715 /* We may have to update a tty frame's menu bar or a
12716 tool-bar. Example `M-x C-h C-h C-g'. */
12717 goto finish_menu_bars
;
12719 /* We've already displayed the echo area glyphs in this window. */
12720 goto finish_scroll_bars
;
12722 else if ((w
!= XWINDOW (minibuf_window
)
12723 || minibuf_level
== 0)
12724 /* When buffer is nonempty, redisplay window normally. */
12725 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
12726 /* Quail displays non-mini buffers in minibuffer window.
12727 In that case, redisplay the window normally. */
12728 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
12730 /* W is a mini-buffer window, but it's not active, so clear
12732 int yb
= window_text_bottom_y (w
);
12733 struct glyph_row
*row
;
12736 for (y
= 0, row
= w
->desired_matrix
->rows
;
12738 y
+= row
->height
, ++row
)
12739 blank_row (w
, row
, y
);
12740 goto finish_scroll_bars
;
12743 clear_glyph_matrix (w
->desired_matrix
);
12746 /* Otherwise set up data on this window; select its buffer and point
12748 /* Really select the buffer, for the sake of buffer-local
12750 set_buffer_internal_1 (XBUFFER (w
->buffer
));
12751 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
12753 current_matrix_up_to_date_p
12754 = (!NILP (w
->window_end_valid
)
12755 && !current_buffer
->clip_changed
12756 && !current_buffer
->prevent_redisplay_optimizations_p
12757 && XFASTINT (w
->last_modified
) >= MODIFF
12758 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
12761 = (!NILP (w
->window_end_valid
)
12762 && !current_buffer
->clip_changed
12763 && XFASTINT (w
->last_modified
) >= MODIFF
12764 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
12766 /* When windows_or_buffers_changed is non-zero, we can't rely on
12767 the window end being valid, so set it to nil there. */
12768 if (windows_or_buffers_changed
)
12770 /* If window starts on a continuation line, maybe adjust the
12771 window start in case the window's width changed. */
12772 if (XMARKER (w
->start
)->buffer
== current_buffer
)
12773 compute_window_start_on_continuation_line (w
);
12775 w
->window_end_valid
= Qnil
;
12778 /* Some sanity checks. */
12779 CHECK_WINDOW_END (w
);
12780 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
12782 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
12785 /* If %c is in mode line, update it if needed. */
12786 if (!NILP (w
->column_number_displayed
)
12787 /* This alternative quickly identifies a common case
12788 where no change is needed. */
12789 && !(PT
== XFASTINT (w
->last_point
)
12790 && XFASTINT (w
->last_modified
) >= MODIFF
12791 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
12792 && (XFASTINT (w
->column_number_displayed
)
12793 != (int) current_column ())) /* iftc */
12794 update_mode_line
= 1;
12796 /* Count number of windows showing the selected buffer. An indirect
12797 buffer counts as its base buffer. */
12798 if (!just_this_one_p
)
12800 struct buffer
*current_base
, *window_base
;
12801 current_base
= current_buffer
;
12802 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
12803 if (current_base
->base_buffer
)
12804 current_base
= current_base
->base_buffer
;
12805 if (window_base
->base_buffer
)
12806 window_base
= window_base
->base_buffer
;
12807 if (current_base
== window_base
)
12811 /* Point refers normally to the selected window. For any other
12812 window, set up appropriate value. */
12813 if (!EQ (window
, selected_window
))
12815 int new_pt
= XMARKER (w
->pointm
)->charpos
;
12816 int new_pt_byte
= marker_byte_position (w
->pointm
);
12820 new_pt_byte
= BEGV_BYTE
;
12821 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
12823 else if (new_pt
> (ZV
- 1))
12826 new_pt_byte
= ZV_BYTE
;
12827 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
12830 /* We don't use SET_PT so that the point-motion hooks don't run. */
12831 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
12834 /* If any of the character widths specified in the display table
12835 have changed, invalidate the width run cache. It's true that
12836 this may be a bit late to catch such changes, but the rest of
12837 redisplay goes (non-fatally) haywire when the display table is
12838 changed, so why should we worry about doing any better? */
12839 if (current_buffer
->width_run_cache
)
12841 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
12843 if (! disptab_matches_widthtab (disptab
,
12844 XVECTOR (current_buffer
->width_table
)))
12846 invalidate_region_cache (current_buffer
,
12847 current_buffer
->width_run_cache
,
12849 recompute_width_table (current_buffer
, disptab
);
12853 /* If window-start is screwed up, choose a new one. */
12854 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
12857 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12859 /* If someone specified a new starting point but did not insist,
12860 check whether it can be used. */
12861 if (!NILP (w
->optional_new_start
)
12862 && CHARPOS (startp
) >= BEGV
12863 && CHARPOS (startp
) <= ZV
)
12865 w
->optional_new_start
= Qnil
;
12866 start_display (&it
, w
, startp
);
12867 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
12868 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
12869 if (IT_CHARPOS (it
) == PT
)
12870 w
->force_start
= Qt
;
12871 /* IT may overshoot PT if text at PT is invisible. */
12872 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
12873 w
->force_start
= Qt
;
12876 /* Handle case where place to start displaying has been specified,
12877 unless the specified location is outside the accessible range. */
12878 if (!NILP (w
->force_start
)
12879 || w
->frozen_window_start_p
)
12881 /* We set this later on if we have to adjust point. */
12885 w
->force_start
= Qnil
;
12887 w
->window_end_valid
= Qnil
;
12889 /* Forget any recorded base line for line number display. */
12890 if (!buffer_unchanged_p
)
12891 w
->base_line_number
= Qnil
;
12893 /* Redisplay the mode line. Select the buffer properly for that.
12894 Also, run the hook window-scroll-functions
12895 because we have scrolled. */
12896 /* Note, we do this after clearing force_start because
12897 if there's an error, it is better to forget about force_start
12898 than to get into an infinite loop calling the hook functions
12899 and having them get more errors. */
12900 if (!update_mode_line
12901 || ! NILP (Vwindow_scroll_functions
))
12903 update_mode_line
= 1;
12904 w
->update_mode_line
= Qt
;
12905 startp
= run_window_scroll_functions (window
, startp
);
12908 w
->last_modified
= make_number (0);
12909 w
->last_overlay_modified
= make_number (0);
12910 if (CHARPOS (startp
) < BEGV
)
12911 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
12912 else if (CHARPOS (startp
) > ZV
)
12913 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
12915 /* Redisplay, then check if cursor has been set during the
12916 redisplay. Give up if new fonts were loaded. */
12917 val
= try_window (window
, startp
, 1);
12920 w
->force_start
= Qt
;
12921 clear_glyph_matrix (w
->desired_matrix
);
12922 goto need_larger_matrices
;
12924 /* Point was outside the scroll margins. */
12926 new_vpos
= window_box_height (w
) / 2;
12928 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
12930 /* If point does not appear, try to move point so it does
12931 appear. The desired matrix has been built above, so we
12932 can use it here. */
12933 new_vpos
= window_box_height (w
) / 2;
12936 if (!cursor_row_fully_visible_p (w
, 0, 0))
12938 /* Point does appear, but on a line partly visible at end of window.
12939 Move it back to a fully-visible line. */
12940 new_vpos
= window_box_height (w
);
12943 /* If we need to move point for either of the above reasons,
12944 now actually do it. */
12947 struct glyph_row
*row
;
12949 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
12950 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
12953 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
12954 MATRIX_ROW_START_BYTEPOS (row
));
12956 if (w
!= XWINDOW (selected_window
))
12957 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
12958 else if (current_buffer
== old
)
12959 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
12961 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
12963 /* If we are highlighting the region, then we just changed
12964 the region, so redisplay to show it. */
12965 if (!NILP (Vtransient_mark_mode
)
12966 && !NILP (current_buffer
->mark_active
))
12968 clear_glyph_matrix (w
->desired_matrix
);
12969 if (!try_window (window
, startp
, 0))
12970 goto need_larger_matrices
;
12975 debug_method_add (w
, "forced window start");
12980 /* Handle case where text has not changed, only point, and it has
12981 not moved off the frame, and we are not retrying after hscroll.
12982 (current_matrix_up_to_date_p is nonzero when retrying.) */
12983 if (current_matrix_up_to_date_p
12984 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
12985 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
12989 case CURSOR_MOVEMENT_SUCCESS
:
12990 used_current_matrix_p
= 1;
12993 #if 0 /* try_cursor_movement never returns this value. */
12994 case CURSOR_MOVEMENT_NEED_LARGER_MATRICES
:
12995 goto need_larger_matrices
;
12998 case CURSOR_MOVEMENT_MUST_SCROLL
:
12999 goto try_to_scroll
;
13005 /* If current starting point was originally the beginning of a line
13006 but no longer is, find a new starting point. */
13007 else if (!NILP (w
->start_at_line_beg
)
13008 && !(CHARPOS (startp
) <= BEGV
13009 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
13012 debug_method_add (w
, "recenter 1");
13017 /* Try scrolling with try_window_id. Value is > 0 if update has
13018 been done, it is -1 if we know that the same window start will
13019 not work. It is 0 if unsuccessful for some other reason. */
13020 else if ((tem
= try_window_id (w
)) != 0)
13023 debug_method_add (w
, "try_window_id %d", tem
);
13026 if (fonts_changed_p
)
13027 goto need_larger_matrices
;
13031 /* Otherwise try_window_id has returned -1 which means that we
13032 don't want the alternative below this comment to execute. */
13034 else if (CHARPOS (startp
) >= BEGV
13035 && CHARPOS (startp
) <= ZV
13036 && PT
>= CHARPOS (startp
)
13037 && (CHARPOS (startp
) < ZV
13038 /* Avoid starting at end of buffer. */
13039 || CHARPOS (startp
) == BEGV
13040 || (XFASTINT (w
->last_modified
) >= MODIFF
13041 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
13044 /* If first window line is a continuation line, and window start
13045 is inside the modified region, but the first change is before
13046 current window start, we must select a new window start.*/
13047 if (NILP (w
->start_at_line_beg
)
13048 && CHARPOS (startp
) > BEGV
)
13050 /* Make sure beg_unchanged and end_unchanged are up to date.
13051 Do it only if buffer has really changed. This may or may
13052 not have been done by try_window_id (see which) already. */
13053 if (MODIFF
> SAVE_MODIFF
13054 /* This seems to happen sometimes after saving a buffer. */
13055 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
13057 if (GPT
- BEG
< BEG_UNCHANGED
)
13058 BEG_UNCHANGED
= GPT
- BEG
;
13059 if (Z
- GPT
< END_UNCHANGED
)
13060 END_UNCHANGED
= Z
- GPT
;
13063 if (CHARPOS (startp
) > BEG
+ BEG_UNCHANGED
13064 && CHARPOS (startp
) <= Z
- END_UNCHANGED
)
13066 /* There doesn't seems to be a simple way to find a new
13067 window start that is near the old window start, so
13068 we just recenter. */
13074 debug_method_add (w
, "same window start");
13077 /* Try to redisplay starting at same place as before.
13078 If point has not moved off frame, accept the results. */
13079 if (!current_matrix_up_to_date_p
13080 /* Don't use try_window_reusing_current_matrix in this case
13081 because a window scroll function can have changed the
13083 || !NILP (Vwindow_scroll_functions
)
13084 || MINI_WINDOW_P (w
)
13085 || !(used_current_matrix_p
13086 = try_window_reusing_current_matrix (w
)))
13088 IF_DEBUG (debug_method_add (w
, "1"));
13089 if (try_window (window
, startp
, 1) < 0)
13090 /* -1 means we need to scroll.
13091 0 means we need new matrices, but fonts_changed_p
13092 is set in that case, so we will detect it below. */
13093 goto try_to_scroll
;
13096 if (fonts_changed_p
)
13097 goto need_larger_matrices
;
13099 if (w
->cursor
.vpos
>= 0)
13101 if (!just_this_one_p
13102 || current_buffer
->clip_changed
13103 || BEG_UNCHANGED
< CHARPOS (startp
))
13104 /* Forget any recorded base line for line number display. */
13105 w
->base_line_number
= Qnil
;
13107 if (!cursor_row_fully_visible_p (w
, 1, 0))
13109 clear_glyph_matrix (w
->desired_matrix
);
13110 last_line_misfit
= 1;
13112 /* Drop through and scroll. */
13117 clear_glyph_matrix (w
->desired_matrix
);
13122 w
->last_modified
= make_number (0);
13123 w
->last_overlay_modified
= make_number (0);
13125 /* Redisplay the mode line. Select the buffer properly for that. */
13126 if (!update_mode_line
)
13128 update_mode_line
= 1;
13129 w
->update_mode_line
= Qt
;
13132 /* Try to scroll by specified few lines. */
13133 if ((scroll_conservatively
13135 || temp_scroll_step
13136 || NUMBERP (current_buffer
->scroll_up_aggressively
)
13137 || NUMBERP (current_buffer
->scroll_down_aggressively
))
13138 && !current_buffer
->clip_changed
13139 && CHARPOS (startp
) >= BEGV
13140 && CHARPOS (startp
) <= ZV
)
13142 /* The function returns -1 if new fonts were loaded, 1 if
13143 successful, 0 if not successful. */
13144 int rc
= try_scrolling (window
, just_this_one_p
,
13145 scroll_conservatively
,
13147 temp_scroll_step
, last_line_misfit
);
13150 case SCROLLING_SUCCESS
:
13153 case SCROLLING_NEED_LARGER_MATRICES
:
13154 goto need_larger_matrices
;
13156 case SCROLLING_FAILED
:
13164 /* Finally, just choose place to start which centers point */
13167 if (centering_position
< 0)
13168 centering_position
= window_box_height (w
) / 2;
13171 debug_method_add (w
, "recenter");
13174 /* w->vscroll = 0; */
13176 /* Forget any previously recorded base line for line number display. */
13177 if (!buffer_unchanged_p
)
13178 w
->base_line_number
= Qnil
;
13180 /* Move backward half the height of the window. */
13181 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
13182 it
.current_y
= it
.last_visible_y
;
13183 move_it_vertically_backward (&it
, centering_position
);
13184 xassert (IT_CHARPOS (it
) >= BEGV
);
13186 /* The function move_it_vertically_backward may move over more
13187 than the specified y-distance. If it->w is small, e.g. a
13188 mini-buffer window, we may end up in front of the window's
13189 display area. Start displaying at the start of the line
13190 containing PT in this case. */
13191 if (it
.current_y
<= 0)
13193 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
13194 move_it_vertically_backward (&it
, 0);
13196 /* I think this assert is bogus if buffer contains
13197 invisible text or images. KFS. */
13198 xassert (IT_CHARPOS (it
) <= PT
);
13203 it
.current_x
= it
.hpos
= 0;
13205 /* Set startp here explicitly in case that helps avoid an infinite loop
13206 in case the window-scroll-functions functions get errors. */
13207 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
13209 /* Run scroll hooks. */
13210 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
13212 /* Redisplay the window. */
13213 if (!current_matrix_up_to_date_p
13214 || windows_or_buffers_changed
13215 || cursor_type_changed
13216 /* Don't use try_window_reusing_current_matrix in this case
13217 because it can have changed the buffer. */
13218 || !NILP (Vwindow_scroll_functions
)
13219 || !just_this_one_p
13220 || MINI_WINDOW_P (w
)
13221 || !(used_current_matrix_p
13222 = try_window_reusing_current_matrix (w
)))
13223 try_window (window
, startp
, 0);
13225 /* If new fonts have been loaded (due to fontsets), give up. We
13226 have to start a new redisplay since we need to re-adjust glyph
13228 if (fonts_changed_p
)
13229 goto need_larger_matrices
;
13231 /* If cursor did not appear assume that the middle of the window is
13232 in the first line of the window. Do it again with the next line.
13233 (Imagine a window of height 100, displaying two lines of height
13234 60. Moving back 50 from it->last_visible_y will end in the first
13236 if (w
->cursor
.vpos
< 0)
13238 if (!NILP (w
->window_end_valid
)
13239 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
13241 clear_glyph_matrix (w
->desired_matrix
);
13242 move_it_by_lines (&it
, 1, 0);
13243 try_window (window
, it
.current
.pos
, 0);
13245 else if (PT
< IT_CHARPOS (it
))
13247 clear_glyph_matrix (w
->desired_matrix
);
13248 move_it_by_lines (&it
, -1, 0);
13249 try_window (window
, it
.current
.pos
, 0);
13253 /* Not much we can do about it. */
13257 /* Consider the following case: Window starts at BEGV, there is
13258 invisible, intangible text at BEGV, so that display starts at
13259 some point START > BEGV. It can happen that we are called with
13260 PT somewhere between BEGV and START. Try to handle that case. */
13261 if (w
->cursor
.vpos
< 0)
13263 struct glyph_row
*row
= w
->current_matrix
->rows
;
13264 if (row
->mode_line_p
)
13266 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13269 if (!cursor_row_fully_visible_p (w
, 0, 0))
13271 /* If vscroll is enabled, disable it and try again. */
13275 clear_glyph_matrix (w
->desired_matrix
);
13279 /* If centering point failed to make the whole line visible,
13280 put point at the top instead. That has to make the whole line
13281 visible, if it can be done. */
13282 if (centering_position
== 0)
13285 clear_glyph_matrix (w
->desired_matrix
);
13286 centering_position
= 0;
13292 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13293 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
13294 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
13297 /* Display the mode line, if we must. */
13298 if ((update_mode_line
13299 /* If window not full width, must redo its mode line
13300 if (a) the window to its side is being redone and
13301 (b) we do a frame-based redisplay. This is a consequence
13302 of how inverted lines are drawn in frame-based redisplay. */
13303 || (!just_this_one_p
13304 && !FRAME_WINDOW_P (f
)
13305 && !WINDOW_FULL_WIDTH_P (w
))
13306 /* Line number to display. */
13307 || INTEGERP (w
->base_line_pos
)
13308 /* Column number is displayed and different from the one displayed. */
13309 || (!NILP (w
->column_number_displayed
)
13310 && (XFASTINT (w
->column_number_displayed
)
13311 != (int) current_column ()))) /* iftc */
13312 /* This means that the window has a mode line. */
13313 && (WINDOW_WANTS_MODELINE_P (w
)
13314 || WINDOW_WANTS_HEADER_LINE_P (w
)))
13316 display_mode_lines (w
);
13318 /* If mode line height has changed, arrange for a thorough
13319 immediate redisplay using the correct mode line height. */
13320 if (WINDOW_WANTS_MODELINE_P (w
)
13321 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
13323 fonts_changed_p
= 1;
13324 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
13325 = DESIRED_MODE_LINE_HEIGHT (w
);
13328 /* If top line height has changed, arrange for a thorough
13329 immediate redisplay using the correct mode line height. */
13330 if (WINDOW_WANTS_HEADER_LINE_P (w
)
13331 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
13333 fonts_changed_p
= 1;
13334 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
13335 = DESIRED_HEADER_LINE_HEIGHT (w
);
13338 if (fonts_changed_p
)
13339 goto need_larger_matrices
;
13342 if (!line_number_displayed
13343 && !BUFFERP (w
->base_line_pos
))
13345 w
->base_line_pos
= Qnil
;
13346 w
->base_line_number
= Qnil
;
13351 /* When we reach a frame's selected window, redo the frame's menu bar. */
13352 if (update_mode_line
13353 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
13355 int redisplay_menu_p
= 0;
13356 int redisplay_tool_bar_p
= 0;
13358 if (FRAME_WINDOW_P (f
))
13360 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
13361 || defined (USE_GTK)
13362 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
13364 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
13368 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
13370 if (redisplay_menu_p
)
13371 display_menu_bar (w
);
13373 #ifdef HAVE_WINDOW_SYSTEM
13375 redisplay_tool_bar_p
= FRAME_EXTERNAL_TOOL_BAR (f
);
13377 redisplay_tool_bar_p
= WINDOWP (f
->tool_bar_window
)
13378 && (FRAME_TOOL_BAR_LINES (f
) > 0
13379 || auto_resize_tool_bars_p
);
13383 if (redisplay_tool_bar_p
)
13384 redisplay_tool_bar (f
);
13388 #ifdef HAVE_WINDOW_SYSTEM
13389 if (FRAME_WINDOW_P (f
)
13390 && update_window_fringes (w
, (just_this_one_p
13391 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
13392 || w
->pseudo_window_p
)))
13396 if (draw_window_fringes (w
, 1))
13397 x_draw_vertical_border (w
);
13401 #endif /* HAVE_WINDOW_SYSTEM */
13403 /* We go to this label, with fonts_changed_p nonzero,
13404 if it is necessary to try again using larger glyph matrices.
13405 We have to redeem the scroll bar even in this case,
13406 because the loop in redisplay_internal expects that. */
13407 need_larger_matrices
:
13409 finish_scroll_bars
:
13411 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
13413 /* Set the thumb's position and size. */
13414 set_vertical_scroll_bar (w
);
13416 /* Note that we actually used the scroll bar attached to this
13417 window, so it shouldn't be deleted at the end of redisplay. */
13418 redeem_scroll_bar_hook (w
);
13421 /* Restore current_buffer and value of point in it. */
13422 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
13423 set_buffer_internal_1 (old
);
13424 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
13426 unbind_to (count
, Qnil
);
13430 /* Build the complete desired matrix of WINDOW with a window start
13431 buffer position POS.
13433 Value is 1 if successful. It is zero if fonts were loaded during
13434 redisplay which makes re-adjusting glyph matrices necessary, and -1
13435 if point would appear in the scroll margins.
13436 (We check that only if CHECK_MARGINS is nonzero. */
13439 try_window (window
, pos
, check_margins
)
13440 Lisp_Object window
;
13441 struct text_pos pos
;
13444 struct window
*w
= XWINDOW (window
);
13446 struct glyph_row
*last_text_row
= NULL
;
13448 /* Make POS the new window start. */
13449 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
13451 /* Mark cursor position as unknown. No overlay arrow seen. */
13452 w
->cursor
.vpos
= -1;
13453 overlay_arrow_seen
= 0;
13455 /* Initialize iterator and info to start at POS. */
13456 start_display (&it
, w
, pos
);
13458 /* Display all lines of W. */
13459 while (it
.current_y
< it
.last_visible_y
)
13461 if (display_line (&it
))
13462 last_text_row
= it
.glyph_row
- 1;
13463 if (fonts_changed_p
)
13467 /* Don't let the cursor end in the scroll margins. */
13469 && !MINI_WINDOW_P (w
))
13471 int this_scroll_margin
;
13473 this_scroll_margin
= max (0, scroll_margin
);
13474 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
13475 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
13477 if ((w
->cursor
.y
< this_scroll_margin
13478 && CHARPOS (pos
) > BEGV
13479 && IT_CHARPOS (it
) < ZV
)
13480 /* rms: considering make_cursor_line_fully_visible_p here
13481 seems to give wrong results. We don't want to recenter
13482 when the last line is partly visible, we want to allow
13483 that case to be handled in the usual way. */
13484 || (w
->cursor
.y
+ 1) > it
.last_visible_y
)
13486 w
->cursor
.vpos
= -1;
13487 clear_glyph_matrix (w
->desired_matrix
);
13492 /* If bottom moved off end of frame, change mode line percentage. */
13493 if (XFASTINT (w
->window_end_pos
) <= 0
13494 && Z
!= IT_CHARPOS (it
))
13495 w
->update_mode_line
= Qt
;
13497 /* Set window_end_pos to the offset of the last character displayed
13498 on the window from the end of current_buffer. Set
13499 window_end_vpos to its row number. */
13502 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
13503 w
->window_end_bytepos
13504 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
13506 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
13508 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
13509 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
13510 ->displays_text_p
);
13514 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
13515 w
->window_end_pos
= make_number (Z
- ZV
);
13516 w
->window_end_vpos
= make_number (0);
13519 /* But that is not valid info until redisplay finishes. */
13520 w
->window_end_valid
= Qnil
;
13526 /************************************************************************
13527 Window redisplay reusing current matrix when buffer has not changed
13528 ************************************************************************/
13530 /* Try redisplay of window W showing an unchanged buffer with a
13531 different window start than the last time it was displayed by
13532 reusing its current matrix. Value is non-zero if successful.
13533 W->start is the new window start. */
13536 try_window_reusing_current_matrix (w
)
13539 struct frame
*f
= XFRAME (w
->frame
);
13540 struct glyph_row
*row
, *bottom_row
;
13543 struct text_pos start
, new_start
;
13544 int nrows_scrolled
, i
;
13545 struct glyph_row
*last_text_row
;
13546 struct glyph_row
*last_reused_text_row
;
13547 struct glyph_row
*start_row
;
13548 int start_vpos
, min_y
, max_y
;
13551 if (inhibit_try_window_reusing
)
13555 if (/* This function doesn't handle terminal frames. */
13556 !FRAME_WINDOW_P (f
)
13557 /* Don't try to reuse the display if windows have been split
13559 || windows_or_buffers_changed
13560 || cursor_type_changed
)
13563 /* Can't do this if region may have changed. */
13564 if ((!NILP (Vtransient_mark_mode
)
13565 && !NILP (current_buffer
->mark_active
))
13566 || !NILP (w
->region_showing
)
13567 || !NILP (Vshow_trailing_whitespace
))
13570 /* If top-line visibility has changed, give up. */
13571 if (WINDOW_WANTS_HEADER_LINE_P (w
)
13572 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
13575 /* Give up if old or new display is scrolled vertically. We could
13576 make this function handle this, but right now it doesn't. */
13577 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
13578 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
13581 /* The variable new_start now holds the new window start. The old
13582 start `start' can be determined from the current matrix. */
13583 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
13584 start
= start_row
->start
.pos
;
13585 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
13587 /* Clear the desired matrix for the display below. */
13588 clear_glyph_matrix (w
->desired_matrix
);
13590 if (CHARPOS (new_start
) <= CHARPOS (start
))
13594 /* Don't use this method if the display starts with an ellipsis
13595 displayed for invisible text. It's not easy to handle that case
13596 below, and it's certainly not worth the effort since this is
13597 not a frequent case. */
13598 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
13601 IF_DEBUG (debug_method_add (w
, "twu1"));
13603 /* Display up to a row that can be reused. The variable
13604 last_text_row is set to the last row displayed that displays
13605 text. Note that it.vpos == 0 if or if not there is a
13606 header-line; it's not the same as the MATRIX_ROW_VPOS! */
13607 start_display (&it
, w
, new_start
);
13608 first_row_y
= it
.current_y
;
13609 w
->cursor
.vpos
= -1;
13610 last_text_row
= last_reused_text_row
= NULL
;
13612 while (it
.current_y
< it
.last_visible_y
13613 && !fonts_changed_p
)
13615 /* If we have reached into the characters in the START row,
13616 that means the line boundaries have changed. So we
13617 can't start copying with the row START. Maybe it will
13618 work to start copying with the following row. */
13619 while (IT_CHARPOS (it
) > CHARPOS (start
))
13621 /* Advance to the next row as the "start". */
13623 start
= start_row
->start
.pos
;
13624 /* If there are no more rows to try, or just one, give up. */
13625 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
13626 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
13627 || CHARPOS (start
) == ZV
)
13629 clear_glyph_matrix (w
->desired_matrix
);
13633 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
13635 /* If we have reached alignment,
13636 we can copy the rest of the rows. */
13637 if (IT_CHARPOS (it
) == CHARPOS (start
))
13640 if (display_line (&it
))
13641 last_text_row
= it
.glyph_row
- 1;
13644 /* A value of current_y < last_visible_y means that we stopped
13645 at the previous window start, which in turn means that we
13646 have at least one reusable row. */
13647 if (it
.current_y
< it
.last_visible_y
)
13649 /* IT.vpos always starts from 0; it counts text lines. */
13650 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
13652 /* Find PT if not already found in the lines displayed. */
13653 if (w
->cursor
.vpos
< 0)
13655 int dy
= it
.current_y
- start_row
->y
;
13657 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
13658 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
13660 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
13661 dy
, nrows_scrolled
);
13664 clear_glyph_matrix (w
->desired_matrix
);
13669 /* Scroll the display. Do it before the current matrix is
13670 changed. The problem here is that update has not yet
13671 run, i.e. part of the current matrix is not up to date.
13672 scroll_run_hook will clear the cursor, and use the
13673 current matrix to get the height of the row the cursor is
13675 run
.current_y
= start_row
->y
;
13676 run
.desired_y
= it
.current_y
;
13677 run
.height
= it
.last_visible_y
- it
.current_y
;
13679 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
13682 rif
->update_window_begin_hook (w
);
13683 rif
->clear_window_mouse_face (w
);
13684 rif
->scroll_run_hook (w
, &run
);
13685 rif
->update_window_end_hook (w
, 0, 0);
13689 /* Shift current matrix down by nrows_scrolled lines. */
13690 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
13691 rotate_matrix (w
->current_matrix
,
13693 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
13696 /* Disable lines that must be updated. */
13697 for (i
= 0; i
< it
.vpos
; ++i
)
13698 (start_row
+ i
)->enabled_p
= 0;
13700 /* Re-compute Y positions. */
13701 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
13702 max_y
= it
.last_visible_y
;
13703 for (row
= start_row
+ nrows_scrolled
;
13707 row
->y
= it
.current_y
;
13708 row
->visible_height
= row
->height
;
13710 if (row
->y
< min_y
)
13711 row
->visible_height
-= min_y
- row
->y
;
13712 if (row
->y
+ row
->height
> max_y
)
13713 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
13714 row
->redraw_fringe_bitmaps_p
= 1;
13716 it
.current_y
+= row
->height
;
13718 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
13719 last_reused_text_row
= row
;
13720 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
13724 /* Disable lines in the current matrix which are now
13725 below the window. */
13726 for (++row
; row
< bottom_row
; ++row
)
13727 row
->enabled_p
= row
->mode_line_p
= 0;
13730 /* Update window_end_pos etc.; last_reused_text_row is the last
13731 reused row from the current matrix containing text, if any.
13732 The value of last_text_row is the last displayed line
13733 containing text. */
13734 if (last_reused_text_row
)
13736 w
->window_end_bytepos
13737 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
13739 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
13741 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
13742 w
->current_matrix
));
13744 else if (last_text_row
)
13746 w
->window_end_bytepos
13747 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
13749 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
13751 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
13755 /* This window must be completely empty. */
13756 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
13757 w
->window_end_pos
= make_number (Z
- ZV
);
13758 w
->window_end_vpos
= make_number (0);
13760 w
->window_end_valid
= Qnil
;
13762 /* Update hint: don't try scrolling again in update_window. */
13763 w
->desired_matrix
->no_scrolling_p
= 1;
13766 debug_method_add (w
, "try_window_reusing_current_matrix 1");
13770 else if (CHARPOS (new_start
) > CHARPOS (start
))
13772 struct glyph_row
*pt_row
, *row
;
13773 struct glyph_row
*first_reusable_row
;
13774 struct glyph_row
*first_row_to_display
;
13776 int yb
= window_text_bottom_y (w
);
13778 /* Find the row starting at new_start, if there is one. Don't
13779 reuse a partially visible line at the end. */
13780 first_reusable_row
= start_row
;
13781 while (first_reusable_row
->enabled_p
13782 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
13783 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
13784 < CHARPOS (new_start
)))
13785 ++first_reusable_row
;
13787 /* Give up if there is no row to reuse. */
13788 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
13789 || !first_reusable_row
->enabled_p
13790 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
13791 != CHARPOS (new_start
)))
13794 /* We can reuse fully visible rows beginning with
13795 first_reusable_row to the end of the window. Set
13796 first_row_to_display to the first row that cannot be reused.
13797 Set pt_row to the row containing point, if there is any. */
13799 for (first_row_to_display
= first_reusable_row
;
13800 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
13801 ++first_row_to_display
)
13803 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
13804 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
13805 pt_row
= first_row_to_display
;
13808 /* Start displaying at the start of first_row_to_display. */
13809 xassert (first_row_to_display
->y
< yb
);
13810 init_to_row_start (&it
, w
, first_row_to_display
);
13812 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
13814 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
13816 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
13817 + WINDOW_HEADER_LINE_HEIGHT (w
));
13819 /* Display lines beginning with first_row_to_display in the
13820 desired matrix. Set last_text_row to the last row displayed
13821 that displays text. */
13822 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
13823 if (pt_row
== NULL
)
13824 w
->cursor
.vpos
= -1;
13825 last_text_row
= NULL
;
13826 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
13827 if (display_line (&it
))
13828 last_text_row
= it
.glyph_row
- 1;
13830 /* Give up If point isn't in a row displayed or reused. */
13831 if (w
->cursor
.vpos
< 0)
13833 clear_glyph_matrix (w
->desired_matrix
);
13837 /* If point is in a reused row, adjust y and vpos of the cursor
13841 w
->cursor
.vpos
-= nrows_scrolled
;
13842 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
13845 /* Scroll the display. */
13846 run
.current_y
= first_reusable_row
->y
;
13847 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
13848 run
.height
= it
.last_visible_y
- run
.current_y
;
13849 dy
= run
.current_y
- run
.desired_y
;
13854 rif
->update_window_begin_hook (w
);
13855 rif
->clear_window_mouse_face (w
);
13856 rif
->scroll_run_hook (w
, &run
);
13857 rif
->update_window_end_hook (w
, 0, 0);
13861 /* Adjust Y positions of reused rows. */
13862 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
13863 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
13864 max_y
= it
.last_visible_y
;
13865 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
13868 row
->visible_height
= row
->height
;
13869 if (row
->y
< min_y
)
13870 row
->visible_height
-= min_y
- row
->y
;
13871 if (row
->y
+ row
->height
> max_y
)
13872 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
13873 row
->redraw_fringe_bitmaps_p
= 1;
13876 /* Scroll the current matrix. */
13877 xassert (nrows_scrolled
> 0);
13878 rotate_matrix (w
->current_matrix
,
13880 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
13883 /* Disable rows not reused. */
13884 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
13885 row
->enabled_p
= 0;
13887 /* Point may have moved to a different line, so we cannot assume that
13888 the previous cursor position is valid; locate the correct row. */
13891 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
13892 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
13896 w
->cursor
.y
= row
->y
;
13898 if (row
< bottom_row
)
13900 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
13901 while (glyph
->charpos
< PT
)
13904 w
->cursor
.x
+= glyph
->pixel_width
;
13910 /* Adjust window end. A null value of last_text_row means that
13911 the window end is in reused rows which in turn means that
13912 only its vpos can have changed. */
13915 w
->window_end_bytepos
13916 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
13918 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
13920 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
13925 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
13928 w
->window_end_valid
= Qnil
;
13929 w
->desired_matrix
->no_scrolling_p
= 1;
13932 debug_method_add (w
, "try_window_reusing_current_matrix 2");
13942 /************************************************************************
13943 Window redisplay reusing current matrix when buffer has changed
13944 ************************************************************************/
13946 static struct glyph_row
*find_last_unchanged_at_beg_row
P_ ((struct window
*));
13947 static struct glyph_row
*find_first_unchanged_at_end_row
P_ ((struct window
*,
13949 static struct glyph_row
*
13950 find_last_row_displaying_text
P_ ((struct glyph_matrix
*, struct it
*,
13951 struct glyph_row
*));
13954 /* Return the last row in MATRIX displaying text. If row START is
13955 non-null, start searching with that row. IT gives the dimensions
13956 of the display. Value is null if matrix is empty; otherwise it is
13957 a pointer to the row found. */
13959 static struct glyph_row
*
13960 find_last_row_displaying_text (matrix
, it
, start
)
13961 struct glyph_matrix
*matrix
;
13963 struct glyph_row
*start
;
13965 struct glyph_row
*row
, *row_found
;
13967 /* Set row_found to the last row in IT->w's current matrix
13968 displaying text. The loop looks funny but think of partially
13971 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
13972 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
13974 xassert (row
->enabled_p
);
13976 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
13985 /* Return the last row in the current matrix of W that is not affected
13986 by changes at the start of current_buffer that occurred since W's
13987 current matrix was built. Value is null if no such row exists.
13989 BEG_UNCHANGED us the number of characters unchanged at the start of
13990 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
13991 first changed character in current_buffer. Characters at positions <
13992 BEG + BEG_UNCHANGED are at the same buffer positions as they were
13993 when the current matrix was built. */
13995 static struct glyph_row
*
13996 find_last_unchanged_at_beg_row (w
)
13999 int first_changed_pos
= BEG
+ BEG_UNCHANGED
;
14000 struct glyph_row
*row
;
14001 struct glyph_row
*row_found
= NULL
;
14002 int yb
= window_text_bottom_y (w
);
14004 /* Find the last row displaying unchanged text. */
14005 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14006 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
14007 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
)
14009 if (/* If row ends before first_changed_pos, it is unchanged,
14010 except in some case. */
14011 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
14012 /* When row ends in ZV and we write at ZV it is not
14014 && !row
->ends_at_zv_p
14015 /* When first_changed_pos is the end of a continued line,
14016 row is not unchanged because it may be no longer
14018 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
14019 && (row
->continued_p
14020 || row
->exact_window_width_line_p
)))
14023 /* Stop if last visible row. */
14024 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
14034 /* Find the first glyph row in the current matrix of W that is not
14035 affected by changes at the end of current_buffer since the
14036 time W's current matrix was built.
14038 Return in *DELTA the number of chars by which buffer positions in
14039 unchanged text at the end of current_buffer must be adjusted.
14041 Return in *DELTA_BYTES the corresponding number of bytes.
14043 Value is null if no such row exists, i.e. all rows are affected by
14046 static struct glyph_row
*
14047 find_first_unchanged_at_end_row (w
, delta
, delta_bytes
)
14049 int *delta
, *delta_bytes
;
14051 struct glyph_row
*row
;
14052 struct glyph_row
*row_found
= NULL
;
14054 *delta
= *delta_bytes
= 0;
14056 /* Display must not have been paused, otherwise the current matrix
14057 is not up to date. */
14058 if (NILP (w
->window_end_valid
))
14061 /* A value of window_end_pos >= END_UNCHANGED means that the window
14062 end is in the range of changed text. If so, there is no
14063 unchanged row at the end of W's current matrix. */
14064 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
14067 /* Set row to the last row in W's current matrix displaying text. */
14068 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
14070 /* If matrix is entirely empty, no unchanged row exists. */
14071 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14073 /* The value of row is the last glyph row in the matrix having a
14074 meaningful buffer position in it. The end position of row
14075 corresponds to window_end_pos. This allows us to translate
14076 buffer positions in the current matrix to current buffer
14077 positions for characters not in changed text. */
14078 int Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
14079 int Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
14080 int last_unchanged_pos
, last_unchanged_pos_old
;
14081 struct glyph_row
*first_text_row
14082 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14084 *delta
= Z
- Z_old
;
14085 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
14087 /* Set last_unchanged_pos to the buffer position of the last
14088 character in the buffer that has not been changed. Z is the
14089 index + 1 of the last character in current_buffer, i.e. by
14090 subtracting END_UNCHANGED we get the index of the last
14091 unchanged character, and we have to add BEG to get its buffer
14093 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
14094 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
14096 /* Search backward from ROW for a row displaying a line that
14097 starts at a minimum position >= last_unchanged_pos_old. */
14098 for (; row
> first_text_row
; --row
)
14100 /* This used to abort, but it can happen.
14101 It is ok to just stop the search instead here. KFS. */
14102 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14105 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
14110 if (row_found
&& !MATRIX_ROW_DISPLAYS_TEXT_P (row_found
))
14117 /* Make sure that glyph rows in the current matrix of window W
14118 reference the same glyph memory as corresponding rows in the
14119 frame's frame matrix. This function is called after scrolling W's
14120 current matrix on a terminal frame in try_window_id and
14121 try_window_reusing_current_matrix. */
14124 sync_frame_with_window_matrix_rows (w
)
14127 struct frame
*f
= XFRAME (w
->frame
);
14128 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
14130 /* Preconditions: W must be a leaf window and full-width. Its frame
14131 must have a frame matrix. */
14132 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
14133 xassert (WINDOW_FULL_WIDTH_P (w
));
14134 xassert (!FRAME_WINDOW_P (f
));
14136 /* If W is a full-width window, glyph pointers in W's current matrix
14137 have, by definition, to be the same as glyph pointers in the
14138 corresponding frame matrix. Note that frame matrices have no
14139 marginal areas (see build_frame_matrix). */
14140 window_row
= w
->current_matrix
->rows
;
14141 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
14142 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
14143 while (window_row
< window_row_end
)
14145 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
14146 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
14148 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
14149 frame_row
->glyphs
[TEXT_AREA
] = start
;
14150 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
14151 frame_row
->glyphs
[LAST_AREA
] = end
;
14153 /* Disable frame rows whose corresponding window rows have
14154 been disabled in try_window_id. */
14155 if (!window_row
->enabled_p
)
14156 frame_row
->enabled_p
= 0;
14158 ++window_row
, ++frame_row
;
14163 /* Find the glyph row in window W containing CHARPOS. Consider all
14164 rows between START and END (not inclusive). END null means search
14165 all rows to the end of the display area of W. Value is the row
14166 containing CHARPOS or null. */
14169 row_containing_pos (w
, charpos
, start
, end
, dy
)
14172 struct glyph_row
*start
, *end
;
14175 struct glyph_row
*row
= start
;
14178 /* If we happen to start on a header-line, skip that. */
14179 if (row
->mode_line_p
)
14182 if ((end
&& row
>= end
) || !row
->enabled_p
)
14185 last_y
= window_text_bottom_y (w
) - dy
;
14189 /* Give up if we have gone too far. */
14190 if (end
&& row
>= end
)
14192 /* This formerly returned if they were equal.
14193 I think that both quantities are of a "last plus one" type;
14194 if so, when they are equal, the row is within the screen. -- rms. */
14195 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
14198 /* If it is in this row, return this row. */
14199 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
14200 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
14201 /* The end position of a row equals the start
14202 position of the next row. If CHARPOS is there, we
14203 would rather display it in the next line, except
14204 when this line ends in ZV. */
14205 && !row
->ends_at_zv_p
14206 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
14207 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
14214 /* Try to redisplay window W by reusing its existing display. W's
14215 current matrix must be up to date when this function is called,
14216 i.e. window_end_valid must not be nil.
14220 1 if display has been updated
14221 0 if otherwise unsuccessful
14222 -1 if redisplay with same window start is known not to succeed
14224 The following steps are performed:
14226 1. Find the last row in the current matrix of W that is not
14227 affected by changes at the start of current_buffer. If no such row
14230 2. Find the first row in W's current matrix that is not affected by
14231 changes at the end of current_buffer. Maybe there is no such row.
14233 3. Display lines beginning with the row + 1 found in step 1 to the
14234 row found in step 2 or, if step 2 didn't find a row, to the end of
14237 4. If cursor is not known to appear on the window, give up.
14239 5. If display stopped at the row found in step 2, scroll the
14240 display and current matrix as needed.
14242 6. Maybe display some lines at the end of W, if we must. This can
14243 happen under various circumstances, like a partially visible line
14244 becoming fully visible, or because newly displayed lines are displayed
14245 in smaller font sizes.
14247 7. Update W's window end information. */
14253 struct frame
*f
= XFRAME (w
->frame
);
14254 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
14255 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
14256 struct glyph_row
*last_unchanged_at_beg_row
;
14257 struct glyph_row
*first_unchanged_at_end_row
;
14258 struct glyph_row
*row
;
14259 struct glyph_row
*bottom_row
;
14262 int delta
= 0, delta_bytes
= 0, stop_pos
, dvpos
, dy
;
14263 struct text_pos start_pos
;
14265 int first_unchanged_at_end_vpos
= 0;
14266 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
14267 struct text_pos start
;
14268 int first_changed_charpos
, last_changed_charpos
;
14271 if (inhibit_try_window_id
)
14275 /* This is handy for debugging. */
14277 #define GIVE_UP(X) \
14279 fprintf (stderr, "try_window_id give up %d\n", (X)); \
14283 #define GIVE_UP(X) return 0
14286 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
14288 /* Don't use this for mini-windows because these can show
14289 messages and mini-buffers, and we don't handle that here. */
14290 if (MINI_WINDOW_P (w
))
14293 /* This flag is used to prevent redisplay optimizations. */
14294 if (windows_or_buffers_changed
|| cursor_type_changed
)
14297 /* Verify that narrowing has not changed.
14298 Also verify that we were not told to prevent redisplay optimizations.
14299 It would be nice to further
14300 reduce the number of cases where this prevents try_window_id. */
14301 if (current_buffer
->clip_changed
14302 || current_buffer
->prevent_redisplay_optimizations_p
)
14305 /* Window must either use window-based redisplay or be full width. */
14306 if (!FRAME_WINDOW_P (f
)
14307 && (!line_ins_del_ok
14308 || !WINDOW_FULL_WIDTH_P (w
)))
14311 /* Give up if point is not known NOT to appear in W. */
14312 if (PT
< CHARPOS (start
))
14315 /* Another way to prevent redisplay optimizations. */
14316 if (XFASTINT (w
->last_modified
) == 0)
14319 /* Verify that window is not hscrolled. */
14320 if (XFASTINT (w
->hscroll
) != 0)
14323 /* Verify that display wasn't paused. */
14324 if (NILP (w
->window_end_valid
))
14327 /* Can't use this if highlighting a region because a cursor movement
14328 will do more than just set the cursor. */
14329 if (!NILP (Vtransient_mark_mode
)
14330 && !NILP (current_buffer
->mark_active
))
14333 /* Likewise if highlighting trailing whitespace. */
14334 if (!NILP (Vshow_trailing_whitespace
))
14337 /* Likewise if showing a region. */
14338 if (!NILP (w
->region_showing
))
14341 /* Can use this if overlay arrow position and or string have changed. */
14342 if (overlay_arrows_changed_p ())
14346 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
14347 only if buffer has really changed. The reason is that the gap is
14348 initially at Z for freshly visited files. The code below would
14349 set end_unchanged to 0 in that case. */
14350 if (MODIFF
> SAVE_MODIFF
14351 /* This seems to happen sometimes after saving a buffer. */
14352 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
14354 if (GPT
- BEG
< BEG_UNCHANGED
)
14355 BEG_UNCHANGED
= GPT
- BEG
;
14356 if (Z
- GPT
< END_UNCHANGED
)
14357 END_UNCHANGED
= Z
- GPT
;
14360 /* The position of the first and last character that has been changed. */
14361 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
14362 last_changed_charpos
= Z
- END_UNCHANGED
;
14364 /* If window starts after a line end, and the last change is in
14365 front of that newline, then changes don't affect the display.
14366 This case happens with stealth-fontification. Note that although
14367 the display is unchanged, glyph positions in the matrix have to
14368 be adjusted, of course. */
14369 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
14370 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
14371 && ((last_changed_charpos
< CHARPOS (start
)
14372 && CHARPOS (start
) == BEGV
)
14373 || (last_changed_charpos
< CHARPOS (start
) - 1
14374 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
14376 int Z_old
, delta
, Z_BYTE_old
, delta_bytes
;
14377 struct glyph_row
*r0
;
14379 /* Compute how many chars/bytes have been added to or removed
14380 from the buffer. */
14381 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
14382 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
14384 delta_bytes
= Z_BYTE
- Z_BYTE_old
;
14386 /* Give up if PT is not in the window. Note that it already has
14387 been checked at the start of try_window_id that PT is not in
14388 front of the window start. */
14389 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + delta
)
14392 /* If window start is unchanged, we can reuse the whole matrix
14393 as is, after adjusting glyph positions. No need to compute
14394 the window end again, since its offset from Z hasn't changed. */
14395 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
14396 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + delta
14397 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + delta_bytes
14398 /* PT must not be in a partially visible line. */
14399 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + delta
14400 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
14402 /* Adjust positions in the glyph matrix. */
14403 if (delta
|| delta_bytes
)
14405 struct glyph_row
*r1
14406 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
14407 increment_matrix_positions (w
->current_matrix
,
14408 MATRIX_ROW_VPOS (r0
, current_matrix
),
14409 MATRIX_ROW_VPOS (r1
, current_matrix
),
14410 delta
, delta_bytes
);
14413 /* Set the cursor. */
14414 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
14416 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
14423 /* Handle the case that changes are all below what is displayed in
14424 the window, and that PT is in the window. This shortcut cannot
14425 be taken if ZV is visible in the window, and text has been added
14426 there that is visible in the window. */
14427 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
14428 /* ZV is not visible in the window, or there are no
14429 changes at ZV, actually. */
14430 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
14431 || first_changed_charpos
== last_changed_charpos
))
14433 struct glyph_row
*r0
;
14435 /* Give up if PT is not in the window. Note that it already has
14436 been checked at the start of try_window_id that PT is not in
14437 front of the window start. */
14438 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
14441 /* If window start is unchanged, we can reuse the whole matrix
14442 as is, without changing glyph positions since no text has
14443 been added/removed in front of the window end. */
14444 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
14445 if (TEXT_POS_EQUAL_P (start
, r0
->start
.pos
)
14446 /* PT must not be in a partially visible line. */
14447 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
14448 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
14450 /* We have to compute the window end anew since text
14451 can have been added/removed after it. */
14453 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
14454 w
->window_end_bytepos
14455 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
14457 /* Set the cursor. */
14458 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
14460 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
14467 /* Give up if window start is in the changed area.
14469 The condition used to read
14471 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
14473 but why that was tested escapes me at the moment. */
14474 if (CHARPOS (start
) >= first_changed_charpos
14475 && CHARPOS (start
) <= last_changed_charpos
)
14478 /* Check that window start agrees with the start of the first glyph
14479 row in its current matrix. Check this after we know the window
14480 start is not in changed text, otherwise positions would not be
14482 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
14483 if (!TEXT_POS_EQUAL_P (start
, row
->start
.pos
))
14486 /* Give up if the window ends in strings. Overlay strings
14487 at the end are difficult to handle, so don't try. */
14488 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
14489 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
14492 /* Compute the position at which we have to start displaying new
14493 lines. Some of the lines at the top of the window might be
14494 reusable because they are not displaying changed text. Find the
14495 last row in W's current matrix not affected by changes at the
14496 start of current_buffer. Value is null if changes start in the
14497 first line of window. */
14498 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
14499 if (last_unchanged_at_beg_row
)
14501 /* Avoid starting to display in the moddle of a character, a TAB
14502 for instance. This is easier than to set up the iterator
14503 exactly, and it's not a frequent case, so the additional
14504 effort wouldn't really pay off. */
14505 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
14506 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
14507 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
14508 --last_unchanged_at_beg_row
;
14510 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
14513 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
14515 start_pos
= it
.current
.pos
;
14517 /* Start displaying new lines in the desired matrix at the same
14518 vpos we would use in the current matrix, i.e. below
14519 last_unchanged_at_beg_row. */
14520 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
14522 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
14523 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
14525 xassert (it
.hpos
== 0 && it
.current_x
== 0);
14529 /* There are no reusable lines at the start of the window.
14530 Start displaying in the first text line. */
14531 start_display (&it
, w
, start
);
14532 it
.vpos
= it
.first_vpos
;
14533 start_pos
= it
.current
.pos
;
14536 /* Find the first row that is not affected by changes at the end of
14537 the buffer. Value will be null if there is no unchanged row, in
14538 which case we must redisplay to the end of the window. delta
14539 will be set to the value by which buffer positions beginning with
14540 first_unchanged_at_end_row have to be adjusted due to text
14542 first_unchanged_at_end_row
14543 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
14544 IF_DEBUG (debug_delta
= delta
);
14545 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
14547 /* Set stop_pos to the buffer position up to which we will have to
14548 display new lines. If first_unchanged_at_end_row != NULL, this
14549 is the buffer position of the start of the line displayed in that
14550 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
14551 that we don't stop at a buffer position. */
14553 if (first_unchanged_at_end_row
)
14555 xassert (last_unchanged_at_beg_row
== NULL
14556 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
14558 /* If this is a continuation line, move forward to the next one
14559 that isn't. Changes in lines above affect this line.
14560 Caution: this may move first_unchanged_at_end_row to a row
14561 not displaying text. */
14562 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
14563 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
14564 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
14565 < it
.last_visible_y
))
14566 ++first_unchanged_at_end_row
;
14568 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
14569 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
14570 >= it
.last_visible_y
))
14571 first_unchanged_at_end_row
= NULL
;
14574 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
14576 first_unchanged_at_end_vpos
14577 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
14578 xassert (stop_pos
>= Z
- END_UNCHANGED
);
14581 else if (last_unchanged_at_beg_row
== NULL
)
14587 /* Either there is no unchanged row at the end, or the one we have
14588 now displays text. This is a necessary condition for the window
14589 end pos calculation at the end of this function. */
14590 xassert (first_unchanged_at_end_row
== NULL
14591 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
14593 debug_last_unchanged_at_beg_vpos
14594 = (last_unchanged_at_beg_row
14595 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
14597 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
14599 #endif /* GLYPH_DEBUG != 0 */
14602 /* Display new lines. Set last_text_row to the last new line
14603 displayed which has text on it, i.e. might end up as being the
14604 line where the window_end_vpos is. */
14605 w
->cursor
.vpos
= -1;
14606 last_text_row
= NULL
;
14607 overlay_arrow_seen
= 0;
14608 while (it
.current_y
< it
.last_visible_y
14609 && !fonts_changed_p
14610 && (first_unchanged_at_end_row
== NULL
14611 || IT_CHARPOS (it
) < stop_pos
))
14613 if (display_line (&it
))
14614 last_text_row
= it
.glyph_row
- 1;
14617 if (fonts_changed_p
)
14621 /* Compute differences in buffer positions, y-positions etc. for
14622 lines reused at the bottom of the window. Compute what we can
14624 if (first_unchanged_at_end_row
14625 /* No lines reused because we displayed everything up to the
14626 bottom of the window. */
14627 && it
.current_y
< it
.last_visible_y
)
14630 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
14632 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
14633 run
.current_y
= first_unchanged_at_end_row
->y
;
14634 run
.desired_y
= run
.current_y
+ dy
;
14635 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
14639 delta
= dvpos
= dy
= run
.current_y
= run
.desired_y
= run
.height
= 0;
14640 first_unchanged_at_end_row
= NULL
;
14642 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
14645 /* Find the cursor if not already found. We have to decide whether
14646 PT will appear on this window (it sometimes doesn't, but this is
14647 not a very frequent case.) This decision has to be made before
14648 the current matrix is altered. A value of cursor.vpos < 0 means
14649 that PT is either in one of the lines beginning at
14650 first_unchanged_at_end_row or below the window. Don't care for
14651 lines that might be displayed later at the window end; as
14652 mentioned, this is not a frequent case. */
14653 if (w
->cursor
.vpos
< 0)
14655 /* Cursor in unchanged rows at the top? */
14656 if (PT
< CHARPOS (start_pos
)
14657 && last_unchanged_at_beg_row
)
14659 row
= row_containing_pos (w
, PT
,
14660 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
14661 last_unchanged_at_beg_row
+ 1, 0);
14663 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14666 /* Start from first_unchanged_at_end_row looking for PT. */
14667 else if (first_unchanged_at_end_row
)
14669 row
= row_containing_pos (w
, PT
- delta
,
14670 first_unchanged_at_end_row
, NULL
, 0);
14672 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
14673 delta_bytes
, dy
, dvpos
);
14676 /* Give up if cursor was not found. */
14677 if (w
->cursor
.vpos
< 0)
14679 clear_glyph_matrix (w
->desired_matrix
);
14684 /* Don't let the cursor end in the scroll margins. */
14686 int this_scroll_margin
, cursor_height
;
14688 this_scroll_margin
= max (0, scroll_margin
);
14689 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14690 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
14691 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
14693 if ((w
->cursor
.y
< this_scroll_margin
14694 && CHARPOS (start
) > BEGV
)
14695 /* Old redisplay didn't take scroll margin into account at the bottom,
14696 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
14697 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
14698 ? cursor_height
+ this_scroll_margin
14699 : 1)) > it
.last_visible_y
)
14701 w
->cursor
.vpos
= -1;
14702 clear_glyph_matrix (w
->desired_matrix
);
14707 /* Scroll the display. Do it before changing the current matrix so
14708 that xterm.c doesn't get confused about where the cursor glyph is
14710 if (dy
&& run
.height
)
14714 if (FRAME_WINDOW_P (f
))
14716 rif
->update_window_begin_hook (w
);
14717 rif
->clear_window_mouse_face (w
);
14718 rif
->scroll_run_hook (w
, &run
);
14719 rif
->update_window_end_hook (w
, 0, 0);
14723 /* Terminal frame. In this case, dvpos gives the number of
14724 lines to scroll by; dvpos < 0 means scroll up. */
14725 int first_unchanged_at_end_vpos
14726 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
14727 int from
= WINDOW_TOP_EDGE_LINE (w
) + first_unchanged_at_end_vpos
;
14728 int end
= (WINDOW_TOP_EDGE_LINE (w
)
14729 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
14730 + window_internal_height (w
));
14732 /* Perform the operation on the screen. */
14735 /* Scroll last_unchanged_at_beg_row to the end of the
14736 window down dvpos lines. */
14737 set_terminal_window (end
);
14739 /* On dumb terminals delete dvpos lines at the end
14740 before inserting dvpos empty lines. */
14741 if (!scroll_region_ok
)
14742 ins_del_lines (end
- dvpos
, -dvpos
);
14744 /* Insert dvpos empty lines in front of
14745 last_unchanged_at_beg_row. */
14746 ins_del_lines (from
, dvpos
);
14748 else if (dvpos
< 0)
14750 /* Scroll up last_unchanged_at_beg_vpos to the end of
14751 the window to last_unchanged_at_beg_vpos - |dvpos|. */
14752 set_terminal_window (end
);
14754 /* Delete dvpos lines in front of
14755 last_unchanged_at_beg_vpos. ins_del_lines will set
14756 the cursor to the given vpos and emit |dvpos| delete
14758 ins_del_lines (from
+ dvpos
, dvpos
);
14760 /* On a dumb terminal insert dvpos empty lines at the
14762 if (!scroll_region_ok
)
14763 ins_del_lines (end
+ dvpos
, -dvpos
);
14766 set_terminal_window (0);
14772 /* Shift reused rows of the current matrix to the right position.
14773 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
14775 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
14776 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
14779 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
14780 bottom_vpos
, dvpos
);
14781 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
14784 else if (dvpos
> 0)
14786 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
14787 bottom_vpos
, dvpos
);
14788 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
14789 first_unchanged_at_end_vpos
+ dvpos
, 0);
14792 /* For frame-based redisplay, make sure that current frame and window
14793 matrix are in sync with respect to glyph memory. */
14794 if (!FRAME_WINDOW_P (f
))
14795 sync_frame_with_window_matrix_rows (w
);
14797 /* Adjust buffer positions in reused rows. */
14799 increment_matrix_positions (current_matrix
,
14800 first_unchanged_at_end_vpos
+ dvpos
,
14801 bottom_vpos
, delta
, delta_bytes
);
14803 /* Adjust Y positions. */
14805 shift_glyph_matrix (w
, current_matrix
,
14806 first_unchanged_at_end_vpos
+ dvpos
,
14809 if (first_unchanged_at_end_row
)
14811 first_unchanged_at_end_row
+= dvpos
;
14812 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
14813 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
14814 first_unchanged_at_end_row
= NULL
;
14817 /* If scrolling up, there may be some lines to display at the end of
14819 last_text_row_at_end
= NULL
;
14822 /* Scrolling up can leave for example a partially visible line
14823 at the end of the window to be redisplayed. */
14824 /* Set last_row to the glyph row in the current matrix where the
14825 window end line is found. It has been moved up or down in
14826 the matrix by dvpos. */
14827 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
14828 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
14830 /* If last_row is the window end line, it should display text. */
14831 xassert (last_row
->displays_text_p
);
14833 /* If window end line was partially visible before, begin
14834 displaying at that line. Otherwise begin displaying with the
14835 line following it. */
14836 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
14838 init_to_row_start (&it
, w
, last_row
);
14839 it
.vpos
= last_vpos
;
14840 it
.current_y
= last_row
->y
;
14844 init_to_row_end (&it
, w
, last_row
);
14845 it
.vpos
= 1 + last_vpos
;
14846 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
14850 /* We may start in a continuation line. If so, we have to
14851 get the right continuation_lines_width and current_x. */
14852 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
14853 it
.hpos
= it
.current_x
= 0;
14855 /* Display the rest of the lines at the window end. */
14856 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
14857 while (it
.current_y
< it
.last_visible_y
14858 && !fonts_changed_p
)
14860 /* Is it always sure that the display agrees with lines in
14861 the current matrix? I don't think so, so we mark rows
14862 displayed invalid in the current matrix by setting their
14863 enabled_p flag to zero. */
14864 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
14865 if (display_line (&it
))
14866 last_text_row_at_end
= it
.glyph_row
- 1;
14870 /* Update window_end_pos and window_end_vpos. */
14871 if (first_unchanged_at_end_row
14872 && !last_text_row_at_end
)
14874 /* Window end line if one of the preserved rows from the current
14875 matrix. Set row to the last row displaying text in current
14876 matrix starting at first_unchanged_at_end_row, after
14878 xassert (first_unchanged_at_end_row
->displays_text_p
);
14879 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
14880 first_unchanged_at_end_row
);
14881 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
14883 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
14884 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
14886 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
14887 xassert (w
->window_end_bytepos
>= 0);
14888 IF_DEBUG (debug_method_add (w
, "A"));
14890 else if (last_text_row_at_end
)
14893 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
14894 w
->window_end_bytepos
14895 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
14897 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
14898 xassert (w
->window_end_bytepos
>= 0);
14899 IF_DEBUG (debug_method_add (w
, "B"));
14901 else if (last_text_row
)
14903 /* We have displayed either to the end of the window or at the
14904 end of the window, i.e. the last row with text is to be found
14905 in the desired matrix. */
14907 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14908 w
->window_end_bytepos
14909 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14911 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
14912 xassert (w
->window_end_bytepos
>= 0);
14914 else if (first_unchanged_at_end_row
== NULL
14915 && last_text_row
== NULL
14916 && last_text_row_at_end
== NULL
)
14918 /* Displayed to end of window, but no line containing text was
14919 displayed. Lines were deleted at the end of the window. */
14920 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
14921 int vpos
= XFASTINT (w
->window_end_vpos
);
14922 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
14923 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
14926 row
== NULL
&& vpos
>= first_vpos
;
14927 --vpos
, --current_row
, --desired_row
)
14929 if (desired_row
->enabled_p
)
14931 if (desired_row
->displays_text_p
)
14934 else if (current_row
->displays_text_p
)
14938 xassert (row
!= NULL
);
14939 w
->window_end_vpos
= make_number (vpos
+ 1);
14940 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
14941 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
14942 xassert (w
->window_end_bytepos
>= 0);
14943 IF_DEBUG (debug_method_add (w
, "C"));
14948 #if 0 /* This leads to problems, for instance when the cursor is
14949 at ZV, and the cursor line displays no text. */
14950 /* Disable rows below what's displayed in the window. This makes
14951 debugging easier. */
14952 enable_glyph_matrix_rows (current_matrix
,
14953 XFASTINT (w
->window_end_vpos
) + 1,
14957 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
14958 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
14960 /* Record that display has not been completed. */
14961 w
->window_end_valid
= Qnil
;
14962 w
->desired_matrix
->no_scrolling_p
= 1;
14970 /***********************************************************************
14971 More debugging support
14972 ***********************************************************************/
14976 void dump_glyph_row
P_ ((struct glyph_row
*, int, int));
14977 void dump_glyph_matrix
P_ ((struct glyph_matrix
*, int));
14978 void dump_glyph
P_ ((struct glyph_row
*, struct glyph
*, int));
14981 /* Dump the contents of glyph matrix MATRIX on stderr.
14983 GLYPHS 0 means don't show glyph contents.
14984 GLYPHS 1 means show glyphs in short form
14985 GLYPHS > 1 means show glyphs in long form. */
14988 dump_glyph_matrix (matrix
, glyphs
)
14989 struct glyph_matrix
*matrix
;
14993 for (i
= 0; i
< matrix
->nrows
; ++i
)
14994 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
14998 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
14999 the glyph row and area where the glyph comes from. */
15002 dump_glyph (row
, glyph
, area
)
15003 struct glyph_row
*row
;
15004 struct glyph
*glyph
;
15007 if (glyph
->type
== CHAR_GLYPH
)
15010 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15011 glyph
- row
->glyphs
[TEXT_AREA
],
15014 (BUFFERP (glyph
->object
)
15016 : (STRINGP (glyph
->object
)
15019 glyph
->pixel_width
,
15021 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
15025 glyph
->left_box_line_p
,
15026 glyph
->right_box_line_p
);
15028 else if (glyph
->type
== STRETCH_GLYPH
)
15031 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15032 glyph
- row
->glyphs
[TEXT_AREA
],
15035 (BUFFERP (glyph
->object
)
15037 : (STRINGP (glyph
->object
)
15040 glyph
->pixel_width
,
15044 glyph
->left_box_line_p
,
15045 glyph
->right_box_line_p
);
15047 else if (glyph
->type
== IMAGE_GLYPH
)
15050 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15051 glyph
- row
->glyphs
[TEXT_AREA
],
15054 (BUFFERP (glyph
->object
)
15056 : (STRINGP (glyph
->object
)
15059 glyph
->pixel_width
,
15063 glyph
->left_box_line_p
,
15064 glyph
->right_box_line_p
);
15066 else if (glyph
->type
== COMPOSITE_GLYPH
)
15069 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15070 glyph
- row
->glyphs
[TEXT_AREA
],
15073 (BUFFERP (glyph
->object
)
15075 : (STRINGP (glyph
->object
)
15078 glyph
->pixel_width
,
15082 glyph
->left_box_line_p
,
15083 glyph
->right_box_line_p
);
15088 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
15089 GLYPHS 0 means don't show glyph contents.
15090 GLYPHS 1 means show glyphs in short form
15091 GLYPHS > 1 means show glyphs in long form. */
15094 dump_glyph_row (row
, vpos
, glyphs
)
15095 struct glyph_row
*row
;
15100 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
15101 fprintf (stderr
, "======================================================================\n");
15103 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d\
15104 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
15106 MATRIX_ROW_START_CHARPOS (row
),
15107 MATRIX_ROW_END_CHARPOS (row
),
15108 row
->used
[TEXT_AREA
],
15109 row
->contains_overlapping_glyphs_p
,
15111 row
->truncated_on_left_p
,
15112 row
->truncated_on_right_p
,
15114 MATRIX_ROW_CONTINUATION_LINE_P (row
),
15115 row
->displays_text_p
,
15118 row
->ends_in_middle_of_char_p
,
15119 row
->starts_in_middle_of_char_p
,
15125 row
->visible_height
,
15128 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
15129 row
->end
.overlay_string_index
,
15130 row
->continuation_lines_width
);
15131 fprintf (stderr
, "%9d %5d\n",
15132 CHARPOS (row
->start
.string_pos
),
15133 CHARPOS (row
->end
.string_pos
));
15134 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
15135 row
->end
.dpvec_index
);
15142 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
15144 struct glyph
*glyph
= row
->glyphs
[area
];
15145 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
15147 /* Glyph for a line end in text. */
15148 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
15151 if (glyph
< glyph_end
)
15152 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
15154 for (; glyph
< glyph_end
; ++glyph
)
15155 dump_glyph (row
, glyph
, area
);
15158 else if (glyphs
== 1)
15162 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
15164 char *s
= (char *) alloca (row
->used
[area
] + 1);
15167 for (i
= 0; i
< row
->used
[area
]; ++i
)
15169 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
15170 if (glyph
->type
== CHAR_GLYPH
15171 && glyph
->u
.ch
< 0x80
15172 && glyph
->u
.ch
>= ' ')
15173 s
[i
] = glyph
->u
.ch
;
15179 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
15185 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
15186 Sdump_glyph_matrix
, 0, 1, "p",
15187 doc
: /* Dump the current matrix of the selected window to stderr.
15188 Shows contents of glyph row structures. With non-nil
15189 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
15190 glyphs in short form, otherwise show glyphs in long form. */)
15192 Lisp_Object glyphs
;
15194 struct window
*w
= XWINDOW (selected_window
);
15195 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15197 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
15198 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
15199 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
15200 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
15201 fprintf (stderr
, "=============================================\n");
15202 dump_glyph_matrix (w
->current_matrix
,
15203 NILP (glyphs
) ? 0 : XINT (glyphs
));
15208 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
15209 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
15212 struct frame
*f
= XFRAME (selected_frame
);
15213 dump_glyph_matrix (f
->current_matrix
, 1);
15218 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
15219 doc
: /* Dump glyph row ROW to stderr.
15220 GLYPH 0 means don't dump glyphs.
15221 GLYPH 1 means dump glyphs in short form.
15222 GLYPH > 1 or omitted means dump glyphs in long form. */)
15224 Lisp_Object row
, glyphs
;
15226 struct glyph_matrix
*matrix
;
15229 CHECK_NUMBER (row
);
15230 matrix
= XWINDOW (selected_window
)->current_matrix
;
15232 if (vpos
>= 0 && vpos
< matrix
->nrows
)
15233 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
15235 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
15240 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
15241 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
15242 GLYPH 0 means don't dump glyphs.
15243 GLYPH 1 means dump glyphs in short form.
15244 GLYPH > 1 or omitted means dump glyphs in long form. */)
15246 Lisp_Object row
, glyphs
;
15248 struct frame
*sf
= SELECTED_FRAME ();
15249 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
15252 CHECK_NUMBER (row
);
15254 if (vpos
>= 0 && vpos
< m
->nrows
)
15255 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
15256 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
15261 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
15262 doc
: /* Toggle tracing of redisplay.
15263 With ARG, turn tracing on if and only if ARG is positive. */)
15268 trace_redisplay_p
= !trace_redisplay_p
;
15271 arg
= Fprefix_numeric_value (arg
);
15272 trace_redisplay_p
= XINT (arg
) > 0;
15279 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
15280 doc
: /* Like `format', but print result to stderr.
15281 usage: (trace-to-stderr STRING &rest OBJECTS) */)
15286 Lisp_Object s
= Fformat (nargs
, args
);
15287 fprintf (stderr
, "%s", SDATA (s
));
15291 #endif /* GLYPH_DEBUG */
15295 /***********************************************************************
15296 Building Desired Matrix Rows
15297 ***********************************************************************/
15299 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
15300 Used for non-window-redisplay windows, and for windows w/o left fringe. */
15302 static struct glyph_row
*
15303 get_overlay_arrow_glyph_row (w
, overlay_arrow_string
)
15305 Lisp_Object overlay_arrow_string
;
15307 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
15308 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15309 struct buffer
*old
= current_buffer
;
15310 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
15311 int arrow_len
= SCHARS (overlay_arrow_string
);
15312 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
15313 const unsigned char *p
;
15316 int n_glyphs_before
;
15318 set_buffer_temp (buffer
);
15319 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
15320 it
.glyph_row
->used
[TEXT_AREA
] = 0;
15321 SET_TEXT_POS (it
.position
, 0, 0);
15323 multibyte_p
= !NILP (buffer
->enable_multibyte_characters
);
15325 while (p
< arrow_end
)
15327 Lisp_Object face
, ilisp
;
15329 /* Get the next character. */
15331 it
.c
= string_char_and_length (p
, arrow_len
, &it
.len
);
15333 it
.c
= *p
, it
.len
= 1;
15336 /* Get its face. */
15337 ilisp
= make_number (p
- arrow_string
);
15338 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
15339 it
.face_id
= compute_char_face (f
, it
.c
, face
);
15341 /* Compute its width, get its glyphs. */
15342 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
15343 SET_TEXT_POS (it
.position
, -1, -1);
15344 PRODUCE_GLYPHS (&it
);
15346 /* If this character doesn't fit any more in the line, we have
15347 to remove some glyphs. */
15348 if (it
.current_x
> it
.last_visible_x
)
15350 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
15355 set_buffer_temp (old
);
15356 return it
.glyph_row
;
15360 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
15361 glyphs are only inserted for terminal frames since we can't really
15362 win with truncation glyphs when partially visible glyphs are
15363 involved. Which glyphs to insert is determined by
15364 produce_special_glyphs. */
15367 insert_left_trunc_glyphs (it
)
15370 struct it truncate_it
;
15371 struct glyph
*from
, *end
, *to
, *toend
;
15373 xassert (!FRAME_WINDOW_P (it
->f
));
15375 /* Get the truncation glyphs. */
15377 truncate_it
.current_x
= 0;
15378 truncate_it
.face_id
= DEFAULT_FACE_ID
;
15379 truncate_it
.glyph_row
= &scratch_glyph_row
;
15380 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
15381 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
15382 truncate_it
.object
= make_number (0);
15383 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
15385 /* Overwrite glyphs from IT with truncation glyphs. */
15386 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
15387 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
15388 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
15389 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
15394 /* There may be padding glyphs left over. Overwrite them too. */
15395 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
15397 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
15403 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
15407 /* Compute the pixel height and width of IT->glyph_row.
15409 Most of the time, ascent and height of a display line will be equal
15410 to the max_ascent and max_height values of the display iterator
15411 structure. This is not the case if
15413 1. We hit ZV without displaying anything. In this case, max_ascent
15414 and max_height will be zero.
15416 2. We have some glyphs that don't contribute to the line height.
15417 (The glyph row flag contributes_to_line_height_p is for future
15418 pixmap extensions).
15420 The first case is easily covered by using default values because in
15421 these cases, the line height does not really matter, except that it
15422 must not be zero. */
15425 compute_line_metrics (it
)
15428 struct glyph_row
*row
= it
->glyph_row
;
15431 if (FRAME_WINDOW_P (it
->f
))
15433 int i
, min_y
, max_y
;
15435 /* The line may consist of one space only, that was added to
15436 place the cursor on it. If so, the row's height hasn't been
15438 if (row
->height
== 0)
15440 if (it
->max_ascent
+ it
->max_descent
== 0)
15441 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
15442 row
->ascent
= it
->max_ascent
;
15443 row
->height
= it
->max_ascent
+ it
->max_descent
;
15444 row
->phys_ascent
= it
->max_phys_ascent
;
15445 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
15446 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
15449 /* Compute the width of this line. */
15450 row
->pixel_width
= row
->x
;
15451 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
15452 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
15454 xassert (row
->pixel_width
>= 0);
15455 xassert (row
->ascent
>= 0 && row
->height
> 0);
15457 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
15458 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
15460 /* If first line's physical ascent is larger than its logical
15461 ascent, use the physical ascent, and make the row taller.
15462 This makes accented characters fully visible. */
15463 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
15464 && row
->phys_ascent
> row
->ascent
)
15466 row
->height
+= row
->phys_ascent
- row
->ascent
;
15467 row
->ascent
= row
->phys_ascent
;
15470 /* Compute how much of the line is visible. */
15471 row
->visible_height
= row
->height
;
15473 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
15474 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
15476 if (row
->y
< min_y
)
15477 row
->visible_height
-= min_y
- row
->y
;
15478 if (row
->y
+ row
->height
> max_y
)
15479 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
15483 row
->pixel_width
= row
->used
[TEXT_AREA
];
15484 if (row
->continued_p
)
15485 row
->pixel_width
-= it
->continuation_pixel_width
;
15486 else if (row
->truncated_on_right_p
)
15487 row
->pixel_width
-= it
->truncation_pixel_width
;
15488 row
->ascent
= row
->phys_ascent
= 0;
15489 row
->height
= row
->phys_height
= row
->visible_height
= 1;
15490 row
->extra_line_spacing
= 0;
15493 /* Compute a hash code for this row. */
15495 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
15496 for (i
= 0; i
< row
->used
[area
]; ++i
)
15497 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
15498 + row
->glyphs
[area
][i
].u
.val
15499 + row
->glyphs
[area
][i
].face_id
15500 + row
->glyphs
[area
][i
].padding_p
15501 + (row
->glyphs
[area
][i
].type
<< 2));
15503 it
->max_ascent
= it
->max_descent
= 0;
15504 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
15508 /* Append one space to the glyph row of iterator IT if doing a
15509 window-based redisplay. The space has the same face as
15510 IT->face_id. Value is non-zero if a space was added.
15512 This function is called to make sure that there is always one glyph
15513 at the end of a glyph row that the cursor can be set on under
15514 window-systems. (If there weren't such a glyph we would not know
15515 how wide and tall a box cursor should be displayed).
15517 At the same time this space let's a nicely handle clearing to the
15518 end of the line if the row ends in italic text. */
15521 append_space_for_newline (it
, default_face_p
)
15523 int default_face_p
;
15525 if (FRAME_WINDOW_P (it
->f
))
15527 int n
= it
->glyph_row
->used
[TEXT_AREA
];
15529 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
15530 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
15532 /* Save some values that must not be changed.
15533 Must save IT->c and IT->len because otherwise
15534 ITERATOR_AT_END_P wouldn't work anymore after
15535 append_space_for_newline has been called. */
15536 enum display_element_type saved_what
= it
->what
;
15537 int saved_c
= it
->c
, saved_len
= it
->len
;
15538 int saved_x
= it
->current_x
;
15539 int saved_face_id
= it
->face_id
;
15540 struct text_pos saved_pos
;
15541 Lisp_Object saved_object
;
15544 saved_object
= it
->object
;
15545 saved_pos
= it
->position
;
15547 it
->what
= IT_CHARACTER
;
15548 bzero (&it
->position
, sizeof it
->position
);
15549 it
->object
= make_number (0);
15553 if (default_face_p
)
15554 it
->face_id
= DEFAULT_FACE_ID
;
15555 else if (it
->face_before_selective_p
)
15556 it
->face_id
= it
->saved_face_id
;
15557 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
15558 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0);
15560 PRODUCE_GLYPHS (it
);
15562 it
->override_ascent
= -1;
15563 it
->constrain_row_ascent_descent_p
= 0;
15564 it
->current_x
= saved_x
;
15565 it
->object
= saved_object
;
15566 it
->position
= saved_pos
;
15567 it
->what
= saved_what
;
15568 it
->face_id
= saved_face_id
;
15569 it
->len
= saved_len
;
15579 /* Extend the face of the last glyph in the text area of IT->glyph_row
15580 to the end of the display line. Called from display_line.
15581 If the glyph row is empty, add a space glyph to it so that we
15582 know the face to draw. Set the glyph row flag fill_line_p. */
15585 extend_face_to_end_of_line (it
)
15589 struct frame
*f
= it
->f
;
15591 /* If line is already filled, do nothing. */
15592 if (it
->current_x
>= it
->last_visible_x
)
15595 /* Face extension extends the background and box of IT->face_id
15596 to the end of the line. If the background equals the background
15597 of the frame, we don't have to do anything. */
15598 if (it
->face_before_selective_p
)
15599 face
= FACE_FROM_ID (it
->f
, it
->saved_face_id
);
15601 face
= FACE_FROM_ID (f
, it
->face_id
);
15603 if (FRAME_WINDOW_P (f
)
15604 && it
->glyph_row
->displays_text_p
15605 && face
->box
== FACE_NO_BOX
15606 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
15610 /* Set the glyph row flag indicating that the face of the last glyph
15611 in the text area has to be drawn to the end of the text area. */
15612 it
->glyph_row
->fill_line_p
= 1;
15614 /* If current character of IT is not ASCII, make sure we have the
15615 ASCII face. This will be automatically undone the next time
15616 get_next_display_element returns a multibyte character. Note
15617 that the character will always be single byte in unibyte text. */
15618 if (!SINGLE_BYTE_CHAR_P (it
->c
))
15620 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0);
15623 if (FRAME_WINDOW_P (f
))
15625 /* If the row is empty, add a space with the current face of IT,
15626 so that we know which face to draw. */
15627 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
15629 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
15630 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
15631 it
->glyph_row
->used
[TEXT_AREA
] = 1;
15636 /* Save some values that must not be changed. */
15637 int saved_x
= it
->current_x
;
15638 struct text_pos saved_pos
;
15639 Lisp_Object saved_object
;
15640 enum display_element_type saved_what
= it
->what
;
15641 int saved_face_id
= it
->face_id
;
15643 saved_object
= it
->object
;
15644 saved_pos
= it
->position
;
15646 it
->what
= IT_CHARACTER
;
15647 bzero (&it
->position
, sizeof it
->position
);
15648 it
->object
= make_number (0);
15651 it
->face_id
= face
->id
;
15653 PRODUCE_GLYPHS (it
);
15655 while (it
->current_x
<= it
->last_visible_x
)
15656 PRODUCE_GLYPHS (it
);
15658 /* Don't count these blanks really. It would let us insert a left
15659 truncation glyph below and make us set the cursor on them, maybe. */
15660 it
->current_x
= saved_x
;
15661 it
->object
= saved_object
;
15662 it
->position
= saved_pos
;
15663 it
->what
= saved_what
;
15664 it
->face_id
= saved_face_id
;
15669 /* Value is non-zero if text starting at CHARPOS in current_buffer is
15670 trailing whitespace. */
15673 trailing_whitespace_p (charpos
)
15676 int bytepos
= CHAR_TO_BYTE (charpos
);
15679 while (bytepos
< ZV_BYTE
15680 && (c
= FETCH_CHAR (bytepos
),
15681 c
== ' ' || c
== '\t'))
15684 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
15686 if (bytepos
!= PT_BYTE
)
15693 /* Highlight trailing whitespace, if any, in ROW. */
15696 highlight_trailing_whitespace (f
, row
)
15698 struct glyph_row
*row
;
15700 int used
= row
->used
[TEXT_AREA
];
15704 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
15705 struct glyph
*glyph
= start
+ used
- 1;
15707 /* Skip over glyphs inserted to display the cursor at the
15708 end of a line, for extending the face of the last glyph
15709 to the end of the line on terminals, and for truncation
15710 and continuation glyphs. */
15711 while (glyph
>= start
15712 && glyph
->type
== CHAR_GLYPH
15713 && INTEGERP (glyph
->object
))
15716 /* If last glyph is a space or stretch, and it's trailing
15717 whitespace, set the face of all trailing whitespace glyphs in
15718 IT->glyph_row to `trailing-whitespace'. */
15720 && BUFFERP (glyph
->object
)
15721 && (glyph
->type
== STRETCH_GLYPH
15722 || (glyph
->type
== CHAR_GLYPH
15723 && glyph
->u
.ch
== ' '))
15724 && trailing_whitespace_p (glyph
->charpos
))
15726 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0, 0);
15730 while (glyph
>= start
15731 && BUFFERP (glyph
->object
)
15732 && (glyph
->type
== STRETCH_GLYPH
15733 || (glyph
->type
== CHAR_GLYPH
15734 && glyph
->u
.ch
== ' ')))
15735 (glyph
--)->face_id
= face_id
;
15741 /* Value is non-zero if glyph row ROW in window W should be
15742 used to hold the cursor. */
15745 cursor_row_p (w
, row
)
15747 struct glyph_row
*row
;
15749 int cursor_row_p
= 1;
15751 if (PT
== MATRIX_ROW_END_CHARPOS (row
))
15753 /* If the row ends with a newline from a string, we don't want
15754 the cursor there, but we still want it at the start of the
15755 string if the string starts in this row.
15756 If the row is continued it doesn't end in a newline. */
15757 if (CHARPOS (row
->end
.string_pos
) >= 0)
15758 cursor_row_p
= (row
->continued_p
15759 || PT
>= MATRIX_ROW_START_CHARPOS (row
));
15760 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15762 /* If the row ends in middle of a real character,
15763 and the line is continued, we want the cursor here.
15764 That's because MATRIX_ROW_END_CHARPOS would equal
15765 PT if PT is before the character. */
15766 if (!row
->ends_in_ellipsis_p
)
15767 cursor_row_p
= row
->continued_p
;
15769 /* If the row ends in an ellipsis, then
15770 MATRIX_ROW_END_CHARPOS will equal point after the invisible text.
15771 We want that position to be displayed after the ellipsis. */
15774 /* If the row ends at ZV, display the cursor at the end of that
15775 row instead of at the start of the row below. */
15776 else if (row
->ends_at_zv_p
)
15782 return cursor_row_p
;
15786 /* Construct the glyph row IT->glyph_row in the desired matrix of
15787 IT->w from text at the current position of IT. See dispextern.h
15788 for an overview of struct it. Value is non-zero if
15789 IT->glyph_row displays text, as opposed to a line displaying ZV
15796 struct glyph_row
*row
= it
->glyph_row
;
15797 Lisp_Object overlay_arrow_string
;
15799 /* We always start displaying at hpos zero even if hscrolled. */
15800 xassert (it
->hpos
== 0 && it
->current_x
== 0);
15802 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
15803 >= it
->w
->desired_matrix
->nrows
)
15805 it
->w
->nrows_scale_factor
++;
15806 fonts_changed_p
= 1;
15810 /* Is IT->w showing the region? */
15811 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
15813 /* Clear the result glyph row and enable it. */
15814 prepare_desired_row (row
);
15816 row
->y
= it
->current_y
;
15817 row
->start
= it
->start
;
15818 row
->continuation_lines_width
= it
->continuation_lines_width
;
15819 row
->displays_text_p
= 1;
15820 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
15821 it
->starts_in_middle_of_char_p
= 0;
15823 /* Arrange the overlays nicely for our purposes. Usually, we call
15824 display_line on only one line at a time, in which case this
15825 can't really hurt too much, or we call it on lines which appear
15826 one after another in the buffer, in which case all calls to
15827 recenter_overlay_lists but the first will be pretty cheap. */
15828 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
15830 /* Move over display elements that are not visible because we are
15831 hscrolled. This may stop at an x-position < IT->first_visible_x
15832 if the first glyph is partially visible or if we hit a line end. */
15833 if (it
->current_x
< it
->first_visible_x
)
15835 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
15836 MOVE_TO_POS
| MOVE_TO_X
);
15839 /* Get the initial row height. This is either the height of the
15840 text hscrolled, if there is any, or zero. */
15841 row
->ascent
= it
->max_ascent
;
15842 row
->height
= it
->max_ascent
+ it
->max_descent
;
15843 row
->phys_ascent
= it
->max_phys_ascent
;
15844 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
15845 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
15847 /* Loop generating characters. The loop is left with IT on the next
15848 character to display. */
15851 int n_glyphs_before
, hpos_before
, x_before
;
15853 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
15855 /* Retrieve the next thing to display. Value is zero if end of
15857 if (!get_next_display_element (it
))
15859 /* Maybe add a space at the end of this line that is used to
15860 display the cursor there under X. Set the charpos of the
15861 first glyph of blank lines not corresponding to any text
15863 #ifdef HAVE_WINDOW_SYSTEM
15864 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
15865 row
->exact_window_width_line_p
= 1;
15867 #endif /* HAVE_WINDOW_SYSTEM */
15868 if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
15869 || row
->used
[TEXT_AREA
] == 0)
15871 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
15872 row
->displays_text_p
= 0;
15874 if (!NILP (XBUFFER (it
->w
->buffer
)->indicate_empty_lines
)
15875 && (!MINI_WINDOW_P (it
->w
)
15876 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
15877 row
->indicate_empty_line_p
= 1;
15880 it
->continuation_lines_width
= 0;
15881 row
->ends_at_zv_p
= 1;
15885 /* Now, get the metrics of what we want to display. This also
15886 generates glyphs in `row' (which is IT->glyph_row). */
15887 n_glyphs_before
= row
->used
[TEXT_AREA
];
15890 /* Remember the line height so far in case the next element doesn't
15891 fit on the line. */
15892 if (!it
->truncate_lines_p
)
15894 ascent
= it
->max_ascent
;
15895 descent
= it
->max_descent
;
15896 phys_ascent
= it
->max_phys_ascent
;
15897 phys_descent
= it
->max_phys_descent
;
15900 PRODUCE_GLYPHS (it
);
15902 /* If this display element was in marginal areas, continue with
15904 if (it
->area
!= TEXT_AREA
)
15906 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
15907 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
15908 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
15909 row
->phys_height
= max (row
->phys_height
,
15910 it
->max_phys_ascent
+ it
->max_phys_descent
);
15911 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
15912 it
->max_extra_line_spacing
);
15913 set_iterator_to_next (it
, 1);
15917 /* Does the display element fit on the line? If we truncate
15918 lines, we should draw past the right edge of the window. If
15919 we don't truncate, we want to stop so that we can display the
15920 continuation glyph before the right margin. If lines are
15921 continued, there are two possible strategies for characters
15922 resulting in more than 1 glyph (e.g. tabs): Display as many
15923 glyphs as possible in this line and leave the rest for the
15924 continuation line, or display the whole element in the next
15925 line. Original redisplay did the former, so we do it also. */
15926 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
15927 hpos_before
= it
->hpos
;
15930 if (/* Not a newline. */
15932 /* Glyphs produced fit entirely in the line. */
15933 && it
->current_x
< it
->last_visible_x
)
15935 it
->hpos
+= nglyphs
;
15936 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
15937 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
15938 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
15939 row
->phys_height
= max (row
->phys_height
,
15940 it
->max_phys_ascent
+ it
->max_phys_descent
);
15941 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
15942 it
->max_extra_line_spacing
);
15943 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
15944 row
->x
= x
- it
->first_visible_x
;
15949 struct glyph
*glyph
;
15951 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
15953 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
15954 new_x
= x
+ glyph
->pixel_width
;
15956 if (/* Lines are continued. */
15957 !it
->truncate_lines_p
15958 && (/* Glyph doesn't fit on the line. */
15959 new_x
> it
->last_visible_x
15960 /* Or it fits exactly on a window system frame. */
15961 || (new_x
== it
->last_visible_x
15962 && FRAME_WINDOW_P (it
->f
))))
15964 /* End of a continued line. */
15967 || (new_x
== it
->last_visible_x
15968 && FRAME_WINDOW_P (it
->f
)))
15970 /* Current glyph is the only one on the line or
15971 fits exactly on the line. We must continue
15972 the line because we can't draw the cursor
15973 after the glyph. */
15974 row
->continued_p
= 1;
15975 it
->current_x
= new_x
;
15976 it
->continuation_lines_width
+= new_x
;
15978 if (i
== nglyphs
- 1)
15980 set_iterator_to_next (it
, 1);
15981 #ifdef HAVE_WINDOW_SYSTEM
15982 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
15984 if (!get_next_display_element (it
))
15986 row
->exact_window_width_line_p
= 1;
15987 it
->continuation_lines_width
= 0;
15988 row
->continued_p
= 0;
15989 row
->ends_at_zv_p
= 1;
15991 else if (ITERATOR_AT_END_OF_LINE_P (it
))
15993 row
->continued_p
= 0;
15994 row
->exact_window_width_line_p
= 1;
15997 #endif /* HAVE_WINDOW_SYSTEM */
16000 else if (CHAR_GLYPH_PADDING_P (*glyph
)
16001 && !FRAME_WINDOW_P (it
->f
))
16003 /* A padding glyph that doesn't fit on this line.
16004 This means the whole character doesn't fit
16006 row
->used
[TEXT_AREA
] = n_glyphs_before
;
16008 /* Fill the rest of the row with continuation
16009 glyphs like in 20.x. */
16010 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
16011 < row
->glyphs
[1 + TEXT_AREA
])
16012 produce_special_glyphs (it
, IT_CONTINUATION
);
16014 row
->continued_p
= 1;
16015 it
->current_x
= x_before
;
16016 it
->continuation_lines_width
+= x_before
;
16018 /* Restore the height to what it was before the
16019 element not fitting on the line. */
16020 it
->max_ascent
= ascent
;
16021 it
->max_descent
= descent
;
16022 it
->max_phys_ascent
= phys_ascent
;
16023 it
->max_phys_descent
= phys_descent
;
16025 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
16027 /* A TAB that extends past the right edge of the
16028 window. This produces a single glyph on
16029 window system frames. We leave the glyph in
16030 this row and let it fill the row, but don't
16031 consume the TAB. */
16032 it
->continuation_lines_width
+= it
->last_visible_x
;
16033 row
->ends_in_middle_of_char_p
= 1;
16034 row
->continued_p
= 1;
16035 glyph
->pixel_width
= it
->last_visible_x
- x
;
16036 it
->starts_in_middle_of_char_p
= 1;
16040 /* Something other than a TAB that draws past
16041 the right edge of the window. Restore
16042 positions to values before the element. */
16043 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
16045 /* Display continuation glyphs. */
16046 if (!FRAME_WINDOW_P (it
->f
))
16047 produce_special_glyphs (it
, IT_CONTINUATION
);
16048 row
->continued_p
= 1;
16050 it
->current_x
= x_before
;
16051 it
->continuation_lines_width
+= x
;
16052 extend_face_to_end_of_line (it
);
16054 if (nglyphs
> 1 && i
> 0)
16056 row
->ends_in_middle_of_char_p
= 1;
16057 it
->starts_in_middle_of_char_p
= 1;
16060 /* Restore the height to what it was before the
16061 element not fitting on the line. */
16062 it
->max_ascent
= ascent
;
16063 it
->max_descent
= descent
;
16064 it
->max_phys_ascent
= phys_ascent
;
16065 it
->max_phys_descent
= phys_descent
;
16070 else if (new_x
> it
->first_visible_x
)
16072 /* Increment number of glyphs actually displayed. */
16075 if (x
< it
->first_visible_x
)
16076 /* Glyph is partially visible, i.e. row starts at
16077 negative X position. */
16078 row
->x
= x
- it
->first_visible_x
;
16082 /* Glyph is completely off the left margin of the
16083 window. This should not happen because of the
16084 move_it_in_display_line at the start of this
16085 function, unless the text display area of the
16086 window is empty. */
16087 xassert (it
->first_visible_x
<= it
->last_visible_x
);
16091 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
16092 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
16093 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
16094 row
->phys_height
= max (row
->phys_height
,
16095 it
->max_phys_ascent
+ it
->max_phys_descent
);
16096 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
16097 it
->max_extra_line_spacing
);
16099 /* End of this display line if row is continued. */
16100 if (row
->continued_p
|| row
->ends_at_zv_p
)
16105 /* Is this a line end? If yes, we're also done, after making
16106 sure that a non-default face is extended up to the right
16107 margin of the window. */
16108 if (ITERATOR_AT_END_OF_LINE_P (it
))
16110 int used_before
= row
->used
[TEXT_AREA
];
16112 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
16114 #ifdef HAVE_WINDOW_SYSTEM
16115 /* Add a space at the end of the line that is used to
16116 display the cursor there. */
16117 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16118 append_space_for_newline (it
, 0);
16119 #endif /* HAVE_WINDOW_SYSTEM */
16121 /* Extend the face to the end of the line. */
16122 extend_face_to_end_of_line (it
);
16124 /* Make sure we have the position. */
16125 if (used_before
== 0)
16126 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
16128 /* Consume the line end. This skips over invisible lines. */
16129 set_iterator_to_next (it
, 1);
16130 it
->continuation_lines_width
= 0;
16134 /* Proceed with next display element. Note that this skips
16135 over lines invisible because of selective display. */
16136 set_iterator_to_next (it
, 1);
16138 /* If we truncate lines, we are done when the last displayed
16139 glyphs reach past the right margin of the window. */
16140 if (it
->truncate_lines_p
16141 && (FRAME_WINDOW_P (it
->f
)
16142 ? (it
->current_x
>= it
->last_visible_x
)
16143 : (it
->current_x
> it
->last_visible_x
)))
16145 /* Maybe add truncation glyphs. */
16146 if (!FRAME_WINDOW_P (it
->f
))
16150 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
16151 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
16154 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
16156 row
->used
[TEXT_AREA
] = i
;
16157 produce_special_glyphs (it
, IT_TRUNCATION
);
16160 #ifdef HAVE_WINDOW_SYSTEM
16163 /* Don't truncate if we can overflow newline into fringe. */
16164 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16166 if (!get_next_display_element (it
))
16168 it
->continuation_lines_width
= 0;
16169 row
->ends_at_zv_p
= 1;
16170 row
->exact_window_width_line_p
= 1;
16173 if (ITERATOR_AT_END_OF_LINE_P (it
))
16175 row
->exact_window_width_line_p
= 1;
16176 goto at_end_of_line
;
16180 #endif /* HAVE_WINDOW_SYSTEM */
16182 row
->truncated_on_right_p
= 1;
16183 it
->continuation_lines_width
= 0;
16184 reseat_at_next_visible_line_start (it
, 0);
16185 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
16186 it
->hpos
= hpos_before
;
16187 it
->current_x
= x_before
;
16192 /* If line is not empty and hscrolled, maybe insert truncation glyphs
16193 at the left window margin. */
16194 if (it
->first_visible_x
16195 && IT_CHARPOS (*it
) != MATRIX_ROW_START_CHARPOS (row
))
16197 if (!FRAME_WINDOW_P (it
->f
))
16198 insert_left_trunc_glyphs (it
);
16199 row
->truncated_on_left_p
= 1;
16202 /* If the start of this line is the overlay arrow-position, then
16203 mark this glyph row as the one containing the overlay arrow.
16204 This is clearly a mess with variable size fonts. It would be
16205 better to let it be displayed like cursors under X. */
16206 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
16207 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
16208 !NILP (overlay_arrow_string
)))
16210 /* Overlay arrow in window redisplay is a fringe bitmap. */
16211 if (STRINGP (overlay_arrow_string
))
16213 struct glyph_row
*arrow_row
16214 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
16215 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
16216 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
16217 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
16218 struct glyph
*p2
, *end
;
16220 /* Copy the arrow glyphs. */
16221 while (glyph
< arrow_end
)
16224 /* Throw away padding glyphs. */
16226 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16227 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
16233 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
16238 xassert (INTEGERP (overlay_arrow_string
));
16239 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
16241 overlay_arrow_seen
= 1;
16244 /* Compute pixel dimensions of this line. */
16245 compute_line_metrics (it
);
16247 /* Remember the position at which this line ends. */
16248 row
->end
= it
->current
;
16250 /* Record whether this row ends inside an ellipsis. */
16251 row
->ends_in_ellipsis_p
16252 = (it
->method
== GET_FROM_DISPLAY_VECTOR
16253 && it
->ellipsis_p
);
16255 /* Save fringe bitmaps in this row. */
16256 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
16257 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
16258 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
16259 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
16261 it
->left_user_fringe_bitmap
= 0;
16262 it
->left_user_fringe_face_id
= 0;
16263 it
->right_user_fringe_bitmap
= 0;
16264 it
->right_user_fringe_face_id
= 0;
16266 /* Maybe set the cursor. */
16267 if (it
->w
->cursor
.vpos
< 0
16268 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
16269 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
16270 && cursor_row_p (it
->w
, row
))
16271 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
16273 /* Highlight trailing whitespace. */
16274 if (!NILP (Vshow_trailing_whitespace
))
16275 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
16277 /* Prepare for the next line. This line starts horizontally at (X
16278 HPOS) = (0 0). Vertical positions are incremented. As a
16279 convenience for the caller, IT->glyph_row is set to the next
16281 it
->current_x
= it
->hpos
= 0;
16282 it
->current_y
+= row
->height
;
16285 it
->start
= it
->current
;
16286 return row
->displays_text_p
;
16291 /***********************************************************************
16293 ***********************************************************************/
16295 /* Redisplay the menu bar in the frame for window W.
16297 The menu bar of X frames that don't have X toolkit support is
16298 displayed in a special window W->frame->menu_bar_window.
16300 The menu bar of terminal frames is treated specially as far as
16301 glyph matrices are concerned. Menu bar lines are not part of
16302 windows, so the update is done directly on the frame matrix rows
16303 for the menu bar. */
16306 display_menu_bar (w
)
16309 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
16314 /* Don't do all this for graphical frames. */
16316 if (!NILP (Vwindow_system
))
16319 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
16324 if (FRAME_MAC_P (f
))
16328 #ifdef USE_X_TOOLKIT
16329 xassert (!FRAME_WINDOW_P (f
));
16330 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
16331 it
.first_visible_x
= 0;
16332 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
16333 #else /* not USE_X_TOOLKIT */
16334 if (FRAME_WINDOW_P (f
))
16336 /* Menu bar lines are displayed in the desired matrix of the
16337 dummy window menu_bar_window. */
16338 struct window
*menu_w
;
16339 xassert (WINDOWP (f
->menu_bar_window
));
16340 menu_w
= XWINDOW (f
->menu_bar_window
);
16341 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
16343 it
.first_visible_x
= 0;
16344 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
16348 /* This is a TTY frame, i.e. character hpos/vpos are used as
16350 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
16352 it
.first_visible_x
= 0;
16353 it
.last_visible_x
= FRAME_COLS (f
);
16355 #endif /* not USE_X_TOOLKIT */
16357 if (! mode_line_inverse_video
)
16358 /* Force the menu-bar to be displayed in the default face. */
16359 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
16361 /* Clear all rows of the menu bar. */
16362 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
16364 struct glyph_row
*row
= it
.glyph_row
+ i
;
16365 clear_glyph_row (row
);
16366 row
->enabled_p
= 1;
16367 row
->full_width_p
= 1;
16370 /* Display all items of the menu bar. */
16371 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
16372 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
16374 Lisp_Object string
;
16376 /* Stop at nil string. */
16377 string
= AREF (items
, i
+ 1);
16381 /* Remember where item was displayed. */
16382 AREF (items
, i
+ 3) = make_number (it
.hpos
);
16384 /* Display the item, pad with one space. */
16385 if (it
.current_x
< it
.last_visible_x
)
16386 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
16387 SCHARS (string
) + 1, 0, 0, -1);
16390 /* Fill out the line with spaces. */
16391 if (it
.current_x
< it
.last_visible_x
)
16392 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
16394 /* Compute the total height of the lines. */
16395 compute_line_metrics (&it
);
16400 /***********************************************************************
16402 ***********************************************************************/
16404 /* Redisplay mode lines in the window tree whose root is WINDOW. If
16405 FORCE is non-zero, redisplay mode lines unconditionally.
16406 Otherwise, redisplay only mode lines that are garbaged. Value is
16407 the number of windows whose mode lines were redisplayed. */
16410 redisplay_mode_lines (window
, force
)
16411 Lisp_Object window
;
16416 while (!NILP (window
))
16418 struct window
*w
= XWINDOW (window
);
16420 if (WINDOWP (w
->hchild
))
16421 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
16422 else if (WINDOWP (w
->vchild
))
16423 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
16425 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
16426 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
16428 struct text_pos lpoint
;
16429 struct buffer
*old
= current_buffer
;
16431 /* Set the window's buffer for the mode line display. */
16432 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16433 set_buffer_internal_1 (XBUFFER (w
->buffer
));
16435 /* Point refers normally to the selected window. For any
16436 other window, set up appropriate value. */
16437 if (!EQ (window
, selected_window
))
16439 struct text_pos pt
;
16441 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
16442 if (CHARPOS (pt
) < BEGV
)
16443 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
16444 else if (CHARPOS (pt
) > (ZV
- 1))
16445 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
16447 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
16450 /* Display mode lines. */
16451 clear_glyph_matrix (w
->desired_matrix
);
16452 if (display_mode_lines (w
))
16455 w
->must_be_updated_p
= 1;
16458 /* Restore old settings. */
16459 set_buffer_internal_1 (old
);
16460 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
16470 /* Display the mode and/or top line of window W. Value is the number
16471 of mode lines displayed. */
16474 display_mode_lines (w
)
16477 Lisp_Object old_selected_window
, old_selected_frame
;
16480 old_selected_frame
= selected_frame
;
16481 selected_frame
= w
->frame
;
16482 old_selected_window
= selected_window
;
16483 XSETWINDOW (selected_window
, w
);
16485 /* These will be set while the mode line specs are processed. */
16486 line_number_displayed
= 0;
16487 w
->column_number_displayed
= Qnil
;
16489 if (WINDOW_WANTS_MODELINE_P (w
))
16491 struct window
*sel_w
= XWINDOW (old_selected_window
);
16493 /* Select mode line face based on the real selected window. */
16494 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
16495 current_buffer
->mode_line_format
);
16499 if (WINDOW_WANTS_HEADER_LINE_P (w
))
16501 display_mode_line (w
, HEADER_LINE_FACE_ID
,
16502 current_buffer
->header_line_format
);
16506 selected_frame
= old_selected_frame
;
16507 selected_window
= old_selected_window
;
16512 /* Display mode or top line of window W. FACE_ID specifies which line
16513 to display; it is either MODE_LINE_FACE_ID or HEADER_LINE_FACE_ID.
16514 FORMAT is the mode line format to display. Value is the pixel
16515 height of the mode line displayed. */
16518 display_mode_line (w
, face_id
, format
)
16520 enum face_id face_id
;
16521 Lisp_Object format
;
16525 int count
= SPECPDL_INDEX ();
16527 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
16528 prepare_desired_row (it
.glyph_row
);
16530 it
.glyph_row
->mode_line_p
= 1;
16532 if (! mode_line_inverse_video
)
16533 /* Force the mode-line to be displayed in the default face. */
16534 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
16536 record_unwind_protect (unwind_format_mode_line
,
16537 format_mode_line_unwind_data (NULL
, 0));
16539 mode_line_target
= MODE_LINE_DISPLAY
;
16541 /* Temporarily make frame's keyboard the current kboard so that
16542 kboard-local variables in the mode_line_format will get the right
16544 push_frame_kboard (it
.f
);
16545 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
16546 pop_frame_kboard ();
16548 unbind_to (count
, Qnil
);
16550 /* Fill up with spaces. */
16551 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
16553 compute_line_metrics (&it
);
16554 it
.glyph_row
->full_width_p
= 1;
16555 it
.glyph_row
->continued_p
= 0;
16556 it
.glyph_row
->truncated_on_left_p
= 0;
16557 it
.glyph_row
->truncated_on_right_p
= 0;
16559 /* Make a 3D mode-line have a shadow at its right end. */
16560 face
= FACE_FROM_ID (it
.f
, face_id
);
16561 extend_face_to_end_of_line (&it
);
16562 if (face
->box
!= FACE_NO_BOX
)
16564 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
16565 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
16566 last
->right_box_line_p
= 1;
16569 return it
.glyph_row
->height
;
16572 /* Move element ELT in LIST to the front of LIST.
16573 Return the updated list. */
16576 move_elt_to_front (elt
, list
)
16577 Lisp_Object elt
, list
;
16579 register Lisp_Object tail
, prev
;
16580 register Lisp_Object tem
;
16584 while (CONSP (tail
))
16590 /* Splice out the link TAIL. */
16592 list
= XCDR (tail
);
16594 Fsetcdr (prev
, XCDR (tail
));
16596 /* Now make it the first. */
16597 Fsetcdr (tail
, list
);
16602 tail
= XCDR (tail
);
16606 /* Not found--return unchanged LIST. */
16610 /* Contribute ELT to the mode line for window IT->w. How it
16611 translates into text depends on its data type.
16613 IT describes the display environment in which we display, as usual.
16615 DEPTH is the depth in recursion. It is used to prevent
16616 infinite recursion here.
16618 FIELD_WIDTH is the number of characters the display of ELT should
16619 occupy in the mode line, and PRECISION is the maximum number of
16620 characters to display from ELT's representation. See
16621 display_string for details.
16623 Returns the hpos of the end of the text generated by ELT.
16625 PROPS is a property list to add to any string we encounter.
16627 If RISKY is nonzero, remove (disregard) any properties in any string
16628 we encounter, and ignore :eval and :propertize.
16630 The global variable `mode_line_target' determines whether the
16631 output is passed to `store_mode_line_noprop',
16632 `store_mode_line_string', or `display_string'. */
16635 display_mode_element (it
, depth
, field_width
, precision
, elt
, props
, risky
)
16638 int field_width
, precision
;
16639 Lisp_Object elt
, props
;
16642 int n
= 0, field
, prec
;
16647 elt
= build_string ("*too-deep*");
16651 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
16655 /* A string: output it and check for %-constructs within it. */
16659 if (SCHARS (elt
) > 0
16660 && (!NILP (props
) || risky
))
16662 Lisp_Object oprops
, aelt
;
16663 oprops
= Ftext_properties_at (make_number (0), elt
);
16665 /* If the starting string's properties are not what
16666 we want, translate the string. Also, if the string
16667 is risky, do that anyway. */
16669 if (NILP (Fequal (props
, oprops
)) || risky
)
16671 /* If the starting string has properties,
16672 merge the specified ones onto the existing ones. */
16673 if (! NILP (oprops
) && !risky
)
16677 oprops
= Fcopy_sequence (oprops
);
16679 while (CONSP (tem
))
16681 oprops
= Fplist_put (oprops
, XCAR (tem
),
16682 XCAR (XCDR (tem
)));
16683 tem
= XCDR (XCDR (tem
));
16688 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
16689 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
16691 /* AELT is what we want. Move it to the front
16692 without consing. */
16694 mode_line_proptrans_alist
16695 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
16701 /* If AELT has the wrong props, it is useless.
16702 so get rid of it. */
16704 mode_line_proptrans_alist
16705 = Fdelq (aelt
, mode_line_proptrans_alist
);
16707 elt
= Fcopy_sequence (elt
);
16708 Fset_text_properties (make_number (0), Flength (elt
),
16710 /* Add this item to mode_line_proptrans_alist. */
16711 mode_line_proptrans_alist
16712 = Fcons (Fcons (elt
, props
),
16713 mode_line_proptrans_alist
);
16714 /* Truncate mode_line_proptrans_alist
16715 to at most 50 elements. */
16716 tem
= Fnthcdr (make_number (50),
16717 mode_line_proptrans_alist
);
16719 XSETCDR (tem
, Qnil
);
16728 prec
= precision
- n
;
16729 switch (mode_line_target
)
16731 case MODE_LINE_NOPROP
:
16732 case MODE_LINE_TITLE
:
16733 n
+= store_mode_line_noprop (SDATA (elt
), -1, prec
);
16735 case MODE_LINE_STRING
:
16736 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
16738 case MODE_LINE_DISPLAY
:
16739 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
16740 0, prec
, 0, STRING_MULTIBYTE (elt
));
16747 /* Handle the non-literal case. */
16749 while ((precision
<= 0 || n
< precision
)
16750 && SREF (elt
, offset
) != 0
16751 && (mode_line_target
!= MODE_LINE_DISPLAY
16752 || it
->current_x
< it
->last_visible_x
))
16754 int last_offset
= offset
;
16756 /* Advance to end of string or next format specifier. */
16757 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
16760 if (offset
- 1 != last_offset
)
16762 int nchars
, nbytes
;
16764 /* Output to end of string or up to '%'. Field width
16765 is length of string. Don't output more than
16766 PRECISION allows us. */
16769 prec
= c_string_width (SDATA (elt
) + last_offset
,
16770 offset
- last_offset
, precision
- n
,
16773 switch (mode_line_target
)
16775 case MODE_LINE_NOPROP
:
16776 case MODE_LINE_TITLE
:
16777 n
+= store_mode_line_noprop (SDATA (elt
) + last_offset
, 0, prec
);
16779 case MODE_LINE_STRING
:
16781 int bytepos
= last_offset
;
16782 int charpos
= string_byte_to_char (elt
, bytepos
);
16783 int endpos
= (precision
<= 0
16784 ? string_byte_to_char (elt
, offset
)
16785 : charpos
+ nchars
);
16787 n
+= store_mode_line_string (NULL
,
16788 Fsubstring (elt
, make_number (charpos
),
16789 make_number (endpos
)),
16793 case MODE_LINE_DISPLAY
:
16795 int bytepos
= last_offset
;
16796 int charpos
= string_byte_to_char (elt
, bytepos
);
16798 if (precision
<= 0)
16799 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
16800 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
16802 STRING_MULTIBYTE (elt
));
16807 else /* c == '%' */
16809 int percent_position
= offset
;
16811 /* Get the specified minimum width. Zero means
16814 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
16815 field
= field
* 10 + c
- '0';
16817 /* Don't pad beyond the total padding allowed. */
16818 if (field_width
- n
> 0 && field
> field_width
- n
)
16819 field
= field_width
- n
;
16821 /* Note that either PRECISION <= 0 or N < PRECISION. */
16822 prec
= precision
- n
;
16825 n
+= display_mode_element (it
, depth
, field
, prec
,
16826 Vglobal_mode_string
, props
,
16831 int bytepos
, charpos
;
16832 unsigned char *spec
;
16834 bytepos
= percent_position
;
16835 charpos
= (STRING_MULTIBYTE (elt
)
16836 ? string_byte_to_char (elt
, bytepos
)
16840 = decode_mode_spec (it
->w
, c
, field
, prec
, &multibyte
);
16842 switch (mode_line_target
)
16844 case MODE_LINE_NOPROP
:
16845 case MODE_LINE_TITLE
:
16846 n
+= store_mode_line_noprop (spec
, field
, prec
);
16848 case MODE_LINE_STRING
:
16850 int len
= strlen (spec
);
16851 Lisp_Object tem
= make_string (spec
, len
);
16852 props
= Ftext_properties_at (make_number (charpos
), elt
);
16853 /* Should only keep face property in props */
16854 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
16857 case MODE_LINE_DISPLAY
:
16859 int nglyphs_before
, nwritten
;
16861 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
16862 nwritten
= display_string (spec
, Qnil
, elt
,
16867 /* Assign to the glyphs written above the
16868 string where the `%x' came from, position
16872 struct glyph
*glyph
16873 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
16877 for (i
= 0; i
< nwritten
; ++i
)
16879 glyph
[i
].object
= elt
;
16880 glyph
[i
].charpos
= charpos
;
16897 /* A symbol: process the value of the symbol recursively
16898 as if it appeared here directly. Avoid error if symbol void.
16899 Special case: if value of symbol is a string, output the string
16902 register Lisp_Object tem
;
16904 /* If the variable is not marked as risky to set
16905 then its contents are risky to use. */
16906 if (NILP (Fget (elt
, Qrisky_local_variable
)))
16909 tem
= Fboundp (elt
);
16912 tem
= Fsymbol_value (elt
);
16913 /* If value is a string, output that string literally:
16914 don't check for % within it. */
16918 if (!EQ (tem
, elt
))
16920 /* Give up right away for nil or t. */
16930 register Lisp_Object car
, tem
;
16932 /* A cons cell: five distinct cases.
16933 If first element is :eval or :propertize, do something special.
16934 If first element is a string or a cons, process all the elements
16935 and effectively concatenate them.
16936 If first element is a negative number, truncate displaying cdr to
16937 at most that many characters. If positive, pad (with spaces)
16938 to at least that many characters.
16939 If first element is a symbol, process the cadr or caddr recursively
16940 according to whether the symbol's value is non-nil or nil. */
16942 if (EQ (car
, QCeval
))
16944 /* An element of the form (:eval FORM) means evaluate FORM
16945 and use the result as mode line elements. */
16950 if (CONSP (XCDR (elt
)))
16953 spec
= safe_eval (XCAR (XCDR (elt
)));
16954 n
+= display_mode_element (it
, depth
, field_width
- n
,
16955 precision
- n
, spec
, props
,
16959 else if (EQ (car
, QCpropertize
))
16961 /* An element of the form (:propertize ELT PROPS...)
16962 means display ELT but applying properties PROPS. */
16967 if (CONSP (XCDR (elt
)))
16968 n
+= display_mode_element (it
, depth
, field_width
- n
,
16969 precision
- n
, XCAR (XCDR (elt
)),
16970 XCDR (XCDR (elt
)), risky
);
16972 else if (SYMBOLP (car
))
16974 tem
= Fboundp (car
);
16978 /* elt is now the cdr, and we know it is a cons cell.
16979 Use its car if CAR has a non-nil value. */
16982 tem
= Fsymbol_value (car
);
16989 /* Symbol's value is nil (or symbol is unbound)
16990 Get the cddr of the original list
16991 and if possible find the caddr and use that. */
16995 else if (!CONSP (elt
))
17000 else if (INTEGERP (car
))
17002 register int lim
= XINT (car
);
17006 /* Negative int means reduce maximum width. */
17007 if (precision
<= 0)
17010 precision
= min (precision
, -lim
);
17014 /* Padding specified. Don't let it be more than
17015 current maximum. */
17017 lim
= min (precision
, lim
);
17019 /* If that's more padding than already wanted, queue it.
17020 But don't reduce padding already specified even if
17021 that is beyond the current truncation point. */
17022 field_width
= max (lim
, field_width
);
17026 else if (STRINGP (car
) || CONSP (car
))
17028 register int limit
= 50;
17029 /* Limit is to protect against circular lists. */
17032 && (precision
<= 0 || n
< precision
))
17034 n
+= display_mode_element (it
, depth
,
17035 /* Do padding only after the last
17036 element in the list. */
17037 (! CONSP (XCDR (elt
))
17040 precision
- n
, XCAR (elt
),
17050 elt
= build_string ("*invalid*");
17054 /* Pad to FIELD_WIDTH. */
17055 if (field_width
> 0 && n
< field_width
)
17057 switch (mode_line_target
)
17059 case MODE_LINE_NOPROP
:
17060 case MODE_LINE_TITLE
:
17061 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
17063 case MODE_LINE_STRING
:
17064 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
17066 case MODE_LINE_DISPLAY
:
17067 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
17076 /* Store a mode-line string element in mode_line_string_list.
17078 If STRING is non-null, display that C string. Otherwise, the Lisp
17079 string LISP_STRING is displayed.
17081 FIELD_WIDTH is the minimum number of output glyphs to produce.
17082 If STRING has fewer characters than FIELD_WIDTH, pad to the right
17083 with spaces. FIELD_WIDTH <= 0 means don't pad.
17085 PRECISION is the maximum number of characters to output from
17086 STRING. PRECISION <= 0 means don't truncate the string.
17088 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
17089 properties to the string.
17091 PROPS are the properties to add to the string.
17092 The mode_line_string_face face property is always added to the string.
17096 store_mode_line_string (string
, lisp_string
, copy_string
, field_width
, precision
, props
)
17098 Lisp_Object lisp_string
;
17107 if (string
!= NULL
)
17109 len
= strlen (string
);
17110 if (precision
> 0 && len
> precision
)
17112 lisp_string
= make_string (string
, len
);
17114 props
= mode_line_string_face_prop
;
17115 else if (!NILP (mode_line_string_face
))
17117 Lisp_Object face
= Fplist_get (props
, Qface
);
17118 props
= Fcopy_sequence (props
);
17120 face
= mode_line_string_face
;
17122 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
17123 props
= Fplist_put (props
, Qface
, face
);
17125 Fadd_text_properties (make_number (0), make_number (len
),
17126 props
, lisp_string
);
17130 len
= XFASTINT (Flength (lisp_string
));
17131 if (precision
> 0 && len
> precision
)
17134 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
17137 if (!NILP (mode_line_string_face
))
17141 props
= Ftext_properties_at (make_number (0), lisp_string
);
17142 face
= Fplist_get (props
, Qface
);
17144 face
= mode_line_string_face
;
17146 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
17147 props
= Fcons (Qface
, Fcons (face
, Qnil
));
17149 lisp_string
= Fcopy_sequence (lisp_string
);
17152 Fadd_text_properties (make_number (0), make_number (len
),
17153 props
, lisp_string
);
17158 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
17162 if (field_width
> len
)
17164 field_width
-= len
;
17165 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
17167 Fadd_text_properties (make_number (0), make_number (field_width
),
17168 props
, lisp_string
);
17169 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
17177 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
17179 doc
: /* Format a string out of a mode line format specification.
17180 First arg FORMAT specifies the mode line format (see `mode-line-format'
17181 for details) to use.
17183 Optional second arg FACE specifies the face property to put
17184 on all characters for which no face is specified.
17185 t means whatever face the window's mode line currently uses
17186 \(either `mode-line' or `mode-line-inactive', depending).
17187 nil means the default is no face property.
17188 If FACE is an integer, the value string has no text properties.
17190 Optional third and fourth args WINDOW and BUFFER specify the window
17191 and buffer to use as the context for the formatting (defaults
17192 are the selected window and the window's buffer). */)
17193 (format
, face
, window
, buffer
)
17194 Lisp_Object format
, face
, window
, buffer
;
17199 struct buffer
*old_buffer
= NULL
;
17201 int no_props
= INTEGERP (face
);
17202 int count
= SPECPDL_INDEX ();
17204 int string_start
= 0;
17207 window
= selected_window
;
17208 CHECK_WINDOW (window
);
17209 w
= XWINDOW (window
);
17212 buffer
= w
->buffer
;
17213 CHECK_BUFFER (buffer
);
17216 return build_string ("");
17224 face
= (EQ (window
, selected_window
) ? Qmode_line
: Qmode_line_inactive
);
17225 face_id
= lookup_named_face (XFRAME (WINDOW_FRAME (w
)), face
, 0, 0);
17229 face_id
= DEFAULT_FACE_ID
;
17231 if (XBUFFER (buffer
) != current_buffer
)
17232 old_buffer
= current_buffer
;
17234 /* Save things including mode_line_proptrans_alist,
17235 and set that to nil so that we don't alter the outer value. */
17236 record_unwind_protect (unwind_format_mode_line
,
17237 format_mode_line_unwind_data (old_buffer
, 1));
17238 mode_line_proptrans_alist
= Qnil
;
17241 set_buffer_internal_1 (XBUFFER (buffer
));
17243 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
17247 mode_line_target
= MODE_LINE_NOPROP
;
17248 mode_line_string_face_prop
= Qnil
;
17249 mode_line_string_list
= Qnil
;
17250 string_start
= MODE_LINE_NOPROP_LEN (0);
17254 mode_line_target
= MODE_LINE_STRING
;
17255 mode_line_string_list
= Qnil
;
17256 mode_line_string_face
= face
;
17257 mode_line_string_face_prop
17258 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
17261 push_frame_kboard (it
.f
);
17262 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
17263 pop_frame_kboard ();
17267 len
= MODE_LINE_NOPROP_LEN (string_start
);
17268 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
17272 mode_line_string_list
= Fnreverse (mode_line_string_list
);
17273 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
17274 make_string ("", 0));
17277 unbind_to (count
, Qnil
);
17281 /* Write a null-terminated, right justified decimal representation of
17282 the positive integer D to BUF using a minimal field width WIDTH. */
17285 pint2str (buf
, width
, d
)
17286 register char *buf
;
17287 register int width
;
17290 register char *p
= buf
;
17298 *p
++ = d
% 10 + '0';
17303 for (width
-= (int) (p
- buf
); width
> 0; --width
)
17314 /* Write a null-terminated, right justified decimal and "human
17315 readable" representation of the nonnegative integer D to BUF using
17316 a minimal field width WIDTH. D should be smaller than 999.5e24. */
17318 static const char power_letter
[] =
17332 pint2hrstr (buf
, width
, d
)
17337 /* We aim to represent the nonnegative integer D as
17338 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
17341 /* -1 means: do not use TENTHS. */
17345 /* Length of QUOTIENT.TENTHS as a string. */
17351 if (1000 <= quotient
)
17353 /* Scale to the appropriate EXPONENT. */
17356 remainder
= quotient
% 1000;
17360 while (1000 <= quotient
);
17362 /* Round to nearest and decide whether to use TENTHS or not. */
17365 tenths
= remainder
/ 100;
17366 if (50 <= remainder
% 100)
17373 if (quotient
== 10)
17381 if (500 <= remainder
)
17383 if (quotient
< 999)
17394 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
17395 if (tenths
== -1 && quotient
<= 99)
17402 p
= psuffix
= buf
+ max (width
, length
);
17404 /* Print EXPONENT. */
17406 *psuffix
++ = power_letter
[exponent
];
17409 /* Print TENTHS. */
17412 *--p
= '0' + tenths
;
17416 /* Print QUOTIENT. */
17419 int digit
= quotient
% 10;
17420 *--p
= '0' + digit
;
17422 while ((quotient
/= 10) != 0);
17424 /* Print leading spaces. */
17429 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
17430 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
17431 type of CODING_SYSTEM. Return updated pointer into BUF. */
17433 static unsigned char invalid_eol_type
[] = "(*invalid*)";
17436 decode_mode_spec_coding (coding_system
, buf
, eol_flag
)
17437 Lisp_Object coding_system
;
17438 register char *buf
;
17442 int multibyte
= !NILP (current_buffer
->enable_multibyte_characters
);
17443 const unsigned char *eol_str
;
17445 /* The EOL conversion we are using. */
17446 Lisp_Object eoltype
;
17448 val
= Fget (coding_system
, Qcoding_system
);
17451 if (!VECTORP (val
)) /* Not yet decided. */
17456 eoltype
= eol_mnemonic_undecided
;
17457 /* Don't mention EOL conversion if it isn't decided. */
17461 Lisp_Object eolvalue
;
17463 eolvalue
= Fget (coding_system
, Qeol_type
);
17466 *buf
++ = XFASTINT (AREF (val
, 1));
17470 /* The EOL conversion that is normal on this system. */
17472 if (NILP (eolvalue
)) /* Not yet decided. */
17473 eoltype
= eol_mnemonic_undecided
;
17474 else if (VECTORP (eolvalue
)) /* Not yet decided. */
17475 eoltype
= eol_mnemonic_undecided
;
17476 else /* INTEGERP (eolvalue) -- 0:LF, 1:CRLF, 2:CR */
17477 eoltype
= (XFASTINT (eolvalue
) == 0
17478 ? eol_mnemonic_unix
17479 : (XFASTINT (eolvalue
) == 1
17480 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
17486 /* Mention the EOL conversion if it is not the usual one. */
17487 if (STRINGP (eoltype
))
17489 eol_str
= SDATA (eoltype
);
17490 eol_str_len
= SBYTES (eoltype
);
17492 else if (INTEGERP (eoltype
)
17493 && CHAR_VALID_P (XINT (eoltype
), 0))
17495 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
17496 eol_str_len
= CHAR_STRING (XINT (eoltype
), tmp
);
17501 eol_str
= invalid_eol_type
;
17502 eol_str_len
= sizeof (invalid_eol_type
) - 1;
17504 bcopy (eol_str
, buf
, eol_str_len
);
17505 buf
+= eol_str_len
;
17511 /* Return a string for the output of a mode line %-spec for window W,
17512 generated by character C. PRECISION >= 0 means don't return a
17513 string longer than that value. FIELD_WIDTH > 0 means pad the
17514 string returned with spaces to that value. Return 1 in *MULTIBYTE
17515 if the result is multibyte text.
17517 Note we operate on the current buffer for most purposes,
17518 the exception being w->base_line_pos. */
17520 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
17523 decode_mode_spec (w
, c
, field_width
, precision
, multibyte
)
17526 int field_width
, precision
;
17530 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
17531 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
17532 struct buffer
*b
= current_buffer
;
17540 if (!NILP (b
->read_only
))
17542 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
17547 /* This differs from %* only for a modified read-only buffer. */
17548 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
17550 if (!NILP (b
->read_only
))
17555 /* This differs from %* in ignoring read-only-ness. */
17556 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
17568 if (command_loop_level
> 5)
17570 p
= decode_mode_spec_buf
;
17571 for (i
= 0; i
< command_loop_level
; i
++)
17574 return decode_mode_spec_buf
;
17582 if (command_loop_level
> 5)
17584 p
= decode_mode_spec_buf
;
17585 for (i
= 0; i
< command_loop_level
; i
++)
17588 return decode_mode_spec_buf
;
17595 /* Let lots_of_dashes be a string of infinite length. */
17596 if (mode_line_target
== MODE_LINE_NOPROP
||
17597 mode_line_target
== MODE_LINE_STRING
)
17599 if (field_width
<= 0
17600 || field_width
> sizeof (lots_of_dashes
))
17602 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
17603 decode_mode_spec_buf
[i
] = '-';
17604 decode_mode_spec_buf
[i
] = '\0';
17605 return decode_mode_spec_buf
;
17608 return lots_of_dashes
;
17617 int col
= (int) current_column (); /* iftc */
17618 w
->column_number_displayed
= make_number (col
);
17619 pint2str (decode_mode_spec_buf
, field_width
, col
);
17620 return decode_mode_spec_buf
;
17624 #ifndef SYSTEM_MALLOC
17626 if (NILP (Vmemory_full
))
17629 return "!MEM FULL! ";
17636 /* %F displays the frame name. */
17637 if (!NILP (f
->title
))
17638 return (char *) SDATA (f
->title
);
17639 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
17640 return (char *) SDATA (f
->name
);
17649 int size
= ZV
- BEGV
;
17650 pint2str (decode_mode_spec_buf
, field_width
, size
);
17651 return decode_mode_spec_buf
;
17656 int size
= ZV
- BEGV
;
17657 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
17658 return decode_mode_spec_buf
;
17663 int startpos
= XMARKER (w
->start
)->charpos
;
17664 int startpos_byte
= marker_byte_position (w
->start
);
17665 int line
, linepos
, linepos_byte
, topline
;
17667 int height
= WINDOW_TOTAL_LINES (w
);
17669 /* If we decided that this buffer isn't suitable for line numbers,
17670 don't forget that too fast. */
17671 if (EQ (w
->base_line_pos
, w
->buffer
))
17673 /* But do forget it, if the window shows a different buffer now. */
17674 else if (BUFFERP (w
->base_line_pos
))
17675 w
->base_line_pos
= Qnil
;
17677 /* If the buffer is very big, don't waste time. */
17678 if (INTEGERP (Vline_number_display_limit
)
17679 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
17681 w
->base_line_pos
= Qnil
;
17682 w
->base_line_number
= Qnil
;
17686 if (!NILP (w
->base_line_number
)
17687 && !NILP (w
->base_line_pos
)
17688 && XFASTINT (w
->base_line_pos
) <= startpos
)
17690 line
= XFASTINT (w
->base_line_number
);
17691 linepos
= XFASTINT (w
->base_line_pos
);
17692 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
17697 linepos
= BUF_BEGV (b
);
17698 linepos_byte
= BUF_BEGV_BYTE (b
);
17701 /* Count lines from base line to window start position. */
17702 nlines
= display_count_lines (linepos
, linepos_byte
,
17706 topline
= nlines
+ line
;
17708 /* Determine a new base line, if the old one is too close
17709 or too far away, or if we did not have one.
17710 "Too close" means it's plausible a scroll-down would
17711 go back past it. */
17712 if (startpos
== BUF_BEGV (b
))
17714 w
->base_line_number
= make_number (topline
);
17715 w
->base_line_pos
= make_number (BUF_BEGV (b
));
17717 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
17718 || linepos
== BUF_BEGV (b
))
17720 int limit
= BUF_BEGV (b
);
17721 int limit_byte
= BUF_BEGV_BYTE (b
);
17723 int distance
= (height
* 2 + 30) * line_number_display_limit_width
;
17725 if (startpos
- distance
> limit
)
17727 limit
= startpos
- distance
;
17728 limit_byte
= CHAR_TO_BYTE (limit
);
17731 nlines
= display_count_lines (startpos
, startpos_byte
,
17733 - (height
* 2 + 30),
17735 /* If we couldn't find the lines we wanted within
17736 line_number_display_limit_width chars per line,
17737 give up on line numbers for this window. */
17738 if (position
== limit_byte
&& limit
== startpos
- distance
)
17740 w
->base_line_pos
= w
->buffer
;
17741 w
->base_line_number
= Qnil
;
17745 w
->base_line_number
= make_number (topline
- nlines
);
17746 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
17749 /* Now count lines from the start pos to point. */
17750 nlines
= display_count_lines (startpos
, startpos_byte
,
17751 PT_BYTE
, PT
, &junk
);
17753 /* Record that we did display the line number. */
17754 line_number_displayed
= 1;
17756 /* Make the string to show. */
17757 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
17758 return decode_mode_spec_buf
;
17761 char* p
= decode_mode_spec_buf
;
17762 int pad
= field_width
- 2;
17768 return decode_mode_spec_buf
;
17774 obj
= b
->mode_name
;
17778 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
17784 int pos
= marker_position (w
->start
);
17785 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
17787 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
17789 if (pos
<= BUF_BEGV (b
))
17794 else if (pos
<= BUF_BEGV (b
))
17798 if (total
> 1000000)
17799 /* Do it differently for a large value, to avoid overflow. */
17800 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
17802 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
17803 /* We can't normally display a 3-digit number,
17804 so get us a 2-digit number that is close. */
17807 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
17808 return decode_mode_spec_buf
;
17812 /* Display percentage of size above the bottom of the screen. */
17815 int toppos
= marker_position (w
->start
);
17816 int botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
17817 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
17819 if (botpos
>= BUF_ZV (b
))
17821 if (toppos
<= BUF_BEGV (b
))
17828 if (total
> 1000000)
17829 /* Do it differently for a large value, to avoid overflow. */
17830 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
17832 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
17833 /* We can't normally display a 3-digit number,
17834 so get us a 2-digit number that is close. */
17837 if (toppos
<= BUF_BEGV (b
))
17838 sprintf (decode_mode_spec_buf
, "Top%2d%%", total
);
17840 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
17841 return decode_mode_spec_buf
;
17846 /* status of process */
17847 obj
= Fget_buffer_process (Fcurrent_buffer ());
17849 return "no process";
17850 #ifdef subprocesses
17851 obj
= Fsymbol_name (Fprocess_status (obj
));
17855 case 't': /* indicate TEXT or BINARY */
17856 #ifdef MODE_LINE_BINARY_TEXT
17857 return MODE_LINE_BINARY_TEXT (b
);
17863 /* coding-system (not including end-of-line format) */
17865 /* coding-system (including end-of-line type) */
17867 int eol_flag
= (c
== 'Z');
17868 char *p
= decode_mode_spec_buf
;
17870 if (! FRAME_WINDOW_P (f
))
17872 /* No need to mention EOL here--the terminal never needs
17873 to do EOL conversion. */
17874 p
= decode_mode_spec_coding (keyboard_coding
.symbol
, p
, 0);
17875 p
= decode_mode_spec_coding (terminal_coding
.symbol
, p
, 0);
17877 p
= decode_mode_spec_coding (b
->buffer_file_coding_system
,
17880 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
17881 #ifdef subprocesses
17882 obj
= Fget_buffer_process (Fcurrent_buffer ());
17883 if (PROCESSP (obj
))
17885 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
17887 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
17890 #endif /* subprocesses */
17893 return decode_mode_spec_buf
;
17899 *multibyte
= STRING_MULTIBYTE (obj
);
17900 return (char *) SDATA (obj
);
17907 /* Count up to COUNT lines starting from START / START_BYTE.
17908 But don't go beyond LIMIT_BYTE.
17909 Return the number of lines thus found (always nonnegative).
17911 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
17914 display_count_lines (start
, start_byte
, limit_byte
, count
, byte_pos_ptr
)
17915 int start
, start_byte
, limit_byte
, count
;
17918 register unsigned char *cursor
;
17919 unsigned char *base
;
17921 register int ceiling
;
17922 register unsigned char *ceiling_addr
;
17923 int orig_count
= count
;
17925 /* If we are not in selective display mode,
17926 check only for newlines. */
17927 int selective_display
= (!NILP (current_buffer
->selective_display
)
17928 && !INTEGERP (current_buffer
->selective_display
));
17932 while (start_byte
< limit_byte
)
17934 ceiling
= BUFFER_CEILING_OF (start_byte
);
17935 ceiling
= min (limit_byte
- 1, ceiling
);
17936 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
17937 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
17940 if (selective_display
)
17941 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
17944 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
17947 if (cursor
!= ceiling_addr
)
17951 start_byte
+= cursor
- base
+ 1;
17952 *byte_pos_ptr
= start_byte
;
17956 if (++cursor
== ceiling_addr
)
17962 start_byte
+= cursor
- base
;
17967 while (start_byte
> limit_byte
)
17969 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
17970 ceiling
= max (limit_byte
, ceiling
);
17971 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
17972 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
17975 if (selective_display
)
17976 while (--cursor
!= ceiling_addr
17977 && *cursor
!= '\n' && *cursor
!= 015)
17980 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
17983 if (cursor
!= ceiling_addr
)
17987 start_byte
+= cursor
- base
+ 1;
17988 *byte_pos_ptr
= start_byte
;
17989 /* When scanning backwards, we should
17990 not count the newline posterior to which we stop. */
17991 return - orig_count
- 1;
17997 /* Here we add 1 to compensate for the last decrement
17998 of CURSOR, which took it past the valid range. */
17999 start_byte
+= cursor
- base
+ 1;
18003 *byte_pos_ptr
= limit_byte
;
18006 return - orig_count
+ count
;
18007 return orig_count
- count
;
18013 /***********************************************************************
18015 ***********************************************************************/
18017 /* Display a NUL-terminated string, starting with index START.
18019 If STRING is non-null, display that C string. Otherwise, the Lisp
18020 string LISP_STRING is displayed.
18022 If FACE_STRING is not nil, FACE_STRING_POS is a position in
18023 FACE_STRING. Display STRING or LISP_STRING with the face at
18024 FACE_STRING_POS in FACE_STRING:
18026 Display the string in the environment given by IT, but use the
18027 standard display table, temporarily.
18029 FIELD_WIDTH is the minimum number of output glyphs to produce.
18030 If STRING has fewer characters than FIELD_WIDTH, pad to the right
18031 with spaces. If STRING has more characters, more than FIELD_WIDTH
18032 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
18034 PRECISION is the maximum number of characters to output from
18035 STRING. PRECISION < 0 means don't truncate the string.
18037 This is roughly equivalent to printf format specifiers:
18039 FIELD_WIDTH PRECISION PRINTF
18040 ----------------------------------------
18046 MULTIBYTE zero means do not display multibyte chars, > 0 means do
18047 display them, and < 0 means obey the current buffer's value of
18048 enable_multibyte_characters.
18050 Value is the number of columns displayed. */
18053 display_string (string
, lisp_string
, face_string
, face_string_pos
,
18054 start
, it
, field_width
, precision
, max_x
, multibyte
)
18055 unsigned char *string
;
18056 Lisp_Object lisp_string
;
18057 Lisp_Object face_string
;
18058 int face_string_pos
;
18061 int field_width
, precision
, max_x
;
18064 int hpos_at_start
= it
->hpos
;
18065 int saved_face_id
= it
->face_id
;
18066 struct glyph_row
*row
= it
->glyph_row
;
18068 /* Initialize the iterator IT for iteration over STRING beginning
18069 with index START. */
18070 reseat_to_string (it
, string
, lisp_string
, start
,
18071 precision
, field_width
, multibyte
);
18073 /* If displaying STRING, set up the face of the iterator
18074 from LISP_STRING, if that's given. */
18075 if (STRINGP (face_string
))
18081 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
18082 0, it
->region_beg_charpos
,
18083 it
->region_end_charpos
,
18084 &endptr
, it
->base_face_id
, 0);
18085 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18086 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
18089 /* Set max_x to the maximum allowed X position. Don't let it go
18090 beyond the right edge of the window. */
18092 max_x
= it
->last_visible_x
;
18094 max_x
= min (max_x
, it
->last_visible_x
);
18096 /* Skip over display elements that are not visible. because IT->w is
18098 if (it
->current_x
< it
->first_visible_x
)
18099 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
18100 MOVE_TO_POS
| MOVE_TO_X
);
18102 row
->ascent
= it
->max_ascent
;
18103 row
->height
= it
->max_ascent
+ it
->max_descent
;
18104 row
->phys_ascent
= it
->max_phys_ascent
;
18105 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18106 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18108 /* This condition is for the case that we are called with current_x
18109 past last_visible_x. */
18110 while (it
->current_x
< max_x
)
18112 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
18114 /* Get the next display element. */
18115 if (!get_next_display_element (it
))
18118 /* Produce glyphs. */
18119 x_before
= it
->current_x
;
18120 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
18121 PRODUCE_GLYPHS (it
);
18123 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
18126 while (i
< nglyphs
)
18128 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
18130 if (!it
->truncate_lines_p
18131 && x
+ glyph
->pixel_width
> max_x
)
18133 /* End of continued line or max_x reached. */
18134 if (CHAR_GLYPH_PADDING_P (*glyph
))
18136 /* A wide character is unbreakable. */
18137 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18138 it
->current_x
= x_before
;
18142 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
18147 else if (x
+ glyph
->pixel_width
> it
->first_visible_x
)
18149 /* Glyph is at least partially visible. */
18151 if (x
< it
->first_visible_x
)
18152 it
->glyph_row
->x
= x
- it
->first_visible_x
;
18156 /* Glyph is off the left margin of the display area.
18157 Should not happen. */
18161 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18162 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18163 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18164 row
->phys_height
= max (row
->phys_height
,
18165 it
->max_phys_ascent
+ it
->max_phys_descent
);
18166 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18167 it
->max_extra_line_spacing
);
18168 x
+= glyph
->pixel_width
;
18172 /* Stop if max_x reached. */
18176 /* Stop at line ends. */
18177 if (ITERATOR_AT_END_OF_LINE_P (it
))
18179 it
->continuation_lines_width
= 0;
18183 set_iterator_to_next (it
, 1);
18185 /* Stop if truncating at the right edge. */
18186 if (it
->truncate_lines_p
18187 && it
->current_x
>= it
->last_visible_x
)
18189 /* Add truncation mark, but don't do it if the line is
18190 truncated at a padding space. */
18191 if (IT_CHARPOS (*it
) < it
->string_nchars
)
18193 if (!FRAME_WINDOW_P (it
->f
))
18197 if (it
->current_x
> it
->last_visible_x
)
18199 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
18200 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
18202 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
18204 row
->used
[TEXT_AREA
] = i
;
18205 produce_special_glyphs (it
, IT_TRUNCATION
);
18208 produce_special_glyphs (it
, IT_TRUNCATION
);
18210 it
->glyph_row
->truncated_on_right_p
= 1;
18216 /* Maybe insert a truncation at the left. */
18217 if (it
->first_visible_x
18218 && IT_CHARPOS (*it
) > 0)
18220 if (!FRAME_WINDOW_P (it
->f
))
18221 insert_left_trunc_glyphs (it
);
18222 it
->glyph_row
->truncated_on_left_p
= 1;
18225 it
->face_id
= saved_face_id
;
18227 /* Value is number of columns displayed. */
18228 return it
->hpos
- hpos_at_start
;
18233 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
18234 appears as an element of LIST or as the car of an element of LIST.
18235 If PROPVAL is a list, compare each element against LIST in that
18236 way, and return 1/2 if any element of PROPVAL is found in LIST.
18237 Otherwise return 0. This function cannot quit.
18238 The return value is 2 if the text is invisible but with an ellipsis
18239 and 1 if it's invisible and without an ellipsis. */
18242 invisible_p (propval
, list
)
18243 register Lisp_Object propval
;
18246 register Lisp_Object tail
, proptail
;
18248 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
18250 register Lisp_Object tem
;
18252 if (EQ (propval
, tem
))
18254 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
18255 return NILP (XCDR (tem
)) ? 1 : 2;
18258 if (CONSP (propval
))
18260 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
18262 Lisp_Object propelt
;
18263 propelt
= XCAR (proptail
);
18264 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
18266 register Lisp_Object tem
;
18268 if (EQ (propelt
, tem
))
18270 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
18271 return NILP (XCDR (tem
)) ? 1 : 2;
18279 /* Calculate a width or height in pixels from a specification using
18280 the following elements:
18283 NUM - a (fractional) multiple of the default font width/height
18284 (NUM) - specifies exactly NUM pixels
18285 UNIT - a fixed number of pixels, see below.
18286 ELEMENT - size of a display element in pixels, see below.
18287 (NUM . SPEC) - equals NUM * SPEC
18288 (+ SPEC SPEC ...) - add pixel values
18289 (- SPEC SPEC ...) - subtract pixel values
18290 (- SPEC) - negate pixel value
18293 INT or FLOAT - a number constant
18294 SYMBOL - use symbol's (buffer local) variable binding.
18297 in - pixels per inch *)
18298 mm - pixels per 1/1000 meter *)
18299 cm - pixels per 1/100 meter *)
18300 width - width of current font in pixels.
18301 height - height of current font in pixels.
18303 *) using the ratio(s) defined in display-pixels-per-inch.
18307 left-fringe - left fringe width in pixels
18308 right-fringe - right fringe width in pixels
18310 left-margin - left margin width in pixels
18311 right-margin - right margin width in pixels
18313 scroll-bar - scroll-bar area width in pixels
18317 Pixels corresponding to 5 inches:
18320 Total width of non-text areas on left side of window (if scroll-bar is on left):
18321 '(space :width (+ left-fringe left-margin scroll-bar))
18323 Align to first text column (in header line):
18324 '(space :align-to 0)
18326 Align to middle of text area minus half the width of variable `my-image'
18327 containing a loaded image:
18328 '(space :align-to (0.5 . (- text my-image)))
18330 Width of left margin minus width of 1 character in the default font:
18331 '(space :width (- left-margin 1))
18333 Width of left margin minus width of 2 characters in the current font:
18334 '(space :width (- left-margin (2 . width)))
18336 Center 1 character over left-margin (in header line):
18337 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
18339 Different ways to express width of left fringe plus left margin minus one pixel:
18340 '(space :width (- (+ left-fringe left-margin) (1)))
18341 '(space :width (+ left-fringe left-margin (- (1))))
18342 '(space :width (+ left-fringe left-margin (-1)))
18346 #define NUMVAL(X) \
18347 ((INTEGERP (X) || FLOATP (X)) \
18352 calc_pixel_width_or_height (res
, it
, prop
, font
, width_p
, align_to
)
18357 int width_p
, *align_to
;
18361 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
18362 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
18365 return OK_PIXELS (0);
18367 if (SYMBOLP (prop
))
18369 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
18371 char *unit
= SDATA (SYMBOL_NAME (prop
));
18373 if (unit
[0] == 'i' && unit
[1] == 'n')
18375 else if (unit
[0] == 'm' && unit
[1] == 'm')
18377 else if (unit
[0] == 'c' && unit
[1] == 'm')
18384 #ifdef HAVE_WINDOW_SYSTEM
18385 if (FRAME_WINDOW_P (it
->f
)
18387 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
18388 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
18390 return OK_PIXELS (ppi
/ pixels
);
18393 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
18394 || (CONSP (Vdisplay_pixels_per_inch
)
18396 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
18397 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
18399 return OK_PIXELS (ppi
/ pixels
);
18405 #ifdef HAVE_WINDOW_SYSTEM
18406 if (EQ (prop
, Qheight
))
18407 return OK_PIXELS (font
? FONT_HEIGHT ((XFontStruct
*)font
) : FRAME_LINE_HEIGHT (it
->f
));
18408 if (EQ (prop
, Qwidth
))
18409 return OK_PIXELS (font
? FONT_WIDTH ((XFontStruct
*)font
) : FRAME_COLUMN_WIDTH (it
->f
));
18411 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
18412 return OK_PIXELS (1);
18415 if (EQ (prop
, Qtext
))
18416 return OK_PIXELS (width_p
18417 ? window_box_width (it
->w
, TEXT_AREA
)
18418 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
18420 if (align_to
&& *align_to
< 0)
18423 if (EQ (prop
, Qleft
))
18424 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
18425 if (EQ (prop
, Qright
))
18426 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
18427 if (EQ (prop
, Qcenter
))
18428 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
18429 + window_box_width (it
->w
, TEXT_AREA
) / 2);
18430 if (EQ (prop
, Qleft_fringe
))
18431 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
18432 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
18433 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
18434 if (EQ (prop
, Qright_fringe
))
18435 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
18436 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
18437 : window_box_right_offset (it
->w
, TEXT_AREA
));
18438 if (EQ (prop
, Qleft_margin
))
18439 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
18440 if (EQ (prop
, Qright_margin
))
18441 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
18442 if (EQ (prop
, Qscroll_bar
))
18443 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
18445 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
18446 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
18447 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
18452 if (EQ (prop
, Qleft_fringe
))
18453 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
18454 if (EQ (prop
, Qright_fringe
))
18455 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
18456 if (EQ (prop
, Qleft_margin
))
18457 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
18458 if (EQ (prop
, Qright_margin
))
18459 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
18460 if (EQ (prop
, Qscroll_bar
))
18461 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
18464 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
18467 if (INTEGERP (prop
) || FLOATP (prop
))
18469 int base_unit
= (width_p
18470 ? FRAME_COLUMN_WIDTH (it
->f
)
18471 : FRAME_LINE_HEIGHT (it
->f
));
18472 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
18477 Lisp_Object car
= XCAR (prop
);
18478 Lisp_Object cdr
= XCDR (prop
);
18482 #ifdef HAVE_WINDOW_SYSTEM
18483 if (valid_image_p (prop
))
18485 int id
= lookup_image (it
->f
, prop
);
18486 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
18488 return OK_PIXELS (width_p
? img
->width
: img
->height
);
18491 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
18497 while (CONSP (cdr
))
18499 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
18500 font
, width_p
, align_to
))
18503 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
18508 if (EQ (car
, Qminus
))
18510 return OK_PIXELS (pixels
);
18513 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
18516 if (INTEGERP (car
) || FLOATP (car
))
18519 pixels
= XFLOATINT (car
);
18521 return OK_PIXELS (pixels
);
18522 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
18523 font
, width_p
, align_to
))
18524 return OK_PIXELS (pixels
* fact
);
18535 /***********************************************************************
18537 ***********************************************************************/
18539 #ifdef HAVE_WINDOW_SYSTEM
18544 dump_glyph_string (s
)
18545 struct glyph_string
*s
;
18547 fprintf (stderr
, "glyph string\n");
18548 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
18549 s
->x
, s
->y
, s
->width
, s
->height
);
18550 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
18551 fprintf (stderr
, " hl = %d\n", s
->hl
);
18552 fprintf (stderr
, " left overhang = %d, right = %d\n",
18553 s
->left_overhang
, s
->right_overhang
);
18554 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
18555 fprintf (stderr
, " extends to end of line = %d\n",
18556 s
->extends_to_end_of_line_p
);
18557 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
18558 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
18561 #endif /* GLYPH_DEBUG */
18563 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
18564 of XChar2b structures for S; it can't be allocated in
18565 init_glyph_string because it must be allocated via `alloca'. W
18566 is the window on which S is drawn. ROW and AREA are the glyph row
18567 and area within the row from which S is constructed. START is the
18568 index of the first glyph structure covered by S. HL is a
18569 face-override for drawing S. */
18572 #define OPTIONAL_HDC(hdc) hdc,
18573 #define DECLARE_HDC(hdc) HDC hdc;
18574 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
18575 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
18578 #ifndef OPTIONAL_HDC
18579 #define OPTIONAL_HDC(hdc)
18580 #define DECLARE_HDC(hdc)
18581 #define ALLOCATE_HDC(hdc, f)
18582 #define RELEASE_HDC(hdc, f)
18586 init_glyph_string (s
, OPTIONAL_HDC (hdc
) char2b
, w
, row
, area
, start
, hl
)
18587 struct glyph_string
*s
;
18591 struct glyph_row
*row
;
18592 enum glyph_row_area area
;
18594 enum draw_glyphs_face hl
;
18596 bzero (s
, sizeof *s
);
18598 s
->f
= XFRAME (w
->frame
);
18602 s
->display
= FRAME_X_DISPLAY (s
->f
);
18603 s
->window
= FRAME_X_WINDOW (s
->f
);
18604 s
->char2b
= char2b
;
18608 s
->first_glyph
= row
->glyphs
[area
] + start
;
18609 s
->height
= row
->height
;
18610 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
18612 /* Display the internal border below the tool-bar window. */
18613 if (WINDOWP (s
->f
->tool_bar_window
)
18614 && s
->w
== XWINDOW (s
->f
->tool_bar_window
))
18615 s
->y
-= FRAME_INTERNAL_BORDER_WIDTH (s
->f
);
18617 s
->ybase
= s
->y
+ row
->ascent
;
18621 /* Append the list of glyph strings with head H and tail T to the list
18622 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
18625 append_glyph_string_lists (head
, tail
, h
, t
)
18626 struct glyph_string
**head
, **tail
;
18627 struct glyph_string
*h
, *t
;
18641 /* Prepend the list of glyph strings with head H and tail T to the
18642 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
18646 prepend_glyph_string_lists (head
, tail
, h
, t
)
18647 struct glyph_string
**head
, **tail
;
18648 struct glyph_string
*h
, *t
;
18662 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
18663 Set *HEAD and *TAIL to the resulting list. */
18666 append_glyph_string (head
, tail
, s
)
18667 struct glyph_string
**head
, **tail
;
18668 struct glyph_string
*s
;
18670 s
->next
= s
->prev
= NULL
;
18671 append_glyph_string_lists (head
, tail
, s
, s
);
18675 /* Get face and two-byte form of character glyph GLYPH on frame F.
18676 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
18677 a pointer to a realized face that is ready for display. */
18679 static INLINE
struct face
*
18680 get_glyph_face_and_encoding (f
, glyph
, char2b
, two_byte_p
)
18682 struct glyph
*glyph
;
18688 xassert (glyph
->type
== CHAR_GLYPH
);
18689 face
= FACE_FROM_ID (f
, glyph
->face_id
);
18694 if (!glyph
->multibyte_p
)
18696 /* Unibyte case. We don't have to encode, but we have to make
18697 sure to use a face suitable for unibyte. */
18698 STORE_XCHAR2B (char2b
, 0, glyph
->u
.ch
);
18700 else if (glyph
->u
.ch
< 128)
18702 /* Case of ASCII in a face known to fit ASCII. */
18703 STORE_XCHAR2B (char2b
, 0, glyph
->u
.ch
);
18707 int c1
, c2
, charset
;
18709 /* Split characters into bytes. If c2 is -1 afterwards, C is
18710 really a one-byte character so that byte1 is zero. */
18711 SPLIT_CHAR (glyph
->u
.ch
, charset
, c1
, c2
);
18713 STORE_XCHAR2B (char2b
, c1
, c2
);
18715 STORE_XCHAR2B (char2b
, 0, c1
);
18717 /* Maybe encode the character in *CHAR2B. */
18718 if (charset
!= CHARSET_ASCII
)
18720 struct font_info
*font_info
18721 = FONT_INFO_FROM_ID (f
, face
->font_info_id
);
18724 = rif
->encode_char (glyph
->u
.ch
, char2b
, font_info
, two_byte_p
);
18728 /* Make sure X resources of the face are allocated. */
18729 xassert (face
!= NULL
);
18730 PREPARE_FACE_FOR_DISPLAY (f
, face
);
18735 /* Fill glyph string S with composition components specified by S->cmp.
18737 FACES is an array of faces for all components of this composition.
18738 S->gidx is the index of the first component for S.
18740 OVERLAPS non-zero means S should draw the foreground only, and use
18741 its physical height for clipping. See also draw_glyphs.
18743 Value is the index of a component not in S. */
18746 fill_composite_glyph_string (s
, faces
, overlaps
)
18747 struct glyph_string
*s
;
18748 struct face
**faces
;
18755 s
->for_overlaps
= overlaps
;
18757 s
->face
= faces
[s
->gidx
];
18758 s
->font
= s
->face
->font
;
18759 s
->font_info
= FONT_INFO_FROM_ID (s
->f
, s
->face
->font_info_id
);
18761 /* For all glyphs of this composition, starting at the offset
18762 S->gidx, until we reach the end of the definition or encounter a
18763 glyph that requires the different face, add it to S. */
18765 for (i
= s
->gidx
+ 1; i
< s
->cmp
->glyph_len
&& faces
[i
] == s
->face
; ++i
)
18768 /* All glyph strings for the same composition has the same width,
18769 i.e. the width set for the first component of the composition. */
18771 s
->width
= s
->first_glyph
->pixel_width
;
18773 /* If the specified font could not be loaded, use the frame's
18774 default font, but record the fact that we couldn't load it in
18775 the glyph string so that we can draw rectangles for the
18776 characters of the glyph string. */
18777 if (s
->font
== NULL
)
18779 s
->font_not_found_p
= 1;
18780 s
->font
= FRAME_FONT (s
->f
);
18783 /* Adjust base line for subscript/superscript text. */
18784 s
->ybase
+= s
->first_glyph
->voffset
;
18786 xassert (s
->face
&& s
->face
->gc
);
18788 /* This glyph string must always be drawn with 16-bit functions. */
18791 return s
->gidx
+ s
->nchars
;
18795 /* Fill glyph string S from a sequence of character glyphs.
18797 FACE_ID is the face id of the string. START is the index of the
18798 first glyph to consider, END is the index of the last + 1.
18799 OVERLAPS non-zero means S should draw the foreground only, and use
18800 its physical height for clipping. See also draw_glyphs.
18802 Value is the index of the first glyph not in S. */
18805 fill_glyph_string (s
, face_id
, start
, end
, overlaps
)
18806 struct glyph_string
*s
;
18808 int start
, end
, overlaps
;
18810 struct glyph
*glyph
, *last
;
18812 int glyph_not_available_p
;
18814 xassert (s
->f
== XFRAME (s
->w
->frame
));
18815 xassert (s
->nchars
== 0);
18816 xassert (start
>= 0 && end
> start
);
18818 s
->for_overlaps
= overlaps
,
18819 glyph
= s
->row
->glyphs
[s
->area
] + start
;
18820 last
= s
->row
->glyphs
[s
->area
] + end
;
18821 voffset
= glyph
->voffset
;
18823 glyph_not_available_p
= glyph
->glyph_not_available_p
;
18825 while (glyph
< last
18826 && glyph
->type
== CHAR_GLYPH
18827 && glyph
->voffset
== voffset
18828 /* Same face id implies same font, nowadays. */
18829 && glyph
->face_id
== face_id
18830 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
18834 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
18835 s
->char2b
+ s
->nchars
,
18837 s
->two_byte_p
= two_byte_p
;
18839 xassert (s
->nchars
<= end
- start
);
18840 s
->width
+= glyph
->pixel_width
;
18844 s
->font
= s
->face
->font
;
18845 s
->font_info
= FONT_INFO_FROM_ID (s
->f
, s
->face
->font_info_id
);
18847 /* If the specified font could not be loaded, use the frame's font,
18848 but record the fact that we couldn't load it in
18849 S->font_not_found_p so that we can draw rectangles for the
18850 characters of the glyph string. */
18851 if (s
->font
== NULL
|| glyph_not_available_p
)
18853 s
->font_not_found_p
= 1;
18854 s
->font
= FRAME_FONT (s
->f
);
18857 /* Adjust base line for subscript/superscript text. */
18858 s
->ybase
+= voffset
;
18860 xassert (s
->face
&& s
->face
->gc
);
18861 return glyph
- s
->row
->glyphs
[s
->area
];
18865 /* Fill glyph string S from image glyph S->first_glyph. */
18868 fill_image_glyph_string (s
)
18869 struct glyph_string
*s
;
18871 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
18872 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
18874 s
->slice
= s
->first_glyph
->slice
;
18875 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
18876 s
->font
= s
->face
->font
;
18877 s
->width
= s
->first_glyph
->pixel_width
;
18879 /* Adjust base line for subscript/superscript text. */
18880 s
->ybase
+= s
->first_glyph
->voffset
;
18884 /* Fill glyph string S from a sequence of stretch glyphs.
18886 ROW is the glyph row in which the glyphs are found, AREA is the
18887 area within the row. START is the index of the first glyph to
18888 consider, END is the index of the last + 1.
18890 Value is the index of the first glyph not in S. */
18893 fill_stretch_glyph_string (s
, row
, area
, start
, end
)
18894 struct glyph_string
*s
;
18895 struct glyph_row
*row
;
18896 enum glyph_row_area area
;
18899 struct glyph
*glyph
, *last
;
18900 int voffset
, face_id
;
18902 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
18904 glyph
= s
->row
->glyphs
[s
->area
] + start
;
18905 last
= s
->row
->glyphs
[s
->area
] + end
;
18906 face_id
= glyph
->face_id
;
18907 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
18908 s
->font
= s
->face
->font
;
18909 s
->font_info
= FONT_INFO_FROM_ID (s
->f
, s
->face
->font_info_id
);
18910 s
->width
= glyph
->pixel_width
;
18912 voffset
= glyph
->voffset
;
18916 && glyph
->type
== STRETCH_GLYPH
18917 && glyph
->voffset
== voffset
18918 && glyph
->face_id
== face_id
);
18920 s
->width
+= glyph
->pixel_width
;
18922 /* Adjust base line for subscript/superscript text. */
18923 s
->ybase
+= voffset
;
18925 /* The case that face->gc == 0 is handled when drawing the glyph
18926 string by calling PREPARE_FACE_FOR_DISPLAY. */
18928 return glyph
- s
->row
->glyphs
[s
->area
];
18933 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
18934 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
18935 assumed to be zero. */
18938 x_get_glyph_overhangs (glyph
, f
, left
, right
)
18939 struct glyph
*glyph
;
18943 *left
= *right
= 0;
18945 if (glyph
->type
== CHAR_GLYPH
)
18949 struct font_info
*font_info
;
18953 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
18955 font_info
= FONT_INFO_FROM_ID (f
, face
->font_info_id
);
18956 if (font
/* ++KFS: Should this be font_info ? */
18957 && (pcm
= rif
->per_char_metric (font
, &char2b
, glyph
->font_type
)))
18959 if (pcm
->rbearing
> pcm
->width
)
18960 *right
= pcm
->rbearing
- pcm
->width
;
18961 if (pcm
->lbearing
< 0)
18962 *left
= -pcm
->lbearing
;
18968 /* Return the index of the first glyph preceding glyph string S that
18969 is overwritten by S because of S's left overhang. Value is -1
18970 if no glyphs are overwritten. */
18973 left_overwritten (s
)
18974 struct glyph_string
*s
;
18978 if (s
->left_overhang
)
18981 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
18982 int first
= s
->first_glyph
- glyphs
;
18984 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
18985 x
-= glyphs
[i
].pixel_width
;
18996 /* Return the index of the first glyph preceding glyph string S that
18997 is overwriting S because of its right overhang. Value is -1 if no
18998 glyph in front of S overwrites S. */
19001 left_overwriting (s
)
19002 struct glyph_string
*s
;
19005 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19006 int first
= s
->first_glyph
- glyphs
;
19010 for (i
= first
- 1; i
>= 0; --i
)
19013 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
19016 x
-= glyphs
[i
].pixel_width
;
19023 /* Return the index of the last glyph following glyph string S that is
19024 not overwritten by S because of S's right overhang. Value is -1 if
19025 no such glyph is found. */
19028 right_overwritten (s
)
19029 struct glyph_string
*s
;
19033 if (s
->right_overhang
)
19036 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19037 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
19038 int end
= s
->row
->used
[s
->area
];
19040 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
19041 x
+= glyphs
[i
].pixel_width
;
19050 /* Return the index of the last glyph following glyph string S that
19051 overwrites S because of its left overhang. Value is negative
19052 if no such glyph is found. */
19055 right_overwriting (s
)
19056 struct glyph_string
*s
;
19059 int end
= s
->row
->used
[s
->area
];
19060 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19061 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
19065 for (i
= first
; i
< end
; ++i
)
19068 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
19071 x
+= glyphs
[i
].pixel_width
;
19078 /* Get face and two-byte form of character C in face FACE_ID on frame
19079 F. The encoding of C is returned in *CHAR2B. MULTIBYTE_P non-zero
19080 means we want to display multibyte text. DISPLAY_P non-zero means
19081 make sure that X resources for the face returned are allocated.
19082 Value is a pointer to a realized face that is ready for display if
19083 DISPLAY_P is non-zero. */
19085 static INLINE
struct face
*
19086 get_char_face_and_encoding (f
, c
, face_id
, char2b
, multibyte_p
, display_p
)
19090 int multibyte_p
, display_p
;
19092 struct face
*face
= FACE_FROM_ID (f
, face_id
);
19096 /* Unibyte case. We don't have to encode, but we have to make
19097 sure to use a face suitable for unibyte. */
19098 STORE_XCHAR2B (char2b
, 0, c
);
19099 face_id
= FACE_FOR_CHAR (f
, face
, c
);
19100 face
= FACE_FROM_ID (f
, face_id
);
19104 /* Case of ASCII in a face known to fit ASCII. */
19105 STORE_XCHAR2B (char2b
, 0, c
);
19109 int c1
, c2
, charset
;
19111 /* Split characters into bytes. If c2 is -1 afterwards, C is
19112 really a one-byte character so that byte1 is zero. */
19113 SPLIT_CHAR (c
, charset
, c1
, c2
);
19115 STORE_XCHAR2B (char2b
, c1
, c2
);
19117 STORE_XCHAR2B (char2b
, 0, c1
);
19119 /* Maybe encode the character in *CHAR2B. */
19120 if (face
->font
!= NULL
)
19122 struct font_info
*font_info
19123 = FONT_INFO_FROM_ID (f
, face
->font_info_id
);
19125 rif
->encode_char (c
, char2b
, font_info
, 0);
19129 /* Make sure X resources of the face are allocated. */
19130 #ifdef HAVE_X_WINDOWS
19134 xassert (face
!= NULL
);
19135 PREPARE_FACE_FOR_DISPLAY (f
, face
);
19142 /* Set background width of glyph string S. START is the index of the
19143 first glyph following S. LAST_X is the right-most x-position + 1
19144 in the drawing area. */
19147 set_glyph_string_background_width (s
, start
, last_x
)
19148 struct glyph_string
*s
;
19152 /* If the face of this glyph string has to be drawn to the end of
19153 the drawing area, set S->extends_to_end_of_line_p. */
19155 if (start
== s
->row
->used
[s
->area
]
19156 && s
->area
== TEXT_AREA
19157 && ((s
->row
->fill_line_p
19158 && (s
->hl
== DRAW_NORMAL_TEXT
19159 || s
->hl
== DRAW_IMAGE_RAISED
19160 || s
->hl
== DRAW_IMAGE_SUNKEN
))
19161 || s
->hl
== DRAW_MOUSE_FACE
))
19162 s
->extends_to_end_of_line_p
= 1;
19164 /* If S extends its face to the end of the line, set its
19165 background_width to the distance to the right edge of the drawing
19167 if (s
->extends_to_end_of_line_p
)
19168 s
->background_width
= last_x
- s
->x
+ 1;
19170 s
->background_width
= s
->width
;
19174 /* Compute overhangs and x-positions for glyph string S and its
19175 predecessors, or successors. X is the starting x-position for S.
19176 BACKWARD_P non-zero means process predecessors. */
19179 compute_overhangs_and_x (s
, x
, backward_p
)
19180 struct glyph_string
*s
;
19188 if (rif
->compute_glyph_string_overhangs
)
19189 rif
->compute_glyph_string_overhangs (s
);
19199 if (rif
->compute_glyph_string_overhangs
)
19200 rif
->compute_glyph_string_overhangs (s
);
19210 /* The following macros are only called from draw_glyphs below.
19211 They reference the following parameters of that function directly:
19212 `w', `row', `area', and `overlap_p'
19213 as well as the following local variables:
19214 `s', `f', and `hdc' (in W32) */
19217 /* On W32, silently add local `hdc' variable to argument list of
19218 init_glyph_string. */
19219 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
19220 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
19222 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
19223 init_glyph_string (s, char2b, w, row, area, start, hl)
19226 /* Add a glyph string for a stretch glyph to the list of strings
19227 between HEAD and TAIL. START is the index of the stretch glyph in
19228 row area AREA of glyph row ROW. END is the index of the last glyph
19229 in that glyph row area. X is the current output position assigned
19230 to the new glyph string constructed. HL overrides that face of the
19231 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
19232 is the right-most x-position of the drawing area. */
19234 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
19235 and below -- keep them on one line. */
19236 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
19239 s = (struct glyph_string *) alloca (sizeof *s); \
19240 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
19241 START = fill_stretch_glyph_string (s, row, area, START, END); \
19242 append_glyph_string (&HEAD, &TAIL, s); \
19248 /* Add a glyph string for an image glyph to the list of strings
19249 between HEAD and TAIL. START is the index of the image glyph in
19250 row area AREA of glyph row ROW. END is the index of the last glyph
19251 in that glyph row area. X is the current output position assigned
19252 to the new glyph string constructed. HL overrides that face of the
19253 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
19254 is the right-most x-position of the drawing area. */
19256 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
19259 s = (struct glyph_string *) alloca (sizeof *s); \
19260 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
19261 fill_image_glyph_string (s); \
19262 append_glyph_string (&HEAD, &TAIL, s); \
19269 /* Add a glyph string for a sequence of character glyphs to the list
19270 of strings between HEAD and TAIL. START is the index of the first
19271 glyph in row area AREA of glyph row ROW that is part of the new
19272 glyph string. END is the index of the last glyph in that glyph row
19273 area. X is the current output position assigned to the new glyph
19274 string constructed. HL overrides that face of the glyph; e.g. it
19275 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
19276 right-most x-position of the drawing area. */
19278 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
19284 c = (row)->glyphs[area][START].u.ch; \
19285 face_id = (row)->glyphs[area][START].face_id; \
19287 s = (struct glyph_string *) alloca (sizeof *s); \
19288 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
19289 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
19290 append_glyph_string (&HEAD, &TAIL, s); \
19292 START = fill_glyph_string (s, face_id, START, END, overlaps); \
19297 /* Add a glyph string for a composite sequence to the list of strings
19298 between HEAD and TAIL. START is the index of the first glyph in
19299 row area AREA of glyph row ROW that is part of the new glyph
19300 string. END is the index of the last glyph in that glyph row area.
19301 X is the current output position assigned to the new glyph string
19302 constructed. HL overrides that face of the glyph; e.g. it is
19303 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
19304 x-position of the drawing area. */
19306 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
19308 int cmp_id = (row)->glyphs[area][START].u.cmp_id; \
19309 int face_id = (row)->glyphs[area][START].face_id; \
19310 struct face *base_face = FACE_FROM_ID (f, face_id); \
19311 struct composition *cmp = composition_table[cmp_id]; \
19312 int glyph_len = cmp->glyph_len; \
19314 struct face **faces; \
19315 struct glyph_string *first_s = NULL; \
19318 base_face = base_face->ascii_face; \
19319 char2b = (XChar2b *) alloca ((sizeof *char2b) * glyph_len); \
19320 faces = (struct face **) alloca ((sizeof *faces) * glyph_len); \
19321 /* At first, fill in `char2b' and `faces'. */ \
19322 for (n = 0; n < glyph_len; n++) \
19324 int c = COMPOSITION_GLYPH (cmp, n); \
19325 int this_face_id = FACE_FOR_CHAR (f, base_face, c); \
19326 faces[n] = FACE_FROM_ID (f, this_face_id); \
19327 get_char_face_and_encoding (f, c, this_face_id, \
19328 char2b + n, 1, 1); \
19331 /* Make glyph_strings for each glyph sequence that is drawable by \
19332 the same face, and append them to HEAD/TAIL. */ \
19333 for (n = 0; n < cmp->glyph_len;) \
19335 s = (struct glyph_string *) alloca (sizeof *s); \
19336 INIT_GLYPH_STRING (s, char2b + n, w, row, area, START, HL); \
19337 append_glyph_string (&(HEAD), &(TAIL), s); \
19345 n = fill_composite_glyph_string (s, faces, overlaps); \
19353 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
19354 of AREA of glyph row ROW on window W between indices START and END.
19355 HL overrides the face for drawing glyph strings, e.g. it is
19356 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
19357 x-positions of the drawing area.
19359 This is an ugly monster macro construct because we must use alloca
19360 to allocate glyph strings (because draw_glyphs can be called
19361 asynchronously). */
19363 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
19366 HEAD = TAIL = NULL; \
19367 while (START < END) \
19369 struct glyph *first_glyph = (row)->glyphs[area] + START; \
19370 switch (first_glyph->type) \
19373 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
19377 case COMPOSITE_GLYPH: \
19378 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
19382 case STRETCH_GLYPH: \
19383 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
19387 case IMAGE_GLYPH: \
19388 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
19396 set_glyph_string_background_width (s, START, LAST_X); \
19403 /* Draw glyphs between START and END in AREA of ROW on window W,
19404 starting at x-position X. X is relative to AREA in W. HL is a
19405 face-override with the following meaning:
19407 DRAW_NORMAL_TEXT draw normally
19408 DRAW_CURSOR draw in cursor face
19409 DRAW_MOUSE_FACE draw in mouse face.
19410 DRAW_INVERSE_VIDEO draw in mode line face
19411 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
19412 DRAW_IMAGE_RAISED draw an image with a raised relief around it
19414 If OVERLAPS is non-zero, draw only the foreground of characters and
19415 clip to the physical height of ROW. Non-zero value also defines
19416 the overlapping part to be drawn:
19418 OVERLAPS_PRED overlap with preceding rows
19419 OVERLAPS_SUCC overlap with succeeding rows
19420 OVERLAPS_BOTH overlap with both preceding/succeeding rows
19421 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
19423 Value is the x-position reached, relative to AREA of W. */
19426 draw_glyphs (w
, x
, row
, area
, start
, end
, hl
, overlaps
)
19429 struct glyph_row
*row
;
19430 enum glyph_row_area area
;
19432 enum draw_glyphs_face hl
;
19435 struct glyph_string
*head
, *tail
;
19436 struct glyph_string
*s
;
19437 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
19438 int last_x
, area_width
;
19441 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19444 ALLOCATE_HDC (hdc
, f
);
19446 /* Let's rather be paranoid than getting a SEGV. */
19447 end
= min (end
, row
->used
[area
]);
19448 start
= max (0, start
);
19449 start
= min (end
, start
);
19451 /* Translate X to frame coordinates. Set last_x to the right
19452 end of the drawing area. */
19453 if (row
->full_width_p
)
19455 /* X is relative to the left edge of W, without scroll bars
19457 x
+= WINDOW_LEFT_EDGE_X (w
);
19458 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
19462 int area_left
= window_box_left (w
, area
);
19464 area_width
= window_box_width (w
, area
);
19465 last_x
= area_left
+ area_width
;
19468 /* Build a doubly-linked list of glyph_string structures between
19469 head and tail from what we have to draw. Note that the macro
19470 BUILD_GLYPH_STRINGS will modify its start parameter. That's
19471 the reason we use a separate variable `i'. */
19473 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
19475 x_reached
= tail
->x
+ tail
->background_width
;
19479 /* If there are any glyphs with lbearing < 0 or rbearing > width in
19480 the row, redraw some glyphs in front or following the glyph
19481 strings built above. */
19482 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
19485 struct glyph_string
*h
, *t
;
19487 /* Compute overhangs for all glyph strings. */
19488 if (rif
->compute_glyph_string_overhangs
)
19489 for (s
= head
; s
; s
= s
->next
)
19490 rif
->compute_glyph_string_overhangs (s
);
19492 /* Prepend glyph strings for glyphs in front of the first glyph
19493 string that are overwritten because of the first glyph
19494 string's left overhang. The background of all strings
19495 prepended must be drawn because the first glyph string
19497 i
= left_overwritten (head
);
19501 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
19502 DRAW_NORMAL_TEXT
, dummy_x
, last_x
);
19504 compute_overhangs_and_x (t
, head
->x
, 1);
19505 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
19509 /* Prepend glyph strings for glyphs in front of the first glyph
19510 string that overwrite that glyph string because of their
19511 right overhang. For these strings, only the foreground must
19512 be drawn, because it draws over the glyph string at `head'.
19513 The background must not be drawn because this would overwrite
19514 right overhangs of preceding glyphs for which no glyph
19516 i
= left_overwriting (head
);
19520 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
19521 DRAW_NORMAL_TEXT
, dummy_x
, last_x
);
19522 for (s
= h
; s
; s
= s
->next
)
19523 s
->background_filled_p
= 1;
19524 compute_overhangs_and_x (t
, head
->x
, 1);
19525 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
19528 /* Append glyphs strings for glyphs following the last glyph
19529 string tail that are overwritten by tail. The background of
19530 these strings has to be drawn because tail's foreground draws
19532 i
= right_overwritten (tail
);
19535 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
19536 DRAW_NORMAL_TEXT
, x
, last_x
);
19537 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
19538 append_glyph_string_lists (&head
, &tail
, h
, t
);
19542 /* Append glyph strings for glyphs following the last glyph
19543 string tail that overwrite tail. The foreground of such
19544 glyphs has to be drawn because it writes into the background
19545 of tail. The background must not be drawn because it could
19546 paint over the foreground of following glyphs. */
19547 i
= right_overwriting (tail
);
19551 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
19552 DRAW_NORMAL_TEXT
, x
, last_x
);
19553 for (s
= h
; s
; s
= s
->next
)
19554 s
->background_filled_p
= 1;
19555 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
19556 append_glyph_string_lists (&head
, &tail
, h
, t
);
19558 if (clip_head
|| clip_tail
)
19559 for (s
= head
; s
; s
= s
->next
)
19561 s
->clip_head
= clip_head
;
19562 s
->clip_tail
= clip_tail
;
19566 /* Draw all strings. */
19567 for (s
= head
; s
; s
= s
->next
)
19568 rif
->draw_glyph_string (s
);
19570 if (area
== TEXT_AREA
19571 && !row
->full_width_p
19572 /* When drawing overlapping rows, only the glyph strings'
19573 foreground is drawn, which doesn't erase a cursor
19577 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
19578 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
19579 : (tail
? tail
->x
+ tail
->background_width
: x
));
19581 int text_left
= window_box_left (w
, TEXT_AREA
);
19585 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
19586 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
19589 /* Value is the x-position up to which drawn, relative to AREA of W.
19590 This doesn't include parts drawn because of overhangs. */
19591 if (row
->full_width_p
)
19592 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
19594 x_reached
-= window_box_left (w
, area
);
19596 RELEASE_HDC (hdc
, f
);
19601 /* Expand row matrix if too narrow. Don't expand if area
19604 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
19606 if (!fonts_changed_p \
19607 && (it->glyph_row->glyphs[area] \
19608 < it->glyph_row->glyphs[area + 1])) \
19610 it->w->ncols_scale_factor++; \
19611 fonts_changed_p = 1; \
19615 /* Store one glyph for IT->char_to_display in IT->glyph_row.
19616 Called from x_produce_glyphs when IT->glyph_row is non-null. */
19622 struct glyph
*glyph
;
19623 enum glyph_row_area area
= it
->area
;
19625 xassert (it
->glyph_row
);
19626 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
19628 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
19629 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
19631 glyph
->charpos
= CHARPOS (it
->position
);
19632 glyph
->object
= it
->object
;
19633 glyph
->pixel_width
= it
->pixel_width
;
19634 glyph
->ascent
= it
->ascent
;
19635 glyph
->descent
= it
->descent
;
19636 glyph
->voffset
= it
->voffset
;
19637 glyph
->type
= CHAR_GLYPH
;
19638 glyph
->multibyte_p
= it
->multibyte_p
;
19639 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
19640 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
19641 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
19642 || it
->phys_descent
> it
->descent
);
19643 glyph
->padding_p
= 0;
19644 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
19645 glyph
->face_id
= it
->face_id
;
19646 glyph
->u
.ch
= it
->char_to_display
;
19647 glyph
->slice
= null_glyph_slice
;
19648 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
19649 ++it
->glyph_row
->used
[area
];
19652 IT_EXPAND_MATRIX_WIDTH (it
, area
);
19655 /* Store one glyph for the composition IT->cmp_id in IT->glyph_row.
19656 Called from x_produce_glyphs when IT->glyph_row is non-null. */
19659 append_composite_glyph (it
)
19662 struct glyph
*glyph
;
19663 enum glyph_row_area area
= it
->area
;
19665 xassert (it
->glyph_row
);
19667 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
19668 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
19670 glyph
->charpos
= CHARPOS (it
->position
);
19671 glyph
->object
= it
->object
;
19672 glyph
->pixel_width
= it
->pixel_width
;
19673 glyph
->ascent
= it
->ascent
;
19674 glyph
->descent
= it
->descent
;
19675 glyph
->voffset
= it
->voffset
;
19676 glyph
->type
= COMPOSITE_GLYPH
;
19677 glyph
->multibyte_p
= it
->multibyte_p
;
19678 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
19679 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
19680 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
19681 || it
->phys_descent
> it
->descent
);
19682 glyph
->padding_p
= 0;
19683 glyph
->glyph_not_available_p
= 0;
19684 glyph
->face_id
= it
->face_id
;
19685 glyph
->u
.cmp_id
= it
->cmp_id
;
19686 glyph
->slice
= null_glyph_slice
;
19687 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
19688 ++it
->glyph_row
->used
[area
];
19691 IT_EXPAND_MATRIX_WIDTH (it
, area
);
19695 /* Change IT->ascent and IT->height according to the setting of
19699 take_vertical_position_into_account (it
)
19704 if (it
->voffset
< 0)
19705 /* Increase the ascent so that we can display the text higher
19707 it
->ascent
-= it
->voffset
;
19709 /* Increase the descent so that we can display the text lower
19711 it
->descent
+= it
->voffset
;
19716 /* Produce glyphs/get display metrics for the image IT is loaded with.
19717 See the description of struct display_iterator in dispextern.h for
19718 an overview of struct display_iterator. */
19721 produce_image_glyph (it
)
19727 struct glyph_slice slice
;
19729 xassert (it
->what
== IT_IMAGE
);
19731 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19733 /* Make sure X resources of the face is loaded. */
19734 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
19736 if (it
->image_id
< 0)
19738 /* Fringe bitmap. */
19739 it
->ascent
= it
->phys_ascent
= 0;
19740 it
->descent
= it
->phys_descent
= 0;
19741 it
->pixel_width
= 0;
19746 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
19748 /* Make sure X resources of the image is loaded. */
19749 prepare_image_for_display (it
->f
, img
);
19751 slice
.x
= slice
.y
= 0;
19752 slice
.width
= img
->width
;
19753 slice
.height
= img
->height
;
19755 if (INTEGERP (it
->slice
.x
))
19756 slice
.x
= XINT (it
->slice
.x
);
19757 else if (FLOATP (it
->slice
.x
))
19758 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
19760 if (INTEGERP (it
->slice
.y
))
19761 slice
.y
= XINT (it
->slice
.y
);
19762 else if (FLOATP (it
->slice
.y
))
19763 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
19765 if (INTEGERP (it
->slice
.width
))
19766 slice
.width
= XINT (it
->slice
.width
);
19767 else if (FLOATP (it
->slice
.width
))
19768 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
19770 if (INTEGERP (it
->slice
.height
))
19771 slice
.height
= XINT (it
->slice
.height
);
19772 else if (FLOATP (it
->slice
.height
))
19773 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
19775 if (slice
.x
>= img
->width
)
19776 slice
.x
= img
->width
;
19777 if (slice
.y
>= img
->height
)
19778 slice
.y
= img
->height
;
19779 if (slice
.x
+ slice
.width
>= img
->width
)
19780 slice
.width
= img
->width
- slice
.x
;
19781 if (slice
.y
+ slice
.height
> img
->height
)
19782 slice
.height
= img
->height
- slice
.y
;
19784 if (slice
.width
== 0 || slice
.height
== 0)
19787 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
19789 it
->descent
= slice
.height
- glyph_ascent
;
19791 it
->descent
+= img
->vmargin
;
19792 if (slice
.y
+ slice
.height
== img
->height
)
19793 it
->descent
+= img
->vmargin
;
19794 it
->phys_descent
= it
->descent
;
19796 it
->pixel_width
= slice
.width
;
19798 it
->pixel_width
+= img
->hmargin
;
19799 if (slice
.x
+ slice
.width
== img
->width
)
19800 it
->pixel_width
+= img
->hmargin
;
19802 /* It's quite possible for images to have an ascent greater than
19803 their height, so don't get confused in that case. */
19804 if (it
->descent
< 0)
19807 #if 0 /* this breaks image tiling */
19808 /* If this glyph is alone on the last line, adjust it.ascent to minimum row ascent. */
19809 int face_ascent
= face
->font
? FONT_BASE (face
->font
) : FRAME_BASELINE_OFFSET (it
->f
);
19810 if (face_ascent
> it
->ascent
)
19811 it
->ascent
= it
->phys_ascent
= face_ascent
;
19816 if (face
->box
!= FACE_NO_BOX
)
19818 if (face
->box_line_width
> 0)
19821 it
->ascent
+= face
->box_line_width
;
19822 if (slice
.y
+ slice
.height
== img
->height
)
19823 it
->descent
+= face
->box_line_width
;
19826 if (it
->start_of_box_run_p
&& slice
.x
== 0)
19827 it
->pixel_width
+= abs (face
->box_line_width
);
19828 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
19829 it
->pixel_width
+= abs (face
->box_line_width
);
19832 take_vertical_position_into_account (it
);
19836 struct glyph
*glyph
;
19837 enum glyph_row_area area
= it
->area
;
19839 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
19840 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
19842 glyph
->charpos
= CHARPOS (it
->position
);
19843 glyph
->object
= it
->object
;
19844 glyph
->pixel_width
= it
->pixel_width
;
19845 glyph
->ascent
= glyph_ascent
;
19846 glyph
->descent
= it
->descent
;
19847 glyph
->voffset
= it
->voffset
;
19848 glyph
->type
= IMAGE_GLYPH
;
19849 glyph
->multibyte_p
= it
->multibyte_p
;
19850 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
19851 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
19852 glyph
->overlaps_vertically_p
= 0;
19853 glyph
->padding_p
= 0;
19854 glyph
->glyph_not_available_p
= 0;
19855 glyph
->face_id
= it
->face_id
;
19856 glyph
->u
.img_id
= img
->id
;
19857 glyph
->slice
= slice
;
19858 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
19859 ++it
->glyph_row
->used
[area
];
19862 IT_EXPAND_MATRIX_WIDTH (it
, area
);
19867 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
19868 of the glyph, WIDTH and HEIGHT are the width and height of the
19869 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
19872 append_stretch_glyph (it
, object
, width
, height
, ascent
)
19874 Lisp_Object object
;
19878 struct glyph
*glyph
;
19879 enum glyph_row_area area
= it
->area
;
19881 xassert (ascent
>= 0 && ascent
<= height
);
19883 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
19884 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
19886 glyph
->charpos
= CHARPOS (it
->position
);
19887 glyph
->object
= object
;
19888 glyph
->pixel_width
= width
;
19889 glyph
->ascent
= ascent
;
19890 glyph
->descent
= height
- ascent
;
19891 glyph
->voffset
= it
->voffset
;
19892 glyph
->type
= STRETCH_GLYPH
;
19893 glyph
->multibyte_p
= it
->multibyte_p
;
19894 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
19895 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
19896 glyph
->overlaps_vertically_p
= 0;
19897 glyph
->padding_p
= 0;
19898 glyph
->glyph_not_available_p
= 0;
19899 glyph
->face_id
= it
->face_id
;
19900 glyph
->u
.stretch
.ascent
= ascent
;
19901 glyph
->u
.stretch
.height
= height
;
19902 glyph
->slice
= null_glyph_slice
;
19903 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
19904 ++it
->glyph_row
->used
[area
];
19907 IT_EXPAND_MATRIX_WIDTH (it
, area
);
19911 /* Produce a stretch glyph for iterator IT. IT->object is the value
19912 of the glyph property displayed. The value must be a list
19913 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
19916 1. `:width WIDTH' specifies that the space should be WIDTH *
19917 canonical char width wide. WIDTH may be an integer or floating
19920 2. `:relative-width FACTOR' specifies that the width of the stretch
19921 should be computed from the width of the first character having the
19922 `glyph' property, and should be FACTOR times that width.
19924 3. `:align-to HPOS' specifies that the space should be wide enough
19925 to reach HPOS, a value in canonical character units.
19927 Exactly one of the above pairs must be present.
19929 4. `:height HEIGHT' specifies that the height of the stretch produced
19930 should be HEIGHT, measured in canonical character units.
19932 5. `:relative-height FACTOR' specifies that the height of the
19933 stretch should be FACTOR times the height of the characters having
19934 the glyph property.
19936 Either none or exactly one of 4 or 5 must be present.
19938 6. `:ascent ASCENT' specifies that ASCENT percent of the height
19939 of the stretch should be used for the ascent of the stretch.
19940 ASCENT must be in the range 0 <= ASCENT <= 100. */
19943 produce_stretch_glyph (it
)
19946 /* (space :width WIDTH :height HEIGHT ...) */
19947 Lisp_Object prop
, plist
;
19948 int width
= 0, height
= 0, align_to
= -1;
19949 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
19952 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19953 XFontStruct
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
19955 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
19957 /* List should start with `space'. */
19958 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
19959 plist
= XCDR (it
->object
);
19961 /* Compute the width of the stretch. */
19962 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
19963 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
19965 /* Absolute width `:width WIDTH' specified and valid. */
19966 zero_width_ok_p
= 1;
19969 else if (prop
= Fplist_get (plist
, QCrelative_width
),
19972 /* Relative width `:relative-width FACTOR' specified and valid.
19973 Compute the width of the characters having the `glyph'
19976 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
19979 if (it
->multibyte_p
)
19981 int maxlen
= ((IT_BYTEPOS (*it
) >= GPT
? ZV
: GPT
)
19982 - IT_BYTEPOS (*it
));
19983 it2
.c
= STRING_CHAR_AND_LENGTH (p
, maxlen
, it2
.len
);
19986 it2
.c
= *p
, it2
.len
= 1;
19988 it2
.glyph_row
= NULL
;
19989 it2
.what
= IT_CHARACTER
;
19990 x_produce_glyphs (&it2
);
19991 width
= NUMVAL (prop
) * it2
.pixel_width
;
19993 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
19994 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
19996 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
19997 align_to
= (align_to
< 0
19999 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
20000 else if (align_to
< 0)
20001 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
20002 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
20003 zero_width_ok_p
= 1;
20006 /* Nothing specified -> width defaults to canonical char width. */
20007 width
= FRAME_COLUMN_WIDTH (it
->f
);
20009 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
20012 /* Compute height. */
20013 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
20014 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
20017 zero_height_ok_p
= 1;
20019 else if (prop
= Fplist_get (plist
, QCrelative_height
),
20021 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
20023 height
= FONT_HEIGHT (font
);
20025 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
20028 /* Compute percentage of height used for ascent. If
20029 `:ascent ASCENT' is present and valid, use that. Otherwise,
20030 derive the ascent from the font in use. */
20031 if (prop
= Fplist_get (plist
, QCascent
),
20032 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
20033 ascent
= height
* NUMVAL (prop
) / 100.0;
20034 else if (!NILP (prop
)
20035 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
20036 ascent
= min (max (0, (int)tem
), height
);
20038 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
20040 if (width
> 0 && !it
->truncate_lines_p
20041 && it
->current_x
+ width
> it
->last_visible_x
)
20042 width
= it
->last_visible_x
- it
->current_x
- 1;
20044 if (width
> 0 && height
> 0 && it
->glyph_row
)
20046 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
20047 if (!STRINGP (object
))
20048 object
= it
->w
->buffer
;
20049 append_stretch_glyph (it
, object
, width
, height
, ascent
);
20052 it
->pixel_width
= width
;
20053 it
->ascent
= it
->phys_ascent
= ascent
;
20054 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
20055 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
20057 take_vertical_position_into_account (it
);
20060 /* Get line-height and line-spacing property at point.
20061 If line-height has format (HEIGHT TOTAL), return TOTAL
20062 in TOTAL_HEIGHT. */
20065 get_line_height_property (it
, prop
)
20069 Lisp_Object position
;
20071 if (STRINGP (it
->object
))
20072 position
= make_number (IT_STRING_CHARPOS (*it
));
20073 else if (BUFFERP (it
->object
))
20074 position
= make_number (IT_CHARPOS (*it
));
20078 return Fget_char_property (position
, prop
, it
->object
);
20081 /* Calculate line-height and line-spacing properties.
20082 An integer value specifies explicit pixel value.
20083 A float value specifies relative value to current face height.
20084 A cons (float . face-name) specifies relative value to
20085 height of specified face font.
20087 Returns height in pixels, or nil. */
20091 calc_line_height_property (it
, val
, font
, boff
, override
)
20095 int boff
, override
;
20097 Lisp_Object face_name
= Qnil
;
20098 int ascent
, descent
, height
;
20100 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
20105 face_name
= XCAR (val
);
20107 if (!NUMBERP (val
))
20108 val
= make_number (1);
20109 if (NILP (face_name
))
20111 height
= it
->ascent
+ it
->descent
;
20116 if (NILP (face_name
))
20118 font
= FRAME_FONT (it
->f
);
20119 boff
= FRAME_BASELINE_OFFSET (it
->f
);
20121 else if (EQ (face_name
, Qt
))
20129 struct font_info
*font_info
;
20131 face_id
= lookup_named_face (it
->f
, face_name
, ' ', 0);
20133 return make_number (-1);
20135 face
= FACE_FROM_ID (it
->f
, face_id
);
20138 return make_number (-1);
20140 font_info
= FONT_INFO_FROM_ID (it
->f
, face
->font_info_id
);
20141 boff
= font_info
->baseline_offset
;
20142 if (font_info
->vertical_centering
)
20143 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
20146 ascent
= FONT_BASE (font
) + boff
;
20147 descent
= FONT_DESCENT (font
) - boff
;
20151 it
->override_ascent
= ascent
;
20152 it
->override_descent
= descent
;
20153 it
->override_boff
= boff
;
20156 height
= ascent
+ descent
;
20160 height
= (int)(XFLOAT_DATA (val
) * height
);
20161 else if (INTEGERP (val
))
20162 height
*= XINT (val
);
20164 return make_number (height
);
20169 Produce glyphs/get display metrics for the display element IT is
20170 loaded with. See the description of struct it in dispextern.h
20171 for an overview of struct it. */
20174 x_produce_glyphs (it
)
20177 int extra_line_spacing
= it
->extra_line_spacing
;
20179 it
->glyph_not_available_p
= 0;
20181 if (it
->what
== IT_CHARACTER
)
20185 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20187 int font_not_found_p
;
20188 struct font_info
*font_info
;
20189 int boff
; /* baseline offset */
20190 /* We may change it->multibyte_p upon unibyte<->multibyte
20191 conversion. So, save the current value now and restore it
20194 Note: It seems that we don't have to record multibyte_p in
20195 struct glyph because the character code itself tells if or
20196 not the character is multibyte. Thus, in the future, we must
20197 consider eliminating the field `multibyte_p' in the struct
20199 int saved_multibyte_p
= it
->multibyte_p
;
20201 /* Maybe translate single-byte characters to multibyte, or the
20203 it
->char_to_display
= it
->c
;
20204 if (!ASCII_BYTE_P (it
->c
))
20206 if (unibyte_display_via_language_environment
20207 && SINGLE_BYTE_CHAR_P (it
->c
)
20209 || !NILP (Vnonascii_translation_table
)))
20211 it
->char_to_display
= unibyte_char_to_multibyte (it
->c
);
20212 it
->multibyte_p
= 1;
20213 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
);
20214 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20216 else if (!SINGLE_BYTE_CHAR_P (it
->c
)
20217 && !it
->multibyte_p
)
20219 it
->multibyte_p
= 1;
20220 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
);
20221 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20225 /* Get font to use. Encode IT->char_to_display. */
20226 get_char_face_and_encoding (it
->f
, it
->char_to_display
, it
->face_id
,
20227 &char2b
, it
->multibyte_p
, 0);
20230 /* When no suitable font found, use the default font. */
20231 font_not_found_p
= font
== NULL
;
20232 if (font_not_found_p
)
20234 font
= FRAME_FONT (it
->f
);
20235 boff
= FRAME_BASELINE_OFFSET (it
->f
);
20240 font_info
= FONT_INFO_FROM_ID (it
->f
, face
->font_info_id
);
20241 boff
= font_info
->baseline_offset
;
20242 if (font_info
->vertical_centering
)
20243 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
20246 if (it
->char_to_display
>= ' '
20247 && (!it
->multibyte_p
|| it
->char_to_display
< 128))
20249 /* Either unibyte or ASCII. */
20254 pcm
= rif
->per_char_metric (font
, &char2b
,
20255 FONT_TYPE_FOR_UNIBYTE (font
, it
->char_to_display
));
20257 if (it
->override_ascent
>= 0)
20259 it
->ascent
= it
->override_ascent
;
20260 it
->descent
= it
->override_descent
;
20261 boff
= it
->override_boff
;
20265 it
->ascent
= FONT_BASE (font
) + boff
;
20266 it
->descent
= FONT_DESCENT (font
) - boff
;
20271 it
->phys_ascent
= pcm
->ascent
+ boff
;
20272 it
->phys_descent
= pcm
->descent
- boff
;
20273 it
->pixel_width
= pcm
->width
;
20277 it
->glyph_not_available_p
= 1;
20278 it
->phys_ascent
= it
->ascent
;
20279 it
->phys_descent
= it
->descent
;
20280 it
->pixel_width
= FONT_WIDTH (font
);
20283 if (it
->constrain_row_ascent_descent_p
)
20285 if (it
->descent
> it
->max_descent
)
20287 it
->ascent
+= it
->descent
- it
->max_descent
;
20288 it
->descent
= it
->max_descent
;
20290 if (it
->ascent
> it
->max_ascent
)
20292 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
20293 it
->ascent
= it
->max_ascent
;
20295 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
20296 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
20297 extra_line_spacing
= 0;
20300 /* If this is a space inside a region of text with
20301 `space-width' property, change its width. */
20302 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
20304 it
->pixel_width
*= XFLOATINT (it
->space_width
);
20306 /* If face has a box, add the box thickness to the character
20307 height. If character has a box line to the left and/or
20308 right, add the box line width to the character's width. */
20309 if (face
->box
!= FACE_NO_BOX
)
20311 int thick
= face
->box_line_width
;
20315 it
->ascent
+= thick
;
20316 it
->descent
+= thick
;
20321 if (it
->start_of_box_run_p
)
20322 it
->pixel_width
+= thick
;
20323 if (it
->end_of_box_run_p
)
20324 it
->pixel_width
+= thick
;
20327 /* If face has an overline, add the height of the overline
20328 (1 pixel) and a 1 pixel margin to the character height. */
20329 if (face
->overline_p
)
20332 if (it
->constrain_row_ascent_descent_p
)
20334 if (it
->ascent
> it
->max_ascent
)
20335 it
->ascent
= it
->max_ascent
;
20336 if (it
->descent
> it
->max_descent
)
20337 it
->descent
= it
->max_descent
;
20340 take_vertical_position_into_account (it
);
20342 /* If we have to actually produce glyphs, do it. */
20347 /* Translate a space with a `space-width' property
20348 into a stretch glyph. */
20349 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
20350 / FONT_HEIGHT (font
));
20351 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
20352 it
->ascent
+ it
->descent
, ascent
);
20357 /* If characters with lbearing or rbearing are displayed
20358 in this line, record that fact in a flag of the
20359 glyph row. This is used to optimize X output code. */
20360 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
20361 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
20364 else if (it
->char_to_display
== '\n')
20366 /* A newline has no width but we need the height of the line.
20367 But if previous part of the line set a height, don't
20368 increase that height */
20370 Lisp_Object height
;
20371 Lisp_Object total_height
= Qnil
;
20373 it
->override_ascent
= -1;
20374 it
->pixel_width
= 0;
20377 height
= get_line_height_property(it
, Qline_height
);
20378 /* Split (line-height total-height) list */
20380 && CONSP (XCDR (height
))
20381 && NILP (XCDR (XCDR (height
))))
20383 total_height
= XCAR (XCDR (height
));
20384 height
= XCAR (height
);
20386 height
= calc_line_height_property(it
, height
, font
, boff
, 1);
20388 if (it
->override_ascent
>= 0)
20390 it
->ascent
= it
->override_ascent
;
20391 it
->descent
= it
->override_descent
;
20392 boff
= it
->override_boff
;
20396 it
->ascent
= FONT_BASE (font
) + boff
;
20397 it
->descent
= FONT_DESCENT (font
) - boff
;
20400 if (EQ (height
, Qt
))
20402 if (it
->descent
> it
->max_descent
)
20404 it
->ascent
+= it
->descent
- it
->max_descent
;
20405 it
->descent
= it
->max_descent
;
20407 if (it
->ascent
> it
->max_ascent
)
20409 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
20410 it
->ascent
= it
->max_ascent
;
20412 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
20413 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
20414 it
->constrain_row_ascent_descent_p
= 1;
20415 extra_line_spacing
= 0;
20419 Lisp_Object spacing
;
20421 it
->phys_ascent
= it
->ascent
;
20422 it
->phys_descent
= it
->descent
;
20424 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
20425 && face
->box
!= FACE_NO_BOX
20426 && face
->box_line_width
> 0)
20428 it
->ascent
+= face
->box_line_width
;
20429 it
->descent
+= face
->box_line_width
;
20432 && XINT (height
) > it
->ascent
+ it
->descent
)
20433 it
->ascent
= XINT (height
) - it
->descent
;
20435 if (!NILP (total_height
))
20436 spacing
= calc_line_height_property(it
, total_height
, font
, boff
, 0);
20439 spacing
= get_line_height_property(it
, Qline_spacing
);
20440 spacing
= calc_line_height_property(it
, spacing
, font
, boff
, 0);
20442 if (INTEGERP (spacing
))
20444 extra_line_spacing
= XINT (spacing
);
20445 if (!NILP (total_height
))
20446 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
20450 else if (it
->char_to_display
== '\t')
20452 int tab_width
= it
->tab_width
* FRAME_SPACE_WIDTH (it
->f
);
20453 int x
= it
->current_x
+ it
->continuation_lines_width
;
20454 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
20456 /* If the distance from the current position to the next tab
20457 stop is less than a space character width, use the
20458 tab stop after that. */
20459 if (next_tab_x
- x
< FRAME_SPACE_WIDTH (it
->f
))
20460 next_tab_x
+= tab_width
;
20462 it
->pixel_width
= next_tab_x
- x
;
20464 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
20465 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
20469 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
20470 it
->ascent
+ it
->descent
, it
->ascent
);
20475 /* A multi-byte character. Assume that the display width of the
20476 character is the width of the character multiplied by the
20477 width of the font. */
20479 /* If we found a font, this font should give us the right
20480 metrics. If we didn't find a font, use the frame's
20481 default font and calculate the width of the character
20482 from the charset width; this is what old redisplay code
20485 pcm
= rif
->per_char_metric (font
, &char2b
,
20486 FONT_TYPE_FOR_MULTIBYTE (font
, it
->c
));
20488 if (font_not_found_p
|| !pcm
)
20490 int charset
= CHAR_CHARSET (it
->char_to_display
);
20492 it
->glyph_not_available_p
= 1;
20493 it
->pixel_width
= (FRAME_COLUMN_WIDTH (it
->f
)
20494 * CHARSET_WIDTH (charset
));
20495 it
->phys_ascent
= FONT_BASE (font
) + boff
;
20496 it
->phys_descent
= FONT_DESCENT (font
) - boff
;
20500 it
->pixel_width
= pcm
->width
;
20501 it
->phys_ascent
= pcm
->ascent
+ boff
;
20502 it
->phys_descent
= pcm
->descent
- boff
;
20504 && (pcm
->lbearing
< 0
20505 || pcm
->rbearing
> pcm
->width
))
20506 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
20509 it
->ascent
= FONT_BASE (font
) + boff
;
20510 it
->descent
= FONT_DESCENT (font
) - boff
;
20511 if (face
->box
!= FACE_NO_BOX
)
20513 int thick
= face
->box_line_width
;
20517 it
->ascent
+= thick
;
20518 it
->descent
+= thick
;
20523 if (it
->start_of_box_run_p
)
20524 it
->pixel_width
+= thick
;
20525 if (it
->end_of_box_run_p
)
20526 it
->pixel_width
+= thick
;
20529 /* If face has an overline, add the height of the overline
20530 (1 pixel) and a 1 pixel margin to the character height. */
20531 if (face
->overline_p
)
20534 take_vertical_position_into_account (it
);
20539 it
->multibyte_p
= saved_multibyte_p
;
20541 else if (it
->what
== IT_COMPOSITION
)
20543 /* Note: A composition is represented as one glyph in the
20544 glyph matrix. There are no padding glyphs. */
20547 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20549 int font_not_found_p
;
20550 struct font_info
*font_info
;
20551 int boff
; /* baseline offset */
20552 struct composition
*cmp
= composition_table
[it
->cmp_id
];
20554 /* Maybe translate single-byte characters to multibyte. */
20555 it
->char_to_display
= it
->c
;
20556 if (unibyte_display_via_language_environment
20557 && SINGLE_BYTE_CHAR_P (it
->c
)
20560 && !NILP (Vnonascii_translation_table
))))
20562 it
->char_to_display
= unibyte_char_to_multibyte (it
->c
);
20565 /* Get face and font to use. Encode IT->char_to_display. */
20566 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
);
20567 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20568 get_char_face_and_encoding (it
->f
, it
->char_to_display
, it
->face_id
,
20569 &char2b
, it
->multibyte_p
, 0);
20572 /* When no suitable font found, use the default font. */
20573 font_not_found_p
= font
== NULL
;
20574 if (font_not_found_p
)
20576 font
= FRAME_FONT (it
->f
);
20577 boff
= FRAME_BASELINE_OFFSET (it
->f
);
20582 font_info
= FONT_INFO_FROM_ID (it
->f
, face
->font_info_id
);
20583 boff
= font_info
->baseline_offset
;
20584 if (font_info
->vertical_centering
)
20585 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
20588 /* There are no padding glyphs, so there is only one glyph to
20589 produce for the composition. Important is that pixel_width,
20590 ascent and descent are the values of what is drawn by
20591 draw_glyphs (i.e. the values of the overall glyphs composed). */
20594 /* If we have not yet calculated pixel size data of glyphs of
20595 the composition for the current face font, calculate them
20596 now. Theoretically, we have to check all fonts for the
20597 glyphs, but that requires much time and memory space. So,
20598 here we check only the font of the first glyph. This leads
20599 to incorrect display very rarely, and C-l (recenter) can
20600 correct the display anyway. */
20601 if (cmp
->font
!= (void *) font
)
20603 /* Ascent and descent of the font of the first character of
20604 this composition (adjusted by baseline offset). Ascent
20605 and descent of overall glyphs should not be less than
20606 them respectively. */
20607 int font_ascent
= FONT_BASE (font
) + boff
;
20608 int font_descent
= FONT_DESCENT (font
) - boff
;
20609 /* Bounding box of the overall glyphs. */
20610 int leftmost
, rightmost
, lowest
, highest
;
20611 int i
, width
, ascent
, descent
;
20613 cmp
->font
= (void *) font
;
20615 /* Initialize the bounding box. */
20617 && (pcm
= rif
->per_char_metric (font
, &char2b
,
20618 FONT_TYPE_FOR_MULTIBYTE (font
, it
->c
))))
20620 width
= pcm
->width
;
20621 ascent
= pcm
->ascent
;
20622 descent
= pcm
->descent
;
20626 width
= FONT_WIDTH (font
);
20627 ascent
= FONT_BASE (font
);
20628 descent
= FONT_DESCENT (font
);
20632 lowest
= - descent
+ boff
;
20633 highest
= ascent
+ boff
;
20637 && font_info
->default_ascent
20638 && CHAR_TABLE_P (Vuse_default_ascent
)
20639 && !NILP (Faref (Vuse_default_ascent
,
20640 make_number (it
->char_to_display
))))
20641 highest
= font_info
->default_ascent
+ boff
;
20643 /* Draw the first glyph at the normal position. It may be
20644 shifted to right later if some other glyphs are drawn at
20646 cmp
->offsets
[0] = 0;
20647 cmp
->offsets
[1] = boff
;
20649 /* Set cmp->offsets for the remaining glyphs. */
20650 for (i
= 1; i
< cmp
->glyph_len
; i
++)
20652 int left
, right
, btm
, top
;
20653 int ch
= COMPOSITION_GLYPH (cmp
, i
);
20654 int face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
);
20656 face
= FACE_FROM_ID (it
->f
, face_id
);
20657 get_char_face_and_encoding (it
->f
, ch
, face
->id
,
20658 &char2b
, it
->multibyte_p
, 0);
20662 font
= FRAME_FONT (it
->f
);
20663 boff
= FRAME_BASELINE_OFFSET (it
->f
);
20669 = FONT_INFO_FROM_ID (it
->f
, face
->font_info_id
);
20670 boff
= font_info
->baseline_offset
;
20671 if (font_info
->vertical_centering
)
20672 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
20676 && (pcm
= rif
->per_char_metric (font
, &char2b
,
20677 FONT_TYPE_FOR_MULTIBYTE (font
, ch
))))
20679 width
= pcm
->width
;
20680 ascent
= pcm
->ascent
;
20681 descent
= pcm
->descent
;
20685 width
= FONT_WIDTH (font
);
20690 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
20692 /* Relative composition with or without
20693 alternate chars. */
20694 left
= (leftmost
+ rightmost
- width
) / 2;
20695 btm
= - descent
+ boff
;
20696 if (font_info
&& font_info
->relative_compose
20697 && (! CHAR_TABLE_P (Vignore_relative_composition
)
20698 || NILP (Faref (Vignore_relative_composition
,
20699 make_number (ch
)))))
20702 if (- descent
>= font_info
->relative_compose
)
20703 /* One extra pixel between two glyphs. */
20705 else if (ascent
<= 0)
20706 /* One extra pixel between two glyphs. */
20707 btm
= lowest
- 1 - ascent
- descent
;
20712 /* A composition rule is specified by an integer
20713 value that encodes global and new reference
20714 points (GREF and NREF). GREF and NREF are
20715 specified by numbers as below:
20717 0---1---2 -- ascent
20721 9--10--11 -- center
20723 ---3---4---5--- baseline
20725 6---7---8 -- descent
20727 int rule
= COMPOSITION_RULE (cmp
, i
);
20728 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
;
20730 COMPOSITION_DECODE_RULE (rule
, gref
, nref
);
20731 grefx
= gref
% 3, nrefx
= nref
% 3;
20732 grefy
= gref
/ 3, nrefy
= nref
/ 3;
20735 + grefx
* (rightmost
- leftmost
) / 2
20736 - nrefx
* width
/ 2);
20737 btm
= ((grefy
== 0 ? highest
20739 : grefy
== 2 ? lowest
20740 : (highest
+ lowest
) / 2)
20741 - (nrefy
== 0 ? ascent
+ descent
20742 : nrefy
== 1 ? descent
- boff
20744 : (ascent
+ descent
) / 2));
20747 cmp
->offsets
[i
* 2] = left
;
20748 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
20750 /* Update the bounding box of the overall glyphs. */
20751 right
= left
+ width
;
20752 top
= btm
+ descent
+ ascent
;
20753 if (left
< leftmost
)
20755 if (right
> rightmost
)
20763 /* If there are glyphs whose x-offsets are negative,
20764 shift all glyphs to the right and make all x-offsets
20768 for (i
= 0; i
< cmp
->glyph_len
; i
++)
20769 cmp
->offsets
[i
* 2] -= leftmost
;
20770 rightmost
-= leftmost
;
20773 cmp
->pixel_width
= rightmost
;
20774 cmp
->ascent
= highest
;
20775 cmp
->descent
= - lowest
;
20776 if (cmp
->ascent
< font_ascent
)
20777 cmp
->ascent
= font_ascent
;
20778 if (cmp
->descent
< font_descent
)
20779 cmp
->descent
= font_descent
;
20782 it
->pixel_width
= cmp
->pixel_width
;
20783 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
20784 it
->descent
= it
->phys_descent
= cmp
->descent
;
20786 if (face
->box
!= FACE_NO_BOX
)
20788 int thick
= face
->box_line_width
;
20792 it
->ascent
+= thick
;
20793 it
->descent
+= thick
;
20798 if (it
->start_of_box_run_p
)
20799 it
->pixel_width
+= thick
;
20800 if (it
->end_of_box_run_p
)
20801 it
->pixel_width
+= thick
;
20804 /* If face has an overline, add the height of the overline
20805 (1 pixel) and a 1 pixel margin to the character height. */
20806 if (face
->overline_p
)
20809 take_vertical_position_into_account (it
);
20812 append_composite_glyph (it
);
20814 else if (it
->what
== IT_IMAGE
)
20815 produce_image_glyph (it
);
20816 else if (it
->what
== IT_STRETCH
)
20817 produce_stretch_glyph (it
);
20819 /* Accumulate dimensions. Note: can't assume that it->descent > 0
20820 because this isn't true for images with `:ascent 100'. */
20821 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
20822 if (it
->area
== TEXT_AREA
)
20823 it
->current_x
+= it
->pixel_width
;
20825 if (extra_line_spacing
> 0)
20827 it
->descent
+= extra_line_spacing
;
20828 if (extra_line_spacing
> it
->max_extra_line_spacing
)
20829 it
->max_extra_line_spacing
= extra_line_spacing
;
20832 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
20833 it
->max_descent
= max (it
->max_descent
, it
->descent
);
20834 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
20835 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
20839 Output LEN glyphs starting at START at the nominal cursor position.
20840 Advance the nominal cursor over the text. The global variable
20841 updated_window contains the window being updated, updated_row is
20842 the glyph row being updated, and updated_area is the area of that
20843 row being updated. */
20846 x_write_glyphs (start
, len
)
20847 struct glyph
*start
;
20852 xassert (updated_window
&& updated_row
);
20855 /* Write glyphs. */
20857 hpos
= start
- updated_row
->glyphs
[updated_area
];
20858 x
= draw_glyphs (updated_window
, output_cursor
.x
,
20859 updated_row
, updated_area
,
20861 DRAW_NORMAL_TEXT
, 0);
20863 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
20864 if (updated_area
== TEXT_AREA
20865 && updated_window
->phys_cursor_on_p
20866 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
20867 && updated_window
->phys_cursor
.hpos
>= hpos
20868 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
20869 updated_window
->phys_cursor_on_p
= 0;
20873 /* Advance the output cursor. */
20874 output_cursor
.hpos
+= len
;
20875 output_cursor
.x
= x
;
20880 Insert LEN glyphs from START at the nominal cursor position. */
20883 x_insert_glyphs (start
, len
)
20884 struct glyph
*start
;
20889 int line_height
, shift_by_width
, shifted_region_width
;
20890 struct glyph_row
*row
;
20891 struct glyph
*glyph
;
20892 int frame_x
, frame_y
, hpos
;
20894 xassert (updated_window
&& updated_row
);
20896 w
= updated_window
;
20897 f
= XFRAME (WINDOW_FRAME (w
));
20899 /* Get the height of the line we are in. */
20901 line_height
= row
->height
;
20903 /* Get the width of the glyphs to insert. */
20904 shift_by_width
= 0;
20905 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
20906 shift_by_width
+= glyph
->pixel_width
;
20908 /* Get the width of the region to shift right. */
20909 shifted_region_width
= (window_box_width (w
, updated_area
)
20914 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
20915 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
20917 rif
->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
20918 line_height
, shift_by_width
);
20920 /* Write the glyphs. */
20921 hpos
= start
- row
->glyphs
[updated_area
];
20922 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
20924 DRAW_NORMAL_TEXT
, 0);
20926 /* Advance the output cursor. */
20927 output_cursor
.hpos
+= len
;
20928 output_cursor
.x
+= shift_by_width
;
20934 Erase the current text line from the nominal cursor position
20935 (inclusive) to pixel column TO_X (exclusive). The idea is that
20936 everything from TO_X onward is already erased.
20938 TO_X is a pixel position relative to updated_area of
20939 updated_window. TO_X == -1 means clear to the end of this area. */
20942 x_clear_end_of_line (to_x
)
20946 struct window
*w
= updated_window
;
20947 int max_x
, min_y
, max_y
;
20948 int from_x
, from_y
, to_y
;
20950 xassert (updated_window
&& updated_row
);
20951 f
= XFRAME (w
->frame
);
20953 if (updated_row
->full_width_p
)
20954 max_x
= WINDOW_TOTAL_WIDTH (w
);
20956 max_x
= window_box_width (w
, updated_area
);
20957 max_y
= window_text_bottom_y (w
);
20959 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
20960 of window. For TO_X > 0, truncate to end of drawing area. */
20966 to_x
= min (to_x
, max_x
);
20968 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
20970 /* Notice if the cursor will be cleared by this operation. */
20971 if (!updated_row
->full_width_p
)
20972 notice_overwritten_cursor (w
, updated_area
,
20973 output_cursor
.x
, -1,
20975 MATRIX_ROW_BOTTOM_Y (updated_row
));
20977 from_x
= output_cursor
.x
;
20979 /* Translate to frame coordinates. */
20980 if (updated_row
->full_width_p
)
20982 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
20983 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
20987 int area_left
= window_box_left (w
, updated_area
);
20988 from_x
+= area_left
;
20992 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
20993 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
20994 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
20996 /* Prevent inadvertently clearing to end of the X window. */
20997 if (to_x
> from_x
&& to_y
> from_y
)
21000 rif
->clear_frame_area (f
, from_x
, from_y
,
21001 to_x
- from_x
, to_y
- from_y
);
21006 #endif /* HAVE_WINDOW_SYSTEM */
21010 /***********************************************************************
21012 ***********************************************************************/
21014 /* Value is the internal representation of the specified cursor type
21015 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
21016 of the bar cursor. */
21018 static enum text_cursor_kinds
21019 get_specified_cursor_type (arg
, width
)
21023 enum text_cursor_kinds type
;
21028 if (EQ (arg
, Qbox
))
21029 return FILLED_BOX_CURSOR
;
21031 if (EQ (arg
, Qhollow
))
21032 return HOLLOW_BOX_CURSOR
;
21034 if (EQ (arg
, Qbar
))
21041 && EQ (XCAR (arg
), Qbar
)
21042 && INTEGERP (XCDR (arg
))
21043 && XINT (XCDR (arg
)) >= 0)
21045 *width
= XINT (XCDR (arg
));
21049 if (EQ (arg
, Qhbar
))
21052 return HBAR_CURSOR
;
21056 && EQ (XCAR (arg
), Qhbar
)
21057 && INTEGERP (XCDR (arg
))
21058 && XINT (XCDR (arg
)) >= 0)
21060 *width
= XINT (XCDR (arg
));
21061 return HBAR_CURSOR
;
21064 /* Treat anything unknown as "hollow box cursor".
21065 It was bad to signal an error; people have trouble fixing
21066 .Xdefaults with Emacs, when it has something bad in it. */
21067 type
= HOLLOW_BOX_CURSOR
;
21072 /* Set the default cursor types for specified frame. */
21074 set_frame_cursor_types (f
, arg
)
21081 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
21082 FRAME_CURSOR_WIDTH (f
) = width
;
21084 /* By default, set up the blink-off state depending on the on-state. */
21086 tem
= Fassoc (arg
, Vblink_cursor_alist
);
21089 FRAME_BLINK_OFF_CURSOR (f
)
21090 = get_specified_cursor_type (XCDR (tem
), &width
);
21091 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
21094 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
21098 /* Return the cursor we want to be displayed in window W. Return
21099 width of bar/hbar cursor through WIDTH arg. Return with
21100 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
21101 (i.e. if the `system caret' should track this cursor).
21103 In a mini-buffer window, we want the cursor only to appear if we
21104 are reading input from this window. For the selected window, we
21105 want the cursor type given by the frame parameter or buffer local
21106 setting of cursor-type. If explicitly marked off, draw no cursor.
21107 In all other cases, we want a hollow box cursor. */
21109 static enum text_cursor_kinds
21110 get_window_cursor_type (w
, glyph
, width
, active_cursor
)
21112 struct glyph
*glyph
;
21114 int *active_cursor
;
21116 struct frame
*f
= XFRAME (w
->frame
);
21117 struct buffer
*b
= XBUFFER (w
->buffer
);
21118 int cursor_type
= DEFAULT_CURSOR
;
21119 Lisp_Object alt_cursor
;
21120 int non_selected
= 0;
21122 *active_cursor
= 1;
21125 if (cursor_in_echo_area
21126 && FRAME_HAS_MINIBUF_P (f
)
21127 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
21129 if (w
== XWINDOW (echo_area_window
))
21131 if (EQ (b
->cursor_type
, Qt
) || NILP (b
->cursor_type
))
21133 *width
= FRAME_CURSOR_WIDTH (f
);
21134 return FRAME_DESIRED_CURSOR (f
);
21137 return get_specified_cursor_type (b
->cursor_type
, width
);
21140 *active_cursor
= 0;
21144 /* Nonselected window or nonselected frame. */
21145 else if (w
!= XWINDOW (f
->selected_window
)
21146 #ifdef HAVE_WINDOW_SYSTEM
21147 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
21151 *active_cursor
= 0;
21153 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
21159 /* Never display a cursor in a window in which cursor-type is nil. */
21160 if (NILP (b
->cursor_type
))
21163 /* Use cursor-in-non-selected-windows for non-selected window or frame. */
21166 alt_cursor
= b
->cursor_in_non_selected_windows
;
21167 return get_specified_cursor_type (alt_cursor
, width
);
21170 /* Get the normal cursor type for this window. */
21171 if (EQ (b
->cursor_type
, Qt
))
21173 cursor_type
= FRAME_DESIRED_CURSOR (f
);
21174 *width
= FRAME_CURSOR_WIDTH (f
);
21177 cursor_type
= get_specified_cursor_type (b
->cursor_type
, width
);
21179 /* Use normal cursor if not blinked off. */
21180 if (!w
->cursor_off_p
)
21182 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
) {
21183 if (cursor_type
== FILLED_BOX_CURSOR
)
21184 cursor_type
= HOLLOW_BOX_CURSOR
;
21186 return cursor_type
;
21189 /* Cursor is blinked off, so determine how to "toggle" it. */
21191 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
21192 if ((alt_cursor
= Fassoc (b
->cursor_type
, Vblink_cursor_alist
), !NILP (alt_cursor
)))
21193 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
21195 /* Then see if frame has specified a specific blink off cursor type. */
21196 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
21198 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
21199 return FRAME_BLINK_OFF_CURSOR (f
);
21203 /* Some people liked having a permanently visible blinking cursor,
21204 while others had very strong opinions against it. So it was
21205 decided to remove it. KFS 2003-09-03 */
21207 /* Finally perform built-in cursor blinking:
21208 filled box <-> hollow box
21209 wide [h]bar <-> narrow [h]bar
21210 narrow [h]bar <-> no cursor
21211 other type <-> no cursor */
21213 if (cursor_type
== FILLED_BOX_CURSOR
)
21214 return HOLLOW_BOX_CURSOR
;
21216 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
21219 return cursor_type
;
21227 #ifdef HAVE_WINDOW_SYSTEM
21229 /* Notice when the text cursor of window W has been completely
21230 overwritten by a drawing operation that outputs glyphs in AREA
21231 starting at X0 and ending at X1 in the line starting at Y0 and
21232 ending at Y1. X coordinates are area-relative. X1 < 0 means all
21233 the rest of the line after X0 has been written. Y coordinates
21234 are window-relative. */
21237 notice_overwritten_cursor (w
, area
, x0
, x1
, y0
, y1
)
21239 enum glyph_row_area area
;
21240 int x0
, y0
, x1
, y1
;
21242 int cx0
, cx1
, cy0
, cy1
;
21243 struct glyph_row
*row
;
21245 if (!w
->phys_cursor_on_p
)
21247 if (area
!= TEXT_AREA
)
21250 if (w
->phys_cursor
.vpos
< 0
21251 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
21252 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
21253 !(row
->enabled_p
&& row
->displays_text_p
)))
21256 if (row
->cursor_in_fringe_p
)
21258 row
->cursor_in_fringe_p
= 0;
21259 draw_fringe_bitmap (w
, row
, 0);
21260 w
->phys_cursor_on_p
= 0;
21264 cx0
= w
->phys_cursor
.x
;
21265 cx1
= cx0
+ w
->phys_cursor_width
;
21266 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
21269 /* The cursor image will be completely removed from the
21270 screen if the output area intersects the cursor area in
21271 y-direction. When we draw in [y0 y1[, and some part of
21272 the cursor is at y < y0, that part must have been drawn
21273 before. When scrolling, the cursor is erased before
21274 actually scrolling, so we don't come here. When not
21275 scrolling, the rows above the old cursor row must have
21276 changed, and in this case these rows must have written
21277 over the cursor image.
21279 Likewise if part of the cursor is below y1, with the
21280 exception of the cursor being in the first blank row at
21281 the buffer and window end because update_text_area
21282 doesn't draw that row. (Except when it does, but
21283 that's handled in update_text_area.) */
21285 cy0
= w
->phys_cursor
.y
;
21286 cy1
= cy0
+ w
->phys_cursor_height
;
21287 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
21290 w
->phys_cursor_on_p
= 0;
21293 #endif /* HAVE_WINDOW_SYSTEM */
21296 /************************************************************************
21298 ************************************************************************/
21300 #ifdef HAVE_WINDOW_SYSTEM
21303 Fix the display of area AREA of overlapping row ROW in window W
21304 with respect to the overlapping part OVERLAPS. */
21307 x_fix_overlapping_area (w
, row
, area
, overlaps
)
21309 struct glyph_row
*row
;
21310 enum glyph_row_area area
;
21318 for (i
= 0; i
< row
->used
[area
];)
21320 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
21322 int start
= i
, start_x
= x
;
21326 x
+= row
->glyphs
[area
][i
].pixel_width
;
21329 while (i
< row
->used
[area
]
21330 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
21332 draw_glyphs (w
, start_x
, row
, area
,
21334 DRAW_NORMAL_TEXT
, overlaps
);
21338 x
+= row
->glyphs
[area
][i
].pixel_width
;
21348 Draw the cursor glyph of window W in glyph row ROW. See the
21349 comment of draw_glyphs for the meaning of HL. */
21352 draw_phys_cursor_glyph (w
, row
, hl
)
21354 struct glyph_row
*row
;
21355 enum draw_glyphs_face hl
;
21357 /* If cursor hpos is out of bounds, don't draw garbage. This can
21358 happen in mini-buffer windows when switching between echo area
21359 glyphs and mini-buffer. */
21360 if (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])
21362 int on_p
= w
->phys_cursor_on_p
;
21364 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
21365 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
21367 w
->phys_cursor_on_p
= on_p
;
21369 if (hl
== DRAW_CURSOR
)
21370 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
21371 /* When we erase the cursor, and ROW is overlapped by other
21372 rows, make sure that these overlapping parts of other rows
21374 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
21376 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
21378 if (row
> w
->current_matrix
->rows
21379 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
21380 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
21381 OVERLAPS_ERASED_CURSOR
);
21383 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
21384 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
21385 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
21386 OVERLAPS_ERASED_CURSOR
);
21393 Erase the image of a cursor of window W from the screen. */
21396 erase_phys_cursor (w
)
21399 struct frame
*f
= XFRAME (w
->frame
);
21400 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
21401 int hpos
= w
->phys_cursor
.hpos
;
21402 int vpos
= w
->phys_cursor
.vpos
;
21403 int mouse_face_here_p
= 0;
21404 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
21405 struct glyph_row
*cursor_row
;
21406 struct glyph
*cursor_glyph
;
21407 enum draw_glyphs_face hl
;
21409 /* No cursor displayed or row invalidated => nothing to do on the
21411 if (w
->phys_cursor_type
== NO_CURSOR
)
21412 goto mark_cursor_off
;
21414 /* VPOS >= active_glyphs->nrows means that window has been resized.
21415 Don't bother to erase the cursor. */
21416 if (vpos
>= active_glyphs
->nrows
)
21417 goto mark_cursor_off
;
21419 /* If row containing cursor is marked invalid, there is nothing we
21421 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
21422 if (!cursor_row
->enabled_p
)
21423 goto mark_cursor_off
;
21425 /* If line spacing is > 0, old cursor may only be partially visible in
21426 window after split-window. So adjust visible height. */
21427 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
21428 window_text_bottom_y (w
) - cursor_row
->y
);
21430 /* If row is completely invisible, don't attempt to delete a cursor which
21431 isn't there. This can happen if cursor is at top of a window, and
21432 we switch to a buffer with a header line in that window. */
21433 if (cursor_row
->visible_height
<= 0)
21434 goto mark_cursor_off
;
21436 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
21437 if (cursor_row
->cursor_in_fringe_p
)
21439 cursor_row
->cursor_in_fringe_p
= 0;
21440 draw_fringe_bitmap (w
, cursor_row
, 0);
21441 goto mark_cursor_off
;
21444 /* This can happen when the new row is shorter than the old one.
21445 In this case, either draw_glyphs or clear_end_of_line
21446 should have cleared the cursor. Note that we wouldn't be
21447 able to erase the cursor in this case because we don't have a
21448 cursor glyph at hand. */
21449 if (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])
21450 goto mark_cursor_off
;
21452 /* If the cursor is in the mouse face area, redisplay that when
21453 we clear the cursor. */
21454 if (! NILP (dpyinfo
->mouse_face_window
)
21455 && w
== XWINDOW (dpyinfo
->mouse_face_window
)
21456 && (vpos
> dpyinfo
->mouse_face_beg_row
21457 || (vpos
== dpyinfo
->mouse_face_beg_row
21458 && hpos
>= dpyinfo
->mouse_face_beg_col
))
21459 && (vpos
< dpyinfo
->mouse_face_end_row
21460 || (vpos
== dpyinfo
->mouse_face_end_row
21461 && hpos
< dpyinfo
->mouse_face_end_col
))
21462 /* Don't redraw the cursor's spot in mouse face if it is at the
21463 end of a line (on a newline). The cursor appears there, but
21464 mouse highlighting does not. */
21465 && cursor_row
->used
[TEXT_AREA
] > hpos
)
21466 mouse_face_here_p
= 1;
21468 /* Maybe clear the display under the cursor. */
21469 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
21472 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
21475 cursor_glyph
= get_phys_cursor_glyph (w
);
21476 if (cursor_glyph
== NULL
)
21477 goto mark_cursor_off
;
21479 width
= cursor_glyph
->pixel_width
;
21480 left_x
= window_box_left_offset (w
, TEXT_AREA
);
21481 x
= w
->phys_cursor
.x
;
21483 width
-= left_x
- x
;
21484 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
21485 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
21486 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
21489 rif
->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
21492 /* Erase the cursor by redrawing the character underneath it. */
21493 if (mouse_face_here_p
)
21494 hl
= DRAW_MOUSE_FACE
;
21496 hl
= DRAW_NORMAL_TEXT
;
21497 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
21500 w
->phys_cursor_on_p
= 0;
21501 w
->phys_cursor_type
= NO_CURSOR
;
21506 Display or clear cursor of window W. If ON is zero, clear the
21507 cursor. If it is non-zero, display the cursor. If ON is nonzero,
21508 where to put the cursor is specified by HPOS, VPOS, X and Y. */
21511 display_and_set_cursor (w
, on
, hpos
, vpos
, x
, y
)
21513 int on
, hpos
, vpos
, x
, y
;
21515 struct frame
*f
= XFRAME (w
->frame
);
21516 int new_cursor_type
;
21517 int new_cursor_width
;
21519 struct glyph_row
*glyph_row
;
21520 struct glyph
*glyph
;
21522 /* This is pointless on invisible frames, and dangerous on garbaged
21523 windows and frames; in the latter case, the frame or window may
21524 be in the midst of changing its size, and x and y may be off the
21526 if (! FRAME_VISIBLE_P (f
)
21527 || FRAME_GARBAGED_P (f
)
21528 || vpos
>= w
->current_matrix
->nrows
21529 || hpos
>= w
->current_matrix
->matrix_w
)
21532 /* If cursor is off and we want it off, return quickly. */
21533 if (!on
&& !w
->phys_cursor_on_p
)
21536 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
21537 /* If cursor row is not enabled, we don't really know where to
21538 display the cursor. */
21539 if (!glyph_row
->enabled_p
)
21541 w
->phys_cursor_on_p
= 0;
21546 if (!glyph_row
->exact_window_width_line_p
21547 || hpos
< glyph_row
->used
[TEXT_AREA
])
21548 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
21550 xassert (interrupt_input_blocked
);
21552 /* Set new_cursor_type to the cursor we want to be displayed. */
21553 new_cursor_type
= get_window_cursor_type (w
, glyph
,
21554 &new_cursor_width
, &active_cursor
);
21556 /* If cursor is currently being shown and we don't want it to be or
21557 it is in the wrong place, or the cursor type is not what we want,
21559 if (w
->phys_cursor_on_p
21561 || w
->phys_cursor
.x
!= x
21562 || w
->phys_cursor
.y
!= y
21563 || new_cursor_type
!= w
->phys_cursor_type
21564 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
21565 && new_cursor_width
!= w
->phys_cursor_width
)))
21566 erase_phys_cursor (w
);
21568 /* Don't check phys_cursor_on_p here because that flag is only set
21569 to zero in some cases where we know that the cursor has been
21570 completely erased, to avoid the extra work of erasing the cursor
21571 twice. In other words, phys_cursor_on_p can be 1 and the cursor
21572 still not be visible, or it has only been partly erased. */
21575 w
->phys_cursor_ascent
= glyph_row
->ascent
;
21576 w
->phys_cursor_height
= glyph_row
->height
;
21578 /* Set phys_cursor_.* before x_draw_.* is called because some
21579 of them may need the information. */
21580 w
->phys_cursor
.x
= x
;
21581 w
->phys_cursor
.y
= glyph_row
->y
;
21582 w
->phys_cursor
.hpos
= hpos
;
21583 w
->phys_cursor
.vpos
= vpos
;
21586 rif
->draw_window_cursor (w
, glyph_row
, x
, y
,
21587 new_cursor_type
, new_cursor_width
,
21588 on
, active_cursor
);
21592 /* Switch the display of W's cursor on or off, according to the value
21596 update_window_cursor (w
, on
)
21600 /* Don't update cursor in windows whose frame is in the process
21601 of being deleted. */
21602 if (w
->current_matrix
)
21605 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
21606 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
21612 /* Call update_window_cursor with parameter ON_P on all leaf windows
21613 in the window tree rooted at W. */
21616 update_cursor_in_window_tree (w
, on_p
)
21622 if (!NILP (w
->hchild
))
21623 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
21624 else if (!NILP (w
->vchild
))
21625 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
21627 update_window_cursor (w
, on_p
);
21629 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
21635 Display the cursor on window W, or clear it, according to ON_P.
21636 Don't change the cursor's position. */
21639 x_update_cursor (f
, on_p
)
21643 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
21648 Clear the cursor of window W to background color, and mark the
21649 cursor as not shown. This is used when the text where the cursor
21650 is is about to be rewritten. */
21656 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
21657 update_window_cursor (w
, 0);
21662 Display the active region described by mouse_face_* according to DRAW. */
21665 show_mouse_face (dpyinfo
, draw
)
21666 Display_Info
*dpyinfo
;
21667 enum draw_glyphs_face draw
;
21669 struct window
*w
= XWINDOW (dpyinfo
->mouse_face_window
);
21670 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21672 if (/* If window is in the process of being destroyed, don't bother
21674 w
->current_matrix
!= NULL
21675 /* Don't update mouse highlight if hidden */
21676 && (draw
!= DRAW_MOUSE_FACE
|| !dpyinfo
->mouse_face_hidden
)
21677 /* Recognize when we are called to operate on rows that don't exist
21678 anymore. This can happen when a window is split. */
21679 && dpyinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
21681 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
21682 struct glyph_row
*row
, *first
, *last
;
21684 first
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
21685 last
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
21687 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
21689 int start_hpos
, end_hpos
, start_x
;
21691 /* For all but the first row, the highlight starts at column 0. */
21694 start_hpos
= dpyinfo
->mouse_face_beg_col
;
21695 start_x
= dpyinfo
->mouse_face_beg_x
;
21704 end_hpos
= dpyinfo
->mouse_face_end_col
;
21707 end_hpos
= row
->used
[TEXT_AREA
];
21708 if (draw
== DRAW_NORMAL_TEXT
)
21709 row
->fill_line_p
= 1; /* Clear to end of line */
21712 if (end_hpos
> start_hpos
)
21714 draw_glyphs (w
, start_x
, row
, TEXT_AREA
,
21715 start_hpos
, end_hpos
,
21719 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
21723 /* When we've written over the cursor, arrange for it to
21724 be displayed again. */
21725 if (phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
21728 display_and_set_cursor (w
, 1,
21729 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
21730 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
21735 /* Change the mouse cursor. */
21736 if (draw
== DRAW_NORMAL_TEXT
)
21737 rif
->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
21738 else if (draw
== DRAW_MOUSE_FACE
)
21739 rif
->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
21741 rif
->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
21745 Clear out the mouse-highlighted active region.
21746 Redraw it un-highlighted first. Value is non-zero if mouse
21747 face was actually drawn unhighlighted. */
21750 clear_mouse_face (dpyinfo
)
21751 Display_Info
*dpyinfo
;
21755 if (!dpyinfo
->mouse_face_hidden
&& !NILP (dpyinfo
->mouse_face_window
))
21757 show_mouse_face (dpyinfo
, DRAW_NORMAL_TEXT
);
21761 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
21762 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
21763 dpyinfo
->mouse_face_window
= Qnil
;
21764 dpyinfo
->mouse_face_overlay
= Qnil
;
21770 Non-zero if physical cursor of window W is within mouse face. */
21773 cursor_in_mouse_face_p (w
)
21776 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
21777 int in_mouse_face
= 0;
21779 if (WINDOWP (dpyinfo
->mouse_face_window
)
21780 && XWINDOW (dpyinfo
->mouse_face_window
) == w
)
21782 int hpos
= w
->phys_cursor
.hpos
;
21783 int vpos
= w
->phys_cursor
.vpos
;
21785 if (vpos
>= dpyinfo
->mouse_face_beg_row
21786 && vpos
<= dpyinfo
->mouse_face_end_row
21787 && (vpos
> dpyinfo
->mouse_face_beg_row
21788 || hpos
>= dpyinfo
->mouse_face_beg_col
)
21789 && (vpos
< dpyinfo
->mouse_face_end_row
21790 || hpos
< dpyinfo
->mouse_face_end_col
21791 || dpyinfo
->mouse_face_past_end
))
21795 return in_mouse_face
;
21801 /* Find the glyph matrix position of buffer position CHARPOS in window
21802 *W. HPOS, *VPOS, *X, and *Y are set to the positions found. W's
21803 current glyphs must be up to date. If CHARPOS is above window
21804 start return (0, 0, 0, 0). If CHARPOS is after end of W, return end
21805 of last line in W. In the row containing CHARPOS, stop before glyphs
21806 having STOP as object. */
21808 #if 1 /* This is a version of fast_find_position that's more correct
21809 in the presence of hscrolling, for example. I didn't install
21810 it right away because the problem fixed is minor, it failed
21811 in 20.x as well, and I think it's too risky to install
21812 so near the release of 21.1. 2001-09-25 gerd. */
21815 fast_find_position (w
, charpos
, hpos
, vpos
, x
, y
, stop
)
21818 int *hpos
, *vpos
, *x
, *y
;
21821 struct glyph_row
*row
, *first
;
21822 struct glyph
*glyph
, *end
;
21825 first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
21826 if (charpos
< MATRIX_ROW_START_CHARPOS (first
))
21831 *vpos
= MATRIX_ROW_VPOS (first
, w
->current_matrix
);
21835 row
= row_containing_pos (w
, charpos
, first
, NULL
, 0);
21838 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
21842 /* If whole rows or last part of a row came from a display overlay,
21843 row_containing_pos will skip over such rows because their end pos
21844 equals the start pos of the overlay or interval.
21846 Move back if we have a STOP object and previous row's
21847 end glyph came from STOP. */
21850 struct glyph_row
*prev
;
21851 while ((prev
= row
- 1, prev
>= first
)
21852 && MATRIX_ROW_END_CHARPOS (prev
) == charpos
21853 && prev
->used
[TEXT_AREA
] > 0)
21855 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
21856 glyph
= beg
+ prev
->used
[TEXT_AREA
];
21857 while (--glyph
>= beg
21858 && INTEGERP (glyph
->object
));
21860 || !EQ (stop
, glyph
->object
))
21868 *vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
21870 glyph
= row
->glyphs
[TEXT_AREA
];
21871 end
= glyph
+ row
->used
[TEXT_AREA
];
21873 /* Skip over glyphs not having an object at the start of the row.
21874 These are special glyphs like truncation marks on terminal
21876 if (row
->displays_text_p
)
21878 && INTEGERP (glyph
->object
)
21879 && !EQ (stop
, glyph
->object
)
21880 && glyph
->charpos
< 0)
21882 *x
+= glyph
->pixel_width
;
21887 && !INTEGERP (glyph
->object
)
21888 && !EQ (stop
, glyph
->object
)
21889 && (!BUFFERP (glyph
->object
)
21890 || glyph
->charpos
< charpos
))
21892 *x
+= glyph
->pixel_width
;
21896 *hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
21903 fast_find_position (w
, pos
, hpos
, vpos
, x
, y
, stop
)
21906 int *hpos
, *vpos
, *x
, *y
;
21911 int maybe_next_line_p
= 0;
21912 int line_start_position
;
21913 int yb
= window_text_bottom_y (w
);
21914 struct glyph_row
*row
, *best_row
;
21915 int row_vpos
, best_row_vpos
;
21918 row
= best_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
21919 row_vpos
= best_row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
21921 while (row
->y
< yb
)
21923 if (row
->used
[TEXT_AREA
])
21924 line_start_position
= row
->glyphs
[TEXT_AREA
]->charpos
;
21926 line_start_position
= 0;
21928 if (line_start_position
> pos
)
21930 /* If the position sought is the end of the buffer,
21931 don't include the blank lines at the bottom of the window. */
21932 else if (line_start_position
== pos
21933 && pos
== BUF_ZV (XBUFFER (w
->buffer
)))
21935 maybe_next_line_p
= 1;
21938 else if (line_start_position
> 0)
21941 best_row_vpos
= row_vpos
;
21944 if (row
->y
+ row
->height
>= yb
)
21951 /* Find the right column within BEST_ROW. */
21953 current_x
= best_row
->x
;
21954 for (i
= 0; i
< best_row
->used
[TEXT_AREA
]; i
++)
21956 struct glyph
*glyph
= best_row
->glyphs
[TEXT_AREA
] + i
;
21957 int charpos
= glyph
->charpos
;
21959 if (BUFFERP (glyph
->object
))
21961 if (charpos
== pos
)
21964 *vpos
= best_row_vpos
;
21969 else if (charpos
> pos
)
21972 else if (EQ (glyph
->object
, stop
))
21977 current_x
+= glyph
->pixel_width
;
21980 /* If we're looking for the end of the buffer,
21981 and we didn't find it in the line we scanned,
21982 use the start of the following line. */
21983 if (maybe_next_line_p
)
21988 current_x
= best_row
->x
;
21991 *vpos
= best_row_vpos
;
21992 *hpos
= lastcol
+ 1;
22001 /* Find the position of the glyph for position POS in OBJECT in
22002 window W's current matrix, and return in *X, *Y the pixel
22003 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
22005 RIGHT_P non-zero means return the position of the right edge of the
22006 glyph, RIGHT_P zero means return the left edge position.
22008 If no glyph for POS exists in the matrix, return the position of
22009 the glyph with the next smaller position that is in the matrix, if
22010 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
22011 exists in the matrix, return the position of the glyph with the
22012 next larger position in OBJECT.
22014 Value is non-zero if a glyph was found. */
22017 fast_find_string_pos (w
, pos
, object
, hpos
, vpos
, x
, y
, right_p
)
22020 Lisp_Object object
;
22021 int *hpos
, *vpos
, *x
, *y
;
22024 int yb
= window_text_bottom_y (w
);
22025 struct glyph_row
*r
;
22026 struct glyph
*best_glyph
= NULL
;
22027 struct glyph_row
*best_row
= NULL
;
22030 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
22031 r
->enabled_p
&& r
->y
< yb
;
22034 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
22035 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
22038 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
22039 if (EQ (g
->object
, object
))
22041 if (g
->charpos
== pos
)
22048 else if (best_glyph
== NULL
22049 || ((abs (g
->charpos
- pos
)
22050 < abs (best_glyph
->charpos
- pos
))
22053 : g
->charpos
> pos
)))
22067 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
22071 *x
+= best_glyph
->pixel_width
;
22076 *vpos
= best_row
- w
->current_matrix
->rows
;
22079 return best_glyph
!= NULL
;
22083 /* See if position X, Y is within a hot-spot of an image. */
22086 on_hot_spot_p (hot_spot
, x
, y
)
22087 Lisp_Object hot_spot
;
22090 if (!CONSP (hot_spot
))
22093 if (EQ (XCAR (hot_spot
), Qrect
))
22095 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
22096 Lisp_Object rect
= XCDR (hot_spot
);
22100 if (!CONSP (XCAR (rect
)))
22102 if (!CONSP (XCDR (rect
)))
22104 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
22106 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
22108 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
22110 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
22114 else if (EQ (XCAR (hot_spot
), Qcircle
))
22116 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
22117 Lisp_Object circ
= XCDR (hot_spot
);
22118 Lisp_Object lr
, lx0
, ly0
;
22120 && CONSP (XCAR (circ
))
22121 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
22122 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
22123 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
22125 double r
= XFLOATINT (lr
);
22126 double dx
= XINT (lx0
) - x
;
22127 double dy
= XINT (ly0
) - y
;
22128 return (dx
* dx
+ dy
* dy
<= r
* r
);
22131 else if (EQ (XCAR (hot_spot
), Qpoly
))
22133 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
22134 if (VECTORP (XCDR (hot_spot
)))
22136 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
22137 Lisp_Object
*poly
= v
->contents
;
22141 Lisp_Object lx
, ly
;
22144 /* Need an even number of coordinates, and at least 3 edges. */
22145 if (n
< 6 || n
& 1)
22148 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
22149 If count is odd, we are inside polygon. Pixels on edges
22150 may or may not be included depending on actual geometry of the
22152 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
22153 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
22155 x0
= XINT (lx
), y0
= XINT (ly
);
22156 for (i
= 0; i
< n
; i
+= 2)
22158 int x1
= x0
, y1
= y0
;
22159 if ((lx
= poly
[i
], !INTEGERP (lx
))
22160 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
22162 x0
= XINT (lx
), y0
= XINT (ly
);
22164 /* Does this segment cross the X line? */
22172 if (y
> y0
&& y
> y1
)
22174 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
22180 /* If we don't understand the format, pretend we're not in the hot-spot. */
22185 find_hot_spot (map
, x
, y
)
22189 while (CONSP (map
))
22191 if (CONSP (XCAR (map
))
22192 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
22200 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
22202 doc
: /* Lookup in image map MAP coordinates X and Y.
22203 An image map is an alist where each element has the format (AREA ID PLIST).
22204 An AREA is specified as either a rectangle, a circle, or a polygon:
22205 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
22206 pixel coordinates of the upper left and bottom right corners.
22207 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
22208 and the radius of the circle; r may be a float or integer.
22209 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
22210 vector describes one corner in the polygon.
22211 Returns the alist element for the first matching AREA in MAP. */)
22222 return find_hot_spot (map
, XINT (x
), XINT (y
));
22226 /* Display frame CURSOR, optionally using shape defined by POINTER. */
22228 define_frame_cursor1 (f
, cursor
, pointer
)
22231 Lisp_Object pointer
;
22233 /* Do not change cursor shape while dragging mouse. */
22234 if (!NILP (do_mouse_tracking
))
22237 if (!NILP (pointer
))
22239 if (EQ (pointer
, Qarrow
))
22240 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
22241 else if (EQ (pointer
, Qhand
))
22242 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
22243 else if (EQ (pointer
, Qtext
))
22244 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
22245 else if (EQ (pointer
, intern ("hdrag")))
22246 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
22247 #ifdef HAVE_X_WINDOWS
22248 else if (EQ (pointer
, intern ("vdrag")))
22249 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
22251 else if (EQ (pointer
, intern ("hourglass")))
22252 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
22253 else if (EQ (pointer
, Qmodeline
))
22254 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
22256 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
22259 if (cursor
!= No_Cursor
)
22260 rif
->define_frame_cursor (f
, cursor
);
22263 /* Take proper action when mouse has moved to the mode or header line
22264 or marginal area AREA of window W, x-position X and y-position Y.
22265 X is relative to the start of the text display area of W, so the
22266 width of bitmap areas and scroll bars must be subtracted to get a
22267 position relative to the start of the mode line. */
22270 note_mode_line_or_margin_highlight (window
, x
, y
, area
)
22271 Lisp_Object window
;
22273 enum window_part area
;
22275 struct window
*w
= XWINDOW (window
);
22276 struct frame
*f
= XFRAME (w
->frame
);
22277 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
22278 Cursor cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
22279 Lisp_Object pointer
= Qnil
;
22280 int charpos
, dx
, dy
, width
, height
;
22281 Lisp_Object string
, object
= Qnil
;
22282 Lisp_Object pos
, help
;
22284 Lisp_Object mouse_face
;
22285 int original_x_pixel
= x
;
22286 struct glyph
* glyph
= NULL
;
22287 struct glyph_row
*row
;
22289 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
22294 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
22295 &object
, &dx
, &dy
, &width
, &height
);
22297 row
= (area
== ON_MODE_LINE
22298 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
22299 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
22302 if (row
->mode_line_p
&& row
->enabled_p
)
22304 glyph
= row
->glyphs
[TEXT_AREA
];
22305 end
= glyph
+ row
->used
[TEXT_AREA
];
22307 for (x0
= original_x_pixel
;
22308 glyph
< end
&& x0
>= glyph
->pixel_width
;
22310 x0
-= glyph
->pixel_width
;
22318 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
22319 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
22320 &object
, &dx
, &dy
, &width
, &height
);
22325 if (IMAGEP (object
))
22327 Lisp_Object image_map
, hotspot
;
22328 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
22330 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
22332 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
22334 Lisp_Object area_id
, plist
;
22336 area_id
= XCAR (hotspot
);
22337 /* Could check AREA_ID to see if we enter/leave this hot-spot.
22338 If so, we could look for mouse-enter, mouse-leave
22339 properties in PLIST (and do something...). */
22340 hotspot
= XCDR (hotspot
);
22341 if (CONSP (hotspot
)
22342 && (plist
= XCAR (hotspot
), CONSP (plist
)))
22344 pointer
= Fplist_get (plist
, Qpointer
);
22345 if (NILP (pointer
))
22347 help
= Fplist_get (plist
, Qhelp_echo
);
22350 help_echo_string
= help
;
22351 /* Is this correct? ++kfs */
22352 XSETWINDOW (help_echo_window
, w
);
22353 help_echo_object
= w
->buffer
;
22354 help_echo_pos
= charpos
;
22358 if (NILP (pointer
))
22359 pointer
= Fplist_get (XCDR (object
), QCpointer
);
22362 if (STRINGP (string
))
22364 pos
= make_number (charpos
);
22365 /* If we're on a string with `help-echo' text property, arrange
22366 for the help to be displayed. This is done by setting the
22367 global variable help_echo_string to the help string. */
22370 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
22373 help_echo_string
= help
;
22374 XSETWINDOW (help_echo_window
, w
);
22375 help_echo_object
= string
;
22376 help_echo_pos
= charpos
;
22380 if (NILP (pointer
))
22381 pointer
= Fget_text_property (pos
, Qpointer
, string
);
22383 /* Change the mouse pointer according to what is under X/Y. */
22384 if (NILP (pointer
) && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
22387 map
= Fget_text_property (pos
, Qlocal_map
, string
);
22388 if (!KEYMAPP (map
))
22389 map
= Fget_text_property (pos
, Qkeymap
, string
);
22390 if (!KEYMAPP (map
))
22391 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
22394 /* Change the mouse face according to what is under X/Y. */
22395 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
22396 if (!NILP (mouse_face
)
22397 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
22402 struct glyph
* tmp_glyph
;
22406 int total_pixel_width
;
22411 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
22412 Qmouse_face
, string
, Qnil
);
22414 b
= make_number (0);
22416 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
22418 e
= make_number (SCHARS (string
));
22420 /* Calculate the position(glyph position: GPOS) of GLYPH in
22421 displayed string. GPOS is different from CHARPOS.
22423 CHARPOS is the position of glyph in internal string
22424 object. A mode line string format has structures which
22425 is converted to a flatten by emacs lisp interpreter.
22426 The internal string is an element of the structures.
22427 The displayed string is the flatten string. */
22428 for (tmp_glyph
= glyph
- 1, gpos
= 0;
22429 tmp_glyph
->charpos
>= XINT (b
);
22430 tmp_glyph
--, gpos
++)
22432 if (!EQ (tmp_glyph
->object
, glyph
->object
))
22436 /* Calculate the lenght(glyph sequence length: GSEQ_LENGTH) of
22437 displayed string holding GLYPH.
22439 GSEQ_LENGTH is different from SCHARS (STRING).
22440 SCHARS (STRING) returns the length of the internal string. */
22441 for (tmp_glyph
= glyph
, gseq_length
= gpos
;
22442 tmp_glyph
->charpos
< XINT (e
);
22443 tmp_glyph
++, gseq_length
++)
22445 if (!EQ (tmp_glyph
->object
, glyph
->object
))
22449 total_pixel_width
= 0;
22450 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
22451 total_pixel_width
+= tmp_glyph
->pixel_width
;
22453 /* Pre calculation of re-rendering position */
22455 hpos
= (area
== ON_MODE_LINE
22456 ? (w
->current_matrix
)->nrows
- 1
22459 /* If the re-rendering position is included in the last
22460 re-rendering area, we should do nothing. */
22461 if ( EQ (window
, dpyinfo
->mouse_face_window
)
22462 && dpyinfo
->mouse_face_beg_col
<= vpos
22463 && vpos
< dpyinfo
->mouse_face_end_col
22464 && dpyinfo
->mouse_face_beg_row
== hpos
)
22467 if (clear_mouse_face (dpyinfo
))
22468 cursor
= No_Cursor
;
22470 dpyinfo
->mouse_face_beg_col
= vpos
;
22471 dpyinfo
->mouse_face_beg_row
= hpos
;
22473 dpyinfo
->mouse_face_beg_x
= original_x_pixel
- (total_pixel_width
+ dx
);
22474 dpyinfo
->mouse_face_beg_y
= 0;
22476 dpyinfo
->mouse_face_end_col
= vpos
+ gseq_length
;
22477 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_beg_row
;
22479 dpyinfo
->mouse_face_end_x
= 0;
22480 dpyinfo
->mouse_face_end_y
= 0;
22482 dpyinfo
->mouse_face_past_end
= 0;
22483 dpyinfo
->mouse_face_window
= window
;
22485 dpyinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
22488 glyph
->face_id
, 1);
22489 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
22491 if (NILP (pointer
))
22494 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
22495 clear_mouse_face (dpyinfo
);
22497 define_frame_cursor1 (f
, cursor
, pointer
);
22502 Take proper action when the mouse has moved to position X, Y on
22503 frame F as regards highlighting characters that have mouse-face
22504 properties. Also de-highlighting chars where the mouse was before.
22505 X and Y can be negative or out of range. */
22508 note_mouse_highlight (f
, x
, y
)
22512 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
22513 enum window_part part
;
22514 Lisp_Object window
;
22516 Cursor cursor
= No_Cursor
;
22517 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
22520 /* When a menu is active, don't highlight because this looks odd. */
22521 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NTGUI)
22522 if (popup_activated ())
22526 if (NILP (Vmouse_highlight
)
22527 || !f
->glyphs_initialized_p
)
22530 dpyinfo
->mouse_face_mouse_x
= x
;
22531 dpyinfo
->mouse_face_mouse_y
= y
;
22532 dpyinfo
->mouse_face_mouse_frame
= f
;
22534 if (dpyinfo
->mouse_face_defer
)
22537 if (gc_in_progress
)
22539 dpyinfo
->mouse_face_deferred_gc
= 1;
22543 /* Which window is that in? */
22544 window
= window_from_coordinates (f
, x
, y
, &part
, 0, 0, 1);
22546 /* If we were displaying active text in another window, clear that.
22547 Also clear if we move out of text area in same window. */
22548 if (! EQ (window
, dpyinfo
->mouse_face_window
)
22549 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
22550 && !NILP (dpyinfo
->mouse_face_window
)))
22551 clear_mouse_face (dpyinfo
);
22553 /* Not on a window -> return. */
22554 if (!WINDOWP (window
))
22557 /* Reset help_echo_string. It will get recomputed below. */
22558 help_echo_string
= Qnil
;
22560 /* Convert to window-relative pixel coordinates. */
22561 w
= XWINDOW (window
);
22562 frame_to_window_pixel_xy (w
, &x
, &y
);
22564 /* Handle tool-bar window differently since it doesn't display a
22566 if (EQ (window
, f
->tool_bar_window
))
22568 note_tool_bar_highlight (f
, x
, y
);
22572 /* Mouse is on the mode, header line or margin? */
22573 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
22574 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
22576 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
22580 if (part
== ON_VERTICAL_BORDER
)
22582 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
22583 help_echo_string
= build_string ("drag-mouse-1: resize");
22585 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
22586 || part
== ON_SCROLL_BAR
)
22587 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
22589 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
22591 /* Are we in a window whose display is up to date?
22592 And verify the buffer's text has not changed. */
22593 b
= XBUFFER (w
->buffer
);
22594 if (part
== ON_TEXT
22595 && EQ (w
->window_end_valid
, w
->buffer
)
22596 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
22597 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
22599 int hpos
, vpos
, pos
, i
, dx
, dy
, area
;
22600 struct glyph
*glyph
;
22601 Lisp_Object object
;
22602 Lisp_Object mouse_face
= Qnil
, overlay
= Qnil
, position
;
22603 Lisp_Object
*overlay_vec
= NULL
;
22605 struct buffer
*obuf
;
22606 int obegv
, ozv
, same_region
;
22608 /* Find the glyph under X/Y. */
22609 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
22611 /* Look for :pointer property on image. */
22612 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
22614 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
22615 if (img
!= NULL
&& IMAGEP (img
->spec
))
22617 Lisp_Object image_map
, hotspot
;
22618 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
22620 && (hotspot
= find_hot_spot (image_map
,
22621 glyph
->slice
.x
+ dx
,
22622 glyph
->slice
.y
+ dy
),
22624 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
22626 Lisp_Object area_id
, plist
;
22628 area_id
= XCAR (hotspot
);
22629 /* Could check AREA_ID to see if we enter/leave this hot-spot.
22630 If so, we could look for mouse-enter, mouse-leave
22631 properties in PLIST (and do something...). */
22632 hotspot
= XCDR (hotspot
);
22633 if (CONSP (hotspot
)
22634 && (plist
= XCAR (hotspot
), CONSP (plist
)))
22636 pointer
= Fplist_get (plist
, Qpointer
);
22637 if (NILP (pointer
))
22639 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
22640 if (!NILP (help_echo_string
))
22642 help_echo_window
= window
;
22643 help_echo_object
= glyph
->object
;
22644 help_echo_pos
= glyph
->charpos
;
22648 if (NILP (pointer
))
22649 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
22653 /* Clear mouse face if X/Y not over text. */
22655 || area
!= TEXT_AREA
22656 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
)
22658 if (clear_mouse_face (dpyinfo
))
22659 cursor
= No_Cursor
;
22660 if (NILP (pointer
))
22662 if (area
!= TEXT_AREA
)
22663 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
22665 pointer
= Vvoid_text_area_pointer
;
22670 pos
= glyph
->charpos
;
22671 object
= glyph
->object
;
22672 if (!STRINGP (object
) && !BUFFERP (object
))
22675 /* If we get an out-of-range value, return now; avoid an error. */
22676 if (BUFFERP (object
) && pos
> BUF_Z (b
))
22679 /* Make the window's buffer temporarily current for
22680 overlays_at and compute_char_face. */
22681 obuf
= current_buffer
;
22682 current_buffer
= b
;
22688 /* Is this char mouse-active or does it have help-echo? */
22689 position
= make_number (pos
);
22691 if (BUFFERP (object
))
22693 /* Put all the overlays we want in a vector in overlay_vec. */
22694 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
22695 /* Sort overlays into increasing priority order. */
22696 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
22701 same_region
= (EQ (window
, dpyinfo
->mouse_face_window
)
22702 && vpos
>= dpyinfo
->mouse_face_beg_row
22703 && vpos
<= dpyinfo
->mouse_face_end_row
22704 && (vpos
> dpyinfo
->mouse_face_beg_row
22705 || hpos
>= dpyinfo
->mouse_face_beg_col
)
22706 && (vpos
< dpyinfo
->mouse_face_end_row
22707 || hpos
< dpyinfo
->mouse_face_end_col
22708 || dpyinfo
->mouse_face_past_end
));
22711 cursor
= No_Cursor
;
22713 /* Check mouse-face highlighting. */
22715 /* If there exists an overlay with mouse-face overlapping
22716 the one we are currently highlighting, we have to
22717 check if we enter the overlapping overlay, and then
22718 highlight only that. */
22719 || (OVERLAYP (dpyinfo
->mouse_face_overlay
)
22720 && mouse_face_overlay_overlaps (dpyinfo
->mouse_face_overlay
)))
22722 /* Find the highest priority overlay that has a mouse-face
22725 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
22727 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
22728 if (!NILP (mouse_face
))
22729 overlay
= overlay_vec
[i
];
22732 /* If we're actually highlighting the same overlay as
22733 before, there's no need to do that again. */
22734 if (!NILP (overlay
)
22735 && EQ (overlay
, dpyinfo
->mouse_face_overlay
))
22736 goto check_help_echo
;
22738 dpyinfo
->mouse_face_overlay
= overlay
;
22740 /* Clear the display of the old active region, if any. */
22741 if (clear_mouse_face (dpyinfo
))
22742 cursor
= No_Cursor
;
22744 /* If no overlay applies, get a text property. */
22745 if (NILP (overlay
))
22746 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
22748 /* Handle the overlay case. */
22749 if (!NILP (overlay
))
22751 /* Find the range of text around this char that
22752 should be active. */
22753 Lisp_Object before
, after
;
22756 before
= Foverlay_start (overlay
);
22757 after
= Foverlay_end (overlay
);
22758 /* Record this as the current active region. */
22759 fast_find_position (w
, XFASTINT (before
),
22760 &dpyinfo
->mouse_face_beg_col
,
22761 &dpyinfo
->mouse_face_beg_row
,
22762 &dpyinfo
->mouse_face_beg_x
,
22763 &dpyinfo
->mouse_face_beg_y
, Qnil
);
22765 dpyinfo
->mouse_face_past_end
22766 = !fast_find_position (w
, XFASTINT (after
),
22767 &dpyinfo
->mouse_face_end_col
,
22768 &dpyinfo
->mouse_face_end_row
,
22769 &dpyinfo
->mouse_face_end_x
,
22770 &dpyinfo
->mouse_face_end_y
, Qnil
);
22771 dpyinfo
->mouse_face_window
= window
;
22773 dpyinfo
->mouse_face_face_id
22774 = face_at_buffer_position (w
, pos
, 0, 0,
22776 !dpyinfo
->mouse_face_hidden
);
22778 /* Display it as active. */
22779 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
22780 cursor
= No_Cursor
;
22782 /* Handle the text property case. */
22783 else if (!NILP (mouse_face
) && BUFFERP (object
))
22785 /* Find the range of text around this char that
22786 should be active. */
22787 Lisp_Object before
, after
, beginning
, end
;
22790 beginning
= Fmarker_position (w
->start
);
22791 end
= make_number (BUF_Z (XBUFFER (object
))
22792 - XFASTINT (w
->window_end_pos
));
22794 = Fprevious_single_property_change (make_number (pos
+ 1),
22796 object
, beginning
);
22798 = Fnext_single_property_change (position
, Qmouse_face
,
22801 /* Record this as the current active region. */
22802 fast_find_position (w
, XFASTINT (before
),
22803 &dpyinfo
->mouse_face_beg_col
,
22804 &dpyinfo
->mouse_face_beg_row
,
22805 &dpyinfo
->mouse_face_beg_x
,
22806 &dpyinfo
->mouse_face_beg_y
, Qnil
);
22807 dpyinfo
->mouse_face_past_end
22808 = !fast_find_position (w
, XFASTINT (after
),
22809 &dpyinfo
->mouse_face_end_col
,
22810 &dpyinfo
->mouse_face_end_row
,
22811 &dpyinfo
->mouse_face_end_x
,
22812 &dpyinfo
->mouse_face_end_y
, Qnil
);
22813 dpyinfo
->mouse_face_window
= window
;
22815 if (BUFFERP (object
))
22816 dpyinfo
->mouse_face_face_id
22817 = face_at_buffer_position (w
, pos
, 0, 0,
22819 !dpyinfo
->mouse_face_hidden
);
22821 /* Display it as active. */
22822 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
22823 cursor
= No_Cursor
;
22825 else if (!NILP (mouse_face
) && STRINGP (object
))
22830 b
= Fprevious_single_property_change (make_number (pos
+ 1),
22833 e
= Fnext_single_property_change (position
, Qmouse_face
,
22836 b
= make_number (0);
22838 e
= make_number (SCHARS (object
) - 1);
22840 fast_find_string_pos (w
, XINT (b
), object
,
22841 &dpyinfo
->mouse_face_beg_col
,
22842 &dpyinfo
->mouse_face_beg_row
,
22843 &dpyinfo
->mouse_face_beg_x
,
22844 &dpyinfo
->mouse_face_beg_y
, 0);
22845 fast_find_string_pos (w
, XINT (e
), object
,
22846 &dpyinfo
->mouse_face_end_col
,
22847 &dpyinfo
->mouse_face_end_row
,
22848 &dpyinfo
->mouse_face_end_x
,
22849 &dpyinfo
->mouse_face_end_y
, 1);
22850 dpyinfo
->mouse_face_past_end
= 0;
22851 dpyinfo
->mouse_face_window
= window
;
22852 dpyinfo
->mouse_face_face_id
22853 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
22854 glyph
->face_id
, 1);
22855 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
22856 cursor
= No_Cursor
;
22858 else if (STRINGP (object
) && NILP (mouse_face
))
22860 /* A string which doesn't have mouse-face, but
22861 the text ``under'' it might have. */
22862 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
22863 int start
= MATRIX_ROW_START_CHARPOS (r
);
22865 pos
= string_buffer_position (w
, object
, start
);
22867 mouse_face
= get_char_property_and_overlay (make_number (pos
),
22871 if (!NILP (mouse_face
) && !NILP (overlay
))
22873 Lisp_Object before
= Foverlay_start (overlay
);
22874 Lisp_Object after
= Foverlay_end (overlay
);
22877 /* Note that we might not be able to find position
22878 BEFORE in the glyph matrix if the overlay is
22879 entirely covered by a `display' property. In
22880 this case, we overshoot. So let's stop in
22881 the glyph matrix before glyphs for OBJECT. */
22882 fast_find_position (w
, XFASTINT (before
),
22883 &dpyinfo
->mouse_face_beg_col
,
22884 &dpyinfo
->mouse_face_beg_row
,
22885 &dpyinfo
->mouse_face_beg_x
,
22886 &dpyinfo
->mouse_face_beg_y
,
22889 dpyinfo
->mouse_face_past_end
22890 = !fast_find_position (w
, XFASTINT (after
),
22891 &dpyinfo
->mouse_face_end_col
,
22892 &dpyinfo
->mouse_face_end_row
,
22893 &dpyinfo
->mouse_face_end_x
,
22894 &dpyinfo
->mouse_face_end_y
,
22896 dpyinfo
->mouse_face_window
= window
;
22897 dpyinfo
->mouse_face_face_id
22898 = face_at_buffer_position (w
, pos
, 0, 0,
22900 !dpyinfo
->mouse_face_hidden
);
22902 /* Display it as active. */
22903 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
22904 cursor
= No_Cursor
;
22911 /* Look for a `help-echo' property. */
22912 if (NILP (help_echo_string
)) {
22913 Lisp_Object help
, overlay
;
22915 /* Check overlays first. */
22916 help
= overlay
= Qnil
;
22917 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
22919 overlay
= overlay_vec
[i
];
22920 help
= Foverlay_get (overlay
, Qhelp_echo
);
22925 help_echo_string
= help
;
22926 help_echo_window
= window
;
22927 help_echo_object
= overlay
;
22928 help_echo_pos
= pos
;
22932 Lisp_Object object
= glyph
->object
;
22933 int charpos
= glyph
->charpos
;
22935 /* Try text properties. */
22936 if (STRINGP (object
)
22938 && charpos
< SCHARS (object
))
22940 help
= Fget_text_property (make_number (charpos
),
22941 Qhelp_echo
, object
);
22944 /* If the string itself doesn't specify a help-echo,
22945 see if the buffer text ``under'' it does. */
22946 struct glyph_row
*r
22947 = MATRIX_ROW (w
->current_matrix
, vpos
);
22948 int start
= MATRIX_ROW_START_CHARPOS (r
);
22949 int pos
= string_buffer_position (w
, object
, start
);
22952 help
= Fget_char_property (make_number (pos
),
22953 Qhelp_echo
, w
->buffer
);
22957 object
= w
->buffer
;
22962 else if (BUFFERP (object
)
22965 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
22970 help_echo_string
= help
;
22971 help_echo_window
= window
;
22972 help_echo_object
= object
;
22973 help_echo_pos
= charpos
;
22978 /* Look for a `pointer' property. */
22979 if (NILP (pointer
))
22981 /* Check overlays first. */
22982 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
22983 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
22985 if (NILP (pointer
))
22987 Lisp_Object object
= glyph
->object
;
22988 int charpos
= glyph
->charpos
;
22990 /* Try text properties. */
22991 if (STRINGP (object
)
22993 && charpos
< SCHARS (object
))
22995 pointer
= Fget_text_property (make_number (charpos
),
22997 if (NILP (pointer
))
22999 /* If the string itself doesn't specify a pointer,
23000 see if the buffer text ``under'' it does. */
23001 struct glyph_row
*r
23002 = MATRIX_ROW (w
->current_matrix
, vpos
);
23003 int start
= MATRIX_ROW_START_CHARPOS (r
);
23004 int pos
= string_buffer_position (w
, object
, start
);
23006 pointer
= Fget_char_property (make_number (pos
),
23007 Qpointer
, w
->buffer
);
23010 else if (BUFFERP (object
)
23013 pointer
= Fget_text_property (make_number (charpos
),
23020 current_buffer
= obuf
;
23025 define_frame_cursor1 (f
, cursor
, pointer
);
23030 Clear any mouse-face on window W. This function is part of the
23031 redisplay interface, and is called from try_window_id and similar
23032 functions to ensure the mouse-highlight is off. */
23035 x_clear_window_mouse_face (w
)
23038 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
23039 Lisp_Object window
;
23042 XSETWINDOW (window
, w
);
23043 if (EQ (window
, dpyinfo
->mouse_face_window
))
23044 clear_mouse_face (dpyinfo
);
23050 Just discard the mouse face information for frame F, if any.
23051 This is used when the size of F is changed. */
23054 cancel_mouse_face (f
)
23057 Lisp_Object window
;
23058 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
23060 window
= dpyinfo
->mouse_face_window
;
23061 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
23063 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
23064 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
23065 dpyinfo
->mouse_face_window
= Qnil
;
23070 #endif /* HAVE_WINDOW_SYSTEM */
23073 /***********************************************************************
23075 ***********************************************************************/
23077 #ifdef HAVE_WINDOW_SYSTEM
23079 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
23080 which intersects rectangle R. R is in window-relative coordinates. */
23083 expose_area (w
, row
, r
, area
)
23085 struct glyph_row
*row
;
23087 enum glyph_row_area area
;
23089 struct glyph
*first
= row
->glyphs
[area
];
23090 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
23091 struct glyph
*last
;
23092 int first_x
, start_x
, x
;
23094 if (area
== TEXT_AREA
&& row
->fill_line_p
)
23095 /* If row extends face to end of line write the whole line. */
23096 draw_glyphs (w
, 0, row
, area
,
23097 0, row
->used
[area
],
23098 DRAW_NORMAL_TEXT
, 0);
23101 /* Set START_X to the window-relative start position for drawing glyphs of
23102 AREA. The first glyph of the text area can be partially visible.
23103 The first glyphs of other areas cannot. */
23104 start_x
= window_box_left_offset (w
, area
);
23106 if (area
== TEXT_AREA
)
23109 /* Find the first glyph that must be redrawn. */
23111 && x
+ first
->pixel_width
< r
->x
)
23113 x
+= first
->pixel_width
;
23117 /* Find the last one. */
23121 && x
< r
->x
+ r
->width
)
23123 x
+= last
->pixel_width
;
23129 draw_glyphs (w
, first_x
- start_x
, row
, area
,
23130 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
23131 DRAW_NORMAL_TEXT
, 0);
23136 /* Redraw the parts of the glyph row ROW on window W intersecting
23137 rectangle R. R is in window-relative coordinates. Value is
23138 non-zero if mouse-face was overwritten. */
23141 expose_line (w
, row
, r
)
23143 struct glyph_row
*row
;
23146 xassert (row
->enabled_p
);
23148 if (row
->mode_line_p
|| w
->pseudo_window_p
)
23149 draw_glyphs (w
, 0, row
, TEXT_AREA
,
23150 0, row
->used
[TEXT_AREA
],
23151 DRAW_NORMAL_TEXT
, 0);
23154 if (row
->used
[LEFT_MARGIN_AREA
])
23155 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
23156 if (row
->used
[TEXT_AREA
])
23157 expose_area (w
, row
, r
, TEXT_AREA
);
23158 if (row
->used
[RIGHT_MARGIN_AREA
])
23159 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
23160 draw_row_fringe_bitmaps (w
, row
);
23163 return row
->mouse_face_p
;
23167 /* Redraw those parts of glyphs rows during expose event handling that
23168 overlap other rows. Redrawing of an exposed line writes over parts
23169 of lines overlapping that exposed line; this function fixes that.
23171 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
23172 row in W's current matrix that is exposed and overlaps other rows.
23173 LAST_OVERLAPPING_ROW is the last such row. */
23176 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
)
23178 struct glyph_row
*first_overlapping_row
;
23179 struct glyph_row
*last_overlapping_row
;
23181 struct glyph_row
*row
;
23183 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
23184 if (row
->overlapping_p
)
23186 xassert (row
->enabled_p
&& !row
->mode_line_p
);
23188 if (row
->used
[LEFT_MARGIN_AREA
])
23189 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
23191 if (row
->used
[TEXT_AREA
])
23192 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
23194 if (row
->used
[RIGHT_MARGIN_AREA
])
23195 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
23200 /* Return non-zero if W's cursor intersects rectangle R. */
23203 phys_cursor_in_rect_p (w
, r
)
23207 XRectangle cr
, result
;
23208 struct glyph
*cursor_glyph
;
23210 cursor_glyph
= get_phys_cursor_glyph (w
);
23213 /* r is relative to W's box, but w->phys_cursor.x is relative
23214 to left edge of W's TEXT area. Adjust it. */
23215 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
23216 cr
.y
= w
->phys_cursor
.y
;
23217 cr
.width
= cursor_glyph
->pixel_width
;
23218 cr
.height
= w
->phys_cursor_height
;
23219 /* ++KFS: W32 version used W32-specific IntersectRect here, but
23220 I assume the effect is the same -- and this is portable. */
23221 return x_intersect_rectangles (&cr
, r
, &result
);
23229 Draw a vertical window border to the right of window W if W doesn't
23230 have vertical scroll bars. */
23233 x_draw_vertical_border (w
)
23236 /* We could do better, if we knew what type of scroll-bar the adjacent
23237 windows (on either side) have... But we don't :-(
23238 However, I think this works ok. ++KFS 2003-04-25 */
23240 /* Redraw borders between horizontally adjacent windows. Don't
23241 do it for frames with vertical scroll bars because either the
23242 right scroll bar of a window, or the left scroll bar of its
23243 neighbor will suffice as a border. */
23244 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
23247 if (!WINDOW_RIGHTMOST_P (w
)
23248 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
23250 int x0
, x1
, y0
, y1
;
23252 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
23255 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
23258 rif
->draw_vertical_window_border (w
, x1
, y0
, y1
);
23260 else if (!WINDOW_LEFTMOST_P (w
)
23261 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
23263 int x0
, x1
, y0
, y1
;
23265 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
23268 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
23271 rif
->draw_vertical_window_border (w
, x0
, y0
, y1
);
23276 /* Redraw the part of window W intersection rectangle FR. Pixel
23277 coordinates in FR are frame-relative. Call this function with
23278 input blocked. Value is non-zero if the exposure overwrites
23282 expose_window (w
, fr
)
23286 struct frame
*f
= XFRAME (w
->frame
);
23288 int mouse_face_overwritten_p
= 0;
23290 /* If window is not yet fully initialized, do nothing. This can
23291 happen when toolkit scroll bars are used and a window is split.
23292 Reconfiguring the scroll bar will generate an expose for a newly
23294 if (w
->current_matrix
== NULL
)
23297 /* When we're currently updating the window, display and current
23298 matrix usually don't agree. Arrange for a thorough display
23300 if (w
== updated_window
)
23302 SET_FRAME_GARBAGED (f
);
23306 /* Frame-relative pixel rectangle of W. */
23307 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
23308 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
23309 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
23310 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
23312 if (x_intersect_rectangles (fr
, &wr
, &r
))
23314 int yb
= window_text_bottom_y (w
);
23315 struct glyph_row
*row
;
23316 int cursor_cleared_p
;
23317 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
23319 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
23320 r
.x
, r
.y
, r
.width
, r
.height
));
23322 /* Convert to window coordinates. */
23323 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
23324 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
23326 /* Turn off the cursor. */
23327 if (!w
->pseudo_window_p
23328 && phys_cursor_in_rect_p (w
, &r
))
23330 x_clear_cursor (w
);
23331 cursor_cleared_p
= 1;
23334 cursor_cleared_p
= 0;
23336 /* Update lines intersecting rectangle R. */
23337 first_overlapping_row
= last_overlapping_row
= NULL
;
23338 for (row
= w
->current_matrix
->rows
;
23343 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
23345 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
23346 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
23347 || (r
.y
>= y0
&& r
.y
< y1
)
23348 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
23350 /* A header line may be overlapping, but there is no need
23351 to fix overlapping areas for them. KFS 2005-02-12 */
23352 if (row
->overlapping_p
&& !row
->mode_line_p
)
23354 if (first_overlapping_row
== NULL
)
23355 first_overlapping_row
= row
;
23356 last_overlapping_row
= row
;
23359 if (expose_line (w
, row
, &r
))
23360 mouse_face_overwritten_p
= 1;
23367 /* Display the mode line if there is one. */
23368 if (WINDOW_WANTS_MODELINE_P (w
)
23369 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
23371 && row
->y
< r
.y
+ r
.height
)
23373 if (expose_line (w
, row
, &r
))
23374 mouse_face_overwritten_p
= 1;
23377 if (!w
->pseudo_window_p
)
23379 /* Fix the display of overlapping rows. */
23380 if (first_overlapping_row
)
23381 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
);
23383 /* Draw border between windows. */
23384 x_draw_vertical_border (w
);
23386 /* Turn the cursor on again. */
23387 if (cursor_cleared_p
)
23388 update_window_cursor (w
, 1);
23392 return mouse_face_overwritten_p
;
23397 /* Redraw (parts) of all windows in the window tree rooted at W that
23398 intersect R. R contains frame pixel coordinates. Value is
23399 non-zero if the exposure overwrites mouse-face. */
23402 expose_window_tree (w
, r
)
23406 struct frame
*f
= XFRAME (w
->frame
);
23407 int mouse_face_overwritten_p
= 0;
23409 while (w
&& !FRAME_GARBAGED_P (f
))
23411 if (!NILP (w
->hchild
))
23412 mouse_face_overwritten_p
23413 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
23414 else if (!NILP (w
->vchild
))
23415 mouse_face_overwritten_p
23416 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
23418 mouse_face_overwritten_p
|= expose_window (w
, r
);
23420 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
23423 return mouse_face_overwritten_p
;
23428 Redisplay an exposed area of frame F. X and Y are the upper-left
23429 corner of the exposed rectangle. W and H are width and height of
23430 the exposed area. All are pixel values. W or H zero means redraw
23431 the entire frame. */
23434 expose_frame (f
, x
, y
, w
, h
)
23439 int mouse_face_overwritten_p
= 0;
23441 TRACE ((stderr
, "expose_frame "));
23443 /* No need to redraw if frame will be redrawn soon. */
23444 if (FRAME_GARBAGED_P (f
))
23446 TRACE ((stderr
, " garbaged\n"));
23450 /* If basic faces haven't been realized yet, there is no point in
23451 trying to redraw anything. This can happen when we get an expose
23452 event while Emacs is starting, e.g. by moving another window. */
23453 if (FRAME_FACE_CACHE (f
) == NULL
23454 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
23456 TRACE ((stderr
, " no faces\n"));
23460 if (w
== 0 || h
== 0)
23463 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
23464 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
23474 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
23475 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
23477 if (WINDOWP (f
->tool_bar_window
))
23478 mouse_face_overwritten_p
23479 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
23481 #ifdef HAVE_X_WINDOWS
23483 #ifndef USE_X_TOOLKIT
23484 if (WINDOWP (f
->menu_bar_window
))
23485 mouse_face_overwritten_p
23486 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
23487 #endif /* not USE_X_TOOLKIT */
23491 /* Some window managers support a focus-follows-mouse style with
23492 delayed raising of frames. Imagine a partially obscured frame,
23493 and moving the mouse into partially obscured mouse-face on that
23494 frame. The visible part of the mouse-face will be highlighted,
23495 then the WM raises the obscured frame. With at least one WM, KDE
23496 2.1, Emacs is not getting any event for the raising of the frame
23497 (even tried with SubstructureRedirectMask), only Expose events.
23498 These expose events will draw text normally, i.e. not
23499 highlighted. Which means we must redo the highlight here.
23500 Subsume it under ``we love X''. --gerd 2001-08-15 */
23501 /* Included in Windows version because Windows most likely does not
23502 do the right thing if any third party tool offers
23503 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
23504 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
23506 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
23507 if (f
== dpyinfo
->mouse_face_mouse_frame
)
23509 int x
= dpyinfo
->mouse_face_mouse_x
;
23510 int y
= dpyinfo
->mouse_face_mouse_y
;
23511 clear_mouse_face (dpyinfo
);
23512 note_mouse_highlight (f
, x
, y
);
23519 Determine the intersection of two rectangles R1 and R2. Return
23520 the intersection in *RESULT. Value is non-zero if RESULT is not
23524 x_intersect_rectangles (r1
, r2
, result
)
23525 XRectangle
*r1
, *r2
, *result
;
23527 XRectangle
*left
, *right
;
23528 XRectangle
*upper
, *lower
;
23529 int intersection_p
= 0;
23531 /* Rearrange so that R1 is the left-most rectangle. */
23533 left
= r1
, right
= r2
;
23535 left
= r2
, right
= r1
;
23537 /* X0 of the intersection is right.x0, if this is inside R1,
23538 otherwise there is no intersection. */
23539 if (right
->x
<= left
->x
+ left
->width
)
23541 result
->x
= right
->x
;
23543 /* The right end of the intersection is the minimum of the
23544 the right ends of left and right. */
23545 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
23548 /* Same game for Y. */
23550 upper
= r1
, lower
= r2
;
23552 upper
= r2
, lower
= r1
;
23554 /* The upper end of the intersection is lower.y0, if this is inside
23555 of upper. Otherwise, there is no intersection. */
23556 if (lower
->y
<= upper
->y
+ upper
->height
)
23558 result
->y
= lower
->y
;
23560 /* The lower end of the intersection is the minimum of the lower
23561 ends of upper and lower. */
23562 result
->height
= (min (lower
->y
+ lower
->height
,
23563 upper
->y
+ upper
->height
)
23565 intersection_p
= 1;
23569 return intersection_p
;
23572 #endif /* HAVE_WINDOW_SYSTEM */
23575 /***********************************************************************
23577 ***********************************************************************/
23582 Vwith_echo_area_save_vector
= Qnil
;
23583 staticpro (&Vwith_echo_area_save_vector
);
23585 Vmessage_stack
= Qnil
;
23586 staticpro (&Vmessage_stack
);
23588 Qinhibit_redisplay
= intern ("inhibit-redisplay");
23589 staticpro (&Qinhibit_redisplay
);
23591 message_dolog_marker1
= Fmake_marker ();
23592 staticpro (&message_dolog_marker1
);
23593 message_dolog_marker2
= Fmake_marker ();
23594 staticpro (&message_dolog_marker2
);
23595 message_dolog_marker3
= Fmake_marker ();
23596 staticpro (&message_dolog_marker3
);
23599 defsubr (&Sdump_frame_glyph_matrix
);
23600 defsubr (&Sdump_glyph_matrix
);
23601 defsubr (&Sdump_glyph_row
);
23602 defsubr (&Sdump_tool_bar_row
);
23603 defsubr (&Strace_redisplay
);
23604 defsubr (&Strace_to_stderr
);
23606 #ifdef HAVE_WINDOW_SYSTEM
23607 defsubr (&Stool_bar_lines_needed
);
23608 defsubr (&Slookup_image_map
);
23610 defsubr (&Sformat_mode_line
);
23612 staticpro (&Qmenu_bar_update_hook
);
23613 Qmenu_bar_update_hook
= intern ("menu-bar-update-hook");
23615 staticpro (&Qoverriding_terminal_local_map
);
23616 Qoverriding_terminal_local_map
= intern ("overriding-terminal-local-map");
23618 staticpro (&Qoverriding_local_map
);
23619 Qoverriding_local_map
= intern ("overriding-local-map");
23621 staticpro (&Qwindow_scroll_functions
);
23622 Qwindow_scroll_functions
= intern ("window-scroll-functions");
23624 staticpro (&Qredisplay_end_trigger_functions
);
23625 Qredisplay_end_trigger_functions
= intern ("redisplay-end-trigger-functions");
23627 staticpro (&Qinhibit_point_motion_hooks
);
23628 Qinhibit_point_motion_hooks
= intern ("inhibit-point-motion-hooks");
23630 QCdata
= intern (":data");
23631 staticpro (&QCdata
);
23632 Qdisplay
= intern ("display");
23633 staticpro (&Qdisplay
);
23634 Qspace_width
= intern ("space-width");
23635 staticpro (&Qspace_width
);
23636 Qraise
= intern ("raise");
23637 staticpro (&Qraise
);
23638 Qslice
= intern ("slice");
23639 staticpro (&Qslice
);
23640 Qspace
= intern ("space");
23641 staticpro (&Qspace
);
23642 Qmargin
= intern ("margin");
23643 staticpro (&Qmargin
);
23644 Qpointer
= intern ("pointer");
23645 staticpro (&Qpointer
);
23646 Qleft_margin
= intern ("left-margin");
23647 staticpro (&Qleft_margin
);
23648 Qright_margin
= intern ("right-margin");
23649 staticpro (&Qright_margin
);
23650 Qcenter
= intern ("center");
23651 staticpro (&Qcenter
);
23652 Qline_height
= intern ("line-height");
23653 staticpro (&Qline_height
);
23654 QCalign_to
= intern (":align-to");
23655 staticpro (&QCalign_to
);
23656 QCrelative_width
= intern (":relative-width");
23657 staticpro (&QCrelative_width
);
23658 QCrelative_height
= intern (":relative-height");
23659 staticpro (&QCrelative_height
);
23660 QCeval
= intern (":eval");
23661 staticpro (&QCeval
);
23662 QCpropertize
= intern (":propertize");
23663 staticpro (&QCpropertize
);
23664 QCfile
= intern (":file");
23665 staticpro (&QCfile
);
23666 Qfontified
= intern ("fontified");
23667 staticpro (&Qfontified
);
23668 Qfontification_functions
= intern ("fontification-functions");
23669 staticpro (&Qfontification_functions
);
23670 Qtrailing_whitespace
= intern ("trailing-whitespace");
23671 staticpro (&Qtrailing_whitespace
);
23672 Qescape_glyph
= intern ("escape-glyph");
23673 staticpro (&Qescape_glyph
);
23674 Qnobreak_space
= intern ("nobreak-space");
23675 staticpro (&Qnobreak_space
);
23676 Qimage
= intern ("image");
23677 staticpro (&Qimage
);
23678 QCmap
= intern (":map");
23679 staticpro (&QCmap
);
23680 QCpointer
= intern (":pointer");
23681 staticpro (&QCpointer
);
23682 Qrect
= intern ("rect");
23683 staticpro (&Qrect
);
23684 Qcircle
= intern ("circle");
23685 staticpro (&Qcircle
);
23686 Qpoly
= intern ("poly");
23687 staticpro (&Qpoly
);
23688 Qmessage_truncate_lines
= intern ("message-truncate-lines");
23689 staticpro (&Qmessage_truncate_lines
);
23690 Qgrow_only
= intern ("grow-only");
23691 staticpro (&Qgrow_only
);
23692 Qinhibit_menubar_update
= intern ("inhibit-menubar-update");
23693 staticpro (&Qinhibit_menubar_update
);
23694 Qinhibit_eval_during_redisplay
= intern ("inhibit-eval-during-redisplay");
23695 staticpro (&Qinhibit_eval_during_redisplay
);
23696 Qposition
= intern ("position");
23697 staticpro (&Qposition
);
23698 Qbuffer_position
= intern ("buffer-position");
23699 staticpro (&Qbuffer_position
);
23700 Qobject
= intern ("object");
23701 staticpro (&Qobject
);
23702 Qbar
= intern ("bar");
23704 Qhbar
= intern ("hbar");
23705 staticpro (&Qhbar
);
23706 Qbox
= intern ("box");
23708 Qhollow
= intern ("hollow");
23709 staticpro (&Qhollow
);
23710 Qhand
= intern ("hand");
23711 staticpro (&Qhand
);
23712 Qarrow
= intern ("arrow");
23713 staticpro (&Qarrow
);
23714 Qtext
= intern ("text");
23715 staticpro (&Qtext
);
23716 Qrisky_local_variable
= intern ("risky-local-variable");
23717 staticpro (&Qrisky_local_variable
);
23718 Qinhibit_free_realized_faces
= intern ("inhibit-free-realized-faces");
23719 staticpro (&Qinhibit_free_realized_faces
);
23721 list_of_error
= Fcons (Fcons (intern ("error"),
23722 Fcons (intern ("void-variable"), Qnil
)),
23724 staticpro (&list_of_error
);
23726 Qlast_arrow_position
= intern ("last-arrow-position");
23727 staticpro (&Qlast_arrow_position
);
23728 Qlast_arrow_string
= intern ("last-arrow-string");
23729 staticpro (&Qlast_arrow_string
);
23731 Qoverlay_arrow_string
= intern ("overlay-arrow-string");
23732 staticpro (&Qoverlay_arrow_string
);
23733 Qoverlay_arrow_bitmap
= intern ("overlay-arrow-bitmap");
23734 staticpro (&Qoverlay_arrow_bitmap
);
23736 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
23737 staticpro (&echo_buffer
[0]);
23738 staticpro (&echo_buffer
[1]);
23740 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
23741 staticpro (&echo_area_buffer
[0]);
23742 staticpro (&echo_area_buffer
[1]);
23744 Vmessages_buffer_name
= build_string ("*Messages*");
23745 staticpro (&Vmessages_buffer_name
);
23747 mode_line_proptrans_alist
= Qnil
;
23748 staticpro (&mode_line_proptrans_alist
);
23749 mode_line_string_list
= Qnil
;
23750 staticpro (&mode_line_string_list
);
23751 mode_line_string_face
= Qnil
;
23752 staticpro (&mode_line_string_face
);
23753 mode_line_string_face_prop
= Qnil
;
23754 staticpro (&mode_line_string_face_prop
);
23755 Vmode_line_unwind_vector
= Qnil
;
23756 staticpro (&Vmode_line_unwind_vector
);
23758 help_echo_string
= Qnil
;
23759 staticpro (&help_echo_string
);
23760 help_echo_object
= Qnil
;
23761 staticpro (&help_echo_object
);
23762 help_echo_window
= Qnil
;
23763 staticpro (&help_echo_window
);
23764 previous_help_echo_string
= Qnil
;
23765 staticpro (&previous_help_echo_string
);
23766 help_echo_pos
= -1;
23768 #ifdef HAVE_WINDOW_SYSTEM
23769 DEFVAR_BOOL ("x-stretch-cursor", &x_stretch_cursor_p
,
23770 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
23771 For example, if a block cursor is over a tab, it will be drawn as
23772 wide as that tab on the display. */);
23773 x_stretch_cursor_p
= 0;
23776 DEFVAR_LISP ("show-trailing-whitespace", &Vshow_trailing_whitespace
,
23777 doc
: /* *Non-nil means highlight trailing whitespace.
23778 The face used for trailing whitespace is `trailing-whitespace'. */);
23779 Vshow_trailing_whitespace
= Qnil
;
23781 DEFVAR_LISP ("nobreak-char-display", &Vnobreak_char_display
,
23782 doc
: /* *Control highlighting of nobreak space and soft hyphen.
23783 A value of t means highlight the character itself (for nobreak space,
23784 use face `nobreak-space').
23785 A value of nil means no highlighting.
23786 Other values mean display the escape glyph followed by an ordinary
23787 space or ordinary hyphen. */);
23788 Vnobreak_char_display
= Qt
;
23790 DEFVAR_LISP ("void-text-area-pointer", &Vvoid_text_area_pointer
,
23791 doc
: /* *The pointer shape to show in void text areas.
23792 A value of nil means to show the text pointer. Other options are `arrow',
23793 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
23794 Vvoid_text_area_pointer
= Qarrow
;
23796 DEFVAR_LISP ("inhibit-redisplay", &Vinhibit_redisplay
,
23797 doc
: /* Non-nil means don't actually do any redisplay.
23798 This is used for internal purposes. */);
23799 Vinhibit_redisplay
= Qnil
;
23801 DEFVAR_LISP ("global-mode-string", &Vglobal_mode_string
,
23802 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
23803 Vglobal_mode_string
= Qnil
;
23805 DEFVAR_LISP ("overlay-arrow-position", &Voverlay_arrow_position
,
23806 doc
: /* Marker for where to display an arrow on top of the buffer text.
23807 This must be the beginning of a line in order to work.
23808 See also `overlay-arrow-string'. */);
23809 Voverlay_arrow_position
= Qnil
;
23811 DEFVAR_LISP ("overlay-arrow-string", &Voverlay_arrow_string
,
23812 doc
: /* String to display as an arrow in non-window frames.
23813 See also `overlay-arrow-position'. */);
23814 Voverlay_arrow_string
= build_string ("=>");
23816 DEFVAR_LISP ("overlay-arrow-variable-list", &Voverlay_arrow_variable_list
,
23817 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
23818 The symbols on this list are examined during redisplay to determine
23819 where to display overlay arrows. */);
23820 Voverlay_arrow_variable_list
23821 = Fcons (intern ("overlay-arrow-position"), Qnil
);
23823 DEFVAR_INT ("scroll-step", &scroll_step
,
23824 doc
: /* *The number of lines to try scrolling a window by when point moves out.
23825 If that fails to bring point back on frame, point is centered instead.
23826 If this is zero, point is always centered after it moves off frame.
23827 If you want scrolling to always be a line at a time, you should set
23828 `scroll-conservatively' to a large value rather than set this to 1. */);
23830 DEFVAR_INT ("scroll-conservatively", &scroll_conservatively
,
23831 doc
: /* *Scroll up to this many lines, to bring point back on screen.
23832 A value of zero means to scroll the text to center point vertically
23833 in the window. */);
23834 scroll_conservatively
= 0;
23836 DEFVAR_INT ("scroll-margin", &scroll_margin
,
23837 doc
: /* *Number of lines of margin at the top and bottom of a window.
23838 Recenter the window whenever point gets within this many lines
23839 of the top or bottom of the window. */);
23842 DEFVAR_LISP ("display-pixels-per-inch", &Vdisplay_pixels_per_inch
,
23843 doc
: /* Pixels per inch value for non-window system displays.
23844 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
23845 Vdisplay_pixels_per_inch
= make_float (72.0);
23848 DEFVAR_INT ("debug-end-pos", &debug_end_pos
, doc
: /* Don't ask. */);
23851 DEFVAR_BOOL ("truncate-partial-width-windows",
23852 &truncate_partial_width_windows
,
23853 doc
: /* *Non-nil means truncate lines in all windows less than full frame wide. */);
23854 truncate_partial_width_windows
= 1;
23856 DEFVAR_BOOL ("mode-line-inverse-video", &mode_line_inverse_video
,
23857 doc
: /* nil means display the mode-line/header-line/menu-bar in the default face.
23858 Any other value means to use the appropriate face, `mode-line',
23859 `header-line', or `menu' respectively. */);
23860 mode_line_inverse_video
= 1;
23862 DEFVAR_LISP ("line-number-display-limit", &Vline_number_display_limit
,
23863 doc
: /* *Maximum buffer size for which line number should be displayed.
23864 If the buffer is bigger than this, the line number does not appear
23865 in the mode line. A value of nil means no limit. */);
23866 Vline_number_display_limit
= Qnil
;
23868 DEFVAR_INT ("line-number-display-limit-width",
23869 &line_number_display_limit_width
,
23870 doc
: /* *Maximum line width (in characters) for line number display.
23871 If the average length of the lines near point is bigger than this, then the
23872 line number may be omitted from the mode line. */);
23873 line_number_display_limit_width
= 200;
23875 DEFVAR_BOOL ("highlight-nonselected-windows", &highlight_nonselected_windows
,
23876 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
23877 highlight_nonselected_windows
= 0;
23879 DEFVAR_BOOL ("multiple-frames", &multiple_frames
,
23880 doc
: /* Non-nil if more than one frame is visible on this display.
23881 Minibuffer-only frames don't count, but iconified frames do.
23882 This variable is not guaranteed to be accurate except while processing
23883 `frame-title-format' and `icon-title-format'. */);
23885 DEFVAR_LISP ("frame-title-format", &Vframe_title_format
,
23886 doc
: /* Template for displaying the title bar of visible frames.
23887 \(Assuming the window manager supports this feature.)
23888 This variable has the same structure as `mode-line-format' (which see),
23889 and is used only on frames for which no explicit name has been set
23890 \(see `modify-frame-parameters'). */);
23892 DEFVAR_LISP ("icon-title-format", &Vicon_title_format
,
23893 doc
: /* Template for displaying the title bar of an iconified frame.
23894 \(Assuming the window manager supports this feature.)
23895 This variable has the same structure as `mode-line-format' (which see),
23896 and is used only on frames for which no explicit name has been set
23897 \(see `modify-frame-parameters'). */);
23899 = Vframe_title_format
23900 = Fcons (intern ("multiple-frames"),
23901 Fcons (build_string ("%b"),
23902 Fcons (Fcons (empty_string
,
23903 Fcons (intern ("invocation-name"),
23904 Fcons (build_string ("@"),
23905 Fcons (intern ("system-name"),
23909 DEFVAR_LISP ("message-log-max", &Vmessage_log_max
,
23910 doc
: /* Maximum number of lines to keep in the message log buffer.
23911 If nil, disable message logging. If t, log messages but don't truncate
23912 the buffer when it becomes large. */);
23913 Vmessage_log_max
= make_number (50);
23915 DEFVAR_LISP ("window-size-change-functions", &Vwindow_size_change_functions
,
23916 doc
: /* Functions called before redisplay, if window sizes have changed.
23917 The value should be a list of functions that take one argument.
23918 Just before redisplay, for each frame, if any of its windows have changed
23919 size since the last redisplay, or have been split or deleted,
23920 all the functions in the list are called, with the frame as argument. */);
23921 Vwindow_size_change_functions
= Qnil
;
23923 DEFVAR_LISP ("window-scroll-functions", &Vwindow_scroll_functions
,
23924 doc
: /* List of functions to call before redisplaying a window with scrolling.
23925 Each function is called with two arguments, the window
23926 and its new display-start position. Note that the value of `window-end'
23927 is not valid when these functions are called. */);
23928 Vwindow_scroll_functions
= Qnil
;
23930 DEFVAR_LISP ("redisplay-end-trigger-functions", &Vredisplay_end_trigger_functions
,
23931 doc
: /* Functions called when redisplay of a window reaches the end trigger.
23932 Each function is called with two arguments, the window and the end trigger value.
23933 See `set-window-redisplay-end-trigger'. */);
23934 Vredisplay_end_trigger_functions
= Qnil
;
23936 DEFVAR_BOOL ("mouse-autoselect-window", &mouse_autoselect_window
,
23937 doc
: /* *Non-nil means autoselect window with mouse pointer. */);
23938 mouse_autoselect_window
= 0;
23940 DEFVAR_BOOL ("auto-resize-tool-bars", &auto_resize_tool_bars_p
,
23941 doc
: /* *Non-nil means automatically resize tool-bars.
23942 This increases a tool-bar's height if not all tool-bar items are visible.
23943 It decreases a tool-bar's height when it would display blank lines
23945 auto_resize_tool_bars_p
= 1;
23947 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", &auto_raise_tool_bar_buttons_p
,
23948 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
23949 auto_raise_tool_bar_buttons_p
= 1;
23951 DEFVAR_BOOL ("make-cursor-line-fully-visible", &make_cursor_line_fully_visible_p
,
23952 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
23953 make_cursor_line_fully_visible_p
= 1;
23955 DEFVAR_LISP ("tool-bar-border", &Vtool_bar_border
,
23956 doc
: /* *Border below tool-bar in pixels.
23957 If an integer, use it as the height of the border.
23958 If it is one of `internal-border-width' or `border-width', use the
23959 value of the corresponding frame parameter.
23960 Otherwise, no border is added below the tool-bar. */);
23961 Vtool_bar_border
= Qinternal_border_width
;
23963 DEFVAR_LISP ("tool-bar-button-margin", &Vtool_bar_button_margin
,
23964 doc
: /* *Margin around tool-bar buttons in pixels.
23965 If an integer, use that for both horizontal and vertical margins.
23966 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
23967 HORZ specifying the horizontal margin, and VERT specifying the
23968 vertical margin. */);
23969 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
23971 DEFVAR_INT ("tool-bar-button-relief", &tool_bar_button_relief
,
23972 doc
: /* *Relief thickness of tool-bar buttons. */);
23973 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
23975 DEFVAR_LISP ("fontification-functions", &Vfontification_functions
,
23976 doc
: /* List of functions to call to fontify regions of text.
23977 Each function is called with one argument POS. Functions must
23978 fontify a region starting at POS in the current buffer, and give
23979 fontified regions the property `fontified'. */);
23980 Vfontification_functions
= Qnil
;
23981 Fmake_variable_buffer_local (Qfontification_functions
);
23983 DEFVAR_BOOL ("unibyte-display-via-language-environment",
23984 &unibyte_display_via_language_environment
,
23985 doc
: /* *Non-nil means display unibyte text according to language environment.
23986 Specifically this means that unibyte non-ASCII characters
23987 are displayed by converting them to the equivalent multibyte characters
23988 according to the current language environment. As a result, they are
23989 displayed according to the current fontset. */);
23990 unibyte_display_via_language_environment
= 0;
23992 DEFVAR_LISP ("max-mini-window-height", &Vmax_mini_window_height
,
23993 doc
: /* *Maximum height for resizing mini-windows.
23994 If a float, it specifies a fraction of the mini-window frame's height.
23995 If an integer, it specifies a number of lines. */);
23996 Vmax_mini_window_height
= make_float (0.25);
23998 DEFVAR_LISP ("resize-mini-windows", &Vresize_mini_windows
,
23999 doc
: /* *How to resize mini-windows.
24000 A value of nil means don't automatically resize mini-windows.
24001 A value of t means resize them to fit the text displayed in them.
24002 A value of `grow-only', the default, means let mini-windows grow
24003 only, until their display becomes empty, at which point the windows
24004 go back to their normal size. */);
24005 Vresize_mini_windows
= Qgrow_only
;
24007 DEFVAR_LISP ("blink-cursor-alist", &Vblink_cursor_alist
,
24008 doc
: /* Alist specifying how to blink the cursor off.
24009 Each element has the form (ON-STATE . OFF-STATE). Whenever the
24010 `cursor-type' frame-parameter or variable equals ON-STATE,
24011 comparing using `equal', Emacs uses OFF-STATE to specify
24012 how to blink it off. ON-STATE and OFF-STATE are values for
24013 the `cursor-type' frame parameter.
24015 If a frame's ON-STATE has no entry in this list,
24016 the frame's other specifications determine how to blink the cursor off. */);
24017 Vblink_cursor_alist
= Qnil
;
24019 DEFVAR_BOOL ("auto-hscroll-mode", &automatic_hscrolling_p
,
24020 doc
: /* *Non-nil means scroll the display automatically to make point visible. */);
24021 automatic_hscrolling_p
= 1;
24023 DEFVAR_INT ("hscroll-margin", &hscroll_margin
,
24024 doc
: /* *How many columns away from the window edge point is allowed to get
24025 before automatic hscrolling will horizontally scroll the window. */);
24026 hscroll_margin
= 5;
24028 DEFVAR_LISP ("hscroll-step", &Vhscroll_step
,
24029 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
24030 When point is less than `hscroll-margin' columns from the window
24031 edge, automatic hscrolling will scroll the window by the amount of columns
24032 determined by this variable. If its value is a positive integer, scroll that
24033 many columns. If it's a positive floating-point number, it specifies the
24034 fraction of the window's width to scroll. If it's nil or zero, point will be
24035 centered horizontally after the scroll. Any other value, including negative
24036 numbers, are treated as if the value were zero.
24038 Automatic hscrolling always moves point outside the scroll margin, so if
24039 point was more than scroll step columns inside the margin, the window will
24040 scroll more than the value given by the scroll step.
24042 Note that the lower bound for automatic hscrolling specified by `scroll-left'
24043 and `scroll-right' overrides this variable's effect. */);
24044 Vhscroll_step
= make_number (0);
24046 DEFVAR_BOOL ("message-truncate-lines", &message_truncate_lines
,
24047 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
24048 Bind this around calls to `message' to let it take effect. */);
24049 message_truncate_lines
= 0;
24051 DEFVAR_LISP ("menu-bar-update-hook", &Vmenu_bar_update_hook
,
24052 doc
: /* Normal hook run to update the menu bar definitions.
24053 Redisplay runs this hook before it redisplays the menu bar.
24054 This is used to update submenus such as Buffers,
24055 whose contents depend on various data. */);
24056 Vmenu_bar_update_hook
= Qnil
;
24058 DEFVAR_BOOL ("inhibit-menubar-update", &inhibit_menubar_update
,
24059 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
24060 inhibit_menubar_update
= 0;
24062 DEFVAR_BOOL ("inhibit-eval-during-redisplay", &inhibit_eval_during_redisplay
,
24063 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
24064 inhibit_eval_during_redisplay
= 0;
24066 DEFVAR_BOOL ("inhibit-free-realized-faces", &inhibit_free_realized_faces
,
24067 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
24068 inhibit_free_realized_faces
= 0;
24071 DEFVAR_BOOL ("inhibit-try-window-id", &inhibit_try_window_id
,
24072 doc
: /* Inhibit try_window_id display optimization. */);
24073 inhibit_try_window_id
= 0;
24075 DEFVAR_BOOL ("inhibit-try-window-reusing", &inhibit_try_window_reusing
,
24076 doc
: /* Inhibit try_window_reusing display optimization. */);
24077 inhibit_try_window_reusing
= 0;
24079 DEFVAR_BOOL ("inhibit-try-cursor-movement", &inhibit_try_cursor_movement
,
24080 doc
: /* Inhibit try_cursor_movement display optimization. */);
24081 inhibit_try_cursor_movement
= 0;
24082 #endif /* GLYPH_DEBUG */
24086 /* Initialize this module when Emacs starts. */
24091 Lisp_Object root_window
;
24092 struct window
*mini_w
;
24094 current_header_line_height
= current_mode_line_height
= -1;
24096 CHARPOS (this_line_start_pos
) = 0;
24098 mini_w
= XWINDOW (minibuf_window
);
24099 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
24101 if (!noninteractive
)
24103 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
24106 XWINDOW (root_window
)->top_line
= make_number (FRAME_TOP_MARGIN (f
));
24107 set_window_height (root_window
,
24108 FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
),
24110 mini_w
->top_line
= make_number (FRAME_LINES (f
) - 1);
24111 set_window_height (minibuf_window
, 1, 0);
24113 XWINDOW (root_window
)->total_cols
= make_number (FRAME_COLS (f
));
24114 mini_w
->total_cols
= make_number (FRAME_COLS (f
));
24116 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
24117 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
24118 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
24120 /* The default ellipsis glyphs `...'. */
24121 for (i
= 0; i
< 3; ++i
)
24122 default_invis_vector
[i
] = make_number ('.');
24126 /* Allocate the buffer for frame titles.
24127 Also used for `format-mode-line'. */
24129 mode_line_noprop_buf
= (char *) xmalloc (size
);
24130 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
24131 mode_line_noprop_ptr
= mode_line_noprop_buf
;
24132 mode_line_target
= MODE_LINE_DISPLAY
;
24135 help_echo_showing_p
= 0;
24139 /* arch-tag: eacc864d-bb6a-4b74-894a-1a4399a1358b
24140 (do not change this comment) */