1 /* Display generation from window structure and buffer text.
2 Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995,
3 1997, 1998, 1999, 2000, 2001, 2002, 2003,
4 2004, 2005, 2006, 2007, 2008, 2009, 2010
5 Free Software Foundation, Inc.
7 This file is part of GNU Emacs.
9 GNU Emacs is free software: you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation, either version 3 of the License, or
12 (at your option) any later version.
14 GNU Emacs is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
22 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>.
26 Emacs separates the task of updating the display from code
27 modifying global state, e.g. buffer text. This way functions
28 operating on buffers don't also have to be concerned with updating
31 Updating the display is triggered by the Lisp interpreter when it
32 decides it's time to do it. This is done either automatically for
33 you as part of the interpreter's command loop or as the result of
34 calling Lisp functions like `sit-for'. The C function `redisplay'
35 in xdisp.c is the only entry into the inner redisplay code. (Or,
36 let's say almost---see the description of direct update
39 The following diagram shows how redisplay code is invoked. As you
40 can see, Lisp calls redisplay and vice versa. Under window systems
41 like X, some portions of the redisplay code are also called
42 asynchronously during mouse movement or expose events. It is very
43 important that these code parts do NOT use the C library (malloc,
44 free) because many C libraries under Unix are not reentrant. They
45 may also NOT call functions of the Lisp interpreter which could
46 change the interpreter's state. If you don't follow these rules,
47 you will encounter bugs which are very hard to explain.
49 (Direct functions, see below)
50 direct_output_for_insert,
51 direct_forward_char (dispnew.c)
52 +---------------------------------+
55 +--------------+ redisplay +----------------+
56 | Lisp machine |---------------->| Redisplay code |<--+
57 +--------------+ (xdisp.c) +----------------+ |
59 +----------------------------------+ |
60 Don't use this path when called |
63 expose_window (asynchronous) |
65 X expose events -----+
67 What does redisplay do? Obviously, it has to figure out somehow what
68 has been changed since the last time the display has been updated,
69 and to make these changes visible. Preferably it would do that in
70 a moderately intelligent way, i.e. fast.
72 Changes in buffer text can be deduced from window and buffer
73 structures, and from some global variables like `beg_unchanged' and
74 `end_unchanged'. The contents of the display are additionally
75 recorded in a `glyph matrix', a two-dimensional matrix of glyph
76 structures. Each row in such a matrix corresponds to a line on the
77 display, and each glyph in a row corresponds to a column displaying
78 a character, an image, or what else. This matrix is called the
79 `current glyph matrix' or `current matrix' in redisplay
82 For buffer parts that have been changed since the last update, a
83 second glyph matrix is constructed, the so called `desired glyph
84 matrix' or short `desired matrix'. Current and desired matrix are
85 then compared to find a cheap way to update the display, e.g. by
86 reusing part of the display by scrolling lines.
91 You will find a lot of redisplay optimizations when you start
92 looking at the innards of redisplay. The overall goal of all these
93 optimizations is to make redisplay fast because it is done
96 Two optimizations are not found in xdisp.c. These are the direct
97 operations mentioned above. As the name suggests they follow a
98 different principle than the rest of redisplay. Instead of
99 building a desired matrix and then comparing it with the current
100 display, they perform their actions directly on the display and on
103 One direct operation updates the display after one character has
104 been entered. The other one moves the cursor by one position
105 forward or backward. You find these functions under the names
106 `direct_output_for_insert' and `direct_output_forward_char' in
112 Desired matrices are always built per Emacs window. The function
113 `display_line' is the central function to look at if you are
114 interested. It constructs one row in a desired matrix given an
115 iterator structure containing both a buffer position and a
116 description of the environment in which the text is to be
117 displayed. But this is too early, read on.
119 Characters and pixmaps displayed for a range of buffer text depend
120 on various settings of buffers and windows, on overlays and text
121 properties, on display tables, on selective display. The good news
122 is that all this hairy stuff is hidden behind a small set of
123 interface functions taking an iterator structure (struct it)
126 Iteration over things to be displayed is then simple. It is
127 started by initializing an iterator with a call to init_iterator.
128 Calls to get_next_display_element fill the iterator structure with
129 relevant information about the next thing to display. Calls to
130 set_iterator_to_next move the iterator to the next thing.
132 Besides this, an iterator also contains information about the
133 display environment in which glyphs for display elements are to be
134 produced. It has fields for the width and height of the display,
135 the information whether long lines are truncated or continued, a
136 current X and Y position, and lots of other stuff you can better
139 Glyphs in a desired matrix are normally constructed in a loop
140 calling get_next_display_element and then produce_glyphs. The call
141 to produce_glyphs will fill the iterator structure with pixel
142 information about the element being displayed and at the same time
143 produce glyphs for it. If the display element fits on the line
144 being displayed, set_iterator_to_next is called next, otherwise the
145 glyphs produced are discarded.
150 That just couldn't be all, could it? What about terminal types not
151 supporting operations on sub-windows of the screen? To update the
152 display on such a terminal, window-based glyph matrices are not
153 well suited. To be able to reuse part of the display (scrolling
154 lines up and down), we must instead have a view of the whole
155 screen. This is what `frame matrices' are for. They are a trick.
157 Frames on terminals like above have a glyph pool. Windows on such
158 a frame sub-allocate their glyph memory from their frame's glyph
159 pool. The frame itself is given its own glyph matrices. By
160 coincidence---or maybe something else---rows in window glyph
161 matrices are slices of corresponding rows in frame matrices. Thus
162 writing to window matrices implicitly updates a frame matrix which
163 provides us with the view of the whole screen that we originally
164 wanted to have without having to move many bytes around. To be
165 honest, there is a little bit more done, but not much more. If you
166 plan to extend that code, take a look at dispnew.c. The function
167 build_frame_matrix is a good starting point. */
175 #include "keyboard.h"
178 #include "termchar.h"
179 #include "dispextern.h"
181 #include "character.h"
184 #include "commands.h"
188 #include "termhooks.h"
189 #include "intervals.h"
192 #include "region-cache.h"
195 #include "blockinput.h"
197 #ifdef HAVE_X_WINDOWS
212 #ifndef FRAME_X_OUTPUT
213 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
216 #define INFINITY 10000000
218 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
219 || defined(HAVE_NS) || defined (USE_GTK)
220 extern void set_frame_menubar
P_ ((struct frame
*f
, int, int));
221 extern int pending_menu_activation
;
224 extern int interrupt_input
;
225 extern int command_loop_level
;
227 extern Lisp_Object do_mouse_tracking
;
229 extern int minibuffer_auto_raise
;
230 extern Lisp_Object Vminibuffer_list
;
232 extern Lisp_Object Qface
;
233 extern Lisp_Object Qmode_line
, Qmode_line_inactive
, Qheader_line
;
235 extern Lisp_Object Voverriding_local_map
;
236 extern Lisp_Object Voverriding_local_map_menu_flag
;
237 extern Lisp_Object Qmenu_item
;
238 extern Lisp_Object Qwhen
;
239 extern Lisp_Object Qhelp_echo
;
240 extern Lisp_Object Qbefore_string
, Qafter_string
;
242 Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
243 Lisp_Object Qwindow_scroll_functions
, Vwindow_scroll_functions
;
244 Lisp_Object Qwindow_text_change_functions
, Vwindow_text_change_functions
;
245 Lisp_Object Qredisplay_end_trigger_functions
, Vredisplay_end_trigger_functions
;
246 Lisp_Object Qinhibit_point_motion_hooks
;
247 Lisp_Object QCeval
, QCfile
, QCdata
, QCpropertize
;
248 Lisp_Object Qfontified
;
249 Lisp_Object Qgrow_only
;
250 Lisp_Object Qinhibit_eval_during_redisplay
;
251 Lisp_Object Qbuffer_position
, Qposition
, Qobject
;
254 Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
257 Lisp_Object Qarrow
, Qhand
, Qtext
;
259 Lisp_Object Qrisky_local_variable
;
261 /* Holds the list (error). */
262 Lisp_Object list_of_error
;
264 /* Functions called to fontify regions of text. */
266 Lisp_Object Vfontification_functions
;
267 Lisp_Object Qfontification_functions
;
269 /* Non-nil means automatically select any window when the mouse
270 cursor moves into it. */
271 Lisp_Object Vmouse_autoselect_window
;
273 Lisp_Object Vwrap_prefix
, Qwrap_prefix
;
274 Lisp_Object Vline_prefix
, Qline_prefix
;
276 /* Non-zero means draw tool bar buttons raised when the mouse moves
279 int auto_raise_tool_bar_buttons_p
;
281 /* Non-zero means to reposition window if cursor line is only partially visible. */
283 int make_cursor_line_fully_visible_p
;
285 /* Margin below tool bar in pixels. 0 or nil means no margin.
286 If value is `internal-border-width' or `border-width',
287 the corresponding frame parameter is used. */
289 Lisp_Object Vtool_bar_border
;
291 /* Margin around tool bar buttons in pixels. */
293 Lisp_Object Vtool_bar_button_margin
;
295 /* Thickness of shadow to draw around tool bar buttons. */
297 EMACS_INT tool_bar_button_relief
;
299 /* Non-nil means automatically resize tool-bars so that all tool-bar
300 items are visible, and no blank lines remain.
302 If value is `grow-only', only make tool-bar bigger. */
304 Lisp_Object Vauto_resize_tool_bars
;
306 /* Non-zero means draw block and hollow cursor as wide as the glyph
307 under it. For example, if a block cursor is over a tab, it will be
308 drawn as wide as that tab on the display. */
310 int x_stretch_cursor_p
;
312 /* Non-nil means don't actually do any redisplay. */
314 Lisp_Object Vinhibit_redisplay
, Qinhibit_redisplay
;
316 /* Non-zero means Lisp evaluation during redisplay is inhibited. */
318 int inhibit_eval_during_redisplay
;
320 /* Names of text properties relevant for redisplay. */
322 Lisp_Object Qdisplay
;
323 extern Lisp_Object Qface
, Qinvisible
, Qwidth
;
325 /* Symbols used in text property values. */
327 Lisp_Object Vdisplay_pixels_per_inch
;
328 Lisp_Object Qspace
, QCalign_to
, QCrelative_width
, QCrelative_height
;
329 Lisp_Object Qleft_margin
, Qright_margin
, Qspace_width
, Qraise
;
332 Lisp_Object Qmargin
, Qpointer
;
333 Lisp_Object Qline_height
;
334 extern Lisp_Object Qheight
;
335 extern Lisp_Object QCwidth
, QCheight
, QCascent
;
336 extern Lisp_Object Qscroll_bar
;
337 extern Lisp_Object Qcursor
;
339 /* Non-nil means highlight trailing whitespace. */
341 Lisp_Object Vshow_trailing_whitespace
;
343 /* Non-nil means escape non-break space and hyphens. */
345 Lisp_Object Vnobreak_char_display
;
347 #ifdef HAVE_WINDOW_SYSTEM
348 extern Lisp_Object Voverflow_newline_into_fringe
;
350 /* Test if overflow newline into fringe. Called with iterator IT
351 at or past right window margin, and with IT->current_x set. */
353 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) \
354 (!NILP (Voverflow_newline_into_fringe) \
355 && FRAME_WINDOW_P (it->f) \
356 && WINDOW_RIGHT_FRINGE_WIDTH (it->w) > 0 \
357 && it->current_x == it->last_visible_x \
358 && it->line_wrap != WORD_WRAP)
360 #else /* !HAVE_WINDOW_SYSTEM */
361 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) 0
362 #endif /* HAVE_WINDOW_SYSTEM */
364 /* Test if the display element loaded in IT is a space or tab
365 character. This is used to determine word wrapping. */
367 #define IT_DISPLAYING_WHITESPACE(it) \
368 (it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t'))
370 /* Non-nil means show the text cursor in void text areas
371 i.e. in blank areas after eol and eob. This used to be
372 the default in 21.3. */
374 Lisp_Object Vvoid_text_area_pointer
;
376 /* Name of the face used to highlight trailing whitespace. */
378 Lisp_Object Qtrailing_whitespace
;
380 /* Name and number of the face used to highlight escape glyphs. */
382 Lisp_Object Qescape_glyph
;
384 /* Name and number of the face used to highlight non-breaking spaces. */
386 Lisp_Object Qnobreak_space
;
388 /* The symbol `image' which is the car of the lists used to represent
393 /* The image map types. */
394 Lisp_Object QCmap
, QCpointer
;
395 Lisp_Object Qrect
, Qcircle
, Qpoly
;
397 /* Non-zero means print newline to stdout before next mini-buffer
400 int noninteractive_need_newline
;
402 /* Non-zero means print newline to message log before next message. */
404 static int message_log_need_newline
;
406 /* Three markers that message_dolog uses.
407 It could allocate them itself, but that causes trouble
408 in handling memory-full errors. */
409 static Lisp_Object message_dolog_marker1
;
410 static Lisp_Object message_dolog_marker2
;
411 static Lisp_Object message_dolog_marker3
;
413 /* The buffer position of the first character appearing entirely or
414 partially on the line of the selected window which contains the
415 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
416 redisplay optimization in redisplay_internal. */
418 static struct text_pos this_line_start_pos
;
420 /* Number of characters past the end of the line above, including the
421 terminating newline. */
423 static struct text_pos this_line_end_pos
;
425 /* The vertical positions and the height of this line. */
427 static int this_line_vpos
;
428 static int this_line_y
;
429 static int this_line_pixel_height
;
431 /* X position at which this display line starts. Usually zero;
432 negative if first character is partially visible. */
434 static int this_line_start_x
;
436 /* Buffer that this_line_.* variables are referring to. */
438 static struct buffer
*this_line_buffer
;
440 /* Nonzero means truncate lines in all windows less wide than the
443 Lisp_Object Vtruncate_partial_width_windows
;
445 /* A flag to control how to display unibyte 8-bit character. */
447 int unibyte_display_via_language_environment
;
449 /* Nonzero means we have more than one non-mini-buffer-only frame.
450 Not guaranteed to be accurate except while parsing
451 frame-title-format. */
455 Lisp_Object Vglobal_mode_string
;
458 /* List of variables (symbols) which hold markers for overlay arrows.
459 The symbols on this list are examined during redisplay to determine
460 where to display overlay arrows. */
462 Lisp_Object Voverlay_arrow_variable_list
;
464 /* Marker for where to display an arrow on top of the buffer text. */
466 Lisp_Object Voverlay_arrow_position
;
468 /* String to display for the arrow. Only used on terminal frames. */
470 Lisp_Object Voverlay_arrow_string
;
472 /* Values of those variables at last redisplay are stored as
473 properties on `overlay-arrow-position' symbol. However, if
474 Voverlay_arrow_position is a marker, last-arrow-position is its
475 numerical position. */
477 Lisp_Object Qlast_arrow_position
, Qlast_arrow_string
;
479 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
480 properties on a symbol in overlay-arrow-variable-list. */
482 Lisp_Object Qoverlay_arrow_string
, Qoverlay_arrow_bitmap
;
484 /* Like mode-line-format, but for the title bar on a visible frame. */
486 Lisp_Object Vframe_title_format
;
488 /* Like mode-line-format, but for the title bar on an iconified frame. */
490 Lisp_Object Vicon_title_format
;
492 /* List of functions to call when a window's size changes. These
493 functions get one arg, a frame on which one or more windows' sizes
496 static Lisp_Object Vwindow_size_change_functions
;
498 Lisp_Object Qmenu_bar_update_hook
, Vmenu_bar_update_hook
;
500 /* Nonzero if an overlay arrow has been displayed in this window. */
502 static int overlay_arrow_seen
;
504 /* Nonzero means highlight the region even in nonselected windows. */
506 int highlight_nonselected_windows
;
508 /* If cursor motion alone moves point off frame, try scrolling this
509 many lines up or down if that will bring it back. */
511 static EMACS_INT scroll_step
;
513 /* Nonzero means scroll just far enough to bring point back on the
514 screen, when appropriate. */
516 static EMACS_INT scroll_conservatively
;
518 /* Recenter the window whenever point gets within this many lines of
519 the top or bottom of the window. This value is translated into a
520 pixel value by multiplying it with FRAME_LINE_HEIGHT, which means
521 that there is really a fixed pixel height scroll margin. */
523 EMACS_INT scroll_margin
;
525 /* Number of windows showing the buffer of the selected window (or
526 another buffer with the same base buffer). keyboard.c refers to
531 /* Vector containing glyphs for an ellipsis `...'. */
533 static Lisp_Object default_invis_vector
[3];
535 /* Zero means display the mode-line/header-line/menu-bar in the default face
536 (this slightly odd definition is for compatibility with previous versions
537 of emacs), non-zero means display them using their respective faces.
539 This variable is deprecated. */
541 int mode_line_inverse_video
;
543 /* Prompt to display in front of the mini-buffer contents. */
545 Lisp_Object minibuf_prompt
;
547 /* Width of current mini-buffer prompt. Only set after display_line
548 of the line that contains the prompt. */
550 int minibuf_prompt_width
;
552 /* This is the window where the echo area message was displayed. It
553 is always a mini-buffer window, but it may not be the same window
554 currently active as a mini-buffer. */
556 Lisp_Object echo_area_window
;
558 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
559 pushes the current message and the value of
560 message_enable_multibyte on the stack, the function restore_message
561 pops the stack and displays MESSAGE again. */
563 Lisp_Object Vmessage_stack
;
565 /* Nonzero means multibyte characters were enabled when the echo area
566 message was specified. */
568 int message_enable_multibyte
;
570 /* Nonzero if we should redraw the mode lines on the next redisplay. */
572 int update_mode_lines
;
574 /* Nonzero if window sizes or contents have changed since last
575 redisplay that finished. */
577 int windows_or_buffers_changed
;
579 /* Nonzero means a frame's cursor type has been changed. */
581 int cursor_type_changed
;
583 /* Nonzero after display_mode_line if %l was used and it displayed a
586 int line_number_displayed
;
588 /* Maximum buffer size for which to display line numbers. */
590 Lisp_Object Vline_number_display_limit
;
592 /* Line width to consider when repositioning for line number display. */
594 static EMACS_INT line_number_display_limit_width
;
596 /* Number of lines to keep in the message log buffer. t means
597 infinite. nil means don't log at all. */
599 Lisp_Object Vmessage_log_max
;
601 /* The name of the *Messages* buffer, a string. */
603 static Lisp_Object Vmessages_buffer_name
;
605 /* Current, index 0, and last displayed echo area message. Either
606 buffers from echo_buffers, or nil to indicate no message. */
608 Lisp_Object echo_area_buffer
[2];
610 /* The buffers referenced from echo_area_buffer. */
612 static Lisp_Object echo_buffer
[2];
614 /* A vector saved used in with_area_buffer to reduce consing. */
616 static Lisp_Object Vwith_echo_area_save_vector
;
618 /* Non-zero means display_echo_area should display the last echo area
619 message again. Set by redisplay_preserve_echo_area. */
621 static int display_last_displayed_message_p
;
623 /* Nonzero if echo area is being used by print; zero if being used by
626 int message_buf_print
;
628 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
630 Lisp_Object Qinhibit_menubar_update
;
631 int inhibit_menubar_update
;
633 /* When evaluating expressions from menu bar items (enable conditions,
634 for instance), this is the frame they are being processed for. */
636 Lisp_Object Vmenu_updating_frame
;
638 /* Maximum height for resizing mini-windows. Either a float
639 specifying a fraction of the available height, or an integer
640 specifying a number of lines. */
642 Lisp_Object Vmax_mini_window_height
;
644 /* Non-zero means messages should be displayed with truncated
645 lines instead of being continued. */
647 int message_truncate_lines
;
648 Lisp_Object Qmessage_truncate_lines
;
650 /* Set to 1 in clear_message to make redisplay_internal aware
651 of an emptied echo area. */
653 static int message_cleared_p
;
655 /* How to blink the default frame cursor off. */
656 Lisp_Object Vblink_cursor_alist
;
658 /* A scratch glyph row with contents used for generating truncation
659 glyphs. Also used in direct_output_for_insert. */
661 #define MAX_SCRATCH_GLYPHS 100
662 struct glyph_row scratch_glyph_row
;
663 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
665 /* Ascent and height of the last line processed by move_it_to. */
667 static int last_max_ascent
, last_height
;
669 /* Non-zero if there's a help-echo in the echo area. */
671 int help_echo_showing_p
;
673 /* If >= 0, computed, exact values of mode-line and header-line height
674 to use in the macros CURRENT_MODE_LINE_HEIGHT and
675 CURRENT_HEADER_LINE_HEIGHT. */
677 int current_mode_line_height
, current_header_line_height
;
679 /* The maximum distance to look ahead for text properties. Values
680 that are too small let us call compute_char_face and similar
681 functions too often which is expensive. Values that are too large
682 let us call compute_char_face and alike too often because we
683 might not be interested in text properties that far away. */
685 #define TEXT_PROP_DISTANCE_LIMIT 100
689 /* Variables to turn off display optimizations from Lisp. */
691 int inhibit_try_window_id
, inhibit_try_window_reusing
;
692 int inhibit_try_cursor_movement
;
694 /* Non-zero means print traces of redisplay if compiled with
697 int trace_redisplay_p
;
699 #endif /* GLYPH_DEBUG */
701 #ifdef DEBUG_TRACE_MOVE
702 /* Non-zero means trace with TRACE_MOVE to stderr. */
705 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
707 #define TRACE_MOVE(x) (void) 0
710 /* Non-zero means automatically scroll windows horizontally to make
713 int automatic_hscrolling_p
;
714 Lisp_Object Qauto_hscroll_mode
;
716 /* How close to the margin can point get before the window is scrolled
718 EMACS_INT hscroll_margin
;
720 /* How much to scroll horizontally when point is inside the above margin. */
721 Lisp_Object Vhscroll_step
;
723 /* The variable `resize-mini-windows'. If nil, don't resize
724 mini-windows. If t, always resize them to fit the text they
725 display. If `grow-only', let mini-windows grow only until they
728 Lisp_Object Vresize_mini_windows
;
730 /* Buffer being redisplayed -- for redisplay_window_error. */
732 struct buffer
*displayed_buffer
;
734 /* Space between overline and text. */
736 EMACS_INT overline_margin
;
738 /* Require underline to be at least this many screen pixels below baseline
739 This to avoid underline "merging" with the base of letters at small
740 font sizes, particularly when x_use_underline_position_properties is on. */
742 EMACS_INT underline_minimum_offset
;
744 /* Value returned from text property handlers (see below). */
749 HANDLED_RECOMPUTE_PROPS
,
750 HANDLED_OVERLAY_STRING_CONSUMED
,
754 /* A description of text properties that redisplay is interested
759 /* The name of the property. */
762 /* A unique index for the property. */
765 /* A handler function called to set up iterator IT from the property
766 at IT's current position. Value is used to steer handle_stop. */
767 enum prop_handled (*handler
) P_ ((struct it
*it
));
770 static enum prop_handled handle_face_prop
P_ ((struct it
*));
771 static enum prop_handled handle_invisible_prop
P_ ((struct it
*));
772 static enum prop_handled handle_display_prop
P_ ((struct it
*));
773 static enum prop_handled handle_composition_prop
P_ ((struct it
*));
774 static enum prop_handled handle_overlay_change
P_ ((struct it
*));
775 static enum prop_handled handle_fontified_prop
P_ ((struct it
*));
777 /* Properties handled by iterators. */
779 static struct props it_props
[] =
781 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
782 /* Handle `face' before `display' because some sub-properties of
783 `display' need to know the face. */
784 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
785 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
786 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
787 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
791 /* Value is the position described by X. If X is a marker, value is
792 the marker_position of X. Otherwise, value is X. */
794 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
796 /* Enumeration returned by some move_it_.* functions internally. */
800 /* Not used. Undefined value. */
803 /* Move ended at the requested buffer position or ZV. */
804 MOVE_POS_MATCH_OR_ZV
,
806 /* Move ended at the requested X pixel position. */
809 /* Move within a line ended at the end of a line that must be
813 /* Move within a line ended at the end of a line that would
814 be displayed truncated. */
817 /* Move within a line ended at a line end. */
821 /* This counter is used to clear the face cache every once in a while
822 in redisplay_internal. It is incremented for each redisplay.
823 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
826 #define CLEAR_FACE_CACHE_COUNT 500
827 static int clear_face_cache_count
;
829 /* Similarly for the image cache. */
831 #ifdef HAVE_WINDOW_SYSTEM
832 #define CLEAR_IMAGE_CACHE_COUNT 101
833 static int clear_image_cache_count
;
836 /* Non-zero while redisplay_internal is in progress. */
840 /* Non-zero means don't free realized faces. Bound while freeing
841 realized faces is dangerous because glyph matrices might still
844 int inhibit_free_realized_faces
;
845 Lisp_Object Qinhibit_free_realized_faces
;
847 /* If a string, XTread_socket generates an event to display that string.
848 (The display is done in read_char.) */
850 Lisp_Object help_echo_string
;
851 Lisp_Object help_echo_window
;
852 Lisp_Object help_echo_object
;
855 /* Temporary variable for XTread_socket. */
857 Lisp_Object previous_help_echo_string
;
859 /* Null glyph slice */
861 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
863 /* Platform-independent portion of hourglass implementation. */
865 /* Non-zero means we're allowed to display a hourglass pointer. */
866 int display_hourglass_p
;
868 /* Non-zero means an hourglass cursor is currently shown. */
869 int hourglass_shown_p
;
871 /* If non-null, an asynchronous timer that, when it expires, displays
872 an hourglass cursor on all frames. */
873 struct atimer
*hourglass_atimer
;
875 /* Number of seconds to wait before displaying an hourglass cursor. */
876 Lisp_Object Vhourglass_delay
;
878 /* Default number of seconds to wait before displaying an hourglass
880 #define DEFAULT_HOURGLASS_DELAY 1
883 /* Function prototypes. */
885 static void setup_for_ellipsis
P_ ((struct it
*, int));
886 static void mark_window_display_accurate_1
P_ ((struct window
*, int));
887 static int single_display_spec_string_p
P_ ((Lisp_Object
, Lisp_Object
));
888 static int display_prop_string_p
P_ ((Lisp_Object
, Lisp_Object
));
889 static int cursor_row_p
P_ ((struct window
*, struct glyph_row
*));
890 static int redisplay_mode_lines
P_ ((Lisp_Object
, int));
891 static char *decode_mode_spec_coding
P_ ((Lisp_Object
, char *, int));
893 static Lisp_Object get_it_property
P_ ((struct it
*it
, Lisp_Object prop
));
895 static void handle_line_prefix
P_ ((struct it
*));
897 static void pint2str
P_ ((char *, int, int));
898 static void pint2hrstr
P_ ((char *, int, int));
899 static struct text_pos run_window_scroll_functions
P_ ((Lisp_Object
,
901 static void reconsider_clip_changes
P_ ((struct window
*, struct buffer
*));
902 static int text_outside_line_unchanged_p
P_ ((struct window
*, int, int));
903 static void store_mode_line_noprop_char
P_ ((char));
904 static int store_mode_line_noprop
P_ ((const unsigned char *, int, int));
905 static void x_consider_frame_title
P_ ((Lisp_Object
));
906 static void handle_stop
P_ ((struct it
*));
907 static int tool_bar_lines_needed
P_ ((struct frame
*, int *));
908 static int single_display_spec_intangible_p
P_ ((Lisp_Object
));
909 static void ensure_echo_area_buffers
P_ ((void));
910 static Lisp_Object unwind_with_echo_area_buffer
P_ ((Lisp_Object
));
911 static Lisp_Object with_echo_area_buffer_unwind_data
P_ ((struct window
*));
912 static int with_echo_area_buffer
P_ ((struct window
*, int,
913 int (*) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
914 EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
915 static void clear_garbaged_frames
P_ ((void));
916 static int current_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
917 static int truncate_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
918 static int set_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
919 static int display_echo_area
P_ ((struct window
*));
920 static int display_echo_area_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
921 static int resize_mini_window_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
922 static Lisp_Object unwind_redisplay
P_ ((Lisp_Object
));
923 static int string_char_and_length
P_ ((const unsigned char *, int *));
924 static struct text_pos display_prop_end
P_ ((struct it
*, Lisp_Object
,
926 static int compute_window_start_on_continuation_line
P_ ((struct window
*));
927 static Lisp_Object safe_eval_handler
P_ ((Lisp_Object
));
928 static void insert_left_trunc_glyphs
P_ ((struct it
*));
929 static struct glyph_row
*get_overlay_arrow_glyph_row
P_ ((struct window
*,
931 static void extend_face_to_end_of_line
P_ ((struct it
*));
932 static int append_space_for_newline
P_ ((struct it
*, int));
933 static int cursor_row_fully_visible_p
P_ ((struct window
*, int, int));
934 static int try_scrolling
P_ ((Lisp_Object
, int, EMACS_INT
, EMACS_INT
, int, int));
935 static int try_cursor_movement
P_ ((Lisp_Object
, struct text_pos
, int *));
936 static int trailing_whitespace_p
P_ ((int));
937 static int message_log_check_duplicate
P_ ((int, int, int, int));
938 static void push_it
P_ ((struct it
*));
939 static void pop_it
P_ ((struct it
*));
940 static void sync_frame_with_window_matrix_rows
P_ ((struct window
*));
941 static void select_frame_for_redisplay
P_ ((Lisp_Object
));
942 static void redisplay_internal
P_ ((int));
943 static int echo_area_display
P_ ((int));
944 static void redisplay_windows
P_ ((Lisp_Object
));
945 static void redisplay_window
P_ ((Lisp_Object
, int));
946 static Lisp_Object
redisplay_window_error ();
947 static Lisp_Object redisplay_window_0
P_ ((Lisp_Object
));
948 static Lisp_Object redisplay_window_1
P_ ((Lisp_Object
));
949 static int update_menu_bar
P_ ((struct frame
*, int, int));
950 static int try_window_reusing_current_matrix
P_ ((struct window
*));
951 static int try_window_id
P_ ((struct window
*));
952 static int display_line
P_ ((struct it
*));
953 static int display_mode_lines
P_ ((struct window
*));
954 static int display_mode_line
P_ ((struct window
*, enum face_id
, Lisp_Object
));
955 static int display_mode_element
P_ ((struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int));
956 static int store_mode_line_string
P_ ((char *, Lisp_Object
, int, int, int, Lisp_Object
));
957 static char *decode_mode_spec
P_ ((struct window
*, int, int, int,
959 static void display_menu_bar
P_ ((struct window
*));
960 static int display_count_lines
P_ ((int, int, int, int, int *));
961 static int display_string
P_ ((unsigned char *, Lisp_Object
, Lisp_Object
,
962 EMACS_INT
, EMACS_INT
, struct it
*, int, int, int, int));
963 static void compute_line_metrics
P_ ((struct it
*));
964 static void run_redisplay_end_trigger_hook
P_ ((struct it
*));
965 static int get_overlay_strings
P_ ((struct it
*, int));
966 static int get_overlay_strings_1
P_ ((struct it
*, int, int));
967 static void next_overlay_string
P_ ((struct it
*));
968 static void reseat
P_ ((struct it
*, struct text_pos
, int));
969 static void reseat_1
P_ ((struct it
*, struct text_pos
, int));
970 static void back_to_previous_visible_line_start
P_ ((struct it
*));
971 void reseat_at_previous_visible_line_start
P_ ((struct it
*));
972 static void reseat_at_next_visible_line_start
P_ ((struct it
*, int));
973 static int next_element_from_ellipsis
P_ ((struct it
*));
974 static int next_element_from_display_vector
P_ ((struct it
*));
975 static int next_element_from_string
P_ ((struct it
*));
976 static int next_element_from_c_string
P_ ((struct it
*));
977 static int next_element_from_buffer
P_ ((struct it
*));
978 static int next_element_from_composition
P_ ((struct it
*));
979 static int next_element_from_image
P_ ((struct it
*));
980 static int next_element_from_stretch
P_ ((struct it
*));
981 static void load_overlay_strings
P_ ((struct it
*, int));
982 static int init_from_display_pos
P_ ((struct it
*, struct window
*,
983 struct display_pos
*));
984 static void reseat_to_string
P_ ((struct it
*, unsigned char *,
985 Lisp_Object
, int, int, int, int));
986 static enum move_it_result
987 move_it_in_display_line_to (struct it
*, EMACS_INT
, int,
988 enum move_operation_enum
);
989 void move_it_vertically_backward
P_ ((struct it
*, int));
990 static void init_to_row_start
P_ ((struct it
*, struct window
*,
991 struct glyph_row
*));
992 static int init_to_row_end
P_ ((struct it
*, struct window
*,
993 struct glyph_row
*));
994 static void back_to_previous_line_start
P_ ((struct it
*));
995 static int forward_to_next_line_start
P_ ((struct it
*, int *));
996 static struct text_pos string_pos_nchars_ahead
P_ ((struct text_pos
,
998 static struct text_pos string_pos
P_ ((int, Lisp_Object
));
999 static struct text_pos c_string_pos
P_ ((int, unsigned char *, int));
1000 static int number_of_chars
P_ ((unsigned char *, int));
1001 static void compute_stop_pos
P_ ((struct it
*));
1002 static void compute_string_pos
P_ ((struct text_pos
*, struct text_pos
,
1004 static int face_before_or_after_it_pos
P_ ((struct it
*, int));
1005 static EMACS_INT next_overlay_change
P_ ((EMACS_INT
));
1006 static int handle_single_display_spec
P_ ((struct it
*, Lisp_Object
,
1007 Lisp_Object
, Lisp_Object
,
1008 struct text_pos
*, int));
1009 static int underlying_face_id
P_ ((struct it
*));
1010 static int in_ellipses_for_invisible_text_p
P_ ((struct display_pos
*,
1013 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
1014 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
1016 #ifdef HAVE_WINDOW_SYSTEM
1018 static void update_tool_bar
P_ ((struct frame
*, int));
1019 static void build_desired_tool_bar_string
P_ ((struct frame
*f
));
1020 static int redisplay_tool_bar
P_ ((struct frame
*));
1021 static void display_tool_bar_line
P_ ((struct it
*, int));
1022 static void notice_overwritten_cursor
P_ ((struct window
*,
1023 enum glyph_row_area
,
1024 int, int, int, int));
1028 #endif /* HAVE_WINDOW_SYSTEM */
1031 /***********************************************************************
1032 Window display dimensions
1033 ***********************************************************************/
1035 /* Return the bottom boundary y-position for text lines in window W.
1036 This is the first y position at which a line cannot start.
1037 It is relative to the top of the window.
1039 This is the height of W minus the height of a mode line, if any. */
1042 window_text_bottom_y (w
)
1045 int height
= WINDOW_TOTAL_HEIGHT (w
);
1047 if (WINDOW_WANTS_MODELINE_P (w
))
1048 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
1052 /* Return the pixel width of display area AREA of window W. AREA < 0
1053 means return the total width of W, not including fringes to
1054 the left and right of the window. */
1057 window_box_width (w
, area
)
1061 int cols
= XFASTINT (w
->total_cols
);
1064 if (!w
->pseudo_window_p
)
1066 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
1068 if (area
== TEXT_AREA
)
1070 if (INTEGERP (w
->left_margin_cols
))
1071 cols
-= XFASTINT (w
->left_margin_cols
);
1072 if (INTEGERP (w
->right_margin_cols
))
1073 cols
-= XFASTINT (w
->right_margin_cols
);
1074 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
1076 else if (area
== LEFT_MARGIN_AREA
)
1078 cols
= (INTEGERP (w
->left_margin_cols
)
1079 ? XFASTINT (w
->left_margin_cols
) : 0);
1082 else if (area
== RIGHT_MARGIN_AREA
)
1084 cols
= (INTEGERP (w
->right_margin_cols
)
1085 ? XFASTINT (w
->right_margin_cols
) : 0);
1090 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
1094 /* Return the pixel height of the display area of window W, not
1095 including mode lines of W, if any. */
1098 window_box_height (w
)
1101 struct frame
*f
= XFRAME (w
->frame
);
1102 int height
= WINDOW_TOTAL_HEIGHT (w
);
1104 xassert (height
>= 0);
1106 /* Note: the code below that determines the mode-line/header-line
1107 height is essentially the same as that contained in the macro
1108 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
1109 the appropriate glyph row has its `mode_line_p' flag set,
1110 and if it doesn't, uses estimate_mode_line_height instead. */
1112 if (WINDOW_WANTS_MODELINE_P (w
))
1114 struct glyph_row
*ml_row
1115 = (w
->current_matrix
&& w
->current_matrix
->rows
1116 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1118 if (ml_row
&& ml_row
->mode_line_p
)
1119 height
-= ml_row
->height
;
1121 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1124 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1126 struct glyph_row
*hl_row
1127 = (w
->current_matrix
&& w
->current_matrix
->rows
1128 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1130 if (hl_row
&& hl_row
->mode_line_p
)
1131 height
-= hl_row
->height
;
1133 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1136 /* With a very small font and a mode-line that's taller than
1137 default, we might end up with a negative height. */
1138 return max (0, height
);
1141 /* Return the window-relative coordinate of the left edge of display
1142 area AREA of window W. AREA < 0 means return the left edge of the
1143 whole window, to the right of the left fringe of W. */
1146 window_box_left_offset (w
, area
)
1152 if (w
->pseudo_window_p
)
1155 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1157 if (area
== TEXT_AREA
)
1158 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1159 + window_box_width (w
, LEFT_MARGIN_AREA
));
1160 else if (area
== RIGHT_MARGIN_AREA
)
1161 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1162 + window_box_width (w
, LEFT_MARGIN_AREA
)
1163 + window_box_width (w
, TEXT_AREA
)
1164 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1166 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1167 else if (area
== LEFT_MARGIN_AREA
1168 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1169 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1175 /* Return the window-relative coordinate of the right edge of display
1176 area AREA of window W. AREA < 0 means return the left edge of the
1177 whole window, to the left of the right fringe of W. */
1180 window_box_right_offset (w
, area
)
1184 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1187 /* Return the frame-relative coordinate of the left edge of display
1188 area AREA of window W. AREA < 0 means return the left edge of the
1189 whole window, to the right of the left fringe of W. */
1192 window_box_left (w
, area
)
1196 struct frame
*f
= XFRAME (w
->frame
);
1199 if (w
->pseudo_window_p
)
1200 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1202 x
= (WINDOW_LEFT_EDGE_X (w
)
1203 + window_box_left_offset (w
, area
));
1209 /* Return the frame-relative coordinate of the right edge of display
1210 area AREA of window W. AREA < 0 means return the left edge of the
1211 whole window, to the left of the right fringe of W. */
1214 window_box_right (w
, area
)
1218 return window_box_left (w
, area
) + window_box_width (w
, area
);
1221 /* Get the bounding box of the display area AREA of window W, without
1222 mode lines, in frame-relative coordinates. AREA < 0 means the
1223 whole window, not including the left and right fringes of
1224 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1225 coordinates of the upper-left corner of the box. Return in
1226 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1229 window_box (w
, area
, box_x
, box_y
, box_width
, box_height
)
1232 int *box_x
, *box_y
, *box_width
, *box_height
;
1235 *box_width
= window_box_width (w
, area
);
1237 *box_height
= window_box_height (w
);
1239 *box_x
= window_box_left (w
, area
);
1242 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1243 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1244 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1249 /* Get the bounding box of the display area AREA of window W, without
1250 mode lines. AREA < 0 means the whole window, not including the
1251 left and right fringe of the window. Return in *TOP_LEFT_X
1252 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1253 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1254 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1258 window_box_edges (w
, area
, top_left_x
, top_left_y
,
1259 bottom_right_x
, bottom_right_y
)
1262 int *top_left_x
, *top_left_y
, *bottom_right_x
, *bottom_right_y
;
1264 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1266 *bottom_right_x
+= *top_left_x
;
1267 *bottom_right_y
+= *top_left_y
;
1272 /***********************************************************************
1274 ***********************************************************************/
1276 /* Return the bottom y-position of the line the iterator IT is in.
1277 This can modify IT's settings. */
1283 int line_height
= it
->max_ascent
+ it
->max_descent
;
1284 int line_top_y
= it
->current_y
;
1286 if (line_height
== 0)
1289 line_height
= last_height
;
1290 else if (IT_CHARPOS (*it
) < ZV
)
1292 move_it_by_lines (it
, 1, 1);
1293 line_height
= (it
->max_ascent
|| it
->max_descent
1294 ? it
->max_ascent
+ it
->max_descent
1299 struct glyph_row
*row
= it
->glyph_row
;
1301 /* Use the default character height. */
1302 it
->glyph_row
= NULL
;
1303 it
->what
= IT_CHARACTER
;
1306 PRODUCE_GLYPHS (it
);
1307 line_height
= it
->ascent
+ it
->descent
;
1308 it
->glyph_row
= row
;
1312 return line_top_y
+ line_height
;
1316 /* Return 1 if position CHARPOS is visible in window W.
1317 CHARPOS < 0 means return info about WINDOW_END position.
1318 If visible, set *X and *Y to pixel coordinates of top left corner.
1319 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1320 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1323 pos_visible_p (w
, charpos
, x
, y
, rtop
, rbot
, rowh
, vpos
)
1325 int charpos
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
;
1328 struct text_pos top
;
1330 struct buffer
*old_buffer
= NULL
;
1332 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1335 if (XBUFFER (w
->buffer
) != current_buffer
)
1337 old_buffer
= current_buffer
;
1338 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1341 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1343 /* Compute exact mode line heights. */
1344 if (WINDOW_WANTS_MODELINE_P (w
))
1345 current_mode_line_height
1346 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1347 current_buffer
->mode_line_format
);
1349 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1350 current_header_line_height
1351 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1352 current_buffer
->header_line_format
);
1354 start_display (&it
, w
, top
);
1355 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1356 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1358 if (charpos
>= 0 && IT_CHARPOS (it
) >= charpos
)
1360 /* We have reached CHARPOS, or passed it. How the call to
1361 move_it_to can overshoot: (i) If CHARPOS is on invisible
1362 text, move_it_to stops at the end of the invisible text,
1363 after CHARPOS. (ii) If CHARPOS is in a display vector,
1364 move_it_to stops on its last glyph. */
1365 int top_x
= it
.current_x
;
1366 int top_y
= it
.current_y
;
1367 enum it_method it_method
= it
.method
;
1368 /* Calling line_bottom_y may change it.method, it.position, etc. */
1369 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1370 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1372 if (top_y
< window_top_y
)
1373 visible_p
= bottom_y
> window_top_y
;
1374 else if (top_y
< it
.last_visible_y
)
1378 if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1380 /* We stopped on the last glyph of a display vector.
1381 Try and recompute. Hack alert! */
1382 if (charpos
< 2 || top
.charpos
>= charpos
)
1383 top_x
= it
.glyph_row
->x
;
1387 start_display (&it2
, w
, top
);
1388 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1389 get_next_display_element (&it2
);
1390 PRODUCE_GLYPHS (&it2
);
1391 if (ITERATOR_AT_END_OF_LINE_P (&it2
)
1392 || it2
.current_x
> it2
.last_visible_x
)
1393 top_x
= it
.glyph_row
->x
;
1396 top_x
= it2
.current_x
;
1397 top_y
= it2
.current_y
;
1403 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1404 *rtop
= max (0, window_top_y
- top_y
);
1405 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1406 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1407 - max (top_y
, window_top_y
)));
1416 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1417 move_it_by_lines (&it
, 1, 0);
1418 if (charpos
< IT_CHARPOS (it
)
1419 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1422 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1424 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1425 *rtop
= max (0, -it2
.current_y
);
1426 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1427 - it
.last_visible_y
));
1428 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1430 - max (it2
.current_y
,
1431 WINDOW_HEADER_LINE_HEIGHT (w
))));
1437 set_buffer_internal_1 (old_buffer
);
1439 current_header_line_height
= current_mode_line_height
= -1;
1441 if (visible_p
&& XFASTINT (w
->hscroll
) > 0)
1442 *x
-= XFASTINT (w
->hscroll
) * WINDOW_FRAME_COLUMN_WIDTH (w
);
1445 /* Debugging code. */
1447 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1448 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1450 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1457 /* Return the next character from STR which is MAXLEN bytes long.
1458 Return in *LEN the length of the character. This is like
1459 STRING_CHAR_AND_LENGTH but never returns an invalid character. If
1460 we find one, we return a `?', but with the length of the invalid
1464 string_char_and_length (str
, len
)
1465 const unsigned char *str
;
1470 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1471 if (!CHAR_VALID_P (c
, 1))
1472 /* We may not change the length here because other places in Emacs
1473 don't use this function, i.e. they silently accept invalid
1482 /* Given a position POS containing a valid character and byte position
1483 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1485 static struct text_pos
1486 string_pos_nchars_ahead (pos
, string
, nchars
)
1487 struct text_pos pos
;
1491 xassert (STRINGP (string
) && nchars
>= 0);
1493 if (STRING_MULTIBYTE (string
))
1495 int rest
= SBYTES (string
) - BYTEPOS (pos
);
1496 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1501 string_char_and_length (p
, &len
);
1502 p
+= len
, rest
-= len
;
1503 xassert (rest
>= 0);
1505 BYTEPOS (pos
) += len
;
1509 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1515 /* Value is the text position, i.e. character and byte position,
1516 for character position CHARPOS in STRING. */
1518 static INLINE
struct text_pos
1519 string_pos (charpos
, string
)
1523 struct text_pos pos
;
1524 xassert (STRINGP (string
));
1525 xassert (charpos
>= 0);
1526 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1531 /* Value is a text position, i.e. character and byte position, for
1532 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1533 means recognize multibyte characters. */
1535 static struct text_pos
1536 c_string_pos (charpos
, s
, multibyte_p
)
1541 struct text_pos pos
;
1543 xassert (s
!= NULL
);
1544 xassert (charpos
>= 0);
1548 int rest
= strlen (s
), len
;
1550 SET_TEXT_POS (pos
, 0, 0);
1553 string_char_and_length (s
, &len
);
1554 s
+= len
, rest
-= len
;
1555 xassert (rest
>= 0);
1557 BYTEPOS (pos
) += len
;
1561 SET_TEXT_POS (pos
, charpos
, charpos
);
1567 /* Value is the number of characters in C string S. MULTIBYTE_P
1568 non-zero means recognize multibyte characters. */
1571 number_of_chars (s
, multibyte_p
)
1579 int rest
= strlen (s
), len
;
1580 unsigned char *p
= (unsigned char *) s
;
1582 for (nchars
= 0; rest
> 0; ++nchars
)
1584 string_char_and_length (p
, &len
);
1585 rest
-= len
, p
+= len
;
1589 nchars
= strlen (s
);
1595 /* Compute byte position NEWPOS->bytepos corresponding to
1596 NEWPOS->charpos. POS is a known position in string STRING.
1597 NEWPOS->charpos must be >= POS.charpos. */
1600 compute_string_pos (newpos
, pos
, string
)
1601 struct text_pos
*newpos
, pos
;
1604 xassert (STRINGP (string
));
1605 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1607 if (STRING_MULTIBYTE (string
))
1608 *newpos
= string_pos_nchars_ahead (pos
, string
,
1609 CHARPOS (*newpos
) - CHARPOS (pos
));
1611 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1615 Return an estimation of the pixel height of mode or header lines on
1616 frame F. FACE_ID specifies what line's height to estimate. */
1619 estimate_mode_line_height (f
, face_id
)
1621 enum face_id face_id
;
1623 #ifdef HAVE_WINDOW_SYSTEM
1624 if (FRAME_WINDOW_P (f
))
1626 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1628 /* This function is called so early when Emacs starts that the face
1629 cache and mode line face are not yet initialized. */
1630 if (FRAME_FACE_CACHE (f
))
1632 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1636 height
= FONT_HEIGHT (face
->font
);
1637 if (face
->box_line_width
> 0)
1638 height
+= 2 * face
->box_line_width
;
1649 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1650 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1651 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1652 not force the value into range. */
1655 pixel_to_glyph_coords (f
, pix_x
, pix_y
, x
, y
, bounds
, noclip
)
1657 register int pix_x
, pix_y
;
1659 NativeRectangle
*bounds
;
1663 #ifdef HAVE_WINDOW_SYSTEM
1664 if (FRAME_WINDOW_P (f
))
1666 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1667 even for negative values. */
1669 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1671 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1673 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1674 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1677 STORE_NATIVE_RECT (*bounds
,
1678 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1679 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1680 FRAME_COLUMN_WIDTH (f
) - 1,
1681 FRAME_LINE_HEIGHT (f
) - 1);
1687 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1688 pix_x
= FRAME_TOTAL_COLS (f
);
1692 else if (pix_y
> FRAME_LINES (f
))
1693 pix_y
= FRAME_LINES (f
);
1703 /* Given HPOS/VPOS in the current matrix of W, return corresponding
1704 frame-relative pixel positions in *FRAME_X and *FRAME_Y. If we
1705 can't tell the positions because W's display is not up to date,
1709 glyph_to_pixel_coords (w
, hpos
, vpos
, frame_x
, frame_y
)
1712 int *frame_x
, *frame_y
;
1714 #ifdef HAVE_WINDOW_SYSTEM
1715 if (FRAME_WINDOW_P (XFRAME (WINDOW_FRAME (w
))))
1719 xassert (hpos
>= 0 && hpos
< w
->current_matrix
->matrix_w
);
1720 xassert (vpos
>= 0 && vpos
< w
->current_matrix
->matrix_h
);
1722 if (display_completed
)
1724 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
1725 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1726 struct glyph
*end
= glyph
+ min (hpos
, row
->used
[TEXT_AREA
]);
1732 hpos
+= glyph
->pixel_width
;
1736 /* If first glyph is partially visible, its first visible position is still 0. */
1748 *frame_x
= WINDOW_TO_FRAME_PIXEL_X (w
, hpos
);
1749 *frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, vpos
);
1760 #ifdef HAVE_WINDOW_SYSTEM
1762 /* Find the glyph under window-relative coordinates X/Y in window W.
1763 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1764 strings. Return in *HPOS and *VPOS the row and column number of
1765 the glyph found. Return in *AREA the glyph area containing X.
1766 Value is a pointer to the glyph found or null if X/Y is not on
1767 text, or we can't tell because W's current matrix is not up to
1772 x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, dx
, dy
, area
)
1775 int *hpos
, *vpos
, *dx
, *dy
, *area
;
1777 struct glyph
*glyph
, *end
;
1778 struct glyph_row
*row
= NULL
;
1781 /* Find row containing Y. Give up if some row is not enabled. */
1782 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1784 row
= MATRIX_ROW (w
->current_matrix
, i
);
1785 if (!row
->enabled_p
)
1787 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1794 /* Give up if Y is not in the window. */
1795 if (i
== w
->current_matrix
->nrows
)
1798 /* Get the glyph area containing X. */
1799 if (w
->pseudo_window_p
)
1806 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1808 *area
= LEFT_MARGIN_AREA
;
1809 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1811 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1814 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1818 *area
= RIGHT_MARGIN_AREA
;
1819 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1823 /* Find glyph containing X. */
1824 glyph
= row
->glyphs
[*area
];
1825 end
= glyph
+ row
->used
[*area
];
1827 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1829 x
-= glyph
->pixel_width
;
1839 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1842 *hpos
= glyph
- row
->glyphs
[*area
];
1848 Convert frame-relative x/y to coordinates relative to window W.
1849 Takes pseudo-windows into account. */
1852 frame_to_window_pixel_xy (w
, x
, y
)
1856 if (w
->pseudo_window_p
)
1858 /* A pseudo-window is always full-width, and starts at the
1859 left edge of the frame, plus a frame border. */
1860 struct frame
*f
= XFRAME (w
->frame
);
1861 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1862 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1866 *x
-= WINDOW_LEFT_EDGE_X (w
);
1867 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1872 Return in RECTS[] at most N clipping rectangles for glyph string S.
1873 Return the number of stored rectangles. */
1876 get_glyph_string_clip_rects (s
, rects
, n
)
1877 struct glyph_string
*s
;
1878 NativeRectangle
*rects
;
1886 if (s
->row
->full_width_p
)
1888 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1889 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1890 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1892 /* Unless displaying a mode or menu bar line, which are always
1893 fully visible, clip to the visible part of the row. */
1894 if (s
->w
->pseudo_window_p
)
1895 r
.height
= s
->row
->visible_height
;
1897 r
.height
= s
->height
;
1901 /* This is a text line that may be partially visible. */
1902 r
.x
= window_box_left (s
->w
, s
->area
);
1903 r
.width
= window_box_width (s
->w
, s
->area
);
1904 r
.height
= s
->row
->visible_height
;
1908 if (r
.x
< s
->clip_head
->x
)
1910 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1911 r
.width
-= s
->clip_head
->x
- r
.x
;
1914 r
.x
= s
->clip_head
->x
;
1917 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1919 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1920 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1925 /* If S draws overlapping rows, it's sufficient to use the top and
1926 bottom of the window for clipping because this glyph string
1927 intentionally draws over other lines. */
1928 if (s
->for_overlaps
)
1930 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1931 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1933 /* Alas, the above simple strategy does not work for the
1934 environments with anti-aliased text: if the same text is
1935 drawn onto the same place multiple times, it gets thicker.
1936 If the overlap we are processing is for the erased cursor, we
1937 take the intersection with the rectagle of the cursor. */
1938 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
1940 XRectangle rc
, r_save
= r
;
1942 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
1943 rc
.y
= s
->w
->phys_cursor
.y
;
1944 rc
.width
= s
->w
->phys_cursor_width
;
1945 rc
.height
= s
->w
->phys_cursor_height
;
1947 x_intersect_rectangles (&r_save
, &rc
, &r
);
1952 /* Don't use S->y for clipping because it doesn't take partially
1953 visible lines into account. For example, it can be negative for
1954 partially visible lines at the top of a window. */
1955 if (!s
->row
->full_width_p
1956 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
1957 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1959 r
.y
= max (0, s
->row
->y
);
1962 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
1964 /* If drawing the cursor, don't let glyph draw outside its
1965 advertised boundaries. Cleartype does this under some circumstances. */
1966 if (s
->hl
== DRAW_CURSOR
)
1968 struct glyph
*glyph
= s
->first_glyph
;
1973 r
.width
-= s
->x
- r
.x
;
1976 r
.width
= min (r
.width
, glyph
->pixel_width
);
1978 /* If r.y is below window bottom, ensure that we still see a cursor. */
1979 height
= min (glyph
->ascent
+ glyph
->descent
,
1980 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
1981 max_y
= window_text_bottom_y (s
->w
) - height
;
1982 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
1983 if (s
->ybase
- glyph
->ascent
> max_y
)
1990 /* Don't draw cursor glyph taller than our actual glyph. */
1991 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
1992 if (height
< r
.height
)
1994 max_y
= r
.y
+ r
.height
;
1995 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
1996 r
.height
= min (max_y
- r
.y
, height
);
2003 XRectangle r_save
= r
;
2005 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
2009 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
2010 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
2012 #ifdef CONVERT_FROM_XRECT
2013 CONVERT_FROM_XRECT (r
, *rects
);
2021 /* If we are processing overlapping and allowed to return
2022 multiple clipping rectangles, we exclude the row of the glyph
2023 string from the clipping rectangle. This is to avoid drawing
2024 the same text on the environment with anti-aliasing. */
2025 #ifdef CONVERT_FROM_XRECT
2028 XRectangle
*rs
= rects
;
2030 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2032 if (s
->for_overlaps
& OVERLAPS_PRED
)
2035 if (r
.y
+ r
.height
> row_y
)
2038 rs
[i
].height
= row_y
- r
.y
;
2044 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2047 if (r
.y
< row_y
+ s
->row
->visible_height
)
2049 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2051 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2052 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2061 #ifdef CONVERT_FROM_XRECT
2062 for (i
= 0; i
< n
; i
++)
2063 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2070 Return in *NR the clipping rectangle for glyph string S. */
2073 get_glyph_string_clip_rect (s
, nr
)
2074 struct glyph_string
*s
;
2075 NativeRectangle
*nr
;
2077 get_glyph_string_clip_rects (s
, nr
, 1);
2082 Return the position and height of the phys cursor in window W.
2083 Set w->phys_cursor_width to width of phys cursor.
2087 get_phys_cursor_geometry (w
, row
, glyph
, xp
, yp
, heightp
)
2089 struct glyph_row
*row
;
2090 struct glyph
*glyph
;
2091 int *xp
, *yp
, *heightp
;
2093 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2094 int x
, y
, wd
, h
, h0
, y0
;
2096 /* Compute the width of the rectangle to draw. If on a stretch
2097 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2098 rectangle as wide as the glyph, but use a canonical character
2100 wd
= glyph
->pixel_width
- 1;
2101 #if defined(HAVE_NTGUI) || defined(HAVE_NS)
2105 x
= w
->phys_cursor
.x
;
2112 if (glyph
->type
== STRETCH_GLYPH
2113 && !x_stretch_cursor_p
)
2114 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2115 w
->phys_cursor_width
= wd
;
2117 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
2119 /* If y is below window bottom, ensure that we still see a cursor. */
2120 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2122 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
2123 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
2125 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2128 h
= max (h
- (y0
- y
) + 1, h0
);
2133 y0
= window_text_bottom_y (w
) - h0
;
2141 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2142 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2147 * Remember which glyph the mouse is over.
2151 remember_mouse_glyph (f
, gx
, gy
, rect
)
2154 NativeRectangle
*rect
;
2158 struct glyph_row
*r
, *gr
, *end_row
;
2159 enum window_part part
;
2160 enum glyph_row_area area
;
2161 int x
, y
, width
, height
;
2163 /* Try to determine frame pixel position and size of the glyph under
2164 frame pixel coordinates X/Y on frame F. */
2166 if (!f
->glyphs_initialized_p
2167 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, &x
, &y
, 0),
2170 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2171 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2175 w
= XWINDOW (window
);
2176 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2177 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2179 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2180 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2182 if (w
->pseudo_window_p
)
2185 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2191 case ON_LEFT_MARGIN
:
2192 area
= LEFT_MARGIN_AREA
;
2195 case ON_RIGHT_MARGIN
:
2196 area
= RIGHT_MARGIN_AREA
;
2199 case ON_HEADER_LINE
:
2201 gr
= (part
== ON_HEADER_LINE
2202 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2203 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2206 goto text_glyph_row_found
;
2213 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2214 if (r
->y
+ r
->height
> y
)
2220 text_glyph_row_found
:
2223 struct glyph
*g
= gr
->glyphs
[area
];
2224 struct glyph
*end
= g
+ gr
->used
[area
];
2226 height
= gr
->height
;
2227 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2228 if (gx
+ g
->pixel_width
> x
)
2233 if (g
->type
== IMAGE_GLYPH
)
2235 /* Don't remember when mouse is over image, as
2236 image may have hot-spots. */
2237 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2240 width
= g
->pixel_width
;
2244 /* Use nominal char spacing at end of line. */
2246 gx
+= (x
/ width
) * width
;
2249 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2250 gx
+= window_box_left_offset (w
, area
);
2254 /* Use nominal line height at end of window. */
2255 gx
= (x
/ width
) * width
;
2257 gy
+= (y
/ height
) * height
;
2261 case ON_LEFT_FRINGE
:
2262 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2263 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2264 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2265 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2268 case ON_RIGHT_FRINGE
:
2269 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2270 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2271 : window_box_right_offset (w
, TEXT_AREA
));
2272 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2276 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2278 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2279 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2280 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2282 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2286 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2287 if (r
->y
+ r
->height
> y
)
2294 height
= gr
->height
;
2297 /* Use nominal line height at end of window. */
2299 gy
+= (y
/ height
) * height
;
2306 /* If there is no glyph under the mouse, then we divide the screen
2307 into a grid of the smallest glyph in the frame, and use that
2310 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2311 round down even for negative values. */
2317 gx
= (gx
/ width
) * width
;
2318 gy
= (gy
/ height
) * height
;
2323 gx
+= WINDOW_LEFT_EDGE_X (w
);
2324 gy
+= WINDOW_TOP_EDGE_Y (w
);
2327 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2329 /* Visible feedback for debugging. */
2332 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2333 f
->output_data
.x
->normal_gc
,
2334 gx
, gy
, width
, height
);
2340 #endif /* HAVE_WINDOW_SYSTEM */
2343 /***********************************************************************
2344 Lisp form evaluation
2345 ***********************************************************************/
2347 /* Error handler for safe_eval and safe_call. */
2350 safe_eval_handler (arg
)
2353 add_to_log ("Error during redisplay: %s", arg
, Qnil
);
2358 /* Evaluate SEXPR and return the result, or nil if something went
2359 wrong. Prevent redisplay during the evaluation. */
2361 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
2362 Return the result, or nil if something went wrong. Prevent
2363 redisplay during the evaluation. */
2366 safe_call (nargs
, args
)
2372 if (inhibit_eval_during_redisplay
)
2376 int count
= SPECPDL_INDEX ();
2377 struct gcpro gcpro1
;
2380 gcpro1
.nvars
= nargs
;
2381 specbind (Qinhibit_redisplay
, Qt
);
2382 /* Use Qt to ensure debugger does not run,
2383 so there is no possibility of wanting to redisplay. */
2384 val
= internal_condition_case_2 (Ffuncall
, nargs
, args
, Qt
,
2387 val
= unbind_to (count
, val
);
2394 /* Call function FN with one argument ARG.
2395 Return the result, or nil if something went wrong. */
2398 safe_call1 (fn
, arg
)
2399 Lisp_Object fn
, arg
;
2401 Lisp_Object args
[2];
2404 return safe_call (2, args
);
2407 static Lisp_Object Qeval
;
2410 safe_eval (Lisp_Object sexpr
)
2412 return safe_call1 (Qeval
, sexpr
);
2415 /* Call function FN with one argument ARG.
2416 Return the result, or nil if something went wrong. */
2419 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2421 Lisp_Object args
[3];
2425 return safe_call (3, args
);
2430 /***********************************************************************
2432 ***********************************************************************/
2436 /* Define CHECK_IT to perform sanity checks on iterators.
2437 This is for debugging. It is too slow to do unconditionally. */
2443 if (it
->method
== GET_FROM_STRING
)
2445 xassert (STRINGP (it
->string
));
2446 xassert (IT_STRING_CHARPOS (*it
) >= 0);
2450 xassert (IT_STRING_CHARPOS (*it
) < 0);
2451 if (it
->method
== GET_FROM_BUFFER
)
2453 /* Check that character and byte positions agree. */
2454 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2459 xassert (it
->current
.dpvec_index
>= 0);
2461 xassert (it
->current
.dpvec_index
< 0);
2464 #define CHECK_IT(IT) check_it ((IT))
2468 #define CHECK_IT(IT) (void) 0
2475 /* Check that the window end of window W is what we expect it
2476 to be---the last row in the current matrix displaying text. */
2479 check_window_end (w
)
2482 if (!MINI_WINDOW_P (w
)
2483 && !NILP (w
->window_end_valid
))
2485 struct glyph_row
*row
;
2486 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
2487 XFASTINT (w
->window_end_vpos
)),
2489 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2490 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2494 #define CHECK_WINDOW_END(W) check_window_end ((W))
2496 #else /* not GLYPH_DEBUG */
2498 #define CHECK_WINDOW_END(W) (void) 0
2500 #endif /* not GLYPH_DEBUG */
2504 /***********************************************************************
2505 Iterator initialization
2506 ***********************************************************************/
2508 /* Initialize IT for displaying current_buffer in window W, starting
2509 at character position CHARPOS. CHARPOS < 0 means that no buffer
2510 position is specified which is useful when the iterator is assigned
2511 a position later. BYTEPOS is the byte position corresponding to
2512 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2514 If ROW is not null, calls to produce_glyphs with IT as parameter
2515 will produce glyphs in that row.
2517 BASE_FACE_ID is the id of a base face to use. It must be one of
2518 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2519 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2520 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2522 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2523 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2524 will be initialized to use the corresponding mode line glyph row of
2525 the desired matrix of W. */
2528 init_iterator (it
, w
, charpos
, bytepos
, row
, base_face_id
)
2531 int charpos
, bytepos
;
2532 struct glyph_row
*row
;
2533 enum face_id base_face_id
;
2535 int highlight_region_p
;
2536 enum face_id remapped_base_face_id
= base_face_id
;
2538 /* Some precondition checks. */
2539 xassert (w
!= NULL
&& it
!= NULL
);
2540 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2543 /* If face attributes have been changed since the last redisplay,
2544 free realized faces now because they depend on face definitions
2545 that might have changed. Don't free faces while there might be
2546 desired matrices pending which reference these faces. */
2547 if (face_change_count
&& !inhibit_free_realized_faces
)
2549 face_change_count
= 0;
2550 free_all_realized_faces (Qnil
);
2553 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2554 if (! NILP (Vface_remapping_alist
))
2555 remapped_base_face_id
= lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2557 /* Use one of the mode line rows of W's desired matrix if
2561 if (base_face_id
== MODE_LINE_FACE_ID
2562 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2563 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2564 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2565 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2569 bzero (it
, sizeof *it
);
2570 it
->current
.overlay_string_index
= -1;
2571 it
->current
.dpvec_index
= -1;
2572 it
->base_face_id
= remapped_base_face_id
;
2574 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2576 /* The window in which we iterate over current_buffer: */
2577 XSETWINDOW (it
->window
, w
);
2579 it
->f
= XFRAME (w
->frame
);
2583 /* Extra space between lines (on window systems only). */
2584 if (base_face_id
== DEFAULT_FACE_ID
2585 && FRAME_WINDOW_P (it
->f
))
2587 if (NATNUMP (current_buffer
->extra_line_spacing
))
2588 it
->extra_line_spacing
= XFASTINT (current_buffer
->extra_line_spacing
);
2589 else if (FLOATP (current_buffer
->extra_line_spacing
))
2590 it
->extra_line_spacing
= (XFLOAT_DATA (current_buffer
->extra_line_spacing
)
2591 * FRAME_LINE_HEIGHT (it
->f
));
2592 else if (it
->f
->extra_line_spacing
> 0)
2593 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2594 it
->max_extra_line_spacing
= 0;
2597 /* If realized faces have been removed, e.g. because of face
2598 attribute changes of named faces, recompute them. When running
2599 in batch mode, the face cache of the initial frame is null. If
2600 we happen to get called, make a dummy face cache. */
2601 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2602 init_frame_faces (it
->f
);
2603 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2604 recompute_basic_faces (it
->f
);
2606 /* Current value of the `slice', `space-width', and 'height' properties. */
2607 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2608 it
->space_width
= Qnil
;
2609 it
->font_height
= Qnil
;
2610 it
->override_ascent
= -1;
2612 /* Are control characters displayed as `^C'? */
2613 it
->ctl_arrow_p
= !NILP (current_buffer
->ctl_arrow
);
2615 /* -1 means everything between a CR and the following line end
2616 is invisible. >0 means lines indented more than this value are
2618 it
->selective
= (INTEGERP (current_buffer
->selective_display
)
2619 ? XFASTINT (current_buffer
->selective_display
)
2620 : (!NILP (current_buffer
->selective_display
)
2622 it
->selective_display_ellipsis_p
2623 = !NILP (current_buffer
->selective_display_ellipses
);
2625 /* Display table to use. */
2626 it
->dp
= window_display_table (w
);
2628 /* Are multibyte characters enabled in current_buffer? */
2629 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
2631 /* Non-zero if we should highlight the region. */
2633 = (!NILP (Vtransient_mark_mode
)
2634 && !NILP (current_buffer
->mark_active
)
2635 && XMARKER (current_buffer
->mark
)->buffer
!= 0);
2637 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2638 start and end of a visible region in window IT->w. Set both to
2639 -1 to indicate no region. */
2640 if (highlight_region_p
2641 /* Maybe highlight only in selected window. */
2642 && (/* Either show region everywhere. */
2643 highlight_nonselected_windows
2644 /* Or show region in the selected window. */
2645 || w
== XWINDOW (selected_window
)
2646 /* Or show the region if we are in the mini-buffer and W is
2647 the window the mini-buffer refers to. */
2648 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2649 && WINDOWP (minibuf_selected_window
)
2650 && w
== XWINDOW (minibuf_selected_window
))))
2652 int charpos
= marker_position (current_buffer
->mark
);
2653 it
->region_beg_charpos
= min (PT
, charpos
);
2654 it
->region_end_charpos
= max (PT
, charpos
);
2657 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2659 /* Get the position at which the redisplay_end_trigger hook should
2660 be run, if it is to be run at all. */
2661 if (MARKERP (w
->redisplay_end_trigger
)
2662 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2663 it
->redisplay_end_trigger_charpos
2664 = marker_position (w
->redisplay_end_trigger
);
2665 else if (INTEGERP (w
->redisplay_end_trigger
))
2666 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
2668 /* Correct bogus values of tab_width. */
2669 it
->tab_width
= XINT (current_buffer
->tab_width
);
2670 if (it
->tab_width
<= 0 || it
->tab_width
> 1000)
2673 /* Are lines in the display truncated? */
2674 if (base_face_id
!= DEFAULT_FACE_ID
2675 || XINT (it
->w
->hscroll
)
2676 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2677 && ((!NILP (Vtruncate_partial_width_windows
)
2678 && !INTEGERP (Vtruncate_partial_width_windows
))
2679 || (INTEGERP (Vtruncate_partial_width_windows
)
2680 && (WINDOW_TOTAL_COLS (it
->w
)
2681 < XINT (Vtruncate_partial_width_windows
))))))
2682 it
->line_wrap
= TRUNCATE
;
2683 else if (NILP (current_buffer
->truncate_lines
))
2684 it
->line_wrap
= NILP (current_buffer
->word_wrap
)
2685 ? WINDOW_WRAP
: WORD_WRAP
;
2687 it
->line_wrap
= TRUNCATE
;
2689 /* Get dimensions of truncation and continuation glyphs. These are
2690 displayed as fringe bitmaps under X, so we don't need them for such
2692 if (!FRAME_WINDOW_P (it
->f
))
2694 if (it
->line_wrap
== TRUNCATE
)
2696 /* We will need the truncation glyph. */
2697 xassert (it
->glyph_row
== NULL
);
2698 produce_special_glyphs (it
, IT_TRUNCATION
);
2699 it
->truncation_pixel_width
= it
->pixel_width
;
2703 /* We will need the continuation glyph. */
2704 xassert (it
->glyph_row
== NULL
);
2705 produce_special_glyphs (it
, IT_CONTINUATION
);
2706 it
->continuation_pixel_width
= it
->pixel_width
;
2709 /* Reset these values to zero because the produce_special_glyphs
2710 above has changed them. */
2711 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2712 it
->phys_ascent
= it
->phys_descent
= 0;
2715 /* Set this after getting the dimensions of truncation and
2716 continuation glyphs, so that we don't produce glyphs when calling
2717 produce_special_glyphs, above. */
2718 it
->glyph_row
= row
;
2719 it
->area
= TEXT_AREA
;
2721 /* Get the dimensions of the display area. The display area
2722 consists of the visible window area plus a horizontally scrolled
2723 part to the left of the window. All x-values are relative to the
2724 start of this total display area. */
2725 if (base_face_id
!= DEFAULT_FACE_ID
)
2727 /* Mode lines, menu bar in terminal frames. */
2728 it
->first_visible_x
= 0;
2729 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2734 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2735 it
->last_visible_x
= (it
->first_visible_x
2736 + window_box_width (w
, TEXT_AREA
));
2738 /* If we truncate lines, leave room for the truncator glyph(s) at
2739 the right margin. Otherwise, leave room for the continuation
2740 glyph(s). Truncation and continuation glyphs are not inserted
2741 for window-based redisplay. */
2742 if (!FRAME_WINDOW_P (it
->f
))
2744 if (it
->line_wrap
== TRUNCATE
)
2745 it
->last_visible_x
-= it
->truncation_pixel_width
;
2747 it
->last_visible_x
-= it
->continuation_pixel_width
;
2750 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2751 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2754 /* Leave room for a border glyph. */
2755 if (!FRAME_WINDOW_P (it
->f
)
2756 && !WINDOW_RIGHTMOST_P (it
->w
))
2757 it
->last_visible_x
-= 1;
2759 it
->last_visible_y
= window_text_bottom_y (w
);
2761 /* For mode lines and alike, arrange for the first glyph having a
2762 left box line if the face specifies a box. */
2763 if (base_face_id
!= DEFAULT_FACE_ID
)
2767 it
->face_id
= remapped_base_face_id
;
2769 /* If we have a boxed mode line, make the first character appear
2770 with a left box line. */
2771 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2772 if (face
->box
!= FACE_NO_BOX
)
2773 it
->start_of_box_run_p
= 1;
2776 /* If a buffer position was specified, set the iterator there,
2777 getting overlays and face properties from that position. */
2778 if (charpos
>= BUF_BEG (current_buffer
))
2780 it
->end_charpos
= ZV
;
2782 IT_CHARPOS (*it
) = charpos
;
2784 /* Compute byte position if not specified. */
2785 if (bytepos
< charpos
)
2786 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2788 IT_BYTEPOS (*it
) = bytepos
;
2790 it
->start
= it
->current
;
2792 /* Compute faces etc. */
2793 reseat (it
, it
->current
.pos
, 1);
2800 /* Initialize IT for the display of window W with window start POS. */
2803 start_display (it
, w
, pos
)
2806 struct text_pos pos
;
2808 struct glyph_row
*row
;
2809 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2811 row
= w
->desired_matrix
->rows
+ first_vpos
;
2812 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2813 it
->first_vpos
= first_vpos
;
2815 /* Don't reseat to previous visible line start if current start
2816 position is in a string or image. */
2817 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2819 int start_at_line_beg_p
;
2820 int first_y
= it
->current_y
;
2822 /* If window start is not at a line start, skip forward to POS to
2823 get the correct continuation lines width. */
2824 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2825 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2826 if (!start_at_line_beg_p
)
2830 reseat_at_previous_visible_line_start (it
);
2831 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2833 new_x
= it
->current_x
+ it
->pixel_width
;
2835 /* If lines are continued, this line may end in the middle
2836 of a multi-glyph character (e.g. a control character
2837 displayed as \003, or in the middle of an overlay
2838 string). In this case move_it_to above will not have
2839 taken us to the start of the continuation line but to the
2840 end of the continued line. */
2841 if (it
->current_x
> 0
2842 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2843 && (/* And glyph doesn't fit on the line. */
2844 new_x
> it
->last_visible_x
2845 /* Or it fits exactly and we're on a window
2847 || (new_x
== it
->last_visible_x
2848 && FRAME_WINDOW_P (it
->f
))))
2850 if (it
->current
.dpvec_index
>= 0
2851 || it
->current
.overlay_string_index
>= 0)
2853 set_iterator_to_next (it
, 1);
2854 move_it_in_display_line_to (it
, -1, -1, 0);
2857 it
->continuation_lines_width
+= it
->current_x
;
2860 /* We're starting a new display line, not affected by the
2861 height of the continued line, so clear the appropriate
2862 fields in the iterator structure. */
2863 it
->max_ascent
= it
->max_descent
= 0;
2864 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2866 it
->current_y
= first_y
;
2868 it
->current_x
= it
->hpos
= 0;
2874 /* Return 1 if POS is a position in ellipses displayed for invisible
2875 text. W is the window we display, for text property lookup. */
2878 in_ellipses_for_invisible_text_p (pos
, w
)
2879 struct display_pos
*pos
;
2882 Lisp_Object prop
, window
;
2884 int charpos
= CHARPOS (pos
->pos
);
2886 /* If POS specifies a position in a display vector, this might
2887 be for an ellipsis displayed for invisible text. We won't
2888 get the iterator set up for delivering that ellipsis unless
2889 we make sure that it gets aware of the invisible text. */
2890 if (pos
->dpvec_index
>= 0
2891 && pos
->overlay_string_index
< 0
2892 && CHARPOS (pos
->string_pos
) < 0
2894 && (XSETWINDOW (window
, w
),
2895 prop
= Fget_char_property (make_number (charpos
),
2896 Qinvisible
, window
),
2897 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2899 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2901 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2908 /* Initialize IT for stepping through current_buffer in window W,
2909 starting at position POS that includes overlay string and display
2910 vector/ control character translation position information. Value
2911 is zero if there are overlay strings with newlines at POS. */
2914 init_from_display_pos (it
, w
, pos
)
2917 struct display_pos
*pos
;
2919 int charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
2920 int i
, overlay_strings_with_newlines
= 0;
2922 /* If POS specifies a position in a display vector, this might
2923 be for an ellipsis displayed for invisible text. We won't
2924 get the iterator set up for delivering that ellipsis unless
2925 we make sure that it gets aware of the invisible text. */
2926 if (in_ellipses_for_invisible_text_p (pos
, w
))
2932 /* Keep in mind: the call to reseat in init_iterator skips invisible
2933 text, so we might end up at a position different from POS. This
2934 is only a problem when POS is a row start after a newline and an
2935 overlay starts there with an after-string, and the overlay has an
2936 invisible property. Since we don't skip invisible text in
2937 display_line and elsewhere immediately after consuming the
2938 newline before the row start, such a POS will not be in a string,
2939 but the call to init_iterator below will move us to the
2941 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
2943 /* This only scans the current chunk -- it should scan all chunks.
2944 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
2945 to 16 in 22.1 to make this a lesser problem. */
2946 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
2948 const char *s
= SDATA (it
->overlay_strings
[i
]);
2949 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
2951 while (s
< e
&& *s
!= '\n')
2956 overlay_strings_with_newlines
= 1;
2961 /* If position is within an overlay string, set up IT to the right
2963 if (pos
->overlay_string_index
>= 0)
2967 /* If the first overlay string happens to have a `display'
2968 property for an image, the iterator will be set up for that
2969 image, and we have to undo that setup first before we can
2970 correct the overlay string index. */
2971 if (it
->method
== GET_FROM_IMAGE
)
2974 /* We already have the first chunk of overlay strings in
2975 IT->overlay_strings. Load more until the one for
2976 pos->overlay_string_index is in IT->overlay_strings. */
2977 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
2979 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
2980 it
->current
.overlay_string_index
= 0;
2983 load_overlay_strings (it
, 0);
2984 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
2988 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
2989 relative_index
= (it
->current
.overlay_string_index
2990 % OVERLAY_STRING_CHUNK_SIZE
);
2991 it
->string
= it
->overlay_strings
[relative_index
];
2992 xassert (STRINGP (it
->string
));
2993 it
->current
.string_pos
= pos
->string_pos
;
2994 it
->method
= GET_FROM_STRING
;
2997 if (CHARPOS (pos
->string_pos
) >= 0)
2999 /* Recorded position is not in an overlay string, but in another
3000 string. This can only be a string from a `display' property.
3001 IT should already be filled with that string. */
3002 it
->current
.string_pos
= pos
->string_pos
;
3003 xassert (STRINGP (it
->string
));
3006 /* Restore position in display vector translations, control
3007 character translations or ellipses. */
3008 if (pos
->dpvec_index
>= 0)
3010 if (it
->dpvec
== NULL
)
3011 get_next_display_element (it
);
3012 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3013 it
->current
.dpvec_index
= pos
->dpvec_index
;
3017 return !overlay_strings_with_newlines
;
3021 /* Initialize IT for stepping through current_buffer in window W
3022 starting at ROW->start. */
3025 init_to_row_start (it
, w
, row
)
3028 struct glyph_row
*row
;
3030 init_from_display_pos (it
, w
, &row
->start
);
3031 it
->start
= row
->start
;
3032 it
->continuation_lines_width
= row
->continuation_lines_width
;
3037 /* Initialize IT for stepping through current_buffer in window W
3038 starting in the line following ROW, i.e. starting at ROW->end.
3039 Value is zero if there are overlay strings with newlines at ROW's
3043 init_to_row_end (it
, w
, row
)
3046 struct glyph_row
*row
;
3050 if (init_from_display_pos (it
, w
, &row
->end
))
3052 if (row
->continued_p
)
3053 it
->continuation_lines_width
3054 = row
->continuation_lines_width
+ row
->pixel_width
;
3065 /***********************************************************************
3067 ***********************************************************************/
3069 /* Called when IT reaches IT->stop_charpos. Handle text property and
3070 overlay changes. Set IT->stop_charpos to the next position where
3077 enum prop_handled handled
;
3078 int handle_overlay_change_p
;
3082 it
->current
.dpvec_index
= -1;
3083 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3084 it
->ignore_overlay_strings_at_pos_p
= 0;
3087 /* Use face of preceding text for ellipsis (if invisible) */
3088 if (it
->selective_display_ellipsis_p
)
3089 it
->saved_face_id
= it
->face_id
;
3093 handled
= HANDLED_NORMALLY
;
3095 /* Call text property handlers. */
3096 for (p
= it_props
; p
->handler
; ++p
)
3098 handled
= p
->handler (it
);
3100 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3102 else if (handled
== HANDLED_RETURN
)
3104 /* We still want to show before and after strings from
3105 overlays even if the actual buffer text is replaced. */
3106 if (!handle_overlay_change_p
3108 || !get_overlay_strings_1 (it
, 0, 0))
3111 setup_for_ellipsis (it
, 0);
3112 /* When handling a display spec, we might load an
3113 empty string. In that case, discard it here. We
3114 used to discard it in handle_single_display_spec,
3115 but that causes get_overlay_strings_1, above, to
3116 ignore overlay strings that we must check. */
3117 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3121 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3125 it
->ignore_overlay_strings_at_pos_p
= 1;
3126 it
->string_from_display_prop_p
= 0;
3127 handle_overlay_change_p
= 0;
3129 handled
= HANDLED_RECOMPUTE_PROPS
;
3132 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3133 handle_overlay_change_p
= 0;
3136 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3138 /* Don't check for overlay strings below when set to deliver
3139 characters from a display vector. */
3140 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3141 handle_overlay_change_p
= 0;
3143 /* Handle overlay changes.
3144 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3145 if it finds overlays. */
3146 if (handle_overlay_change_p
)
3147 handled
= handle_overlay_change (it
);
3152 setup_for_ellipsis (it
, 0);
3156 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3158 /* Determine where to stop next. */
3159 if (handled
== HANDLED_NORMALLY
)
3160 compute_stop_pos (it
);
3164 /* Compute IT->stop_charpos from text property and overlay change
3165 information for IT's current position. */
3168 compute_stop_pos (it
)
3171 register INTERVAL iv
, next_iv
;
3172 Lisp_Object object
, limit
, position
;
3173 EMACS_INT charpos
, bytepos
;
3175 /* If nowhere else, stop at the end. */
3176 it
->stop_charpos
= it
->end_charpos
;
3178 if (STRINGP (it
->string
))
3180 /* Strings are usually short, so don't limit the search for
3182 object
= it
->string
;
3184 charpos
= IT_STRING_CHARPOS (*it
);
3185 bytepos
= IT_STRING_BYTEPOS (*it
);
3191 /* If next overlay change is in front of the current stop pos
3192 (which is IT->end_charpos), stop there. Note: value of
3193 next_overlay_change is point-max if no overlay change
3195 charpos
= IT_CHARPOS (*it
);
3196 bytepos
= IT_BYTEPOS (*it
);
3197 pos
= next_overlay_change (charpos
);
3198 if (pos
< it
->stop_charpos
)
3199 it
->stop_charpos
= pos
;
3201 /* If showing the region, we have to stop at the region
3202 start or end because the face might change there. */
3203 if (it
->region_beg_charpos
> 0)
3205 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3206 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3207 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3208 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3211 /* Set up variables for computing the stop position from text
3212 property changes. */
3213 XSETBUFFER (object
, current_buffer
);
3214 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3217 /* Get the interval containing IT's position. Value is a null
3218 interval if there isn't such an interval. */
3219 position
= make_number (charpos
);
3220 iv
= validate_interval_range (object
, &position
, &position
, 0);
3221 if (!NULL_INTERVAL_P (iv
))
3223 Lisp_Object values_here
[LAST_PROP_IDX
];
3226 /* Get properties here. */
3227 for (p
= it_props
; p
->handler
; ++p
)
3228 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3230 /* Look for an interval following iv that has different
3232 for (next_iv
= next_interval (iv
);
3233 (!NULL_INTERVAL_P (next_iv
)
3235 || XFASTINT (limit
) > next_iv
->position
));
3236 next_iv
= next_interval (next_iv
))
3238 for (p
= it_props
; p
->handler
; ++p
)
3240 Lisp_Object new_value
;
3242 new_value
= textget (next_iv
->plist
, *p
->name
);
3243 if (!EQ (values_here
[p
->idx
], new_value
))
3251 if (!NULL_INTERVAL_P (next_iv
))
3253 if (INTEGERP (limit
)
3254 && next_iv
->position
>= XFASTINT (limit
))
3255 /* No text property change up to limit. */
3256 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3258 /* Text properties change in next_iv. */
3259 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3263 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3264 it
->stop_charpos
, it
->string
);
3266 xassert (STRINGP (it
->string
)
3267 || (it
->stop_charpos
>= BEGV
3268 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3272 /* Return the position of the next overlay change after POS in
3273 current_buffer. Value is point-max if no overlay change
3274 follows. This is like `next-overlay-change' but doesn't use
3278 next_overlay_change (pos
)
3283 Lisp_Object
*overlays
;
3286 /* Get all overlays at the given position. */
3287 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3289 /* If any of these overlays ends before endpos,
3290 use its ending point instead. */
3291 for (i
= 0; i
< noverlays
; ++i
)
3296 oend
= OVERLAY_END (overlays
[i
]);
3297 oendpos
= OVERLAY_POSITION (oend
);
3298 endpos
= min (endpos
, oendpos
);
3306 /***********************************************************************
3308 ***********************************************************************/
3310 /* Handle changes in the `fontified' property of the current buffer by
3311 calling hook functions from Qfontification_functions to fontify
3314 static enum prop_handled
3315 handle_fontified_prop (it
)
3318 Lisp_Object prop
, pos
;
3319 enum prop_handled handled
= HANDLED_NORMALLY
;
3321 if (!NILP (Vmemory_full
))
3324 /* Get the value of the `fontified' property at IT's current buffer
3325 position. (The `fontified' property doesn't have a special
3326 meaning in strings.) If the value is nil, call functions from
3327 Qfontification_functions. */
3328 if (!STRINGP (it
->string
)
3330 && !NILP (Vfontification_functions
)
3331 && !NILP (Vrun_hooks
)
3332 && (pos
= make_number (IT_CHARPOS (*it
)),
3333 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3334 /* Ignore the special cased nil value always present at EOB since
3335 no amount of fontifying will be able to change it. */
3336 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3338 int count
= SPECPDL_INDEX ();
3341 val
= Vfontification_functions
;
3342 specbind (Qfontification_functions
, Qnil
);
3344 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3345 safe_call1 (val
, pos
);
3348 Lisp_Object globals
, fn
;
3349 struct gcpro gcpro1
, gcpro2
;
3352 GCPRO2 (val
, globals
);
3354 for (; CONSP (val
); val
= XCDR (val
))
3360 /* A value of t indicates this hook has a local
3361 binding; it means to run the global binding too.
3362 In a global value, t should not occur. If it
3363 does, we must ignore it to avoid an endless
3365 for (globals
= Fdefault_value (Qfontification_functions
);
3367 globals
= XCDR (globals
))
3369 fn
= XCAR (globals
);
3371 safe_call1 (fn
, pos
);
3375 safe_call1 (fn
, pos
);
3381 unbind_to (count
, Qnil
);
3383 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3384 something. This avoids an endless loop if they failed to
3385 fontify the text for which reason ever. */
3386 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3387 handled
= HANDLED_RECOMPUTE_PROPS
;
3395 /***********************************************************************
3397 ***********************************************************************/
3399 /* Set up iterator IT from face properties at its current position.
3400 Called from handle_stop. */
3402 static enum prop_handled
3403 handle_face_prop (it
)
3407 EMACS_INT next_stop
;
3409 if (!STRINGP (it
->string
))
3412 = face_at_buffer_position (it
->w
,
3414 it
->region_beg_charpos
,
3415 it
->region_end_charpos
,
3418 + TEXT_PROP_DISTANCE_LIMIT
),
3419 0, it
->base_face_id
);
3421 /* Is this a start of a run of characters with box face?
3422 Caveat: this can be called for a freshly initialized
3423 iterator; face_id is -1 in this case. We know that the new
3424 face will not change until limit, i.e. if the new face has a
3425 box, all characters up to limit will have one. But, as
3426 usual, we don't know whether limit is really the end. */
3427 if (new_face_id
!= it
->face_id
)
3429 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3431 /* If new face has a box but old face has not, this is
3432 the start of a run of characters with box, i.e. it has
3433 a shadow on the left side. The value of face_id of the
3434 iterator will be -1 if this is the initial call that gets
3435 the face. In this case, we have to look in front of IT's
3436 position and see whether there is a face != new_face_id. */
3437 it
->start_of_box_run_p
3438 = (new_face
->box
!= FACE_NO_BOX
3439 && (it
->face_id
>= 0
3440 || IT_CHARPOS (*it
) == BEG
3441 || new_face_id
!= face_before_it_pos (it
)));
3442 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3447 int base_face_id
, bufpos
;
3449 Lisp_Object from_overlay
3450 = (it
->current
.overlay_string_index
>= 0
3451 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3454 /* See if we got to this string directly or indirectly from
3455 an overlay property. That includes the before-string or
3456 after-string of an overlay, strings in display properties
3457 provided by an overlay, their text properties, etc.
3459 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3460 if (! NILP (from_overlay
))
3461 for (i
= it
->sp
- 1; i
>= 0; i
--)
3463 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3465 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3466 else if (! NILP (it
->stack
[i
].from_overlay
))
3467 from_overlay
= it
->stack
[i
].from_overlay
;
3469 if (!NILP (from_overlay
))
3473 if (! NILP (from_overlay
))
3475 bufpos
= IT_CHARPOS (*it
);
3476 /* For a string from an overlay, the base face depends
3477 only on text properties and ignores overlays. */
3479 = face_for_overlay_string (it
->w
,
3481 it
->region_beg_charpos
,
3482 it
->region_end_charpos
,
3485 + TEXT_PROP_DISTANCE_LIMIT
),
3493 /* For strings from a `display' property, use the face at
3494 IT's current buffer position as the base face to merge
3495 with, so that overlay strings appear in the same face as
3496 surrounding text, unless they specify their own
3498 base_face_id
= underlying_face_id (it
);
3501 new_face_id
= face_at_string_position (it
->w
,
3503 IT_STRING_CHARPOS (*it
),
3505 it
->region_beg_charpos
,
3506 it
->region_end_charpos
,
3510 /* Is this a start of a run of characters with box? Caveat:
3511 this can be called for a freshly allocated iterator; face_id
3512 is -1 is this case. We know that the new face will not
3513 change until the next check pos, i.e. if the new face has a
3514 box, all characters up to that position will have a
3515 box. But, as usual, we don't know whether that position
3516 is really the end. */
3517 if (new_face_id
!= it
->face_id
)
3519 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3520 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3522 /* If new face has a box but old face hasn't, this is the
3523 start of a run of characters with box, i.e. it has a
3524 shadow on the left side. */
3525 it
->start_of_box_run_p
3526 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3527 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3531 it
->face_id
= new_face_id
;
3532 return HANDLED_NORMALLY
;
3536 /* Return the ID of the face ``underlying'' IT's current position,
3537 which is in a string. If the iterator is associated with a
3538 buffer, return the face at IT's current buffer position.
3539 Otherwise, use the iterator's base_face_id. */
3542 underlying_face_id (it
)
3545 int face_id
= it
->base_face_id
, i
;
3547 xassert (STRINGP (it
->string
));
3549 for (i
= it
->sp
- 1; i
>= 0; --i
)
3550 if (NILP (it
->stack
[i
].string
))
3551 face_id
= it
->stack
[i
].face_id
;
3557 /* Compute the face one character before or after the current position
3558 of IT. BEFORE_P non-zero means get the face in front of IT's
3559 position. Value is the id of the face. */
3562 face_before_or_after_it_pos (it
, before_p
)
3567 EMACS_INT next_check_charpos
;
3568 struct text_pos pos
;
3570 xassert (it
->s
== NULL
);
3572 if (STRINGP (it
->string
))
3574 int bufpos
, base_face_id
;
3576 /* No face change past the end of the string (for the case
3577 we are padding with spaces). No face change before the
3579 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3580 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3583 /* Set pos to the position before or after IT's current position. */
3585 pos
= string_pos (IT_STRING_CHARPOS (*it
) - 1, it
->string
);
3587 /* For composition, we must check the character after the
3589 pos
= (it
->what
== IT_COMPOSITION
3590 ? string_pos (IT_STRING_CHARPOS (*it
)
3591 + it
->cmp_it
.nchars
, it
->string
)
3592 : string_pos (IT_STRING_CHARPOS (*it
) + 1, it
->string
));
3594 if (it
->current
.overlay_string_index
>= 0)
3595 bufpos
= IT_CHARPOS (*it
);
3599 base_face_id
= underlying_face_id (it
);
3601 /* Get the face for ASCII, or unibyte. */
3602 face_id
= face_at_string_position (it
->w
,
3606 it
->region_beg_charpos
,
3607 it
->region_end_charpos
,
3608 &next_check_charpos
,
3611 /* Correct the face for charsets different from ASCII. Do it
3612 for the multibyte case only. The face returned above is
3613 suitable for unibyte text if IT->string is unibyte. */
3614 if (STRING_MULTIBYTE (it
->string
))
3616 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos
);
3617 int rest
= SBYTES (it
->string
) - BYTEPOS (pos
);
3619 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3621 c
= string_char_and_length (p
, &len
);
3622 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), it
->string
);
3627 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3628 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3631 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3632 pos
= it
->current
.pos
;
3635 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3638 if (it
->what
== IT_COMPOSITION
)
3639 /* For composition, we must check the position after the
3641 pos
.charpos
+= it
->cmp_it
.nchars
, pos
.bytepos
+= it
->len
;
3643 INC_TEXT_POS (pos
, it
->multibyte_p
);
3646 /* Determine face for CHARSET_ASCII, or unibyte. */
3647 face_id
= face_at_buffer_position (it
->w
,
3649 it
->region_beg_charpos
,
3650 it
->region_end_charpos
,
3651 &next_check_charpos
,
3654 /* Correct the face for charsets different from ASCII. Do it
3655 for the multibyte case only. The face returned above is
3656 suitable for unibyte text if current_buffer is unibyte. */
3657 if (it
->multibyte_p
)
3659 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3660 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3661 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3670 /***********************************************************************
3672 ***********************************************************************/
3674 /* Set up iterator IT from invisible properties at its current
3675 position. Called from handle_stop. */
3677 static enum prop_handled
3678 handle_invisible_prop (it
)
3681 enum prop_handled handled
= HANDLED_NORMALLY
;
3683 if (STRINGP (it
->string
))
3685 extern Lisp_Object Qinvisible
;
3686 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3688 /* Get the value of the invisible text property at the
3689 current position. Value will be nil if there is no such
3691 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3692 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3695 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3697 handled
= HANDLED_RECOMPUTE_PROPS
;
3699 /* Get the position at which the next change of the
3700 invisible text property can be found in IT->string.
3701 Value will be nil if the property value is the same for
3702 all the rest of IT->string. */
3703 XSETINT (limit
, SCHARS (it
->string
));
3704 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3707 /* Text at current position is invisible. The next
3708 change in the property is at position end_charpos.
3709 Move IT's current position to that position. */
3710 if (INTEGERP (end_charpos
)
3711 && XFASTINT (end_charpos
) < XFASTINT (limit
))
3713 struct text_pos old
;
3714 old
= it
->current
.string_pos
;
3715 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3716 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
3720 /* The rest of the string is invisible. If this is an
3721 overlay string, proceed with the next overlay string
3722 or whatever comes and return a character from there. */
3723 if (it
->current
.overlay_string_index
>= 0)
3725 next_overlay_string (it
);
3726 /* Don't check for overlay strings when we just
3727 finished processing them. */
3728 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
3732 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
3733 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
3741 EMACS_INT newpos
, next_stop
, start_charpos
;
3742 Lisp_Object pos
, prop
, overlay
;
3744 /* First of all, is there invisible text at this position? */
3745 start_charpos
= IT_CHARPOS (*it
);
3746 pos
= make_number (IT_CHARPOS (*it
));
3747 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
3749 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3751 /* If we are on invisible text, skip over it. */
3752 if (invis_p
&& IT_CHARPOS (*it
) < it
->end_charpos
)
3754 /* Record whether we have to display an ellipsis for the
3756 int display_ellipsis_p
= invis_p
== 2;
3758 handled
= HANDLED_RECOMPUTE_PROPS
;
3760 /* Loop skipping over invisible text. The loop is left at
3761 ZV or with IT on the first char being visible again. */
3764 /* Try to skip some invisible text. Return value is the
3765 position reached which can be equal to IT's position
3766 if there is nothing invisible here. This skips both
3767 over invisible text properties and overlays with
3768 invisible property. */
3769 newpos
= skip_invisible (IT_CHARPOS (*it
),
3770 &next_stop
, ZV
, it
->window
);
3772 /* If we skipped nothing at all we weren't at invisible
3773 text in the first place. If everything to the end of
3774 the buffer was skipped, end the loop. */
3775 if (newpos
== IT_CHARPOS (*it
) || newpos
>= ZV
)
3779 /* We skipped some characters but not necessarily
3780 all there are. Check if we ended up on visible
3781 text. Fget_char_property returns the property of
3782 the char before the given position, i.e. if we
3783 get invis_p = 0, this means that the char at
3784 newpos is visible. */
3785 pos
= make_number (newpos
);
3786 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
3787 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3790 /* If we ended up on invisible text, proceed to
3791 skip starting with next_stop. */
3793 IT_CHARPOS (*it
) = next_stop
;
3795 /* If there are adjacent invisible texts, don't lose the
3796 second one's ellipsis. */
3798 display_ellipsis_p
= 1;
3802 /* The position newpos is now either ZV or on visible text. */
3803 IT_CHARPOS (*it
) = newpos
;
3804 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
3806 /* If there are before-strings at the start of invisible
3807 text, and the text is invisible because of a text
3808 property, arrange to show before-strings because 20.x did
3809 it that way. (If the text is invisible because of an
3810 overlay property instead of a text property, this is
3811 already handled in the overlay code.) */
3813 && get_overlay_strings (it
, start_charpos
))
3815 handled
= HANDLED_RECOMPUTE_PROPS
;
3816 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
3818 else if (display_ellipsis_p
)
3820 /* Make sure that the glyphs of the ellipsis will get
3821 correct `charpos' values. If we would not update
3822 it->position here, the glyphs would belong to the
3823 last visible character _before_ the invisible
3824 text, which confuses `set_cursor_from_row'.
3826 We use the last invisible position instead of the
3827 first because this way the cursor is always drawn on
3828 the first "." of the ellipsis, whenever PT is inside
3829 the invisible text. Otherwise the cursor would be
3830 placed _after_ the ellipsis when the point is after the
3831 first invisible character. */
3832 if (!STRINGP (it
->object
))
3834 it
->position
.charpos
= IT_CHARPOS (*it
) - 1;
3835 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
3838 /* Let the ellipsis display before
3839 considering any properties of the following char.
3840 Fixes jasonr@gnu.org 01 Oct 07 bug. */
3841 handled
= HANDLED_RETURN
;
3850 /* Make iterator IT return `...' next.
3851 Replaces LEN characters from buffer. */
3854 setup_for_ellipsis (it
, len
)
3858 /* Use the display table definition for `...'. Invalid glyphs
3859 will be handled by the method returning elements from dpvec. */
3860 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
3862 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
3863 it
->dpvec
= v
->contents
;
3864 it
->dpend
= v
->contents
+ v
->size
;
3868 /* Default `...'. */
3869 it
->dpvec
= default_invis_vector
;
3870 it
->dpend
= default_invis_vector
+ 3;
3873 it
->dpvec_char_len
= len
;
3874 it
->current
.dpvec_index
= 0;
3875 it
->dpvec_face_id
= -1;
3877 /* Remember the current face id in case glyphs specify faces.
3878 IT's face is restored in set_iterator_to_next.
3879 saved_face_id was set to preceding char's face in handle_stop. */
3880 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
3881 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
3883 it
->method
= GET_FROM_DISPLAY_VECTOR
;
3889 /***********************************************************************
3891 ***********************************************************************/
3893 /* Set up iterator IT from `display' property at its current position.
3894 Called from handle_stop.
3895 We return HANDLED_RETURN if some part of the display property
3896 overrides the display of the buffer text itself.
3897 Otherwise we return HANDLED_NORMALLY. */
3899 static enum prop_handled
3900 handle_display_prop (it
)
3903 Lisp_Object prop
, object
, overlay
;
3904 struct text_pos
*position
;
3905 /* Nonzero if some property replaces the display of the text itself. */
3906 int display_replaced_p
= 0;
3908 if (STRINGP (it
->string
))
3910 object
= it
->string
;
3911 position
= &it
->current
.string_pos
;
3915 XSETWINDOW (object
, it
->w
);
3916 position
= &it
->current
.pos
;
3919 /* Reset those iterator values set from display property values. */
3920 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
3921 it
->space_width
= Qnil
;
3922 it
->font_height
= Qnil
;
3925 /* We don't support recursive `display' properties, i.e. string
3926 values that have a string `display' property, that have a string
3927 `display' property etc. */
3928 if (!it
->string_from_display_prop_p
)
3929 it
->area
= TEXT_AREA
;
3931 prop
= get_char_property_and_overlay (make_number (position
->charpos
),
3932 Qdisplay
, object
, &overlay
);
3934 return HANDLED_NORMALLY
;
3935 /* Now OVERLAY is the overlay that gave us this property, or nil
3936 if it was a text property. */
3938 if (!STRINGP (it
->string
))
3939 object
= it
->w
->buffer
;
3942 /* Simple properties. */
3943 && !EQ (XCAR (prop
), Qimage
)
3944 && !EQ (XCAR (prop
), Qspace
)
3945 && !EQ (XCAR (prop
), Qwhen
)
3946 && !EQ (XCAR (prop
), Qslice
)
3947 && !EQ (XCAR (prop
), Qspace_width
)
3948 && !EQ (XCAR (prop
), Qheight
)
3949 && !EQ (XCAR (prop
), Qraise
)
3950 /* Marginal area specifications. */
3951 && !(CONSP (XCAR (prop
)) && EQ (XCAR (XCAR (prop
)), Qmargin
))
3952 && !EQ (XCAR (prop
), Qleft_fringe
)
3953 && !EQ (XCAR (prop
), Qright_fringe
)
3954 && !NILP (XCAR (prop
)))
3956 for (; CONSP (prop
); prop
= XCDR (prop
))
3958 if (handle_single_display_spec (it
, XCAR (prop
), object
, overlay
,
3959 position
, display_replaced_p
))
3961 display_replaced_p
= 1;
3962 /* If some text in a string is replaced, `position' no
3963 longer points to the position of `object'. */
3964 if (STRINGP (object
))
3969 else if (VECTORP (prop
))
3972 for (i
= 0; i
< ASIZE (prop
); ++i
)
3973 if (handle_single_display_spec (it
, AREF (prop
, i
), object
, overlay
,
3974 position
, display_replaced_p
))
3976 display_replaced_p
= 1;
3977 /* If some text in a string is replaced, `position' no
3978 longer points to the position of `object'. */
3979 if (STRINGP (object
))
3985 if (handle_single_display_spec (it
, prop
, object
, overlay
,
3987 display_replaced_p
= 1;
3990 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
3994 /* Value is the position of the end of the `display' property starting
3995 at START_POS in OBJECT. */
3997 static struct text_pos
3998 display_prop_end (it
, object
, start_pos
)
4001 struct text_pos start_pos
;
4004 struct text_pos end_pos
;
4006 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4007 Qdisplay
, object
, Qnil
);
4008 CHARPOS (end_pos
) = XFASTINT (end
);
4009 if (STRINGP (object
))
4010 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4012 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4018 /* Set up IT from a single `display' specification PROP. OBJECT
4019 is the object in which the `display' property was found. *POSITION
4020 is the position at which it was found. DISPLAY_REPLACED_P non-zero
4021 means that we previously saw a display specification which already
4022 replaced text display with something else, for example an image;
4023 we ignore such properties after the first one has been processed.
4025 OVERLAY is the overlay this `display' property came from,
4026 or nil if it was a text property.
4028 If PROP is a `space' or `image' specification, and in some other
4029 cases too, set *POSITION to the position where the `display'
4032 Value is non-zero if something was found which replaces the display
4033 of buffer or string text. */
4036 handle_single_display_spec (it
, spec
, object
, overlay
, position
,
4037 display_replaced_before_p
)
4041 Lisp_Object overlay
;
4042 struct text_pos
*position
;
4043 int display_replaced_before_p
;
4046 Lisp_Object location
, value
;
4047 struct text_pos start_pos
, save_pos
;
4050 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4051 If the result is non-nil, use VALUE instead of SPEC. */
4053 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4062 if (!NILP (form
) && !EQ (form
, Qt
))
4064 int count
= SPECPDL_INDEX ();
4065 struct gcpro gcpro1
;
4067 /* Bind `object' to the object having the `display' property, a
4068 buffer or string. Bind `position' to the position in the
4069 object where the property was found, and `buffer-position'
4070 to the current position in the buffer. */
4071 specbind (Qobject
, object
);
4072 specbind (Qposition
, make_number (CHARPOS (*position
)));
4073 specbind (Qbuffer_position
,
4074 make_number (STRINGP (object
)
4075 ? IT_CHARPOS (*it
) : CHARPOS (*position
)));
4077 form
= safe_eval (form
);
4079 unbind_to (count
, Qnil
);
4085 /* Handle `(height HEIGHT)' specifications. */
4087 && EQ (XCAR (spec
), Qheight
)
4088 && CONSP (XCDR (spec
)))
4090 if (!FRAME_WINDOW_P (it
->f
))
4093 it
->font_height
= XCAR (XCDR (spec
));
4094 if (!NILP (it
->font_height
))
4096 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4097 int new_height
= -1;
4099 if (CONSP (it
->font_height
)
4100 && (EQ (XCAR (it
->font_height
), Qplus
)
4101 || EQ (XCAR (it
->font_height
), Qminus
))
4102 && CONSP (XCDR (it
->font_height
))
4103 && INTEGERP (XCAR (XCDR (it
->font_height
))))
4105 /* `(+ N)' or `(- N)' where N is an integer. */
4106 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4107 if (EQ (XCAR (it
->font_height
), Qplus
))
4109 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4111 else if (FUNCTIONP (it
->font_height
))
4113 /* Call function with current height as argument.
4114 Value is the new height. */
4116 height
= safe_call1 (it
->font_height
,
4117 face
->lface
[LFACE_HEIGHT_INDEX
]);
4118 if (NUMBERP (height
))
4119 new_height
= XFLOATINT (height
);
4121 else if (NUMBERP (it
->font_height
))
4123 /* Value is a multiple of the canonical char height. */
4126 face
= FACE_FROM_ID (it
->f
,
4127 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4128 new_height
= (XFLOATINT (it
->font_height
)
4129 * XINT (face
->lface
[LFACE_HEIGHT_INDEX
]));
4133 /* Evaluate IT->font_height with `height' bound to the
4134 current specified height to get the new height. */
4135 int count
= SPECPDL_INDEX ();
4137 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4138 value
= safe_eval (it
->font_height
);
4139 unbind_to (count
, Qnil
);
4141 if (NUMBERP (value
))
4142 new_height
= XFLOATINT (value
);
4146 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4152 /* Handle `(space-width WIDTH)'. */
4154 && EQ (XCAR (spec
), Qspace_width
)
4155 && CONSP (XCDR (spec
)))
4157 if (!FRAME_WINDOW_P (it
->f
))
4160 value
= XCAR (XCDR (spec
));
4161 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4162 it
->space_width
= value
;
4167 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4169 && EQ (XCAR (spec
), Qslice
))
4173 if (!FRAME_WINDOW_P (it
->f
))
4176 if (tem
= XCDR (spec
), CONSP (tem
))
4178 it
->slice
.x
= XCAR (tem
);
4179 if (tem
= XCDR (tem
), CONSP (tem
))
4181 it
->slice
.y
= XCAR (tem
);
4182 if (tem
= XCDR (tem
), CONSP (tem
))
4184 it
->slice
.width
= XCAR (tem
);
4185 if (tem
= XCDR (tem
), CONSP (tem
))
4186 it
->slice
.height
= XCAR (tem
);
4194 /* Handle `(raise FACTOR)'. */
4196 && EQ (XCAR (spec
), Qraise
)
4197 && CONSP (XCDR (spec
)))
4199 if (!FRAME_WINDOW_P (it
->f
))
4202 #ifdef HAVE_WINDOW_SYSTEM
4203 value
= XCAR (XCDR (spec
));
4204 if (NUMBERP (value
))
4206 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4207 it
->voffset
= - (XFLOATINT (value
)
4208 * (FONT_HEIGHT (face
->font
)));
4210 #endif /* HAVE_WINDOW_SYSTEM */
4215 /* Don't handle the other kinds of display specifications
4216 inside a string that we got from a `display' property. */
4217 if (it
->string_from_display_prop_p
)
4220 /* Characters having this form of property are not displayed, so
4221 we have to find the end of the property. */
4222 start_pos
= *position
;
4223 *position
= display_prop_end (it
, object
, start_pos
);
4226 /* Stop the scan at that end position--we assume that all
4227 text properties change there. */
4228 it
->stop_charpos
= position
->charpos
;
4230 /* Handle `(left-fringe BITMAP [FACE])'
4231 and `(right-fringe BITMAP [FACE])'. */
4233 && (EQ (XCAR (spec
), Qleft_fringe
)
4234 || EQ (XCAR (spec
), Qright_fringe
))
4235 && CONSP (XCDR (spec
)))
4237 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
4240 if (!FRAME_WINDOW_P (it
->f
))
4241 /* If we return here, POSITION has been advanced
4242 across the text with this property. */
4245 #ifdef HAVE_WINDOW_SYSTEM
4246 value
= XCAR (XCDR (spec
));
4247 if (!SYMBOLP (value
)
4248 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4249 /* If we return here, POSITION has been advanced
4250 across the text with this property. */
4253 if (CONSP (XCDR (XCDR (spec
))))
4255 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4256 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4262 /* Save current settings of IT so that we can restore them
4263 when we are finished with the glyph property value. */
4265 save_pos
= it
->position
;
4266 it
->position
= *position
;
4268 it
->position
= save_pos
;
4270 it
->area
= TEXT_AREA
;
4271 it
->what
= IT_IMAGE
;
4272 it
->image_id
= -1; /* no image */
4273 it
->position
= start_pos
;
4274 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4275 it
->method
= GET_FROM_IMAGE
;
4276 it
->from_overlay
= Qnil
;
4277 it
->face_id
= face_id
;
4279 /* Say that we haven't consumed the characters with
4280 `display' property yet. The call to pop_it in
4281 set_iterator_to_next will clean this up. */
4282 *position
= start_pos
;
4284 if (EQ (XCAR (spec
), Qleft_fringe
))
4286 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4287 it
->left_user_fringe_face_id
= face_id
;
4291 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4292 it
->right_user_fringe_face_id
= face_id
;
4294 #endif /* HAVE_WINDOW_SYSTEM */
4298 /* Prepare to handle `((margin left-margin) ...)',
4299 `((margin right-margin) ...)' and `((margin nil) ...)'
4300 prefixes for display specifications. */
4301 location
= Qunbound
;
4302 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4306 value
= XCDR (spec
);
4308 value
= XCAR (value
);
4311 if (EQ (XCAR (tem
), Qmargin
)
4312 && (tem
= XCDR (tem
),
4313 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4315 || EQ (tem
, Qleft_margin
)
4316 || EQ (tem
, Qright_margin
))))
4320 if (EQ (location
, Qunbound
))
4326 /* After this point, VALUE is the property after any
4327 margin prefix has been stripped. It must be a string,
4328 an image specification, or `(space ...)'.
4330 LOCATION specifies where to display: `left-margin',
4331 `right-margin' or nil. */
4333 valid_p
= (STRINGP (value
)
4334 #ifdef HAVE_WINDOW_SYSTEM
4335 || (FRAME_WINDOW_P (it
->f
) && valid_image_p (value
))
4336 #endif /* not HAVE_WINDOW_SYSTEM */
4337 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4339 if (valid_p
&& !display_replaced_before_p
)
4341 /* Save current settings of IT so that we can restore them
4342 when we are finished with the glyph property value. */
4343 save_pos
= it
->position
;
4344 it
->position
= *position
;
4346 it
->position
= save_pos
;
4347 it
->from_overlay
= overlay
;
4349 if (NILP (location
))
4350 it
->area
= TEXT_AREA
;
4351 else if (EQ (location
, Qleft_margin
))
4352 it
->area
= LEFT_MARGIN_AREA
;
4354 it
->area
= RIGHT_MARGIN_AREA
;
4356 if (STRINGP (value
))
4359 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4360 it
->current
.overlay_string_index
= -1;
4361 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4362 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4363 it
->method
= GET_FROM_STRING
;
4364 it
->stop_charpos
= 0;
4365 it
->string_from_display_prop_p
= 1;
4366 /* Say that we haven't consumed the characters with
4367 `display' property yet. The call to pop_it in
4368 set_iterator_to_next will clean this up. */
4369 if (BUFFERP (object
))
4370 *position
= start_pos
;
4372 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4374 it
->method
= GET_FROM_STRETCH
;
4376 *position
= it
->position
= start_pos
;
4378 #ifdef HAVE_WINDOW_SYSTEM
4381 it
->what
= IT_IMAGE
;
4382 it
->image_id
= lookup_image (it
->f
, value
);
4383 it
->position
= start_pos
;
4384 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4385 it
->method
= GET_FROM_IMAGE
;
4387 /* Say that we haven't consumed the characters with
4388 `display' property yet. The call to pop_it in
4389 set_iterator_to_next will clean this up. */
4390 *position
= start_pos
;
4392 #endif /* HAVE_WINDOW_SYSTEM */
4397 /* Invalid property or property not supported. Restore
4398 POSITION to what it was before. */
4399 *position
= start_pos
;
4404 /* Check if SPEC is a display sub-property value whose text should be
4405 treated as intangible. */
4408 single_display_spec_intangible_p (prop
)
4411 /* Skip over `when FORM'. */
4412 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4426 /* Skip over `margin LOCATION'. If LOCATION is in the margins,
4427 we don't need to treat text as intangible. */
4428 if (EQ (XCAR (prop
), Qmargin
))
4436 || EQ (XCAR (prop
), Qleft_margin
)
4437 || EQ (XCAR (prop
), Qright_margin
))
4441 return (CONSP (prop
)
4442 && (EQ (XCAR (prop
), Qimage
)
4443 || EQ (XCAR (prop
), Qspace
)));
4447 /* Check if PROP is a display property value whose text should be
4448 treated as intangible. */
4451 display_prop_intangible_p (prop
)
4455 && CONSP (XCAR (prop
))
4456 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4458 /* A list of sub-properties. */
4459 while (CONSP (prop
))
4461 if (single_display_spec_intangible_p (XCAR (prop
)))
4466 else if (VECTORP (prop
))
4468 /* A vector of sub-properties. */
4470 for (i
= 0; i
< ASIZE (prop
); ++i
)
4471 if (single_display_spec_intangible_p (AREF (prop
, i
)))
4475 return single_display_spec_intangible_p (prop
);
4481 /* Return 1 if PROP is a display sub-property value containing STRING. */
4484 single_display_spec_string_p (prop
, string
)
4485 Lisp_Object prop
, string
;
4487 if (EQ (string
, prop
))
4490 /* Skip over `when FORM'. */
4491 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4500 /* Skip over `margin LOCATION'. */
4501 if (EQ (XCAR (prop
), Qmargin
))
4512 return CONSP (prop
) && EQ (XCAR (prop
), string
);
4516 /* Return 1 if STRING appears in the `display' property PROP. */
4519 display_prop_string_p (prop
, string
)
4520 Lisp_Object prop
, string
;
4523 && CONSP (XCAR (prop
))
4524 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4526 /* A list of sub-properties. */
4527 while (CONSP (prop
))
4529 if (single_display_spec_string_p (XCAR (prop
), string
))
4534 else if (VECTORP (prop
))
4536 /* A vector of sub-properties. */
4538 for (i
= 0; i
< ASIZE (prop
); ++i
)
4539 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4543 return single_display_spec_string_p (prop
, string
);
4549 /* Determine which buffer position in W's buffer STRING comes from.
4550 AROUND_CHARPOS is an approximate position where it could come from.
4551 Value is the buffer position or 0 if it couldn't be determined.
4553 W's buffer must be current.
4555 This function is necessary because we don't record buffer positions
4556 in glyphs generated from strings (to keep struct glyph small).
4557 This function may only use code that doesn't eval because it is
4558 called asynchronously from note_mouse_highlight. */
4561 string_buffer_position (w
, string
, around_charpos
)
4566 Lisp_Object limit
, prop
, pos
;
4567 const int MAX_DISTANCE
= 1000;
4570 pos
= make_number (around_charpos
);
4571 limit
= make_number (min (XINT (pos
) + MAX_DISTANCE
, ZV
));
4572 while (!found
&& !EQ (pos
, limit
))
4574 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4575 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4578 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
, limit
);
4583 pos
= make_number (around_charpos
);
4584 limit
= make_number (max (XINT (pos
) - MAX_DISTANCE
, BEGV
));
4585 while (!found
&& !EQ (pos
, limit
))
4587 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4588 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4591 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
4596 return found
? XINT (pos
) : 0;
4601 /***********************************************************************
4602 `composition' property
4603 ***********************************************************************/
4605 /* Set up iterator IT from `composition' property at its current
4606 position. Called from handle_stop. */
4608 static enum prop_handled
4609 handle_composition_prop (it
)
4612 Lisp_Object prop
, string
;
4613 EMACS_INT pos
, pos_byte
, start
, end
;
4615 if (STRINGP (it
->string
))
4619 pos
= IT_STRING_CHARPOS (*it
);
4620 pos_byte
= IT_STRING_BYTEPOS (*it
);
4621 string
= it
->string
;
4622 s
= SDATA (string
) + pos_byte
;
4623 it
->c
= STRING_CHAR (s
);
4627 pos
= IT_CHARPOS (*it
);
4628 pos_byte
= IT_BYTEPOS (*it
);
4630 it
->c
= FETCH_CHAR (pos_byte
);
4633 /* If there's a valid composition and point is not inside of the
4634 composition (in the case that the composition is from the current
4635 buffer), draw a glyph composed from the composition components. */
4636 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
4637 && COMPOSITION_VALID_P (start
, end
, prop
)
4638 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
4642 if (STRINGP (it
->string
))
4643 pos_byte
= string_char_to_byte (it
->string
, start
);
4645 pos_byte
= CHAR_TO_BYTE (start
);
4647 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
4650 if (it
->cmp_it
.id
>= 0)
4653 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
4654 it
->cmp_it
.nglyphs
= -1;
4658 return HANDLED_NORMALLY
;
4663 /***********************************************************************
4665 ***********************************************************************/
4667 /* The following structure is used to record overlay strings for
4668 later sorting in load_overlay_strings. */
4670 struct overlay_entry
4672 Lisp_Object overlay
;
4679 /* Set up iterator IT from overlay strings at its current position.
4680 Called from handle_stop. */
4682 static enum prop_handled
4683 handle_overlay_change (it
)
4686 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
4687 return HANDLED_RECOMPUTE_PROPS
;
4689 return HANDLED_NORMALLY
;
4693 /* Set up the next overlay string for delivery by IT, if there is an
4694 overlay string to deliver. Called by set_iterator_to_next when the
4695 end of the current overlay string is reached. If there are more
4696 overlay strings to display, IT->string and
4697 IT->current.overlay_string_index are set appropriately here.
4698 Otherwise IT->string is set to nil. */
4701 next_overlay_string (it
)
4704 ++it
->current
.overlay_string_index
;
4705 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
4707 /* No more overlay strings. Restore IT's settings to what
4708 they were before overlay strings were processed, and
4709 continue to deliver from current_buffer. */
4711 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
4714 || (NILP (it
->string
)
4715 && it
->method
== GET_FROM_BUFFER
4716 && it
->stop_charpos
>= BEGV
4717 && it
->stop_charpos
<= it
->end_charpos
));
4718 it
->current
.overlay_string_index
= -1;
4719 it
->n_overlay_strings
= 0;
4721 /* If we're at the end of the buffer, record that we have
4722 processed the overlay strings there already, so that
4723 next_element_from_buffer doesn't try it again. */
4724 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
4725 it
->overlay_strings_at_end_processed_p
= 1;
4729 /* There are more overlay strings to process. If
4730 IT->current.overlay_string_index has advanced to a position
4731 where we must load IT->overlay_strings with more strings, do
4733 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
4735 if (it
->current
.overlay_string_index
&& i
== 0)
4736 load_overlay_strings (it
, 0);
4738 /* Initialize IT to deliver display elements from the overlay
4740 it
->string
= it
->overlay_strings
[i
];
4741 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4742 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
4743 it
->method
= GET_FROM_STRING
;
4744 it
->stop_charpos
= 0;
4745 if (it
->cmp_it
.stop_pos
>= 0)
4746 it
->cmp_it
.stop_pos
= 0;
4753 /* Compare two overlay_entry structures E1 and E2. Used as a
4754 comparison function for qsort in load_overlay_strings. Overlay
4755 strings for the same position are sorted so that
4757 1. All after-strings come in front of before-strings, except
4758 when they come from the same overlay.
4760 2. Within after-strings, strings are sorted so that overlay strings
4761 from overlays with higher priorities come first.
4763 2. Within before-strings, strings are sorted so that overlay
4764 strings from overlays with higher priorities come last.
4766 Value is analogous to strcmp. */
4770 compare_overlay_entries (e1
, e2
)
4773 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
4774 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
4777 if (entry1
->after_string_p
!= entry2
->after_string_p
)
4779 /* Let after-strings appear in front of before-strings if
4780 they come from different overlays. */
4781 if (EQ (entry1
->overlay
, entry2
->overlay
))
4782 result
= entry1
->after_string_p
? 1 : -1;
4784 result
= entry1
->after_string_p
? -1 : 1;
4786 else if (entry1
->after_string_p
)
4787 /* After-strings sorted in order of decreasing priority. */
4788 result
= entry2
->priority
- entry1
->priority
;
4790 /* Before-strings sorted in order of increasing priority. */
4791 result
= entry1
->priority
- entry2
->priority
;
4797 /* Load the vector IT->overlay_strings with overlay strings from IT's
4798 current buffer position, or from CHARPOS if that is > 0. Set
4799 IT->n_overlays to the total number of overlay strings found.
4801 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
4802 a time. On entry into load_overlay_strings,
4803 IT->current.overlay_string_index gives the number of overlay
4804 strings that have already been loaded by previous calls to this
4807 IT->add_overlay_start contains an additional overlay start
4808 position to consider for taking overlay strings from, if non-zero.
4809 This position comes into play when the overlay has an `invisible'
4810 property, and both before and after-strings. When we've skipped to
4811 the end of the overlay, because of its `invisible' property, we
4812 nevertheless want its before-string to appear.
4813 IT->add_overlay_start will contain the overlay start position
4816 Overlay strings are sorted so that after-string strings come in
4817 front of before-string strings. Within before and after-strings,
4818 strings are sorted by overlay priority. See also function
4819 compare_overlay_entries. */
4822 load_overlay_strings (it
, charpos
)
4826 extern Lisp_Object Qwindow
, Qpriority
;
4827 Lisp_Object overlay
, window
, str
, invisible
;
4828 struct Lisp_Overlay
*ov
;
4831 int n
= 0, i
, j
, invis_p
;
4832 struct overlay_entry
*entries
4833 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
4836 charpos
= IT_CHARPOS (*it
);
4838 /* Append the overlay string STRING of overlay OVERLAY to vector
4839 `entries' which has size `size' and currently contains `n'
4840 elements. AFTER_P non-zero means STRING is an after-string of
4842 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
4845 Lisp_Object priority; \
4849 int new_size = 2 * size; \
4850 struct overlay_entry *old = entries; \
4852 (struct overlay_entry *) alloca (new_size \
4853 * sizeof *entries); \
4854 bcopy (old, entries, size * sizeof *entries); \
4858 entries[n].string = (STRING); \
4859 entries[n].overlay = (OVERLAY); \
4860 priority = Foverlay_get ((OVERLAY), Qpriority); \
4861 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
4862 entries[n].after_string_p = (AFTER_P); \
4867 /* Process overlay before the overlay center. */
4868 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
4870 XSETMISC (overlay
, ov
);
4871 xassert (OVERLAYP (overlay
));
4872 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4873 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4878 /* Skip this overlay if it doesn't start or end at IT's current
4880 if (end
!= charpos
&& start
!= charpos
)
4883 /* Skip this overlay if it doesn't apply to IT->w. */
4884 window
= Foverlay_get (overlay
, Qwindow
);
4885 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4888 /* If the text ``under'' the overlay is invisible, both before-
4889 and after-strings from this overlay are visible; start and
4890 end position are indistinguishable. */
4891 invisible
= Foverlay_get (overlay
, Qinvisible
);
4892 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4894 /* If overlay has a non-empty before-string, record it. */
4895 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4896 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4898 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4900 /* If overlay has a non-empty after-string, record it. */
4901 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4902 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4904 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4907 /* Process overlays after the overlay center. */
4908 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
4910 XSETMISC (overlay
, ov
);
4911 xassert (OVERLAYP (overlay
));
4912 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4913 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4915 if (start
> charpos
)
4918 /* Skip this overlay if it doesn't start or end at IT's current
4920 if (end
!= charpos
&& start
!= charpos
)
4923 /* Skip this overlay if it doesn't apply to IT->w. */
4924 window
= Foverlay_get (overlay
, Qwindow
);
4925 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4928 /* If the text ``under'' the overlay is invisible, it has a zero
4929 dimension, and both before- and after-strings apply. */
4930 invisible
= Foverlay_get (overlay
, Qinvisible
);
4931 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4933 /* If overlay has a non-empty before-string, record it. */
4934 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4935 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4937 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4939 /* If overlay has a non-empty after-string, record it. */
4940 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4941 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4943 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4946 #undef RECORD_OVERLAY_STRING
4950 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
4952 /* Record the total number of strings to process. */
4953 it
->n_overlay_strings
= n
;
4955 /* IT->current.overlay_string_index is the number of overlay strings
4956 that have already been consumed by IT. Copy some of the
4957 remaining overlay strings to IT->overlay_strings. */
4959 j
= it
->current
.overlay_string_index
;
4960 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
4962 it
->overlay_strings
[i
] = entries
[j
].string
;
4963 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
4970 /* Get the first chunk of overlay strings at IT's current buffer
4971 position, or at CHARPOS if that is > 0. Value is non-zero if at
4972 least one overlay string was found. */
4975 get_overlay_strings_1 (it
, charpos
, compute_stop_p
)
4980 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
4981 process. This fills IT->overlay_strings with strings, and sets
4982 IT->n_overlay_strings to the total number of strings to process.
4983 IT->pos.overlay_string_index has to be set temporarily to zero
4984 because load_overlay_strings needs this; it must be set to -1
4985 when no overlay strings are found because a zero value would
4986 indicate a position in the first overlay string. */
4987 it
->current
.overlay_string_index
= 0;
4988 load_overlay_strings (it
, charpos
);
4990 /* If we found overlay strings, set up IT to deliver display
4991 elements from the first one. Otherwise set up IT to deliver
4992 from current_buffer. */
4993 if (it
->n_overlay_strings
)
4995 /* Make sure we know settings in current_buffer, so that we can
4996 restore meaningful values when we're done with the overlay
4999 compute_stop_pos (it
);
5000 xassert (it
->face_id
>= 0);
5002 /* Save IT's settings. They are restored after all overlay
5003 strings have been processed. */
5004 xassert (!compute_stop_p
|| it
->sp
== 0);
5006 /* When called from handle_stop, there might be an empty display
5007 string loaded. In that case, don't bother saving it. */
5008 if (!STRINGP (it
->string
) || SCHARS (it
->string
))
5011 /* Set up IT to deliver display elements from the first overlay
5013 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5014 it
->string
= it
->overlay_strings
[0];
5015 it
->from_overlay
= Qnil
;
5016 it
->stop_charpos
= 0;
5017 xassert (STRINGP (it
->string
));
5018 it
->end_charpos
= SCHARS (it
->string
);
5019 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5020 it
->method
= GET_FROM_STRING
;
5024 it
->current
.overlay_string_index
= -1;
5029 get_overlay_strings (it
, charpos
)
5034 it
->method
= GET_FROM_BUFFER
;
5036 (void) get_overlay_strings_1 (it
, charpos
, 1);
5040 /* Value is non-zero if we found at least one overlay string. */
5041 return STRINGP (it
->string
);
5046 /***********************************************************************
5047 Saving and restoring state
5048 ***********************************************************************/
5050 /* Save current settings of IT on IT->stack. Called, for example,
5051 before setting up IT for an overlay string, to be able to restore
5052 IT's settings to what they were after the overlay string has been
5059 struct iterator_stack_entry
*p
;
5061 xassert (it
->sp
< IT_STACK_SIZE
);
5062 p
= it
->stack
+ it
->sp
;
5064 p
->stop_charpos
= it
->stop_charpos
;
5065 p
->cmp_it
= it
->cmp_it
;
5066 xassert (it
->face_id
>= 0);
5067 p
->face_id
= it
->face_id
;
5068 p
->string
= it
->string
;
5069 p
->method
= it
->method
;
5070 p
->from_overlay
= it
->from_overlay
;
5073 case GET_FROM_IMAGE
:
5074 p
->u
.image
.object
= it
->object
;
5075 p
->u
.image
.image_id
= it
->image_id
;
5076 p
->u
.image
.slice
= it
->slice
;
5078 case GET_FROM_STRETCH
:
5079 p
->u
.stretch
.object
= it
->object
;
5082 p
->position
= it
->position
;
5083 p
->current
= it
->current
;
5084 p
->end_charpos
= it
->end_charpos
;
5085 p
->string_nchars
= it
->string_nchars
;
5087 p
->multibyte_p
= it
->multibyte_p
;
5088 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5089 p
->space_width
= it
->space_width
;
5090 p
->font_height
= it
->font_height
;
5091 p
->voffset
= it
->voffset
;
5092 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5093 p
->display_ellipsis_p
= 0;
5094 p
->line_wrap
= it
->line_wrap
;
5099 /* Restore IT's settings from IT->stack. Called, for example, when no
5100 more overlay strings must be processed, and we return to delivering
5101 display elements from a buffer, or when the end of a string from a
5102 `display' property is reached and we return to delivering display
5103 elements from an overlay string, or from a buffer. */
5109 struct iterator_stack_entry
*p
;
5111 xassert (it
->sp
> 0);
5113 p
= it
->stack
+ it
->sp
;
5114 it
->stop_charpos
= p
->stop_charpos
;
5115 it
->cmp_it
= p
->cmp_it
;
5116 it
->face_id
= p
->face_id
;
5117 it
->current
= p
->current
;
5118 it
->position
= p
->position
;
5119 it
->string
= p
->string
;
5120 it
->from_overlay
= p
->from_overlay
;
5121 if (NILP (it
->string
))
5122 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5123 it
->method
= p
->method
;
5126 case GET_FROM_IMAGE
:
5127 it
->image_id
= p
->u
.image
.image_id
;
5128 it
->object
= p
->u
.image
.object
;
5129 it
->slice
= p
->u
.image
.slice
;
5131 case GET_FROM_STRETCH
:
5132 it
->object
= p
->u
.comp
.object
;
5134 case GET_FROM_BUFFER
:
5135 it
->object
= it
->w
->buffer
;
5137 case GET_FROM_STRING
:
5138 it
->object
= it
->string
;
5140 case GET_FROM_DISPLAY_VECTOR
:
5142 it
->method
= GET_FROM_C_STRING
;
5143 else if (STRINGP (it
->string
))
5144 it
->method
= GET_FROM_STRING
;
5147 it
->method
= GET_FROM_BUFFER
;
5148 it
->object
= it
->w
->buffer
;
5151 it
->end_charpos
= p
->end_charpos
;
5152 it
->string_nchars
= p
->string_nchars
;
5154 it
->multibyte_p
= p
->multibyte_p
;
5155 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5156 it
->space_width
= p
->space_width
;
5157 it
->font_height
= p
->font_height
;
5158 it
->voffset
= p
->voffset
;
5159 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5160 it
->line_wrap
= p
->line_wrap
;
5165 /***********************************************************************
5167 ***********************************************************************/
5169 /* Set IT's current position to the previous line start. */
5172 back_to_previous_line_start (it
)
5175 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5176 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5180 /* Move IT to the next line start.
5182 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5183 we skipped over part of the text (as opposed to moving the iterator
5184 continuously over the text). Otherwise, don't change the value
5187 Newlines may come from buffer text, overlay strings, or strings
5188 displayed via the `display' property. That's the reason we can't
5189 simply use find_next_newline_no_quit.
5191 Note that this function may not skip over invisible text that is so
5192 because of text properties and immediately follows a newline. If
5193 it would, function reseat_at_next_visible_line_start, when called
5194 from set_iterator_to_next, would effectively make invisible
5195 characters following a newline part of the wrong glyph row, which
5196 leads to wrong cursor motion. */
5199 forward_to_next_line_start (it
, skipped_p
)
5203 int old_selective
, newline_found_p
, n
;
5204 const int MAX_NEWLINE_DISTANCE
= 500;
5206 /* If already on a newline, just consume it to avoid unintended
5207 skipping over invisible text below. */
5208 if (it
->what
== IT_CHARACTER
5210 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5212 set_iterator_to_next (it
, 0);
5217 /* Don't handle selective display in the following. It's (a)
5218 unnecessary because it's done by the caller, and (b) leads to an
5219 infinite recursion because next_element_from_ellipsis indirectly
5220 calls this function. */
5221 old_selective
= it
->selective
;
5224 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5225 from buffer text. */
5226 for (n
= newline_found_p
= 0;
5227 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5228 n
+= STRINGP (it
->string
) ? 0 : 1)
5230 if (!get_next_display_element (it
))
5232 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5233 set_iterator_to_next (it
, 0);
5236 /* If we didn't find a newline near enough, see if we can use a
5238 if (!newline_found_p
)
5240 int start
= IT_CHARPOS (*it
);
5241 int limit
= find_next_newline_no_quit (start
, 1);
5244 xassert (!STRINGP (it
->string
));
5246 /* If there isn't any `display' property in sight, and no
5247 overlays, we can just use the position of the newline in
5249 if (it
->stop_charpos
>= limit
5250 || ((pos
= Fnext_single_property_change (make_number (start
),
5252 Qnil
, make_number (limit
)),
5254 && next_overlay_change (start
) == ZV
))
5256 IT_CHARPOS (*it
) = limit
;
5257 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5258 *skipped_p
= newline_found_p
= 1;
5262 while (get_next_display_element (it
)
5263 && !newline_found_p
)
5265 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5266 set_iterator_to_next (it
, 0);
5271 it
->selective
= old_selective
;
5272 return newline_found_p
;
5276 /* Set IT's current position to the previous visible line start. Skip
5277 invisible text that is so either due to text properties or due to
5278 selective display. Caution: this does not change IT->current_x and
5282 back_to_previous_visible_line_start (it
)
5285 while (IT_CHARPOS (*it
) > BEGV
)
5287 back_to_previous_line_start (it
);
5289 if (IT_CHARPOS (*it
) <= BEGV
)
5292 /* If selective > 0, then lines indented more than that values
5294 if (it
->selective
> 0
5295 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5296 (double) it
->selective
)) /* iftc */
5299 /* Check the newline before point for invisibility. */
5302 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5303 Qinvisible
, it
->window
);
5304 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5308 if (IT_CHARPOS (*it
) <= BEGV
)
5315 Lisp_Object val
, overlay
;
5317 /* If newline is part of a composition, continue from start of composition */
5318 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5319 && beg
< IT_CHARPOS (*it
))
5322 /* If newline is replaced by a display property, find start of overlay
5323 or interval and continue search from that point. */
5325 pos
= --IT_CHARPOS (it2
);
5328 it2
.string_from_display_prop_p
= 0;
5329 if (handle_display_prop (&it2
) == HANDLED_RETURN
5330 && !NILP (val
= get_char_property_and_overlay
5331 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5332 && (OVERLAYP (overlay
)
5333 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5334 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5337 /* Newline is not replaced by anything -- so we are done. */
5343 IT_CHARPOS (*it
) = beg
;
5344 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5348 it
->continuation_lines_width
= 0;
5350 xassert (IT_CHARPOS (*it
) >= BEGV
);
5351 xassert (IT_CHARPOS (*it
) == BEGV
5352 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5357 /* Reseat iterator IT at the previous visible line start. Skip
5358 invisible text that is so either due to text properties or due to
5359 selective display. At the end, update IT's overlay information,
5360 face information etc. */
5363 reseat_at_previous_visible_line_start (it
)
5366 back_to_previous_visible_line_start (it
);
5367 reseat (it
, it
->current
.pos
, 1);
5372 /* Reseat iterator IT on the next visible line start in the current
5373 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5374 preceding the line start. Skip over invisible text that is so
5375 because of selective display. Compute faces, overlays etc at the
5376 new position. Note that this function does not skip over text that
5377 is invisible because of text properties. */
5380 reseat_at_next_visible_line_start (it
, on_newline_p
)
5384 int newline_found_p
, skipped_p
= 0;
5386 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5388 /* Skip over lines that are invisible because they are indented
5389 more than the value of IT->selective. */
5390 if (it
->selective
> 0)
5391 while (IT_CHARPOS (*it
) < ZV
5392 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5393 (double) it
->selective
)) /* iftc */
5395 xassert (IT_BYTEPOS (*it
) == BEGV
5396 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5397 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5400 /* Position on the newline if that's what's requested. */
5401 if (on_newline_p
&& newline_found_p
)
5403 if (STRINGP (it
->string
))
5405 if (IT_STRING_CHARPOS (*it
) > 0)
5407 --IT_STRING_CHARPOS (*it
);
5408 --IT_STRING_BYTEPOS (*it
);
5411 else if (IT_CHARPOS (*it
) > BEGV
)
5415 reseat (it
, it
->current
.pos
, 0);
5419 reseat (it
, it
->current
.pos
, 0);
5426 /***********************************************************************
5427 Changing an iterator's position
5428 ***********************************************************************/
5430 /* Change IT's current position to POS in current_buffer. If FORCE_P
5431 is non-zero, always check for text properties at the new position.
5432 Otherwise, text properties are only looked up if POS >=
5433 IT->check_charpos of a property. */
5436 reseat (it
, pos
, force_p
)
5438 struct text_pos pos
;
5441 int original_pos
= IT_CHARPOS (*it
);
5443 reseat_1 (it
, pos
, 0);
5445 /* Determine where to check text properties. Avoid doing it
5446 where possible because text property lookup is very expensive. */
5448 || CHARPOS (pos
) > it
->stop_charpos
5449 || CHARPOS (pos
) < original_pos
)
5456 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
5457 IT->stop_pos to POS, also. */
5460 reseat_1 (it
, pos
, set_stop_p
)
5462 struct text_pos pos
;
5465 /* Don't call this function when scanning a C string. */
5466 xassert (it
->s
== NULL
);
5468 /* POS must be a reasonable value. */
5469 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
5471 it
->current
.pos
= it
->position
= pos
;
5472 it
->end_charpos
= ZV
;
5474 it
->current
.dpvec_index
= -1;
5475 it
->current
.overlay_string_index
= -1;
5476 IT_STRING_CHARPOS (*it
) = -1;
5477 IT_STRING_BYTEPOS (*it
) = -1;
5479 it
->string_from_display_prop_p
= 0;
5480 it
->method
= GET_FROM_BUFFER
;
5481 it
->object
= it
->w
->buffer
;
5482 it
->area
= TEXT_AREA
;
5483 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
5485 it
->string_from_display_prop_p
= 0;
5486 it
->face_before_selective_p
= 0;
5489 it
->stop_charpos
= CHARPOS (pos
);
5493 /* Set up IT for displaying a string, starting at CHARPOS in window W.
5494 If S is non-null, it is a C string to iterate over. Otherwise,
5495 STRING gives a Lisp string to iterate over.
5497 If PRECISION > 0, don't return more then PRECISION number of
5498 characters from the string.
5500 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
5501 characters have been returned. FIELD_WIDTH < 0 means an infinite
5504 MULTIBYTE = 0 means disable processing of multibyte characters,
5505 MULTIBYTE > 0 means enable it,
5506 MULTIBYTE < 0 means use IT->multibyte_p.
5508 IT must be initialized via a prior call to init_iterator before
5509 calling this function. */
5512 reseat_to_string (it
, s
, string
, charpos
, precision
, field_width
, multibyte
)
5517 int precision
, field_width
, multibyte
;
5519 /* No region in strings. */
5520 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
5522 /* No text property checks performed by default, but see below. */
5523 it
->stop_charpos
= -1;
5525 /* Set iterator position and end position. */
5526 bzero (&it
->current
, sizeof it
->current
);
5527 it
->current
.overlay_string_index
= -1;
5528 it
->current
.dpvec_index
= -1;
5529 xassert (charpos
>= 0);
5531 /* If STRING is specified, use its multibyteness, otherwise use the
5532 setting of MULTIBYTE, if specified. */
5534 it
->multibyte_p
= multibyte
> 0;
5538 xassert (STRINGP (string
));
5539 it
->string
= string
;
5541 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
5542 it
->method
= GET_FROM_STRING
;
5543 it
->current
.string_pos
= string_pos (charpos
, string
);
5550 /* Note that we use IT->current.pos, not it->current.string_pos,
5551 for displaying C strings. */
5552 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
5553 if (it
->multibyte_p
)
5555 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
5556 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
5560 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
5561 it
->end_charpos
= it
->string_nchars
= strlen (s
);
5564 it
->method
= GET_FROM_C_STRING
;
5567 /* PRECISION > 0 means don't return more than PRECISION characters
5569 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
5570 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
5572 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
5573 characters have been returned. FIELD_WIDTH == 0 means don't pad,
5574 FIELD_WIDTH < 0 means infinite field width. This is useful for
5575 padding with `-' at the end of a mode line. */
5576 if (field_width
< 0)
5577 field_width
= INFINITY
;
5578 if (field_width
> it
->end_charpos
- charpos
)
5579 it
->end_charpos
= charpos
+ field_width
;
5581 /* Use the standard display table for displaying strings. */
5582 if (DISP_TABLE_P (Vstandard_display_table
))
5583 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
5585 it
->stop_charpos
= charpos
;
5586 if (s
== NULL
&& it
->multibyte_p
)
5588 EMACS_INT endpos
= SCHARS (it
->string
);
5589 if (endpos
> it
->end_charpos
)
5590 endpos
= it
->end_charpos
;
5591 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
5599 /***********************************************************************
5601 ***********************************************************************/
5603 /* Map enum it_method value to corresponding next_element_from_* function. */
5605 static int (* get_next_element
[NUM_IT_METHODS
]) P_ ((struct it
*it
)) =
5607 next_element_from_buffer
,
5608 next_element_from_display_vector
,
5609 next_element_from_string
,
5610 next_element_from_c_string
,
5611 next_element_from_image
,
5612 next_element_from_stretch
5615 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
5618 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
5619 (possibly with the following characters). */
5621 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
5622 ((IT)->cmp_it.id >= 0 \
5623 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
5624 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
5625 END_CHARPOS, (IT)->w, \
5626 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
5630 /* Load IT's display element fields with information about the next
5631 display element from the current position of IT. Value is zero if
5632 end of buffer (or C string) is reached. */
5634 static struct frame
*last_escape_glyph_frame
= NULL
;
5635 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
5636 static int last_escape_glyph_merged_face_id
= 0;
5639 get_next_display_element (it
)
5642 /* Non-zero means that we found a display element. Zero means that
5643 we hit the end of what we iterate over. Performance note: the
5644 function pointer `method' used here turns out to be faster than
5645 using a sequence of if-statements. */
5649 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
5651 if (it
->what
== IT_CHARACTER
)
5653 /* Map via display table or translate control characters.
5654 IT->c, IT->len etc. have been set to the next character by
5655 the function call above. If we have a display table, and it
5656 contains an entry for IT->c, translate it. Don't do this if
5657 IT->c itself comes from a display table, otherwise we could
5658 end up in an infinite recursion. (An alternative could be to
5659 count the recursion depth of this function and signal an
5660 error when a certain maximum depth is reached.) Is it worth
5662 if (success_p
&& it
->dpvec
== NULL
)
5665 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
5666 enum { char_is_other
= 0, char_is_nbsp
, char_is_soft_hyphen
}
5667 nbsp_or_shy
= char_is_other
;
5668 int c
= it
->c
; /* This is the character to display. */
5670 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
5672 xassert (SINGLE_BYTE_CHAR_P (c
));
5673 if (unibyte_display_via_language_environment
)
5675 c
= DECODE_CHAR (unibyte
, c
);
5677 c
= BYTE8_TO_CHAR (it
->c
);
5680 c
= BYTE8_TO_CHAR (it
->c
);
5684 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
5687 struct Lisp_Vector
*v
= XVECTOR (dv
);
5689 /* Return the first character from the display table
5690 entry, if not empty. If empty, don't display the
5691 current character. */
5694 it
->dpvec_char_len
= it
->len
;
5695 it
->dpvec
= v
->contents
;
5696 it
->dpend
= v
->contents
+ v
->size
;
5697 it
->current
.dpvec_index
= 0;
5698 it
->dpvec_face_id
= -1;
5699 it
->saved_face_id
= it
->face_id
;
5700 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5705 set_iterator_to_next (it
, 0);
5710 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
5711 nbsp_or_shy
= (c
== 0xA0 ? char_is_nbsp
5712 : c
== 0xAD ? char_is_soft_hyphen
5715 /* Translate control characters into `\003' or `^C' form.
5716 Control characters coming from a display table entry are
5717 currently not translated because we use IT->dpvec to hold
5718 the translation. This could easily be changed but I
5719 don't believe that it is worth doing.
5721 NBSP and SOFT-HYPEN are property translated too.
5723 Non-printable characters and raw-byte characters are also
5724 translated to octal form. */
5725 if (((c
< ' ' || c
== 127) /* ASCII control chars */
5726 ? (it
->area
!= TEXT_AREA
5727 /* In mode line, treat \n, \t like other crl chars. */
5730 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
5731 || (c
!= '\n' && c
!= '\t'))
5734 || ! CHAR_PRINTABLE_P (c
))))
5736 /* C is a control character, NBSP, SOFT-HYPEN, raw-byte,
5737 or a non-printable character which must be displayed
5738 either as '\003' or as `^C' where the '\\' and '^'
5739 can be defined in the display table. Fill
5740 IT->ctl_chars with glyphs for what we have to
5741 display. Then, set IT->dpvec to these glyphs. */
5744 int face_id
, lface_id
= 0 ;
5747 /* Handle control characters with ^. */
5749 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
5753 g
= '^'; /* default glyph for Control */
5754 /* Set IT->ctl_chars[0] to the glyph for `^'. */
5756 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5757 && GLYPH_CODE_CHAR_VALID_P (gc
))
5759 g
= GLYPH_CODE_CHAR (gc
);
5760 lface_id
= GLYPH_CODE_FACE (gc
);
5764 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
5766 else if (it
->f
== last_escape_glyph_frame
5767 && it
->face_id
== last_escape_glyph_face_id
)
5769 face_id
= last_escape_glyph_merged_face_id
;
5773 /* Merge the escape-glyph face into the current face. */
5774 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5776 last_escape_glyph_frame
= it
->f
;
5777 last_escape_glyph_face_id
= it
->face_id
;
5778 last_escape_glyph_merged_face_id
= face_id
;
5781 XSETINT (it
->ctl_chars
[0], g
);
5782 XSETINT (it
->ctl_chars
[1], c
^ 0100);
5784 goto display_control
;
5787 /* Handle non-break space in the mode where it only gets
5790 if (EQ (Vnobreak_char_display
, Qt
)
5791 && nbsp_or_shy
== char_is_nbsp
)
5793 /* Merge the no-break-space face into the current face. */
5794 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
5798 XSETINT (it
->ctl_chars
[0], ' ');
5800 goto display_control
;
5803 /* Handle sequences that start with the "escape glyph". */
5805 /* the default escape glyph is \. */
5806 escape_glyph
= '\\';
5809 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5810 && GLYPH_CODE_CHAR_VALID_P (gc
))
5812 escape_glyph
= GLYPH_CODE_CHAR (gc
);
5813 lface_id
= GLYPH_CODE_FACE (gc
);
5817 /* The display table specified a face.
5818 Merge it into face_id and also into escape_glyph. */
5819 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
5822 else if (it
->f
== last_escape_glyph_frame
5823 && it
->face_id
== last_escape_glyph_face_id
)
5825 face_id
= last_escape_glyph_merged_face_id
;
5829 /* Merge the escape-glyph face into the current face. */
5830 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5832 last_escape_glyph_frame
= it
->f
;
5833 last_escape_glyph_face_id
= it
->face_id
;
5834 last_escape_glyph_merged_face_id
= face_id
;
5837 /* Handle soft hyphens in the mode where they only get
5840 if (EQ (Vnobreak_char_display
, Qt
)
5841 && nbsp_or_shy
== char_is_soft_hyphen
)
5843 XSETINT (it
->ctl_chars
[0], '-');
5845 goto display_control
;
5848 /* Handle non-break space and soft hyphen
5849 with the escape glyph. */
5853 XSETINT (it
->ctl_chars
[0], escape_glyph
);
5854 c
= (nbsp_or_shy
== char_is_nbsp
? ' ' : '-');
5855 XSETINT (it
->ctl_chars
[1], c
);
5857 goto display_control
;
5864 if (CHAR_BYTE8_P (c
))
5865 /* Display \200 instead of \17777600. */
5866 c
= CHAR_TO_BYTE8 (c
);
5867 len
= sprintf (str
, "%03o", c
);
5869 XSETINT (it
->ctl_chars
[0], escape_glyph
);
5870 for (i
= 0; i
< len
; i
++)
5871 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
5876 /* Set up IT->dpvec and return first character from it. */
5877 it
->dpvec_char_len
= it
->len
;
5878 it
->dpvec
= it
->ctl_chars
;
5879 it
->dpend
= it
->dpvec
+ ctl_len
;
5880 it
->current
.dpvec_index
= 0;
5881 it
->dpvec_face_id
= face_id
;
5882 it
->saved_face_id
= it
->face_id
;
5883 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5887 it
->char_to_display
= c
;
5891 it
->char_to_display
= it
->c
;
5895 #ifdef HAVE_WINDOW_SYSTEM
5896 /* Adjust face id for a multibyte character. There are no multibyte
5897 character in unibyte text. */
5898 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
5901 && FRAME_WINDOW_P (it
->f
))
5903 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
5905 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
5907 /* Automatic composition with glyph-string. */
5908 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
5910 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
5914 int pos
= (it
->s
? -1
5915 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
5916 : IT_CHARPOS (*it
));
5918 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
, pos
,
5924 /* Is this character the last one of a run of characters with
5925 box? If yes, set IT->end_of_box_run_p to 1. */
5929 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
5931 int face_id
= underlying_face_id (it
);
5932 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
5936 if (face
->box
== FACE_NO_BOX
)
5938 /* If the box comes from face properties in a
5939 display string, check faces in that string. */
5940 int string_face_id
= face_after_it_pos (it
);
5941 it
->end_of_box_run_p
5942 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
5945 /* Otherwise, the box comes from the underlying face.
5946 If this is the last string character displayed, check
5947 the next buffer location. */
5948 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
5949 && (it
->current
.overlay_string_index
5950 == it
->n_overlay_strings
- 1))
5954 struct text_pos pos
= it
->current
.pos
;
5955 INC_TEXT_POS (pos
, it
->multibyte_p
);
5957 next_face_id
= face_at_buffer_position
5958 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
5959 it
->region_end_charpos
, &ignore
,
5960 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
5962 it
->end_of_box_run_p
5963 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
5970 int face_id
= face_after_it_pos (it
);
5971 it
->end_of_box_run_p
5972 = (face_id
!= it
->face_id
5973 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
5977 /* Value is 0 if end of buffer or string reached. */
5982 /* Move IT to the next display element.
5984 RESEAT_P non-zero means if called on a newline in buffer text,
5985 skip to the next visible line start.
5987 Functions get_next_display_element and set_iterator_to_next are
5988 separate because I find this arrangement easier to handle than a
5989 get_next_display_element function that also increments IT's
5990 position. The way it is we can first look at an iterator's current
5991 display element, decide whether it fits on a line, and if it does,
5992 increment the iterator position. The other way around we probably
5993 would either need a flag indicating whether the iterator has to be
5994 incremented the next time, or we would have to implement a
5995 decrement position function which would not be easy to write. */
5998 set_iterator_to_next (it
, reseat_p
)
6002 /* Reset flags indicating start and end of a sequence of characters
6003 with box. Reset them at the start of this function because
6004 moving the iterator to a new position might set them. */
6005 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6009 case GET_FROM_BUFFER
:
6010 /* The current display element of IT is a character from
6011 current_buffer. Advance in the buffer, and maybe skip over
6012 invisible lines that are so because of selective display. */
6013 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6014 reseat_at_next_visible_line_start (it
, 0);
6015 else if (it
->cmp_it
.id
>= 0)
6017 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6018 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6019 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6020 it
->cmp_it
.from
= it
->cmp_it
.to
;
6024 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6025 IT_BYTEPOS (*it
), it
->stop_charpos
,
6031 xassert (it
->len
!= 0);
6032 IT_BYTEPOS (*it
) += it
->len
;
6033 IT_CHARPOS (*it
) += 1;
6034 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6038 case GET_FROM_C_STRING
:
6039 /* Current display element of IT is from a C string. */
6040 IT_BYTEPOS (*it
) += it
->len
;
6041 IT_CHARPOS (*it
) += 1;
6044 case GET_FROM_DISPLAY_VECTOR
:
6045 /* Current display element of IT is from a display table entry.
6046 Advance in the display table definition. Reset it to null if
6047 end reached, and continue with characters from buffers/
6049 ++it
->current
.dpvec_index
;
6051 /* Restore face of the iterator to what they were before the
6052 display vector entry (these entries may contain faces). */
6053 it
->face_id
= it
->saved_face_id
;
6055 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6057 int recheck_faces
= it
->ellipsis_p
;
6060 it
->method
= GET_FROM_C_STRING
;
6061 else if (STRINGP (it
->string
))
6062 it
->method
= GET_FROM_STRING
;
6065 it
->method
= GET_FROM_BUFFER
;
6066 it
->object
= it
->w
->buffer
;
6070 it
->current
.dpvec_index
= -1;
6072 /* Skip over characters which were displayed via IT->dpvec. */
6073 if (it
->dpvec_char_len
< 0)
6074 reseat_at_next_visible_line_start (it
, 1);
6075 else if (it
->dpvec_char_len
> 0)
6077 if (it
->method
== GET_FROM_STRING
6078 && it
->n_overlay_strings
> 0)
6079 it
->ignore_overlay_strings_at_pos_p
= 1;
6080 it
->len
= it
->dpvec_char_len
;
6081 set_iterator_to_next (it
, reseat_p
);
6084 /* Maybe recheck faces after display vector */
6086 it
->stop_charpos
= IT_CHARPOS (*it
);
6090 case GET_FROM_STRING
:
6091 /* Current display element is a character from a Lisp string. */
6092 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6093 if (it
->cmp_it
.id
>= 0)
6095 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6096 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6097 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6098 it
->cmp_it
.from
= it
->cmp_it
.to
;
6102 composition_compute_stop_pos (&it
->cmp_it
,
6103 IT_STRING_CHARPOS (*it
),
6104 IT_STRING_BYTEPOS (*it
),
6105 it
->stop_charpos
, it
->string
);
6110 IT_STRING_BYTEPOS (*it
) += it
->len
;
6111 IT_STRING_CHARPOS (*it
) += 1;
6114 consider_string_end
:
6116 if (it
->current
.overlay_string_index
>= 0)
6118 /* IT->string is an overlay string. Advance to the
6119 next, if there is one. */
6120 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6123 next_overlay_string (it
);
6125 setup_for_ellipsis (it
, 0);
6130 /* IT->string is not an overlay string. If we reached
6131 its end, and there is something on IT->stack, proceed
6132 with what is on the stack. This can be either another
6133 string, this time an overlay string, or a buffer. */
6134 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
6138 if (it
->method
== GET_FROM_STRING
)
6139 goto consider_string_end
;
6144 case GET_FROM_IMAGE
:
6145 case GET_FROM_STRETCH
:
6146 /* The position etc with which we have to proceed are on
6147 the stack. The position may be at the end of a string,
6148 if the `display' property takes up the whole string. */
6149 xassert (it
->sp
> 0);
6151 if (it
->method
== GET_FROM_STRING
)
6152 goto consider_string_end
;
6156 /* There are no other methods defined, so this should be a bug. */
6160 xassert (it
->method
!= GET_FROM_STRING
6161 || (STRINGP (it
->string
)
6162 && IT_STRING_CHARPOS (*it
) >= 0));
6165 /* Load IT's display element fields with information about the next
6166 display element which comes from a display table entry or from the
6167 result of translating a control character to one of the forms `^C'
6170 IT->dpvec holds the glyphs to return as characters.
6171 IT->saved_face_id holds the face id before the display vector--it
6172 is restored into IT->face_id in set_iterator_to_next. */
6175 next_element_from_display_vector (it
)
6181 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
6183 it
->face_id
= it
->saved_face_id
;
6185 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
6186 That seemed totally bogus - so I changed it... */
6187 gc
= it
->dpvec
[it
->current
.dpvec_index
];
6189 if (GLYPH_CODE_P (gc
) && GLYPH_CODE_CHAR_VALID_P (gc
))
6191 it
->c
= GLYPH_CODE_CHAR (gc
);
6192 it
->len
= CHAR_BYTES (it
->c
);
6194 /* The entry may contain a face id to use. Such a face id is
6195 the id of a Lisp face, not a realized face. A face id of
6196 zero means no face is specified. */
6197 if (it
->dpvec_face_id
>= 0)
6198 it
->face_id
= it
->dpvec_face_id
;
6201 int lface_id
= GLYPH_CODE_FACE (gc
);
6203 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6208 /* Display table entry is invalid. Return a space. */
6209 it
->c
= ' ', it
->len
= 1;
6211 /* Don't change position and object of the iterator here. They are
6212 still the values of the character that had this display table
6213 entry or was translated, and that's what we want. */
6214 it
->what
= IT_CHARACTER
;
6219 /* Load IT with the next display element from Lisp string IT->string.
6220 IT->current.string_pos is the current position within the string.
6221 If IT->current.overlay_string_index >= 0, the Lisp string is an
6225 next_element_from_string (it
)
6228 struct text_pos position
;
6230 xassert (STRINGP (it
->string
));
6231 xassert (IT_STRING_CHARPOS (*it
) >= 0);
6232 position
= it
->current
.string_pos
;
6234 /* Time to check for invisible text? */
6235 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
6236 && IT_STRING_CHARPOS (*it
) == it
->stop_charpos
)
6240 /* Since a handler may have changed IT->method, we must
6242 return GET_NEXT_DISPLAY_ELEMENT (it
);
6245 if (it
->current
.overlay_string_index
>= 0)
6247 /* Get the next character from an overlay string. In overlay
6248 strings, There is no field width or padding with spaces to
6250 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6255 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6256 IT_STRING_BYTEPOS (*it
), SCHARS (it
->string
))
6257 && next_element_from_composition (it
))
6261 else if (STRING_MULTIBYTE (it
->string
))
6263 int remaining
= SBYTES (it
->string
) - IT_STRING_BYTEPOS (*it
);
6264 const unsigned char *s
= (SDATA (it
->string
)
6265 + IT_STRING_BYTEPOS (*it
));
6266 it
->c
= string_char_and_length (s
, &it
->len
);
6270 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6276 /* Get the next character from a Lisp string that is not an
6277 overlay string. Such strings come from the mode line, for
6278 example. We may have to pad with spaces, or truncate the
6279 string. See also next_element_from_c_string. */
6280 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
6285 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
6287 /* Pad with spaces. */
6288 it
->c
= ' ', it
->len
= 1;
6289 CHARPOS (position
) = BYTEPOS (position
) = -1;
6291 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6292 IT_STRING_BYTEPOS (*it
), it
->string_nchars
)
6293 && next_element_from_composition (it
))
6297 else if (STRING_MULTIBYTE (it
->string
))
6299 int maxlen
= SBYTES (it
->string
) - IT_STRING_BYTEPOS (*it
);
6300 const unsigned char *s
= (SDATA (it
->string
)
6301 + IT_STRING_BYTEPOS (*it
));
6302 it
->c
= string_char_and_length (s
, &it
->len
);
6306 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6311 /* Record what we have and where it came from. */
6312 it
->what
= IT_CHARACTER
;
6313 it
->object
= it
->string
;
6314 it
->position
= position
;
6319 /* Load IT with next display element from C string IT->s.
6320 IT->string_nchars is the maximum number of characters to return
6321 from the string. IT->end_charpos may be greater than
6322 IT->string_nchars when this function is called, in which case we
6323 may have to return padding spaces. Value is zero if end of string
6324 reached, including padding spaces. */
6327 next_element_from_c_string (it
)
6333 it
->what
= IT_CHARACTER
;
6334 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
6337 /* IT's position can be greater IT->string_nchars in case a field
6338 width or precision has been specified when the iterator was
6340 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6342 /* End of the game. */
6346 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
6348 /* Pad with spaces. */
6349 it
->c
= ' ', it
->len
= 1;
6350 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
6352 else if (it
->multibyte_p
)
6354 /* Implementation note: The calls to strlen apparently aren't a
6355 performance problem because there is no noticeable performance
6356 difference between Emacs running in unibyte or multibyte mode. */
6357 int maxlen
= strlen (it
->s
) - IT_BYTEPOS (*it
);
6358 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
6361 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
6367 /* Set up IT to return characters from an ellipsis, if appropriate.
6368 The definition of the ellipsis glyphs may come from a display table
6369 entry. This function fills IT with the first glyph from the
6370 ellipsis if an ellipsis is to be displayed. */
6373 next_element_from_ellipsis (it
)
6376 if (it
->selective_display_ellipsis_p
)
6377 setup_for_ellipsis (it
, it
->len
);
6380 /* The face at the current position may be different from the
6381 face we find after the invisible text. Remember what it
6382 was in IT->saved_face_id, and signal that it's there by
6383 setting face_before_selective_p. */
6384 it
->saved_face_id
= it
->face_id
;
6385 it
->method
= GET_FROM_BUFFER
;
6386 it
->object
= it
->w
->buffer
;
6387 reseat_at_next_visible_line_start (it
, 1);
6388 it
->face_before_selective_p
= 1;
6391 return GET_NEXT_DISPLAY_ELEMENT (it
);
6395 /* Deliver an image display element. The iterator IT is already
6396 filled with image information (done in handle_display_prop). Value
6401 next_element_from_image (it
)
6404 it
->what
= IT_IMAGE
;
6405 it
->ignore_overlay_strings_at_pos_p
= 0;
6410 /* Fill iterator IT with next display element from a stretch glyph
6411 property. IT->object is the value of the text property. Value is
6415 next_element_from_stretch (it
)
6418 it
->what
= IT_STRETCH
;
6423 /* Load IT with the next display element from current_buffer. Value
6424 is zero if end of buffer reached. IT->stop_charpos is the next
6425 position at which to stop and check for text properties or buffer
6429 next_element_from_buffer (it
)
6434 xassert (IT_CHARPOS (*it
) >= BEGV
);
6436 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
6438 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6440 int overlay_strings_follow_p
;
6442 /* End of the game, except when overlay strings follow that
6443 haven't been returned yet. */
6444 if (it
->overlay_strings_at_end_processed_p
)
6445 overlay_strings_follow_p
= 0;
6448 it
->overlay_strings_at_end_processed_p
= 1;
6449 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
6452 if (overlay_strings_follow_p
)
6453 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6457 it
->position
= it
->current
.pos
;
6464 return GET_NEXT_DISPLAY_ELEMENT (it
);
6469 /* No face changes, overlays etc. in sight, so just return a
6470 character from current_buffer. */
6473 /* Maybe run the redisplay end trigger hook. Performance note:
6474 This doesn't seem to cost measurable time. */
6475 if (it
->redisplay_end_trigger_charpos
6477 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
6478 run_redisplay_end_trigger_hook (it
);
6480 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6482 && next_element_from_composition (it
))
6487 /* Get the next character, maybe multibyte. */
6488 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
6489 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
6490 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
6492 it
->c
= *p
, it
->len
= 1;
6494 /* Record what we have and where it came from. */
6495 it
->what
= IT_CHARACTER
;
6496 it
->object
= it
->w
->buffer
;
6497 it
->position
= it
->current
.pos
;
6499 /* Normally we return the character found above, except when we
6500 really want to return an ellipsis for selective display. */
6505 /* A value of selective > 0 means hide lines indented more
6506 than that number of columns. */
6507 if (it
->selective
> 0
6508 && IT_CHARPOS (*it
) + 1 < ZV
6509 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
6510 IT_BYTEPOS (*it
) + 1,
6511 (double) it
->selective
)) /* iftc */
6513 success_p
= next_element_from_ellipsis (it
);
6514 it
->dpvec_char_len
= -1;
6517 else if (it
->c
== '\r' && it
->selective
== -1)
6519 /* A value of selective == -1 means that everything from the
6520 CR to the end of the line is invisible, with maybe an
6521 ellipsis displayed for it. */
6522 success_p
= next_element_from_ellipsis (it
);
6523 it
->dpvec_char_len
= -1;
6528 /* Value is zero if end of buffer reached. */
6529 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
6534 /* Run the redisplay end trigger hook for IT. */
6537 run_redisplay_end_trigger_hook (it
)
6540 Lisp_Object args
[3];
6542 /* IT->glyph_row should be non-null, i.e. we should be actually
6543 displaying something, or otherwise we should not run the hook. */
6544 xassert (it
->glyph_row
);
6546 /* Set up hook arguments. */
6547 args
[0] = Qredisplay_end_trigger_functions
;
6548 args
[1] = it
->window
;
6549 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
6550 it
->redisplay_end_trigger_charpos
= 0;
6552 /* Since we are *trying* to run these functions, don't try to run
6553 them again, even if they get an error. */
6554 it
->w
->redisplay_end_trigger
= Qnil
;
6555 Frun_hook_with_args (3, args
);
6557 /* Notice if it changed the face of the character we are on. */
6558 handle_face_prop (it
);
6562 /* Deliver a composition display element. Unlike the other
6563 next_element_from_XXX, this function is not registered in the array
6564 get_next_element[]. It is called from next_element_from_buffer and
6565 next_element_from_string when necessary. */
6568 next_element_from_composition (it
)
6571 it
->what
= IT_COMPOSITION
;
6572 it
->len
= it
->cmp_it
.nbytes
;
6573 if (STRINGP (it
->string
))
6577 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6578 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6581 it
->position
= it
->current
.string_pos
;
6582 it
->object
= it
->string
;
6583 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
6584 IT_STRING_BYTEPOS (*it
), it
->string
);
6590 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6591 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6594 it
->position
= it
->current
.pos
;
6595 it
->object
= it
->w
->buffer
;
6596 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
6597 IT_BYTEPOS (*it
), Qnil
);
6604 /***********************************************************************
6605 Moving an iterator without producing glyphs
6606 ***********************************************************************/
6608 /* Check if iterator is at a position corresponding to a valid buffer
6609 position after some move_it_ call. */
6611 #define IT_POS_VALID_AFTER_MOVE_P(it) \
6612 ((it)->method == GET_FROM_STRING \
6613 ? IT_STRING_CHARPOS (*it) == 0 \
6617 /* Move iterator IT to a specified buffer or X position within one
6618 line on the display without producing glyphs.
6620 OP should be a bit mask including some or all of these bits:
6621 MOVE_TO_X: Stop on reaching x-position TO_X.
6622 MOVE_TO_POS: Stop on reaching buffer or string position TO_CHARPOS.
6623 Regardless of OP's value, stop in reaching the end of the display line.
6625 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
6626 This means, in particular, that TO_X includes window's horizontal
6629 The return value has several possible values that
6630 say what condition caused the scan to stop:
6632 MOVE_POS_MATCH_OR_ZV
6633 - when TO_POS or ZV was reached.
6636 -when TO_X was reached before TO_POS or ZV were reached.
6639 - when we reached the end of the display area and the line must
6643 - when we reached the end of the display area and the line is
6647 - when we stopped at a line end, i.e. a newline or a CR and selective
6650 static enum move_it_result
6651 move_it_in_display_line_to (struct it
*it
,
6652 EMACS_INT to_charpos
, int to_x
,
6653 enum move_operation_enum op
)
6655 enum move_it_result result
= MOVE_UNDEFINED
;
6656 struct glyph_row
*saved_glyph_row
;
6657 struct it wrap_it
, atpos_it
, atx_it
;
6660 /* Don't produce glyphs in produce_glyphs. */
6661 saved_glyph_row
= it
->glyph_row
;
6662 it
->glyph_row
= NULL
;
6664 /* Use wrap_it to save a copy of IT wherever a word wrap could
6665 occur. Use atpos_it to save a copy of IT at the desired buffer
6666 position, if found, so that we can scan ahead and check if the
6667 word later overshoots the window edge. Use atx_it similarly, for
6673 #define BUFFER_POS_REACHED_P() \
6674 ((op & MOVE_TO_POS) != 0 \
6675 && BUFFERP (it->object) \
6676 && IT_CHARPOS (*it) >= to_charpos \
6677 && (it->method == GET_FROM_BUFFER \
6678 || (it->method == GET_FROM_DISPLAY_VECTOR \
6679 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
6681 /* If there's a line-/wrap-prefix, handle it. */
6682 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
6683 && it
->current_y
< it
->last_visible_y
)
6684 handle_line_prefix (it
);
6688 int x
, i
, ascent
= 0, descent
= 0;
6690 /* Utility macro to reset an iterator with x, ascent, and descent. */
6691 #define IT_RESET_X_ASCENT_DESCENT(IT) \
6692 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
6693 (IT)->max_descent = descent)
6695 /* Stop if we move beyond TO_CHARPOS (after an image or stretch
6697 if ((op
& MOVE_TO_POS
) != 0
6698 && BUFFERP (it
->object
)
6699 && it
->method
== GET_FROM_BUFFER
6700 && IT_CHARPOS (*it
) > to_charpos
)
6702 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
6704 result
= MOVE_POS_MATCH_OR_ZV
;
6707 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
6708 /* If wrap_it is valid, the current position might be in a
6709 word that is wrapped. So, save the iterator in
6710 atpos_it and continue to see if wrapping happens. */
6714 /* Stop when ZV reached.
6715 We used to stop here when TO_CHARPOS reached as well, but that is
6716 too soon if this glyph does not fit on this line. So we handle it
6717 explicitly below. */
6718 if (!get_next_display_element (it
))
6720 result
= MOVE_POS_MATCH_OR_ZV
;
6724 if (it
->line_wrap
== TRUNCATE
)
6726 if (BUFFER_POS_REACHED_P ())
6728 result
= MOVE_POS_MATCH_OR_ZV
;
6734 if (it
->line_wrap
== WORD_WRAP
)
6736 if (IT_DISPLAYING_WHITESPACE (it
))
6740 /* We have reached a glyph that follows one or more
6741 whitespace characters. If the position is
6742 already found, we are done. */
6743 if (atpos_it
.sp
>= 0)
6746 result
= MOVE_POS_MATCH_OR_ZV
;
6752 result
= MOVE_X_REACHED
;
6755 /* Otherwise, we can wrap here. */
6762 /* Remember the line height for the current line, in case
6763 the next element doesn't fit on the line. */
6764 ascent
= it
->max_ascent
;
6765 descent
= it
->max_descent
;
6767 /* The call to produce_glyphs will get the metrics of the
6768 display element IT is loaded with. Record the x-position
6769 before this display element, in case it doesn't fit on the
6773 PRODUCE_GLYPHS (it
);
6775 if (it
->area
!= TEXT_AREA
)
6777 set_iterator_to_next (it
, 1);
6781 /* The number of glyphs we get back in IT->nglyphs will normally
6782 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
6783 character on a terminal frame, or (iii) a line end. For the
6784 second case, IT->nglyphs - 1 padding glyphs will be present.
6785 (On X frames, there is only one glyph produced for a
6786 composite character.)
6788 The behavior implemented below means, for continuation lines,
6789 that as many spaces of a TAB as fit on the current line are
6790 displayed there. For terminal frames, as many glyphs of a
6791 multi-glyph character are displayed in the current line, too.
6792 This is what the old redisplay code did, and we keep it that
6793 way. Under X, the whole shape of a complex character must
6794 fit on the line or it will be completely displayed in the
6797 Note that both for tabs and padding glyphs, all glyphs have
6801 /* More than one glyph or glyph doesn't fit on line. All
6802 glyphs have the same width. */
6803 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
6805 int x_before_this_char
= x
;
6806 int hpos_before_this_char
= it
->hpos
;
6808 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
6810 new_x
= x
+ single_glyph_width
;
6812 /* We want to leave anything reaching TO_X to the caller. */
6813 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
6815 if (BUFFER_POS_REACHED_P ())
6817 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
6818 goto buffer_pos_reached
;
6819 if (atpos_it
.sp
< 0)
6822 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
6827 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
6830 result
= MOVE_X_REACHED
;
6836 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
6841 if (/* Lines are continued. */
6842 it
->line_wrap
!= TRUNCATE
6843 && (/* And glyph doesn't fit on the line. */
6844 new_x
> it
->last_visible_x
6845 /* Or it fits exactly and we're on a window
6847 || (new_x
== it
->last_visible_x
6848 && FRAME_WINDOW_P (it
->f
))))
6850 if (/* IT->hpos == 0 means the very first glyph
6851 doesn't fit on the line, e.g. a wide image. */
6853 || (new_x
== it
->last_visible_x
6854 && FRAME_WINDOW_P (it
->f
)))
6857 it
->current_x
= new_x
;
6859 /* The character's last glyph just barely fits
6861 if (i
== it
->nglyphs
- 1)
6863 /* If this is the destination position,
6864 return a position *before* it in this row,
6865 now that we know it fits in this row. */
6866 if (BUFFER_POS_REACHED_P ())
6868 if (it
->line_wrap
!= WORD_WRAP
6871 it
->hpos
= hpos_before_this_char
;
6872 it
->current_x
= x_before_this_char
;
6873 result
= MOVE_POS_MATCH_OR_ZV
;
6876 if (it
->line_wrap
== WORD_WRAP
6880 atpos_it
.current_x
= x_before_this_char
;
6881 atpos_it
.hpos
= hpos_before_this_char
;
6885 set_iterator_to_next (it
, 1);
6886 /* On graphical terminals, newlines may
6887 "overflow" into the fringe if
6888 overflow-newline-into-fringe is non-nil.
6889 On text-only terminals, newlines may
6890 overflow into the last glyph on the
6892 if (!FRAME_WINDOW_P (it
->f
)
6893 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
6895 if (!get_next_display_element (it
))
6897 result
= MOVE_POS_MATCH_OR_ZV
;
6900 if (BUFFER_POS_REACHED_P ())
6902 if (ITERATOR_AT_END_OF_LINE_P (it
))
6903 result
= MOVE_POS_MATCH_OR_ZV
;
6905 result
= MOVE_LINE_CONTINUED
;
6908 if (ITERATOR_AT_END_OF_LINE_P (it
))
6910 result
= MOVE_NEWLINE_OR_CR
;
6917 IT_RESET_X_ASCENT_DESCENT (it
);
6919 if (wrap_it
.sp
>= 0)
6926 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
6928 result
= MOVE_LINE_CONTINUED
;
6932 if (BUFFER_POS_REACHED_P ())
6934 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
6935 goto buffer_pos_reached
;
6936 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
6939 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
6943 if (new_x
> it
->first_visible_x
)
6945 /* Glyph is visible. Increment number of glyphs that
6946 would be displayed. */
6951 if (result
!= MOVE_UNDEFINED
)
6954 else if (BUFFER_POS_REACHED_P ())
6957 IT_RESET_X_ASCENT_DESCENT (it
);
6958 result
= MOVE_POS_MATCH_OR_ZV
;
6961 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
6963 /* Stop when TO_X specified and reached. This check is
6964 necessary here because of lines consisting of a line end,
6965 only. The line end will not produce any glyphs and we
6966 would never get MOVE_X_REACHED. */
6967 xassert (it
->nglyphs
== 0);
6968 result
= MOVE_X_REACHED
;
6972 /* Is this a line end? If yes, we're done. */
6973 if (ITERATOR_AT_END_OF_LINE_P (it
))
6975 result
= MOVE_NEWLINE_OR_CR
;
6979 /* The current display element has been consumed. Advance
6981 set_iterator_to_next (it
, 1);
6983 /* Stop if lines are truncated and IT's current x-position is
6984 past the right edge of the window now. */
6985 if (it
->line_wrap
== TRUNCATE
6986 && it
->current_x
>= it
->last_visible_x
)
6988 if (!FRAME_WINDOW_P (it
->f
)
6989 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
6991 if (!get_next_display_element (it
)
6992 || BUFFER_POS_REACHED_P ())
6994 result
= MOVE_POS_MATCH_OR_ZV
;
6997 if (ITERATOR_AT_END_OF_LINE_P (it
))
6999 result
= MOVE_NEWLINE_OR_CR
;
7003 result
= MOVE_LINE_TRUNCATED
;
7006 #undef IT_RESET_X_ASCENT_DESCENT
7009 #undef BUFFER_POS_REACHED_P
7011 /* If we scanned beyond to_pos and didn't find a point to wrap at,
7012 restore the saved iterator. */
7013 if (atpos_it
.sp
>= 0)
7015 else if (atx_it
.sp
>= 0)
7020 /* Restore the iterator settings altered at the beginning of this
7022 it
->glyph_row
= saved_glyph_row
;
7026 /* For external use. */
7028 move_it_in_display_line (struct it
*it
,
7029 EMACS_INT to_charpos
, int to_x
,
7030 enum move_operation_enum op
)
7032 if (it
->line_wrap
== WORD_WRAP
7033 && (op
& MOVE_TO_X
))
7035 struct it save_it
= *it
;
7036 int skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7037 /* When word-wrap is on, TO_X may lie past the end
7038 of a wrapped line. Then it->current is the
7039 character on the next line, so backtrack to the
7040 space before the wrap point. */
7041 if (skip
== MOVE_LINE_CONTINUED
)
7043 int prev_x
= max (it
->current_x
- 1, 0);
7045 move_it_in_display_line_to
7046 (it
, -1, prev_x
, MOVE_TO_X
);
7050 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7054 /* Move IT forward until it satisfies one or more of the criteria in
7055 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
7057 OP is a bit-mask that specifies where to stop, and in particular,
7058 which of those four position arguments makes a difference. See the
7059 description of enum move_operation_enum.
7061 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
7062 screen line, this function will set IT to the next position >
7066 move_it_to (it
, to_charpos
, to_x
, to_y
, to_vpos
, op
)
7068 int to_charpos
, to_x
, to_y
, to_vpos
;
7071 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
7072 int line_height
, line_start_x
= 0, reached
= 0;
7076 if (op
& MOVE_TO_VPOS
)
7078 /* If no TO_CHARPOS and no TO_X specified, stop at the
7079 start of the line TO_VPOS. */
7080 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
7082 if (it
->vpos
== to_vpos
)
7088 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
7092 /* TO_VPOS >= 0 means stop at TO_X in the line at
7093 TO_VPOS, or at TO_POS, whichever comes first. */
7094 if (it
->vpos
== to_vpos
)
7100 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7102 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
7107 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
7109 /* We have reached TO_X but not in the line we want. */
7110 skip
= move_it_in_display_line_to (it
, to_charpos
,
7112 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7120 else if (op
& MOVE_TO_Y
)
7122 struct it it_backup
;
7124 if (it
->line_wrap
== WORD_WRAP
)
7127 /* TO_Y specified means stop at TO_X in the line containing
7128 TO_Y---or at TO_CHARPOS if this is reached first. The
7129 problem is that we can't really tell whether the line
7130 contains TO_Y before we have completely scanned it, and
7131 this may skip past TO_X. What we do is to first scan to
7134 If TO_X is not specified, use a TO_X of zero. The reason
7135 is to make the outcome of this function more predictable.
7136 If we didn't use TO_X == 0, we would stop at the end of
7137 the line which is probably not what a caller would expect
7139 skip
= move_it_in_display_line_to
7140 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
7141 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
7143 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
7144 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7146 else if (skip
== MOVE_X_REACHED
)
7148 /* If TO_X was reached, we want to know whether TO_Y is
7149 in the line. We know this is the case if the already
7150 scanned glyphs make the line tall enough. Otherwise,
7151 we must check by scanning the rest of the line. */
7152 line_height
= it
->max_ascent
+ it
->max_descent
;
7153 if (to_y
>= it
->current_y
7154 && to_y
< it
->current_y
+ line_height
)
7160 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
7161 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
7163 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
7164 line_height
= it
->max_ascent
+ it
->max_descent
;
7165 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7167 if (to_y
>= it
->current_y
7168 && to_y
< it
->current_y
+ line_height
)
7170 /* If TO_Y is in this line and TO_X was reached
7171 above, we scanned too far. We have to restore
7172 IT's settings to the ones before skipping. */
7179 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7185 /* Check whether TO_Y is in this line. */
7186 line_height
= it
->max_ascent
+ it
->max_descent
;
7187 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7189 if (to_y
>= it
->current_y
7190 && to_y
< it
->current_y
+ line_height
)
7192 /* When word-wrap is on, TO_X may lie past the end
7193 of a wrapped line. Then it->current is the
7194 character on the next line, so backtrack to the
7195 space before the wrap point. */
7196 if (skip
== MOVE_LINE_CONTINUED
7197 && it
->line_wrap
== WORD_WRAP
)
7199 int prev_x
= max (it
->current_x
- 1, 0);
7201 skip
= move_it_in_display_line_to
7202 (it
, -1, prev_x
, MOVE_TO_X
);
7211 else if (BUFFERP (it
->object
)
7212 && (it
->method
== GET_FROM_BUFFER
7213 || it
->method
== GET_FROM_STRETCH
)
7214 && IT_CHARPOS (*it
) >= to_charpos
)
7215 skip
= MOVE_POS_MATCH_OR_ZV
;
7217 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
7221 case MOVE_POS_MATCH_OR_ZV
:
7225 case MOVE_NEWLINE_OR_CR
:
7226 set_iterator_to_next (it
, 1);
7227 it
->continuation_lines_width
= 0;
7230 case MOVE_LINE_TRUNCATED
:
7231 it
->continuation_lines_width
= 0;
7232 reseat_at_next_visible_line_start (it
, 0);
7233 if ((op
& MOVE_TO_POS
) != 0
7234 && IT_CHARPOS (*it
) > to_charpos
)
7241 case MOVE_LINE_CONTINUED
:
7242 /* For continued lines ending in a tab, some of the glyphs
7243 associated with the tab are displayed on the current
7244 line. Since it->current_x does not include these glyphs,
7245 we use it->last_visible_x instead. */
7248 it
->continuation_lines_width
+= it
->last_visible_x
;
7249 /* When moving by vpos, ensure that the iterator really
7250 advances to the next line (bug#847, bug#969). Fixme:
7251 do we need to do this in other circumstances? */
7252 if (it
->current_x
!= it
->last_visible_x
7253 && (op
& MOVE_TO_VPOS
)
7254 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
7256 line_start_x
= it
->current_x
+ it
->pixel_width
7257 - it
->last_visible_x
;
7258 set_iterator_to_next (it
, 0);
7262 it
->continuation_lines_width
+= it
->current_x
;
7269 /* Reset/increment for the next run. */
7270 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
7271 it
->current_x
= line_start_x
;
7274 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7276 last_height
= it
->max_ascent
+ it
->max_descent
;
7277 last_max_ascent
= it
->max_ascent
;
7278 it
->max_ascent
= it
->max_descent
= 0;
7283 /* On text terminals, we may stop at the end of a line in the middle
7284 of a multi-character glyph. If the glyph itself is continued,
7285 i.e. it is actually displayed on the next line, don't treat this
7286 stopping point as valid; move to the next line instead (unless
7287 that brings us offscreen). */
7288 if (!FRAME_WINDOW_P (it
->f
)
7290 && IT_CHARPOS (*it
) == to_charpos
7291 && it
->what
== IT_CHARACTER
7293 && it
->line_wrap
== WINDOW_WRAP
7294 && it
->current_x
== it
->last_visible_x
- 1
7297 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
7299 it
->continuation_lines_width
+= it
->current_x
;
7300 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
7301 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7303 last_height
= it
->max_ascent
+ it
->max_descent
;
7304 last_max_ascent
= it
->max_ascent
;
7307 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
7311 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
7313 If DY > 0, move IT backward at least that many pixels. DY = 0
7314 means move IT backward to the preceding line start or BEGV. This
7315 function may move over more than DY pixels if IT->current_y - DY
7316 ends up in the middle of a line; in this case IT->current_y will be
7317 set to the top of the line moved to. */
7320 move_it_vertically_backward (it
, dy
)
7331 start_pos
= IT_CHARPOS (*it
);
7333 /* Estimate how many newlines we must move back. */
7334 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
7336 /* Set the iterator's position that many lines back. */
7337 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
7338 back_to_previous_visible_line_start (it
);
7340 /* Reseat the iterator here. When moving backward, we don't want
7341 reseat to skip forward over invisible text, set up the iterator
7342 to deliver from overlay strings at the new position etc. So,
7343 use reseat_1 here. */
7344 reseat_1 (it
, it
->current
.pos
, 1);
7346 /* We are now surely at a line start. */
7347 it
->current_x
= it
->hpos
= 0;
7348 it
->continuation_lines_width
= 0;
7350 /* Move forward and see what y-distance we moved. First move to the
7351 start of the next line so that we get its height. We need this
7352 height to be able to tell whether we reached the specified
7355 it2
.max_ascent
= it2
.max_descent
= 0;
7358 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
7359 MOVE_TO_POS
| MOVE_TO_VPOS
);
7361 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
7362 xassert (IT_CHARPOS (*it
) >= BEGV
);
7365 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
7366 xassert (IT_CHARPOS (*it
) >= BEGV
);
7367 /* H is the actual vertical distance from the position in *IT
7368 and the starting position. */
7369 h
= it2
.current_y
- it
->current_y
;
7370 /* NLINES is the distance in number of lines. */
7371 nlines
= it2
.vpos
- it
->vpos
;
7373 /* Correct IT's y and vpos position
7374 so that they are relative to the starting point. */
7380 /* DY == 0 means move to the start of the screen line. The
7381 value of nlines is > 0 if continuation lines were involved. */
7383 move_it_by_lines (it
, nlines
, 1);
7387 /* The y-position we try to reach, relative to *IT.
7388 Note that H has been subtracted in front of the if-statement. */
7389 int target_y
= it
->current_y
+ h
- dy
;
7390 int y0
= it3
.current_y
;
7391 int y1
= line_bottom_y (&it3
);
7392 int line_height
= y1
- y0
;
7394 /* If we did not reach target_y, try to move further backward if
7395 we can. If we moved too far backward, try to move forward. */
7396 if (target_y
< it
->current_y
7397 /* This is heuristic. In a window that's 3 lines high, with
7398 a line height of 13 pixels each, recentering with point
7399 on the bottom line will try to move -39/2 = 19 pixels
7400 backward. Try to avoid moving into the first line. */
7401 && (it
->current_y
- target_y
7402 > min (window_box_height (it
->w
), line_height
* 2 / 3))
7403 && IT_CHARPOS (*it
) > BEGV
)
7405 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
7406 target_y
- it
->current_y
));
7407 dy
= it
->current_y
- target_y
;
7408 goto move_further_back
;
7410 else if (target_y
>= it
->current_y
+ line_height
7411 && IT_CHARPOS (*it
) < ZV
)
7413 /* Should move forward by at least one line, maybe more.
7415 Note: Calling move_it_by_lines can be expensive on
7416 terminal frames, where compute_motion is used (via
7417 vmotion) to do the job, when there are very long lines
7418 and truncate-lines is nil. That's the reason for
7419 treating terminal frames specially here. */
7421 if (!FRAME_WINDOW_P (it
->f
))
7422 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
7427 move_it_by_lines (it
, 1, 1);
7429 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
7436 /* Move IT by a specified amount of pixel lines DY. DY negative means
7437 move backwards. DY = 0 means move to start of screen line. At the
7438 end, IT will be on the start of a screen line. */
7441 move_it_vertically (it
, dy
)
7446 move_it_vertically_backward (it
, -dy
);
7449 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
7450 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
7451 MOVE_TO_POS
| MOVE_TO_Y
);
7452 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
7454 /* If buffer ends in ZV without a newline, move to the start of
7455 the line to satisfy the post-condition. */
7456 if (IT_CHARPOS (*it
) == ZV
7458 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
7459 move_it_by_lines (it
, 0, 0);
7464 /* Move iterator IT past the end of the text line it is in. */
7467 move_it_past_eol (it
)
7470 enum move_it_result rc
;
7472 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
7473 if (rc
== MOVE_NEWLINE_OR_CR
)
7474 set_iterator_to_next (it
, 0);
7478 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
7479 negative means move up. DVPOS == 0 means move to the start of the
7480 screen line. NEED_Y_P non-zero means calculate IT->current_y. If
7481 NEED_Y_P is zero, IT->current_y will be left unchanged.
7483 Further optimization ideas: If we would know that IT->f doesn't use
7484 a face with proportional font, we could be faster for
7485 truncate-lines nil. */
7488 move_it_by_lines (it
, dvpos
, need_y_p
)
7490 int dvpos
, need_y_p
;
7492 struct position pos
;
7494 /* The commented-out optimization uses vmotion on terminals. This
7495 gives bad results, because elements like it->what, on which
7496 callers such as pos_visible_p rely, aren't updated. */
7497 /* if (!FRAME_WINDOW_P (it->f))
7499 struct text_pos textpos;
7501 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
7502 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
7503 reseat (it, textpos, 1);
7504 it->vpos += pos.vpos;
7505 it->current_y += pos.vpos;
7511 /* DVPOS == 0 means move to the start of the screen line. */
7512 move_it_vertically_backward (it
, 0);
7513 xassert (it
->current_x
== 0 && it
->hpos
== 0);
7514 /* Let next call to line_bottom_y calculate real line height */
7519 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
7520 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
7521 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
7526 int start_charpos
, i
;
7528 /* Start at the beginning of the screen line containing IT's
7529 position. This may actually move vertically backwards,
7530 in case of overlays, so adjust dvpos accordingly. */
7532 move_it_vertically_backward (it
, 0);
7535 /* Go back -DVPOS visible lines and reseat the iterator there. */
7536 start_charpos
= IT_CHARPOS (*it
);
7537 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
7538 back_to_previous_visible_line_start (it
);
7539 reseat (it
, it
->current
.pos
, 1);
7541 /* Move further back if we end up in a string or an image. */
7542 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
7544 /* First try to move to start of display line. */
7546 move_it_vertically_backward (it
, 0);
7548 if (IT_POS_VALID_AFTER_MOVE_P (it
))
7550 /* If start of line is still in string or image,
7551 move further back. */
7552 back_to_previous_visible_line_start (it
);
7553 reseat (it
, it
->current
.pos
, 1);
7557 it
->current_x
= it
->hpos
= 0;
7559 /* Above call may have moved too far if continuation lines
7560 are involved. Scan forward and see if it did. */
7562 it2
.vpos
= it2
.current_y
= 0;
7563 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
7564 it
->vpos
-= it2
.vpos
;
7565 it
->current_y
-= it2
.current_y
;
7566 it
->current_x
= it
->hpos
= 0;
7568 /* If we moved too far back, move IT some lines forward. */
7569 if (it2
.vpos
> -dvpos
)
7571 int delta
= it2
.vpos
+ dvpos
;
7573 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
7574 /* Move back again if we got too far ahead. */
7575 if (IT_CHARPOS (*it
) >= start_charpos
)
7581 /* Return 1 if IT points into the middle of a display vector. */
7584 in_display_vector_p (it
)
7587 return (it
->method
== GET_FROM_DISPLAY_VECTOR
7588 && it
->current
.dpvec_index
> 0
7589 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
7593 /***********************************************************************
7595 ***********************************************************************/
7598 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
7602 add_to_log (format
, arg1
, arg2
)
7604 Lisp_Object arg1
, arg2
;
7606 Lisp_Object args
[3];
7607 Lisp_Object msg
, fmt
;
7610 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
7613 /* Do nothing if called asynchronously. Inserting text into
7614 a buffer may call after-change-functions and alike and
7615 that would means running Lisp asynchronously. */
7616 if (handling_signal
)
7620 GCPRO4 (fmt
, msg
, arg1
, arg2
);
7622 args
[0] = fmt
= build_string (format
);
7625 msg
= Fformat (3, args
);
7627 len
= SBYTES (msg
) + 1;
7628 SAFE_ALLOCA (buffer
, char *, len
);
7629 bcopy (SDATA (msg
), buffer
, len
);
7631 message_dolog (buffer
, len
- 1, 1, 0);
7638 /* Output a newline in the *Messages* buffer if "needs" one. */
7641 message_log_maybe_newline ()
7643 if (message_log_need_newline
)
7644 message_dolog ("", 0, 1, 0);
7648 /* Add a string M of length NBYTES to the message log, optionally
7649 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
7650 nonzero, means interpret the contents of M as multibyte. This
7651 function calls low-level routines in order to bypass text property
7652 hooks, etc. which might not be safe to run.
7654 This may GC (insert may run before/after change hooks),
7655 so the buffer M must NOT point to a Lisp string. */
7658 message_dolog (m
, nbytes
, nlflag
, multibyte
)
7660 int nbytes
, nlflag
, multibyte
;
7662 if (!NILP (Vmemory_full
))
7665 if (!NILP (Vmessage_log_max
))
7667 struct buffer
*oldbuf
;
7668 Lisp_Object oldpoint
, oldbegv
, oldzv
;
7669 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
7670 int point_at_end
= 0;
7672 Lisp_Object old_deactivate_mark
, tem
;
7673 struct gcpro gcpro1
;
7675 old_deactivate_mark
= Vdeactivate_mark
;
7676 oldbuf
= current_buffer
;
7677 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
7678 current_buffer
->undo_list
= Qt
;
7680 oldpoint
= message_dolog_marker1
;
7681 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
7682 oldbegv
= message_dolog_marker2
;
7683 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
7684 oldzv
= message_dolog_marker3
;
7685 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
7686 GCPRO1 (old_deactivate_mark
);
7694 BEGV_BYTE
= BEG_BYTE
;
7697 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
7699 /* Insert the string--maybe converting multibyte to single byte
7700 or vice versa, so that all the text fits the buffer. */
7702 && NILP (current_buffer
->enable_multibyte_characters
))
7704 int i
, c
, char_bytes
;
7705 unsigned char work
[1];
7707 /* Convert a multibyte string to single-byte
7708 for the *Message* buffer. */
7709 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
7711 c
= string_char_and_length (m
+ i
, &char_bytes
);
7712 work
[0] = (ASCII_CHAR_P (c
)
7714 : multibyte_char_to_unibyte (c
, Qnil
));
7715 insert_1_both (work
, 1, 1, 1, 0, 0);
7718 else if (! multibyte
7719 && ! NILP (current_buffer
->enable_multibyte_characters
))
7721 int i
, c
, char_bytes
;
7722 unsigned char *msg
= (unsigned char *) m
;
7723 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
7724 /* Convert a single-byte string to multibyte
7725 for the *Message* buffer. */
7726 for (i
= 0; i
< nbytes
; i
++)
7729 MAKE_CHAR_MULTIBYTE (c
);
7730 char_bytes
= CHAR_STRING (c
, str
);
7731 insert_1_both (str
, 1, char_bytes
, 1, 0, 0);
7735 insert_1 (m
, nbytes
, 1, 0, 0);
7739 int this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
, dup
;
7740 insert_1 ("\n", 1, 1, 0, 0);
7742 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
7744 this_bol_byte
= PT_BYTE
;
7746 /* See if this line duplicates the previous one.
7747 If so, combine duplicates. */
7750 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
7752 prev_bol_byte
= PT_BYTE
;
7754 dup
= message_log_check_duplicate (prev_bol
, prev_bol_byte
,
7755 this_bol
, this_bol_byte
);
7758 del_range_both (prev_bol
, prev_bol_byte
,
7759 this_bol
, this_bol_byte
, 0);
7765 /* If you change this format, don't forget to also
7766 change message_log_check_duplicate. */
7767 sprintf (dupstr
, " [%d times]", dup
);
7768 duplen
= strlen (dupstr
);
7769 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
7770 insert_1 (dupstr
, duplen
, 1, 0, 1);
7775 /* If we have more than the desired maximum number of lines
7776 in the *Messages* buffer now, delete the oldest ones.
7777 This is safe because we don't have undo in this buffer. */
7779 if (NATNUMP (Vmessage_log_max
))
7781 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
7782 -XFASTINT (Vmessage_log_max
) - 1, 0);
7783 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
7786 BEGV
= XMARKER (oldbegv
)->charpos
;
7787 BEGV_BYTE
= marker_byte_position (oldbegv
);
7796 ZV
= XMARKER (oldzv
)->charpos
;
7797 ZV_BYTE
= marker_byte_position (oldzv
);
7801 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
7803 /* We can't do Fgoto_char (oldpoint) because it will run some
7805 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
7806 XMARKER (oldpoint
)->bytepos
);
7809 unchain_marker (XMARKER (oldpoint
));
7810 unchain_marker (XMARKER (oldbegv
));
7811 unchain_marker (XMARKER (oldzv
));
7813 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
7814 set_buffer_internal (oldbuf
);
7816 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
7817 message_log_need_newline
= !nlflag
;
7818 Vdeactivate_mark
= old_deactivate_mark
;
7823 /* We are at the end of the buffer after just having inserted a newline.
7824 (Note: We depend on the fact we won't be crossing the gap.)
7825 Check to see if the most recent message looks a lot like the previous one.
7826 Return 0 if different, 1 if the new one should just replace it, or a
7827 value N > 1 if we should also append " [N times]". */
7830 message_log_check_duplicate (prev_bol
, prev_bol_byte
, this_bol
, this_bol_byte
)
7831 int prev_bol
, this_bol
;
7832 int prev_bol_byte
, this_bol_byte
;
7835 int len
= Z_BYTE
- 1 - this_bol_byte
;
7837 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
7838 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
7840 for (i
= 0; i
< len
; i
++)
7842 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
7850 if (*p1
++ == ' ' && *p1
++ == '[')
7853 while (*p1
>= '0' && *p1
<= '9')
7854 n
= n
* 10 + *p1
++ - '0';
7855 if (strncmp (p1
, " times]\n", 8) == 0)
7862 /* Display an echo area message M with a specified length of NBYTES
7863 bytes. The string may include null characters. If M is 0, clear
7864 out any existing message, and let the mini-buffer text show
7867 This may GC, so the buffer M must NOT point to a Lisp string. */
7870 message2 (m
, nbytes
, multibyte
)
7875 /* First flush out any partial line written with print. */
7876 message_log_maybe_newline ();
7878 message_dolog (m
, nbytes
, 1, multibyte
);
7879 message2_nolog (m
, nbytes
, multibyte
);
7883 /* The non-logging counterpart of message2. */
7886 message2_nolog (m
, nbytes
, multibyte
)
7888 int nbytes
, multibyte
;
7890 struct frame
*sf
= SELECTED_FRAME ();
7891 message_enable_multibyte
= multibyte
;
7893 if (FRAME_INITIAL_P (sf
))
7895 if (noninteractive_need_newline
)
7896 putc ('\n', stderr
);
7897 noninteractive_need_newline
= 0;
7899 fwrite (m
, nbytes
, 1, stderr
);
7900 if (cursor_in_echo_area
== 0)
7901 fprintf (stderr
, "\n");
7904 /* A null message buffer means that the frame hasn't really been
7905 initialized yet. Error messages get reported properly by
7906 cmd_error, so this must be just an informative message; toss it. */
7907 else if (INTERACTIVE
7908 && sf
->glyphs_initialized_p
7909 && FRAME_MESSAGE_BUF (sf
))
7911 Lisp_Object mini_window
;
7914 /* Get the frame containing the mini-buffer
7915 that the selected frame is using. */
7916 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
7917 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
7919 FRAME_SAMPLE_VISIBILITY (f
);
7920 if (FRAME_VISIBLE_P (sf
)
7921 && ! FRAME_VISIBLE_P (f
))
7922 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
7926 set_message (m
, Qnil
, nbytes
, multibyte
);
7927 if (minibuffer_auto_raise
)
7928 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
7931 clear_message (1, 1);
7933 do_pending_window_change (0);
7934 echo_area_display (1);
7935 do_pending_window_change (0);
7936 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
7937 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
7942 /* Display an echo area message M with a specified length of NBYTES
7943 bytes. The string may include null characters. If M is not a
7944 string, clear out any existing message, and let the mini-buffer
7947 This function cancels echoing. */
7950 message3 (m
, nbytes
, multibyte
)
7955 struct gcpro gcpro1
;
7958 clear_message (1,1);
7961 /* First flush out any partial line written with print. */
7962 message_log_maybe_newline ();
7968 SAFE_ALLOCA (buffer
, char *, nbytes
);
7969 bcopy (SDATA (m
), buffer
, nbytes
);
7970 message_dolog (buffer
, nbytes
, 1, multibyte
);
7973 message3_nolog (m
, nbytes
, multibyte
);
7979 /* The non-logging version of message3.
7980 This does not cancel echoing, because it is used for echoing.
7981 Perhaps we need to make a separate function for echoing
7982 and make this cancel echoing. */
7985 message3_nolog (m
, nbytes
, multibyte
)
7987 int nbytes
, multibyte
;
7989 struct frame
*sf
= SELECTED_FRAME ();
7990 message_enable_multibyte
= multibyte
;
7992 if (FRAME_INITIAL_P (sf
))
7994 if (noninteractive_need_newline
)
7995 putc ('\n', stderr
);
7996 noninteractive_need_newline
= 0;
7998 fwrite (SDATA (m
), nbytes
, 1, stderr
);
7999 if (cursor_in_echo_area
== 0)
8000 fprintf (stderr
, "\n");
8003 /* A null message buffer means that the frame hasn't really been
8004 initialized yet. Error messages get reported properly by
8005 cmd_error, so this must be just an informative message; toss it. */
8006 else if (INTERACTIVE
8007 && sf
->glyphs_initialized_p
8008 && FRAME_MESSAGE_BUF (sf
))
8010 Lisp_Object mini_window
;
8014 /* Get the frame containing the mini-buffer
8015 that the selected frame is using. */
8016 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8017 frame
= XWINDOW (mini_window
)->frame
;
8020 FRAME_SAMPLE_VISIBILITY (f
);
8021 if (FRAME_VISIBLE_P (sf
)
8022 && !FRAME_VISIBLE_P (f
))
8023 Fmake_frame_visible (frame
);
8025 if (STRINGP (m
) && SCHARS (m
) > 0)
8027 set_message (NULL
, m
, nbytes
, multibyte
);
8028 if (minibuffer_auto_raise
)
8029 Fraise_frame (frame
);
8030 /* Assume we are not echoing.
8031 (If we are, echo_now will override this.) */
8032 echo_message_buffer
= Qnil
;
8035 clear_message (1, 1);
8037 do_pending_window_change (0);
8038 echo_area_display (1);
8039 do_pending_window_change (0);
8040 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8041 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8046 /* Display a null-terminated echo area message M. If M is 0, clear
8047 out any existing message, and let the mini-buffer text show through.
8049 The buffer M must continue to exist until after the echo area gets
8050 cleared or some other message gets displayed there. Do not pass
8051 text that is stored in a Lisp string. Do not pass text in a buffer
8052 that was alloca'd. */
8058 message2 (m
, (m
? strlen (m
) : 0), 0);
8062 /* The non-logging counterpart of message1. */
8068 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
8071 /* Display a message M which contains a single %s
8072 which gets replaced with STRING. */
8075 message_with_string (m
, string
, log
)
8080 CHECK_STRING (string
);
8086 if (noninteractive_need_newline
)
8087 putc ('\n', stderr
);
8088 noninteractive_need_newline
= 0;
8089 fprintf (stderr
, m
, SDATA (string
));
8090 if (!cursor_in_echo_area
)
8091 fprintf (stderr
, "\n");
8095 else if (INTERACTIVE
)
8097 /* The frame whose minibuffer we're going to display the message on.
8098 It may be larger than the selected frame, so we need
8099 to use its buffer, not the selected frame's buffer. */
8100 Lisp_Object mini_window
;
8101 struct frame
*f
, *sf
= SELECTED_FRAME ();
8103 /* Get the frame containing the minibuffer
8104 that the selected frame is using. */
8105 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8106 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8108 /* A null message buffer means that the frame hasn't really been
8109 initialized yet. Error messages get reported properly by
8110 cmd_error, so this must be just an informative message; toss it. */
8111 if (FRAME_MESSAGE_BUF (f
))
8113 Lisp_Object args
[2], message
;
8114 struct gcpro gcpro1
, gcpro2
;
8116 args
[0] = build_string (m
);
8117 args
[1] = message
= string
;
8118 GCPRO2 (args
[0], message
);
8121 message
= Fformat (2, args
);
8124 message3 (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
8126 message3_nolog (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
8130 /* Print should start at the beginning of the message
8131 buffer next time. */
8132 message_buf_print
= 0;
8138 /* Dump an informative message to the minibuf. If M is 0, clear out
8139 any existing message, and let the mini-buffer text show through. */
8143 message (m
, a1
, a2
, a3
)
8145 EMACS_INT a1
, a2
, a3
;
8151 if (noninteractive_need_newline
)
8152 putc ('\n', stderr
);
8153 noninteractive_need_newline
= 0;
8154 fprintf (stderr
, m
, a1
, a2
, a3
);
8155 if (cursor_in_echo_area
== 0)
8156 fprintf (stderr
, "\n");
8160 else if (INTERACTIVE
)
8162 /* The frame whose mini-buffer we're going to display the message
8163 on. It may be larger than the selected frame, so we need to
8164 use its buffer, not the selected frame's buffer. */
8165 Lisp_Object mini_window
;
8166 struct frame
*f
, *sf
= SELECTED_FRAME ();
8168 /* Get the frame containing the mini-buffer
8169 that the selected frame is using. */
8170 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8171 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8173 /* A null message buffer means that the frame hasn't really been
8174 initialized yet. Error messages get reported properly by
8175 cmd_error, so this must be just an informative message; toss
8177 if (FRAME_MESSAGE_BUF (f
))
8188 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8189 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3, a
);
8191 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8192 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3,
8194 #endif /* NO_ARG_ARRAY */
8196 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
8201 /* Print should start at the beginning of the message
8202 buffer next time. */
8203 message_buf_print
= 0;
8209 /* The non-logging version of message. */
8212 message_nolog (m
, a1
, a2
, a3
)
8214 EMACS_INT a1
, a2
, a3
;
8216 Lisp_Object old_log_max
;
8217 old_log_max
= Vmessage_log_max
;
8218 Vmessage_log_max
= Qnil
;
8219 message (m
, a1
, a2
, a3
);
8220 Vmessage_log_max
= old_log_max
;
8224 /* Display the current message in the current mini-buffer. This is
8225 only called from error handlers in process.c, and is not time
8231 if (!NILP (echo_area_buffer
[0]))
8234 string
= Fcurrent_message ();
8235 message3 (string
, SBYTES (string
),
8236 !NILP (current_buffer
->enable_multibyte_characters
));
8241 /* Make sure echo area buffers in `echo_buffers' are live.
8242 If they aren't, make new ones. */
8245 ensure_echo_area_buffers ()
8249 for (i
= 0; i
< 2; ++i
)
8250 if (!BUFFERP (echo_buffer
[i
])
8251 || NILP (XBUFFER (echo_buffer
[i
])->name
))
8254 Lisp_Object old_buffer
;
8257 old_buffer
= echo_buffer
[i
];
8258 sprintf (name
, " *Echo Area %d*", i
);
8259 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
8260 XBUFFER (echo_buffer
[i
])->truncate_lines
= Qnil
;
8261 /* to force word wrap in echo area -
8262 it was decided to postpone this*/
8263 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
8265 for (j
= 0; j
< 2; ++j
)
8266 if (EQ (old_buffer
, echo_area_buffer
[j
]))
8267 echo_area_buffer
[j
] = echo_buffer
[i
];
8272 /* Call FN with args A1..A4 with either the current or last displayed
8273 echo_area_buffer as current buffer.
8275 WHICH zero means use the current message buffer
8276 echo_area_buffer[0]. If that is nil, choose a suitable buffer
8277 from echo_buffer[] and clear it.
8279 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
8280 suitable buffer from echo_buffer[] and clear it.
8282 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
8283 that the current message becomes the last displayed one, make
8284 choose a suitable buffer for echo_area_buffer[0], and clear it.
8286 Value is what FN returns. */
8289 with_echo_area_buffer (w
, which
, fn
, a1
, a2
, a3
, a4
)
8292 int (*fn
) P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
8298 int this_one
, the_other
, clear_buffer_p
, rc
;
8299 int count
= SPECPDL_INDEX ();
8301 /* If buffers aren't live, make new ones. */
8302 ensure_echo_area_buffers ();
8307 this_one
= 0, the_other
= 1;
8309 this_one
= 1, the_other
= 0;
8312 this_one
= 0, the_other
= 1;
8315 /* We need a fresh one in case the current echo buffer equals
8316 the one containing the last displayed echo area message. */
8317 if (!NILP (echo_area_buffer
[this_one
])
8318 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
8319 echo_area_buffer
[this_one
] = Qnil
;
8322 /* Choose a suitable buffer from echo_buffer[] is we don't
8324 if (NILP (echo_area_buffer
[this_one
]))
8326 echo_area_buffer
[this_one
]
8327 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
8328 ? echo_buffer
[the_other
]
8329 : echo_buffer
[this_one
]);
8333 buffer
= echo_area_buffer
[this_one
];
8335 /* Don't get confused by reusing the buffer used for echoing
8336 for a different purpose. */
8337 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
8340 record_unwind_protect (unwind_with_echo_area_buffer
,
8341 with_echo_area_buffer_unwind_data (w
));
8343 /* Make the echo area buffer current. Note that for display
8344 purposes, it is not necessary that the displayed window's buffer
8345 == current_buffer, except for text property lookup. So, let's
8346 only set that buffer temporarily here without doing a full
8347 Fset_window_buffer. We must also change w->pointm, though,
8348 because otherwise an assertions in unshow_buffer fails, and Emacs
8350 set_buffer_internal_1 (XBUFFER (buffer
));
8354 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
8357 current_buffer
->undo_list
= Qt
;
8358 current_buffer
->read_only
= Qnil
;
8359 specbind (Qinhibit_read_only
, Qt
);
8360 specbind (Qinhibit_modification_hooks
, Qt
);
8362 if (clear_buffer_p
&& Z
> BEG
)
8365 xassert (BEGV
>= BEG
);
8366 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8368 rc
= fn (a1
, a2
, a3
, a4
);
8370 xassert (BEGV
>= BEG
);
8371 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8373 unbind_to (count
, Qnil
);
8378 /* Save state that should be preserved around the call to the function
8379 FN called in with_echo_area_buffer. */
8382 with_echo_area_buffer_unwind_data (w
)
8386 Lisp_Object vector
, tmp
;
8388 /* Reduce consing by keeping one vector in
8389 Vwith_echo_area_save_vector. */
8390 vector
= Vwith_echo_area_save_vector
;
8391 Vwith_echo_area_save_vector
= Qnil
;
8394 vector
= Fmake_vector (make_number (7), Qnil
);
8396 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
8397 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
8398 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
8402 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
8403 ASET (vector
, i
, w
->buffer
); ++i
;
8404 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
8405 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
8410 for (; i
< end
; ++i
)
8411 ASET (vector
, i
, Qnil
);
8414 xassert (i
== ASIZE (vector
));
8419 /* Restore global state from VECTOR which was created by
8420 with_echo_area_buffer_unwind_data. */
8423 unwind_with_echo_area_buffer (vector
)
8426 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
8427 Vdeactivate_mark
= AREF (vector
, 1);
8428 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
8430 if (WINDOWP (AREF (vector
, 3)))
8433 Lisp_Object buffer
, charpos
, bytepos
;
8435 w
= XWINDOW (AREF (vector
, 3));
8436 buffer
= AREF (vector
, 4);
8437 charpos
= AREF (vector
, 5);
8438 bytepos
= AREF (vector
, 6);
8441 set_marker_both (w
->pointm
, buffer
,
8442 XFASTINT (charpos
), XFASTINT (bytepos
));
8445 Vwith_echo_area_save_vector
= vector
;
8450 /* Set up the echo area for use by print functions. MULTIBYTE_P
8451 non-zero means we will print multibyte. */
8454 setup_echo_area_for_printing (multibyte_p
)
8457 /* If we can't find an echo area any more, exit. */
8458 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8461 ensure_echo_area_buffers ();
8463 if (!message_buf_print
)
8465 /* A message has been output since the last time we printed.
8466 Choose a fresh echo area buffer. */
8467 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8468 echo_area_buffer
[0] = echo_buffer
[1];
8470 echo_area_buffer
[0] = echo_buffer
[0];
8472 /* Switch to that buffer and clear it. */
8473 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8474 current_buffer
->truncate_lines
= Qnil
;
8478 int count
= SPECPDL_INDEX ();
8479 specbind (Qinhibit_read_only
, Qt
);
8480 /* Note that undo recording is always disabled. */
8482 unbind_to (count
, Qnil
);
8484 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8486 /* Set up the buffer for the multibyteness we need. */
8488 != !NILP (current_buffer
->enable_multibyte_characters
))
8489 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
8491 /* Raise the frame containing the echo area. */
8492 if (minibuffer_auto_raise
)
8494 struct frame
*sf
= SELECTED_FRAME ();
8495 Lisp_Object mini_window
;
8496 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8497 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8500 message_log_maybe_newline ();
8501 message_buf_print
= 1;
8505 if (NILP (echo_area_buffer
[0]))
8507 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8508 echo_area_buffer
[0] = echo_buffer
[1];
8510 echo_area_buffer
[0] = echo_buffer
[0];
8513 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
8515 /* Someone switched buffers between print requests. */
8516 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8517 current_buffer
->truncate_lines
= Qnil
;
8523 /* Display an echo area message in window W. Value is non-zero if W's
8524 height is changed. If display_last_displayed_message_p is
8525 non-zero, display the message that was last displayed, otherwise
8526 display the current message. */
8529 display_echo_area (w
)
8532 int i
, no_message_p
, window_height_changed_p
, count
;
8534 /* Temporarily disable garbage collections while displaying the echo
8535 area. This is done because a GC can print a message itself.
8536 That message would modify the echo area buffer's contents while a
8537 redisplay of the buffer is going on, and seriously confuse
8539 count
= inhibit_garbage_collection ();
8541 /* If there is no message, we must call display_echo_area_1
8542 nevertheless because it resizes the window. But we will have to
8543 reset the echo_area_buffer in question to nil at the end because
8544 with_echo_area_buffer will sets it to an empty buffer. */
8545 i
= display_last_displayed_message_p
? 1 : 0;
8546 no_message_p
= NILP (echo_area_buffer
[i
]);
8548 window_height_changed_p
8549 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
8550 display_echo_area_1
,
8551 (EMACS_INT
) w
, Qnil
, 0, 0);
8554 echo_area_buffer
[i
] = Qnil
;
8556 unbind_to (count
, Qnil
);
8557 return window_height_changed_p
;
8561 /* Helper for display_echo_area. Display the current buffer which
8562 contains the current echo area message in window W, a mini-window,
8563 a pointer to which is passed in A1. A2..A4 are currently not used.
8564 Change the height of W so that all of the message is displayed.
8565 Value is non-zero if height of W was changed. */
8568 display_echo_area_1 (a1
, a2
, a3
, a4
)
8573 struct window
*w
= (struct window
*) a1
;
8575 struct text_pos start
;
8576 int window_height_changed_p
= 0;
8578 /* Do this before displaying, so that we have a large enough glyph
8579 matrix for the display. If we can't get enough space for the
8580 whole text, display the last N lines. That works by setting w->start. */
8581 window_height_changed_p
= resize_mini_window (w
, 0);
8583 /* Use the starting position chosen by resize_mini_window. */
8584 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
8587 clear_glyph_matrix (w
->desired_matrix
);
8588 XSETWINDOW (window
, w
);
8589 try_window (window
, start
, 0);
8591 return window_height_changed_p
;
8595 /* Resize the echo area window to exactly the size needed for the
8596 currently displayed message, if there is one. If a mini-buffer
8597 is active, don't shrink it. */
8600 resize_echo_area_exactly ()
8602 if (BUFFERP (echo_area_buffer
[0])
8603 && WINDOWP (echo_area_window
))
8605 struct window
*w
= XWINDOW (echo_area_window
);
8607 Lisp_Object resize_exactly
;
8609 if (minibuf_level
== 0)
8610 resize_exactly
= Qt
;
8612 resize_exactly
= Qnil
;
8614 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
8615 (EMACS_INT
) w
, resize_exactly
, 0, 0);
8618 ++windows_or_buffers_changed
;
8619 ++update_mode_lines
;
8620 redisplay_internal (0);
8626 /* Callback function for with_echo_area_buffer, when used from
8627 resize_echo_area_exactly. A1 contains a pointer to the window to
8628 resize, EXACTLY non-nil means resize the mini-window exactly to the
8629 size of the text displayed. A3 and A4 are not used. Value is what
8630 resize_mini_window returns. */
8633 resize_mini_window_1 (a1
, exactly
, a3
, a4
)
8635 Lisp_Object exactly
;
8638 return resize_mini_window ((struct window
*) a1
, !NILP (exactly
));
8642 /* Resize mini-window W to fit the size of its contents. EXACT_P
8643 means size the window exactly to the size needed. Otherwise, it's
8644 only enlarged until W's buffer is empty.
8646 Set W->start to the right place to begin display. If the whole
8647 contents fit, start at the beginning. Otherwise, start so as
8648 to make the end of the contents appear. This is particularly
8649 important for y-or-n-p, but seems desirable generally.
8651 Value is non-zero if the window height has been changed. */
8654 resize_mini_window (w
, exact_p
)
8658 struct frame
*f
= XFRAME (w
->frame
);
8659 int window_height_changed_p
= 0;
8661 xassert (MINI_WINDOW_P (w
));
8663 /* By default, start display at the beginning. */
8664 set_marker_both (w
->start
, w
->buffer
,
8665 BUF_BEGV (XBUFFER (w
->buffer
)),
8666 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
8668 /* Don't resize windows while redisplaying a window; it would
8669 confuse redisplay functions when the size of the window they are
8670 displaying changes from under them. Such a resizing can happen,
8671 for instance, when which-func prints a long message while
8672 we are running fontification-functions. We're running these
8673 functions with safe_call which binds inhibit-redisplay to t. */
8674 if (!NILP (Vinhibit_redisplay
))
8677 /* Nil means don't try to resize. */
8678 if (NILP (Vresize_mini_windows
)
8679 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
8682 if (!FRAME_MINIBUF_ONLY_P (f
))
8685 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
8686 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
8687 int height
, max_height
;
8688 int unit
= FRAME_LINE_HEIGHT (f
);
8689 struct text_pos start
;
8690 struct buffer
*old_current_buffer
= NULL
;
8692 if (current_buffer
!= XBUFFER (w
->buffer
))
8694 old_current_buffer
= current_buffer
;
8695 set_buffer_internal (XBUFFER (w
->buffer
));
8698 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8700 /* Compute the max. number of lines specified by the user. */
8701 if (FLOATP (Vmax_mini_window_height
))
8702 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
8703 else if (INTEGERP (Vmax_mini_window_height
))
8704 max_height
= XINT (Vmax_mini_window_height
);
8706 max_height
= total_height
/ 4;
8708 /* Correct that max. height if it's bogus. */
8709 max_height
= max (1, max_height
);
8710 max_height
= min (total_height
, max_height
);
8712 /* Find out the height of the text in the window. */
8713 if (it
.line_wrap
== TRUNCATE
)
8718 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
8719 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
8720 height
= it
.current_y
+ last_height
;
8722 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
8723 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
8724 height
= (height
+ unit
- 1) / unit
;
8727 /* Compute a suitable window start. */
8728 if (height
> max_height
)
8730 height
= max_height
;
8731 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8732 move_it_vertically_backward (&it
, (height
- 1) * unit
);
8733 start
= it
.current
.pos
;
8736 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
8737 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
8739 if (EQ (Vresize_mini_windows
, Qgrow_only
))
8741 /* Let it grow only, until we display an empty message, in which
8742 case the window shrinks again. */
8743 if (height
> WINDOW_TOTAL_LINES (w
))
8745 int old_height
= WINDOW_TOTAL_LINES (w
);
8746 freeze_window_starts (f
, 1);
8747 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8748 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8750 else if (height
< WINDOW_TOTAL_LINES (w
)
8751 && (exact_p
|| BEGV
== ZV
))
8753 int old_height
= WINDOW_TOTAL_LINES (w
);
8754 freeze_window_starts (f
, 0);
8755 shrink_mini_window (w
);
8756 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8761 /* Always resize to exact size needed. */
8762 if (height
> WINDOW_TOTAL_LINES (w
))
8764 int old_height
= WINDOW_TOTAL_LINES (w
);
8765 freeze_window_starts (f
, 1);
8766 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8767 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8769 else if (height
< WINDOW_TOTAL_LINES (w
))
8771 int old_height
= WINDOW_TOTAL_LINES (w
);
8772 freeze_window_starts (f
, 0);
8773 shrink_mini_window (w
);
8777 freeze_window_starts (f
, 1);
8778 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8781 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8785 if (old_current_buffer
)
8786 set_buffer_internal (old_current_buffer
);
8789 return window_height_changed_p
;
8793 /* Value is the current message, a string, or nil if there is no
8801 if (!BUFFERP (echo_area_buffer
[0]))
8805 with_echo_area_buffer (0, 0, current_message_1
,
8806 (EMACS_INT
) &msg
, Qnil
, 0, 0);
8808 echo_area_buffer
[0] = Qnil
;
8816 current_message_1 (a1
, a2
, a3
, a4
)
8821 Lisp_Object
*msg
= (Lisp_Object
*) a1
;
8824 *msg
= make_buffer_string (BEG
, Z
, 1);
8831 /* Push the current message on Vmessage_stack for later restauration
8832 by restore_message. Value is non-zero if the current message isn't
8833 empty. This is a relatively infrequent operation, so it's not
8834 worth optimizing. */
8840 msg
= current_message ();
8841 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
8842 return STRINGP (msg
);
8846 /* Restore message display from the top of Vmessage_stack. */
8853 xassert (CONSP (Vmessage_stack
));
8854 msg
= XCAR (Vmessage_stack
);
8856 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
8858 message3_nolog (msg
, 0, 0);
8862 /* Handler for record_unwind_protect calling pop_message. */
8865 pop_message_unwind (dummy
)
8872 /* Pop the top-most entry off Vmessage_stack. */
8877 xassert (CONSP (Vmessage_stack
));
8878 Vmessage_stack
= XCDR (Vmessage_stack
);
8882 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
8883 exits. If the stack is not empty, we have a missing pop_message
8887 check_message_stack ()
8889 if (!NILP (Vmessage_stack
))
8894 /* Truncate to NCHARS what will be displayed in the echo area the next
8895 time we display it---but don't redisplay it now. */
8898 truncate_echo_area (nchars
)
8902 echo_area_buffer
[0] = Qnil
;
8903 /* A null message buffer means that the frame hasn't really been
8904 initialized yet. Error messages get reported properly by
8905 cmd_error, so this must be just an informative message; toss it. */
8906 else if (!noninteractive
8908 && !NILP (echo_area_buffer
[0]))
8910 struct frame
*sf
= SELECTED_FRAME ();
8911 if (FRAME_MESSAGE_BUF (sf
))
8912 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
8917 /* Helper function for truncate_echo_area. Truncate the current
8918 message to at most NCHARS characters. */
8921 truncate_message_1 (nchars
, a2
, a3
, a4
)
8926 if (BEG
+ nchars
< Z
)
8927 del_range (BEG
+ nchars
, Z
);
8929 echo_area_buffer
[0] = Qnil
;
8934 /* Set the current message to a substring of S or STRING.
8936 If STRING is a Lisp string, set the message to the first NBYTES
8937 bytes from STRING. NBYTES zero means use the whole string. If
8938 STRING is multibyte, the message will be displayed multibyte.
8940 If S is not null, set the message to the first LEN bytes of S. LEN
8941 zero means use the whole string. MULTIBYTE_P non-zero means S is
8942 multibyte. Display the message multibyte in that case.
8944 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
8945 to t before calling set_message_1 (which calls insert).
8949 set_message (s
, string
, nbytes
, multibyte_p
)
8952 int nbytes
, multibyte_p
;
8954 message_enable_multibyte
8955 = ((s
&& multibyte_p
)
8956 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
8958 with_echo_area_buffer (0, -1, set_message_1
,
8959 (EMACS_INT
) s
, string
, nbytes
, multibyte_p
);
8960 message_buf_print
= 0;
8961 help_echo_showing_p
= 0;
8965 /* Helper function for set_message. Arguments have the same meaning
8966 as there, with A1 corresponding to S and A2 corresponding to STRING
8967 This function is called with the echo area buffer being
8971 set_message_1 (a1
, a2
, nbytes
, multibyte_p
)
8974 EMACS_INT nbytes
, multibyte_p
;
8976 const char *s
= (const char *) a1
;
8977 Lisp_Object string
= a2
;
8979 /* Change multibyteness of the echo buffer appropriately. */
8980 if (message_enable_multibyte
8981 != !NILP (current_buffer
->enable_multibyte_characters
))
8982 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
8984 current_buffer
->truncate_lines
= message_truncate_lines
? Qt
: Qnil
;
8986 /* Insert new message at BEG. */
8987 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8989 if (STRINGP (string
))
8994 nbytes
= SBYTES (string
);
8995 nchars
= string_byte_to_char (string
, nbytes
);
8997 /* This function takes care of single/multibyte conversion. We
8998 just have to ensure that the echo area buffer has the right
8999 setting of enable_multibyte_characters. */
9000 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
9005 nbytes
= strlen (s
);
9007 if (multibyte_p
&& NILP (current_buffer
->enable_multibyte_characters
))
9009 /* Convert from multi-byte to single-byte. */
9011 unsigned char work
[1];
9013 /* Convert a multibyte string to single-byte. */
9014 for (i
= 0; i
< nbytes
; i
+= n
)
9016 c
= string_char_and_length (s
+ i
, &n
);
9017 work
[0] = (ASCII_CHAR_P (c
)
9019 : multibyte_char_to_unibyte (c
, Qnil
));
9020 insert_1_both (work
, 1, 1, 1, 0, 0);
9023 else if (!multibyte_p
9024 && !NILP (current_buffer
->enable_multibyte_characters
))
9026 /* Convert from single-byte to multi-byte. */
9028 const unsigned char *msg
= (const unsigned char *) s
;
9029 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9031 /* Convert a single-byte string to multibyte. */
9032 for (i
= 0; i
< nbytes
; i
++)
9035 MAKE_CHAR_MULTIBYTE (c
);
9036 n
= CHAR_STRING (c
, str
);
9037 insert_1_both (str
, 1, n
, 1, 0, 0);
9041 insert_1 (s
, nbytes
, 1, 0, 0);
9048 /* Clear messages. CURRENT_P non-zero means clear the current
9049 message. LAST_DISPLAYED_P non-zero means clear the message
9053 clear_message (current_p
, last_displayed_p
)
9054 int current_p
, last_displayed_p
;
9058 echo_area_buffer
[0] = Qnil
;
9059 message_cleared_p
= 1;
9062 if (last_displayed_p
)
9063 echo_area_buffer
[1] = Qnil
;
9065 message_buf_print
= 0;
9068 /* Clear garbaged frames.
9070 This function is used where the old redisplay called
9071 redraw_garbaged_frames which in turn called redraw_frame which in
9072 turn called clear_frame. The call to clear_frame was a source of
9073 flickering. I believe a clear_frame is not necessary. It should
9074 suffice in the new redisplay to invalidate all current matrices,
9075 and ensure a complete redisplay of all windows. */
9078 clear_garbaged_frames ()
9082 Lisp_Object tail
, frame
;
9083 int changed_count
= 0;
9085 FOR_EACH_FRAME (tail
, frame
)
9087 struct frame
*f
= XFRAME (frame
);
9089 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
9093 Fredraw_frame (frame
);
9094 f
->force_flush_display_p
= 1;
9096 clear_current_matrices (f
);
9105 ++windows_or_buffers_changed
;
9110 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
9111 is non-zero update selected_frame. Value is non-zero if the
9112 mini-windows height has been changed. */
9115 echo_area_display (update_frame_p
)
9118 Lisp_Object mini_window
;
9121 int window_height_changed_p
= 0;
9122 struct frame
*sf
= SELECTED_FRAME ();
9124 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9125 w
= XWINDOW (mini_window
);
9126 f
= XFRAME (WINDOW_FRAME (w
));
9128 /* Don't display if frame is invisible or not yet initialized. */
9129 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
9132 #ifdef HAVE_WINDOW_SYSTEM
9133 /* When Emacs starts, selected_frame may be the initial terminal
9134 frame. If we let this through, a message would be displayed on
9136 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
9138 #endif /* HAVE_WINDOW_SYSTEM */
9140 /* Redraw garbaged frames. */
9142 clear_garbaged_frames ();
9144 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
9146 echo_area_window
= mini_window
;
9147 window_height_changed_p
= display_echo_area (w
);
9148 w
->must_be_updated_p
= 1;
9150 /* Update the display, unless called from redisplay_internal.
9151 Also don't update the screen during redisplay itself. The
9152 update will happen at the end of redisplay, and an update
9153 here could cause confusion. */
9154 if (update_frame_p
&& !redisplaying_p
)
9158 /* If the display update has been interrupted by pending
9159 input, update mode lines in the frame. Due to the
9160 pending input, it might have been that redisplay hasn't
9161 been called, so that mode lines above the echo area are
9162 garbaged. This looks odd, so we prevent it here. */
9163 if (!display_completed
)
9164 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
9166 if (window_height_changed_p
9167 /* Don't do this if Emacs is shutting down. Redisplay
9168 needs to run hooks. */
9169 && !NILP (Vrun_hooks
))
9171 /* Must update other windows. Likewise as in other
9172 cases, don't let this update be interrupted by
9174 int count
= SPECPDL_INDEX ();
9175 specbind (Qredisplay_dont_pause
, Qt
);
9176 windows_or_buffers_changed
= 1;
9177 redisplay_internal (0);
9178 unbind_to (count
, Qnil
);
9180 else if (FRAME_WINDOW_P (f
) && n
== 0)
9182 /* Window configuration is the same as before.
9183 Can do with a display update of the echo area,
9184 unless we displayed some mode lines. */
9185 update_single_window (w
, 1);
9186 FRAME_RIF (f
)->flush_display (f
);
9189 update_frame (f
, 1, 1);
9191 /* If cursor is in the echo area, make sure that the next
9192 redisplay displays the minibuffer, so that the cursor will
9193 be replaced with what the minibuffer wants. */
9194 if (cursor_in_echo_area
)
9195 ++windows_or_buffers_changed
;
9198 else if (!EQ (mini_window
, selected_window
))
9199 windows_or_buffers_changed
++;
9201 /* Last displayed message is now the current message. */
9202 echo_area_buffer
[1] = echo_area_buffer
[0];
9203 /* Inform read_char that we're not echoing. */
9204 echo_message_buffer
= Qnil
;
9206 /* Prevent redisplay optimization in redisplay_internal by resetting
9207 this_line_start_pos. This is done because the mini-buffer now
9208 displays the message instead of its buffer text. */
9209 if (EQ (mini_window
, selected_window
))
9210 CHARPOS (this_line_start_pos
) = 0;
9212 return window_height_changed_p
;
9217 /***********************************************************************
9218 Mode Lines and Frame Titles
9219 ***********************************************************************/
9221 /* A buffer for constructing non-propertized mode-line strings and
9222 frame titles in it; allocated from the heap in init_xdisp and
9223 resized as needed in store_mode_line_noprop_char. */
9225 static char *mode_line_noprop_buf
;
9227 /* The buffer's end, and a current output position in it. */
9229 static char *mode_line_noprop_buf_end
;
9230 static char *mode_line_noprop_ptr
;
9232 #define MODE_LINE_NOPROP_LEN(start) \
9233 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
9236 MODE_LINE_DISPLAY
= 0,
9242 /* Alist that caches the results of :propertize.
9243 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
9244 static Lisp_Object mode_line_proptrans_alist
;
9246 /* List of strings making up the mode-line. */
9247 static Lisp_Object mode_line_string_list
;
9249 /* Base face property when building propertized mode line string. */
9250 static Lisp_Object mode_line_string_face
;
9251 static Lisp_Object mode_line_string_face_prop
;
9254 /* Unwind data for mode line strings */
9256 static Lisp_Object Vmode_line_unwind_vector
;
9259 format_mode_line_unwind_data (struct buffer
*obuf
,
9263 Lisp_Object vector
, tmp
;
9265 /* Reduce consing by keeping one vector in
9266 Vwith_echo_area_save_vector. */
9267 vector
= Vmode_line_unwind_vector
;
9268 Vmode_line_unwind_vector
= Qnil
;
9271 vector
= Fmake_vector (make_number (8), Qnil
);
9273 ASET (vector
, 0, make_number (mode_line_target
));
9274 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
9275 ASET (vector
, 2, mode_line_string_list
);
9276 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
9277 ASET (vector
, 4, mode_line_string_face
);
9278 ASET (vector
, 5, mode_line_string_face_prop
);
9281 XSETBUFFER (tmp
, obuf
);
9284 ASET (vector
, 6, tmp
);
9285 ASET (vector
, 7, owin
);
9291 unwind_format_mode_line (vector
)
9294 mode_line_target
= XINT (AREF (vector
, 0));
9295 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
9296 mode_line_string_list
= AREF (vector
, 2);
9297 if (! EQ (AREF (vector
, 3), Qt
))
9298 mode_line_proptrans_alist
= AREF (vector
, 3);
9299 mode_line_string_face
= AREF (vector
, 4);
9300 mode_line_string_face_prop
= AREF (vector
, 5);
9302 if (!NILP (AREF (vector
, 7)))
9303 /* Select window before buffer, since it may change the buffer. */
9304 Fselect_window (AREF (vector
, 7), Qt
);
9306 if (!NILP (AREF (vector
, 6)))
9308 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
9309 ASET (vector
, 6, Qnil
);
9312 Vmode_line_unwind_vector
= vector
;
9317 /* Store a single character C for the frame title in mode_line_noprop_buf.
9318 Re-allocate mode_line_noprop_buf if necessary. */
9322 store_mode_line_noprop_char (char c
)
9324 store_mode_line_noprop_char (c
)
9328 /* If output position has reached the end of the allocated buffer,
9329 double the buffer's size. */
9330 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
9332 int len
= MODE_LINE_NOPROP_LEN (0);
9333 int new_size
= 2 * len
* sizeof *mode_line_noprop_buf
;
9334 mode_line_noprop_buf
= (char *) xrealloc (mode_line_noprop_buf
, new_size
);
9335 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ new_size
;
9336 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
9339 *mode_line_noprop_ptr
++ = c
;
9343 /* Store part of a frame title in mode_line_noprop_buf, beginning at
9344 mode_line_noprop_ptr. STR is the string to store. Do not copy
9345 characters that yield more columns than PRECISION; PRECISION <= 0
9346 means copy the whole string. Pad with spaces until FIELD_WIDTH
9347 number of characters have been copied; FIELD_WIDTH <= 0 means don't
9348 pad. Called from display_mode_element when it is used to build a
9352 store_mode_line_noprop (str
, field_width
, precision
)
9353 const unsigned char *str
;
9354 int field_width
, precision
;
9359 /* Copy at most PRECISION chars from STR. */
9360 nbytes
= strlen (str
);
9361 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
9363 store_mode_line_noprop_char (*str
++);
9365 /* Fill up with spaces until FIELD_WIDTH reached. */
9366 while (field_width
> 0
9369 store_mode_line_noprop_char (' ');
9376 /***********************************************************************
9378 ***********************************************************************/
9380 #ifdef HAVE_WINDOW_SYSTEM
9382 /* Set the title of FRAME, if it has changed. The title format is
9383 Vicon_title_format if FRAME is iconified, otherwise it is
9384 frame_title_format. */
9387 x_consider_frame_title (frame
)
9390 struct frame
*f
= XFRAME (frame
);
9392 if (FRAME_WINDOW_P (f
)
9393 || FRAME_MINIBUF_ONLY_P (f
)
9394 || f
->explicit_name
)
9396 /* Do we have more than one visible frame on this X display? */
9403 int count
= SPECPDL_INDEX ();
9405 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
9407 Lisp_Object other_frame
= XCAR (tail
);
9408 struct frame
*tf
= XFRAME (other_frame
);
9411 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
9412 && !FRAME_MINIBUF_ONLY_P (tf
)
9413 && !EQ (other_frame
, tip_frame
)
9414 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
9418 /* Set global variable indicating that multiple frames exist. */
9419 multiple_frames
= CONSP (tail
);
9421 /* Switch to the buffer of selected window of the frame. Set up
9422 mode_line_target so that display_mode_element will output into
9423 mode_line_noprop_buf; then display the title. */
9424 record_unwind_protect (unwind_format_mode_line
,
9425 format_mode_line_unwind_data
9426 (current_buffer
, selected_window
, 0));
9428 Fselect_window (f
->selected_window
, Qt
);
9429 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
9430 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
9432 mode_line_target
= MODE_LINE_TITLE
;
9433 title_start
= MODE_LINE_NOPROP_LEN (0);
9434 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
9435 NULL
, DEFAULT_FACE_ID
);
9436 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
9437 len
= MODE_LINE_NOPROP_LEN (title_start
);
9438 title
= mode_line_noprop_buf
+ title_start
;
9439 unbind_to (count
, Qnil
);
9441 /* Set the title only if it's changed. This avoids consing in
9442 the common case where it hasn't. (If it turns out that we've
9443 already wasted too much time by walking through the list with
9444 display_mode_element, then we might need to optimize at a
9445 higher level than this.) */
9446 if (! STRINGP (f
->name
)
9447 || SBYTES (f
->name
) != len
9448 || bcmp (title
, SDATA (f
->name
), len
) != 0)
9449 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
9453 #endif /* not HAVE_WINDOW_SYSTEM */
9458 /***********************************************************************
9460 ***********************************************************************/
9463 /* Prepare for redisplay by updating menu-bar item lists when
9464 appropriate. This can call eval. */
9467 prepare_menu_bars ()
9470 struct gcpro gcpro1
, gcpro2
;
9472 Lisp_Object tooltip_frame
;
9474 #ifdef HAVE_WINDOW_SYSTEM
9475 tooltip_frame
= tip_frame
;
9477 tooltip_frame
= Qnil
;
9480 /* Update all frame titles based on their buffer names, etc. We do
9481 this before the menu bars so that the buffer-menu will show the
9482 up-to-date frame titles. */
9483 #ifdef HAVE_WINDOW_SYSTEM
9484 if (windows_or_buffers_changed
|| update_mode_lines
)
9486 Lisp_Object tail
, frame
;
9488 FOR_EACH_FRAME (tail
, frame
)
9491 if (!EQ (frame
, tooltip_frame
)
9492 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
9493 x_consider_frame_title (frame
);
9496 #endif /* HAVE_WINDOW_SYSTEM */
9498 /* Update the menu bar item lists, if appropriate. This has to be
9499 done before any actual redisplay or generation of display lines. */
9500 all_windows
= (update_mode_lines
9501 || buffer_shared
> 1
9502 || windows_or_buffers_changed
);
9505 Lisp_Object tail
, frame
;
9506 int count
= SPECPDL_INDEX ();
9507 /* 1 means that update_menu_bar has run its hooks
9508 so any further calls to update_menu_bar shouldn't do so again. */
9509 int menu_bar_hooks_run
= 0;
9511 record_unwind_save_match_data ();
9513 FOR_EACH_FRAME (tail
, frame
)
9517 /* Ignore tooltip frame. */
9518 if (EQ (frame
, tooltip_frame
))
9521 /* If a window on this frame changed size, report that to
9522 the user and clear the size-change flag. */
9523 if (FRAME_WINDOW_SIZES_CHANGED (f
))
9525 Lisp_Object functions
;
9527 /* Clear flag first in case we get an error below. */
9528 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
9529 functions
= Vwindow_size_change_functions
;
9530 GCPRO2 (tail
, functions
);
9532 while (CONSP (functions
))
9534 if (!EQ (XCAR (functions
), Qt
))
9535 call1 (XCAR (functions
), frame
);
9536 functions
= XCDR (functions
);
9542 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
9543 #ifdef HAVE_WINDOW_SYSTEM
9544 update_tool_bar (f
, 0);
9547 if (windows_or_buffers_changed
9549 ns_set_doc_edited (f
, Fbuffer_modified_p
9550 (XWINDOW (f
->selected_window
)->buffer
));
9555 unbind_to (count
, Qnil
);
9559 struct frame
*sf
= SELECTED_FRAME ();
9560 update_menu_bar (sf
, 1, 0);
9561 #ifdef HAVE_WINDOW_SYSTEM
9562 update_tool_bar (sf
, 1);
9566 /* Motif needs this. See comment in xmenu.c. Turn it off when
9567 pending_menu_activation is not defined. */
9568 #ifdef USE_X_TOOLKIT
9569 pending_menu_activation
= 0;
9574 /* Update the menu bar item list for frame F. This has to be done
9575 before we start to fill in any display lines, because it can call
9578 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
9580 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
9581 already ran the menu bar hooks for this redisplay, so there
9582 is no need to run them again. The return value is the
9583 updated value of this flag, to pass to the next call. */
9586 update_menu_bar (f
, save_match_data
, hooks_run
)
9588 int save_match_data
;
9592 register struct window
*w
;
9594 /* If called recursively during a menu update, do nothing. This can
9595 happen when, for instance, an activate-menubar-hook causes a
9597 if (inhibit_menubar_update
)
9600 window
= FRAME_SELECTED_WINDOW (f
);
9601 w
= XWINDOW (window
);
9603 if (FRAME_WINDOW_P (f
)
9605 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9606 || defined (HAVE_NS) || defined (USE_GTK)
9607 FRAME_EXTERNAL_MENU_BAR (f
)
9609 FRAME_MENU_BAR_LINES (f
) > 0
9611 : FRAME_MENU_BAR_LINES (f
) > 0)
9613 /* If the user has switched buffers or windows, we need to
9614 recompute to reflect the new bindings. But we'll
9615 recompute when update_mode_lines is set too; that means
9616 that people can use force-mode-line-update to request
9617 that the menu bar be recomputed. The adverse effect on
9618 the rest of the redisplay algorithm is about the same as
9619 windows_or_buffers_changed anyway. */
9620 if (windows_or_buffers_changed
9621 /* This used to test w->update_mode_line, but we believe
9622 there is no need to recompute the menu in that case. */
9623 || update_mode_lines
9624 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9625 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9626 != !NILP (w
->last_had_star
))
9627 || ((!NILP (Vtransient_mark_mode
)
9628 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
9629 != !NILP (w
->region_showing
)))
9631 struct buffer
*prev
= current_buffer
;
9632 int count
= SPECPDL_INDEX ();
9634 specbind (Qinhibit_menubar_update
, Qt
);
9636 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9637 if (save_match_data
)
9638 record_unwind_save_match_data ();
9639 if (NILP (Voverriding_local_map_menu_flag
))
9641 specbind (Qoverriding_terminal_local_map
, Qnil
);
9642 specbind (Qoverriding_local_map
, Qnil
);
9647 /* Run the Lucid hook. */
9648 safe_run_hooks (Qactivate_menubar_hook
);
9650 /* If it has changed current-menubar from previous value,
9651 really recompute the menu-bar from the value. */
9652 if (! NILP (Vlucid_menu_bar_dirty_flag
))
9653 call0 (Qrecompute_lucid_menubar
);
9655 safe_run_hooks (Qmenu_bar_update_hook
);
9660 XSETFRAME (Vmenu_updating_frame
, f
);
9661 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
9663 /* Redisplay the menu bar in case we changed it. */
9664 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9665 || defined (HAVE_NS) || defined (USE_GTK)
9666 if (FRAME_WINDOW_P (f
))
9668 #if defined (HAVE_NS)
9669 /* All frames on Mac OS share the same menubar. So only
9670 the selected frame should be allowed to set it. */
9671 if (f
== SELECTED_FRAME ())
9673 set_frame_menubar (f
, 0, 0);
9676 /* On a terminal screen, the menu bar is an ordinary screen
9677 line, and this makes it get updated. */
9678 w
->update_mode_line
= Qt
;
9679 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9680 /* In the non-toolkit version, the menu bar is an ordinary screen
9681 line, and this makes it get updated. */
9682 w
->update_mode_line
= Qt
;
9683 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9685 unbind_to (count
, Qnil
);
9686 set_buffer_internal_1 (prev
);
9695 /***********************************************************************
9697 ***********************************************************************/
9699 #ifdef HAVE_WINDOW_SYSTEM
9702 Nominal cursor position -- where to draw output.
9703 HPOS and VPOS are window relative glyph matrix coordinates.
9704 X and Y are window relative pixel coordinates. */
9706 struct cursor_pos output_cursor
;
9710 Set the global variable output_cursor to CURSOR. All cursor
9711 positions are relative to updated_window. */
9714 set_output_cursor (cursor
)
9715 struct cursor_pos
*cursor
;
9717 output_cursor
.hpos
= cursor
->hpos
;
9718 output_cursor
.vpos
= cursor
->vpos
;
9719 output_cursor
.x
= cursor
->x
;
9720 output_cursor
.y
= cursor
->y
;
9725 Set a nominal cursor position.
9727 HPOS and VPOS are column/row positions in a window glyph matrix. X
9728 and Y are window text area relative pixel positions.
9730 If this is done during an update, updated_window will contain the
9731 window that is being updated and the position is the future output
9732 cursor position for that window. If updated_window is null, use
9733 selected_window and display the cursor at the given position. */
9736 x_cursor_to (vpos
, hpos
, y
, x
)
9737 int vpos
, hpos
, y
, x
;
9741 /* If updated_window is not set, work on selected_window. */
9745 w
= XWINDOW (selected_window
);
9747 /* Set the output cursor. */
9748 output_cursor
.hpos
= hpos
;
9749 output_cursor
.vpos
= vpos
;
9750 output_cursor
.x
= x
;
9751 output_cursor
.y
= y
;
9753 /* If not called as part of an update, really display the cursor.
9754 This will also set the cursor position of W. */
9755 if (updated_window
== NULL
)
9758 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
9759 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
9760 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
9765 #endif /* HAVE_WINDOW_SYSTEM */
9768 /***********************************************************************
9770 ***********************************************************************/
9772 #ifdef HAVE_WINDOW_SYSTEM
9774 /* Where the mouse was last time we reported a mouse event. */
9776 FRAME_PTR last_mouse_frame
;
9778 /* Tool-bar item index of the item on which a mouse button was pressed
9781 int last_tool_bar_item
;
9785 update_tool_bar_unwind (frame
)
9788 selected_frame
= frame
;
9792 /* Update the tool-bar item list for frame F. This has to be done
9793 before we start to fill in any display lines. Called from
9794 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
9795 and restore it here. */
9798 update_tool_bar (f
, save_match_data
)
9800 int save_match_data
;
9802 #if defined (USE_GTK) || defined (HAVE_NS)
9803 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
9805 int do_update
= WINDOWP (f
->tool_bar_window
)
9806 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
9814 window
= FRAME_SELECTED_WINDOW (f
);
9815 w
= XWINDOW (window
);
9817 /* If the user has switched buffers or windows, we need to
9818 recompute to reflect the new bindings. But we'll
9819 recompute when update_mode_lines is set too; that means
9820 that people can use force-mode-line-update to request
9821 that the menu bar be recomputed. The adverse effect on
9822 the rest of the redisplay algorithm is about the same as
9823 windows_or_buffers_changed anyway. */
9824 if (windows_or_buffers_changed
9825 || !NILP (w
->update_mode_line
)
9826 || update_mode_lines
9827 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9828 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9829 != !NILP (w
->last_had_star
))
9830 || ((!NILP (Vtransient_mark_mode
)
9831 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
9832 != !NILP (w
->region_showing
)))
9834 struct buffer
*prev
= current_buffer
;
9835 int count
= SPECPDL_INDEX ();
9836 Lisp_Object frame
, new_tool_bar
;
9838 struct gcpro gcpro1
;
9840 /* Set current_buffer to the buffer of the selected
9841 window of the frame, so that we get the right local
9843 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9845 /* Save match data, if we must. */
9846 if (save_match_data
)
9847 record_unwind_save_match_data ();
9849 /* Make sure that we don't accidentally use bogus keymaps. */
9850 if (NILP (Voverriding_local_map_menu_flag
))
9852 specbind (Qoverriding_terminal_local_map
, Qnil
);
9853 specbind (Qoverriding_local_map
, Qnil
);
9856 GCPRO1 (new_tool_bar
);
9858 /* We must temporarily set the selected frame to this frame
9859 before calling tool_bar_items, because the calculation of
9860 the tool-bar keymap uses the selected frame (see
9861 `tool-bar-make-keymap' in tool-bar.el). */
9862 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
9863 XSETFRAME (frame
, f
);
9864 selected_frame
= frame
;
9866 /* Build desired tool-bar items from keymaps. */
9867 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
9870 /* Redisplay the tool-bar if we changed it. */
9871 if (new_n_tool_bar
!= f
->n_tool_bar_items
9872 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
9874 /* Redisplay that happens asynchronously due to an expose event
9875 may access f->tool_bar_items. Make sure we update both
9876 variables within BLOCK_INPUT so no such event interrupts. */
9878 f
->tool_bar_items
= new_tool_bar
;
9879 f
->n_tool_bar_items
= new_n_tool_bar
;
9880 w
->update_mode_line
= Qt
;
9886 unbind_to (count
, Qnil
);
9887 set_buffer_internal_1 (prev
);
9893 /* Set F->desired_tool_bar_string to a Lisp string representing frame
9894 F's desired tool-bar contents. F->tool_bar_items must have
9895 been set up previously by calling prepare_menu_bars. */
9898 build_desired_tool_bar_string (f
)
9901 int i
, size
, size_needed
;
9902 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9903 Lisp_Object image
, plist
, props
;
9905 image
= plist
= props
= Qnil
;
9906 GCPRO3 (image
, plist
, props
);
9908 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
9909 Otherwise, make a new string. */
9911 /* The size of the string we might be able to reuse. */
9912 size
= (STRINGP (f
->desired_tool_bar_string
)
9913 ? SCHARS (f
->desired_tool_bar_string
)
9916 /* We need one space in the string for each image. */
9917 size_needed
= f
->n_tool_bar_items
;
9919 /* Reuse f->desired_tool_bar_string, if possible. */
9920 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
9921 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
9925 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
9926 Fremove_text_properties (make_number (0), make_number (size
),
9927 props
, f
->desired_tool_bar_string
);
9930 /* Put a `display' property on the string for the images to display,
9931 put a `menu_item' property on tool-bar items with a value that
9932 is the index of the item in F's tool-bar item vector. */
9933 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
9935 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
9937 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
9938 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
9939 int hmargin
, vmargin
, relief
, idx
, end
;
9940 extern Lisp_Object QCrelief
, QCmargin
, QCconversion
;
9942 /* If image is a vector, choose the image according to the
9944 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
9945 if (VECTORP (image
))
9949 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
9950 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
9953 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
9954 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
9956 xassert (ASIZE (image
) >= idx
);
9957 image
= AREF (image
, idx
);
9962 /* Ignore invalid image specifications. */
9963 if (!valid_image_p (image
))
9966 /* Display the tool-bar button pressed, or depressed. */
9967 plist
= Fcopy_sequence (XCDR (image
));
9969 /* Compute margin and relief to draw. */
9970 relief
= (tool_bar_button_relief
>= 0
9971 ? tool_bar_button_relief
9972 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
9973 hmargin
= vmargin
= relief
;
9975 if (INTEGERP (Vtool_bar_button_margin
)
9976 && XINT (Vtool_bar_button_margin
) > 0)
9978 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
9979 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
9981 else if (CONSP (Vtool_bar_button_margin
))
9983 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
9984 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
9985 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
9987 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
9988 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
9989 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
9992 if (auto_raise_tool_bar_buttons_p
)
9994 /* Add a `:relief' property to the image spec if the item is
9998 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
10005 /* If image is selected, display it pressed, i.e. with a
10006 negative relief. If it's not selected, display it with a
10008 plist
= Fplist_put (plist
, QCrelief
,
10010 ? make_number (-relief
)
10011 : make_number (relief
)));
10016 /* Put a margin around the image. */
10017 if (hmargin
|| vmargin
)
10019 if (hmargin
== vmargin
)
10020 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
10022 plist
= Fplist_put (plist
, QCmargin
,
10023 Fcons (make_number (hmargin
),
10024 make_number (vmargin
)));
10027 /* If button is not enabled, and we don't have special images
10028 for the disabled state, make the image appear disabled by
10029 applying an appropriate algorithm to it. */
10030 if (!enabled_p
&& idx
< 0)
10031 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
10033 /* Put a `display' text property on the string for the image to
10034 display. Put a `menu-item' property on the string that gives
10035 the start of this item's properties in the tool-bar items
10037 image
= Fcons (Qimage
, plist
);
10038 props
= list4 (Qdisplay
, image
,
10039 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
10041 /* Let the last image hide all remaining spaces in the tool bar
10042 string. The string can be longer than needed when we reuse a
10043 previous string. */
10044 if (i
+ 1 == f
->n_tool_bar_items
)
10045 end
= SCHARS (f
->desired_tool_bar_string
);
10048 Fadd_text_properties (make_number (i
), make_number (end
),
10049 props
, f
->desired_tool_bar_string
);
10057 /* Display one line of the tool-bar of frame IT->f.
10059 HEIGHT specifies the desired height of the tool-bar line.
10060 If the actual height of the glyph row is less than HEIGHT, the
10061 row's height is increased to HEIGHT, and the icons are centered
10062 vertically in the new height.
10064 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
10065 count a final empty row in case the tool-bar width exactly matches
10070 display_tool_bar_line (it
, height
)
10074 struct glyph_row
*row
= it
->glyph_row
;
10075 int max_x
= it
->last_visible_x
;
10076 struct glyph
*last
;
10078 prepare_desired_row (row
);
10079 row
->y
= it
->current_y
;
10081 /* Note that this isn't made use of if the face hasn't a box,
10082 so there's no need to check the face here. */
10083 it
->start_of_box_run_p
= 1;
10085 while (it
->current_x
< max_x
)
10087 int x
, n_glyphs_before
, i
, nglyphs
;
10088 struct it it_before
;
10090 /* Get the next display element. */
10091 if (!get_next_display_element (it
))
10093 /* Don't count empty row if we are counting needed tool-bar lines. */
10094 if (height
< 0 && !it
->hpos
)
10099 /* Produce glyphs. */
10100 n_glyphs_before
= row
->used
[TEXT_AREA
];
10103 PRODUCE_GLYPHS (it
);
10105 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
10107 x
= it_before
.current_x
;
10108 while (i
< nglyphs
)
10110 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
10112 if (x
+ glyph
->pixel_width
> max_x
)
10114 /* Glyph doesn't fit on line. Backtrack. */
10115 row
->used
[TEXT_AREA
] = n_glyphs_before
;
10117 /* If this is the only glyph on this line, it will never fit on the
10118 toolbar, so skip it. But ensure there is at least one glyph,
10119 so we don't accidentally disable the tool-bar. */
10120 if (n_glyphs_before
== 0
10121 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
10127 x
+= glyph
->pixel_width
;
10131 /* Stop at line ends. */
10132 if (ITERATOR_AT_END_OF_LINE_P (it
))
10135 set_iterator_to_next (it
, 1);
10140 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
10142 /* Use default face for the border below the tool bar.
10144 FIXME: When auto-resize-tool-bars is grow-only, there is
10145 no additional border below the possibly empty tool-bar lines.
10146 So to make the extra empty lines look "normal", we have to
10147 use the tool-bar face for the border too. */
10148 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
10149 it
->face_id
= DEFAULT_FACE_ID
;
10151 extend_face_to_end_of_line (it
);
10152 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
10153 last
->right_box_line_p
= 1;
10154 if (last
== row
->glyphs
[TEXT_AREA
])
10155 last
->left_box_line_p
= 1;
10157 /* Make line the desired height and center it vertically. */
10158 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
10160 /* Don't add more than one line height. */
10161 height
%= FRAME_LINE_HEIGHT (it
->f
);
10162 it
->max_ascent
+= height
/ 2;
10163 it
->max_descent
+= (height
+ 1) / 2;
10166 compute_line_metrics (it
);
10168 /* If line is empty, make it occupy the rest of the tool-bar. */
10169 if (!row
->displays_text_p
)
10171 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
10172 row
->visible_height
= row
->height
;
10173 row
->ascent
= row
->phys_ascent
= 0;
10174 row
->extra_line_spacing
= 0;
10177 row
->full_width_p
= 1;
10178 row
->continued_p
= 0;
10179 row
->truncated_on_left_p
= 0;
10180 row
->truncated_on_right_p
= 0;
10182 it
->current_x
= it
->hpos
= 0;
10183 it
->current_y
+= row
->height
;
10189 /* Max tool-bar height. */
10191 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
10192 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
10194 /* Value is the number of screen lines needed to make all tool-bar
10195 items of frame F visible. The number of actual rows needed is
10196 returned in *N_ROWS if non-NULL. */
10199 tool_bar_lines_needed (f
, n_rows
)
10203 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10205 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
10206 the desired matrix, so use (unused) mode-line row as temporary row to
10207 avoid destroying the first tool-bar row. */
10208 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
10210 /* Initialize an iterator for iteration over
10211 F->desired_tool_bar_string in the tool-bar window of frame F. */
10212 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
10213 it
.first_visible_x
= 0;
10214 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10215 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10217 while (!ITERATOR_AT_END_P (&it
))
10219 clear_glyph_row (temp_row
);
10220 it
.glyph_row
= temp_row
;
10221 display_tool_bar_line (&it
, -1);
10223 clear_glyph_row (temp_row
);
10225 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
10227 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
10229 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
10233 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
10235 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
10244 frame
= selected_frame
;
10246 CHECK_FRAME (frame
);
10247 f
= XFRAME (frame
);
10249 if (WINDOWP (f
->tool_bar_window
)
10250 || (w
= XWINDOW (f
->tool_bar_window
),
10251 WINDOW_TOTAL_LINES (w
) > 0))
10253 update_tool_bar (f
, 1);
10254 if (f
->n_tool_bar_items
)
10256 build_desired_tool_bar_string (f
);
10257 nlines
= tool_bar_lines_needed (f
, NULL
);
10261 return make_number (nlines
);
10265 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
10266 height should be changed. */
10269 redisplay_tool_bar (f
)
10274 struct glyph_row
*row
;
10276 #if defined (USE_GTK) || defined (HAVE_NS)
10277 if (FRAME_EXTERNAL_TOOL_BAR (f
))
10278 update_frame_tool_bar (f
);
10282 /* If frame hasn't a tool-bar window or if it is zero-height, don't
10283 do anything. This means you must start with tool-bar-lines
10284 non-zero to get the auto-sizing effect. Or in other words, you
10285 can turn off tool-bars by specifying tool-bar-lines zero. */
10286 if (!WINDOWP (f
->tool_bar_window
)
10287 || (w
= XWINDOW (f
->tool_bar_window
),
10288 WINDOW_TOTAL_LINES (w
) == 0))
10291 /* Set up an iterator for the tool-bar window. */
10292 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
10293 it
.first_visible_x
= 0;
10294 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10295 row
= it
.glyph_row
;
10297 /* Build a string that represents the contents of the tool-bar. */
10298 build_desired_tool_bar_string (f
);
10299 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10301 if (f
->n_tool_bar_rows
== 0)
10305 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
10306 nlines
!= WINDOW_TOTAL_LINES (w
)))
10308 extern Lisp_Object Qtool_bar_lines
;
10310 int old_height
= WINDOW_TOTAL_LINES (w
);
10312 XSETFRAME (frame
, f
);
10313 Fmodify_frame_parameters (frame
,
10314 Fcons (Fcons (Qtool_bar_lines
,
10315 make_number (nlines
)),
10317 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10319 clear_glyph_matrix (w
->desired_matrix
);
10320 fonts_changed_p
= 1;
10326 /* Display as many lines as needed to display all tool-bar items. */
10328 if (f
->n_tool_bar_rows
> 0)
10330 int border
, rows
, height
, extra
;
10332 if (INTEGERP (Vtool_bar_border
))
10333 border
= XINT (Vtool_bar_border
);
10334 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
10335 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
10336 else if (EQ (Vtool_bar_border
, Qborder_width
))
10337 border
= f
->border_width
;
10343 rows
= f
->n_tool_bar_rows
;
10344 height
= max (1, (it
.last_visible_y
- border
) / rows
);
10345 extra
= it
.last_visible_y
- border
- height
* rows
;
10347 while (it
.current_y
< it
.last_visible_y
)
10350 if (extra
> 0 && rows
-- > 0)
10352 h
= (extra
+ rows
- 1) / rows
;
10355 display_tool_bar_line (&it
, height
+ h
);
10360 while (it
.current_y
< it
.last_visible_y
)
10361 display_tool_bar_line (&it
, 0);
10364 /* It doesn't make much sense to try scrolling in the tool-bar
10365 window, so don't do it. */
10366 w
->desired_matrix
->no_scrolling_p
= 1;
10367 w
->must_be_updated_p
= 1;
10369 if (!NILP (Vauto_resize_tool_bars
))
10371 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
10372 int change_height_p
= 0;
10374 /* If we couldn't display everything, change the tool-bar's
10375 height if there is room for more. */
10376 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
10377 && it
.current_y
< max_tool_bar_height
)
10378 change_height_p
= 1;
10380 row
= it
.glyph_row
- 1;
10382 /* If there are blank lines at the end, except for a partially
10383 visible blank line at the end that is smaller than
10384 FRAME_LINE_HEIGHT, change the tool-bar's height. */
10385 if (!row
->displays_text_p
10386 && row
->height
>= FRAME_LINE_HEIGHT (f
))
10387 change_height_p
= 1;
10389 /* If row displays tool-bar items, but is partially visible,
10390 change the tool-bar's height. */
10391 if (row
->displays_text_p
10392 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
10393 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
10394 change_height_p
= 1;
10396 /* Resize windows as needed by changing the `tool-bar-lines'
10397 frame parameter. */
10398 if (change_height_p
)
10400 extern Lisp_Object Qtool_bar_lines
;
10402 int old_height
= WINDOW_TOTAL_LINES (w
);
10404 int nlines
= tool_bar_lines_needed (f
, &nrows
);
10406 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
10407 && !f
->minimize_tool_bar_window_p
)
10408 ? (nlines
> old_height
)
10409 : (nlines
!= old_height
));
10410 f
->minimize_tool_bar_window_p
= 0;
10412 if (change_height_p
)
10414 XSETFRAME (frame
, f
);
10415 Fmodify_frame_parameters (frame
,
10416 Fcons (Fcons (Qtool_bar_lines
,
10417 make_number (nlines
)),
10419 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10421 clear_glyph_matrix (w
->desired_matrix
);
10422 f
->n_tool_bar_rows
= nrows
;
10423 fonts_changed_p
= 1;
10430 f
->minimize_tool_bar_window_p
= 0;
10435 /* Get information about the tool-bar item which is displayed in GLYPH
10436 on frame F. Return in *PROP_IDX the index where tool-bar item
10437 properties start in F->tool_bar_items. Value is zero if
10438 GLYPH doesn't display a tool-bar item. */
10441 tool_bar_item_info (f
, glyph
, prop_idx
)
10443 struct glyph
*glyph
;
10450 /* This function can be called asynchronously, which means we must
10451 exclude any possibility that Fget_text_property signals an
10453 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
10454 charpos
= max (0, charpos
);
10456 /* Get the text property `menu-item' at pos. The value of that
10457 property is the start index of this item's properties in
10458 F->tool_bar_items. */
10459 prop
= Fget_text_property (make_number (charpos
),
10460 Qmenu_item
, f
->current_tool_bar_string
);
10461 if (INTEGERP (prop
))
10463 *prop_idx
= XINT (prop
);
10473 /* Get information about the tool-bar item at position X/Y on frame F.
10474 Return in *GLYPH a pointer to the glyph of the tool-bar item in
10475 the current matrix of the tool-bar window of F, or NULL if not
10476 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
10477 item in F->tool_bar_items. Value is
10479 -1 if X/Y is not on a tool-bar item
10480 0 if X/Y is on the same item that was highlighted before.
10484 get_tool_bar_item (f
, x
, y
, glyph
, hpos
, vpos
, prop_idx
)
10487 struct glyph
**glyph
;
10488 int *hpos
, *vpos
, *prop_idx
;
10490 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10491 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10494 /* Find the glyph under X/Y. */
10495 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
10496 if (*glyph
== NULL
)
10499 /* Get the start of this tool-bar item's properties in
10500 f->tool_bar_items. */
10501 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
10504 /* Is mouse on the highlighted item? */
10505 if (EQ (f
->tool_bar_window
, dpyinfo
->mouse_face_window
)
10506 && *vpos
>= dpyinfo
->mouse_face_beg_row
10507 && *vpos
<= dpyinfo
->mouse_face_end_row
10508 && (*vpos
> dpyinfo
->mouse_face_beg_row
10509 || *hpos
>= dpyinfo
->mouse_face_beg_col
)
10510 && (*vpos
< dpyinfo
->mouse_face_end_row
10511 || *hpos
< dpyinfo
->mouse_face_end_col
10512 || dpyinfo
->mouse_face_past_end
))
10520 Handle mouse button event on the tool-bar of frame F, at
10521 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
10522 0 for button release. MODIFIERS is event modifiers for button
10526 handle_tool_bar_click (f
, x
, y
, down_p
, modifiers
)
10529 unsigned int modifiers
;
10531 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10532 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10533 int hpos
, vpos
, prop_idx
;
10534 struct glyph
*glyph
;
10535 Lisp_Object enabled_p
;
10537 /* If not on the highlighted tool-bar item, return. */
10538 frame_to_window_pixel_xy (w
, &x
, &y
);
10539 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
10542 /* If item is disabled, do nothing. */
10543 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10544 if (NILP (enabled_p
))
10549 /* Show item in pressed state. */
10550 show_mouse_face (dpyinfo
, DRAW_IMAGE_SUNKEN
);
10551 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
10552 last_tool_bar_item
= prop_idx
;
10556 Lisp_Object key
, frame
;
10557 struct input_event event
;
10558 EVENT_INIT (event
);
10560 /* Show item in released state. */
10561 show_mouse_face (dpyinfo
, DRAW_IMAGE_RAISED
);
10562 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
10564 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
10566 XSETFRAME (frame
, f
);
10567 event
.kind
= TOOL_BAR_EVENT
;
10568 event
.frame_or_window
= frame
;
10570 kbd_buffer_store_event (&event
);
10572 event
.kind
= TOOL_BAR_EVENT
;
10573 event
.frame_or_window
= frame
;
10575 event
.modifiers
= modifiers
;
10576 kbd_buffer_store_event (&event
);
10577 last_tool_bar_item
= -1;
10582 /* Possibly highlight a tool-bar item on frame F when mouse moves to
10583 tool-bar window-relative coordinates X/Y. Called from
10584 note_mouse_highlight. */
10587 note_tool_bar_highlight (f
, x
, y
)
10591 Lisp_Object window
= f
->tool_bar_window
;
10592 struct window
*w
= XWINDOW (window
);
10593 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10595 struct glyph
*glyph
;
10596 struct glyph_row
*row
;
10598 Lisp_Object enabled_p
;
10600 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
10601 int mouse_down_p
, rc
;
10603 /* Function note_mouse_highlight is called with negative x(y
10604 values when mouse moves outside of the frame. */
10605 if (x
<= 0 || y
<= 0)
10607 clear_mouse_face (dpyinfo
);
10611 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
10614 /* Not on tool-bar item. */
10615 clear_mouse_face (dpyinfo
);
10619 /* On same tool-bar item as before. */
10620 goto set_help_echo
;
10622 clear_mouse_face (dpyinfo
);
10624 /* Mouse is down, but on different tool-bar item? */
10625 mouse_down_p
= (dpyinfo
->grabbed
10626 && f
== last_mouse_frame
10627 && FRAME_LIVE_P (f
));
10629 && last_tool_bar_item
!= prop_idx
)
10632 dpyinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
10633 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
10635 /* If tool-bar item is not enabled, don't highlight it. */
10636 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10637 if (!NILP (enabled_p
))
10639 /* Compute the x-position of the glyph. In front and past the
10640 image is a space. We include this in the highlighted area. */
10641 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
10642 for (i
= x
= 0; i
< hpos
; ++i
)
10643 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
10645 /* Record this as the current active region. */
10646 dpyinfo
->mouse_face_beg_col
= hpos
;
10647 dpyinfo
->mouse_face_beg_row
= vpos
;
10648 dpyinfo
->mouse_face_beg_x
= x
;
10649 dpyinfo
->mouse_face_beg_y
= row
->y
;
10650 dpyinfo
->mouse_face_past_end
= 0;
10652 dpyinfo
->mouse_face_end_col
= hpos
+ 1;
10653 dpyinfo
->mouse_face_end_row
= vpos
;
10654 dpyinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
10655 dpyinfo
->mouse_face_end_y
= row
->y
;
10656 dpyinfo
->mouse_face_window
= window
;
10657 dpyinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
10659 /* Display it as active. */
10660 show_mouse_face (dpyinfo
, draw
);
10661 dpyinfo
->mouse_face_image_state
= draw
;
10666 /* Set help_echo_string to a help string to display for this tool-bar item.
10667 XTread_socket does the rest. */
10668 help_echo_object
= help_echo_window
= Qnil
;
10669 help_echo_pos
= -1;
10670 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
10671 if (NILP (help_echo_string
))
10672 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
10675 #endif /* HAVE_WINDOW_SYSTEM */
10679 /************************************************************************
10680 Horizontal scrolling
10681 ************************************************************************/
10683 static int hscroll_window_tree
P_ ((Lisp_Object
));
10684 static int hscroll_windows
P_ ((Lisp_Object
));
10686 /* For all leaf windows in the window tree rooted at WINDOW, set their
10687 hscroll value so that PT is (i) visible in the window, and (ii) so
10688 that it is not within a certain margin at the window's left and
10689 right border. Value is non-zero if any window's hscroll has been
10693 hscroll_window_tree (window
)
10694 Lisp_Object window
;
10696 int hscrolled_p
= 0;
10697 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
10698 int hscroll_step_abs
= 0;
10699 double hscroll_step_rel
= 0;
10701 if (hscroll_relative_p
)
10703 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
10704 if (hscroll_step_rel
< 0)
10706 hscroll_relative_p
= 0;
10707 hscroll_step_abs
= 0;
10710 else if (INTEGERP (Vhscroll_step
))
10712 hscroll_step_abs
= XINT (Vhscroll_step
);
10713 if (hscroll_step_abs
< 0)
10714 hscroll_step_abs
= 0;
10717 hscroll_step_abs
= 0;
10719 while (WINDOWP (window
))
10721 struct window
*w
= XWINDOW (window
);
10723 if (WINDOWP (w
->hchild
))
10724 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
10725 else if (WINDOWP (w
->vchild
))
10726 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
10727 else if (w
->cursor
.vpos
>= 0)
10730 int text_area_width
;
10731 struct glyph_row
*current_cursor_row
10732 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
10733 struct glyph_row
*desired_cursor_row
10734 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
10735 struct glyph_row
*cursor_row
10736 = (desired_cursor_row
->enabled_p
10737 ? desired_cursor_row
10738 : current_cursor_row
);
10740 text_area_width
= window_box_width (w
, TEXT_AREA
);
10742 /* Scroll when cursor is inside this scroll margin. */
10743 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
10745 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
10746 && ((XFASTINT (w
->hscroll
)
10747 && w
->cursor
.x
<= h_margin
)
10748 || (cursor_row
->enabled_p
10749 && cursor_row
->truncated_on_right_p
10750 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
10754 struct buffer
*saved_current_buffer
;
10758 /* Find point in a display of infinite width. */
10759 saved_current_buffer
= current_buffer
;
10760 current_buffer
= XBUFFER (w
->buffer
);
10762 if (w
== XWINDOW (selected_window
))
10763 pt
= BUF_PT (current_buffer
);
10766 pt
= marker_position (w
->pointm
);
10767 pt
= max (BEGV
, pt
);
10771 /* Move iterator to pt starting at cursor_row->start in
10772 a line with infinite width. */
10773 init_to_row_start (&it
, w
, cursor_row
);
10774 it
.last_visible_x
= INFINITY
;
10775 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
10776 current_buffer
= saved_current_buffer
;
10778 /* Position cursor in window. */
10779 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
10780 hscroll
= max (0, (it
.current_x
10781 - (ITERATOR_AT_END_OF_LINE_P (&it
)
10782 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
10783 : (text_area_width
/ 2))))
10784 / FRAME_COLUMN_WIDTH (it
.f
);
10785 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
10787 if (hscroll_relative_p
)
10788 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
10791 wanted_x
= text_area_width
10792 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10795 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10799 if (hscroll_relative_p
)
10800 wanted_x
= text_area_width
* hscroll_step_rel
10803 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10806 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10808 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
10810 /* Don't call Fset_window_hscroll if value hasn't
10811 changed because it will prevent redisplay
10813 if (XFASTINT (w
->hscroll
) != hscroll
)
10815 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
10816 w
->hscroll
= make_number (hscroll
);
10825 /* Value is non-zero if hscroll of any leaf window has been changed. */
10826 return hscrolled_p
;
10830 /* Set hscroll so that cursor is visible and not inside horizontal
10831 scroll margins for all windows in the tree rooted at WINDOW. See
10832 also hscroll_window_tree above. Value is non-zero if any window's
10833 hscroll has been changed. If it has, desired matrices on the frame
10834 of WINDOW are cleared. */
10837 hscroll_windows (window
)
10838 Lisp_Object window
;
10840 int hscrolled_p
= hscroll_window_tree (window
);
10842 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
10843 return hscrolled_p
;
10848 /************************************************************************
10850 ************************************************************************/
10852 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
10853 to a non-zero value. This is sometimes handy to have in a debugger
10858 /* First and last unchanged row for try_window_id. */
10860 int debug_first_unchanged_at_end_vpos
;
10861 int debug_last_unchanged_at_beg_vpos
;
10863 /* Delta vpos and y. */
10865 int debug_dvpos
, debug_dy
;
10867 /* Delta in characters and bytes for try_window_id. */
10869 int debug_delta
, debug_delta_bytes
;
10871 /* Values of window_end_pos and window_end_vpos at the end of
10874 EMACS_INT debug_end_pos
, debug_end_vpos
;
10876 /* Append a string to W->desired_matrix->method. FMT is a printf
10877 format string. A1...A9 are a supplement for a variable-length
10878 argument list. If trace_redisplay_p is non-zero also printf the
10879 resulting string to stderr. */
10882 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
10885 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
10888 char *method
= w
->desired_matrix
->method
;
10889 int len
= strlen (method
);
10890 int size
= sizeof w
->desired_matrix
->method
;
10891 int remaining
= size
- len
- 1;
10893 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
10894 if (len
&& remaining
)
10897 --remaining
, ++len
;
10900 strncpy (method
+ len
, buffer
, remaining
);
10902 if (trace_redisplay_p
)
10903 fprintf (stderr
, "%p (%s): %s\n",
10905 ((BUFFERP (w
->buffer
)
10906 && STRINGP (XBUFFER (w
->buffer
)->name
))
10907 ? (char *) SDATA (XBUFFER (w
->buffer
)->name
)
10912 #endif /* GLYPH_DEBUG */
10915 /* Value is non-zero if all changes in window W, which displays
10916 current_buffer, are in the text between START and END. START is a
10917 buffer position, END is given as a distance from Z. Used in
10918 redisplay_internal for display optimization. */
10921 text_outside_line_unchanged_p (w
, start
, end
)
10925 int unchanged_p
= 1;
10927 /* If text or overlays have changed, see where. */
10928 if (XFASTINT (w
->last_modified
) < MODIFF
10929 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
10931 /* Gap in the line? */
10932 if (GPT
< start
|| Z
- GPT
< end
)
10935 /* Changes start in front of the line, or end after it? */
10937 && (BEG_UNCHANGED
< start
- 1
10938 || END_UNCHANGED
< end
))
10941 /* If selective display, can't optimize if changes start at the
10942 beginning of the line. */
10944 && INTEGERP (current_buffer
->selective_display
)
10945 && XINT (current_buffer
->selective_display
) > 0
10946 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
10949 /* If there are overlays at the start or end of the line, these
10950 may have overlay strings with newlines in them. A change at
10951 START, for instance, may actually concern the display of such
10952 overlay strings as well, and they are displayed on different
10953 lines. So, quickly rule out this case. (For the future, it
10954 might be desirable to implement something more telling than
10955 just BEG/END_UNCHANGED.) */
10958 if (BEG
+ BEG_UNCHANGED
== start
10959 && overlay_touches_p (start
))
10961 if (END_UNCHANGED
== end
10962 && overlay_touches_p (Z
- end
))
10967 return unchanged_p
;
10971 /* Do a frame update, taking possible shortcuts into account. This is
10972 the main external entry point for redisplay.
10974 If the last redisplay displayed an echo area message and that message
10975 is no longer requested, we clear the echo area or bring back the
10976 mini-buffer if that is in use. */
10981 redisplay_internal (0);
10986 overlay_arrow_string_or_property (var
)
10991 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
10994 return Voverlay_arrow_string
;
10997 /* Return 1 if there are any overlay-arrows in current_buffer. */
10999 overlay_arrow_in_current_buffer_p ()
11003 for (vlist
= Voverlay_arrow_variable_list
;
11005 vlist
= XCDR (vlist
))
11007 Lisp_Object var
= XCAR (vlist
);
11010 if (!SYMBOLP (var
))
11012 val
= find_symbol_value (var
);
11014 && current_buffer
== XMARKER (val
)->buffer
)
11021 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
11025 overlay_arrows_changed_p ()
11029 for (vlist
= Voverlay_arrow_variable_list
;
11031 vlist
= XCDR (vlist
))
11033 Lisp_Object var
= XCAR (vlist
);
11034 Lisp_Object val
, pstr
;
11036 if (!SYMBOLP (var
))
11038 val
= find_symbol_value (var
);
11039 if (!MARKERP (val
))
11041 if (! EQ (COERCE_MARKER (val
),
11042 Fget (var
, Qlast_arrow_position
))
11043 || ! (pstr
= overlay_arrow_string_or_property (var
),
11044 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
11050 /* Mark overlay arrows to be updated on next redisplay. */
11053 update_overlay_arrows (up_to_date
)
11058 for (vlist
= Voverlay_arrow_variable_list
;
11060 vlist
= XCDR (vlist
))
11062 Lisp_Object var
= XCAR (vlist
);
11064 if (!SYMBOLP (var
))
11067 if (up_to_date
> 0)
11069 Lisp_Object val
= find_symbol_value (var
);
11070 Fput (var
, Qlast_arrow_position
,
11071 COERCE_MARKER (val
));
11072 Fput (var
, Qlast_arrow_string
,
11073 overlay_arrow_string_or_property (var
));
11075 else if (up_to_date
< 0
11076 || !NILP (Fget (var
, Qlast_arrow_position
)))
11078 Fput (var
, Qlast_arrow_position
, Qt
);
11079 Fput (var
, Qlast_arrow_string
, Qt
);
11085 /* Return overlay arrow string to display at row.
11086 Return integer (bitmap number) for arrow bitmap in left fringe.
11087 Return nil if no overlay arrow. */
11090 overlay_arrow_at_row (it
, row
)
11092 struct glyph_row
*row
;
11096 for (vlist
= Voverlay_arrow_variable_list
;
11098 vlist
= XCDR (vlist
))
11100 Lisp_Object var
= XCAR (vlist
);
11103 if (!SYMBOLP (var
))
11106 val
= find_symbol_value (var
);
11109 && current_buffer
== XMARKER (val
)->buffer
11110 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
11112 if (FRAME_WINDOW_P (it
->f
)
11113 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
11115 #ifdef HAVE_WINDOW_SYSTEM
11116 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
11119 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
11120 return make_number (fringe_bitmap
);
11123 return make_number (-1); /* Use default arrow bitmap */
11125 return overlay_arrow_string_or_property (var
);
11132 /* Return 1 if point moved out of or into a composition. Otherwise
11133 return 0. PREV_BUF and PREV_PT are the last point buffer and
11134 position. BUF and PT are the current point buffer and position. */
11137 check_point_in_composition (prev_buf
, prev_pt
, buf
, pt
)
11138 struct buffer
*prev_buf
, *buf
;
11141 EMACS_INT start
, end
;
11143 Lisp_Object buffer
;
11145 XSETBUFFER (buffer
, buf
);
11146 /* Check a composition at the last point if point moved within the
11148 if (prev_buf
== buf
)
11151 /* Point didn't move. */
11154 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
11155 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
11156 && COMPOSITION_VALID_P (start
, end
, prop
)
11157 && start
< prev_pt
&& end
> prev_pt
)
11158 /* The last point was within the composition. Return 1 iff
11159 point moved out of the composition. */
11160 return (pt
<= start
|| pt
>= end
);
11163 /* Check a composition at the current point. */
11164 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
11165 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
11166 && COMPOSITION_VALID_P (start
, end
, prop
)
11167 && start
< pt
&& end
> pt
);
11171 /* Reconsider the setting of B->clip_changed which is displayed
11175 reconsider_clip_changes (w
, b
)
11179 if (b
->clip_changed
11180 && !NILP (w
->window_end_valid
)
11181 && w
->current_matrix
->buffer
== b
11182 && w
->current_matrix
->zv
== BUF_ZV (b
)
11183 && w
->current_matrix
->begv
== BUF_BEGV (b
))
11184 b
->clip_changed
= 0;
11186 /* If display wasn't paused, and W is not a tool bar window, see if
11187 point has been moved into or out of a composition. In that case,
11188 we set b->clip_changed to 1 to force updating the screen. If
11189 b->clip_changed has already been set to 1, we can skip this
11191 if (!b
->clip_changed
11192 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
11196 if (w
== XWINDOW (selected_window
))
11197 pt
= BUF_PT (current_buffer
);
11199 pt
= marker_position (w
->pointm
);
11201 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
11202 || pt
!= XINT (w
->last_point
))
11203 && check_point_in_composition (w
->current_matrix
->buffer
,
11204 XINT (w
->last_point
),
11205 XBUFFER (w
->buffer
), pt
))
11206 b
->clip_changed
= 1;
11211 /* Select FRAME to forward the values of frame-local variables into C
11212 variables so that the redisplay routines can access those values
11216 select_frame_for_redisplay (frame
)
11219 Lisp_Object tail
, symbol
, val
;
11220 Lisp_Object old
= selected_frame
;
11221 struct Lisp_Symbol
*sym
;
11223 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
11225 selected_frame
= frame
;
11229 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
11230 if (CONSP (XCAR (tail
))
11231 && (symbol
= XCAR (XCAR (tail
)),
11233 && (sym
= indirect_variable (XSYMBOL (symbol
)),
11235 (BUFFER_LOCAL_VALUEP (val
)))
11236 && XBUFFER_LOCAL_VALUE (val
)->check_frame
)
11237 /* Use find_symbol_value rather than Fsymbol_value
11238 to avoid an error if it is void. */
11239 find_symbol_value (symbol
);
11240 } while (!EQ (frame
, old
) && (frame
= old
, 1));
11244 #define STOP_POLLING \
11245 do { if (! polling_stopped_here) stop_polling (); \
11246 polling_stopped_here = 1; } while (0)
11248 #define RESUME_POLLING \
11249 do { if (polling_stopped_here) start_polling (); \
11250 polling_stopped_here = 0; } while (0)
11253 /* If PRESERVE_ECHO_AREA is nonzero, it means this redisplay is not in
11254 response to any user action; therefore, we should preserve the echo
11255 area. (Actually, our caller does that job.) Perhaps in the future
11256 avoid recentering windows if it is not necessary; currently that
11257 causes some problems. */
11260 redisplay_internal (preserve_echo_area
)
11261 int preserve_echo_area
;
11263 struct window
*w
= XWINDOW (selected_window
);
11266 int must_finish
= 0;
11267 struct text_pos tlbufpos
, tlendpos
;
11268 int number_of_visible_frames
;
11271 int polling_stopped_here
= 0;
11272 Lisp_Object old_frame
= selected_frame
;
11274 /* Non-zero means redisplay has to consider all windows on all
11275 frames. Zero means, only selected_window is considered. */
11276 int consider_all_windows_p
;
11278 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
11280 /* No redisplay if running in batch mode or frame is not yet fully
11281 initialized, or redisplay is explicitly turned off by setting
11282 Vinhibit_redisplay. */
11283 if (FRAME_INITIAL_P (SELECTED_FRAME ())
11284 || !NILP (Vinhibit_redisplay
))
11287 /* Don't examine these until after testing Vinhibit_redisplay.
11288 When Emacs is shutting down, perhaps because its connection to
11289 X has dropped, we should not look at them at all. */
11290 f
= XFRAME (w
->frame
);
11291 sf
= SELECTED_FRAME ();
11293 if (!f
->glyphs_initialized_p
)
11296 /* The flag redisplay_performed_directly_p is set by
11297 direct_output_for_insert when it already did the whole screen
11298 update necessary. */
11299 if (redisplay_performed_directly_p
)
11301 redisplay_performed_directly_p
= 0;
11302 if (!hscroll_windows (selected_window
))
11306 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
11307 if (popup_activated ())
11311 /* I don't think this happens but let's be paranoid. */
11312 if (redisplaying_p
)
11315 /* Record a function that resets redisplaying_p to its old value
11316 when we leave this function. */
11317 count
= SPECPDL_INDEX ();
11318 record_unwind_protect (unwind_redisplay
,
11319 Fcons (make_number (redisplaying_p
), selected_frame
));
11321 specbind (Qinhibit_free_realized_faces
, Qnil
);
11324 Lisp_Object tail
, frame
;
11326 FOR_EACH_FRAME (tail
, frame
)
11328 struct frame
*f
= XFRAME (frame
);
11329 f
->already_hscrolled_p
= 0;
11334 if (!EQ (old_frame
, selected_frame
)
11335 && FRAME_LIVE_P (XFRAME (old_frame
)))
11336 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
11337 selected_frame and selected_window to be temporarily out-of-sync so
11338 when we come back here via `goto retry', we need to resync because we
11339 may need to run Elisp code (via prepare_menu_bars). */
11340 select_frame_for_redisplay (old_frame
);
11343 reconsider_clip_changes (w
, current_buffer
);
11344 last_escape_glyph_frame
= NULL
;
11345 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
11347 /* If new fonts have been loaded that make a glyph matrix adjustment
11348 necessary, do it. */
11349 if (fonts_changed_p
)
11351 adjust_glyphs (NULL
);
11352 ++windows_or_buffers_changed
;
11353 fonts_changed_p
= 0;
11356 /* If face_change_count is non-zero, init_iterator will free all
11357 realized faces, which includes the faces referenced from current
11358 matrices. So, we can't reuse current matrices in this case. */
11359 if (face_change_count
)
11360 ++windows_or_buffers_changed
;
11362 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11363 && FRAME_TTY (sf
)->previous_frame
!= sf
)
11365 /* Since frames on a single ASCII terminal share the same
11366 display area, displaying a different frame means redisplay
11367 the whole thing. */
11368 windows_or_buffers_changed
++;
11369 SET_FRAME_GARBAGED (sf
);
11371 set_tty_color_mode (FRAME_TTY (sf
), sf
);
11373 FRAME_TTY (sf
)->previous_frame
= sf
;
11376 /* Set the visible flags for all frames. Do this before checking
11377 for resized or garbaged frames; they want to know if their frames
11378 are visible. See the comment in frame.h for
11379 FRAME_SAMPLE_VISIBILITY. */
11381 Lisp_Object tail
, frame
;
11383 number_of_visible_frames
= 0;
11385 FOR_EACH_FRAME (tail
, frame
)
11387 struct frame
*f
= XFRAME (frame
);
11389 FRAME_SAMPLE_VISIBILITY (f
);
11390 if (FRAME_VISIBLE_P (f
))
11391 ++number_of_visible_frames
;
11392 clear_desired_matrices (f
);
11396 /* Notice any pending interrupt request to change frame size. */
11397 do_pending_window_change (1);
11399 /* Clear frames marked as garbaged. */
11400 if (frame_garbaged
)
11401 clear_garbaged_frames ();
11403 /* Build menubar and tool-bar items. */
11404 if (NILP (Vmemory_full
))
11405 prepare_menu_bars ();
11407 if (windows_or_buffers_changed
)
11408 update_mode_lines
++;
11410 /* Detect case that we need to write or remove a star in the mode line. */
11411 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
11413 w
->update_mode_line
= Qt
;
11414 if (buffer_shared
> 1)
11415 update_mode_lines
++;
11418 /* Avoid invocation of point motion hooks by `current_column' below. */
11419 count1
= SPECPDL_INDEX ();
11420 specbind (Qinhibit_point_motion_hooks
, Qt
);
11422 /* If %c is in the mode line, update it if needed. */
11423 if (!NILP (w
->column_number_displayed
)
11424 /* This alternative quickly identifies a common case
11425 where no change is needed. */
11426 && !(PT
== XFASTINT (w
->last_point
)
11427 && XFASTINT (w
->last_modified
) >= MODIFF
11428 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
11429 && (XFASTINT (w
->column_number_displayed
)
11430 != (int) current_column ())) /* iftc */
11431 w
->update_mode_line
= Qt
;
11433 unbind_to (count1
, Qnil
);
11435 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
11437 /* The variable buffer_shared is set in redisplay_window and
11438 indicates that we redisplay a buffer in different windows. See
11440 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
11441 || cursor_type_changed
);
11443 /* If specs for an arrow have changed, do thorough redisplay
11444 to ensure we remove any arrow that should no longer exist. */
11445 if (overlay_arrows_changed_p ())
11446 consider_all_windows_p
= windows_or_buffers_changed
= 1;
11448 /* Normally the message* functions will have already displayed and
11449 updated the echo area, but the frame may have been trashed, or
11450 the update may have been preempted, so display the echo area
11451 again here. Checking message_cleared_p captures the case that
11452 the echo area should be cleared. */
11453 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
11454 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
11455 || (message_cleared_p
11456 && minibuf_level
== 0
11457 /* If the mini-window is currently selected, this means the
11458 echo-area doesn't show through. */
11459 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
11461 int window_height_changed_p
= echo_area_display (0);
11464 /* If we don't display the current message, don't clear the
11465 message_cleared_p flag, because, if we did, we wouldn't clear
11466 the echo area in the next redisplay which doesn't preserve
11468 if (!display_last_displayed_message_p
)
11469 message_cleared_p
= 0;
11471 if (fonts_changed_p
)
11473 else if (window_height_changed_p
)
11475 consider_all_windows_p
= 1;
11476 ++update_mode_lines
;
11477 ++windows_or_buffers_changed
;
11479 /* If window configuration was changed, frames may have been
11480 marked garbaged. Clear them or we will experience
11481 surprises wrt scrolling. */
11482 if (frame_garbaged
)
11483 clear_garbaged_frames ();
11486 else if (EQ (selected_window
, minibuf_window
)
11487 && (current_buffer
->clip_changed
11488 || XFASTINT (w
->last_modified
) < MODIFF
11489 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11490 && resize_mini_window (w
, 0))
11492 /* Resized active mini-window to fit the size of what it is
11493 showing if its contents might have changed. */
11495 /* FIXME: this causes all frames to be updated, which seems unnecessary
11496 since only the current frame needs to be considered. This function needs
11497 to be rewritten with two variables, consider_all_windows and
11498 consider_all_frames. */
11499 consider_all_windows_p
= 1;
11500 ++windows_or_buffers_changed
;
11501 ++update_mode_lines
;
11503 /* If window configuration was changed, frames may have been
11504 marked garbaged. Clear them or we will experience
11505 surprises wrt scrolling. */
11506 if (frame_garbaged
)
11507 clear_garbaged_frames ();
11511 /* If showing the region, and mark has changed, we must redisplay
11512 the whole window. The assignment to this_line_start_pos prevents
11513 the optimization directly below this if-statement. */
11514 if (((!NILP (Vtransient_mark_mode
)
11515 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
11516 != !NILP (w
->region_showing
))
11517 || (!NILP (w
->region_showing
)
11518 && !EQ (w
->region_showing
,
11519 Fmarker_position (XBUFFER (w
->buffer
)->mark
))))
11520 CHARPOS (this_line_start_pos
) = 0;
11522 /* Optimize the case that only the line containing the cursor in the
11523 selected window has changed. Variables starting with this_ are
11524 set in display_line and record information about the line
11525 containing the cursor. */
11526 tlbufpos
= this_line_start_pos
;
11527 tlendpos
= this_line_end_pos
;
11528 if (!consider_all_windows_p
11529 && CHARPOS (tlbufpos
) > 0
11530 && NILP (w
->update_mode_line
)
11531 && !current_buffer
->clip_changed
11532 && !current_buffer
->prevent_redisplay_optimizations_p
11533 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
11534 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
11535 /* Make sure recorded data applies to current buffer, etc. */
11536 && this_line_buffer
== current_buffer
11537 && current_buffer
== XBUFFER (w
->buffer
)
11538 && NILP (w
->force_start
)
11539 && NILP (w
->optional_new_start
)
11540 /* Point must be on the line that we have info recorded about. */
11541 && PT
>= CHARPOS (tlbufpos
)
11542 && PT
<= Z
- CHARPOS (tlendpos
)
11543 /* All text outside that line, including its final newline,
11544 must be unchanged. */
11545 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
11546 CHARPOS (tlendpos
)))
11548 if (CHARPOS (tlbufpos
) > BEGV
11549 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
11550 && (CHARPOS (tlbufpos
) == ZV
11551 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
11552 /* Former continuation line has disappeared by becoming empty. */
11554 else if (XFASTINT (w
->last_modified
) < MODIFF
11555 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
11556 || MINI_WINDOW_P (w
))
11558 /* We have to handle the case of continuation around a
11559 wide-column character (see the comment in indent.c around
11562 For instance, in the following case:
11564 -------- Insert --------
11565 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
11566 J_I_ ==> J_I_ `^^' are cursors.
11570 As we have to redraw the line above, we cannot use this
11574 int line_height_before
= this_line_pixel_height
;
11576 /* Note that start_display will handle the case that the
11577 line starting at tlbufpos is a continuation line. */
11578 start_display (&it
, w
, tlbufpos
);
11580 /* Implementation note: It this still necessary? */
11581 if (it
.current_x
!= this_line_start_x
)
11584 TRACE ((stderr
, "trying display optimization 1\n"));
11585 w
->cursor
.vpos
= -1;
11586 overlay_arrow_seen
= 0;
11587 it
.vpos
= this_line_vpos
;
11588 it
.current_y
= this_line_y
;
11589 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
11590 display_line (&it
);
11592 /* If line contains point, is not continued,
11593 and ends at same distance from eob as before, we win. */
11594 if (w
->cursor
.vpos
>= 0
11595 /* Line is not continued, otherwise this_line_start_pos
11596 would have been set to 0 in display_line. */
11597 && CHARPOS (this_line_start_pos
)
11598 /* Line ends as before. */
11599 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
11600 /* Line has same height as before. Otherwise other lines
11601 would have to be shifted up or down. */
11602 && this_line_pixel_height
== line_height_before
)
11604 /* If this is not the window's last line, we must adjust
11605 the charstarts of the lines below. */
11606 if (it
.current_y
< it
.last_visible_y
)
11608 struct glyph_row
*row
11609 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
11610 int delta
, delta_bytes
;
11612 /* We used to distinguish between two cases here,
11613 conditioned by Z - CHARPOS (tlendpos) == ZV, for
11614 when the line ends in a newline or the end of the
11615 buffer's accessible portion. But both cases did
11616 the same, so they were collapsed. */
11618 - CHARPOS (tlendpos
)
11619 - MATRIX_ROW_START_CHARPOS (row
));
11620 delta_bytes
= (Z_BYTE
11621 - BYTEPOS (tlendpos
)
11622 - MATRIX_ROW_START_BYTEPOS (row
));
11624 increment_matrix_positions (w
->current_matrix
,
11625 this_line_vpos
+ 1,
11626 w
->current_matrix
->nrows
,
11627 delta
, delta_bytes
);
11630 /* If this row displays text now but previously didn't,
11631 or vice versa, w->window_end_vpos may have to be
11633 if ((it
.glyph_row
- 1)->displays_text_p
)
11635 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
11636 XSETINT (w
->window_end_vpos
, this_line_vpos
);
11638 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
11639 && this_line_vpos
> 0)
11640 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
11641 w
->window_end_valid
= Qnil
;
11643 /* Update hint: No need to try to scroll in update_window. */
11644 w
->desired_matrix
->no_scrolling_p
= 1;
11647 *w
->desired_matrix
->method
= 0;
11648 debug_method_add (w
, "optimization 1");
11650 #ifdef HAVE_WINDOW_SYSTEM
11651 update_window_fringes (w
, 0);
11658 else if (/* Cursor position hasn't changed. */
11659 PT
== XFASTINT (w
->last_point
)
11660 /* Make sure the cursor was last displayed
11661 in this window. Otherwise we have to reposition it. */
11662 && 0 <= w
->cursor
.vpos
11663 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
11667 do_pending_window_change (1);
11669 /* We used to always goto end_of_redisplay here, but this
11670 isn't enough if we have a blinking cursor. */
11671 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
11672 goto end_of_redisplay
;
11676 /* If highlighting the region, or if the cursor is in the echo area,
11677 then we can't just move the cursor. */
11678 else if (! (!NILP (Vtransient_mark_mode
)
11679 && !NILP (current_buffer
->mark_active
))
11680 && (EQ (selected_window
, current_buffer
->last_selected_window
)
11681 || highlight_nonselected_windows
)
11682 && NILP (w
->region_showing
)
11683 && NILP (Vshow_trailing_whitespace
)
11684 && !cursor_in_echo_area
)
11687 struct glyph_row
*row
;
11689 /* Skip from tlbufpos to PT and see where it is. Note that
11690 PT may be in invisible text. If so, we will end at the
11691 next visible position. */
11692 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
11693 NULL
, DEFAULT_FACE_ID
);
11694 it
.current_x
= this_line_start_x
;
11695 it
.current_y
= this_line_y
;
11696 it
.vpos
= this_line_vpos
;
11698 /* The call to move_it_to stops in front of PT, but
11699 moves over before-strings. */
11700 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
11702 if (it
.vpos
== this_line_vpos
11703 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
11706 xassert (this_line_vpos
== it
.vpos
);
11707 xassert (this_line_y
== it
.current_y
);
11708 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
11710 *w
->desired_matrix
->method
= 0;
11711 debug_method_add (w
, "optimization 3");
11720 /* Text changed drastically or point moved off of line. */
11721 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
11724 CHARPOS (this_line_start_pos
) = 0;
11725 consider_all_windows_p
|= buffer_shared
> 1;
11726 ++clear_face_cache_count
;
11727 #ifdef HAVE_WINDOW_SYSTEM
11728 ++clear_image_cache_count
;
11731 /* Build desired matrices, and update the display. If
11732 consider_all_windows_p is non-zero, do it for all windows on all
11733 frames. Otherwise do it for selected_window, only. */
11735 if (consider_all_windows_p
)
11737 Lisp_Object tail
, frame
;
11739 FOR_EACH_FRAME (tail
, frame
)
11740 XFRAME (frame
)->updated_p
= 0;
11742 /* Recompute # windows showing selected buffer. This will be
11743 incremented each time such a window is displayed. */
11746 FOR_EACH_FRAME (tail
, frame
)
11748 struct frame
*f
= XFRAME (frame
);
11750 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
11752 if (! EQ (frame
, selected_frame
))
11753 /* Select the frame, for the sake of frame-local
11755 select_frame_for_redisplay (frame
);
11757 /* Mark all the scroll bars to be removed; we'll redeem
11758 the ones we want when we redisplay their windows. */
11759 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
11760 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
11762 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11763 redisplay_windows (FRAME_ROOT_WINDOW (f
));
11765 /* The X error handler may have deleted that frame. */
11766 if (!FRAME_LIVE_P (f
))
11769 /* Any scroll bars which redisplay_windows should have
11770 nuked should now go away. */
11771 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
11772 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
11774 /* If fonts changed, display again. */
11775 /* ??? rms: I suspect it is a mistake to jump all the way
11776 back to retry here. It should just retry this frame. */
11777 if (fonts_changed_p
)
11780 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11782 /* See if we have to hscroll. */
11783 if (!f
->already_hscrolled_p
)
11785 f
->already_hscrolled_p
= 1;
11786 if (hscroll_windows (f
->root_window
))
11790 /* Prevent various kinds of signals during display
11791 update. stdio is not robust about handling
11792 signals, which can cause an apparent I/O
11794 if (interrupt_input
)
11795 unrequest_sigio ();
11798 /* Update the display. */
11799 set_window_update_flags (XWINDOW (f
->root_window
), 1);
11800 pause
|= update_frame (f
, 0, 0);
11806 if (!EQ (old_frame
, selected_frame
)
11807 && FRAME_LIVE_P (XFRAME (old_frame
)))
11808 /* We played a bit fast-and-loose above and allowed selected_frame
11809 and selected_window to be temporarily out-of-sync but let's make
11810 sure this stays contained. */
11811 select_frame_for_redisplay (old_frame
);
11812 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
11816 /* Do the mark_window_display_accurate after all windows have
11817 been redisplayed because this call resets flags in buffers
11818 which are needed for proper redisplay. */
11819 FOR_EACH_FRAME (tail
, frame
)
11821 struct frame
*f
= XFRAME (frame
);
11824 mark_window_display_accurate (f
->root_window
, 1);
11825 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
11826 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
11831 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
11833 Lisp_Object mini_window
;
11834 struct frame
*mini_frame
;
11836 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
11837 /* Use list_of_error, not Qerror, so that
11838 we catch only errors and don't run the debugger. */
11839 internal_condition_case_1 (redisplay_window_1
, selected_window
,
11841 redisplay_window_error
);
11843 /* Compare desired and current matrices, perform output. */
11846 /* If fonts changed, display again. */
11847 if (fonts_changed_p
)
11850 /* Prevent various kinds of signals during display update.
11851 stdio is not robust about handling signals,
11852 which can cause an apparent I/O error. */
11853 if (interrupt_input
)
11854 unrequest_sigio ();
11857 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
11859 if (hscroll_windows (selected_window
))
11862 XWINDOW (selected_window
)->must_be_updated_p
= 1;
11863 pause
= update_frame (sf
, 0, 0);
11866 /* We may have called echo_area_display at the top of this
11867 function. If the echo area is on another frame, that may
11868 have put text on a frame other than the selected one, so the
11869 above call to update_frame would not have caught it. Catch
11871 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
11872 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
11874 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
11876 XWINDOW (mini_window
)->must_be_updated_p
= 1;
11877 pause
|= update_frame (mini_frame
, 0, 0);
11878 if (!pause
&& hscroll_windows (mini_window
))
11883 /* If display was paused because of pending input, make sure we do a
11884 thorough update the next time. */
11887 /* Prevent the optimization at the beginning of
11888 redisplay_internal that tries a single-line update of the
11889 line containing the cursor in the selected window. */
11890 CHARPOS (this_line_start_pos
) = 0;
11892 /* Let the overlay arrow be updated the next time. */
11893 update_overlay_arrows (0);
11895 /* If we pause after scrolling, some rows in the current
11896 matrices of some windows are not valid. */
11897 if (!WINDOW_FULL_WIDTH_P (w
)
11898 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
11899 update_mode_lines
= 1;
11903 if (!consider_all_windows_p
)
11905 /* This has already been done above if
11906 consider_all_windows_p is set. */
11907 mark_window_display_accurate_1 (w
, 1);
11909 /* Say overlay arrows are up to date. */
11910 update_overlay_arrows (1);
11912 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
11913 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
11916 update_mode_lines
= 0;
11917 windows_or_buffers_changed
= 0;
11918 cursor_type_changed
= 0;
11921 /* Start SIGIO interrupts coming again. Having them off during the
11922 code above makes it less likely one will discard output, but not
11923 impossible, since there might be stuff in the system buffer here.
11924 But it is much hairier to try to do anything about that. */
11925 if (interrupt_input
)
11929 /* If a frame has become visible which was not before, redisplay
11930 again, so that we display it. Expose events for such a frame
11931 (which it gets when becoming visible) don't call the parts of
11932 redisplay constructing glyphs, so simply exposing a frame won't
11933 display anything in this case. So, we have to display these
11934 frames here explicitly. */
11937 Lisp_Object tail
, frame
;
11940 FOR_EACH_FRAME (tail
, frame
)
11942 int this_is_visible
= 0;
11944 if (XFRAME (frame
)->visible
)
11945 this_is_visible
= 1;
11946 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
11947 if (XFRAME (frame
)->visible
)
11948 this_is_visible
= 1;
11950 if (this_is_visible
)
11954 if (new_count
!= number_of_visible_frames
)
11955 windows_or_buffers_changed
++;
11958 /* Change frame size now if a change is pending. */
11959 do_pending_window_change (1);
11961 /* If we just did a pending size change, or have additional
11962 visible frames, redisplay again. */
11963 if (windows_or_buffers_changed
&& !pause
)
11966 /* Clear the face cache eventually. */
11967 if (consider_all_windows_p
)
11969 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
11971 clear_face_cache (0);
11972 clear_face_cache_count
= 0;
11974 #ifdef HAVE_WINDOW_SYSTEM
11975 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
11977 clear_image_caches (Qnil
);
11978 clear_image_cache_count
= 0;
11980 #endif /* HAVE_WINDOW_SYSTEM */
11984 unbind_to (count
, Qnil
);
11989 /* Redisplay, but leave alone any recent echo area message unless
11990 another message has been requested in its place.
11992 This is useful in situations where you need to redisplay but no
11993 user action has occurred, making it inappropriate for the message
11994 area to be cleared. See tracking_off and
11995 wait_reading_process_output for examples of these situations.
11997 FROM_WHERE is an integer saying from where this function was
11998 called. This is useful for debugging. */
12001 redisplay_preserve_echo_area (from_where
)
12004 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
12006 if (!NILP (echo_area_buffer
[1]))
12008 /* We have a previously displayed message, but no current
12009 message. Redisplay the previous message. */
12010 display_last_displayed_message_p
= 1;
12011 redisplay_internal (1);
12012 display_last_displayed_message_p
= 0;
12015 redisplay_internal (1);
12017 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
12018 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
12019 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
12023 /* Function registered with record_unwind_protect in
12024 redisplay_internal. Reset redisplaying_p to the value it had
12025 before redisplay_internal was called, and clear
12026 prevent_freeing_realized_faces_p. It also selects the previously
12027 selected frame, unless it has been deleted (by an X connection
12028 failure during redisplay, for example). */
12031 unwind_redisplay (val
)
12034 Lisp_Object old_redisplaying_p
, old_frame
;
12036 old_redisplaying_p
= XCAR (val
);
12037 redisplaying_p
= XFASTINT (old_redisplaying_p
);
12038 old_frame
= XCDR (val
);
12039 if (! EQ (old_frame
, selected_frame
)
12040 && FRAME_LIVE_P (XFRAME (old_frame
)))
12041 select_frame_for_redisplay (old_frame
);
12046 /* Mark the display of window W as accurate or inaccurate. If
12047 ACCURATE_P is non-zero mark display of W as accurate. If
12048 ACCURATE_P is zero, arrange for W to be redisplayed the next time
12049 redisplay_internal is called. */
12052 mark_window_display_accurate_1 (w
, accurate_p
)
12056 if (BUFFERP (w
->buffer
))
12058 struct buffer
*b
= XBUFFER (w
->buffer
);
12061 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
12062 w
->last_overlay_modified
12063 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
12065 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
12069 b
->clip_changed
= 0;
12070 b
->prevent_redisplay_optimizations_p
= 0;
12072 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
12073 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
12074 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
12075 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
12077 w
->current_matrix
->buffer
= b
;
12078 w
->current_matrix
->begv
= BUF_BEGV (b
);
12079 w
->current_matrix
->zv
= BUF_ZV (b
);
12081 w
->last_cursor
= w
->cursor
;
12082 w
->last_cursor_off_p
= w
->cursor_off_p
;
12084 if (w
== XWINDOW (selected_window
))
12085 w
->last_point
= make_number (BUF_PT (b
));
12087 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
12093 w
->window_end_valid
= w
->buffer
;
12094 w
->update_mode_line
= Qnil
;
12099 /* Mark the display of windows in the window tree rooted at WINDOW as
12100 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
12101 windows as accurate. If ACCURATE_P is zero, arrange for windows to
12102 be redisplayed the next time redisplay_internal is called. */
12105 mark_window_display_accurate (window
, accurate_p
)
12106 Lisp_Object window
;
12111 for (; !NILP (window
); window
= w
->next
)
12113 w
= XWINDOW (window
);
12114 mark_window_display_accurate_1 (w
, accurate_p
);
12116 if (!NILP (w
->vchild
))
12117 mark_window_display_accurate (w
->vchild
, accurate_p
);
12118 if (!NILP (w
->hchild
))
12119 mark_window_display_accurate (w
->hchild
, accurate_p
);
12124 update_overlay_arrows (1);
12128 /* Force a thorough redisplay the next time by setting
12129 last_arrow_position and last_arrow_string to t, which is
12130 unequal to any useful value of Voverlay_arrow_... */
12131 update_overlay_arrows (-1);
12136 /* Return value in display table DP (Lisp_Char_Table *) for character
12137 C. Since a display table doesn't have any parent, we don't have to
12138 follow parent. Do not call this function directly but use the
12139 macro DISP_CHAR_VECTOR. */
12142 disp_char_vector (dp
, c
)
12143 struct Lisp_Char_Table
*dp
;
12148 if (ASCII_CHAR_P (c
))
12151 if (SUB_CHAR_TABLE_P (val
))
12152 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
12158 XSETCHAR_TABLE (table
, dp
);
12159 val
= char_table_ref (table
, c
);
12168 /***********************************************************************
12170 ***********************************************************************/
12172 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
12175 redisplay_windows (window
)
12176 Lisp_Object window
;
12178 while (!NILP (window
))
12180 struct window
*w
= XWINDOW (window
);
12182 if (!NILP (w
->hchild
))
12183 redisplay_windows (w
->hchild
);
12184 else if (!NILP (w
->vchild
))
12185 redisplay_windows (w
->vchild
);
12186 else if (!NILP (w
->buffer
))
12188 displayed_buffer
= XBUFFER (w
->buffer
);
12189 /* Use list_of_error, not Qerror, so that
12190 we catch only errors and don't run the debugger. */
12191 internal_condition_case_1 (redisplay_window_0
, window
,
12193 redisplay_window_error
);
12201 redisplay_window_error ()
12203 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
12208 redisplay_window_0 (window
)
12209 Lisp_Object window
;
12211 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12212 redisplay_window (window
, 0);
12217 redisplay_window_1 (window
)
12218 Lisp_Object window
;
12220 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12221 redisplay_window (window
, 1);
12226 /* Increment GLYPH until it reaches END or CONDITION fails while
12227 adding (GLYPH)->pixel_width to X. */
12229 #define SKIP_GLYPHS(glyph, end, x, condition) \
12232 (x) += (glyph)->pixel_width; \
12235 while ((glyph) < (end) && (condition))
12238 /* Set cursor position of W. PT is assumed to be displayed in ROW.
12239 DELTA and DELTA_BYTES are the numbers of characters and bytes by
12240 which positions recorded in ROW differ from current buffer
12243 Return 0 if cursor is not on this row, 1 otherwise. */
12246 set_cursor_from_row (w
, row
, matrix
, delta
, delta_bytes
, dy
, dvpos
)
12248 struct glyph_row
*row
;
12249 struct glyph_matrix
*matrix
;
12250 int delta
, delta_bytes
, dy
, dvpos
;
12252 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
12253 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
12254 struct glyph
*cursor
= NULL
;
12255 /* The first glyph that starts a sequence of glyphs from a string
12256 that is a value of a display property. */
12257 struct glyph
*string_start
;
12258 /* The X coordinate of string_start. */
12259 int string_start_x
;
12260 /* The last known character position in row. */
12261 int last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12262 /* The last known character position before string_start. */
12263 int string_before_pos
;
12266 /* Last buffer position covered by an overlay. */
12267 int cursor_from_overlay_pos
= 0;
12268 int pt_old
= PT
- delta
;
12270 /* Skip over glyphs not having an object at the start of the row.
12271 These are special glyphs like truncation marks on terminal
12273 if (row
->displays_text_p
)
12275 && INTEGERP (glyph
->object
)
12276 && glyph
->charpos
< 0)
12278 x
+= glyph
->pixel_width
;
12282 string_start
= NULL
;
12284 && !INTEGERP (glyph
->object
)
12285 && (!BUFFERP (glyph
->object
)
12286 || (last_pos
= glyph
->charpos
) < pt_old
12287 || glyph
->avoid_cursor_p
))
12289 if (! STRINGP (glyph
->object
))
12291 string_start
= NULL
;
12292 x
+= glyph
->pixel_width
;
12294 /* If we are beyond the cursor position computed from the
12295 last overlay seen, that overlay is not in effect for
12296 current cursor position. Reset the cursor information
12297 computed from that overlay. */
12298 if (cursor_from_overlay_pos
12299 && last_pos
>= cursor_from_overlay_pos
)
12301 cursor_from_overlay_pos
= 0;
12307 if (string_start
== NULL
)
12309 string_before_pos
= last_pos
;
12310 string_start
= glyph
;
12311 string_start_x
= x
;
12313 /* Skip all glyphs from a string. */
12318 if ((cursor
== NULL
|| glyph
> cursor
)
12319 && (cprop
= Fget_char_property (make_number ((glyph
)->charpos
),
12320 Qcursor
, (glyph
)->object
),
12322 && (pos
= string_buffer_position (w
, glyph
->object
,
12323 string_before_pos
),
12324 (pos
== 0 /* from overlay */
12325 || pos
== pt_old
)))
12327 /* Compute the first buffer position after the overlay.
12328 If the `cursor' property tells us how many positions
12329 are associated with the overlay, use that. Otherwise,
12330 estimate from the buffer positions of the glyphs
12331 before and after the overlay. */
12332 cursor_from_overlay_pos
= (pos
? 0 : last_pos
12333 + (INTEGERP (cprop
) ? XINT (cprop
) : 0));
12337 x
+= glyph
->pixel_width
;
12340 while (glyph
< end
&& EQ (glyph
->object
, string_start
->object
));
12344 if (cursor
!= NULL
)
12349 else if (row
->ends_in_ellipsis_p
&& glyph
== end
)
12351 /* Scan back over the ellipsis glyphs, decrementing positions. */
12352 while (glyph
> row
->glyphs
[TEXT_AREA
]
12353 && (glyph
- 1)->charpos
== last_pos
)
12354 glyph
--, x
-= glyph
->pixel_width
;
12355 /* That loop always goes one position too far, including the
12356 glyph before the ellipsis. So scan forward over that one. */
12357 x
+= glyph
->pixel_width
;
12360 else if (string_start
12361 && (glyph
== end
|| !BUFFERP (glyph
->object
) || last_pos
> pt_old
))
12363 /* We may have skipped over point because the previous glyphs
12364 are from string. As there's no easy way to know the
12365 character position of the current glyph, find the correct
12366 glyph on point by scanning from string_start again. */
12368 Lisp_Object string
;
12369 struct glyph
*stop
= glyph
;
12372 limit
= make_number (pt_old
+ 1);
12373 glyph
= string_start
;
12374 x
= string_start_x
;
12375 string
= glyph
->object
;
12376 pos
= string_buffer_position (w
, string
, string_before_pos
);
12377 /* If POS == 0, STRING is from overlay. We skip such glyphs
12378 because we always put the cursor after overlay strings. */
12379 while (pos
== 0 && glyph
< stop
)
12381 string
= glyph
->object
;
12382 SKIP_GLYPHS (glyph
, stop
, x
, EQ (glyph
->object
, string
));
12384 pos
= string_buffer_position (w
, glyph
->object
, string_before_pos
);
12387 while (glyph
< stop
)
12389 pos
= XINT (Fnext_single_char_property_change
12390 (make_number (pos
), Qdisplay
, Qnil
, limit
));
12393 /* Skip glyphs from the same string. */
12394 string
= glyph
->object
;
12395 SKIP_GLYPHS (glyph
, stop
, x
, EQ (glyph
->object
, string
));
12396 /* Skip glyphs from an overlay. */
12397 while (glyph
< stop
12398 && ! string_buffer_position (w
, glyph
->object
, pos
))
12400 string
= glyph
->object
;
12401 SKIP_GLYPHS (glyph
, stop
, x
, EQ (glyph
->object
, string
));
12405 /* If we reached the end of the line, and END was from a string,
12406 the cursor is not on this line. */
12407 if (glyph
== end
&& row
->continued_p
)
12411 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
12413 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
12414 w
->cursor
.y
= row
->y
+ dy
;
12416 if (w
== XWINDOW (selected_window
))
12418 if (!row
->continued_p
12419 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
12422 this_line_buffer
= XBUFFER (w
->buffer
);
12424 CHARPOS (this_line_start_pos
)
12425 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
12426 BYTEPOS (this_line_start_pos
)
12427 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
12429 CHARPOS (this_line_end_pos
)
12430 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
12431 BYTEPOS (this_line_end_pos
)
12432 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
12434 this_line_y
= w
->cursor
.y
;
12435 this_line_pixel_height
= row
->height
;
12436 this_line_vpos
= w
->cursor
.vpos
;
12437 this_line_start_x
= row
->x
;
12440 CHARPOS (this_line_start_pos
) = 0;
12447 /* Run window scroll functions, if any, for WINDOW with new window
12448 start STARTP. Sets the window start of WINDOW to that position.
12450 We assume that the window's buffer is really current. */
12452 static INLINE
struct text_pos
12453 run_window_scroll_functions (window
, startp
)
12454 Lisp_Object window
;
12455 struct text_pos startp
;
12457 struct window
*w
= XWINDOW (window
);
12458 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
12460 if (current_buffer
!= XBUFFER (w
->buffer
))
12463 if (!NILP (Vwindow_scroll_functions
))
12465 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
12466 make_number (CHARPOS (startp
)));
12467 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12468 /* In case the hook functions switch buffers. */
12469 if (current_buffer
!= XBUFFER (w
->buffer
))
12470 set_buffer_internal_1 (XBUFFER (w
->buffer
));
12477 /* Make sure the line containing the cursor is fully visible.
12478 A value of 1 means there is nothing to be done.
12479 (Either the line is fully visible, or it cannot be made so,
12480 or we cannot tell.)
12482 If FORCE_P is non-zero, return 0 even if partial visible cursor row
12483 is higher than window.
12485 A value of 0 means the caller should do scrolling
12486 as if point had gone off the screen. */
12489 cursor_row_fully_visible_p (w
, force_p
, current_matrix_p
)
12492 int current_matrix_p
;
12494 struct glyph_matrix
*matrix
;
12495 struct glyph_row
*row
;
12498 if (!make_cursor_line_fully_visible_p
)
12501 /* It's not always possible to find the cursor, e.g, when a window
12502 is full of overlay strings. Don't do anything in that case. */
12503 if (w
->cursor
.vpos
< 0)
12506 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
12507 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
12509 /* If the cursor row is not partially visible, there's nothing to do. */
12510 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
12513 /* If the row the cursor is in is taller than the window's height,
12514 it's not clear what to do, so do nothing. */
12515 window_height
= window_box_height (w
);
12516 if (row
->height
>= window_height
)
12518 if (!force_p
|| MINI_WINDOW_P (w
)
12519 || w
->vscroll
|| w
->cursor
.vpos
== 0)
12526 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
12527 non-zero means only WINDOW is redisplayed in redisplay_internal.
12528 TEMP_SCROLL_STEP has the same meaning as scroll_step, and is used
12529 in redisplay_window to bring a partially visible line into view in
12530 the case that only the cursor has moved.
12532 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
12533 last screen line's vertical height extends past the end of the screen.
12537 1 if scrolling succeeded
12539 0 if scrolling didn't find point.
12541 -1 if new fonts have been loaded so that we must interrupt
12542 redisplay, adjust glyph matrices, and try again. */
12548 SCROLLING_NEED_LARGER_MATRICES
12552 try_scrolling (window
, just_this_one_p
, scroll_conservatively
,
12553 scroll_step
, temp_scroll_step
, last_line_misfit
)
12554 Lisp_Object window
;
12555 int just_this_one_p
;
12556 EMACS_INT scroll_conservatively
, scroll_step
;
12557 int temp_scroll_step
;
12558 int last_line_misfit
;
12560 struct window
*w
= XWINDOW (window
);
12561 struct frame
*f
= XFRAME (w
->frame
);
12562 struct text_pos pos
, startp
;
12564 int this_scroll_margin
, scroll_max
, rc
, height
;
12565 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
12566 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
12567 Lisp_Object aggressive
;
12568 int scroll_limit
= INT_MAX
/ FRAME_LINE_HEIGHT (f
);
12571 debug_method_add (w
, "try_scrolling");
12574 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12576 /* Compute scroll margin height in pixels. We scroll when point is
12577 within this distance from the top or bottom of the window. */
12578 if (scroll_margin
> 0)
12579 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
12580 * FRAME_LINE_HEIGHT (f
);
12582 this_scroll_margin
= 0;
12584 /* Force scroll_conservatively to have a reasonable value, to avoid
12585 overflow while computing how much to scroll. Note that the user
12586 can supply scroll-conservatively equal to `most-positive-fixnum',
12587 which can be larger than INT_MAX. */
12588 if (scroll_conservatively
> scroll_limit
)
12590 scroll_conservatively
= scroll_limit
;
12591 scroll_max
= INT_MAX
;
12593 else if (scroll_step
|| scroll_conservatively
|| temp_scroll_step
)
12594 /* Compute how much we should try to scroll maximally to bring
12595 point into view. */
12596 scroll_max
= (max (scroll_step
,
12597 max (scroll_conservatively
, temp_scroll_step
))
12598 * FRAME_LINE_HEIGHT (f
));
12599 else if (NUMBERP (current_buffer
->scroll_down_aggressively
)
12600 || NUMBERP (current_buffer
->scroll_up_aggressively
))
12601 /* We're trying to scroll because of aggressive scrolling but no
12602 scroll_step is set. Choose an arbitrary one. */
12603 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
12609 /* Decide whether to scroll down. */
12610 if (PT
> CHARPOS (startp
))
12612 int scroll_margin_y
;
12614 /* Compute the pixel ypos of the scroll margin, then move it to
12615 either that ypos or PT, whichever comes first. */
12616 start_display (&it
, w
, startp
);
12617 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
12618 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
12619 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
12620 (MOVE_TO_POS
| MOVE_TO_Y
));
12622 if (PT
> CHARPOS (it
.current
.pos
))
12624 int y0
= line_bottom_y (&it
);
12626 /* Compute the distance from the scroll margin to PT
12627 (including the height of the cursor line). Moving the
12628 iterator unconditionally to PT can be slow if PT is far
12629 away, so stop 10 lines past the window bottom (is there a
12630 way to do the right thing quickly?). */
12631 move_it_to (&it
, PT
, -1,
12632 it
.last_visible_y
+ 10 * FRAME_LINE_HEIGHT (f
),
12633 -1, MOVE_TO_POS
| MOVE_TO_Y
);
12634 dy
= line_bottom_y (&it
) - y0
;
12636 if (dy
> scroll_max
)
12637 return SCROLLING_FAILED
;
12645 /* Point is in or below the bottom scroll margin, so move the
12646 window start down. If scrolling conservatively, move it just
12647 enough down to make point visible. If scroll_step is set,
12648 move it down by scroll_step. */
12649 if (scroll_conservatively
)
12651 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
12652 FRAME_LINE_HEIGHT (f
) * scroll_conservatively
);
12653 else if (scroll_step
|| temp_scroll_step
)
12654 amount_to_scroll
= scroll_max
;
12657 aggressive
= current_buffer
->scroll_up_aggressively
;
12658 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
12659 if (NUMBERP (aggressive
))
12661 double float_amount
= XFLOATINT (aggressive
) * height
;
12662 amount_to_scroll
= float_amount
;
12663 if (amount_to_scroll
== 0 && float_amount
> 0)
12664 amount_to_scroll
= 1;
12668 if (amount_to_scroll
<= 0)
12669 return SCROLLING_FAILED
;
12671 start_display (&it
, w
, startp
);
12672 move_it_vertically (&it
, amount_to_scroll
);
12674 /* If STARTP is unchanged, move it down another screen line. */
12675 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
12676 move_it_by_lines (&it
, 1, 1);
12677 startp
= it
.current
.pos
;
12681 struct text_pos scroll_margin_pos
= startp
;
12683 /* See if point is inside the scroll margin at the top of the
12685 if (this_scroll_margin
)
12687 start_display (&it
, w
, startp
);
12688 move_it_vertically (&it
, this_scroll_margin
);
12689 scroll_margin_pos
= it
.current
.pos
;
12692 if (PT
< CHARPOS (scroll_margin_pos
))
12694 /* Point is in the scroll margin at the top of the window or
12695 above what is displayed in the window. */
12698 /* Compute the vertical distance from PT to the scroll
12699 margin position. Give up if distance is greater than
12701 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
12702 start_display (&it
, w
, pos
);
12704 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
12705 it
.last_visible_y
, -1,
12706 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
12707 dy
= it
.current_y
- y0
;
12708 if (dy
> scroll_max
)
12709 return SCROLLING_FAILED
;
12711 /* Compute new window start. */
12712 start_display (&it
, w
, startp
);
12714 if (scroll_conservatively
)
12716 = max (dy
, FRAME_LINE_HEIGHT (f
) * max (scroll_step
, temp_scroll_step
));
12717 else if (scroll_step
|| temp_scroll_step
)
12718 amount_to_scroll
= scroll_max
;
12721 aggressive
= current_buffer
->scroll_down_aggressively
;
12722 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
12723 if (NUMBERP (aggressive
))
12725 double float_amount
= XFLOATINT (aggressive
) * height
;
12726 amount_to_scroll
= float_amount
;
12727 if (amount_to_scroll
== 0 && float_amount
> 0)
12728 amount_to_scroll
= 1;
12732 if (amount_to_scroll
<= 0)
12733 return SCROLLING_FAILED
;
12735 move_it_vertically_backward (&it
, amount_to_scroll
);
12736 startp
= it
.current
.pos
;
12740 /* Run window scroll functions. */
12741 startp
= run_window_scroll_functions (window
, startp
);
12743 /* Display the window. Give up if new fonts are loaded, or if point
12745 if (!try_window (window
, startp
, 0))
12746 rc
= SCROLLING_NEED_LARGER_MATRICES
;
12747 else if (w
->cursor
.vpos
< 0)
12749 clear_glyph_matrix (w
->desired_matrix
);
12750 rc
= SCROLLING_FAILED
;
12754 /* Maybe forget recorded base line for line number display. */
12755 if (!just_this_one_p
12756 || current_buffer
->clip_changed
12757 || BEG_UNCHANGED
< CHARPOS (startp
))
12758 w
->base_line_number
= Qnil
;
12760 /* If cursor ends up on a partially visible line,
12761 treat that as being off the bottom of the screen. */
12762 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
12763 /* It's possible that the cursor is on the first line of the
12764 buffer, which is partially obscured due to a vscroll
12765 (Bug#7537). In that case, avoid looping forever . */
12766 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
12768 clear_glyph_matrix (w
->desired_matrix
);
12769 ++extra_scroll_margin_lines
;
12772 rc
= SCROLLING_SUCCESS
;
12779 /* Compute a suitable window start for window W if display of W starts
12780 on a continuation line. Value is non-zero if a new window start
12783 The new window start will be computed, based on W's width, starting
12784 from the start of the continued line. It is the start of the
12785 screen line with the minimum distance from the old start W->start. */
12788 compute_window_start_on_continuation_line (w
)
12791 struct text_pos pos
, start_pos
;
12792 int window_start_changed_p
= 0;
12794 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
12796 /* If window start is on a continuation line... Window start may be
12797 < BEGV in case there's invisible text at the start of the
12798 buffer (M-x rmail, for example). */
12799 if (CHARPOS (start_pos
) > BEGV
12800 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
12803 struct glyph_row
*row
;
12805 /* Handle the case that the window start is out of range. */
12806 if (CHARPOS (start_pos
) < BEGV
)
12807 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
12808 else if (CHARPOS (start_pos
) > ZV
)
12809 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
12811 /* Find the start of the continued line. This should be fast
12812 because scan_buffer is fast (newline cache). */
12813 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
12814 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
12815 row
, DEFAULT_FACE_ID
);
12816 reseat_at_previous_visible_line_start (&it
);
12818 /* If the line start is "too far" away from the window start,
12819 say it takes too much time to compute a new window start. */
12820 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
12821 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
12823 int min_distance
, distance
;
12825 /* Move forward by display lines to find the new window
12826 start. If window width was enlarged, the new start can
12827 be expected to be > the old start. If window width was
12828 decreased, the new window start will be < the old start.
12829 So, we're looking for the display line start with the
12830 minimum distance from the old window start. */
12831 pos
= it
.current
.pos
;
12832 min_distance
= INFINITY
;
12833 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
12834 distance
< min_distance
)
12836 min_distance
= distance
;
12837 pos
= it
.current
.pos
;
12838 move_it_by_lines (&it
, 1, 0);
12841 /* Set the window start there. */
12842 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
12843 window_start_changed_p
= 1;
12847 return window_start_changed_p
;
12851 /* Try cursor movement in case text has not changed in window WINDOW,
12852 with window start STARTP. Value is
12854 CURSOR_MOVEMENT_SUCCESS if successful
12856 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
12858 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
12859 display. *SCROLL_STEP is set to 1, under certain circumstances, if
12860 we want to scroll as if scroll-step were set to 1. See the code.
12862 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
12863 which case we have to abort this redisplay, and adjust matrices
12868 CURSOR_MOVEMENT_SUCCESS
,
12869 CURSOR_MOVEMENT_CANNOT_BE_USED
,
12870 CURSOR_MOVEMENT_MUST_SCROLL
,
12871 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
12875 try_cursor_movement (window
, startp
, scroll_step
)
12876 Lisp_Object window
;
12877 struct text_pos startp
;
12880 struct window
*w
= XWINDOW (window
);
12881 struct frame
*f
= XFRAME (w
->frame
);
12882 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
12885 if (inhibit_try_cursor_movement
)
12889 /* Handle case where text has not changed, only point, and it has
12890 not moved off the frame. */
12891 if (/* Point may be in this window. */
12892 PT
>= CHARPOS (startp
)
12893 /* Selective display hasn't changed. */
12894 && !current_buffer
->clip_changed
12895 /* Function force-mode-line-update is used to force a thorough
12896 redisplay. It sets either windows_or_buffers_changed or
12897 update_mode_lines. So don't take a shortcut here for these
12899 && !update_mode_lines
12900 && !windows_or_buffers_changed
12901 && !cursor_type_changed
12902 /* Can't use this case if highlighting a region. When a
12903 region exists, cursor movement has to do more than just
12905 && !(!NILP (Vtransient_mark_mode
)
12906 && !NILP (current_buffer
->mark_active
))
12907 && NILP (w
->region_showing
)
12908 && NILP (Vshow_trailing_whitespace
)
12909 /* Right after splitting windows, last_point may be nil. */
12910 && INTEGERP (w
->last_point
)
12911 /* This code is not used for mini-buffer for the sake of the case
12912 of redisplaying to replace an echo area message; since in
12913 that case the mini-buffer contents per se are usually
12914 unchanged. This code is of no real use in the mini-buffer
12915 since the handling of this_line_start_pos, etc., in redisplay
12916 handles the same cases. */
12917 && !EQ (window
, minibuf_window
)
12918 /* When splitting windows or for new windows, it happens that
12919 redisplay is called with a nil window_end_vpos or one being
12920 larger than the window. This should really be fixed in
12921 window.c. I don't have this on my list, now, so we do
12922 approximately the same as the old redisplay code. --gerd. */
12923 && INTEGERP (w
->window_end_vpos
)
12924 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
12925 && (FRAME_WINDOW_P (f
)
12926 || !overlay_arrow_in_current_buffer_p ()))
12928 int this_scroll_margin
, top_scroll_margin
;
12929 struct glyph_row
*row
= NULL
;
12932 debug_method_add (w
, "cursor movement");
12935 /* Scroll if point within this distance from the top or bottom
12936 of the window. This is a pixel value. */
12937 if (scroll_margin
> 0)
12939 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
12940 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
12943 this_scroll_margin
= 0;
12945 top_scroll_margin
= this_scroll_margin
;
12946 if (WINDOW_WANTS_HEADER_LINE_P (w
))
12947 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
12949 /* Start with the row the cursor was displayed during the last
12950 not paused redisplay. Give up if that row is not valid. */
12951 if (w
->last_cursor
.vpos
< 0
12952 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
12953 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
12956 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
12957 if (row
->mode_line_p
)
12959 if (!row
->enabled_p
)
12960 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
12963 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
12966 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
12968 if (PT
> XFASTINT (w
->last_point
))
12970 /* Point has moved forward. */
12971 while (MATRIX_ROW_END_CHARPOS (row
) < PT
12972 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
12974 xassert (row
->enabled_p
);
12978 /* The end position of a row equals the start position
12979 of the next row. If PT is there, we would rather
12980 display it in the next line. */
12981 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
12982 && MATRIX_ROW_END_CHARPOS (row
) == PT
12983 && !cursor_row_p (w
, row
))
12986 /* If within the scroll margin, scroll. Note that
12987 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
12988 the next line would be drawn, and that
12989 this_scroll_margin can be zero. */
12990 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
12991 || PT
> MATRIX_ROW_END_CHARPOS (row
)
12992 /* Line is completely visible last line in window
12993 and PT is to be set in the next line. */
12994 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
12995 && PT
== MATRIX_ROW_END_CHARPOS (row
)
12996 && !row
->ends_at_zv_p
12997 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
13000 else if (PT
< XFASTINT (w
->last_point
))
13002 /* Cursor has to be moved backward. Note that PT >=
13003 CHARPOS (startp) because of the outer if-statement. */
13004 while (!row
->mode_line_p
13005 && (MATRIX_ROW_START_CHARPOS (row
) > PT
13006 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13007 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
13008 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
13009 row
> w
->current_matrix
->rows
13010 && (row
-1)->ends_in_newline_from_string_p
))))
13011 && (row
->y
> top_scroll_margin
13012 || CHARPOS (startp
) == BEGV
))
13014 xassert (row
->enabled_p
);
13018 /* Consider the following case: Window starts at BEGV,
13019 there is invisible, intangible text at BEGV, so that
13020 display starts at some point START > BEGV. It can
13021 happen that we are called with PT somewhere between
13022 BEGV and START. Try to handle that case. */
13023 if (row
< w
->current_matrix
->rows
13024 || row
->mode_line_p
)
13026 row
= w
->current_matrix
->rows
;
13027 if (row
->mode_line_p
)
13031 /* Due to newlines in overlay strings, we may have to
13032 skip forward over overlay strings. */
13033 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13034 && MATRIX_ROW_END_CHARPOS (row
) == PT
13035 && !cursor_row_p (w
, row
))
13038 /* If within the scroll margin, scroll. */
13039 if (row
->y
< top_scroll_margin
13040 && CHARPOS (startp
) != BEGV
)
13045 /* Cursor did not move. So don't scroll even if cursor line
13046 is partially visible, as it was so before. */
13047 rc
= CURSOR_MOVEMENT_SUCCESS
;
13050 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
13051 || PT
> MATRIX_ROW_END_CHARPOS (row
))
13053 /* if PT is not in the glyph row, give up. */
13054 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13056 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13057 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
13058 && make_cursor_line_fully_visible_p
)
13060 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
13061 && !row
->ends_at_zv_p
13062 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
13063 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13064 else if (row
->height
> window_box_height (w
))
13066 /* If we end up in a partially visible line, let's
13067 make it fully visible, except when it's taller
13068 than the window, in which case we can't do much
13071 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13075 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13076 if (!cursor_row_fully_visible_p (w
, 0, 1))
13077 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13079 rc
= CURSOR_MOVEMENT_SUCCESS
;
13083 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13088 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
13090 rc
= CURSOR_MOVEMENT_SUCCESS
;
13095 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13096 && MATRIX_ROW_START_CHARPOS (row
) == PT
13097 && cursor_row_p (w
, row
));
13106 set_vertical_scroll_bar (w
)
13109 int start
, end
, whole
;
13111 /* Calculate the start and end positions for the current window.
13112 At some point, it would be nice to choose between scrollbars
13113 which reflect the whole buffer size, with special markers
13114 indicating narrowing, and scrollbars which reflect only the
13117 Note that mini-buffers sometimes aren't displaying any text. */
13118 if (!MINI_WINDOW_P (w
)
13119 || (w
== XWINDOW (minibuf_window
)
13120 && NILP (echo_area_buffer
[0])))
13122 struct buffer
*buf
= XBUFFER (w
->buffer
);
13123 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
13124 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
13125 /* I don't think this is guaranteed to be right. For the
13126 moment, we'll pretend it is. */
13127 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
13131 if (whole
< (end
- start
))
13132 whole
= end
- start
;
13135 start
= end
= whole
= 0;
13137 /* Indicate what this scroll bar ought to be displaying now. */
13138 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13139 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13140 (w
, end
- start
, whole
, start
);
13144 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
13145 selected_window is redisplayed.
13147 We can return without actually redisplaying the window if
13148 fonts_changed_p is nonzero. In that case, redisplay_internal will
13152 redisplay_window (window
, just_this_one_p
)
13153 Lisp_Object window
;
13154 int just_this_one_p
;
13156 struct window
*w
= XWINDOW (window
);
13157 struct frame
*f
= XFRAME (w
->frame
);
13158 struct buffer
*buffer
= XBUFFER (w
->buffer
);
13159 struct buffer
*old
= current_buffer
;
13160 struct text_pos lpoint
, opoint
, startp
;
13161 int update_mode_line
;
13164 /* Record it now because it's overwritten. */
13165 int current_matrix_up_to_date_p
= 0;
13166 int used_current_matrix_p
= 0;
13167 /* This is less strict than current_matrix_up_to_date_p.
13168 It indictes that the buffer contents and narrowing are unchanged. */
13169 int buffer_unchanged_p
= 0;
13170 int temp_scroll_step
= 0;
13171 int count
= SPECPDL_INDEX ();
13173 int centering_position
= -1;
13174 int last_line_misfit
= 0;
13175 int beg_unchanged
, end_unchanged
;
13177 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13180 /* W must be a leaf window here. */
13181 xassert (!NILP (w
->buffer
));
13183 *w
->desired_matrix
->method
= 0;
13187 reconsider_clip_changes (w
, buffer
);
13189 /* Has the mode line to be updated? */
13190 update_mode_line
= (!NILP (w
->update_mode_line
)
13191 || update_mode_lines
13192 || buffer
->clip_changed
13193 || buffer
->prevent_redisplay_optimizations_p
);
13195 if (MINI_WINDOW_P (w
))
13197 if (w
== XWINDOW (echo_area_window
)
13198 && !NILP (echo_area_buffer
[0]))
13200 if (update_mode_line
)
13201 /* We may have to update a tty frame's menu bar or a
13202 tool-bar. Example `M-x C-h C-h C-g'. */
13203 goto finish_menu_bars
;
13205 /* We've already displayed the echo area glyphs in this window. */
13206 goto finish_scroll_bars
;
13208 else if ((w
!= XWINDOW (minibuf_window
)
13209 || minibuf_level
== 0)
13210 /* When buffer is nonempty, redisplay window normally. */
13211 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
13212 /* Quail displays non-mini buffers in minibuffer window.
13213 In that case, redisplay the window normally. */
13214 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
13216 /* W is a mini-buffer window, but it's not active, so clear
13218 int yb
= window_text_bottom_y (w
);
13219 struct glyph_row
*row
;
13222 for (y
= 0, row
= w
->desired_matrix
->rows
;
13224 y
+= row
->height
, ++row
)
13225 blank_row (w
, row
, y
);
13226 goto finish_scroll_bars
;
13229 clear_glyph_matrix (w
->desired_matrix
);
13232 /* Otherwise set up data on this window; select its buffer and point
13234 /* Really select the buffer, for the sake of buffer-local
13236 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13238 current_matrix_up_to_date_p
13239 = (!NILP (w
->window_end_valid
)
13240 && !current_buffer
->clip_changed
13241 && !current_buffer
->prevent_redisplay_optimizations_p
13242 && XFASTINT (w
->last_modified
) >= MODIFF
13243 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13245 /* Run the window-bottom-change-functions
13246 if it is possible that the text on the screen has changed
13247 (either due to modification of the text, or any other reason). */
13248 if (!current_matrix_up_to_date_p
13249 && !NILP (Vwindow_text_change_functions
))
13251 safe_run_hooks (Qwindow_text_change_functions
);
13255 beg_unchanged
= BEG_UNCHANGED
;
13256 end_unchanged
= END_UNCHANGED
;
13258 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
13260 specbind (Qinhibit_point_motion_hooks
, Qt
);
13263 = (!NILP (w
->window_end_valid
)
13264 && !current_buffer
->clip_changed
13265 && XFASTINT (w
->last_modified
) >= MODIFF
13266 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13268 /* When windows_or_buffers_changed is non-zero, we can't rely on
13269 the window end being valid, so set it to nil there. */
13270 if (windows_or_buffers_changed
)
13272 /* If window starts on a continuation line, maybe adjust the
13273 window start in case the window's width changed. */
13274 if (XMARKER (w
->start
)->buffer
== current_buffer
)
13275 compute_window_start_on_continuation_line (w
);
13277 w
->window_end_valid
= Qnil
;
13280 /* Some sanity checks. */
13281 CHECK_WINDOW_END (w
);
13282 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
13284 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
13287 /* If %c is in mode line, update it if needed. */
13288 if (!NILP (w
->column_number_displayed
)
13289 /* This alternative quickly identifies a common case
13290 where no change is needed. */
13291 && !(PT
== XFASTINT (w
->last_point
)
13292 && XFASTINT (w
->last_modified
) >= MODIFF
13293 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
13294 && (XFASTINT (w
->column_number_displayed
)
13295 != (int) current_column ())) /* iftc */
13296 update_mode_line
= 1;
13298 /* Count number of windows showing the selected buffer. An indirect
13299 buffer counts as its base buffer. */
13300 if (!just_this_one_p
)
13302 struct buffer
*current_base
, *window_base
;
13303 current_base
= current_buffer
;
13304 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13305 if (current_base
->base_buffer
)
13306 current_base
= current_base
->base_buffer
;
13307 if (window_base
->base_buffer
)
13308 window_base
= window_base
->base_buffer
;
13309 if (current_base
== window_base
)
13313 /* Point refers normally to the selected window. For any other
13314 window, set up appropriate value. */
13315 if (!EQ (window
, selected_window
))
13317 int new_pt
= XMARKER (w
->pointm
)->charpos
;
13318 int new_pt_byte
= marker_byte_position (w
->pointm
);
13322 new_pt_byte
= BEGV_BYTE
;
13323 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
13325 else if (new_pt
> (ZV
- 1))
13328 new_pt_byte
= ZV_BYTE
;
13329 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
13332 /* We don't use SET_PT so that the point-motion hooks don't run. */
13333 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
13336 /* If any of the character widths specified in the display table
13337 have changed, invalidate the width run cache. It's true that
13338 this may be a bit late to catch such changes, but the rest of
13339 redisplay goes (non-fatally) haywire when the display table is
13340 changed, so why should we worry about doing any better? */
13341 if (current_buffer
->width_run_cache
)
13343 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
13345 if (! disptab_matches_widthtab (disptab
,
13346 XVECTOR (current_buffer
->width_table
)))
13348 invalidate_region_cache (current_buffer
,
13349 current_buffer
->width_run_cache
,
13351 recompute_width_table (current_buffer
, disptab
);
13355 /* If window-start is screwed up, choose a new one. */
13356 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
13359 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13361 /* If someone specified a new starting point but did not insist,
13362 check whether it can be used. */
13363 if (!NILP (w
->optional_new_start
)
13364 && CHARPOS (startp
) >= BEGV
13365 && CHARPOS (startp
) <= ZV
)
13367 w
->optional_new_start
= Qnil
;
13368 start_display (&it
, w
, startp
);
13369 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
13370 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13371 if (IT_CHARPOS (it
) == PT
)
13372 w
->force_start
= Qt
;
13373 /* IT may overshoot PT if text at PT is invisible. */
13374 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
13375 w
->force_start
= Qt
;
13380 /* Handle case where place to start displaying has been specified,
13381 unless the specified location is outside the accessible range. */
13382 if (!NILP (w
->force_start
)
13383 || w
->frozen_window_start_p
)
13385 /* We set this later on if we have to adjust point. */
13388 w
->force_start
= Qnil
;
13390 w
->window_end_valid
= Qnil
;
13392 /* Forget any recorded base line for line number display. */
13393 if (!buffer_unchanged_p
)
13394 w
->base_line_number
= Qnil
;
13396 /* Redisplay the mode line. Select the buffer properly for that.
13397 Also, run the hook window-scroll-functions
13398 because we have scrolled. */
13399 /* Note, we do this after clearing force_start because
13400 if there's an error, it is better to forget about force_start
13401 than to get into an infinite loop calling the hook functions
13402 and having them get more errors. */
13403 if (!update_mode_line
13404 || ! NILP (Vwindow_scroll_functions
))
13406 update_mode_line
= 1;
13407 w
->update_mode_line
= Qt
;
13408 startp
= run_window_scroll_functions (window
, startp
);
13411 w
->last_modified
= make_number (0);
13412 w
->last_overlay_modified
= make_number (0);
13413 if (CHARPOS (startp
) < BEGV
)
13414 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
13415 else if (CHARPOS (startp
) > ZV
)
13416 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
13418 /* Redisplay, then check if cursor has been set during the
13419 redisplay. Give up if new fonts were loaded. */
13420 /* We used to issue a CHECK_MARGINS argument to try_window here,
13421 but this causes scrolling to fail when point begins inside
13422 the scroll margin (bug#148) -- cyd */
13423 if (!try_window (window
, startp
, 0))
13425 w
->force_start
= Qt
;
13426 clear_glyph_matrix (w
->desired_matrix
);
13427 goto need_larger_matrices
;
13430 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
13432 /* If point does not appear, try to move point so it does
13433 appear. The desired matrix has been built above, so we
13434 can use it here. */
13435 new_vpos
= window_box_height (w
) / 2;
13438 if (!cursor_row_fully_visible_p (w
, 0, 0))
13440 /* Point does appear, but on a line partly visible at end of window.
13441 Move it back to a fully-visible line. */
13442 new_vpos
= window_box_height (w
);
13445 /* If we need to move point for either of the above reasons,
13446 now actually do it. */
13449 struct glyph_row
*row
;
13451 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
13452 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
13455 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
13456 MATRIX_ROW_START_BYTEPOS (row
));
13458 if (w
!= XWINDOW (selected_window
))
13459 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
13460 else if (current_buffer
== old
)
13461 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13463 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
13465 /* If we are highlighting the region, then we just changed
13466 the region, so redisplay to show it. */
13467 if (!NILP (Vtransient_mark_mode
)
13468 && !NILP (current_buffer
->mark_active
))
13470 clear_glyph_matrix (w
->desired_matrix
);
13471 if (!try_window (window
, startp
, 0))
13472 goto need_larger_matrices
;
13477 debug_method_add (w
, "forced window start");
13482 /* Handle case where text has not changed, only point, and it has
13483 not moved off the frame, and we are not retrying after hscroll.
13484 (current_matrix_up_to_date_p is nonzero when retrying.) */
13485 if (current_matrix_up_to_date_p
13486 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
13487 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
13491 case CURSOR_MOVEMENT_SUCCESS
:
13492 used_current_matrix_p
= 1;
13495 case CURSOR_MOVEMENT_MUST_SCROLL
:
13496 goto try_to_scroll
;
13502 /* If current starting point was originally the beginning of a line
13503 but no longer is, find a new starting point. */
13504 else if (!NILP (w
->start_at_line_beg
)
13505 && !(CHARPOS (startp
) <= BEGV
13506 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
13509 debug_method_add (w
, "recenter 1");
13514 /* Try scrolling with try_window_id. Value is > 0 if update has
13515 been done, it is -1 if we know that the same window start will
13516 not work. It is 0 if unsuccessful for some other reason. */
13517 else if ((tem
= try_window_id (w
)) != 0)
13520 debug_method_add (w
, "try_window_id %d", tem
);
13523 if (fonts_changed_p
)
13524 goto need_larger_matrices
;
13528 /* Otherwise try_window_id has returned -1 which means that we
13529 don't want the alternative below this comment to execute. */
13531 else if (CHARPOS (startp
) >= BEGV
13532 && CHARPOS (startp
) <= ZV
13533 && PT
>= CHARPOS (startp
)
13534 && (CHARPOS (startp
) < ZV
13535 /* Avoid starting at end of buffer. */
13536 || CHARPOS (startp
) == BEGV
13537 || (XFASTINT (w
->last_modified
) >= MODIFF
13538 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
13541 /* If first window line is a continuation line, and window start
13542 is inside the modified region, but the first change is before
13543 current window start, we must select a new window start.
13545 However, if this is the result of a down-mouse event (e.g. by
13546 extending the mouse-drag-overlay), we don't want to select a
13547 new window start, since that would change the position under
13548 the mouse, resulting in an unwanted mouse-movement rather
13549 than a simple mouse-click. */
13550 if (NILP (w
->start_at_line_beg
)
13551 && NILP (do_mouse_tracking
)
13552 && CHARPOS (startp
) > BEGV
13553 && CHARPOS (startp
) > BEG
+ beg_unchanged
13554 && CHARPOS (startp
) <= Z
- end_unchanged
13555 /* Even if w->start_at_line_beg is nil, a new window may
13556 start at a line_beg, since that's how set_buffer_window
13557 sets it. So, we need to check the return value of
13558 compute_window_start_on_continuation_line. (See also
13560 && XMARKER (w
->start
)->buffer
== current_buffer
13561 && compute_window_start_on_continuation_line (w
))
13563 w
->force_start
= Qt
;
13564 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13569 debug_method_add (w
, "same window start");
13572 /* Try to redisplay starting at same place as before.
13573 If point has not moved off frame, accept the results. */
13574 if (!current_matrix_up_to_date_p
13575 /* Don't use try_window_reusing_current_matrix in this case
13576 because a window scroll function can have changed the
13578 || !NILP (Vwindow_scroll_functions
)
13579 || MINI_WINDOW_P (w
)
13580 || !(used_current_matrix_p
13581 = try_window_reusing_current_matrix (w
)))
13583 IF_DEBUG (debug_method_add (w
, "1"));
13584 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
13585 /* -1 means we need to scroll.
13586 0 means we need new matrices, but fonts_changed_p
13587 is set in that case, so we will detect it below. */
13588 goto try_to_scroll
;
13591 if (fonts_changed_p
)
13592 goto need_larger_matrices
;
13594 if (w
->cursor
.vpos
>= 0)
13596 if (!just_this_one_p
13597 || current_buffer
->clip_changed
13598 || BEG_UNCHANGED
< CHARPOS (startp
))
13599 /* Forget any recorded base line for line number display. */
13600 w
->base_line_number
= Qnil
;
13602 if (!cursor_row_fully_visible_p (w
, 1, 0))
13604 clear_glyph_matrix (w
->desired_matrix
);
13605 last_line_misfit
= 1;
13607 /* Drop through and scroll. */
13612 clear_glyph_matrix (w
->desired_matrix
);
13617 w
->last_modified
= make_number (0);
13618 w
->last_overlay_modified
= make_number (0);
13620 /* Redisplay the mode line. Select the buffer properly for that. */
13621 if (!update_mode_line
)
13623 update_mode_line
= 1;
13624 w
->update_mode_line
= Qt
;
13627 /* Try to scroll by specified few lines. */
13628 if ((scroll_conservatively
13630 || temp_scroll_step
13631 || NUMBERP (current_buffer
->scroll_up_aggressively
)
13632 || NUMBERP (current_buffer
->scroll_down_aggressively
))
13633 && !current_buffer
->clip_changed
13634 && CHARPOS (startp
) >= BEGV
13635 && CHARPOS (startp
) <= ZV
)
13637 /* The function returns -1 if new fonts were loaded, 1 if
13638 successful, 0 if not successful. */
13639 int rc
= try_scrolling (window
, just_this_one_p
,
13640 scroll_conservatively
,
13642 temp_scroll_step
, last_line_misfit
);
13645 case SCROLLING_SUCCESS
:
13648 case SCROLLING_NEED_LARGER_MATRICES
:
13649 goto need_larger_matrices
;
13651 case SCROLLING_FAILED
:
13659 /* Finally, just choose place to start which centers point */
13662 if (centering_position
< 0)
13663 centering_position
= window_box_height (w
) / 2;
13666 debug_method_add (w
, "recenter");
13669 /* w->vscroll = 0; */
13671 /* Forget any previously recorded base line for line number display. */
13672 if (!buffer_unchanged_p
)
13673 w
->base_line_number
= Qnil
;
13675 /* Move backward half the height of the window. */
13676 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
13677 it
.current_y
= it
.last_visible_y
;
13678 move_it_vertically_backward (&it
, centering_position
);
13679 xassert (IT_CHARPOS (it
) >= BEGV
);
13681 /* The function move_it_vertically_backward may move over more
13682 than the specified y-distance. If it->w is small, e.g. a
13683 mini-buffer window, we may end up in front of the window's
13684 display area. Start displaying at the start of the line
13685 containing PT in this case. */
13686 if (it
.current_y
<= 0)
13688 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
13689 move_it_vertically_backward (&it
, 0);
13693 it
.current_x
= it
.hpos
= 0;
13695 /* Set startp here explicitly in case that helps avoid an infinite loop
13696 in case the window-scroll-functions functions get errors. */
13697 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
13699 /* Run scroll hooks. */
13700 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
13702 /* Redisplay the window. */
13703 if (!current_matrix_up_to_date_p
13704 || windows_or_buffers_changed
13705 || cursor_type_changed
13706 /* Don't use try_window_reusing_current_matrix in this case
13707 because it can have changed the buffer. */
13708 || !NILP (Vwindow_scroll_functions
)
13709 || !just_this_one_p
13710 || MINI_WINDOW_P (w
)
13711 || !(used_current_matrix_p
13712 = try_window_reusing_current_matrix (w
)))
13713 try_window (window
, startp
, 0);
13715 /* If new fonts have been loaded (due to fontsets), give up. We
13716 have to start a new redisplay since we need to re-adjust glyph
13718 if (fonts_changed_p
)
13719 goto need_larger_matrices
;
13721 /* If cursor did not appear assume that the middle of the window is
13722 in the first line of the window. Do it again with the next line.
13723 (Imagine a window of height 100, displaying two lines of height
13724 60. Moving back 50 from it->last_visible_y will end in the first
13726 if (w
->cursor
.vpos
< 0)
13728 if (!NILP (w
->window_end_valid
)
13729 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
13731 clear_glyph_matrix (w
->desired_matrix
);
13732 move_it_by_lines (&it
, 1, 0);
13733 try_window (window
, it
.current
.pos
, 0);
13735 else if (PT
< IT_CHARPOS (it
))
13737 clear_glyph_matrix (w
->desired_matrix
);
13738 move_it_by_lines (&it
, -1, 0);
13739 try_window (window
, it
.current
.pos
, 0);
13743 /* Not much we can do about it. */
13747 /* Consider the following case: Window starts at BEGV, there is
13748 invisible, intangible text at BEGV, so that display starts at
13749 some point START > BEGV. It can happen that we are called with
13750 PT somewhere between BEGV and START. Try to handle that case. */
13751 if (w
->cursor
.vpos
< 0)
13753 struct glyph_row
*row
= w
->current_matrix
->rows
;
13754 if (row
->mode_line_p
)
13756 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13759 if (!cursor_row_fully_visible_p (w
, 0, 0))
13761 /* If vscroll is enabled, disable it and try again. */
13765 clear_glyph_matrix (w
->desired_matrix
);
13769 /* If centering point failed to make the whole line visible,
13770 put point at the top instead. That has to make the whole line
13771 visible, if it can be done. */
13772 if (centering_position
== 0)
13775 clear_glyph_matrix (w
->desired_matrix
);
13776 centering_position
= 0;
13782 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13783 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
13784 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
13787 /* Display the mode line, if we must. */
13788 if ((update_mode_line
13789 /* If window not full width, must redo its mode line
13790 if (a) the window to its side is being redone and
13791 (b) we do a frame-based redisplay. This is a consequence
13792 of how inverted lines are drawn in frame-based redisplay. */
13793 || (!just_this_one_p
13794 && !FRAME_WINDOW_P (f
)
13795 && !WINDOW_FULL_WIDTH_P (w
))
13796 /* Line number to display. */
13797 || INTEGERP (w
->base_line_pos
)
13798 /* Column number is displayed and different from the one displayed. */
13799 || (!NILP (w
->column_number_displayed
)
13800 && (XFASTINT (w
->column_number_displayed
)
13801 != (int) current_column ()))) /* iftc */
13802 /* This means that the window has a mode line. */
13803 && (WINDOW_WANTS_MODELINE_P (w
)
13804 || WINDOW_WANTS_HEADER_LINE_P (w
)))
13806 display_mode_lines (w
);
13808 /* If mode line height has changed, arrange for a thorough
13809 immediate redisplay using the correct mode line height. */
13810 if (WINDOW_WANTS_MODELINE_P (w
)
13811 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
13813 fonts_changed_p
= 1;
13814 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
13815 = DESIRED_MODE_LINE_HEIGHT (w
);
13818 /* If header line height has changed, arrange for a thorough
13819 immediate redisplay using the correct header line height. */
13820 if (WINDOW_WANTS_HEADER_LINE_P (w
)
13821 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
13823 fonts_changed_p
= 1;
13824 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
13825 = DESIRED_HEADER_LINE_HEIGHT (w
);
13828 if (fonts_changed_p
)
13829 goto need_larger_matrices
;
13832 if (!line_number_displayed
13833 && !BUFFERP (w
->base_line_pos
))
13835 w
->base_line_pos
= Qnil
;
13836 w
->base_line_number
= Qnil
;
13841 /* When we reach a frame's selected window, redo the frame's menu bar. */
13842 if (update_mode_line
13843 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
13845 int redisplay_menu_p
= 0;
13846 int redisplay_tool_bar_p
= 0;
13848 if (FRAME_WINDOW_P (f
))
13850 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
13851 || defined (HAVE_NS) || defined (USE_GTK)
13852 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
13854 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
13858 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
13860 if (redisplay_menu_p
)
13861 display_menu_bar (w
);
13863 #ifdef HAVE_WINDOW_SYSTEM
13864 if (FRAME_WINDOW_P (f
))
13866 #if defined (USE_GTK) || defined (HAVE_NS)
13867 redisplay_tool_bar_p
= FRAME_EXTERNAL_TOOL_BAR (f
);
13869 redisplay_tool_bar_p
= WINDOWP (f
->tool_bar_window
)
13870 && (FRAME_TOOL_BAR_LINES (f
) > 0
13871 || !NILP (Vauto_resize_tool_bars
));
13874 if (redisplay_tool_bar_p
&& redisplay_tool_bar (f
))
13876 extern int ignore_mouse_drag_p
;
13877 ignore_mouse_drag_p
= 1;
13883 #ifdef HAVE_WINDOW_SYSTEM
13884 if (FRAME_WINDOW_P (f
)
13885 && update_window_fringes (w
, (just_this_one_p
13886 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
13887 || w
->pseudo_window_p
)))
13891 if (draw_window_fringes (w
, 1))
13892 x_draw_vertical_border (w
);
13896 #endif /* HAVE_WINDOW_SYSTEM */
13898 /* We go to this label, with fonts_changed_p nonzero,
13899 if it is necessary to try again using larger glyph matrices.
13900 We have to redeem the scroll bar even in this case,
13901 because the loop in redisplay_internal expects that. */
13902 need_larger_matrices
:
13904 finish_scroll_bars
:
13906 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
13908 /* Set the thumb's position and size. */
13909 set_vertical_scroll_bar (w
);
13911 /* Note that we actually used the scroll bar attached to this
13912 window, so it shouldn't be deleted at the end of redisplay. */
13913 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
13914 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
13917 /* Restore current_buffer and value of point in it. The window
13918 update may have changed the buffer, so first make sure `opoint'
13919 is still valid (Bug#6177). */
13920 if (CHARPOS (opoint
) < BEGV
)
13921 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
13922 else if (CHARPOS (opoint
) > ZV
)
13923 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
13925 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
13927 set_buffer_internal_1 (old
);
13928 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
13929 shorter. This can be caused by log truncation in *Messages*. */
13930 if (CHARPOS (lpoint
) <= ZV
)
13931 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
13933 unbind_to (count
, Qnil
);
13937 /* Build the complete desired matrix of WINDOW with a window start
13938 buffer position POS.
13940 Value is 1 if successful. It is zero if fonts were loaded during
13941 redisplay which makes re-adjusting glyph matrices necessary, and -1
13942 if point would appear in the scroll margins.
13943 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
13944 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
13948 try_window (window
, pos
, flags
)
13949 Lisp_Object window
;
13950 struct text_pos pos
;
13953 struct window
*w
= XWINDOW (window
);
13955 struct glyph_row
*last_text_row
= NULL
;
13956 struct frame
*f
= XFRAME (w
->frame
);
13958 /* Make POS the new window start. */
13959 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
13961 /* Mark cursor position as unknown. No overlay arrow seen. */
13962 w
->cursor
.vpos
= -1;
13963 overlay_arrow_seen
= 0;
13965 /* Initialize iterator and info to start at POS. */
13966 start_display (&it
, w
, pos
);
13968 /* Display all lines of W. */
13969 while (it
.current_y
< it
.last_visible_y
)
13971 if (display_line (&it
))
13972 last_text_row
= it
.glyph_row
- 1;
13973 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
13977 /* Don't let the cursor end in the scroll margins. */
13978 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
13979 && !MINI_WINDOW_P (w
))
13981 int this_scroll_margin
;
13983 if (scroll_margin
> 0)
13985 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
13986 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
13989 this_scroll_margin
= 0;
13991 if ((w
->cursor
.y
>= 0 /* not vscrolled */
13992 && w
->cursor
.y
< this_scroll_margin
13993 && CHARPOS (pos
) > BEGV
13994 && IT_CHARPOS (it
) < ZV
)
13995 /* rms: considering make_cursor_line_fully_visible_p here
13996 seems to give wrong results. We don't want to recenter
13997 when the last line is partly visible, we want to allow
13998 that case to be handled in the usual way. */
13999 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
14001 w
->cursor
.vpos
= -1;
14002 clear_glyph_matrix (w
->desired_matrix
);
14007 /* If bottom moved off end of frame, change mode line percentage. */
14008 if (XFASTINT (w
->window_end_pos
) <= 0
14009 && Z
!= IT_CHARPOS (it
))
14010 w
->update_mode_line
= Qt
;
14012 /* Set window_end_pos to the offset of the last character displayed
14013 on the window from the end of current_buffer. Set
14014 window_end_vpos to its row number. */
14017 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
14018 w
->window_end_bytepos
14019 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14021 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14023 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14024 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
14025 ->displays_text_p
);
14029 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14030 w
->window_end_pos
= make_number (Z
- ZV
);
14031 w
->window_end_vpos
= make_number (0);
14034 /* But that is not valid info until redisplay finishes. */
14035 w
->window_end_valid
= Qnil
;
14041 /************************************************************************
14042 Window redisplay reusing current matrix when buffer has not changed
14043 ************************************************************************/
14045 /* Try redisplay of window W showing an unchanged buffer with a
14046 different window start than the last time it was displayed by
14047 reusing its current matrix. Value is non-zero if successful.
14048 W->start is the new window start. */
14051 try_window_reusing_current_matrix (w
)
14054 struct frame
*f
= XFRAME (w
->frame
);
14055 struct glyph_row
*row
, *bottom_row
;
14058 struct text_pos start
, new_start
;
14059 int nrows_scrolled
, i
;
14060 struct glyph_row
*last_text_row
;
14061 struct glyph_row
*last_reused_text_row
;
14062 struct glyph_row
*start_row
;
14063 int start_vpos
, min_y
, max_y
;
14066 if (inhibit_try_window_reusing
)
14070 if (/* This function doesn't handle terminal frames. */
14071 !FRAME_WINDOW_P (f
)
14072 /* Don't try to reuse the display if windows have been split
14074 || windows_or_buffers_changed
14075 || cursor_type_changed
)
14078 /* Can't do this if region may have changed. */
14079 if ((!NILP (Vtransient_mark_mode
)
14080 && !NILP (current_buffer
->mark_active
))
14081 || !NILP (w
->region_showing
)
14082 || !NILP (Vshow_trailing_whitespace
))
14085 /* If top-line visibility has changed, give up. */
14086 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14087 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
14090 /* Give up if old or new display is scrolled vertically. We could
14091 make this function handle this, but right now it doesn't. */
14092 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14093 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
14096 /* The variable new_start now holds the new window start. The old
14097 start `start' can be determined from the current matrix. */
14098 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
14099 start
= start_row
->start
.pos
;
14100 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14102 /* Clear the desired matrix for the display below. */
14103 clear_glyph_matrix (w
->desired_matrix
);
14105 if (CHARPOS (new_start
) <= CHARPOS (start
))
14109 /* Don't use this method if the display starts with an ellipsis
14110 displayed for invisible text. It's not easy to handle that case
14111 below, and it's certainly not worth the effort since this is
14112 not a frequent case. */
14113 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
14116 IF_DEBUG (debug_method_add (w
, "twu1"));
14118 /* Display up to a row that can be reused. The variable
14119 last_text_row is set to the last row displayed that displays
14120 text. Note that it.vpos == 0 if or if not there is a
14121 header-line; it's not the same as the MATRIX_ROW_VPOS! */
14122 start_display (&it
, w
, new_start
);
14123 first_row_y
= it
.current_y
;
14124 w
->cursor
.vpos
= -1;
14125 last_text_row
= last_reused_text_row
= NULL
;
14127 while (it
.current_y
< it
.last_visible_y
14128 && !fonts_changed_p
)
14130 /* If we have reached into the characters in the START row,
14131 that means the line boundaries have changed. So we
14132 can't start copying with the row START. Maybe it will
14133 work to start copying with the following row. */
14134 while (IT_CHARPOS (it
) > CHARPOS (start
))
14136 /* Advance to the next row as the "start". */
14138 start
= start_row
->start
.pos
;
14139 /* If there are no more rows to try, or just one, give up. */
14140 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
14141 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
14142 || CHARPOS (start
) == ZV
)
14144 clear_glyph_matrix (w
->desired_matrix
);
14148 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14150 /* If we have reached alignment,
14151 we can copy the rest of the rows. */
14152 if (IT_CHARPOS (it
) == CHARPOS (start
))
14155 if (display_line (&it
))
14156 last_text_row
= it
.glyph_row
- 1;
14159 /* A value of current_y < last_visible_y means that we stopped
14160 at the previous window start, which in turn means that we
14161 have at least one reusable row. */
14162 if (it
.current_y
< it
.last_visible_y
)
14164 /* IT.vpos always starts from 0; it counts text lines. */
14165 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
14167 /* Find PT if not already found in the lines displayed. */
14168 if (w
->cursor
.vpos
< 0)
14170 int dy
= it
.current_y
- start_row
->y
;
14172 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14173 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
14175 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
14176 dy
, nrows_scrolled
);
14179 clear_glyph_matrix (w
->desired_matrix
);
14184 /* Scroll the display. Do it before the current matrix is
14185 changed. The problem here is that update has not yet
14186 run, i.e. part of the current matrix is not up to date.
14187 scroll_run_hook will clear the cursor, and use the
14188 current matrix to get the height of the row the cursor is
14190 run
.current_y
= start_row
->y
;
14191 run
.desired_y
= it
.current_y
;
14192 run
.height
= it
.last_visible_y
- it
.current_y
;
14194 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
14197 FRAME_RIF (f
)->update_window_begin_hook (w
);
14198 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14199 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14200 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14204 /* Shift current matrix down by nrows_scrolled lines. */
14205 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14206 rotate_matrix (w
->current_matrix
,
14208 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14211 /* Disable lines that must be updated. */
14212 for (i
= 0; i
< nrows_scrolled
; ++i
)
14213 (start_row
+ i
)->enabled_p
= 0;
14215 /* Re-compute Y positions. */
14216 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14217 max_y
= it
.last_visible_y
;
14218 for (row
= start_row
+ nrows_scrolled
;
14222 row
->y
= it
.current_y
;
14223 row
->visible_height
= row
->height
;
14225 if (row
->y
< min_y
)
14226 row
->visible_height
-= min_y
- row
->y
;
14227 if (row
->y
+ row
->height
> max_y
)
14228 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14229 row
->redraw_fringe_bitmaps_p
= 1;
14231 it
.current_y
+= row
->height
;
14233 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14234 last_reused_text_row
= row
;
14235 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
14239 /* Disable lines in the current matrix which are now
14240 below the window. */
14241 for (++row
; row
< bottom_row
; ++row
)
14242 row
->enabled_p
= row
->mode_line_p
= 0;
14245 /* Update window_end_pos etc.; last_reused_text_row is the last
14246 reused row from the current matrix containing text, if any.
14247 The value of last_text_row is the last displayed line
14248 containing text. */
14249 if (last_reused_text_row
)
14251 w
->window_end_bytepos
14252 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
14254 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
14256 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
14257 w
->current_matrix
));
14259 else if (last_text_row
)
14261 w
->window_end_bytepos
14262 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14264 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14266 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14270 /* This window must be completely empty. */
14271 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14272 w
->window_end_pos
= make_number (Z
- ZV
);
14273 w
->window_end_vpos
= make_number (0);
14275 w
->window_end_valid
= Qnil
;
14277 /* Update hint: don't try scrolling again in update_window. */
14278 w
->desired_matrix
->no_scrolling_p
= 1;
14281 debug_method_add (w
, "try_window_reusing_current_matrix 1");
14285 else if (CHARPOS (new_start
) > CHARPOS (start
))
14287 struct glyph_row
*pt_row
, *row
;
14288 struct glyph_row
*first_reusable_row
;
14289 struct glyph_row
*first_row_to_display
;
14291 int yb
= window_text_bottom_y (w
);
14293 /* Find the row starting at new_start, if there is one. Don't
14294 reuse a partially visible line at the end. */
14295 first_reusable_row
= start_row
;
14296 while (first_reusable_row
->enabled_p
14297 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
14298 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14299 < CHARPOS (new_start
)))
14300 ++first_reusable_row
;
14302 /* Give up if there is no row to reuse. */
14303 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
14304 || !first_reusable_row
->enabled_p
14305 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14306 != CHARPOS (new_start
)))
14309 /* We can reuse fully visible rows beginning with
14310 first_reusable_row to the end of the window. Set
14311 first_row_to_display to the first row that cannot be reused.
14312 Set pt_row to the row containing point, if there is any. */
14314 for (first_row_to_display
= first_reusable_row
;
14315 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
14316 ++first_row_to_display
)
14318 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
14319 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
14320 pt_row
= first_row_to_display
;
14323 /* Start displaying at the start of first_row_to_display. */
14324 xassert (first_row_to_display
->y
< yb
);
14325 init_to_row_start (&it
, w
, first_row_to_display
);
14327 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
14329 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
14331 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
14332 + WINDOW_HEADER_LINE_HEIGHT (w
));
14334 /* Display lines beginning with first_row_to_display in the
14335 desired matrix. Set last_text_row to the last row displayed
14336 that displays text. */
14337 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
14338 if (pt_row
== NULL
)
14339 w
->cursor
.vpos
= -1;
14340 last_text_row
= NULL
;
14341 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
14342 if (display_line (&it
))
14343 last_text_row
= it
.glyph_row
- 1;
14345 /* If point is in a reused row, adjust y and vpos of the cursor
14349 w
->cursor
.vpos
-= nrows_scrolled
;
14350 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
14353 /* Give up if point isn't in a row displayed or reused. (This
14354 also handles the case where w->cursor.vpos < nrows_scrolled
14355 after the calls to display_line, which can happen with scroll
14356 margins. See bug#1295.) */
14357 if (w
->cursor
.vpos
< 0)
14359 clear_glyph_matrix (w
->desired_matrix
);
14363 /* Scroll the display. */
14364 run
.current_y
= first_reusable_row
->y
;
14365 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14366 run
.height
= it
.last_visible_y
- run
.current_y
;
14367 dy
= run
.current_y
- run
.desired_y
;
14372 FRAME_RIF (f
)->update_window_begin_hook (w
);
14373 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14374 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14375 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14379 /* Adjust Y positions of reused rows. */
14380 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14381 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14382 max_y
= it
.last_visible_y
;
14383 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
14386 row
->visible_height
= row
->height
;
14387 if (row
->y
< min_y
)
14388 row
->visible_height
-= min_y
- row
->y
;
14389 if (row
->y
+ row
->height
> max_y
)
14390 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14391 row
->redraw_fringe_bitmaps_p
= 1;
14394 /* Scroll the current matrix. */
14395 xassert (nrows_scrolled
> 0);
14396 rotate_matrix (w
->current_matrix
,
14398 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14401 /* Disable rows not reused. */
14402 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
14403 row
->enabled_p
= 0;
14405 /* Point may have moved to a different line, so we cannot assume that
14406 the previous cursor position is valid; locate the correct row. */
14409 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
14410 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
14414 w
->cursor
.y
= row
->y
;
14416 if (row
< bottom_row
)
14418 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
14419 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
14422 && (!BUFFERP (glyph
->object
)
14423 || glyph
->charpos
< PT
);
14427 w
->cursor
.x
+= glyph
->pixel_width
;
14432 /* Adjust window end. A null value of last_text_row means that
14433 the window end is in reused rows which in turn means that
14434 only its vpos can have changed. */
14437 w
->window_end_bytepos
14438 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14440 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14442 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14447 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
14450 w
->window_end_valid
= Qnil
;
14451 w
->desired_matrix
->no_scrolling_p
= 1;
14454 debug_method_add (w
, "try_window_reusing_current_matrix 2");
14464 /************************************************************************
14465 Window redisplay reusing current matrix when buffer has changed
14466 ************************************************************************/
14468 static struct glyph_row
*find_last_unchanged_at_beg_row
P_ ((struct window
*));
14469 static struct glyph_row
*find_first_unchanged_at_end_row
P_ ((struct window
*,
14471 static struct glyph_row
*
14472 find_last_row_displaying_text
P_ ((struct glyph_matrix
*, struct it
*,
14473 struct glyph_row
*));
14476 /* Return the last row in MATRIX displaying text. If row START is
14477 non-null, start searching with that row. IT gives the dimensions
14478 of the display. Value is null if matrix is empty; otherwise it is
14479 a pointer to the row found. */
14481 static struct glyph_row
*
14482 find_last_row_displaying_text (matrix
, it
, start
)
14483 struct glyph_matrix
*matrix
;
14485 struct glyph_row
*start
;
14487 struct glyph_row
*row
, *row_found
;
14489 /* Set row_found to the last row in IT->w's current matrix
14490 displaying text. The loop looks funny but think of partially
14493 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
14494 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14496 xassert (row
->enabled_p
);
14498 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
14507 /* Return the last row in the current matrix of W that is not affected
14508 by changes at the start of current_buffer that occurred since W's
14509 current matrix was built. Value is null if no such row exists.
14511 BEG_UNCHANGED us the number of characters unchanged at the start of
14512 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
14513 first changed character in current_buffer. Characters at positions <
14514 BEG + BEG_UNCHANGED are at the same buffer positions as they were
14515 when the current matrix was built. */
14517 static struct glyph_row
*
14518 find_last_unchanged_at_beg_row (w
)
14521 int first_changed_pos
= BEG
+ BEG_UNCHANGED
;
14522 struct glyph_row
*row
;
14523 struct glyph_row
*row_found
= NULL
;
14524 int yb
= window_text_bottom_y (w
);
14526 /* Find the last row displaying unchanged text. */
14527 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14528 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
14529 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
14532 if (/* If row ends before first_changed_pos, it is unchanged,
14533 except in some case. */
14534 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
14535 /* When row ends in ZV and we write at ZV it is not
14537 && !row
->ends_at_zv_p
14538 /* When first_changed_pos is the end of a continued line,
14539 row is not unchanged because it may be no longer
14541 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
14542 && (row
->continued_p
14543 || row
->exact_window_width_line_p
)))
14546 /* Stop if last visible row. */
14547 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
14555 /* Find the first glyph row in the current matrix of W that is not
14556 affected by changes at the end of current_buffer since the
14557 time W's current matrix was built.
14559 Return in *DELTA the number of chars by which buffer positions in
14560 unchanged text at the end of current_buffer must be adjusted.
14562 Return in *DELTA_BYTES the corresponding number of bytes.
14564 Value is null if no such row exists, i.e. all rows are affected by
14567 static struct glyph_row
*
14568 find_first_unchanged_at_end_row (w
, delta
, delta_bytes
)
14570 int *delta
, *delta_bytes
;
14572 struct glyph_row
*row
;
14573 struct glyph_row
*row_found
= NULL
;
14575 *delta
= *delta_bytes
= 0;
14577 /* Display must not have been paused, otherwise the current matrix
14578 is not up to date. */
14579 eassert (!NILP (w
->window_end_valid
));
14581 /* A value of window_end_pos >= END_UNCHANGED means that the window
14582 end is in the range of changed text. If so, there is no
14583 unchanged row at the end of W's current matrix. */
14584 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
14587 /* Set row to the last row in W's current matrix displaying text. */
14588 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
14590 /* If matrix is entirely empty, no unchanged row exists. */
14591 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14593 /* The value of row is the last glyph row in the matrix having a
14594 meaningful buffer position in it. The end position of row
14595 corresponds to window_end_pos. This allows us to translate
14596 buffer positions in the current matrix to current buffer
14597 positions for characters not in changed text. */
14598 int Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
14599 int Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
14600 int last_unchanged_pos
, last_unchanged_pos_old
;
14601 struct glyph_row
*first_text_row
14602 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14604 *delta
= Z
- Z_old
;
14605 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
14607 /* Set last_unchanged_pos to the buffer position of the last
14608 character in the buffer that has not been changed. Z is the
14609 index + 1 of the last character in current_buffer, i.e. by
14610 subtracting END_UNCHANGED we get the index of the last
14611 unchanged character, and we have to add BEG to get its buffer
14613 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
14614 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
14616 /* Search backward from ROW for a row displaying a line that
14617 starts at a minimum position >= last_unchanged_pos_old. */
14618 for (; row
> first_text_row
; --row
)
14620 /* This used to abort, but it can happen.
14621 It is ok to just stop the search instead here. KFS. */
14622 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14625 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
14630 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
14636 /* Make sure that glyph rows in the current matrix of window W
14637 reference the same glyph memory as corresponding rows in the
14638 frame's frame matrix. This function is called after scrolling W's
14639 current matrix on a terminal frame in try_window_id and
14640 try_window_reusing_current_matrix. */
14643 sync_frame_with_window_matrix_rows (w
)
14646 struct frame
*f
= XFRAME (w
->frame
);
14647 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
14649 /* Preconditions: W must be a leaf window and full-width. Its frame
14650 must have a frame matrix. */
14651 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
14652 xassert (WINDOW_FULL_WIDTH_P (w
));
14653 xassert (!FRAME_WINDOW_P (f
));
14655 /* If W is a full-width window, glyph pointers in W's current matrix
14656 have, by definition, to be the same as glyph pointers in the
14657 corresponding frame matrix. Note that frame matrices have no
14658 marginal areas (see build_frame_matrix). */
14659 window_row
= w
->current_matrix
->rows
;
14660 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
14661 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
14662 while (window_row
< window_row_end
)
14664 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
14665 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
14667 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
14668 frame_row
->glyphs
[TEXT_AREA
] = start
;
14669 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
14670 frame_row
->glyphs
[LAST_AREA
] = end
;
14672 /* Disable frame rows whose corresponding window rows have
14673 been disabled in try_window_id. */
14674 if (!window_row
->enabled_p
)
14675 frame_row
->enabled_p
= 0;
14677 ++window_row
, ++frame_row
;
14682 /* Find the glyph row in window W containing CHARPOS. Consider all
14683 rows between START and END (not inclusive). END null means search
14684 all rows to the end of the display area of W. Value is the row
14685 containing CHARPOS or null. */
14688 row_containing_pos (w
, charpos
, start
, end
, dy
)
14691 struct glyph_row
*start
, *end
;
14694 struct glyph_row
*row
= start
;
14697 /* If we happen to start on a header-line, skip that. */
14698 if (row
->mode_line_p
)
14701 if ((end
&& row
>= end
) || !row
->enabled_p
)
14704 last_y
= window_text_bottom_y (w
) - dy
;
14708 /* Give up if we have gone too far. */
14709 if (end
&& row
>= end
)
14711 /* This formerly returned if they were equal.
14712 I think that both quantities are of a "last plus one" type;
14713 if so, when they are equal, the row is within the screen. -- rms. */
14714 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
14717 /* If it is in this row, return this row. */
14718 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
14719 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
14720 /* The end position of a row equals the start
14721 position of the next row. If CHARPOS is there, we
14722 would rather display it in the next line, except
14723 when this line ends in ZV. */
14724 && !row
->ends_at_zv_p
14725 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
14726 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
14733 /* Try to redisplay window W by reusing its existing display. W's
14734 current matrix must be up to date when this function is called,
14735 i.e. window_end_valid must not be nil.
14739 1 if display has been updated
14740 0 if otherwise unsuccessful
14741 -1 if redisplay with same window start is known not to succeed
14743 The following steps are performed:
14745 1. Find the last row in the current matrix of W that is not
14746 affected by changes at the start of current_buffer. If no such row
14749 2. Find the first row in W's current matrix that is not affected by
14750 changes at the end of current_buffer. Maybe there is no such row.
14752 3. Display lines beginning with the row + 1 found in step 1 to the
14753 row found in step 2 or, if step 2 didn't find a row, to the end of
14756 4. If cursor is not known to appear on the window, give up.
14758 5. If display stopped at the row found in step 2, scroll the
14759 display and current matrix as needed.
14761 6. Maybe display some lines at the end of W, if we must. This can
14762 happen under various circumstances, like a partially visible line
14763 becoming fully visible, or because newly displayed lines are displayed
14764 in smaller font sizes.
14766 7. Update W's window end information. */
14772 struct frame
*f
= XFRAME (w
->frame
);
14773 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
14774 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
14775 struct glyph_row
*last_unchanged_at_beg_row
;
14776 struct glyph_row
*first_unchanged_at_end_row
;
14777 struct glyph_row
*row
;
14778 struct glyph_row
*bottom_row
;
14781 int delta
= 0, delta_bytes
= 0, stop_pos
, dvpos
, dy
;
14782 struct text_pos start_pos
;
14784 int first_unchanged_at_end_vpos
= 0;
14785 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
14786 struct text_pos start
;
14787 int first_changed_charpos
, last_changed_charpos
;
14790 if (inhibit_try_window_id
)
14794 /* This is handy for debugging. */
14796 #define GIVE_UP(X) \
14798 fprintf (stderr, "try_window_id give up %d\n", (X)); \
14802 #define GIVE_UP(X) return 0
14805 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
14807 /* Don't use this for mini-windows because these can show
14808 messages and mini-buffers, and we don't handle that here. */
14809 if (MINI_WINDOW_P (w
))
14812 /* This flag is used to prevent redisplay optimizations. */
14813 if (windows_or_buffers_changed
|| cursor_type_changed
)
14816 /* Verify that narrowing has not changed.
14817 Also verify that we were not told to prevent redisplay optimizations.
14818 It would be nice to further
14819 reduce the number of cases where this prevents try_window_id. */
14820 if (current_buffer
->clip_changed
14821 || current_buffer
->prevent_redisplay_optimizations_p
)
14824 /* Window must either use window-based redisplay or be full width. */
14825 if (!FRAME_WINDOW_P (f
)
14826 && (!FRAME_LINE_INS_DEL_OK (f
)
14827 || !WINDOW_FULL_WIDTH_P (w
)))
14830 /* Give up if point is known NOT to appear in W. */
14831 if (PT
< CHARPOS (start
))
14834 /* Another way to prevent redisplay optimizations. */
14835 if (XFASTINT (w
->last_modified
) == 0)
14838 /* Verify that window is not hscrolled. */
14839 if (XFASTINT (w
->hscroll
) != 0)
14842 /* Verify that display wasn't paused. */
14843 if (NILP (w
->window_end_valid
))
14846 /* Can't use this if highlighting a region because a cursor movement
14847 will do more than just set the cursor. */
14848 if (!NILP (Vtransient_mark_mode
)
14849 && !NILP (current_buffer
->mark_active
))
14852 /* Likewise if highlighting trailing whitespace. */
14853 if (!NILP (Vshow_trailing_whitespace
))
14856 /* Likewise if showing a region. */
14857 if (!NILP (w
->region_showing
))
14860 /* Can't use this if overlay arrow position and/or string have
14862 if (overlay_arrows_changed_p ())
14865 /* When word-wrap is on, adding a space to the first word of a
14866 wrapped line can change the wrap position, altering the line
14867 above it. It might be worthwhile to handle this more
14868 intelligently, but for now just redisplay from scratch. */
14869 if (!NILP (XBUFFER (w
->buffer
)->word_wrap
))
14872 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
14873 only if buffer has really changed. The reason is that the gap is
14874 initially at Z for freshly visited files. The code below would
14875 set end_unchanged to 0 in that case. */
14876 if (MODIFF
> SAVE_MODIFF
14877 /* This seems to happen sometimes after saving a buffer. */
14878 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
14880 if (GPT
- BEG
< BEG_UNCHANGED
)
14881 BEG_UNCHANGED
= GPT
- BEG
;
14882 if (Z
- GPT
< END_UNCHANGED
)
14883 END_UNCHANGED
= Z
- GPT
;
14886 /* The position of the first and last character that has been changed. */
14887 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
14888 last_changed_charpos
= Z
- END_UNCHANGED
;
14890 /* If window starts after a line end, and the last change is in
14891 front of that newline, then changes don't affect the display.
14892 This case happens with stealth-fontification. Note that although
14893 the display is unchanged, glyph positions in the matrix have to
14894 be adjusted, of course. */
14895 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
14896 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
14897 && ((last_changed_charpos
< CHARPOS (start
)
14898 && CHARPOS (start
) == BEGV
)
14899 || (last_changed_charpos
< CHARPOS (start
) - 1
14900 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
14902 int Z_old
, delta
, Z_BYTE_old
, delta_bytes
;
14903 struct glyph_row
*r0
;
14905 /* Compute how many chars/bytes have been added to or removed
14906 from the buffer. */
14907 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
14908 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
14910 delta_bytes
= Z_BYTE
- Z_BYTE_old
;
14912 /* Give up if PT is not in the window. Note that it already has
14913 been checked at the start of try_window_id that PT is not in
14914 front of the window start. */
14915 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + delta
)
14918 /* If window start is unchanged, we can reuse the whole matrix
14919 as is, after adjusting glyph positions. No need to compute
14920 the window end again, since its offset from Z hasn't changed. */
14921 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
14922 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + delta
14923 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + delta_bytes
14924 /* PT must not be in a partially visible line. */
14925 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + delta
14926 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
14928 /* Adjust positions in the glyph matrix. */
14929 if (delta
|| delta_bytes
)
14931 struct glyph_row
*r1
14932 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
14933 increment_matrix_positions (w
->current_matrix
,
14934 MATRIX_ROW_VPOS (r0
, current_matrix
),
14935 MATRIX_ROW_VPOS (r1
, current_matrix
),
14936 delta
, delta_bytes
);
14939 /* Set the cursor. */
14940 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
14942 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
14949 /* Handle the case that changes are all below what is displayed in
14950 the window, and that PT is in the window. This shortcut cannot
14951 be taken if ZV is visible in the window, and text has been added
14952 there that is visible in the window. */
14953 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
14954 /* ZV is not visible in the window, or there are no
14955 changes at ZV, actually. */
14956 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
14957 || first_changed_charpos
== last_changed_charpos
))
14959 struct glyph_row
*r0
;
14961 /* Give up if PT is not in the window. Note that it already has
14962 been checked at the start of try_window_id that PT is not in
14963 front of the window start. */
14964 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
14967 /* If window start is unchanged, we can reuse the whole matrix
14968 as is, without changing glyph positions since no text has
14969 been added/removed in front of the window end. */
14970 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
14971 if (TEXT_POS_EQUAL_P (start
, r0
->start
.pos
)
14972 /* PT must not be in a partially visible line. */
14973 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
14974 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
14976 /* We have to compute the window end anew since text
14977 can have been added/removed after it. */
14979 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
14980 w
->window_end_bytepos
14981 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
14983 /* Set the cursor. */
14984 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
14986 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
14993 /* Give up if window start is in the changed area.
14995 The condition used to read
14997 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
14999 but why that was tested escapes me at the moment. */
15000 if (CHARPOS (start
) >= first_changed_charpos
15001 && CHARPOS (start
) <= last_changed_charpos
)
15004 /* Check that window start agrees with the start of the first glyph
15005 row in its current matrix. Check this after we know the window
15006 start is not in changed text, otherwise positions would not be
15008 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15009 if (!TEXT_POS_EQUAL_P (start
, row
->start
.pos
))
15012 /* Give up if the window ends in strings. Overlay strings
15013 at the end are difficult to handle, so don't try. */
15014 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
15015 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
15018 /* Compute the position at which we have to start displaying new
15019 lines. Some of the lines at the top of the window might be
15020 reusable because they are not displaying changed text. Find the
15021 last row in W's current matrix not affected by changes at the
15022 start of current_buffer. Value is null if changes start in the
15023 first line of window. */
15024 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
15025 if (last_unchanged_at_beg_row
)
15027 /* Avoid starting to display in the moddle of a character, a TAB
15028 for instance. This is easier than to set up the iterator
15029 exactly, and it's not a frequent case, so the additional
15030 effort wouldn't really pay off. */
15031 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
15032 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
15033 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
15034 --last_unchanged_at_beg_row
;
15036 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
15039 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
15041 start_pos
= it
.current
.pos
;
15043 /* Start displaying new lines in the desired matrix at the same
15044 vpos we would use in the current matrix, i.e. below
15045 last_unchanged_at_beg_row. */
15046 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
15048 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15049 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
15051 xassert (it
.hpos
== 0 && it
.current_x
== 0);
15055 /* There are no reusable lines at the start of the window.
15056 Start displaying in the first text line. */
15057 start_display (&it
, w
, start
);
15058 it
.vpos
= it
.first_vpos
;
15059 start_pos
= it
.current
.pos
;
15062 /* Find the first row that is not affected by changes at the end of
15063 the buffer. Value will be null if there is no unchanged row, in
15064 which case we must redisplay to the end of the window. delta
15065 will be set to the value by which buffer positions beginning with
15066 first_unchanged_at_end_row have to be adjusted due to text
15068 first_unchanged_at_end_row
15069 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
15070 IF_DEBUG (debug_delta
= delta
);
15071 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
15073 /* Set stop_pos to the buffer position up to which we will have to
15074 display new lines. If first_unchanged_at_end_row != NULL, this
15075 is the buffer position of the start of the line displayed in that
15076 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
15077 that we don't stop at a buffer position. */
15079 if (first_unchanged_at_end_row
)
15081 xassert (last_unchanged_at_beg_row
== NULL
15082 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
15084 /* If this is a continuation line, move forward to the next one
15085 that isn't. Changes in lines above affect this line.
15086 Caution: this may move first_unchanged_at_end_row to a row
15087 not displaying text. */
15088 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
15089 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15090 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15091 < it
.last_visible_y
))
15092 ++first_unchanged_at_end_row
;
15094 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15095 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15096 >= it
.last_visible_y
))
15097 first_unchanged_at_end_row
= NULL
;
15100 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
15102 first_unchanged_at_end_vpos
15103 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
15104 xassert (stop_pos
>= Z
- END_UNCHANGED
);
15107 else if (last_unchanged_at_beg_row
== NULL
)
15113 /* Either there is no unchanged row at the end, or the one we have
15114 now displays text. This is a necessary condition for the window
15115 end pos calculation at the end of this function. */
15116 xassert (first_unchanged_at_end_row
== NULL
15117 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
15119 debug_last_unchanged_at_beg_vpos
15120 = (last_unchanged_at_beg_row
15121 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
15123 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
15125 #endif /* GLYPH_DEBUG != 0 */
15128 /* Display new lines. Set last_text_row to the last new line
15129 displayed which has text on it, i.e. might end up as being the
15130 line where the window_end_vpos is. */
15131 w
->cursor
.vpos
= -1;
15132 last_text_row
= NULL
;
15133 overlay_arrow_seen
= 0;
15134 while (it
.current_y
< it
.last_visible_y
15135 && !fonts_changed_p
15136 && (first_unchanged_at_end_row
== NULL
15137 || IT_CHARPOS (it
) < stop_pos
))
15139 if (display_line (&it
))
15140 last_text_row
= it
.glyph_row
- 1;
15143 if (fonts_changed_p
)
15147 /* Compute differences in buffer positions, y-positions etc. for
15148 lines reused at the bottom of the window. Compute what we can
15150 if (first_unchanged_at_end_row
15151 /* No lines reused because we displayed everything up to the
15152 bottom of the window. */
15153 && it
.current_y
< it
.last_visible_y
)
15156 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
15158 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
15159 run
.current_y
= first_unchanged_at_end_row
->y
;
15160 run
.desired_y
= run
.current_y
+ dy
;
15161 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
15165 delta
= delta_bytes
= dvpos
= dy
15166 = run
.current_y
= run
.desired_y
= run
.height
= 0;
15167 first_unchanged_at_end_row
= NULL
;
15169 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
15172 /* Find the cursor if not already found. We have to decide whether
15173 PT will appear on this window (it sometimes doesn't, but this is
15174 not a very frequent case.) This decision has to be made before
15175 the current matrix is altered. A value of cursor.vpos < 0 means
15176 that PT is either in one of the lines beginning at
15177 first_unchanged_at_end_row or below the window. Don't care for
15178 lines that might be displayed later at the window end; as
15179 mentioned, this is not a frequent case. */
15180 if (w
->cursor
.vpos
< 0)
15182 /* Cursor in unchanged rows at the top? */
15183 if (PT
< CHARPOS (start_pos
)
15184 && last_unchanged_at_beg_row
)
15186 row
= row_containing_pos (w
, PT
,
15187 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
15188 last_unchanged_at_beg_row
+ 1, 0);
15190 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15193 /* Start from first_unchanged_at_end_row looking for PT. */
15194 else if (first_unchanged_at_end_row
)
15196 row
= row_containing_pos (w
, PT
- delta
,
15197 first_unchanged_at_end_row
, NULL
, 0);
15199 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
15200 delta_bytes
, dy
, dvpos
);
15203 /* Give up if cursor was not found. */
15204 if (w
->cursor
.vpos
< 0)
15206 clear_glyph_matrix (w
->desired_matrix
);
15211 /* Don't let the cursor end in the scroll margins. */
15213 int this_scroll_margin
, cursor_height
;
15215 this_scroll_margin
= max (0, scroll_margin
);
15216 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15217 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
15218 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
15220 if ((w
->cursor
.y
< this_scroll_margin
15221 && CHARPOS (start
) > BEGV
)
15222 /* Old redisplay didn't take scroll margin into account at the bottom,
15223 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
15224 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
15225 ? cursor_height
+ this_scroll_margin
15226 : 1)) > it
.last_visible_y
)
15228 w
->cursor
.vpos
= -1;
15229 clear_glyph_matrix (w
->desired_matrix
);
15234 /* Scroll the display. Do it before changing the current matrix so
15235 that xterm.c doesn't get confused about where the cursor glyph is
15237 if (dy
&& run
.height
)
15241 if (FRAME_WINDOW_P (f
))
15243 FRAME_RIF (f
)->update_window_begin_hook (w
);
15244 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15245 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15246 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15250 /* Terminal frame. In this case, dvpos gives the number of
15251 lines to scroll by; dvpos < 0 means scroll up. */
15252 int first_unchanged_at_end_vpos
15253 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
15254 int from
= WINDOW_TOP_EDGE_LINE (w
) + first_unchanged_at_end_vpos
;
15255 int end
= (WINDOW_TOP_EDGE_LINE (w
)
15256 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
15257 + window_internal_height (w
));
15259 /* Perform the operation on the screen. */
15262 /* Scroll last_unchanged_at_beg_row to the end of the
15263 window down dvpos lines. */
15264 set_terminal_window (f
, end
);
15266 /* On dumb terminals delete dvpos lines at the end
15267 before inserting dvpos empty lines. */
15268 if (!FRAME_SCROLL_REGION_OK (f
))
15269 ins_del_lines (f
, end
- dvpos
, -dvpos
);
15271 /* Insert dvpos empty lines in front of
15272 last_unchanged_at_beg_row. */
15273 ins_del_lines (f
, from
, dvpos
);
15275 else if (dvpos
< 0)
15277 /* Scroll up last_unchanged_at_beg_vpos to the end of
15278 the window to last_unchanged_at_beg_vpos - |dvpos|. */
15279 set_terminal_window (f
, end
);
15281 /* Delete dvpos lines in front of
15282 last_unchanged_at_beg_vpos. ins_del_lines will set
15283 the cursor to the given vpos and emit |dvpos| delete
15285 ins_del_lines (f
, from
+ dvpos
, dvpos
);
15287 /* On a dumb terminal insert dvpos empty lines at the
15289 if (!FRAME_SCROLL_REGION_OK (f
))
15290 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
15293 set_terminal_window (f
, 0);
15299 /* Shift reused rows of the current matrix to the right position.
15300 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
15302 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15303 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
15306 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
15307 bottom_vpos
, dvpos
);
15308 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
15311 else if (dvpos
> 0)
15313 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
15314 bottom_vpos
, dvpos
);
15315 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
15316 first_unchanged_at_end_vpos
+ dvpos
, 0);
15319 /* For frame-based redisplay, make sure that current frame and window
15320 matrix are in sync with respect to glyph memory. */
15321 if (!FRAME_WINDOW_P (f
))
15322 sync_frame_with_window_matrix_rows (w
);
15324 /* Adjust buffer positions in reused rows. */
15325 if (delta
|| delta_bytes
)
15326 increment_matrix_positions (current_matrix
,
15327 first_unchanged_at_end_vpos
+ dvpos
,
15328 bottom_vpos
, delta
, delta_bytes
);
15330 /* Adjust Y positions. */
15332 shift_glyph_matrix (w
, current_matrix
,
15333 first_unchanged_at_end_vpos
+ dvpos
,
15336 if (first_unchanged_at_end_row
)
15338 first_unchanged_at_end_row
+= dvpos
;
15339 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
15340 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
15341 first_unchanged_at_end_row
= NULL
;
15344 /* If scrolling up, there may be some lines to display at the end of
15346 last_text_row_at_end
= NULL
;
15349 /* Scrolling up can leave for example a partially visible line
15350 at the end of the window to be redisplayed. */
15351 /* Set last_row to the glyph row in the current matrix where the
15352 window end line is found. It has been moved up or down in
15353 the matrix by dvpos. */
15354 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
15355 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
15357 /* If last_row is the window end line, it should display text. */
15358 xassert (last_row
->displays_text_p
);
15360 /* If window end line was partially visible before, begin
15361 displaying at that line. Otherwise begin displaying with the
15362 line following it. */
15363 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
15365 init_to_row_start (&it
, w
, last_row
);
15366 it
.vpos
= last_vpos
;
15367 it
.current_y
= last_row
->y
;
15371 init_to_row_end (&it
, w
, last_row
);
15372 it
.vpos
= 1 + last_vpos
;
15373 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
15377 /* We may start in a continuation line. If so, we have to
15378 get the right continuation_lines_width and current_x. */
15379 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
15380 it
.hpos
= it
.current_x
= 0;
15382 /* Display the rest of the lines at the window end. */
15383 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15384 while (it
.current_y
< it
.last_visible_y
15385 && !fonts_changed_p
)
15387 /* Is it always sure that the display agrees with lines in
15388 the current matrix? I don't think so, so we mark rows
15389 displayed invalid in the current matrix by setting their
15390 enabled_p flag to zero. */
15391 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
15392 if (display_line (&it
))
15393 last_text_row_at_end
= it
.glyph_row
- 1;
15397 /* Update window_end_pos and window_end_vpos. */
15398 if (first_unchanged_at_end_row
15399 && !last_text_row_at_end
)
15401 /* Window end line if one of the preserved rows from the current
15402 matrix. Set row to the last row displaying text in current
15403 matrix starting at first_unchanged_at_end_row, after
15405 xassert (first_unchanged_at_end_row
->displays_text_p
);
15406 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
15407 first_unchanged_at_end_row
);
15408 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
15410 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15411 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15413 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
15414 xassert (w
->window_end_bytepos
>= 0);
15415 IF_DEBUG (debug_method_add (w
, "A"));
15417 else if (last_text_row_at_end
)
15420 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
15421 w
->window_end_bytepos
15422 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
15424 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
15425 xassert (w
->window_end_bytepos
>= 0);
15426 IF_DEBUG (debug_method_add (w
, "B"));
15428 else if (last_text_row
)
15430 /* We have displayed either to the end of the window or at the
15431 end of the window, i.e. the last row with text is to be found
15432 in the desired matrix. */
15434 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15435 w
->window_end_bytepos
15436 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15438 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
15439 xassert (w
->window_end_bytepos
>= 0);
15441 else if (first_unchanged_at_end_row
== NULL
15442 && last_text_row
== NULL
15443 && last_text_row_at_end
== NULL
)
15445 /* Displayed to end of window, but no line containing text was
15446 displayed. Lines were deleted at the end of the window. */
15447 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
15448 int vpos
= XFASTINT (w
->window_end_vpos
);
15449 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
15450 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
15453 row
== NULL
&& vpos
>= first_vpos
;
15454 --vpos
, --current_row
, --desired_row
)
15456 if (desired_row
->enabled_p
)
15458 if (desired_row
->displays_text_p
)
15461 else if (current_row
->displays_text_p
)
15465 xassert (row
!= NULL
);
15466 w
->window_end_vpos
= make_number (vpos
+ 1);
15467 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15468 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15469 xassert (w
->window_end_bytepos
>= 0);
15470 IF_DEBUG (debug_method_add (w
, "C"));
15475 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
15476 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
15478 /* Record that display has not been completed. */
15479 w
->window_end_valid
= Qnil
;
15480 w
->desired_matrix
->no_scrolling_p
= 1;
15488 /***********************************************************************
15489 More debugging support
15490 ***********************************************************************/
15494 void dump_glyph_row
P_ ((struct glyph_row
*, int, int));
15495 void dump_glyph_matrix
P_ ((struct glyph_matrix
*, int));
15496 void dump_glyph
P_ ((struct glyph_row
*, struct glyph
*, int));
15499 /* Dump the contents of glyph matrix MATRIX on stderr.
15501 GLYPHS 0 means don't show glyph contents.
15502 GLYPHS 1 means show glyphs in short form
15503 GLYPHS > 1 means show glyphs in long form. */
15506 dump_glyph_matrix (matrix
, glyphs
)
15507 struct glyph_matrix
*matrix
;
15511 for (i
= 0; i
< matrix
->nrows
; ++i
)
15512 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
15516 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
15517 the glyph row and area where the glyph comes from. */
15520 dump_glyph (row
, glyph
, area
)
15521 struct glyph_row
*row
;
15522 struct glyph
*glyph
;
15525 if (glyph
->type
== CHAR_GLYPH
)
15528 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15529 glyph
- row
->glyphs
[TEXT_AREA
],
15532 (BUFFERP (glyph
->object
)
15534 : (STRINGP (glyph
->object
)
15537 glyph
->pixel_width
,
15539 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
15543 glyph
->left_box_line_p
,
15544 glyph
->right_box_line_p
);
15546 else if (glyph
->type
== STRETCH_GLYPH
)
15549 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15550 glyph
- row
->glyphs
[TEXT_AREA
],
15553 (BUFFERP (glyph
->object
)
15555 : (STRINGP (glyph
->object
)
15558 glyph
->pixel_width
,
15562 glyph
->left_box_line_p
,
15563 glyph
->right_box_line_p
);
15565 else if (glyph
->type
== IMAGE_GLYPH
)
15568 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15569 glyph
- row
->glyphs
[TEXT_AREA
],
15572 (BUFFERP (glyph
->object
)
15574 : (STRINGP (glyph
->object
)
15577 glyph
->pixel_width
,
15581 glyph
->left_box_line_p
,
15582 glyph
->right_box_line_p
);
15584 else if (glyph
->type
== COMPOSITE_GLYPH
)
15587 " %5d %4c %6d %c %3d 0x%05x",
15588 glyph
- row
->glyphs
[TEXT_AREA
],
15591 (BUFFERP (glyph
->object
)
15593 : (STRINGP (glyph
->object
)
15596 glyph
->pixel_width
,
15598 if (glyph
->u
.cmp
.automatic
)
15601 glyph
->u
.cmp
.from
, glyph
->u
.cmp
.to
);
15602 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
15604 glyph
->left_box_line_p
,
15605 glyph
->right_box_line_p
);
15610 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
15611 GLYPHS 0 means don't show glyph contents.
15612 GLYPHS 1 means show glyphs in short form
15613 GLYPHS > 1 means show glyphs in long form. */
15616 dump_glyph_row (row
, vpos
, glyphs
)
15617 struct glyph_row
*row
;
15622 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
15623 fprintf (stderr
, "======================================================================\n");
15625 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d\
15626 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
15628 MATRIX_ROW_START_CHARPOS (row
),
15629 MATRIX_ROW_END_CHARPOS (row
),
15630 row
->used
[TEXT_AREA
],
15631 row
->contains_overlapping_glyphs_p
,
15633 row
->truncated_on_left_p
,
15634 row
->truncated_on_right_p
,
15636 MATRIX_ROW_CONTINUATION_LINE_P (row
),
15637 row
->displays_text_p
,
15640 row
->ends_in_middle_of_char_p
,
15641 row
->starts_in_middle_of_char_p
,
15647 row
->visible_height
,
15650 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
15651 row
->end
.overlay_string_index
,
15652 row
->continuation_lines_width
);
15653 fprintf (stderr
, "%9d %5d\n",
15654 CHARPOS (row
->start
.string_pos
),
15655 CHARPOS (row
->end
.string_pos
));
15656 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
15657 row
->end
.dpvec_index
);
15664 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
15666 struct glyph
*glyph
= row
->glyphs
[area
];
15667 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
15669 /* Glyph for a line end in text. */
15670 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
15673 if (glyph
< glyph_end
)
15674 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
15676 for (; glyph
< glyph_end
; ++glyph
)
15677 dump_glyph (row
, glyph
, area
);
15680 else if (glyphs
== 1)
15684 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
15686 char *s
= (char *) alloca (row
->used
[area
] + 1);
15689 for (i
= 0; i
< row
->used
[area
]; ++i
)
15691 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
15692 if (glyph
->type
== CHAR_GLYPH
15693 && glyph
->u
.ch
< 0x80
15694 && glyph
->u
.ch
>= ' ')
15695 s
[i
] = glyph
->u
.ch
;
15701 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
15707 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
15708 Sdump_glyph_matrix
, 0, 1, "p",
15709 doc
: /* Dump the current matrix of the selected window to stderr.
15710 Shows contents of glyph row structures. With non-nil
15711 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
15712 glyphs in short form, otherwise show glyphs in long form. */)
15714 Lisp_Object glyphs
;
15716 struct window
*w
= XWINDOW (selected_window
);
15717 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15719 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
15720 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
15721 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
15722 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
15723 fprintf (stderr
, "=============================================\n");
15724 dump_glyph_matrix (w
->current_matrix
,
15725 NILP (glyphs
) ? 0 : XINT (glyphs
));
15730 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
15731 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
15734 struct frame
*f
= XFRAME (selected_frame
);
15735 dump_glyph_matrix (f
->current_matrix
, 1);
15740 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
15741 doc
: /* Dump glyph row ROW to stderr.
15742 GLYPH 0 means don't dump glyphs.
15743 GLYPH 1 means dump glyphs in short form.
15744 GLYPH > 1 or omitted means dump glyphs in long form. */)
15746 Lisp_Object row
, glyphs
;
15748 struct glyph_matrix
*matrix
;
15751 CHECK_NUMBER (row
);
15752 matrix
= XWINDOW (selected_window
)->current_matrix
;
15754 if (vpos
>= 0 && vpos
< matrix
->nrows
)
15755 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
15757 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
15762 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
15763 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
15764 GLYPH 0 means don't dump glyphs.
15765 GLYPH 1 means dump glyphs in short form.
15766 GLYPH > 1 or omitted means dump glyphs in long form. */)
15768 Lisp_Object row
, glyphs
;
15770 struct frame
*sf
= SELECTED_FRAME ();
15771 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
15774 CHECK_NUMBER (row
);
15776 if (vpos
>= 0 && vpos
< m
->nrows
)
15777 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
15778 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
15783 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
15784 doc
: /* Toggle tracing of redisplay.
15785 With ARG, turn tracing on if and only if ARG is positive. */)
15790 trace_redisplay_p
= !trace_redisplay_p
;
15793 arg
= Fprefix_numeric_value (arg
);
15794 trace_redisplay_p
= XINT (arg
) > 0;
15801 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
15802 doc
: /* Like `format', but print result to stderr.
15803 usage: (trace-to-stderr STRING &rest OBJECTS) */)
15808 Lisp_Object s
= Fformat (nargs
, args
);
15809 fprintf (stderr
, "%s", SDATA (s
));
15813 #endif /* GLYPH_DEBUG */
15817 /***********************************************************************
15818 Building Desired Matrix Rows
15819 ***********************************************************************/
15821 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
15822 Used for non-window-redisplay windows, and for windows w/o left fringe. */
15824 static struct glyph_row
*
15825 get_overlay_arrow_glyph_row (w
, overlay_arrow_string
)
15827 Lisp_Object overlay_arrow_string
;
15829 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
15830 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15831 struct buffer
*old
= current_buffer
;
15832 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
15833 int arrow_len
= SCHARS (overlay_arrow_string
);
15834 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
15835 const unsigned char *p
;
15838 int n_glyphs_before
;
15840 set_buffer_temp (buffer
);
15841 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
15842 it
.glyph_row
->used
[TEXT_AREA
] = 0;
15843 SET_TEXT_POS (it
.position
, 0, 0);
15845 multibyte_p
= !NILP (buffer
->enable_multibyte_characters
);
15847 while (p
< arrow_end
)
15849 Lisp_Object face
, ilisp
;
15851 /* Get the next character. */
15853 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
15856 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
15857 if (! ASCII_CHAR_P (it
.c
))
15858 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
15862 /* Get its face. */
15863 ilisp
= make_number (p
- arrow_string
);
15864 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
15865 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
15867 /* Compute its width, get its glyphs. */
15868 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
15869 SET_TEXT_POS (it
.position
, -1, -1);
15870 PRODUCE_GLYPHS (&it
);
15872 /* If this character doesn't fit any more in the line, we have
15873 to remove some glyphs. */
15874 if (it
.current_x
> it
.last_visible_x
)
15876 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
15881 set_buffer_temp (old
);
15882 return it
.glyph_row
;
15886 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
15887 glyphs are only inserted for terminal frames since we can't really
15888 win with truncation glyphs when partially visible glyphs are
15889 involved. Which glyphs to insert is determined by
15890 produce_special_glyphs. */
15893 insert_left_trunc_glyphs (it
)
15896 struct it truncate_it
;
15897 struct glyph
*from
, *end
, *to
, *toend
;
15899 xassert (!FRAME_WINDOW_P (it
->f
));
15901 /* Get the truncation glyphs. */
15903 truncate_it
.current_x
= 0;
15904 truncate_it
.face_id
= DEFAULT_FACE_ID
;
15905 truncate_it
.glyph_row
= &scratch_glyph_row
;
15906 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
15907 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
15908 truncate_it
.object
= make_number (0);
15909 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
15911 /* Overwrite glyphs from IT with truncation glyphs. */
15912 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
15913 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
15914 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
15915 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
15920 /* There may be padding glyphs left over. Overwrite them too. */
15921 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
15923 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
15929 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
15933 /* Compute the pixel height and width of IT->glyph_row.
15935 Most of the time, ascent and height of a display line will be equal
15936 to the max_ascent and max_height values of the display iterator
15937 structure. This is not the case if
15939 1. We hit ZV without displaying anything. In this case, max_ascent
15940 and max_height will be zero.
15942 2. We have some glyphs that don't contribute to the line height.
15943 (The glyph row flag contributes_to_line_height_p is for future
15944 pixmap extensions).
15946 The first case is easily covered by using default values because in
15947 these cases, the line height does not really matter, except that it
15948 must not be zero. */
15951 compute_line_metrics (it
)
15954 struct glyph_row
*row
= it
->glyph_row
;
15957 if (FRAME_WINDOW_P (it
->f
))
15959 int i
, min_y
, max_y
;
15961 /* The line may consist of one space only, that was added to
15962 place the cursor on it. If so, the row's height hasn't been
15964 if (row
->height
== 0)
15966 if (it
->max_ascent
+ it
->max_descent
== 0)
15967 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
15968 row
->ascent
= it
->max_ascent
;
15969 row
->height
= it
->max_ascent
+ it
->max_descent
;
15970 row
->phys_ascent
= it
->max_phys_ascent
;
15971 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
15972 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
15975 /* Compute the width of this line. */
15976 row
->pixel_width
= row
->x
;
15977 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
15978 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
15980 xassert (row
->pixel_width
>= 0);
15981 xassert (row
->ascent
>= 0 && row
->height
> 0);
15983 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
15984 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
15986 /* If first line's physical ascent is larger than its logical
15987 ascent, use the physical ascent, and make the row taller.
15988 This makes accented characters fully visible. */
15989 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
15990 && row
->phys_ascent
> row
->ascent
)
15992 row
->height
+= row
->phys_ascent
- row
->ascent
;
15993 row
->ascent
= row
->phys_ascent
;
15996 /* Compute how much of the line is visible. */
15997 row
->visible_height
= row
->height
;
15999 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
16000 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
16002 if (row
->y
< min_y
)
16003 row
->visible_height
-= min_y
- row
->y
;
16004 if (row
->y
+ row
->height
> max_y
)
16005 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16009 row
->pixel_width
= row
->used
[TEXT_AREA
];
16010 if (row
->continued_p
)
16011 row
->pixel_width
-= it
->continuation_pixel_width
;
16012 else if (row
->truncated_on_right_p
)
16013 row
->pixel_width
-= it
->truncation_pixel_width
;
16014 row
->ascent
= row
->phys_ascent
= 0;
16015 row
->height
= row
->phys_height
= row
->visible_height
= 1;
16016 row
->extra_line_spacing
= 0;
16019 /* Compute a hash code for this row. */
16021 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16022 for (i
= 0; i
< row
->used
[area
]; ++i
)
16023 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
16024 + row
->glyphs
[area
][i
].u
.val
16025 + row
->glyphs
[area
][i
].face_id
16026 + row
->glyphs
[area
][i
].padding_p
16027 + (row
->glyphs
[area
][i
].type
<< 2));
16029 it
->max_ascent
= it
->max_descent
= 0;
16030 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
16034 /* Append one space to the glyph row of iterator IT if doing a
16035 window-based redisplay. The space has the same face as
16036 IT->face_id. Value is non-zero if a space was added.
16038 This function is called to make sure that there is always one glyph
16039 at the end of a glyph row that the cursor can be set on under
16040 window-systems. (If there weren't such a glyph we would not know
16041 how wide and tall a box cursor should be displayed).
16043 At the same time this space let's a nicely handle clearing to the
16044 end of the line if the row ends in italic text. */
16047 append_space_for_newline (it
, default_face_p
)
16049 int default_face_p
;
16051 if (FRAME_WINDOW_P (it
->f
))
16053 int n
= it
->glyph_row
->used
[TEXT_AREA
];
16055 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
16056 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
16058 /* Save some values that must not be changed.
16059 Must save IT->c and IT->len because otherwise
16060 ITERATOR_AT_END_P wouldn't work anymore after
16061 append_space_for_newline has been called. */
16062 enum display_element_type saved_what
= it
->what
;
16063 int saved_c
= it
->c
, saved_len
= it
->len
;
16064 int saved_char_to_display
= it
->char_to_display
;
16065 int saved_x
= it
->current_x
;
16066 int saved_face_id
= it
->face_id
;
16067 struct text_pos saved_pos
;
16068 Lisp_Object saved_object
;
16071 saved_object
= it
->object
;
16072 saved_pos
= it
->position
;
16074 it
->what
= IT_CHARACTER
;
16075 bzero (&it
->position
, sizeof it
->position
);
16076 it
->object
= make_number (0);
16077 it
->c
= it
->char_to_display
= ' ';
16080 if (default_face_p
)
16081 it
->face_id
= DEFAULT_FACE_ID
;
16082 else if (it
->face_before_selective_p
)
16083 it
->face_id
= it
->saved_face_id
;
16084 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
16085 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
16087 PRODUCE_GLYPHS (it
);
16089 it
->override_ascent
= -1;
16090 it
->constrain_row_ascent_descent_p
= 0;
16091 it
->current_x
= saved_x
;
16092 it
->object
= saved_object
;
16093 it
->position
= saved_pos
;
16094 it
->what
= saved_what
;
16095 it
->face_id
= saved_face_id
;
16096 it
->len
= saved_len
;
16098 it
->char_to_display
= saved_char_to_display
;
16107 /* Extend the face of the last glyph in the text area of IT->glyph_row
16108 to the end of the display line. Called from display_line.
16109 If the glyph row is empty, add a space glyph to it so that we
16110 know the face to draw. Set the glyph row flag fill_line_p. */
16113 extend_face_to_end_of_line (it
)
16117 struct frame
*f
= it
->f
;
16119 /* If line is already filled, do nothing. */
16120 if (it
->current_x
>= it
->last_visible_x
)
16123 /* Face extension extends the background and box of IT->face_id
16124 to the end of the line. If the background equals the background
16125 of the frame, we don't have to do anything. */
16126 if (it
->face_before_selective_p
)
16127 face
= FACE_FROM_ID (it
->f
, it
->saved_face_id
);
16129 face
= FACE_FROM_ID (f
, it
->face_id
);
16131 if (FRAME_WINDOW_P (f
)
16132 && it
->glyph_row
->displays_text_p
16133 && face
->box
== FACE_NO_BOX
16134 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
16138 /* Set the glyph row flag indicating that the face of the last glyph
16139 in the text area has to be drawn to the end of the text area. */
16140 it
->glyph_row
->fill_line_p
= 1;
16142 /* If current character of IT is not ASCII, make sure we have the
16143 ASCII face. This will be automatically undone the next time
16144 get_next_display_element returns a multibyte character. Note
16145 that the character will always be single byte in unibyte
16147 if (!ASCII_CHAR_P (it
->c
))
16149 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
16152 if (FRAME_WINDOW_P (f
))
16154 /* If the row is empty, add a space with the current face of IT,
16155 so that we know which face to draw. */
16156 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
16158 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
16159 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
16160 it
->glyph_row
->used
[TEXT_AREA
] = 1;
16165 /* Save some values that must not be changed. */
16166 int saved_x
= it
->current_x
;
16167 struct text_pos saved_pos
;
16168 Lisp_Object saved_object
;
16169 enum display_element_type saved_what
= it
->what
;
16170 int saved_face_id
= it
->face_id
;
16172 saved_object
= it
->object
;
16173 saved_pos
= it
->position
;
16175 it
->what
= IT_CHARACTER
;
16176 bzero (&it
->position
, sizeof it
->position
);
16177 it
->object
= make_number (0);
16178 it
->c
= it
->char_to_display
= ' ';
16180 it
->face_id
= face
->id
;
16182 PRODUCE_GLYPHS (it
);
16184 while (it
->current_x
<= it
->last_visible_x
)
16185 PRODUCE_GLYPHS (it
);
16187 /* Don't count these blanks really. It would let us insert a left
16188 truncation glyph below and make us set the cursor on them, maybe. */
16189 it
->current_x
= saved_x
;
16190 it
->object
= saved_object
;
16191 it
->position
= saved_pos
;
16192 it
->what
= saved_what
;
16193 it
->face_id
= saved_face_id
;
16198 /* Value is non-zero if text starting at CHARPOS in current_buffer is
16199 trailing whitespace. */
16202 trailing_whitespace_p (charpos
)
16205 int bytepos
= CHAR_TO_BYTE (charpos
);
16208 while (bytepos
< ZV_BYTE
16209 && (c
= FETCH_CHAR (bytepos
),
16210 c
== ' ' || c
== '\t'))
16213 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
16215 if (bytepos
!= PT_BYTE
)
16222 /* Highlight trailing whitespace, if any, in ROW. */
16225 highlight_trailing_whitespace (f
, row
)
16227 struct glyph_row
*row
;
16229 int used
= row
->used
[TEXT_AREA
];
16233 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
16234 struct glyph
*glyph
= start
+ used
- 1;
16236 /* Skip over glyphs inserted to display the cursor at the
16237 end of a line, for extending the face of the last glyph
16238 to the end of the line on terminals, and for truncation
16239 and continuation glyphs. */
16240 while (glyph
>= start
16241 && glyph
->type
== CHAR_GLYPH
16242 && INTEGERP (glyph
->object
))
16245 /* If last glyph is a space or stretch, and it's trailing
16246 whitespace, set the face of all trailing whitespace glyphs in
16247 IT->glyph_row to `trailing-whitespace'. */
16249 && BUFFERP (glyph
->object
)
16250 && (glyph
->type
== STRETCH_GLYPH
16251 || (glyph
->type
== CHAR_GLYPH
16252 && glyph
->u
.ch
== ' '))
16253 && trailing_whitespace_p (glyph
->charpos
))
16255 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
16259 while (glyph
>= start
16260 && BUFFERP (glyph
->object
)
16261 && (glyph
->type
== STRETCH_GLYPH
16262 || (glyph
->type
== CHAR_GLYPH
16263 && glyph
->u
.ch
== ' ')))
16264 (glyph
--)->face_id
= face_id
;
16270 /* Value is non-zero if glyph row ROW in window W should be
16271 used to hold the cursor. */
16274 cursor_row_p (w
, row
)
16276 struct glyph_row
*row
;
16278 int cursor_row_p
= 1;
16280 if (PT
== MATRIX_ROW_END_CHARPOS (row
))
16282 /* Suppose the row ends on a string.
16283 Unless the row is continued, that means it ends on a newline
16284 in the string. If it's anything other than a display string
16285 (e.g. a before-string from an overlay), we don't want the
16286 cursor there. (This heuristic seems to give the optimal
16287 behavior for the various types of multi-line strings.) */
16288 if (CHARPOS (row
->end
.string_pos
) >= 0)
16290 if (row
->continued_p
)
16294 /* Check for `display' property. */
16295 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
16296 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
16297 struct glyph
*glyph
;
16300 for (glyph
= end
; glyph
>= beg
; --glyph
)
16301 if (STRINGP (glyph
->object
))
16304 = Fget_char_property (make_number (PT
),
16308 && display_prop_string_p (prop
, glyph
->object
));
16313 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
16315 /* If the row ends in middle of a real character,
16316 and the line is continued, we want the cursor here.
16317 That's because MATRIX_ROW_END_CHARPOS would equal
16318 PT if PT is before the character. */
16319 if (!row
->ends_in_ellipsis_p
)
16320 cursor_row_p
= row
->continued_p
;
16322 /* If the row ends in an ellipsis, then
16323 MATRIX_ROW_END_CHARPOS will equal point after the invisible text.
16324 We want that position to be displayed after the ellipsis. */
16327 /* If the row ends at ZV, display the cursor at the end of that
16328 row instead of at the start of the row below. */
16329 else if (row
->ends_at_zv_p
)
16335 return cursor_row_p
;
16340 /* Push the display property PROP so that it will be rendered at the
16341 current position in IT. Return 1 if PROP was successfully pushed,
16345 push_display_prop (struct it
*it
, Lisp_Object prop
)
16349 if (STRINGP (prop
))
16351 if (SCHARS (prop
) == 0)
16358 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
16359 it
->current
.overlay_string_index
= -1;
16360 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
16361 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
16362 it
->method
= GET_FROM_STRING
;
16363 it
->stop_charpos
= 0;
16365 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
16367 it
->method
= GET_FROM_STRETCH
;
16370 #ifdef HAVE_WINDOW_SYSTEM
16371 else if (IMAGEP (prop
))
16373 it
->what
= IT_IMAGE
;
16374 it
->image_id
= lookup_image (it
->f
, prop
);
16375 it
->method
= GET_FROM_IMAGE
;
16377 #endif /* HAVE_WINDOW_SYSTEM */
16380 pop_it (it
); /* bogus display property, give up */
16387 /* Return the character-property PROP at the current position in IT. */
16390 get_it_property (it
, prop
)
16394 Lisp_Object position
;
16396 if (STRINGP (it
->object
))
16397 position
= make_number (IT_STRING_CHARPOS (*it
));
16398 else if (BUFFERP (it
->object
))
16399 position
= make_number (IT_CHARPOS (*it
));
16403 return Fget_char_property (position
, prop
, it
->object
);
16406 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
16409 handle_line_prefix (struct it
*it
)
16411 Lisp_Object prefix
;
16412 if (it
->continuation_lines_width
> 0)
16414 prefix
= get_it_property (it
, Qwrap_prefix
);
16416 prefix
= Vwrap_prefix
;
16420 prefix
= get_it_property (it
, Qline_prefix
);
16422 prefix
= Vline_prefix
;
16424 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
16426 /* If the prefix is wider than the window, and we try to wrap
16427 it, it would acquire its own wrap prefix, and so on till the
16428 iterator stack overflows. So, don't wrap the prefix. */
16429 it
->line_wrap
= TRUNCATE
;
16430 it
->avoid_cursor_p
= 1;
16436 /* Construct the glyph row IT->glyph_row in the desired matrix of
16437 IT->w from text at the current position of IT. See dispextern.h
16438 for an overview of struct it. Value is non-zero if
16439 IT->glyph_row displays text, as opposed to a line displaying ZV
16446 struct glyph_row
*row
= it
->glyph_row
;
16447 Lisp_Object overlay_arrow_string
;
16449 int may_wrap
= 0, wrap_x
;
16450 int wrap_row_used
= -1, wrap_row_ascent
, wrap_row_height
;
16451 int wrap_row_phys_ascent
, wrap_row_phys_height
;
16452 int wrap_row_extra_line_spacing
;
16454 /* We always start displaying at hpos zero even if hscrolled. */
16455 xassert (it
->hpos
== 0 && it
->current_x
== 0);
16457 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
16458 >= it
->w
->desired_matrix
->nrows
)
16460 it
->w
->nrows_scale_factor
++;
16461 fonts_changed_p
= 1;
16465 /* Is IT->w showing the region? */
16466 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
16468 /* Clear the result glyph row and enable it. */
16469 prepare_desired_row (row
);
16471 row
->y
= it
->current_y
;
16472 row
->start
= it
->start
;
16473 row
->continuation_lines_width
= it
->continuation_lines_width
;
16474 row
->displays_text_p
= 1;
16475 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
16476 it
->starts_in_middle_of_char_p
= 0;
16478 /* Arrange the overlays nicely for our purposes. Usually, we call
16479 display_line on only one line at a time, in which case this
16480 can't really hurt too much, or we call it on lines which appear
16481 one after another in the buffer, in which case all calls to
16482 recenter_overlay_lists but the first will be pretty cheap. */
16483 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
16485 /* Move over display elements that are not visible because we are
16486 hscrolled. This may stop at an x-position < IT->first_visible_x
16487 if the first glyph is partially visible or if we hit a line end. */
16488 if (it
->current_x
< it
->first_visible_x
)
16490 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
16491 MOVE_TO_POS
| MOVE_TO_X
);
16495 /* We only do this when not calling `move_it_in_display_line_to'
16496 above, because move_it_in_display_line_to calls
16497 handle_line_prefix itself. */
16498 handle_line_prefix (it
);
16501 /* Get the initial row height. This is either the height of the
16502 text hscrolled, if there is any, or zero. */
16503 row
->ascent
= it
->max_ascent
;
16504 row
->height
= it
->max_ascent
+ it
->max_descent
;
16505 row
->phys_ascent
= it
->max_phys_ascent
;
16506 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16507 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
16509 /* Loop generating characters. The loop is left with IT on the next
16510 character to display. */
16513 int n_glyphs_before
, hpos_before
, x_before
;
16515 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
16517 /* Retrieve the next thing to display. Value is zero if end of
16519 if (!get_next_display_element (it
))
16521 /* Maybe add a space at the end of this line that is used to
16522 display the cursor there under X. Set the charpos of the
16523 first glyph of blank lines not corresponding to any text
16525 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16526 row
->exact_window_width_line_p
= 1;
16527 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
16528 || row
->used
[TEXT_AREA
] == 0)
16530 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
16531 row
->displays_text_p
= 0;
16533 if (!NILP (XBUFFER (it
->w
->buffer
)->indicate_empty_lines
)
16534 && (!MINI_WINDOW_P (it
->w
)
16535 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
16536 row
->indicate_empty_line_p
= 1;
16539 it
->continuation_lines_width
= 0;
16540 row
->ends_at_zv_p
= 1;
16544 /* Now, get the metrics of what we want to display. This also
16545 generates glyphs in `row' (which is IT->glyph_row). */
16546 n_glyphs_before
= row
->used
[TEXT_AREA
];
16549 /* Remember the line height so far in case the next element doesn't
16550 fit on the line. */
16551 if (it
->line_wrap
!= TRUNCATE
)
16553 ascent
= it
->max_ascent
;
16554 descent
= it
->max_descent
;
16555 phys_ascent
= it
->max_phys_ascent
;
16556 phys_descent
= it
->max_phys_descent
;
16558 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
16560 if (IT_DISPLAYING_WHITESPACE (it
))
16566 wrap_row_used
= row
->used
[TEXT_AREA
];
16567 wrap_row_ascent
= row
->ascent
;
16568 wrap_row_height
= row
->height
;
16569 wrap_row_phys_ascent
= row
->phys_ascent
;
16570 wrap_row_phys_height
= row
->phys_height
;
16571 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
16577 PRODUCE_GLYPHS (it
);
16579 /* If this display element was in marginal areas, continue with
16581 if (it
->area
!= TEXT_AREA
)
16583 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
16584 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
16585 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
16586 row
->phys_height
= max (row
->phys_height
,
16587 it
->max_phys_ascent
+ it
->max_phys_descent
);
16588 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
16589 it
->max_extra_line_spacing
);
16590 set_iterator_to_next (it
, 1);
16594 /* Does the display element fit on the line? If we truncate
16595 lines, we should draw past the right edge of the window. If
16596 we don't truncate, we want to stop so that we can display the
16597 continuation glyph before the right margin. If lines are
16598 continued, there are two possible strategies for characters
16599 resulting in more than 1 glyph (e.g. tabs): Display as many
16600 glyphs as possible in this line and leave the rest for the
16601 continuation line, or display the whole element in the next
16602 line. Original redisplay did the former, so we do it also. */
16603 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
16604 hpos_before
= it
->hpos
;
16607 if (/* Not a newline. */
16609 /* Glyphs produced fit entirely in the line. */
16610 && it
->current_x
< it
->last_visible_x
)
16612 it
->hpos
+= nglyphs
;
16613 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
16614 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
16615 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
16616 row
->phys_height
= max (row
->phys_height
,
16617 it
->max_phys_ascent
+ it
->max_phys_descent
);
16618 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
16619 it
->max_extra_line_spacing
);
16620 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
16621 row
->x
= x
- it
->first_visible_x
;
16626 struct glyph
*glyph
;
16628 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
16630 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
16631 new_x
= x
+ glyph
->pixel_width
;
16633 if (/* Lines are continued. */
16634 it
->line_wrap
!= TRUNCATE
16635 && (/* Glyph doesn't fit on the line. */
16636 new_x
> it
->last_visible_x
16637 /* Or it fits exactly on a window system frame. */
16638 || (new_x
== it
->last_visible_x
16639 && FRAME_WINDOW_P (it
->f
))))
16641 /* End of a continued line. */
16644 || (new_x
== it
->last_visible_x
16645 && FRAME_WINDOW_P (it
->f
)))
16647 /* Current glyph is the only one on the line or
16648 fits exactly on the line. We must continue
16649 the line because we can't draw the cursor
16650 after the glyph. */
16651 row
->continued_p
= 1;
16652 it
->current_x
= new_x
;
16653 it
->continuation_lines_width
+= new_x
;
16655 if (i
== nglyphs
- 1)
16657 /* If line-wrap is on, check if a previous
16658 wrap point was found. */
16659 if (wrap_row_used
> 0
16660 /* Even if there is a previous wrap
16661 point, continue the line here as
16662 usual, if (i) the previous character
16663 was a space or tab AND (ii) the
16664 current character is not. */
16666 || IT_DISPLAYING_WHITESPACE (it
)))
16669 set_iterator_to_next (it
, 1);
16670 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16672 if (!get_next_display_element (it
))
16674 row
->exact_window_width_line_p
= 1;
16675 it
->continuation_lines_width
= 0;
16676 row
->continued_p
= 0;
16677 row
->ends_at_zv_p
= 1;
16679 else if (ITERATOR_AT_END_OF_LINE_P (it
))
16681 row
->continued_p
= 0;
16682 row
->exact_window_width_line_p
= 1;
16687 else if (CHAR_GLYPH_PADDING_P (*glyph
)
16688 && !FRAME_WINDOW_P (it
->f
))
16690 /* A padding glyph that doesn't fit on this line.
16691 This means the whole character doesn't fit
16693 row
->used
[TEXT_AREA
] = n_glyphs_before
;
16695 /* Fill the rest of the row with continuation
16696 glyphs like in 20.x. */
16697 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
16698 < row
->glyphs
[1 + TEXT_AREA
])
16699 produce_special_glyphs (it
, IT_CONTINUATION
);
16701 row
->continued_p
= 1;
16702 it
->current_x
= x_before
;
16703 it
->continuation_lines_width
+= x_before
;
16705 /* Restore the height to what it was before the
16706 element not fitting on the line. */
16707 it
->max_ascent
= ascent
;
16708 it
->max_descent
= descent
;
16709 it
->max_phys_ascent
= phys_ascent
;
16710 it
->max_phys_descent
= phys_descent
;
16712 else if (wrap_row_used
> 0)
16716 it
->continuation_lines_width
+= wrap_x
;
16717 row
->used
[TEXT_AREA
] = wrap_row_used
;
16718 row
->ascent
= wrap_row_ascent
;
16719 row
->height
= wrap_row_height
;
16720 row
->phys_ascent
= wrap_row_phys_ascent
;
16721 row
->phys_height
= wrap_row_phys_height
;
16722 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
16723 row
->continued_p
= 1;
16724 row
->ends_at_zv_p
= 0;
16725 row
->exact_window_width_line_p
= 0;
16726 it
->continuation_lines_width
+= x
;
16728 /* Make sure that a non-default face is extended
16729 up to the right margin of the window. */
16730 extend_face_to_end_of_line (it
);
16732 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
16734 /* A TAB that extends past the right edge of the
16735 window. This produces a single glyph on
16736 window system frames. We leave the glyph in
16737 this row and let it fill the row, but don't
16738 consume the TAB. */
16739 it
->continuation_lines_width
+= it
->last_visible_x
;
16740 row
->ends_in_middle_of_char_p
= 1;
16741 row
->continued_p
= 1;
16742 glyph
->pixel_width
= it
->last_visible_x
- x
;
16743 it
->starts_in_middle_of_char_p
= 1;
16747 /* Something other than a TAB that draws past
16748 the right edge of the window. Restore
16749 positions to values before the element. */
16750 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
16752 /* Display continuation glyphs. */
16753 if (!FRAME_WINDOW_P (it
->f
))
16754 produce_special_glyphs (it
, IT_CONTINUATION
);
16755 row
->continued_p
= 1;
16757 it
->current_x
= x_before
;
16758 it
->continuation_lines_width
+= x
;
16759 extend_face_to_end_of_line (it
);
16761 if (nglyphs
> 1 && i
> 0)
16763 row
->ends_in_middle_of_char_p
= 1;
16764 it
->starts_in_middle_of_char_p
= 1;
16767 /* Restore the height to what it was before the
16768 element not fitting on the line. */
16769 it
->max_ascent
= ascent
;
16770 it
->max_descent
= descent
;
16771 it
->max_phys_ascent
= phys_ascent
;
16772 it
->max_phys_descent
= phys_descent
;
16777 else if (new_x
> it
->first_visible_x
)
16779 /* Increment number of glyphs actually displayed. */
16782 if (x
< it
->first_visible_x
)
16783 /* Glyph is partially visible, i.e. row starts at
16784 negative X position. */
16785 row
->x
= x
- it
->first_visible_x
;
16789 /* Glyph is completely off the left margin of the
16790 window. This should not happen because of the
16791 move_it_in_display_line at the start of this
16792 function, unless the text display area of the
16793 window is empty. */
16794 xassert (it
->first_visible_x
<= it
->last_visible_x
);
16798 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
16799 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
16800 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
16801 row
->phys_height
= max (row
->phys_height
,
16802 it
->max_phys_ascent
+ it
->max_phys_descent
);
16803 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
16804 it
->max_extra_line_spacing
);
16806 /* End of this display line if row is continued. */
16807 if (row
->continued_p
|| row
->ends_at_zv_p
)
16812 /* Is this a line end? If yes, we're also done, after making
16813 sure that a non-default face is extended up to the right
16814 margin of the window. */
16815 if (ITERATOR_AT_END_OF_LINE_P (it
))
16817 int used_before
= row
->used
[TEXT_AREA
];
16819 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
16821 /* Add a space at the end of the line that is used to
16822 display the cursor there. */
16823 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16824 append_space_for_newline (it
, 0);
16826 /* Extend the face to the end of the line. */
16827 extend_face_to_end_of_line (it
);
16829 /* Make sure we have the position. */
16830 if (used_before
== 0)
16831 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
16833 /* Consume the line end. This skips over invisible lines. */
16834 set_iterator_to_next (it
, 1);
16835 it
->continuation_lines_width
= 0;
16839 /* Proceed with next display element. Note that this skips
16840 over lines invisible because of selective display. */
16841 set_iterator_to_next (it
, 1);
16843 /* If we truncate lines, we are done when the last displayed
16844 glyphs reach past the right margin of the window. */
16845 if (it
->line_wrap
== TRUNCATE
16846 && (FRAME_WINDOW_P (it
->f
)
16847 ? (it
->current_x
>= it
->last_visible_x
)
16848 : (it
->current_x
> it
->last_visible_x
)))
16850 /* Maybe add truncation glyphs. */
16851 if (!FRAME_WINDOW_P (it
->f
))
16855 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
16856 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
16859 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
16861 row
->used
[TEXT_AREA
] = i
;
16862 produce_special_glyphs (it
, IT_TRUNCATION
);
16865 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16867 /* Don't truncate if we can overflow newline into fringe. */
16868 if (!get_next_display_element (it
))
16870 it
->continuation_lines_width
= 0;
16871 row
->ends_at_zv_p
= 1;
16872 row
->exact_window_width_line_p
= 1;
16875 if (ITERATOR_AT_END_OF_LINE_P (it
))
16877 row
->exact_window_width_line_p
= 1;
16878 goto at_end_of_line
;
16882 row
->truncated_on_right_p
= 1;
16883 it
->continuation_lines_width
= 0;
16884 reseat_at_next_visible_line_start (it
, 0);
16885 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
16886 it
->hpos
= hpos_before
;
16887 it
->current_x
= x_before
;
16892 /* If line is not empty and hscrolled, maybe insert truncation glyphs
16893 at the left window margin. */
16894 if (it
->first_visible_x
16895 && IT_CHARPOS (*it
) != MATRIX_ROW_START_CHARPOS (row
))
16897 if (!FRAME_WINDOW_P (it
->f
))
16898 insert_left_trunc_glyphs (it
);
16899 row
->truncated_on_left_p
= 1;
16902 /* If the start of this line is the overlay arrow-position, then
16903 mark this glyph row as the one containing the overlay arrow.
16904 This is clearly a mess with variable size fonts. It would be
16905 better to let it be displayed like cursors under X. */
16906 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
16907 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
16908 !NILP (overlay_arrow_string
)))
16910 /* Overlay arrow in window redisplay is a fringe bitmap. */
16911 if (STRINGP (overlay_arrow_string
))
16913 struct glyph_row
*arrow_row
16914 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
16915 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
16916 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
16917 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
16918 struct glyph
*p2
, *end
;
16920 /* Copy the arrow glyphs. */
16921 while (glyph
< arrow_end
)
16924 /* Throw away padding glyphs. */
16926 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16927 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
16933 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
16938 xassert (INTEGERP (overlay_arrow_string
));
16939 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
16941 overlay_arrow_seen
= 1;
16944 /* Compute pixel dimensions of this line. */
16945 compute_line_metrics (it
);
16947 /* Remember the position at which this line ends. */
16948 row
->end
= it
->current
;
16950 /* Record whether this row ends inside an ellipsis. */
16951 row
->ends_in_ellipsis_p
16952 = (it
->method
== GET_FROM_DISPLAY_VECTOR
16953 && it
->ellipsis_p
);
16955 /* Save fringe bitmaps in this row. */
16956 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
16957 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
16958 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
16959 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
16961 it
->left_user_fringe_bitmap
= 0;
16962 it
->left_user_fringe_face_id
= 0;
16963 it
->right_user_fringe_bitmap
= 0;
16964 it
->right_user_fringe_face_id
= 0;
16966 /* Maybe set the cursor. */
16967 if (it
->w
->cursor
.vpos
< 0
16968 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
16969 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
16970 && cursor_row_p (it
->w
, row
))
16971 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
16973 /* Highlight trailing whitespace. */
16974 if (!NILP (Vshow_trailing_whitespace
))
16975 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
16977 /* Prepare for the next line. This line starts horizontally at (X
16978 HPOS) = (0 0). Vertical positions are incremented. As a
16979 convenience for the caller, IT->glyph_row is set to the next
16981 it
->current_x
= it
->hpos
= 0;
16982 it
->current_y
+= row
->height
;
16985 it
->start
= it
->current
;
16986 return row
->displays_text_p
;
16991 /***********************************************************************
16993 ***********************************************************************/
16995 /* Redisplay the menu bar in the frame for window W.
16997 The menu bar of X frames that don't have X toolkit support is
16998 displayed in a special window W->frame->menu_bar_window.
17000 The menu bar of terminal frames is treated specially as far as
17001 glyph matrices are concerned. Menu bar lines are not part of
17002 windows, so the update is done directly on the frame matrix rows
17003 for the menu bar. */
17006 display_menu_bar (w
)
17009 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
17014 /* Don't do all this for graphical frames. */
17016 if (FRAME_W32_P (f
))
17019 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
17025 if (FRAME_NS_P (f
))
17027 #endif /* HAVE_NS */
17029 #ifdef USE_X_TOOLKIT
17030 xassert (!FRAME_WINDOW_P (f
));
17031 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
17032 it
.first_visible_x
= 0;
17033 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
17034 #else /* not USE_X_TOOLKIT */
17035 if (FRAME_WINDOW_P (f
))
17037 /* Menu bar lines are displayed in the desired matrix of the
17038 dummy window menu_bar_window. */
17039 struct window
*menu_w
;
17040 xassert (WINDOWP (f
->menu_bar_window
));
17041 menu_w
= XWINDOW (f
->menu_bar_window
);
17042 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
17044 it
.first_visible_x
= 0;
17045 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
17049 /* This is a TTY frame, i.e. character hpos/vpos are used as
17051 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
17053 it
.first_visible_x
= 0;
17054 it
.last_visible_x
= FRAME_COLS (f
);
17056 #endif /* not USE_X_TOOLKIT */
17058 if (! mode_line_inverse_video
)
17059 /* Force the menu-bar to be displayed in the default face. */
17060 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
17062 /* Clear all rows of the menu bar. */
17063 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
17065 struct glyph_row
*row
= it
.glyph_row
+ i
;
17066 clear_glyph_row (row
);
17067 row
->enabled_p
= 1;
17068 row
->full_width_p
= 1;
17071 /* Display all items of the menu bar. */
17072 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
17073 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
17075 Lisp_Object string
;
17077 /* Stop at nil string. */
17078 string
= AREF (items
, i
+ 1);
17082 /* Remember where item was displayed. */
17083 ASET (items
, i
+ 3, make_number (it
.hpos
));
17085 /* Display the item, pad with one space. */
17086 if (it
.current_x
< it
.last_visible_x
)
17087 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
17088 SCHARS (string
) + 1, 0, 0, -1);
17091 /* Fill out the line with spaces. */
17092 if (it
.current_x
< it
.last_visible_x
)
17093 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
17095 /* Compute the total height of the lines. */
17096 compute_line_metrics (&it
);
17101 /***********************************************************************
17103 ***********************************************************************/
17105 /* Redisplay mode lines in the window tree whose root is WINDOW. If
17106 FORCE is non-zero, redisplay mode lines unconditionally.
17107 Otherwise, redisplay only mode lines that are garbaged. Value is
17108 the number of windows whose mode lines were redisplayed. */
17111 redisplay_mode_lines (window
, force
)
17112 Lisp_Object window
;
17117 while (!NILP (window
))
17119 struct window
*w
= XWINDOW (window
);
17121 if (WINDOWP (w
->hchild
))
17122 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
17123 else if (WINDOWP (w
->vchild
))
17124 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
17126 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
17127 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
17129 struct text_pos lpoint
;
17130 struct buffer
*old
= current_buffer
;
17132 /* Set the window's buffer for the mode line display. */
17133 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
17134 set_buffer_internal_1 (XBUFFER (w
->buffer
));
17136 /* Point refers normally to the selected window. For any
17137 other window, set up appropriate value. */
17138 if (!EQ (window
, selected_window
))
17140 struct text_pos pt
;
17142 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
17143 if (CHARPOS (pt
) < BEGV
)
17144 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
17145 else if (CHARPOS (pt
) > (ZV
- 1))
17146 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
17148 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
17151 /* Display mode lines. */
17152 clear_glyph_matrix (w
->desired_matrix
);
17153 if (display_mode_lines (w
))
17156 w
->must_be_updated_p
= 1;
17159 /* Restore old settings. */
17160 set_buffer_internal_1 (old
);
17161 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
17171 /* Display the mode and/or header line of window W. Value is the
17172 sum number of mode lines and header lines displayed. */
17175 display_mode_lines (w
)
17178 Lisp_Object old_selected_window
, old_selected_frame
;
17181 old_selected_frame
= selected_frame
;
17182 selected_frame
= w
->frame
;
17183 old_selected_window
= selected_window
;
17184 XSETWINDOW (selected_window
, w
);
17186 /* These will be set while the mode line specs are processed. */
17187 line_number_displayed
= 0;
17188 w
->column_number_displayed
= Qnil
;
17190 if (WINDOW_WANTS_MODELINE_P (w
))
17192 struct window
*sel_w
= XWINDOW (old_selected_window
);
17194 /* Select mode line face based on the real selected window. */
17195 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
17196 current_buffer
->mode_line_format
);
17200 if (WINDOW_WANTS_HEADER_LINE_P (w
))
17202 display_mode_line (w
, HEADER_LINE_FACE_ID
,
17203 current_buffer
->header_line_format
);
17207 selected_frame
= old_selected_frame
;
17208 selected_window
= old_selected_window
;
17213 /* Display mode or header line of window W. FACE_ID specifies which
17214 line to display; it is either MODE_LINE_FACE_ID or
17215 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
17216 display. Value is the pixel height of the mode/header line
17220 display_mode_line (w
, face_id
, format
)
17222 enum face_id face_id
;
17223 Lisp_Object format
;
17227 int count
= SPECPDL_INDEX ();
17229 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
17230 /* Don't extend on a previously drawn mode-line.
17231 This may happen if called from pos_visible_p. */
17232 it
.glyph_row
->enabled_p
= 0;
17233 prepare_desired_row (it
.glyph_row
);
17235 it
.glyph_row
->mode_line_p
= 1;
17237 if (! mode_line_inverse_video
)
17238 /* Force the mode-line to be displayed in the default face. */
17239 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
17241 record_unwind_protect (unwind_format_mode_line
,
17242 format_mode_line_unwind_data (NULL
, Qnil
, 0));
17244 mode_line_target
= MODE_LINE_DISPLAY
;
17246 /* Temporarily make frame's keyboard the current kboard so that
17247 kboard-local variables in the mode_line_format will get the right
17249 push_kboard (FRAME_KBOARD (it
.f
));
17250 record_unwind_save_match_data ();
17251 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
17254 unbind_to (count
, Qnil
);
17256 /* Fill up with spaces. */
17257 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
17259 compute_line_metrics (&it
);
17260 it
.glyph_row
->full_width_p
= 1;
17261 it
.glyph_row
->continued_p
= 0;
17262 it
.glyph_row
->truncated_on_left_p
= 0;
17263 it
.glyph_row
->truncated_on_right_p
= 0;
17265 /* Make a 3D mode-line have a shadow at its right end. */
17266 face
= FACE_FROM_ID (it
.f
, face_id
);
17267 extend_face_to_end_of_line (&it
);
17268 if (face
->box
!= FACE_NO_BOX
)
17270 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
17271 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
17272 last
->right_box_line_p
= 1;
17275 return it
.glyph_row
->height
;
17278 /* Move element ELT in LIST to the front of LIST.
17279 Return the updated list. */
17282 move_elt_to_front (elt
, list
)
17283 Lisp_Object elt
, list
;
17285 register Lisp_Object tail
, prev
;
17286 register Lisp_Object tem
;
17290 while (CONSP (tail
))
17296 /* Splice out the link TAIL. */
17298 list
= XCDR (tail
);
17300 Fsetcdr (prev
, XCDR (tail
));
17302 /* Now make it the first. */
17303 Fsetcdr (tail
, list
);
17308 tail
= XCDR (tail
);
17312 /* Not found--return unchanged LIST. */
17316 /* Contribute ELT to the mode line for window IT->w. How it
17317 translates into text depends on its data type.
17319 IT describes the display environment in which we display, as usual.
17321 DEPTH is the depth in recursion. It is used to prevent
17322 infinite recursion here.
17324 FIELD_WIDTH is the number of characters the display of ELT should
17325 occupy in the mode line, and PRECISION is the maximum number of
17326 characters to display from ELT's representation. See
17327 display_string for details.
17329 Returns the hpos of the end of the text generated by ELT.
17331 PROPS is a property list to add to any string we encounter.
17333 If RISKY is nonzero, remove (disregard) any properties in any string
17334 we encounter, and ignore :eval and :propertize.
17336 The global variable `mode_line_target' determines whether the
17337 output is passed to `store_mode_line_noprop',
17338 `store_mode_line_string', or `display_string'. */
17341 display_mode_element (it
, depth
, field_width
, precision
, elt
, props
, risky
)
17344 int field_width
, precision
;
17345 Lisp_Object elt
, props
;
17348 int n
= 0, field
, prec
;
17353 elt
= build_string ("*too-deep*");
17357 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
17361 /* A string: output it and check for %-constructs within it. */
17365 if (SCHARS (elt
) > 0
17366 && (!NILP (props
) || risky
))
17368 Lisp_Object oprops
, aelt
;
17369 oprops
= Ftext_properties_at (make_number (0), elt
);
17371 /* If the starting string's properties are not what
17372 we want, translate the string. Also, if the string
17373 is risky, do that anyway. */
17375 if (NILP (Fequal (props
, oprops
)) || risky
)
17377 /* If the starting string has properties,
17378 merge the specified ones onto the existing ones. */
17379 if (! NILP (oprops
) && !risky
)
17383 oprops
= Fcopy_sequence (oprops
);
17385 while (CONSP (tem
))
17387 oprops
= Fplist_put (oprops
, XCAR (tem
),
17388 XCAR (XCDR (tem
)));
17389 tem
= XCDR (XCDR (tem
));
17394 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
17395 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
17397 /* AELT is what we want. Move it to the front
17398 without consing. */
17400 mode_line_proptrans_alist
17401 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
17407 /* If AELT has the wrong props, it is useless.
17408 so get rid of it. */
17410 mode_line_proptrans_alist
17411 = Fdelq (aelt
, mode_line_proptrans_alist
);
17413 elt
= Fcopy_sequence (elt
);
17414 Fset_text_properties (make_number (0), Flength (elt
),
17416 /* Add this item to mode_line_proptrans_alist. */
17417 mode_line_proptrans_alist
17418 = Fcons (Fcons (elt
, props
),
17419 mode_line_proptrans_alist
);
17420 /* Truncate mode_line_proptrans_alist
17421 to at most 50 elements. */
17422 tem
= Fnthcdr (make_number (50),
17423 mode_line_proptrans_alist
);
17425 XSETCDR (tem
, Qnil
);
17434 prec
= precision
- n
;
17435 switch (mode_line_target
)
17437 case MODE_LINE_NOPROP
:
17438 case MODE_LINE_TITLE
:
17439 n
+= store_mode_line_noprop (SDATA (elt
), -1, prec
);
17441 case MODE_LINE_STRING
:
17442 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
17444 case MODE_LINE_DISPLAY
:
17445 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
17446 0, prec
, 0, STRING_MULTIBYTE (elt
));
17453 /* Handle the non-literal case. */
17455 while ((precision
<= 0 || n
< precision
)
17456 && SREF (elt
, offset
) != 0
17457 && (mode_line_target
!= MODE_LINE_DISPLAY
17458 || it
->current_x
< it
->last_visible_x
))
17460 int last_offset
= offset
;
17462 /* Advance to end of string or next format specifier. */
17463 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
17466 if (offset
- 1 != last_offset
)
17468 int nchars
, nbytes
;
17470 /* Output to end of string or up to '%'. Field width
17471 is length of string. Don't output more than
17472 PRECISION allows us. */
17475 prec
= c_string_width (SDATA (elt
) + last_offset
,
17476 offset
- last_offset
, precision
- n
,
17479 switch (mode_line_target
)
17481 case MODE_LINE_NOPROP
:
17482 case MODE_LINE_TITLE
:
17483 n
+= store_mode_line_noprop (SDATA (elt
) + last_offset
, 0, prec
);
17485 case MODE_LINE_STRING
:
17487 int bytepos
= last_offset
;
17488 int charpos
= string_byte_to_char (elt
, bytepos
);
17489 int endpos
= (precision
<= 0
17490 ? string_byte_to_char (elt
, offset
)
17491 : charpos
+ nchars
);
17493 n
+= store_mode_line_string (NULL
,
17494 Fsubstring (elt
, make_number (charpos
),
17495 make_number (endpos
)),
17499 case MODE_LINE_DISPLAY
:
17501 int bytepos
= last_offset
;
17502 int charpos
= string_byte_to_char (elt
, bytepos
);
17504 if (precision
<= 0)
17505 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
17506 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
17508 STRING_MULTIBYTE (elt
));
17513 else /* c == '%' */
17515 int percent_position
= offset
;
17517 /* Get the specified minimum width. Zero means
17520 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
17521 field
= field
* 10 + c
- '0';
17523 /* Don't pad beyond the total padding allowed. */
17524 if (field_width
- n
> 0 && field
> field_width
- n
)
17525 field
= field_width
- n
;
17527 /* Note that either PRECISION <= 0 or N < PRECISION. */
17528 prec
= precision
- n
;
17531 n
+= display_mode_element (it
, depth
, field
, prec
,
17532 Vglobal_mode_string
, props
,
17537 int bytepos
, charpos
;
17538 unsigned char *spec
;
17539 Lisp_Object string
;
17541 bytepos
= percent_position
;
17542 charpos
= (STRING_MULTIBYTE (elt
)
17543 ? string_byte_to_char (elt
, bytepos
)
17545 spec
= decode_mode_spec (it
->w
, c
, field
, prec
, &string
);
17546 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
17548 switch (mode_line_target
)
17550 case MODE_LINE_NOPROP
:
17551 case MODE_LINE_TITLE
:
17552 n
+= store_mode_line_noprop (spec
, field
, prec
);
17554 case MODE_LINE_STRING
:
17556 int len
= strlen (spec
);
17557 Lisp_Object tem
= make_string (spec
, len
);
17558 props
= Ftext_properties_at (make_number (charpos
), elt
);
17559 /* Should only keep face property in props */
17560 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
17563 case MODE_LINE_DISPLAY
:
17565 int nglyphs_before
, nwritten
;
17567 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
17568 nwritten
= display_string (spec
, string
, elt
,
17573 /* Assign to the glyphs written above the
17574 string where the `%x' came from, position
17578 struct glyph
*glyph
17579 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
17583 for (i
= 0; i
< nwritten
; ++i
)
17585 glyph
[i
].object
= elt
;
17586 glyph
[i
].charpos
= charpos
;
17603 /* A symbol: process the value of the symbol recursively
17604 as if it appeared here directly. Avoid error if symbol void.
17605 Special case: if value of symbol is a string, output the string
17608 register Lisp_Object tem
;
17610 /* If the variable is not marked as risky to set
17611 then its contents are risky to use. */
17612 if (NILP (Fget (elt
, Qrisky_local_variable
)))
17615 tem
= Fboundp (elt
);
17618 tem
= Fsymbol_value (elt
);
17619 /* If value is a string, output that string literally:
17620 don't check for % within it. */
17624 if (!EQ (tem
, elt
))
17626 /* Give up right away for nil or t. */
17636 register Lisp_Object car
, tem
;
17638 /* A cons cell: five distinct cases.
17639 If first element is :eval or :propertize, do something special.
17640 If first element is a string or a cons, process all the elements
17641 and effectively concatenate them.
17642 If first element is a negative number, truncate displaying cdr to
17643 at most that many characters. If positive, pad (with spaces)
17644 to at least that many characters.
17645 If first element is a symbol, process the cadr or caddr recursively
17646 according to whether the symbol's value is non-nil or nil. */
17648 if (EQ (car
, QCeval
))
17650 /* An element of the form (:eval FORM) means evaluate FORM
17651 and use the result as mode line elements. */
17656 if (CONSP (XCDR (elt
)))
17659 spec
= safe_eval (XCAR (XCDR (elt
)));
17660 n
+= display_mode_element (it
, depth
, field_width
- n
,
17661 precision
- n
, spec
, props
,
17665 else if (EQ (car
, QCpropertize
))
17667 /* An element of the form (:propertize ELT PROPS...)
17668 means display ELT but applying properties PROPS. */
17673 if (CONSP (XCDR (elt
)))
17674 n
+= display_mode_element (it
, depth
, field_width
- n
,
17675 precision
- n
, XCAR (XCDR (elt
)),
17676 XCDR (XCDR (elt
)), risky
);
17678 else if (SYMBOLP (car
))
17680 tem
= Fboundp (car
);
17684 /* elt is now the cdr, and we know it is a cons cell.
17685 Use its car if CAR has a non-nil value. */
17688 tem
= Fsymbol_value (car
);
17695 /* Symbol's value is nil (or symbol is unbound)
17696 Get the cddr of the original list
17697 and if possible find the caddr and use that. */
17701 else if (!CONSP (elt
))
17706 else if (INTEGERP (car
))
17708 register int lim
= XINT (car
);
17712 /* Negative int means reduce maximum width. */
17713 if (precision
<= 0)
17716 precision
= min (precision
, -lim
);
17720 /* Padding specified. Don't let it be more than
17721 current maximum. */
17723 lim
= min (precision
, lim
);
17725 /* If that's more padding than already wanted, queue it.
17726 But don't reduce padding already specified even if
17727 that is beyond the current truncation point. */
17728 field_width
= max (lim
, field_width
);
17732 else if (STRINGP (car
) || CONSP (car
))
17734 Lisp_Object halftail
= elt
;
17738 && (precision
<= 0 || n
< precision
))
17740 n
+= display_mode_element (it
, depth
,
17741 /* Do padding only after the last
17742 element in the list. */
17743 (! CONSP (XCDR (elt
))
17746 precision
- n
, XCAR (elt
),
17750 if ((len
& 1) == 0)
17751 halftail
= XCDR (halftail
);
17752 /* Check for cycle. */
17753 if (EQ (halftail
, elt
))
17762 elt
= build_string ("*invalid*");
17766 /* Pad to FIELD_WIDTH. */
17767 if (field_width
> 0 && n
< field_width
)
17769 switch (mode_line_target
)
17771 case MODE_LINE_NOPROP
:
17772 case MODE_LINE_TITLE
:
17773 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
17775 case MODE_LINE_STRING
:
17776 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
17778 case MODE_LINE_DISPLAY
:
17779 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
17788 /* Store a mode-line string element in mode_line_string_list.
17790 If STRING is non-null, display that C string. Otherwise, the Lisp
17791 string LISP_STRING is displayed.
17793 FIELD_WIDTH is the minimum number of output glyphs to produce.
17794 If STRING has fewer characters than FIELD_WIDTH, pad to the right
17795 with spaces. FIELD_WIDTH <= 0 means don't pad.
17797 PRECISION is the maximum number of characters to output from
17798 STRING. PRECISION <= 0 means don't truncate the string.
17800 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
17801 properties to the string.
17803 PROPS are the properties to add to the string.
17804 The mode_line_string_face face property is always added to the string.
17808 store_mode_line_string (string
, lisp_string
, copy_string
, field_width
, precision
, props
)
17810 Lisp_Object lisp_string
;
17819 if (string
!= NULL
)
17821 len
= strlen (string
);
17822 if (precision
> 0 && len
> precision
)
17824 lisp_string
= make_string (string
, len
);
17826 props
= mode_line_string_face_prop
;
17827 else if (!NILP (mode_line_string_face
))
17829 Lisp_Object face
= Fplist_get (props
, Qface
);
17830 props
= Fcopy_sequence (props
);
17832 face
= mode_line_string_face
;
17834 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
17835 props
= Fplist_put (props
, Qface
, face
);
17837 Fadd_text_properties (make_number (0), make_number (len
),
17838 props
, lisp_string
);
17842 len
= XFASTINT (Flength (lisp_string
));
17843 if (precision
> 0 && len
> precision
)
17846 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
17849 if (!NILP (mode_line_string_face
))
17853 props
= Ftext_properties_at (make_number (0), lisp_string
);
17854 face
= Fplist_get (props
, Qface
);
17856 face
= mode_line_string_face
;
17858 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
17859 props
= Fcons (Qface
, Fcons (face
, Qnil
));
17861 lisp_string
= Fcopy_sequence (lisp_string
);
17864 Fadd_text_properties (make_number (0), make_number (len
),
17865 props
, lisp_string
);
17870 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
17874 if (field_width
> len
)
17876 field_width
-= len
;
17877 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
17879 Fadd_text_properties (make_number (0), make_number (field_width
),
17880 props
, lisp_string
);
17881 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
17889 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
17891 doc
: /* Format a string out of a mode line format specification.
17892 First arg FORMAT specifies the mode line format (see `mode-line-format'
17893 for details) to use.
17895 Optional second arg FACE specifies the face property to put
17896 on all characters for which no face is specified.
17897 The value t means whatever face the window's mode line currently uses
17898 \(either `mode-line' or `mode-line-inactive', depending).
17899 A value of nil means the default is no face property.
17900 If FACE is an integer, the value string has no text properties.
17902 Optional third and fourth args WINDOW and BUFFER specify the window
17903 and buffer to use as the context for the formatting (defaults
17904 are the selected window and the window's buffer). */)
17905 (format
, face
, window
, buffer
)
17906 Lisp_Object format
, face
, window
, buffer
;
17911 struct buffer
*old_buffer
= NULL
;
17913 int no_props
= INTEGERP (face
);
17914 int count
= SPECPDL_INDEX ();
17916 int string_start
= 0;
17919 window
= selected_window
;
17920 CHECK_WINDOW (window
);
17921 w
= XWINDOW (window
);
17924 buffer
= w
->buffer
;
17925 CHECK_BUFFER (buffer
);
17927 /* Make formatting the modeline a non-op when noninteractive, otherwise
17928 there will be problems later caused by a partially initialized frame. */
17929 if (NILP (format
) || noninteractive
)
17930 return empty_unibyte_string
;
17938 face
= (EQ (window
, selected_window
) ? Qmode_line
: Qmode_line_inactive
);
17939 face_id
= lookup_named_face (XFRAME (WINDOW_FRAME (w
)), face
, 0);
17943 face_id
= DEFAULT_FACE_ID
;
17945 if (XBUFFER (buffer
) != current_buffer
)
17946 old_buffer
= current_buffer
;
17948 /* Save things including mode_line_proptrans_alist,
17949 and set that to nil so that we don't alter the outer value. */
17950 record_unwind_protect (unwind_format_mode_line
,
17951 format_mode_line_unwind_data
17952 (old_buffer
, selected_window
, 1));
17953 mode_line_proptrans_alist
= Qnil
;
17955 Fselect_window (window
, Qt
);
17957 set_buffer_internal_1 (XBUFFER (buffer
));
17959 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
17963 mode_line_target
= MODE_LINE_NOPROP
;
17964 mode_line_string_face_prop
= Qnil
;
17965 mode_line_string_list
= Qnil
;
17966 string_start
= MODE_LINE_NOPROP_LEN (0);
17970 mode_line_target
= MODE_LINE_STRING
;
17971 mode_line_string_list
= Qnil
;
17972 mode_line_string_face
= face
;
17973 mode_line_string_face_prop
17974 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
17977 push_kboard (FRAME_KBOARD (it
.f
));
17978 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
17983 len
= MODE_LINE_NOPROP_LEN (string_start
);
17984 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
17988 mode_line_string_list
= Fnreverse (mode_line_string_list
);
17989 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
17990 empty_unibyte_string
);
17993 unbind_to (count
, Qnil
);
17997 /* Write a null-terminated, right justified decimal representation of
17998 the positive integer D to BUF using a minimal field width WIDTH. */
18001 pint2str (buf
, width
, d
)
18002 register char *buf
;
18003 register int width
;
18006 register char *p
= buf
;
18014 *p
++ = d
% 10 + '0';
18019 for (width
-= (int) (p
- buf
); width
> 0; --width
)
18030 /* Write a null-terminated, right justified decimal and "human
18031 readable" representation of the nonnegative integer D to BUF using
18032 a minimal field width WIDTH. D should be smaller than 999.5e24. */
18034 static const char power_letter
[] =
18048 pint2hrstr (buf
, width
, d
)
18053 /* We aim to represent the nonnegative integer D as
18054 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
18057 /* -1 means: do not use TENTHS. */
18061 /* Length of QUOTIENT.TENTHS as a string. */
18067 if (1000 <= quotient
)
18069 /* Scale to the appropriate EXPONENT. */
18072 remainder
= quotient
% 1000;
18076 while (1000 <= quotient
);
18078 /* Round to nearest and decide whether to use TENTHS or not. */
18081 tenths
= remainder
/ 100;
18082 if (50 <= remainder
% 100)
18089 if (quotient
== 10)
18097 if (500 <= remainder
)
18099 if (quotient
< 999)
18110 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
18111 if (tenths
== -1 && quotient
<= 99)
18118 p
= psuffix
= buf
+ max (width
, length
);
18120 /* Print EXPONENT. */
18122 *psuffix
++ = power_letter
[exponent
];
18125 /* Print TENTHS. */
18128 *--p
= '0' + tenths
;
18132 /* Print QUOTIENT. */
18135 int digit
= quotient
% 10;
18136 *--p
= '0' + digit
;
18138 while ((quotient
/= 10) != 0);
18140 /* Print leading spaces. */
18145 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
18146 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
18147 type of CODING_SYSTEM. Return updated pointer into BUF. */
18149 static unsigned char invalid_eol_type
[] = "(*invalid*)";
18152 decode_mode_spec_coding (coding_system
, buf
, eol_flag
)
18153 Lisp_Object coding_system
;
18154 register char *buf
;
18158 int multibyte
= !NILP (current_buffer
->enable_multibyte_characters
);
18159 const unsigned char *eol_str
;
18161 /* The EOL conversion we are using. */
18162 Lisp_Object eoltype
;
18164 val
= CODING_SYSTEM_SPEC (coding_system
);
18167 if (!VECTORP (val
)) /* Not yet decided. */
18172 eoltype
= eol_mnemonic_undecided
;
18173 /* Don't mention EOL conversion if it isn't decided. */
18178 Lisp_Object eolvalue
;
18180 attrs
= AREF (val
, 0);
18181 eolvalue
= AREF (val
, 2);
18184 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
18188 /* The EOL conversion that is normal on this system. */
18190 if (NILP (eolvalue
)) /* Not yet decided. */
18191 eoltype
= eol_mnemonic_undecided
;
18192 else if (VECTORP (eolvalue
)) /* Not yet decided. */
18193 eoltype
= eol_mnemonic_undecided
;
18194 else /* eolvalue is Qunix, Qdos, or Qmac. */
18195 eoltype
= (EQ (eolvalue
, Qunix
)
18196 ? eol_mnemonic_unix
18197 : (EQ (eolvalue
, Qdos
) == 1
18198 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
18204 /* Mention the EOL conversion if it is not the usual one. */
18205 if (STRINGP (eoltype
))
18207 eol_str
= SDATA (eoltype
);
18208 eol_str_len
= SBYTES (eoltype
);
18210 else if (CHARACTERP (eoltype
))
18212 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
18213 eol_str_len
= CHAR_STRING (XINT (eoltype
), tmp
);
18218 eol_str
= invalid_eol_type
;
18219 eol_str_len
= sizeof (invalid_eol_type
) - 1;
18221 bcopy (eol_str
, buf
, eol_str_len
);
18222 buf
+= eol_str_len
;
18228 /* Return a string for the output of a mode line %-spec for window W,
18229 generated by character C. PRECISION >= 0 means don't return a
18230 string longer than that value. FIELD_WIDTH > 0 means pad the
18231 string returned with spaces to that value. Return a Lisp string in
18232 *STRING if the resulting string is taken from that Lisp string.
18234 Note we operate on the current buffer for most purposes,
18235 the exception being w->base_line_pos. */
18237 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
18240 decode_mode_spec (w
, c
, field_width
, precision
, string
)
18243 int field_width
, precision
;
18244 Lisp_Object
*string
;
18247 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18248 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
18249 struct buffer
*b
= current_buffer
;
18257 if (!NILP (b
->read_only
))
18259 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
18264 /* This differs from %* only for a modified read-only buffer. */
18265 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
18267 if (!NILP (b
->read_only
))
18272 /* This differs from %* in ignoring read-only-ness. */
18273 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
18285 if (command_loop_level
> 5)
18287 p
= decode_mode_spec_buf
;
18288 for (i
= 0; i
< command_loop_level
; i
++)
18291 return decode_mode_spec_buf
;
18299 if (command_loop_level
> 5)
18301 p
= decode_mode_spec_buf
;
18302 for (i
= 0; i
< command_loop_level
; i
++)
18305 return decode_mode_spec_buf
;
18312 /* Let lots_of_dashes be a string of infinite length. */
18313 if (mode_line_target
== MODE_LINE_NOPROP
||
18314 mode_line_target
== MODE_LINE_STRING
)
18316 if (field_width
<= 0
18317 || field_width
> sizeof (lots_of_dashes
))
18319 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
18320 decode_mode_spec_buf
[i
] = '-';
18321 decode_mode_spec_buf
[i
] = '\0';
18322 return decode_mode_spec_buf
;
18325 return lots_of_dashes
;
18333 /* %c and %l are ignored in `frame-title-format'.
18334 (In redisplay_internal, the frame title is drawn _before_ the
18335 windows are updated, so the stuff which depends on actual
18336 window contents (such as %l) may fail to render properly, or
18337 even crash emacs.) */
18338 if (mode_line_target
== MODE_LINE_TITLE
)
18342 int col
= (int) current_column (); /* iftc */
18343 w
->column_number_displayed
= make_number (col
);
18344 pint2str (decode_mode_spec_buf
, field_width
, col
);
18345 return decode_mode_spec_buf
;
18349 #ifndef SYSTEM_MALLOC
18351 if (NILP (Vmemory_full
))
18354 return "!MEM FULL! ";
18361 /* %F displays the frame name. */
18362 if (!NILP (f
->title
))
18363 return (char *) SDATA (f
->title
);
18364 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
18365 return (char *) SDATA (f
->name
);
18374 int size
= ZV
- BEGV
;
18375 pint2str (decode_mode_spec_buf
, field_width
, size
);
18376 return decode_mode_spec_buf
;
18381 int size
= ZV
- BEGV
;
18382 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
18383 return decode_mode_spec_buf
;
18388 int startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
18389 int topline
, nlines
, junk
, height
;
18391 /* %c and %l are ignored in `frame-title-format'. */
18392 if (mode_line_target
== MODE_LINE_TITLE
)
18395 startpos
= XMARKER (w
->start
)->charpos
;
18396 startpos_byte
= marker_byte_position (w
->start
);
18397 height
= WINDOW_TOTAL_LINES (w
);
18399 /* If we decided that this buffer isn't suitable for line numbers,
18400 don't forget that too fast. */
18401 if (EQ (w
->base_line_pos
, w
->buffer
))
18403 /* But do forget it, if the window shows a different buffer now. */
18404 else if (BUFFERP (w
->base_line_pos
))
18405 w
->base_line_pos
= Qnil
;
18407 /* If the buffer is very big, don't waste time. */
18408 if (INTEGERP (Vline_number_display_limit
)
18409 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
18411 w
->base_line_pos
= Qnil
;
18412 w
->base_line_number
= Qnil
;
18416 if (INTEGERP (w
->base_line_number
)
18417 && INTEGERP (w
->base_line_pos
)
18418 && XFASTINT (w
->base_line_pos
) <= startpos
)
18420 line
= XFASTINT (w
->base_line_number
);
18421 linepos
= XFASTINT (w
->base_line_pos
);
18422 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
18427 linepos
= BUF_BEGV (b
);
18428 linepos_byte
= BUF_BEGV_BYTE (b
);
18431 /* Count lines from base line to window start position. */
18432 nlines
= display_count_lines (linepos
, linepos_byte
,
18436 topline
= nlines
+ line
;
18438 /* Determine a new base line, if the old one is too close
18439 or too far away, or if we did not have one.
18440 "Too close" means it's plausible a scroll-down would
18441 go back past it. */
18442 if (startpos
== BUF_BEGV (b
))
18444 w
->base_line_number
= make_number (topline
);
18445 w
->base_line_pos
= make_number (BUF_BEGV (b
));
18447 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
18448 || linepos
== BUF_BEGV (b
))
18450 int limit
= BUF_BEGV (b
);
18451 int limit_byte
= BUF_BEGV_BYTE (b
);
18453 int distance
= (height
* 2 + 30) * line_number_display_limit_width
;
18455 if (startpos
- distance
> limit
)
18457 limit
= startpos
- distance
;
18458 limit_byte
= CHAR_TO_BYTE (limit
);
18461 nlines
= display_count_lines (startpos
, startpos_byte
,
18463 - (height
* 2 + 30),
18465 /* If we couldn't find the lines we wanted within
18466 line_number_display_limit_width chars per line,
18467 give up on line numbers for this window. */
18468 if (position
== limit_byte
&& limit
== startpos
- distance
)
18470 w
->base_line_pos
= w
->buffer
;
18471 w
->base_line_number
= Qnil
;
18475 w
->base_line_number
= make_number (topline
- nlines
);
18476 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
18479 /* Now count lines from the start pos to point. */
18480 nlines
= display_count_lines (startpos
, startpos_byte
,
18481 PT_BYTE
, PT
, &junk
);
18483 /* Record that we did display the line number. */
18484 line_number_displayed
= 1;
18486 /* Make the string to show. */
18487 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
18488 return decode_mode_spec_buf
;
18491 char* p
= decode_mode_spec_buf
;
18492 int pad
= field_width
- 2;
18498 return decode_mode_spec_buf
;
18504 obj
= b
->mode_name
;
18508 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
18514 int pos
= marker_position (w
->start
);
18515 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
18517 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
18519 if (pos
<= BUF_BEGV (b
))
18524 else if (pos
<= BUF_BEGV (b
))
18528 if (total
> 1000000)
18529 /* Do it differently for a large value, to avoid overflow. */
18530 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
18532 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
18533 /* We can't normally display a 3-digit number,
18534 so get us a 2-digit number that is close. */
18537 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
18538 return decode_mode_spec_buf
;
18542 /* Display percentage of size above the bottom of the screen. */
18545 int toppos
= marker_position (w
->start
);
18546 int botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
18547 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
18549 if (botpos
>= BUF_ZV (b
))
18551 if (toppos
<= BUF_BEGV (b
))
18558 if (total
> 1000000)
18559 /* Do it differently for a large value, to avoid overflow. */
18560 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
18562 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
18563 /* We can't normally display a 3-digit number,
18564 so get us a 2-digit number that is close. */
18567 if (toppos
<= BUF_BEGV (b
))
18568 sprintf (decode_mode_spec_buf
, "Top%2d%%", total
);
18570 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
18571 return decode_mode_spec_buf
;
18576 /* status of process */
18577 obj
= Fget_buffer_process (Fcurrent_buffer ());
18579 return "no process";
18580 #ifdef subprocesses
18581 obj
= Fsymbol_name (Fprocess_status (obj
));
18587 int count
= inhibit_garbage_collection ();
18588 Lisp_Object val
= call1 (intern ("file-remote-p"),
18589 current_buffer
->directory
);
18590 unbind_to (count
, Qnil
);
18598 case 't': /* indicate TEXT or BINARY */
18599 #ifdef MODE_LINE_BINARY_TEXT
18600 return MODE_LINE_BINARY_TEXT (b
);
18606 /* coding-system (not including end-of-line format) */
18608 /* coding-system (including end-of-line type) */
18610 int eol_flag
= (c
== 'Z');
18611 char *p
= decode_mode_spec_buf
;
18613 if (! FRAME_WINDOW_P (f
))
18615 /* No need to mention EOL here--the terminal never needs
18616 to do EOL conversion. */
18617 p
= decode_mode_spec_coding (CODING_ID_NAME
18618 (FRAME_KEYBOARD_CODING (f
)->id
),
18620 p
= decode_mode_spec_coding (CODING_ID_NAME
18621 (FRAME_TERMINAL_CODING (f
)->id
),
18624 p
= decode_mode_spec_coding (b
->buffer_file_coding_system
,
18627 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
18628 #ifdef subprocesses
18629 obj
= Fget_buffer_process (Fcurrent_buffer ());
18630 if (PROCESSP (obj
))
18632 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
18634 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
18637 #endif /* subprocesses */
18640 return decode_mode_spec_buf
;
18647 return (char *) SDATA (obj
);
18654 /* Count up to COUNT lines starting from START / START_BYTE.
18655 But don't go beyond LIMIT_BYTE.
18656 Return the number of lines thus found (always nonnegative).
18658 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
18661 display_count_lines (start
, start_byte
, limit_byte
, count
, byte_pos_ptr
)
18662 int start
, start_byte
, limit_byte
, count
;
18665 register unsigned char *cursor
;
18666 unsigned char *base
;
18668 register int ceiling
;
18669 register unsigned char *ceiling_addr
;
18670 int orig_count
= count
;
18672 /* If we are not in selective display mode,
18673 check only for newlines. */
18674 int selective_display
= (!NILP (current_buffer
->selective_display
)
18675 && !INTEGERP (current_buffer
->selective_display
));
18679 while (start_byte
< limit_byte
)
18681 ceiling
= BUFFER_CEILING_OF (start_byte
);
18682 ceiling
= min (limit_byte
- 1, ceiling
);
18683 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
18684 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
18687 if (selective_display
)
18688 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
18691 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
18694 if (cursor
!= ceiling_addr
)
18698 start_byte
+= cursor
- base
+ 1;
18699 *byte_pos_ptr
= start_byte
;
18703 if (++cursor
== ceiling_addr
)
18709 start_byte
+= cursor
- base
;
18714 while (start_byte
> limit_byte
)
18716 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
18717 ceiling
= max (limit_byte
, ceiling
);
18718 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
18719 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
18722 if (selective_display
)
18723 while (--cursor
!= ceiling_addr
18724 && *cursor
!= '\n' && *cursor
!= 015)
18727 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
18730 if (cursor
!= ceiling_addr
)
18734 start_byte
+= cursor
- base
+ 1;
18735 *byte_pos_ptr
= start_byte
;
18736 /* When scanning backwards, we should
18737 not count the newline posterior to which we stop. */
18738 return - orig_count
- 1;
18744 /* Here we add 1 to compensate for the last decrement
18745 of CURSOR, which took it past the valid range. */
18746 start_byte
+= cursor
- base
+ 1;
18750 *byte_pos_ptr
= limit_byte
;
18753 return - orig_count
+ count
;
18754 return orig_count
- count
;
18760 /***********************************************************************
18762 ***********************************************************************/
18764 /* Display a NUL-terminated string, starting with index START.
18766 If STRING is non-null, display that C string. Otherwise, the Lisp
18767 string LISP_STRING is displayed. There's a case that STRING is
18768 non-null and LISP_STRING is not nil. It means STRING is a string
18769 data of LISP_STRING. In that case, we display LISP_STRING while
18770 ignoring its text properties.
18772 If FACE_STRING is not nil, FACE_STRING_POS is a position in
18773 FACE_STRING. Display STRING or LISP_STRING with the face at
18774 FACE_STRING_POS in FACE_STRING:
18776 Display the string in the environment given by IT, but use the
18777 standard display table, temporarily.
18779 FIELD_WIDTH is the minimum number of output glyphs to produce.
18780 If STRING has fewer characters than FIELD_WIDTH, pad to the right
18781 with spaces. If STRING has more characters, more than FIELD_WIDTH
18782 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
18784 PRECISION is the maximum number of characters to output from
18785 STRING. PRECISION < 0 means don't truncate the string.
18787 This is roughly equivalent to printf format specifiers:
18789 FIELD_WIDTH PRECISION PRINTF
18790 ----------------------------------------
18796 MULTIBYTE zero means do not display multibyte chars, > 0 means do
18797 display them, and < 0 means obey the current buffer's value of
18798 enable_multibyte_characters.
18800 Value is the number of columns displayed. */
18803 display_string (string
, lisp_string
, face_string
, face_string_pos
,
18804 start
, it
, field_width
, precision
, max_x
, multibyte
)
18805 unsigned char *string
;
18806 Lisp_Object lisp_string
;
18807 Lisp_Object face_string
;
18808 EMACS_INT face_string_pos
;
18811 int field_width
, precision
, max_x
;
18814 int hpos_at_start
= it
->hpos
;
18815 int saved_face_id
= it
->face_id
;
18816 struct glyph_row
*row
= it
->glyph_row
;
18818 /* Initialize the iterator IT for iteration over STRING beginning
18819 with index START. */
18820 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
18821 precision
, field_width
, multibyte
);
18822 if (string
&& STRINGP (lisp_string
))
18823 /* LISP_STRING is the one returned by decode_mode_spec. We should
18824 ignore its text properties. */
18825 it
->stop_charpos
= -1;
18827 /* If displaying STRING, set up the face of the iterator
18828 from LISP_STRING, if that's given. */
18829 if (STRINGP (face_string
))
18835 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
18836 0, it
->region_beg_charpos
,
18837 it
->region_end_charpos
,
18838 &endptr
, it
->base_face_id
, 0);
18839 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18840 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
18843 /* Set max_x to the maximum allowed X position. Don't let it go
18844 beyond the right edge of the window. */
18846 max_x
= it
->last_visible_x
;
18848 max_x
= min (max_x
, it
->last_visible_x
);
18850 /* Skip over display elements that are not visible. because IT->w is
18852 if (it
->current_x
< it
->first_visible_x
)
18853 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
18854 MOVE_TO_POS
| MOVE_TO_X
);
18856 row
->ascent
= it
->max_ascent
;
18857 row
->height
= it
->max_ascent
+ it
->max_descent
;
18858 row
->phys_ascent
= it
->max_phys_ascent
;
18859 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18860 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18862 /* This condition is for the case that we are called with current_x
18863 past last_visible_x. */
18864 while (it
->current_x
< max_x
)
18866 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
18868 /* Get the next display element. */
18869 if (!get_next_display_element (it
))
18872 /* Produce glyphs. */
18873 x_before
= it
->current_x
;
18874 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
18875 PRODUCE_GLYPHS (it
);
18877 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
18880 while (i
< nglyphs
)
18882 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
18884 if (it
->line_wrap
!= TRUNCATE
18885 && x
+ glyph
->pixel_width
> max_x
)
18887 /* End of continued line or max_x reached. */
18888 if (CHAR_GLYPH_PADDING_P (*glyph
))
18890 /* A wide character is unbreakable. */
18891 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18892 it
->current_x
= x_before
;
18896 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
18901 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
18903 /* Glyph is at least partially visible. */
18905 if (x
< it
->first_visible_x
)
18906 it
->glyph_row
->x
= x
- it
->first_visible_x
;
18910 /* Glyph is off the left margin of the display area.
18911 Should not happen. */
18915 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18916 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18917 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18918 row
->phys_height
= max (row
->phys_height
,
18919 it
->max_phys_ascent
+ it
->max_phys_descent
);
18920 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18921 it
->max_extra_line_spacing
);
18922 x
+= glyph
->pixel_width
;
18926 /* Stop if max_x reached. */
18930 /* Stop at line ends. */
18931 if (ITERATOR_AT_END_OF_LINE_P (it
))
18933 it
->continuation_lines_width
= 0;
18937 set_iterator_to_next (it
, 1);
18939 /* Stop if truncating at the right edge. */
18940 if (it
->line_wrap
== TRUNCATE
18941 && it
->current_x
>= it
->last_visible_x
)
18943 /* Add truncation mark, but don't do it if the line is
18944 truncated at a padding space. */
18945 if (IT_CHARPOS (*it
) < it
->string_nchars
)
18947 if (!FRAME_WINDOW_P (it
->f
))
18951 if (it
->current_x
> it
->last_visible_x
)
18953 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
18954 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
18956 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
18958 row
->used
[TEXT_AREA
] = i
;
18959 produce_special_glyphs (it
, IT_TRUNCATION
);
18962 produce_special_glyphs (it
, IT_TRUNCATION
);
18964 it
->glyph_row
->truncated_on_right_p
= 1;
18970 /* Maybe insert a truncation at the left. */
18971 if (it
->first_visible_x
18972 && IT_CHARPOS (*it
) > 0)
18974 if (!FRAME_WINDOW_P (it
->f
))
18975 insert_left_trunc_glyphs (it
);
18976 it
->glyph_row
->truncated_on_left_p
= 1;
18979 it
->face_id
= saved_face_id
;
18981 /* Value is number of columns displayed. */
18982 return it
->hpos
- hpos_at_start
;
18987 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
18988 appears as an element of LIST or as the car of an element of LIST.
18989 If PROPVAL is a list, compare each element against LIST in that
18990 way, and return 1/2 if any element of PROPVAL is found in LIST.
18991 Otherwise return 0. This function cannot quit.
18992 The return value is 2 if the text is invisible but with an ellipsis
18993 and 1 if it's invisible and without an ellipsis. */
18996 invisible_p (propval
, list
)
18997 register Lisp_Object propval
;
19000 register Lisp_Object tail
, proptail
;
19002 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
19004 register Lisp_Object tem
;
19006 if (EQ (propval
, tem
))
19008 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
19009 return NILP (XCDR (tem
)) ? 1 : 2;
19012 if (CONSP (propval
))
19014 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
19016 Lisp_Object propelt
;
19017 propelt
= XCAR (proptail
);
19018 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
19020 register Lisp_Object tem
;
19022 if (EQ (propelt
, tem
))
19024 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
19025 return NILP (XCDR (tem
)) ? 1 : 2;
19033 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
19034 doc
: /* Non-nil if the property makes the text invisible.
19035 POS-OR-PROP can be a marker or number, in which case it is taken to be
19036 a position in the current buffer and the value of the `invisible' property
19037 is checked; or it can be some other value, which is then presumed to be the
19038 value of the `invisible' property of the text of interest.
19039 The non-nil value returned can be t for truly invisible text or something
19040 else if the text is replaced by an ellipsis. */)
19042 Lisp_Object pos_or_prop
;
19045 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
19046 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
19048 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
19049 return (invis
== 0 ? Qnil
19051 : make_number (invis
));
19054 /* Calculate a width or height in pixels from a specification using
19055 the following elements:
19058 NUM - a (fractional) multiple of the default font width/height
19059 (NUM) - specifies exactly NUM pixels
19060 UNIT - a fixed number of pixels, see below.
19061 ELEMENT - size of a display element in pixels, see below.
19062 (NUM . SPEC) - equals NUM * SPEC
19063 (+ SPEC SPEC ...) - add pixel values
19064 (- SPEC SPEC ...) - subtract pixel values
19065 (- SPEC) - negate pixel value
19068 INT or FLOAT - a number constant
19069 SYMBOL - use symbol's (buffer local) variable binding.
19072 in - pixels per inch *)
19073 mm - pixels per 1/1000 meter *)
19074 cm - pixels per 1/100 meter *)
19075 width - width of current font in pixels.
19076 height - height of current font in pixels.
19078 *) using the ratio(s) defined in display-pixels-per-inch.
19082 left-fringe - left fringe width in pixels
19083 right-fringe - right fringe width in pixels
19085 left-margin - left margin width in pixels
19086 right-margin - right margin width in pixels
19088 scroll-bar - scroll-bar area width in pixels
19092 Pixels corresponding to 5 inches:
19095 Total width of non-text areas on left side of window (if scroll-bar is on left):
19096 '(space :width (+ left-fringe left-margin scroll-bar))
19098 Align to first text column (in header line):
19099 '(space :align-to 0)
19101 Align to middle of text area minus half the width of variable `my-image'
19102 containing a loaded image:
19103 '(space :align-to (0.5 . (- text my-image)))
19105 Width of left margin minus width of 1 character in the default font:
19106 '(space :width (- left-margin 1))
19108 Width of left margin minus width of 2 characters in the current font:
19109 '(space :width (- left-margin (2 . width)))
19111 Center 1 character over left-margin (in header line):
19112 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
19114 Different ways to express width of left fringe plus left margin minus one pixel:
19115 '(space :width (- (+ left-fringe left-margin) (1)))
19116 '(space :width (+ left-fringe left-margin (- (1))))
19117 '(space :width (+ left-fringe left-margin (-1)))
19121 #define NUMVAL(X) \
19122 ((INTEGERP (X) || FLOATP (X)) \
19127 calc_pixel_width_or_height (res
, it
, prop
, font
, width_p
, align_to
)
19132 int width_p
, *align_to
;
19136 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
19137 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
19140 return OK_PIXELS (0);
19142 xassert (FRAME_LIVE_P (it
->f
));
19144 if (SYMBOLP (prop
))
19146 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
19148 char *unit
= SDATA (SYMBOL_NAME (prop
));
19150 if (unit
[0] == 'i' && unit
[1] == 'n')
19152 else if (unit
[0] == 'm' && unit
[1] == 'm')
19154 else if (unit
[0] == 'c' && unit
[1] == 'm')
19161 #ifdef HAVE_WINDOW_SYSTEM
19162 if (FRAME_WINDOW_P (it
->f
)
19164 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
19165 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
19167 return OK_PIXELS (ppi
/ pixels
);
19170 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
19171 || (CONSP (Vdisplay_pixels_per_inch
)
19173 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
19174 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
19176 return OK_PIXELS (ppi
/ pixels
);
19182 #ifdef HAVE_WINDOW_SYSTEM
19183 if (EQ (prop
, Qheight
))
19184 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
19185 if (EQ (prop
, Qwidth
))
19186 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
19188 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
19189 return OK_PIXELS (1);
19192 if (EQ (prop
, Qtext
))
19193 return OK_PIXELS (width_p
19194 ? window_box_width (it
->w
, TEXT_AREA
)
19195 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
19197 if (align_to
&& *align_to
< 0)
19200 if (EQ (prop
, Qleft
))
19201 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
19202 if (EQ (prop
, Qright
))
19203 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
19204 if (EQ (prop
, Qcenter
))
19205 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
19206 + window_box_width (it
->w
, TEXT_AREA
) / 2);
19207 if (EQ (prop
, Qleft_fringe
))
19208 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
19209 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
19210 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
19211 if (EQ (prop
, Qright_fringe
))
19212 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
19213 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
19214 : window_box_right_offset (it
->w
, TEXT_AREA
));
19215 if (EQ (prop
, Qleft_margin
))
19216 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
19217 if (EQ (prop
, Qright_margin
))
19218 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
19219 if (EQ (prop
, Qscroll_bar
))
19220 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
19222 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
19223 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
19224 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
19229 if (EQ (prop
, Qleft_fringe
))
19230 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
19231 if (EQ (prop
, Qright_fringe
))
19232 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
19233 if (EQ (prop
, Qleft_margin
))
19234 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
19235 if (EQ (prop
, Qright_margin
))
19236 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
19237 if (EQ (prop
, Qscroll_bar
))
19238 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
19241 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
19244 if (INTEGERP (prop
) || FLOATP (prop
))
19246 int base_unit
= (width_p
19247 ? FRAME_COLUMN_WIDTH (it
->f
)
19248 : FRAME_LINE_HEIGHT (it
->f
));
19249 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
19254 Lisp_Object car
= XCAR (prop
);
19255 Lisp_Object cdr
= XCDR (prop
);
19259 #ifdef HAVE_WINDOW_SYSTEM
19260 if (FRAME_WINDOW_P (it
->f
)
19261 && valid_image_p (prop
))
19263 int id
= lookup_image (it
->f
, prop
);
19264 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
19266 return OK_PIXELS (width_p
? img
->width
: img
->height
);
19269 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
19275 while (CONSP (cdr
))
19277 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
19278 font
, width_p
, align_to
))
19281 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
19286 if (EQ (car
, Qminus
))
19288 return OK_PIXELS (pixels
);
19291 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
19294 if (INTEGERP (car
) || FLOATP (car
))
19297 pixels
= XFLOATINT (car
);
19299 return OK_PIXELS (pixels
);
19300 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
19301 font
, width_p
, align_to
))
19302 return OK_PIXELS (pixels
* fact
);
19313 /***********************************************************************
19315 ***********************************************************************/
19317 #ifdef HAVE_WINDOW_SYSTEM
19322 dump_glyph_string (s
)
19323 struct glyph_string
*s
;
19325 fprintf (stderr
, "glyph string\n");
19326 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
19327 s
->x
, s
->y
, s
->width
, s
->height
);
19328 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
19329 fprintf (stderr
, " hl = %d\n", s
->hl
);
19330 fprintf (stderr
, " left overhang = %d, right = %d\n",
19331 s
->left_overhang
, s
->right_overhang
);
19332 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
19333 fprintf (stderr
, " extends to end of line = %d\n",
19334 s
->extends_to_end_of_line_p
);
19335 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
19336 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
19339 #endif /* GLYPH_DEBUG */
19341 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
19342 of XChar2b structures for S; it can't be allocated in
19343 init_glyph_string because it must be allocated via `alloca'. W
19344 is the window on which S is drawn. ROW and AREA are the glyph row
19345 and area within the row from which S is constructed. START is the
19346 index of the first glyph structure covered by S. HL is a
19347 face-override for drawing S. */
19350 #define OPTIONAL_HDC(hdc) hdc,
19351 #define DECLARE_HDC(hdc) HDC hdc;
19352 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
19353 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
19356 #ifndef OPTIONAL_HDC
19357 #define OPTIONAL_HDC(hdc)
19358 #define DECLARE_HDC(hdc)
19359 #define ALLOCATE_HDC(hdc, f)
19360 #define RELEASE_HDC(hdc, f)
19364 init_glyph_string (s
, OPTIONAL_HDC (hdc
) char2b
, w
, row
, area
, start
, hl
)
19365 struct glyph_string
*s
;
19369 struct glyph_row
*row
;
19370 enum glyph_row_area area
;
19372 enum draw_glyphs_face hl
;
19374 bzero (s
, sizeof *s
);
19376 s
->f
= XFRAME (w
->frame
);
19380 s
->display
= FRAME_X_DISPLAY (s
->f
);
19381 s
->window
= FRAME_X_WINDOW (s
->f
);
19382 s
->char2b
= char2b
;
19386 s
->first_glyph
= row
->glyphs
[area
] + start
;
19387 s
->height
= row
->height
;
19388 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
19389 s
->ybase
= s
->y
+ row
->ascent
;
19393 /* Append the list of glyph strings with head H and tail T to the list
19394 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
19397 append_glyph_string_lists (head
, tail
, h
, t
)
19398 struct glyph_string
**head
, **tail
;
19399 struct glyph_string
*h
, *t
;
19413 /* Prepend the list of glyph strings with head H and tail T to the
19414 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
19418 prepend_glyph_string_lists (head
, tail
, h
, t
)
19419 struct glyph_string
**head
, **tail
;
19420 struct glyph_string
*h
, *t
;
19434 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
19435 Set *HEAD and *TAIL to the resulting list. */
19438 append_glyph_string (head
, tail
, s
)
19439 struct glyph_string
**head
, **tail
;
19440 struct glyph_string
*s
;
19442 s
->next
= s
->prev
= NULL
;
19443 append_glyph_string_lists (head
, tail
, s
, s
);
19447 /* Get face and two-byte form of character C in face FACE_ID on frame
19448 F. The encoding of C is returned in *CHAR2B. MULTIBYTE_P non-zero
19449 means we want to display multibyte text. DISPLAY_P non-zero means
19450 make sure that X resources for the face returned are allocated.
19451 Value is a pointer to a realized face that is ready for display if
19452 DISPLAY_P is non-zero. */
19454 static INLINE
struct face
*
19455 get_char_face_and_encoding (f
, c
, face_id
, char2b
, multibyte_p
, display_p
)
19459 int multibyte_p
, display_p
;
19461 struct face
*face
= FACE_FROM_ID (f
, face_id
);
19465 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
19467 if (code
!= FONT_INVALID_CODE
)
19468 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
19470 STORE_XCHAR2B (char2b
, 0, 0);
19473 /* Make sure X resources of the face are allocated. */
19474 #ifdef HAVE_X_WINDOWS
19478 xassert (face
!= NULL
);
19479 PREPARE_FACE_FOR_DISPLAY (f
, face
);
19486 /* Get face and two-byte form of character glyph GLYPH on frame F.
19487 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
19488 a pointer to a realized face that is ready for display. */
19490 static INLINE
struct face
*
19491 get_glyph_face_and_encoding (f
, glyph
, char2b
, two_byte_p
)
19493 struct glyph
*glyph
;
19499 xassert (glyph
->type
== CHAR_GLYPH
);
19500 face
= FACE_FROM_ID (f
, glyph
->face_id
);
19509 if (CHAR_BYTE8_P (glyph
->u
.ch
))
19510 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
19512 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
19514 if (code
!= FONT_INVALID_CODE
)
19515 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
19517 STORE_XCHAR2B (char2b
, 0, 0);
19520 /* Make sure X resources of the face are allocated. */
19521 xassert (face
!= NULL
);
19522 PREPARE_FACE_FOR_DISPLAY (f
, face
);
19527 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
19528 Retunr 1 if FONT has a glyph for C, otherwise return 0. */
19531 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
19535 if (CHAR_BYTE8_P (c
))
19536 code
= CHAR_TO_BYTE8 (c
);
19538 code
= font
->driver
->encode_char (font
, c
);
19540 if (code
== FONT_INVALID_CODE
)
19542 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
19547 /* Fill glyph string S with composition components specified by S->cmp.
19549 BASE_FACE is the base face of the composition.
19550 S->cmp_from is the index of the first component for S.
19552 OVERLAPS non-zero means S should draw the foreground only, and use
19553 its physical height for clipping. See also draw_glyphs.
19555 Value is the index of a component not in S. */
19558 fill_composite_glyph_string (s
, base_face
, overlaps
)
19559 struct glyph_string
*s
;
19560 struct face
*base_face
;
19564 /* For all glyphs of this composition, starting at the offset
19565 S->cmp_from, until we reach the end of the definition or encounter a
19566 glyph that requires the different face, add it to S. */
19571 s
->for_overlaps
= overlaps
;
19574 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
19576 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
19580 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
19583 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
19584 s
->char2b
+ i
, 1, 1);
19590 s
->font
= s
->face
->font
;
19592 else if (s
->face
!= face
)
19600 /* All glyph strings for the same composition has the same width,
19601 i.e. the width set for the first component of the composition. */
19602 s
->width
= s
->first_glyph
->pixel_width
;
19604 /* If the specified font could not be loaded, use the frame's
19605 default font, but record the fact that we couldn't load it in
19606 the glyph string so that we can draw rectangles for the
19607 characters of the glyph string. */
19608 if (s
->font
== NULL
)
19610 s
->font_not_found_p
= 1;
19611 s
->font
= FRAME_FONT (s
->f
);
19614 /* Adjust base line for subscript/superscript text. */
19615 s
->ybase
+= s
->first_glyph
->voffset
;
19617 /* This glyph string must always be drawn with 16-bit functions. */
19624 fill_gstring_glyph_string (s
, face_id
, start
, end
, overlaps
)
19625 struct glyph_string
*s
;
19627 int start
, end
, overlaps
;
19629 struct glyph
*glyph
, *last
;
19630 Lisp_Object lgstring
;
19633 s
->for_overlaps
= overlaps
;
19634 glyph
= s
->row
->glyphs
[s
->area
] + start
;
19635 last
= s
->row
->glyphs
[s
->area
] + end
;
19636 s
->cmp_id
= glyph
->u
.cmp
.id
;
19637 s
->cmp_from
= glyph
->u
.cmp
.from
;
19638 s
->cmp_to
= glyph
->u
.cmp
.to
+ 1;
19639 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
19640 lgstring
= composition_gstring_from_id (s
->cmp_id
);
19641 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
19643 while (glyph
< last
19644 && glyph
->u
.cmp
.automatic
19645 && glyph
->u
.cmp
.id
== s
->cmp_id
19646 && s
->cmp_to
== glyph
->u
.cmp
.from
)
19647 s
->cmp_to
= (glyph
++)->u
.cmp
.to
+ 1;
19649 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
19651 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
19652 unsigned code
= LGLYPH_CODE (lglyph
);
19654 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
19656 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
19657 return glyph
- s
->row
->glyphs
[s
->area
];
19661 /* Fill glyph string S from a sequence of character glyphs.
19663 FACE_ID is the face id of the string. START is the index of the
19664 first glyph to consider, END is the index of the last + 1.
19665 OVERLAPS non-zero means S should draw the foreground only, and use
19666 its physical height for clipping. See also draw_glyphs.
19668 Value is the index of the first glyph not in S. */
19671 fill_glyph_string (s
, face_id
, start
, end
, overlaps
)
19672 struct glyph_string
*s
;
19674 int start
, end
, overlaps
;
19676 struct glyph
*glyph
, *last
;
19678 int glyph_not_available_p
;
19680 xassert (s
->f
== XFRAME (s
->w
->frame
));
19681 xassert (s
->nchars
== 0);
19682 xassert (start
>= 0 && end
> start
);
19684 s
->for_overlaps
= overlaps
;
19685 glyph
= s
->row
->glyphs
[s
->area
] + start
;
19686 last
= s
->row
->glyphs
[s
->area
] + end
;
19687 voffset
= glyph
->voffset
;
19688 s
->padding_p
= glyph
->padding_p
;
19689 glyph_not_available_p
= glyph
->glyph_not_available_p
;
19691 while (glyph
< last
19692 && glyph
->type
== CHAR_GLYPH
19693 && glyph
->voffset
== voffset
19694 /* Same face id implies same font, nowadays. */
19695 && glyph
->face_id
== face_id
19696 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
19700 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
19701 s
->char2b
+ s
->nchars
,
19703 s
->two_byte_p
= two_byte_p
;
19705 xassert (s
->nchars
<= end
- start
);
19706 s
->width
+= glyph
->pixel_width
;
19707 if (glyph
++->padding_p
!= s
->padding_p
)
19711 s
->font
= s
->face
->font
;
19713 /* If the specified font could not be loaded, use the frame's font,
19714 but record the fact that we couldn't load it in
19715 S->font_not_found_p so that we can draw rectangles for the
19716 characters of the glyph string. */
19717 if (s
->font
== NULL
|| glyph_not_available_p
)
19719 s
->font_not_found_p
= 1;
19720 s
->font
= FRAME_FONT (s
->f
);
19723 /* Adjust base line for subscript/superscript text. */
19724 s
->ybase
+= voffset
;
19726 xassert (s
->face
&& s
->face
->gc
);
19727 return glyph
- s
->row
->glyphs
[s
->area
];
19731 /* Fill glyph string S from image glyph S->first_glyph. */
19734 fill_image_glyph_string (s
)
19735 struct glyph_string
*s
;
19737 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
19738 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
19740 s
->slice
= s
->first_glyph
->slice
;
19741 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
19742 s
->font
= s
->face
->font
;
19743 s
->width
= s
->first_glyph
->pixel_width
;
19745 /* Adjust base line for subscript/superscript text. */
19746 s
->ybase
+= s
->first_glyph
->voffset
;
19750 /* Fill glyph string S from a sequence of stretch glyphs.
19752 ROW is the glyph row in which the glyphs are found, AREA is the
19753 area within the row. START is the index of the first glyph to
19754 consider, END is the index of the last + 1.
19756 Value is the index of the first glyph not in S. */
19759 fill_stretch_glyph_string (s
, row
, area
, start
, end
)
19760 struct glyph_string
*s
;
19761 struct glyph_row
*row
;
19762 enum glyph_row_area area
;
19765 struct glyph
*glyph
, *last
;
19766 int voffset
, face_id
;
19768 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
19770 glyph
= s
->row
->glyphs
[s
->area
] + start
;
19771 last
= s
->row
->glyphs
[s
->area
] + end
;
19772 face_id
= glyph
->face_id
;
19773 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
19774 s
->font
= s
->face
->font
;
19775 s
->width
= glyph
->pixel_width
;
19777 voffset
= glyph
->voffset
;
19781 && glyph
->type
== STRETCH_GLYPH
19782 && glyph
->voffset
== voffset
19783 && glyph
->face_id
== face_id
);
19785 s
->width
+= glyph
->pixel_width
;
19787 /* Adjust base line for subscript/superscript text. */
19788 s
->ybase
+= voffset
;
19790 /* The case that face->gc == 0 is handled when drawing the glyph
19791 string by calling PREPARE_FACE_FOR_DISPLAY. */
19793 return glyph
- s
->row
->glyphs
[s
->area
];
19796 static struct font_metrics
*
19797 get_per_char_metric (f
, font
, char2b
)
19802 static struct font_metrics metrics
;
19803 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
19805 if (! font
|| code
== FONT_INVALID_CODE
)
19807 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
19812 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
19813 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
19814 assumed to be zero. */
19817 x_get_glyph_overhangs (glyph
, f
, left
, right
)
19818 struct glyph
*glyph
;
19822 *left
= *right
= 0;
19824 if (glyph
->type
== CHAR_GLYPH
)
19828 struct font_metrics
*pcm
;
19830 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
19831 if (face
->font
&& (pcm
= get_per_char_metric (f
, face
->font
, &char2b
)))
19833 if (pcm
->rbearing
> pcm
->width
)
19834 *right
= pcm
->rbearing
- pcm
->width
;
19835 if (pcm
->lbearing
< 0)
19836 *left
= -pcm
->lbearing
;
19839 else if (glyph
->type
== COMPOSITE_GLYPH
)
19841 if (! glyph
->u
.cmp
.automatic
)
19843 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
19845 if (cmp
->rbearing
> cmp
->pixel_width
)
19846 *right
= cmp
->rbearing
- cmp
->pixel_width
;
19847 if (cmp
->lbearing
< 0)
19848 *left
= - cmp
->lbearing
;
19852 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
19853 struct font_metrics metrics
;
19855 composition_gstring_width (gstring
, glyph
->u
.cmp
.from
,
19856 glyph
->u
.cmp
.to
+ 1, &metrics
);
19857 if (metrics
.rbearing
> metrics
.width
)
19858 *right
= metrics
.rbearing
- metrics
.width
;
19859 if (metrics
.lbearing
< 0)
19860 *left
= - metrics
.lbearing
;
19866 /* Return the index of the first glyph preceding glyph string S that
19867 is overwritten by S because of S's left overhang. Value is -1
19868 if no glyphs are overwritten. */
19871 left_overwritten (s
)
19872 struct glyph_string
*s
;
19876 if (s
->left_overhang
)
19879 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19880 int first
= s
->first_glyph
- glyphs
;
19882 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
19883 x
-= glyphs
[i
].pixel_width
;
19894 /* Return the index of the first glyph preceding glyph string S that
19895 is overwriting S because of its right overhang. Value is -1 if no
19896 glyph in front of S overwrites S. */
19899 left_overwriting (s
)
19900 struct glyph_string
*s
;
19903 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19904 int first
= s
->first_glyph
- glyphs
;
19908 for (i
= first
- 1; i
>= 0; --i
)
19911 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
19914 x
-= glyphs
[i
].pixel_width
;
19921 /* Return the index of the last glyph following glyph string S that is
19922 overwritten by S because of S's right overhang. Value is -1 if
19923 no such glyph is found. */
19926 right_overwritten (s
)
19927 struct glyph_string
*s
;
19931 if (s
->right_overhang
)
19934 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19935 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
19936 int end
= s
->row
->used
[s
->area
];
19938 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
19939 x
+= glyphs
[i
].pixel_width
;
19948 /* Return the index of the last glyph following glyph string S that
19949 overwrites S because of its left overhang. Value is negative
19950 if no such glyph is found. */
19953 right_overwriting (s
)
19954 struct glyph_string
*s
;
19957 int end
= s
->row
->used
[s
->area
];
19958 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19959 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
19963 for (i
= first
; i
< end
; ++i
)
19966 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
19969 x
+= glyphs
[i
].pixel_width
;
19976 /* Set background width of glyph string S. START is the index of the
19977 first glyph following S. LAST_X is the right-most x-position + 1
19978 in the drawing area. */
19981 set_glyph_string_background_width (s
, start
, last_x
)
19982 struct glyph_string
*s
;
19986 /* If the face of this glyph string has to be drawn to the end of
19987 the drawing area, set S->extends_to_end_of_line_p. */
19989 if (start
== s
->row
->used
[s
->area
]
19990 && s
->area
== TEXT_AREA
19991 && ((s
->row
->fill_line_p
19992 && (s
->hl
== DRAW_NORMAL_TEXT
19993 || s
->hl
== DRAW_IMAGE_RAISED
19994 || s
->hl
== DRAW_IMAGE_SUNKEN
))
19995 || s
->hl
== DRAW_MOUSE_FACE
))
19996 s
->extends_to_end_of_line_p
= 1;
19998 /* If S extends its face to the end of the line, set its
19999 background_width to the distance to the right edge of the drawing
20001 if (s
->extends_to_end_of_line_p
)
20002 s
->background_width
= last_x
- s
->x
+ 1;
20004 s
->background_width
= s
->width
;
20008 /* Compute overhangs and x-positions for glyph string S and its
20009 predecessors, or successors. X is the starting x-position for S.
20010 BACKWARD_P non-zero means process predecessors. */
20013 compute_overhangs_and_x (s
, x
, backward_p
)
20014 struct glyph_string
*s
;
20022 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
20023 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
20033 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
20034 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
20044 /* The following macros are only called from draw_glyphs below.
20045 They reference the following parameters of that function directly:
20046 `w', `row', `area', and `overlap_p'
20047 as well as the following local variables:
20048 `s', `f', and `hdc' (in W32) */
20051 /* On W32, silently add local `hdc' variable to argument list of
20052 init_glyph_string. */
20053 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
20054 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
20056 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
20057 init_glyph_string (s, char2b, w, row, area, start, hl)
20060 /* Add a glyph string for a stretch glyph to the list of strings
20061 between HEAD and TAIL. START is the index of the stretch glyph in
20062 row area AREA of glyph row ROW. END is the index of the last glyph
20063 in that glyph row area. X is the current output position assigned
20064 to the new glyph string constructed. HL overrides that face of the
20065 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
20066 is the right-most x-position of the drawing area. */
20068 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
20069 and below -- keep them on one line. */
20070 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
20073 s = (struct glyph_string *) alloca (sizeof *s); \
20074 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
20075 START = fill_stretch_glyph_string (s, row, area, START, END); \
20076 append_glyph_string (&HEAD, &TAIL, s); \
20082 /* Add a glyph string for an image glyph to the list of strings
20083 between HEAD and TAIL. START is the index of the image glyph in
20084 row area AREA of glyph row ROW. END is the index of the last glyph
20085 in that glyph row area. X is the current output position assigned
20086 to the new glyph string constructed. HL overrides that face of the
20087 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
20088 is the right-most x-position of the drawing area. */
20090 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
20093 s = (struct glyph_string *) alloca (sizeof *s); \
20094 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
20095 fill_image_glyph_string (s); \
20096 append_glyph_string (&HEAD, &TAIL, s); \
20103 /* Add a glyph string for a sequence of character glyphs to the list
20104 of strings between HEAD and TAIL. START is the index of the first
20105 glyph in row area AREA of glyph row ROW that is part of the new
20106 glyph string. END is the index of the last glyph in that glyph row
20107 area. X is the current output position assigned to the new glyph
20108 string constructed. HL overrides that face of the glyph; e.g. it
20109 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
20110 right-most x-position of the drawing area. */
20112 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
20118 face_id = (row)->glyphs[area][START].face_id; \
20120 s = (struct glyph_string *) alloca (sizeof *s); \
20121 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
20122 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
20123 append_glyph_string (&HEAD, &TAIL, s); \
20125 START = fill_glyph_string (s, face_id, START, END, overlaps); \
20130 /* Add a glyph string for a composite sequence to the list of strings
20131 between HEAD and TAIL. START is the index of the first glyph in
20132 row area AREA of glyph row ROW that is part of the new glyph
20133 string. END is the index of the last glyph in that glyph row area.
20134 X is the current output position assigned to the new glyph string
20135 constructed. HL overrides that face of the glyph; e.g. it is
20136 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
20137 x-position of the drawing area. */
20139 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
20141 int face_id = (row)->glyphs[area][START].face_id; \
20142 struct face *base_face = FACE_FROM_ID (f, face_id); \
20143 int cmp_id = (row)->glyphs[area][START].u.cmp.id; \
20144 struct composition *cmp = composition_table[cmp_id]; \
20146 struct glyph_string *first_s; \
20149 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
20151 /* Make glyph_strings for each glyph sequence that is drawable by \
20152 the same face, and append them to HEAD/TAIL. */ \
20153 for (n = 0; n < cmp->glyph_len;) \
20155 s = (struct glyph_string *) alloca (sizeof *s); \
20156 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
20157 append_glyph_string (&(HEAD), &(TAIL), s); \
20163 n = fill_composite_glyph_string (s, base_face, overlaps); \
20171 /* Add a glyph string for a glyph-string sequence to the list of strings
20172 between HEAD and TAIL. */
20174 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
20178 Lisp_Object gstring; \
20180 face_id = (row)->glyphs[area][START].face_id; \
20181 gstring = (composition_gstring_from_id \
20182 ((row)->glyphs[area][START].u.cmp.id)); \
20183 s = (struct glyph_string *) alloca (sizeof *s); \
20184 char2b = (XChar2b *) alloca ((sizeof *char2b) \
20185 * LGSTRING_GLYPH_LEN (gstring)); \
20186 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
20187 append_glyph_string (&(HEAD), &(TAIL), s); \
20189 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
20193 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
20194 of AREA of glyph row ROW on window W between indices START and END.
20195 HL overrides the face for drawing glyph strings, e.g. it is
20196 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
20197 x-positions of the drawing area.
20199 This is an ugly monster macro construct because we must use alloca
20200 to allocate glyph strings (because draw_glyphs can be called
20201 asynchronously). */
20203 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
20206 HEAD = TAIL = NULL; \
20207 while (START < END) \
20209 struct glyph *first_glyph = (row)->glyphs[area] + START; \
20210 switch (first_glyph->type) \
20213 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
20217 case COMPOSITE_GLYPH: \
20218 if (first_glyph->u.cmp.automatic) \
20219 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
20222 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
20226 case STRETCH_GLYPH: \
20227 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
20231 case IMAGE_GLYPH: \
20232 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
20242 set_glyph_string_background_width (s, START, LAST_X); \
20249 /* Draw glyphs between START and END in AREA of ROW on window W,
20250 starting at x-position X. X is relative to AREA in W. HL is a
20251 face-override with the following meaning:
20253 DRAW_NORMAL_TEXT draw normally
20254 DRAW_CURSOR draw in cursor face
20255 DRAW_MOUSE_FACE draw in mouse face.
20256 DRAW_INVERSE_VIDEO draw in mode line face
20257 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
20258 DRAW_IMAGE_RAISED draw an image with a raised relief around it
20260 If OVERLAPS is non-zero, draw only the foreground of characters and
20261 clip to the physical height of ROW. Non-zero value also defines
20262 the overlapping part to be drawn:
20264 OVERLAPS_PRED overlap with preceding rows
20265 OVERLAPS_SUCC overlap with succeeding rows
20266 OVERLAPS_BOTH overlap with both preceding/succeeding rows
20267 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
20269 Value is the x-position reached, relative to AREA of W. */
20272 draw_glyphs (w
, x
, row
, area
, start
, end
, hl
, overlaps
)
20275 struct glyph_row
*row
;
20276 enum glyph_row_area area
;
20277 EMACS_INT start
, end
;
20278 enum draw_glyphs_face hl
;
20281 struct glyph_string
*head
, *tail
;
20282 struct glyph_string
*s
;
20283 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
20284 int i
, j
, x_reached
, last_x
, area_left
= 0;
20285 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
20288 ALLOCATE_HDC (hdc
, f
);
20290 /* Let's rather be paranoid than getting a SEGV. */
20291 end
= min (end
, row
->used
[area
]);
20292 start
= max (0, start
);
20293 start
= min (end
, start
);
20295 /* Translate X to frame coordinates. Set last_x to the right
20296 end of the drawing area. */
20297 if (row
->full_width_p
)
20299 /* X is relative to the left edge of W, without scroll bars
20301 area_left
= WINDOW_LEFT_EDGE_X (w
);
20302 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
20306 area_left
= window_box_left (w
, area
);
20307 last_x
= area_left
+ window_box_width (w
, area
);
20311 /* Build a doubly-linked list of glyph_string structures between
20312 head and tail from what we have to draw. Note that the macro
20313 BUILD_GLYPH_STRINGS will modify its start parameter. That's
20314 the reason we use a separate variable `i'. */
20316 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
20318 x_reached
= tail
->x
+ tail
->background_width
;
20322 /* If there are any glyphs with lbearing < 0 or rbearing > width in
20323 the row, redraw some glyphs in front or following the glyph
20324 strings built above. */
20325 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
20327 struct glyph_string
*h
, *t
;
20328 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
20329 int mouse_beg_col
, mouse_end_col
, check_mouse_face
= 0;
20332 /* If mouse highlighting is on, we may need to draw adjacent
20333 glyphs using mouse-face highlighting. */
20334 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
20336 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
20338 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
20339 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
20341 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
20343 check_mouse_face
= 1;
20344 mouse_beg_col
= (row
== mouse_beg_row
)
20345 ? dpyinfo
->mouse_face_beg_col
: 0;
20346 mouse_end_col
= (row
== mouse_end_row
)
20347 ? dpyinfo
->mouse_face_end_col
20348 : row
->used
[TEXT_AREA
];
20352 /* Compute overhangs for all glyph strings. */
20353 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
20354 for (s
= head
; s
; s
= s
->next
)
20355 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
20357 /* Prepend glyph strings for glyphs in front of the first glyph
20358 string that are overwritten because of the first glyph
20359 string's left overhang. The background of all strings
20360 prepended must be drawn because the first glyph string
20362 i
= left_overwritten (head
);
20365 enum draw_glyphs_face overlap_hl
;
20367 /* If this row contains mouse highlighting, attempt to draw
20368 the overlapped glyphs with the correct highlight. This
20369 code fails if the overlap encompasses more than one glyph
20370 and mouse-highlight spans only some of these glyphs.
20371 However, making it work perfectly involves a lot more
20372 code, and I don't know if the pathological case occurs in
20373 practice, so we'll stick to this for now. --- cyd */
20374 if (check_mouse_face
20375 && mouse_beg_col
< start
&& mouse_end_col
> i
)
20376 overlap_hl
= DRAW_MOUSE_FACE
;
20378 overlap_hl
= DRAW_NORMAL_TEXT
;
20381 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
20382 overlap_hl
, dummy_x
, last_x
);
20384 compute_overhangs_and_x (t
, head
->x
, 1);
20385 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
20389 /* Prepend glyph strings for glyphs in front of the first glyph
20390 string that overwrite that glyph string because of their
20391 right overhang. For these strings, only the foreground must
20392 be drawn, because it draws over the glyph string at `head'.
20393 The background must not be drawn because this would overwrite
20394 right overhangs of preceding glyphs for which no glyph
20396 i
= left_overwriting (head
);
20399 enum draw_glyphs_face overlap_hl
;
20401 if (check_mouse_face
20402 && mouse_beg_col
< start
&& mouse_end_col
> i
)
20403 overlap_hl
= DRAW_MOUSE_FACE
;
20405 overlap_hl
= DRAW_NORMAL_TEXT
;
20408 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
20409 overlap_hl
, dummy_x
, last_x
);
20410 for (s
= h
; s
; s
= s
->next
)
20411 s
->background_filled_p
= 1;
20412 compute_overhangs_and_x (t
, head
->x
, 1);
20413 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
20416 /* Append glyphs strings for glyphs following the last glyph
20417 string tail that are overwritten by tail. The background of
20418 these strings has to be drawn because tail's foreground draws
20420 i
= right_overwritten (tail
);
20423 enum draw_glyphs_face overlap_hl
;
20425 if (check_mouse_face
20426 && mouse_beg_col
< i
&& mouse_end_col
> end
)
20427 overlap_hl
= DRAW_MOUSE_FACE
;
20429 overlap_hl
= DRAW_NORMAL_TEXT
;
20431 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
20432 overlap_hl
, x
, last_x
);
20433 /* Because BUILD_GLYPH_STRINGS updates the first argument,
20434 we don't have `end = i;' here. */
20435 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
20436 append_glyph_string_lists (&head
, &tail
, h
, t
);
20440 /* Append glyph strings for glyphs following the last glyph
20441 string tail that overwrite tail. The foreground of such
20442 glyphs has to be drawn because it writes into the background
20443 of tail. The background must not be drawn because it could
20444 paint over the foreground of following glyphs. */
20445 i
= right_overwriting (tail
);
20448 enum draw_glyphs_face overlap_hl
;
20449 if (check_mouse_face
20450 && mouse_beg_col
< i
&& mouse_end_col
> end
)
20451 overlap_hl
= DRAW_MOUSE_FACE
;
20453 overlap_hl
= DRAW_NORMAL_TEXT
;
20456 i
++; /* We must include the Ith glyph. */
20457 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
20458 overlap_hl
, x
, last_x
);
20459 for (s
= h
; s
; s
= s
->next
)
20460 s
->background_filled_p
= 1;
20461 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
20462 append_glyph_string_lists (&head
, &tail
, h
, t
);
20464 if (clip_head
|| clip_tail
)
20465 for (s
= head
; s
; s
= s
->next
)
20467 s
->clip_head
= clip_head
;
20468 s
->clip_tail
= clip_tail
;
20472 /* Draw all strings. */
20473 for (s
= head
; s
; s
= s
->next
)
20474 FRAME_RIF (f
)->draw_glyph_string (s
);
20477 /* When focus a sole frame and move horizontally, this sets on_p to 0
20478 causing a failure to erase prev cursor position. */
20479 if (area
== TEXT_AREA
20480 && !row
->full_width_p
20481 /* When drawing overlapping rows, only the glyph strings'
20482 foreground is drawn, which doesn't erase a cursor
20486 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
20487 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
20488 : (tail
? tail
->x
+ tail
->background_width
: x
));
20492 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
20493 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
20497 /* Value is the x-position up to which drawn, relative to AREA of W.
20498 This doesn't include parts drawn because of overhangs. */
20499 if (row
->full_width_p
)
20500 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
20502 x_reached
-= area_left
;
20504 RELEASE_HDC (hdc
, f
);
20509 /* Expand row matrix if too narrow. Don't expand if area
20512 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
20514 if (!fonts_changed_p \
20515 && (it->glyph_row->glyphs[area] \
20516 < it->glyph_row->glyphs[area + 1])) \
20518 it->w->ncols_scale_factor++; \
20519 fonts_changed_p = 1; \
20523 /* Store one glyph for IT->char_to_display in IT->glyph_row.
20524 Called from x_produce_glyphs when IT->glyph_row is non-null. */
20530 struct glyph
*glyph
;
20531 enum glyph_row_area area
= it
->area
;
20533 xassert (it
->glyph_row
);
20534 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
20536 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20537 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20539 glyph
->charpos
= CHARPOS (it
->position
);
20540 glyph
->object
= it
->object
;
20541 if (it
->pixel_width
> 0)
20543 glyph
->pixel_width
= it
->pixel_width
;
20544 glyph
->padding_p
= 0;
20548 /* Assure at least 1-pixel width. Otherwise, cursor can't
20549 be displayed correctly. */
20550 glyph
->pixel_width
= 1;
20551 glyph
->padding_p
= 1;
20553 glyph
->ascent
= it
->ascent
;
20554 glyph
->descent
= it
->descent
;
20555 glyph
->voffset
= it
->voffset
;
20556 glyph
->type
= CHAR_GLYPH
;
20557 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
20558 glyph
->multibyte_p
= it
->multibyte_p
;
20559 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20560 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20561 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
20562 || it
->phys_descent
> it
->descent
);
20563 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
20564 glyph
->face_id
= it
->face_id
;
20565 glyph
->u
.ch
= it
->char_to_display
;
20566 glyph
->slice
= null_glyph_slice
;
20567 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20568 ++it
->glyph_row
->used
[area
];
20571 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20574 /* Store one glyph for the composition IT->cmp_it.id in
20575 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
20579 append_composite_glyph (it
)
20582 struct glyph
*glyph
;
20583 enum glyph_row_area area
= it
->area
;
20585 xassert (it
->glyph_row
);
20587 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20588 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20590 glyph
->charpos
= CHARPOS (it
->position
);
20591 glyph
->object
= it
->object
;
20592 glyph
->pixel_width
= it
->pixel_width
;
20593 glyph
->ascent
= it
->ascent
;
20594 glyph
->descent
= it
->descent
;
20595 glyph
->voffset
= it
->voffset
;
20596 glyph
->type
= COMPOSITE_GLYPH
;
20597 if (it
->cmp_it
.ch
< 0)
20599 glyph
->u
.cmp
.automatic
= 0;
20600 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
20604 glyph
->u
.cmp
.automatic
= 1;
20605 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
20606 glyph
->u
.cmp
.from
= it
->cmp_it
.from
;
20607 glyph
->u
.cmp
.to
= it
->cmp_it
.to
- 1;
20609 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
20610 glyph
->multibyte_p
= it
->multibyte_p
;
20611 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20612 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20613 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
20614 || it
->phys_descent
> it
->descent
);
20615 glyph
->padding_p
= 0;
20616 glyph
->glyph_not_available_p
= 0;
20617 glyph
->face_id
= it
->face_id
;
20618 glyph
->slice
= null_glyph_slice
;
20619 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20620 ++it
->glyph_row
->used
[area
];
20623 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20627 /* Change IT->ascent and IT->height according to the setting of
20631 take_vertical_position_into_account (it
)
20636 if (it
->voffset
< 0)
20637 /* Increase the ascent so that we can display the text higher
20639 it
->ascent
-= it
->voffset
;
20641 /* Increase the descent so that we can display the text lower
20643 it
->descent
+= it
->voffset
;
20648 /* Produce glyphs/get display metrics for the image IT is loaded with.
20649 See the description of struct display_iterator in dispextern.h for
20650 an overview of struct display_iterator. */
20653 produce_image_glyph (it
)
20658 int glyph_ascent
, crop
;
20659 struct glyph_slice slice
;
20661 xassert (it
->what
== IT_IMAGE
);
20663 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20665 /* Make sure X resources of the face is loaded. */
20666 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
20668 if (it
->image_id
< 0)
20670 /* Fringe bitmap. */
20671 it
->ascent
= it
->phys_ascent
= 0;
20672 it
->descent
= it
->phys_descent
= 0;
20673 it
->pixel_width
= 0;
20678 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
20680 /* Make sure X resources of the image is loaded. */
20681 prepare_image_for_display (it
->f
, img
);
20683 slice
.x
= slice
.y
= 0;
20684 slice
.width
= img
->width
;
20685 slice
.height
= img
->height
;
20687 if (INTEGERP (it
->slice
.x
))
20688 slice
.x
= XINT (it
->slice
.x
);
20689 else if (FLOATP (it
->slice
.x
))
20690 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
20692 if (INTEGERP (it
->slice
.y
))
20693 slice
.y
= XINT (it
->slice
.y
);
20694 else if (FLOATP (it
->slice
.y
))
20695 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
20697 if (INTEGERP (it
->slice
.width
))
20698 slice
.width
= XINT (it
->slice
.width
);
20699 else if (FLOATP (it
->slice
.width
))
20700 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
20702 if (INTEGERP (it
->slice
.height
))
20703 slice
.height
= XINT (it
->slice
.height
);
20704 else if (FLOATP (it
->slice
.height
))
20705 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
20707 if (slice
.x
>= img
->width
)
20708 slice
.x
= img
->width
;
20709 if (slice
.y
>= img
->height
)
20710 slice
.y
= img
->height
;
20711 if (slice
.x
+ slice
.width
>= img
->width
)
20712 slice
.width
= img
->width
- slice
.x
;
20713 if (slice
.y
+ slice
.height
> img
->height
)
20714 slice
.height
= img
->height
- slice
.y
;
20716 if (slice
.width
== 0 || slice
.height
== 0)
20719 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
20721 it
->descent
= slice
.height
- glyph_ascent
;
20723 it
->descent
+= img
->vmargin
;
20724 if (slice
.y
+ slice
.height
== img
->height
)
20725 it
->descent
+= img
->vmargin
;
20726 it
->phys_descent
= it
->descent
;
20728 it
->pixel_width
= slice
.width
;
20730 it
->pixel_width
+= img
->hmargin
;
20731 if (slice
.x
+ slice
.width
== img
->width
)
20732 it
->pixel_width
+= img
->hmargin
;
20734 /* It's quite possible for images to have an ascent greater than
20735 their height, so don't get confused in that case. */
20736 if (it
->descent
< 0)
20741 if (face
->box
!= FACE_NO_BOX
)
20743 if (face
->box_line_width
> 0)
20746 it
->ascent
+= face
->box_line_width
;
20747 if (slice
.y
+ slice
.height
== img
->height
)
20748 it
->descent
+= face
->box_line_width
;
20751 if (it
->start_of_box_run_p
&& slice
.x
== 0)
20752 it
->pixel_width
+= eabs (face
->box_line_width
);
20753 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
20754 it
->pixel_width
+= eabs (face
->box_line_width
);
20757 take_vertical_position_into_account (it
);
20759 /* Automatically crop wide image glyphs at right edge so we can
20760 draw the cursor on same display row. */
20761 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
20762 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
20764 it
->pixel_width
-= crop
;
20765 slice
.width
-= crop
;
20770 struct glyph
*glyph
;
20771 enum glyph_row_area area
= it
->area
;
20773 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20774 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20776 glyph
->charpos
= CHARPOS (it
->position
);
20777 glyph
->object
= it
->object
;
20778 glyph
->pixel_width
= it
->pixel_width
;
20779 glyph
->ascent
= glyph_ascent
;
20780 glyph
->descent
= it
->descent
;
20781 glyph
->voffset
= it
->voffset
;
20782 glyph
->type
= IMAGE_GLYPH
;
20783 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
20784 glyph
->multibyte_p
= it
->multibyte_p
;
20785 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20786 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20787 glyph
->overlaps_vertically_p
= 0;
20788 glyph
->padding_p
= 0;
20789 glyph
->glyph_not_available_p
= 0;
20790 glyph
->face_id
= it
->face_id
;
20791 glyph
->u
.img_id
= img
->id
;
20792 glyph
->slice
= slice
;
20793 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20794 ++it
->glyph_row
->used
[area
];
20797 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20802 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
20803 of the glyph, WIDTH and HEIGHT are the width and height of the
20804 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
20807 append_stretch_glyph (it
, object
, width
, height
, ascent
)
20809 Lisp_Object object
;
20813 struct glyph
*glyph
;
20814 enum glyph_row_area area
= it
->area
;
20816 xassert (ascent
>= 0 && ascent
<= height
);
20818 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20819 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20821 glyph
->charpos
= CHARPOS (it
->position
);
20822 glyph
->object
= object
;
20823 glyph
->pixel_width
= width
;
20824 glyph
->ascent
= ascent
;
20825 glyph
->descent
= height
- ascent
;
20826 glyph
->voffset
= it
->voffset
;
20827 glyph
->type
= STRETCH_GLYPH
;
20828 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
20829 glyph
->multibyte_p
= it
->multibyte_p
;
20830 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20831 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20832 glyph
->overlaps_vertically_p
= 0;
20833 glyph
->padding_p
= 0;
20834 glyph
->glyph_not_available_p
= 0;
20835 glyph
->face_id
= it
->face_id
;
20836 glyph
->u
.stretch
.ascent
= ascent
;
20837 glyph
->u
.stretch
.height
= height
;
20838 glyph
->slice
= null_glyph_slice
;
20839 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20840 ++it
->glyph_row
->used
[area
];
20843 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20847 /* Produce a stretch glyph for iterator IT. IT->object is the value
20848 of the glyph property displayed. The value must be a list
20849 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
20852 1. `:width WIDTH' specifies that the space should be WIDTH *
20853 canonical char width wide. WIDTH may be an integer or floating
20856 2. `:relative-width FACTOR' specifies that the width of the stretch
20857 should be computed from the width of the first character having the
20858 `glyph' property, and should be FACTOR times that width.
20860 3. `:align-to HPOS' specifies that the space should be wide enough
20861 to reach HPOS, a value in canonical character units.
20863 Exactly one of the above pairs must be present.
20865 4. `:height HEIGHT' specifies that the height of the stretch produced
20866 should be HEIGHT, measured in canonical character units.
20868 5. `:relative-height FACTOR' specifies that the height of the
20869 stretch should be FACTOR times the height of the characters having
20870 the glyph property.
20872 Either none or exactly one of 4 or 5 must be present.
20874 6. `:ascent ASCENT' specifies that ASCENT percent of the height
20875 of the stretch should be used for the ascent of the stretch.
20876 ASCENT must be in the range 0 <= ASCENT <= 100. */
20879 produce_stretch_glyph (it
)
20882 /* (space :width WIDTH :height HEIGHT ...) */
20883 Lisp_Object prop
, plist
;
20884 int width
= 0, height
= 0, align_to
= -1;
20885 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
20888 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20889 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
20891 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
20893 /* List should start with `space'. */
20894 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
20895 plist
= XCDR (it
->object
);
20897 /* Compute the width of the stretch. */
20898 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
20899 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
20901 /* Absolute width `:width WIDTH' specified and valid. */
20902 zero_width_ok_p
= 1;
20905 else if (prop
= Fplist_get (plist
, QCrelative_width
),
20908 /* Relative width `:relative-width FACTOR' specified and valid.
20909 Compute the width of the characters having the `glyph'
20912 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
20915 if (it
->multibyte_p
)
20917 int maxlen
= ((IT_BYTEPOS (*it
) >= GPT
? ZV
: GPT
)
20918 - IT_BYTEPOS (*it
));
20919 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
20923 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
20924 if (! ASCII_CHAR_P (it2
.c
))
20925 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
20928 it2
.glyph_row
= NULL
;
20929 it2
.what
= IT_CHARACTER
;
20930 x_produce_glyphs (&it2
);
20931 width
= NUMVAL (prop
) * it2
.pixel_width
;
20933 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
20934 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
20936 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
20937 align_to
= (align_to
< 0
20939 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
20940 else if (align_to
< 0)
20941 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
20942 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
20943 zero_width_ok_p
= 1;
20946 /* Nothing specified -> width defaults to canonical char width. */
20947 width
= FRAME_COLUMN_WIDTH (it
->f
);
20949 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
20952 /* Compute height. */
20953 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
20954 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
20957 zero_height_ok_p
= 1;
20959 else if (prop
= Fplist_get (plist
, QCrelative_height
),
20961 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
20963 height
= FONT_HEIGHT (font
);
20965 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
20968 /* Compute percentage of height used for ascent. If
20969 `:ascent ASCENT' is present and valid, use that. Otherwise,
20970 derive the ascent from the font in use. */
20971 if (prop
= Fplist_get (plist
, QCascent
),
20972 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
20973 ascent
= height
* NUMVAL (prop
) / 100.0;
20974 else if (!NILP (prop
)
20975 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
20976 ascent
= min (max (0, (int)tem
), height
);
20978 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
20980 if (width
> 0 && it
->line_wrap
!= TRUNCATE
20981 && it
->current_x
+ width
> it
->last_visible_x
)
20982 width
= it
->last_visible_x
- it
->current_x
- 1;
20984 if (width
> 0 && height
> 0 && it
->glyph_row
)
20986 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
20987 if (!STRINGP (object
))
20988 object
= it
->w
->buffer
;
20989 append_stretch_glyph (it
, object
, width
, height
, ascent
);
20992 it
->pixel_width
= width
;
20993 it
->ascent
= it
->phys_ascent
= ascent
;
20994 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
20995 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
20997 take_vertical_position_into_account (it
);
21000 /* Calculate line-height and line-spacing properties.
21001 An integer value specifies explicit pixel value.
21002 A float value specifies relative value to current face height.
21003 A cons (float . face-name) specifies relative value to
21004 height of specified face font.
21006 Returns height in pixels, or nil. */
21010 calc_line_height_property (it
, val
, font
, boff
, override
)
21014 int boff
, override
;
21016 Lisp_Object face_name
= Qnil
;
21017 int ascent
, descent
, height
;
21019 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
21024 face_name
= XCAR (val
);
21026 if (!NUMBERP (val
))
21027 val
= make_number (1);
21028 if (NILP (face_name
))
21030 height
= it
->ascent
+ it
->descent
;
21035 if (NILP (face_name
))
21037 font
= FRAME_FONT (it
->f
);
21038 boff
= FRAME_BASELINE_OFFSET (it
->f
);
21040 else if (EQ (face_name
, Qt
))
21049 face_id
= lookup_named_face (it
->f
, face_name
, 0);
21051 return make_number (-1);
21053 face
= FACE_FROM_ID (it
->f
, face_id
);
21056 return make_number (-1);
21057 boff
= font
->baseline_offset
;
21058 if (font
->vertical_centering
)
21059 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
21062 ascent
= FONT_BASE (font
) + boff
;
21063 descent
= FONT_DESCENT (font
) - boff
;
21067 it
->override_ascent
= ascent
;
21068 it
->override_descent
= descent
;
21069 it
->override_boff
= boff
;
21072 height
= ascent
+ descent
;
21076 height
= (int)(XFLOAT_DATA (val
) * height
);
21077 else if (INTEGERP (val
))
21078 height
*= XINT (val
);
21080 return make_number (height
);
21085 Produce glyphs/get display metrics for the display element IT is
21086 loaded with. See the description of struct it in dispextern.h
21087 for an overview of struct it. */
21090 x_produce_glyphs (it
)
21093 int extra_line_spacing
= it
->extra_line_spacing
;
21095 it
->glyph_not_available_p
= 0;
21097 if (it
->what
== IT_CHARACTER
)
21100 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21101 struct font
*font
= face
->font
;
21102 int font_not_found_p
= font
== NULL
;
21103 struct font_metrics
*pcm
= NULL
;
21104 int boff
; /* baseline offset */
21106 if (font_not_found_p
)
21108 /* When no suitable font found, display an empty box based
21109 on the metrics of the font of the default face (or what
21111 struct face
*no_font_face
21112 = FACE_FROM_ID (it
->f
,
21113 NILP (Vface_remapping_alist
) ? DEFAULT_FACE_ID
21114 : lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
21115 font
= no_font_face
->font
;
21116 boff
= font
->baseline_offset
;
21120 boff
= font
->baseline_offset
;
21121 if (font
->vertical_centering
)
21122 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
21125 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
21131 if (it
->override_ascent
>= 0)
21133 it
->ascent
= it
->override_ascent
;
21134 it
->descent
= it
->override_descent
;
21135 boff
= it
->override_boff
;
21139 it
->ascent
= FONT_BASE (font
) + boff
;
21140 it
->descent
= FONT_DESCENT (font
) - boff
;
21143 if (! font_not_found_p
21144 && get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
21146 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
21147 if (pcm
->width
== 0
21148 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
21154 it
->phys_ascent
= pcm
->ascent
+ boff
;
21155 it
->phys_descent
= pcm
->descent
- boff
;
21156 it
->pixel_width
= pcm
->width
;
21160 it
->glyph_not_available_p
= 1;
21161 it
->phys_ascent
= it
->ascent
;
21162 it
->phys_descent
= it
->descent
;
21163 it
->pixel_width
= font
->space_width
;
21166 if (it
->constrain_row_ascent_descent_p
)
21168 if (it
->descent
> it
->max_descent
)
21170 it
->ascent
+= it
->descent
- it
->max_descent
;
21171 it
->descent
= it
->max_descent
;
21173 if (it
->ascent
> it
->max_ascent
)
21175 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
21176 it
->ascent
= it
->max_ascent
;
21178 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
21179 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
21180 extra_line_spacing
= 0;
21183 /* If this is a space inside a region of text with
21184 `space-width' property, change its width. */
21185 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
21187 it
->pixel_width
*= XFLOATINT (it
->space_width
);
21189 /* If face has a box, add the box thickness to the character
21190 height. If character has a box line to the left and/or
21191 right, add the box line width to the character's width. */
21192 if (face
->box
!= FACE_NO_BOX
)
21194 int thick
= face
->box_line_width
;
21198 it
->ascent
+= thick
;
21199 it
->descent
+= thick
;
21204 if (it
->start_of_box_run_p
)
21205 it
->pixel_width
+= thick
;
21206 if (it
->end_of_box_run_p
)
21207 it
->pixel_width
+= thick
;
21210 /* If face has an overline, add the height of the overline
21211 (1 pixel) and a 1 pixel margin to the character height. */
21212 if (face
->overline_p
)
21213 it
->ascent
+= overline_margin
;
21215 if (it
->constrain_row_ascent_descent_p
)
21217 if (it
->ascent
> it
->max_ascent
)
21218 it
->ascent
= it
->max_ascent
;
21219 if (it
->descent
> it
->max_descent
)
21220 it
->descent
= it
->max_descent
;
21223 take_vertical_position_into_account (it
);
21225 /* If we have to actually produce glyphs, do it. */
21230 /* Translate a space with a `space-width' property
21231 into a stretch glyph. */
21232 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
21233 / FONT_HEIGHT (font
));
21234 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
21235 it
->ascent
+ it
->descent
, ascent
);
21240 /* If characters with lbearing or rbearing are displayed
21241 in this line, record that fact in a flag of the
21242 glyph row. This is used to optimize X output code. */
21243 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
21244 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
21246 if (! stretched_p
&& it
->pixel_width
== 0)
21247 /* We assure that all visible glyphs have at least 1-pixel
21249 it
->pixel_width
= 1;
21251 else if (it
->char_to_display
== '\n')
21253 /* A newline has no width, but we need the height of the
21254 line. But if previous part of the line sets a height,
21255 don't increase that height */
21257 Lisp_Object height
;
21258 Lisp_Object total_height
= Qnil
;
21260 it
->override_ascent
= -1;
21261 it
->pixel_width
= 0;
21264 height
= get_it_property(it
, Qline_height
);
21265 /* Split (line-height total-height) list */
21267 && CONSP (XCDR (height
))
21268 && NILP (XCDR (XCDR (height
))))
21270 total_height
= XCAR (XCDR (height
));
21271 height
= XCAR (height
);
21273 height
= calc_line_height_property(it
, height
, font
, boff
, 1);
21275 if (it
->override_ascent
>= 0)
21277 it
->ascent
= it
->override_ascent
;
21278 it
->descent
= it
->override_descent
;
21279 boff
= it
->override_boff
;
21283 it
->ascent
= FONT_BASE (font
) + boff
;
21284 it
->descent
= FONT_DESCENT (font
) - boff
;
21287 if (EQ (height
, Qt
))
21289 if (it
->descent
> it
->max_descent
)
21291 it
->ascent
+= it
->descent
- it
->max_descent
;
21292 it
->descent
= it
->max_descent
;
21294 if (it
->ascent
> it
->max_ascent
)
21296 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
21297 it
->ascent
= it
->max_ascent
;
21299 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
21300 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
21301 it
->constrain_row_ascent_descent_p
= 1;
21302 extra_line_spacing
= 0;
21306 Lisp_Object spacing
;
21308 it
->phys_ascent
= it
->ascent
;
21309 it
->phys_descent
= it
->descent
;
21311 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
21312 && face
->box
!= FACE_NO_BOX
21313 && face
->box_line_width
> 0)
21315 it
->ascent
+= face
->box_line_width
;
21316 it
->descent
+= face
->box_line_width
;
21319 && XINT (height
) > it
->ascent
+ it
->descent
)
21320 it
->ascent
= XINT (height
) - it
->descent
;
21322 if (!NILP (total_height
))
21323 spacing
= calc_line_height_property(it
, total_height
, font
, boff
, 0);
21326 spacing
= get_it_property(it
, Qline_spacing
);
21327 spacing
= calc_line_height_property(it
, spacing
, font
, boff
, 0);
21329 if (INTEGERP (spacing
))
21331 extra_line_spacing
= XINT (spacing
);
21332 if (!NILP (total_height
))
21333 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
21337 else /* i.e. (it->char_to_display == '\t') */
21339 if (font
->space_width
> 0)
21341 int tab_width
= it
->tab_width
* font
->space_width
;
21342 int x
= it
->current_x
+ it
->continuation_lines_width
;
21343 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
21345 /* If the distance from the current position to the next tab
21346 stop is less than a space character width, use the
21347 tab stop after that. */
21348 if (next_tab_x
- x
< font
->space_width
)
21349 next_tab_x
+= tab_width
;
21351 it
->pixel_width
= next_tab_x
- x
;
21353 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
21354 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
21358 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
21359 it
->ascent
+ it
->descent
, it
->ascent
);
21364 it
->pixel_width
= 0;
21369 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
21371 /* A static composition.
21373 Note: A composition is represented as one glyph in the
21374 glyph matrix. There are no padding glyphs.
21376 Important note: pixel_width, ascent, and descent are the
21377 values of what is drawn by draw_glyphs (i.e. the values of
21378 the overall glyphs composed). */
21379 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21380 int boff
; /* baseline offset */
21381 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
21382 int glyph_len
= cmp
->glyph_len
;
21383 struct font
*font
= face
->font
;
21387 /* If we have not yet calculated pixel size data of glyphs of
21388 the composition for the current face font, calculate them
21389 now. Theoretically, we have to check all fonts for the
21390 glyphs, but that requires much time and memory space. So,
21391 here we check only the font of the first glyph. This may
21392 lead to incorrect display, but it's very rare, and C-l
21393 (recenter-top-bottom) can correct the display anyway. */
21394 if (! cmp
->font
|| cmp
->font
!= font
)
21396 /* Ascent and descent of the font of the first character
21397 of this composition (adjusted by baseline offset).
21398 Ascent and descent of overall glyphs should not be less
21399 than these, respectively. */
21400 int font_ascent
, font_descent
, font_height
;
21401 /* Bounding box of the overall glyphs. */
21402 int leftmost
, rightmost
, lowest
, highest
;
21403 int lbearing
, rbearing
;
21404 int i
, width
, ascent
, descent
;
21405 int left_padded
= 0, right_padded
= 0;
21408 struct font_metrics
*pcm
;
21409 int font_not_found_p
;
21412 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
21413 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
21415 if (glyph_len
< cmp
->glyph_len
)
21417 for (i
= 0; i
< glyph_len
; i
++)
21419 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
21421 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
21426 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
21427 : IT_CHARPOS (*it
));
21428 /* If no suitable font is found, use the default font. */
21429 font_not_found_p
= font
== NULL
;
21430 if (font_not_found_p
)
21432 face
= face
->ascii_face
;
21435 boff
= font
->baseline_offset
;
21436 if (font
->vertical_centering
)
21437 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
21438 font_ascent
= FONT_BASE (font
) + boff
;
21439 font_descent
= FONT_DESCENT (font
) - boff
;
21440 font_height
= FONT_HEIGHT (font
);
21442 cmp
->font
= (void *) font
;
21445 if (! font_not_found_p
)
21447 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
21448 &char2b
, it
->multibyte_p
, 0);
21449 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
21452 /* Initialize the bounding box. */
21455 width
= pcm
->width
;
21456 ascent
= pcm
->ascent
;
21457 descent
= pcm
->descent
;
21458 lbearing
= pcm
->lbearing
;
21459 rbearing
= pcm
->rbearing
;
21463 width
= font
->space_width
;
21464 ascent
= FONT_BASE (font
);
21465 descent
= FONT_DESCENT (font
);
21472 lowest
= - descent
+ boff
;
21473 highest
= ascent
+ boff
;
21475 if (! font_not_found_p
21476 && font
->default_ascent
21477 && CHAR_TABLE_P (Vuse_default_ascent
)
21478 && !NILP (Faref (Vuse_default_ascent
,
21479 make_number (it
->char_to_display
))))
21480 highest
= font
->default_ascent
+ boff
;
21482 /* Draw the first glyph at the normal position. It may be
21483 shifted to right later if some other glyphs are drawn
21485 cmp
->offsets
[i
* 2] = 0;
21486 cmp
->offsets
[i
* 2 + 1] = boff
;
21487 cmp
->lbearing
= lbearing
;
21488 cmp
->rbearing
= rbearing
;
21490 /* Set cmp->offsets for the remaining glyphs. */
21491 for (i
++; i
< glyph_len
; i
++)
21493 int left
, right
, btm
, top
;
21494 int ch
= COMPOSITION_GLYPH (cmp
, i
);
21496 struct face
*this_face
;
21501 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
21502 this_face
= FACE_FROM_ID (it
->f
, face_id
);
21503 font
= this_face
->font
;
21509 this_boff
= font
->baseline_offset
;
21510 if (font
->vertical_centering
)
21511 this_boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
21512 get_char_face_and_encoding (it
->f
, ch
, face_id
,
21513 &char2b
, it
->multibyte_p
, 0);
21514 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
21517 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
21520 width
= pcm
->width
;
21521 ascent
= pcm
->ascent
;
21522 descent
= pcm
->descent
;
21523 lbearing
= pcm
->lbearing
;
21524 rbearing
= pcm
->rbearing
;
21525 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
21527 /* Relative composition with or without
21528 alternate chars. */
21529 left
= (leftmost
+ rightmost
- width
) / 2;
21530 btm
= - descent
+ boff
;
21531 if (font
->relative_compose
21532 && (! CHAR_TABLE_P (Vignore_relative_composition
)
21533 || NILP (Faref (Vignore_relative_composition
,
21534 make_number (ch
)))))
21537 if (- descent
>= font
->relative_compose
)
21538 /* One extra pixel between two glyphs. */
21540 else if (ascent
<= 0)
21541 /* One extra pixel between two glyphs. */
21542 btm
= lowest
- 1 - ascent
- descent
;
21547 /* A composition rule is specified by an integer
21548 value that encodes global and new reference
21549 points (GREF and NREF). GREF and NREF are
21550 specified by numbers as below:
21552 0---1---2 -- ascent
21556 9--10--11 -- center
21558 ---3---4---5--- baseline
21560 6---7---8 -- descent
21562 int rule
= COMPOSITION_RULE (cmp
, i
);
21563 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
21565 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
21566 grefx
= gref
% 3, nrefx
= nref
% 3;
21567 grefy
= gref
/ 3, nrefy
= nref
/ 3;
21569 xoff
= font_height
* (xoff
- 128) / 256;
21571 yoff
= font_height
* (yoff
- 128) / 256;
21574 + grefx
* (rightmost
- leftmost
) / 2
21575 - nrefx
* width
/ 2
21578 btm
= ((grefy
== 0 ? highest
21580 : grefy
== 2 ? lowest
21581 : (highest
+ lowest
) / 2)
21582 - (nrefy
== 0 ? ascent
+ descent
21583 : nrefy
== 1 ? descent
- boff
21585 : (ascent
+ descent
) / 2)
21589 cmp
->offsets
[i
* 2] = left
;
21590 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
21592 /* Update the bounding box of the overall glyphs. */
21595 right
= left
+ width
;
21596 if (left
< leftmost
)
21598 if (right
> rightmost
)
21601 top
= btm
+ descent
+ ascent
;
21607 if (cmp
->lbearing
> left
+ lbearing
)
21608 cmp
->lbearing
= left
+ lbearing
;
21609 if (cmp
->rbearing
< left
+ rbearing
)
21610 cmp
->rbearing
= left
+ rbearing
;
21614 /* If there are glyphs whose x-offsets are negative,
21615 shift all glyphs to the right and make all x-offsets
21619 for (i
= 0; i
< cmp
->glyph_len
; i
++)
21620 cmp
->offsets
[i
* 2] -= leftmost
;
21621 rightmost
-= leftmost
;
21622 cmp
->lbearing
-= leftmost
;
21623 cmp
->rbearing
-= leftmost
;
21626 if (left_padded
&& cmp
->lbearing
< 0)
21628 for (i
= 0; i
< cmp
->glyph_len
; i
++)
21629 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
21630 rightmost
-= cmp
->lbearing
;
21631 cmp
->rbearing
-= cmp
->lbearing
;
21634 if (right_padded
&& rightmost
< cmp
->rbearing
)
21636 rightmost
= cmp
->rbearing
;
21639 cmp
->pixel_width
= rightmost
;
21640 cmp
->ascent
= highest
;
21641 cmp
->descent
= - lowest
;
21642 if (cmp
->ascent
< font_ascent
)
21643 cmp
->ascent
= font_ascent
;
21644 if (cmp
->descent
< font_descent
)
21645 cmp
->descent
= font_descent
;
21649 && (cmp
->lbearing
< 0
21650 || cmp
->rbearing
> cmp
->pixel_width
))
21651 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
21653 it
->pixel_width
= cmp
->pixel_width
;
21654 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
21655 it
->descent
= it
->phys_descent
= cmp
->descent
;
21656 if (face
->box
!= FACE_NO_BOX
)
21658 int thick
= face
->box_line_width
;
21662 it
->ascent
+= thick
;
21663 it
->descent
+= thick
;
21668 if (it
->start_of_box_run_p
)
21669 it
->pixel_width
+= thick
;
21670 if (it
->end_of_box_run_p
)
21671 it
->pixel_width
+= thick
;
21674 /* If face has an overline, add the height of the overline
21675 (1 pixel) and a 1 pixel margin to the character height. */
21676 if (face
->overline_p
)
21677 it
->ascent
+= overline_margin
;
21679 take_vertical_position_into_account (it
);
21680 if (it
->ascent
< 0)
21682 if (it
->descent
< 0)
21686 append_composite_glyph (it
);
21688 else if (it
->what
== IT_COMPOSITION
)
21690 /* A dynamic (automatic) composition. */
21691 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21692 Lisp_Object gstring
;
21693 struct font_metrics metrics
;
21695 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
21697 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
21700 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
21701 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
21702 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
21703 it
->descent
= it
->phys_descent
= metrics
.descent
;
21704 if (face
->box
!= FACE_NO_BOX
)
21706 int thick
= face
->box_line_width
;
21710 it
->ascent
+= thick
;
21711 it
->descent
+= thick
;
21716 if (it
->start_of_box_run_p
)
21717 it
->pixel_width
+= thick
;
21718 if (it
->end_of_box_run_p
)
21719 it
->pixel_width
+= thick
;
21721 /* If face has an overline, add the height of the overline
21722 (1 pixel) and a 1 pixel margin to the character height. */
21723 if (face
->overline_p
)
21724 it
->ascent
+= overline_margin
;
21725 take_vertical_position_into_account (it
);
21726 if (it
->ascent
< 0)
21728 if (it
->descent
< 0)
21732 append_composite_glyph (it
);
21734 else if (it
->what
== IT_IMAGE
)
21735 produce_image_glyph (it
);
21736 else if (it
->what
== IT_STRETCH
)
21737 produce_stretch_glyph (it
);
21739 /* Accumulate dimensions. Note: can't assume that it->descent > 0
21740 because this isn't true for images with `:ascent 100'. */
21741 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
21742 if (it
->area
== TEXT_AREA
)
21743 it
->current_x
+= it
->pixel_width
;
21745 if (extra_line_spacing
> 0)
21747 it
->descent
+= extra_line_spacing
;
21748 if (extra_line_spacing
> it
->max_extra_line_spacing
)
21749 it
->max_extra_line_spacing
= extra_line_spacing
;
21752 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
21753 it
->max_descent
= max (it
->max_descent
, it
->descent
);
21754 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
21755 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
21759 Output LEN glyphs starting at START at the nominal cursor position.
21760 Advance the nominal cursor over the text. The global variable
21761 updated_window contains the window being updated, updated_row is
21762 the glyph row being updated, and updated_area is the area of that
21763 row being updated. */
21766 x_write_glyphs (start
, len
)
21767 struct glyph
*start
;
21772 xassert (updated_window
&& updated_row
);
21775 /* Write glyphs. */
21777 hpos
= start
- updated_row
->glyphs
[updated_area
];
21778 x
= draw_glyphs (updated_window
, output_cursor
.x
,
21779 updated_row
, updated_area
,
21781 DRAW_NORMAL_TEXT
, 0);
21783 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
21784 if (updated_area
== TEXT_AREA
21785 && updated_window
->phys_cursor_on_p
21786 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
21787 && updated_window
->phys_cursor
.hpos
>= hpos
21788 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
21789 updated_window
->phys_cursor_on_p
= 0;
21793 /* Advance the output cursor. */
21794 output_cursor
.hpos
+= len
;
21795 output_cursor
.x
= x
;
21800 Insert LEN glyphs from START at the nominal cursor position. */
21803 x_insert_glyphs (start
, len
)
21804 struct glyph
*start
;
21809 int line_height
, shift_by_width
, shifted_region_width
;
21810 struct glyph_row
*row
;
21811 struct glyph
*glyph
;
21812 int frame_x
, frame_y
;
21815 xassert (updated_window
&& updated_row
);
21817 w
= updated_window
;
21818 f
= XFRAME (WINDOW_FRAME (w
));
21820 /* Get the height of the line we are in. */
21822 line_height
= row
->height
;
21824 /* Get the width of the glyphs to insert. */
21825 shift_by_width
= 0;
21826 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
21827 shift_by_width
+= glyph
->pixel_width
;
21829 /* Get the width of the region to shift right. */
21830 shifted_region_width
= (window_box_width (w
, updated_area
)
21835 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
21836 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
21838 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
21839 line_height
, shift_by_width
);
21841 /* Write the glyphs. */
21842 hpos
= start
- row
->glyphs
[updated_area
];
21843 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
21845 DRAW_NORMAL_TEXT
, 0);
21847 /* Advance the output cursor. */
21848 output_cursor
.hpos
+= len
;
21849 output_cursor
.x
+= shift_by_width
;
21855 Erase the current text line from the nominal cursor position
21856 (inclusive) to pixel column TO_X (exclusive). The idea is that
21857 everything from TO_X onward is already erased.
21859 TO_X is a pixel position relative to updated_area of
21860 updated_window. TO_X == -1 means clear to the end of this area. */
21863 x_clear_end_of_line (to_x
)
21867 struct window
*w
= updated_window
;
21868 int max_x
, min_y
, max_y
;
21869 int from_x
, from_y
, to_y
;
21871 xassert (updated_window
&& updated_row
);
21872 f
= XFRAME (w
->frame
);
21874 if (updated_row
->full_width_p
)
21875 max_x
= WINDOW_TOTAL_WIDTH (w
);
21877 max_x
= window_box_width (w
, updated_area
);
21878 max_y
= window_text_bottom_y (w
);
21880 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
21881 of window. For TO_X > 0, truncate to end of drawing area. */
21887 to_x
= min (to_x
, max_x
);
21889 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
21891 /* Notice if the cursor will be cleared by this operation. */
21892 if (!updated_row
->full_width_p
)
21893 notice_overwritten_cursor (w
, updated_area
,
21894 output_cursor
.x
, -1,
21896 MATRIX_ROW_BOTTOM_Y (updated_row
));
21898 from_x
= output_cursor
.x
;
21900 /* Translate to frame coordinates. */
21901 if (updated_row
->full_width_p
)
21903 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
21904 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
21908 int area_left
= window_box_left (w
, updated_area
);
21909 from_x
+= area_left
;
21913 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
21914 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
21915 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
21917 /* Prevent inadvertently clearing to end of the X window. */
21918 if (to_x
> from_x
&& to_y
> from_y
)
21921 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
21922 to_x
- from_x
, to_y
- from_y
);
21927 #endif /* HAVE_WINDOW_SYSTEM */
21931 /***********************************************************************
21933 ***********************************************************************/
21935 /* Value is the internal representation of the specified cursor type
21936 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
21937 of the bar cursor. */
21939 static enum text_cursor_kinds
21940 get_specified_cursor_type (arg
, width
)
21944 enum text_cursor_kinds type
;
21949 if (EQ (arg
, Qbox
))
21950 return FILLED_BOX_CURSOR
;
21952 if (EQ (arg
, Qhollow
))
21953 return HOLLOW_BOX_CURSOR
;
21955 if (EQ (arg
, Qbar
))
21962 && EQ (XCAR (arg
), Qbar
)
21963 && INTEGERP (XCDR (arg
))
21964 && XINT (XCDR (arg
)) >= 0)
21966 *width
= XINT (XCDR (arg
));
21970 if (EQ (arg
, Qhbar
))
21973 return HBAR_CURSOR
;
21977 && EQ (XCAR (arg
), Qhbar
)
21978 && INTEGERP (XCDR (arg
))
21979 && XINT (XCDR (arg
)) >= 0)
21981 *width
= XINT (XCDR (arg
));
21982 return HBAR_CURSOR
;
21985 /* Treat anything unknown as "hollow box cursor".
21986 It was bad to signal an error; people have trouble fixing
21987 .Xdefaults with Emacs, when it has something bad in it. */
21988 type
= HOLLOW_BOX_CURSOR
;
21993 /* Set the default cursor types for specified frame. */
21995 set_frame_cursor_types (f
, arg
)
22002 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
22003 FRAME_CURSOR_WIDTH (f
) = width
;
22005 /* By default, set up the blink-off state depending on the on-state. */
22007 tem
= Fassoc (arg
, Vblink_cursor_alist
);
22010 FRAME_BLINK_OFF_CURSOR (f
)
22011 = get_specified_cursor_type (XCDR (tem
), &width
);
22012 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
22015 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
22019 /* Return the cursor we want to be displayed in window W. Return
22020 width of bar/hbar cursor through WIDTH arg. Return with
22021 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
22022 (i.e. if the `system caret' should track this cursor).
22024 In a mini-buffer window, we want the cursor only to appear if we
22025 are reading input from this window. For the selected window, we
22026 want the cursor type given by the frame parameter or buffer local
22027 setting of cursor-type. If explicitly marked off, draw no cursor.
22028 In all other cases, we want a hollow box cursor. */
22030 static enum text_cursor_kinds
22031 get_window_cursor_type (w
, glyph
, width
, active_cursor
)
22033 struct glyph
*glyph
;
22035 int *active_cursor
;
22037 struct frame
*f
= XFRAME (w
->frame
);
22038 struct buffer
*b
= XBUFFER (w
->buffer
);
22039 int cursor_type
= DEFAULT_CURSOR
;
22040 Lisp_Object alt_cursor
;
22041 int non_selected
= 0;
22043 *active_cursor
= 1;
22046 if (cursor_in_echo_area
22047 && FRAME_HAS_MINIBUF_P (f
)
22048 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
22050 if (w
== XWINDOW (echo_area_window
))
22052 if (EQ (b
->cursor_type
, Qt
) || NILP (b
->cursor_type
))
22054 *width
= FRAME_CURSOR_WIDTH (f
);
22055 return FRAME_DESIRED_CURSOR (f
);
22058 return get_specified_cursor_type (b
->cursor_type
, width
);
22061 *active_cursor
= 0;
22065 /* Detect a nonselected window or nonselected frame. */
22066 else if (w
!= XWINDOW (f
->selected_window
)
22067 #ifdef HAVE_WINDOW_SYSTEM
22068 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
22072 *active_cursor
= 0;
22074 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
22080 /* Never display a cursor in a window in which cursor-type is nil. */
22081 if (NILP (b
->cursor_type
))
22084 /* Get the normal cursor type for this window. */
22085 if (EQ (b
->cursor_type
, Qt
))
22087 cursor_type
= FRAME_DESIRED_CURSOR (f
);
22088 *width
= FRAME_CURSOR_WIDTH (f
);
22091 cursor_type
= get_specified_cursor_type (b
->cursor_type
, width
);
22093 /* Use cursor-in-non-selected-windows instead
22094 for non-selected window or frame. */
22097 alt_cursor
= b
->cursor_in_non_selected_windows
;
22098 if (!EQ (Qt
, alt_cursor
))
22099 return get_specified_cursor_type (alt_cursor
, width
);
22100 /* t means modify the normal cursor type. */
22101 if (cursor_type
== FILLED_BOX_CURSOR
)
22102 cursor_type
= HOLLOW_BOX_CURSOR
;
22103 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
22105 return cursor_type
;
22108 /* Use normal cursor if not blinked off. */
22109 if (!w
->cursor_off_p
)
22111 #ifdef HAVE_WINDOW_SYSTEM
22112 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
22114 if (cursor_type
== FILLED_BOX_CURSOR
)
22116 /* Using a block cursor on large images can be very annoying.
22117 So use a hollow cursor for "large" images.
22118 If image is not transparent (no mask), also use hollow cursor. */
22119 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
22120 if (img
!= NULL
&& IMAGEP (img
->spec
))
22122 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
22123 where N = size of default frame font size.
22124 This should cover most of the "tiny" icons people may use. */
22126 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
22127 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
22128 cursor_type
= HOLLOW_BOX_CURSOR
;
22131 else if (cursor_type
!= NO_CURSOR
)
22133 /* Display current only supports BOX and HOLLOW cursors for images.
22134 So for now, unconditionally use a HOLLOW cursor when cursor is
22135 not a solid box cursor. */
22136 cursor_type
= HOLLOW_BOX_CURSOR
;
22140 return cursor_type
;
22143 /* Cursor is blinked off, so determine how to "toggle" it. */
22145 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
22146 if ((alt_cursor
= Fassoc (b
->cursor_type
, Vblink_cursor_alist
), !NILP (alt_cursor
)))
22147 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
22149 /* Then see if frame has specified a specific blink off cursor type. */
22150 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
22152 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
22153 return FRAME_BLINK_OFF_CURSOR (f
);
22157 /* Some people liked having a permanently visible blinking cursor,
22158 while others had very strong opinions against it. So it was
22159 decided to remove it. KFS 2003-09-03 */
22161 /* Finally perform built-in cursor blinking:
22162 filled box <-> hollow box
22163 wide [h]bar <-> narrow [h]bar
22164 narrow [h]bar <-> no cursor
22165 other type <-> no cursor */
22167 if (cursor_type
== FILLED_BOX_CURSOR
)
22168 return HOLLOW_BOX_CURSOR
;
22170 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
22173 return cursor_type
;
22181 #ifdef HAVE_WINDOW_SYSTEM
22183 /* Notice when the text cursor of window W has been completely
22184 overwritten by a drawing operation that outputs glyphs in AREA
22185 starting at X0 and ending at X1 in the line starting at Y0 and
22186 ending at Y1. X coordinates are area-relative. X1 < 0 means all
22187 the rest of the line after X0 has been written. Y coordinates
22188 are window-relative. */
22191 notice_overwritten_cursor (w
, area
, x0
, x1
, y0
, y1
)
22193 enum glyph_row_area area
;
22194 int x0
, y0
, x1
, y1
;
22196 int cx0
, cx1
, cy0
, cy1
;
22197 struct glyph_row
*row
;
22199 if (!w
->phys_cursor_on_p
)
22201 if (area
!= TEXT_AREA
)
22204 if (w
->phys_cursor
.vpos
< 0
22205 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
22206 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
22207 !(row
->enabled_p
&& row
->displays_text_p
)))
22210 if (row
->cursor_in_fringe_p
)
22212 row
->cursor_in_fringe_p
= 0;
22213 draw_fringe_bitmap (w
, row
, 0);
22214 w
->phys_cursor_on_p
= 0;
22218 cx0
= w
->phys_cursor
.x
;
22219 cx1
= cx0
+ w
->phys_cursor_width
;
22220 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
22223 /* The cursor image will be completely removed from the
22224 screen if the output area intersects the cursor area in
22225 y-direction. When we draw in [y0 y1[, and some part of
22226 the cursor is at y < y0, that part must have been drawn
22227 before. When scrolling, the cursor is erased before
22228 actually scrolling, so we don't come here. When not
22229 scrolling, the rows above the old cursor row must have
22230 changed, and in this case these rows must have written
22231 over the cursor image.
22233 Likewise if part of the cursor is below y1, with the
22234 exception of the cursor being in the first blank row at
22235 the buffer and window end because update_text_area
22236 doesn't draw that row. (Except when it does, but
22237 that's handled in update_text_area.) */
22239 cy0
= w
->phys_cursor
.y
;
22240 cy1
= cy0
+ w
->phys_cursor_height
;
22241 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
22244 w
->phys_cursor_on_p
= 0;
22247 #endif /* HAVE_WINDOW_SYSTEM */
22250 /************************************************************************
22252 ************************************************************************/
22254 #ifdef HAVE_WINDOW_SYSTEM
22257 Fix the display of area AREA of overlapping row ROW in window W
22258 with respect to the overlapping part OVERLAPS. */
22261 x_fix_overlapping_area (w
, row
, area
, overlaps
)
22263 struct glyph_row
*row
;
22264 enum glyph_row_area area
;
22272 for (i
= 0; i
< row
->used
[area
];)
22274 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
22276 int start
= i
, start_x
= x
;
22280 x
+= row
->glyphs
[area
][i
].pixel_width
;
22283 while (i
< row
->used
[area
]
22284 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
22286 draw_glyphs (w
, start_x
, row
, area
,
22288 DRAW_NORMAL_TEXT
, overlaps
);
22292 x
+= row
->glyphs
[area
][i
].pixel_width
;
22302 Draw the cursor glyph of window W in glyph row ROW. See the
22303 comment of draw_glyphs for the meaning of HL. */
22306 draw_phys_cursor_glyph (w
, row
, hl
)
22308 struct glyph_row
*row
;
22309 enum draw_glyphs_face hl
;
22311 /* If cursor hpos is out of bounds, don't draw garbage. This can
22312 happen in mini-buffer windows when switching between echo area
22313 glyphs and mini-buffer. */
22314 if (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])
22316 int on_p
= w
->phys_cursor_on_p
;
22318 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
22319 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
22321 w
->phys_cursor_on_p
= on_p
;
22323 if (hl
== DRAW_CURSOR
)
22324 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
22325 /* When we erase the cursor, and ROW is overlapped by other
22326 rows, make sure that these overlapping parts of other rows
22328 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
22330 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
22332 if (row
> w
->current_matrix
->rows
22333 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
22334 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
22335 OVERLAPS_ERASED_CURSOR
);
22337 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
22338 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
22339 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
22340 OVERLAPS_ERASED_CURSOR
);
22347 Erase the image of a cursor of window W from the screen. */
22350 erase_phys_cursor (w
)
22353 struct frame
*f
= XFRAME (w
->frame
);
22354 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
22355 int hpos
= w
->phys_cursor
.hpos
;
22356 int vpos
= w
->phys_cursor
.vpos
;
22357 int mouse_face_here_p
= 0;
22358 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
22359 struct glyph_row
*cursor_row
;
22360 struct glyph
*cursor_glyph
;
22361 enum draw_glyphs_face hl
;
22363 /* No cursor displayed or row invalidated => nothing to do on the
22365 if (w
->phys_cursor_type
== NO_CURSOR
)
22366 goto mark_cursor_off
;
22368 /* VPOS >= active_glyphs->nrows means that window has been resized.
22369 Don't bother to erase the cursor. */
22370 if (vpos
>= active_glyphs
->nrows
)
22371 goto mark_cursor_off
;
22373 /* If row containing cursor is marked invalid, there is nothing we
22375 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
22376 if (!cursor_row
->enabled_p
)
22377 goto mark_cursor_off
;
22379 /* If line spacing is > 0, old cursor may only be partially visible in
22380 window after split-window. So adjust visible height. */
22381 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
22382 window_text_bottom_y (w
) - cursor_row
->y
);
22384 /* If row is completely invisible, don't attempt to delete a cursor which
22385 isn't there. This can happen if cursor is at top of a window, and
22386 we switch to a buffer with a header line in that window. */
22387 if (cursor_row
->visible_height
<= 0)
22388 goto mark_cursor_off
;
22390 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
22391 if (cursor_row
->cursor_in_fringe_p
)
22393 cursor_row
->cursor_in_fringe_p
= 0;
22394 draw_fringe_bitmap (w
, cursor_row
, 0);
22395 goto mark_cursor_off
;
22398 /* This can happen when the new row is shorter than the old one.
22399 In this case, either draw_glyphs or clear_end_of_line
22400 should have cleared the cursor. Note that we wouldn't be
22401 able to erase the cursor in this case because we don't have a
22402 cursor glyph at hand. */
22403 if (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])
22404 goto mark_cursor_off
;
22406 /* If the cursor is in the mouse face area, redisplay that when
22407 we clear the cursor. */
22408 if (! NILP (dpyinfo
->mouse_face_window
)
22409 && w
== XWINDOW (dpyinfo
->mouse_face_window
)
22410 && (vpos
> dpyinfo
->mouse_face_beg_row
22411 || (vpos
== dpyinfo
->mouse_face_beg_row
22412 && hpos
>= dpyinfo
->mouse_face_beg_col
))
22413 && (vpos
< dpyinfo
->mouse_face_end_row
22414 || (vpos
== dpyinfo
->mouse_face_end_row
22415 && hpos
< dpyinfo
->mouse_face_end_col
))
22416 /* Don't redraw the cursor's spot in mouse face if it is at the
22417 end of a line (on a newline). The cursor appears there, but
22418 mouse highlighting does not. */
22419 && cursor_row
->used
[TEXT_AREA
] > hpos
)
22420 mouse_face_here_p
= 1;
22422 /* Maybe clear the display under the cursor. */
22423 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
22426 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
22429 cursor_glyph
= get_phys_cursor_glyph (w
);
22430 if (cursor_glyph
== NULL
)
22431 goto mark_cursor_off
;
22433 width
= cursor_glyph
->pixel_width
;
22434 left_x
= window_box_left_offset (w
, TEXT_AREA
);
22435 x
= w
->phys_cursor
.x
;
22437 width
-= left_x
- x
;
22438 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
22439 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
22440 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
22443 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
22446 /* Erase the cursor by redrawing the character underneath it. */
22447 if (mouse_face_here_p
)
22448 hl
= DRAW_MOUSE_FACE
;
22450 hl
= DRAW_NORMAL_TEXT
;
22451 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
22454 w
->phys_cursor_on_p
= 0;
22455 w
->phys_cursor_type
= NO_CURSOR
;
22460 Display or clear cursor of window W. If ON is zero, clear the
22461 cursor. If it is non-zero, display the cursor. If ON is nonzero,
22462 where to put the cursor is specified by HPOS, VPOS, X and Y. */
22465 display_and_set_cursor (w
, on
, hpos
, vpos
, x
, y
)
22467 int on
, hpos
, vpos
, x
, y
;
22469 struct frame
*f
= XFRAME (w
->frame
);
22470 int new_cursor_type
;
22471 int new_cursor_width
;
22473 struct glyph_row
*glyph_row
;
22474 struct glyph
*glyph
;
22476 /* This is pointless on invisible frames, and dangerous on garbaged
22477 windows and frames; in the latter case, the frame or window may
22478 be in the midst of changing its size, and x and y may be off the
22480 if (! FRAME_VISIBLE_P (f
)
22481 || FRAME_GARBAGED_P (f
)
22482 || vpos
>= w
->current_matrix
->nrows
22483 || hpos
>= w
->current_matrix
->matrix_w
)
22486 /* If cursor is off and we want it off, return quickly. */
22487 if (!on
&& !w
->phys_cursor_on_p
)
22490 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
22491 /* If cursor row is not enabled, we don't really know where to
22492 display the cursor. */
22493 if (!glyph_row
->enabled_p
)
22495 w
->phys_cursor_on_p
= 0;
22500 if (!glyph_row
->exact_window_width_line_p
22501 || hpos
< glyph_row
->used
[TEXT_AREA
])
22502 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
22504 xassert (interrupt_input_blocked
);
22506 /* Set new_cursor_type to the cursor we want to be displayed. */
22507 new_cursor_type
= get_window_cursor_type (w
, glyph
,
22508 &new_cursor_width
, &active_cursor
);
22510 /* If cursor is currently being shown and we don't want it to be or
22511 it is in the wrong place, or the cursor type is not what we want,
22513 if (w
->phys_cursor_on_p
22515 || w
->phys_cursor
.x
!= x
22516 || w
->phys_cursor
.y
!= y
22517 || new_cursor_type
!= w
->phys_cursor_type
22518 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
22519 && new_cursor_width
!= w
->phys_cursor_width
)))
22520 erase_phys_cursor (w
);
22522 /* Don't check phys_cursor_on_p here because that flag is only set
22523 to zero in some cases where we know that the cursor has been
22524 completely erased, to avoid the extra work of erasing the cursor
22525 twice. In other words, phys_cursor_on_p can be 1 and the cursor
22526 still not be visible, or it has only been partly erased. */
22529 w
->phys_cursor_ascent
= glyph_row
->ascent
;
22530 w
->phys_cursor_height
= glyph_row
->height
;
22532 /* Set phys_cursor_.* before x_draw_.* is called because some
22533 of them may need the information. */
22534 w
->phys_cursor
.x
= x
;
22535 w
->phys_cursor
.y
= glyph_row
->y
;
22536 w
->phys_cursor
.hpos
= hpos
;
22537 w
->phys_cursor
.vpos
= vpos
;
22540 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
22541 new_cursor_type
, new_cursor_width
,
22542 on
, active_cursor
);
22546 /* Switch the display of W's cursor on or off, according to the value
22550 update_window_cursor (w
, on
)
22554 /* Don't update cursor in windows whose frame is in the process
22555 of being deleted. */
22556 if (w
->current_matrix
)
22559 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
22560 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
22566 /* Call update_window_cursor with parameter ON_P on all leaf windows
22567 in the window tree rooted at W. */
22570 update_cursor_in_window_tree (w
, on_p
)
22576 if (!NILP (w
->hchild
))
22577 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
22578 else if (!NILP (w
->vchild
))
22579 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
22581 update_window_cursor (w
, on_p
);
22583 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
22589 Display the cursor on window W, or clear it, according to ON_P.
22590 Don't change the cursor's position. */
22593 x_update_cursor (f
, on_p
)
22597 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
22602 Clear the cursor of window W to background color, and mark the
22603 cursor as not shown. This is used when the text where the cursor
22604 is about to be rewritten. */
22610 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
22611 update_window_cursor (w
, 0);
22616 Display the active region described by mouse_face_* according to DRAW. */
22619 show_mouse_face (dpyinfo
, draw
)
22620 Display_Info
*dpyinfo
;
22621 enum draw_glyphs_face draw
;
22623 struct window
*w
= XWINDOW (dpyinfo
->mouse_face_window
);
22624 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22626 if (/* If window is in the process of being destroyed, don't bother
22628 w
->current_matrix
!= NULL
22629 /* Don't update mouse highlight if hidden */
22630 && (draw
!= DRAW_MOUSE_FACE
|| !dpyinfo
->mouse_face_hidden
)
22631 /* Recognize when we are called to operate on rows that don't exist
22632 anymore. This can happen when a window is split. */
22633 && dpyinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
22635 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
22636 struct glyph_row
*row
, *first
, *last
;
22638 first
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
22639 last
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
22641 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
22643 int start_hpos
, end_hpos
, start_x
;
22645 /* For all but the first row, the highlight starts at column 0. */
22648 start_hpos
= dpyinfo
->mouse_face_beg_col
;
22649 start_x
= dpyinfo
->mouse_face_beg_x
;
22658 end_hpos
= dpyinfo
->mouse_face_end_col
;
22661 end_hpos
= row
->used
[TEXT_AREA
];
22662 if (draw
== DRAW_NORMAL_TEXT
)
22663 row
->fill_line_p
= 1; /* Clear to end of line */
22666 if (end_hpos
> start_hpos
)
22668 draw_glyphs (w
, start_x
, row
, TEXT_AREA
,
22669 start_hpos
, end_hpos
,
22673 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
22677 /* When we've written over the cursor, arrange for it to
22678 be displayed again. */
22679 if (phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
22682 display_and_set_cursor (w
, 1,
22683 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
22684 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
22689 /* Change the mouse cursor. */
22690 if (draw
== DRAW_NORMAL_TEXT
&& !EQ (dpyinfo
->mouse_face_window
, f
->tool_bar_window
))
22691 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
22692 else if (draw
== DRAW_MOUSE_FACE
)
22693 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
22695 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
22699 Clear out the mouse-highlighted active region.
22700 Redraw it un-highlighted first. Value is non-zero if mouse
22701 face was actually drawn unhighlighted. */
22704 clear_mouse_face (dpyinfo
)
22705 Display_Info
*dpyinfo
;
22709 if (!dpyinfo
->mouse_face_hidden
&& !NILP (dpyinfo
->mouse_face_window
))
22711 show_mouse_face (dpyinfo
, DRAW_NORMAL_TEXT
);
22715 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
22716 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
22717 dpyinfo
->mouse_face_window
= Qnil
;
22718 dpyinfo
->mouse_face_overlay
= Qnil
;
22724 Non-zero if physical cursor of window W is within mouse face. */
22727 cursor_in_mouse_face_p (w
)
22730 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
22731 int in_mouse_face
= 0;
22733 if (WINDOWP (dpyinfo
->mouse_face_window
)
22734 && XWINDOW (dpyinfo
->mouse_face_window
) == w
)
22736 int hpos
= w
->phys_cursor
.hpos
;
22737 int vpos
= w
->phys_cursor
.vpos
;
22739 if (vpos
>= dpyinfo
->mouse_face_beg_row
22740 && vpos
<= dpyinfo
->mouse_face_end_row
22741 && (vpos
> dpyinfo
->mouse_face_beg_row
22742 || hpos
>= dpyinfo
->mouse_face_beg_col
)
22743 && (vpos
< dpyinfo
->mouse_face_end_row
22744 || hpos
< dpyinfo
->mouse_face_end_col
22745 || dpyinfo
->mouse_face_past_end
))
22749 return in_mouse_face
;
22755 /* This function sets the mouse_face_* elements of DPYINFO, assuming
22756 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
22757 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
22758 for the overlay or run of text properties specifying the mouse
22759 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
22760 before-string and after-string that must also be highlighted.
22761 DISPLAY_STRING, if non-nil, is a display string that may cover some
22762 or all of the highlighted text. */
22765 mouse_face_from_buffer_pos (Lisp_Object window
,
22766 Display_Info
*dpyinfo
,
22767 EMACS_INT mouse_charpos
,
22768 EMACS_INT start_charpos
,
22769 EMACS_INT end_charpos
,
22770 Lisp_Object before_string
,
22771 Lisp_Object after_string
,
22772 Lisp_Object display_string
)
22774 struct window
*w
= XWINDOW (window
);
22775 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
22776 struct glyph_row
*row
;
22777 struct glyph
*glyph
, *end
;
22781 xassert (NILP (display_string
) || STRINGP (display_string
));
22782 xassert (NILP (before_string
) || STRINGP (before_string
));
22783 xassert (NILP (after_string
) || STRINGP (after_string
));
22785 /* Find the first highlighted glyph. */
22786 if (start_charpos
< MATRIX_ROW_START_CHARPOS (first
))
22788 dpyinfo
->mouse_face_beg_col
= 0;
22789 dpyinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (first
, w
->current_matrix
);
22790 dpyinfo
->mouse_face_beg_x
= first
->x
;
22791 dpyinfo
->mouse_face_beg_y
= first
->y
;
22795 row
= row_containing_pos (w
, start_charpos
, first
, NULL
, 0);
22797 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
22799 /* If the before-string or display-string contains newlines,
22800 row_containing_pos skips to its last row. Move back. */
22801 if (!NILP (before_string
) || !NILP (display_string
))
22803 struct glyph_row
*prev
;
22804 while ((prev
= row
- 1, prev
>= first
)
22805 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
22806 && prev
->used
[TEXT_AREA
] > 0)
22808 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
22809 glyph
= beg
+ prev
->used
[TEXT_AREA
];
22810 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
22812 || !(EQ (glyph
->object
, before_string
)
22813 || EQ (glyph
->object
, display_string
)))
22819 glyph
= row
->glyphs
[TEXT_AREA
];
22820 end
= glyph
+ row
->used
[TEXT_AREA
];
22822 dpyinfo
->mouse_face_beg_y
= row
->y
;
22823 dpyinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
22825 /* Skip truncation glyphs at the start of the glyph row. */
22826 if (row
->displays_text_p
)
22828 && INTEGERP (glyph
->object
)
22829 && glyph
->charpos
< 0;
22831 x
+= glyph
->pixel_width
;
22833 /* Scan the glyph row, stopping before BEFORE_STRING or
22834 DISPLAY_STRING or START_CHARPOS. */
22836 && !INTEGERP (glyph
->object
)
22837 && !EQ (glyph
->object
, before_string
)
22838 && !EQ (glyph
->object
, display_string
)
22839 && !(BUFFERP (glyph
->object
)
22840 && glyph
->charpos
>= start_charpos
);
22842 x
+= glyph
->pixel_width
;
22844 dpyinfo
->mouse_face_beg_x
= x
;
22845 dpyinfo
->mouse_face_beg_col
= glyph
- row
->glyphs
[TEXT_AREA
];
22848 /* Find the last highlighted glyph. */
22849 row
= row_containing_pos (w
, end_charpos
, first
, NULL
, 0);
22852 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
22853 dpyinfo
->mouse_face_past_end
= 1;
22855 else if (!NILP (after_string
))
22857 /* If the after-string has newlines, advance to its last row. */
22858 struct glyph_row
*next
;
22859 struct glyph_row
*last
22860 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
22862 for (next
= row
+ 1;
22864 && next
->used
[TEXT_AREA
] > 0
22865 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
22870 glyph
= row
->glyphs
[TEXT_AREA
];
22871 end
= glyph
+ row
->used
[TEXT_AREA
];
22873 dpyinfo
->mouse_face_end_y
= row
->y
;
22874 dpyinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
22876 /* Skip truncation glyphs at the start of the row. */
22877 if (row
->displays_text_p
)
22879 && INTEGERP (glyph
->object
)
22880 && glyph
->charpos
< 0;
22882 x
+= glyph
->pixel_width
;
22884 /* Scan the glyph row, stopping at END_CHARPOS or when we encounter
22887 && !INTEGERP (glyph
->object
)
22888 && !EQ (glyph
->object
, after_string
)
22889 && !(BUFFERP (glyph
->object
) && glyph
->charpos
>= end_charpos
);
22891 x
+= glyph
->pixel_width
;
22893 /* If we found AFTER_STRING, consume it and stop. */
22894 if (EQ (glyph
->object
, after_string
))
22896 for (; EQ (glyph
->object
, after_string
) && glyph
< end
; ++glyph
)
22897 x
+= glyph
->pixel_width
;
22901 /* If there's no after-string, we must check if we overshot,
22902 which might be the case if we stopped after a string glyph.
22903 That glyph may belong to a before-string or display-string
22904 associated with the end position, which must not be
22906 Lisp_Object prev_object
;
22909 while (glyph
> row
->glyphs
[TEXT_AREA
])
22911 prev_object
= (glyph
- 1)->object
;
22912 if (!STRINGP (prev_object
) || EQ (prev_object
, display_string
))
22915 pos
= string_buffer_position (w
, prev_object
, end_charpos
);
22916 if (pos
&& pos
< end_charpos
)
22919 for (; glyph
> row
->glyphs
[TEXT_AREA
]
22920 && EQ ((glyph
- 1)->object
, prev_object
);
22922 x
-= (glyph
- 1)->pixel_width
;
22926 dpyinfo
->mouse_face_end_x
= x
;
22927 dpyinfo
->mouse_face_end_col
= glyph
- row
->glyphs
[TEXT_AREA
];
22928 dpyinfo
->mouse_face_window
= window
;
22929 dpyinfo
->mouse_face_face_id
22930 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
22932 !dpyinfo
->mouse_face_hidden
, -1);
22933 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
22937 /* Find the position of the glyph for position POS in OBJECT in
22938 window W's current matrix, and return in *X, *Y the pixel
22939 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
22941 RIGHT_P non-zero means return the position of the right edge of the
22942 glyph, RIGHT_P zero means return the left edge position.
22944 If no glyph for POS exists in the matrix, return the position of
22945 the glyph with the next smaller position that is in the matrix, if
22946 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
22947 exists in the matrix, return the position of the glyph with the
22948 next larger position in OBJECT.
22950 Value is non-zero if a glyph was found. */
22953 fast_find_string_pos (w
, pos
, object
, hpos
, vpos
, x
, y
, right_p
)
22956 Lisp_Object object
;
22957 int *hpos
, *vpos
, *x
, *y
;
22960 int yb
= window_text_bottom_y (w
);
22961 struct glyph_row
*r
;
22962 struct glyph
*best_glyph
= NULL
;
22963 struct glyph_row
*best_row
= NULL
;
22966 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
22967 r
->enabled_p
&& r
->y
< yb
;
22970 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
22971 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
22974 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
22975 if (EQ (g
->object
, object
))
22977 if (g
->charpos
== pos
)
22984 else if (best_glyph
== NULL
22985 || ((eabs (g
->charpos
- pos
)
22986 < eabs (best_glyph
->charpos
- pos
))
22989 : g
->charpos
> pos
)))
23003 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
23007 *x
+= best_glyph
->pixel_width
;
23012 *vpos
= best_row
- w
->current_matrix
->rows
;
23015 return best_glyph
!= NULL
;
23019 /* See if position X, Y is within a hot-spot of an image. */
23022 on_hot_spot_p (hot_spot
, x
, y
)
23023 Lisp_Object hot_spot
;
23026 if (!CONSP (hot_spot
))
23029 if (EQ (XCAR (hot_spot
), Qrect
))
23031 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
23032 Lisp_Object rect
= XCDR (hot_spot
);
23036 if (!CONSP (XCAR (rect
)))
23038 if (!CONSP (XCDR (rect
)))
23040 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
23042 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
23044 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
23046 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
23050 else if (EQ (XCAR (hot_spot
), Qcircle
))
23052 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
23053 Lisp_Object circ
= XCDR (hot_spot
);
23054 Lisp_Object lr
, lx0
, ly0
;
23056 && CONSP (XCAR (circ
))
23057 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
23058 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
23059 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
23061 double r
= XFLOATINT (lr
);
23062 double dx
= XINT (lx0
) - x
;
23063 double dy
= XINT (ly0
) - y
;
23064 return (dx
* dx
+ dy
* dy
<= r
* r
);
23067 else if (EQ (XCAR (hot_spot
), Qpoly
))
23069 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
23070 if (VECTORP (XCDR (hot_spot
)))
23072 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
23073 Lisp_Object
*poly
= v
->contents
;
23077 Lisp_Object lx
, ly
;
23080 /* Need an even number of coordinates, and at least 3 edges. */
23081 if (n
< 6 || n
& 1)
23084 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
23085 If count is odd, we are inside polygon. Pixels on edges
23086 may or may not be included depending on actual geometry of the
23088 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
23089 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
23091 x0
= XINT (lx
), y0
= XINT (ly
);
23092 for (i
= 0; i
< n
; i
+= 2)
23094 int x1
= x0
, y1
= y0
;
23095 if ((lx
= poly
[i
], !INTEGERP (lx
))
23096 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
23098 x0
= XINT (lx
), y0
= XINT (ly
);
23100 /* Does this segment cross the X line? */
23108 if (y
> y0
&& y
> y1
)
23110 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
23120 find_hot_spot (map
, x
, y
)
23124 while (CONSP (map
))
23126 if (CONSP (XCAR (map
))
23127 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
23135 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
23137 doc
: /* Lookup in image map MAP coordinates X and Y.
23138 An image map is an alist where each element has the format (AREA ID PLIST).
23139 An AREA is specified as either a rectangle, a circle, or a polygon:
23140 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
23141 pixel coordinates of the upper left and bottom right corners.
23142 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
23143 and the radius of the circle; r may be a float or integer.
23144 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
23145 vector describes one corner in the polygon.
23146 Returns the alist element for the first matching AREA in MAP. */)
23157 return find_hot_spot (map
, XINT (x
), XINT (y
));
23161 /* Display frame CURSOR, optionally using shape defined by POINTER. */
23163 define_frame_cursor1 (f
, cursor
, pointer
)
23166 Lisp_Object pointer
;
23168 /* Do not change cursor shape while dragging mouse. */
23169 if (!NILP (do_mouse_tracking
))
23172 if (!NILP (pointer
))
23174 if (EQ (pointer
, Qarrow
))
23175 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23176 else if (EQ (pointer
, Qhand
))
23177 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
23178 else if (EQ (pointer
, Qtext
))
23179 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
23180 else if (EQ (pointer
, intern ("hdrag")))
23181 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
23182 #ifdef HAVE_X_WINDOWS
23183 else if (EQ (pointer
, intern ("vdrag")))
23184 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
23186 else if (EQ (pointer
, intern ("hourglass")))
23187 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
23188 else if (EQ (pointer
, Qmodeline
))
23189 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
23191 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23194 if (cursor
!= No_Cursor
)
23195 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
23198 /* Take proper action when mouse has moved to the mode or header line
23199 or marginal area AREA of window W, x-position X and y-position Y.
23200 X is relative to the start of the text display area of W, so the
23201 width of bitmap areas and scroll bars must be subtracted to get a
23202 position relative to the start of the mode line. */
23205 note_mode_line_or_margin_highlight (window
, x
, y
, area
)
23206 Lisp_Object window
;
23208 enum window_part area
;
23210 struct window
*w
= XWINDOW (window
);
23211 struct frame
*f
= XFRAME (w
->frame
);
23212 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
23213 Cursor cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23214 Lisp_Object pointer
= Qnil
;
23215 int charpos
, dx
, dy
, width
, height
;
23216 Lisp_Object string
, object
= Qnil
;
23217 Lisp_Object pos
, help
;
23219 Lisp_Object mouse_face
;
23220 int original_x_pixel
= x
;
23221 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
23222 struct glyph_row
*row
;
23224 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
23229 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
23230 &object
, &dx
, &dy
, &width
, &height
);
23232 row
= (area
== ON_MODE_LINE
23233 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
23234 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
23237 if (row
->mode_line_p
&& row
->enabled_p
)
23239 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
23240 end
= glyph
+ row
->used
[TEXT_AREA
];
23242 for (x0
= original_x_pixel
;
23243 glyph
< end
&& x0
>= glyph
->pixel_width
;
23245 x0
-= glyph
->pixel_width
;
23253 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
23254 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
23255 &object
, &dx
, &dy
, &width
, &height
);
23260 if (IMAGEP (object
))
23262 Lisp_Object image_map
, hotspot
;
23263 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
23265 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
23267 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
23269 Lisp_Object area_id
, plist
;
23271 area_id
= XCAR (hotspot
);
23272 /* Could check AREA_ID to see if we enter/leave this hot-spot.
23273 If so, we could look for mouse-enter, mouse-leave
23274 properties in PLIST (and do something...). */
23275 hotspot
= XCDR (hotspot
);
23276 if (CONSP (hotspot
)
23277 && (plist
= XCAR (hotspot
), CONSP (plist
)))
23279 pointer
= Fplist_get (plist
, Qpointer
);
23280 if (NILP (pointer
))
23282 help
= Fplist_get (plist
, Qhelp_echo
);
23285 help_echo_string
= help
;
23286 /* Is this correct? ++kfs */
23287 XSETWINDOW (help_echo_window
, w
);
23288 help_echo_object
= w
->buffer
;
23289 help_echo_pos
= charpos
;
23293 if (NILP (pointer
))
23294 pointer
= Fplist_get (XCDR (object
), QCpointer
);
23297 if (STRINGP (string
))
23299 pos
= make_number (charpos
);
23300 /* If we're on a string with `help-echo' text property, arrange
23301 for the help to be displayed. This is done by setting the
23302 global variable help_echo_string to the help string. */
23305 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
23308 help_echo_string
= help
;
23309 XSETWINDOW (help_echo_window
, w
);
23310 help_echo_object
= string
;
23311 help_echo_pos
= charpos
;
23315 if (NILP (pointer
))
23316 pointer
= Fget_text_property (pos
, Qpointer
, string
);
23318 /* Change the mouse pointer according to what is under X/Y. */
23319 if (NILP (pointer
) && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
23322 map
= Fget_text_property (pos
, Qlocal_map
, string
);
23323 if (!KEYMAPP (map
))
23324 map
= Fget_text_property (pos
, Qkeymap
, string
);
23325 if (!KEYMAPP (map
))
23326 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
23329 /* Change the mouse face according to what is under X/Y. */
23330 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
23331 if (!NILP (mouse_face
)
23332 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
23337 struct glyph
* tmp_glyph
;
23341 int total_pixel_width
;
23346 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
23347 Qmouse_face
, string
, Qnil
);
23349 b
= make_number (0);
23351 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
23353 e
= make_number (SCHARS (string
));
23355 /* Calculate the position(glyph position: GPOS) of GLYPH in
23356 displayed string. GPOS is different from CHARPOS.
23358 CHARPOS is the position of glyph in internal string
23359 object. A mode line string format has structures which
23360 is converted to a flatten by emacs lisp interpreter.
23361 The internal string is an element of the structures.
23362 The displayed string is the flatten string. */
23364 if (glyph
> row_start_glyph
)
23366 tmp_glyph
= glyph
- 1;
23367 while (tmp_glyph
>= row_start_glyph
23368 && tmp_glyph
->charpos
>= XINT (b
)
23369 && EQ (tmp_glyph
->object
, glyph
->object
))
23376 /* Calculate the lenght(glyph sequence length: GSEQ_LENGTH) of
23377 displayed string holding GLYPH.
23379 GSEQ_LENGTH is different from SCHARS (STRING).
23380 SCHARS (STRING) returns the length of the internal string. */
23381 for (tmp_glyph
= glyph
, gseq_length
= gpos
;
23382 tmp_glyph
->charpos
< XINT (e
);
23383 tmp_glyph
++, gseq_length
++)
23385 if (!EQ (tmp_glyph
->object
, glyph
->object
))
23389 total_pixel_width
= 0;
23390 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
23391 total_pixel_width
+= tmp_glyph
->pixel_width
;
23393 /* Pre calculation of re-rendering position */
23395 hpos
= (area
== ON_MODE_LINE
23396 ? (w
->current_matrix
)->nrows
- 1
23399 /* If the re-rendering position is included in the last
23400 re-rendering area, we should do nothing. */
23401 if ( EQ (window
, dpyinfo
->mouse_face_window
)
23402 && dpyinfo
->mouse_face_beg_col
<= vpos
23403 && vpos
< dpyinfo
->mouse_face_end_col
23404 && dpyinfo
->mouse_face_beg_row
== hpos
)
23407 if (clear_mouse_face (dpyinfo
))
23408 cursor
= No_Cursor
;
23410 dpyinfo
->mouse_face_beg_col
= vpos
;
23411 dpyinfo
->mouse_face_beg_row
= hpos
;
23413 dpyinfo
->mouse_face_beg_x
= original_x_pixel
- (total_pixel_width
+ dx
);
23414 dpyinfo
->mouse_face_beg_y
= 0;
23416 dpyinfo
->mouse_face_end_col
= vpos
+ gseq_length
;
23417 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_beg_row
;
23419 dpyinfo
->mouse_face_end_x
= 0;
23420 dpyinfo
->mouse_face_end_y
= 0;
23422 dpyinfo
->mouse_face_past_end
= 0;
23423 dpyinfo
->mouse_face_window
= window
;
23425 dpyinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
23428 glyph
->face_id
, 1);
23429 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23431 if (NILP (pointer
))
23434 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
23435 clear_mouse_face (dpyinfo
);
23437 define_frame_cursor1 (f
, cursor
, pointer
);
23442 Take proper action when the mouse has moved to position X, Y on
23443 frame F as regards highlighting characters that have mouse-face
23444 properties. Also de-highlighting chars where the mouse was before.
23445 X and Y can be negative or out of range. */
23448 note_mouse_highlight (f
, x
, y
)
23452 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
23453 enum window_part part
;
23454 Lisp_Object window
;
23456 Cursor cursor
= No_Cursor
;
23457 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
23460 /* When a menu is active, don't highlight because this looks odd. */
23461 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
23462 if (popup_activated ())
23466 if (NILP (Vmouse_highlight
)
23467 || !f
->glyphs_initialized_p
23468 || f
->pointer_invisible
)
23471 dpyinfo
->mouse_face_mouse_x
= x
;
23472 dpyinfo
->mouse_face_mouse_y
= y
;
23473 dpyinfo
->mouse_face_mouse_frame
= f
;
23475 if (dpyinfo
->mouse_face_defer
)
23478 if (gc_in_progress
)
23480 dpyinfo
->mouse_face_deferred_gc
= 1;
23484 /* Which window is that in? */
23485 window
= window_from_coordinates (f
, x
, y
, &part
, 0, 0, 1);
23487 /* If we were displaying active text in another window, clear that.
23488 Also clear if we move out of text area in same window. */
23489 if (! EQ (window
, dpyinfo
->mouse_face_window
)
23490 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
23491 && !NILP (dpyinfo
->mouse_face_window
)))
23492 clear_mouse_face (dpyinfo
);
23494 /* Not on a window -> return. */
23495 if (!WINDOWP (window
))
23498 /* Reset help_echo_string. It will get recomputed below. */
23499 help_echo_string
= Qnil
;
23501 /* Convert to window-relative pixel coordinates. */
23502 w
= XWINDOW (window
);
23503 frame_to_window_pixel_xy (w
, &x
, &y
);
23505 /* Handle tool-bar window differently since it doesn't display a
23507 if (EQ (window
, f
->tool_bar_window
))
23509 note_tool_bar_highlight (f
, x
, y
);
23513 /* Mouse is on the mode, header line or margin? */
23514 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
23515 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
23517 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
23521 if (part
== ON_VERTICAL_BORDER
)
23523 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
23524 help_echo_string
= build_string ("drag-mouse-1: resize");
23526 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
23527 || part
== ON_SCROLL_BAR
)
23528 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23530 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
23532 /* Are we in a window whose display is up to date?
23533 And verify the buffer's text has not changed. */
23534 b
= XBUFFER (w
->buffer
);
23535 if (part
== ON_TEXT
23536 && EQ (w
->window_end_valid
, w
->buffer
)
23537 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
23538 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
23540 int hpos
, vpos
, pos
, i
, dx
, dy
, area
;
23541 struct glyph
*glyph
;
23542 Lisp_Object object
;
23543 Lisp_Object mouse_face
= Qnil
, overlay
= Qnil
, position
;
23544 Lisp_Object
*overlay_vec
= NULL
;
23546 struct buffer
*obuf
;
23547 int obegv
, ozv
, same_region
;
23549 /* Find the glyph under X/Y. */
23550 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
23552 /* Look for :pointer property on image. */
23553 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
23555 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
23556 if (img
!= NULL
&& IMAGEP (img
->spec
))
23558 Lisp_Object image_map
, hotspot
;
23559 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
23561 && (hotspot
= find_hot_spot (image_map
,
23562 glyph
->slice
.x
+ dx
,
23563 glyph
->slice
.y
+ dy
),
23565 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
23567 Lisp_Object area_id
, plist
;
23569 area_id
= XCAR (hotspot
);
23570 /* Could check AREA_ID to see if we enter/leave this hot-spot.
23571 If so, we could look for mouse-enter, mouse-leave
23572 properties in PLIST (and do something...). */
23573 hotspot
= XCDR (hotspot
);
23574 if (CONSP (hotspot
)
23575 && (plist
= XCAR (hotspot
), CONSP (plist
)))
23577 pointer
= Fplist_get (plist
, Qpointer
);
23578 if (NILP (pointer
))
23580 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
23581 if (!NILP (help_echo_string
))
23583 help_echo_window
= window
;
23584 help_echo_object
= glyph
->object
;
23585 help_echo_pos
= glyph
->charpos
;
23589 if (NILP (pointer
))
23590 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
23594 /* Clear mouse face if X/Y not over text. */
23596 || area
!= TEXT_AREA
23597 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
)
23599 if (clear_mouse_face (dpyinfo
))
23600 cursor
= No_Cursor
;
23601 if (NILP (pointer
))
23603 if (area
!= TEXT_AREA
)
23604 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23606 pointer
= Vvoid_text_area_pointer
;
23611 pos
= glyph
->charpos
;
23612 object
= glyph
->object
;
23613 if (!STRINGP (object
) && !BUFFERP (object
))
23616 /* If we get an out-of-range value, return now; avoid an error. */
23617 if (BUFFERP (object
) && pos
> BUF_Z (b
))
23620 /* Make the window's buffer temporarily current for
23621 overlays_at and compute_char_face. */
23622 obuf
= current_buffer
;
23623 current_buffer
= b
;
23629 /* Is this char mouse-active or does it have help-echo? */
23630 position
= make_number (pos
);
23632 if (BUFFERP (object
))
23634 /* Put all the overlays we want in a vector in overlay_vec. */
23635 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
23636 /* Sort overlays into increasing priority order. */
23637 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
23642 same_region
= (EQ (window
, dpyinfo
->mouse_face_window
)
23643 && vpos
>= dpyinfo
->mouse_face_beg_row
23644 && vpos
<= dpyinfo
->mouse_face_end_row
23645 && (vpos
> dpyinfo
->mouse_face_beg_row
23646 || hpos
>= dpyinfo
->mouse_face_beg_col
)
23647 && (vpos
< dpyinfo
->mouse_face_end_row
23648 || hpos
< dpyinfo
->mouse_face_end_col
23649 || dpyinfo
->mouse_face_past_end
));
23652 cursor
= No_Cursor
;
23654 /* Check mouse-face highlighting. */
23656 /* If there exists an overlay with mouse-face overlapping
23657 the one we are currently highlighting, we have to
23658 check if we enter the overlapping overlay, and then
23659 highlight only that. */
23660 || (OVERLAYP (dpyinfo
->mouse_face_overlay
)
23661 && mouse_face_overlay_overlaps (dpyinfo
->mouse_face_overlay
)))
23663 /* Find the highest priority overlay with a mouse-face. */
23665 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
23667 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
23668 if (!NILP (mouse_face
))
23669 overlay
= overlay_vec
[i
];
23672 /* If we're highlighting the same overlay as before, there's
23673 no need to do that again. */
23674 if (!NILP (overlay
) && EQ (overlay
, dpyinfo
->mouse_face_overlay
))
23675 goto check_help_echo
;
23676 dpyinfo
->mouse_face_overlay
= overlay
;
23678 /* Clear the display of the old active region, if any. */
23679 if (clear_mouse_face (dpyinfo
))
23680 cursor
= No_Cursor
;
23682 /* If no overlay applies, get a text property. */
23683 if (NILP (overlay
))
23684 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
23686 /* Next, compute the bounds of the mouse highlighting and
23688 if (!NILP (mouse_face
) && STRINGP (object
))
23690 /* The mouse-highlighting comes from a display string
23691 with a mouse-face. */
23695 b
= Fprevious_single_property_change
23696 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
23697 e
= Fnext_single_property_change
23698 (position
, Qmouse_face
, object
, Qnil
);
23700 b
= make_number (0);
23702 e
= make_number (SCHARS (object
) - 1);
23704 fast_find_string_pos (w
, XINT (b
), object
,
23705 &dpyinfo
->mouse_face_beg_col
,
23706 &dpyinfo
->mouse_face_beg_row
,
23707 &dpyinfo
->mouse_face_beg_x
,
23708 &dpyinfo
->mouse_face_beg_y
, 0);
23709 fast_find_string_pos (w
, XINT (e
), object
,
23710 &dpyinfo
->mouse_face_end_col
,
23711 &dpyinfo
->mouse_face_end_row
,
23712 &dpyinfo
->mouse_face_end_x
,
23713 &dpyinfo
->mouse_face_end_y
, 1);
23714 dpyinfo
->mouse_face_past_end
= 0;
23715 dpyinfo
->mouse_face_window
= window
;
23716 dpyinfo
->mouse_face_face_id
23717 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
23718 glyph
->face_id
, 1);
23719 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23720 cursor
= No_Cursor
;
23724 /* The mouse-highlighting, if any, comes from an overlay
23725 or text property in the buffer. */
23726 Lisp_Object buffer
, display_string
;
23728 if (STRINGP (object
))
23730 /* If we are on a display string with no mouse-face,
23731 check if the text under it has one. */
23732 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
23733 int start
= MATRIX_ROW_START_CHARPOS (r
);
23734 pos
= string_buffer_position (w
, object
, start
);
23737 mouse_face
= get_char_property_and_overlay
23738 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
23739 buffer
= w
->buffer
;
23740 display_string
= object
;
23746 display_string
= Qnil
;
23749 if (!NILP (mouse_face
))
23751 Lisp_Object before
, after
;
23752 Lisp_Object before_string
, after_string
;
23754 if (NILP (overlay
))
23756 /* Handle the text property case. */
23757 before
= Fprevious_single_property_change
23758 (make_number (pos
+ 1), Qmouse_face
, buffer
,
23759 Fmarker_position (w
->start
));
23760 after
= Fnext_single_property_change
23761 (make_number (pos
), Qmouse_face
, buffer
,
23762 make_number (BUF_Z (XBUFFER (buffer
))
23763 - XFASTINT (w
->window_end_pos
)));
23764 before_string
= after_string
= Qnil
;
23768 /* Handle the overlay case. */
23769 before
= Foverlay_start (overlay
);
23770 after
= Foverlay_end (overlay
);
23771 before_string
= Foverlay_get (overlay
, Qbefore_string
);
23772 after_string
= Foverlay_get (overlay
, Qafter_string
);
23774 if (!STRINGP (before_string
)) before_string
= Qnil
;
23775 if (!STRINGP (after_string
)) after_string
= Qnil
;
23778 mouse_face_from_buffer_pos (window
, dpyinfo
, pos
,
23781 before_string
, after_string
,
23783 cursor
= No_Cursor
;
23790 /* Look for a `help-echo' property. */
23791 if (NILP (help_echo_string
)) {
23792 Lisp_Object help
, overlay
;
23794 /* Check overlays first. */
23795 help
= overlay
= Qnil
;
23796 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
23798 overlay
= overlay_vec
[i
];
23799 help
= Foverlay_get (overlay
, Qhelp_echo
);
23804 help_echo_string
= help
;
23805 help_echo_window
= window
;
23806 help_echo_object
= overlay
;
23807 help_echo_pos
= pos
;
23811 Lisp_Object object
= glyph
->object
;
23812 int charpos
= glyph
->charpos
;
23814 /* Try text properties. */
23815 if (STRINGP (object
)
23817 && charpos
< SCHARS (object
))
23819 help
= Fget_text_property (make_number (charpos
),
23820 Qhelp_echo
, object
);
23823 /* If the string itself doesn't specify a help-echo,
23824 see if the buffer text ``under'' it does. */
23825 struct glyph_row
*r
23826 = MATRIX_ROW (w
->current_matrix
, vpos
);
23827 int start
= MATRIX_ROW_START_CHARPOS (r
);
23828 int pos
= string_buffer_position (w
, object
, start
);
23831 help
= Fget_char_property (make_number (pos
),
23832 Qhelp_echo
, w
->buffer
);
23836 object
= w
->buffer
;
23841 else if (BUFFERP (object
)
23844 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
23849 help_echo_string
= help
;
23850 help_echo_window
= window
;
23851 help_echo_object
= object
;
23852 help_echo_pos
= charpos
;
23857 /* Look for a `pointer' property. */
23858 if (NILP (pointer
))
23860 /* Check overlays first. */
23861 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
23862 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
23864 if (NILP (pointer
))
23866 Lisp_Object object
= glyph
->object
;
23867 int charpos
= glyph
->charpos
;
23869 /* Try text properties. */
23870 if (STRINGP (object
)
23872 && charpos
< SCHARS (object
))
23874 pointer
= Fget_text_property (make_number (charpos
),
23876 if (NILP (pointer
))
23878 /* If the string itself doesn't specify a pointer,
23879 see if the buffer text ``under'' it does. */
23880 struct glyph_row
*r
23881 = MATRIX_ROW (w
->current_matrix
, vpos
);
23882 int start
= MATRIX_ROW_START_CHARPOS (r
);
23883 int pos
= string_buffer_position (w
, object
, start
);
23885 pointer
= Fget_char_property (make_number (pos
),
23886 Qpointer
, w
->buffer
);
23889 else if (BUFFERP (object
)
23892 pointer
= Fget_text_property (make_number (charpos
),
23899 current_buffer
= obuf
;
23904 define_frame_cursor1 (f
, cursor
, pointer
);
23909 Clear any mouse-face on window W. This function is part of the
23910 redisplay interface, and is called from try_window_id and similar
23911 functions to ensure the mouse-highlight is off. */
23914 x_clear_window_mouse_face (w
)
23917 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
23918 Lisp_Object window
;
23921 XSETWINDOW (window
, w
);
23922 if (EQ (window
, dpyinfo
->mouse_face_window
))
23923 clear_mouse_face (dpyinfo
);
23929 Just discard the mouse face information for frame F, if any.
23930 This is used when the size of F is changed. */
23933 cancel_mouse_face (f
)
23936 Lisp_Object window
;
23937 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
23939 window
= dpyinfo
->mouse_face_window
;
23940 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
23942 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
23943 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
23944 dpyinfo
->mouse_face_window
= Qnil
;
23949 #endif /* HAVE_WINDOW_SYSTEM */
23952 /***********************************************************************
23954 ***********************************************************************/
23956 #ifdef HAVE_WINDOW_SYSTEM
23958 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
23959 which intersects rectangle R. R is in window-relative coordinates. */
23962 expose_area (w
, row
, r
, area
)
23964 struct glyph_row
*row
;
23966 enum glyph_row_area area
;
23968 struct glyph
*first
= row
->glyphs
[area
];
23969 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
23970 struct glyph
*last
;
23971 int first_x
, start_x
, x
;
23973 if (area
== TEXT_AREA
&& row
->fill_line_p
)
23974 /* If row extends face to end of line write the whole line. */
23975 draw_glyphs (w
, 0, row
, area
,
23976 0, row
->used
[area
],
23977 DRAW_NORMAL_TEXT
, 0);
23980 /* Set START_X to the window-relative start position for drawing glyphs of
23981 AREA. The first glyph of the text area can be partially visible.
23982 The first glyphs of other areas cannot. */
23983 start_x
= window_box_left_offset (w
, area
);
23985 if (area
== TEXT_AREA
)
23988 /* Find the first glyph that must be redrawn. */
23990 && x
+ first
->pixel_width
< r
->x
)
23992 x
+= first
->pixel_width
;
23996 /* Find the last one. */
24000 && x
< r
->x
+ r
->width
)
24002 x
+= last
->pixel_width
;
24008 draw_glyphs (w
, first_x
- start_x
, row
, area
,
24009 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
24010 DRAW_NORMAL_TEXT
, 0);
24015 /* Redraw the parts of the glyph row ROW on window W intersecting
24016 rectangle R. R is in window-relative coordinates. Value is
24017 non-zero if mouse-face was overwritten. */
24020 expose_line (w
, row
, r
)
24022 struct glyph_row
*row
;
24025 xassert (row
->enabled_p
);
24027 if (row
->mode_line_p
|| w
->pseudo_window_p
)
24028 draw_glyphs (w
, 0, row
, TEXT_AREA
,
24029 0, row
->used
[TEXT_AREA
],
24030 DRAW_NORMAL_TEXT
, 0);
24033 if (row
->used
[LEFT_MARGIN_AREA
])
24034 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
24035 if (row
->used
[TEXT_AREA
])
24036 expose_area (w
, row
, r
, TEXT_AREA
);
24037 if (row
->used
[RIGHT_MARGIN_AREA
])
24038 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
24039 draw_row_fringe_bitmaps (w
, row
);
24042 return row
->mouse_face_p
;
24046 /* Redraw those parts of glyphs rows during expose event handling that
24047 overlap other rows. Redrawing of an exposed line writes over parts
24048 of lines overlapping that exposed line; this function fixes that.
24050 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
24051 row in W's current matrix that is exposed and overlaps other rows.
24052 LAST_OVERLAPPING_ROW is the last such row. */
24055 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
, r
)
24057 struct glyph_row
*first_overlapping_row
;
24058 struct glyph_row
*last_overlapping_row
;
24061 struct glyph_row
*row
;
24063 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
24064 if (row
->overlapping_p
)
24066 xassert (row
->enabled_p
&& !row
->mode_line_p
);
24069 if (row
->used
[LEFT_MARGIN_AREA
])
24070 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
24072 if (row
->used
[TEXT_AREA
])
24073 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
24075 if (row
->used
[RIGHT_MARGIN_AREA
])
24076 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
24082 /* Return non-zero if W's cursor intersects rectangle R. */
24085 phys_cursor_in_rect_p (w
, r
)
24089 XRectangle cr
, result
;
24090 struct glyph
*cursor_glyph
;
24091 struct glyph_row
*row
;
24093 if (w
->phys_cursor
.vpos
>= 0
24094 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
24095 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
24097 && row
->cursor_in_fringe_p
)
24099 /* Cursor is in the fringe. */
24100 cr
.x
= window_box_right_offset (w
,
24101 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
24102 ? RIGHT_MARGIN_AREA
24105 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
24106 cr
.height
= row
->height
;
24107 return x_intersect_rectangles (&cr
, r
, &result
);
24110 cursor_glyph
= get_phys_cursor_glyph (w
);
24113 /* r is relative to W's box, but w->phys_cursor.x is relative
24114 to left edge of W's TEXT area. Adjust it. */
24115 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
24116 cr
.y
= w
->phys_cursor
.y
;
24117 cr
.width
= cursor_glyph
->pixel_width
;
24118 cr
.height
= w
->phys_cursor_height
;
24119 /* ++KFS: W32 version used W32-specific IntersectRect here, but
24120 I assume the effect is the same -- and this is portable. */
24121 return x_intersect_rectangles (&cr
, r
, &result
);
24123 /* If we don't understand the format, pretend we're not in the hot-spot. */
24129 Draw a vertical window border to the right of window W if W doesn't
24130 have vertical scroll bars. */
24133 x_draw_vertical_border (w
)
24136 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
24138 /* We could do better, if we knew what type of scroll-bar the adjacent
24139 windows (on either side) have... But we don't :-(
24140 However, I think this works ok. ++KFS 2003-04-25 */
24142 /* Redraw borders between horizontally adjacent windows. Don't
24143 do it for frames with vertical scroll bars because either the
24144 right scroll bar of a window, or the left scroll bar of its
24145 neighbor will suffice as a border. */
24146 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
24149 if (!WINDOW_RIGHTMOST_P (w
)
24150 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
24152 int x0
, x1
, y0
, y1
;
24154 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
24157 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
24160 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
24162 else if (!WINDOW_LEFTMOST_P (w
)
24163 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
24165 int x0
, x1
, y0
, y1
;
24167 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
24170 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
24173 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
24178 /* Redraw the part of window W intersection rectangle FR. Pixel
24179 coordinates in FR are frame-relative. Call this function with
24180 input blocked. Value is non-zero if the exposure overwrites
24184 expose_window (w
, fr
)
24188 struct frame
*f
= XFRAME (w
->frame
);
24190 int mouse_face_overwritten_p
= 0;
24192 /* If window is not yet fully initialized, do nothing. This can
24193 happen when toolkit scroll bars are used and a window is split.
24194 Reconfiguring the scroll bar will generate an expose for a newly
24196 if (w
->current_matrix
== NULL
)
24199 /* When we're currently updating the window, display and current
24200 matrix usually don't agree. Arrange for a thorough display
24202 if (w
== updated_window
)
24204 SET_FRAME_GARBAGED (f
);
24208 /* Frame-relative pixel rectangle of W. */
24209 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
24210 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
24211 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
24212 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
24214 if (x_intersect_rectangles (fr
, &wr
, &r
))
24216 int yb
= window_text_bottom_y (w
);
24217 struct glyph_row
*row
;
24218 int cursor_cleared_p
;
24219 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
24221 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
24222 r
.x
, r
.y
, r
.width
, r
.height
));
24224 /* Convert to window coordinates. */
24225 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
24226 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
24228 /* Turn off the cursor. */
24229 if (!w
->pseudo_window_p
24230 && phys_cursor_in_rect_p (w
, &r
))
24232 x_clear_cursor (w
);
24233 cursor_cleared_p
= 1;
24236 cursor_cleared_p
= 0;
24238 /* Update lines intersecting rectangle R. */
24239 first_overlapping_row
= last_overlapping_row
= NULL
;
24240 for (row
= w
->current_matrix
->rows
;
24245 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
24247 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
24248 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
24249 || (r
.y
>= y0
&& r
.y
< y1
)
24250 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
24252 /* A header line may be overlapping, but there is no need
24253 to fix overlapping areas for them. KFS 2005-02-12 */
24254 if (row
->overlapping_p
&& !row
->mode_line_p
)
24256 if (first_overlapping_row
== NULL
)
24257 first_overlapping_row
= row
;
24258 last_overlapping_row
= row
;
24262 if (expose_line (w
, row
, &r
))
24263 mouse_face_overwritten_p
= 1;
24266 else if (row
->overlapping_p
)
24268 /* We must redraw a row overlapping the exposed area. */
24270 ? y0
+ row
->phys_height
> r
.y
24271 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
24273 if (first_overlapping_row
== NULL
)
24274 first_overlapping_row
= row
;
24275 last_overlapping_row
= row
;
24283 /* Display the mode line if there is one. */
24284 if (WINDOW_WANTS_MODELINE_P (w
)
24285 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
24287 && row
->y
< r
.y
+ r
.height
)
24289 if (expose_line (w
, row
, &r
))
24290 mouse_face_overwritten_p
= 1;
24293 if (!w
->pseudo_window_p
)
24295 /* Fix the display of overlapping rows. */
24296 if (first_overlapping_row
)
24297 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
24300 /* Draw border between windows. */
24301 x_draw_vertical_border (w
);
24303 /* Turn the cursor on again. */
24304 if (cursor_cleared_p
)
24305 update_window_cursor (w
, 1);
24309 return mouse_face_overwritten_p
;
24314 /* Redraw (parts) of all windows in the window tree rooted at W that
24315 intersect R. R contains frame pixel coordinates. Value is
24316 non-zero if the exposure overwrites mouse-face. */
24319 expose_window_tree (w
, r
)
24323 struct frame
*f
= XFRAME (w
->frame
);
24324 int mouse_face_overwritten_p
= 0;
24326 while (w
&& !FRAME_GARBAGED_P (f
))
24328 if (!NILP (w
->hchild
))
24329 mouse_face_overwritten_p
24330 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
24331 else if (!NILP (w
->vchild
))
24332 mouse_face_overwritten_p
24333 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
24335 mouse_face_overwritten_p
|= expose_window (w
, r
);
24337 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
24340 return mouse_face_overwritten_p
;
24345 Redisplay an exposed area of frame F. X and Y are the upper-left
24346 corner of the exposed rectangle. W and H are width and height of
24347 the exposed area. All are pixel values. W or H zero means redraw
24348 the entire frame. */
24351 expose_frame (f
, x
, y
, w
, h
)
24356 int mouse_face_overwritten_p
= 0;
24358 TRACE ((stderr
, "expose_frame "));
24360 /* No need to redraw if frame will be redrawn soon. */
24361 if (FRAME_GARBAGED_P (f
))
24363 TRACE ((stderr
, " garbaged\n"));
24367 /* If basic faces haven't been realized yet, there is no point in
24368 trying to redraw anything. This can happen when we get an expose
24369 event while Emacs is starting, e.g. by moving another window. */
24370 if (FRAME_FACE_CACHE (f
) == NULL
24371 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
24373 TRACE ((stderr
, " no faces\n"));
24377 if (w
== 0 || h
== 0)
24380 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
24381 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
24391 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
24392 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
24394 if (WINDOWP (f
->tool_bar_window
))
24395 mouse_face_overwritten_p
24396 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
24398 #ifdef HAVE_X_WINDOWS
24400 #ifndef USE_X_TOOLKIT
24401 if (WINDOWP (f
->menu_bar_window
))
24402 mouse_face_overwritten_p
24403 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
24404 #endif /* not USE_X_TOOLKIT */
24408 /* Some window managers support a focus-follows-mouse style with
24409 delayed raising of frames. Imagine a partially obscured frame,
24410 and moving the mouse into partially obscured mouse-face on that
24411 frame. The visible part of the mouse-face will be highlighted,
24412 then the WM raises the obscured frame. With at least one WM, KDE
24413 2.1, Emacs is not getting any event for the raising of the frame
24414 (even tried with SubstructureRedirectMask), only Expose events.
24415 These expose events will draw text normally, i.e. not
24416 highlighted. Which means we must redo the highlight here.
24417 Subsume it under ``we love X''. --gerd 2001-08-15 */
24418 /* Included in Windows version because Windows most likely does not
24419 do the right thing if any third party tool offers
24420 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
24421 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
24423 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24424 if (f
== dpyinfo
->mouse_face_mouse_frame
)
24426 int x
= dpyinfo
->mouse_face_mouse_x
;
24427 int y
= dpyinfo
->mouse_face_mouse_y
;
24428 clear_mouse_face (dpyinfo
);
24429 note_mouse_highlight (f
, x
, y
);
24436 Determine the intersection of two rectangles R1 and R2. Return
24437 the intersection in *RESULT. Value is non-zero if RESULT is not
24441 x_intersect_rectangles (r1
, r2
, result
)
24442 XRectangle
*r1
, *r2
, *result
;
24444 XRectangle
*left
, *right
;
24445 XRectangle
*upper
, *lower
;
24446 int intersection_p
= 0;
24448 /* Rearrange so that R1 is the left-most rectangle. */
24450 left
= r1
, right
= r2
;
24452 left
= r2
, right
= r1
;
24454 /* X0 of the intersection is right.x0, if this is inside R1,
24455 otherwise there is no intersection. */
24456 if (right
->x
<= left
->x
+ left
->width
)
24458 result
->x
= right
->x
;
24460 /* The right end of the intersection is the minimum of the
24461 the right ends of left and right. */
24462 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
24465 /* Same game for Y. */
24467 upper
= r1
, lower
= r2
;
24469 upper
= r2
, lower
= r1
;
24471 /* The upper end of the intersection is lower.y0, if this is inside
24472 of upper. Otherwise, there is no intersection. */
24473 if (lower
->y
<= upper
->y
+ upper
->height
)
24475 result
->y
= lower
->y
;
24477 /* The lower end of the intersection is the minimum of the lower
24478 ends of upper and lower. */
24479 result
->height
= (min (lower
->y
+ lower
->height
,
24480 upper
->y
+ upper
->height
)
24482 intersection_p
= 1;
24486 return intersection_p
;
24489 #endif /* HAVE_WINDOW_SYSTEM */
24492 /***********************************************************************
24494 ***********************************************************************/
24499 Vwith_echo_area_save_vector
= Qnil
;
24500 staticpro (&Vwith_echo_area_save_vector
);
24502 Vmessage_stack
= Qnil
;
24503 staticpro (&Vmessage_stack
);
24505 Qinhibit_redisplay
= intern_c_string ("inhibit-redisplay");
24506 staticpro (&Qinhibit_redisplay
);
24508 message_dolog_marker1
= Fmake_marker ();
24509 staticpro (&message_dolog_marker1
);
24510 message_dolog_marker2
= Fmake_marker ();
24511 staticpro (&message_dolog_marker2
);
24512 message_dolog_marker3
= Fmake_marker ();
24513 staticpro (&message_dolog_marker3
);
24516 defsubr (&Sdump_frame_glyph_matrix
);
24517 defsubr (&Sdump_glyph_matrix
);
24518 defsubr (&Sdump_glyph_row
);
24519 defsubr (&Sdump_tool_bar_row
);
24520 defsubr (&Strace_redisplay
);
24521 defsubr (&Strace_to_stderr
);
24523 #ifdef HAVE_WINDOW_SYSTEM
24524 defsubr (&Stool_bar_lines_needed
);
24525 defsubr (&Slookup_image_map
);
24527 defsubr (&Sformat_mode_line
);
24528 defsubr (&Sinvisible_p
);
24530 staticpro (&Qmenu_bar_update_hook
);
24531 Qmenu_bar_update_hook
= intern_c_string ("menu-bar-update-hook");
24533 staticpro (&Qoverriding_terminal_local_map
);
24534 Qoverriding_terminal_local_map
= intern_c_string ("overriding-terminal-local-map");
24536 staticpro (&Qoverriding_local_map
);
24537 Qoverriding_local_map
= intern_c_string ("overriding-local-map");
24539 staticpro (&Qwindow_scroll_functions
);
24540 Qwindow_scroll_functions
= intern_c_string ("window-scroll-functions");
24542 staticpro (&Qwindow_text_change_functions
);
24543 Qwindow_text_change_functions
= intern_c_string ("window-text-change-functions");
24545 staticpro (&Qredisplay_end_trigger_functions
);
24546 Qredisplay_end_trigger_functions
= intern_c_string ("redisplay-end-trigger-functions");
24548 staticpro (&Qinhibit_point_motion_hooks
);
24549 Qinhibit_point_motion_hooks
= intern_c_string ("inhibit-point-motion-hooks");
24551 Qeval
= intern_c_string ("eval");
24552 staticpro (&Qeval
);
24554 QCdata
= intern_c_string (":data");
24555 staticpro (&QCdata
);
24556 Qdisplay
= intern_c_string ("display");
24557 staticpro (&Qdisplay
);
24558 Qspace_width
= intern_c_string ("space-width");
24559 staticpro (&Qspace_width
);
24560 Qraise
= intern_c_string ("raise");
24561 staticpro (&Qraise
);
24562 Qslice
= intern_c_string ("slice");
24563 staticpro (&Qslice
);
24564 Qspace
= intern_c_string ("space");
24565 staticpro (&Qspace
);
24566 Qmargin
= intern_c_string ("margin");
24567 staticpro (&Qmargin
);
24568 Qpointer
= intern_c_string ("pointer");
24569 staticpro (&Qpointer
);
24570 Qleft_margin
= intern_c_string ("left-margin");
24571 staticpro (&Qleft_margin
);
24572 Qright_margin
= intern_c_string ("right-margin");
24573 staticpro (&Qright_margin
);
24574 Qcenter
= intern_c_string ("center");
24575 staticpro (&Qcenter
);
24576 Qline_height
= intern_c_string ("line-height");
24577 staticpro (&Qline_height
);
24578 QCalign_to
= intern_c_string (":align-to");
24579 staticpro (&QCalign_to
);
24580 QCrelative_width
= intern_c_string (":relative-width");
24581 staticpro (&QCrelative_width
);
24582 QCrelative_height
= intern_c_string (":relative-height");
24583 staticpro (&QCrelative_height
);
24584 QCeval
= intern_c_string (":eval");
24585 staticpro (&QCeval
);
24586 QCpropertize
= intern_c_string (":propertize");
24587 staticpro (&QCpropertize
);
24588 QCfile
= intern_c_string (":file");
24589 staticpro (&QCfile
);
24590 Qfontified
= intern_c_string ("fontified");
24591 staticpro (&Qfontified
);
24592 Qfontification_functions
= intern_c_string ("fontification-functions");
24593 staticpro (&Qfontification_functions
);
24594 Qtrailing_whitespace
= intern_c_string ("trailing-whitespace");
24595 staticpro (&Qtrailing_whitespace
);
24596 Qescape_glyph
= intern_c_string ("escape-glyph");
24597 staticpro (&Qescape_glyph
);
24598 Qnobreak_space
= intern_c_string ("nobreak-space");
24599 staticpro (&Qnobreak_space
);
24600 Qimage
= intern_c_string ("image");
24601 staticpro (&Qimage
);
24602 QCmap
= intern_c_string (":map");
24603 staticpro (&QCmap
);
24604 QCpointer
= intern_c_string (":pointer");
24605 staticpro (&QCpointer
);
24606 Qrect
= intern_c_string ("rect");
24607 staticpro (&Qrect
);
24608 Qcircle
= intern_c_string ("circle");
24609 staticpro (&Qcircle
);
24610 Qpoly
= intern_c_string ("poly");
24611 staticpro (&Qpoly
);
24612 Qmessage_truncate_lines
= intern_c_string ("message-truncate-lines");
24613 staticpro (&Qmessage_truncate_lines
);
24614 Qgrow_only
= intern_c_string ("grow-only");
24615 staticpro (&Qgrow_only
);
24616 Qinhibit_menubar_update
= intern_c_string ("inhibit-menubar-update");
24617 staticpro (&Qinhibit_menubar_update
);
24618 Qinhibit_eval_during_redisplay
= intern_c_string ("inhibit-eval-during-redisplay");
24619 staticpro (&Qinhibit_eval_during_redisplay
);
24620 Qposition
= intern_c_string ("position");
24621 staticpro (&Qposition
);
24622 Qbuffer_position
= intern_c_string ("buffer-position");
24623 staticpro (&Qbuffer_position
);
24624 Qobject
= intern_c_string ("object");
24625 staticpro (&Qobject
);
24626 Qbar
= intern_c_string ("bar");
24628 Qhbar
= intern_c_string ("hbar");
24629 staticpro (&Qhbar
);
24630 Qbox
= intern_c_string ("box");
24632 Qhollow
= intern_c_string ("hollow");
24633 staticpro (&Qhollow
);
24634 Qhand
= intern_c_string ("hand");
24635 staticpro (&Qhand
);
24636 Qarrow
= intern_c_string ("arrow");
24637 staticpro (&Qarrow
);
24638 Qtext
= intern_c_string ("text");
24639 staticpro (&Qtext
);
24640 Qrisky_local_variable
= intern_c_string ("risky-local-variable");
24641 staticpro (&Qrisky_local_variable
);
24642 Qinhibit_free_realized_faces
= intern_c_string ("inhibit-free-realized-faces");
24643 staticpro (&Qinhibit_free_realized_faces
);
24645 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
24646 Fcons (intern_c_string ("void-variable"), Qnil
)),
24648 staticpro (&list_of_error
);
24650 Qlast_arrow_position
= intern_c_string ("last-arrow-position");
24651 staticpro (&Qlast_arrow_position
);
24652 Qlast_arrow_string
= intern_c_string ("last-arrow-string");
24653 staticpro (&Qlast_arrow_string
);
24655 Qoverlay_arrow_string
= intern_c_string ("overlay-arrow-string");
24656 staticpro (&Qoverlay_arrow_string
);
24657 Qoverlay_arrow_bitmap
= intern_c_string ("overlay-arrow-bitmap");
24658 staticpro (&Qoverlay_arrow_bitmap
);
24660 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
24661 staticpro (&echo_buffer
[0]);
24662 staticpro (&echo_buffer
[1]);
24664 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
24665 staticpro (&echo_area_buffer
[0]);
24666 staticpro (&echo_area_buffer
[1]);
24668 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
24669 staticpro (&Vmessages_buffer_name
);
24671 mode_line_proptrans_alist
= Qnil
;
24672 staticpro (&mode_line_proptrans_alist
);
24673 mode_line_string_list
= Qnil
;
24674 staticpro (&mode_line_string_list
);
24675 mode_line_string_face
= Qnil
;
24676 staticpro (&mode_line_string_face
);
24677 mode_line_string_face_prop
= Qnil
;
24678 staticpro (&mode_line_string_face_prop
);
24679 Vmode_line_unwind_vector
= Qnil
;
24680 staticpro (&Vmode_line_unwind_vector
);
24682 help_echo_string
= Qnil
;
24683 staticpro (&help_echo_string
);
24684 help_echo_object
= Qnil
;
24685 staticpro (&help_echo_object
);
24686 help_echo_window
= Qnil
;
24687 staticpro (&help_echo_window
);
24688 previous_help_echo_string
= Qnil
;
24689 staticpro (&previous_help_echo_string
);
24690 help_echo_pos
= -1;
24692 #ifdef HAVE_WINDOW_SYSTEM
24693 DEFVAR_BOOL ("x-stretch-cursor", &x_stretch_cursor_p
,
24694 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
24695 For example, if a block cursor is over a tab, it will be drawn as
24696 wide as that tab on the display. */);
24697 x_stretch_cursor_p
= 0;
24700 DEFVAR_LISP ("show-trailing-whitespace", &Vshow_trailing_whitespace
,
24701 doc
: /* *Non-nil means highlight trailing whitespace.
24702 The face used for trailing whitespace is `trailing-whitespace'. */);
24703 Vshow_trailing_whitespace
= Qnil
;
24705 DEFVAR_LISP ("nobreak-char-display", &Vnobreak_char_display
,
24706 doc
: /* *Control highlighting of nobreak space and soft hyphen.
24707 A value of t means highlight the character itself (for nobreak space,
24708 use face `nobreak-space').
24709 A value of nil means no highlighting.
24710 Other values mean display the escape glyph followed by an ordinary
24711 space or ordinary hyphen. */);
24712 Vnobreak_char_display
= Qt
;
24714 DEFVAR_LISP ("void-text-area-pointer", &Vvoid_text_area_pointer
,
24715 doc
: /* *The pointer shape to show in void text areas.
24716 A value of nil means to show the text pointer. Other options are `arrow',
24717 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
24718 Vvoid_text_area_pointer
= Qarrow
;
24720 DEFVAR_LISP ("inhibit-redisplay", &Vinhibit_redisplay
,
24721 doc
: /* Non-nil means don't actually do any redisplay.
24722 This is used for internal purposes. */);
24723 Vinhibit_redisplay
= Qnil
;
24725 DEFVAR_LISP ("global-mode-string", &Vglobal_mode_string
,
24726 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
24727 Vglobal_mode_string
= Qnil
;
24729 DEFVAR_LISP ("overlay-arrow-position", &Voverlay_arrow_position
,
24730 doc
: /* Marker for where to display an arrow on top of the buffer text.
24731 This must be the beginning of a line in order to work.
24732 See also `overlay-arrow-string'. */);
24733 Voverlay_arrow_position
= Qnil
;
24735 DEFVAR_LISP ("overlay-arrow-string", &Voverlay_arrow_string
,
24736 doc
: /* String to display as an arrow in non-window frames.
24737 See also `overlay-arrow-position'. */);
24738 Voverlay_arrow_string
= make_pure_c_string ("=>");
24740 DEFVAR_LISP ("overlay-arrow-variable-list", &Voverlay_arrow_variable_list
,
24741 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
24742 The symbols on this list are examined during redisplay to determine
24743 where to display overlay arrows. */);
24744 Voverlay_arrow_variable_list
24745 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
24747 DEFVAR_INT ("scroll-step", &scroll_step
,
24748 doc
: /* *The number of lines to try scrolling a window by when point moves out.
24749 If that fails to bring point back on frame, point is centered instead.
24750 If this is zero, point is always centered after it moves off frame.
24751 If you want scrolling to always be a line at a time, you should set
24752 `scroll-conservatively' to a large value rather than set this to 1. */);
24754 DEFVAR_INT ("scroll-conservatively", &scroll_conservatively
,
24755 doc
: /* *Scroll up to this many lines, to bring point back on screen.
24756 If point moves off-screen, redisplay will scroll by up to
24757 `scroll-conservatively' lines in order to bring point just barely
24758 onto the screen again. If that cannot be done, then redisplay
24759 recenters point as usual.
24761 A value of zero means always recenter point if it moves off screen. */);
24762 scroll_conservatively
= 0;
24764 DEFVAR_INT ("scroll-margin", &scroll_margin
,
24765 doc
: /* *Number of lines of margin at the top and bottom of a window.
24766 Recenter the window whenever point gets within this many lines
24767 of the top or bottom of the window. */);
24770 DEFVAR_LISP ("display-pixels-per-inch", &Vdisplay_pixels_per_inch
,
24771 doc
: /* Pixels per inch value for non-window system displays.
24772 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
24773 Vdisplay_pixels_per_inch
= make_float (72.0);
24776 DEFVAR_INT ("debug-end-pos", &debug_end_pos
, doc
: /* Don't ask. */);
24779 DEFVAR_LISP ("truncate-partial-width-windows",
24780 &Vtruncate_partial_width_windows
,
24781 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
24782 For an integer value, truncate lines in each window narrower than the
24783 full frame width, provided the window width is less than that integer;
24784 otherwise, respect the value of `truncate-lines'.
24786 For any other non-nil value, truncate lines in all windows that do
24787 not span the full frame width.
24789 A value of nil means to respect the value of `truncate-lines'.
24791 If `word-wrap' is enabled, you might want to reduce this. */);
24792 Vtruncate_partial_width_windows
= make_number (50);
24794 DEFVAR_BOOL ("mode-line-inverse-video", &mode_line_inverse_video
,
24795 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
24796 Any other value means to use the appropriate face, `mode-line',
24797 `header-line', or `menu' respectively. */);
24798 mode_line_inverse_video
= 1;
24800 DEFVAR_LISP ("line-number-display-limit", &Vline_number_display_limit
,
24801 doc
: /* *Maximum buffer size for which line number should be displayed.
24802 If the buffer is bigger than this, the line number does not appear
24803 in the mode line. A value of nil means no limit. */);
24804 Vline_number_display_limit
= Qnil
;
24806 DEFVAR_INT ("line-number-display-limit-width",
24807 &line_number_display_limit_width
,
24808 doc
: /* *Maximum line width (in characters) for line number display.
24809 If the average length of the lines near point is bigger than this, then the
24810 line number may be omitted from the mode line. */);
24811 line_number_display_limit_width
= 200;
24813 DEFVAR_BOOL ("highlight-nonselected-windows", &highlight_nonselected_windows
,
24814 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
24815 highlight_nonselected_windows
= 0;
24817 DEFVAR_BOOL ("multiple-frames", &multiple_frames
,
24818 doc
: /* Non-nil if more than one frame is visible on this display.
24819 Minibuffer-only frames don't count, but iconified frames do.
24820 This variable is not guaranteed to be accurate except while processing
24821 `frame-title-format' and `icon-title-format'. */);
24823 DEFVAR_LISP ("frame-title-format", &Vframe_title_format
,
24824 doc
: /* Template for displaying the title bar of visible frames.
24825 \(Assuming the window manager supports this feature.)
24827 This variable has the same structure as `mode-line-format', except that
24828 the %c and %l constructs are ignored. It is used only on frames for
24829 which no explicit name has been set \(see `modify-frame-parameters'). */);
24831 DEFVAR_LISP ("icon-title-format", &Vicon_title_format
,
24832 doc
: /* Template for displaying the title bar of an iconified frame.
24833 \(Assuming the window manager supports this feature.)
24834 This variable has the same structure as `mode-line-format' (which see),
24835 and is used only on frames for which no explicit name has been set
24836 \(see `modify-frame-parameters'). */);
24838 = Vframe_title_format
24839 = pure_cons (intern_c_string ("multiple-frames"),
24840 pure_cons (make_pure_c_string ("%b"),
24841 pure_cons (pure_cons (empty_unibyte_string
,
24842 pure_cons (intern_c_string ("invocation-name"),
24843 pure_cons (make_pure_c_string ("@"),
24844 pure_cons (intern_c_string ("system-name"),
24848 DEFVAR_LISP ("message-log-max", &Vmessage_log_max
,
24849 doc
: /* Maximum number of lines to keep in the message log buffer.
24850 If nil, disable message logging. If t, log messages but don't truncate
24851 the buffer when it becomes large. */);
24852 Vmessage_log_max
= make_number (100);
24854 DEFVAR_LISP ("window-size-change-functions", &Vwindow_size_change_functions
,
24855 doc
: /* Functions called before redisplay, if window sizes have changed.
24856 The value should be a list of functions that take one argument.
24857 Just before redisplay, for each frame, if any of its windows have changed
24858 size since the last redisplay, or have been split or deleted,
24859 all the functions in the list are called, with the frame as argument. */);
24860 Vwindow_size_change_functions
= Qnil
;
24862 DEFVAR_LISP ("window-scroll-functions", &Vwindow_scroll_functions
,
24863 doc
: /* List of functions to call before redisplaying a window with scrolling.
24864 Each function is called with two arguments, the window and its new
24865 display-start position. Note that these functions are also called by
24866 `set-window-buffer'. Also note that the value of `window-end' is not
24867 valid when these functions are called. */);
24868 Vwindow_scroll_functions
= Qnil
;
24870 DEFVAR_LISP ("window-text-change-functions",
24871 &Vwindow_text_change_functions
,
24872 doc
: /* Functions to call in redisplay when text in the window might change. */);
24873 Vwindow_text_change_functions
= Qnil
;
24875 DEFVAR_LISP ("redisplay-end-trigger-functions", &Vredisplay_end_trigger_functions
,
24876 doc
: /* Functions called when redisplay of a window reaches the end trigger.
24877 Each function is called with two arguments, the window and the end trigger value.
24878 See `set-window-redisplay-end-trigger'. */);
24879 Vredisplay_end_trigger_functions
= Qnil
;
24881 DEFVAR_LISP ("mouse-autoselect-window", &Vmouse_autoselect_window
,
24882 doc
: /* *Non-nil means autoselect window with mouse pointer.
24883 If nil, do not autoselect windows.
24884 A positive number means delay autoselection by that many seconds: a
24885 window is autoselected only after the mouse has remained in that
24886 window for the duration of the delay.
24887 A negative number has a similar effect, but causes windows to be
24888 autoselected only after the mouse has stopped moving. \(Because of
24889 the way Emacs compares mouse events, you will occasionally wait twice
24890 that time before the window gets selected.\)
24891 Any other value means to autoselect window instantaneously when the
24892 mouse pointer enters it.
24894 Autoselection selects the minibuffer only if it is active, and never
24895 unselects the minibuffer if it is active.
24897 When customizing this variable make sure that the actual value of
24898 `focus-follows-mouse' matches the behavior of your window manager. */);
24899 Vmouse_autoselect_window
= Qnil
;
24901 DEFVAR_LISP ("auto-resize-tool-bars", &Vauto_resize_tool_bars
,
24902 doc
: /* *Non-nil means automatically resize tool-bars.
24903 This dynamically changes the tool-bar's height to the minimum height
24904 that is needed to make all tool-bar items visible.
24905 If value is `grow-only', the tool-bar's height is only increased
24906 automatically; to decrease the tool-bar height, use \\[recenter]. */);
24907 Vauto_resize_tool_bars
= Qt
;
24909 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", &auto_raise_tool_bar_buttons_p
,
24910 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
24911 auto_raise_tool_bar_buttons_p
= 1;
24913 DEFVAR_BOOL ("make-cursor-line-fully-visible", &make_cursor_line_fully_visible_p
,
24914 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
24915 make_cursor_line_fully_visible_p
= 1;
24917 DEFVAR_LISP ("tool-bar-border", &Vtool_bar_border
,
24918 doc
: /* *Border below tool-bar in pixels.
24919 If an integer, use it as the height of the border.
24920 If it is one of `internal-border-width' or `border-width', use the
24921 value of the corresponding frame parameter.
24922 Otherwise, no border is added below the tool-bar. */);
24923 Vtool_bar_border
= Qinternal_border_width
;
24925 DEFVAR_LISP ("tool-bar-button-margin", &Vtool_bar_button_margin
,
24926 doc
: /* *Margin around tool-bar buttons in pixels.
24927 If an integer, use that for both horizontal and vertical margins.
24928 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
24929 HORZ specifying the horizontal margin, and VERT specifying the
24930 vertical margin. */);
24931 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
24933 DEFVAR_INT ("tool-bar-button-relief", &tool_bar_button_relief
,
24934 doc
: /* *Relief thickness of tool-bar buttons. */);
24935 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
24937 DEFVAR_LISP ("fontification-functions", &Vfontification_functions
,
24938 doc
: /* List of functions to call to fontify regions of text.
24939 Each function is called with one argument POS. Functions must
24940 fontify a region starting at POS in the current buffer, and give
24941 fontified regions the property `fontified'. */);
24942 Vfontification_functions
= Qnil
;
24943 Fmake_variable_buffer_local (Qfontification_functions
);
24945 DEFVAR_BOOL ("unibyte-display-via-language-environment",
24946 &unibyte_display_via_language_environment
,
24947 doc
: /* *Non-nil means display unibyte text according to language environment.
24948 Specifically, this means that raw bytes in the range 160-255 decimal
24949 are displayed by converting them to the equivalent multibyte characters
24950 according to the current language environment. As a result, they are
24951 displayed according to the current fontset.
24953 Note that this variable affects only how these bytes are displayed,
24954 but does not change the fact they are interpreted as raw bytes. */);
24955 unibyte_display_via_language_environment
= 0;
24957 DEFVAR_LISP ("max-mini-window-height", &Vmax_mini_window_height
,
24958 doc
: /* *Maximum height for resizing mini-windows.
24959 If a float, it specifies a fraction of the mini-window frame's height.
24960 If an integer, it specifies a number of lines. */);
24961 Vmax_mini_window_height
= make_float (0.25);
24963 DEFVAR_LISP ("resize-mini-windows", &Vresize_mini_windows
,
24964 doc
: /* *How to resize mini-windows.
24965 A value of nil means don't automatically resize mini-windows.
24966 A value of t means resize them to fit the text displayed in them.
24967 A value of `grow-only', the default, means let mini-windows grow
24968 only, until their display becomes empty, at which point the windows
24969 go back to their normal size. */);
24970 Vresize_mini_windows
= Qgrow_only
;
24972 DEFVAR_LISP ("blink-cursor-alist", &Vblink_cursor_alist
,
24973 doc
: /* Alist specifying how to blink the cursor off.
24974 Each element has the form (ON-STATE . OFF-STATE). Whenever the
24975 `cursor-type' frame-parameter or variable equals ON-STATE,
24976 comparing using `equal', Emacs uses OFF-STATE to specify
24977 how to blink it off. ON-STATE and OFF-STATE are values for
24978 the `cursor-type' frame parameter.
24980 If a frame's ON-STATE has no entry in this list,
24981 the frame's other specifications determine how to blink the cursor off. */);
24982 Vblink_cursor_alist
= Qnil
;
24984 DEFVAR_BOOL ("auto-hscroll-mode", &automatic_hscrolling_p
,
24985 doc
: /* *Non-nil means scroll the display automatically to make point visible. */);
24986 automatic_hscrolling_p
= 1;
24987 Qauto_hscroll_mode
= intern_c_string ("auto-hscroll-mode");
24988 staticpro (&Qauto_hscroll_mode
);
24990 DEFVAR_INT ("hscroll-margin", &hscroll_margin
,
24991 doc
: /* *How many columns away from the window edge point is allowed to get
24992 before automatic hscrolling will horizontally scroll the window. */);
24993 hscroll_margin
= 5;
24995 DEFVAR_LISP ("hscroll-step", &Vhscroll_step
,
24996 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
24997 When point is less than `hscroll-margin' columns from the window
24998 edge, automatic hscrolling will scroll the window by the amount of columns
24999 determined by this variable. If its value is a positive integer, scroll that
25000 many columns. If it's a positive floating-point number, it specifies the
25001 fraction of the window's width to scroll. If it's nil or zero, point will be
25002 centered horizontally after the scroll. Any other value, including negative
25003 numbers, are treated as if the value were zero.
25005 Automatic hscrolling always moves point outside the scroll margin, so if
25006 point was more than scroll step columns inside the margin, the window will
25007 scroll more than the value given by the scroll step.
25009 Note that the lower bound for automatic hscrolling specified by `scroll-left'
25010 and `scroll-right' overrides this variable's effect. */);
25011 Vhscroll_step
= make_number (0);
25013 DEFVAR_BOOL ("message-truncate-lines", &message_truncate_lines
,
25014 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
25015 Bind this around calls to `message' to let it take effect. */);
25016 message_truncate_lines
= 0;
25018 DEFVAR_LISP ("menu-bar-update-hook", &Vmenu_bar_update_hook
,
25019 doc
: /* Normal hook run to update the menu bar definitions.
25020 Redisplay runs this hook before it redisplays the menu bar.
25021 This is used to update submenus such as Buffers,
25022 whose contents depend on various data. */);
25023 Vmenu_bar_update_hook
= Qnil
;
25025 DEFVAR_LISP ("menu-updating-frame", &Vmenu_updating_frame
,
25026 doc
: /* Frame for which we are updating a menu.
25027 The enable predicate for a menu binding should check this variable. */);
25028 Vmenu_updating_frame
= Qnil
;
25030 DEFVAR_BOOL ("inhibit-menubar-update", &inhibit_menubar_update
,
25031 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
25032 inhibit_menubar_update
= 0;
25034 DEFVAR_LISP ("wrap-prefix", &Vwrap_prefix
,
25035 doc
: /* Prefix prepended to all continuation lines at display time.
25036 The value may be a string, an image, or a stretch-glyph; it is
25037 interpreted in the same way as the value of a `display' text property.
25039 This variable is overridden by any `wrap-prefix' text or overlay
25042 To add a prefix to non-continuation lines, use `line-prefix'. */);
25043 Vwrap_prefix
= Qnil
;
25044 staticpro (&Qwrap_prefix
);
25045 Qwrap_prefix
= intern_c_string ("wrap-prefix");
25046 Fmake_variable_buffer_local (Qwrap_prefix
);
25048 DEFVAR_LISP ("line-prefix", &Vline_prefix
,
25049 doc
: /* Prefix prepended to all non-continuation lines at display time.
25050 The value may be a string, an image, or a stretch-glyph; it is
25051 interpreted in the same way as the value of a `display' text property.
25053 This variable is overridden by any `line-prefix' text or overlay
25056 To add a prefix to continuation lines, use `wrap-prefix'. */);
25057 Vline_prefix
= Qnil
;
25058 staticpro (&Qline_prefix
);
25059 Qline_prefix
= intern_c_string ("line-prefix");
25060 Fmake_variable_buffer_local (Qline_prefix
);
25062 DEFVAR_BOOL ("inhibit-eval-during-redisplay", &inhibit_eval_during_redisplay
,
25063 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
25064 inhibit_eval_during_redisplay
= 0;
25066 DEFVAR_BOOL ("inhibit-free-realized-faces", &inhibit_free_realized_faces
,
25067 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
25068 inhibit_free_realized_faces
= 0;
25071 DEFVAR_BOOL ("inhibit-try-window-id", &inhibit_try_window_id
,
25072 doc
: /* Inhibit try_window_id display optimization. */);
25073 inhibit_try_window_id
= 0;
25075 DEFVAR_BOOL ("inhibit-try-window-reusing", &inhibit_try_window_reusing
,
25076 doc
: /* Inhibit try_window_reusing display optimization. */);
25077 inhibit_try_window_reusing
= 0;
25079 DEFVAR_BOOL ("inhibit-try-cursor-movement", &inhibit_try_cursor_movement
,
25080 doc
: /* Inhibit try_cursor_movement display optimization. */);
25081 inhibit_try_cursor_movement
= 0;
25082 #endif /* GLYPH_DEBUG */
25084 DEFVAR_INT ("overline-margin", &overline_margin
,
25085 doc
: /* *Space between overline and text, in pixels.
25086 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
25087 margin to the caracter height. */);
25088 overline_margin
= 2;
25090 DEFVAR_INT ("underline-minimum-offset",
25091 &underline_minimum_offset
,
25092 doc
: /* Minimum distance between baseline and underline.
25093 This can improve legibility of underlined text at small font sizes,
25094 particularly when using variable `x-use-underline-position-properties'
25095 with fonts that specify an UNDERLINE_POSITION relatively close to the
25096 baseline. The default value is 1. */);
25097 underline_minimum_offset
= 1;
25099 DEFVAR_BOOL ("display-hourglass", &display_hourglass_p
,
25100 doc
: /* Non-zero means Emacs displays an hourglass pointer on window systems. */);
25101 display_hourglass_p
= 1;
25103 DEFVAR_LISP ("hourglass-delay", &Vhourglass_delay
,
25104 doc
: /* *Seconds to wait before displaying an hourglass pointer.
25105 Value must be an integer or float. */);
25106 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
25108 hourglass_atimer
= NULL
;
25109 hourglass_shown_p
= 0;
25113 /* Initialize this module when Emacs starts. */
25118 Lisp_Object root_window
;
25119 struct window
*mini_w
;
25121 current_header_line_height
= current_mode_line_height
= -1;
25123 CHARPOS (this_line_start_pos
) = 0;
25125 mini_w
= XWINDOW (minibuf_window
);
25126 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
25128 if (!noninteractive
)
25130 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
25133 XWINDOW (root_window
)->top_line
= make_number (FRAME_TOP_MARGIN (f
));
25134 set_window_height (root_window
,
25135 FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
),
25137 mini_w
->top_line
= make_number (FRAME_LINES (f
) - 1);
25138 set_window_height (minibuf_window
, 1, 0);
25140 XWINDOW (root_window
)->total_cols
= make_number (FRAME_COLS (f
));
25141 mini_w
->total_cols
= make_number (FRAME_COLS (f
));
25143 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
25144 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
25145 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
25147 /* The default ellipsis glyphs `...'. */
25148 for (i
= 0; i
< 3; ++i
)
25149 default_invis_vector
[i
] = make_number ('.');
25153 /* Allocate the buffer for frame titles.
25154 Also used for `format-mode-line'. */
25156 mode_line_noprop_buf
= (char *) xmalloc (size
);
25157 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
25158 mode_line_noprop_ptr
= mode_line_noprop_buf
;
25159 mode_line_target
= MODE_LINE_DISPLAY
;
25162 help_echo_showing_p
= 0;
25165 /* Since w32 does not support atimers, it defines its own implementation of
25166 the following three functions in w32fns.c. */
25169 /* Platform-independent portion of hourglass implementation. */
25171 /* Return non-zero if houglass timer has been started or hourglass is shown. */
25173 hourglass_started ()
25175 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
25178 /* Cancel a currently active hourglass timer, and start a new one. */
25182 #if defined (HAVE_WINDOW_SYSTEM)
25184 int secs
, usecs
= 0;
25186 cancel_hourglass ();
25188 if (INTEGERP (Vhourglass_delay
)
25189 && XINT (Vhourglass_delay
) > 0)
25190 secs
= XFASTINT (Vhourglass_delay
);
25191 else if (FLOATP (Vhourglass_delay
)
25192 && XFLOAT_DATA (Vhourglass_delay
) > 0)
25195 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
25196 secs
= XFASTINT (tem
);
25197 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
25200 secs
= DEFAULT_HOURGLASS_DELAY
;
25202 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
25203 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
25204 show_hourglass
, NULL
);
25209 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
25212 cancel_hourglass ()
25214 #if defined (HAVE_WINDOW_SYSTEM)
25215 if (hourglass_atimer
)
25217 cancel_atimer (hourglass_atimer
);
25218 hourglass_atimer
= NULL
;
25221 if (hourglass_shown_p
)
25225 #endif /* ! WINDOWSNT */
25227 /* arch-tag: eacc864d-bb6a-4b74-894a-1a4399a1358b
25228 (do not change this comment) */