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
;
4492 it
->method
= GET_FROM_COMPOSITION
;
4494 it
->cmp_len
= COMPOSITION_LENGTH (prop
);
4495 /* For a terminal, draw only the first character of the
4497 it
->c
= COMPOSITION_GLYPH (composition_table
[id
], 0);
4498 it
->len
= (STRINGP (it
->string
)
4499 ? string_char_to_byte (it
->string
, end
)
4500 : CHAR_TO_BYTE (end
)) - pos_byte
;
4501 it
->stop_charpos
= end
;
4502 handled
= HANDLED_RETURN
;
4511 /***********************************************************************
4513 ***********************************************************************/
4515 /* The following structure is used to record overlay strings for
4516 later sorting in load_overlay_strings. */
4518 struct overlay_entry
4520 Lisp_Object overlay
;
4527 /* Set up iterator IT from overlay strings at its current position.
4528 Called from handle_stop. */
4530 static enum prop_handled
4531 handle_overlay_change (it
)
4534 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
4535 return HANDLED_RECOMPUTE_PROPS
;
4537 return HANDLED_NORMALLY
;
4541 /* Set up the next overlay string for delivery by IT, if there is an
4542 overlay string to deliver. Called by set_iterator_to_next when the
4543 end of the current overlay string is reached. If there are more
4544 overlay strings to display, IT->string and
4545 IT->current.overlay_string_index are set appropriately here.
4546 Otherwise IT->string is set to nil. */
4549 next_overlay_string (it
)
4552 ++it
->current
.overlay_string_index
;
4553 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
4555 /* No more overlay strings. Restore IT's settings to what
4556 they were before overlay strings were processed, and
4557 continue to deliver from current_buffer. */
4558 int display_ellipsis_p
= it
->stack
[it
->sp
- 1].display_ellipsis_p
;
4562 || it
->method
== GET_FROM_COMPOSITION
4563 || (NILP (it
->string
)
4564 && it
->method
== GET_FROM_BUFFER
4565 && it
->stop_charpos
>= BEGV
4566 && it
->stop_charpos
<= it
->end_charpos
));
4567 it
->current
.overlay_string_index
= -1;
4568 it
->n_overlay_strings
= 0;
4570 /* If we're at the end of the buffer, record that we have
4571 processed the overlay strings there already, so that
4572 next_element_from_buffer doesn't try it again. */
4573 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
4574 it
->overlay_strings_at_end_processed_p
= 1;
4576 /* If we have to display `...' for invisible text, set
4577 the iterator up for that. */
4578 if (display_ellipsis_p
)
4579 setup_for_ellipsis (it
, 0);
4583 /* There are more overlay strings to process. If
4584 IT->current.overlay_string_index has advanced to a position
4585 where we must load IT->overlay_strings with more strings, do
4587 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
4589 if (it
->current
.overlay_string_index
&& i
== 0)
4590 load_overlay_strings (it
, 0);
4592 /* Initialize IT to deliver display elements from the overlay
4594 it
->string
= it
->overlay_strings
[i
];
4595 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4596 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
4597 it
->method
= GET_FROM_STRING
;
4598 it
->stop_charpos
= 0;
4605 /* Compare two overlay_entry structures E1 and E2. Used as a
4606 comparison function for qsort in load_overlay_strings. Overlay
4607 strings for the same position are sorted so that
4609 1. All after-strings come in front of before-strings, except
4610 when they come from the same overlay.
4612 2. Within after-strings, strings are sorted so that overlay strings
4613 from overlays with higher priorities come first.
4615 2. Within before-strings, strings are sorted so that overlay
4616 strings from overlays with higher priorities come last.
4618 Value is analogous to strcmp. */
4622 compare_overlay_entries (e1
, e2
)
4625 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
4626 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
4629 if (entry1
->after_string_p
!= entry2
->after_string_p
)
4631 /* Let after-strings appear in front of before-strings if
4632 they come from different overlays. */
4633 if (EQ (entry1
->overlay
, entry2
->overlay
))
4634 result
= entry1
->after_string_p
? 1 : -1;
4636 result
= entry1
->after_string_p
? -1 : 1;
4638 else if (entry1
->after_string_p
)
4639 /* After-strings sorted in order of decreasing priority. */
4640 result
= entry2
->priority
- entry1
->priority
;
4642 /* Before-strings sorted in order of increasing priority. */
4643 result
= entry1
->priority
- entry2
->priority
;
4649 /* Load the vector IT->overlay_strings with overlay strings from IT's
4650 current buffer position, or from CHARPOS if that is > 0. Set
4651 IT->n_overlays to the total number of overlay strings found.
4653 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
4654 a time. On entry into load_overlay_strings,
4655 IT->current.overlay_string_index gives the number of overlay
4656 strings that have already been loaded by previous calls to this
4659 IT->add_overlay_start contains an additional overlay start
4660 position to consider for taking overlay strings from, if non-zero.
4661 This position comes into play when the overlay has an `invisible'
4662 property, and both before and after-strings. When we've skipped to
4663 the end of the overlay, because of its `invisible' property, we
4664 nevertheless want its before-string to appear.
4665 IT->add_overlay_start will contain the overlay start position
4668 Overlay strings are sorted so that after-string strings come in
4669 front of before-string strings. Within before and after-strings,
4670 strings are sorted by overlay priority. See also function
4671 compare_overlay_entries. */
4674 load_overlay_strings (it
, charpos
)
4678 extern Lisp_Object Qafter_string
, Qbefore_string
, Qwindow
, Qpriority
;
4679 Lisp_Object overlay
, window
, str
, invisible
;
4680 struct Lisp_Overlay
*ov
;
4683 int n
= 0, i
, j
, invis_p
;
4684 struct overlay_entry
*entries
4685 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
4688 charpos
= IT_CHARPOS (*it
);
4690 /* Append the overlay string STRING of overlay OVERLAY to vector
4691 `entries' which has size `size' and currently contains `n'
4692 elements. AFTER_P non-zero means STRING is an after-string of
4694 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
4697 Lisp_Object priority; \
4701 int new_size = 2 * size; \
4702 struct overlay_entry *old = entries; \
4704 (struct overlay_entry *) alloca (new_size \
4705 * sizeof *entries); \
4706 bcopy (old, entries, size * sizeof *entries); \
4710 entries[n].string = (STRING); \
4711 entries[n].overlay = (OVERLAY); \
4712 priority = Foverlay_get ((OVERLAY), Qpriority); \
4713 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
4714 entries[n].after_string_p = (AFTER_P); \
4719 /* Process overlay before the overlay center. */
4720 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
4722 XSETMISC (overlay
, ov
);
4723 xassert (OVERLAYP (overlay
));
4724 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4725 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4730 /* Skip this overlay if it doesn't start or end at IT's current
4732 if (end
!= charpos
&& start
!= charpos
)
4735 /* Skip this overlay if it doesn't apply to IT->w. */
4736 window
= Foverlay_get (overlay
, Qwindow
);
4737 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4740 /* If the text ``under'' the overlay is invisible, both before-
4741 and after-strings from this overlay are visible; start and
4742 end position are indistinguishable. */
4743 invisible
= Foverlay_get (overlay
, Qinvisible
);
4744 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4746 /* If overlay has a non-empty before-string, record it. */
4747 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4748 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4750 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4752 /* If overlay has a non-empty after-string, record it. */
4753 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4754 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4756 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4759 /* Process overlays after the overlay center. */
4760 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
4762 XSETMISC (overlay
, ov
);
4763 xassert (OVERLAYP (overlay
));
4764 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4765 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4767 if (start
> charpos
)
4770 /* Skip this overlay if it doesn't start or end at IT's current
4772 if (end
!= charpos
&& start
!= charpos
)
4775 /* Skip this overlay if it doesn't apply to IT->w. */
4776 window
= Foverlay_get (overlay
, Qwindow
);
4777 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4780 /* If the text ``under'' the overlay is invisible, it has a zero
4781 dimension, and both before- and after-strings apply. */
4782 invisible
= Foverlay_get (overlay
, Qinvisible
);
4783 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4785 /* If overlay has a non-empty before-string, record it. */
4786 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4787 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4789 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4791 /* If overlay has a non-empty after-string, record it. */
4792 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4793 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4795 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4798 #undef RECORD_OVERLAY_STRING
4802 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
4804 /* Record the total number of strings to process. */
4805 it
->n_overlay_strings
= n
;
4807 /* IT->current.overlay_string_index is the number of overlay strings
4808 that have already been consumed by IT. Copy some of the
4809 remaining overlay strings to IT->overlay_strings. */
4811 j
= it
->current
.overlay_string_index
;
4812 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
4813 it
->overlay_strings
[i
++] = entries
[j
++].string
;
4819 /* Get the first chunk of overlay strings at IT's current buffer
4820 position, or at CHARPOS if that is > 0. Value is non-zero if at
4821 least one overlay string was found. */
4824 get_overlay_strings_1 (it
, charpos
, compute_stop_p
)
4828 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
4829 process. This fills IT->overlay_strings with strings, and sets
4830 IT->n_overlay_strings to the total number of strings to process.
4831 IT->pos.overlay_string_index has to be set temporarily to zero
4832 because load_overlay_strings needs this; it must be set to -1
4833 when no overlay strings are found because a zero value would
4834 indicate a position in the first overlay string. */
4835 it
->current
.overlay_string_index
= 0;
4836 load_overlay_strings (it
, charpos
);
4838 /* If we found overlay strings, set up IT to deliver display
4839 elements from the first one. Otherwise set up IT to deliver
4840 from current_buffer. */
4841 if (it
->n_overlay_strings
)
4843 /* Make sure we know settings in current_buffer, so that we can
4844 restore meaningful values when we're done with the overlay
4847 compute_stop_pos (it
);
4848 xassert (it
->face_id
>= 0);
4850 /* Save IT's settings. They are restored after all overlay
4851 strings have been processed. */
4852 xassert (!compute_stop_p
|| it
->sp
== 0);
4855 /* Set up IT to deliver display elements from the first overlay
4857 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4858 it
->string
= it
->overlay_strings
[0];
4859 it
->stop_charpos
= 0;
4860 xassert (STRINGP (it
->string
));
4861 it
->end_charpos
= SCHARS (it
->string
);
4862 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4863 it
->method
= GET_FROM_STRING
;
4867 it
->current
.overlay_string_index
= -1;
4872 get_overlay_strings (it
, charpos
)
4877 it
->method
= GET_FROM_BUFFER
;
4879 (void) get_overlay_strings_1 (it
, charpos
, 1);
4883 /* Value is non-zero if we found at least one overlay string. */
4884 return STRINGP (it
->string
);
4889 /***********************************************************************
4890 Saving and restoring state
4891 ***********************************************************************/
4893 /* Save current settings of IT on IT->stack. Called, for example,
4894 before setting up IT for an overlay string, to be able to restore
4895 IT's settings to what they were after the overlay string has been
4902 struct iterator_stack_entry
*p
;
4904 xassert (it
->sp
< IT_STACK_SIZE
);
4905 p
= it
->stack
+ it
->sp
;
4907 p
->stop_charpos
= it
->stop_charpos
;
4908 xassert (it
->face_id
>= 0);
4909 p
->face_id
= it
->face_id
;
4910 p
->string
= it
->string
;
4911 p
->method
= it
->method
;
4914 case GET_FROM_IMAGE
:
4915 p
->u
.image
.object
= it
->object
;
4916 p
->u
.image
.image_id
= it
->image_id
;
4917 p
->u
.image
.slice
= it
->slice
;
4919 case GET_FROM_COMPOSITION
:
4920 p
->u
.comp
.object
= it
->object
;
4921 p
->u
.comp
.c
= it
->c
;
4922 p
->u
.comp
.len
= it
->len
;
4923 p
->u
.comp
.cmp_id
= it
->cmp_id
;
4924 p
->u
.comp
.cmp_len
= it
->cmp_len
;
4926 case GET_FROM_STRETCH
:
4927 p
->u
.stretch
.object
= it
->object
;
4930 p
->position
= it
->position
;
4931 p
->current
= it
->current
;
4932 p
->end_charpos
= it
->end_charpos
;
4933 p
->string_nchars
= it
->string_nchars
;
4935 p
->multibyte_p
= it
->multibyte_p
;
4936 p
->space_width
= it
->space_width
;
4937 p
->font_height
= it
->font_height
;
4938 p
->voffset
= it
->voffset
;
4939 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
4940 p
->display_ellipsis_p
= 0;
4945 /* Restore IT's settings from IT->stack. Called, for example, when no
4946 more overlay strings must be processed, and we return to delivering
4947 display elements from a buffer, or when the end of a string from a
4948 `display' property is reached and we return to delivering display
4949 elements from an overlay string, or from a buffer. */
4955 struct iterator_stack_entry
*p
;
4957 xassert (it
->sp
> 0);
4959 p
= it
->stack
+ it
->sp
;
4960 it
->stop_charpos
= p
->stop_charpos
;
4961 it
->face_id
= p
->face_id
;
4962 it
->current
= p
->current
;
4963 it
->position
= p
->position
;
4964 it
->string
= p
->string
;
4965 if (NILP (it
->string
))
4966 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
4967 it
->method
= p
->method
;
4970 case GET_FROM_IMAGE
:
4971 it
->image_id
= p
->u
.image
.image_id
;
4972 it
->object
= p
->u
.image
.object
;
4973 it
->slice
= p
->u
.image
.slice
;
4975 case GET_FROM_COMPOSITION
:
4976 it
->object
= p
->u
.comp
.object
;
4977 it
->c
= p
->u
.comp
.c
;
4978 it
->len
= p
->u
.comp
.len
;
4979 it
->cmp_id
= p
->u
.comp
.cmp_id
;
4980 it
->cmp_len
= p
->u
.comp
.cmp_len
;
4982 case GET_FROM_STRETCH
:
4983 it
->object
= p
->u
.comp
.object
;
4986 it
->end_charpos
= p
->end_charpos
;
4987 it
->string_nchars
= p
->string_nchars
;
4989 it
->multibyte_p
= p
->multibyte_p
;
4990 it
->space_width
= p
->space_width
;
4991 it
->font_height
= p
->font_height
;
4992 it
->voffset
= p
->voffset
;
4993 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
4998 /***********************************************************************
5000 ***********************************************************************/
5002 /* Set IT's current position to the previous line start. */
5005 back_to_previous_line_start (it
)
5008 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5009 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5013 /* Move IT to the next line start.
5015 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5016 we skipped over part of the text (as opposed to moving the iterator
5017 continuously over the text). Otherwise, don't change the value
5020 Newlines may come from buffer text, overlay strings, or strings
5021 displayed via the `display' property. That's the reason we can't
5022 simply use find_next_newline_no_quit.
5024 Note that this function may not skip over invisible text that is so
5025 because of text properties and immediately follows a newline. If
5026 it would, function reseat_at_next_visible_line_start, when called
5027 from set_iterator_to_next, would effectively make invisible
5028 characters following a newline part of the wrong glyph row, which
5029 leads to wrong cursor motion. */
5032 forward_to_next_line_start (it
, skipped_p
)
5036 int old_selective
, newline_found_p
, n
;
5037 const int MAX_NEWLINE_DISTANCE
= 500;
5039 /* If already on a newline, just consume it to avoid unintended
5040 skipping over invisible text below. */
5041 if (it
->what
== IT_CHARACTER
5043 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5045 set_iterator_to_next (it
, 0);
5050 /* Don't handle selective display in the following. It's (a)
5051 unnecessary because it's done by the caller, and (b) leads to an
5052 infinite recursion because next_element_from_ellipsis indirectly
5053 calls this function. */
5054 old_selective
= it
->selective
;
5057 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5058 from buffer text. */
5059 for (n
= newline_found_p
= 0;
5060 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5061 n
+= STRINGP (it
->string
) ? 0 : 1)
5063 if (!get_next_display_element (it
))
5065 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5066 set_iterator_to_next (it
, 0);
5069 /* If we didn't find a newline near enough, see if we can use a
5071 if (!newline_found_p
)
5073 int start
= IT_CHARPOS (*it
);
5074 int limit
= find_next_newline_no_quit (start
, 1);
5077 xassert (!STRINGP (it
->string
));
5079 /* If there isn't any `display' property in sight, and no
5080 overlays, we can just use the position of the newline in
5082 if (it
->stop_charpos
>= limit
5083 || ((pos
= Fnext_single_property_change (make_number (start
),
5085 Qnil
, make_number (limit
)),
5087 && next_overlay_change (start
) == ZV
))
5089 IT_CHARPOS (*it
) = limit
;
5090 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5091 *skipped_p
= newline_found_p
= 1;
5095 while (get_next_display_element (it
)
5096 && !newline_found_p
)
5098 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5099 set_iterator_to_next (it
, 0);
5104 it
->selective
= old_selective
;
5105 return newline_found_p
;
5109 /* Set IT's current position to the previous visible line start. Skip
5110 invisible text that is so either due to text properties or due to
5111 selective display. Caution: this does not change IT->current_x and
5115 back_to_previous_visible_line_start (it
)
5118 while (IT_CHARPOS (*it
) > BEGV
)
5120 back_to_previous_line_start (it
);
5122 if (IT_CHARPOS (*it
) <= BEGV
)
5125 /* If selective > 0, then lines indented more than that values
5127 if (it
->selective
> 0
5128 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5129 (double) it
->selective
)) /* iftc */
5132 /* Check the newline before point for invisibility. */
5135 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5136 Qinvisible
, it
->window
);
5137 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5141 if (IT_CHARPOS (*it
) <= BEGV
)
5148 Lisp_Object val
, overlay
;
5150 /* If newline is part of a composition, continue from start of composition */
5151 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5152 && beg
< IT_CHARPOS (*it
))
5155 /* If newline is replaced by a display property, find start of overlay
5156 or interval and continue search from that point. */
5158 pos
= --IT_CHARPOS (it2
);
5161 if (handle_display_prop (&it2
) == HANDLED_RETURN
5162 && !NILP (val
= get_char_property_and_overlay
5163 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5164 && (OVERLAYP (overlay
)
5165 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5166 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5169 /* Newline is not replaced by anything -- so we are done. */
5175 IT_CHARPOS (*it
) = beg
;
5176 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5180 it
->continuation_lines_width
= 0;
5182 xassert (IT_CHARPOS (*it
) >= BEGV
);
5183 xassert (IT_CHARPOS (*it
) == BEGV
5184 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5189 /* Reseat iterator IT at the previous visible line start. Skip
5190 invisible text that is so either due to text properties or due to
5191 selective display. At the end, update IT's overlay information,
5192 face information etc. */
5195 reseat_at_previous_visible_line_start (it
)
5198 back_to_previous_visible_line_start (it
);
5199 reseat (it
, it
->current
.pos
, 1);
5204 /* Reseat iterator IT on the next visible line start in the current
5205 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5206 preceding the line start. Skip over invisible text that is so
5207 because of selective display. Compute faces, overlays etc at the
5208 new position. Note that this function does not skip over text that
5209 is invisible because of text properties. */
5212 reseat_at_next_visible_line_start (it
, on_newline_p
)
5216 int newline_found_p
, skipped_p
= 0;
5218 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5220 /* Skip over lines that are invisible because they are indented
5221 more than the value of IT->selective. */
5222 if (it
->selective
> 0)
5223 while (IT_CHARPOS (*it
) < ZV
5224 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5225 (double) it
->selective
)) /* iftc */
5227 xassert (IT_BYTEPOS (*it
) == BEGV
5228 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5229 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5232 /* Position on the newline if that's what's requested. */
5233 if (on_newline_p
&& newline_found_p
)
5235 if (STRINGP (it
->string
))
5237 if (IT_STRING_CHARPOS (*it
) > 0)
5239 --IT_STRING_CHARPOS (*it
);
5240 --IT_STRING_BYTEPOS (*it
);
5243 else if (IT_CHARPOS (*it
) > BEGV
)
5247 reseat (it
, it
->current
.pos
, 0);
5251 reseat (it
, it
->current
.pos
, 0);
5258 /***********************************************************************
5259 Changing an iterator's position
5260 ***********************************************************************/
5262 /* Change IT's current position to POS in current_buffer. If FORCE_P
5263 is non-zero, always check for text properties at the new position.
5264 Otherwise, text properties are only looked up if POS >=
5265 IT->check_charpos of a property. */
5268 reseat (it
, pos
, force_p
)
5270 struct text_pos pos
;
5273 int original_pos
= IT_CHARPOS (*it
);
5275 reseat_1 (it
, pos
, 0);
5277 /* Determine where to check text properties. Avoid doing it
5278 where possible because text property lookup is very expensive. */
5280 || CHARPOS (pos
) > it
->stop_charpos
5281 || CHARPOS (pos
) < original_pos
)
5288 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
5289 IT->stop_pos to POS, also. */
5292 reseat_1 (it
, pos
, set_stop_p
)
5294 struct text_pos pos
;
5297 /* Don't call this function when scanning a C string. */
5298 xassert (it
->s
== NULL
);
5300 /* POS must be a reasonable value. */
5301 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
5303 it
->current
.pos
= it
->position
= pos
;
5304 XSETBUFFER (it
->object
, current_buffer
);
5305 it
->end_charpos
= ZV
;
5307 it
->current
.dpvec_index
= -1;
5308 it
->current
.overlay_string_index
= -1;
5309 IT_STRING_CHARPOS (*it
) = -1;
5310 IT_STRING_BYTEPOS (*it
) = -1;
5312 it
->method
= GET_FROM_BUFFER
;
5313 it
->object
= it
->w
->buffer
;
5314 it
->area
= TEXT_AREA
;
5315 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
5317 it
->string_from_display_prop_p
= 0;
5318 it
->face_before_selective_p
= 0;
5321 it
->stop_charpos
= CHARPOS (pos
);
5325 /* Set up IT for displaying a string, starting at CHARPOS in window W.
5326 If S is non-null, it is a C string to iterate over. Otherwise,
5327 STRING gives a Lisp string to iterate over.
5329 If PRECISION > 0, don't return more then PRECISION number of
5330 characters from the string.
5332 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
5333 characters have been returned. FIELD_WIDTH < 0 means an infinite
5336 MULTIBYTE = 0 means disable processing of multibyte characters,
5337 MULTIBYTE > 0 means enable it,
5338 MULTIBYTE < 0 means use IT->multibyte_p.
5340 IT must be initialized via a prior call to init_iterator before
5341 calling this function. */
5344 reseat_to_string (it
, s
, string
, charpos
, precision
, field_width
, multibyte
)
5349 int precision
, field_width
, multibyte
;
5351 /* No region in strings. */
5352 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
5354 /* No text property checks performed by default, but see below. */
5355 it
->stop_charpos
= -1;
5357 /* Set iterator position and end position. */
5358 bzero (&it
->current
, sizeof it
->current
);
5359 it
->current
.overlay_string_index
= -1;
5360 it
->current
.dpvec_index
= -1;
5361 xassert (charpos
>= 0);
5363 /* If STRING is specified, use its multibyteness, otherwise use the
5364 setting of MULTIBYTE, if specified. */
5366 it
->multibyte_p
= multibyte
> 0;
5370 xassert (STRINGP (string
));
5371 it
->string
= string
;
5373 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
5374 it
->method
= GET_FROM_STRING
;
5375 it
->current
.string_pos
= string_pos (charpos
, string
);
5382 /* Note that we use IT->current.pos, not it->current.string_pos,
5383 for displaying C strings. */
5384 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
5385 if (it
->multibyte_p
)
5387 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
5388 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
5392 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
5393 it
->end_charpos
= it
->string_nchars
= strlen (s
);
5396 it
->method
= GET_FROM_C_STRING
;
5399 /* PRECISION > 0 means don't return more than PRECISION characters
5401 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
5402 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
5404 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
5405 characters have been returned. FIELD_WIDTH == 0 means don't pad,
5406 FIELD_WIDTH < 0 means infinite field width. This is useful for
5407 padding with `-' at the end of a mode line. */
5408 if (field_width
< 0)
5409 field_width
= INFINITY
;
5410 if (field_width
> it
->end_charpos
- charpos
)
5411 it
->end_charpos
= charpos
+ field_width
;
5413 /* Use the standard display table for displaying strings. */
5414 if (DISP_TABLE_P (Vstandard_display_table
))
5415 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
5417 it
->stop_charpos
= charpos
;
5423 /***********************************************************************
5425 ***********************************************************************/
5427 /* Map enum it_method value to corresponding next_element_from_* function. */
5429 static int (* get_next_element
[NUM_IT_METHODS
]) P_ ((struct it
*it
)) =
5431 next_element_from_buffer
,
5432 next_element_from_display_vector
,
5433 next_element_from_composition
,
5434 next_element_from_string
,
5435 next_element_from_c_string
,
5436 next_element_from_image
,
5437 next_element_from_stretch
5441 /* Load IT's display element fields with information about the next
5442 display element from the current position of IT. Value is zero if
5443 end of buffer (or C string) is reached. */
5445 static struct frame
*last_escape_glyph_frame
= NULL
;
5446 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
5447 static int last_escape_glyph_merged_face_id
= 0;
5450 get_next_display_element (it
)
5453 /* Non-zero means that we found a display element. Zero means that
5454 we hit the end of what we iterate over. Performance note: the
5455 function pointer `method' used here turns out to be faster than
5456 using a sequence of if-statements. */
5460 success_p
= (*get_next_element
[it
->method
]) (it
);
5462 if (it
->what
== IT_CHARACTER
)
5464 /* Map via display table or translate control characters.
5465 IT->c, IT->len etc. have been set to the next character by
5466 the function call above. If we have a display table, and it
5467 contains an entry for IT->c, translate it. Don't do this if
5468 IT->c itself comes from a display table, otherwise we could
5469 end up in an infinite recursion. (An alternative could be to
5470 count the recursion depth of this function and signal an
5471 error when a certain maximum depth is reached.) Is it worth
5473 if (success_p
&& it
->dpvec
== NULL
)
5478 && (dv
= DISP_CHAR_VECTOR (it
->dp
, it
->c
),
5481 struct Lisp_Vector
*v
= XVECTOR (dv
);
5483 /* Return the first character from the display table
5484 entry, if not empty. If empty, don't display the
5485 current character. */
5488 it
->dpvec_char_len
= it
->len
;
5489 it
->dpvec
= v
->contents
;
5490 it
->dpend
= v
->contents
+ v
->size
;
5491 it
->current
.dpvec_index
= 0;
5492 it
->dpvec_face_id
= -1;
5493 it
->saved_face_id
= it
->face_id
;
5494 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5499 set_iterator_to_next (it
, 0);
5504 /* Translate control characters into `\003' or `^C' form.
5505 Control characters coming from a display table entry are
5506 currently not translated because we use IT->dpvec to hold
5507 the translation. This could easily be changed but I
5508 don't believe that it is worth doing.
5510 If it->multibyte_p is nonzero, eight-bit characters and
5511 non-printable multibyte characters are also translated to
5514 If it->multibyte_p is zero, eight-bit characters that
5515 don't have corresponding multibyte char code are also
5516 translated to octal form. */
5517 else if ((it
->c
< ' '
5518 && (it
->area
!= TEXT_AREA
5519 /* In mode line, treat \n like other crl chars. */
5521 && it
->glyph_row
&& it
->glyph_row
->mode_line_p
)
5522 || (it
->c
!= '\n' && it
->c
!= '\t')))
5526 || !CHAR_PRINTABLE_P (it
->c
)
5527 || (!NILP (Vnobreak_char_display
)
5528 && (it
->c
== 0x8a0 || it
->c
== 0x8ad
5529 || it
->c
== 0x920 || it
->c
== 0x92d
5530 || it
->c
== 0xe20 || it
->c
== 0xe2d
5531 || it
->c
== 0xf20 || it
->c
== 0xf2d)))
5533 && (!unibyte_display_via_language_environment
5534 || it
->c
== unibyte_char_to_multibyte (it
->c
)))))
5536 /* IT->c is a control character which must be displayed
5537 either as '\003' or as `^C' where the '\\' and '^'
5538 can be defined in the display table. Fill
5539 IT->ctl_chars with glyphs for what we have to
5540 display. Then, set IT->dpvec to these glyphs. */
5543 int face_id
, lface_id
= 0 ;
5546 /* Handle control characters with ^. */
5548 if (it
->c
< 128 && it
->ctl_arrow_p
)
5550 g
= '^'; /* default glyph for Control */
5551 /* Set IT->ctl_chars[0] to the glyph for `^'. */
5553 && INTEGERP (DISP_CTRL_GLYPH (it
->dp
))
5554 && GLYPH_CHAR_VALID_P (XINT (DISP_CTRL_GLYPH (it
->dp
))))
5556 g
= XINT (DISP_CTRL_GLYPH (it
->dp
));
5557 lface_id
= FAST_GLYPH_FACE (g
);
5561 g
= FAST_GLYPH_CHAR (g
);
5562 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
5565 else if (it
->f
== last_escape_glyph_frame
5566 && it
->face_id
== last_escape_glyph_face_id
)
5568 face_id
= last_escape_glyph_merged_face_id
;
5572 /* Merge the escape-glyph face into the current face. */
5573 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5575 last_escape_glyph_frame
= it
->f
;
5576 last_escape_glyph_face_id
= it
->face_id
;
5577 last_escape_glyph_merged_face_id
= face_id
;
5580 XSETINT (it
->ctl_chars
[0], g
);
5582 XSETINT (it
->ctl_chars
[1], g
);
5584 goto display_control
;
5587 /* Handle non-break space in the mode where it only gets
5590 if (EQ (Vnobreak_char_display
, Qt
)
5591 && (it
->c
== 0x8a0 || it
->c
== 0x920
5592 || it
->c
== 0xe20 || it
->c
== 0xf20))
5594 /* Merge the no-break-space face into the current face. */
5595 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
5599 XSETINT (it
->ctl_chars
[0], g
);
5601 goto display_control
;
5604 /* Handle sequences that start with the "escape glyph". */
5606 /* the default escape glyph is \. */
5607 escape_glyph
= '\\';
5610 && INTEGERP (DISP_ESCAPE_GLYPH (it
->dp
))
5611 && GLYPH_CHAR_VALID_P (XFASTINT (DISP_ESCAPE_GLYPH (it
->dp
))))
5613 escape_glyph
= XFASTINT (DISP_ESCAPE_GLYPH (it
->dp
));
5614 lface_id
= FAST_GLYPH_FACE (escape_glyph
);
5618 /* The display table specified a face.
5619 Merge it into face_id and also into escape_glyph. */
5620 escape_glyph
= FAST_GLYPH_CHAR (escape_glyph
);
5621 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
5624 else if (it
->f
== last_escape_glyph_frame
5625 && it
->face_id
== last_escape_glyph_face_id
)
5627 face_id
= last_escape_glyph_merged_face_id
;
5631 /* Merge the escape-glyph face into the current face. */
5632 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5634 last_escape_glyph_frame
= it
->f
;
5635 last_escape_glyph_face_id
= it
->face_id
;
5636 last_escape_glyph_merged_face_id
= face_id
;
5639 /* Handle soft hyphens in the mode where they only get
5642 if (EQ (Vnobreak_char_display
, Qt
)
5643 && (it
->c
== 0x8ad || it
->c
== 0x92d
5644 || it
->c
== 0xe2d || it
->c
== 0xf2d))
5647 XSETINT (it
->ctl_chars
[0], g
);
5649 goto display_control
;
5652 /* Handle non-break space and soft hyphen
5653 with the escape glyph. */
5655 if (it
->c
== 0x8a0 || it
->c
== 0x8ad
5656 || it
->c
== 0x920 || it
->c
== 0x92d
5657 || it
->c
== 0xe20 || it
->c
== 0xe2d
5658 || it
->c
== 0xf20 || it
->c
== 0xf2d)
5660 XSETINT (it
->ctl_chars
[0], escape_glyph
);
5661 g
= it
->c
= ((it
->c
& 0xf) == 0 ? ' ' : '-');
5662 XSETINT (it
->ctl_chars
[1], g
);
5664 goto display_control
;
5668 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
5672 /* Set IT->ctl_chars[0] to the glyph for `\\'. */
5673 if (SINGLE_BYTE_CHAR_P (it
->c
))
5674 str
[0] = it
->c
, len
= 1;
5677 len
= CHAR_STRING_NO_SIGNAL (it
->c
, str
);
5680 /* It's an invalid character, which shouldn't
5681 happen actually, but due to bugs it may
5682 happen. Let's print the char as is, there's
5683 not much meaningful we can do with it. */
5685 str
[1] = it
->c
>> 8;
5686 str
[2] = it
->c
>> 16;
5687 str
[3] = it
->c
>> 24;
5692 for (i
= 0; i
< len
; i
++)
5694 XSETINT (it
->ctl_chars
[i
* 4], escape_glyph
);
5695 /* Insert three more glyphs into IT->ctl_chars for
5696 the octal display of the character. */
5697 g
= ((str
[i
] >> 6) & 7) + '0';
5698 XSETINT (it
->ctl_chars
[i
* 4 + 1], g
);
5699 g
= ((str
[i
] >> 3) & 7) + '0';
5700 XSETINT (it
->ctl_chars
[i
* 4 + 2], g
);
5701 g
= (str
[i
] & 7) + '0';
5702 XSETINT (it
->ctl_chars
[i
* 4 + 3], g
);
5708 /* Set up IT->dpvec and return first character from it. */
5709 it
->dpvec_char_len
= it
->len
;
5710 it
->dpvec
= it
->ctl_chars
;
5711 it
->dpend
= it
->dpvec
+ ctl_len
;
5712 it
->current
.dpvec_index
= 0;
5713 it
->dpvec_face_id
= face_id
;
5714 it
->saved_face_id
= it
->face_id
;
5715 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5721 /* Adjust face id for a multibyte character. There are no
5722 multibyte character in unibyte text. */
5725 && FRAME_WINDOW_P (it
->f
))
5727 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
5728 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->c
);
5732 /* Is this character the last one of a run of characters with
5733 box? If yes, set IT->end_of_box_run_p to 1. */
5740 it
->end_of_box_run_p
5741 = ((face_id
= face_after_it_pos (it
),
5742 face_id
!= it
->face_id
)
5743 && (face
= FACE_FROM_ID (it
->f
, face_id
),
5744 face
->box
== FACE_NO_BOX
));
5747 /* Value is 0 if end of buffer or string reached. */
5752 /* Move IT to the next display element.
5754 RESEAT_P non-zero means if called on a newline in buffer text,
5755 skip to the next visible line start.
5757 Functions get_next_display_element and set_iterator_to_next are
5758 separate because I find this arrangement easier to handle than a
5759 get_next_display_element function that also increments IT's
5760 position. The way it is we can first look at an iterator's current
5761 display element, decide whether it fits on a line, and if it does,
5762 increment the iterator position. The other way around we probably
5763 would either need a flag indicating whether the iterator has to be
5764 incremented the next time, or we would have to implement a
5765 decrement position function which would not be easy to write. */
5768 set_iterator_to_next (it
, reseat_p
)
5772 /* Reset flags indicating start and end of a sequence of characters
5773 with box. Reset them at the start of this function because
5774 moving the iterator to a new position might set them. */
5775 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
5779 case GET_FROM_BUFFER
:
5780 /* The current display element of IT is a character from
5781 current_buffer. Advance in the buffer, and maybe skip over
5782 invisible lines that are so because of selective display. */
5783 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
5784 reseat_at_next_visible_line_start (it
, 0);
5787 xassert (it
->len
!= 0);
5788 IT_BYTEPOS (*it
) += it
->len
;
5789 IT_CHARPOS (*it
) += 1;
5790 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
5794 case GET_FROM_COMPOSITION
:
5795 xassert (it
->cmp_id
>= 0 && it
->cmp_id
< n_compositions
);
5796 xassert (it
->sp
> 0);
5798 if (it
->method
== GET_FROM_STRING
)
5800 IT_STRING_BYTEPOS (*it
) += it
->len
;
5801 IT_STRING_CHARPOS (*it
) += it
->cmp_len
;
5802 it
->object
= it
->string
;
5803 goto consider_string_end
;
5805 else if (it
->method
== GET_FROM_BUFFER
)
5807 IT_BYTEPOS (*it
) += it
->len
;
5808 IT_CHARPOS (*it
) += it
->cmp_len
;
5809 it
->object
= it
->w
->buffer
;
5813 case GET_FROM_C_STRING
:
5814 /* Current display element of IT is from a C string. */
5815 IT_BYTEPOS (*it
) += it
->len
;
5816 IT_CHARPOS (*it
) += 1;
5819 case GET_FROM_DISPLAY_VECTOR
:
5820 /* Current display element of IT is from a display table entry.
5821 Advance in the display table definition. Reset it to null if
5822 end reached, and continue with characters from buffers/
5824 ++it
->current
.dpvec_index
;
5826 /* Restore face of the iterator to what they were before the
5827 display vector entry (these entries may contain faces). */
5828 it
->face_id
= it
->saved_face_id
;
5830 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
5832 int recheck_faces
= it
->ellipsis_p
;
5835 it
->method
= GET_FROM_C_STRING
;
5836 else if (STRINGP (it
->string
))
5837 it
->method
= GET_FROM_STRING
;
5840 it
->method
= GET_FROM_BUFFER
;
5841 it
->object
= it
->w
->buffer
;
5845 it
->current
.dpvec_index
= -1;
5847 /* Skip over characters which were displayed via IT->dpvec. */
5848 if (it
->dpvec_char_len
< 0)
5849 reseat_at_next_visible_line_start (it
, 1);
5850 else if (it
->dpvec_char_len
> 0)
5852 if (it
->method
== GET_FROM_STRING
5853 && it
->n_overlay_strings
> 0)
5854 it
->ignore_overlay_strings_at_pos_p
= 1;
5855 it
->len
= it
->dpvec_char_len
;
5856 set_iterator_to_next (it
, reseat_p
);
5859 /* Maybe recheck faces after display vector */
5861 it
->stop_charpos
= IT_CHARPOS (*it
);
5865 case GET_FROM_STRING
:
5866 /* Current display element is a character from a Lisp string. */
5867 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
5868 IT_STRING_BYTEPOS (*it
) += it
->len
;
5869 IT_STRING_CHARPOS (*it
) += 1;
5871 consider_string_end
:
5873 if (it
->current
.overlay_string_index
>= 0)
5875 /* IT->string is an overlay string. Advance to the
5876 next, if there is one. */
5877 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
5878 next_overlay_string (it
);
5882 /* IT->string is not an overlay string. If we reached
5883 its end, and there is something on IT->stack, proceed
5884 with what is on the stack. This can be either another
5885 string, this time an overlay string, or a buffer. */
5886 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
5890 if (it
->method
== GET_FROM_STRING
)
5891 goto consider_string_end
;
5896 case GET_FROM_IMAGE
:
5897 case GET_FROM_STRETCH
:
5898 /* The position etc with which we have to proceed are on
5899 the stack. The position may be at the end of a string,
5900 if the `display' property takes up the whole string. */
5901 xassert (it
->sp
> 0);
5903 if (it
->method
== GET_FROM_STRING
)
5904 goto consider_string_end
;
5908 /* There are no other methods defined, so this should be a bug. */
5912 xassert (it
->method
!= GET_FROM_STRING
5913 || (STRINGP (it
->string
)
5914 && IT_STRING_CHARPOS (*it
) >= 0));
5917 /* Load IT's display element fields with information about the next
5918 display element which comes from a display table entry or from the
5919 result of translating a control character to one of the forms `^C'
5922 IT->dpvec holds the glyphs to return as characters.
5923 IT->saved_face_id holds the face id before the display vector--
5924 it is restored into IT->face_idin set_iterator_to_next. */
5927 next_element_from_display_vector (it
)
5931 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
5933 it
->face_id
= it
->saved_face_id
;
5935 if (INTEGERP (*it
->dpvec
)
5936 && GLYPH_CHAR_VALID_P (XFASTINT (*it
->dpvec
)))
5940 g
= XFASTINT (it
->dpvec
[it
->current
.dpvec_index
]);
5941 it
->c
= FAST_GLYPH_CHAR (g
);
5942 it
->len
= CHAR_BYTES (it
->c
);
5944 /* The entry may contain a face id to use. Such a face id is
5945 the id of a Lisp face, not a realized face. A face id of
5946 zero means no face is specified. */
5947 if (it
->dpvec_face_id
>= 0)
5948 it
->face_id
= it
->dpvec_face_id
;
5951 int lface_id
= FAST_GLYPH_FACE (g
);
5953 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
5958 /* Display table entry is invalid. Return a space. */
5959 it
->c
= ' ', it
->len
= 1;
5961 /* Don't change position and object of the iterator here. They are
5962 still the values of the character that had this display table
5963 entry or was translated, and that's what we want. */
5964 it
->what
= IT_CHARACTER
;
5969 /* Load IT with the next display element from Lisp string IT->string.
5970 IT->current.string_pos is the current position within the string.
5971 If IT->current.overlay_string_index >= 0, the Lisp string is an
5975 next_element_from_string (it
)
5978 struct text_pos position
;
5980 xassert (STRINGP (it
->string
));
5981 xassert (IT_STRING_CHARPOS (*it
) >= 0);
5982 position
= it
->current
.string_pos
;
5984 /* Time to check for invisible text? */
5985 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
5986 && IT_STRING_CHARPOS (*it
) == it
->stop_charpos
)
5990 /* Since a handler may have changed IT->method, we must
5992 return get_next_display_element (it
);
5995 if (it
->current
.overlay_string_index
>= 0)
5997 /* Get the next character from an overlay string. In overlay
5998 strings, There is no field width or padding with spaces to
6000 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6005 else if (STRING_MULTIBYTE (it
->string
))
6007 int remaining
= SBYTES (it
->string
) - IT_STRING_BYTEPOS (*it
);
6008 const unsigned char *s
= (SDATA (it
->string
)
6009 + IT_STRING_BYTEPOS (*it
));
6010 it
->c
= string_char_and_length (s
, remaining
, &it
->len
);
6014 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6020 /* Get the next character from a Lisp string that is not an
6021 overlay string. Such strings come from the mode line, for
6022 example. We may have to pad with spaces, or truncate the
6023 string. See also next_element_from_c_string. */
6024 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
6029 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
6031 /* Pad with spaces. */
6032 it
->c
= ' ', it
->len
= 1;
6033 CHARPOS (position
) = BYTEPOS (position
) = -1;
6035 else if (STRING_MULTIBYTE (it
->string
))
6037 int maxlen
= SBYTES (it
->string
) - IT_STRING_BYTEPOS (*it
);
6038 const unsigned char *s
= (SDATA (it
->string
)
6039 + IT_STRING_BYTEPOS (*it
));
6040 it
->c
= string_char_and_length (s
, maxlen
, &it
->len
);
6044 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6049 /* Record what we have and where it came from. Note that we store a
6050 buffer position in IT->position although it could arguably be a
6052 it
->what
= IT_CHARACTER
;
6053 it
->object
= it
->string
;
6054 it
->position
= position
;
6059 /* Load IT with next display element from C string IT->s.
6060 IT->string_nchars is the maximum number of characters to return
6061 from the string. IT->end_charpos may be greater than
6062 IT->string_nchars when this function is called, in which case we
6063 may have to return padding spaces. Value is zero if end of string
6064 reached, including padding spaces. */
6067 next_element_from_c_string (it
)
6073 it
->what
= IT_CHARACTER
;
6074 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
6077 /* IT's position can be greater IT->string_nchars in case a field
6078 width or precision has been specified when the iterator was
6080 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6082 /* End of the game. */
6086 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
6088 /* Pad with spaces. */
6089 it
->c
= ' ', it
->len
= 1;
6090 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
6092 else if (it
->multibyte_p
)
6094 /* Implementation note: The calls to strlen apparently aren't a
6095 performance problem because there is no noticeable performance
6096 difference between Emacs running in unibyte or multibyte mode. */
6097 int maxlen
= strlen (it
->s
) - IT_BYTEPOS (*it
);
6098 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
),
6102 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
6108 /* Set up IT to return characters from an ellipsis, if appropriate.
6109 The definition of the ellipsis glyphs may come from a display table
6110 entry. This function Fills IT with the first glyph from the
6111 ellipsis if an ellipsis is to be displayed. */
6114 next_element_from_ellipsis (it
)
6117 if (it
->selective_display_ellipsis_p
)
6118 setup_for_ellipsis (it
, it
->len
);
6121 /* The face at the current position may be different from the
6122 face we find after the invisible text. Remember what it
6123 was in IT->saved_face_id, and signal that it's there by
6124 setting face_before_selective_p. */
6125 it
->saved_face_id
= it
->face_id
;
6126 it
->method
= GET_FROM_BUFFER
;
6127 it
->object
= it
->w
->buffer
;
6128 reseat_at_next_visible_line_start (it
, 1);
6129 it
->face_before_selective_p
= 1;
6132 return get_next_display_element (it
);
6136 /* Deliver an image display element. The iterator IT is already
6137 filled with image information (done in handle_display_prop). Value
6142 next_element_from_image (it
)
6145 it
->what
= IT_IMAGE
;
6150 /* Fill iterator IT with next display element from a stretch glyph
6151 property. IT->object is the value of the text property. Value is
6155 next_element_from_stretch (it
)
6158 it
->what
= IT_STRETCH
;
6163 /* Load IT with the next display element from current_buffer. Value
6164 is zero if end of buffer reached. IT->stop_charpos is the next
6165 position at which to stop and check for text properties or buffer
6169 next_element_from_buffer (it
)
6174 /* Check this assumption, otherwise, we would never enter the
6175 if-statement, below. */
6176 xassert (IT_CHARPOS (*it
) >= BEGV
6177 && IT_CHARPOS (*it
) <= it
->stop_charpos
);
6179 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
6181 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6183 int overlay_strings_follow_p
;
6185 /* End of the game, except when overlay strings follow that
6186 haven't been returned yet. */
6187 if (it
->overlay_strings_at_end_processed_p
)
6188 overlay_strings_follow_p
= 0;
6191 it
->overlay_strings_at_end_processed_p
= 1;
6192 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
6195 if (overlay_strings_follow_p
)
6196 success_p
= get_next_display_element (it
);
6200 it
->position
= it
->current
.pos
;
6207 return get_next_display_element (it
);
6212 /* No face changes, overlays etc. in sight, so just return a
6213 character from current_buffer. */
6216 /* Maybe run the redisplay end trigger hook. Performance note:
6217 This doesn't seem to cost measurable time. */
6218 if (it
->redisplay_end_trigger_charpos
6220 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
6221 run_redisplay_end_trigger_hook (it
);
6223 /* Get the next character, maybe multibyte. */
6224 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
6225 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
6227 int maxlen
= ((IT_BYTEPOS (*it
) >= GPT_BYTE
? ZV_BYTE
: GPT_BYTE
)
6228 - IT_BYTEPOS (*it
));
6229 it
->c
= string_char_and_length (p
, maxlen
, &it
->len
);
6232 it
->c
= *p
, it
->len
= 1;
6234 /* Record what we have and where it came from. */
6235 it
->what
= IT_CHARACTER
;;
6236 it
->object
= it
->w
->buffer
;
6237 it
->position
= it
->current
.pos
;
6239 /* Normally we return the character found above, except when we
6240 really want to return an ellipsis for selective display. */
6245 /* A value of selective > 0 means hide lines indented more
6246 than that number of columns. */
6247 if (it
->selective
> 0
6248 && IT_CHARPOS (*it
) + 1 < ZV
6249 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
6250 IT_BYTEPOS (*it
) + 1,
6251 (double) it
->selective
)) /* iftc */
6253 success_p
= next_element_from_ellipsis (it
);
6254 it
->dpvec_char_len
= -1;
6257 else if (it
->c
== '\r' && it
->selective
== -1)
6259 /* A value of selective == -1 means that everything from the
6260 CR to the end of the line is invisible, with maybe an
6261 ellipsis displayed for it. */
6262 success_p
= next_element_from_ellipsis (it
);
6263 it
->dpvec_char_len
= -1;
6268 /* Value is zero if end of buffer reached. */
6269 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
6274 /* Run the redisplay end trigger hook for IT. */
6277 run_redisplay_end_trigger_hook (it
)
6280 Lisp_Object args
[3];
6282 /* IT->glyph_row should be non-null, i.e. we should be actually
6283 displaying something, or otherwise we should not run the hook. */
6284 xassert (it
->glyph_row
);
6286 /* Set up hook arguments. */
6287 args
[0] = Qredisplay_end_trigger_functions
;
6288 args
[1] = it
->window
;
6289 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
6290 it
->redisplay_end_trigger_charpos
= 0;
6292 /* Since we are *trying* to run these functions, don't try to run
6293 them again, even if they get an error. */
6294 it
->w
->redisplay_end_trigger
= Qnil
;
6295 Frun_hook_with_args (3, args
);
6297 /* Notice if it changed the face of the character we are on. */
6298 handle_face_prop (it
);
6302 /* Deliver a composition display element. The iterator IT is already
6303 filled with composition information (done in
6304 handle_composition_prop). Value is always 1. */
6307 next_element_from_composition (it
)
6310 it
->what
= IT_COMPOSITION
;
6311 it
->position
= (STRINGP (it
->string
)
6312 ? it
->current
.string_pos
6314 if (STRINGP (it
->string
))
6315 it
->object
= it
->string
;
6317 it
->object
= it
->w
->buffer
;
6323 /***********************************************************************
6324 Moving an iterator without producing glyphs
6325 ***********************************************************************/
6327 /* Check if iterator is at a position corresponding to a valid buffer
6328 position after some move_it_ call. */
6330 #define IT_POS_VALID_AFTER_MOVE_P(it) \
6331 ((it)->method == GET_FROM_STRING \
6332 ? IT_STRING_CHARPOS (*it) == 0 \
6336 /* Move iterator IT to a specified buffer or X position within one
6337 line on the display without producing glyphs.
6339 OP should be a bit mask including some or all of these bits:
6340 MOVE_TO_X: Stop on reaching x-position TO_X.
6341 MOVE_TO_POS: Stop on reaching buffer or string position TO_CHARPOS.
6342 Regardless of OP's value, stop in reaching the end of the display line.
6344 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
6345 This means, in particular, that TO_X includes window's horizontal
6348 The return value has several possible values that
6349 say what condition caused the scan to stop:
6351 MOVE_POS_MATCH_OR_ZV
6352 - when TO_POS or ZV was reached.
6355 -when TO_X was reached before TO_POS or ZV were reached.
6358 - when we reached the end of the display area and the line must
6362 - when we reached the end of the display area and the line is
6366 - when we stopped at a line end, i.e. a newline or a CR and selective
6369 static enum move_it_result
6370 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
)
6372 int to_charpos
, to_x
, op
;
6374 enum move_it_result result
= MOVE_UNDEFINED
;
6375 struct glyph_row
*saved_glyph_row
;
6377 /* Don't produce glyphs in produce_glyphs. */
6378 saved_glyph_row
= it
->glyph_row
;
6379 it
->glyph_row
= NULL
;
6381 #define BUFFER_POS_REACHED_P() \
6382 ((op & MOVE_TO_POS) != 0 \
6383 && BUFFERP (it->object) \
6384 && IT_CHARPOS (*it) >= to_charpos \
6385 && (it->method == GET_FROM_BUFFER \
6386 || (it->method == GET_FROM_DISPLAY_VECTOR \
6387 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
6392 int x
, i
, ascent
= 0, descent
= 0;
6394 /* Stop if we move beyond TO_CHARPOS (after an image or stretch glyph). */
6395 if ((op
& MOVE_TO_POS
) != 0
6396 && BUFFERP (it
->object
)
6397 && it
->method
== GET_FROM_BUFFER
6398 && IT_CHARPOS (*it
) > to_charpos
)
6400 result
= MOVE_POS_MATCH_OR_ZV
;
6404 /* Stop when ZV reached.
6405 We used to stop here when TO_CHARPOS reached as well, but that is
6406 too soon if this glyph does not fit on this line. So we handle it
6407 explicitly below. */
6408 if (!get_next_display_element (it
)
6409 || (it
->truncate_lines_p
6410 && BUFFER_POS_REACHED_P ()))
6412 result
= MOVE_POS_MATCH_OR_ZV
;
6416 /* The call to produce_glyphs will get the metrics of the
6417 display element IT is loaded with. We record in x the
6418 x-position before this display element in case it does not
6422 /* Remember the line height so far in case the next element doesn't
6424 if (!it
->truncate_lines_p
)
6426 ascent
= it
->max_ascent
;
6427 descent
= it
->max_descent
;
6430 PRODUCE_GLYPHS (it
);
6432 if (it
->area
!= TEXT_AREA
)
6434 set_iterator_to_next (it
, 1);
6438 /* The number of glyphs we get back in IT->nglyphs will normally
6439 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
6440 character on a terminal frame, or (iii) a line end. For the
6441 second case, IT->nglyphs - 1 padding glyphs will be present
6442 (on X frames, there is only one glyph produced for a
6443 composite character.
6445 The behavior implemented below means, for continuation lines,
6446 that as many spaces of a TAB as fit on the current line are
6447 displayed there. For terminal frames, as many glyphs of a
6448 multi-glyph character are displayed in the current line, too.
6449 This is what the old redisplay code did, and we keep it that
6450 way. Under X, the whole shape of a complex character must
6451 fit on the line or it will be completely displayed in the
6454 Note that both for tabs and padding glyphs, all glyphs have
6458 /* More than one glyph or glyph doesn't fit on line. All
6459 glyphs have the same width. */
6460 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
6462 int x_before_this_char
= x
;
6463 int hpos_before_this_char
= it
->hpos
;
6465 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
6467 new_x
= x
+ single_glyph_width
;
6469 /* We want to leave anything reaching TO_X to the caller. */
6470 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
6472 if (BUFFER_POS_REACHED_P ())
6473 goto buffer_pos_reached
;
6475 result
= MOVE_X_REACHED
;
6478 else if (/* Lines are continued. */
6479 !it
->truncate_lines_p
6480 && (/* And glyph doesn't fit on the line. */
6481 new_x
> it
->last_visible_x
6482 /* Or it fits exactly and we're on a window
6484 || (new_x
== it
->last_visible_x
6485 && FRAME_WINDOW_P (it
->f
))))
6487 if (/* IT->hpos == 0 means the very first glyph
6488 doesn't fit on the line, e.g. a wide image. */
6490 || (new_x
== it
->last_visible_x
6491 && FRAME_WINDOW_P (it
->f
)))
6494 it
->current_x
= new_x
;
6496 /* The character's last glyph just barely fits
6498 if (i
== it
->nglyphs
- 1)
6500 /* If this is the destination position,
6501 return a position *before* it in this row,
6502 now that we know it fits in this row. */
6503 if (BUFFER_POS_REACHED_P ())
6505 it
->hpos
= hpos_before_this_char
;
6506 it
->current_x
= x_before_this_char
;
6507 result
= MOVE_POS_MATCH_OR_ZV
;
6511 set_iterator_to_next (it
, 1);
6512 #ifdef HAVE_WINDOW_SYSTEM
6513 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
6515 if (!get_next_display_element (it
))
6517 result
= MOVE_POS_MATCH_OR_ZV
;
6520 if (BUFFER_POS_REACHED_P ())
6522 if (ITERATOR_AT_END_OF_LINE_P (it
))
6523 result
= MOVE_POS_MATCH_OR_ZV
;
6525 result
= MOVE_LINE_CONTINUED
;
6528 if (ITERATOR_AT_END_OF_LINE_P (it
))
6530 result
= MOVE_NEWLINE_OR_CR
;
6534 #endif /* HAVE_WINDOW_SYSTEM */
6540 it
->max_ascent
= ascent
;
6541 it
->max_descent
= descent
;
6544 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
6546 result
= MOVE_LINE_CONTINUED
;
6549 else if (BUFFER_POS_REACHED_P ())
6550 goto buffer_pos_reached
;
6551 else if (new_x
> it
->first_visible_x
)
6553 /* Glyph is visible. Increment number of glyphs that
6554 would be displayed. */
6559 /* Glyph is completely off the left margin of the display
6560 area. Nothing to do. */
6564 if (result
!= MOVE_UNDEFINED
)
6567 else if (BUFFER_POS_REACHED_P ())
6571 it
->max_ascent
= ascent
;
6572 it
->max_descent
= descent
;
6573 result
= MOVE_POS_MATCH_OR_ZV
;
6576 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
6578 /* Stop when TO_X specified and reached. This check is
6579 necessary here because of lines consisting of a line end,
6580 only. The line end will not produce any glyphs and we
6581 would never get MOVE_X_REACHED. */
6582 xassert (it
->nglyphs
== 0);
6583 result
= MOVE_X_REACHED
;
6587 /* Is this a line end? If yes, we're done. */
6588 if (ITERATOR_AT_END_OF_LINE_P (it
))
6590 result
= MOVE_NEWLINE_OR_CR
;
6594 /* The current display element has been consumed. Advance
6596 set_iterator_to_next (it
, 1);
6598 /* Stop if lines are truncated and IT's current x-position is
6599 past the right edge of the window now. */
6600 if (it
->truncate_lines_p
6601 && it
->current_x
>= it
->last_visible_x
)
6603 #ifdef HAVE_WINDOW_SYSTEM
6604 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
6606 if (!get_next_display_element (it
)
6607 || BUFFER_POS_REACHED_P ())
6609 result
= MOVE_POS_MATCH_OR_ZV
;
6612 if (ITERATOR_AT_END_OF_LINE_P (it
))
6614 result
= MOVE_NEWLINE_OR_CR
;
6618 #endif /* HAVE_WINDOW_SYSTEM */
6619 result
= MOVE_LINE_TRUNCATED
;
6624 #undef BUFFER_POS_REACHED_P
6626 /* Restore the iterator settings altered at the beginning of this
6628 it
->glyph_row
= saved_glyph_row
;
6633 /* Move IT forward until it satisfies one or more of the criteria in
6634 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
6636 OP is a bit-mask that specifies where to stop, and in particular,
6637 which of those four position arguments makes a difference. See the
6638 description of enum move_operation_enum.
6640 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
6641 screen line, this function will set IT to the next position >
6645 move_it_to (it
, to_charpos
, to_x
, to_y
, to_vpos
, op
)
6647 int to_charpos
, to_x
, to_y
, to_vpos
;
6650 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
6656 if (op
& MOVE_TO_VPOS
)
6658 /* If no TO_CHARPOS and no TO_X specified, stop at the
6659 start of the line TO_VPOS. */
6660 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
6662 if (it
->vpos
== to_vpos
)
6668 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
6672 /* TO_VPOS >= 0 means stop at TO_X in the line at
6673 TO_VPOS, or at TO_POS, whichever comes first. */
6674 if (it
->vpos
== to_vpos
)
6680 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
6682 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
6687 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
6689 /* We have reached TO_X but not in the line we want. */
6690 skip
= move_it_in_display_line_to (it
, to_charpos
,
6692 if (skip
== MOVE_POS_MATCH_OR_ZV
)
6700 else if (op
& MOVE_TO_Y
)
6702 struct it it_backup
;
6704 /* TO_Y specified means stop at TO_X in the line containing
6705 TO_Y---or at TO_CHARPOS if this is reached first. The
6706 problem is that we can't really tell whether the line
6707 contains TO_Y before we have completely scanned it, and
6708 this may skip past TO_X. What we do is to first scan to
6711 If TO_X is not specified, use a TO_X of zero. The reason
6712 is to make the outcome of this function more predictable.
6713 If we didn't use TO_X == 0, we would stop at the end of
6714 the line which is probably not what a caller would expect
6716 skip
= move_it_in_display_line_to (it
, to_charpos
,
6720 | (op
& MOVE_TO_POS
)));
6722 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
6723 if (skip
== MOVE_POS_MATCH_OR_ZV
)
6729 /* If TO_X was reached, we would like to know whether TO_Y
6730 is in the line. This can only be said if we know the
6731 total line height which requires us to scan the rest of
6733 if (skip
== MOVE_X_REACHED
)
6736 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
6737 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
6739 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
6742 /* Now, decide whether TO_Y is in this line. */
6743 line_height
= it
->max_ascent
+ it
->max_descent
;
6744 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
6746 if (to_y
>= it
->current_y
6747 && to_y
< it
->current_y
+ line_height
)
6749 if (skip
== MOVE_X_REACHED
)
6750 /* If TO_Y is in this line and TO_X was reached above,
6751 we scanned too far. We have to restore IT's settings
6752 to the ones before skipping. */
6756 else if (skip
== MOVE_X_REACHED
)
6759 if (skip
== MOVE_POS_MATCH_OR_ZV
)
6767 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
6771 case MOVE_POS_MATCH_OR_ZV
:
6775 case MOVE_NEWLINE_OR_CR
:
6776 set_iterator_to_next (it
, 1);
6777 it
->continuation_lines_width
= 0;
6780 case MOVE_LINE_TRUNCATED
:
6781 it
->continuation_lines_width
= 0;
6782 reseat_at_next_visible_line_start (it
, 0);
6783 if ((op
& MOVE_TO_POS
) != 0
6784 && IT_CHARPOS (*it
) > to_charpos
)
6791 case MOVE_LINE_CONTINUED
:
6792 it
->continuation_lines_width
+= it
->current_x
;
6799 /* Reset/increment for the next run. */
6800 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
6801 it
->current_x
= it
->hpos
= 0;
6802 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
6804 last_height
= it
->max_ascent
+ it
->max_descent
;
6805 last_max_ascent
= it
->max_ascent
;
6806 it
->max_ascent
= it
->max_descent
= 0;
6811 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
6815 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
6817 If DY > 0, move IT backward at least that many pixels. DY = 0
6818 means move IT backward to the preceding line start or BEGV. This
6819 function may move over more than DY pixels if IT->current_y - DY
6820 ends up in the middle of a line; in this case IT->current_y will be
6821 set to the top of the line moved to. */
6824 move_it_vertically_backward (it
, dy
)
6835 start_pos
= IT_CHARPOS (*it
);
6837 /* Estimate how many newlines we must move back. */
6838 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
6840 /* Set the iterator's position that many lines back. */
6841 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
6842 back_to_previous_visible_line_start (it
);
6844 /* Reseat the iterator here. When moving backward, we don't want
6845 reseat to skip forward over invisible text, set up the iterator
6846 to deliver from overlay strings at the new position etc. So,
6847 use reseat_1 here. */
6848 reseat_1 (it
, it
->current
.pos
, 1);
6850 /* We are now surely at a line start. */
6851 it
->current_x
= it
->hpos
= 0;
6852 it
->continuation_lines_width
= 0;
6854 /* Move forward and see what y-distance we moved. First move to the
6855 start of the next line so that we get its height. We need this
6856 height to be able to tell whether we reached the specified
6859 it2
.max_ascent
= it2
.max_descent
= 0;
6862 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
6863 MOVE_TO_POS
| MOVE_TO_VPOS
);
6865 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
6866 xassert (IT_CHARPOS (*it
) >= BEGV
);
6869 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
6870 xassert (IT_CHARPOS (*it
) >= BEGV
);
6871 /* H is the actual vertical distance from the position in *IT
6872 and the starting position. */
6873 h
= it2
.current_y
- it
->current_y
;
6874 /* NLINES is the distance in number of lines. */
6875 nlines
= it2
.vpos
- it
->vpos
;
6877 /* Correct IT's y and vpos position
6878 so that they are relative to the starting point. */
6884 /* DY == 0 means move to the start of the screen line. The
6885 value of nlines is > 0 if continuation lines were involved. */
6887 move_it_by_lines (it
, nlines
, 1);
6889 /* I think this assert is bogus if buffer contains
6890 invisible text or images. KFS. */
6891 xassert (IT_CHARPOS (*it
) <= start_pos
);
6896 /* The y-position we try to reach, relative to *IT.
6897 Note that H has been subtracted in front of the if-statement. */
6898 int target_y
= it
->current_y
+ h
- dy
;
6899 int y0
= it3
.current_y
;
6900 int y1
= line_bottom_y (&it3
);
6901 int line_height
= y1
- y0
;
6903 /* If we did not reach target_y, try to move further backward if
6904 we can. If we moved too far backward, try to move forward. */
6905 if (target_y
< it
->current_y
6906 /* This is heuristic. In a window that's 3 lines high, with
6907 a line height of 13 pixels each, recentering with point
6908 on the bottom line will try to move -39/2 = 19 pixels
6909 backward. Try to avoid moving into the first line. */
6910 && (it
->current_y
- target_y
6911 > min (window_box_height (it
->w
), line_height
* 2 / 3))
6912 && IT_CHARPOS (*it
) > BEGV
)
6914 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
6915 target_y
- it
->current_y
));
6916 dy
= it
->current_y
- target_y
;
6917 goto move_further_back
;
6919 else if (target_y
>= it
->current_y
+ line_height
6920 && IT_CHARPOS (*it
) < ZV
)
6922 /* Should move forward by at least one line, maybe more.
6924 Note: Calling move_it_by_lines can be expensive on
6925 terminal frames, where compute_motion is used (via
6926 vmotion) to do the job, when there are very long lines
6927 and truncate-lines is nil. That's the reason for
6928 treating terminal frames specially here. */
6930 if (!FRAME_WINDOW_P (it
->f
))
6931 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
6936 move_it_by_lines (it
, 1, 1);
6938 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
6942 /* I think this assert is bogus if buffer contains
6943 invisible text or images. KFS. */
6944 xassert (IT_CHARPOS (*it
) >= BEGV
);
6951 /* Move IT by a specified amount of pixel lines DY. DY negative means
6952 move backwards. DY = 0 means move to start of screen line. At the
6953 end, IT will be on the start of a screen line. */
6956 move_it_vertically (it
, dy
)
6961 move_it_vertically_backward (it
, -dy
);
6964 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
6965 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
6966 MOVE_TO_POS
| MOVE_TO_Y
);
6967 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
6969 /* If buffer ends in ZV without a newline, move to the start of
6970 the line to satisfy the post-condition. */
6971 if (IT_CHARPOS (*it
) == ZV
6973 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
6974 move_it_by_lines (it
, 0, 0);
6979 /* Move iterator IT past the end of the text line it is in. */
6982 move_it_past_eol (it
)
6985 enum move_it_result rc
;
6987 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
6988 if (rc
== MOVE_NEWLINE_OR_CR
)
6989 set_iterator_to_next (it
, 0);
6993 #if 0 /* Currently not used. */
6995 /* Return non-zero if some text between buffer positions START_CHARPOS
6996 and END_CHARPOS is invisible. IT->window is the window for text
7000 invisible_text_between_p (it
, start_charpos
, end_charpos
)
7002 int start_charpos
, end_charpos
;
7004 Lisp_Object prop
, limit
;
7005 int invisible_found_p
;
7007 xassert (it
!= NULL
&& start_charpos
<= end_charpos
);
7009 /* Is text at START invisible? */
7010 prop
= Fget_char_property (make_number (start_charpos
), Qinvisible
,
7012 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
7013 invisible_found_p
= 1;
7016 limit
= Fnext_single_char_property_change (make_number (start_charpos
),
7018 make_number (end_charpos
));
7019 invisible_found_p
= XFASTINT (limit
) < end_charpos
;
7022 return invisible_found_p
;
7028 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
7029 negative means move up. DVPOS == 0 means move to the start of the
7030 screen line. NEED_Y_P non-zero means calculate IT->current_y. If
7031 NEED_Y_P is zero, IT->current_y will be left unchanged.
7033 Further optimization ideas: If we would know that IT->f doesn't use
7034 a face with proportional font, we could be faster for
7035 truncate-lines nil. */
7038 move_it_by_lines (it
, dvpos
, need_y_p
)
7040 int dvpos
, need_y_p
;
7042 struct position pos
;
7044 if (!FRAME_WINDOW_P (it
->f
))
7046 struct text_pos textpos
;
7048 /* We can use vmotion on frames without proportional fonts. */
7049 pos
= *vmotion (IT_CHARPOS (*it
), dvpos
, it
->w
);
7050 SET_TEXT_POS (textpos
, pos
.bufpos
, pos
.bytepos
);
7051 reseat (it
, textpos
, 1);
7052 it
->vpos
+= pos
.vpos
;
7053 it
->current_y
+= pos
.vpos
;
7055 else if (dvpos
== 0)
7057 /* DVPOS == 0 means move to the start of the screen line. */
7058 move_it_vertically_backward (it
, 0);
7059 xassert (it
->current_x
== 0 && it
->hpos
== 0);
7060 /* Let next call to line_bottom_y calculate real line height */
7065 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
7066 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
7067 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
7072 int start_charpos
, i
;
7074 /* Start at the beginning of the screen line containing IT's
7075 position. This may actually move vertically backwards,
7076 in case of overlays, so adjust dvpos accordingly. */
7078 move_it_vertically_backward (it
, 0);
7081 /* Go back -DVPOS visible lines and reseat the iterator there. */
7082 start_charpos
= IT_CHARPOS (*it
);
7083 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
7084 back_to_previous_visible_line_start (it
);
7085 reseat (it
, it
->current
.pos
, 1);
7087 /* Move further back if we end up in a string or an image. */
7088 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
7090 /* First try to move to start of display line. */
7092 move_it_vertically_backward (it
, 0);
7094 if (IT_POS_VALID_AFTER_MOVE_P (it
))
7096 /* If start of line is still in string or image,
7097 move further back. */
7098 back_to_previous_visible_line_start (it
);
7099 reseat (it
, it
->current
.pos
, 1);
7103 it
->current_x
= it
->hpos
= 0;
7105 /* Above call may have moved too far if continuation lines
7106 are involved. Scan forward and see if it did. */
7108 it2
.vpos
= it2
.current_y
= 0;
7109 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
7110 it
->vpos
-= it2
.vpos
;
7111 it
->current_y
-= it2
.current_y
;
7112 it
->current_x
= it
->hpos
= 0;
7114 /* If we moved too far back, move IT some lines forward. */
7115 if (it2
.vpos
> -dvpos
)
7117 int delta
= it2
.vpos
+ dvpos
;
7119 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
7120 /* Move back again if we got too far ahead. */
7121 if (IT_CHARPOS (*it
) >= start_charpos
)
7127 /* Return 1 if IT points into the middle of a display vector. */
7130 in_display_vector_p (it
)
7133 return (it
->method
== GET_FROM_DISPLAY_VECTOR
7134 && it
->current
.dpvec_index
> 0
7135 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
7139 /***********************************************************************
7141 ***********************************************************************/
7144 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
7148 add_to_log (format
, arg1
, arg2
)
7150 Lisp_Object arg1
, arg2
;
7152 Lisp_Object args
[3];
7153 Lisp_Object msg
, fmt
;
7156 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
7159 /* Do nothing if called asynchronously. Inserting text into
7160 a buffer may call after-change-functions and alike and
7161 that would means running Lisp asynchronously. */
7162 if (handling_signal
)
7166 GCPRO4 (fmt
, msg
, arg1
, arg2
);
7168 args
[0] = fmt
= build_string (format
);
7171 msg
= Fformat (3, args
);
7173 len
= SBYTES (msg
) + 1;
7174 SAFE_ALLOCA (buffer
, char *, len
);
7175 bcopy (SDATA (msg
), buffer
, len
);
7177 message_dolog (buffer
, len
- 1, 1, 0);
7184 /* Output a newline in the *Messages* buffer if "needs" one. */
7187 message_log_maybe_newline ()
7189 if (message_log_need_newline
)
7190 message_dolog ("", 0, 1, 0);
7194 /* Add a string M of length NBYTES to the message log, optionally
7195 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
7196 nonzero, means interpret the contents of M as multibyte. This
7197 function calls low-level routines in order to bypass text property
7198 hooks, etc. which might not be safe to run.
7200 This may GC (insert may run before/after change hooks),
7201 so the buffer M must NOT point to a Lisp string. */
7204 message_dolog (m
, nbytes
, nlflag
, multibyte
)
7206 int nbytes
, nlflag
, multibyte
;
7208 if (!NILP (Vmemory_full
))
7211 if (!NILP (Vmessage_log_max
))
7213 struct buffer
*oldbuf
;
7214 Lisp_Object oldpoint
, oldbegv
, oldzv
;
7215 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
7216 int point_at_end
= 0;
7218 Lisp_Object old_deactivate_mark
, tem
;
7219 struct gcpro gcpro1
;
7221 old_deactivate_mark
= Vdeactivate_mark
;
7222 oldbuf
= current_buffer
;
7223 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
7224 current_buffer
->undo_list
= Qt
;
7226 oldpoint
= message_dolog_marker1
;
7227 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
7228 oldbegv
= message_dolog_marker2
;
7229 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
7230 oldzv
= message_dolog_marker3
;
7231 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
7232 GCPRO1 (old_deactivate_mark
);
7240 BEGV_BYTE
= BEG_BYTE
;
7243 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
7245 /* Insert the string--maybe converting multibyte to single byte
7246 or vice versa, so that all the text fits the buffer. */
7248 && NILP (current_buffer
->enable_multibyte_characters
))
7250 int i
, c
, char_bytes
;
7251 unsigned char work
[1];
7253 /* Convert a multibyte string to single-byte
7254 for the *Message* buffer. */
7255 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
7257 c
= string_char_and_length (m
+ i
, nbytes
- i
, &char_bytes
);
7258 work
[0] = (SINGLE_BYTE_CHAR_P (c
)
7260 : multibyte_char_to_unibyte (c
, Qnil
));
7261 insert_1_both (work
, 1, 1, 1, 0, 0);
7264 else if (! multibyte
7265 && ! NILP (current_buffer
->enable_multibyte_characters
))
7267 int i
, c
, char_bytes
;
7268 unsigned char *msg
= (unsigned char *) m
;
7269 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
7270 /* Convert a single-byte string to multibyte
7271 for the *Message* buffer. */
7272 for (i
= 0; i
< nbytes
; i
++)
7274 c
= unibyte_char_to_multibyte (msg
[i
]);
7275 char_bytes
= CHAR_STRING (c
, str
);
7276 insert_1_both (str
, 1, char_bytes
, 1, 0, 0);
7280 insert_1 (m
, nbytes
, 1, 0, 0);
7284 int this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
, dup
;
7285 insert_1 ("\n", 1, 1, 0, 0);
7287 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
7289 this_bol_byte
= PT_BYTE
;
7291 /* See if this line duplicates the previous one.
7292 If so, combine duplicates. */
7295 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
7297 prev_bol_byte
= PT_BYTE
;
7299 dup
= message_log_check_duplicate (prev_bol
, prev_bol_byte
,
7300 this_bol
, this_bol_byte
);
7303 del_range_both (prev_bol
, prev_bol_byte
,
7304 this_bol
, this_bol_byte
, 0);
7310 /* If you change this format, don't forget to also
7311 change message_log_check_duplicate. */
7312 sprintf (dupstr
, " [%d times]", dup
);
7313 duplen
= strlen (dupstr
);
7314 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
7315 insert_1 (dupstr
, duplen
, 1, 0, 1);
7320 /* If we have more than the desired maximum number of lines
7321 in the *Messages* buffer now, delete the oldest ones.
7322 This is safe because we don't have undo in this buffer. */
7324 if (NATNUMP (Vmessage_log_max
))
7326 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
7327 -XFASTINT (Vmessage_log_max
) - 1, 0);
7328 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
7331 BEGV
= XMARKER (oldbegv
)->charpos
;
7332 BEGV_BYTE
= marker_byte_position (oldbegv
);
7341 ZV
= XMARKER (oldzv
)->charpos
;
7342 ZV_BYTE
= marker_byte_position (oldzv
);
7346 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
7348 /* We can't do Fgoto_char (oldpoint) because it will run some
7350 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
7351 XMARKER (oldpoint
)->bytepos
);
7354 unchain_marker (XMARKER (oldpoint
));
7355 unchain_marker (XMARKER (oldbegv
));
7356 unchain_marker (XMARKER (oldzv
));
7358 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
7359 set_buffer_internal (oldbuf
);
7361 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
7362 message_log_need_newline
= !nlflag
;
7363 Vdeactivate_mark
= old_deactivate_mark
;
7368 /* We are at the end of the buffer after just having inserted a newline.
7369 (Note: We depend on the fact we won't be crossing the gap.)
7370 Check to see if the most recent message looks a lot like the previous one.
7371 Return 0 if different, 1 if the new one should just replace it, or a
7372 value N > 1 if we should also append " [N times]". */
7375 message_log_check_duplicate (prev_bol
, prev_bol_byte
, this_bol
, this_bol_byte
)
7376 int prev_bol
, this_bol
;
7377 int prev_bol_byte
, this_bol_byte
;
7380 int len
= Z_BYTE
- 1 - this_bol_byte
;
7382 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
7383 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
7385 for (i
= 0; i
< len
; i
++)
7387 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
7395 if (*p1
++ == ' ' && *p1
++ == '[')
7398 while (*p1
>= '0' && *p1
<= '9')
7399 n
= n
* 10 + *p1
++ - '0';
7400 if (strncmp (p1
, " times]\n", 8) == 0)
7407 /* Display an echo area message M with a specified length of NBYTES
7408 bytes. The string may include null characters. If M is 0, clear
7409 out any existing message, and let the mini-buffer text show
7412 This may GC, so the buffer M must NOT point to a Lisp string. */
7415 message2 (m
, nbytes
, multibyte
)
7420 /* First flush out any partial line written with print. */
7421 message_log_maybe_newline ();
7423 message_dolog (m
, nbytes
, 1, multibyte
);
7424 message2_nolog (m
, nbytes
, multibyte
);
7428 /* The non-logging counterpart of message2. */
7431 message2_nolog (m
, nbytes
, multibyte
)
7433 int nbytes
, multibyte
;
7435 struct frame
*sf
= SELECTED_FRAME ();
7436 message_enable_multibyte
= multibyte
;
7440 if (noninteractive_need_newline
)
7441 putc ('\n', stderr
);
7442 noninteractive_need_newline
= 0;
7444 fwrite (m
, nbytes
, 1, stderr
);
7445 if (cursor_in_echo_area
== 0)
7446 fprintf (stderr
, "\n");
7449 /* A null message buffer means that the frame hasn't really been
7450 initialized yet. Error messages get reported properly by
7451 cmd_error, so this must be just an informative message; toss it. */
7452 else if (INTERACTIVE
7453 && sf
->glyphs_initialized_p
7454 && FRAME_MESSAGE_BUF (sf
))
7456 Lisp_Object mini_window
;
7459 /* Get the frame containing the mini-buffer
7460 that the selected frame is using. */
7461 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
7462 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
7464 FRAME_SAMPLE_VISIBILITY (f
);
7465 if (FRAME_VISIBLE_P (sf
)
7466 && ! FRAME_VISIBLE_P (f
))
7467 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
7471 set_message (m
, Qnil
, nbytes
, multibyte
);
7472 if (minibuffer_auto_raise
)
7473 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
7476 clear_message (1, 1);
7478 do_pending_window_change (0);
7479 echo_area_display (1);
7480 do_pending_window_change (0);
7481 if (frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
7482 (*frame_up_to_date_hook
) (f
);
7487 /* Display an echo area message M with a specified length of NBYTES
7488 bytes. The string may include null characters. If M is not a
7489 string, clear out any existing message, and let the mini-buffer
7492 This function cancels echoing. */
7495 message3 (m
, nbytes
, multibyte
)
7500 struct gcpro gcpro1
;
7503 clear_message (1,1);
7506 /* First flush out any partial line written with print. */
7507 message_log_maybe_newline ();
7513 SAFE_ALLOCA (buffer
, char *, nbytes
);
7514 bcopy (SDATA (m
), buffer
, nbytes
);
7515 message_dolog (buffer
, nbytes
, 1, multibyte
);
7518 message3_nolog (m
, nbytes
, multibyte
);
7524 /* The non-logging version of message3.
7525 This does not cancel echoing, because it is used for echoing.
7526 Perhaps we need to make a separate function for echoing
7527 and make this cancel echoing. */
7530 message3_nolog (m
, nbytes
, multibyte
)
7532 int nbytes
, multibyte
;
7534 struct frame
*sf
= SELECTED_FRAME ();
7535 message_enable_multibyte
= multibyte
;
7539 if (noninteractive_need_newline
)
7540 putc ('\n', stderr
);
7541 noninteractive_need_newline
= 0;
7543 fwrite (SDATA (m
), nbytes
, 1, stderr
);
7544 if (cursor_in_echo_area
== 0)
7545 fprintf (stderr
, "\n");
7548 /* A null message buffer means that the frame hasn't really been
7549 initialized yet. Error messages get reported properly by
7550 cmd_error, so this must be just an informative message; toss it. */
7551 else if (INTERACTIVE
7552 && sf
->glyphs_initialized_p
7553 && FRAME_MESSAGE_BUF (sf
))
7555 Lisp_Object mini_window
;
7559 /* Get the frame containing the mini-buffer
7560 that the selected frame is using. */
7561 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
7562 frame
= XWINDOW (mini_window
)->frame
;
7565 FRAME_SAMPLE_VISIBILITY (f
);
7566 if (FRAME_VISIBLE_P (sf
)
7567 && !FRAME_VISIBLE_P (f
))
7568 Fmake_frame_visible (frame
);
7570 if (STRINGP (m
) && SCHARS (m
) > 0)
7572 set_message (NULL
, m
, nbytes
, multibyte
);
7573 if (minibuffer_auto_raise
)
7574 Fraise_frame (frame
);
7575 /* Assume we are not echoing.
7576 (If we are, echo_now will override this.) */
7577 echo_message_buffer
= Qnil
;
7580 clear_message (1, 1);
7582 do_pending_window_change (0);
7583 echo_area_display (1);
7584 do_pending_window_change (0);
7585 if (frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
7586 (*frame_up_to_date_hook
) (f
);
7591 /* Display a null-terminated echo area message M. If M is 0, clear
7592 out any existing message, and let the mini-buffer text show through.
7594 The buffer M must continue to exist until after the echo area gets
7595 cleared or some other message gets displayed there. Do not pass
7596 text that is stored in a Lisp string. Do not pass text in a buffer
7597 that was alloca'd. */
7603 message2 (m
, (m
? strlen (m
) : 0), 0);
7607 /* The non-logging counterpart of message1. */
7613 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
7616 /* Display a message M which contains a single %s
7617 which gets replaced with STRING. */
7620 message_with_string (m
, string
, log
)
7625 CHECK_STRING (string
);
7631 if (noninteractive_need_newline
)
7632 putc ('\n', stderr
);
7633 noninteractive_need_newline
= 0;
7634 fprintf (stderr
, m
, SDATA (string
));
7635 if (cursor_in_echo_area
== 0)
7636 fprintf (stderr
, "\n");
7640 else if (INTERACTIVE
)
7642 /* The frame whose minibuffer we're going to display the message on.
7643 It may be larger than the selected frame, so we need
7644 to use its buffer, not the selected frame's buffer. */
7645 Lisp_Object mini_window
;
7646 struct frame
*f
, *sf
= SELECTED_FRAME ();
7648 /* Get the frame containing the minibuffer
7649 that the selected frame is using. */
7650 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
7651 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
7653 /* A null message buffer means that the frame hasn't really been
7654 initialized yet. Error messages get reported properly by
7655 cmd_error, so this must be just an informative message; toss it. */
7656 if (FRAME_MESSAGE_BUF (f
))
7658 Lisp_Object args
[2], message
;
7659 struct gcpro gcpro1
, gcpro2
;
7661 args
[0] = build_string (m
);
7662 args
[1] = message
= string
;
7663 GCPRO2 (args
[0], message
);
7666 message
= Fformat (2, args
);
7669 message3 (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
7671 message3_nolog (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
7675 /* Print should start at the beginning of the message
7676 buffer next time. */
7677 message_buf_print
= 0;
7683 /* Dump an informative message to the minibuf. If M is 0, clear out
7684 any existing message, and let the mini-buffer text show through. */
7688 message (m
, a1
, a2
, a3
)
7690 EMACS_INT a1
, a2
, a3
;
7696 if (noninteractive_need_newline
)
7697 putc ('\n', stderr
);
7698 noninteractive_need_newline
= 0;
7699 fprintf (stderr
, m
, a1
, a2
, a3
);
7700 if (cursor_in_echo_area
== 0)
7701 fprintf (stderr
, "\n");
7705 else if (INTERACTIVE
)
7707 /* The frame whose mini-buffer we're going to display the message
7708 on. It may be larger than the selected frame, so we need to
7709 use its buffer, not the selected frame's buffer. */
7710 Lisp_Object mini_window
;
7711 struct frame
*f
, *sf
= SELECTED_FRAME ();
7713 /* Get the frame containing the mini-buffer
7714 that the selected frame is using. */
7715 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
7716 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
7718 /* A null message buffer means that the frame hasn't really been
7719 initialized yet. Error messages get reported properly by
7720 cmd_error, so this must be just an informative message; toss
7722 if (FRAME_MESSAGE_BUF (f
))
7733 len
= doprnt (FRAME_MESSAGE_BUF (f
),
7734 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3, a
);
7736 len
= doprnt (FRAME_MESSAGE_BUF (f
),
7737 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3,
7739 #endif /* NO_ARG_ARRAY */
7741 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
7746 /* Print should start at the beginning of the message
7747 buffer next time. */
7748 message_buf_print
= 0;
7754 /* The non-logging version of message. */
7757 message_nolog (m
, a1
, a2
, a3
)
7759 EMACS_INT a1
, a2
, a3
;
7761 Lisp_Object old_log_max
;
7762 old_log_max
= Vmessage_log_max
;
7763 Vmessage_log_max
= Qnil
;
7764 message (m
, a1
, a2
, a3
);
7765 Vmessage_log_max
= old_log_max
;
7769 /* Display the current message in the current mini-buffer. This is
7770 only called from error handlers in process.c, and is not time
7776 if (!NILP (echo_area_buffer
[0]))
7779 string
= Fcurrent_message ();
7780 message3 (string
, SBYTES (string
),
7781 !NILP (current_buffer
->enable_multibyte_characters
));
7786 /* Make sure echo area buffers in `echo_buffers' are live.
7787 If they aren't, make new ones. */
7790 ensure_echo_area_buffers ()
7794 for (i
= 0; i
< 2; ++i
)
7795 if (!BUFFERP (echo_buffer
[i
])
7796 || NILP (XBUFFER (echo_buffer
[i
])->name
))
7799 Lisp_Object old_buffer
;
7802 old_buffer
= echo_buffer
[i
];
7803 sprintf (name
, " *Echo Area %d*", i
);
7804 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
7805 XBUFFER (echo_buffer
[i
])->truncate_lines
= Qnil
;
7807 for (j
= 0; j
< 2; ++j
)
7808 if (EQ (old_buffer
, echo_area_buffer
[j
]))
7809 echo_area_buffer
[j
] = echo_buffer
[i
];
7814 /* Call FN with args A1..A4 with either the current or last displayed
7815 echo_area_buffer as current buffer.
7817 WHICH zero means use the current message buffer
7818 echo_area_buffer[0]. If that is nil, choose a suitable buffer
7819 from echo_buffer[] and clear it.
7821 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
7822 suitable buffer from echo_buffer[] and clear it.
7824 Value is what FN returns. */
7827 with_echo_area_buffer (w
, which
, fn
, a1
, a2
, a3
, a4
)
7830 int (*fn
) P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
7836 int this_one
, the_other
, clear_buffer_p
, rc
;
7837 int count
= SPECPDL_INDEX ();
7839 /* If buffers aren't live, make new ones. */
7840 ensure_echo_area_buffers ();
7845 this_one
= 0, the_other
= 1;
7847 this_one
= 1, the_other
= 0;
7849 /* Choose a suitable buffer from echo_buffer[] is we don't
7851 if (NILP (echo_area_buffer
[this_one
]))
7853 echo_area_buffer
[this_one
]
7854 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
7855 ? echo_buffer
[the_other
]
7856 : echo_buffer
[this_one
]);
7860 buffer
= echo_area_buffer
[this_one
];
7862 /* Don't get confused by reusing the buffer used for echoing
7863 for a different purpose. */
7864 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
7867 record_unwind_protect (unwind_with_echo_area_buffer
,
7868 with_echo_area_buffer_unwind_data (w
));
7870 /* Make the echo area buffer current. Note that for display
7871 purposes, it is not necessary that the displayed window's buffer
7872 == current_buffer, except for text property lookup. So, let's
7873 only set that buffer temporarily here without doing a full
7874 Fset_window_buffer. We must also change w->pointm, though,
7875 because otherwise an assertions in unshow_buffer fails, and Emacs
7877 set_buffer_internal_1 (XBUFFER (buffer
));
7881 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
7884 current_buffer
->undo_list
= Qt
;
7885 current_buffer
->read_only
= Qnil
;
7886 specbind (Qinhibit_read_only
, Qt
);
7887 specbind (Qinhibit_modification_hooks
, Qt
);
7889 if (clear_buffer_p
&& Z
> BEG
)
7892 xassert (BEGV
>= BEG
);
7893 xassert (ZV
<= Z
&& ZV
>= BEGV
);
7895 rc
= fn (a1
, a2
, a3
, a4
);
7897 xassert (BEGV
>= BEG
);
7898 xassert (ZV
<= Z
&& ZV
>= BEGV
);
7900 unbind_to (count
, Qnil
);
7905 /* Save state that should be preserved around the call to the function
7906 FN called in with_echo_area_buffer. */
7909 with_echo_area_buffer_unwind_data (w
)
7915 /* Reduce consing by keeping one vector in
7916 Vwith_echo_area_save_vector. */
7917 vector
= Vwith_echo_area_save_vector
;
7918 Vwith_echo_area_save_vector
= Qnil
;
7921 vector
= Fmake_vector (make_number (7), Qnil
);
7923 XSETBUFFER (AREF (vector
, i
), current_buffer
); ++i
;
7924 AREF (vector
, i
) = Vdeactivate_mark
, ++i
;
7925 AREF (vector
, i
) = make_number (windows_or_buffers_changed
), ++i
;
7929 XSETWINDOW (AREF (vector
, i
), w
); ++i
;
7930 AREF (vector
, i
) = w
->buffer
; ++i
;
7931 AREF (vector
, i
) = make_number (XMARKER (w
->pointm
)->charpos
); ++i
;
7932 AREF (vector
, i
) = make_number (XMARKER (w
->pointm
)->bytepos
); ++i
;
7937 for (; i
< end
; ++i
)
7938 AREF (vector
, i
) = Qnil
;
7941 xassert (i
== ASIZE (vector
));
7946 /* Restore global state from VECTOR which was created by
7947 with_echo_area_buffer_unwind_data. */
7950 unwind_with_echo_area_buffer (vector
)
7953 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
7954 Vdeactivate_mark
= AREF (vector
, 1);
7955 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
7957 if (WINDOWP (AREF (vector
, 3)))
7960 Lisp_Object buffer
, charpos
, bytepos
;
7962 w
= XWINDOW (AREF (vector
, 3));
7963 buffer
= AREF (vector
, 4);
7964 charpos
= AREF (vector
, 5);
7965 bytepos
= AREF (vector
, 6);
7968 set_marker_both (w
->pointm
, buffer
,
7969 XFASTINT (charpos
), XFASTINT (bytepos
));
7972 Vwith_echo_area_save_vector
= vector
;
7977 /* Set up the echo area for use by print functions. MULTIBYTE_P
7978 non-zero means we will print multibyte. */
7981 setup_echo_area_for_printing (multibyte_p
)
7984 /* If we can't find an echo area any more, exit. */
7985 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
7988 ensure_echo_area_buffers ();
7990 if (!message_buf_print
)
7992 /* A message has been output since the last time we printed.
7993 Choose a fresh echo area buffer. */
7994 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
7995 echo_area_buffer
[0] = echo_buffer
[1];
7997 echo_area_buffer
[0] = echo_buffer
[0];
7999 /* Switch to that buffer and clear it. */
8000 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8001 current_buffer
->truncate_lines
= Qnil
;
8005 int count
= SPECPDL_INDEX ();
8006 specbind (Qinhibit_read_only
, Qt
);
8007 /* Note that undo recording is always disabled. */
8009 unbind_to (count
, Qnil
);
8011 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8013 /* Set up the buffer for the multibyteness we need. */
8015 != !NILP (current_buffer
->enable_multibyte_characters
))
8016 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
8018 /* Raise the frame containing the echo area. */
8019 if (minibuffer_auto_raise
)
8021 struct frame
*sf
= SELECTED_FRAME ();
8022 Lisp_Object mini_window
;
8023 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8024 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8027 message_log_maybe_newline ();
8028 message_buf_print
= 1;
8032 if (NILP (echo_area_buffer
[0]))
8034 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8035 echo_area_buffer
[0] = echo_buffer
[1];
8037 echo_area_buffer
[0] = echo_buffer
[0];
8040 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
8042 /* Someone switched buffers between print requests. */
8043 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8044 current_buffer
->truncate_lines
= Qnil
;
8050 /* Display an echo area message in window W. Value is non-zero if W's
8051 height is changed. If display_last_displayed_message_p is
8052 non-zero, display the message that was last displayed, otherwise
8053 display the current message. */
8056 display_echo_area (w
)
8059 int i
, no_message_p
, window_height_changed_p
, count
;
8061 /* Temporarily disable garbage collections while displaying the echo
8062 area. This is done because a GC can print a message itself.
8063 That message would modify the echo area buffer's contents while a
8064 redisplay of the buffer is going on, and seriously confuse
8066 count
= inhibit_garbage_collection ();
8068 /* If there is no message, we must call display_echo_area_1
8069 nevertheless because it resizes the window. But we will have to
8070 reset the echo_area_buffer in question to nil at the end because
8071 with_echo_area_buffer will sets it to an empty buffer. */
8072 i
= display_last_displayed_message_p
? 1 : 0;
8073 no_message_p
= NILP (echo_area_buffer
[i
]);
8075 window_height_changed_p
8076 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
8077 display_echo_area_1
,
8078 (EMACS_INT
) w
, Qnil
, 0, 0);
8081 echo_area_buffer
[i
] = Qnil
;
8083 unbind_to (count
, Qnil
);
8084 return window_height_changed_p
;
8088 /* Helper for display_echo_area. Display the current buffer which
8089 contains the current echo area message in window W, a mini-window,
8090 a pointer to which is passed in A1. A2..A4 are currently not used.
8091 Change the height of W so that all of the message is displayed.
8092 Value is non-zero if height of W was changed. */
8095 display_echo_area_1 (a1
, a2
, a3
, a4
)
8100 struct window
*w
= (struct window
*) a1
;
8102 struct text_pos start
;
8103 int window_height_changed_p
= 0;
8105 /* Do this before displaying, so that we have a large enough glyph
8106 matrix for the display. If we can't get enough space for the
8107 whole text, display the last N lines. That works by setting w->start. */
8108 window_height_changed_p
= resize_mini_window (w
, 0);
8110 /* Use the starting position chosen by resize_mini_window. */
8111 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
8114 clear_glyph_matrix (w
->desired_matrix
);
8115 XSETWINDOW (window
, w
);
8116 try_window (window
, start
, 0);
8118 return window_height_changed_p
;
8122 /* Resize the echo area window to exactly the size needed for the
8123 currently displayed message, if there is one. If a mini-buffer
8124 is active, don't shrink it. */
8127 resize_echo_area_exactly ()
8129 if (BUFFERP (echo_area_buffer
[0])
8130 && WINDOWP (echo_area_window
))
8132 struct window
*w
= XWINDOW (echo_area_window
);
8134 Lisp_Object resize_exactly
;
8136 if (minibuf_level
== 0)
8137 resize_exactly
= Qt
;
8139 resize_exactly
= Qnil
;
8141 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
8142 (EMACS_INT
) w
, resize_exactly
, 0, 0);
8145 ++windows_or_buffers_changed
;
8146 ++update_mode_lines
;
8147 redisplay_internal (0);
8153 /* Callback function for with_echo_area_buffer, when used from
8154 resize_echo_area_exactly. A1 contains a pointer to the window to
8155 resize, EXACTLY non-nil means resize the mini-window exactly to the
8156 size of the text displayed. A3 and A4 are not used. Value is what
8157 resize_mini_window returns. */
8160 resize_mini_window_1 (a1
, exactly
, a3
, a4
)
8162 Lisp_Object exactly
;
8165 return resize_mini_window ((struct window
*) a1
, !NILP (exactly
));
8169 /* Resize mini-window W to fit the size of its contents. EXACT:P
8170 means size the window exactly to the size needed. Otherwise, it's
8171 only enlarged until W's buffer is empty.
8173 Set W->start to the right place to begin display. If the whole
8174 contents fit, start at the beginning. Otherwise, start so as
8175 to make the end of the contents appear. This is particularly
8176 important for y-or-n-p, but seems desirable generally.
8178 Value is non-zero if the window height has been changed. */
8181 resize_mini_window (w
, exact_p
)
8185 struct frame
*f
= XFRAME (w
->frame
);
8186 int window_height_changed_p
= 0;
8188 xassert (MINI_WINDOW_P (w
));
8190 /* By default, start display at the beginning. */
8191 set_marker_both (w
->start
, w
->buffer
,
8192 BUF_BEGV (XBUFFER (w
->buffer
)),
8193 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
8195 /* Don't resize windows while redisplaying a window; it would
8196 confuse redisplay functions when the size of the window they are
8197 displaying changes from under them. Such a resizing can happen,
8198 for instance, when which-func prints a long message while
8199 we are running fontification-functions. We're running these
8200 functions with safe_call which binds inhibit-redisplay to t. */
8201 if (!NILP (Vinhibit_redisplay
))
8204 /* Nil means don't try to resize. */
8205 if (NILP (Vresize_mini_windows
)
8206 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
8209 if (!FRAME_MINIBUF_ONLY_P (f
))
8212 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
8213 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
8214 int height
, max_height
;
8215 int unit
= FRAME_LINE_HEIGHT (f
);
8216 struct text_pos start
;
8217 struct buffer
*old_current_buffer
= NULL
;
8219 if (current_buffer
!= XBUFFER (w
->buffer
))
8221 old_current_buffer
= current_buffer
;
8222 set_buffer_internal (XBUFFER (w
->buffer
));
8225 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8227 /* Compute the max. number of lines specified by the user. */
8228 if (FLOATP (Vmax_mini_window_height
))
8229 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
8230 else if (INTEGERP (Vmax_mini_window_height
))
8231 max_height
= XINT (Vmax_mini_window_height
);
8233 max_height
= total_height
/ 4;
8235 /* Correct that max. height if it's bogus. */
8236 max_height
= max (1, max_height
);
8237 max_height
= min (total_height
, max_height
);
8239 /* Find out the height of the text in the window. */
8240 if (it
.truncate_lines_p
)
8245 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
8246 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
8247 height
= it
.current_y
+ last_height
;
8249 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
8250 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
8251 height
= (height
+ unit
- 1) / unit
;
8254 /* Compute a suitable window start. */
8255 if (height
> max_height
)
8257 height
= max_height
;
8258 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8259 move_it_vertically_backward (&it
, (height
- 1) * unit
);
8260 start
= it
.current
.pos
;
8263 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
8264 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
8266 if (EQ (Vresize_mini_windows
, Qgrow_only
))
8268 /* Let it grow only, until we display an empty message, in which
8269 case the window shrinks again. */
8270 if (height
> WINDOW_TOTAL_LINES (w
))
8272 int old_height
= WINDOW_TOTAL_LINES (w
);
8273 freeze_window_starts (f
, 1);
8274 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8275 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8277 else if (height
< WINDOW_TOTAL_LINES (w
)
8278 && (exact_p
|| BEGV
== ZV
))
8280 int old_height
= WINDOW_TOTAL_LINES (w
);
8281 freeze_window_starts (f
, 0);
8282 shrink_mini_window (w
);
8283 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8288 /* Always resize to exact size needed. */
8289 if (height
> WINDOW_TOTAL_LINES (w
))
8291 int old_height
= WINDOW_TOTAL_LINES (w
);
8292 freeze_window_starts (f
, 1);
8293 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8294 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8296 else if (height
< WINDOW_TOTAL_LINES (w
))
8298 int old_height
= WINDOW_TOTAL_LINES (w
);
8299 freeze_window_starts (f
, 0);
8300 shrink_mini_window (w
);
8304 freeze_window_starts (f
, 1);
8305 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8308 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8312 if (old_current_buffer
)
8313 set_buffer_internal (old_current_buffer
);
8316 return window_height_changed_p
;
8320 /* Value is the current message, a string, or nil if there is no
8328 if (NILP (echo_area_buffer
[0]))
8332 with_echo_area_buffer (0, 0, current_message_1
,
8333 (EMACS_INT
) &msg
, Qnil
, 0, 0);
8335 echo_area_buffer
[0] = Qnil
;
8343 current_message_1 (a1
, a2
, a3
, a4
)
8348 Lisp_Object
*msg
= (Lisp_Object
*) a1
;
8351 *msg
= make_buffer_string (BEG
, Z
, 1);
8358 /* Push the current message on Vmessage_stack for later restauration
8359 by restore_message. Value is non-zero if the current message isn't
8360 empty. This is a relatively infrequent operation, so it's not
8361 worth optimizing. */
8367 msg
= current_message ();
8368 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
8369 return STRINGP (msg
);
8373 /* Restore message display from the top of Vmessage_stack. */
8380 xassert (CONSP (Vmessage_stack
));
8381 msg
= XCAR (Vmessage_stack
);
8383 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
8385 message3_nolog (msg
, 0, 0);
8389 /* Handler for record_unwind_protect calling pop_message. */
8392 pop_message_unwind (dummy
)
8399 /* Pop the top-most entry off Vmessage_stack. */
8404 xassert (CONSP (Vmessage_stack
));
8405 Vmessage_stack
= XCDR (Vmessage_stack
);
8409 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
8410 exits. If the stack is not empty, we have a missing pop_message
8414 check_message_stack ()
8416 if (!NILP (Vmessage_stack
))
8421 /* Truncate to NCHARS what will be displayed in the echo area the next
8422 time we display it---but don't redisplay it now. */
8425 truncate_echo_area (nchars
)
8429 echo_area_buffer
[0] = Qnil
;
8430 /* A null message buffer means that the frame hasn't really been
8431 initialized yet. Error messages get reported properly by
8432 cmd_error, so this must be just an informative message; toss it. */
8433 else if (!noninteractive
8435 && !NILP (echo_area_buffer
[0]))
8437 struct frame
*sf
= SELECTED_FRAME ();
8438 if (FRAME_MESSAGE_BUF (sf
))
8439 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
8444 /* Helper function for truncate_echo_area. Truncate the current
8445 message to at most NCHARS characters. */
8448 truncate_message_1 (nchars
, a2
, a3
, a4
)
8453 if (BEG
+ nchars
< Z
)
8454 del_range (BEG
+ nchars
, Z
);
8456 echo_area_buffer
[0] = Qnil
;
8461 /* Set the current message to a substring of S or STRING.
8463 If STRING is a Lisp string, set the message to the first NBYTES
8464 bytes from STRING. NBYTES zero means use the whole string. If
8465 STRING is multibyte, the message will be displayed multibyte.
8467 If S is not null, set the message to the first LEN bytes of S. LEN
8468 zero means use the whole string. MULTIBYTE_P non-zero means S is
8469 multibyte. Display the message multibyte in that case.
8471 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
8472 to t before calling set_message_1 (which calls insert).
8476 set_message (s
, string
, nbytes
, multibyte_p
)
8479 int nbytes
, multibyte_p
;
8481 message_enable_multibyte
8482 = ((s
&& multibyte_p
)
8483 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
8485 with_echo_area_buffer (0, 0, set_message_1
,
8486 (EMACS_INT
) s
, string
, nbytes
, multibyte_p
);
8487 message_buf_print
= 0;
8488 help_echo_showing_p
= 0;
8492 /* Helper function for set_message. Arguments have the same meaning
8493 as there, with A1 corresponding to S and A2 corresponding to STRING
8494 This function is called with the echo area buffer being
8498 set_message_1 (a1
, a2
, nbytes
, multibyte_p
)
8501 EMACS_INT nbytes
, multibyte_p
;
8503 const char *s
= (const char *) a1
;
8504 Lisp_Object string
= a2
;
8506 /* Change multibyteness of the echo buffer appropriately. */
8507 if (message_enable_multibyte
8508 != !NILP (current_buffer
->enable_multibyte_characters
))
8509 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
8511 current_buffer
->truncate_lines
= message_truncate_lines
? Qt
: Qnil
;
8513 /* Insert new message at BEG. */
8514 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8517 if (STRINGP (string
))
8522 nbytes
= SBYTES (string
);
8523 nchars
= string_byte_to_char (string
, nbytes
);
8525 /* This function takes care of single/multibyte conversion. We
8526 just have to ensure that the echo area buffer has the right
8527 setting of enable_multibyte_characters. */
8528 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
8533 nbytes
= strlen (s
);
8535 if (multibyte_p
&& NILP (current_buffer
->enable_multibyte_characters
))
8537 /* Convert from multi-byte to single-byte. */
8539 unsigned char work
[1];
8541 /* Convert a multibyte string to single-byte. */
8542 for (i
= 0; i
< nbytes
; i
+= n
)
8544 c
= string_char_and_length (s
+ i
, nbytes
- i
, &n
);
8545 work
[0] = (SINGLE_BYTE_CHAR_P (c
)
8547 : multibyte_char_to_unibyte (c
, Qnil
));
8548 insert_1_both (work
, 1, 1, 1, 0, 0);
8551 else if (!multibyte_p
8552 && !NILP (current_buffer
->enable_multibyte_characters
))
8554 /* Convert from single-byte to multi-byte. */
8556 const unsigned char *msg
= (const unsigned char *) s
;
8557 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
8559 /* Convert a single-byte string to multibyte. */
8560 for (i
= 0; i
< nbytes
; i
++)
8562 c
= unibyte_char_to_multibyte (msg
[i
]);
8563 n
= CHAR_STRING (c
, str
);
8564 insert_1_both (str
, 1, n
, 1, 0, 0);
8568 insert_1 (s
, nbytes
, 1, 0, 0);
8575 /* Clear messages. CURRENT_P non-zero means clear the current
8576 message. LAST_DISPLAYED_P non-zero means clear the message
8580 clear_message (current_p
, last_displayed_p
)
8581 int current_p
, last_displayed_p
;
8585 echo_area_buffer
[0] = Qnil
;
8586 message_cleared_p
= 1;
8589 if (last_displayed_p
)
8590 echo_area_buffer
[1] = Qnil
;
8592 message_buf_print
= 0;
8595 /* Clear garbaged frames.
8597 This function is used where the old redisplay called
8598 redraw_garbaged_frames which in turn called redraw_frame which in
8599 turn called clear_frame. The call to clear_frame was a source of
8600 flickering. I believe a clear_frame is not necessary. It should
8601 suffice in the new redisplay to invalidate all current matrices,
8602 and ensure a complete redisplay of all windows. */
8605 clear_garbaged_frames ()
8609 Lisp_Object tail
, frame
;
8610 int changed_count
= 0;
8612 FOR_EACH_FRAME (tail
, frame
)
8614 struct frame
*f
= XFRAME (frame
);
8616 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
8620 Fredraw_frame (frame
);
8621 f
->force_flush_display_p
= 1;
8623 clear_current_matrices (f
);
8632 ++windows_or_buffers_changed
;
8637 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
8638 is non-zero update selected_frame. Value is non-zero if the
8639 mini-windows height has been changed. */
8642 echo_area_display (update_frame_p
)
8645 Lisp_Object mini_window
;
8648 int window_height_changed_p
= 0;
8649 struct frame
*sf
= SELECTED_FRAME ();
8651 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8652 w
= XWINDOW (mini_window
);
8653 f
= XFRAME (WINDOW_FRAME (w
));
8655 /* Don't display if frame is invisible or not yet initialized. */
8656 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
8659 /* The terminal frame is used as the first Emacs frame on the Mac OS. */
8661 #ifdef HAVE_WINDOW_SYSTEM
8662 /* When Emacs starts, selected_frame may be a visible terminal
8663 frame, even if we run under a window system. If we let this
8664 through, a message would be displayed on the terminal. */
8665 if (EQ (selected_frame
, Vterminal_frame
)
8666 && !NILP (Vwindow_system
))
8668 #endif /* HAVE_WINDOW_SYSTEM */
8671 /* Redraw garbaged frames. */
8673 clear_garbaged_frames ();
8675 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
8677 echo_area_window
= mini_window
;
8678 window_height_changed_p
= display_echo_area (w
);
8679 w
->must_be_updated_p
= 1;
8681 /* Update the display, unless called from redisplay_internal.
8682 Also don't update the screen during redisplay itself. The
8683 update will happen at the end of redisplay, and an update
8684 here could cause confusion. */
8685 if (update_frame_p
&& !redisplaying_p
)
8689 /* If the display update has been interrupted by pending
8690 input, update mode lines in the frame. Due to the
8691 pending input, it might have been that redisplay hasn't
8692 been called, so that mode lines above the echo area are
8693 garbaged. This looks odd, so we prevent it here. */
8694 if (!display_completed
)
8695 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
8697 if (window_height_changed_p
8698 /* Don't do this if Emacs is shutting down. Redisplay
8699 needs to run hooks. */
8700 && !NILP (Vrun_hooks
))
8702 /* Must update other windows. Likewise as in other
8703 cases, don't let this update be interrupted by
8705 int count
= SPECPDL_INDEX ();
8706 specbind (Qredisplay_dont_pause
, Qt
);
8707 windows_or_buffers_changed
= 1;
8708 redisplay_internal (0);
8709 unbind_to (count
, Qnil
);
8711 else if (FRAME_WINDOW_P (f
) && n
== 0)
8713 /* Window configuration is the same as before.
8714 Can do with a display update of the echo area,
8715 unless we displayed some mode lines. */
8716 update_single_window (w
, 1);
8717 rif
->flush_display (f
);
8720 update_frame (f
, 1, 1);
8722 /* If cursor is in the echo area, make sure that the next
8723 redisplay displays the minibuffer, so that the cursor will
8724 be replaced with what the minibuffer wants. */
8725 if (cursor_in_echo_area
)
8726 ++windows_or_buffers_changed
;
8729 else if (!EQ (mini_window
, selected_window
))
8730 windows_or_buffers_changed
++;
8732 /* The current message is now also the last one displayed. */
8733 echo_area_buffer
[1] = echo_area_buffer
[0];
8735 /* Prevent redisplay optimization in redisplay_internal by resetting
8736 this_line_start_pos. This is done because the mini-buffer now
8737 displays the message instead of its buffer text. */
8738 if (EQ (mini_window
, selected_window
))
8739 CHARPOS (this_line_start_pos
) = 0;
8741 return window_height_changed_p
;
8746 /***********************************************************************
8747 Mode Lines and Frame Titles
8748 ***********************************************************************/
8750 /* A buffer for constructing non-propertized mode-line strings and
8751 frame titles in it; allocated from the heap in init_xdisp and
8752 resized as needed in store_mode_line_noprop_char. */
8754 static char *mode_line_noprop_buf
;
8756 /* The buffer's end, and a current output position in it. */
8758 static char *mode_line_noprop_buf_end
;
8759 static char *mode_line_noprop_ptr
;
8761 #define MODE_LINE_NOPROP_LEN(start) \
8762 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
8765 MODE_LINE_DISPLAY
= 0,
8771 /* Alist that caches the results of :propertize.
8772 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
8773 static Lisp_Object mode_line_proptrans_alist
;
8775 /* List of strings making up the mode-line. */
8776 static Lisp_Object mode_line_string_list
;
8778 /* Base face property when building propertized mode line string. */
8779 static Lisp_Object mode_line_string_face
;
8780 static Lisp_Object mode_line_string_face_prop
;
8783 /* Unwind data for mode line strings */
8785 static Lisp_Object Vmode_line_unwind_vector
;
8788 format_mode_line_unwind_data (obuf
, save_proptrans
)
8789 struct buffer
*obuf
;
8793 /* Reduce consing by keeping one vector in
8794 Vwith_echo_area_save_vector. */
8795 vector
= Vmode_line_unwind_vector
;
8796 Vmode_line_unwind_vector
= Qnil
;
8799 vector
= Fmake_vector (make_number (7), Qnil
);
8801 AREF (vector
, 0) = make_number (mode_line_target
);
8802 AREF (vector
, 1) = make_number (MODE_LINE_NOPROP_LEN (0));
8803 AREF (vector
, 2) = mode_line_string_list
;
8804 AREF (vector
, 3) = (save_proptrans
? mode_line_proptrans_alist
: Qt
);
8805 AREF (vector
, 4) = mode_line_string_face
;
8806 AREF (vector
, 5) = mode_line_string_face_prop
;
8809 XSETBUFFER (AREF (vector
, 6), obuf
);
8811 AREF (vector
, 6) = Qnil
;
8817 unwind_format_mode_line (vector
)
8820 mode_line_target
= XINT (AREF (vector
, 0));
8821 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
8822 mode_line_string_list
= AREF (vector
, 2);
8823 if (! EQ (AREF (vector
, 3), Qt
))
8824 mode_line_proptrans_alist
= AREF (vector
, 3);
8825 mode_line_string_face
= AREF (vector
, 4);
8826 mode_line_string_face_prop
= AREF (vector
, 5);
8828 if (!NILP (AREF (vector
, 6)))
8830 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
8831 AREF (vector
, 6) = Qnil
;
8834 Vmode_line_unwind_vector
= vector
;
8839 /* Store a single character C for the frame title in mode_line_noprop_buf.
8840 Re-allocate mode_line_noprop_buf if necessary. */
8844 store_mode_line_noprop_char (char c
)
8846 store_mode_line_noprop_char (c
)
8850 /* If output position has reached the end of the allocated buffer,
8851 double the buffer's size. */
8852 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
8854 int len
= MODE_LINE_NOPROP_LEN (0);
8855 int new_size
= 2 * len
* sizeof *mode_line_noprop_buf
;
8856 mode_line_noprop_buf
= (char *) xrealloc (mode_line_noprop_buf
, new_size
);
8857 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ new_size
;
8858 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
8861 *mode_line_noprop_ptr
++ = c
;
8865 /* Store part of a frame title in mode_line_noprop_buf, beginning at
8866 mode_line_noprop_ptr. STR is the string to store. Do not copy
8867 characters that yield more columns than PRECISION; PRECISION <= 0
8868 means copy the whole string. Pad with spaces until FIELD_WIDTH
8869 number of characters have been copied; FIELD_WIDTH <= 0 means don't
8870 pad. Called from display_mode_element when it is used to build a
8874 store_mode_line_noprop (str
, field_width
, precision
)
8875 const unsigned char *str
;
8876 int field_width
, precision
;
8881 /* Copy at most PRECISION chars from STR. */
8882 nbytes
= strlen (str
);
8883 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
8885 store_mode_line_noprop_char (*str
++);
8887 /* Fill up with spaces until FIELD_WIDTH reached. */
8888 while (field_width
> 0
8891 store_mode_line_noprop_char (' ');
8898 /***********************************************************************
8900 ***********************************************************************/
8902 #ifdef HAVE_WINDOW_SYSTEM
8904 /* Set the title of FRAME, if it has changed. The title format is
8905 Vicon_title_format if FRAME is iconified, otherwise it is
8906 frame_title_format. */
8909 x_consider_frame_title (frame
)
8912 struct frame
*f
= XFRAME (frame
);
8914 if (FRAME_WINDOW_P (f
)
8915 || FRAME_MINIBUF_ONLY_P (f
)
8916 || f
->explicit_name
)
8918 /* Do we have more than one visible frame on this X display? */
8925 int count
= SPECPDL_INDEX ();
8927 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
8929 Lisp_Object other_frame
= XCAR (tail
);
8930 struct frame
*tf
= XFRAME (other_frame
);
8933 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
8934 && !FRAME_MINIBUF_ONLY_P (tf
)
8935 && !EQ (other_frame
, tip_frame
)
8936 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
8940 /* Set global variable indicating that multiple frames exist. */
8941 multiple_frames
= CONSP (tail
);
8943 /* Switch to the buffer of selected window of the frame. Set up
8944 mode_line_target so that display_mode_element will output into
8945 mode_line_noprop_buf; then display the title. */
8946 record_unwind_protect (unwind_format_mode_line
,
8947 format_mode_line_unwind_data (current_buffer
, 0));
8949 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
8950 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
8952 mode_line_target
= MODE_LINE_TITLE
;
8953 title_start
= MODE_LINE_NOPROP_LEN (0);
8954 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
8955 NULL
, DEFAULT_FACE_ID
);
8956 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
8957 len
= MODE_LINE_NOPROP_LEN (title_start
);
8958 title
= mode_line_noprop_buf
+ title_start
;
8959 unbind_to (count
, Qnil
);
8961 /* Set the title only if it's changed. This avoids consing in
8962 the common case where it hasn't. (If it turns out that we've
8963 already wasted too much time by walking through the list with
8964 display_mode_element, then we might need to optimize at a
8965 higher level than this.) */
8966 if (! STRINGP (f
->name
)
8967 || SBYTES (f
->name
) != len
8968 || bcmp (title
, SDATA (f
->name
), len
) != 0)
8969 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
8973 #endif /* not HAVE_WINDOW_SYSTEM */
8978 /***********************************************************************
8980 ***********************************************************************/
8983 /* Prepare for redisplay by updating menu-bar item lists when
8984 appropriate. This can call eval. */
8987 prepare_menu_bars ()
8990 struct gcpro gcpro1
, gcpro2
;
8992 Lisp_Object tooltip_frame
;
8994 #ifdef HAVE_WINDOW_SYSTEM
8995 tooltip_frame
= tip_frame
;
8997 tooltip_frame
= Qnil
;
9000 /* Update all frame titles based on their buffer names, etc. We do
9001 this before the menu bars so that the buffer-menu will show the
9002 up-to-date frame titles. */
9003 #ifdef HAVE_WINDOW_SYSTEM
9004 if (windows_or_buffers_changed
|| update_mode_lines
)
9006 Lisp_Object tail
, frame
;
9008 FOR_EACH_FRAME (tail
, frame
)
9011 if (!EQ (frame
, tooltip_frame
)
9012 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
9013 x_consider_frame_title (frame
);
9016 #endif /* HAVE_WINDOW_SYSTEM */
9018 /* Update the menu bar item lists, if appropriate. This has to be
9019 done before any actual redisplay or generation of display lines. */
9020 all_windows
= (update_mode_lines
9021 || buffer_shared
> 1
9022 || windows_or_buffers_changed
);
9025 Lisp_Object tail
, frame
;
9026 int count
= SPECPDL_INDEX ();
9028 record_unwind_save_match_data ();
9030 FOR_EACH_FRAME (tail
, frame
)
9034 /* Ignore tooltip frame. */
9035 if (EQ (frame
, tooltip_frame
))
9038 /* If a window on this frame changed size, report that to
9039 the user and clear the size-change flag. */
9040 if (FRAME_WINDOW_SIZES_CHANGED (f
))
9042 Lisp_Object functions
;
9044 /* Clear flag first in case we get an error below. */
9045 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
9046 functions
= Vwindow_size_change_functions
;
9047 GCPRO2 (tail
, functions
);
9049 while (CONSP (functions
))
9051 call1 (XCAR (functions
), frame
);
9052 functions
= XCDR (functions
);
9058 update_menu_bar (f
, 0);
9059 #ifdef HAVE_WINDOW_SYSTEM
9060 update_tool_bar (f
, 0);
9062 mac_update_title_bar (f
, 0);
9068 unbind_to (count
, Qnil
);
9072 struct frame
*sf
= SELECTED_FRAME ();
9073 update_menu_bar (sf
, 1);
9074 #ifdef HAVE_WINDOW_SYSTEM
9075 update_tool_bar (sf
, 1);
9077 mac_update_title_bar (sf
, 1);
9082 /* Motif needs this. See comment in xmenu.c. Turn it off when
9083 pending_menu_activation is not defined. */
9084 #ifdef USE_X_TOOLKIT
9085 pending_menu_activation
= 0;
9090 /* Update the menu bar item list for frame F. This has to be done
9091 before we start to fill in any display lines, because it can call
9094 If SAVE_MATCH_DATA is non-zero, we must save and restore it here. */
9097 update_menu_bar (f
, save_match_data
)
9099 int save_match_data
;
9102 register struct window
*w
;
9104 /* If called recursively during a menu update, do nothing. This can
9105 happen when, for instance, an activate-menubar-hook causes a
9107 if (inhibit_menubar_update
)
9110 window
= FRAME_SELECTED_WINDOW (f
);
9111 w
= XWINDOW (window
);
9113 #if 0 /* The if statement below this if statement used to include the
9114 condition !NILP (w->update_mode_line), rather than using
9115 update_mode_lines directly, and this if statement may have
9116 been added to make that condition work. Now the if
9117 statement below matches its comment, this isn't needed. */
9118 if (update_mode_lines
)
9119 w
->update_mode_line
= Qt
;
9122 if (FRAME_WINDOW_P (f
)
9124 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
9125 || defined (USE_GTK)
9126 FRAME_EXTERNAL_MENU_BAR (f
)
9128 FRAME_MENU_BAR_LINES (f
) > 0
9130 : FRAME_MENU_BAR_LINES (f
) > 0)
9132 /* If the user has switched buffers or windows, we need to
9133 recompute to reflect the new bindings. But we'll
9134 recompute when update_mode_lines is set too; that means
9135 that people can use force-mode-line-update to request
9136 that the menu bar be recomputed. The adverse effect on
9137 the rest of the redisplay algorithm is about the same as
9138 windows_or_buffers_changed anyway. */
9139 if (windows_or_buffers_changed
9140 /* This used to test w->update_mode_line, but we believe
9141 there is no need to recompute the menu in that case. */
9142 || update_mode_lines
9143 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9144 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9145 != !NILP (w
->last_had_star
))
9146 || ((!NILP (Vtransient_mark_mode
)
9147 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
9148 != !NILP (w
->region_showing
)))
9150 struct buffer
*prev
= current_buffer
;
9151 int count
= SPECPDL_INDEX ();
9153 specbind (Qinhibit_menubar_update
, Qt
);
9155 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9156 if (save_match_data
)
9157 record_unwind_save_match_data ();
9158 if (NILP (Voverriding_local_map_menu_flag
))
9160 specbind (Qoverriding_terminal_local_map
, Qnil
);
9161 specbind (Qoverriding_local_map
, Qnil
);
9164 /* Run the Lucid hook. */
9165 safe_run_hooks (Qactivate_menubar_hook
);
9167 /* If it has changed current-menubar from previous value,
9168 really recompute the menu-bar from the value. */
9169 if (! NILP (Vlucid_menu_bar_dirty_flag
))
9170 call0 (Qrecompute_lucid_menubar
);
9172 safe_run_hooks (Qmenu_bar_update_hook
);
9173 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
9175 /* Redisplay the menu bar in case we changed it. */
9176 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
9177 || defined (USE_GTK)
9178 if (FRAME_WINDOW_P (f
))
9181 /* All frames on Mac OS share the same menubar. So only
9182 the selected frame should be allowed to set it. */
9183 if (f
== SELECTED_FRAME ())
9185 set_frame_menubar (f
, 0, 0);
9188 /* On a terminal screen, the menu bar is an ordinary screen
9189 line, and this makes it get updated. */
9190 w
->update_mode_line
= Qt
;
9191 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || MAC_OS || USE_GTK) */
9192 /* In the non-toolkit version, the menu bar is an ordinary screen
9193 line, and this makes it get updated. */
9194 w
->update_mode_line
= Qt
;
9195 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || MAC_OS || USE_GTK) */
9197 unbind_to (count
, Qnil
);
9198 set_buffer_internal_1 (prev
);
9205 /***********************************************************************
9207 ***********************************************************************/
9209 #ifdef HAVE_WINDOW_SYSTEM
9212 Nominal cursor position -- where to draw output.
9213 HPOS and VPOS are window relative glyph matrix coordinates.
9214 X and Y are window relative pixel coordinates. */
9216 struct cursor_pos output_cursor
;
9220 Set the global variable output_cursor to CURSOR. All cursor
9221 positions are relative to updated_window. */
9224 set_output_cursor (cursor
)
9225 struct cursor_pos
*cursor
;
9227 output_cursor
.hpos
= cursor
->hpos
;
9228 output_cursor
.vpos
= cursor
->vpos
;
9229 output_cursor
.x
= cursor
->x
;
9230 output_cursor
.y
= cursor
->y
;
9235 Set a nominal cursor position.
9237 HPOS and VPOS are column/row positions in a window glyph matrix. X
9238 and Y are window text area relative pixel positions.
9240 If this is done during an update, updated_window will contain the
9241 window that is being updated and the position is the future output
9242 cursor position for that window. If updated_window is null, use
9243 selected_window and display the cursor at the given position. */
9246 x_cursor_to (vpos
, hpos
, y
, x
)
9247 int vpos
, hpos
, y
, x
;
9251 /* If updated_window is not set, work on selected_window. */
9255 w
= XWINDOW (selected_window
);
9257 /* Set the output cursor. */
9258 output_cursor
.hpos
= hpos
;
9259 output_cursor
.vpos
= vpos
;
9260 output_cursor
.x
= x
;
9261 output_cursor
.y
= y
;
9263 /* If not called as part of an update, really display the cursor.
9264 This will also set the cursor position of W. */
9265 if (updated_window
== NULL
)
9268 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
9269 if (rif
->flush_display_optional
)
9270 rif
->flush_display_optional (SELECTED_FRAME ());
9275 #endif /* HAVE_WINDOW_SYSTEM */
9278 /***********************************************************************
9280 ***********************************************************************/
9282 #ifdef HAVE_WINDOW_SYSTEM
9284 /* Where the mouse was last time we reported a mouse event. */
9286 FRAME_PTR last_mouse_frame
;
9288 /* Tool-bar item index of the item on which a mouse button was pressed
9291 int last_tool_bar_item
;
9294 /* Update the tool-bar item list for frame F. This has to be done
9295 before we start to fill in any display lines. Called from
9296 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
9297 and restore it here. */
9300 update_tool_bar (f
, save_match_data
)
9302 int save_match_data
;
9305 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
9307 int do_update
= WINDOWP (f
->tool_bar_window
)
9308 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
9316 window
= FRAME_SELECTED_WINDOW (f
);
9317 w
= XWINDOW (window
);
9319 /* If the user has switched buffers or windows, we need to
9320 recompute to reflect the new bindings. But we'll
9321 recompute when update_mode_lines is set too; that means
9322 that people can use force-mode-line-update to request
9323 that the menu bar be recomputed. The adverse effect on
9324 the rest of the redisplay algorithm is about the same as
9325 windows_or_buffers_changed anyway. */
9326 if (windows_or_buffers_changed
9327 || !NILP (w
->update_mode_line
)
9328 || update_mode_lines
9329 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9330 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9331 != !NILP (w
->last_had_star
))
9332 || ((!NILP (Vtransient_mark_mode
)
9333 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
9334 != !NILP (w
->region_showing
)))
9336 struct buffer
*prev
= current_buffer
;
9337 int count
= SPECPDL_INDEX ();
9338 Lisp_Object new_tool_bar
;
9340 struct gcpro gcpro1
;
9342 /* Set current_buffer to the buffer of the selected
9343 window of the frame, so that we get the right local
9345 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9347 /* Save match data, if we must. */
9348 if (save_match_data
)
9349 record_unwind_save_match_data ();
9351 /* Make sure that we don't accidentally use bogus keymaps. */
9352 if (NILP (Voverriding_local_map_menu_flag
))
9354 specbind (Qoverriding_terminal_local_map
, Qnil
);
9355 specbind (Qoverriding_local_map
, Qnil
);
9358 GCPRO1 (new_tool_bar
);
9360 /* Build desired tool-bar items from keymaps. */
9361 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
9364 /* Redisplay the tool-bar if we changed it. */
9365 if (NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
9367 /* Redisplay that happens asynchronously due to an expose event
9368 may access f->tool_bar_items. Make sure we update both
9369 variables within BLOCK_INPUT so no such event interrupts. */
9371 f
->tool_bar_items
= new_tool_bar
;
9372 f
->n_tool_bar_items
= new_n_tool_bar
;
9373 w
->update_mode_line
= Qt
;
9379 unbind_to (count
, Qnil
);
9380 set_buffer_internal_1 (prev
);
9386 /* Set F->desired_tool_bar_string to a Lisp string representing frame
9387 F's desired tool-bar contents. F->tool_bar_items must have
9388 been set up previously by calling prepare_menu_bars. */
9391 build_desired_tool_bar_string (f
)
9394 int i
, size
, size_needed
;
9395 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9396 Lisp_Object image
, plist
, props
;
9398 image
= plist
= props
= Qnil
;
9399 GCPRO3 (image
, plist
, props
);
9401 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
9402 Otherwise, make a new string. */
9404 /* The size of the string we might be able to reuse. */
9405 size
= (STRINGP (f
->desired_tool_bar_string
)
9406 ? SCHARS (f
->desired_tool_bar_string
)
9409 /* We need one space in the string for each image. */
9410 size_needed
= f
->n_tool_bar_items
;
9412 /* Reuse f->desired_tool_bar_string, if possible. */
9413 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
9414 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
9418 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
9419 Fremove_text_properties (make_number (0), make_number (size
),
9420 props
, f
->desired_tool_bar_string
);
9423 /* Put a `display' property on the string for the images to display,
9424 put a `menu_item' property on tool-bar items with a value that
9425 is the index of the item in F's tool-bar item vector. */
9426 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
9428 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
9430 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
9431 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
9432 int hmargin
, vmargin
, relief
, idx
, end
;
9433 extern Lisp_Object QCrelief
, QCmargin
, QCconversion
;
9435 /* If image is a vector, choose the image according to the
9437 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
9438 if (VECTORP (image
))
9442 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
9443 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
9446 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
9447 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
9449 xassert (ASIZE (image
) >= idx
);
9450 image
= AREF (image
, idx
);
9455 /* Ignore invalid image specifications. */
9456 if (!valid_image_p (image
))
9459 /* Display the tool-bar button pressed, or depressed. */
9460 plist
= Fcopy_sequence (XCDR (image
));
9462 /* Compute margin and relief to draw. */
9463 relief
= (tool_bar_button_relief
>= 0
9464 ? tool_bar_button_relief
9465 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
9466 hmargin
= vmargin
= relief
;
9468 if (INTEGERP (Vtool_bar_button_margin
)
9469 && XINT (Vtool_bar_button_margin
) > 0)
9471 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
9472 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
9474 else if (CONSP (Vtool_bar_button_margin
))
9476 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
9477 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
9478 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
9480 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
9481 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
9482 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
9485 if (auto_raise_tool_bar_buttons_p
)
9487 /* Add a `:relief' property to the image spec if the item is
9491 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
9498 /* If image is selected, display it pressed, i.e. with a
9499 negative relief. If it's not selected, display it with a
9501 plist
= Fplist_put (plist
, QCrelief
,
9503 ? make_number (-relief
)
9504 : make_number (relief
)));
9509 /* Put a margin around the image. */
9510 if (hmargin
|| vmargin
)
9512 if (hmargin
== vmargin
)
9513 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
9515 plist
= Fplist_put (plist
, QCmargin
,
9516 Fcons (make_number (hmargin
),
9517 make_number (vmargin
)));
9520 /* If button is not enabled, and we don't have special images
9521 for the disabled state, make the image appear disabled by
9522 applying an appropriate algorithm to it. */
9523 if (!enabled_p
&& idx
< 0)
9524 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
9526 /* Put a `display' text property on the string for the image to
9527 display. Put a `menu-item' property on the string that gives
9528 the start of this item's properties in the tool-bar items
9530 image
= Fcons (Qimage
, plist
);
9531 props
= list4 (Qdisplay
, image
,
9532 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
9534 /* Let the last image hide all remaining spaces in the tool bar
9535 string. The string can be longer than needed when we reuse a
9537 if (i
+ 1 == f
->n_tool_bar_items
)
9538 end
= SCHARS (f
->desired_tool_bar_string
);
9541 Fadd_text_properties (make_number (i
), make_number (end
),
9542 props
, f
->desired_tool_bar_string
);
9550 /* Display one line of the tool-bar of frame IT->f.
9552 HEIGHT specifies the desired height of the tool-bar line.
9553 If the actual height of the glyph row is less than HEIGHT, the
9554 row's height is increased to HEIGHT, and the icons are centered
9555 vertically in the new height.
9557 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
9558 count a final empty row in case the tool-bar width exactly matches
9563 display_tool_bar_line (it
, height
)
9567 struct glyph_row
*row
= it
->glyph_row
;
9568 int max_x
= it
->last_visible_x
;
9571 prepare_desired_row (row
);
9572 row
->y
= it
->current_y
;
9574 /* Note that this isn't made use of if the face hasn't a box,
9575 so there's no need to check the face here. */
9576 it
->start_of_box_run_p
= 1;
9578 while (it
->current_x
< max_x
)
9580 int x
, n_glyphs_before
, i
, nglyphs
;
9581 struct it it_before
;
9583 /* Get the next display element. */
9584 if (!get_next_display_element (it
))
9586 /* Don't count empty row if we are counting needed tool-bar lines. */
9587 if (height
< 0 && !it
->hpos
)
9592 /* Produce glyphs. */
9593 n_glyphs_before
= row
->used
[TEXT_AREA
];
9596 PRODUCE_GLYPHS (it
);
9598 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
9600 x
= it_before
.current_x
;
9603 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
9605 if (x
+ glyph
->pixel_width
> max_x
)
9607 /* Glyph doesn't fit on line. Backtrack. */
9608 row
->used
[TEXT_AREA
] = n_glyphs_before
;
9614 x
+= glyph
->pixel_width
;
9618 /* Stop at line ends. */
9619 if (ITERATOR_AT_END_OF_LINE_P (it
))
9622 set_iterator_to_next (it
, 1);
9627 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
9628 /* Use default face for the border below the tool bar. */
9629 if (!row
->displays_text_p
)
9630 it
->face_id
= DEFAULT_FACE_ID
;
9631 extend_face_to_end_of_line (it
);
9632 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
9633 last
->right_box_line_p
= 1;
9634 if (last
== row
->glyphs
[TEXT_AREA
])
9635 last
->left_box_line_p
= 1;
9637 /* Make line the desired height and center it vertically. */
9638 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
9640 /* Don't add more than one line height. */
9641 height
%= FRAME_LINE_HEIGHT (it
->f
);
9642 it
->max_ascent
+= height
/ 2;
9643 it
->max_descent
+= (height
+ 1) / 2;
9646 compute_line_metrics (it
);
9648 /* If line is empty, make it occupy the rest of the tool-bar. */
9649 if (!row
->displays_text_p
)
9651 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
9652 row
->ascent
= row
->phys_ascent
= 0;
9653 row
->extra_line_spacing
= 0;
9656 row
->full_width_p
= 1;
9657 row
->continued_p
= 0;
9658 row
->truncated_on_left_p
= 0;
9659 row
->truncated_on_right_p
= 0;
9661 it
->current_x
= it
->hpos
= 0;
9662 it
->current_y
+= row
->height
;
9668 /* Value is the number of screen lines needed to make all tool-bar
9669 items of frame F visible. The number of actual rows needed is
9670 returned in *N_ROWS if non-NULL. */
9673 tool_bar_lines_needed (f
, n_rows
)
9677 struct window
*w
= XWINDOW (f
->tool_bar_window
);
9679 struct glyph_row
*temp_row
= w
->desired_matrix
->rows
;
9681 /* Initialize an iterator for iteration over
9682 F->desired_tool_bar_string in the tool-bar window of frame F. */
9683 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
9684 it
.first_visible_x
= 0;
9685 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
9686 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
9688 while (!ITERATOR_AT_END_P (&it
))
9690 clear_glyph_row (temp_row
);
9691 it
.glyph_row
= temp_row
;
9692 display_tool_bar_line (&it
, -1);
9694 clear_glyph_row (temp_row
);
9696 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
9698 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
9700 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
9704 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
9706 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
9715 frame
= selected_frame
;
9717 CHECK_FRAME (frame
);
9720 if (WINDOWP (f
->tool_bar_window
)
9721 || (w
= XWINDOW (f
->tool_bar_window
),
9722 WINDOW_TOTAL_LINES (w
) > 0))
9724 update_tool_bar (f
, 1);
9725 if (f
->n_tool_bar_items
)
9727 build_desired_tool_bar_string (f
);
9728 nlines
= tool_bar_lines_needed (f
, NULL
);
9732 return make_number (nlines
);
9736 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
9737 height should be changed. */
9740 redisplay_tool_bar (f
)
9745 struct glyph_row
*row
;
9746 int change_height_p
= 0;
9749 if (FRAME_EXTERNAL_TOOL_BAR (f
))
9750 update_frame_tool_bar (f
);
9754 /* If frame hasn't a tool-bar window or if it is zero-height, don't
9755 do anything. This means you must start with tool-bar-lines
9756 non-zero to get the auto-sizing effect. Or in other words, you
9757 can turn off tool-bars by specifying tool-bar-lines zero. */
9758 if (!WINDOWP (f
->tool_bar_window
)
9759 || (w
= XWINDOW (f
->tool_bar_window
),
9760 WINDOW_TOTAL_LINES (w
) == 0))
9763 /* Set up an iterator for the tool-bar window. */
9764 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
9765 it
.first_visible_x
= 0;
9766 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
9769 /* Build a string that represents the contents of the tool-bar. */
9770 build_desired_tool_bar_string (f
);
9771 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
9773 if (f
->n_tool_bar_rows
== 0)
9777 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
9778 nlines
!= WINDOW_TOTAL_LINES (w
)))
9780 extern Lisp_Object Qtool_bar_lines
;
9782 int old_height
= WINDOW_TOTAL_LINES (w
);
9784 XSETFRAME (frame
, f
);
9785 clear_glyph_matrix (w
->desired_matrix
);
9786 Fmodify_frame_parameters (frame
,
9787 Fcons (Fcons (Qtool_bar_lines
,
9788 make_number (nlines
)),
9790 if (WINDOW_TOTAL_LINES (w
) != old_height
)
9792 fonts_changed_p
= 1;
9798 /* Display as many lines as needed to display all tool-bar items. */
9800 if (f
->n_tool_bar_rows
> 0)
9802 int border
, rows
, height
, extra
;
9804 if (INTEGERP (Vtool_bar_border
))
9805 border
= XINT (Vtool_bar_border
);
9806 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
9807 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
9808 else if (EQ (Vtool_bar_border
, Qborder_width
))
9809 border
= f
->border_width
;
9815 rows
= f
->n_tool_bar_rows
;
9816 height
= max (1, (it
.last_visible_y
- border
) / rows
);
9817 extra
= it
.last_visible_y
- border
- height
* rows
;
9819 while (it
.current_y
< it
.last_visible_y
)
9822 if (extra
> 0 && rows
-- > 0)
9824 h
= (extra
+ rows
- 1) / rows
;
9827 display_tool_bar_line (&it
, height
+ h
);
9832 while (it
.current_y
< it
.last_visible_y
)
9833 display_tool_bar_line (&it
, 0);
9836 /* It doesn't make much sense to try scrolling in the tool-bar
9837 window, so don't do it. */
9838 w
->desired_matrix
->no_scrolling_p
= 1;
9839 w
->must_be_updated_p
= 1;
9841 if (auto_resize_tool_bars_p
)
9845 /* If we couldn't display everything, change the tool-bar's
9847 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
)
9848 change_height_p
= 1;
9850 /* If there are blank lines at the end, except for a partially
9851 visible blank line at the end that is smaller than
9852 FRAME_LINE_HEIGHT, change the tool-bar's height. */
9853 row
= it
.glyph_row
- 1;
9854 if (!row
->displays_text_p
9855 && row
->height
>= FRAME_LINE_HEIGHT (f
))
9856 change_height_p
= 1;
9858 /* If row displays tool-bar items, but is partially visible,
9859 change the tool-bar's height. */
9860 if (row
->displays_text_p
9861 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
)
9862 change_height_p
= 1;
9864 /* Resize windows as needed by changing the `tool-bar-lines'
9867 && (nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
9868 nlines
!= WINDOW_TOTAL_LINES (w
)))
9870 extern Lisp_Object Qtool_bar_lines
;
9872 int old_height
= WINDOW_TOTAL_LINES (w
);
9874 XSETFRAME (frame
, f
);
9875 clear_glyph_matrix (w
->desired_matrix
);
9876 Fmodify_frame_parameters (frame
,
9877 Fcons (Fcons (Qtool_bar_lines
,
9878 make_number (nlines
)),
9880 if (WINDOW_TOTAL_LINES (w
) != old_height
)
9881 fonts_changed_p
= 1;
9885 return change_height_p
;
9889 /* Get information about the tool-bar item which is displayed in GLYPH
9890 on frame F. Return in *PROP_IDX the index where tool-bar item
9891 properties start in F->tool_bar_items. Value is zero if
9892 GLYPH doesn't display a tool-bar item. */
9895 tool_bar_item_info (f
, glyph
, prop_idx
)
9897 struct glyph
*glyph
;
9904 /* This function can be called asynchronously, which means we must
9905 exclude any possibility that Fget_text_property signals an
9907 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
9908 charpos
= max (0, charpos
);
9910 /* Get the text property `menu-item' at pos. The value of that
9911 property is the start index of this item's properties in
9912 F->tool_bar_items. */
9913 prop
= Fget_text_property (make_number (charpos
),
9914 Qmenu_item
, f
->current_tool_bar_string
);
9915 if (INTEGERP (prop
))
9917 *prop_idx
= XINT (prop
);
9927 /* Get information about the tool-bar item at position X/Y on frame F.
9928 Return in *GLYPH a pointer to the glyph of the tool-bar item in
9929 the current matrix of the tool-bar window of F, or NULL if not
9930 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
9931 item in F->tool_bar_items. Value is
9933 -1 if X/Y is not on a tool-bar item
9934 0 if X/Y is on the same item that was highlighted before.
9938 get_tool_bar_item (f
, x
, y
, glyph
, hpos
, vpos
, prop_idx
)
9941 struct glyph
**glyph
;
9942 int *hpos
, *vpos
, *prop_idx
;
9944 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
9945 struct window
*w
= XWINDOW (f
->tool_bar_window
);
9948 /* Find the glyph under X/Y. */
9949 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
9953 /* Get the start of this tool-bar item's properties in
9954 f->tool_bar_items. */
9955 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
9958 /* Is mouse on the highlighted item? */
9959 if (EQ (f
->tool_bar_window
, dpyinfo
->mouse_face_window
)
9960 && *vpos
>= dpyinfo
->mouse_face_beg_row
9961 && *vpos
<= dpyinfo
->mouse_face_end_row
9962 && (*vpos
> dpyinfo
->mouse_face_beg_row
9963 || *hpos
>= dpyinfo
->mouse_face_beg_col
)
9964 && (*vpos
< dpyinfo
->mouse_face_end_row
9965 || *hpos
< dpyinfo
->mouse_face_end_col
9966 || dpyinfo
->mouse_face_past_end
))
9974 Handle mouse button event on the tool-bar of frame F, at
9975 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
9976 0 for button release. MODIFIERS is event modifiers for button
9980 handle_tool_bar_click (f
, x
, y
, down_p
, modifiers
)
9983 unsigned int modifiers
;
9985 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
9986 struct window
*w
= XWINDOW (f
->tool_bar_window
);
9987 int hpos
, vpos
, prop_idx
;
9988 struct glyph
*glyph
;
9989 Lisp_Object enabled_p
;
9991 /* If not on the highlighted tool-bar item, return. */
9992 frame_to_window_pixel_xy (w
, &x
, &y
);
9993 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
9996 /* If item is disabled, do nothing. */
9997 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
9998 if (NILP (enabled_p
))
10003 /* Show item in pressed state. */
10004 show_mouse_face (dpyinfo
, DRAW_IMAGE_SUNKEN
);
10005 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
10006 last_tool_bar_item
= prop_idx
;
10010 Lisp_Object key
, frame
;
10011 struct input_event event
;
10012 EVENT_INIT (event
);
10014 /* Show item in released state. */
10015 show_mouse_face (dpyinfo
, DRAW_IMAGE_RAISED
);
10016 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
10018 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
10020 XSETFRAME (frame
, f
);
10021 event
.kind
= TOOL_BAR_EVENT
;
10022 event
.frame_or_window
= frame
;
10024 kbd_buffer_store_event (&event
);
10026 event
.kind
= TOOL_BAR_EVENT
;
10027 event
.frame_or_window
= frame
;
10029 event
.modifiers
= modifiers
;
10030 kbd_buffer_store_event (&event
);
10031 last_tool_bar_item
= -1;
10036 /* Possibly highlight a tool-bar item on frame F when mouse moves to
10037 tool-bar window-relative coordinates X/Y. Called from
10038 note_mouse_highlight. */
10041 note_tool_bar_highlight (f
, x
, y
)
10045 Lisp_Object window
= f
->tool_bar_window
;
10046 struct window
*w
= XWINDOW (window
);
10047 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10049 struct glyph
*glyph
;
10050 struct glyph_row
*row
;
10052 Lisp_Object enabled_p
;
10054 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
10055 int mouse_down_p
, rc
;
10057 /* Function note_mouse_highlight is called with negative x(y
10058 values when mouse moves outside of the frame. */
10059 if (x
<= 0 || y
<= 0)
10061 clear_mouse_face (dpyinfo
);
10065 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
10068 /* Not on tool-bar item. */
10069 clear_mouse_face (dpyinfo
);
10073 /* On same tool-bar item as before. */
10074 goto set_help_echo
;
10076 clear_mouse_face (dpyinfo
);
10078 /* Mouse is down, but on different tool-bar item? */
10079 mouse_down_p
= (dpyinfo
->grabbed
10080 && f
== last_mouse_frame
10081 && FRAME_LIVE_P (f
));
10083 && last_tool_bar_item
!= prop_idx
)
10086 dpyinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
10087 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
10089 /* If tool-bar item is not enabled, don't highlight it. */
10090 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10091 if (!NILP (enabled_p
))
10093 /* Compute the x-position of the glyph. In front and past the
10094 image is a space. We include this in the highlighted area. */
10095 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
10096 for (i
= x
= 0; i
< hpos
; ++i
)
10097 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
10099 /* Record this as the current active region. */
10100 dpyinfo
->mouse_face_beg_col
= hpos
;
10101 dpyinfo
->mouse_face_beg_row
= vpos
;
10102 dpyinfo
->mouse_face_beg_x
= x
;
10103 dpyinfo
->mouse_face_beg_y
= row
->y
;
10104 dpyinfo
->mouse_face_past_end
= 0;
10106 dpyinfo
->mouse_face_end_col
= hpos
+ 1;
10107 dpyinfo
->mouse_face_end_row
= vpos
;
10108 dpyinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
10109 dpyinfo
->mouse_face_end_y
= row
->y
;
10110 dpyinfo
->mouse_face_window
= window
;
10111 dpyinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
10113 /* Display it as active. */
10114 show_mouse_face (dpyinfo
, draw
);
10115 dpyinfo
->mouse_face_image_state
= draw
;
10120 /* Set help_echo_string to a help string to display for this tool-bar item.
10121 XTread_socket does the rest. */
10122 help_echo_object
= help_echo_window
= Qnil
;
10123 help_echo_pos
= -1;
10124 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
10125 if (NILP (help_echo_string
))
10126 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
10129 #endif /* HAVE_WINDOW_SYSTEM */
10133 /************************************************************************
10134 Horizontal scrolling
10135 ************************************************************************/
10137 static int hscroll_window_tree
P_ ((Lisp_Object
));
10138 static int hscroll_windows
P_ ((Lisp_Object
));
10140 /* For all leaf windows in the window tree rooted at WINDOW, set their
10141 hscroll value so that PT is (i) visible in the window, and (ii) so
10142 that it is not within a certain margin at the window's left and
10143 right border. Value is non-zero if any window's hscroll has been
10147 hscroll_window_tree (window
)
10148 Lisp_Object window
;
10150 int hscrolled_p
= 0;
10151 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
10152 int hscroll_step_abs
= 0;
10153 double hscroll_step_rel
= 0;
10155 if (hscroll_relative_p
)
10157 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
10158 if (hscroll_step_rel
< 0)
10160 hscroll_relative_p
= 0;
10161 hscroll_step_abs
= 0;
10164 else if (INTEGERP (Vhscroll_step
))
10166 hscroll_step_abs
= XINT (Vhscroll_step
);
10167 if (hscroll_step_abs
< 0)
10168 hscroll_step_abs
= 0;
10171 hscroll_step_abs
= 0;
10173 while (WINDOWP (window
))
10175 struct window
*w
= XWINDOW (window
);
10177 if (WINDOWP (w
->hchild
))
10178 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
10179 else if (WINDOWP (w
->vchild
))
10180 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
10181 else if (w
->cursor
.vpos
>= 0)
10184 int text_area_width
;
10185 struct glyph_row
*current_cursor_row
10186 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
10187 struct glyph_row
*desired_cursor_row
10188 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
10189 struct glyph_row
*cursor_row
10190 = (desired_cursor_row
->enabled_p
10191 ? desired_cursor_row
10192 : current_cursor_row
);
10194 text_area_width
= window_box_width (w
, TEXT_AREA
);
10196 /* Scroll when cursor is inside this scroll margin. */
10197 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
10199 if ((XFASTINT (w
->hscroll
)
10200 && w
->cursor
.x
<= h_margin
)
10201 || (cursor_row
->enabled_p
10202 && cursor_row
->truncated_on_right_p
10203 && (w
->cursor
.x
>= text_area_width
- h_margin
)))
10207 struct buffer
*saved_current_buffer
;
10211 /* Find point in a display of infinite width. */
10212 saved_current_buffer
= current_buffer
;
10213 current_buffer
= XBUFFER (w
->buffer
);
10215 if (w
== XWINDOW (selected_window
))
10216 pt
= BUF_PT (current_buffer
);
10219 pt
= marker_position (w
->pointm
);
10220 pt
= max (BEGV
, pt
);
10224 /* Move iterator to pt starting at cursor_row->start in
10225 a line with infinite width. */
10226 init_to_row_start (&it
, w
, cursor_row
);
10227 it
.last_visible_x
= INFINITY
;
10228 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
10229 current_buffer
= saved_current_buffer
;
10231 /* Position cursor in window. */
10232 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
10233 hscroll
= max (0, (it
.current_x
10234 - (ITERATOR_AT_END_OF_LINE_P (&it
)
10235 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
10236 : (text_area_width
/ 2))))
10237 / FRAME_COLUMN_WIDTH (it
.f
);
10238 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
10240 if (hscroll_relative_p
)
10241 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
10244 wanted_x
= text_area_width
10245 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10248 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10252 if (hscroll_relative_p
)
10253 wanted_x
= text_area_width
* hscroll_step_rel
10256 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10259 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10261 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
10263 /* Don't call Fset_window_hscroll if value hasn't
10264 changed because it will prevent redisplay
10266 if (XFASTINT (w
->hscroll
) != hscroll
)
10268 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
10269 w
->hscroll
= make_number (hscroll
);
10278 /* Value is non-zero if hscroll of any leaf window has been changed. */
10279 return hscrolled_p
;
10283 /* Set hscroll so that cursor is visible and not inside horizontal
10284 scroll margins for all windows in the tree rooted at WINDOW. See
10285 also hscroll_window_tree above. Value is non-zero if any window's
10286 hscroll has been changed. If it has, desired matrices on the frame
10287 of WINDOW are cleared. */
10290 hscroll_windows (window
)
10291 Lisp_Object window
;
10295 if (automatic_hscrolling_p
)
10297 hscrolled_p
= hscroll_window_tree (window
);
10299 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
10303 return hscrolled_p
;
10308 /************************************************************************
10310 ************************************************************************/
10312 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
10313 to a non-zero value. This is sometimes handy to have in a debugger
10318 /* First and last unchanged row for try_window_id. */
10320 int debug_first_unchanged_at_end_vpos
;
10321 int debug_last_unchanged_at_beg_vpos
;
10323 /* Delta vpos and y. */
10325 int debug_dvpos
, debug_dy
;
10327 /* Delta in characters and bytes for try_window_id. */
10329 int debug_delta
, debug_delta_bytes
;
10331 /* Values of window_end_pos and window_end_vpos at the end of
10334 EMACS_INT debug_end_pos
, debug_end_vpos
;
10336 /* Append a string to W->desired_matrix->method. FMT is a printf
10337 format string. A1...A9 are a supplement for a variable-length
10338 argument list. If trace_redisplay_p is non-zero also printf the
10339 resulting string to stderr. */
10342 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
10345 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
10348 char *method
= w
->desired_matrix
->method
;
10349 int len
= strlen (method
);
10350 int size
= sizeof w
->desired_matrix
->method
;
10351 int remaining
= size
- len
- 1;
10353 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
10354 if (len
&& remaining
)
10357 --remaining
, ++len
;
10360 strncpy (method
+ len
, buffer
, remaining
);
10362 if (trace_redisplay_p
)
10363 fprintf (stderr
, "%p (%s): %s\n",
10365 ((BUFFERP (w
->buffer
)
10366 && STRINGP (XBUFFER (w
->buffer
)->name
))
10367 ? (char *) SDATA (XBUFFER (w
->buffer
)->name
)
10372 #endif /* GLYPH_DEBUG */
10375 /* Value is non-zero if all changes in window W, which displays
10376 current_buffer, are in the text between START and END. START is a
10377 buffer position, END is given as a distance from Z. Used in
10378 redisplay_internal for display optimization. */
10381 text_outside_line_unchanged_p (w
, start
, end
)
10385 int unchanged_p
= 1;
10387 /* If text or overlays have changed, see where. */
10388 if (XFASTINT (w
->last_modified
) < MODIFF
10389 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
10391 /* Gap in the line? */
10392 if (GPT
< start
|| Z
- GPT
< end
)
10395 /* Changes start in front of the line, or end after it? */
10397 && (BEG_UNCHANGED
< start
- 1
10398 || END_UNCHANGED
< end
))
10401 /* If selective display, can't optimize if changes start at the
10402 beginning of the line. */
10404 && INTEGERP (current_buffer
->selective_display
)
10405 && XINT (current_buffer
->selective_display
) > 0
10406 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
10409 /* If there are overlays at the start or end of the line, these
10410 may have overlay strings with newlines in them. A change at
10411 START, for instance, may actually concern the display of such
10412 overlay strings as well, and they are displayed on different
10413 lines. So, quickly rule out this case. (For the future, it
10414 might be desirable to implement something more telling than
10415 just BEG/END_UNCHANGED.) */
10418 if (BEG
+ BEG_UNCHANGED
== start
10419 && overlay_touches_p (start
))
10421 if (END_UNCHANGED
== end
10422 && overlay_touches_p (Z
- end
))
10427 return unchanged_p
;
10431 /* Do a frame update, taking possible shortcuts into account. This is
10432 the main external entry point for redisplay.
10434 If the last redisplay displayed an echo area message and that message
10435 is no longer requested, we clear the echo area or bring back the
10436 mini-buffer if that is in use. */
10441 redisplay_internal (0);
10446 overlay_arrow_string_or_property (var
)
10451 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
10454 return Voverlay_arrow_string
;
10457 /* Return 1 if there are any overlay-arrows in current_buffer. */
10459 overlay_arrow_in_current_buffer_p ()
10463 for (vlist
= Voverlay_arrow_variable_list
;
10465 vlist
= XCDR (vlist
))
10467 Lisp_Object var
= XCAR (vlist
);
10470 if (!SYMBOLP (var
))
10472 val
= find_symbol_value (var
);
10474 && current_buffer
== XMARKER (val
)->buffer
)
10481 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
10485 overlay_arrows_changed_p ()
10489 for (vlist
= Voverlay_arrow_variable_list
;
10491 vlist
= XCDR (vlist
))
10493 Lisp_Object var
= XCAR (vlist
);
10494 Lisp_Object val
, pstr
;
10496 if (!SYMBOLP (var
))
10498 val
= find_symbol_value (var
);
10499 if (!MARKERP (val
))
10501 if (! EQ (COERCE_MARKER (val
),
10502 Fget (var
, Qlast_arrow_position
))
10503 || ! (pstr
= overlay_arrow_string_or_property (var
),
10504 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
10510 /* Mark overlay arrows to be updated on next redisplay. */
10513 update_overlay_arrows (up_to_date
)
10518 for (vlist
= Voverlay_arrow_variable_list
;
10520 vlist
= XCDR (vlist
))
10522 Lisp_Object var
= XCAR (vlist
);
10524 if (!SYMBOLP (var
))
10527 if (up_to_date
> 0)
10529 Lisp_Object val
= find_symbol_value (var
);
10530 Fput (var
, Qlast_arrow_position
,
10531 COERCE_MARKER (val
));
10532 Fput (var
, Qlast_arrow_string
,
10533 overlay_arrow_string_or_property (var
));
10535 else if (up_to_date
< 0
10536 || !NILP (Fget (var
, Qlast_arrow_position
)))
10538 Fput (var
, Qlast_arrow_position
, Qt
);
10539 Fput (var
, Qlast_arrow_string
, Qt
);
10545 /* Return overlay arrow string to display at row.
10546 Return integer (bitmap number) for arrow bitmap in left fringe.
10547 Return nil if no overlay arrow. */
10550 overlay_arrow_at_row (it
, row
)
10552 struct glyph_row
*row
;
10556 for (vlist
= Voverlay_arrow_variable_list
;
10558 vlist
= XCDR (vlist
))
10560 Lisp_Object var
= XCAR (vlist
);
10563 if (!SYMBOLP (var
))
10566 val
= find_symbol_value (var
);
10569 && current_buffer
== XMARKER (val
)->buffer
10570 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
10572 if (FRAME_WINDOW_P (it
->f
)
10573 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
10575 #ifdef HAVE_WINDOW_SYSTEM
10576 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
10579 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
10580 return make_number (fringe_bitmap
);
10583 return make_number (-1); /* Use default arrow bitmap */
10585 return overlay_arrow_string_or_property (var
);
10592 /* Return 1 if point moved out of or into a composition. Otherwise
10593 return 0. PREV_BUF and PREV_PT are the last point buffer and
10594 position. BUF and PT are the current point buffer and position. */
10597 check_point_in_composition (prev_buf
, prev_pt
, buf
, pt
)
10598 struct buffer
*prev_buf
, *buf
;
10603 Lisp_Object buffer
;
10605 XSETBUFFER (buffer
, buf
);
10606 /* Check a composition at the last point if point moved within the
10608 if (prev_buf
== buf
)
10611 /* Point didn't move. */
10614 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
10615 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
10616 && COMPOSITION_VALID_P (start
, end
, prop
)
10617 && start
< prev_pt
&& end
> prev_pt
)
10618 /* The last point was within the composition. Return 1 iff
10619 point moved out of the composition. */
10620 return (pt
<= start
|| pt
>= end
);
10623 /* Check a composition at the current point. */
10624 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
10625 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
10626 && COMPOSITION_VALID_P (start
, end
, prop
)
10627 && start
< pt
&& end
> pt
);
10631 /* Reconsider the setting of B->clip_changed which is displayed
10635 reconsider_clip_changes (w
, b
)
10639 if (b
->clip_changed
10640 && !NILP (w
->window_end_valid
)
10641 && w
->current_matrix
->buffer
== b
10642 && w
->current_matrix
->zv
== BUF_ZV (b
)
10643 && w
->current_matrix
->begv
== BUF_BEGV (b
))
10644 b
->clip_changed
= 0;
10646 /* If display wasn't paused, and W is not a tool bar window, see if
10647 point has been moved into or out of a composition. In that case,
10648 we set b->clip_changed to 1 to force updating the screen. If
10649 b->clip_changed has already been set to 1, we can skip this
10651 if (!b
->clip_changed
10652 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
10656 if (w
== XWINDOW (selected_window
))
10657 pt
= BUF_PT (current_buffer
);
10659 pt
= marker_position (w
->pointm
);
10661 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
10662 || pt
!= XINT (w
->last_point
))
10663 && check_point_in_composition (w
->current_matrix
->buffer
,
10664 XINT (w
->last_point
),
10665 XBUFFER (w
->buffer
), pt
))
10666 b
->clip_changed
= 1;
10671 /* Select FRAME to forward the values of frame-local variables into C
10672 variables so that the redisplay routines can access those values
10676 select_frame_for_redisplay (frame
)
10679 Lisp_Object tail
, sym
, val
;
10680 Lisp_Object old
= selected_frame
;
10682 selected_frame
= frame
;
10684 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
10685 if (CONSP (XCAR (tail
))
10686 && (sym
= XCAR (XCAR (tail
)),
10688 && (sym
= indirect_variable (sym
),
10689 val
= SYMBOL_VALUE (sym
),
10690 (BUFFER_LOCAL_VALUEP (val
)
10691 || SOME_BUFFER_LOCAL_VALUEP (val
)))
10692 && XBUFFER_LOCAL_VALUE (val
)->check_frame
)
10693 /* Use find_symbol_value rather than Fsymbol_value
10694 to avoid an error if it is void. */
10695 find_symbol_value (sym
);
10697 for (tail
= XFRAME (old
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
10698 if (CONSP (XCAR (tail
))
10699 && (sym
= XCAR (XCAR (tail
)),
10701 && (sym
= indirect_variable (sym
),
10702 val
= SYMBOL_VALUE (sym
),
10703 (BUFFER_LOCAL_VALUEP (val
)
10704 || SOME_BUFFER_LOCAL_VALUEP (val
)))
10705 && XBUFFER_LOCAL_VALUE (val
)->check_frame
)
10706 find_symbol_value (sym
);
10710 #define STOP_POLLING \
10711 do { if (! polling_stopped_here) stop_polling (); \
10712 polling_stopped_here = 1; } while (0)
10714 #define RESUME_POLLING \
10715 do { if (polling_stopped_here) start_polling (); \
10716 polling_stopped_here = 0; } while (0)
10719 /* If PRESERVE_ECHO_AREA is nonzero, it means this redisplay is not in
10720 response to any user action; therefore, we should preserve the echo
10721 area. (Actually, our caller does that job.) Perhaps in the future
10722 avoid recentering windows if it is not necessary; currently that
10723 causes some problems. */
10726 redisplay_internal (preserve_echo_area
)
10727 int preserve_echo_area
;
10729 struct window
*w
= XWINDOW (selected_window
);
10730 struct frame
*f
= XFRAME (w
->frame
);
10732 int must_finish
= 0;
10733 struct text_pos tlbufpos
, tlendpos
;
10734 int number_of_visible_frames
;
10736 struct frame
*sf
= SELECTED_FRAME ();
10737 int polling_stopped_here
= 0;
10739 /* Non-zero means redisplay has to consider all windows on all
10740 frames. Zero means, only selected_window is considered. */
10741 int consider_all_windows_p
;
10743 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
10745 /* No redisplay if running in batch mode or frame is not yet fully
10746 initialized, or redisplay is explicitly turned off by setting
10747 Vinhibit_redisplay. */
10749 || !NILP (Vinhibit_redisplay
)
10750 || !f
->glyphs_initialized_p
)
10753 /* The flag redisplay_performed_directly_p is set by
10754 direct_output_for_insert when it already did the whole screen
10755 update necessary. */
10756 if (redisplay_performed_directly_p
)
10758 redisplay_performed_directly_p
= 0;
10759 if (!hscroll_windows (selected_window
))
10763 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
10764 if (popup_activated ())
10768 /* I don't think this happens but let's be paranoid. */
10769 if (redisplaying_p
)
10772 /* Record a function that resets redisplaying_p to its old value
10773 when we leave this function. */
10774 count
= SPECPDL_INDEX ();
10775 record_unwind_protect (unwind_redisplay
,
10776 Fcons (make_number (redisplaying_p
), selected_frame
));
10778 specbind (Qinhibit_free_realized_faces
, Qnil
);
10781 Lisp_Object tail
, frame
;
10783 FOR_EACH_FRAME (tail
, frame
)
10785 struct frame
*f
= XFRAME (frame
);
10786 f
->already_hscrolled_p
= 0;
10792 reconsider_clip_changes (w
, current_buffer
);
10793 last_escape_glyph_frame
= NULL
;
10794 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
10796 /* If new fonts have been loaded that make a glyph matrix adjustment
10797 necessary, do it. */
10798 if (fonts_changed_p
)
10800 adjust_glyphs (NULL
);
10801 ++windows_or_buffers_changed
;
10802 fonts_changed_p
= 0;
10805 /* If face_change_count is non-zero, init_iterator will free all
10806 realized faces, which includes the faces referenced from current
10807 matrices. So, we can't reuse current matrices in this case. */
10808 if (face_change_count
)
10809 ++windows_or_buffers_changed
;
10811 if (! FRAME_WINDOW_P (sf
)
10812 && previous_terminal_frame
!= sf
)
10814 /* Since frames on an ASCII terminal share the same display
10815 area, displaying a different frame means redisplay the whole
10817 windows_or_buffers_changed
++;
10818 SET_FRAME_GARBAGED (sf
);
10819 XSETFRAME (Vterminal_frame
, sf
);
10821 previous_terminal_frame
= sf
;
10823 /* Set the visible flags for all frames. Do this before checking
10824 for resized or garbaged frames; they want to know if their frames
10825 are visible. See the comment in frame.h for
10826 FRAME_SAMPLE_VISIBILITY. */
10828 Lisp_Object tail
, frame
;
10830 number_of_visible_frames
= 0;
10832 FOR_EACH_FRAME (tail
, frame
)
10834 struct frame
*f
= XFRAME (frame
);
10836 FRAME_SAMPLE_VISIBILITY (f
);
10837 if (FRAME_VISIBLE_P (f
))
10838 ++number_of_visible_frames
;
10839 clear_desired_matrices (f
);
10843 /* Notice any pending interrupt request to change frame size. */
10844 do_pending_window_change (1);
10846 /* Clear frames marked as garbaged. */
10847 if (frame_garbaged
)
10848 clear_garbaged_frames ();
10850 /* Build menubar and tool-bar items. */
10851 if (NILP (Vmemory_full
))
10852 prepare_menu_bars ();
10854 if (windows_or_buffers_changed
)
10855 update_mode_lines
++;
10857 /* Detect case that we need to write or remove a star in the mode line. */
10858 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
10860 w
->update_mode_line
= Qt
;
10861 if (buffer_shared
> 1)
10862 update_mode_lines
++;
10865 /* If %c is in the mode line, update it if needed. */
10866 if (!NILP (w
->column_number_displayed
)
10867 /* This alternative quickly identifies a common case
10868 where no change is needed. */
10869 && !(PT
== XFASTINT (w
->last_point
)
10870 && XFASTINT (w
->last_modified
) >= MODIFF
10871 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
10872 && (XFASTINT (w
->column_number_displayed
)
10873 != (int) current_column ())) /* iftc */
10874 w
->update_mode_line
= Qt
;
10876 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
10878 /* The variable buffer_shared is set in redisplay_window and
10879 indicates that we redisplay a buffer in different windows. See
10881 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
10882 || cursor_type_changed
);
10884 /* If specs for an arrow have changed, do thorough redisplay
10885 to ensure we remove any arrow that should no longer exist. */
10886 if (overlay_arrows_changed_p ())
10887 consider_all_windows_p
= windows_or_buffers_changed
= 1;
10889 /* Normally the message* functions will have already displayed and
10890 updated the echo area, but the frame may have been trashed, or
10891 the update may have been preempted, so display the echo area
10892 again here. Checking message_cleared_p captures the case that
10893 the echo area should be cleared. */
10894 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
10895 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
10896 || (message_cleared_p
10897 && minibuf_level
== 0
10898 /* If the mini-window is currently selected, this means the
10899 echo-area doesn't show through. */
10900 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
10902 int window_height_changed_p
= echo_area_display (0);
10905 /* If we don't display the current message, don't clear the
10906 message_cleared_p flag, because, if we did, we wouldn't clear
10907 the echo area in the next redisplay which doesn't preserve
10909 if (!display_last_displayed_message_p
)
10910 message_cleared_p
= 0;
10912 if (fonts_changed_p
)
10914 else if (window_height_changed_p
)
10916 consider_all_windows_p
= 1;
10917 ++update_mode_lines
;
10918 ++windows_or_buffers_changed
;
10920 /* If window configuration was changed, frames may have been
10921 marked garbaged. Clear them or we will experience
10922 surprises wrt scrolling. */
10923 if (frame_garbaged
)
10924 clear_garbaged_frames ();
10927 else if (EQ (selected_window
, minibuf_window
)
10928 && (current_buffer
->clip_changed
10929 || XFASTINT (w
->last_modified
) < MODIFF
10930 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
10931 && resize_mini_window (w
, 0))
10933 /* Resized active mini-window to fit the size of what it is
10934 showing if its contents might have changed. */
10936 consider_all_windows_p
= 1;
10937 ++windows_or_buffers_changed
;
10938 ++update_mode_lines
;
10940 /* If window configuration was changed, frames may have been
10941 marked garbaged. Clear them or we will experience
10942 surprises wrt scrolling. */
10943 if (frame_garbaged
)
10944 clear_garbaged_frames ();
10948 /* If showing the region, and mark has changed, we must redisplay
10949 the whole window. The assignment to this_line_start_pos prevents
10950 the optimization directly below this if-statement. */
10951 if (((!NILP (Vtransient_mark_mode
)
10952 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
10953 != !NILP (w
->region_showing
))
10954 || (!NILP (w
->region_showing
)
10955 && !EQ (w
->region_showing
,
10956 Fmarker_position (XBUFFER (w
->buffer
)->mark
))))
10957 CHARPOS (this_line_start_pos
) = 0;
10959 /* Optimize the case that only the line containing the cursor in the
10960 selected window has changed. Variables starting with this_ are
10961 set in display_line and record information about the line
10962 containing the cursor. */
10963 tlbufpos
= this_line_start_pos
;
10964 tlendpos
= this_line_end_pos
;
10965 if (!consider_all_windows_p
10966 && CHARPOS (tlbufpos
) > 0
10967 && NILP (w
->update_mode_line
)
10968 && !current_buffer
->clip_changed
10969 && !current_buffer
->prevent_redisplay_optimizations_p
10970 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
10971 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
10972 /* Make sure recorded data applies to current buffer, etc. */
10973 && this_line_buffer
== current_buffer
10974 && current_buffer
== XBUFFER (w
->buffer
)
10975 && NILP (w
->force_start
)
10976 && NILP (w
->optional_new_start
)
10977 /* Point must be on the line that we have info recorded about. */
10978 && PT
>= CHARPOS (tlbufpos
)
10979 && PT
<= Z
- CHARPOS (tlendpos
)
10980 /* All text outside that line, including its final newline,
10981 must be unchanged */
10982 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
10983 CHARPOS (tlendpos
)))
10985 if (CHARPOS (tlbufpos
) > BEGV
10986 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
10987 && (CHARPOS (tlbufpos
) == ZV
10988 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
10989 /* Former continuation line has disappeared by becoming empty */
10991 else if (XFASTINT (w
->last_modified
) < MODIFF
10992 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
10993 || MINI_WINDOW_P (w
))
10995 /* We have to handle the case of continuation around a
10996 wide-column character (See the comment in indent.c around
10999 For instance, in the following case:
11001 -------- Insert --------
11002 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
11003 J_I_ ==> J_I_ `^^' are cursors.
11007 As we have to redraw the line above, we should goto cancel. */
11010 int line_height_before
= this_line_pixel_height
;
11012 /* Note that start_display will handle the case that the
11013 line starting at tlbufpos is a continuation lines. */
11014 start_display (&it
, w
, tlbufpos
);
11016 /* Implementation note: It this still necessary? */
11017 if (it
.current_x
!= this_line_start_x
)
11020 TRACE ((stderr
, "trying display optimization 1\n"));
11021 w
->cursor
.vpos
= -1;
11022 overlay_arrow_seen
= 0;
11023 it
.vpos
= this_line_vpos
;
11024 it
.current_y
= this_line_y
;
11025 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
11026 display_line (&it
);
11028 /* If line contains point, is not continued,
11029 and ends at same distance from eob as before, we win */
11030 if (w
->cursor
.vpos
>= 0
11031 /* Line is not continued, otherwise this_line_start_pos
11032 would have been set to 0 in display_line. */
11033 && CHARPOS (this_line_start_pos
)
11034 /* Line ends as before. */
11035 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
11036 /* Line has same height as before. Otherwise other lines
11037 would have to be shifted up or down. */
11038 && this_line_pixel_height
== line_height_before
)
11040 /* If this is not the window's last line, we must adjust
11041 the charstarts of the lines below. */
11042 if (it
.current_y
< it
.last_visible_y
)
11044 struct glyph_row
*row
11045 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
11046 int delta
, delta_bytes
;
11048 if (Z
- CHARPOS (tlendpos
) == ZV
)
11050 /* This line ends at end of (accessible part of)
11051 buffer. There is no newline to count. */
11053 - CHARPOS (tlendpos
)
11054 - MATRIX_ROW_START_CHARPOS (row
));
11055 delta_bytes
= (Z_BYTE
11056 - BYTEPOS (tlendpos
)
11057 - MATRIX_ROW_START_BYTEPOS (row
));
11061 /* This line ends in a newline. Must take
11062 account of the newline and the rest of the
11063 text that follows. */
11065 - CHARPOS (tlendpos
)
11066 - MATRIX_ROW_START_CHARPOS (row
));
11067 delta_bytes
= (Z_BYTE
11068 - BYTEPOS (tlendpos
)
11069 - MATRIX_ROW_START_BYTEPOS (row
));
11072 increment_matrix_positions (w
->current_matrix
,
11073 this_line_vpos
+ 1,
11074 w
->current_matrix
->nrows
,
11075 delta
, delta_bytes
);
11078 /* If this row displays text now but previously didn't,
11079 or vice versa, w->window_end_vpos may have to be
11081 if ((it
.glyph_row
- 1)->displays_text_p
)
11083 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
11084 XSETINT (w
->window_end_vpos
, this_line_vpos
);
11086 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
11087 && this_line_vpos
> 0)
11088 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
11089 w
->window_end_valid
= Qnil
;
11091 /* Update hint: No need to try to scroll in update_window. */
11092 w
->desired_matrix
->no_scrolling_p
= 1;
11095 *w
->desired_matrix
->method
= 0;
11096 debug_method_add (w
, "optimization 1");
11098 #ifdef HAVE_WINDOW_SYSTEM
11099 update_window_fringes (w
, 0);
11106 else if (/* Cursor position hasn't changed. */
11107 PT
== XFASTINT (w
->last_point
)
11108 /* Make sure the cursor was last displayed
11109 in this window. Otherwise we have to reposition it. */
11110 && 0 <= w
->cursor
.vpos
11111 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
11115 do_pending_window_change (1);
11117 /* We used to always goto end_of_redisplay here, but this
11118 isn't enough if we have a blinking cursor. */
11119 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
11120 goto end_of_redisplay
;
11124 /* If highlighting the region, or if the cursor is in the echo area,
11125 then we can't just move the cursor. */
11126 else if (! (!NILP (Vtransient_mark_mode
)
11127 && !NILP (current_buffer
->mark_active
))
11128 && (EQ (selected_window
, current_buffer
->last_selected_window
)
11129 || highlight_nonselected_windows
)
11130 && NILP (w
->region_showing
)
11131 && NILP (Vshow_trailing_whitespace
)
11132 && !cursor_in_echo_area
)
11135 struct glyph_row
*row
;
11137 /* Skip from tlbufpos to PT and see where it is. Note that
11138 PT may be in invisible text. If so, we will end at the
11139 next visible position. */
11140 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
11141 NULL
, DEFAULT_FACE_ID
);
11142 it
.current_x
= this_line_start_x
;
11143 it
.current_y
= this_line_y
;
11144 it
.vpos
= this_line_vpos
;
11146 /* The call to move_it_to stops in front of PT, but
11147 moves over before-strings. */
11148 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
11150 if (it
.vpos
== this_line_vpos
11151 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
11154 xassert (this_line_vpos
== it
.vpos
);
11155 xassert (this_line_y
== it
.current_y
);
11156 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
11158 *w
->desired_matrix
->method
= 0;
11159 debug_method_add (w
, "optimization 3");
11168 /* Text changed drastically or point moved off of line. */
11169 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
11172 CHARPOS (this_line_start_pos
) = 0;
11173 consider_all_windows_p
|= buffer_shared
> 1;
11174 ++clear_face_cache_count
;
11175 #ifdef HAVE_WINDOW_SYSTEM
11176 ++clear_image_cache_count
;
11179 /* Build desired matrices, and update the display. If
11180 consider_all_windows_p is non-zero, do it for all windows on all
11181 frames. Otherwise do it for selected_window, only. */
11183 if (consider_all_windows_p
)
11185 Lisp_Object tail
, frame
;
11187 FOR_EACH_FRAME (tail
, frame
)
11188 XFRAME (frame
)->updated_p
= 0;
11190 /* Recompute # windows showing selected buffer. This will be
11191 incremented each time such a window is displayed. */
11194 FOR_EACH_FRAME (tail
, frame
)
11196 struct frame
*f
= XFRAME (frame
);
11198 if (FRAME_WINDOW_P (f
) || f
== sf
)
11200 if (! EQ (frame
, selected_frame
))
11201 /* Select the frame, for the sake of frame-local
11203 select_frame_for_redisplay (frame
);
11205 /* Mark all the scroll bars to be removed; we'll redeem
11206 the ones we want when we redisplay their windows. */
11207 if (condemn_scroll_bars_hook
)
11208 condemn_scroll_bars_hook (f
);
11210 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11211 redisplay_windows (FRAME_ROOT_WINDOW (f
));
11213 /* Any scroll bars which redisplay_windows should have
11214 nuked should now go away. */
11215 if (judge_scroll_bars_hook
)
11216 judge_scroll_bars_hook (f
);
11218 /* If fonts changed, display again. */
11219 /* ??? rms: I suspect it is a mistake to jump all the way
11220 back to retry here. It should just retry this frame. */
11221 if (fonts_changed_p
)
11224 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11226 /* See if we have to hscroll. */
11227 if (!f
->already_hscrolled_p
)
11229 f
->already_hscrolled_p
= 1;
11230 if (hscroll_windows (f
->root_window
))
11234 /* Prevent various kinds of signals during display
11235 update. stdio is not robust about handling
11236 signals, which can cause an apparent I/O
11238 if (interrupt_input
)
11239 unrequest_sigio ();
11242 /* Update the display. */
11243 set_window_update_flags (XWINDOW (f
->root_window
), 1);
11244 pause
|= update_frame (f
, 0, 0);
11245 #if 0 /* Exiting the loop can leave the wrong value for buffer_shared. */
11257 /* Do the mark_window_display_accurate after all windows have
11258 been redisplayed because this call resets flags in buffers
11259 which are needed for proper redisplay. */
11260 FOR_EACH_FRAME (tail
, frame
)
11262 struct frame
*f
= XFRAME (frame
);
11265 mark_window_display_accurate (f
->root_window
, 1);
11266 if (frame_up_to_date_hook
)
11267 frame_up_to_date_hook (f
);
11272 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
11274 Lisp_Object mini_window
;
11275 struct frame
*mini_frame
;
11277 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
11278 /* Use list_of_error, not Qerror, so that
11279 we catch only errors and don't run the debugger. */
11280 internal_condition_case_1 (redisplay_window_1
, selected_window
,
11282 redisplay_window_error
);
11284 /* Compare desired and current matrices, perform output. */
11287 /* If fonts changed, display again. */
11288 if (fonts_changed_p
)
11291 /* Prevent various kinds of signals during display update.
11292 stdio is not robust about handling signals,
11293 which can cause an apparent I/O error. */
11294 if (interrupt_input
)
11295 unrequest_sigio ();
11298 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
11300 if (hscroll_windows (selected_window
))
11303 XWINDOW (selected_window
)->must_be_updated_p
= 1;
11304 pause
= update_frame (sf
, 0, 0);
11307 /* We may have called echo_area_display at the top of this
11308 function. If the echo area is on another frame, that may
11309 have put text on a frame other than the selected one, so the
11310 above call to update_frame would not have caught it. Catch
11312 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
11313 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
11315 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
11317 XWINDOW (mini_window
)->must_be_updated_p
= 1;
11318 pause
|= update_frame (mini_frame
, 0, 0);
11319 if (!pause
&& hscroll_windows (mini_window
))
11324 /* If display was paused because of pending input, make sure we do a
11325 thorough update the next time. */
11328 /* Prevent the optimization at the beginning of
11329 redisplay_internal that tries a single-line update of the
11330 line containing the cursor in the selected window. */
11331 CHARPOS (this_line_start_pos
) = 0;
11333 /* Let the overlay arrow be updated the next time. */
11334 update_overlay_arrows (0);
11336 /* If we pause after scrolling, some rows in the current
11337 matrices of some windows are not valid. */
11338 if (!WINDOW_FULL_WIDTH_P (w
)
11339 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
11340 update_mode_lines
= 1;
11344 if (!consider_all_windows_p
)
11346 /* This has already been done above if
11347 consider_all_windows_p is set. */
11348 mark_window_display_accurate_1 (w
, 1);
11350 /* Say overlay arrows are up to date. */
11351 update_overlay_arrows (1);
11353 if (frame_up_to_date_hook
!= 0)
11354 frame_up_to_date_hook (sf
);
11357 update_mode_lines
= 0;
11358 windows_or_buffers_changed
= 0;
11359 cursor_type_changed
= 0;
11362 /* Start SIGIO interrupts coming again. Having them off during the
11363 code above makes it less likely one will discard output, but not
11364 impossible, since there might be stuff in the system buffer here.
11365 But it is much hairier to try to do anything about that. */
11366 if (interrupt_input
)
11370 /* If a frame has become visible which was not before, redisplay
11371 again, so that we display it. Expose events for such a frame
11372 (which it gets when becoming visible) don't call the parts of
11373 redisplay constructing glyphs, so simply exposing a frame won't
11374 display anything in this case. So, we have to display these
11375 frames here explicitly. */
11378 Lisp_Object tail
, frame
;
11381 FOR_EACH_FRAME (tail
, frame
)
11383 int this_is_visible
= 0;
11385 if (XFRAME (frame
)->visible
)
11386 this_is_visible
= 1;
11387 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
11388 if (XFRAME (frame
)->visible
)
11389 this_is_visible
= 1;
11391 if (this_is_visible
)
11395 if (new_count
!= number_of_visible_frames
)
11396 windows_or_buffers_changed
++;
11399 /* Change frame size now if a change is pending. */
11400 do_pending_window_change (1);
11402 /* If we just did a pending size change, or have additional
11403 visible frames, redisplay again. */
11404 if (windows_or_buffers_changed
&& !pause
)
11407 /* Clear the face cache eventually. */
11408 if (consider_all_windows_p
)
11410 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
11412 clear_face_cache (0);
11413 clear_face_cache_count
= 0;
11415 #ifdef HAVE_WINDOW_SYSTEM
11416 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
11418 Lisp_Object tail
, frame
;
11419 FOR_EACH_FRAME (tail
, frame
)
11421 struct frame
*f
= XFRAME (frame
);
11422 if (FRAME_WINDOW_P (f
))
11423 clear_image_cache (f
, 0);
11425 clear_image_cache_count
= 0;
11427 #endif /* HAVE_WINDOW_SYSTEM */
11431 unbind_to (count
, Qnil
);
11436 /* Redisplay, but leave alone any recent echo area message unless
11437 another message has been requested in its place.
11439 This is useful in situations where you need to redisplay but no
11440 user action has occurred, making it inappropriate for the message
11441 area to be cleared. See tracking_off and
11442 wait_reading_process_output for examples of these situations.
11444 FROM_WHERE is an integer saying from where this function was
11445 called. This is useful for debugging. */
11448 redisplay_preserve_echo_area (from_where
)
11451 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
11453 if (!NILP (echo_area_buffer
[1]))
11455 /* We have a previously displayed message, but no current
11456 message. Redisplay the previous message. */
11457 display_last_displayed_message_p
= 1;
11458 redisplay_internal (1);
11459 display_last_displayed_message_p
= 0;
11462 redisplay_internal (1);
11464 if (rif
!= NULL
&& rif
->flush_display_optional
)
11465 rif
->flush_display_optional (NULL
);
11469 /* Function registered with record_unwind_protect in
11470 redisplay_internal. Reset redisplaying_p to the value it had
11471 before redisplay_internal was called, and clear
11472 prevent_freeing_realized_faces_p. It also selects the previously
11476 unwind_redisplay (val
)
11479 Lisp_Object old_redisplaying_p
, old_frame
;
11481 old_redisplaying_p
= XCAR (val
);
11482 redisplaying_p
= XFASTINT (old_redisplaying_p
);
11483 old_frame
= XCDR (val
);
11484 if (! EQ (old_frame
, selected_frame
))
11485 select_frame_for_redisplay (old_frame
);
11490 /* Mark the display of window W as accurate or inaccurate. If
11491 ACCURATE_P is non-zero mark display of W as accurate. If
11492 ACCURATE_P is zero, arrange for W to be redisplayed the next time
11493 redisplay_internal is called. */
11496 mark_window_display_accurate_1 (w
, accurate_p
)
11500 if (BUFFERP (w
->buffer
))
11502 struct buffer
*b
= XBUFFER (w
->buffer
);
11505 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
11506 w
->last_overlay_modified
11507 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
11509 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
11513 b
->clip_changed
= 0;
11514 b
->prevent_redisplay_optimizations_p
= 0;
11516 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
11517 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
11518 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
11519 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
11521 w
->current_matrix
->buffer
= b
;
11522 w
->current_matrix
->begv
= BUF_BEGV (b
);
11523 w
->current_matrix
->zv
= BUF_ZV (b
);
11525 w
->last_cursor
= w
->cursor
;
11526 w
->last_cursor_off_p
= w
->cursor_off_p
;
11528 if (w
== XWINDOW (selected_window
))
11529 w
->last_point
= make_number (BUF_PT (b
));
11531 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
11537 w
->window_end_valid
= w
->buffer
;
11538 #if 0 /* This is incorrect with variable-height lines. */
11539 xassert (XINT (w
->window_end_vpos
)
11540 < (WINDOW_TOTAL_LINES (w
)
11541 - (WINDOW_WANTS_MODELINE_P (w
) ? 1 : 0)));
11543 w
->update_mode_line
= Qnil
;
11548 /* Mark the display of windows in the window tree rooted at WINDOW as
11549 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
11550 windows as accurate. If ACCURATE_P is zero, arrange for windows to
11551 be redisplayed the next time redisplay_internal is called. */
11554 mark_window_display_accurate (window
, accurate_p
)
11555 Lisp_Object window
;
11560 for (; !NILP (window
); window
= w
->next
)
11562 w
= XWINDOW (window
);
11563 mark_window_display_accurate_1 (w
, accurate_p
);
11565 if (!NILP (w
->vchild
))
11566 mark_window_display_accurate (w
->vchild
, accurate_p
);
11567 if (!NILP (w
->hchild
))
11568 mark_window_display_accurate (w
->hchild
, accurate_p
);
11573 update_overlay_arrows (1);
11577 /* Force a thorough redisplay the next time by setting
11578 last_arrow_position and last_arrow_string to t, which is
11579 unequal to any useful value of Voverlay_arrow_... */
11580 update_overlay_arrows (-1);
11585 /* Return value in display table DP (Lisp_Char_Table *) for character
11586 C. Since a display table doesn't have any parent, we don't have to
11587 follow parent. Do not call this function directly but use the
11588 macro DISP_CHAR_VECTOR. */
11591 disp_char_vector (dp
, c
)
11592 struct Lisp_Char_Table
*dp
;
11598 if (SINGLE_BYTE_CHAR_P (c
))
11599 return (dp
->contents
[c
]);
11601 SPLIT_CHAR (c
, code
[0], code
[1], code
[2]);
11604 else if (code
[2] < 32)
11607 /* Here, the possible range of code[0] (== charset ID) is
11608 128..max_charset. Since the top level char table contains data
11609 for multibyte characters after 256th element, we must increment
11610 code[0] by 128 to get a correct index. */
11612 code
[3] = -1; /* anchor */
11614 for (i
= 0; code
[i
] >= 0; i
++, dp
= XCHAR_TABLE (val
))
11616 val
= dp
->contents
[code
[i
]];
11617 if (!SUB_CHAR_TABLE_P (val
))
11618 return (NILP (val
) ? dp
->defalt
: val
);
11621 /* Here, val is a sub char table. We return the default value of
11623 return (dp
->defalt
);
11628 /***********************************************************************
11630 ***********************************************************************/
11632 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
11635 redisplay_windows (window
)
11636 Lisp_Object window
;
11638 while (!NILP (window
))
11640 struct window
*w
= XWINDOW (window
);
11642 if (!NILP (w
->hchild
))
11643 redisplay_windows (w
->hchild
);
11644 else if (!NILP (w
->vchild
))
11645 redisplay_windows (w
->vchild
);
11648 displayed_buffer
= XBUFFER (w
->buffer
);
11649 /* Use list_of_error, not Qerror, so that
11650 we catch only errors and don't run the debugger. */
11651 internal_condition_case_1 (redisplay_window_0
, window
,
11653 redisplay_window_error
);
11661 redisplay_window_error ()
11663 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
11668 redisplay_window_0 (window
)
11669 Lisp_Object window
;
11671 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
11672 redisplay_window (window
, 0);
11677 redisplay_window_1 (window
)
11678 Lisp_Object window
;
11680 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
11681 redisplay_window (window
, 1);
11686 /* Increment GLYPH until it reaches END or CONDITION fails while
11687 adding (GLYPH)->pixel_width to X. */
11689 #define SKIP_GLYPHS(glyph, end, x, condition) \
11692 (x) += (glyph)->pixel_width; \
11695 while ((glyph) < (end) && (condition))
11698 /* Set cursor position of W. PT is assumed to be displayed in ROW.
11699 DELTA is the number of bytes by which positions recorded in ROW
11700 differ from current buffer positions.
11702 Return 0 if cursor is not on this row. 1 otherwise. */
11705 set_cursor_from_row (w
, row
, matrix
, delta
, delta_bytes
, dy
, dvpos
)
11707 struct glyph_row
*row
;
11708 struct glyph_matrix
*matrix
;
11709 int delta
, delta_bytes
, dy
, dvpos
;
11711 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
11712 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
11713 struct glyph
*cursor
= NULL
;
11714 /* The first glyph that starts a sequence of glyphs from string. */
11715 struct glyph
*string_start
;
11716 /* The X coordinate of string_start. */
11717 int string_start_x
;
11718 /* The last known character position. */
11719 int last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
11720 /* The last known character position before string_start. */
11721 int string_before_pos
;
11724 int cursor_from_overlay_pos
= 0;
11725 int pt_old
= PT
- delta
;
11727 /* Skip over glyphs not having an object at the start of the row.
11728 These are special glyphs like truncation marks on terminal
11730 if (row
->displays_text_p
)
11732 && INTEGERP (glyph
->object
)
11733 && glyph
->charpos
< 0)
11735 x
+= glyph
->pixel_width
;
11739 string_start
= NULL
;
11741 && !INTEGERP (glyph
->object
)
11742 && (!BUFFERP (glyph
->object
)
11743 || (last_pos
= glyph
->charpos
) < pt_old
))
11745 if (! STRINGP (glyph
->object
))
11747 string_start
= NULL
;
11748 x
+= glyph
->pixel_width
;
11750 if (cursor_from_overlay_pos
11751 && last_pos
>= cursor_from_overlay_pos
)
11753 cursor_from_overlay_pos
= 0;
11759 if (string_start
== NULL
)
11761 string_before_pos
= last_pos
;
11762 string_start
= glyph
;
11763 string_start_x
= x
;
11765 /* Skip all glyphs from string. */
11770 if ((cursor
== NULL
|| glyph
> cursor
)
11771 && (cprop
= Fget_char_property (make_number ((glyph
)->charpos
),
11772 Qcursor
, (glyph
)->object
),
11774 && (pos
= string_buffer_position (w
, glyph
->object
,
11775 string_before_pos
),
11776 (pos
== 0 /* From overlay */
11777 || pos
== pt_old
)))
11779 /* Estimate overlay buffer position from the buffer
11780 positions of the glyphs before and after the overlay.
11781 Add 1 to last_pos so that if point corresponds to the
11782 glyph right after the overlay, we still use a 'cursor'
11783 property found in that overlay. */
11784 cursor_from_overlay_pos
= (pos
? 0 : last_pos
11785 + (INTEGERP (cprop
) ? XINT (cprop
) : 0));
11789 x
+= glyph
->pixel_width
;
11792 while (glyph
< end
&& EQ (glyph
->object
, string_start
->object
));
11796 if (cursor
!= NULL
)
11801 else if (row
->ends_in_ellipsis_p
&& glyph
== end
)
11803 /* Scan back over the ellipsis glyphs, decrementing positions. */
11804 while (glyph
> row
->glyphs
[TEXT_AREA
]
11805 && (glyph
- 1)->charpos
== last_pos
)
11806 glyph
--, x
-= glyph
->pixel_width
;
11807 /* That loop always goes one position too far,
11808 including the glyph before the ellipsis.
11809 So scan forward over that one. */
11810 x
+= glyph
->pixel_width
;
11813 else if (string_start
11814 && (glyph
== end
|| !BUFFERP (glyph
->object
) || last_pos
> pt_old
))
11816 /* We may have skipped over point because the previous glyphs
11817 are from string. As there's no easy way to know the
11818 character position of the current glyph, find the correct
11819 glyph on point by scanning from string_start again. */
11821 Lisp_Object string
;
11822 struct glyph
*stop
= glyph
;
11825 limit
= make_number (pt_old
+ 1);
11826 glyph
= string_start
;
11827 x
= string_start_x
;
11828 string
= glyph
->object
;
11829 pos
= string_buffer_position (w
, string
, string_before_pos
);
11830 /* If STRING is from overlay, LAST_POS == 0. We skip such glyphs
11831 because we always put cursor after overlay strings. */
11832 while (pos
== 0 && glyph
< stop
)
11834 string
= glyph
->object
;
11835 SKIP_GLYPHS (glyph
, stop
, x
, EQ (glyph
->object
, string
));
11837 pos
= string_buffer_position (w
, glyph
->object
, string_before_pos
);
11840 while (glyph
< stop
)
11842 pos
= XINT (Fnext_single_char_property_change
11843 (make_number (pos
), Qdisplay
, Qnil
, limit
));
11846 /* Skip glyphs from the same string. */
11847 string
= glyph
->object
;
11848 SKIP_GLYPHS (glyph
, stop
, x
, EQ (glyph
->object
, string
));
11849 /* Skip glyphs from an overlay. */
11850 while (glyph
< stop
11851 && ! string_buffer_position (w
, glyph
->object
, pos
))
11853 string
= glyph
->object
;
11854 SKIP_GLYPHS (glyph
, stop
, x
, EQ (glyph
->object
, string
));
11858 /* If we reached the end of the line, and end was from a string,
11859 cursor is not on this line. */
11860 if (glyph
== end
&& row
->continued_p
)
11864 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
11866 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
11867 w
->cursor
.y
= row
->y
+ dy
;
11869 if (w
== XWINDOW (selected_window
))
11871 if (!row
->continued_p
11872 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
11875 this_line_buffer
= XBUFFER (w
->buffer
);
11877 CHARPOS (this_line_start_pos
)
11878 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
11879 BYTEPOS (this_line_start_pos
)
11880 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
11882 CHARPOS (this_line_end_pos
)
11883 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
11884 BYTEPOS (this_line_end_pos
)
11885 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
11887 this_line_y
= w
->cursor
.y
;
11888 this_line_pixel_height
= row
->height
;
11889 this_line_vpos
= w
->cursor
.vpos
;
11890 this_line_start_x
= row
->x
;
11893 CHARPOS (this_line_start_pos
) = 0;
11900 /* Run window scroll functions, if any, for WINDOW with new window
11901 start STARTP. Sets the window start of WINDOW to that position.
11903 We assume that the window's buffer is really current. */
11905 static INLINE
struct text_pos
11906 run_window_scroll_functions (window
, startp
)
11907 Lisp_Object window
;
11908 struct text_pos startp
;
11910 struct window
*w
= XWINDOW (window
);
11911 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
11913 if (current_buffer
!= XBUFFER (w
->buffer
))
11916 if (!NILP (Vwindow_scroll_functions
))
11918 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
11919 make_number (CHARPOS (startp
)));
11920 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
11921 /* In case the hook functions switch buffers. */
11922 if (current_buffer
!= XBUFFER (w
->buffer
))
11923 set_buffer_internal_1 (XBUFFER (w
->buffer
));
11930 /* Make sure the line containing the cursor is fully visible.
11931 A value of 1 means there is nothing to be done.
11932 (Either the line is fully visible, or it cannot be made so,
11933 or we cannot tell.)
11935 If FORCE_P is non-zero, return 0 even if partial visible cursor row
11936 is higher than window.
11938 A value of 0 means the caller should do scrolling
11939 as if point had gone off the screen. */
11942 cursor_row_fully_visible_p (w
, force_p
, current_matrix_p
)
11945 int current_matrix_p
;
11947 struct glyph_matrix
*matrix
;
11948 struct glyph_row
*row
;
11951 if (!make_cursor_line_fully_visible_p
)
11954 /* It's not always possible to find the cursor, e.g, when a window
11955 is full of overlay strings. Don't do anything in that case. */
11956 if (w
->cursor
.vpos
< 0)
11959 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
11960 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
11962 /* If the cursor row is not partially visible, there's nothing to do. */
11963 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
11966 /* If the row the cursor is in is taller than the window's height,
11967 it's not clear what to do, so do nothing. */
11968 window_height
= window_box_height (w
);
11969 if (row
->height
>= window_height
)
11971 if (!force_p
|| MINI_WINDOW_P (w
) || w
->vscroll
)
11977 /* This code used to try to scroll the window just enough to make
11978 the line visible. It returned 0 to say that the caller should
11979 allocate larger glyph matrices. */
11981 if (MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (w
, row
))
11983 int dy
= row
->height
- row
->visible_height
;
11986 shift_glyph_matrix (w
, matrix
, 0, matrix
->nrows
, dy
);
11988 else /* MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P (w, row)) */
11990 int dy
= - (row
->height
- row
->visible_height
);
11993 shift_glyph_matrix (w
, matrix
, 0, matrix
->nrows
, dy
);
11996 /* When we change the cursor y-position of the selected window,
11997 change this_line_y as well so that the display optimization for
11998 the cursor line of the selected window in redisplay_internal uses
11999 the correct y-position. */
12000 if (w
== XWINDOW (selected_window
))
12001 this_line_y
= w
->cursor
.y
;
12003 /* If vscrolling requires a larger glyph matrix, arrange for a fresh
12004 redisplay with larger matrices. */
12005 if (matrix
->nrows
< required_matrix_height (w
))
12007 fonts_changed_p
= 1;
12016 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
12017 non-zero means only WINDOW is redisplayed in redisplay_internal.
12018 TEMP_SCROLL_STEP has the same meaning as scroll_step, and is used
12019 in redisplay_window to bring a partially visible line into view in
12020 the case that only the cursor has moved.
12022 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
12023 last screen line's vertical height extends past the end of the screen.
12027 1 if scrolling succeeded
12029 0 if scrolling didn't find point.
12031 -1 if new fonts have been loaded so that we must interrupt
12032 redisplay, adjust glyph matrices, and try again. */
12038 SCROLLING_NEED_LARGER_MATRICES
12042 try_scrolling (window
, just_this_one_p
, scroll_conservatively
,
12043 scroll_step
, temp_scroll_step
, last_line_misfit
)
12044 Lisp_Object window
;
12045 int just_this_one_p
;
12046 EMACS_INT scroll_conservatively
, scroll_step
;
12047 int temp_scroll_step
;
12048 int last_line_misfit
;
12050 struct window
*w
= XWINDOW (window
);
12051 struct frame
*f
= XFRAME (w
->frame
);
12052 struct text_pos scroll_margin_pos
;
12053 struct text_pos pos
;
12054 struct text_pos startp
;
12056 Lisp_Object window_end
;
12057 int this_scroll_margin
;
12061 int amount_to_scroll
= 0;
12062 Lisp_Object aggressive
;
12064 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
12067 debug_method_add (w
, "try_scrolling");
12070 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12072 /* Compute scroll margin height in pixels. We scroll when point is
12073 within this distance from the top or bottom of the window. */
12074 if (scroll_margin
> 0)
12076 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
12077 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
12080 this_scroll_margin
= 0;
12082 /* Force scroll_conservatively to have a reasonable value so it doesn't
12083 cause an overflow while computing how much to scroll. */
12084 if (scroll_conservatively
)
12085 scroll_conservatively
= min (scroll_conservatively
,
12086 MOST_POSITIVE_FIXNUM
/ FRAME_LINE_HEIGHT (f
));
12088 /* Compute how much we should try to scroll maximally to bring point
12090 if (scroll_step
|| scroll_conservatively
|| temp_scroll_step
)
12091 scroll_max
= max (scroll_step
,
12092 max (scroll_conservatively
, temp_scroll_step
));
12093 else if (NUMBERP (current_buffer
->scroll_down_aggressively
)
12094 || NUMBERP (current_buffer
->scroll_up_aggressively
))
12095 /* We're trying to scroll because of aggressive scrolling
12096 but no scroll_step is set. Choose an arbitrary one. Maybe
12097 there should be a variable for this. */
12101 scroll_max
*= FRAME_LINE_HEIGHT (f
);
12103 /* Decide whether we have to scroll down. Start at the window end
12104 and move this_scroll_margin up to find the position of the scroll
12106 window_end
= Fwindow_end (window
, Qt
);
12110 CHARPOS (scroll_margin_pos
) = XINT (window_end
);
12111 BYTEPOS (scroll_margin_pos
) = CHAR_TO_BYTE (CHARPOS (scroll_margin_pos
));
12113 if (this_scroll_margin
|| extra_scroll_margin_lines
)
12115 start_display (&it
, w
, scroll_margin_pos
);
12116 if (this_scroll_margin
)
12117 move_it_vertically_backward (&it
, this_scroll_margin
);
12118 if (extra_scroll_margin_lines
)
12119 move_it_by_lines (&it
, - extra_scroll_margin_lines
, 0);
12120 scroll_margin_pos
= it
.current
.pos
;
12123 if (PT
>= CHARPOS (scroll_margin_pos
))
12127 /* Point is in the scroll margin at the bottom of the window, or
12128 below. Compute a new window start that makes point visible. */
12130 /* Compute the distance from the scroll margin to PT.
12131 Give up if the distance is greater than scroll_max. */
12132 start_display (&it
, w
, scroll_margin_pos
);
12134 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
12135 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
12137 /* To make point visible, we have to move the window start
12138 down so that the line the cursor is in is visible, which
12139 means we have to add in the height of the cursor line. */
12140 dy
= line_bottom_y (&it
) - y0
;
12142 if (dy
> scroll_max
)
12143 return SCROLLING_FAILED
;
12145 /* Move the window start down. If scrolling conservatively,
12146 move it just enough down to make point visible. If
12147 scroll_step is set, move it down by scroll_step. */
12148 start_display (&it
, w
, startp
);
12150 if (scroll_conservatively
)
12151 /* Set AMOUNT_TO_SCROLL to at least one line,
12152 and at most scroll_conservatively lines. */
12154 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
12155 FRAME_LINE_HEIGHT (f
) * scroll_conservatively
);
12156 else if (scroll_step
|| temp_scroll_step
)
12157 amount_to_scroll
= scroll_max
;
12160 aggressive
= current_buffer
->scroll_up_aggressively
;
12161 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
12162 if (NUMBERP (aggressive
))
12164 double float_amount
= XFLOATINT (aggressive
) * height
;
12165 amount_to_scroll
= float_amount
;
12166 if (amount_to_scroll
== 0 && float_amount
> 0)
12167 amount_to_scroll
= 1;
12171 if (amount_to_scroll
<= 0)
12172 return SCROLLING_FAILED
;
12174 /* If moving by amount_to_scroll leaves STARTP unchanged,
12175 move it down one screen line. */
12177 move_it_vertically (&it
, amount_to_scroll
);
12178 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
12179 move_it_by_lines (&it
, 1, 1);
12180 startp
= it
.current
.pos
;
12184 /* See if point is inside the scroll margin at the top of the
12186 scroll_margin_pos
= startp
;
12187 if (this_scroll_margin
)
12189 start_display (&it
, w
, startp
);
12190 move_it_vertically (&it
, this_scroll_margin
);
12191 scroll_margin_pos
= it
.current
.pos
;
12194 if (PT
< CHARPOS (scroll_margin_pos
))
12196 /* Point is in the scroll margin at the top of the window or
12197 above what is displayed in the window. */
12200 /* Compute the vertical distance from PT to the scroll
12201 margin position. Give up if distance is greater than
12203 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
12204 start_display (&it
, w
, pos
);
12206 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
12207 it
.last_visible_y
, -1,
12208 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
12209 dy
= it
.current_y
- y0
;
12210 if (dy
> scroll_max
)
12211 return SCROLLING_FAILED
;
12213 /* Compute new window start. */
12214 start_display (&it
, w
, startp
);
12216 if (scroll_conservatively
)
12218 = max (dy
, FRAME_LINE_HEIGHT (f
) * max (scroll_step
, temp_scroll_step
));
12219 else if (scroll_step
|| temp_scroll_step
)
12220 amount_to_scroll
= scroll_max
;
12223 aggressive
= current_buffer
->scroll_down_aggressively
;
12224 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
12225 if (NUMBERP (aggressive
))
12227 double float_amount
= XFLOATINT (aggressive
) * height
;
12228 amount_to_scroll
= float_amount
;
12229 if (amount_to_scroll
== 0 && float_amount
> 0)
12230 amount_to_scroll
= 1;
12234 if (amount_to_scroll
<= 0)
12235 return SCROLLING_FAILED
;
12237 move_it_vertically_backward (&it
, amount_to_scroll
);
12238 startp
= it
.current
.pos
;
12242 /* Run window scroll functions. */
12243 startp
= run_window_scroll_functions (window
, startp
);
12245 /* Display the window. Give up if new fonts are loaded, or if point
12247 if (!try_window (window
, startp
, 0))
12248 rc
= SCROLLING_NEED_LARGER_MATRICES
;
12249 else if (w
->cursor
.vpos
< 0)
12251 clear_glyph_matrix (w
->desired_matrix
);
12252 rc
= SCROLLING_FAILED
;
12256 /* Maybe forget recorded base line for line number display. */
12257 if (!just_this_one_p
12258 || current_buffer
->clip_changed
12259 || BEG_UNCHANGED
< CHARPOS (startp
))
12260 w
->base_line_number
= Qnil
;
12262 /* If cursor ends up on a partially visible line,
12263 treat that as being off the bottom of the screen. */
12264 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0))
12266 clear_glyph_matrix (w
->desired_matrix
);
12267 ++extra_scroll_margin_lines
;
12270 rc
= SCROLLING_SUCCESS
;
12277 /* Compute a suitable window start for window W if display of W starts
12278 on a continuation line. Value is non-zero if a new window start
12281 The new window start will be computed, based on W's width, starting
12282 from the start of the continued line. It is the start of the
12283 screen line with the minimum distance from the old start W->start. */
12286 compute_window_start_on_continuation_line (w
)
12289 struct text_pos pos
, start_pos
;
12290 int window_start_changed_p
= 0;
12292 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
12294 /* If window start is on a continuation line... Window start may be
12295 < BEGV in case there's invisible text at the start of the
12296 buffer (M-x rmail, for example). */
12297 if (CHARPOS (start_pos
) > BEGV
12298 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
12301 struct glyph_row
*row
;
12303 /* Handle the case that the window start is out of range. */
12304 if (CHARPOS (start_pos
) < BEGV
)
12305 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
12306 else if (CHARPOS (start_pos
) > ZV
)
12307 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
12309 /* Find the start of the continued line. This should be fast
12310 because scan_buffer is fast (newline cache). */
12311 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
12312 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
12313 row
, DEFAULT_FACE_ID
);
12314 reseat_at_previous_visible_line_start (&it
);
12316 /* If the line start is "too far" away from the window start,
12317 say it takes too much time to compute a new window start. */
12318 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
12319 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
12321 int min_distance
, distance
;
12323 /* Move forward by display lines to find the new window
12324 start. If window width was enlarged, the new start can
12325 be expected to be > the old start. If window width was
12326 decreased, the new window start will be < the old start.
12327 So, we're looking for the display line start with the
12328 minimum distance from the old window start. */
12329 pos
= it
.current
.pos
;
12330 min_distance
= INFINITY
;
12331 while ((distance
= abs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
12332 distance
< min_distance
)
12334 min_distance
= distance
;
12335 pos
= it
.current
.pos
;
12336 move_it_by_lines (&it
, 1, 0);
12339 /* Set the window start there. */
12340 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
12341 window_start_changed_p
= 1;
12345 return window_start_changed_p
;
12349 /* Try cursor movement in case text has not changed in window WINDOW,
12350 with window start STARTP. Value is
12352 CURSOR_MOVEMENT_SUCCESS if successful
12354 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
12356 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
12357 display. *SCROLL_STEP is set to 1, under certain circumstances, if
12358 we want to scroll as if scroll-step were set to 1. See the code.
12360 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
12361 which case we have to abort this redisplay, and adjust matrices
12366 CURSOR_MOVEMENT_SUCCESS
,
12367 CURSOR_MOVEMENT_CANNOT_BE_USED
,
12368 CURSOR_MOVEMENT_MUST_SCROLL
,
12369 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
12373 try_cursor_movement (window
, startp
, scroll_step
)
12374 Lisp_Object window
;
12375 struct text_pos startp
;
12378 struct window
*w
= XWINDOW (window
);
12379 struct frame
*f
= XFRAME (w
->frame
);
12380 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
12383 if (inhibit_try_cursor_movement
)
12387 /* Handle case where text has not changed, only point, and it has
12388 not moved off the frame. */
12389 if (/* Point may be in this window. */
12390 PT
>= CHARPOS (startp
)
12391 /* Selective display hasn't changed. */
12392 && !current_buffer
->clip_changed
12393 /* Function force-mode-line-update is used to force a thorough
12394 redisplay. It sets either windows_or_buffers_changed or
12395 update_mode_lines. So don't take a shortcut here for these
12397 && !update_mode_lines
12398 && !windows_or_buffers_changed
12399 && !cursor_type_changed
12400 /* Can't use this case if highlighting a region. When a
12401 region exists, cursor movement has to do more than just
12403 && !(!NILP (Vtransient_mark_mode
)
12404 && !NILP (current_buffer
->mark_active
))
12405 && NILP (w
->region_showing
)
12406 && NILP (Vshow_trailing_whitespace
)
12407 /* Right after splitting windows, last_point may be nil. */
12408 && INTEGERP (w
->last_point
)
12409 /* This code is not used for mini-buffer for the sake of the case
12410 of redisplaying to replace an echo area message; since in
12411 that case the mini-buffer contents per se are usually
12412 unchanged. This code is of no real use in the mini-buffer
12413 since the handling of this_line_start_pos, etc., in redisplay
12414 handles the same cases. */
12415 && !EQ (window
, minibuf_window
)
12416 /* When splitting windows or for new windows, it happens that
12417 redisplay is called with a nil window_end_vpos or one being
12418 larger than the window. This should really be fixed in
12419 window.c. I don't have this on my list, now, so we do
12420 approximately the same as the old redisplay code. --gerd. */
12421 && INTEGERP (w
->window_end_vpos
)
12422 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
12423 && (FRAME_WINDOW_P (f
)
12424 || !overlay_arrow_in_current_buffer_p ()))
12426 int this_scroll_margin
, top_scroll_margin
;
12427 struct glyph_row
*row
= NULL
;
12430 debug_method_add (w
, "cursor movement");
12433 /* Scroll if point within this distance from the top or bottom
12434 of the window. This is a pixel value. */
12435 this_scroll_margin
= max (0, scroll_margin
);
12436 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
12437 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
12439 top_scroll_margin
= this_scroll_margin
;
12440 if (WINDOW_WANTS_HEADER_LINE_P (w
))
12441 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
12443 /* Start with the row the cursor was displayed during the last
12444 not paused redisplay. Give up if that row is not valid. */
12445 if (w
->last_cursor
.vpos
< 0
12446 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
12447 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
12450 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
12451 if (row
->mode_line_p
)
12453 if (!row
->enabled_p
)
12454 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
12457 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
12460 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
12462 if (PT
> XFASTINT (w
->last_point
))
12464 /* Point has moved forward. */
12465 while (MATRIX_ROW_END_CHARPOS (row
) < PT
12466 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
12468 xassert (row
->enabled_p
);
12472 /* The end position of a row equals the start position
12473 of the next row. If PT is there, we would rather
12474 display it in the next line. */
12475 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
12476 && MATRIX_ROW_END_CHARPOS (row
) == PT
12477 && !cursor_row_p (w
, row
))
12480 /* If within the scroll margin, scroll. Note that
12481 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
12482 the next line would be drawn, and that
12483 this_scroll_margin can be zero. */
12484 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
12485 || PT
> MATRIX_ROW_END_CHARPOS (row
)
12486 /* Line is completely visible last line in window
12487 and PT is to be set in the next line. */
12488 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
12489 && PT
== MATRIX_ROW_END_CHARPOS (row
)
12490 && !row
->ends_at_zv_p
12491 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
12494 else if (PT
< XFASTINT (w
->last_point
))
12496 /* Cursor has to be moved backward. Note that PT >=
12497 CHARPOS (startp) because of the outer if-statement. */
12498 while (!row
->mode_line_p
12499 && (MATRIX_ROW_START_CHARPOS (row
) > PT
12500 || (MATRIX_ROW_START_CHARPOS (row
) == PT
12501 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
12502 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
12503 row
> w
->current_matrix
->rows
12504 && (row
-1)->ends_in_newline_from_string_p
))))
12505 && (row
->y
> top_scroll_margin
12506 || CHARPOS (startp
) == BEGV
))
12508 xassert (row
->enabled_p
);
12512 /* Consider the following case: Window starts at BEGV,
12513 there is invisible, intangible text at BEGV, so that
12514 display starts at some point START > BEGV. It can
12515 happen that we are called with PT somewhere between
12516 BEGV and START. Try to handle that case. */
12517 if (row
< w
->current_matrix
->rows
12518 || row
->mode_line_p
)
12520 row
= w
->current_matrix
->rows
;
12521 if (row
->mode_line_p
)
12525 /* Due to newlines in overlay strings, we may have to
12526 skip forward over overlay strings. */
12527 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
12528 && MATRIX_ROW_END_CHARPOS (row
) == PT
12529 && !cursor_row_p (w
, row
))
12532 /* If within the scroll margin, scroll. */
12533 if (row
->y
< top_scroll_margin
12534 && CHARPOS (startp
) != BEGV
)
12539 /* Cursor did not move. So don't scroll even if cursor line
12540 is partially visible, as it was so before. */
12541 rc
= CURSOR_MOVEMENT_SUCCESS
;
12544 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
12545 || PT
> MATRIX_ROW_END_CHARPOS (row
))
12547 /* if PT is not in the glyph row, give up. */
12548 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
12550 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
12551 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
12552 && make_cursor_line_fully_visible_p
)
12554 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
12555 && !row
->ends_at_zv_p
12556 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
12557 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
12558 else if (row
->height
> window_box_height (w
))
12560 /* If we end up in a partially visible line, let's
12561 make it fully visible, except when it's taller
12562 than the window, in which case we can't do much
12565 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
12569 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
12570 if (!cursor_row_fully_visible_p (w
, 0, 1))
12571 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
12573 rc
= CURSOR_MOVEMENT_SUCCESS
;
12577 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
12582 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
12584 rc
= CURSOR_MOVEMENT_SUCCESS
;
12589 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
12590 && MATRIX_ROW_START_CHARPOS (row
) == PT
12591 && cursor_row_p (w
, row
));
12600 set_vertical_scroll_bar (w
)
12603 int start
, end
, whole
;
12605 /* Calculate the start and end positions for the current window.
12606 At some point, it would be nice to choose between scrollbars
12607 which reflect the whole buffer size, with special markers
12608 indicating narrowing, and scrollbars which reflect only the
12611 Note that mini-buffers sometimes aren't displaying any text. */
12612 if (!MINI_WINDOW_P (w
)
12613 || (w
== XWINDOW (minibuf_window
)
12614 && NILP (echo_area_buffer
[0])))
12616 struct buffer
*buf
= XBUFFER (w
->buffer
);
12617 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
12618 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
12619 /* I don't think this is guaranteed to be right. For the
12620 moment, we'll pretend it is. */
12621 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
12625 if (whole
< (end
- start
))
12626 whole
= end
- start
;
12629 start
= end
= whole
= 0;
12631 /* Indicate what this scroll bar ought to be displaying now. */
12632 set_vertical_scroll_bar_hook (w
, end
- start
, whole
, start
);
12636 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
12637 selected_window is redisplayed.
12639 We can return without actually redisplaying the window if
12640 fonts_changed_p is nonzero. In that case, redisplay_internal will
12644 redisplay_window (window
, just_this_one_p
)
12645 Lisp_Object window
;
12646 int just_this_one_p
;
12648 struct window
*w
= XWINDOW (window
);
12649 struct frame
*f
= XFRAME (w
->frame
);
12650 struct buffer
*buffer
= XBUFFER (w
->buffer
);
12651 struct buffer
*old
= current_buffer
;
12652 struct text_pos lpoint
, opoint
, startp
;
12653 int update_mode_line
;
12656 /* Record it now because it's overwritten. */
12657 int current_matrix_up_to_date_p
= 0;
12658 int used_current_matrix_p
= 0;
12659 /* This is less strict than current_matrix_up_to_date_p.
12660 It indictes that the buffer contents and narrowing are unchanged. */
12661 int buffer_unchanged_p
= 0;
12662 int temp_scroll_step
= 0;
12663 int count
= SPECPDL_INDEX ();
12665 int centering_position
= -1;
12666 int last_line_misfit
= 0;
12668 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
12671 /* W must be a leaf window here. */
12672 xassert (!NILP (w
->buffer
));
12674 *w
->desired_matrix
->method
= 0;
12677 specbind (Qinhibit_point_motion_hooks
, Qt
);
12679 reconsider_clip_changes (w
, buffer
);
12681 /* Has the mode line to be updated? */
12682 update_mode_line
= (!NILP (w
->update_mode_line
)
12683 || update_mode_lines
12684 || buffer
->clip_changed
12685 || buffer
->prevent_redisplay_optimizations_p
);
12687 if (MINI_WINDOW_P (w
))
12689 if (w
== XWINDOW (echo_area_window
)
12690 && !NILP (echo_area_buffer
[0]))
12692 if (update_mode_line
)
12693 /* We may have to update a tty frame's menu bar or a
12694 tool-bar. Example `M-x C-h C-h C-g'. */
12695 goto finish_menu_bars
;
12697 /* We've already displayed the echo area glyphs in this window. */
12698 goto finish_scroll_bars
;
12700 else if ((w
!= XWINDOW (minibuf_window
)
12701 || minibuf_level
== 0)
12702 /* When buffer is nonempty, redisplay window normally. */
12703 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
12704 /* Quail displays non-mini buffers in minibuffer window.
12705 In that case, redisplay the window normally. */
12706 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
12708 /* W is a mini-buffer window, but it's not active, so clear
12710 int yb
= window_text_bottom_y (w
);
12711 struct glyph_row
*row
;
12714 for (y
= 0, row
= w
->desired_matrix
->rows
;
12716 y
+= row
->height
, ++row
)
12717 blank_row (w
, row
, y
);
12718 goto finish_scroll_bars
;
12721 clear_glyph_matrix (w
->desired_matrix
);
12724 /* Otherwise set up data on this window; select its buffer and point
12726 /* Really select the buffer, for the sake of buffer-local
12728 set_buffer_internal_1 (XBUFFER (w
->buffer
));
12729 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
12731 current_matrix_up_to_date_p
12732 = (!NILP (w
->window_end_valid
)
12733 && !current_buffer
->clip_changed
12734 && !current_buffer
->prevent_redisplay_optimizations_p
12735 && XFASTINT (w
->last_modified
) >= MODIFF
12736 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
12739 = (!NILP (w
->window_end_valid
)
12740 && !current_buffer
->clip_changed
12741 && XFASTINT (w
->last_modified
) >= MODIFF
12742 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
12744 /* When windows_or_buffers_changed is non-zero, we can't rely on
12745 the window end being valid, so set it to nil there. */
12746 if (windows_or_buffers_changed
)
12748 /* If window starts on a continuation line, maybe adjust the
12749 window start in case the window's width changed. */
12750 if (XMARKER (w
->start
)->buffer
== current_buffer
)
12751 compute_window_start_on_continuation_line (w
);
12753 w
->window_end_valid
= Qnil
;
12756 /* Some sanity checks. */
12757 CHECK_WINDOW_END (w
);
12758 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
12760 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
12763 /* If %c is in mode line, update it if needed. */
12764 if (!NILP (w
->column_number_displayed
)
12765 /* This alternative quickly identifies a common case
12766 where no change is needed. */
12767 && !(PT
== XFASTINT (w
->last_point
)
12768 && XFASTINT (w
->last_modified
) >= MODIFF
12769 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
12770 && (XFASTINT (w
->column_number_displayed
)
12771 != (int) current_column ())) /* iftc */
12772 update_mode_line
= 1;
12774 /* Count number of windows showing the selected buffer. An indirect
12775 buffer counts as its base buffer. */
12776 if (!just_this_one_p
)
12778 struct buffer
*current_base
, *window_base
;
12779 current_base
= current_buffer
;
12780 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
12781 if (current_base
->base_buffer
)
12782 current_base
= current_base
->base_buffer
;
12783 if (window_base
->base_buffer
)
12784 window_base
= window_base
->base_buffer
;
12785 if (current_base
== window_base
)
12789 /* Point refers normally to the selected window. For any other
12790 window, set up appropriate value. */
12791 if (!EQ (window
, selected_window
))
12793 int new_pt
= XMARKER (w
->pointm
)->charpos
;
12794 int new_pt_byte
= marker_byte_position (w
->pointm
);
12798 new_pt_byte
= BEGV_BYTE
;
12799 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
12801 else if (new_pt
> (ZV
- 1))
12804 new_pt_byte
= ZV_BYTE
;
12805 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
12808 /* We don't use SET_PT so that the point-motion hooks don't run. */
12809 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
12812 /* If any of the character widths specified in the display table
12813 have changed, invalidate the width run cache. It's true that
12814 this may be a bit late to catch such changes, but the rest of
12815 redisplay goes (non-fatally) haywire when the display table is
12816 changed, so why should we worry about doing any better? */
12817 if (current_buffer
->width_run_cache
)
12819 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
12821 if (! disptab_matches_widthtab (disptab
,
12822 XVECTOR (current_buffer
->width_table
)))
12824 invalidate_region_cache (current_buffer
,
12825 current_buffer
->width_run_cache
,
12827 recompute_width_table (current_buffer
, disptab
);
12831 /* If window-start is screwed up, choose a new one. */
12832 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
12835 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12837 /* If someone specified a new starting point but did not insist,
12838 check whether it can be used. */
12839 if (!NILP (w
->optional_new_start
)
12840 && CHARPOS (startp
) >= BEGV
12841 && CHARPOS (startp
) <= ZV
)
12843 w
->optional_new_start
= Qnil
;
12844 start_display (&it
, w
, startp
);
12845 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
12846 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
12847 if (IT_CHARPOS (it
) == PT
)
12848 w
->force_start
= Qt
;
12849 /* IT may overshoot PT if text at PT is invisible. */
12850 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
12851 w
->force_start
= Qt
;
12854 /* Handle case where place to start displaying has been specified,
12855 unless the specified location is outside the accessible range. */
12856 if (!NILP (w
->force_start
)
12857 || w
->frozen_window_start_p
)
12859 /* We set this later on if we have to adjust point. */
12863 w
->force_start
= Qnil
;
12865 w
->window_end_valid
= Qnil
;
12867 /* Forget any recorded base line for line number display. */
12868 if (!buffer_unchanged_p
)
12869 w
->base_line_number
= Qnil
;
12871 /* Redisplay the mode line. Select the buffer properly for that.
12872 Also, run the hook window-scroll-functions
12873 because we have scrolled. */
12874 /* Note, we do this after clearing force_start because
12875 if there's an error, it is better to forget about force_start
12876 than to get into an infinite loop calling the hook functions
12877 and having them get more errors. */
12878 if (!update_mode_line
12879 || ! NILP (Vwindow_scroll_functions
))
12881 update_mode_line
= 1;
12882 w
->update_mode_line
= Qt
;
12883 startp
= run_window_scroll_functions (window
, startp
);
12886 w
->last_modified
= make_number (0);
12887 w
->last_overlay_modified
= make_number (0);
12888 if (CHARPOS (startp
) < BEGV
)
12889 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
12890 else if (CHARPOS (startp
) > ZV
)
12891 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
12893 /* Redisplay, then check if cursor has been set during the
12894 redisplay. Give up if new fonts were loaded. */
12895 val
= try_window (window
, startp
, 1);
12898 w
->force_start
= Qt
;
12899 clear_glyph_matrix (w
->desired_matrix
);
12900 goto need_larger_matrices
;
12902 /* Point was outside the scroll margins. */
12904 new_vpos
= window_box_height (w
) / 2;
12906 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
12908 /* If point does not appear, try to move point so it does
12909 appear. The desired matrix has been built above, so we
12910 can use it here. */
12911 new_vpos
= window_box_height (w
) / 2;
12914 if (!cursor_row_fully_visible_p (w
, 0, 0))
12916 /* Point does appear, but on a line partly visible at end of window.
12917 Move it back to a fully-visible line. */
12918 new_vpos
= window_box_height (w
);
12921 /* If we need to move point for either of the above reasons,
12922 now actually do it. */
12925 struct glyph_row
*row
;
12927 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
12928 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
12931 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
12932 MATRIX_ROW_START_BYTEPOS (row
));
12934 if (w
!= XWINDOW (selected_window
))
12935 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
12936 else if (current_buffer
== old
)
12937 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
12939 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
12941 /* If we are highlighting the region, then we just changed
12942 the region, so redisplay to show it. */
12943 if (!NILP (Vtransient_mark_mode
)
12944 && !NILP (current_buffer
->mark_active
))
12946 clear_glyph_matrix (w
->desired_matrix
);
12947 if (!try_window (window
, startp
, 0))
12948 goto need_larger_matrices
;
12953 debug_method_add (w
, "forced window start");
12958 /* Handle case where text has not changed, only point, and it has
12959 not moved off the frame, and we are not retrying after hscroll.
12960 (current_matrix_up_to_date_p is nonzero when retrying.) */
12961 if (current_matrix_up_to_date_p
12962 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
12963 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
12967 case CURSOR_MOVEMENT_SUCCESS
:
12968 used_current_matrix_p
= 1;
12971 #if 0 /* try_cursor_movement never returns this value. */
12972 case CURSOR_MOVEMENT_NEED_LARGER_MATRICES
:
12973 goto need_larger_matrices
;
12976 case CURSOR_MOVEMENT_MUST_SCROLL
:
12977 goto try_to_scroll
;
12983 /* If current starting point was originally the beginning of a line
12984 but no longer is, find a new starting point. */
12985 else if (!NILP (w
->start_at_line_beg
)
12986 && !(CHARPOS (startp
) <= BEGV
12987 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
12990 debug_method_add (w
, "recenter 1");
12995 /* Try scrolling with try_window_id. Value is > 0 if update has
12996 been done, it is -1 if we know that the same window start will
12997 not work. It is 0 if unsuccessful for some other reason. */
12998 else if ((tem
= try_window_id (w
)) != 0)
13001 debug_method_add (w
, "try_window_id %d", tem
);
13004 if (fonts_changed_p
)
13005 goto need_larger_matrices
;
13009 /* Otherwise try_window_id has returned -1 which means that we
13010 don't want the alternative below this comment to execute. */
13012 else if (CHARPOS (startp
) >= BEGV
13013 && CHARPOS (startp
) <= ZV
13014 && PT
>= CHARPOS (startp
)
13015 && (CHARPOS (startp
) < ZV
13016 /* Avoid starting at end of buffer. */
13017 || CHARPOS (startp
) == BEGV
13018 || (XFASTINT (w
->last_modified
) >= MODIFF
13019 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
13022 /* If first window line is a continuation line, and window start
13023 is inside the modified region, but the first change is before
13024 current window start, we must select a new window start.*/
13025 if (NILP (w
->start_at_line_beg
)
13026 && CHARPOS (startp
) > BEGV
)
13028 /* Make sure beg_unchanged and end_unchanged are up to date.
13029 Do it only if buffer has really changed. This may or may
13030 not have been done by try_window_id (see which) already. */
13031 if (MODIFF
> SAVE_MODIFF
13032 /* This seems to happen sometimes after saving a buffer. */
13033 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
13035 if (GPT
- BEG
< BEG_UNCHANGED
)
13036 BEG_UNCHANGED
= GPT
- BEG
;
13037 if (Z
- GPT
< END_UNCHANGED
)
13038 END_UNCHANGED
= Z
- GPT
;
13041 if (CHARPOS (startp
) > BEG
+ BEG_UNCHANGED
13042 && CHARPOS (startp
) <= Z
- END_UNCHANGED
)
13044 /* There doesn't seems to be a simple way to find a new
13045 window start that is near the old window start, so
13046 we just recenter. */
13052 debug_method_add (w
, "same window start");
13055 /* Try to redisplay starting at same place as before.
13056 If point has not moved off frame, accept the results. */
13057 if (!current_matrix_up_to_date_p
13058 /* Don't use try_window_reusing_current_matrix in this case
13059 because a window scroll function can have changed the
13061 || !NILP (Vwindow_scroll_functions
)
13062 || MINI_WINDOW_P (w
)
13063 || !(used_current_matrix_p
13064 = try_window_reusing_current_matrix (w
)))
13066 IF_DEBUG (debug_method_add (w
, "1"));
13067 if (try_window (window
, startp
, 1) < 0)
13068 /* -1 means we need to scroll.
13069 0 means we need new matrices, but fonts_changed_p
13070 is set in that case, so we will detect it below. */
13071 goto try_to_scroll
;
13074 if (fonts_changed_p
)
13075 goto need_larger_matrices
;
13077 if (w
->cursor
.vpos
>= 0)
13079 if (!just_this_one_p
13080 || current_buffer
->clip_changed
13081 || BEG_UNCHANGED
< CHARPOS (startp
))
13082 /* Forget any recorded base line for line number display. */
13083 w
->base_line_number
= Qnil
;
13085 if (!cursor_row_fully_visible_p (w
, 1, 0))
13087 clear_glyph_matrix (w
->desired_matrix
);
13088 last_line_misfit
= 1;
13090 /* Drop through and scroll. */
13095 clear_glyph_matrix (w
->desired_matrix
);
13100 w
->last_modified
= make_number (0);
13101 w
->last_overlay_modified
= make_number (0);
13103 /* Redisplay the mode line. Select the buffer properly for that. */
13104 if (!update_mode_line
)
13106 update_mode_line
= 1;
13107 w
->update_mode_line
= Qt
;
13110 /* Try to scroll by specified few lines. */
13111 if ((scroll_conservatively
13113 || temp_scroll_step
13114 || NUMBERP (current_buffer
->scroll_up_aggressively
)
13115 || NUMBERP (current_buffer
->scroll_down_aggressively
))
13116 && !current_buffer
->clip_changed
13117 && CHARPOS (startp
) >= BEGV
13118 && CHARPOS (startp
) <= ZV
)
13120 /* The function returns -1 if new fonts were loaded, 1 if
13121 successful, 0 if not successful. */
13122 int rc
= try_scrolling (window
, just_this_one_p
,
13123 scroll_conservatively
,
13125 temp_scroll_step
, last_line_misfit
);
13128 case SCROLLING_SUCCESS
:
13131 case SCROLLING_NEED_LARGER_MATRICES
:
13132 goto need_larger_matrices
;
13134 case SCROLLING_FAILED
:
13142 /* Finally, just choose place to start which centers point */
13145 if (centering_position
< 0)
13146 centering_position
= window_box_height (w
) / 2;
13149 debug_method_add (w
, "recenter");
13152 /* w->vscroll = 0; */
13154 /* Forget any previously recorded base line for line number display. */
13155 if (!buffer_unchanged_p
)
13156 w
->base_line_number
= Qnil
;
13158 /* Move backward half the height of the window. */
13159 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
13160 it
.current_y
= it
.last_visible_y
;
13161 move_it_vertically_backward (&it
, centering_position
);
13162 xassert (IT_CHARPOS (it
) >= BEGV
);
13164 /* The function move_it_vertically_backward may move over more
13165 than the specified y-distance. If it->w is small, e.g. a
13166 mini-buffer window, we may end up in front of the window's
13167 display area. Start displaying at the start of the line
13168 containing PT in this case. */
13169 if (it
.current_y
<= 0)
13171 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
13172 move_it_vertically_backward (&it
, 0);
13174 /* I think this assert is bogus if buffer contains
13175 invisible text or images. KFS. */
13176 xassert (IT_CHARPOS (it
) <= PT
);
13181 it
.current_x
= it
.hpos
= 0;
13183 /* Set startp here explicitly in case that helps avoid an infinite loop
13184 in case the window-scroll-functions functions get errors. */
13185 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
13187 /* Run scroll hooks. */
13188 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
13190 /* Redisplay the window. */
13191 if (!current_matrix_up_to_date_p
13192 || windows_or_buffers_changed
13193 || cursor_type_changed
13194 /* Don't use try_window_reusing_current_matrix in this case
13195 because it can have changed the buffer. */
13196 || !NILP (Vwindow_scroll_functions
)
13197 || !just_this_one_p
13198 || MINI_WINDOW_P (w
)
13199 || !(used_current_matrix_p
13200 = try_window_reusing_current_matrix (w
)))
13201 try_window (window
, startp
, 0);
13203 /* If new fonts have been loaded (due to fontsets), give up. We
13204 have to start a new redisplay since we need to re-adjust glyph
13206 if (fonts_changed_p
)
13207 goto need_larger_matrices
;
13209 /* If cursor did not appear assume that the middle of the window is
13210 in the first line of the window. Do it again with the next line.
13211 (Imagine a window of height 100, displaying two lines of height
13212 60. Moving back 50 from it->last_visible_y will end in the first
13214 if (w
->cursor
.vpos
< 0)
13216 if (!NILP (w
->window_end_valid
)
13217 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
13219 clear_glyph_matrix (w
->desired_matrix
);
13220 move_it_by_lines (&it
, 1, 0);
13221 try_window (window
, it
.current
.pos
, 0);
13223 else if (PT
< IT_CHARPOS (it
))
13225 clear_glyph_matrix (w
->desired_matrix
);
13226 move_it_by_lines (&it
, -1, 0);
13227 try_window (window
, it
.current
.pos
, 0);
13231 /* Not much we can do about it. */
13235 /* Consider the following case: Window starts at BEGV, there is
13236 invisible, intangible text at BEGV, so that display starts at
13237 some point START > BEGV. It can happen that we are called with
13238 PT somewhere between BEGV and START. Try to handle that case. */
13239 if (w
->cursor
.vpos
< 0)
13241 struct glyph_row
*row
= w
->current_matrix
->rows
;
13242 if (row
->mode_line_p
)
13244 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13247 if (!cursor_row_fully_visible_p (w
, 0, 0))
13249 /* If vscroll is enabled, disable it and try again. */
13253 clear_glyph_matrix (w
->desired_matrix
);
13257 /* If centering point failed to make the whole line visible,
13258 put point at the top instead. That has to make the whole line
13259 visible, if it can be done. */
13260 if (centering_position
== 0)
13263 clear_glyph_matrix (w
->desired_matrix
);
13264 centering_position
= 0;
13270 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13271 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
13272 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
13275 /* Display the mode line, if we must. */
13276 if ((update_mode_line
13277 /* If window not full width, must redo its mode line
13278 if (a) the window to its side is being redone and
13279 (b) we do a frame-based redisplay. This is a consequence
13280 of how inverted lines are drawn in frame-based redisplay. */
13281 || (!just_this_one_p
13282 && !FRAME_WINDOW_P (f
)
13283 && !WINDOW_FULL_WIDTH_P (w
))
13284 /* Line number to display. */
13285 || INTEGERP (w
->base_line_pos
)
13286 /* Column number is displayed and different from the one displayed. */
13287 || (!NILP (w
->column_number_displayed
)
13288 && (XFASTINT (w
->column_number_displayed
)
13289 != (int) current_column ()))) /* iftc */
13290 /* This means that the window has a mode line. */
13291 && (WINDOW_WANTS_MODELINE_P (w
)
13292 || WINDOW_WANTS_HEADER_LINE_P (w
)))
13294 display_mode_lines (w
);
13296 /* If mode line height has changed, arrange for a thorough
13297 immediate redisplay using the correct mode line height. */
13298 if (WINDOW_WANTS_MODELINE_P (w
)
13299 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
13301 fonts_changed_p
= 1;
13302 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
13303 = DESIRED_MODE_LINE_HEIGHT (w
);
13306 /* If top line height has changed, arrange for a thorough
13307 immediate redisplay using the correct mode line height. */
13308 if (WINDOW_WANTS_HEADER_LINE_P (w
)
13309 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
13311 fonts_changed_p
= 1;
13312 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
13313 = DESIRED_HEADER_LINE_HEIGHT (w
);
13316 if (fonts_changed_p
)
13317 goto need_larger_matrices
;
13320 if (!line_number_displayed
13321 && !BUFFERP (w
->base_line_pos
))
13323 w
->base_line_pos
= Qnil
;
13324 w
->base_line_number
= Qnil
;
13329 /* When we reach a frame's selected window, redo the frame's menu bar. */
13330 if (update_mode_line
13331 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
13333 int redisplay_menu_p
= 0;
13334 int redisplay_tool_bar_p
= 0;
13336 if (FRAME_WINDOW_P (f
))
13338 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
13339 || defined (USE_GTK)
13340 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
13342 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
13346 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
13348 if (redisplay_menu_p
)
13349 display_menu_bar (w
);
13351 #ifdef HAVE_WINDOW_SYSTEM
13353 redisplay_tool_bar_p
= FRAME_EXTERNAL_TOOL_BAR (f
);
13355 redisplay_tool_bar_p
= WINDOWP (f
->tool_bar_window
)
13356 && (FRAME_TOOL_BAR_LINES (f
) > 0
13357 || auto_resize_tool_bars_p
);
13361 if (redisplay_tool_bar_p
)
13362 redisplay_tool_bar (f
);
13366 #ifdef HAVE_WINDOW_SYSTEM
13367 if (FRAME_WINDOW_P (f
)
13368 && update_window_fringes (w
, (just_this_one_p
13369 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
13370 || w
->pseudo_window_p
)))
13374 if (draw_window_fringes (w
, 1))
13375 x_draw_vertical_border (w
);
13379 #endif /* HAVE_WINDOW_SYSTEM */
13381 /* We go to this label, with fonts_changed_p nonzero,
13382 if it is necessary to try again using larger glyph matrices.
13383 We have to redeem the scroll bar even in this case,
13384 because the loop in redisplay_internal expects that. */
13385 need_larger_matrices
:
13387 finish_scroll_bars
:
13389 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
13391 /* Set the thumb's position and size. */
13392 set_vertical_scroll_bar (w
);
13394 /* Note that we actually used the scroll bar attached to this
13395 window, so it shouldn't be deleted at the end of redisplay. */
13396 redeem_scroll_bar_hook (w
);
13399 /* Restore current_buffer and value of point in it. */
13400 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
13401 set_buffer_internal_1 (old
);
13402 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
13404 unbind_to (count
, Qnil
);
13408 /* Build the complete desired matrix of WINDOW with a window start
13409 buffer position POS.
13411 Value is 1 if successful. It is zero if fonts were loaded during
13412 redisplay which makes re-adjusting glyph matrices necessary, and -1
13413 if point would appear in the scroll margins.
13414 (We check that only if CHECK_MARGINS is nonzero. */
13417 try_window (window
, pos
, check_margins
)
13418 Lisp_Object window
;
13419 struct text_pos pos
;
13422 struct window
*w
= XWINDOW (window
);
13424 struct glyph_row
*last_text_row
= NULL
;
13426 /* Make POS the new window start. */
13427 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
13429 /* Mark cursor position as unknown. No overlay arrow seen. */
13430 w
->cursor
.vpos
= -1;
13431 overlay_arrow_seen
= 0;
13433 /* Initialize iterator and info to start at POS. */
13434 start_display (&it
, w
, pos
);
13436 /* Display all lines of W. */
13437 while (it
.current_y
< it
.last_visible_y
)
13439 if (display_line (&it
))
13440 last_text_row
= it
.glyph_row
- 1;
13441 if (fonts_changed_p
)
13445 /* Don't let the cursor end in the scroll margins. */
13447 && !MINI_WINDOW_P (w
))
13449 int this_scroll_margin
;
13451 this_scroll_margin
= max (0, scroll_margin
);
13452 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
13453 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
13455 if ((w
->cursor
.y
< this_scroll_margin
13456 && CHARPOS (pos
) > BEGV
13457 && IT_CHARPOS (it
) < ZV
)
13458 /* rms: considering make_cursor_line_fully_visible_p here
13459 seems to give wrong results. We don't want to recenter
13460 when the last line is partly visible, we want to allow
13461 that case to be handled in the usual way. */
13462 || (w
->cursor
.y
+ 1) > it
.last_visible_y
)
13464 w
->cursor
.vpos
= -1;
13465 clear_glyph_matrix (w
->desired_matrix
);
13470 /* If bottom moved off end of frame, change mode line percentage. */
13471 if (XFASTINT (w
->window_end_pos
) <= 0
13472 && Z
!= IT_CHARPOS (it
))
13473 w
->update_mode_line
= Qt
;
13475 /* Set window_end_pos to the offset of the last character displayed
13476 on the window from the end of current_buffer. Set
13477 window_end_vpos to its row number. */
13480 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
13481 w
->window_end_bytepos
13482 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
13484 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
13486 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
13487 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
13488 ->displays_text_p
);
13492 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
13493 w
->window_end_pos
= make_number (Z
- ZV
);
13494 w
->window_end_vpos
= make_number (0);
13497 /* But that is not valid info until redisplay finishes. */
13498 w
->window_end_valid
= Qnil
;
13504 /************************************************************************
13505 Window redisplay reusing current matrix when buffer has not changed
13506 ************************************************************************/
13508 /* Try redisplay of window W showing an unchanged buffer with a
13509 different window start than the last time it was displayed by
13510 reusing its current matrix. Value is non-zero if successful.
13511 W->start is the new window start. */
13514 try_window_reusing_current_matrix (w
)
13517 struct frame
*f
= XFRAME (w
->frame
);
13518 struct glyph_row
*row
, *bottom_row
;
13521 struct text_pos start
, new_start
;
13522 int nrows_scrolled
, i
;
13523 struct glyph_row
*last_text_row
;
13524 struct glyph_row
*last_reused_text_row
;
13525 struct glyph_row
*start_row
;
13526 int start_vpos
, min_y
, max_y
;
13529 if (inhibit_try_window_reusing
)
13533 if (/* This function doesn't handle terminal frames. */
13534 !FRAME_WINDOW_P (f
)
13535 /* Don't try to reuse the display if windows have been split
13537 || windows_or_buffers_changed
13538 || cursor_type_changed
)
13541 /* Can't do this if region may have changed. */
13542 if ((!NILP (Vtransient_mark_mode
)
13543 && !NILP (current_buffer
->mark_active
))
13544 || !NILP (w
->region_showing
)
13545 || !NILP (Vshow_trailing_whitespace
))
13548 /* If top-line visibility has changed, give up. */
13549 if (WINDOW_WANTS_HEADER_LINE_P (w
)
13550 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
13553 /* Give up if old or new display is scrolled vertically. We could
13554 make this function handle this, but right now it doesn't. */
13555 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
13556 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
13559 /* The variable new_start now holds the new window start. The old
13560 start `start' can be determined from the current matrix. */
13561 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
13562 start
= start_row
->start
.pos
;
13563 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
13565 /* Clear the desired matrix for the display below. */
13566 clear_glyph_matrix (w
->desired_matrix
);
13568 if (CHARPOS (new_start
) <= CHARPOS (start
))
13572 /* Don't use this method if the display starts with an ellipsis
13573 displayed for invisible text. It's not easy to handle that case
13574 below, and it's certainly not worth the effort since this is
13575 not a frequent case. */
13576 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
13579 IF_DEBUG (debug_method_add (w
, "twu1"));
13581 /* Display up to a row that can be reused. The variable
13582 last_text_row is set to the last row displayed that displays
13583 text. Note that it.vpos == 0 if or if not there is a
13584 header-line; it's not the same as the MATRIX_ROW_VPOS! */
13585 start_display (&it
, w
, new_start
);
13586 first_row_y
= it
.current_y
;
13587 w
->cursor
.vpos
= -1;
13588 last_text_row
= last_reused_text_row
= NULL
;
13590 while (it
.current_y
< it
.last_visible_y
13591 && !fonts_changed_p
)
13593 /* If we have reached into the characters in the START row,
13594 that means the line boundaries have changed. So we
13595 can't start copying with the row START. Maybe it will
13596 work to start copying with the following row. */
13597 while (IT_CHARPOS (it
) > CHARPOS (start
))
13599 /* Advance to the next row as the "start". */
13601 start
= start_row
->start
.pos
;
13602 /* If there are no more rows to try, or just one, give up. */
13603 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
13604 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
13605 || CHARPOS (start
) == ZV
)
13607 clear_glyph_matrix (w
->desired_matrix
);
13611 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
13613 /* If we have reached alignment,
13614 we can copy the rest of the rows. */
13615 if (IT_CHARPOS (it
) == CHARPOS (start
))
13618 if (display_line (&it
))
13619 last_text_row
= it
.glyph_row
- 1;
13622 /* A value of current_y < last_visible_y means that we stopped
13623 at the previous window start, which in turn means that we
13624 have at least one reusable row. */
13625 if (it
.current_y
< it
.last_visible_y
)
13627 /* IT.vpos always starts from 0; it counts text lines. */
13628 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
13630 /* Find PT if not already found in the lines displayed. */
13631 if (w
->cursor
.vpos
< 0)
13633 int dy
= it
.current_y
- start_row
->y
;
13635 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
13636 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
13638 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
13639 dy
, nrows_scrolled
);
13642 clear_glyph_matrix (w
->desired_matrix
);
13647 /* Scroll the display. Do it before the current matrix is
13648 changed. The problem here is that update has not yet
13649 run, i.e. part of the current matrix is not up to date.
13650 scroll_run_hook will clear the cursor, and use the
13651 current matrix to get the height of the row the cursor is
13653 run
.current_y
= start_row
->y
;
13654 run
.desired_y
= it
.current_y
;
13655 run
.height
= it
.last_visible_y
- it
.current_y
;
13657 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
13660 rif
->update_window_begin_hook (w
);
13661 rif
->clear_window_mouse_face (w
);
13662 rif
->scroll_run_hook (w
, &run
);
13663 rif
->update_window_end_hook (w
, 0, 0);
13667 /* Shift current matrix down by nrows_scrolled lines. */
13668 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
13669 rotate_matrix (w
->current_matrix
,
13671 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
13674 /* Disable lines that must be updated. */
13675 for (i
= 0; i
< it
.vpos
; ++i
)
13676 (start_row
+ i
)->enabled_p
= 0;
13678 /* Re-compute Y positions. */
13679 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
13680 max_y
= it
.last_visible_y
;
13681 for (row
= start_row
+ nrows_scrolled
;
13685 row
->y
= it
.current_y
;
13686 row
->visible_height
= row
->height
;
13688 if (row
->y
< min_y
)
13689 row
->visible_height
-= min_y
- row
->y
;
13690 if (row
->y
+ row
->height
> max_y
)
13691 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
13692 row
->redraw_fringe_bitmaps_p
= 1;
13694 it
.current_y
+= row
->height
;
13696 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
13697 last_reused_text_row
= row
;
13698 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
13702 /* Disable lines in the current matrix which are now
13703 below the window. */
13704 for (++row
; row
< bottom_row
; ++row
)
13705 row
->enabled_p
= row
->mode_line_p
= 0;
13708 /* Update window_end_pos etc.; last_reused_text_row is the last
13709 reused row from the current matrix containing text, if any.
13710 The value of last_text_row is the last displayed line
13711 containing text. */
13712 if (last_reused_text_row
)
13714 w
->window_end_bytepos
13715 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
13717 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
13719 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
13720 w
->current_matrix
));
13722 else if (last_text_row
)
13724 w
->window_end_bytepos
13725 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
13727 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
13729 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
13733 /* This window must be completely empty. */
13734 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
13735 w
->window_end_pos
= make_number (Z
- ZV
);
13736 w
->window_end_vpos
= make_number (0);
13738 w
->window_end_valid
= Qnil
;
13740 /* Update hint: don't try scrolling again in update_window. */
13741 w
->desired_matrix
->no_scrolling_p
= 1;
13744 debug_method_add (w
, "try_window_reusing_current_matrix 1");
13748 else if (CHARPOS (new_start
) > CHARPOS (start
))
13750 struct glyph_row
*pt_row
, *row
;
13751 struct glyph_row
*first_reusable_row
;
13752 struct glyph_row
*first_row_to_display
;
13754 int yb
= window_text_bottom_y (w
);
13756 /* Find the row starting at new_start, if there is one. Don't
13757 reuse a partially visible line at the end. */
13758 first_reusable_row
= start_row
;
13759 while (first_reusable_row
->enabled_p
13760 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
13761 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
13762 < CHARPOS (new_start
)))
13763 ++first_reusable_row
;
13765 /* Give up if there is no row to reuse. */
13766 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
13767 || !first_reusable_row
->enabled_p
13768 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
13769 != CHARPOS (new_start
)))
13772 /* We can reuse fully visible rows beginning with
13773 first_reusable_row to the end of the window. Set
13774 first_row_to_display to the first row that cannot be reused.
13775 Set pt_row to the row containing point, if there is any. */
13777 for (first_row_to_display
= first_reusable_row
;
13778 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
13779 ++first_row_to_display
)
13781 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
13782 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
13783 pt_row
= first_row_to_display
;
13786 /* Start displaying at the start of first_row_to_display. */
13787 xassert (first_row_to_display
->y
< yb
);
13788 init_to_row_start (&it
, w
, first_row_to_display
);
13790 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
13792 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
13794 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
13795 + WINDOW_HEADER_LINE_HEIGHT (w
));
13797 /* Display lines beginning with first_row_to_display in the
13798 desired matrix. Set last_text_row to the last row displayed
13799 that displays text. */
13800 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
13801 if (pt_row
== NULL
)
13802 w
->cursor
.vpos
= -1;
13803 last_text_row
= NULL
;
13804 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
13805 if (display_line (&it
))
13806 last_text_row
= it
.glyph_row
- 1;
13808 /* Give up If point isn't in a row displayed or reused. */
13809 if (w
->cursor
.vpos
< 0)
13811 clear_glyph_matrix (w
->desired_matrix
);
13815 /* If point is in a reused row, adjust y and vpos of the cursor
13819 w
->cursor
.vpos
-= nrows_scrolled
;
13820 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
13823 /* Scroll the display. */
13824 run
.current_y
= first_reusable_row
->y
;
13825 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
13826 run
.height
= it
.last_visible_y
- run
.current_y
;
13827 dy
= run
.current_y
- run
.desired_y
;
13832 rif
->update_window_begin_hook (w
);
13833 rif
->clear_window_mouse_face (w
);
13834 rif
->scroll_run_hook (w
, &run
);
13835 rif
->update_window_end_hook (w
, 0, 0);
13839 /* Adjust Y positions of reused rows. */
13840 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
13841 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
13842 max_y
= it
.last_visible_y
;
13843 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
13846 row
->visible_height
= row
->height
;
13847 if (row
->y
< min_y
)
13848 row
->visible_height
-= min_y
- row
->y
;
13849 if (row
->y
+ row
->height
> max_y
)
13850 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
13851 row
->redraw_fringe_bitmaps_p
= 1;
13854 /* Scroll the current matrix. */
13855 xassert (nrows_scrolled
> 0);
13856 rotate_matrix (w
->current_matrix
,
13858 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
13861 /* Disable rows not reused. */
13862 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
13863 row
->enabled_p
= 0;
13865 /* Point may have moved to a different line, so we cannot assume that
13866 the previous cursor position is valid; locate the correct row. */
13869 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
13870 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
13874 w
->cursor
.y
= row
->y
;
13876 if (row
< bottom_row
)
13878 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
13879 while (glyph
->charpos
< PT
)
13882 w
->cursor
.x
+= glyph
->pixel_width
;
13888 /* Adjust window end. A null value of last_text_row means that
13889 the window end is in reused rows which in turn means that
13890 only its vpos can have changed. */
13893 w
->window_end_bytepos
13894 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
13896 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
13898 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
13903 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
13906 w
->window_end_valid
= Qnil
;
13907 w
->desired_matrix
->no_scrolling_p
= 1;
13910 debug_method_add (w
, "try_window_reusing_current_matrix 2");
13920 /************************************************************************
13921 Window redisplay reusing current matrix when buffer has changed
13922 ************************************************************************/
13924 static struct glyph_row
*find_last_unchanged_at_beg_row
P_ ((struct window
*));
13925 static struct glyph_row
*find_first_unchanged_at_end_row
P_ ((struct window
*,
13927 static struct glyph_row
*
13928 find_last_row_displaying_text
P_ ((struct glyph_matrix
*, struct it
*,
13929 struct glyph_row
*));
13932 /* Return the last row in MATRIX displaying text. If row START is
13933 non-null, start searching with that row. IT gives the dimensions
13934 of the display. Value is null if matrix is empty; otherwise it is
13935 a pointer to the row found. */
13937 static struct glyph_row
*
13938 find_last_row_displaying_text (matrix
, it
, start
)
13939 struct glyph_matrix
*matrix
;
13941 struct glyph_row
*start
;
13943 struct glyph_row
*row
, *row_found
;
13945 /* Set row_found to the last row in IT->w's current matrix
13946 displaying text. The loop looks funny but think of partially
13949 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
13950 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
13952 xassert (row
->enabled_p
);
13954 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
13963 /* Return the last row in the current matrix of W that is not affected
13964 by changes at the start of current_buffer that occurred since W's
13965 current matrix was built. Value is null if no such row exists.
13967 BEG_UNCHANGED us the number of characters unchanged at the start of
13968 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
13969 first changed character in current_buffer. Characters at positions <
13970 BEG + BEG_UNCHANGED are at the same buffer positions as they were
13971 when the current matrix was built. */
13973 static struct glyph_row
*
13974 find_last_unchanged_at_beg_row (w
)
13977 int first_changed_pos
= BEG
+ BEG_UNCHANGED
;
13978 struct glyph_row
*row
;
13979 struct glyph_row
*row_found
= NULL
;
13980 int yb
= window_text_bottom_y (w
);
13982 /* Find the last row displaying unchanged text. */
13983 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
13984 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
13985 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
)
13987 if (/* If row ends before first_changed_pos, it is unchanged,
13988 except in some case. */
13989 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
13990 /* When row ends in ZV and we write at ZV it is not
13992 && !row
->ends_at_zv_p
13993 /* When first_changed_pos is the end of a continued line,
13994 row is not unchanged because it may be no longer
13996 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
13997 && (row
->continued_p
13998 || row
->exact_window_width_line_p
)))
14001 /* Stop if last visible row. */
14002 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
14012 /* Find the first glyph row in the current matrix of W that is not
14013 affected by changes at the end of current_buffer since the
14014 time W's current matrix was built.
14016 Return in *DELTA the number of chars by which buffer positions in
14017 unchanged text at the end of current_buffer must be adjusted.
14019 Return in *DELTA_BYTES the corresponding number of bytes.
14021 Value is null if no such row exists, i.e. all rows are affected by
14024 static struct glyph_row
*
14025 find_first_unchanged_at_end_row (w
, delta
, delta_bytes
)
14027 int *delta
, *delta_bytes
;
14029 struct glyph_row
*row
;
14030 struct glyph_row
*row_found
= NULL
;
14032 *delta
= *delta_bytes
= 0;
14034 /* Display must not have been paused, otherwise the current matrix
14035 is not up to date. */
14036 if (NILP (w
->window_end_valid
))
14039 /* A value of window_end_pos >= END_UNCHANGED means that the window
14040 end is in the range of changed text. If so, there is no
14041 unchanged row at the end of W's current matrix. */
14042 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
14045 /* Set row to the last row in W's current matrix displaying text. */
14046 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
14048 /* If matrix is entirely empty, no unchanged row exists. */
14049 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14051 /* The value of row is the last glyph row in the matrix having a
14052 meaningful buffer position in it. The end position of row
14053 corresponds to window_end_pos. This allows us to translate
14054 buffer positions in the current matrix to current buffer
14055 positions for characters not in changed text. */
14056 int Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
14057 int Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
14058 int last_unchanged_pos
, last_unchanged_pos_old
;
14059 struct glyph_row
*first_text_row
14060 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14062 *delta
= Z
- Z_old
;
14063 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
14065 /* Set last_unchanged_pos to the buffer position of the last
14066 character in the buffer that has not been changed. Z is the
14067 index + 1 of the last character in current_buffer, i.e. by
14068 subtracting END_UNCHANGED we get the index of the last
14069 unchanged character, and we have to add BEG to get its buffer
14071 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
14072 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
14074 /* Search backward from ROW for a row displaying a line that
14075 starts at a minimum position >= last_unchanged_pos_old. */
14076 for (; row
> first_text_row
; --row
)
14078 /* This used to abort, but it can happen.
14079 It is ok to just stop the search instead here. KFS. */
14080 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14083 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
14088 if (row_found
&& !MATRIX_ROW_DISPLAYS_TEXT_P (row_found
))
14095 /* Make sure that glyph rows in the current matrix of window W
14096 reference the same glyph memory as corresponding rows in the
14097 frame's frame matrix. This function is called after scrolling W's
14098 current matrix on a terminal frame in try_window_id and
14099 try_window_reusing_current_matrix. */
14102 sync_frame_with_window_matrix_rows (w
)
14105 struct frame
*f
= XFRAME (w
->frame
);
14106 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
14108 /* Preconditions: W must be a leaf window and full-width. Its frame
14109 must have a frame matrix. */
14110 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
14111 xassert (WINDOW_FULL_WIDTH_P (w
));
14112 xassert (!FRAME_WINDOW_P (f
));
14114 /* If W is a full-width window, glyph pointers in W's current matrix
14115 have, by definition, to be the same as glyph pointers in the
14116 corresponding frame matrix. Note that frame matrices have no
14117 marginal areas (see build_frame_matrix). */
14118 window_row
= w
->current_matrix
->rows
;
14119 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
14120 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
14121 while (window_row
< window_row_end
)
14123 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
14124 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
14126 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
14127 frame_row
->glyphs
[TEXT_AREA
] = start
;
14128 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
14129 frame_row
->glyphs
[LAST_AREA
] = end
;
14131 /* Disable frame rows whose corresponding window rows have
14132 been disabled in try_window_id. */
14133 if (!window_row
->enabled_p
)
14134 frame_row
->enabled_p
= 0;
14136 ++window_row
, ++frame_row
;
14141 /* Find the glyph row in window W containing CHARPOS. Consider all
14142 rows between START and END (not inclusive). END null means search
14143 all rows to the end of the display area of W. Value is the row
14144 containing CHARPOS or null. */
14147 row_containing_pos (w
, charpos
, start
, end
, dy
)
14150 struct glyph_row
*start
, *end
;
14153 struct glyph_row
*row
= start
;
14156 /* If we happen to start on a header-line, skip that. */
14157 if (row
->mode_line_p
)
14160 if ((end
&& row
>= end
) || !row
->enabled_p
)
14163 last_y
= window_text_bottom_y (w
) - dy
;
14167 /* Give up if we have gone too far. */
14168 if (end
&& row
>= end
)
14170 /* This formerly returned if they were equal.
14171 I think that both quantities are of a "last plus one" type;
14172 if so, when they are equal, the row is within the screen. -- rms. */
14173 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
14176 /* If it is in this row, return this row. */
14177 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
14178 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
14179 /* The end position of a row equals the start
14180 position of the next row. If CHARPOS is there, we
14181 would rather display it in the next line, except
14182 when this line ends in ZV. */
14183 && !row
->ends_at_zv_p
14184 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
14185 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
14192 /* Try to redisplay window W by reusing its existing display. W's
14193 current matrix must be up to date when this function is called,
14194 i.e. window_end_valid must not be nil.
14198 1 if display has been updated
14199 0 if otherwise unsuccessful
14200 -1 if redisplay with same window start is known not to succeed
14202 The following steps are performed:
14204 1. Find the last row in the current matrix of W that is not
14205 affected by changes at the start of current_buffer. If no such row
14208 2. Find the first row in W's current matrix that is not affected by
14209 changes at the end of current_buffer. Maybe there is no such row.
14211 3. Display lines beginning with the row + 1 found in step 1 to the
14212 row found in step 2 or, if step 2 didn't find a row, to the end of
14215 4. If cursor is not known to appear on the window, give up.
14217 5. If display stopped at the row found in step 2, scroll the
14218 display and current matrix as needed.
14220 6. Maybe display some lines at the end of W, if we must. This can
14221 happen under various circumstances, like a partially visible line
14222 becoming fully visible, or because newly displayed lines are displayed
14223 in smaller font sizes.
14225 7. Update W's window end information. */
14231 struct frame
*f
= XFRAME (w
->frame
);
14232 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
14233 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
14234 struct glyph_row
*last_unchanged_at_beg_row
;
14235 struct glyph_row
*first_unchanged_at_end_row
;
14236 struct glyph_row
*row
;
14237 struct glyph_row
*bottom_row
;
14240 int delta
= 0, delta_bytes
= 0, stop_pos
, dvpos
, dy
;
14241 struct text_pos start_pos
;
14243 int first_unchanged_at_end_vpos
= 0;
14244 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
14245 struct text_pos start
;
14246 int first_changed_charpos
, last_changed_charpos
;
14249 if (inhibit_try_window_id
)
14253 /* This is handy for debugging. */
14255 #define GIVE_UP(X) \
14257 fprintf (stderr, "try_window_id give up %d\n", (X)); \
14261 #define GIVE_UP(X) return 0
14264 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
14266 /* Don't use this for mini-windows because these can show
14267 messages and mini-buffers, and we don't handle that here. */
14268 if (MINI_WINDOW_P (w
))
14271 /* This flag is used to prevent redisplay optimizations. */
14272 if (windows_or_buffers_changed
|| cursor_type_changed
)
14275 /* Verify that narrowing has not changed.
14276 Also verify that we were not told to prevent redisplay optimizations.
14277 It would be nice to further
14278 reduce the number of cases where this prevents try_window_id. */
14279 if (current_buffer
->clip_changed
14280 || current_buffer
->prevent_redisplay_optimizations_p
)
14283 /* Window must either use window-based redisplay or be full width. */
14284 if (!FRAME_WINDOW_P (f
)
14285 && (!line_ins_del_ok
14286 || !WINDOW_FULL_WIDTH_P (w
)))
14289 /* Give up if point is not known NOT to appear in W. */
14290 if (PT
< CHARPOS (start
))
14293 /* Another way to prevent redisplay optimizations. */
14294 if (XFASTINT (w
->last_modified
) == 0)
14297 /* Verify that window is not hscrolled. */
14298 if (XFASTINT (w
->hscroll
) != 0)
14301 /* Verify that display wasn't paused. */
14302 if (NILP (w
->window_end_valid
))
14305 /* Can't use this if highlighting a region because a cursor movement
14306 will do more than just set the cursor. */
14307 if (!NILP (Vtransient_mark_mode
)
14308 && !NILP (current_buffer
->mark_active
))
14311 /* Likewise if highlighting trailing whitespace. */
14312 if (!NILP (Vshow_trailing_whitespace
))
14315 /* Likewise if showing a region. */
14316 if (!NILP (w
->region_showing
))
14319 /* Can use this if overlay arrow position and or string have changed. */
14320 if (overlay_arrows_changed_p ())
14324 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
14325 only if buffer has really changed. The reason is that the gap is
14326 initially at Z for freshly visited files. The code below would
14327 set end_unchanged to 0 in that case. */
14328 if (MODIFF
> SAVE_MODIFF
14329 /* This seems to happen sometimes after saving a buffer. */
14330 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
14332 if (GPT
- BEG
< BEG_UNCHANGED
)
14333 BEG_UNCHANGED
= GPT
- BEG
;
14334 if (Z
- GPT
< END_UNCHANGED
)
14335 END_UNCHANGED
= Z
- GPT
;
14338 /* The position of the first and last character that has been changed. */
14339 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
14340 last_changed_charpos
= Z
- END_UNCHANGED
;
14342 /* If window starts after a line end, and the last change is in
14343 front of that newline, then changes don't affect the display.
14344 This case happens with stealth-fontification. Note that although
14345 the display is unchanged, glyph positions in the matrix have to
14346 be adjusted, of course. */
14347 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
14348 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
14349 && ((last_changed_charpos
< CHARPOS (start
)
14350 && CHARPOS (start
) == BEGV
)
14351 || (last_changed_charpos
< CHARPOS (start
) - 1
14352 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
14354 int Z_old
, delta
, Z_BYTE_old
, delta_bytes
;
14355 struct glyph_row
*r0
;
14357 /* Compute how many chars/bytes have been added to or removed
14358 from the buffer. */
14359 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
14360 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
14362 delta_bytes
= Z_BYTE
- Z_BYTE_old
;
14364 /* Give up if PT is not in the window. Note that it already has
14365 been checked at the start of try_window_id that PT is not in
14366 front of the window start. */
14367 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + delta
)
14370 /* If window start is unchanged, we can reuse the whole matrix
14371 as is, after adjusting glyph positions. No need to compute
14372 the window end again, since its offset from Z hasn't changed. */
14373 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
14374 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + delta
14375 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + delta_bytes
14376 /* PT must not be in a partially visible line. */
14377 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + delta
14378 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
14380 /* Adjust positions in the glyph matrix. */
14381 if (delta
|| delta_bytes
)
14383 struct glyph_row
*r1
14384 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
14385 increment_matrix_positions (w
->current_matrix
,
14386 MATRIX_ROW_VPOS (r0
, current_matrix
),
14387 MATRIX_ROW_VPOS (r1
, current_matrix
),
14388 delta
, delta_bytes
);
14391 /* Set the cursor. */
14392 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
14394 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
14401 /* Handle the case that changes are all below what is displayed in
14402 the window, and that PT is in the window. This shortcut cannot
14403 be taken if ZV is visible in the window, and text has been added
14404 there that is visible in the window. */
14405 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
14406 /* ZV is not visible in the window, or there are no
14407 changes at ZV, actually. */
14408 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
14409 || first_changed_charpos
== last_changed_charpos
))
14411 struct glyph_row
*r0
;
14413 /* Give up if PT is not in the window. Note that it already has
14414 been checked at the start of try_window_id that PT is not in
14415 front of the window start. */
14416 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
14419 /* If window start is unchanged, we can reuse the whole matrix
14420 as is, without changing glyph positions since no text has
14421 been added/removed in front of the window end. */
14422 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
14423 if (TEXT_POS_EQUAL_P (start
, r0
->start
.pos
)
14424 /* PT must not be in a partially visible line. */
14425 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
14426 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
14428 /* We have to compute the window end anew since text
14429 can have been added/removed after it. */
14431 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
14432 w
->window_end_bytepos
14433 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
14435 /* Set the cursor. */
14436 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
14438 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
14445 /* Give up if window start is in the changed area.
14447 The condition used to read
14449 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
14451 but why that was tested escapes me at the moment. */
14452 if (CHARPOS (start
) >= first_changed_charpos
14453 && CHARPOS (start
) <= last_changed_charpos
)
14456 /* Check that window start agrees with the start of the first glyph
14457 row in its current matrix. Check this after we know the window
14458 start is not in changed text, otherwise positions would not be
14460 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
14461 if (!TEXT_POS_EQUAL_P (start
, row
->start
.pos
))
14464 /* Give up if the window ends in strings. Overlay strings
14465 at the end are difficult to handle, so don't try. */
14466 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
14467 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
14470 /* Compute the position at which we have to start displaying new
14471 lines. Some of the lines at the top of the window might be
14472 reusable because they are not displaying changed text. Find the
14473 last row in W's current matrix not affected by changes at the
14474 start of current_buffer. Value is null if changes start in the
14475 first line of window. */
14476 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
14477 if (last_unchanged_at_beg_row
)
14479 /* Avoid starting to display in the moddle of a character, a TAB
14480 for instance. This is easier than to set up the iterator
14481 exactly, and it's not a frequent case, so the additional
14482 effort wouldn't really pay off. */
14483 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
14484 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
14485 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
14486 --last_unchanged_at_beg_row
;
14488 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
14491 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
14493 start_pos
= it
.current
.pos
;
14495 /* Start displaying new lines in the desired matrix at the same
14496 vpos we would use in the current matrix, i.e. below
14497 last_unchanged_at_beg_row. */
14498 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
14500 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
14501 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
14503 xassert (it
.hpos
== 0 && it
.current_x
== 0);
14507 /* There are no reusable lines at the start of the window.
14508 Start displaying in the first text line. */
14509 start_display (&it
, w
, start
);
14510 it
.vpos
= it
.first_vpos
;
14511 start_pos
= it
.current
.pos
;
14514 /* Find the first row that is not affected by changes at the end of
14515 the buffer. Value will be null if there is no unchanged row, in
14516 which case we must redisplay to the end of the window. delta
14517 will be set to the value by which buffer positions beginning with
14518 first_unchanged_at_end_row have to be adjusted due to text
14520 first_unchanged_at_end_row
14521 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
14522 IF_DEBUG (debug_delta
= delta
);
14523 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
14525 /* Set stop_pos to the buffer position up to which we will have to
14526 display new lines. If first_unchanged_at_end_row != NULL, this
14527 is the buffer position of the start of the line displayed in that
14528 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
14529 that we don't stop at a buffer position. */
14531 if (first_unchanged_at_end_row
)
14533 xassert (last_unchanged_at_beg_row
== NULL
14534 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
14536 /* If this is a continuation line, move forward to the next one
14537 that isn't. Changes in lines above affect this line.
14538 Caution: this may move first_unchanged_at_end_row to a row
14539 not displaying text. */
14540 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
14541 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
14542 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
14543 < it
.last_visible_y
))
14544 ++first_unchanged_at_end_row
;
14546 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
14547 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
14548 >= it
.last_visible_y
))
14549 first_unchanged_at_end_row
= NULL
;
14552 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
14554 first_unchanged_at_end_vpos
14555 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
14556 xassert (stop_pos
>= Z
- END_UNCHANGED
);
14559 else if (last_unchanged_at_beg_row
== NULL
)
14565 /* Either there is no unchanged row at the end, or the one we have
14566 now displays text. This is a necessary condition for the window
14567 end pos calculation at the end of this function. */
14568 xassert (first_unchanged_at_end_row
== NULL
14569 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
14571 debug_last_unchanged_at_beg_vpos
14572 = (last_unchanged_at_beg_row
14573 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
14575 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
14577 #endif /* GLYPH_DEBUG != 0 */
14580 /* Display new lines. Set last_text_row to the last new line
14581 displayed which has text on it, i.e. might end up as being the
14582 line where the window_end_vpos is. */
14583 w
->cursor
.vpos
= -1;
14584 last_text_row
= NULL
;
14585 overlay_arrow_seen
= 0;
14586 while (it
.current_y
< it
.last_visible_y
14587 && !fonts_changed_p
14588 && (first_unchanged_at_end_row
== NULL
14589 || IT_CHARPOS (it
) < stop_pos
))
14591 if (display_line (&it
))
14592 last_text_row
= it
.glyph_row
- 1;
14595 if (fonts_changed_p
)
14599 /* Compute differences in buffer positions, y-positions etc. for
14600 lines reused at the bottom of the window. Compute what we can
14602 if (first_unchanged_at_end_row
14603 /* No lines reused because we displayed everything up to the
14604 bottom of the window. */
14605 && it
.current_y
< it
.last_visible_y
)
14608 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
14610 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
14611 run
.current_y
= first_unchanged_at_end_row
->y
;
14612 run
.desired_y
= run
.current_y
+ dy
;
14613 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
14617 delta
= dvpos
= dy
= run
.current_y
= run
.desired_y
= run
.height
= 0;
14618 first_unchanged_at_end_row
= NULL
;
14620 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
14623 /* Find the cursor if not already found. We have to decide whether
14624 PT will appear on this window (it sometimes doesn't, but this is
14625 not a very frequent case.) This decision has to be made before
14626 the current matrix is altered. A value of cursor.vpos < 0 means
14627 that PT is either in one of the lines beginning at
14628 first_unchanged_at_end_row or below the window. Don't care for
14629 lines that might be displayed later at the window end; as
14630 mentioned, this is not a frequent case. */
14631 if (w
->cursor
.vpos
< 0)
14633 /* Cursor in unchanged rows at the top? */
14634 if (PT
< CHARPOS (start_pos
)
14635 && last_unchanged_at_beg_row
)
14637 row
= row_containing_pos (w
, PT
,
14638 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
14639 last_unchanged_at_beg_row
+ 1, 0);
14641 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14644 /* Start from first_unchanged_at_end_row looking for PT. */
14645 else if (first_unchanged_at_end_row
)
14647 row
= row_containing_pos (w
, PT
- delta
,
14648 first_unchanged_at_end_row
, NULL
, 0);
14650 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
14651 delta_bytes
, dy
, dvpos
);
14654 /* Give up if cursor was not found. */
14655 if (w
->cursor
.vpos
< 0)
14657 clear_glyph_matrix (w
->desired_matrix
);
14662 /* Don't let the cursor end in the scroll margins. */
14664 int this_scroll_margin
, cursor_height
;
14666 this_scroll_margin
= max (0, scroll_margin
);
14667 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14668 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
14669 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
14671 if ((w
->cursor
.y
< this_scroll_margin
14672 && CHARPOS (start
) > BEGV
)
14673 /* Old redisplay didn't take scroll margin into account at the bottom,
14674 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
14675 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
14676 ? cursor_height
+ this_scroll_margin
14677 : 1)) > it
.last_visible_y
)
14679 w
->cursor
.vpos
= -1;
14680 clear_glyph_matrix (w
->desired_matrix
);
14685 /* Scroll the display. Do it before changing the current matrix so
14686 that xterm.c doesn't get confused about where the cursor glyph is
14688 if (dy
&& run
.height
)
14692 if (FRAME_WINDOW_P (f
))
14694 rif
->update_window_begin_hook (w
);
14695 rif
->clear_window_mouse_face (w
);
14696 rif
->scroll_run_hook (w
, &run
);
14697 rif
->update_window_end_hook (w
, 0, 0);
14701 /* Terminal frame. In this case, dvpos gives the number of
14702 lines to scroll by; dvpos < 0 means scroll up. */
14703 int first_unchanged_at_end_vpos
14704 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
14705 int from
= WINDOW_TOP_EDGE_LINE (w
) + first_unchanged_at_end_vpos
;
14706 int end
= (WINDOW_TOP_EDGE_LINE (w
)
14707 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
14708 + window_internal_height (w
));
14710 /* Perform the operation on the screen. */
14713 /* Scroll last_unchanged_at_beg_row to the end of the
14714 window down dvpos lines. */
14715 set_terminal_window (end
);
14717 /* On dumb terminals delete dvpos lines at the end
14718 before inserting dvpos empty lines. */
14719 if (!scroll_region_ok
)
14720 ins_del_lines (end
- dvpos
, -dvpos
);
14722 /* Insert dvpos empty lines in front of
14723 last_unchanged_at_beg_row. */
14724 ins_del_lines (from
, dvpos
);
14726 else if (dvpos
< 0)
14728 /* Scroll up last_unchanged_at_beg_vpos to the end of
14729 the window to last_unchanged_at_beg_vpos - |dvpos|. */
14730 set_terminal_window (end
);
14732 /* Delete dvpos lines in front of
14733 last_unchanged_at_beg_vpos. ins_del_lines will set
14734 the cursor to the given vpos and emit |dvpos| delete
14736 ins_del_lines (from
+ dvpos
, dvpos
);
14738 /* On a dumb terminal insert dvpos empty lines at the
14740 if (!scroll_region_ok
)
14741 ins_del_lines (end
+ dvpos
, -dvpos
);
14744 set_terminal_window (0);
14750 /* Shift reused rows of the current matrix to the right position.
14751 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
14753 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
14754 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
14757 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
14758 bottom_vpos
, dvpos
);
14759 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
14762 else if (dvpos
> 0)
14764 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
14765 bottom_vpos
, dvpos
);
14766 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
14767 first_unchanged_at_end_vpos
+ dvpos
, 0);
14770 /* For frame-based redisplay, make sure that current frame and window
14771 matrix are in sync with respect to glyph memory. */
14772 if (!FRAME_WINDOW_P (f
))
14773 sync_frame_with_window_matrix_rows (w
);
14775 /* Adjust buffer positions in reused rows. */
14777 increment_matrix_positions (current_matrix
,
14778 first_unchanged_at_end_vpos
+ dvpos
,
14779 bottom_vpos
, delta
, delta_bytes
);
14781 /* Adjust Y positions. */
14783 shift_glyph_matrix (w
, current_matrix
,
14784 first_unchanged_at_end_vpos
+ dvpos
,
14787 if (first_unchanged_at_end_row
)
14789 first_unchanged_at_end_row
+= dvpos
;
14790 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
14791 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
14792 first_unchanged_at_end_row
= NULL
;
14795 /* If scrolling up, there may be some lines to display at the end of
14797 last_text_row_at_end
= NULL
;
14800 /* Scrolling up can leave for example a partially visible line
14801 at the end of the window to be redisplayed. */
14802 /* Set last_row to the glyph row in the current matrix where the
14803 window end line is found. It has been moved up or down in
14804 the matrix by dvpos. */
14805 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
14806 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
14808 /* If last_row is the window end line, it should display text. */
14809 xassert (last_row
->displays_text_p
);
14811 /* If window end line was partially visible before, begin
14812 displaying at that line. Otherwise begin displaying with the
14813 line following it. */
14814 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
14816 init_to_row_start (&it
, w
, last_row
);
14817 it
.vpos
= last_vpos
;
14818 it
.current_y
= last_row
->y
;
14822 init_to_row_end (&it
, w
, last_row
);
14823 it
.vpos
= 1 + last_vpos
;
14824 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
14828 /* We may start in a continuation line. If so, we have to
14829 get the right continuation_lines_width and current_x. */
14830 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
14831 it
.hpos
= it
.current_x
= 0;
14833 /* Display the rest of the lines at the window end. */
14834 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
14835 while (it
.current_y
< it
.last_visible_y
14836 && !fonts_changed_p
)
14838 /* Is it always sure that the display agrees with lines in
14839 the current matrix? I don't think so, so we mark rows
14840 displayed invalid in the current matrix by setting their
14841 enabled_p flag to zero. */
14842 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
14843 if (display_line (&it
))
14844 last_text_row_at_end
= it
.glyph_row
- 1;
14848 /* Update window_end_pos and window_end_vpos. */
14849 if (first_unchanged_at_end_row
14850 && !last_text_row_at_end
)
14852 /* Window end line if one of the preserved rows from the current
14853 matrix. Set row to the last row displaying text in current
14854 matrix starting at first_unchanged_at_end_row, after
14856 xassert (first_unchanged_at_end_row
->displays_text_p
);
14857 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
14858 first_unchanged_at_end_row
);
14859 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
14861 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
14862 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
14864 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
14865 xassert (w
->window_end_bytepos
>= 0);
14866 IF_DEBUG (debug_method_add (w
, "A"));
14868 else if (last_text_row_at_end
)
14871 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
14872 w
->window_end_bytepos
14873 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
14875 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
14876 xassert (w
->window_end_bytepos
>= 0);
14877 IF_DEBUG (debug_method_add (w
, "B"));
14879 else if (last_text_row
)
14881 /* We have displayed either to the end of the window or at the
14882 end of the window, i.e. the last row with text is to be found
14883 in the desired matrix. */
14885 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14886 w
->window_end_bytepos
14887 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14889 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
14890 xassert (w
->window_end_bytepos
>= 0);
14892 else if (first_unchanged_at_end_row
== NULL
14893 && last_text_row
== NULL
14894 && last_text_row_at_end
== NULL
)
14896 /* Displayed to end of window, but no line containing text was
14897 displayed. Lines were deleted at the end of the window. */
14898 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
14899 int vpos
= XFASTINT (w
->window_end_vpos
);
14900 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
14901 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
14904 row
== NULL
&& vpos
>= first_vpos
;
14905 --vpos
, --current_row
, --desired_row
)
14907 if (desired_row
->enabled_p
)
14909 if (desired_row
->displays_text_p
)
14912 else if (current_row
->displays_text_p
)
14916 xassert (row
!= NULL
);
14917 w
->window_end_vpos
= make_number (vpos
+ 1);
14918 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
14919 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
14920 xassert (w
->window_end_bytepos
>= 0);
14921 IF_DEBUG (debug_method_add (w
, "C"));
14926 #if 0 /* This leads to problems, for instance when the cursor is
14927 at ZV, and the cursor line displays no text. */
14928 /* Disable rows below what's displayed in the window. This makes
14929 debugging easier. */
14930 enable_glyph_matrix_rows (current_matrix
,
14931 XFASTINT (w
->window_end_vpos
) + 1,
14935 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
14936 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
14938 /* Record that display has not been completed. */
14939 w
->window_end_valid
= Qnil
;
14940 w
->desired_matrix
->no_scrolling_p
= 1;
14948 /***********************************************************************
14949 More debugging support
14950 ***********************************************************************/
14954 void dump_glyph_row
P_ ((struct glyph_row
*, int, int));
14955 void dump_glyph_matrix
P_ ((struct glyph_matrix
*, int));
14956 void dump_glyph
P_ ((struct glyph_row
*, struct glyph
*, int));
14959 /* Dump the contents of glyph matrix MATRIX on stderr.
14961 GLYPHS 0 means don't show glyph contents.
14962 GLYPHS 1 means show glyphs in short form
14963 GLYPHS > 1 means show glyphs in long form. */
14966 dump_glyph_matrix (matrix
, glyphs
)
14967 struct glyph_matrix
*matrix
;
14971 for (i
= 0; i
< matrix
->nrows
; ++i
)
14972 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
14976 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
14977 the glyph row and area where the glyph comes from. */
14980 dump_glyph (row
, glyph
, area
)
14981 struct glyph_row
*row
;
14982 struct glyph
*glyph
;
14985 if (glyph
->type
== CHAR_GLYPH
)
14988 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
14989 glyph
- row
->glyphs
[TEXT_AREA
],
14992 (BUFFERP (glyph
->object
)
14994 : (STRINGP (glyph
->object
)
14997 glyph
->pixel_width
,
14999 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
15003 glyph
->left_box_line_p
,
15004 glyph
->right_box_line_p
);
15006 else if (glyph
->type
== STRETCH_GLYPH
)
15009 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15010 glyph
- row
->glyphs
[TEXT_AREA
],
15013 (BUFFERP (glyph
->object
)
15015 : (STRINGP (glyph
->object
)
15018 glyph
->pixel_width
,
15022 glyph
->left_box_line_p
,
15023 glyph
->right_box_line_p
);
15025 else if (glyph
->type
== IMAGE_GLYPH
)
15028 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15029 glyph
- row
->glyphs
[TEXT_AREA
],
15032 (BUFFERP (glyph
->object
)
15034 : (STRINGP (glyph
->object
)
15037 glyph
->pixel_width
,
15041 glyph
->left_box_line_p
,
15042 glyph
->right_box_line_p
);
15044 else if (glyph
->type
== COMPOSITE_GLYPH
)
15047 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15048 glyph
- row
->glyphs
[TEXT_AREA
],
15051 (BUFFERP (glyph
->object
)
15053 : (STRINGP (glyph
->object
)
15056 glyph
->pixel_width
,
15060 glyph
->left_box_line_p
,
15061 glyph
->right_box_line_p
);
15066 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
15067 GLYPHS 0 means don't show glyph contents.
15068 GLYPHS 1 means show glyphs in short form
15069 GLYPHS > 1 means show glyphs in long form. */
15072 dump_glyph_row (row
, vpos
, glyphs
)
15073 struct glyph_row
*row
;
15078 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
15079 fprintf (stderr
, "======================================================================\n");
15081 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d\
15082 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
15084 MATRIX_ROW_START_CHARPOS (row
),
15085 MATRIX_ROW_END_CHARPOS (row
),
15086 row
->used
[TEXT_AREA
],
15087 row
->contains_overlapping_glyphs_p
,
15089 row
->truncated_on_left_p
,
15090 row
->truncated_on_right_p
,
15092 MATRIX_ROW_CONTINUATION_LINE_P (row
),
15093 row
->displays_text_p
,
15096 row
->ends_in_middle_of_char_p
,
15097 row
->starts_in_middle_of_char_p
,
15103 row
->visible_height
,
15106 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
15107 row
->end
.overlay_string_index
,
15108 row
->continuation_lines_width
);
15109 fprintf (stderr
, "%9d %5d\n",
15110 CHARPOS (row
->start
.string_pos
),
15111 CHARPOS (row
->end
.string_pos
));
15112 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
15113 row
->end
.dpvec_index
);
15120 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
15122 struct glyph
*glyph
= row
->glyphs
[area
];
15123 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
15125 /* Glyph for a line end in text. */
15126 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
15129 if (glyph
< glyph_end
)
15130 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
15132 for (; glyph
< glyph_end
; ++glyph
)
15133 dump_glyph (row
, glyph
, area
);
15136 else if (glyphs
== 1)
15140 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
15142 char *s
= (char *) alloca (row
->used
[area
] + 1);
15145 for (i
= 0; i
< row
->used
[area
]; ++i
)
15147 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
15148 if (glyph
->type
== CHAR_GLYPH
15149 && glyph
->u
.ch
< 0x80
15150 && glyph
->u
.ch
>= ' ')
15151 s
[i
] = glyph
->u
.ch
;
15157 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
15163 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
15164 Sdump_glyph_matrix
, 0, 1, "p",
15165 doc
: /* Dump the current matrix of the selected window to stderr.
15166 Shows contents of glyph row structures. With non-nil
15167 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
15168 glyphs in short form, otherwise show glyphs in long form. */)
15170 Lisp_Object glyphs
;
15172 struct window
*w
= XWINDOW (selected_window
);
15173 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15175 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
15176 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
15177 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
15178 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
15179 fprintf (stderr
, "=============================================\n");
15180 dump_glyph_matrix (w
->current_matrix
,
15181 NILP (glyphs
) ? 0 : XINT (glyphs
));
15186 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
15187 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
15190 struct frame
*f
= XFRAME (selected_frame
);
15191 dump_glyph_matrix (f
->current_matrix
, 1);
15196 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
15197 doc
: /* Dump glyph row ROW to stderr.
15198 GLYPH 0 means don't dump glyphs.
15199 GLYPH 1 means dump glyphs in short form.
15200 GLYPH > 1 or omitted means dump glyphs in long form. */)
15202 Lisp_Object row
, glyphs
;
15204 struct glyph_matrix
*matrix
;
15207 CHECK_NUMBER (row
);
15208 matrix
= XWINDOW (selected_window
)->current_matrix
;
15210 if (vpos
>= 0 && vpos
< matrix
->nrows
)
15211 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
15213 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
15218 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
15219 doc
: /* Dump glyph row ROW of the tool-bar of the current frame 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 frame
*sf
= SELECTED_FRAME ();
15227 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
15230 CHECK_NUMBER (row
);
15232 if (vpos
>= 0 && vpos
< m
->nrows
)
15233 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
15234 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
15239 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
15240 doc
: /* Toggle tracing of redisplay.
15241 With ARG, turn tracing on if and only if ARG is positive. */)
15246 trace_redisplay_p
= !trace_redisplay_p
;
15249 arg
= Fprefix_numeric_value (arg
);
15250 trace_redisplay_p
= XINT (arg
) > 0;
15257 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
15258 doc
: /* Like `format', but print result to stderr.
15259 usage: (trace-to-stderr STRING &rest OBJECTS) */)
15264 Lisp_Object s
= Fformat (nargs
, args
);
15265 fprintf (stderr
, "%s", SDATA (s
));
15269 #endif /* GLYPH_DEBUG */
15273 /***********************************************************************
15274 Building Desired Matrix Rows
15275 ***********************************************************************/
15277 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
15278 Used for non-window-redisplay windows, and for windows w/o left fringe. */
15280 static struct glyph_row
*
15281 get_overlay_arrow_glyph_row (w
, overlay_arrow_string
)
15283 Lisp_Object overlay_arrow_string
;
15285 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
15286 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15287 struct buffer
*old
= current_buffer
;
15288 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
15289 int arrow_len
= SCHARS (overlay_arrow_string
);
15290 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
15291 const unsigned char *p
;
15294 int n_glyphs_before
;
15296 set_buffer_temp (buffer
);
15297 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
15298 it
.glyph_row
->used
[TEXT_AREA
] = 0;
15299 SET_TEXT_POS (it
.position
, 0, 0);
15301 multibyte_p
= !NILP (buffer
->enable_multibyte_characters
);
15303 while (p
< arrow_end
)
15305 Lisp_Object face
, ilisp
;
15307 /* Get the next character. */
15309 it
.c
= string_char_and_length (p
, arrow_len
, &it
.len
);
15311 it
.c
= *p
, it
.len
= 1;
15314 /* Get its face. */
15315 ilisp
= make_number (p
- arrow_string
);
15316 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
15317 it
.face_id
= compute_char_face (f
, it
.c
, face
);
15319 /* Compute its width, get its glyphs. */
15320 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
15321 SET_TEXT_POS (it
.position
, -1, -1);
15322 PRODUCE_GLYPHS (&it
);
15324 /* If this character doesn't fit any more in the line, we have
15325 to remove some glyphs. */
15326 if (it
.current_x
> it
.last_visible_x
)
15328 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
15333 set_buffer_temp (old
);
15334 return it
.glyph_row
;
15338 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
15339 glyphs are only inserted for terminal frames since we can't really
15340 win with truncation glyphs when partially visible glyphs are
15341 involved. Which glyphs to insert is determined by
15342 produce_special_glyphs. */
15345 insert_left_trunc_glyphs (it
)
15348 struct it truncate_it
;
15349 struct glyph
*from
, *end
, *to
, *toend
;
15351 xassert (!FRAME_WINDOW_P (it
->f
));
15353 /* Get the truncation glyphs. */
15355 truncate_it
.current_x
= 0;
15356 truncate_it
.face_id
= DEFAULT_FACE_ID
;
15357 truncate_it
.glyph_row
= &scratch_glyph_row
;
15358 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
15359 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
15360 truncate_it
.object
= make_number (0);
15361 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
15363 /* Overwrite glyphs from IT with truncation glyphs. */
15364 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
15365 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
15366 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
15367 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
15372 /* There may be padding glyphs left over. Overwrite them too. */
15373 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
15375 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
15381 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
15385 /* Compute the pixel height and width of IT->glyph_row.
15387 Most of the time, ascent and height of a display line will be equal
15388 to the max_ascent and max_height values of the display iterator
15389 structure. This is not the case if
15391 1. We hit ZV without displaying anything. In this case, max_ascent
15392 and max_height will be zero.
15394 2. We have some glyphs that don't contribute to the line height.
15395 (The glyph row flag contributes_to_line_height_p is for future
15396 pixmap extensions).
15398 The first case is easily covered by using default values because in
15399 these cases, the line height does not really matter, except that it
15400 must not be zero. */
15403 compute_line_metrics (it
)
15406 struct glyph_row
*row
= it
->glyph_row
;
15409 if (FRAME_WINDOW_P (it
->f
))
15411 int i
, min_y
, max_y
;
15413 /* The line may consist of one space only, that was added to
15414 place the cursor on it. If so, the row's height hasn't been
15416 if (row
->height
== 0)
15418 if (it
->max_ascent
+ it
->max_descent
== 0)
15419 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
15420 row
->ascent
= it
->max_ascent
;
15421 row
->height
= it
->max_ascent
+ it
->max_descent
;
15422 row
->phys_ascent
= it
->max_phys_ascent
;
15423 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
15424 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
15427 /* Compute the width of this line. */
15428 row
->pixel_width
= row
->x
;
15429 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
15430 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
15432 xassert (row
->pixel_width
>= 0);
15433 xassert (row
->ascent
>= 0 && row
->height
> 0);
15435 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
15436 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
15438 /* If first line's physical ascent is larger than its logical
15439 ascent, use the physical ascent, and make the row taller.
15440 This makes accented characters fully visible. */
15441 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
15442 && row
->phys_ascent
> row
->ascent
)
15444 row
->height
+= row
->phys_ascent
- row
->ascent
;
15445 row
->ascent
= row
->phys_ascent
;
15448 /* Compute how much of the line is visible. */
15449 row
->visible_height
= row
->height
;
15451 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
15452 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
15454 if (row
->y
< min_y
)
15455 row
->visible_height
-= min_y
- row
->y
;
15456 if (row
->y
+ row
->height
> max_y
)
15457 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
15461 row
->pixel_width
= row
->used
[TEXT_AREA
];
15462 if (row
->continued_p
)
15463 row
->pixel_width
-= it
->continuation_pixel_width
;
15464 else if (row
->truncated_on_right_p
)
15465 row
->pixel_width
-= it
->truncation_pixel_width
;
15466 row
->ascent
= row
->phys_ascent
= 0;
15467 row
->height
= row
->phys_height
= row
->visible_height
= 1;
15468 row
->extra_line_spacing
= 0;
15471 /* Compute a hash code for this row. */
15473 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
15474 for (i
= 0; i
< row
->used
[area
]; ++i
)
15475 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
15476 + row
->glyphs
[area
][i
].u
.val
15477 + row
->glyphs
[area
][i
].face_id
15478 + row
->glyphs
[area
][i
].padding_p
15479 + (row
->glyphs
[area
][i
].type
<< 2));
15481 it
->max_ascent
= it
->max_descent
= 0;
15482 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
15486 /* Append one space to the glyph row of iterator IT if doing a
15487 window-based redisplay. The space has the same face as
15488 IT->face_id. Value is non-zero if a space was added.
15490 This function is called to make sure that there is always one glyph
15491 at the end of a glyph row that the cursor can be set on under
15492 window-systems. (If there weren't such a glyph we would not know
15493 how wide and tall a box cursor should be displayed).
15495 At the same time this space let's a nicely handle clearing to the
15496 end of the line if the row ends in italic text. */
15499 append_space_for_newline (it
, default_face_p
)
15501 int default_face_p
;
15503 if (FRAME_WINDOW_P (it
->f
))
15505 int n
= it
->glyph_row
->used
[TEXT_AREA
];
15507 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
15508 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
15510 /* Save some values that must not be changed.
15511 Must save IT->c and IT->len because otherwise
15512 ITERATOR_AT_END_P wouldn't work anymore after
15513 append_space_for_newline has been called. */
15514 enum display_element_type saved_what
= it
->what
;
15515 int saved_c
= it
->c
, saved_len
= it
->len
;
15516 int saved_x
= it
->current_x
;
15517 int saved_face_id
= it
->face_id
;
15518 struct text_pos saved_pos
;
15519 Lisp_Object saved_object
;
15522 saved_object
= it
->object
;
15523 saved_pos
= it
->position
;
15525 it
->what
= IT_CHARACTER
;
15526 bzero (&it
->position
, sizeof it
->position
);
15527 it
->object
= make_number (0);
15531 if (default_face_p
)
15532 it
->face_id
= DEFAULT_FACE_ID
;
15533 else if (it
->face_before_selective_p
)
15534 it
->face_id
= it
->saved_face_id
;
15535 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
15536 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0);
15538 PRODUCE_GLYPHS (it
);
15540 it
->override_ascent
= -1;
15541 it
->constrain_row_ascent_descent_p
= 0;
15542 it
->current_x
= saved_x
;
15543 it
->object
= saved_object
;
15544 it
->position
= saved_pos
;
15545 it
->what
= saved_what
;
15546 it
->face_id
= saved_face_id
;
15547 it
->len
= saved_len
;
15557 /* Extend the face of the last glyph in the text area of IT->glyph_row
15558 to the end of the display line. Called from display_line.
15559 If the glyph row is empty, add a space glyph to it so that we
15560 know the face to draw. Set the glyph row flag fill_line_p. */
15563 extend_face_to_end_of_line (it
)
15567 struct frame
*f
= it
->f
;
15569 /* If line is already filled, do nothing. */
15570 if (it
->current_x
>= it
->last_visible_x
)
15573 /* Face extension extends the background and box of IT->face_id
15574 to the end of the line. If the background equals the background
15575 of the frame, we don't have to do anything. */
15576 if (it
->face_before_selective_p
)
15577 face
= FACE_FROM_ID (it
->f
, it
->saved_face_id
);
15579 face
= FACE_FROM_ID (f
, it
->face_id
);
15581 if (FRAME_WINDOW_P (f
)
15582 && it
->glyph_row
->displays_text_p
15583 && face
->box
== FACE_NO_BOX
15584 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
15588 /* Set the glyph row flag indicating that the face of the last glyph
15589 in the text area has to be drawn to the end of the text area. */
15590 it
->glyph_row
->fill_line_p
= 1;
15592 /* If current character of IT is not ASCII, make sure we have the
15593 ASCII face. This will be automatically undone the next time
15594 get_next_display_element returns a multibyte character. Note
15595 that the character will always be single byte in unibyte text. */
15596 if (!SINGLE_BYTE_CHAR_P (it
->c
))
15598 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0);
15601 if (FRAME_WINDOW_P (f
))
15603 /* If the row is empty, add a space with the current face of IT,
15604 so that we know which face to draw. */
15605 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
15607 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
15608 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
15609 it
->glyph_row
->used
[TEXT_AREA
] = 1;
15614 /* Save some values that must not be changed. */
15615 int saved_x
= it
->current_x
;
15616 struct text_pos saved_pos
;
15617 Lisp_Object saved_object
;
15618 enum display_element_type saved_what
= it
->what
;
15619 int saved_face_id
= it
->face_id
;
15621 saved_object
= it
->object
;
15622 saved_pos
= it
->position
;
15624 it
->what
= IT_CHARACTER
;
15625 bzero (&it
->position
, sizeof it
->position
);
15626 it
->object
= make_number (0);
15629 it
->face_id
= face
->id
;
15631 PRODUCE_GLYPHS (it
);
15633 while (it
->current_x
<= it
->last_visible_x
)
15634 PRODUCE_GLYPHS (it
);
15636 /* Don't count these blanks really. It would let us insert a left
15637 truncation glyph below and make us set the cursor on them, maybe. */
15638 it
->current_x
= saved_x
;
15639 it
->object
= saved_object
;
15640 it
->position
= saved_pos
;
15641 it
->what
= saved_what
;
15642 it
->face_id
= saved_face_id
;
15647 /* Value is non-zero if text starting at CHARPOS in current_buffer is
15648 trailing whitespace. */
15651 trailing_whitespace_p (charpos
)
15654 int bytepos
= CHAR_TO_BYTE (charpos
);
15657 while (bytepos
< ZV_BYTE
15658 && (c
= FETCH_CHAR (bytepos
),
15659 c
== ' ' || c
== '\t'))
15662 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
15664 if (bytepos
!= PT_BYTE
)
15671 /* Highlight trailing whitespace, if any, in ROW. */
15674 highlight_trailing_whitespace (f
, row
)
15676 struct glyph_row
*row
;
15678 int used
= row
->used
[TEXT_AREA
];
15682 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
15683 struct glyph
*glyph
= start
+ used
- 1;
15685 /* Skip over glyphs inserted to display the cursor at the
15686 end of a line, for extending the face of the last glyph
15687 to the end of the line on terminals, and for truncation
15688 and continuation glyphs. */
15689 while (glyph
>= start
15690 && glyph
->type
== CHAR_GLYPH
15691 && INTEGERP (glyph
->object
))
15694 /* If last glyph is a space or stretch, and it's trailing
15695 whitespace, set the face of all trailing whitespace glyphs in
15696 IT->glyph_row to `trailing-whitespace'. */
15698 && BUFFERP (glyph
->object
)
15699 && (glyph
->type
== STRETCH_GLYPH
15700 || (glyph
->type
== CHAR_GLYPH
15701 && glyph
->u
.ch
== ' '))
15702 && trailing_whitespace_p (glyph
->charpos
))
15704 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0, 0);
15708 while (glyph
>= start
15709 && BUFFERP (glyph
->object
)
15710 && (glyph
->type
== STRETCH_GLYPH
15711 || (glyph
->type
== CHAR_GLYPH
15712 && glyph
->u
.ch
== ' ')))
15713 (glyph
--)->face_id
= face_id
;
15719 /* Value is non-zero if glyph row ROW in window W should be
15720 used to hold the cursor. */
15723 cursor_row_p (w
, row
)
15725 struct glyph_row
*row
;
15727 int cursor_row_p
= 1;
15729 if (PT
== MATRIX_ROW_END_CHARPOS (row
))
15731 /* If the row ends with a newline from a string, we don't want
15732 the cursor there, but we still want it at the start of the
15733 string if the string starts in this row.
15734 If the row is continued it doesn't end in a newline. */
15735 if (CHARPOS (row
->end
.string_pos
) >= 0)
15736 cursor_row_p
= (row
->continued_p
15737 || PT
>= MATRIX_ROW_START_CHARPOS (row
));
15738 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15740 /* If the row ends in middle of a real character,
15741 and the line is continued, we want the cursor here.
15742 That's because MATRIX_ROW_END_CHARPOS would equal
15743 PT if PT is before the character. */
15744 if (!row
->ends_in_ellipsis_p
)
15745 cursor_row_p
= row
->continued_p
;
15747 /* If the row ends in an ellipsis, then
15748 MATRIX_ROW_END_CHARPOS will equal point after the invisible text.
15749 We want that position to be displayed after the ellipsis. */
15752 /* If the row ends at ZV, display the cursor at the end of that
15753 row instead of at the start of the row below. */
15754 else if (row
->ends_at_zv_p
)
15760 return cursor_row_p
;
15764 /* Construct the glyph row IT->glyph_row in the desired matrix of
15765 IT->w from text at the current position of IT. See dispextern.h
15766 for an overview of struct it. Value is non-zero if
15767 IT->glyph_row displays text, as opposed to a line displaying ZV
15774 struct glyph_row
*row
= it
->glyph_row
;
15775 Lisp_Object overlay_arrow_string
;
15777 /* We always start displaying at hpos zero even if hscrolled. */
15778 xassert (it
->hpos
== 0 && it
->current_x
== 0);
15780 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
15781 >= it
->w
->desired_matrix
->nrows
)
15783 it
->w
->nrows_scale_factor
++;
15784 fonts_changed_p
= 1;
15788 /* Is IT->w showing the region? */
15789 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
15791 /* Clear the result glyph row and enable it. */
15792 prepare_desired_row (row
);
15794 row
->y
= it
->current_y
;
15795 row
->start
= it
->start
;
15796 row
->continuation_lines_width
= it
->continuation_lines_width
;
15797 row
->displays_text_p
= 1;
15798 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
15799 it
->starts_in_middle_of_char_p
= 0;
15801 /* Arrange the overlays nicely for our purposes. Usually, we call
15802 display_line on only one line at a time, in which case this
15803 can't really hurt too much, or we call it on lines which appear
15804 one after another in the buffer, in which case all calls to
15805 recenter_overlay_lists but the first will be pretty cheap. */
15806 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
15808 /* Move over display elements that are not visible because we are
15809 hscrolled. This may stop at an x-position < IT->first_visible_x
15810 if the first glyph is partially visible or if we hit a line end. */
15811 if (it
->current_x
< it
->first_visible_x
)
15813 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
15814 MOVE_TO_POS
| MOVE_TO_X
);
15817 /* Get the initial row height. This is either the height of the
15818 text hscrolled, if there is any, or zero. */
15819 row
->ascent
= it
->max_ascent
;
15820 row
->height
= it
->max_ascent
+ it
->max_descent
;
15821 row
->phys_ascent
= it
->max_phys_ascent
;
15822 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
15823 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
15825 /* Loop generating characters. The loop is left with IT on the next
15826 character to display. */
15829 int n_glyphs_before
, hpos_before
, x_before
;
15831 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
15833 /* Retrieve the next thing to display. Value is zero if end of
15835 if (!get_next_display_element (it
))
15837 /* Maybe add a space at the end of this line that is used to
15838 display the cursor there under X. Set the charpos of the
15839 first glyph of blank lines not corresponding to any text
15841 #ifdef HAVE_WINDOW_SYSTEM
15842 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
15843 row
->exact_window_width_line_p
= 1;
15845 #endif /* HAVE_WINDOW_SYSTEM */
15846 if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
15847 || row
->used
[TEXT_AREA
] == 0)
15849 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
15850 row
->displays_text_p
= 0;
15852 if (!NILP (XBUFFER (it
->w
->buffer
)->indicate_empty_lines
)
15853 && (!MINI_WINDOW_P (it
->w
)
15854 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
15855 row
->indicate_empty_line_p
= 1;
15858 it
->continuation_lines_width
= 0;
15859 row
->ends_at_zv_p
= 1;
15863 /* Now, get the metrics of what we want to display. This also
15864 generates glyphs in `row' (which is IT->glyph_row). */
15865 n_glyphs_before
= row
->used
[TEXT_AREA
];
15868 /* Remember the line height so far in case the next element doesn't
15869 fit on the line. */
15870 if (!it
->truncate_lines_p
)
15872 ascent
= it
->max_ascent
;
15873 descent
= it
->max_descent
;
15874 phys_ascent
= it
->max_phys_ascent
;
15875 phys_descent
= it
->max_phys_descent
;
15878 PRODUCE_GLYPHS (it
);
15880 /* If this display element was in marginal areas, continue with
15882 if (it
->area
!= TEXT_AREA
)
15884 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
15885 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
15886 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
15887 row
->phys_height
= max (row
->phys_height
,
15888 it
->max_phys_ascent
+ it
->max_phys_descent
);
15889 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
15890 it
->max_extra_line_spacing
);
15891 set_iterator_to_next (it
, 1);
15895 /* Does the display element fit on the line? If we truncate
15896 lines, we should draw past the right edge of the window. If
15897 we don't truncate, we want to stop so that we can display the
15898 continuation glyph before the right margin. If lines are
15899 continued, there are two possible strategies for characters
15900 resulting in more than 1 glyph (e.g. tabs): Display as many
15901 glyphs as possible in this line and leave the rest for the
15902 continuation line, or display the whole element in the next
15903 line. Original redisplay did the former, so we do it also. */
15904 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
15905 hpos_before
= it
->hpos
;
15908 if (/* Not a newline. */
15910 /* Glyphs produced fit entirely in the line. */
15911 && it
->current_x
< it
->last_visible_x
)
15913 it
->hpos
+= nglyphs
;
15914 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
15915 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
15916 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
15917 row
->phys_height
= max (row
->phys_height
,
15918 it
->max_phys_ascent
+ it
->max_phys_descent
);
15919 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
15920 it
->max_extra_line_spacing
);
15921 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
15922 row
->x
= x
- it
->first_visible_x
;
15927 struct glyph
*glyph
;
15929 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
15931 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
15932 new_x
= x
+ glyph
->pixel_width
;
15934 if (/* Lines are continued. */
15935 !it
->truncate_lines_p
15936 && (/* Glyph doesn't fit on the line. */
15937 new_x
> it
->last_visible_x
15938 /* Or it fits exactly on a window system frame. */
15939 || (new_x
== it
->last_visible_x
15940 && FRAME_WINDOW_P (it
->f
))))
15942 /* End of a continued line. */
15945 || (new_x
== it
->last_visible_x
15946 && FRAME_WINDOW_P (it
->f
)))
15948 /* Current glyph is the only one on the line or
15949 fits exactly on the line. We must continue
15950 the line because we can't draw the cursor
15951 after the glyph. */
15952 row
->continued_p
= 1;
15953 it
->current_x
= new_x
;
15954 it
->continuation_lines_width
+= new_x
;
15956 if (i
== nglyphs
- 1)
15958 set_iterator_to_next (it
, 1);
15959 #ifdef HAVE_WINDOW_SYSTEM
15960 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
15962 if (!get_next_display_element (it
))
15964 row
->exact_window_width_line_p
= 1;
15965 it
->continuation_lines_width
= 0;
15966 row
->continued_p
= 0;
15967 row
->ends_at_zv_p
= 1;
15969 else if (ITERATOR_AT_END_OF_LINE_P (it
))
15971 row
->continued_p
= 0;
15972 row
->exact_window_width_line_p
= 1;
15975 #endif /* HAVE_WINDOW_SYSTEM */
15978 else if (CHAR_GLYPH_PADDING_P (*glyph
)
15979 && !FRAME_WINDOW_P (it
->f
))
15981 /* A padding glyph that doesn't fit on this line.
15982 This means the whole character doesn't fit
15984 row
->used
[TEXT_AREA
] = n_glyphs_before
;
15986 /* Fill the rest of the row with continuation
15987 glyphs like in 20.x. */
15988 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
15989 < row
->glyphs
[1 + TEXT_AREA
])
15990 produce_special_glyphs (it
, IT_CONTINUATION
);
15992 row
->continued_p
= 1;
15993 it
->current_x
= x_before
;
15994 it
->continuation_lines_width
+= x_before
;
15996 /* Restore the height to what it was before the
15997 element not fitting on the line. */
15998 it
->max_ascent
= ascent
;
15999 it
->max_descent
= descent
;
16000 it
->max_phys_ascent
= phys_ascent
;
16001 it
->max_phys_descent
= phys_descent
;
16003 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
16005 /* A TAB that extends past the right edge of the
16006 window. This produces a single glyph on
16007 window system frames. We leave the glyph in
16008 this row and let it fill the row, but don't
16009 consume the TAB. */
16010 it
->continuation_lines_width
+= it
->last_visible_x
;
16011 row
->ends_in_middle_of_char_p
= 1;
16012 row
->continued_p
= 1;
16013 glyph
->pixel_width
= it
->last_visible_x
- x
;
16014 it
->starts_in_middle_of_char_p
= 1;
16018 /* Something other than a TAB that draws past
16019 the right edge of the window. Restore
16020 positions to values before the element. */
16021 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
16023 /* Display continuation glyphs. */
16024 if (!FRAME_WINDOW_P (it
->f
))
16025 produce_special_glyphs (it
, IT_CONTINUATION
);
16026 row
->continued_p
= 1;
16028 it
->current_x
= x_before
;
16029 it
->continuation_lines_width
+= x
;
16030 extend_face_to_end_of_line (it
);
16032 if (nglyphs
> 1 && i
> 0)
16034 row
->ends_in_middle_of_char_p
= 1;
16035 it
->starts_in_middle_of_char_p
= 1;
16038 /* Restore the height to what it was before the
16039 element not fitting on the line. */
16040 it
->max_ascent
= ascent
;
16041 it
->max_descent
= descent
;
16042 it
->max_phys_ascent
= phys_ascent
;
16043 it
->max_phys_descent
= phys_descent
;
16048 else if (new_x
> it
->first_visible_x
)
16050 /* Increment number of glyphs actually displayed. */
16053 if (x
< it
->first_visible_x
)
16054 /* Glyph is partially visible, i.e. row starts at
16055 negative X position. */
16056 row
->x
= x
- it
->first_visible_x
;
16060 /* Glyph is completely off the left margin of the
16061 window. This should not happen because of the
16062 move_it_in_display_line at the start of this
16063 function, unless the text display area of the
16064 window is empty. */
16065 xassert (it
->first_visible_x
<= it
->last_visible_x
);
16069 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
16070 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
16071 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
16072 row
->phys_height
= max (row
->phys_height
,
16073 it
->max_phys_ascent
+ it
->max_phys_descent
);
16074 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
16075 it
->max_extra_line_spacing
);
16077 /* End of this display line if row is continued. */
16078 if (row
->continued_p
|| row
->ends_at_zv_p
)
16083 /* Is this a line end? If yes, we're also done, after making
16084 sure that a non-default face is extended up to the right
16085 margin of the window. */
16086 if (ITERATOR_AT_END_OF_LINE_P (it
))
16088 int used_before
= row
->used
[TEXT_AREA
];
16090 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
16092 #ifdef HAVE_WINDOW_SYSTEM
16093 /* Add a space at the end of the line that is used to
16094 display the cursor there. */
16095 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16096 append_space_for_newline (it
, 0);
16097 #endif /* HAVE_WINDOW_SYSTEM */
16099 /* Extend the face to the end of the line. */
16100 extend_face_to_end_of_line (it
);
16102 /* Make sure we have the position. */
16103 if (used_before
== 0)
16104 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
16106 /* Consume the line end. This skips over invisible lines. */
16107 set_iterator_to_next (it
, 1);
16108 it
->continuation_lines_width
= 0;
16112 /* Proceed with next display element. Note that this skips
16113 over lines invisible because of selective display. */
16114 set_iterator_to_next (it
, 1);
16116 /* If we truncate lines, we are done when the last displayed
16117 glyphs reach past the right margin of the window. */
16118 if (it
->truncate_lines_p
16119 && (FRAME_WINDOW_P (it
->f
)
16120 ? (it
->current_x
>= it
->last_visible_x
)
16121 : (it
->current_x
> it
->last_visible_x
)))
16123 /* Maybe add truncation glyphs. */
16124 if (!FRAME_WINDOW_P (it
->f
))
16128 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
16129 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
16132 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
16134 row
->used
[TEXT_AREA
] = i
;
16135 produce_special_glyphs (it
, IT_TRUNCATION
);
16138 #ifdef HAVE_WINDOW_SYSTEM
16141 /* Don't truncate if we can overflow newline into fringe. */
16142 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16144 if (!get_next_display_element (it
))
16146 it
->continuation_lines_width
= 0;
16147 row
->ends_at_zv_p
= 1;
16148 row
->exact_window_width_line_p
= 1;
16151 if (ITERATOR_AT_END_OF_LINE_P (it
))
16153 row
->exact_window_width_line_p
= 1;
16154 goto at_end_of_line
;
16158 #endif /* HAVE_WINDOW_SYSTEM */
16160 row
->truncated_on_right_p
= 1;
16161 it
->continuation_lines_width
= 0;
16162 reseat_at_next_visible_line_start (it
, 0);
16163 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
16164 it
->hpos
= hpos_before
;
16165 it
->current_x
= x_before
;
16170 /* If line is not empty and hscrolled, maybe insert truncation glyphs
16171 at the left window margin. */
16172 if (it
->first_visible_x
16173 && IT_CHARPOS (*it
) != MATRIX_ROW_START_CHARPOS (row
))
16175 if (!FRAME_WINDOW_P (it
->f
))
16176 insert_left_trunc_glyphs (it
);
16177 row
->truncated_on_left_p
= 1;
16180 /* If the start of this line is the overlay arrow-position, then
16181 mark this glyph row as the one containing the overlay arrow.
16182 This is clearly a mess with variable size fonts. It would be
16183 better to let it be displayed like cursors under X. */
16184 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
16185 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
16186 !NILP (overlay_arrow_string
)))
16188 /* Overlay arrow in window redisplay is a fringe bitmap. */
16189 if (STRINGP (overlay_arrow_string
))
16191 struct glyph_row
*arrow_row
16192 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
16193 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
16194 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
16195 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
16196 struct glyph
*p2
, *end
;
16198 /* Copy the arrow glyphs. */
16199 while (glyph
< arrow_end
)
16202 /* Throw away padding glyphs. */
16204 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16205 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
16211 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
16216 xassert (INTEGERP (overlay_arrow_string
));
16217 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
16219 overlay_arrow_seen
= 1;
16222 /* Compute pixel dimensions of this line. */
16223 compute_line_metrics (it
);
16225 /* Remember the position at which this line ends. */
16226 row
->end
= it
->current
;
16228 /* Record whether this row ends inside an ellipsis. */
16229 row
->ends_in_ellipsis_p
16230 = (it
->method
== GET_FROM_DISPLAY_VECTOR
16231 && it
->ellipsis_p
);
16233 /* Save fringe bitmaps in this row. */
16234 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
16235 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
16236 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
16237 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
16239 it
->left_user_fringe_bitmap
= 0;
16240 it
->left_user_fringe_face_id
= 0;
16241 it
->right_user_fringe_bitmap
= 0;
16242 it
->right_user_fringe_face_id
= 0;
16244 /* Maybe set the cursor. */
16245 if (it
->w
->cursor
.vpos
< 0
16246 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
16247 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
16248 && cursor_row_p (it
->w
, row
))
16249 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
16251 /* Highlight trailing whitespace. */
16252 if (!NILP (Vshow_trailing_whitespace
))
16253 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
16255 /* Prepare for the next line. This line starts horizontally at (X
16256 HPOS) = (0 0). Vertical positions are incremented. As a
16257 convenience for the caller, IT->glyph_row is set to the next
16259 it
->current_x
= it
->hpos
= 0;
16260 it
->current_y
+= row
->height
;
16263 it
->start
= it
->current
;
16264 return row
->displays_text_p
;
16269 /***********************************************************************
16271 ***********************************************************************/
16273 /* Redisplay the menu bar in the frame for window W.
16275 The menu bar of X frames that don't have X toolkit support is
16276 displayed in a special window W->frame->menu_bar_window.
16278 The menu bar of terminal frames is treated specially as far as
16279 glyph matrices are concerned. Menu bar lines are not part of
16280 windows, so the update is done directly on the frame matrix rows
16281 for the menu bar. */
16284 display_menu_bar (w
)
16287 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
16292 /* Don't do all this for graphical frames. */
16294 if (!NILP (Vwindow_system
))
16297 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
16302 if (FRAME_MAC_P (f
))
16306 #ifdef USE_X_TOOLKIT
16307 xassert (!FRAME_WINDOW_P (f
));
16308 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
16309 it
.first_visible_x
= 0;
16310 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
16311 #else /* not USE_X_TOOLKIT */
16312 if (FRAME_WINDOW_P (f
))
16314 /* Menu bar lines are displayed in the desired matrix of the
16315 dummy window menu_bar_window. */
16316 struct window
*menu_w
;
16317 xassert (WINDOWP (f
->menu_bar_window
));
16318 menu_w
= XWINDOW (f
->menu_bar_window
);
16319 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
16321 it
.first_visible_x
= 0;
16322 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
16326 /* This is a TTY frame, i.e. character hpos/vpos are used as
16328 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
16330 it
.first_visible_x
= 0;
16331 it
.last_visible_x
= FRAME_COLS (f
);
16333 #endif /* not USE_X_TOOLKIT */
16335 if (! mode_line_inverse_video
)
16336 /* Force the menu-bar to be displayed in the default face. */
16337 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
16339 /* Clear all rows of the menu bar. */
16340 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
16342 struct glyph_row
*row
= it
.glyph_row
+ i
;
16343 clear_glyph_row (row
);
16344 row
->enabled_p
= 1;
16345 row
->full_width_p
= 1;
16348 /* Display all items of the menu bar. */
16349 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
16350 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
16352 Lisp_Object string
;
16354 /* Stop at nil string. */
16355 string
= AREF (items
, i
+ 1);
16359 /* Remember where item was displayed. */
16360 AREF (items
, i
+ 3) = make_number (it
.hpos
);
16362 /* Display the item, pad with one space. */
16363 if (it
.current_x
< it
.last_visible_x
)
16364 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
16365 SCHARS (string
) + 1, 0, 0, -1);
16368 /* Fill out the line with spaces. */
16369 if (it
.current_x
< it
.last_visible_x
)
16370 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
16372 /* Compute the total height of the lines. */
16373 compute_line_metrics (&it
);
16378 /***********************************************************************
16380 ***********************************************************************/
16382 /* Redisplay mode lines in the window tree whose root is WINDOW. If
16383 FORCE is non-zero, redisplay mode lines unconditionally.
16384 Otherwise, redisplay only mode lines that are garbaged. Value is
16385 the number of windows whose mode lines were redisplayed. */
16388 redisplay_mode_lines (window
, force
)
16389 Lisp_Object window
;
16394 while (!NILP (window
))
16396 struct window
*w
= XWINDOW (window
);
16398 if (WINDOWP (w
->hchild
))
16399 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
16400 else if (WINDOWP (w
->vchild
))
16401 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
16403 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
16404 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
16406 struct text_pos lpoint
;
16407 struct buffer
*old
= current_buffer
;
16409 /* Set the window's buffer for the mode line display. */
16410 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16411 set_buffer_internal_1 (XBUFFER (w
->buffer
));
16413 /* Point refers normally to the selected window. For any
16414 other window, set up appropriate value. */
16415 if (!EQ (window
, selected_window
))
16417 struct text_pos pt
;
16419 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
16420 if (CHARPOS (pt
) < BEGV
)
16421 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
16422 else if (CHARPOS (pt
) > (ZV
- 1))
16423 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
16425 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
16428 /* Display mode lines. */
16429 clear_glyph_matrix (w
->desired_matrix
);
16430 if (display_mode_lines (w
))
16433 w
->must_be_updated_p
= 1;
16436 /* Restore old settings. */
16437 set_buffer_internal_1 (old
);
16438 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
16448 /* Display the mode and/or top line of window W. Value is the number
16449 of mode lines displayed. */
16452 display_mode_lines (w
)
16455 Lisp_Object old_selected_window
, old_selected_frame
;
16458 old_selected_frame
= selected_frame
;
16459 selected_frame
= w
->frame
;
16460 old_selected_window
= selected_window
;
16461 XSETWINDOW (selected_window
, w
);
16463 /* These will be set while the mode line specs are processed. */
16464 line_number_displayed
= 0;
16465 w
->column_number_displayed
= Qnil
;
16467 if (WINDOW_WANTS_MODELINE_P (w
))
16469 struct window
*sel_w
= XWINDOW (old_selected_window
);
16471 /* Select mode line face based on the real selected window. */
16472 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
16473 current_buffer
->mode_line_format
);
16477 if (WINDOW_WANTS_HEADER_LINE_P (w
))
16479 display_mode_line (w
, HEADER_LINE_FACE_ID
,
16480 current_buffer
->header_line_format
);
16484 selected_frame
= old_selected_frame
;
16485 selected_window
= old_selected_window
;
16490 /* Display mode or top line of window W. FACE_ID specifies which line
16491 to display; it is either MODE_LINE_FACE_ID or HEADER_LINE_FACE_ID.
16492 FORMAT is the mode line format to display. Value is the pixel
16493 height of the mode line displayed. */
16496 display_mode_line (w
, face_id
, format
)
16498 enum face_id face_id
;
16499 Lisp_Object format
;
16503 int count
= SPECPDL_INDEX ();
16505 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
16506 prepare_desired_row (it
.glyph_row
);
16508 it
.glyph_row
->mode_line_p
= 1;
16510 if (! mode_line_inverse_video
)
16511 /* Force the mode-line to be displayed in the default face. */
16512 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
16514 record_unwind_protect (unwind_format_mode_line
,
16515 format_mode_line_unwind_data (NULL
, 0));
16517 mode_line_target
= MODE_LINE_DISPLAY
;
16519 /* Temporarily make frame's keyboard the current kboard so that
16520 kboard-local variables in the mode_line_format will get the right
16522 push_frame_kboard (it
.f
);
16523 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
16524 pop_frame_kboard ();
16526 unbind_to (count
, Qnil
);
16528 /* Fill up with spaces. */
16529 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
16531 compute_line_metrics (&it
);
16532 it
.glyph_row
->full_width_p
= 1;
16533 it
.glyph_row
->continued_p
= 0;
16534 it
.glyph_row
->truncated_on_left_p
= 0;
16535 it
.glyph_row
->truncated_on_right_p
= 0;
16537 /* Make a 3D mode-line have a shadow at its right end. */
16538 face
= FACE_FROM_ID (it
.f
, face_id
);
16539 extend_face_to_end_of_line (&it
);
16540 if (face
->box
!= FACE_NO_BOX
)
16542 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
16543 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
16544 last
->right_box_line_p
= 1;
16547 return it
.glyph_row
->height
;
16550 /* Move element ELT in LIST to the front of LIST.
16551 Return the updated list. */
16554 move_elt_to_front (elt
, list
)
16555 Lisp_Object elt
, list
;
16557 register Lisp_Object tail
, prev
;
16558 register Lisp_Object tem
;
16562 while (CONSP (tail
))
16568 /* Splice out the link TAIL. */
16570 list
= XCDR (tail
);
16572 Fsetcdr (prev
, XCDR (tail
));
16574 /* Now make it the first. */
16575 Fsetcdr (tail
, list
);
16580 tail
= XCDR (tail
);
16584 /* Not found--return unchanged LIST. */
16588 /* Contribute ELT to the mode line for window IT->w. How it
16589 translates into text depends on its data type.
16591 IT describes the display environment in which we display, as usual.
16593 DEPTH is the depth in recursion. It is used to prevent
16594 infinite recursion here.
16596 FIELD_WIDTH is the number of characters the display of ELT should
16597 occupy in the mode line, and PRECISION is the maximum number of
16598 characters to display from ELT's representation. See
16599 display_string for details.
16601 Returns the hpos of the end of the text generated by ELT.
16603 PROPS is a property list to add to any string we encounter.
16605 If RISKY is nonzero, remove (disregard) any properties in any string
16606 we encounter, and ignore :eval and :propertize.
16608 The global variable `mode_line_target' determines whether the
16609 output is passed to `store_mode_line_noprop',
16610 `store_mode_line_string', or `display_string'. */
16613 display_mode_element (it
, depth
, field_width
, precision
, elt
, props
, risky
)
16616 int field_width
, precision
;
16617 Lisp_Object elt
, props
;
16620 int n
= 0, field
, prec
;
16625 elt
= build_string ("*too-deep*");
16629 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
16633 /* A string: output it and check for %-constructs within it. */
16637 if (SCHARS (elt
) > 0
16638 && (!NILP (props
) || risky
))
16640 Lisp_Object oprops
, aelt
;
16641 oprops
= Ftext_properties_at (make_number (0), elt
);
16643 /* If the starting string's properties are not what
16644 we want, translate the string. Also, if the string
16645 is risky, do that anyway. */
16647 if (NILP (Fequal (props
, oprops
)) || risky
)
16649 /* If the starting string has properties,
16650 merge the specified ones onto the existing ones. */
16651 if (! NILP (oprops
) && !risky
)
16655 oprops
= Fcopy_sequence (oprops
);
16657 while (CONSP (tem
))
16659 oprops
= Fplist_put (oprops
, XCAR (tem
),
16660 XCAR (XCDR (tem
)));
16661 tem
= XCDR (XCDR (tem
));
16666 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
16667 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
16669 /* AELT is what we want. Move it to the front
16670 without consing. */
16672 mode_line_proptrans_alist
16673 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
16679 /* If AELT has the wrong props, it is useless.
16680 so get rid of it. */
16682 mode_line_proptrans_alist
16683 = Fdelq (aelt
, mode_line_proptrans_alist
);
16685 elt
= Fcopy_sequence (elt
);
16686 Fset_text_properties (make_number (0), Flength (elt
),
16688 /* Add this item to mode_line_proptrans_alist. */
16689 mode_line_proptrans_alist
16690 = Fcons (Fcons (elt
, props
),
16691 mode_line_proptrans_alist
);
16692 /* Truncate mode_line_proptrans_alist
16693 to at most 50 elements. */
16694 tem
= Fnthcdr (make_number (50),
16695 mode_line_proptrans_alist
);
16697 XSETCDR (tem
, Qnil
);
16706 prec
= precision
- n
;
16707 switch (mode_line_target
)
16709 case MODE_LINE_NOPROP
:
16710 case MODE_LINE_TITLE
:
16711 n
+= store_mode_line_noprop (SDATA (elt
), -1, prec
);
16713 case MODE_LINE_STRING
:
16714 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
16716 case MODE_LINE_DISPLAY
:
16717 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
16718 0, prec
, 0, STRING_MULTIBYTE (elt
));
16725 /* Handle the non-literal case. */
16727 while ((precision
<= 0 || n
< precision
)
16728 && SREF (elt
, offset
) != 0
16729 && (mode_line_target
!= MODE_LINE_DISPLAY
16730 || it
->current_x
< it
->last_visible_x
))
16732 int last_offset
= offset
;
16734 /* Advance to end of string or next format specifier. */
16735 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
16738 if (offset
- 1 != last_offset
)
16740 int nchars
, nbytes
;
16742 /* Output to end of string or up to '%'. Field width
16743 is length of string. Don't output more than
16744 PRECISION allows us. */
16747 prec
= c_string_width (SDATA (elt
) + last_offset
,
16748 offset
- last_offset
, precision
- n
,
16751 switch (mode_line_target
)
16753 case MODE_LINE_NOPROP
:
16754 case MODE_LINE_TITLE
:
16755 n
+= store_mode_line_noprop (SDATA (elt
) + last_offset
, 0, prec
);
16757 case MODE_LINE_STRING
:
16759 int bytepos
= last_offset
;
16760 int charpos
= string_byte_to_char (elt
, bytepos
);
16761 int endpos
= (precision
<= 0
16762 ? string_byte_to_char (elt
, offset
)
16763 : charpos
+ nchars
);
16765 n
+= store_mode_line_string (NULL
,
16766 Fsubstring (elt
, make_number (charpos
),
16767 make_number (endpos
)),
16771 case MODE_LINE_DISPLAY
:
16773 int bytepos
= last_offset
;
16774 int charpos
= string_byte_to_char (elt
, bytepos
);
16776 if (precision
<= 0)
16777 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
16778 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
16780 STRING_MULTIBYTE (elt
));
16785 else /* c == '%' */
16787 int percent_position
= offset
;
16789 /* Get the specified minimum width. Zero means
16792 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
16793 field
= field
* 10 + c
- '0';
16795 /* Don't pad beyond the total padding allowed. */
16796 if (field_width
- n
> 0 && field
> field_width
- n
)
16797 field
= field_width
- n
;
16799 /* Note that either PRECISION <= 0 or N < PRECISION. */
16800 prec
= precision
- n
;
16803 n
+= display_mode_element (it
, depth
, field
, prec
,
16804 Vglobal_mode_string
, props
,
16809 int bytepos
, charpos
;
16810 unsigned char *spec
;
16812 bytepos
= percent_position
;
16813 charpos
= (STRING_MULTIBYTE (elt
)
16814 ? string_byte_to_char (elt
, bytepos
)
16818 = decode_mode_spec (it
->w
, c
, field
, prec
, &multibyte
);
16820 switch (mode_line_target
)
16822 case MODE_LINE_NOPROP
:
16823 case MODE_LINE_TITLE
:
16824 n
+= store_mode_line_noprop (spec
, field
, prec
);
16826 case MODE_LINE_STRING
:
16828 int len
= strlen (spec
);
16829 Lisp_Object tem
= make_string (spec
, len
);
16830 props
= Ftext_properties_at (make_number (charpos
), elt
);
16831 /* Should only keep face property in props */
16832 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
16835 case MODE_LINE_DISPLAY
:
16837 int nglyphs_before
, nwritten
;
16839 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
16840 nwritten
= display_string (spec
, Qnil
, elt
,
16845 /* Assign to the glyphs written above the
16846 string where the `%x' came from, position
16850 struct glyph
*glyph
16851 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
16855 for (i
= 0; i
< nwritten
; ++i
)
16857 glyph
[i
].object
= elt
;
16858 glyph
[i
].charpos
= charpos
;
16875 /* A symbol: process the value of the symbol recursively
16876 as if it appeared here directly. Avoid error if symbol void.
16877 Special case: if value of symbol is a string, output the string
16880 register Lisp_Object tem
;
16882 /* If the variable is not marked as risky to set
16883 then its contents are risky to use. */
16884 if (NILP (Fget (elt
, Qrisky_local_variable
)))
16887 tem
= Fboundp (elt
);
16890 tem
= Fsymbol_value (elt
);
16891 /* If value is a string, output that string literally:
16892 don't check for % within it. */
16896 if (!EQ (tem
, elt
))
16898 /* Give up right away for nil or t. */
16908 register Lisp_Object car
, tem
;
16910 /* A cons cell: five distinct cases.
16911 If first element is :eval or :propertize, do something special.
16912 If first element is a string or a cons, process all the elements
16913 and effectively concatenate them.
16914 If first element is a negative number, truncate displaying cdr to
16915 at most that many characters. If positive, pad (with spaces)
16916 to at least that many characters.
16917 If first element is a symbol, process the cadr or caddr recursively
16918 according to whether the symbol's value is non-nil or nil. */
16920 if (EQ (car
, QCeval
))
16922 /* An element of the form (:eval FORM) means evaluate FORM
16923 and use the result as mode line elements. */
16928 if (CONSP (XCDR (elt
)))
16931 spec
= safe_eval (XCAR (XCDR (elt
)));
16932 n
+= display_mode_element (it
, depth
, field_width
- n
,
16933 precision
- n
, spec
, props
,
16937 else if (EQ (car
, QCpropertize
))
16939 /* An element of the form (:propertize ELT PROPS...)
16940 means display ELT but applying properties PROPS. */
16945 if (CONSP (XCDR (elt
)))
16946 n
+= display_mode_element (it
, depth
, field_width
- n
,
16947 precision
- n
, XCAR (XCDR (elt
)),
16948 XCDR (XCDR (elt
)), risky
);
16950 else if (SYMBOLP (car
))
16952 tem
= Fboundp (car
);
16956 /* elt is now the cdr, and we know it is a cons cell.
16957 Use its car if CAR has a non-nil value. */
16960 tem
= Fsymbol_value (car
);
16967 /* Symbol's value is nil (or symbol is unbound)
16968 Get the cddr of the original list
16969 and if possible find the caddr and use that. */
16973 else if (!CONSP (elt
))
16978 else if (INTEGERP (car
))
16980 register int lim
= XINT (car
);
16984 /* Negative int means reduce maximum width. */
16985 if (precision
<= 0)
16988 precision
= min (precision
, -lim
);
16992 /* Padding specified. Don't let it be more than
16993 current maximum. */
16995 lim
= min (precision
, lim
);
16997 /* If that's more padding than already wanted, queue it.
16998 But don't reduce padding already specified even if
16999 that is beyond the current truncation point. */
17000 field_width
= max (lim
, field_width
);
17004 else if (STRINGP (car
) || CONSP (car
))
17006 register int limit
= 50;
17007 /* Limit is to protect against circular lists. */
17010 && (precision
<= 0 || n
< precision
))
17012 n
+= display_mode_element (it
, depth
,
17013 /* Do padding only after the last
17014 element in the list. */
17015 (! CONSP (XCDR (elt
))
17018 precision
- n
, XCAR (elt
),
17028 elt
= build_string ("*invalid*");
17032 /* Pad to FIELD_WIDTH. */
17033 if (field_width
> 0 && n
< field_width
)
17035 switch (mode_line_target
)
17037 case MODE_LINE_NOPROP
:
17038 case MODE_LINE_TITLE
:
17039 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
17041 case MODE_LINE_STRING
:
17042 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
17044 case MODE_LINE_DISPLAY
:
17045 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
17054 /* Store a mode-line string element in mode_line_string_list.
17056 If STRING is non-null, display that C string. Otherwise, the Lisp
17057 string LISP_STRING is displayed.
17059 FIELD_WIDTH is the minimum number of output glyphs to produce.
17060 If STRING has fewer characters than FIELD_WIDTH, pad to the right
17061 with spaces. FIELD_WIDTH <= 0 means don't pad.
17063 PRECISION is the maximum number of characters to output from
17064 STRING. PRECISION <= 0 means don't truncate the string.
17066 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
17067 properties to the string.
17069 PROPS are the properties to add to the string.
17070 The mode_line_string_face face property is always added to the string.
17074 store_mode_line_string (string
, lisp_string
, copy_string
, field_width
, precision
, props
)
17076 Lisp_Object lisp_string
;
17085 if (string
!= NULL
)
17087 len
= strlen (string
);
17088 if (precision
> 0 && len
> precision
)
17090 lisp_string
= make_string (string
, len
);
17092 props
= mode_line_string_face_prop
;
17093 else if (!NILP (mode_line_string_face
))
17095 Lisp_Object face
= Fplist_get (props
, Qface
);
17096 props
= Fcopy_sequence (props
);
17098 face
= mode_line_string_face
;
17100 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
17101 props
= Fplist_put (props
, Qface
, face
);
17103 Fadd_text_properties (make_number (0), make_number (len
),
17104 props
, lisp_string
);
17108 len
= XFASTINT (Flength (lisp_string
));
17109 if (precision
> 0 && len
> precision
)
17112 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
17115 if (!NILP (mode_line_string_face
))
17119 props
= Ftext_properties_at (make_number (0), lisp_string
);
17120 face
= Fplist_get (props
, Qface
);
17122 face
= mode_line_string_face
;
17124 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
17125 props
= Fcons (Qface
, Fcons (face
, Qnil
));
17127 lisp_string
= Fcopy_sequence (lisp_string
);
17130 Fadd_text_properties (make_number (0), make_number (len
),
17131 props
, lisp_string
);
17136 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
17140 if (field_width
> len
)
17142 field_width
-= len
;
17143 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
17145 Fadd_text_properties (make_number (0), make_number (field_width
),
17146 props
, lisp_string
);
17147 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
17155 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
17157 doc
: /* Format a string out of a mode line format specification.
17158 First arg FORMAT specifies the mode line format (see `mode-line-format'
17159 for details) to use.
17161 Optional second arg FACE specifies the face property to put
17162 on all characters for which no face is specified.
17163 t means whatever face the window's mode line currently uses
17164 \(either `mode-line' or `mode-line-inactive', depending).
17165 nil means the default is no face property.
17166 If FACE is an integer, the value string has no text properties.
17168 Optional third and fourth args WINDOW and BUFFER specify the window
17169 and buffer to use as the context for the formatting (defaults
17170 are the selected window and the window's buffer). */)
17171 (format
, face
, window
, buffer
)
17172 Lisp_Object format
, face
, window
, buffer
;
17177 struct buffer
*old_buffer
= NULL
;
17179 int no_props
= INTEGERP (face
);
17180 int count
= SPECPDL_INDEX ();
17182 int string_start
= 0;
17185 window
= selected_window
;
17186 CHECK_WINDOW (window
);
17187 w
= XWINDOW (window
);
17190 buffer
= w
->buffer
;
17191 CHECK_BUFFER (buffer
);
17194 return build_string ("");
17202 face
= (EQ (window
, selected_window
) ? Qmode_line
: Qmode_line_inactive
);
17203 face_id
= lookup_named_face (XFRAME (WINDOW_FRAME (w
)), face
, 0, 0);
17207 face_id
= DEFAULT_FACE_ID
;
17209 if (XBUFFER (buffer
) != current_buffer
)
17210 old_buffer
= current_buffer
;
17212 /* Save things including mode_line_proptrans_alist,
17213 and set that to nil so that we don't alter the outer value. */
17214 record_unwind_protect (unwind_format_mode_line
,
17215 format_mode_line_unwind_data (old_buffer
, 1));
17216 mode_line_proptrans_alist
= Qnil
;
17219 set_buffer_internal_1 (XBUFFER (buffer
));
17221 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
17225 mode_line_target
= MODE_LINE_NOPROP
;
17226 mode_line_string_face_prop
= Qnil
;
17227 mode_line_string_list
= Qnil
;
17228 string_start
= MODE_LINE_NOPROP_LEN (0);
17232 mode_line_target
= MODE_LINE_STRING
;
17233 mode_line_string_list
= Qnil
;
17234 mode_line_string_face
= face
;
17235 mode_line_string_face_prop
17236 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
17239 push_frame_kboard (it
.f
);
17240 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
17241 pop_frame_kboard ();
17245 len
= MODE_LINE_NOPROP_LEN (string_start
);
17246 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
17250 mode_line_string_list
= Fnreverse (mode_line_string_list
);
17251 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
17252 make_string ("", 0));
17255 unbind_to (count
, Qnil
);
17259 /* Write a null-terminated, right justified decimal representation of
17260 the positive integer D to BUF using a minimal field width WIDTH. */
17263 pint2str (buf
, width
, d
)
17264 register char *buf
;
17265 register int width
;
17268 register char *p
= buf
;
17276 *p
++ = d
% 10 + '0';
17281 for (width
-= (int) (p
- buf
); width
> 0; --width
)
17292 /* Write a null-terminated, right justified decimal and "human
17293 readable" representation of the nonnegative integer D to BUF using
17294 a minimal field width WIDTH. D should be smaller than 999.5e24. */
17296 static const char power_letter
[] =
17310 pint2hrstr (buf
, width
, d
)
17315 /* We aim to represent the nonnegative integer D as
17316 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
17319 /* -1 means: do not use TENTHS. */
17323 /* Length of QUOTIENT.TENTHS as a string. */
17329 if (1000 <= quotient
)
17331 /* Scale to the appropriate EXPONENT. */
17334 remainder
= quotient
% 1000;
17338 while (1000 <= quotient
);
17340 /* Round to nearest and decide whether to use TENTHS or not. */
17343 tenths
= remainder
/ 100;
17344 if (50 <= remainder
% 100)
17351 if (quotient
== 10)
17359 if (500 <= remainder
)
17361 if (quotient
< 999)
17372 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
17373 if (tenths
== -1 && quotient
<= 99)
17380 p
= psuffix
= buf
+ max (width
, length
);
17382 /* Print EXPONENT. */
17384 *psuffix
++ = power_letter
[exponent
];
17387 /* Print TENTHS. */
17390 *--p
= '0' + tenths
;
17394 /* Print QUOTIENT. */
17397 int digit
= quotient
% 10;
17398 *--p
= '0' + digit
;
17400 while ((quotient
/= 10) != 0);
17402 /* Print leading spaces. */
17407 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
17408 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
17409 type of CODING_SYSTEM. Return updated pointer into BUF. */
17411 static unsigned char invalid_eol_type
[] = "(*invalid*)";
17414 decode_mode_spec_coding (coding_system
, buf
, eol_flag
)
17415 Lisp_Object coding_system
;
17416 register char *buf
;
17420 int multibyte
= !NILP (current_buffer
->enable_multibyte_characters
);
17421 const unsigned char *eol_str
;
17423 /* The EOL conversion we are using. */
17424 Lisp_Object eoltype
;
17426 val
= Fget (coding_system
, Qcoding_system
);
17429 if (!VECTORP (val
)) /* Not yet decided. */
17434 eoltype
= eol_mnemonic_undecided
;
17435 /* Don't mention EOL conversion if it isn't decided. */
17439 Lisp_Object eolvalue
;
17441 eolvalue
= Fget (coding_system
, Qeol_type
);
17444 *buf
++ = XFASTINT (AREF (val
, 1));
17448 /* The EOL conversion that is normal on this system. */
17450 if (NILP (eolvalue
)) /* Not yet decided. */
17451 eoltype
= eol_mnemonic_undecided
;
17452 else if (VECTORP (eolvalue
)) /* Not yet decided. */
17453 eoltype
= eol_mnemonic_undecided
;
17454 else /* INTEGERP (eolvalue) -- 0:LF, 1:CRLF, 2:CR */
17455 eoltype
= (XFASTINT (eolvalue
) == 0
17456 ? eol_mnemonic_unix
17457 : (XFASTINT (eolvalue
) == 1
17458 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
17464 /* Mention the EOL conversion if it is not the usual one. */
17465 if (STRINGP (eoltype
))
17467 eol_str
= SDATA (eoltype
);
17468 eol_str_len
= SBYTES (eoltype
);
17470 else if (INTEGERP (eoltype
)
17471 && CHAR_VALID_P (XINT (eoltype
), 0))
17473 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
17474 eol_str_len
= CHAR_STRING (XINT (eoltype
), tmp
);
17479 eol_str
= invalid_eol_type
;
17480 eol_str_len
= sizeof (invalid_eol_type
) - 1;
17482 bcopy (eol_str
, buf
, eol_str_len
);
17483 buf
+= eol_str_len
;
17489 /* Return a string for the output of a mode line %-spec for window W,
17490 generated by character C. PRECISION >= 0 means don't return a
17491 string longer than that value. FIELD_WIDTH > 0 means pad the
17492 string returned with spaces to that value. Return 1 in *MULTIBYTE
17493 if the result is multibyte text.
17495 Note we operate on the current buffer for most purposes,
17496 the exception being w->base_line_pos. */
17498 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
17501 decode_mode_spec (w
, c
, field_width
, precision
, multibyte
)
17504 int field_width
, precision
;
17508 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
17509 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
17510 struct buffer
*b
= current_buffer
;
17518 if (!NILP (b
->read_only
))
17520 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
17525 /* This differs from %* only for a modified read-only buffer. */
17526 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
17528 if (!NILP (b
->read_only
))
17533 /* This differs from %* in ignoring read-only-ness. */
17534 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
17546 if (command_loop_level
> 5)
17548 p
= decode_mode_spec_buf
;
17549 for (i
= 0; i
< command_loop_level
; i
++)
17552 return decode_mode_spec_buf
;
17560 if (command_loop_level
> 5)
17562 p
= decode_mode_spec_buf
;
17563 for (i
= 0; i
< command_loop_level
; i
++)
17566 return decode_mode_spec_buf
;
17573 /* Let lots_of_dashes be a string of infinite length. */
17574 if (mode_line_target
== MODE_LINE_NOPROP
||
17575 mode_line_target
== MODE_LINE_STRING
)
17577 if (field_width
<= 0
17578 || field_width
> sizeof (lots_of_dashes
))
17580 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
17581 decode_mode_spec_buf
[i
] = '-';
17582 decode_mode_spec_buf
[i
] = '\0';
17583 return decode_mode_spec_buf
;
17586 return lots_of_dashes
;
17595 int col
= (int) current_column (); /* iftc */
17596 w
->column_number_displayed
= make_number (col
);
17597 pint2str (decode_mode_spec_buf
, field_width
, col
);
17598 return decode_mode_spec_buf
;
17602 #ifndef SYSTEM_MALLOC
17604 if (NILP (Vmemory_full
))
17607 return "!MEM FULL! ";
17614 /* %F displays the frame name. */
17615 if (!NILP (f
->title
))
17616 return (char *) SDATA (f
->title
);
17617 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
17618 return (char *) SDATA (f
->name
);
17627 int size
= ZV
- BEGV
;
17628 pint2str (decode_mode_spec_buf
, field_width
, size
);
17629 return decode_mode_spec_buf
;
17634 int size
= ZV
- BEGV
;
17635 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
17636 return decode_mode_spec_buf
;
17641 int startpos
= XMARKER (w
->start
)->charpos
;
17642 int startpos_byte
= marker_byte_position (w
->start
);
17643 int line
, linepos
, linepos_byte
, topline
;
17645 int height
= WINDOW_TOTAL_LINES (w
);
17647 /* If we decided that this buffer isn't suitable for line numbers,
17648 don't forget that too fast. */
17649 if (EQ (w
->base_line_pos
, w
->buffer
))
17651 /* But do forget it, if the window shows a different buffer now. */
17652 else if (BUFFERP (w
->base_line_pos
))
17653 w
->base_line_pos
= Qnil
;
17655 /* If the buffer is very big, don't waste time. */
17656 if (INTEGERP (Vline_number_display_limit
)
17657 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
17659 w
->base_line_pos
= Qnil
;
17660 w
->base_line_number
= Qnil
;
17664 if (!NILP (w
->base_line_number
)
17665 && !NILP (w
->base_line_pos
)
17666 && XFASTINT (w
->base_line_pos
) <= startpos
)
17668 line
= XFASTINT (w
->base_line_number
);
17669 linepos
= XFASTINT (w
->base_line_pos
);
17670 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
17675 linepos
= BUF_BEGV (b
);
17676 linepos_byte
= BUF_BEGV_BYTE (b
);
17679 /* Count lines from base line to window start position. */
17680 nlines
= display_count_lines (linepos
, linepos_byte
,
17684 topline
= nlines
+ line
;
17686 /* Determine a new base line, if the old one is too close
17687 or too far away, or if we did not have one.
17688 "Too close" means it's plausible a scroll-down would
17689 go back past it. */
17690 if (startpos
== BUF_BEGV (b
))
17692 w
->base_line_number
= make_number (topline
);
17693 w
->base_line_pos
= make_number (BUF_BEGV (b
));
17695 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
17696 || linepos
== BUF_BEGV (b
))
17698 int limit
= BUF_BEGV (b
);
17699 int limit_byte
= BUF_BEGV_BYTE (b
);
17701 int distance
= (height
* 2 + 30) * line_number_display_limit_width
;
17703 if (startpos
- distance
> limit
)
17705 limit
= startpos
- distance
;
17706 limit_byte
= CHAR_TO_BYTE (limit
);
17709 nlines
= display_count_lines (startpos
, startpos_byte
,
17711 - (height
* 2 + 30),
17713 /* If we couldn't find the lines we wanted within
17714 line_number_display_limit_width chars per line,
17715 give up on line numbers for this window. */
17716 if (position
== limit_byte
&& limit
== startpos
- distance
)
17718 w
->base_line_pos
= w
->buffer
;
17719 w
->base_line_number
= Qnil
;
17723 w
->base_line_number
= make_number (topline
- nlines
);
17724 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
17727 /* Now count lines from the start pos to point. */
17728 nlines
= display_count_lines (startpos
, startpos_byte
,
17729 PT_BYTE
, PT
, &junk
);
17731 /* Record that we did display the line number. */
17732 line_number_displayed
= 1;
17734 /* Make the string to show. */
17735 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
17736 return decode_mode_spec_buf
;
17739 char* p
= decode_mode_spec_buf
;
17740 int pad
= field_width
- 2;
17746 return decode_mode_spec_buf
;
17752 obj
= b
->mode_name
;
17756 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
17762 int pos
= marker_position (w
->start
);
17763 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
17765 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
17767 if (pos
<= BUF_BEGV (b
))
17772 else if (pos
<= BUF_BEGV (b
))
17776 if (total
> 1000000)
17777 /* Do it differently for a large value, to avoid overflow. */
17778 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
17780 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
17781 /* We can't normally display a 3-digit number,
17782 so get us a 2-digit number that is close. */
17785 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
17786 return decode_mode_spec_buf
;
17790 /* Display percentage of size above the bottom of the screen. */
17793 int toppos
= marker_position (w
->start
);
17794 int botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
17795 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
17797 if (botpos
>= BUF_ZV (b
))
17799 if (toppos
<= BUF_BEGV (b
))
17806 if (total
> 1000000)
17807 /* Do it differently for a large value, to avoid overflow. */
17808 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
17810 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
17811 /* We can't normally display a 3-digit number,
17812 so get us a 2-digit number that is close. */
17815 if (toppos
<= BUF_BEGV (b
))
17816 sprintf (decode_mode_spec_buf
, "Top%2d%%", total
);
17818 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
17819 return decode_mode_spec_buf
;
17824 /* status of process */
17825 obj
= Fget_buffer_process (Fcurrent_buffer ());
17827 return "no process";
17828 #ifdef subprocesses
17829 obj
= Fsymbol_name (Fprocess_status (obj
));
17833 case 't': /* indicate TEXT or BINARY */
17834 #ifdef MODE_LINE_BINARY_TEXT
17835 return MODE_LINE_BINARY_TEXT (b
);
17841 /* coding-system (not including end-of-line format) */
17843 /* coding-system (including end-of-line type) */
17845 int eol_flag
= (c
== 'Z');
17846 char *p
= decode_mode_spec_buf
;
17848 if (! FRAME_WINDOW_P (f
))
17850 /* No need to mention EOL here--the terminal never needs
17851 to do EOL conversion. */
17852 p
= decode_mode_spec_coding (keyboard_coding
.symbol
, p
, 0);
17853 p
= decode_mode_spec_coding (terminal_coding
.symbol
, p
, 0);
17855 p
= decode_mode_spec_coding (b
->buffer_file_coding_system
,
17858 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
17859 #ifdef subprocesses
17860 obj
= Fget_buffer_process (Fcurrent_buffer ());
17861 if (PROCESSP (obj
))
17863 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
17865 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
17868 #endif /* subprocesses */
17871 return decode_mode_spec_buf
;
17877 *multibyte
= STRING_MULTIBYTE (obj
);
17878 return (char *) SDATA (obj
);
17885 /* Count up to COUNT lines starting from START / START_BYTE.
17886 But don't go beyond LIMIT_BYTE.
17887 Return the number of lines thus found (always nonnegative).
17889 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
17892 display_count_lines (start
, start_byte
, limit_byte
, count
, byte_pos_ptr
)
17893 int start
, start_byte
, limit_byte
, count
;
17896 register unsigned char *cursor
;
17897 unsigned char *base
;
17899 register int ceiling
;
17900 register unsigned char *ceiling_addr
;
17901 int orig_count
= count
;
17903 /* If we are not in selective display mode,
17904 check only for newlines. */
17905 int selective_display
= (!NILP (current_buffer
->selective_display
)
17906 && !INTEGERP (current_buffer
->selective_display
));
17910 while (start_byte
< limit_byte
)
17912 ceiling
= BUFFER_CEILING_OF (start_byte
);
17913 ceiling
= min (limit_byte
- 1, ceiling
);
17914 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
17915 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
17918 if (selective_display
)
17919 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
17922 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
17925 if (cursor
!= ceiling_addr
)
17929 start_byte
+= cursor
- base
+ 1;
17930 *byte_pos_ptr
= start_byte
;
17934 if (++cursor
== ceiling_addr
)
17940 start_byte
+= cursor
- base
;
17945 while (start_byte
> limit_byte
)
17947 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
17948 ceiling
= max (limit_byte
, ceiling
);
17949 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
17950 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
17953 if (selective_display
)
17954 while (--cursor
!= ceiling_addr
17955 && *cursor
!= '\n' && *cursor
!= 015)
17958 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
17961 if (cursor
!= ceiling_addr
)
17965 start_byte
+= cursor
- base
+ 1;
17966 *byte_pos_ptr
= start_byte
;
17967 /* When scanning backwards, we should
17968 not count the newline posterior to which we stop. */
17969 return - orig_count
- 1;
17975 /* Here we add 1 to compensate for the last decrement
17976 of CURSOR, which took it past the valid range. */
17977 start_byte
+= cursor
- base
+ 1;
17981 *byte_pos_ptr
= limit_byte
;
17984 return - orig_count
+ count
;
17985 return orig_count
- count
;
17991 /***********************************************************************
17993 ***********************************************************************/
17995 /* Display a NUL-terminated string, starting with index START.
17997 If STRING is non-null, display that C string. Otherwise, the Lisp
17998 string LISP_STRING is displayed.
18000 If FACE_STRING is not nil, FACE_STRING_POS is a position in
18001 FACE_STRING. Display STRING or LISP_STRING with the face at
18002 FACE_STRING_POS in FACE_STRING:
18004 Display the string in the environment given by IT, but use the
18005 standard display table, temporarily.
18007 FIELD_WIDTH is the minimum number of output glyphs to produce.
18008 If STRING has fewer characters than FIELD_WIDTH, pad to the right
18009 with spaces. If STRING has more characters, more than FIELD_WIDTH
18010 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
18012 PRECISION is the maximum number of characters to output from
18013 STRING. PRECISION < 0 means don't truncate the string.
18015 This is roughly equivalent to printf format specifiers:
18017 FIELD_WIDTH PRECISION PRINTF
18018 ----------------------------------------
18024 MULTIBYTE zero means do not display multibyte chars, > 0 means do
18025 display them, and < 0 means obey the current buffer's value of
18026 enable_multibyte_characters.
18028 Value is the number of columns displayed. */
18031 display_string (string
, lisp_string
, face_string
, face_string_pos
,
18032 start
, it
, field_width
, precision
, max_x
, multibyte
)
18033 unsigned char *string
;
18034 Lisp_Object lisp_string
;
18035 Lisp_Object face_string
;
18036 int face_string_pos
;
18039 int field_width
, precision
, max_x
;
18042 int hpos_at_start
= it
->hpos
;
18043 int saved_face_id
= it
->face_id
;
18044 struct glyph_row
*row
= it
->glyph_row
;
18046 /* Initialize the iterator IT for iteration over STRING beginning
18047 with index START. */
18048 reseat_to_string (it
, string
, lisp_string
, start
,
18049 precision
, field_width
, multibyte
);
18051 /* If displaying STRING, set up the face of the iterator
18052 from LISP_STRING, if that's given. */
18053 if (STRINGP (face_string
))
18059 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
18060 0, it
->region_beg_charpos
,
18061 it
->region_end_charpos
,
18062 &endptr
, it
->base_face_id
, 0);
18063 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18064 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
18067 /* Set max_x to the maximum allowed X position. Don't let it go
18068 beyond the right edge of the window. */
18070 max_x
= it
->last_visible_x
;
18072 max_x
= min (max_x
, it
->last_visible_x
);
18074 /* Skip over display elements that are not visible. because IT->w is
18076 if (it
->current_x
< it
->first_visible_x
)
18077 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
18078 MOVE_TO_POS
| MOVE_TO_X
);
18080 row
->ascent
= it
->max_ascent
;
18081 row
->height
= it
->max_ascent
+ it
->max_descent
;
18082 row
->phys_ascent
= it
->max_phys_ascent
;
18083 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18084 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18086 /* This condition is for the case that we are called with current_x
18087 past last_visible_x. */
18088 while (it
->current_x
< max_x
)
18090 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
18092 /* Get the next display element. */
18093 if (!get_next_display_element (it
))
18096 /* Produce glyphs. */
18097 x_before
= it
->current_x
;
18098 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
18099 PRODUCE_GLYPHS (it
);
18101 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
18104 while (i
< nglyphs
)
18106 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
18108 if (!it
->truncate_lines_p
18109 && x
+ glyph
->pixel_width
> max_x
)
18111 /* End of continued line or max_x reached. */
18112 if (CHAR_GLYPH_PADDING_P (*glyph
))
18114 /* A wide character is unbreakable. */
18115 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18116 it
->current_x
= x_before
;
18120 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
18125 else if (x
+ glyph
->pixel_width
> it
->first_visible_x
)
18127 /* Glyph is at least partially visible. */
18129 if (x
< it
->first_visible_x
)
18130 it
->glyph_row
->x
= x
- it
->first_visible_x
;
18134 /* Glyph is off the left margin of the display area.
18135 Should not happen. */
18139 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18140 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18141 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18142 row
->phys_height
= max (row
->phys_height
,
18143 it
->max_phys_ascent
+ it
->max_phys_descent
);
18144 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18145 it
->max_extra_line_spacing
);
18146 x
+= glyph
->pixel_width
;
18150 /* Stop if max_x reached. */
18154 /* Stop at line ends. */
18155 if (ITERATOR_AT_END_OF_LINE_P (it
))
18157 it
->continuation_lines_width
= 0;
18161 set_iterator_to_next (it
, 1);
18163 /* Stop if truncating at the right edge. */
18164 if (it
->truncate_lines_p
18165 && it
->current_x
>= it
->last_visible_x
)
18167 /* Add truncation mark, but don't do it if the line is
18168 truncated at a padding space. */
18169 if (IT_CHARPOS (*it
) < it
->string_nchars
)
18171 if (!FRAME_WINDOW_P (it
->f
))
18175 if (it
->current_x
> it
->last_visible_x
)
18177 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
18178 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
18180 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
18182 row
->used
[TEXT_AREA
] = i
;
18183 produce_special_glyphs (it
, IT_TRUNCATION
);
18186 produce_special_glyphs (it
, IT_TRUNCATION
);
18188 it
->glyph_row
->truncated_on_right_p
= 1;
18194 /* Maybe insert a truncation at the left. */
18195 if (it
->first_visible_x
18196 && IT_CHARPOS (*it
) > 0)
18198 if (!FRAME_WINDOW_P (it
->f
))
18199 insert_left_trunc_glyphs (it
);
18200 it
->glyph_row
->truncated_on_left_p
= 1;
18203 it
->face_id
= saved_face_id
;
18205 /* Value is number of columns displayed. */
18206 return it
->hpos
- hpos_at_start
;
18211 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
18212 appears as an element of LIST or as the car of an element of LIST.
18213 If PROPVAL is a list, compare each element against LIST in that
18214 way, and return 1/2 if any element of PROPVAL is found in LIST.
18215 Otherwise return 0. This function cannot quit.
18216 The return value is 2 if the text is invisible but with an ellipsis
18217 and 1 if it's invisible and without an ellipsis. */
18220 invisible_p (propval
, list
)
18221 register Lisp_Object propval
;
18224 register Lisp_Object tail
, proptail
;
18226 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
18228 register Lisp_Object tem
;
18230 if (EQ (propval
, tem
))
18232 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
18233 return NILP (XCDR (tem
)) ? 1 : 2;
18236 if (CONSP (propval
))
18238 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
18240 Lisp_Object propelt
;
18241 propelt
= XCAR (proptail
);
18242 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
18244 register Lisp_Object tem
;
18246 if (EQ (propelt
, tem
))
18248 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
18249 return NILP (XCDR (tem
)) ? 1 : 2;
18257 /* Calculate a width or height in pixels from a specification using
18258 the following elements:
18261 NUM - a (fractional) multiple of the default font width/height
18262 (NUM) - specifies exactly NUM pixels
18263 UNIT - a fixed number of pixels, see below.
18264 ELEMENT - size of a display element in pixels, see below.
18265 (NUM . SPEC) - equals NUM * SPEC
18266 (+ SPEC SPEC ...) - add pixel values
18267 (- SPEC SPEC ...) - subtract pixel values
18268 (- SPEC) - negate pixel value
18271 INT or FLOAT - a number constant
18272 SYMBOL - use symbol's (buffer local) variable binding.
18275 in - pixels per inch *)
18276 mm - pixels per 1/1000 meter *)
18277 cm - pixels per 1/100 meter *)
18278 width - width of current font in pixels.
18279 height - height of current font in pixels.
18281 *) using the ratio(s) defined in display-pixels-per-inch.
18285 left-fringe - left fringe width in pixels
18286 right-fringe - right fringe width in pixels
18288 left-margin - left margin width in pixels
18289 right-margin - right margin width in pixels
18291 scroll-bar - scroll-bar area width in pixels
18295 Pixels corresponding to 5 inches:
18298 Total width of non-text areas on left side of window (if scroll-bar is on left):
18299 '(space :width (+ left-fringe left-margin scroll-bar))
18301 Align to first text column (in header line):
18302 '(space :align-to 0)
18304 Align to middle of text area minus half the width of variable `my-image'
18305 containing a loaded image:
18306 '(space :align-to (0.5 . (- text my-image)))
18308 Width of left margin minus width of 1 character in the default font:
18309 '(space :width (- left-margin 1))
18311 Width of left margin minus width of 2 characters in the current font:
18312 '(space :width (- left-margin (2 . width)))
18314 Center 1 character over left-margin (in header line):
18315 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
18317 Different ways to express width of left fringe plus left margin minus one pixel:
18318 '(space :width (- (+ left-fringe left-margin) (1)))
18319 '(space :width (+ left-fringe left-margin (- (1))))
18320 '(space :width (+ left-fringe left-margin (-1)))
18324 #define NUMVAL(X) \
18325 ((INTEGERP (X) || FLOATP (X)) \
18330 calc_pixel_width_or_height (res
, it
, prop
, font
, width_p
, align_to
)
18335 int width_p
, *align_to
;
18339 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
18340 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
18343 return OK_PIXELS (0);
18345 if (SYMBOLP (prop
))
18347 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
18349 char *unit
= SDATA (SYMBOL_NAME (prop
));
18351 if (unit
[0] == 'i' && unit
[1] == 'n')
18353 else if (unit
[0] == 'm' && unit
[1] == 'm')
18355 else if (unit
[0] == 'c' && unit
[1] == 'm')
18362 #ifdef HAVE_WINDOW_SYSTEM
18363 if (FRAME_WINDOW_P (it
->f
)
18365 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
18366 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
18368 return OK_PIXELS (ppi
/ pixels
);
18371 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
18372 || (CONSP (Vdisplay_pixels_per_inch
)
18374 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
18375 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
18377 return OK_PIXELS (ppi
/ pixels
);
18383 #ifdef HAVE_WINDOW_SYSTEM
18384 if (EQ (prop
, Qheight
))
18385 return OK_PIXELS (font
? FONT_HEIGHT ((XFontStruct
*)font
) : FRAME_LINE_HEIGHT (it
->f
));
18386 if (EQ (prop
, Qwidth
))
18387 return OK_PIXELS (font
? FONT_WIDTH ((XFontStruct
*)font
) : FRAME_COLUMN_WIDTH (it
->f
));
18389 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
18390 return OK_PIXELS (1);
18393 if (EQ (prop
, Qtext
))
18394 return OK_PIXELS (width_p
18395 ? window_box_width (it
->w
, TEXT_AREA
)
18396 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
18398 if (align_to
&& *align_to
< 0)
18401 if (EQ (prop
, Qleft
))
18402 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
18403 if (EQ (prop
, Qright
))
18404 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
18405 if (EQ (prop
, Qcenter
))
18406 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
18407 + window_box_width (it
->w
, TEXT_AREA
) / 2);
18408 if (EQ (prop
, Qleft_fringe
))
18409 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
18410 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
18411 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
18412 if (EQ (prop
, Qright_fringe
))
18413 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
18414 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
18415 : window_box_right_offset (it
->w
, TEXT_AREA
));
18416 if (EQ (prop
, Qleft_margin
))
18417 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
18418 if (EQ (prop
, Qright_margin
))
18419 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
18420 if (EQ (prop
, Qscroll_bar
))
18421 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
18423 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
18424 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
18425 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
18430 if (EQ (prop
, Qleft_fringe
))
18431 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
18432 if (EQ (prop
, Qright_fringe
))
18433 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
18434 if (EQ (prop
, Qleft_margin
))
18435 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
18436 if (EQ (prop
, Qright_margin
))
18437 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
18438 if (EQ (prop
, Qscroll_bar
))
18439 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
18442 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
18445 if (INTEGERP (prop
) || FLOATP (prop
))
18447 int base_unit
= (width_p
18448 ? FRAME_COLUMN_WIDTH (it
->f
)
18449 : FRAME_LINE_HEIGHT (it
->f
));
18450 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
18455 Lisp_Object car
= XCAR (prop
);
18456 Lisp_Object cdr
= XCDR (prop
);
18460 #ifdef HAVE_WINDOW_SYSTEM
18461 if (valid_image_p (prop
))
18463 int id
= lookup_image (it
->f
, prop
);
18464 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
18466 return OK_PIXELS (width_p
? img
->width
: img
->height
);
18469 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
18475 while (CONSP (cdr
))
18477 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
18478 font
, width_p
, align_to
))
18481 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
18486 if (EQ (car
, Qminus
))
18488 return OK_PIXELS (pixels
);
18491 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
18494 if (INTEGERP (car
) || FLOATP (car
))
18497 pixels
= XFLOATINT (car
);
18499 return OK_PIXELS (pixels
);
18500 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
18501 font
, width_p
, align_to
))
18502 return OK_PIXELS (pixels
* fact
);
18513 /***********************************************************************
18515 ***********************************************************************/
18517 #ifdef HAVE_WINDOW_SYSTEM
18522 dump_glyph_string (s
)
18523 struct glyph_string
*s
;
18525 fprintf (stderr
, "glyph string\n");
18526 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
18527 s
->x
, s
->y
, s
->width
, s
->height
);
18528 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
18529 fprintf (stderr
, " hl = %d\n", s
->hl
);
18530 fprintf (stderr
, " left overhang = %d, right = %d\n",
18531 s
->left_overhang
, s
->right_overhang
);
18532 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
18533 fprintf (stderr
, " extends to end of line = %d\n",
18534 s
->extends_to_end_of_line_p
);
18535 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
18536 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
18539 #endif /* GLYPH_DEBUG */
18541 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
18542 of XChar2b structures for S; it can't be allocated in
18543 init_glyph_string because it must be allocated via `alloca'. W
18544 is the window on which S is drawn. ROW and AREA are the glyph row
18545 and area within the row from which S is constructed. START is the
18546 index of the first glyph structure covered by S. HL is a
18547 face-override for drawing S. */
18550 #define OPTIONAL_HDC(hdc) hdc,
18551 #define DECLARE_HDC(hdc) HDC hdc;
18552 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
18553 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
18556 #ifndef OPTIONAL_HDC
18557 #define OPTIONAL_HDC(hdc)
18558 #define DECLARE_HDC(hdc)
18559 #define ALLOCATE_HDC(hdc, f)
18560 #define RELEASE_HDC(hdc, f)
18564 init_glyph_string (s
, OPTIONAL_HDC (hdc
) char2b
, w
, row
, area
, start
, hl
)
18565 struct glyph_string
*s
;
18569 struct glyph_row
*row
;
18570 enum glyph_row_area area
;
18572 enum draw_glyphs_face hl
;
18574 bzero (s
, sizeof *s
);
18576 s
->f
= XFRAME (w
->frame
);
18580 s
->display
= FRAME_X_DISPLAY (s
->f
);
18581 s
->window
= FRAME_X_WINDOW (s
->f
);
18582 s
->char2b
= char2b
;
18586 s
->first_glyph
= row
->glyphs
[area
] + start
;
18587 s
->height
= row
->height
;
18588 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
18590 /* Display the internal border below the tool-bar window. */
18591 if (WINDOWP (s
->f
->tool_bar_window
)
18592 && s
->w
== XWINDOW (s
->f
->tool_bar_window
))
18593 s
->y
-= FRAME_INTERNAL_BORDER_WIDTH (s
->f
);
18595 s
->ybase
= s
->y
+ row
->ascent
;
18599 /* Append the list of glyph strings with head H and tail T to the list
18600 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
18603 append_glyph_string_lists (head
, tail
, h
, t
)
18604 struct glyph_string
**head
, **tail
;
18605 struct glyph_string
*h
, *t
;
18619 /* Prepend the list of glyph strings with head H and tail T to the
18620 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
18624 prepend_glyph_string_lists (head
, tail
, h
, t
)
18625 struct glyph_string
**head
, **tail
;
18626 struct glyph_string
*h
, *t
;
18640 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
18641 Set *HEAD and *TAIL to the resulting list. */
18644 append_glyph_string (head
, tail
, s
)
18645 struct glyph_string
**head
, **tail
;
18646 struct glyph_string
*s
;
18648 s
->next
= s
->prev
= NULL
;
18649 append_glyph_string_lists (head
, tail
, s
, s
);
18653 /* Get face and two-byte form of character glyph GLYPH on frame F.
18654 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
18655 a pointer to a realized face that is ready for display. */
18657 static INLINE
struct face
*
18658 get_glyph_face_and_encoding (f
, glyph
, char2b
, two_byte_p
)
18660 struct glyph
*glyph
;
18666 xassert (glyph
->type
== CHAR_GLYPH
);
18667 face
= FACE_FROM_ID (f
, glyph
->face_id
);
18672 if (!glyph
->multibyte_p
)
18674 /* Unibyte case. We don't have to encode, but we have to make
18675 sure to use a face suitable for unibyte. */
18676 STORE_XCHAR2B (char2b
, 0, glyph
->u
.ch
);
18678 else if (glyph
->u
.ch
< 128)
18680 /* Case of ASCII in a face known to fit ASCII. */
18681 STORE_XCHAR2B (char2b
, 0, glyph
->u
.ch
);
18685 int c1
, c2
, charset
;
18687 /* Split characters into bytes. If c2 is -1 afterwards, C is
18688 really a one-byte character so that byte1 is zero. */
18689 SPLIT_CHAR (glyph
->u
.ch
, charset
, c1
, c2
);
18691 STORE_XCHAR2B (char2b
, c1
, c2
);
18693 STORE_XCHAR2B (char2b
, 0, c1
);
18695 /* Maybe encode the character in *CHAR2B. */
18696 if (charset
!= CHARSET_ASCII
)
18698 struct font_info
*font_info
18699 = FONT_INFO_FROM_ID (f
, face
->font_info_id
);
18702 = rif
->encode_char (glyph
->u
.ch
, char2b
, font_info
, two_byte_p
);
18706 /* Make sure X resources of the face are allocated. */
18707 xassert (face
!= NULL
);
18708 PREPARE_FACE_FOR_DISPLAY (f
, face
);
18713 /* Fill glyph string S with composition components specified by S->cmp.
18715 FACES is an array of faces for all components of this composition.
18716 S->gidx is the index of the first component for S.
18718 OVERLAPS non-zero means S should draw the foreground only, and use
18719 its physical height for clipping. See also draw_glyphs.
18721 Value is the index of a component not in S. */
18724 fill_composite_glyph_string (s
, faces
, overlaps
)
18725 struct glyph_string
*s
;
18726 struct face
**faces
;
18733 s
->for_overlaps
= overlaps
;
18735 s
->face
= faces
[s
->gidx
];
18736 s
->font
= s
->face
->font
;
18737 s
->font_info
= FONT_INFO_FROM_ID (s
->f
, s
->face
->font_info_id
);
18739 /* For all glyphs of this composition, starting at the offset
18740 S->gidx, until we reach the end of the definition or encounter a
18741 glyph that requires the different face, add it to S. */
18743 for (i
= s
->gidx
+ 1; i
< s
->cmp
->glyph_len
&& faces
[i
] == s
->face
; ++i
)
18746 /* All glyph strings for the same composition has the same width,
18747 i.e. the width set for the first component of the composition. */
18749 s
->width
= s
->first_glyph
->pixel_width
;
18751 /* If the specified font could not be loaded, use the frame's
18752 default font, but record the fact that we couldn't load it in
18753 the glyph string so that we can draw rectangles for the
18754 characters of the glyph string. */
18755 if (s
->font
== NULL
)
18757 s
->font_not_found_p
= 1;
18758 s
->font
= FRAME_FONT (s
->f
);
18761 /* Adjust base line for subscript/superscript text. */
18762 s
->ybase
+= s
->first_glyph
->voffset
;
18764 xassert (s
->face
&& s
->face
->gc
);
18766 /* This glyph string must always be drawn with 16-bit functions. */
18769 return s
->gidx
+ s
->nchars
;
18773 /* Fill glyph string S from a sequence of character glyphs.
18775 FACE_ID is the face id of the string. START is the index of the
18776 first glyph to consider, END is the index of the last + 1.
18777 OVERLAPS non-zero means S should draw the foreground only, and use
18778 its physical height for clipping. See also draw_glyphs.
18780 Value is the index of the first glyph not in S. */
18783 fill_glyph_string (s
, face_id
, start
, end
, overlaps
)
18784 struct glyph_string
*s
;
18786 int start
, end
, overlaps
;
18788 struct glyph
*glyph
, *last
;
18790 int glyph_not_available_p
;
18792 xassert (s
->f
== XFRAME (s
->w
->frame
));
18793 xassert (s
->nchars
== 0);
18794 xassert (start
>= 0 && end
> start
);
18796 s
->for_overlaps
= overlaps
,
18797 glyph
= s
->row
->glyphs
[s
->area
] + start
;
18798 last
= s
->row
->glyphs
[s
->area
] + end
;
18799 voffset
= glyph
->voffset
;
18801 glyph_not_available_p
= glyph
->glyph_not_available_p
;
18803 while (glyph
< last
18804 && glyph
->type
== CHAR_GLYPH
18805 && glyph
->voffset
== voffset
18806 /* Same face id implies same font, nowadays. */
18807 && glyph
->face_id
== face_id
18808 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
18812 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
18813 s
->char2b
+ s
->nchars
,
18815 s
->two_byte_p
= two_byte_p
;
18817 xassert (s
->nchars
<= end
- start
);
18818 s
->width
+= glyph
->pixel_width
;
18822 s
->font
= s
->face
->font
;
18823 s
->font_info
= FONT_INFO_FROM_ID (s
->f
, s
->face
->font_info_id
);
18825 /* If the specified font could not be loaded, use the frame's font,
18826 but record the fact that we couldn't load it in
18827 S->font_not_found_p so that we can draw rectangles for the
18828 characters of the glyph string. */
18829 if (s
->font
== NULL
|| glyph_not_available_p
)
18831 s
->font_not_found_p
= 1;
18832 s
->font
= FRAME_FONT (s
->f
);
18835 /* Adjust base line for subscript/superscript text. */
18836 s
->ybase
+= voffset
;
18838 xassert (s
->face
&& s
->face
->gc
);
18839 return glyph
- s
->row
->glyphs
[s
->area
];
18843 /* Fill glyph string S from image glyph S->first_glyph. */
18846 fill_image_glyph_string (s
)
18847 struct glyph_string
*s
;
18849 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
18850 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
18852 s
->slice
= s
->first_glyph
->slice
;
18853 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
18854 s
->font
= s
->face
->font
;
18855 s
->width
= s
->first_glyph
->pixel_width
;
18857 /* Adjust base line for subscript/superscript text. */
18858 s
->ybase
+= s
->first_glyph
->voffset
;
18862 /* Fill glyph string S from a sequence of stretch glyphs.
18864 ROW is the glyph row in which the glyphs are found, AREA is the
18865 area within the row. START is the index of the first glyph to
18866 consider, END is the index of the last + 1.
18868 Value is the index of the first glyph not in S. */
18871 fill_stretch_glyph_string (s
, row
, area
, start
, end
)
18872 struct glyph_string
*s
;
18873 struct glyph_row
*row
;
18874 enum glyph_row_area area
;
18877 struct glyph
*glyph
, *last
;
18878 int voffset
, face_id
;
18880 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
18882 glyph
= s
->row
->glyphs
[s
->area
] + start
;
18883 last
= s
->row
->glyphs
[s
->area
] + end
;
18884 face_id
= glyph
->face_id
;
18885 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
18886 s
->font
= s
->face
->font
;
18887 s
->font_info
= FONT_INFO_FROM_ID (s
->f
, s
->face
->font_info_id
);
18888 s
->width
= glyph
->pixel_width
;
18890 voffset
= glyph
->voffset
;
18894 && glyph
->type
== STRETCH_GLYPH
18895 && glyph
->voffset
== voffset
18896 && glyph
->face_id
== face_id
);
18898 s
->width
+= glyph
->pixel_width
;
18900 /* Adjust base line for subscript/superscript text. */
18901 s
->ybase
+= voffset
;
18903 /* The case that face->gc == 0 is handled when drawing the glyph
18904 string by calling PREPARE_FACE_FOR_DISPLAY. */
18906 return glyph
- s
->row
->glyphs
[s
->area
];
18911 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
18912 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
18913 assumed to be zero. */
18916 x_get_glyph_overhangs (glyph
, f
, left
, right
)
18917 struct glyph
*glyph
;
18921 *left
= *right
= 0;
18923 if (glyph
->type
== CHAR_GLYPH
)
18927 struct font_info
*font_info
;
18931 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
18933 font_info
= FONT_INFO_FROM_ID (f
, face
->font_info_id
);
18934 if (font
/* ++KFS: Should this be font_info ? */
18935 && (pcm
= rif
->per_char_metric (font
, &char2b
, glyph
->font_type
)))
18937 if (pcm
->rbearing
> pcm
->width
)
18938 *right
= pcm
->rbearing
- pcm
->width
;
18939 if (pcm
->lbearing
< 0)
18940 *left
= -pcm
->lbearing
;
18946 /* Return the index of the first glyph preceding glyph string S that
18947 is overwritten by S because of S's left overhang. Value is -1
18948 if no glyphs are overwritten. */
18951 left_overwritten (s
)
18952 struct glyph_string
*s
;
18956 if (s
->left_overhang
)
18959 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
18960 int first
= s
->first_glyph
- glyphs
;
18962 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
18963 x
-= glyphs
[i
].pixel_width
;
18974 /* Return the index of the first glyph preceding glyph string S that
18975 is overwriting S because of its right overhang. Value is -1 if no
18976 glyph in front of S overwrites S. */
18979 left_overwriting (s
)
18980 struct glyph_string
*s
;
18983 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
18984 int first
= s
->first_glyph
- glyphs
;
18988 for (i
= first
- 1; i
>= 0; --i
)
18991 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
18994 x
-= glyphs
[i
].pixel_width
;
19001 /* Return the index of the last glyph following glyph string S that is
19002 not overwritten by S because of S's right overhang. Value is -1 if
19003 no such glyph is found. */
19006 right_overwritten (s
)
19007 struct glyph_string
*s
;
19011 if (s
->right_overhang
)
19014 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19015 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
19016 int end
= s
->row
->used
[s
->area
];
19018 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
19019 x
+= glyphs
[i
].pixel_width
;
19028 /* Return the index of the last glyph following glyph string S that
19029 overwrites S because of its left overhang. Value is negative
19030 if no such glyph is found. */
19033 right_overwriting (s
)
19034 struct glyph_string
*s
;
19037 int end
= s
->row
->used
[s
->area
];
19038 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19039 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
19043 for (i
= first
; i
< end
; ++i
)
19046 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
19049 x
+= glyphs
[i
].pixel_width
;
19056 /* Get face and two-byte form of character C in face FACE_ID on frame
19057 F. The encoding of C is returned in *CHAR2B. MULTIBYTE_P non-zero
19058 means we want to display multibyte text. DISPLAY_P non-zero means
19059 make sure that X resources for the face returned are allocated.
19060 Value is a pointer to a realized face that is ready for display if
19061 DISPLAY_P is non-zero. */
19063 static INLINE
struct face
*
19064 get_char_face_and_encoding (f
, c
, face_id
, char2b
, multibyte_p
, display_p
)
19068 int multibyte_p
, display_p
;
19070 struct face
*face
= FACE_FROM_ID (f
, face_id
);
19074 /* Unibyte case. We don't have to encode, but we have to make
19075 sure to use a face suitable for unibyte. */
19076 STORE_XCHAR2B (char2b
, 0, c
);
19077 face_id
= FACE_FOR_CHAR (f
, face
, c
);
19078 face
= FACE_FROM_ID (f
, face_id
);
19082 /* Case of ASCII in a face known to fit ASCII. */
19083 STORE_XCHAR2B (char2b
, 0, c
);
19087 int c1
, c2
, charset
;
19089 /* Split characters into bytes. If c2 is -1 afterwards, C is
19090 really a one-byte character so that byte1 is zero. */
19091 SPLIT_CHAR (c
, charset
, c1
, c2
);
19093 STORE_XCHAR2B (char2b
, c1
, c2
);
19095 STORE_XCHAR2B (char2b
, 0, c1
);
19097 /* Maybe encode the character in *CHAR2B. */
19098 if (face
->font
!= NULL
)
19100 struct font_info
*font_info
19101 = FONT_INFO_FROM_ID (f
, face
->font_info_id
);
19103 rif
->encode_char (c
, char2b
, font_info
, 0);
19107 /* Make sure X resources of the face are allocated. */
19108 #ifdef HAVE_X_WINDOWS
19112 xassert (face
!= NULL
);
19113 PREPARE_FACE_FOR_DISPLAY (f
, face
);
19120 /* Set background width of glyph string S. START is the index of the
19121 first glyph following S. LAST_X is the right-most x-position + 1
19122 in the drawing area. */
19125 set_glyph_string_background_width (s
, start
, last_x
)
19126 struct glyph_string
*s
;
19130 /* If the face of this glyph string has to be drawn to the end of
19131 the drawing area, set S->extends_to_end_of_line_p. */
19133 if (start
== s
->row
->used
[s
->area
]
19134 && s
->area
== TEXT_AREA
19135 && ((s
->row
->fill_line_p
19136 && (s
->hl
== DRAW_NORMAL_TEXT
19137 || s
->hl
== DRAW_IMAGE_RAISED
19138 || s
->hl
== DRAW_IMAGE_SUNKEN
))
19139 || s
->hl
== DRAW_MOUSE_FACE
))
19140 s
->extends_to_end_of_line_p
= 1;
19142 /* If S extends its face to the end of the line, set its
19143 background_width to the distance to the right edge of the drawing
19145 if (s
->extends_to_end_of_line_p
)
19146 s
->background_width
= last_x
- s
->x
+ 1;
19148 s
->background_width
= s
->width
;
19152 /* Compute overhangs and x-positions for glyph string S and its
19153 predecessors, or successors. X is the starting x-position for S.
19154 BACKWARD_P non-zero means process predecessors. */
19157 compute_overhangs_and_x (s
, x
, backward_p
)
19158 struct glyph_string
*s
;
19166 if (rif
->compute_glyph_string_overhangs
)
19167 rif
->compute_glyph_string_overhangs (s
);
19177 if (rif
->compute_glyph_string_overhangs
)
19178 rif
->compute_glyph_string_overhangs (s
);
19188 /* The following macros are only called from draw_glyphs below.
19189 They reference the following parameters of that function directly:
19190 `w', `row', `area', and `overlap_p'
19191 as well as the following local variables:
19192 `s', `f', and `hdc' (in W32) */
19195 /* On W32, silently add local `hdc' variable to argument list of
19196 init_glyph_string. */
19197 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
19198 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
19200 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
19201 init_glyph_string (s, char2b, w, row, area, start, hl)
19204 /* Add a glyph string for a stretch glyph to the list of strings
19205 between HEAD and TAIL. START is the index of the stretch glyph in
19206 row area AREA of glyph row ROW. END is the index of the last glyph
19207 in that glyph row area. X is the current output position assigned
19208 to the new glyph string constructed. HL overrides that face of the
19209 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
19210 is the right-most x-position of the drawing area. */
19212 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
19213 and below -- keep them on one line. */
19214 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
19217 s = (struct glyph_string *) alloca (sizeof *s); \
19218 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
19219 START = fill_stretch_glyph_string (s, row, area, START, END); \
19220 append_glyph_string (&HEAD, &TAIL, s); \
19226 /* Add a glyph string for an image glyph to the list of strings
19227 between HEAD and TAIL. START is the index of the image 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 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
19237 s = (struct glyph_string *) alloca (sizeof *s); \
19238 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
19239 fill_image_glyph_string (s); \
19240 append_glyph_string (&HEAD, &TAIL, s); \
19247 /* Add a glyph string for a sequence of character glyphs to the list
19248 of strings between HEAD and TAIL. START is the index of the first
19249 glyph in row area AREA of glyph row ROW that is part of the new
19250 glyph string. END is the index of the last glyph in that glyph row
19251 area. X is the current output position assigned to the new glyph
19252 string constructed. HL overrides that face of the glyph; e.g. it
19253 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
19254 right-most x-position of the drawing area. */
19256 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
19262 c = (row)->glyphs[area][START].u.ch; \
19263 face_id = (row)->glyphs[area][START].face_id; \
19265 s = (struct glyph_string *) alloca (sizeof *s); \
19266 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
19267 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
19268 append_glyph_string (&HEAD, &TAIL, s); \
19270 START = fill_glyph_string (s, face_id, START, END, overlaps); \
19275 /* Add a glyph string for a composite sequence to the list of strings
19276 between HEAD and TAIL. START is the index of the first glyph in
19277 row area AREA of glyph row ROW that is part of the new glyph
19278 string. END is the index of the last glyph in that glyph row area.
19279 X is the current output position assigned to the new glyph string
19280 constructed. HL overrides that face of the glyph; e.g. it is
19281 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
19282 x-position of the drawing area. */
19284 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
19286 int cmp_id = (row)->glyphs[area][START].u.cmp_id; \
19287 int face_id = (row)->glyphs[area][START].face_id; \
19288 struct face *base_face = FACE_FROM_ID (f, face_id); \
19289 struct composition *cmp = composition_table[cmp_id]; \
19290 int glyph_len = cmp->glyph_len; \
19292 struct face **faces; \
19293 struct glyph_string *first_s = NULL; \
19296 base_face = base_face->ascii_face; \
19297 char2b = (XChar2b *) alloca ((sizeof *char2b) * glyph_len); \
19298 faces = (struct face **) alloca ((sizeof *faces) * glyph_len); \
19299 /* At first, fill in `char2b' and `faces'. */ \
19300 for (n = 0; n < glyph_len; n++) \
19302 int c = COMPOSITION_GLYPH (cmp, n); \
19303 int this_face_id = FACE_FOR_CHAR (f, base_face, c); \
19304 faces[n] = FACE_FROM_ID (f, this_face_id); \
19305 get_char_face_and_encoding (f, c, this_face_id, \
19306 char2b + n, 1, 1); \
19309 /* Make glyph_strings for each glyph sequence that is drawable by \
19310 the same face, and append them to HEAD/TAIL. */ \
19311 for (n = 0; n < cmp->glyph_len;) \
19313 s = (struct glyph_string *) alloca (sizeof *s); \
19314 INIT_GLYPH_STRING (s, char2b + n, w, row, area, START, HL); \
19315 append_glyph_string (&(HEAD), &(TAIL), s); \
19323 n = fill_composite_glyph_string (s, faces, overlaps); \
19331 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
19332 of AREA of glyph row ROW on window W between indices START and END.
19333 HL overrides the face for drawing glyph strings, e.g. it is
19334 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
19335 x-positions of the drawing area.
19337 This is an ugly monster macro construct because we must use alloca
19338 to allocate glyph strings (because draw_glyphs can be called
19339 asynchronously). */
19341 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
19344 HEAD = TAIL = NULL; \
19345 while (START < END) \
19347 struct glyph *first_glyph = (row)->glyphs[area] + START; \
19348 switch (first_glyph->type) \
19351 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
19355 case COMPOSITE_GLYPH: \
19356 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
19360 case STRETCH_GLYPH: \
19361 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
19365 case IMAGE_GLYPH: \
19366 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
19374 set_glyph_string_background_width (s, START, LAST_X); \
19381 /* Draw glyphs between START and END in AREA of ROW on window W,
19382 starting at x-position X. X is relative to AREA in W. HL is a
19383 face-override with the following meaning:
19385 DRAW_NORMAL_TEXT draw normally
19386 DRAW_CURSOR draw in cursor face
19387 DRAW_MOUSE_FACE draw in mouse face.
19388 DRAW_INVERSE_VIDEO draw in mode line face
19389 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
19390 DRAW_IMAGE_RAISED draw an image with a raised relief around it
19392 If OVERLAPS is non-zero, draw only the foreground of characters and
19393 clip to the physical height of ROW. Non-zero value also defines
19394 the overlapping part to be drawn:
19396 OVERLAPS_PRED overlap with preceding rows
19397 OVERLAPS_SUCC overlap with succeeding rows
19398 OVERLAPS_BOTH overlap with both preceding/succeeding rows
19399 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
19401 Value is the x-position reached, relative to AREA of W. */
19404 draw_glyphs (w
, x
, row
, area
, start
, end
, hl
, overlaps
)
19407 struct glyph_row
*row
;
19408 enum glyph_row_area area
;
19410 enum draw_glyphs_face hl
;
19413 struct glyph_string
*head
, *tail
;
19414 struct glyph_string
*s
;
19415 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
19416 int last_x
, area_width
;
19419 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19422 ALLOCATE_HDC (hdc
, f
);
19424 /* Let's rather be paranoid than getting a SEGV. */
19425 end
= min (end
, row
->used
[area
]);
19426 start
= max (0, start
);
19427 start
= min (end
, start
);
19429 /* Translate X to frame coordinates. Set last_x to the right
19430 end of the drawing area. */
19431 if (row
->full_width_p
)
19433 /* X is relative to the left edge of W, without scroll bars
19435 x
+= WINDOW_LEFT_EDGE_X (w
);
19436 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
19440 int area_left
= window_box_left (w
, area
);
19442 area_width
= window_box_width (w
, area
);
19443 last_x
= area_left
+ area_width
;
19446 /* Build a doubly-linked list of glyph_string structures between
19447 head and tail from what we have to draw. Note that the macro
19448 BUILD_GLYPH_STRINGS will modify its start parameter. That's
19449 the reason we use a separate variable `i'. */
19451 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
19453 x_reached
= tail
->x
+ tail
->background_width
;
19457 /* If there are any glyphs with lbearing < 0 or rbearing > width in
19458 the row, redraw some glyphs in front or following the glyph
19459 strings built above. */
19460 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
19463 struct glyph_string
*h
, *t
;
19465 /* Compute overhangs for all glyph strings. */
19466 if (rif
->compute_glyph_string_overhangs
)
19467 for (s
= head
; s
; s
= s
->next
)
19468 rif
->compute_glyph_string_overhangs (s
);
19470 /* Prepend glyph strings for glyphs in front of the first glyph
19471 string that are overwritten because of the first glyph
19472 string's left overhang. The background of all strings
19473 prepended must be drawn because the first glyph string
19475 i
= left_overwritten (head
);
19479 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
19480 DRAW_NORMAL_TEXT
, dummy_x
, last_x
);
19482 compute_overhangs_and_x (t
, head
->x
, 1);
19483 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
19487 /* Prepend glyph strings for glyphs in front of the first glyph
19488 string that overwrite that glyph string because of their
19489 right overhang. For these strings, only the foreground must
19490 be drawn, because it draws over the glyph string at `head'.
19491 The background must not be drawn because this would overwrite
19492 right overhangs of preceding glyphs for which no glyph
19494 i
= left_overwriting (head
);
19498 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
19499 DRAW_NORMAL_TEXT
, dummy_x
, last_x
);
19500 for (s
= h
; s
; s
= s
->next
)
19501 s
->background_filled_p
= 1;
19502 compute_overhangs_and_x (t
, head
->x
, 1);
19503 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
19506 /* Append glyphs strings for glyphs following the last glyph
19507 string tail that are overwritten by tail. The background of
19508 these strings has to be drawn because tail's foreground draws
19510 i
= right_overwritten (tail
);
19513 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
19514 DRAW_NORMAL_TEXT
, x
, last_x
);
19515 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
19516 append_glyph_string_lists (&head
, &tail
, h
, t
);
19520 /* Append glyph strings for glyphs following the last glyph
19521 string tail that overwrite tail. The foreground of such
19522 glyphs has to be drawn because it writes into the background
19523 of tail. The background must not be drawn because it could
19524 paint over the foreground of following glyphs. */
19525 i
= right_overwriting (tail
);
19529 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
19530 DRAW_NORMAL_TEXT
, x
, last_x
);
19531 for (s
= h
; s
; s
= s
->next
)
19532 s
->background_filled_p
= 1;
19533 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
19534 append_glyph_string_lists (&head
, &tail
, h
, t
);
19536 if (clip_head
|| clip_tail
)
19537 for (s
= head
; s
; s
= s
->next
)
19539 s
->clip_head
= clip_head
;
19540 s
->clip_tail
= clip_tail
;
19544 /* Draw all strings. */
19545 for (s
= head
; s
; s
= s
->next
)
19546 rif
->draw_glyph_string (s
);
19548 if (area
== TEXT_AREA
19549 && !row
->full_width_p
19550 /* When drawing overlapping rows, only the glyph strings'
19551 foreground is drawn, which doesn't erase a cursor
19555 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
19556 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
19557 : (tail
? tail
->x
+ tail
->background_width
: x
));
19559 int text_left
= window_box_left (w
, TEXT_AREA
);
19563 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
19564 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
19567 /* Value is the x-position up to which drawn, relative to AREA of W.
19568 This doesn't include parts drawn because of overhangs. */
19569 if (row
->full_width_p
)
19570 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
19572 x_reached
-= window_box_left (w
, area
);
19574 RELEASE_HDC (hdc
, f
);
19579 /* Expand row matrix if too narrow. Don't expand if area
19582 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
19584 if (!fonts_changed_p \
19585 && (it->glyph_row->glyphs[area] \
19586 < it->glyph_row->glyphs[area + 1])) \
19588 it->w->ncols_scale_factor++; \
19589 fonts_changed_p = 1; \
19593 /* Store one glyph for IT->char_to_display in IT->glyph_row.
19594 Called from x_produce_glyphs when IT->glyph_row is non-null. */
19600 struct glyph
*glyph
;
19601 enum glyph_row_area area
= it
->area
;
19603 xassert (it
->glyph_row
);
19604 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
19606 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
19607 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
19609 glyph
->charpos
= CHARPOS (it
->position
);
19610 glyph
->object
= it
->object
;
19611 glyph
->pixel_width
= it
->pixel_width
;
19612 glyph
->ascent
= it
->ascent
;
19613 glyph
->descent
= it
->descent
;
19614 glyph
->voffset
= it
->voffset
;
19615 glyph
->type
= CHAR_GLYPH
;
19616 glyph
->multibyte_p
= it
->multibyte_p
;
19617 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
19618 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
19619 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
19620 || it
->phys_descent
> it
->descent
);
19621 glyph
->padding_p
= 0;
19622 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
19623 glyph
->face_id
= it
->face_id
;
19624 glyph
->u
.ch
= it
->char_to_display
;
19625 glyph
->slice
= null_glyph_slice
;
19626 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
19627 ++it
->glyph_row
->used
[area
];
19630 IT_EXPAND_MATRIX_WIDTH (it
, area
);
19633 /* Store one glyph for the composition IT->cmp_id in IT->glyph_row.
19634 Called from x_produce_glyphs when IT->glyph_row is non-null. */
19637 append_composite_glyph (it
)
19640 struct glyph
*glyph
;
19641 enum glyph_row_area area
= it
->area
;
19643 xassert (it
->glyph_row
);
19645 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
19646 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
19648 glyph
->charpos
= CHARPOS (it
->position
);
19649 glyph
->object
= it
->object
;
19650 glyph
->pixel_width
= it
->pixel_width
;
19651 glyph
->ascent
= it
->ascent
;
19652 glyph
->descent
= it
->descent
;
19653 glyph
->voffset
= it
->voffset
;
19654 glyph
->type
= COMPOSITE_GLYPH
;
19655 glyph
->multibyte_p
= it
->multibyte_p
;
19656 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
19657 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
19658 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
19659 || it
->phys_descent
> it
->descent
);
19660 glyph
->padding_p
= 0;
19661 glyph
->glyph_not_available_p
= 0;
19662 glyph
->face_id
= it
->face_id
;
19663 glyph
->u
.cmp_id
= it
->cmp_id
;
19664 glyph
->slice
= null_glyph_slice
;
19665 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
19666 ++it
->glyph_row
->used
[area
];
19669 IT_EXPAND_MATRIX_WIDTH (it
, area
);
19673 /* Change IT->ascent and IT->height according to the setting of
19677 take_vertical_position_into_account (it
)
19682 if (it
->voffset
< 0)
19683 /* Increase the ascent so that we can display the text higher
19685 it
->ascent
-= it
->voffset
;
19687 /* Increase the descent so that we can display the text lower
19689 it
->descent
+= it
->voffset
;
19694 /* Produce glyphs/get display metrics for the image IT is loaded with.
19695 See the description of struct display_iterator in dispextern.h for
19696 an overview of struct display_iterator. */
19699 produce_image_glyph (it
)
19705 struct glyph_slice slice
;
19707 xassert (it
->what
== IT_IMAGE
);
19709 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19711 /* Make sure X resources of the face is loaded. */
19712 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
19714 if (it
->image_id
< 0)
19716 /* Fringe bitmap. */
19717 it
->ascent
= it
->phys_ascent
= 0;
19718 it
->descent
= it
->phys_descent
= 0;
19719 it
->pixel_width
= 0;
19724 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
19726 /* Make sure X resources of the image is loaded. */
19727 prepare_image_for_display (it
->f
, img
);
19729 slice
.x
= slice
.y
= 0;
19730 slice
.width
= img
->width
;
19731 slice
.height
= img
->height
;
19733 if (INTEGERP (it
->slice
.x
))
19734 slice
.x
= XINT (it
->slice
.x
);
19735 else if (FLOATP (it
->slice
.x
))
19736 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
19738 if (INTEGERP (it
->slice
.y
))
19739 slice
.y
= XINT (it
->slice
.y
);
19740 else if (FLOATP (it
->slice
.y
))
19741 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
19743 if (INTEGERP (it
->slice
.width
))
19744 slice
.width
= XINT (it
->slice
.width
);
19745 else if (FLOATP (it
->slice
.width
))
19746 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
19748 if (INTEGERP (it
->slice
.height
))
19749 slice
.height
= XINT (it
->slice
.height
);
19750 else if (FLOATP (it
->slice
.height
))
19751 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
19753 if (slice
.x
>= img
->width
)
19754 slice
.x
= img
->width
;
19755 if (slice
.y
>= img
->height
)
19756 slice
.y
= img
->height
;
19757 if (slice
.x
+ slice
.width
>= img
->width
)
19758 slice
.width
= img
->width
- slice
.x
;
19759 if (slice
.y
+ slice
.height
> img
->height
)
19760 slice
.height
= img
->height
- slice
.y
;
19762 if (slice
.width
== 0 || slice
.height
== 0)
19765 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
19767 it
->descent
= slice
.height
- glyph_ascent
;
19769 it
->descent
+= img
->vmargin
;
19770 if (slice
.y
+ slice
.height
== img
->height
)
19771 it
->descent
+= img
->vmargin
;
19772 it
->phys_descent
= it
->descent
;
19774 it
->pixel_width
= slice
.width
;
19776 it
->pixel_width
+= img
->hmargin
;
19777 if (slice
.x
+ slice
.width
== img
->width
)
19778 it
->pixel_width
+= img
->hmargin
;
19780 /* It's quite possible for images to have an ascent greater than
19781 their height, so don't get confused in that case. */
19782 if (it
->descent
< 0)
19785 #if 0 /* this breaks image tiling */
19786 /* If this glyph is alone on the last line, adjust it.ascent to minimum row ascent. */
19787 int face_ascent
= face
->font
? FONT_BASE (face
->font
) : FRAME_BASELINE_OFFSET (it
->f
);
19788 if (face_ascent
> it
->ascent
)
19789 it
->ascent
= it
->phys_ascent
= face_ascent
;
19794 if (face
->box
!= FACE_NO_BOX
)
19796 if (face
->box_line_width
> 0)
19799 it
->ascent
+= face
->box_line_width
;
19800 if (slice
.y
+ slice
.height
== img
->height
)
19801 it
->descent
+= face
->box_line_width
;
19804 if (it
->start_of_box_run_p
&& slice
.x
== 0)
19805 it
->pixel_width
+= abs (face
->box_line_width
);
19806 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
19807 it
->pixel_width
+= abs (face
->box_line_width
);
19810 take_vertical_position_into_account (it
);
19814 struct glyph
*glyph
;
19815 enum glyph_row_area area
= it
->area
;
19817 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
19818 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
19820 glyph
->charpos
= CHARPOS (it
->position
);
19821 glyph
->object
= it
->object
;
19822 glyph
->pixel_width
= it
->pixel_width
;
19823 glyph
->ascent
= glyph_ascent
;
19824 glyph
->descent
= it
->descent
;
19825 glyph
->voffset
= it
->voffset
;
19826 glyph
->type
= IMAGE_GLYPH
;
19827 glyph
->multibyte_p
= it
->multibyte_p
;
19828 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
19829 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
19830 glyph
->overlaps_vertically_p
= 0;
19831 glyph
->padding_p
= 0;
19832 glyph
->glyph_not_available_p
= 0;
19833 glyph
->face_id
= it
->face_id
;
19834 glyph
->u
.img_id
= img
->id
;
19835 glyph
->slice
= slice
;
19836 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
19837 ++it
->glyph_row
->used
[area
];
19840 IT_EXPAND_MATRIX_WIDTH (it
, area
);
19845 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
19846 of the glyph, WIDTH and HEIGHT are the width and height of the
19847 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
19850 append_stretch_glyph (it
, object
, width
, height
, ascent
)
19852 Lisp_Object object
;
19856 struct glyph
*glyph
;
19857 enum glyph_row_area area
= it
->area
;
19859 xassert (ascent
>= 0 && ascent
<= height
);
19861 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
19862 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
19864 glyph
->charpos
= CHARPOS (it
->position
);
19865 glyph
->object
= object
;
19866 glyph
->pixel_width
= width
;
19867 glyph
->ascent
= ascent
;
19868 glyph
->descent
= height
- ascent
;
19869 glyph
->voffset
= it
->voffset
;
19870 glyph
->type
= STRETCH_GLYPH
;
19871 glyph
->multibyte_p
= it
->multibyte_p
;
19872 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
19873 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
19874 glyph
->overlaps_vertically_p
= 0;
19875 glyph
->padding_p
= 0;
19876 glyph
->glyph_not_available_p
= 0;
19877 glyph
->face_id
= it
->face_id
;
19878 glyph
->u
.stretch
.ascent
= ascent
;
19879 glyph
->u
.stretch
.height
= height
;
19880 glyph
->slice
= null_glyph_slice
;
19881 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
19882 ++it
->glyph_row
->used
[area
];
19885 IT_EXPAND_MATRIX_WIDTH (it
, area
);
19889 /* Produce a stretch glyph for iterator IT. IT->object is the value
19890 of the glyph property displayed. The value must be a list
19891 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
19894 1. `:width WIDTH' specifies that the space should be WIDTH *
19895 canonical char width wide. WIDTH may be an integer or floating
19898 2. `:relative-width FACTOR' specifies that the width of the stretch
19899 should be computed from the width of the first character having the
19900 `glyph' property, and should be FACTOR times that width.
19902 3. `:align-to HPOS' specifies that the space should be wide enough
19903 to reach HPOS, a value in canonical character units.
19905 Exactly one of the above pairs must be present.
19907 4. `:height HEIGHT' specifies that the height of the stretch produced
19908 should be HEIGHT, measured in canonical character units.
19910 5. `:relative-height FACTOR' specifies that the height of the
19911 stretch should be FACTOR times the height of the characters having
19912 the glyph property.
19914 Either none or exactly one of 4 or 5 must be present.
19916 6. `:ascent ASCENT' specifies that ASCENT percent of the height
19917 of the stretch should be used for the ascent of the stretch.
19918 ASCENT must be in the range 0 <= ASCENT <= 100. */
19921 produce_stretch_glyph (it
)
19924 /* (space :width WIDTH :height HEIGHT ...) */
19925 Lisp_Object prop
, plist
;
19926 int width
= 0, height
= 0, align_to
= -1;
19927 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
19930 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19931 XFontStruct
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
19933 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
19935 /* List should start with `space'. */
19936 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
19937 plist
= XCDR (it
->object
);
19939 /* Compute the width of the stretch. */
19940 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
19941 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
19943 /* Absolute width `:width WIDTH' specified and valid. */
19944 zero_width_ok_p
= 1;
19947 else if (prop
= Fplist_get (plist
, QCrelative_width
),
19950 /* Relative width `:relative-width FACTOR' specified and valid.
19951 Compute the width of the characters having the `glyph'
19954 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
19957 if (it
->multibyte_p
)
19959 int maxlen
= ((IT_BYTEPOS (*it
) >= GPT
? ZV
: GPT
)
19960 - IT_BYTEPOS (*it
));
19961 it2
.c
= STRING_CHAR_AND_LENGTH (p
, maxlen
, it2
.len
);
19964 it2
.c
= *p
, it2
.len
= 1;
19966 it2
.glyph_row
= NULL
;
19967 it2
.what
= IT_CHARACTER
;
19968 x_produce_glyphs (&it2
);
19969 width
= NUMVAL (prop
) * it2
.pixel_width
;
19971 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
19972 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
19974 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
19975 align_to
= (align_to
< 0
19977 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
19978 else if (align_to
< 0)
19979 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
19980 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
19981 zero_width_ok_p
= 1;
19984 /* Nothing specified -> width defaults to canonical char width. */
19985 width
= FRAME_COLUMN_WIDTH (it
->f
);
19987 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
19990 /* Compute height. */
19991 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
19992 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
19995 zero_height_ok_p
= 1;
19997 else if (prop
= Fplist_get (plist
, QCrelative_height
),
19999 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
20001 height
= FONT_HEIGHT (font
);
20003 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
20006 /* Compute percentage of height used for ascent. If
20007 `:ascent ASCENT' is present and valid, use that. Otherwise,
20008 derive the ascent from the font in use. */
20009 if (prop
= Fplist_get (plist
, QCascent
),
20010 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
20011 ascent
= height
* NUMVAL (prop
) / 100.0;
20012 else if (!NILP (prop
)
20013 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
20014 ascent
= min (max (0, (int)tem
), height
);
20016 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
20018 if (width
> 0 && !it
->truncate_lines_p
20019 && it
->current_x
+ width
> it
->last_visible_x
)
20020 width
= it
->last_visible_x
- it
->current_x
- 1;
20022 if (width
> 0 && height
> 0 && it
->glyph_row
)
20024 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
20025 if (!STRINGP (object
))
20026 object
= it
->w
->buffer
;
20027 append_stretch_glyph (it
, object
, width
, height
, ascent
);
20030 it
->pixel_width
= width
;
20031 it
->ascent
= it
->phys_ascent
= ascent
;
20032 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
20033 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
20035 take_vertical_position_into_account (it
);
20038 /* Get line-height and line-spacing property at point.
20039 If line-height has format (HEIGHT TOTAL), return TOTAL
20040 in TOTAL_HEIGHT. */
20043 get_line_height_property (it
, prop
)
20047 Lisp_Object position
;
20049 if (STRINGP (it
->object
))
20050 position
= make_number (IT_STRING_CHARPOS (*it
));
20051 else if (BUFFERP (it
->object
))
20052 position
= make_number (IT_CHARPOS (*it
));
20056 return Fget_char_property (position
, prop
, it
->object
);
20059 /* Calculate line-height and line-spacing properties.
20060 An integer value specifies explicit pixel value.
20061 A float value specifies relative value to current face height.
20062 A cons (float . face-name) specifies relative value to
20063 height of specified face font.
20065 Returns height in pixels, or nil. */
20069 calc_line_height_property (it
, val
, font
, boff
, override
)
20073 int boff
, override
;
20075 Lisp_Object face_name
= Qnil
;
20076 int ascent
, descent
, height
;
20078 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
20083 face_name
= XCAR (val
);
20085 if (!NUMBERP (val
))
20086 val
= make_number (1);
20087 if (NILP (face_name
))
20089 height
= it
->ascent
+ it
->descent
;
20094 if (NILP (face_name
))
20096 font
= FRAME_FONT (it
->f
);
20097 boff
= FRAME_BASELINE_OFFSET (it
->f
);
20099 else if (EQ (face_name
, Qt
))
20107 struct font_info
*font_info
;
20109 face_id
= lookup_named_face (it
->f
, face_name
, ' ', 0);
20111 return make_number (-1);
20113 face
= FACE_FROM_ID (it
->f
, face_id
);
20116 return make_number (-1);
20118 font_info
= FONT_INFO_FROM_ID (it
->f
, face
->font_info_id
);
20119 boff
= font_info
->baseline_offset
;
20120 if (font_info
->vertical_centering
)
20121 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
20124 ascent
= FONT_BASE (font
) + boff
;
20125 descent
= FONT_DESCENT (font
) - boff
;
20129 it
->override_ascent
= ascent
;
20130 it
->override_descent
= descent
;
20131 it
->override_boff
= boff
;
20134 height
= ascent
+ descent
;
20138 height
= (int)(XFLOAT_DATA (val
) * height
);
20139 else if (INTEGERP (val
))
20140 height
*= XINT (val
);
20142 return make_number (height
);
20147 Produce glyphs/get display metrics for the display element IT is
20148 loaded with. See the description of struct it in dispextern.h
20149 for an overview of struct it. */
20152 x_produce_glyphs (it
)
20155 int extra_line_spacing
= it
->extra_line_spacing
;
20157 it
->glyph_not_available_p
= 0;
20159 if (it
->what
== IT_CHARACTER
)
20163 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20165 int font_not_found_p
;
20166 struct font_info
*font_info
;
20167 int boff
; /* baseline offset */
20168 /* We may change it->multibyte_p upon unibyte<->multibyte
20169 conversion. So, save the current value now and restore it
20172 Note: It seems that we don't have to record multibyte_p in
20173 struct glyph because the character code itself tells if or
20174 not the character is multibyte. Thus, in the future, we must
20175 consider eliminating the field `multibyte_p' in the struct
20177 int saved_multibyte_p
= it
->multibyte_p
;
20179 /* Maybe translate single-byte characters to multibyte, or the
20181 it
->char_to_display
= it
->c
;
20182 if (!ASCII_BYTE_P (it
->c
))
20184 if (unibyte_display_via_language_environment
20185 && SINGLE_BYTE_CHAR_P (it
->c
)
20187 || !NILP (Vnonascii_translation_table
)))
20189 it
->char_to_display
= unibyte_char_to_multibyte (it
->c
);
20190 it
->multibyte_p
= 1;
20191 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
);
20192 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20194 else if (!SINGLE_BYTE_CHAR_P (it
->c
)
20195 && !it
->multibyte_p
)
20197 it
->multibyte_p
= 1;
20198 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
);
20199 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20203 /* Get font to use. Encode IT->char_to_display. */
20204 get_char_face_and_encoding (it
->f
, it
->char_to_display
, it
->face_id
,
20205 &char2b
, it
->multibyte_p
, 0);
20208 /* When no suitable font found, use the default font. */
20209 font_not_found_p
= font
== NULL
;
20210 if (font_not_found_p
)
20212 font
= FRAME_FONT (it
->f
);
20213 boff
= FRAME_BASELINE_OFFSET (it
->f
);
20218 font_info
= FONT_INFO_FROM_ID (it
->f
, face
->font_info_id
);
20219 boff
= font_info
->baseline_offset
;
20220 if (font_info
->vertical_centering
)
20221 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
20224 if (it
->char_to_display
>= ' '
20225 && (!it
->multibyte_p
|| it
->char_to_display
< 128))
20227 /* Either unibyte or ASCII. */
20232 pcm
= rif
->per_char_metric (font
, &char2b
,
20233 FONT_TYPE_FOR_UNIBYTE (font
, it
->char_to_display
));
20235 if (it
->override_ascent
>= 0)
20237 it
->ascent
= it
->override_ascent
;
20238 it
->descent
= it
->override_descent
;
20239 boff
= it
->override_boff
;
20243 it
->ascent
= FONT_BASE (font
) + boff
;
20244 it
->descent
= FONT_DESCENT (font
) - boff
;
20249 it
->phys_ascent
= pcm
->ascent
+ boff
;
20250 it
->phys_descent
= pcm
->descent
- boff
;
20251 it
->pixel_width
= pcm
->width
;
20255 it
->glyph_not_available_p
= 1;
20256 it
->phys_ascent
= it
->ascent
;
20257 it
->phys_descent
= it
->descent
;
20258 it
->pixel_width
= FONT_WIDTH (font
);
20261 if (it
->constrain_row_ascent_descent_p
)
20263 if (it
->descent
> it
->max_descent
)
20265 it
->ascent
+= it
->descent
- it
->max_descent
;
20266 it
->descent
= it
->max_descent
;
20268 if (it
->ascent
> it
->max_ascent
)
20270 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
20271 it
->ascent
= it
->max_ascent
;
20273 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
20274 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
20275 extra_line_spacing
= 0;
20278 /* If this is a space inside a region of text with
20279 `space-width' property, change its width. */
20280 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
20282 it
->pixel_width
*= XFLOATINT (it
->space_width
);
20284 /* If face has a box, add the box thickness to the character
20285 height. If character has a box line to the left and/or
20286 right, add the box line width to the character's width. */
20287 if (face
->box
!= FACE_NO_BOX
)
20289 int thick
= face
->box_line_width
;
20293 it
->ascent
+= thick
;
20294 it
->descent
+= thick
;
20299 if (it
->start_of_box_run_p
)
20300 it
->pixel_width
+= thick
;
20301 if (it
->end_of_box_run_p
)
20302 it
->pixel_width
+= thick
;
20305 /* If face has an overline, add the height of the overline
20306 (1 pixel) and a 1 pixel margin to the character height. */
20307 if (face
->overline_p
)
20310 if (it
->constrain_row_ascent_descent_p
)
20312 if (it
->ascent
> it
->max_ascent
)
20313 it
->ascent
= it
->max_ascent
;
20314 if (it
->descent
> it
->max_descent
)
20315 it
->descent
= it
->max_descent
;
20318 take_vertical_position_into_account (it
);
20320 /* If we have to actually produce glyphs, do it. */
20325 /* Translate a space with a `space-width' property
20326 into a stretch glyph. */
20327 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
20328 / FONT_HEIGHT (font
));
20329 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
20330 it
->ascent
+ it
->descent
, ascent
);
20335 /* If characters with lbearing or rbearing are displayed
20336 in this line, record that fact in a flag of the
20337 glyph row. This is used to optimize X output code. */
20338 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
20339 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
20342 else if (it
->char_to_display
== '\n')
20344 /* A newline has no width but we need the height of the line.
20345 But if previous part of the line set a height, don't
20346 increase that height */
20348 Lisp_Object height
;
20349 Lisp_Object total_height
= Qnil
;
20351 it
->override_ascent
= -1;
20352 it
->pixel_width
= 0;
20355 height
= get_line_height_property(it
, Qline_height
);
20356 /* Split (line-height total-height) list */
20358 && CONSP (XCDR (height
))
20359 && NILP (XCDR (XCDR (height
))))
20361 total_height
= XCAR (XCDR (height
));
20362 height
= XCAR (height
);
20364 height
= calc_line_height_property(it
, height
, font
, boff
, 1);
20366 if (it
->override_ascent
>= 0)
20368 it
->ascent
= it
->override_ascent
;
20369 it
->descent
= it
->override_descent
;
20370 boff
= it
->override_boff
;
20374 it
->ascent
= FONT_BASE (font
) + boff
;
20375 it
->descent
= FONT_DESCENT (font
) - boff
;
20378 if (EQ (height
, Qt
))
20380 if (it
->descent
> it
->max_descent
)
20382 it
->ascent
+= it
->descent
- it
->max_descent
;
20383 it
->descent
= it
->max_descent
;
20385 if (it
->ascent
> it
->max_ascent
)
20387 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
20388 it
->ascent
= it
->max_ascent
;
20390 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
20391 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
20392 it
->constrain_row_ascent_descent_p
= 1;
20393 extra_line_spacing
= 0;
20397 Lisp_Object spacing
;
20399 it
->phys_ascent
= it
->ascent
;
20400 it
->phys_descent
= it
->descent
;
20402 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
20403 && face
->box
!= FACE_NO_BOX
20404 && face
->box_line_width
> 0)
20406 it
->ascent
+= face
->box_line_width
;
20407 it
->descent
+= face
->box_line_width
;
20410 && XINT (height
) > it
->ascent
+ it
->descent
)
20411 it
->ascent
= XINT (height
) - it
->descent
;
20413 if (!NILP (total_height
))
20414 spacing
= calc_line_height_property(it
, total_height
, font
, boff
, 0);
20417 spacing
= get_line_height_property(it
, Qline_spacing
);
20418 spacing
= calc_line_height_property(it
, spacing
, font
, boff
, 0);
20420 if (INTEGERP (spacing
))
20422 extra_line_spacing
= XINT (spacing
);
20423 if (!NILP (total_height
))
20424 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
20428 else if (it
->char_to_display
== '\t')
20430 int tab_width
= it
->tab_width
* FRAME_SPACE_WIDTH (it
->f
);
20431 int x
= it
->current_x
+ it
->continuation_lines_width
;
20432 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
20434 /* If the distance from the current position to the next tab
20435 stop is less than a space character width, use the
20436 tab stop after that. */
20437 if (next_tab_x
- x
< FRAME_SPACE_WIDTH (it
->f
))
20438 next_tab_x
+= tab_width
;
20440 it
->pixel_width
= next_tab_x
- x
;
20442 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
20443 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
20447 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
20448 it
->ascent
+ it
->descent
, it
->ascent
);
20453 /* A multi-byte character. Assume that the display width of the
20454 character is the width of the character multiplied by the
20455 width of the font. */
20457 /* If we found a font, this font should give us the right
20458 metrics. If we didn't find a font, use the frame's
20459 default font and calculate the width of the character
20460 from the charset width; this is what old redisplay code
20463 pcm
= rif
->per_char_metric (font
, &char2b
,
20464 FONT_TYPE_FOR_MULTIBYTE (font
, it
->c
));
20466 if (font_not_found_p
|| !pcm
)
20468 int charset
= CHAR_CHARSET (it
->char_to_display
);
20470 it
->glyph_not_available_p
= 1;
20471 it
->pixel_width
= (FRAME_COLUMN_WIDTH (it
->f
)
20472 * CHARSET_WIDTH (charset
));
20473 it
->phys_ascent
= FONT_BASE (font
) + boff
;
20474 it
->phys_descent
= FONT_DESCENT (font
) - boff
;
20478 it
->pixel_width
= pcm
->width
;
20479 it
->phys_ascent
= pcm
->ascent
+ boff
;
20480 it
->phys_descent
= pcm
->descent
- boff
;
20482 && (pcm
->lbearing
< 0
20483 || pcm
->rbearing
> pcm
->width
))
20484 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
20487 it
->ascent
= FONT_BASE (font
) + boff
;
20488 it
->descent
= FONT_DESCENT (font
) - boff
;
20489 if (face
->box
!= FACE_NO_BOX
)
20491 int thick
= face
->box_line_width
;
20495 it
->ascent
+= thick
;
20496 it
->descent
+= thick
;
20501 if (it
->start_of_box_run_p
)
20502 it
->pixel_width
+= thick
;
20503 if (it
->end_of_box_run_p
)
20504 it
->pixel_width
+= thick
;
20507 /* If face has an overline, add the height of the overline
20508 (1 pixel) and a 1 pixel margin to the character height. */
20509 if (face
->overline_p
)
20512 take_vertical_position_into_account (it
);
20517 it
->multibyte_p
= saved_multibyte_p
;
20519 else if (it
->what
== IT_COMPOSITION
)
20521 /* Note: A composition is represented as one glyph in the
20522 glyph matrix. There are no padding glyphs. */
20525 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20527 int font_not_found_p
;
20528 struct font_info
*font_info
;
20529 int boff
; /* baseline offset */
20530 struct composition
*cmp
= composition_table
[it
->cmp_id
];
20532 /* Maybe translate single-byte characters to multibyte. */
20533 it
->char_to_display
= it
->c
;
20534 if (unibyte_display_via_language_environment
20535 && SINGLE_BYTE_CHAR_P (it
->c
)
20538 && !NILP (Vnonascii_translation_table
))))
20540 it
->char_to_display
= unibyte_char_to_multibyte (it
->c
);
20543 /* Get face and font to use. Encode IT->char_to_display. */
20544 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
);
20545 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20546 get_char_face_and_encoding (it
->f
, it
->char_to_display
, it
->face_id
,
20547 &char2b
, it
->multibyte_p
, 0);
20550 /* When no suitable font found, use the default font. */
20551 font_not_found_p
= font
== NULL
;
20552 if (font_not_found_p
)
20554 font
= FRAME_FONT (it
->f
);
20555 boff
= FRAME_BASELINE_OFFSET (it
->f
);
20560 font_info
= FONT_INFO_FROM_ID (it
->f
, face
->font_info_id
);
20561 boff
= font_info
->baseline_offset
;
20562 if (font_info
->vertical_centering
)
20563 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
20566 /* There are no padding glyphs, so there is only one glyph to
20567 produce for the composition. Important is that pixel_width,
20568 ascent and descent are the values of what is drawn by
20569 draw_glyphs (i.e. the values of the overall glyphs composed). */
20572 /* If we have not yet calculated pixel size data of glyphs of
20573 the composition for the current face font, calculate them
20574 now. Theoretically, we have to check all fonts for the
20575 glyphs, but that requires much time and memory space. So,
20576 here we check only the font of the first glyph. This leads
20577 to incorrect display very rarely, and C-l (recenter) can
20578 correct the display anyway. */
20579 if (cmp
->font
!= (void *) font
)
20581 /* Ascent and descent of the font of the first character of
20582 this composition (adjusted by baseline offset). Ascent
20583 and descent of overall glyphs should not be less than
20584 them respectively. */
20585 int font_ascent
= FONT_BASE (font
) + boff
;
20586 int font_descent
= FONT_DESCENT (font
) - boff
;
20587 /* Bounding box of the overall glyphs. */
20588 int leftmost
, rightmost
, lowest
, highest
;
20589 int i
, width
, ascent
, descent
;
20591 cmp
->font
= (void *) font
;
20593 /* Initialize the bounding box. */
20595 && (pcm
= rif
->per_char_metric (font
, &char2b
,
20596 FONT_TYPE_FOR_MULTIBYTE (font
, it
->c
))))
20598 width
= pcm
->width
;
20599 ascent
= pcm
->ascent
;
20600 descent
= pcm
->descent
;
20604 width
= FONT_WIDTH (font
);
20605 ascent
= FONT_BASE (font
);
20606 descent
= FONT_DESCENT (font
);
20610 lowest
= - descent
+ boff
;
20611 highest
= ascent
+ boff
;
20615 && font_info
->default_ascent
20616 && CHAR_TABLE_P (Vuse_default_ascent
)
20617 && !NILP (Faref (Vuse_default_ascent
,
20618 make_number (it
->char_to_display
))))
20619 highest
= font_info
->default_ascent
+ boff
;
20621 /* Draw the first glyph at the normal position. It may be
20622 shifted to right later if some other glyphs are drawn at
20624 cmp
->offsets
[0] = 0;
20625 cmp
->offsets
[1] = boff
;
20627 /* Set cmp->offsets for the remaining glyphs. */
20628 for (i
= 1; i
< cmp
->glyph_len
; i
++)
20630 int left
, right
, btm
, top
;
20631 int ch
= COMPOSITION_GLYPH (cmp
, i
);
20632 int face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
);
20634 face
= FACE_FROM_ID (it
->f
, face_id
);
20635 get_char_face_and_encoding (it
->f
, ch
, face
->id
,
20636 &char2b
, it
->multibyte_p
, 0);
20640 font
= FRAME_FONT (it
->f
);
20641 boff
= FRAME_BASELINE_OFFSET (it
->f
);
20647 = FONT_INFO_FROM_ID (it
->f
, face
->font_info_id
);
20648 boff
= font_info
->baseline_offset
;
20649 if (font_info
->vertical_centering
)
20650 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
20654 && (pcm
= rif
->per_char_metric (font
, &char2b
,
20655 FONT_TYPE_FOR_MULTIBYTE (font
, ch
))))
20657 width
= pcm
->width
;
20658 ascent
= pcm
->ascent
;
20659 descent
= pcm
->descent
;
20663 width
= FONT_WIDTH (font
);
20668 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
20670 /* Relative composition with or without
20671 alternate chars. */
20672 left
= (leftmost
+ rightmost
- width
) / 2;
20673 btm
= - descent
+ boff
;
20674 if (font_info
&& font_info
->relative_compose
20675 && (! CHAR_TABLE_P (Vignore_relative_composition
)
20676 || NILP (Faref (Vignore_relative_composition
,
20677 make_number (ch
)))))
20680 if (- descent
>= font_info
->relative_compose
)
20681 /* One extra pixel between two glyphs. */
20683 else if (ascent
<= 0)
20684 /* One extra pixel between two glyphs. */
20685 btm
= lowest
- 1 - ascent
- descent
;
20690 /* A composition rule is specified by an integer
20691 value that encodes global and new reference
20692 points (GREF and NREF). GREF and NREF are
20693 specified by numbers as below:
20695 0---1---2 -- ascent
20699 9--10--11 -- center
20701 ---3---4---5--- baseline
20703 6---7---8 -- descent
20705 int rule
= COMPOSITION_RULE (cmp
, i
);
20706 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
;
20708 COMPOSITION_DECODE_RULE (rule
, gref
, nref
);
20709 grefx
= gref
% 3, nrefx
= nref
% 3;
20710 grefy
= gref
/ 3, nrefy
= nref
/ 3;
20713 + grefx
* (rightmost
- leftmost
) / 2
20714 - nrefx
* width
/ 2);
20715 btm
= ((grefy
== 0 ? highest
20717 : grefy
== 2 ? lowest
20718 : (highest
+ lowest
) / 2)
20719 - (nrefy
== 0 ? ascent
+ descent
20720 : nrefy
== 1 ? descent
- boff
20722 : (ascent
+ descent
) / 2));
20725 cmp
->offsets
[i
* 2] = left
;
20726 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
20728 /* Update the bounding box of the overall glyphs. */
20729 right
= left
+ width
;
20730 top
= btm
+ descent
+ ascent
;
20731 if (left
< leftmost
)
20733 if (right
> rightmost
)
20741 /* If there are glyphs whose x-offsets are negative,
20742 shift all glyphs to the right and make all x-offsets
20746 for (i
= 0; i
< cmp
->glyph_len
; i
++)
20747 cmp
->offsets
[i
* 2] -= leftmost
;
20748 rightmost
-= leftmost
;
20751 cmp
->pixel_width
= rightmost
;
20752 cmp
->ascent
= highest
;
20753 cmp
->descent
= - lowest
;
20754 if (cmp
->ascent
< font_ascent
)
20755 cmp
->ascent
= font_ascent
;
20756 if (cmp
->descent
< font_descent
)
20757 cmp
->descent
= font_descent
;
20760 it
->pixel_width
= cmp
->pixel_width
;
20761 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
20762 it
->descent
= it
->phys_descent
= cmp
->descent
;
20764 if (face
->box
!= FACE_NO_BOX
)
20766 int thick
= face
->box_line_width
;
20770 it
->ascent
+= thick
;
20771 it
->descent
+= thick
;
20776 if (it
->start_of_box_run_p
)
20777 it
->pixel_width
+= thick
;
20778 if (it
->end_of_box_run_p
)
20779 it
->pixel_width
+= thick
;
20782 /* If face has an overline, add the height of the overline
20783 (1 pixel) and a 1 pixel margin to the character height. */
20784 if (face
->overline_p
)
20787 take_vertical_position_into_account (it
);
20790 append_composite_glyph (it
);
20792 else if (it
->what
== IT_IMAGE
)
20793 produce_image_glyph (it
);
20794 else if (it
->what
== IT_STRETCH
)
20795 produce_stretch_glyph (it
);
20797 /* Accumulate dimensions. Note: can't assume that it->descent > 0
20798 because this isn't true for images with `:ascent 100'. */
20799 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
20800 if (it
->area
== TEXT_AREA
)
20801 it
->current_x
+= it
->pixel_width
;
20803 if (extra_line_spacing
> 0)
20805 it
->descent
+= extra_line_spacing
;
20806 if (extra_line_spacing
> it
->max_extra_line_spacing
)
20807 it
->max_extra_line_spacing
= extra_line_spacing
;
20810 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
20811 it
->max_descent
= max (it
->max_descent
, it
->descent
);
20812 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
20813 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
20817 Output LEN glyphs starting at START at the nominal cursor position.
20818 Advance the nominal cursor over the text. The global variable
20819 updated_window contains the window being updated, updated_row is
20820 the glyph row being updated, and updated_area is the area of that
20821 row being updated. */
20824 x_write_glyphs (start
, len
)
20825 struct glyph
*start
;
20830 xassert (updated_window
&& updated_row
);
20833 /* Write glyphs. */
20835 hpos
= start
- updated_row
->glyphs
[updated_area
];
20836 x
= draw_glyphs (updated_window
, output_cursor
.x
,
20837 updated_row
, updated_area
,
20839 DRAW_NORMAL_TEXT
, 0);
20841 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
20842 if (updated_area
== TEXT_AREA
20843 && updated_window
->phys_cursor_on_p
20844 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
20845 && updated_window
->phys_cursor
.hpos
>= hpos
20846 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
20847 updated_window
->phys_cursor_on_p
= 0;
20851 /* Advance the output cursor. */
20852 output_cursor
.hpos
+= len
;
20853 output_cursor
.x
= x
;
20858 Insert LEN glyphs from START at the nominal cursor position. */
20861 x_insert_glyphs (start
, len
)
20862 struct glyph
*start
;
20867 int line_height
, shift_by_width
, shifted_region_width
;
20868 struct glyph_row
*row
;
20869 struct glyph
*glyph
;
20870 int frame_x
, frame_y
, hpos
;
20872 xassert (updated_window
&& updated_row
);
20874 w
= updated_window
;
20875 f
= XFRAME (WINDOW_FRAME (w
));
20877 /* Get the height of the line we are in. */
20879 line_height
= row
->height
;
20881 /* Get the width of the glyphs to insert. */
20882 shift_by_width
= 0;
20883 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
20884 shift_by_width
+= glyph
->pixel_width
;
20886 /* Get the width of the region to shift right. */
20887 shifted_region_width
= (window_box_width (w
, updated_area
)
20892 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
20893 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
20895 rif
->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
20896 line_height
, shift_by_width
);
20898 /* Write the glyphs. */
20899 hpos
= start
- row
->glyphs
[updated_area
];
20900 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
20902 DRAW_NORMAL_TEXT
, 0);
20904 /* Advance the output cursor. */
20905 output_cursor
.hpos
+= len
;
20906 output_cursor
.x
+= shift_by_width
;
20912 Erase the current text line from the nominal cursor position
20913 (inclusive) to pixel column TO_X (exclusive). The idea is that
20914 everything from TO_X onward is already erased.
20916 TO_X is a pixel position relative to updated_area of
20917 updated_window. TO_X == -1 means clear to the end of this area. */
20920 x_clear_end_of_line (to_x
)
20924 struct window
*w
= updated_window
;
20925 int max_x
, min_y
, max_y
;
20926 int from_x
, from_y
, to_y
;
20928 xassert (updated_window
&& updated_row
);
20929 f
= XFRAME (w
->frame
);
20931 if (updated_row
->full_width_p
)
20932 max_x
= WINDOW_TOTAL_WIDTH (w
);
20934 max_x
= window_box_width (w
, updated_area
);
20935 max_y
= window_text_bottom_y (w
);
20937 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
20938 of window. For TO_X > 0, truncate to end of drawing area. */
20944 to_x
= min (to_x
, max_x
);
20946 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
20948 /* Notice if the cursor will be cleared by this operation. */
20949 if (!updated_row
->full_width_p
)
20950 notice_overwritten_cursor (w
, updated_area
,
20951 output_cursor
.x
, -1,
20953 MATRIX_ROW_BOTTOM_Y (updated_row
));
20955 from_x
= output_cursor
.x
;
20957 /* Translate to frame coordinates. */
20958 if (updated_row
->full_width_p
)
20960 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
20961 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
20965 int area_left
= window_box_left (w
, updated_area
);
20966 from_x
+= area_left
;
20970 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
20971 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
20972 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
20974 /* Prevent inadvertently clearing to end of the X window. */
20975 if (to_x
> from_x
&& to_y
> from_y
)
20978 rif
->clear_frame_area (f
, from_x
, from_y
,
20979 to_x
- from_x
, to_y
- from_y
);
20984 #endif /* HAVE_WINDOW_SYSTEM */
20988 /***********************************************************************
20990 ***********************************************************************/
20992 /* Value is the internal representation of the specified cursor type
20993 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
20994 of the bar cursor. */
20996 static enum text_cursor_kinds
20997 get_specified_cursor_type (arg
, width
)
21001 enum text_cursor_kinds type
;
21006 if (EQ (arg
, Qbox
))
21007 return FILLED_BOX_CURSOR
;
21009 if (EQ (arg
, Qhollow
))
21010 return HOLLOW_BOX_CURSOR
;
21012 if (EQ (arg
, Qbar
))
21019 && EQ (XCAR (arg
), Qbar
)
21020 && INTEGERP (XCDR (arg
))
21021 && XINT (XCDR (arg
)) >= 0)
21023 *width
= XINT (XCDR (arg
));
21027 if (EQ (arg
, Qhbar
))
21030 return HBAR_CURSOR
;
21034 && EQ (XCAR (arg
), Qhbar
)
21035 && INTEGERP (XCDR (arg
))
21036 && XINT (XCDR (arg
)) >= 0)
21038 *width
= XINT (XCDR (arg
));
21039 return HBAR_CURSOR
;
21042 /* Treat anything unknown as "hollow box cursor".
21043 It was bad to signal an error; people have trouble fixing
21044 .Xdefaults with Emacs, when it has something bad in it. */
21045 type
= HOLLOW_BOX_CURSOR
;
21050 /* Set the default cursor types for specified frame. */
21052 set_frame_cursor_types (f
, arg
)
21059 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
21060 FRAME_CURSOR_WIDTH (f
) = width
;
21062 /* By default, set up the blink-off state depending on the on-state. */
21064 tem
= Fassoc (arg
, Vblink_cursor_alist
);
21067 FRAME_BLINK_OFF_CURSOR (f
)
21068 = get_specified_cursor_type (XCDR (tem
), &width
);
21069 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
21072 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
21076 /* Return the cursor we want to be displayed in window W. Return
21077 width of bar/hbar cursor through WIDTH arg. Return with
21078 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
21079 (i.e. if the `system caret' should track this cursor).
21081 In a mini-buffer window, we want the cursor only to appear if we
21082 are reading input from this window. For the selected window, we
21083 want the cursor type given by the frame parameter or buffer local
21084 setting of cursor-type. If explicitly marked off, draw no cursor.
21085 In all other cases, we want a hollow box cursor. */
21087 static enum text_cursor_kinds
21088 get_window_cursor_type (w
, glyph
, width
, active_cursor
)
21090 struct glyph
*glyph
;
21092 int *active_cursor
;
21094 struct frame
*f
= XFRAME (w
->frame
);
21095 struct buffer
*b
= XBUFFER (w
->buffer
);
21096 int cursor_type
= DEFAULT_CURSOR
;
21097 Lisp_Object alt_cursor
;
21098 int non_selected
= 0;
21100 *active_cursor
= 1;
21103 if (cursor_in_echo_area
21104 && FRAME_HAS_MINIBUF_P (f
)
21105 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
21107 if (w
== XWINDOW (echo_area_window
))
21109 if (EQ (b
->cursor_type
, Qt
) || NILP (b
->cursor_type
))
21111 *width
= FRAME_CURSOR_WIDTH (f
);
21112 return FRAME_DESIRED_CURSOR (f
);
21115 return get_specified_cursor_type (b
->cursor_type
, width
);
21118 *active_cursor
= 0;
21122 /* Nonselected window or nonselected frame. */
21123 else if (w
!= XWINDOW (f
->selected_window
)
21124 #ifdef HAVE_WINDOW_SYSTEM
21125 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
21129 *active_cursor
= 0;
21131 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
21137 /* Never display a cursor in a window in which cursor-type is nil. */
21138 if (NILP (b
->cursor_type
))
21141 /* Use cursor-in-non-selected-windows for non-selected window or frame. */
21144 alt_cursor
= b
->cursor_in_non_selected_windows
;
21145 return get_specified_cursor_type (alt_cursor
, width
);
21148 /* Get the normal cursor type for this window. */
21149 if (EQ (b
->cursor_type
, Qt
))
21151 cursor_type
= FRAME_DESIRED_CURSOR (f
);
21152 *width
= FRAME_CURSOR_WIDTH (f
);
21155 cursor_type
= get_specified_cursor_type (b
->cursor_type
, width
);
21157 /* Use normal cursor if not blinked off. */
21158 if (!w
->cursor_off_p
)
21160 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
) {
21161 if (cursor_type
== FILLED_BOX_CURSOR
)
21162 cursor_type
= HOLLOW_BOX_CURSOR
;
21164 return cursor_type
;
21167 /* Cursor is blinked off, so determine how to "toggle" it. */
21169 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
21170 if ((alt_cursor
= Fassoc (b
->cursor_type
, Vblink_cursor_alist
), !NILP (alt_cursor
)))
21171 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
21173 /* Then see if frame has specified a specific blink off cursor type. */
21174 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
21176 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
21177 return FRAME_BLINK_OFF_CURSOR (f
);
21181 /* Some people liked having a permanently visible blinking cursor,
21182 while others had very strong opinions against it. So it was
21183 decided to remove it. KFS 2003-09-03 */
21185 /* Finally perform built-in cursor blinking:
21186 filled box <-> hollow box
21187 wide [h]bar <-> narrow [h]bar
21188 narrow [h]bar <-> no cursor
21189 other type <-> no cursor */
21191 if (cursor_type
== FILLED_BOX_CURSOR
)
21192 return HOLLOW_BOX_CURSOR
;
21194 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
21197 return cursor_type
;
21205 #ifdef HAVE_WINDOW_SYSTEM
21207 /* Notice when the text cursor of window W has been completely
21208 overwritten by a drawing operation that outputs glyphs in AREA
21209 starting at X0 and ending at X1 in the line starting at Y0 and
21210 ending at Y1. X coordinates are area-relative. X1 < 0 means all
21211 the rest of the line after X0 has been written. Y coordinates
21212 are window-relative. */
21215 notice_overwritten_cursor (w
, area
, x0
, x1
, y0
, y1
)
21217 enum glyph_row_area area
;
21218 int x0
, y0
, x1
, y1
;
21220 int cx0
, cx1
, cy0
, cy1
;
21221 struct glyph_row
*row
;
21223 if (!w
->phys_cursor_on_p
)
21225 if (area
!= TEXT_AREA
)
21228 if (w
->phys_cursor
.vpos
< 0
21229 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
21230 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
21231 !(row
->enabled_p
&& row
->displays_text_p
)))
21234 if (row
->cursor_in_fringe_p
)
21236 row
->cursor_in_fringe_p
= 0;
21237 draw_fringe_bitmap (w
, row
, 0);
21238 w
->phys_cursor_on_p
= 0;
21242 cx0
= w
->phys_cursor
.x
;
21243 cx1
= cx0
+ w
->phys_cursor_width
;
21244 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
21247 /* The cursor image will be completely removed from the
21248 screen if the output area intersects the cursor area in
21249 y-direction. When we draw in [y0 y1[, and some part of
21250 the cursor is at y < y0, that part must have been drawn
21251 before. When scrolling, the cursor is erased before
21252 actually scrolling, so we don't come here. When not
21253 scrolling, the rows above the old cursor row must have
21254 changed, and in this case these rows must have written
21255 over the cursor image.
21257 Likewise if part of the cursor is below y1, with the
21258 exception of the cursor being in the first blank row at
21259 the buffer and window end because update_text_area
21260 doesn't draw that row. (Except when it does, but
21261 that's handled in update_text_area.) */
21263 cy0
= w
->phys_cursor
.y
;
21264 cy1
= cy0
+ w
->phys_cursor_height
;
21265 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
21268 w
->phys_cursor_on_p
= 0;
21271 #endif /* HAVE_WINDOW_SYSTEM */
21274 /************************************************************************
21276 ************************************************************************/
21278 #ifdef HAVE_WINDOW_SYSTEM
21281 Fix the display of area AREA of overlapping row ROW in window W
21282 with respect to the overlapping part OVERLAPS. */
21285 x_fix_overlapping_area (w
, row
, area
, overlaps
)
21287 struct glyph_row
*row
;
21288 enum glyph_row_area area
;
21296 for (i
= 0; i
< row
->used
[area
];)
21298 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
21300 int start
= i
, start_x
= x
;
21304 x
+= row
->glyphs
[area
][i
].pixel_width
;
21307 while (i
< row
->used
[area
]
21308 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
21310 draw_glyphs (w
, start_x
, row
, area
,
21312 DRAW_NORMAL_TEXT
, overlaps
);
21316 x
+= row
->glyphs
[area
][i
].pixel_width
;
21326 Draw the cursor glyph of window W in glyph row ROW. See the
21327 comment of draw_glyphs for the meaning of HL. */
21330 draw_phys_cursor_glyph (w
, row
, hl
)
21332 struct glyph_row
*row
;
21333 enum draw_glyphs_face hl
;
21335 /* If cursor hpos is out of bounds, don't draw garbage. This can
21336 happen in mini-buffer windows when switching between echo area
21337 glyphs and mini-buffer. */
21338 if (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])
21340 int on_p
= w
->phys_cursor_on_p
;
21342 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
21343 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
21345 w
->phys_cursor_on_p
= on_p
;
21347 if (hl
== DRAW_CURSOR
)
21348 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
21349 /* When we erase the cursor, and ROW is overlapped by other
21350 rows, make sure that these overlapping parts of other rows
21352 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
21354 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
21356 if (row
> w
->current_matrix
->rows
21357 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
21358 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
21359 OVERLAPS_ERASED_CURSOR
);
21361 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
21362 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
21363 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
21364 OVERLAPS_ERASED_CURSOR
);
21371 Erase the image of a cursor of window W from the screen. */
21374 erase_phys_cursor (w
)
21377 struct frame
*f
= XFRAME (w
->frame
);
21378 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
21379 int hpos
= w
->phys_cursor
.hpos
;
21380 int vpos
= w
->phys_cursor
.vpos
;
21381 int mouse_face_here_p
= 0;
21382 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
21383 struct glyph_row
*cursor_row
;
21384 struct glyph
*cursor_glyph
;
21385 enum draw_glyphs_face hl
;
21387 /* No cursor displayed or row invalidated => nothing to do on the
21389 if (w
->phys_cursor_type
== NO_CURSOR
)
21390 goto mark_cursor_off
;
21392 /* VPOS >= active_glyphs->nrows means that window has been resized.
21393 Don't bother to erase the cursor. */
21394 if (vpos
>= active_glyphs
->nrows
)
21395 goto mark_cursor_off
;
21397 /* If row containing cursor is marked invalid, there is nothing we
21399 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
21400 if (!cursor_row
->enabled_p
)
21401 goto mark_cursor_off
;
21403 /* If line spacing is > 0, old cursor may only be partially visible in
21404 window after split-window. So adjust visible height. */
21405 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
21406 window_text_bottom_y (w
) - cursor_row
->y
);
21408 /* If row is completely invisible, don't attempt to delete a cursor which
21409 isn't there. This can happen if cursor is at top of a window, and
21410 we switch to a buffer with a header line in that window. */
21411 if (cursor_row
->visible_height
<= 0)
21412 goto mark_cursor_off
;
21414 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
21415 if (cursor_row
->cursor_in_fringe_p
)
21417 cursor_row
->cursor_in_fringe_p
= 0;
21418 draw_fringe_bitmap (w
, cursor_row
, 0);
21419 goto mark_cursor_off
;
21422 /* This can happen when the new row is shorter than the old one.
21423 In this case, either draw_glyphs or clear_end_of_line
21424 should have cleared the cursor. Note that we wouldn't be
21425 able to erase the cursor in this case because we don't have a
21426 cursor glyph at hand. */
21427 if (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])
21428 goto mark_cursor_off
;
21430 /* If the cursor is in the mouse face area, redisplay that when
21431 we clear the cursor. */
21432 if (! NILP (dpyinfo
->mouse_face_window
)
21433 && w
== XWINDOW (dpyinfo
->mouse_face_window
)
21434 && (vpos
> dpyinfo
->mouse_face_beg_row
21435 || (vpos
== dpyinfo
->mouse_face_beg_row
21436 && hpos
>= dpyinfo
->mouse_face_beg_col
))
21437 && (vpos
< dpyinfo
->mouse_face_end_row
21438 || (vpos
== dpyinfo
->mouse_face_end_row
21439 && hpos
< dpyinfo
->mouse_face_end_col
))
21440 /* Don't redraw the cursor's spot in mouse face if it is at the
21441 end of a line (on a newline). The cursor appears there, but
21442 mouse highlighting does not. */
21443 && cursor_row
->used
[TEXT_AREA
] > hpos
)
21444 mouse_face_here_p
= 1;
21446 /* Maybe clear the display under the cursor. */
21447 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
21450 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
21453 cursor_glyph
= get_phys_cursor_glyph (w
);
21454 if (cursor_glyph
== NULL
)
21455 goto mark_cursor_off
;
21457 width
= cursor_glyph
->pixel_width
;
21458 left_x
= window_box_left_offset (w
, TEXT_AREA
);
21459 x
= w
->phys_cursor
.x
;
21461 width
-= left_x
- x
;
21462 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
21463 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
21464 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
21467 rif
->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
21470 /* Erase the cursor by redrawing the character underneath it. */
21471 if (mouse_face_here_p
)
21472 hl
= DRAW_MOUSE_FACE
;
21474 hl
= DRAW_NORMAL_TEXT
;
21475 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
21478 w
->phys_cursor_on_p
= 0;
21479 w
->phys_cursor_type
= NO_CURSOR
;
21484 Display or clear cursor of window W. If ON is zero, clear the
21485 cursor. If it is non-zero, display the cursor. If ON is nonzero,
21486 where to put the cursor is specified by HPOS, VPOS, X and Y. */
21489 display_and_set_cursor (w
, on
, hpos
, vpos
, x
, y
)
21491 int on
, hpos
, vpos
, x
, y
;
21493 struct frame
*f
= XFRAME (w
->frame
);
21494 int new_cursor_type
;
21495 int new_cursor_width
;
21497 struct glyph_row
*glyph_row
;
21498 struct glyph
*glyph
;
21500 /* This is pointless on invisible frames, and dangerous on garbaged
21501 windows and frames; in the latter case, the frame or window may
21502 be in the midst of changing its size, and x and y may be off the
21504 if (! FRAME_VISIBLE_P (f
)
21505 || FRAME_GARBAGED_P (f
)
21506 || vpos
>= w
->current_matrix
->nrows
21507 || hpos
>= w
->current_matrix
->matrix_w
)
21510 /* If cursor is off and we want it off, return quickly. */
21511 if (!on
&& !w
->phys_cursor_on_p
)
21514 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
21515 /* If cursor row is not enabled, we don't really know where to
21516 display the cursor. */
21517 if (!glyph_row
->enabled_p
)
21519 w
->phys_cursor_on_p
= 0;
21524 if (!glyph_row
->exact_window_width_line_p
21525 || hpos
< glyph_row
->used
[TEXT_AREA
])
21526 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
21528 xassert (interrupt_input_blocked
);
21530 /* Set new_cursor_type to the cursor we want to be displayed. */
21531 new_cursor_type
= get_window_cursor_type (w
, glyph
,
21532 &new_cursor_width
, &active_cursor
);
21534 /* If cursor is currently being shown and we don't want it to be or
21535 it is in the wrong place, or the cursor type is not what we want,
21537 if (w
->phys_cursor_on_p
21539 || w
->phys_cursor
.x
!= x
21540 || w
->phys_cursor
.y
!= y
21541 || new_cursor_type
!= w
->phys_cursor_type
21542 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
21543 && new_cursor_width
!= w
->phys_cursor_width
)))
21544 erase_phys_cursor (w
);
21546 /* Don't check phys_cursor_on_p here because that flag is only set
21547 to zero in some cases where we know that the cursor has been
21548 completely erased, to avoid the extra work of erasing the cursor
21549 twice. In other words, phys_cursor_on_p can be 1 and the cursor
21550 still not be visible, or it has only been partly erased. */
21553 w
->phys_cursor_ascent
= glyph_row
->ascent
;
21554 w
->phys_cursor_height
= glyph_row
->height
;
21556 /* Set phys_cursor_.* before x_draw_.* is called because some
21557 of them may need the information. */
21558 w
->phys_cursor
.x
= x
;
21559 w
->phys_cursor
.y
= glyph_row
->y
;
21560 w
->phys_cursor
.hpos
= hpos
;
21561 w
->phys_cursor
.vpos
= vpos
;
21564 rif
->draw_window_cursor (w
, glyph_row
, x
, y
,
21565 new_cursor_type
, new_cursor_width
,
21566 on
, active_cursor
);
21570 /* Switch the display of W's cursor on or off, according to the value
21574 update_window_cursor (w
, on
)
21578 /* Don't update cursor in windows whose frame is in the process
21579 of being deleted. */
21580 if (w
->current_matrix
)
21583 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
21584 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
21590 /* Call update_window_cursor with parameter ON_P on all leaf windows
21591 in the window tree rooted at W. */
21594 update_cursor_in_window_tree (w
, on_p
)
21600 if (!NILP (w
->hchild
))
21601 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
21602 else if (!NILP (w
->vchild
))
21603 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
21605 update_window_cursor (w
, on_p
);
21607 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
21613 Display the cursor on window W, or clear it, according to ON_P.
21614 Don't change the cursor's position. */
21617 x_update_cursor (f
, on_p
)
21621 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
21626 Clear the cursor of window W to background color, and mark the
21627 cursor as not shown. This is used when the text where the cursor
21628 is is about to be rewritten. */
21634 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
21635 update_window_cursor (w
, 0);
21640 Display the active region described by mouse_face_* according to DRAW. */
21643 show_mouse_face (dpyinfo
, draw
)
21644 Display_Info
*dpyinfo
;
21645 enum draw_glyphs_face draw
;
21647 struct window
*w
= XWINDOW (dpyinfo
->mouse_face_window
);
21648 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21650 if (/* If window is in the process of being destroyed, don't bother
21652 w
->current_matrix
!= NULL
21653 /* Don't update mouse highlight if hidden */
21654 && (draw
!= DRAW_MOUSE_FACE
|| !dpyinfo
->mouse_face_hidden
)
21655 /* Recognize when we are called to operate on rows that don't exist
21656 anymore. This can happen when a window is split. */
21657 && dpyinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
21659 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
21660 struct glyph_row
*row
, *first
, *last
;
21662 first
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
21663 last
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
21665 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
21667 int start_hpos
, end_hpos
, start_x
;
21669 /* For all but the first row, the highlight starts at column 0. */
21672 start_hpos
= dpyinfo
->mouse_face_beg_col
;
21673 start_x
= dpyinfo
->mouse_face_beg_x
;
21682 end_hpos
= dpyinfo
->mouse_face_end_col
;
21685 end_hpos
= row
->used
[TEXT_AREA
];
21686 if (draw
== DRAW_NORMAL_TEXT
)
21687 row
->fill_line_p
= 1; /* Clear to end of line */
21690 if (end_hpos
> start_hpos
)
21692 draw_glyphs (w
, start_x
, row
, TEXT_AREA
,
21693 start_hpos
, end_hpos
,
21697 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
21701 /* When we've written over the cursor, arrange for it to
21702 be displayed again. */
21703 if (phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
21706 display_and_set_cursor (w
, 1,
21707 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
21708 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
21713 /* Change the mouse cursor. */
21714 if (draw
== DRAW_NORMAL_TEXT
)
21715 rif
->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
21716 else if (draw
== DRAW_MOUSE_FACE
)
21717 rif
->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
21719 rif
->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
21723 Clear out the mouse-highlighted active region.
21724 Redraw it un-highlighted first. Value is non-zero if mouse
21725 face was actually drawn unhighlighted. */
21728 clear_mouse_face (dpyinfo
)
21729 Display_Info
*dpyinfo
;
21733 if (!dpyinfo
->mouse_face_hidden
&& !NILP (dpyinfo
->mouse_face_window
))
21735 show_mouse_face (dpyinfo
, DRAW_NORMAL_TEXT
);
21739 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
21740 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
21741 dpyinfo
->mouse_face_window
= Qnil
;
21742 dpyinfo
->mouse_face_overlay
= Qnil
;
21748 Non-zero if physical cursor of window W is within mouse face. */
21751 cursor_in_mouse_face_p (w
)
21754 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
21755 int in_mouse_face
= 0;
21757 if (WINDOWP (dpyinfo
->mouse_face_window
)
21758 && XWINDOW (dpyinfo
->mouse_face_window
) == w
)
21760 int hpos
= w
->phys_cursor
.hpos
;
21761 int vpos
= w
->phys_cursor
.vpos
;
21763 if (vpos
>= dpyinfo
->mouse_face_beg_row
21764 && vpos
<= dpyinfo
->mouse_face_end_row
21765 && (vpos
> dpyinfo
->mouse_face_beg_row
21766 || hpos
>= dpyinfo
->mouse_face_beg_col
)
21767 && (vpos
< dpyinfo
->mouse_face_end_row
21768 || hpos
< dpyinfo
->mouse_face_end_col
21769 || dpyinfo
->mouse_face_past_end
))
21773 return in_mouse_face
;
21779 /* Find the glyph matrix position of buffer position CHARPOS in window
21780 *W. HPOS, *VPOS, *X, and *Y are set to the positions found. W's
21781 current glyphs must be up to date. If CHARPOS is above window
21782 start return (0, 0, 0, 0). If CHARPOS is after end of W, return end
21783 of last line in W. In the row containing CHARPOS, stop before glyphs
21784 having STOP as object. */
21786 #if 1 /* This is a version of fast_find_position that's more correct
21787 in the presence of hscrolling, for example. I didn't install
21788 it right away because the problem fixed is minor, it failed
21789 in 20.x as well, and I think it's too risky to install
21790 so near the release of 21.1. 2001-09-25 gerd. */
21793 fast_find_position (w
, charpos
, hpos
, vpos
, x
, y
, stop
)
21796 int *hpos
, *vpos
, *x
, *y
;
21799 struct glyph_row
*row
, *first
;
21800 struct glyph
*glyph
, *end
;
21803 first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
21804 if (charpos
< MATRIX_ROW_START_CHARPOS (first
))
21809 *vpos
= MATRIX_ROW_VPOS (first
, w
->current_matrix
);
21813 row
= row_containing_pos (w
, charpos
, first
, NULL
, 0);
21816 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
21820 /* If whole rows or last part of a row came from a display overlay,
21821 row_containing_pos will skip over such rows because their end pos
21822 equals the start pos of the overlay or interval.
21824 Move back if we have a STOP object and previous row's
21825 end glyph came from STOP. */
21828 struct glyph_row
*prev
;
21829 while ((prev
= row
- 1, prev
>= first
)
21830 && MATRIX_ROW_END_CHARPOS (prev
) == charpos
21831 && prev
->used
[TEXT_AREA
] > 0)
21833 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
21834 glyph
= beg
+ prev
->used
[TEXT_AREA
];
21835 while (--glyph
>= beg
21836 && INTEGERP (glyph
->object
));
21838 || !EQ (stop
, glyph
->object
))
21846 *vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
21848 glyph
= row
->glyphs
[TEXT_AREA
];
21849 end
= glyph
+ row
->used
[TEXT_AREA
];
21851 /* Skip over glyphs not having an object at the start of the row.
21852 These are special glyphs like truncation marks on terminal
21854 if (row
->displays_text_p
)
21856 && INTEGERP (glyph
->object
)
21857 && !EQ (stop
, glyph
->object
)
21858 && glyph
->charpos
< 0)
21860 *x
+= glyph
->pixel_width
;
21865 && !INTEGERP (glyph
->object
)
21866 && !EQ (stop
, glyph
->object
)
21867 && (!BUFFERP (glyph
->object
)
21868 || glyph
->charpos
< charpos
))
21870 *x
+= glyph
->pixel_width
;
21874 *hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
21881 fast_find_position (w
, pos
, hpos
, vpos
, x
, y
, stop
)
21884 int *hpos
, *vpos
, *x
, *y
;
21889 int maybe_next_line_p
= 0;
21890 int line_start_position
;
21891 int yb
= window_text_bottom_y (w
);
21892 struct glyph_row
*row
, *best_row
;
21893 int row_vpos
, best_row_vpos
;
21896 row
= best_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
21897 row_vpos
= best_row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
21899 while (row
->y
< yb
)
21901 if (row
->used
[TEXT_AREA
])
21902 line_start_position
= row
->glyphs
[TEXT_AREA
]->charpos
;
21904 line_start_position
= 0;
21906 if (line_start_position
> pos
)
21908 /* If the position sought is the end of the buffer,
21909 don't include the blank lines at the bottom of the window. */
21910 else if (line_start_position
== pos
21911 && pos
== BUF_ZV (XBUFFER (w
->buffer
)))
21913 maybe_next_line_p
= 1;
21916 else if (line_start_position
> 0)
21919 best_row_vpos
= row_vpos
;
21922 if (row
->y
+ row
->height
>= yb
)
21929 /* Find the right column within BEST_ROW. */
21931 current_x
= best_row
->x
;
21932 for (i
= 0; i
< best_row
->used
[TEXT_AREA
]; i
++)
21934 struct glyph
*glyph
= best_row
->glyphs
[TEXT_AREA
] + i
;
21935 int charpos
= glyph
->charpos
;
21937 if (BUFFERP (glyph
->object
))
21939 if (charpos
== pos
)
21942 *vpos
= best_row_vpos
;
21947 else if (charpos
> pos
)
21950 else if (EQ (glyph
->object
, stop
))
21955 current_x
+= glyph
->pixel_width
;
21958 /* If we're looking for the end of the buffer,
21959 and we didn't find it in the line we scanned,
21960 use the start of the following line. */
21961 if (maybe_next_line_p
)
21966 current_x
= best_row
->x
;
21969 *vpos
= best_row_vpos
;
21970 *hpos
= lastcol
+ 1;
21979 /* Find the position of the glyph for position POS in OBJECT in
21980 window W's current matrix, and return in *X, *Y the pixel
21981 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
21983 RIGHT_P non-zero means return the position of the right edge of the
21984 glyph, RIGHT_P zero means return the left edge position.
21986 If no glyph for POS exists in the matrix, return the position of
21987 the glyph with the next smaller position that is in the matrix, if
21988 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
21989 exists in the matrix, return the position of the glyph with the
21990 next larger position in OBJECT.
21992 Value is non-zero if a glyph was found. */
21995 fast_find_string_pos (w
, pos
, object
, hpos
, vpos
, x
, y
, right_p
)
21998 Lisp_Object object
;
21999 int *hpos
, *vpos
, *x
, *y
;
22002 int yb
= window_text_bottom_y (w
);
22003 struct glyph_row
*r
;
22004 struct glyph
*best_glyph
= NULL
;
22005 struct glyph_row
*best_row
= NULL
;
22008 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
22009 r
->enabled_p
&& r
->y
< yb
;
22012 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
22013 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
22016 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
22017 if (EQ (g
->object
, object
))
22019 if (g
->charpos
== pos
)
22026 else if (best_glyph
== NULL
22027 || ((abs (g
->charpos
- pos
)
22028 < abs (best_glyph
->charpos
- pos
))
22031 : g
->charpos
> pos
)))
22045 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
22049 *x
+= best_glyph
->pixel_width
;
22054 *vpos
= best_row
- w
->current_matrix
->rows
;
22057 return best_glyph
!= NULL
;
22061 /* See if position X, Y is within a hot-spot of an image. */
22064 on_hot_spot_p (hot_spot
, x
, y
)
22065 Lisp_Object hot_spot
;
22068 if (!CONSP (hot_spot
))
22071 if (EQ (XCAR (hot_spot
), Qrect
))
22073 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
22074 Lisp_Object rect
= XCDR (hot_spot
);
22078 if (!CONSP (XCAR (rect
)))
22080 if (!CONSP (XCDR (rect
)))
22082 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
22084 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
22086 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
22088 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
22092 else if (EQ (XCAR (hot_spot
), Qcircle
))
22094 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
22095 Lisp_Object circ
= XCDR (hot_spot
);
22096 Lisp_Object lr
, lx0
, ly0
;
22098 && CONSP (XCAR (circ
))
22099 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
22100 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
22101 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
22103 double r
= XFLOATINT (lr
);
22104 double dx
= XINT (lx0
) - x
;
22105 double dy
= XINT (ly0
) - y
;
22106 return (dx
* dx
+ dy
* dy
<= r
* r
);
22109 else if (EQ (XCAR (hot_spot
), Qpoly
))
22111 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
22112 if (VECTORP (XCDR (hot_spot
)))
22114 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
22115 Lisp_Object
*poly
= v
->contents
;
22119 Lisp_Object lx
, ly
;
22122 /* Need an even number of coordinates, and at least 3 edges. */
22123 if (n
< 6 || n
& 1)
22126 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
22127 If count is odd, we are inside polygon. Pixels on edges
22128 may or may not be included depending on actual geometry of the
22130 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
22131 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
22133 x0
= XINT (lx
), y0
= XINT (ly
);
22134 for (i
= 0; i
< n
; i
+= 2)
22136 int x1
= x0
, y1
= y0
;
22137 if ((lx
= poly
[i
], !INTEGERP (lx
))
22138 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
22140 x0
= XINT (lx
), y0
= XINT (ly
);
22142 /* Does this segment cross the X line? */
22150 if (y
> y0
&& y
> y1
)
22152 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
22158 /* If we don't understand the format, pretend we're not in the hot-spot. */
22163 find_hot_spot (map
, x
, y
)
22167 while (CONSP (map
))
22169 if (CONSP (XCAR (map
))
22170 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
22178 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
22180 doc
: /* Lookup in image map MAP coordinates X and Y.
22181 An image map is an alist where each element has the format (AREA ID PLIST).
22182 An AREA is specified as either a rectangle, a circle, or a polygon:
22183 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
22184 pixel coordinates of the upper left and bottom right corners.
22185 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
22186 and the radius of the circle; r may be a float or integer.
22187 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
22188 vector describes one corner in the polygon.
22189 Returns the alist element for the first matching AREA in MAP. */)
22200 return find_hot_spot (map
, XINT (x
), XINT (y
));
22204 /* Display frame CURSOR, optionally using shape defined by POINTER. */
22206 define_frame_cursor1 (f
, cursor
, pointer
)
22209 Lisp_Object pointer
;
22211 /* Do not change cursor shape while dragging mouse. */
22212 if (!NILP (do_mouse_tracking
))
22215 if (!NILP (pointer
))
22217 if (EQ (pointer
, Qarrow
))
22218 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
22219 else if (EQ (pointer
, Qhand
))
22220 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
22221 else if (EQ (pointer
, Qtext
))
22222 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
22223 else if (EQ (pointer
, intern ("hdrag")))
22224 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
22225 #ifdef HAVE_X_WINDOWS
22226 else if (EQ (pointer
, intern ("vdrag")))
22227 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
22229 else if (EQ (pointer
, intern ("hourglass")))
22230 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
22231 else if (EQ (pointer
, Qmodeline
))
22232 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
22234 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
22237 if (cursor
!= No_Cursor
)
22238 rif
->define_frame_cursor (f
, cursor
);
22241 /* Take proper action when mouse has moved to the mode or header line
22242 or marginal area AREA of window W, x-position X and y-position Y.
22243 X is relative to the start of the text display area of W, so the
22244 width of bitmap areas and scroll bars must be subtracted to get a
22245 position relative to the start of the mode line. */
22248 note_mode_line_or_margin_highlight (window
, x
, y
, area
)
22249 Lisp_Object window
;
22251 enum window_part area
;
22253 struct window
*w
= XWINDOW (window
);
22254 struct frame
*f
= XFRAME (w
->frame
);
22255 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
22256 Cursor cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
22257 Lisp_Object pointer
= Qnil
;
22258 int charpos
, dx
, dy
, width
, height
;
22259 Lisp_Object string
, object
= Qnil
;
22260 Lisp_Object pos
, help
;
22262 Lisp_Object mouse_face
;
22263 int original_x_pixel
= x
;
22264 struct glyph
* glyph
= NULL
;
22265 struct glyph_row
*row
;
22267 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
22272 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
22273 &object
, &dx
, &dy
, &width
, &height
);
22275 row
= (area
== ON_MODE_LINE
22276 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
22277 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
22280 if (row
->mode_line_p
&& row
->enabled_p
)
22282 glyph
= row
->glyphs
[TEXT_AREA
];
22283 end
= glyph
+ row
->used
[TEXT_AREA
];
22285 for (x0
= original_x_pixel
;
22286 glyph
< end
&& x0
>= glyph
->pixel_width
;
22288 x0
-= glyph
->pixel_width
;
22296 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
22297 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
22298 &object
, &dx
, &dy
, &width
, &height
);
22303 if (IMAGEP (object
))
22305 Lisp_Object image_map
, hotspot
;
22306 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
22308 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
22310 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
22312 Lisp_Object area_id
, plist
;
22314 area_id
= XCAR (hotspot
);
22315 /* Could check AREA_ID to see if we enter/leave this hot-spot.
22316 If so, we could look for mouse-enter, mouse-leave
22317 properties in PLIST (and do something...). */
22318 hotspot
= XCDR (hotspot
);
22319 if (CONSP (hotspot
)
22320 && (plist
= XCAR (hotspot
), CONSP (plist
)))
22322 pointer
= Fplist_get (plist
, Qpointer
);
22323 if (NILP (pointer
))
22325 help
= Fplist_get (plist
, Qhelp_echo
);
22328 help_echo_string
= help
;
22329 /* Is this correct? ++kfs */
22330 XSETWINDOW (help_echo_window
, w
);
22331 help_echo_object
= w
->buffer
;
22332 help_echo_pos
= charpos
;
22336 if (NILP (pointer
))
22337 pointer
= Fplist_get (XCDR (object
), QCpointer
);
22340 if (STRINGP (string
))
22342 pos
= make_number (charpos
);
22343 /* If we're on a string with `help-echo' text property, arrange
22344 for the help to be displayed. This is done by setting the
22345 global variable help_echo_string to the help string. */
22348 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
22351 help_echo_string
= help
;
22352 XSETWINDOW (help_echo_window
, w
);
22353 help_echo_object
= string
;
22354 help_echo_pos
= charpos
;
22358 if (NILP (pointer
))
22359 pointer
= Fget_text_property (pos
, Qpointer
, string
);
22361 /* Change the mouse pointer according to what is under X/Y. */
22362 if (NILP (pointer
) && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
22365 map
= Fget_text_property (pos
, Qlocal_map
, string
);
22366 if (!KEYMAPP (map
))
22367 map
= Fget_text_property (pos
, Qkeymap
, string
);
22368 if (!KEYMAPP (map
))
22369 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
22372 /* Change the mouse face according to what is under X/Y. */
22373 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
22374 if (!NILP (mouse_face
)
22375 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
22380 struct glyph
* tmp_glyph
;
22384 int total_pixel_width
;
22389 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
22390 Qmouse_face
, string
, Qnil
);
22392 b
= make_number (0);
22394 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
22396 e
= make_number (SCHARS (string
));
22398 /* Calculate the position(glyph position: GPOS) of GLYPH in
22399 displayed string. GPOS is different from CHARPOS.
22401 CHARPOS is the position of glyph in internal string
22402 object. A mode line string format has structures which
22403 is converted to a flatten by emacs lisp interpreter.
22404 The internal string is an element of the structures.
22405 The displayed string is the flatten string. */
22406 for (tmp_glyph
= glyph
- 1, gpos
= 0;
22407 tmp_glyph
->charpos
>= XINT (b
);
22408 tmp_glyph
--, gpos
++)
22410 if (!EQ (tmp_glyph
->object
, glyph
->object
))
22414 /* Calculate the lenght(glyph sequence length: GSEQ_LENGTH) of
22415 displayed string holding GLYPH.
22417 GSEQ_LENGTH is different from SCHARS (STRING).
22418 SCHARS (STRING) returns the length of the internal string. */
22419 for (tmp_glyph
= glyph
, gseq_length
= gpos
;
22420 tmp_glyph
->charpos
< XINT (e
);
22421 tmp_glyph
++, gseq_length
++)
22423 if (!EQ (tmp_glyph
->object
, glyph
->object
))
22427 total_pixel_width
= 0;
22428 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
22429 total_pixel_width
+= tmp_glyph
->pixel_width
;
22431 /* Pre calculation of re-rendering position */
22433 hpos
= (area
== ON_MODE_LINE
22434 ? (w
->current_matrix
)->nrows
- 1
22437 /* If the re-rendering position is included in the last
22438 re-rendering area, we should do nothing. */
22439 if ( EQ (window
, dpyinfo
->mouse_face_window
)
22440 && dpyinfo
->mouse_face_beg_col
<= vpos
22441 && vpos
< dpyinfo
->mouse_face_end_col
22442 && dpyinfo
->mouse_face_beg_row
== hpos
)
22445 if (clear_mouse_face (dpyinfo
))
22446 cursor
= No_Cursor
;
22448 dpyinfo
->mouse_face_beg_col
= vpos
;
22449 dpyinfo
->mouse_face_beg_row
= hpos
;
22451 dpyinfo
->mouse_face_beg_x
= original_x_pixel
- (total_pixel_width
+ dx
);
22452 dpyinfo
->mouse_face_beg_y
= 0;
22454 dpyinfo
->mouse_face_end_col
= vpos
+ gseq_length
;
22455 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_beg_row
;
22457 dpyinfo
->mouse_face_end_x
= 0;
22458 dpyinfo
->mouse_face_end_y
= 0;
22460 dpyinfo
->mouse_face_past_end
= 0;
22461 dpyinfo
->mouse_face_window
= window
;
22463 dpyinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
22466 glyph
->face_id
, 1);
22467 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
22469 if (NILP (pointer
))
22472 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
22473 clear_mouse_face (dpyinfo
);
22475 define_frame_cursor1 (f
, cursor
, pointer
);
22480 Take proper action when the mouse has moved to position X, Y on
22481 frame F as regards highlighting characters that have mouse-face
22482 properties. Also de-highlighting chars where the mouse was before.
22483 X and Y can be negative or out of range. */
22486 note_mouse_highlight (f
, x
, y
)
22490 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
22491 enum window_part part
;
22492 Lisp_Object window
;
22494 Cursor cursor
= No_Cursor
;
22495 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
22498 /* When a menu is active, don't highlight because this looks odd. */
22499 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NTGUI)
22500 if (popup_activated ())
22504 if (NILP (Vmouse_highlight
)
22505 || !f
->glyphs_initialized_p
)
22508 dpyinfo
->mouse_face_mouse_x
= x
;
22509 dpyinfo
->mouse_face_mouse_y
= y
;
22510 dpyinfo
->mouse_face_mouse_frame
= f
;
22512 if (dpyinfo
->mouse_face_defer
)
22515 if (gc_in_progress
)
22517 dpyinfo
->mouse_face_deferred_gc
= 1;
22521 /* Which window is that in? */
22522 window
= window_from_coordinates (f
, x
, y
, &part
, 0, 0, 1);
22524 /* If we were displaying active text in another window, clear that.
22525 Also clear if we move out of text area in same window. */
22526 if (! EQ (window
, dpyinfo
->mouse_face_window
)
22527 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
22528 && !NILP (dpyinfo
->mouse_face_window
)))
22529 clear_mouse_face (dpyinfo
);
22531 /* Not on a window -> return. */
22532 if (!WINDOWP (window
))
22535 /* Reset help_echo_string. It will get recomputed below. */
22536 help_echo_string
= Qnil
;
22538 /* Convert to window-relative pixel coordinates. */
22539 w
= XWINDOW (window
);
22540 frame_to_window_pixel_xy (w
, &x
, &y
);
22542 /* Handle tool-bar window differently since it doesn't display a
22544 if (EQ (window
, f
->tool_bar_window
))
22546 note_tool_bar_highlight (f
, x
, y
);
22550 /* Mouse is on the mode, header line or margin? */
22551 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
22552 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
22554 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
22558 if (part
== ON_VERTICAL_BORDER
)
22560 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
22561 help_echo_string
= build_string ("drag-mouse-1: resize");
22563 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
22564 || part
== ON_SCROLL_BAR
)
22565 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
22567 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
22569 /* Are we in a window whose display is up to date?
22570 And verify the buffer's text has not changed. */
22571 b
= XBUFFER (w
->buffer
);
22572 if (part
== ON_TEXT
22573 && EQ (w
->window_end_valid
, w
->buffer
)
22574 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
22575 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
22577 int hpos
, vpos
, pos
, i
, dx
, dy
, area
;
22578 struct glyph
*glyph
;
22579 Lisp_Object object
;
22580 Lisp_Object mouse_face
= Qnil
, overlay
= Qnil
, position
;
22581 Lisp_Object
*overlay_vec
= NULL
;
22583 struct buffer
*obuf
;
22584 int obegv
, ozv
, same_region
;
22586 /* Find the glyph under X/Y. */
22587 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
22589 /* Look for :pointer property on image. */
22590 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
22592 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
22593 if (img
!= NULL
&& IMAGEP (img
->spec
))
22595 Lisp_Object image_map
, hotspot
;
22596 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
22598 && (hotspot
= find_hot_spot (image_map
,
22599 glyph
->slice
.x
+ dx
,
22600 glyph
->slice
.y
+ dy
),
22602 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
22604 Lisp_Object area_id
, plist
;
22606 area_id
= XCAR (hotspot
);
22607 /* Could check AREA_ID to see if we enter/leave this hot-spot.
22608 If so, we could look for mouse-enter, mouse-leave
22609 properties in PLIST (and do something...). */
22610 hotspot
= XCDR (hotspot
);
22611 if (CONSP (hotspot
)
22612 && (plist
= XCAR (hotspot
), CONSP (plist
)))
22614 pointer
= Fplist_get (plist
, Qpointer
);
22615 if (NILP (pointer
))
22617 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
22618 if (!NILP (help_echo_string
))
22620 help_echo_window
= window
;
22621 help_echo_object
= glyph
->object
;
22622 help_echo_pos
= glyph
->charpos
;
22626 if (NILP (pointer
))
22627 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
22631 /* Clear mouse face if X/Y not over text. */
22633 || area
!= TEXT_AREA
22634 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
)
22636 if (clear_mouse_face (dpyinfo
))
22637 cursor
= No_Cursor
;
22638 if (NILP (pointer
))
22640 if (area
!= TEXT_AREA
)
22641 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
22643 pointer
= Vvoid_text_area_pointer
;
22648 pos
= glyph
->charpos
;
22649 object
= glyph
->object
;
22650 if (!STRINGP (object
) && !BUFFERP (object
))
22653 /* If we get an out-of-range value, return now; avoid an error. */
22654 if (BUFFERP (object
) && pos
> BUF_Z (b
))
22657 /* Make the window's buffer temporarily current for
22658 overlays_at and compute_char_face. */
22659 obuf
= current_buffer
;
22660 current_buffer
= b
;
22666 /* Is this char mouse-active or does it have help-echo? */
22667 position
= make_number (pos
);
22669 if (BUFFERP (object
))
22671 /* Put all the overlays we want in a vector in overlay_vec. */
22672 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
22673 /* Sort overlays into increasing priority order. */
22674 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
22679 same_region
= (EQ (window
, dpyinfo
->mouse_face_window
)
22680 && vpos
>= dpyinfo
->mouse_face_beg_row
22681 && vpos
<= dpyinfo
->mouse_face_end_row
22682 && (vpos
> dpyinfo
->mouse_face_beg_row
22683 || hpos
>= dpyinfo
->mouse_face_beg_col
)
22684 && (vpos
< dpyinfo
->mouse_face_end_row
22685 || hpos
< dpyinfo
->mouse_face_end_col
22686 || dpyinfo
->mouse_face_past_end
));
22689 cursor
= No_Cursor
;
22691 /* Check mouse-face highlighting. */
22693 /* If there exists an overlay with mouse-face overlapping
22694 the one we are currently highlighting, we have to
22695 check if we enter the overlapping overlay, and then
22696 highlight only that. */
22697 || (OVERLAYP (dpyinfo
->mouse_face_overlay
)
22698 && mouse_face_overlay_overlaps (dpyinfo
->mouse_face_overlay
)))
22700 /* Find the highest priority overlay that has a mouse-face
22703 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
22705 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
22706 if (!NILP (mouse_face
))
22707 overlay
= overlay_vec
[i
];
22710 /* If we're actually highlighting the same overlay as
22711 before, there's no need to do that again. */
22712 if (!NILP (overlay
)
22713 && EQ (overlay
, dpyinfo
->mouse_face_overlay
))
22714 goto check_help_echo
;
22716 dpyinfo
->mouse_face_overlay
= overlay
;
22718 /* Clear the display of the old active region, if any. */
22719 if (clear_mouse_face (dpyinfo
))
22720 cursor
= No_Cursor
;
22722 /* If no overlay applies, get a text property. */
22723 if (NILP (overlay
))
22724 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
22726 /* Handle the overlay case. */
22727 if (!NILP (overlay
))
22729 /* Find the range of text around this char that
22730 should be active. */
22731 Lisp_Object before
, after
;
22734 before
= Foverlay_start (overlay
);
22735 after
= Foverlay_end (overlay
);
22736 /* Record this as the current active region. */
22737 fast_find_position (w
, XFASTINT (before
),
22738 &dpyinfo
->mouse_face_beg_col
,
22739 &dpyinfo
->mouse_face_beg_row
,
22740 &dpyinfo
->mouse_face_beg_x
,
22741 &dpyinfo
->mouse_face_beg_y
, Qnil
);
22743 dpyinfo
->mouse_face_past_end
22744 = !fast_find_position (w
, XFASTINT (after
),
22745 &dpyinfo
->mouse_face_end_col
,
22746 &dpyinfo
->mouse_face_end_row
,
22747 &dpyinfo
->mouse_face_end_x
,
22748 &dpyinfo
->mouse_face_end_y
, Qnil
);
22749 dpyinfo
->mouse_face_window
= window
;
22751 dpyinfo
->mouse_face_face_id
22752 = face_at_buffer_position (w
, pos
, 0, 0,
22754 !dpyinfo
->mouse_face_hidden
);
22756 /* Display it as active. */
22757 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
22758 cursor
= No_Cursor
;
22760 /* Handle the text property case. */
22761 else if (!NILP (mouse_face
) && BUFFERP (object
))
22763 /* Find the range of text around this char that
22764 should be active. */
22765 Lisp_Object before
, after
, beginning
, end
;
22768 beginning
= Fmarker_position (w
->start
);
22769 end
= make_number (BUF_Z (XBUFFER (object
))
22770 - XFASTINT (w
->window_end_pos
));
22772 = Fprevious_single_property_change (make_number (pos
+ 1),
22774 object
, beginning
);
22776 = Fnext_single_property_change (position
, Qmouse_face
,
22779 /* Record this as the current active region. */
22780 fast_find_position (w
, XFASTINT (before
),
22781 &dpyinfo
->mouse_face_beg_col
,
22782 &dpyinfo
->mouse_face_beg_row
,
22783 &dpyinfo
->mouse_face_beg_x
,
22784 &dpyinfo
->mouse_face_beg_y
, Qnil
);
22785 dpyinfo
->mouse_face_past_end
22786 = !fast_find_position (w
, XFASTINT (after
),
22787 &dpyinfo
->mouse_face_end_col
,
22788 &dpyinfo
->mouse_face_end_row
,
22789 &dpyinfo
->mouse_face_end_x
,
22790 &dpyinfo
->mouse_face_end_y
, Qnil
);
22791 dpyinfo
->mouse_face_window
= window
;
22793 if (BUFFERP (object
))
22794 dpyinfo
->mouse_face_face_id
22795 = face_at_buffer_position (w
, pos
, 0, 0,
22797 !dpyinfo
->mouse_face_hidden
);
22799 /* Display it as active. */
22800 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
22801 cursor
= No_Cursor
;
22803 else if (!NILP (mouse_face
) && STRINGP (object
))
22808 b
= Fprevious_single_property_change (make_number (pos
+ 1),
22811 e
= Fnext_single_property_change (position
, Qmouse_face
,
22814 b
= make_number (0);
22816 e
= make_number (SCHARS (object
) - 1);
22818 fast_find_string_pos (w
, XINT (b
), object
,
22819 &dpyinfo
->mouse_face_beg_col
,
22820 &dpyinfo
->mouse_face_beg_row
,
22821 &dpyinfo
->mouse_face_beg_x
,
22822 &dpyinfo
->mouse_face_beg_y
, 0);
22823 fast_find_string_pos (w
, XINT (e
), object
,
22824 &dpyinfo
->mouse_face_end_col
,
22825 &dpyinfo
->mouse_face_end_row
,
22826 &dpyinfo
->mouse_face_end_x
,
22827 &dpyinfo
->mouse_face_end_y
, 1);
22828 dpyinfo
->mouse_face_past_end
= 0;
22829 dpyinfo
->mouse_face_window
= window
;
22830 dpyinfo
->mouse_face_face_id
22831 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
22832 glyph
->face_id
, 1);
22833 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
22834 cursor
= No_Cursor
;
22836 else if (STRINGP (object
) && NILP (mouse_face
))
22838 /* A string which doesn't have mouse-face, but
22839 the text ``under'' it might have. */
22840 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
22841 int start
= MATRIX_ROW_START_CHARPOS (r
);
22843 pos
= string_buffer_position (w
, object
, start
);
22845 mouse_face
= get_char_property_and_overlay (make_number (pos
),
22849 if (!NILP (mouse_face
) && !NILP (overlay
))
22851 Lisp_Object before
= Foverlay_start (overlay
);
22852 Lisp_Object after
= Foverlay_end (overlay
);
22855 /* Note that we might not be able to find position
22856 BEFORE in the glyph matrix if the overlay is
22857 entirely covered by a `display' property. In
22858 this case, we overshoot. So let's stop in
22859 the glyph matrix before glyphs for OBJECT. */
22860 fast_find_position (w
, XFASTINT (before
),
22861 &dpyinfo
->mouse_face_beg_col
,
22862 &dpyinfo
->mouse_face_beg_row
,
22863 &dpyinfo
->mouse_face_beg_x
,
22864 &dpyinfo
->mouse_face_beg_y
,
22867 dpyinfo
->mouse_face_past_end
22868 = !fast_find_position (w
, XFASTINT (after
),
22869 &dpyinfo
->mouse_face_end_col
,
22870 &dpyinfo
->mouse_face_end_row
,
22871 &dpyinfo
->mouse_face_end_x
,
22872 &dpyinfo
->mouse_face_end_y
,
22874 dpyinfo
->mouse_face_window
= window
;
22875 dpyinfo
->mouse_face_face_id
22876 = face_at_buffer_position (w
, pos
, 0, 0,
22878 !dpyinfo
->mouse_face_hidden
);
22880 /* Display it as active. */
22881 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
22882 cursor
= No_Cursor
;
22889 /* Look for a `help-echo' property. */
22890 if (NILP (help_echo_string
)) {
22891 Lisp_Object help
, overlay
;
22893 /* Check overlays first. */
22894 help
= overlay
= Qnil
;
22895 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
22897 overlay
= overlay_vec
[i
];
22898 help
= Foverlay_get (overlay
, Qhelp_echo
);
22903 help_echo_string
= help
;
22904 help_echo_window
= window
;
22905 help_echo_object
= overlay
;
22906 help_echo_pos
= pos
;
22910 Lisp_Object object
= glyph
->object
;
22911 int charpos
= glyph
->charpos
;
22913 /* Try text properties. */
22914 if (STRINGP (object
)
22916 && charpos
< SCHARS (object
))
22918 help
= Fget_text_property (make_number (charpos
),
22919 Qhelp_echo
, object
);
22922 /* If the string itself doesn't specify a help-echo,
22923 see if the buffer text ``under'' it does. */
22924 struct glyph_row
*r
22925 = MATRIX_ROW (w
->current_matrix
, vpos
);
22926 int start
= MATRIX_ROW_START_CHARPOS (r
);
22927 int pos
= string_buffer_position (w
, object
, start
);
22930 help
= Fget_char_property (make_number (pos
),
22931 Qhelp_echo
, w
->buffer
);
22935 object
= w
->buffer
;
22940 else if (BUFFERP (object
)
22943 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
22948 help_echo_string
= help
;
22949 help_echo_window
= window
;
22950 help_echo_object
= object
;
22951 help_echo_pos
= charpos
;
22956 /* Look for a `pointer' property. */
22957 if (NILP (pointer
))
22959 /* Check overlays first. */
22960 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
22961 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
22963 if (NILP (pointer
))
22965 Lisp_Object object
= glyph
->object
;
22966 int charpos
= glyph
->charpos
;
22968 /* Try text properties. */
22969 if (STRINGP (object
)
22971 && charpos
< SCHARS (object
))
22973 pointer
= Fget_text_property (make_number (charpos
),
22975 if (NILP (pointer
))
22977 /* If the string itself doesn't specify a pointer,
22978 see if the buffer text ``under'' it does. */
22979 struct glyph_row
*r
22980 = MATRIX_ROW (w
->current_matrix
, vpos
);
22981 int start
= MATRIX_ROW_START_CHARPOS (r
);
22982 int pos
= string_buffer_position (w
, object
, start
);
22984 pointer
= Fget_char_property (make_number (pos
),
22985 Qpointer
, w
->buffer
);
22988 else if (BUFFERP (object
)
22991 pointer
= Fget_text_property (make_number (charpos
),
22998 current_buffer
= obuf
;
23003 define_frame_cursor1 (f
, cursor
, pointer
);
23008 Clear any mouse-face on window W. This function is part of the
23009 redisplay interface, and is called from try_window_id and similar
23010 functions to ensure the mouse-highlight is off. */
23013 x_clear_window_mouse_face (w
)
23016 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
23017 Lisp_Object window
;
23020 XSETWINDOW (window
, w
);
23021 if (EQ (window
, dpyinfo
->mouse_face_window
))
23022 clear_mouse_face (dpyinfo
);
23028 Just discard the mouse face information for frame F, if any.
23029 This is used when the size of F is changed. */
23032 cancel_mouse_face (f
)
23035 Lisp_Object window
;
23036 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
23038 window
= dpyinfo
->mouse_face_window
;
23039 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
23041 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
23042 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
23043 dpyinfo
->mouse_face_window
= Qnil
;
23048 #endif /* HAVE_WINDOW_SYSTEM */
23051 /***********************************************************************
23053 ***********************************************************************/
23055 #ifdef HAVE_WINDOW_SYSTEM
23057 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
23058 which intersects rectangle R. R is in window-relative coordinates. */
23061 expose_area (w
, row
, r
, area
)
23063 struct glyph_row
*row
;
23065 enum glyph_row_area area
;
23067 struct glyph
*first
= row
->glyphs
[area
];
23068 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
23069 struct glyph
*last
;
23070 int first_x
, start_x
, x
;
23072 if (area
== TEXT_AREA
&& row
->fill_line_p
)
23073 /* If row extends face to end of line write the whole line. */
23074 draw_glyphs (w
, 0, row
, area
,
23075 0, row
->used
[area
],
23076 DRAW_NORMAL_TEXT
, 0);
23079 /* Set START_X to the window-relative start position for drawing glyphs of
23080 AREA. The first glyph of the text area can be partially visible.
23081 The first glyphs of other areas cannot. */
23082 start_x
= window_box_left_offset (w
, area
);
23084 if (area
== TEXT_AREA
)
23087 /* Find the first glyph that must be redrawn. */
23089 && x
+ first
->pixel_width
< r
->x
)
23091 x
+= first
->pixel_width
;
23095 /* Find the last one. */
23099 && x
< r
->x
+ r
->width
)
23101 x
+= last
->pixel_width
;
23107 draw_glyphs (w
, first_x
- start_x
, row
, area
,
23108 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
23109 DRAW_NORMAL_TEXT
, 0);
23114 /* Redraw the parts of the glyph row ROW on window W intersecting
23115 rectangle R. R is in window-relative coordinates. Value is
23116 non-zero if mouse-face was overwritten. */
23119 expose_line (w
, row
, r
)
23121 struct glyph_row
*row
;
23124 xassert (row
->enabled_p
);
23126 if (row
->mode_line_p
|| w
->pseudo_window_p
)
23127 draw_glyphs (w
, 0, row
, TEXT_AREA
,
23128 0, row
->used
[TEXT_AREA
],
23129 DRAW_NORMAL_TEXT
, 0);
23132 if (row
->used
[LEFT_MARGIN_AREA
])
23133 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
23134 if (row
->used
[TEXT_AREA
])
23135 expose_area (w
, row
, r
, TEXT_AREA
);
23136 if (row
->used
[RIGHT_MARGIN_AREA
])
23137 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
23138 draw_row_fringe_bitmaps (w
, row
);
23141 return row
->mouse_face_p
;
23145 /* Redraw those parts of glyphs rows during expose event handling that
23146 overlap other rows. Redrawing of an exposed line writes over parts
23147 of lines overlapping that exposed line; this function fixes that.
23149 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
23150 row in W's current matrix that is exposed and overlaps other rows.
23151 LAST_OVERLAPPING_ROW is the last such row. */
23154 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
)
23156 struct glyph_row
*first_overlapping_row
;
23157 struct glyph_row
*last_overlapping_row
;
23159 struct glyph_row
*row
;
23161 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
23162 if (row
->overlapping_p
)
23164 xassert (row
->enabled_p
&& !row
->mode_line_p
);
23166 if (row
->used
[LEFT_MARGIN_AREA
])
23167 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
23169 if (row
->used
[TEXT_AREA
])
23170 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
23172 if (row
->used
[RIGHT_MARGIN_AREA
])
23173 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
23178 /* Return non-zero if W's cursor intersects rectangle R. */
23181 phys_cursor_in_rect_p (w
, r
)
23185 XRectangle cr
, result
;
23186 struct glyph
*cursor_glyph
;
23188 cursor_glyph
= get_phys_cursor_glyph (w
);
23191 /* r is relative to W's box, but w->phys_cursor.x is relative
23192 to left edge of W's TEXT area. Adjust it. */
23193 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
23194 cr
.y
= w
->phys_cursor
.y
;
23195 cr
.width
= cursor_glyph
->pixel_width
;
23196 cr
.height
= w
->phys_cursor_height
;
23197 /* ++KFS: W32 version used W32-specific IntersectRect here, but
23198 I assume the effect is the same -- and this is portable. */
23199 return x_intersect_rectangles (&cr
, r
, &result
);
23207 Draw a vertical window border to the right of window W if W doesn't
23208 have vertical scroll bars. */
23211 x_draw_vertical_border (w
)
23214 /* We could do better, if we knew what type of scroll-bar the adjacent
23215 windows (on either side) have... But we don't :-(
23216 However, I think this works ok. ++KFS 2003-04-25 */
23218 /* Redraw borders between horizontally adjacent windows. Don't
23219 do it for frames with vertical scroll bars because either the
23220 right scroll bar of a window, or the left scroll bar of its
23221 neighbor will suffice as a border. */
23222 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
23225 if (!WINDOW_RIGHTMOST_P (w
)
23226 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
23228 int x0
, x1
, y0
, y1
;
23230 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
23233 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
23236 rif
->draw_vertical_window_border (w
, x1
, y0
, y1
);
23238 else if (!WINDOW_LEFTMOST_P (w
)
23239 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
23241 int x0
, x1
, y0
, y1
;
23243 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
23246 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
23249 rif
->draw_vertical_window_border (w
, x0
, y0
, y1
);
23254 /* Redraw the part of window W intersection rectangle FR. Pixel
23255 coordinates in FR are frame-relative. Call this function with
23256 input blocked. Value is non-zero if the exposure overwrites
23260 expose_window (w
, fr
)
23264 struct frame
*f
= XFRAME (w
->frame
);
23266 int mouse_face_overwritten_p
= 0;
23268 /* If window is not yet fully initialized, do nothing. This can
23269 happen when toolkit scroll bars are used and a window is split.
23270 Reconfiguring the scroll bar will generate an expose for a newly
23272 if (w
->current_matrix
== NULL
)
23275 /* When we're currently updating the window, display and current
23276 matrix usually don't agree. Arrange for a thorough display
23278 if (w
== updated_window
)
23280 SET_FRAME_GARBAGED (f
);
23284 /* Frame-relative pixel rectangle of W. */
23285 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
23286 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
23287 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
23288 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
23290 if (x_intersect_rectangles (fr
, &wr
, &r
))
23292 int yb
= window_text_bottom_y (w
);
23293 struct glyph_row
*row
;
23294 int cursor_cleared_p
;
23295 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
23297 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
23298 r
.x
, r
.y
, r
.width
, r
.height
));
23300 /* Convert to window coordinates. */
23301 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
23302 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
23304 /* Turn off the cursor. */
23305 if (!w
->pseudo_window_p
23306 && phys_cursor_in_rect_p (w
, &r
))
23308 x_clear_cursor (w
);
23309 cursor_cleared_p
= 1;
23312 cursor_cleared_p
= 0;
23314 /* Update lines intersecting rectangle R. */
23315 first_overlapping_row
= last_overlapping_row
= NULL
;
23316 for (row
= w
->current_matrix
->rows
;
23321 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
23323 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
23324 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
23325 || (r
.y
>= y0
&& r
.y
< y1
)
23326 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
23328 /* A header line may be overlapping, but there is no need
23329 to fix overlapping areas for them. KFS 2005-02-12 */
23330 if (row
->overlapping_p
&& !row
->mode_line_p
)
23332 if (first_overlapping_row
== NULL
)
23333 first_overlapping_row
= row
;
23334 last_overlapping_row
= row
;
23337 if (expose_line (w
, row
, &r
))
23338 mouse_face_overwritten_p
= 1;
23345 /* Display the mode line if there is one. */
23346 if (WINDOW_WANTS_MODELINE_P (w
)
23347 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
23349 && row
->y
< r
.y
+ r
.height
)
23351 if (expose_line (w
, row
, &r
))
23352 mouse_face_overwritten_p
= 1;
23355 if (!w
->pseudo_window_p
)
23357 /* Fix the display of overlapping rows. */
23358 if (first_overlapping_row
)
23359 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
);
23361 /* Draw border between windows. */
23362 x_draw_vertical_border (w
);
23364 /* Turn the cursor on again. */
23365 if (cursor_cleared_p
)
23366 update_window_cursor (w
, 1);
23370 return mouse_face_overwritten_p
;
23375 /* Redraw (parts) of all windows in the window tree rooted at W that
23376 intersect R. R contains frame pixel coordinates. Value is
23377 non-zero if the exposure overwrites mouse-face. */
23380 expose_window_tree (w
, r
)
23384 struct frame
*f
= XFRAME (w
->frame
);
23385 int mouse_face_overwritten_p
= 0;
23387 while (w
&& !FRAME_GARBAGED_P (f
))
23389 if (!NILP (w
->hchild
))
23390 mouse_face_overwritten_p
23391 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
23392 else if (!NILP (w
->vchild
))
23393 mouse_face_overwritten_p
23394 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
23396 mouse_face_overwritten_p
|= expose_window (w
, r
);
23398 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
23401 return mouse_face_overwritten_p
;
23406 Redisplay an exposed area of frame F. X and Y are the upper-left
23407 corner of the exposed rectangle. W and H are width and height of
23408 the exposed area. All are pixel values. W or H zero means redraw
23409 the entire frame. */
23412 expose_frame (f
, x
, y
, w
, h
)
23417 int mouse_face_overwritten_p
= 0;
23419 TRACE ((stderr
, "expose_frame "));
23421 /* No need to redraw if frame will be redrawn soon. */
23422 if (FRAME_GARBAGED_P (f
))
23424 TRACE ((stderr
, " garbaged\n"));
23428 /* If basic faces haven't been realized yet, there is no point in
23429 trying to redraw anything. This can happen when we get an expose
23430 event while Emacs is starting, e.g. by moving another window. */
23431 if (FRAME_FACE_CACHE (f
) == NULL
23432 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
23434 TRACE ((stderr
, " no faces\n"));
23438 if (w
== 0 || h
== 0)
23441 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
23442 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
23452 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
23453 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
23455 if (WINDOWP (f
->tool_bar_window
))
23456 mouse_face_overwritten_p
23457 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
23459 #ifdef HAVE_X_WINDOWS
23461 #ifndef USE_X_TOOLKIT
23462 if (WINDOWP (f
->menu_bar_window
))
23463 mouse_face_overwritten_p
23464 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
23465 #endif /* not USE_X_TOOLKIT */
23469 /* Some window managers support a focus-follows-mouse style with
23470 delayed raising of frames. Imagine a partially obscured frame,
23471 and moving the mouse into partially obscured mouse-face on that
23472 frame. The visible part of the mouse-face will be highlighted,
23473 then the WM raises the obscured frame. With at least one WM, KDE
23474 2.1, Emacs is not getting any event for the raising of the frame
23475 (even tried with SubstructureRedirectMask), only Expose events.
23476 These expose events will draw text normally, i.e. not
23477 highlighted. Which means we must redo the highlight here.
23478 Subsume it under ``we love X''. --gerd 2001-08-15 */
23479 /* Included in Windows version because Windows most likely does not
23480 do the right thing if any third party tool offers
23481 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
23482 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
23484 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
23485 if (f
== dpyinfo
->mouse_face_mouse_frame
)
23487 int x
= dpyinfo
->mouse_face_mouse_x
;
23488 int y
= dpyinfo
->mouse_face_mouse_y
;
23489 clear_mouse_face (dpyinfo
);
23490 note_mouse_highlight (f
, x
, y
);
23497 Determine the intersection of two rectangles R1 and R2. Return
23498 the intersection in *RESULT. Value is non-zero if RESULT is not
23502 x_intersect_rectangles (r1
, r2
, result
)
23503 XRectangle
*r1
, *r2
, *result
;
23505 XRectangle
*left
, *right
;
23506 XRectangle
*upper
, *lower
;
23507 int intersection_p
= 0;
23509 /* Rearrange so that R1 is the left-most rectangle. */
23511 left
= r1
, right
= r2
;
23513 left
= r2
, right
= r1
;
23515 /* X0 of the intersection is right.x0, if this is inside R1,
23516 otherwise there is no intersection. */
23517 if (right
->x
<= left
->x
+ left
->width
)
23519 result
->x
= right
->x
;
23521 /* The right end of the intersection is the minimum of the
23522 the right ends of left and right. */
23523 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
23526 /* Same game for Y. */
23528 upper
= r1
, lower
= r2
;
23530 upper
= r2
, lower
= r1
;
23532 /* The upper end of the intersection is lower.y0, if this is inside
23533 of upper. Otherwise, there is no intersection. */
23534 if (lower
->y
<= upper
->y
+ upper
->height
)
23536 result
->y
= lower
->y
;
23538 /* The lower end of the intersection is the minimum of the lower
23539 ends of upper and lower. */
23540 result
->height
= (min (lower
->y
+ lower
->height
,
23541 upper
->y
+ upper
->height
)
23543 intersection_p
= 1;
23547 return intersection_p
;
23550 #endif /* HAVE_WINDOW_SYSTEM */
23553 /***********************************************************************
23555 ***********************************************************************/
23560 Vwith_echo_area_save_vector
= Qnil
;
23561 staticpro (&Vwith_echo_area_save_vector
);
23563 Vmessage_stack
= Qnil
;
23564 staticpro (&Vmessage_stack
);
23566 Qinhibit_redisplay
= intern ("inhibit-redisplay");
23567 staticpro (&Qinhibit_redisplay
);
23569 message_dolog_marker1
= Fmake_marker ();
23570 staticpro (&message_dolog_marker1
);
23571 message_dolog_marker2
= Fmake_marker ();
23572 staticpro (&message_dolog_marker2
);
23573 message_dolog_marker3
= Fmake_marker ();
23574 staticpro (&message_dolog_marker3
);
23577 defsubr (&Sdump_frame_glyph_matrix
);
23578 defsubr (&Sdump_glyph_matrix
);
23579 defsubr (&Sdump_glyph_row
);
23580 defsubr (&Sdump_tool_bar_row
);
23581 defsubr (&Strace_redisplay
);
23582 defsubr (&Strace_to_stderr
);
23584 #ifdef HAVE_WINDOW_SYSTEM
23585 defsubr (&Stool_bar_lines_needed
);
23586 defsubr (&Slookup_image_map
);
23588 defsubr (&Sformat_mode_line
);
23590 staticpro (&Qmenu_bar_update_hook
);
23591 Qmenu_bar_update_hook
= intern ("menu-bar-update-hook");
23593 staticpro (&Qoverriding_terminal_local_map
);
23594 Qoverriding_terminal_local_map
= intern ("overriding-terminal-local-map");
23596 staticpro (&Qoverriding_local_map
);
23597 Qoverriding_local_map
= intern ("overriding-local-map");
23599 staticpro (&Qwindow_scroll_functions
);
23600 Qwindow_scroll_functions
= intern ("window-scroll-functions");
23602 staticpro (&Qredisplay_end_trigger_functions
);
23603 Qredisplay_end_trigger_functions
= intern ("redisplay-end-trigger-functions");
23605 staticpro (&Qinhibit_point_motion_hooks
);
23606 Qinhibit_point_motion_hooks
= intern ("inhibit-point-motion-hooks");
23608 QCdata
= intern (":data");
23609 staticpro (&QCdata
);
23610 Qdisplay
= intern ("display");
23611 staticpro (&Qdisplay
);
23612 Qspace_width
= intern ("space-width");
23613 staticpro (&Qspace_width
);
23614 Qraise
= intern ("raise");
23615 staticpro (&Qraise
);
23616 Qslice
= intern ("slice");
23617 staticpro (&Qslice
);
23618 Qspace
= intern ("space");
23619 staticpro (&Qspace
);
23620 Qmargin
= intern ("margin");
23621 staticpro (&Qmargin
);
23622 Qpointer
= intern ("pointer");
23623 staticpro (&Qpointer
);
23624 Qleft_margin
= intern ("left-margin");
23625 staticpro (&Qleft_margin
);
23626 Qright_margin
= intern ("right-margin");
23627 staticpro (&Qright_margin
);
23628 Qcenter
= intern ("center");
23629 staticpro (&Qcenter
);
23630 Qline_height
= intern ("line-height");
23631 staticpro (&Qline_height
);
23632 QCalign_to
= intern (":align-to");
23633 staticpro (&QCalign_to
);
23634 QCrelative_width
= intern (":relative-width");
23635 staticpro (&QCrelative_width
);
23636 QCrelative_height
= intern (":relative-height");
23637 staticpro (&QCrelative_height
);
23638 QCeval
= intern (":eval");
23639 staticpro (&QCeval
);
23640 QCpropertize
= intern (":propertize");
23641 staticpro (&QCpropertize
);
23642 QCfile
= intern (":file");
23643 staticpro (&QCfile
);
23644 Qfontified
= intern ("fontified");
23645 staticpro (&Qfontified
);
23646 Qfontification_functions
= intern ("fontification-functions");
23647 staticpro (&Qfontification_functions
);
23648 Qtrailing_whitespace
= intern ("trailing-whitespace");
23649 staticpro (&Qtrailing_whitespace
);
23650 Qescape_glyph
= intern ("escape-glyph");
23651 staticpro (&Qescape_glyph
);
23652 Qnobreak_space
= intern ("nobreak-space");
23653 staticpro (&Qnobreak_space
);
23654 Qimage
= intern ("image");
23655 staticpro (&Qimage
);
23656 QCmap
= intern (":map");
23657 staticpro (&QCmap
);
23658 QCpointer
= intern (":pointer");
23659 staticpro (&QCpointer
);
23660 Qrect
= intern ("rect");
23661 staticpro (&Qrect
);
23662 Qcircle
= intern ("circle");
23663 staticpro (&Qcircle
);
23664 Qpoly
= intern ("poly");
23665 staticpro (&Qpoly
);
23666 Qmessage_truncate_lines
= intern ("message-truncate-lines");
23667 staticpro (&Qmessage_truncate_lines
);
23668 Qgrow_only
= intern ("grow-only");
23669 staticpro (&Qgrow_only
);
23670 Qinhibit_menubar_update
= intern ("inhibit-menubar-update");
23671 staticpro (&Qinhibit_menubar_update
);
23672 Qinhibit_eval_during_redisplay
= intern ("inhibit-eval-during-redisplay");
23673 staticpro (&Qinhibit_eval_during_redisplay
);
23674 Qposition
= intern ("position");
23675 staticpro (&Qposition
);
23676 Qbuffer_position
= intern ("buffer-position");
23677 staticpro (&Qbuffer_position
);
23678 Qobject
= intern ("object");
23679 staticpro (&Qobject
);
23680 Qbar
= intern ("bar");
23682 Qhbar
= intern ("hbar");
23683 staticpro (&Qhbar
);
23684 Qbox
= intern ("box");
23686 Qhollow
= intern ("hollow");
23687 staticpro (&Qhollow
);
23688 Qhand
= intern ("hand");
23689 staticpro (&Qhand
);
23690 Qarrow
= intern ("arrow");
23691 staticpro (&Qarrow
);
23692 Qtext
= intern ("text");
23693 staticpro (&Qtext
);
23694 Qrisky_local_variable
= intern ("risky-local-variable");
23695 staticpro (&Qrisky_local_variable
);
23696 Qinhibit_free_realized_faces
= intern ("inhibit-free-realized-faces");
23697 staticpro (&Qinhibit_free_realized_faces
);
23699 list_of_error
= Fcons (Fcons (intern ("error"),
23700 Fcons (intern ("void-variable"), Qnil
)),
23702 staticpro (&list_of_error
);
23704 Qlast_arrow_position
= intern ("last-arrow-position");
23705 staticpro (&Qlast_arrow_position
);
23706 Qlast_arrow_string
= intern ("last-arrow-string");
23707 staticpro (&Qlast_arrow_string
);
23709 Qoverlay_arrow_string
= intern ("overlay-arrow-string");
23710 staticpro (&Qoverlay_arrow_string
);
23711 Qoverlay_arrow_bitmap
= intern ("overlay-arrow-bitmap");
23712 staticpro (&Qoverlay_arrow_bitmap
);
23714 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
23715 staticpro (&echo_buffer
[0]);
23716 staticpro (&echo_buffer
[1]);
23718 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
23719 staticpro (&echo_area_buffer
[0]);
23720 staticpro (&echo_area_buffer
[1]);
23722 Vmessages_buffer_name
= build_string ("*Messages*");
23723 staticpro (&Vmessages_buffer_name
);
23725 mode_line_proptrans_alist
= Qnil
;
23726 staticpro (&mode_line_proptrans_alist
);
23727 mode_line_string_list
= Qnil
;
23728 staticpro (&mode_line_string_list
);
23729 mode_line_string_face
= Qnil
;
23730 staticpro (&mode_line_string_face
);
23731 mode_line_string_face_prop
= Qnil
;
23732 staticpro (&mode_line_string_face_prop
);
23733 Vmode_line_unwind_vector
= Qnil
;
23734 staticpro (&Vmode_line_unwind_vector
);
23736 help_echo_string
= Qnil
;
23737 staticpro (&help_echo_string
);
23738 help_echo_object
= Qnil
;
23739 staticpro (&help_echo_object
);
23740 help_echo_window
= Qnil
;
23741 staticpro (&help_echo_window
);
23742 previous_help_echo_string
= Qnil
;
23743 staticpro (&previous_help_echo_string
);
23744 help_echo_pos
= -1;
23746 #ifdef HAVE_WINDOW_SYSTEM
23747 DEFVAR_BOOL ("x-stretch-cursor", &x_stretch_cursor_p
,
23748 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
23749 For example, if a block cursor is over a tab, it will be drawn as
23750 wide as that tab on the display. */);
23751 x_stretch_cursor_p
= 0;
23754 DEFVAR_LISP ("show-trailing-whitespace", &Vshow_trailing_whitespace
,
23755 doc
: /* *Non-nil means highlight trailing whitespace.
23756 The face used for trailing whitespace is `trailing-whitespace'. */);
23757 Vshow_trailing_whitespace
= Qnil
;
23759 DEFVAR_LISP ("nobreak-char-display", &Vnobreak_char_display
,
23760 doc
: /* *Control highlighting of nobreak space and soft hyphen.
23761 A value of t means highlight the character itself (for nobreak space,
23762 use face `nobreak-space').
23763 A value of nil means no highlighting.
23764 Other values mean display the escape glyph followed by an ordinary
23765 space or ordinary hyphen. */);
23766 Vnobreak_char_display
= Qt
;
23768 DEFVAR_LISP ("void-text-area-pointer", &Vvoid_text_area_pointer
,
23769 doc
: /* *The pointer shape to show in void text areas.
23770 A value of nil means to show the text pointer. Other options are `arrow',
23771 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
23772 Vvoid_text_area_pointer
= Qarrow
;
23774 DEFVAR_LISP ("inhibit-redisplay", &Vinhibit_redisplay
,
23775 doc
: /* Non-nil means don't actually do any redisplay.
23776 This is used for internal purposes. */);
23777 Vinhibit_redisplay
= Qnil
;
23779 DEFVAR_LISP ("global-mode-string", &Vglobal_mode_string
,
23780 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
23781 Vglobal_mode_string
= Qnil
;
23783 DEFVAR_LISP ("overlay-arrow-position", &Voverlay_arrow_position
,
23784 doc
: /* Marker for where to display an arrow on top of the buffer text.
23785 This must be the beginning of a line in order to work.
23786 See also `overlay-arrow-string'. */);
23787 Voverlay_arrow_position
= Qnil
;
23789 DEFVAR_LISP ("overlay-arrow-string", &Voverlay_arrow_string
,
23790 doc
: /* String to display as an arrow in non-window frames.
23791 See also `overlay-arrow-position'. */);
23792 Voverlay_arrow_string
= build_string ("=>");
23794 DEFVAR_LISP ("overlay-arrow-variable-list", &Voverlay_arrow_variable_list
,
23795 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
23796 The symbols on this list are examined during redisplay to determine
23797 where to display overlay arrows. */);
23798 Voverlay_arrow_variable_list
23799 = Fcons (intern ("overlay-arrow-position"), Qnil
);
23801 DEFVAR_INT ("scroll-step", &scroll_step
,
23802 doc
: /* *The number of lines to try scrolling a window by when point moves out.
23803 If that fails to bring point back on frame, point is centered instead.
23804 If this is zero, point is always centered after it moves off frame.
23805 If you want scrolling to always be a line at a time, you should set
23806 `scroll-conservatively' to a large value rather than set this to 1. */);
23808 DEFVAR_INT ("scroll-conservatively", &scroll_conservatively
,
23809 doc
: /* *Scroll up to this many lines, to bring point back on screen.
23810 A value of zero means to scroll the text to center point vertically
23811 in the window. */);
23812 scroll_conservatively
= 0;
23814 DEFVAR_INT ("scroll-margin", &scroll_margin
,
23815 doc
: /* *Number of lines of margin at the top and bottom of a window.
23816 Recenter the window whenever point gets within this many lines
23817 of the top or bottom of the window. */);
23820 DEFVAR_LISP ("display-pixels-per-inch", &Vdisplay_pixels_per_inch
,
23821 doc
: /* Pixels per inch value for non-window system displays.
23822 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
23823 Vdisplay_pixels_per_inch
= make_float (72.0);
23826 DEFVAR_INT ("debug-end-pos", &debug_end_pos
, doc
: /* Don't ask. */);
23829 DEFVAR_BOOL ("truncate-partial-width-windows",
23830 &truncate_partial_width_windows
,
23831 doc
: /* *Non-nil means truncate lines in all windows less than full frame wide. */);
23832 truncate_partial_width_windows
= 1;
23834 DEFVAR_BOOL ("mode-line-inverse-video", &mode_line_inverse_video
,
23835 doc
: /* nil means display the mode-line/header-line/menu-bar in the default face.
23836 Any other value means to use the appropriate face, `mode-line',
23837 `header-line', or `menu' respectively. */);
23838 mode_line_inverse_video
= 1;
23840 DEFVAR_LISP ("line-number-display-limit", &Vline_number_display_limit
,
23841 doc
: /* *Maximum buffer size for which line number should be displayed.
23842 If the buffer is bigger than this, the line number does not appear
23843 in the mode line. A value of nil means no limit. */);
23844 Vline_number_display_limit
= Qnil
;
23846 DEFVAR_INT ("line-number-display-limit-width",
23847 &line_number_display_limit_width
,
23848 doc
: /* *Maximum line width (in characters) for line number display.
23849 If the average length of the lines near point is bigger than this, then the
23850 line number may be omitted from the mode line. */);
23851 line_number_display_limit_width
= 200;
23853 DEFVAR_BOOL ("highlight-nonselected-windows", &highlight_nonselected_windows
,
23854 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
23855 highlight_nonselected_windows
= 0;
23857 DEFVAR_BOOL ("multiple-frames", &multiple_frames
,
23858 doc
: /* Non-nil if more than one frame is visible on this display.
23859 Minibuffer-only frames don't count, but iconified frames do.
23860 This variable is not guaranteed to be accurate except while processing
23861 `frame-title-format' and `icon-title-format'. */);
23863 DEFVAR_LISP ("frame-title-format", &Vframe_title_format
,
23864 doc
: /* Template for displaying the title bar of visible frames.
23865 \(Assuming the window manager supports this feature.)
23866 This variable has the same structure as `mode-line-format' (which see),
23867 and is used only on frames for which no explicit name has been set
23868 \(see `modify-frame-parameters'). */);
23870 DEFVAR_LISP ("icon-title-format", &Vicon_title_format
,
23871 doc
: /* Template for displaying the title bar of an iconified frame.
23872 \(Assuming the window manager supports this feature.)
23873 This variable has the same structure as `mode-line-format' (which see),
23874 and is used only on frames for which no explicit name has been set
23875 \(see `modify-frame-parameters'). */);
23877 = Vframe_title_format
23878 = Fcons (intern ("multiple-frames"),
23879 Fcons (build_string ("%b"),
23880 Fcons (Fcons (empty_string
,
23881 Fcons (intern ("invocation-name"),
23882 Fcons (build_string ("@"),
23883 Fcons (intern ("system-name"),
23887 DEFVAR_LISP ("message-log-max", &Vmessage_log_max
,
23888 doc
: /* Maximum number of lines to keep in the message log buffer.
23889 If nil, disable message logging. If t, log messages but don't truncate
23890 the buffer when it becomes large. */);
23891 Vmessage_log_max
= make_number (50);
23893 DEFVAR_LISP ("window-size-change-functions", &Vwindow_size_change_functions
,
23894 doc
: /* Functions called before redisplay, if window sizes have changed.
23895 The value should be a list of functions that take one argument.
23896 Just before redisplay, for each frame, if any of its windows have changed
23897 size since the last redisplay, or have been split or deleted,
23898 all the functions in the list are called, with the frame as argument. */);
23899 Vwindow_size_change_functions
= Qnil
;
23901 DEFVAR_LISP ("window-scroll-functions", &Vwindow_scroll_functions
,
23902 doc
: /* List of functions to call before redisplaying a window with scrolling.
23903 Each function is called with two arguments, the window
23904 and its new display-start position. Note that the value of `window-end'
23905 is not valid when these functions are called. */);
23906 Vwindow_scroll_functions
= Qnil
;
23908 DEFVAR_LISP ("redisplay-end-trigger-functions", &Vredisplay_end_trigger_functions
,
23909 doc
: /* Functions called when redisplay of a window reaches the end trigger.
23910 Each function is called with two arguments, the window and the end trigger value.
23911 See `set-window-redisplay-end-trigger'. */);
23912 Vredisplay_end_trigger_functions
= Qnil
;
23914 DEFVAR_BOOL ("mouse-autoselect-window", &mouse_autoselect_window
,
23915 doc
: /* *Non-nil means autoselect window with mouse pointer. */);
23916 mouse_autoselect_window
= 0;
23918 DEFVAR_BOOL ("auto-resize-tool-bars", &auto_resize_tool_bars_p
,
23919 doc
: /* *Non-nil means automatically resize tool-bars.
23920 This increases a tool-bar's height if not all tool-bar items are visible.
23921 It decreases a tool-bar's height when it would display blank lines
23923 auto_resize_tool_bars_p
= 1;
23925 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", &auto_raise_tool_bar_buttons_p
,
23926 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
23927 auto_raise_tool_bar_buttons_p
= 1;
23929 DEFVAR_BOOL ("make-cursor-line-fully-visible", &make_cursor_line_fully_visible_p
,
23930 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
23931 make_cursor_line_fully_visible_p
= 1;
23933 DEFVAR_LISP ("tool-bar-border", &Vtool_bar_border
,
23934 doc
: /* *Border below tool-bar in pixels.
23935 If an integer, use it as the height of the border.
23936 If it is one of `internal-border-width' or `border-width', use the
23937 value of the corresponding frame parameter.
23938 Otherwise, no border is added below the tool-bar. */);
23939 Vtool_bar_border
= Qinternal_border_width
;
23941 DEFVAR_LISP ("tool-bar-button-margin", &Vtool_bar_button_margin
,
23942 doc
: /* *Margin around tool-bar buttons in pixels.
23943 If an integer, use that for both horizontal and vertical margins.
23944 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
23945 HORZ specifying the horizontal margin, and VERT specifying the
23946 vertical margin. */);
23947 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
23949 DEFVAR_INT ("tool-bar-button-relief", &tool_bar_button_relief
,
23950 doc
: /* *Relief thickness of tool-bar buttons. */);
23951 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
23953 DEFVAR_LISP ("fontification-functions", &Vfontification_functions
,
23954 doc
: /* List of functions to call to fontify regions of text.
23955 Each function is called with one argument POS. Functions must
23956 fontify a region starting at POS in the current buffer, and give
23957 fontified regions the property `fontified'. */);
23958 Vfontification_functions
= Qnil
;
23959 Fmake_variable_buffer_local (Qfontification_functions
);
23961 DEFVAR_BOOL ("unibyte-display-via-language-environment",
23962 &unibyte_display_via_language_environment
,
23963 doc
: /* *Non-nil means display unibyte text according to language environment.
23964 Specifically this means that unibyte non-ASCII characters
23965 are displayed by converting them to the equivalent multibyte characters
23966 according to the current language environment. As a result, they are
23967 displayed according to the current fontset. */);
23968 unibyte_display_via_language_environment
= 0;
23970 DEFVAR_LISP ("max-mini-window-height", &Vmax_mini_window_height
,
23971 doc
: /* *Maximum height for resizing mini-windows.
23972 If a float, it specifies a fraction of the mini-window frame's height.
23973 If an integer, it specifies a number of lines. */);
23974 Vmax_mini_window_height
= make_float (0.25);
23976 DEFVAR_LISP ("resize-mini-windows", &Vresize_mini_windows
,
23977 doc
: /* *How to resize mini-windows.
23978 A value of nil means don't automatically resize mini-windows.
23979 A value of t means resize them to fit the text displayed in them.
23980 A value of `grow-only', the default, means let mini-windows grow
23981 only, until their display becomes empty, at which point the windows
23982 go back to their normal size. */);
23983 Vresize_mini_windows
= Qgrow_only
;
23985 DEFVAR_LISP ("blink-cursor-alist", &Vblink_cursor_alist
,
23986 doc
: /* Alist specifying how to blink the cursor off.
23987 Each element has the form (ON-STATE . OFF-STATE). Whenever the
23988 `cursor-type' frame-parameter or variable equals ON-STATE,
23989 comparing using `equal', Emacs uses OFF-STATE to specify
23990 how to blink it off. ON-STATE and OFF-STATE are values for
23991 the `cursor-type' frame parameter.
23993 If a frame's ON-STATE has no entry in this list,
23994 the frame's other specifications determine how to blink the cursor off. */);
23995 Vblink_cursor_alist
= Qnil
;
23997 DEFVAR_BOOL ("auto-hscroll-mode", &automatic_hscrolling_p
,
23998 doc
: /* *Non-nil means scroll the display automatically to make point visible. */);
23999 automatic_hscrolling_p
= 1;
24001 DEFVAR_INT ("hscroll-margin", &hscroll_margin
,
24002 doc
: /* *How many columns away from the window edge point is allowed to get
24003 before automatic hscrolling will horizontally scroll the window. */);
24004 hscroll_margin
= 5;
24006 DEFVAR_LISP ("hscroll-step", &Vhscroll_step
,
24007 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
24008 When point is less than `hscroll-margin' columns from the window
24009 edge, automatic hscrolling will scroll the window by the amount of columns
24010 determined by this variable. If its value is a positive integer, scroll that
24011 many columns. If it's a positive floating-point number, it specifies the
24012 fraction of the window's width to scroll. If it's nil or zero, point will be
24013 centered horizontally after the scroll. Any other value, including negative
24014 numbers, are treated as if the value were zero.
24016 Automatic hscrolling always moves point outside the scroll margin, so if
24017 point was more than scroll step columns inside the margin, the window will
24018 scroll more than the value given by the scroll step.
24020 Note that the lower bound for automatic hscrolling specified by `scroll-left'
24021 and `scroll-right' overrides this variable's effect. */);
24022 Vhscroll_step
= make_number (0);
24024 DEFVAR_BOOL ("message-truncate-lines", &message_truncate_lines
,
24025 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
24026 Bind this around calls to `message' to let it take effect. */);
24027 message_truncate_lines
= 0;
24029 DEFVAR_LISP ("menu-bar-update-hook", &Vmenu_bar_update_hook
,
24030 doc
: /* Normal hook run to update the menu bar definitions.
24031 Redisplay runs this hook before it redisplays the menu bar.
24032 This is used to update submenus such as Buffers,
24033 whose contents depend on various data. */);
24034 Vmenu_bar_update_hook
= Qnil
;
24036 DEFVAR_BOOL ("inhibit-menubar-update", &inhibit_menubar_update
,
24037 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
24038 inhibit_menubar_update
= 0;
24040 DEFVAR_BOOL ("inhibit-eval-during-redisplay", &inhibit_eval_during_redisplay
,
24041 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
24042 inhibit_eval_during_redisplay
= 0;
24044 DEFVAR_BOOL ("inhibit-free-realized-faces", &inhibit_free_realized_faces
,
24045 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
24046 inhibit_free_realized_faces
= 0;
24049 DEFVAR_BOOL ("inhibit-try-window-id", &inhibit_try_window_id
,
24050 doc
: /* Inhibit try_window_id display optimization. */);
24051 inhibit_try_window_id
= 0;
24053 DEFVAR_BOOL ("inhibit-try-window-reusing", &inhibit_try_window_reusing
,
24054 doc
: /* Inhibit try_window_reusing display optimization. */);
24055 inhibit_try_window_reusing
= 0;
24057 DEFVAR_BOOL ("inhibit-try-cursor-movement", &inhibit_try_cursor_movement
,
24058 doc
: /* Inhibit try_cursor_movement display optimization. */);
24059 inhibit_try_cursor_movement
= 0;
24060 #endif /* GLYPH_DEBUG */
24064 /* Initialize this module when Emacs starts. */
24069 Lisp_Object root_window
;
24070 struct window
*mini_w
;
24072 current_header_line_height
= current_mode_line_height
= -1;
24074 CHARPOS (this_line_start_pos
) = 0;
24076 mini_w
= XWINDOW (minibuf_window
);
24077 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
24079 if (!noninteractive
)
24081 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
24084 XWINDOW (root_window
)->top_line
= make_number (FRAME_TOP_MARGIN (f
));
24085 set_window_height (root_window
,
24086 FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
),
24088 mini_w
->top_line
= make_number (FRAME_LINES (f
) - 1);
24089 set_window_height (minibuf_window
, 1, 0);
24091 XWINDOW (root_window
)->total_cols
= make_number (FRAME_COLS (f
));
24092 mini_w
->total_cols
= make_number (FRAME_COLS (f
));
24094 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
24095 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
24096 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
24098 /* The default ellipsis glyphs `...'. */
24099 for (i
= 0; i
< 3; ++i
)
24100 default_invis_vector
[i
] = make_number ('.');
24104 /* Allocate the buffer for frame titles.
24105 Also used for `format-mode-line'. */
24107 mode_line_noprop_buf
= (char *) xmalloc (size
);
24108 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
24109 mode_line_noprop_ptr
= mode_line_noprop_buf
;
24110 mode_line_target
= MODE_LINE_DISPLAY
;
24113 help_echo_showing_p
= 0;
24117 /* arch-tag: eacc864d-bb6a-4b74-894a-1a4399a1358b
24118 (do not change this comment) */