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 decoded
= it
->c
;
5671 && (dv
= DISP_CHAR_VECTOR (it
->dp
, it
->c
),
5674 struct Lisp_Vector
*v
= XVECTOR (dv
);
5676 /* Return the first character from the display table
5677 entry, if not empty. If empty, don't display the
5678 current character. */
5681 it
->dpvec_char_len
= it
->len
;
5682 it
->dpvec
= v
->contents
;
5683 it
->dpend
= v
->contents
+ v
->size
;
5684 it
->current
.dpvec_index
= 0;
5685 it
->dpvec_face_id
= -1;
5686 it
->saved_face_id
= it
->face_id
;
5687 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5692 set_iterator_to_next (it
, 0);
5697 if (unibyte_display_via_language_environment
5698 && !ASCII_CHAR_P (it
->c
))
5699 decoded
= DECODE_CHAR (unibyte
, it
->c
);
5701 if (it
->c
>= 0x80 && ! NILP (Vnobreak_char_display
))
5703 if (it
->multibyte_p
)
5704 nbsp_or_shy
= (it
->c
== 0xA0 ? char_is_nbsp
5705 : it
->c
== 0xAD ? char_is_soft_hyphen
5707 else if (unibyte_display_via_language_environment
)
5708 nbsp_or_shy
= (decoded
== 0xA0 ? char_is_nbsp
5709 : decoded
== 0xAD ? char_is_soft_hyphen
5713 /* Translate control characters into `\003' or `^C' form.
5714 Control characters coming from a display table entry are
5715 currently not translated because we use IT->dpvec to hold
5716 the translation. This could easily be changed but I
5717 don't believe that it is worth doing.
5719 If it->multibyte_p is nonzero, non-printable non-ASCII
5720 characters are also translated to octal form.
5722 If it->multibyte_p is zero, eight-bit characters that
5723 don't have corresponding multibyte char code are also
5724 translated to octal form. */
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 || (it
->c
!= '\n' && it
->c
!= '\t'))
5734 ? ! CHAR_PRINTABLE_P (it
->c
)
5735 : (! unibyte_display_via_language_environment
5737 : (decoded
>= 0x80 && decoded
< 0xA0))))))
5739 /* IT->c is a control character which must be displayed
5740 either as '\003' or as `^C' where the '\\' and '^'
5741 can be defined in the display table. Fill
5742 IT->ctl_chars with glyphs for what we have to
5743 display. Then, set IT->dpvec to these glyphs. */
5746 int face_id
, lface_id
= 0 ;
5749 /* Handle control characters with ^. */
5751 if (it
->c
< 128 && it
->ctl_arrow_p
)
5755 g
= '^'; /* default glyph for Control */
5756 /* Set IT->ctl_chars[0] to the glyph for `^'. */
5758 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5759 && GLYPH_CODE_CHAR_VALID_P (gc
))
5761 g
= GLYPH_CODE_CHAR (gc
);
5762 lface_id
= GLYPH_CODE_FACE (gc
);
5766 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
5768 else if (it
->f
== last_escape_glyph_frame
5769 && it
->face_id
== last_escape_glyph_face_id
)
5771 face_id
= last_escape_glyph_merged_face_id
;
5775 /* Merge the escape-glyph face into the current face. */
5776 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5778 last_escape_glyph_frame
= it
->f
;
5779 last_escape_glyph_face_id
= it
->face_id
;
5780 last_escape_glyph_merged_face_id
= face_id
;
5783 XSETINT (it
->ctl_chars
[0], g
);
5784 XSETINT (it
->ctl_chars
[1], it
->c
^ 0100);
5786 goto display_control
;
5789 /* Handle non-break space in the mode where it only gets
5792 if (EQ (Vnobreak_char_display
, Qt
)
5793 && nbsp_or_shy
== char_is_nbsp
)
5795 /* Merge the no-break-space face into the current face. */
5796 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
5800 XSETINT (it
->ctl_chars
[0], ' ');
5802 goto display_control
;
5805 /* Handle sequences that start with the "escape glyph". */
5807 /* the default escape glyph is \. */
5808 escape_glyph
= '\\';
5811 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5812 && GLYPH_CODE_CHAR_VALID_P (gc
))
5814 escape_glyph
= GLYPH_CODE_CHAR (gc
);
5815 lface_id
= GLYPH_CODE_FACE (gc
);
5819 /* The display table specified a face.
5820 Merge it into face_id and also into escape_glyph. */
5821 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
5824 else if (it
->f
== last_escape_glyph_frame
5825 && it
->face_id
== last_escape_glyph_face_id
)
5827 face_id
= last_escape_glyph_merged_face_id
;
5831 /* Merge the escape-glyph face into the current face. */
5832 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5834 last_escape_glyph_frame
= it
->f
;
5835 last_escape_glyph_face_id
= it
->face_id
;
5836 last_escape_glyph_merged_face_id
= face_id
;
5839 /* Handle soft hyphens in the mode where they only get
5842 if (EQ (Vnobreak_char_display
, Qt
)
5843 && nbsp_or_shy
== char_is_soft_hyphen
)
5846 XSETINT (it
->ctl_chars
[0], '-');
5848 goto display_control
;
5851 /* Handle non-break space and soft hyphen
5852 with the escape glyph. */
5856 XSETINT (it
->ctl_chars
[0], escape_glyph
);
5857 it
->c
= (nbsp_or_shy
== char_is_nbsp
? ' ' : '-');
5858 XSETINT (it
->ctl_chars
[1], it
->c
);
5860 goto display_control
;
5864 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
5868 /* Set IT->ctl_chars[0] to the glyph for `\\'. */
5869 if (CHAR_BYTE8_P (it
->c
))
5871 str
[0] = CHAR_TO_BYTE8 (it
->c
);
5874 else if (it
->c
< 256)
5881 /* It's an invalid character, which shouldn't
5882 happen actually, but due to bugs it may
5883 happen. Let's print the char as is, there's
5884 not much meaningful we can do with it. */
5886 str
[1] = it
->c
>> 8;
5887 str
[2] = it
->c
>> 16;
5888 str
[3] = it
->c
>> 24;
5892 for (i
= 0; i
< len
; i
++)
5895 XSETINT (it
->ctl_chars
[i
* 4], escape_glyph
);
5896 /* Insert three more glyphs into IT->ctl_chars for
5897 the octal display of the character. */
5898 g
= ((str
[i
] >> 6) & 7) + '0';
5899 XSETINT (it
->ctl_chars
[i
* 4 + 1], g
);
5900 g
= ((str
[i
] >> 3) & 7) + '0';
5901 XSETINT (it
->ctl_chars
[i
* 4 + 2], g
);
5902 g
= (str
[i
] & 7) + '0';
5903 XSETINT (it
->ctl_chars
[i
* 4 + 3], g
);
5909 /* Set up IT->dpvec and return first character from it. */
5910 it
->dpvec_char_len
= it
->len
;
5911 it
->dpvec
= it
->ctl_chars
;
5912 it
->dpend
= it
->dpvec
+ ctl_len
;
5913 it
->current
.dpvec_index
= 0;
5914 it
->dpvec_face_id
= face_id
;
5915 it
->saved_face_id
= it
->face_id
;
5916 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5923 #ifdef HAVE_WINDOW_SYSTEM
5924 /* Adjust face id for a multibyte character. There are no multibyte
5925 character in unibyte text. */
5926 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
5929 && FRAME_WINDOW_P (it
->f
))
5931 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
5933 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
5935 /* Automatic composition with glyph-string. */
5936 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
5938 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
5942 int pos
= (it
->s
? -1
5943 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
5944 : IT_CHARPOS (*it
));
5946 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->c
, pos
, it
->string
);
5951 /* Is this character the last one of a run of characters with
5952 box? If yes, set IT->end_of_box_run_p to 1. */
5956 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
5958 int face_id
= underlying_face_id (it
);
5959 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
5963 if (face
->box
== FACE_NO_BOX
)
5965 /* If the box comes from face properties in a
5966 display string, check faces in that string. */
5967 int string_face_id
= face_after_it_pos (it
);
5968 it
->end_of_box_run_p
5969 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
5972 /* Otherwise, the box comes from the underlying face.
5973 If this is the last string character displayed, check
5974 the next buffer location. */
5975 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
5976 && (it
->current
.overlay_string_index
5977 == it
->n_overlay_strings
- 1))
5981 struct text_pos pos
= it
->current
.pos
;
5982 INC_TEXT_POS (pos
, it
->multibyte_p
);
5984 next_face_id
= face_at_buffer_position
5985 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
5986 it
->region_end_charpos
, &ignore
,
5987 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
5989 it
->end_of_box_run_p
5990 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
5997 int face_id
= face_after_it_pos (it
);
5998 it
->end_of_box_run_p
5999 = (face_id
!= it
->face_id
6000 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
6004 /* Value is 0 if end of buffer or string reached. */
6009 /* Move IT to the next display element.
6011 RESEAT_P non-zero means if called on a newline in buffer text,
6012 skip to the next visible line start.
6014 Functions get_next_display_element and set_iterator_to_next are
6015 separate because I find this arrangement easier to handle than a
6016 get_next_display_element function that also increments IT's
6017 position. The way it is we can first look at an iterator's current
6018 display element, decide whether it fits on a line, and if it does,
6019 increment the iterator position. The other way around we probably
6020 would either need a flag indicating whether the iterator has to be
6021 incremented the next time, or we would have to implement a
6022 decrement position function which would not be easy to write. */
6025 set_iterator_to_next (it
, reseat_p
)
6029 /* Reset flags indicating start and end of a sequence of characters
6030 with box. Reset them at the start of this function because
6031 moving the iterator to a new position might set them. */
6032 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6036 case GET_FROM_BUFFER
:
6037 /* The current display element of IT is a character from
6038 current_buffer. Advance in the buffer, and maybe skip over
6039 invisible lines that are so because of selective display. */
6040 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6041 reseat_at_next_visible_line_start (it
, 0);
6042 else if (it
->cmp_it
.id
>= 0)
6044 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6045 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6046 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6047 it
->cmp_it
.from
= it
->cmp_it
.to
;
6051 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6052 IT_BYTEPOS (*it
), it
->stop_charpos
,
6058 xassert (it
->len
!= 0);
6059 IT_BYTEPOS (*it
) += it
->len
;
6060 IT_CHARPOS (*it
) += 1;
6061 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6065 case GET_FROM_C_STRING
:
6066 /* Current display element of IT is from a C string. */
6067 IT_BYTEPOS (*it
) += it
->len
;
6068 IT_CHARPOS (*it
) += 1;
6071 case GET_FROM_DISPLAY_VECTOR
:
6072 /* Current display element of IT is from a display table entry.
6073 Advance in the display table definition. Reset it to null if
6074 end reached, and continue with characters from buffers/
6076 ++it
->current
.dpvec_index
;
6078 /* Restore face of the iterator to what they were before the
6079 display vector entry (these entries may contain faces). */
6080 it
->face_id
= it
->saved_face_id
;
6082 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6084 int recheck_faces
= it
->ellipsis_p
;
6087 it
->method
= GET_FROM_C_STRING
;
6088 else if (STRINGP (it
->string
))
6089 it
->method
= GET_FROM_STRING
;
6092 it
->method
= GET_FROM_BUFFER
;
6093 it
->object
= it
->w
->buffer
;
6097 it
->current
.dpvec_index
= -1;
6099 /* Skip over characters which were displayed via IT->dpvec. */
6100 if (it
->dpvec_char_len
< 0)
6101 reseat_at_next_visible_line_start (it
, 1);
6102 else if (it
->dpvec_char_len
> 0)
6104 if (it
->method
== GET_FROM_STRING
6105 && it
->n_overlay_strings
> 0)
6106 it
->ignore_overlay_strings_at_pos_p
= 1;
6107 it
->len
= it
->dpvec_char_len
;
6108 set_iterator_to_next (it
, reseat_p
);
6111 /* Maybe recheck faces after display vector */
6113 it
->stop_charpos
= IT_CHARPOS (*it
);
6117 case GET_FROM_STRING
:
6118 /* Current display element is a character from a Lisp string. */
6119 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6120 if (it
->cmp_it
.id
>= 0)
6122 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6123 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6124 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6125 it
->cmp_it
.from
= it
->cmp_it
.to
;
6129 composition_compute_stop_pos (&it
->cmp_it
,
6130 IT_STRING_CHARPOS (*it
),
6131 IT_STRING_BYTEPOS (*it
),
6132 it
->stop_charpos
, it
->string
);
6137 IT_STRING_BYTEPOS (*it
) += it
->len
;
6138 IT_STRING_CHARPOS (*it
) += 1;
6141 consider_string_end
:
6143 if (it
->current
.overlay_string_index
>= 0)
6145 /* IT->string is an overlay string. Advance to the
6146 next, if there is one. */
6147 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6150 next_overlay_string (it
);
6152 setup_for_ellipsis (it
, 0);
6157 /* IT->string is not an overlay string. If we reached
6158 its end, and there is something on IT->stack, proceed
6159 with what is on the stack. This can be either another
6160 string, this time an overlay string, or a buffer. */
6161 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
6165 if (it
->method
== GET_FROM_STRING
)
6166 goto consider_string_end
;
6171 case GET_FROM_IMAGE
:
6172 case GET_FROM_STRETCH
:
6173 /* The position etc with which we have to proceed are on
6174 the stack. The position may be at the end of a string,
6175 if the `display' property takes up the whole string. */
6176 xassert (it
->sp
> 0);
6178 if (it
->method
== GET_FROM_STRING
)
6179 goto consider_string_end
;
6183 /* There are no other methods defined, so this should be a bug. */
6187 xassert (it
->method
!= GET_FROM_STRING
6188 || (STRINGP (it
->string
)
6189 && IT_STRING_CHARPOS (*it
) >= 0));
6192 /* Load IT's display element fields with information about the next
6193 display element which comes from a display table entry or from the
6194 result of translating a control character to one of the forms `^C'
6197 IT->dpvec holds the glyphs to return as characters.
6198 IT->saved_face_id holds the face id before the display vector--it
6199 is restored into IT->face_id in set_iterator_to_next. */
6202 next_element_from_display_vector (it
)
6208 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
6210 it
->face_id
= it
->saved_face_id
;
6212 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
6213 That seemed totally bogus - so I changed it... */
6214 gc
= it
->dpvec
[it
->current
.dpvec_index
];
6216 if (GLYPH_CODE_P (gc
) && GLYPH_CODE_CHAR_VALID_P (gc
))
6218 it
->c
= GLYPH_CODE_CHAR (gc
);
6219 it
->len
= CHAR_BYTES (it
->c
);
6221 /* The entry may contain a face id to use. Such a face id is
6222 the id of a Lisp face, not a realized face. A face id of
6223 zero means no face is specified. */
6224 if (it
->dpvec_face_id
>= 0)
6225 it
->face_id
= it
->dpvec_face_id
;
6228 int lface_id
= GLYPH_CODE_FACE (gc
);
6230 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6235 /* Display table entry is invalid. Return a space. */
6236 it
->c
= ' ', it
->len
= 1;
6238 /* Don't change position and object of the iterator here. They are
6239 still the values of the character that had this display table
6240 entry or was translated, and that's what we want. */
6241 it
->what
= IT_CHARACTER
;
6246 /* Load IT with the next display element from Lisp string IT->string.
6247 IT->current.string_pos is the current position within the string.
6248 If IT->current.overlay_string_index >= 0, the Lisp string is an
6252 next_element_from_string (it
)
6255 struct text_pos position
;
6257 xassert (STRINGP (it
->string
));
6258 xassert (IT_STRING_CHARPOS (*it
) >= 0);
6259 position
= it
->current
.string_pos
;
6261 /* Time to check for invisible text? */
6262 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
6263 && IT_STRING_CHARPOS (*it
) == it
->stop_charpos
)
6267 /* Since a handler may have changed IT->method, we must
6269 return GET_NEXT_DISPLAY_ELEMENT (it
);
6272 if (it
->current
.overlay_string_index
>= 0)
6274 /* Get the next character from an overlay string. In overlay
6275 strings, There is no field width or padding with spaces to
6277 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6282 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6283 IT_STRING_BYTEPOS (*it
), SCHARS (it
->string
))
6284 && next_element_from_composition (it
))
6288 else if (STRING_MULTIBYTE (it
->string
))
6290 int remaining
= SBYTES (it
->string
) - IT_STRING_BYTEPOS (*it
);
6291 const unsigned char *s
= (SDATA (it
->string
)
6292 + IT_STRING_BYTEPOS (*it
));
6293 it
->c
= string_char_and_length (s
, &it
->len
);
6297 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6303 /* Get the next character from a Lisp string that is not an
6304 overlay string. Such strings come from the mode line, for
6305 example. We may have to pad with spaces, or truncate the
6306 string. See also next_element_from_c_string. */
6307 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
6312 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
6314 /* Pad with spaces. */
6315 it
->c
= ' ', it
->len
= 1;
6316 CHARPOS (position
) = BYTEPOS (position
) = -1;
6318 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6319 IT_STRING_BYTEPOS (*it
), it
->string_nchars
)
6320 && next_element_from_composition (it
))
6324 else if (STRING_MULTIBYTE (it
->string
))
6326 int maxlen
= SBYTES (it
->string
) - IT_STRING_BYTEPOS (*it
);
6327 const unsigned char *s
= (SDATA (it
->string
)
6328 + IT_STRING_BYTEPOS (*it
));
6329 it
->c
= string_char_and_length (s
, &it
->len
);
6333 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6338 /* Record what we have and where it came from. */
6339 it
->what
= IT_CHARACTER
;
6340 it
->object
= it
->string
;
6341 it
->position
= position
;
6346 /* Load IT with next display element from C string IT->s.
6347 IT->string_nchars is the maximum number of characters to return
6348 from the string. IT->end_charpos may be greater than
6349 IT->string_nchars when this function is called, in which case we
6350 may have to return padding spaces. Value is zero if end of string
6351 reached, including padding spaces. */
6354 next_element_from_c_string (it
)
6360 it
->what
= IT_CHARACTER
;
6361 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
6364 /* IT's position can be greater IT->string_nchars in case a field
6365 width or precision has been specified when the iterator was
6367 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6369 /* End of the game. */
6373 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
6375 /* Pad with spaces. */
6376 it
->c
= ' ', it
->len
= 1;
6377 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
6379 else if (it
->multibyte_p
)
6381 /* Implementation note: The calls to strlen apparently aren't a
6382 performance problem because there is no noticeable performance
6383 difference between Emacs running in unibyte or multibyte mode. */
6384 int maxlen
= strlen (it
->s
) - IT_BYTEPOS (*it
);
6385 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
6388 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
6394 /* Set up IT to return characters from an ellipsis, if appropriate.
6395 The definition of the ellipsis glyphs may come from a display table
6396 entry. This function fills IT with the first glyph from the
6397 ellipsis if an ellipsis is to be displayed. */
6400 next_element_from_ellipsis (it
)
6403 if (it
->selective_display_ellipsis_p
)
6404 setup_for_ellipsis (it
, it
->len
);
6407 /* The face at the current position may be different from the
6408 face we find after the invisible text. Remember what it
6409 was in IT->saved_face_id, and signal that it's there by
6410 setting face_before_selective_p. */
6411 it
->saved_face_id
= it
->face_id
;
6412 it
->method
= GET_FROM_BUFFER
;
6413 it
->object
= it
->w
->buffer
;
6414 reseat_at_next_visible_line_start (it
, 1);
6415 it
->face_before_selective_p
= 1;
6418 return GET_NEXT_DISPLAY_ELEMENT (it
);
6422 /* Deliver an image display element. The iterator IT is already
6423 filled with image information (done in handle_display_prop). Value
6428 next_element_from_image (it
)
6431 it
->what
= IT_IMAGE
;
6436 /* Fill iterator IT with next display element from a stretch glyph
6437 property. IT->object is the value of the text property. Value is
6441 next_element_from_stretch (it
)
6444 it
->what
= IT_STRETCH
;
6449 /* Load IT with the next display element from current_buffer. Value
6450 is zero if end of buffer reached. IT->stop_charpos is the next
6451 position at which to stop and check for text properties or buffer
6455 next_element_from_buffer (it
)
6460 xassert (IT_CHARPOS (*it
) >= BEGV
);
6462 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
6464 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6466 int overlay_strings_follow_p
;
6468 /* End of the game, except when overlay strings follow that
6469 haven't been returned yet. */
6470 if (it
->overlay_strings_at_end_processed_p
)
6471 overlay_strings_follow_p
= 0;
6474 it
->overlay_strings_at_end_processed_p
= 1;
6475 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
6478 if (overlay_strings_follow_p
)
6479 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6483 it
->position
= it
->current
.pos
;
6490 return GET_NEXT_DISPLAY_ELEMENT (it
);
6495 /* No face changes, overlays etc. in sight, so just return a
6496 character from current_buffer. */
6499 /* Maybe run the redisplay end trigger hook. Performance note:
6500 This doesn't seem to cost measurable time. */
6501 if (it
->redisplay_end_trigger_charpos
6503 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
6504 run_redisplay_end_trigger_hook (it
);
6506 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6508 && next_element_from_composition (it
))
6513 /* Get the next character, maybe multibyte. */
6514 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
6515 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
6516 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
6518 it
->c
= *p
, it
->len
= 1;
6520 /* Record what we have and where it came from. */
6521 it
->what
= IT_CHARACTER
;
6522 it
->object
= it
->w
->buffer
;
6523 it
->position
= it
->current
.pos
;
6525 /* Normally we return the character found above, except when we
6526 really want to return an ellipsis for selective display. */
6531 /* A value of selective > 0 means hide lines indented more
6532 than that number of columns. */
6533 if (it
->selective
> 0
6534 && IT_CHARPOS (*it
) + 1 < ZV
6535 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
6536 IT_BYTEPOS (*it
) + 1,
6537 (double) it
->selective
)) /* iftc */
6539 success_p
= next_element_from_ellipsis (it
);
6540 it
->dpvec_char_len
= -1;
6543 else if (it
->c
== '\r' && it
->selective
== -1)
6545 /* A value of selective == -1 means that everything from the
6546 CR to the end of the line is invisible, with maybe an
6547 ellipsis displayed for it. */
6548 success_p
= next_element_from_ellipsis (it
);
6549 it
->dpvec_char_len
= -1;
6554 /* Value is zero if end of buffer reached. */
6555 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
6560 /* Run the redisplay end trigger hook for IT. */
6563 run_redisplay_end_trigger_hook (it
)
6566 Lisp_Object args
[3];
6568 /* IT->glyph_row should be non-null, i.e. we should be actually
6569 displaying something, or otherwise we should not run the hook. */
6570 xassert (it
->glyph_row
);
6572 /* Set up hook arguments. */
6573 args
[0] = Qredisplay_end_trigger_functions
;
6574 args
[1] = it
->window
;
6575 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
6576 it
->redisplay_end_trigger_charpos
= 0;
6578 /* Since we are *trying* to run these functions, don't try to run
6579 them again, even if they get an error. */
6580 it
->w
->redisplay_end_trigger
= Qnil
;
6581 Frun_hook_with_args (3, args
);
6583 /* Notice if it changed the face of the character we are on. */
6584 handle_face_prop (it
);
6588 /* Deliver a composition display element. Unlike the other
6589 next_element_from_XXX, this function is not registered in the array
6590 get_next_element[]. It is called from next_element_from_buffer and
6591 next_element_from_string when necessary. */
6594 next_element_from_composition (it
)
6597 it
->what
= IT_COMPOSITION
;
6598 it
->len
= it
->cmp_it
.nbytes
;
6599 if (STRINGP (it
->string
))
6603 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6604 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6607 it
->position
= it
->current
.string_pos
;
6608 it
->object
= it
->string
;
6609 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
6610 IT_STRING_BYTEPOS (*it
), it
->string
);
6616 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6617 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6620 it
->position
= it
->current
.pos
;
6621 it
->object
= it
->w
->buffer
;
6622 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
6623 IT_BYTEPOS (*it
), Qnil
);
6630 /***********************************************************************
6631 Moving an iterator without producing glyphs
6632 ***********************************************************************/
6634 /* Check if iterator is at a position corresponding to a valid buffer
6635 position after some move_it_ call. */
6637 #define IT_POS_VALID_AFTER_MOVE_P(it) \
6638 ((it)->method == GET_FROM_STRING \
6639 ? IT_STRING_CHARPOS (*it) == 0 \
6643 /* Move iterator IT to a specified buffer or X position within one
6644 line on the display without producing glyphs.
6646 OP should be a bit mask including some or all of these bits:
6647 MOVE_TO_X: Stop on reaching x-position TO_X.
6648 MOVE_TO_POS: Stop on reaching buffer or string position TO_CHARPOS.
6649 Regardless of OP's value, stop in reaching the end of the display line.
6651 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
6652 This means, in particular, that TO_X includes window's horizontal
6655 The return value has several possible values that
6656 say what condition caused the scan to stop:
6658 MOVE_POS_MATCH_OR_ZV
6659 - when TO_POS or ZV was reached.
6662 -when TO_X was reached before TO_POS or ZV were reached.
6665 - when we reached the end of the display area and the line must
6669 - when we reached the end of the display area and the line is
6673 - when we stopped at a line end, i.e. a newline or a CR and selective
6676 static enum move_it_result
6677 move_it_in_display_line_to (struct it
*it
,
6678 EMACS_INT to_charpos
, int to_x
,
6679 enum move_operation_enum op
)
6681 enum move_it_result result
= MOVE_UNDEFINED
;
6682 struct glyph_row
*saved_glyph_row
;
6683 struct it wrap_it
, atpos_it
, atx_it
;
6686 /* Don't produce glyphs in produce_glyphs. */
6687 saved_glyph_row
= it
->glyph_row
;
6688 it
->glyph_row
= NULL
;
6690 /* Use wrap_it to save a copy of IT wherever a word wrap could
6691 occur. Use atpos_it to save a copy of IT at the desired buffer
6692 position, if found, so that we can scan ahead and check if the
6693 word later overshoots the window edge. Use atx_it similarly, for
6699 #define BUFFER_POS_REACHED_P() \
6700 ((op & MOVE_TO_POS) != 0 \
6701 && BUFFERP (it->object) \
6702 && IT_CHARPOS (*it) >= to_charpos \
6703 && (it->method == GET_FROM_BUFFER \
6704 || (it->method == GET_FROM_DISPLAY_VECTOR \
6705 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
6707 /* If there's a line-/wrap-prefix, handle it. */
6708 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
6709 && it
->current_y
< it
->last_visible_y
)
6710 handle_line_prefix (it
);
6714 int x
, i
, ascent
= 0, descent
= 0;
6716 /* Utility macro to reset an iterator with x, ascent, and descent. */
6717 #define IT_RESET_X_ASCENT_DESCENT(IT) \
6718 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
6719 (IT)->max_descent = descent)
6721 /* Stop if we move beyond TO_CHARPOS (after an image or stretch
6723 if ((op
& MOVE_TO_POS
) != 0
6724 && BUFFERP (it
->object
)
6725 && it
->method
== GET_FROM_BUFFER
6726 && IT_CHARPOS (*it
) > to_charpos
)
6728 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
6730 result
= MOVE_POS_MATCH_OR_ZV
;
6733 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
6734 /* If wrap_it is valid, the current position might be in a
6735 word that is wrapped. So, save the iterator in
6736 atpos_it and continue to see if wrapping happens. */
6740 /* Stop when ZV reached.
6741 We used to stop here when TO_CHARPOS reached as well, but that is
6742 too soon if this glyph does not fit on this line. So we handle it
6743 explicitly below. */
6744 if (!get_next_display_element (it
))
6746 result
= MOVE_POS_MATCH_OR_ZV
;
6750 if (it
->line_wrap
== TRUNCATE
)
6752 if (BUFFER_POS_REACHED_P ())
6754 result
= MOVE_POS_MATCH_OR_ZV
;
6760 if (it
->line_wrap
== WORD_WRAP
)
6762 if (IT_DISPLAYING_WHITESPACE (it
))
6766 /* We have reached a glyph that follows one or more
6767 whitespace characters. If the position is
6768 already found, we are done. */
6769 if (atpos_it
.sp
>= 0)
6772 result
= MOVE_POS_MATCH_OR_ZV
;
6778 result
= MOVE_X_REACHED
;
6781 /* Otherwise, we can wrap here. */
6788 /* Remember the line height for the current line, in case
6789 the next element doesn't fit on the line. */
6790 ascent
= it
->max_ascent
;
6791 descent
= it
->max_descent
;
6793 /* The call to produce_glyphs will get the metrics of the
6794 display element IT is loaded with. Record the x-position
6795 before this display element, in case it doesn't fit on the
6799 PRODUCE_GLYPHS (it
);
6801 if (it
->area
!= TEXT_AREA
)
6803 set_iterator_to_next (it
, 1);
6807 /* The number of glyphs we get back in IT->nglyphs will normally
6808 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
6809 character on a terminal frame, or (iii) a line end. For the
6810 second case, IT->nglyphs - 1 padding glyphs will be present.
6811 (On X frames, there is only one glyph produced for a
6812 composite character.)
6814 The behavior implemented below means, for continuation lines,
6815 that as many spaces of a TAB as fit on the current line are
6816 displayed there. For terminal frames, as many glyphs of a
6817 multi-glyph character are displayed in the current line, too.
6818 This is what the old redisplay code did, and we keep it that
6819 way. Under X, the whole shape of a complex character must
6820 fit on the line or it will be completely displayed in the
6823 Note that both for tabs and padding glyphs, all glyphs have
6827 /* More than one glyph or glyph doesn't fit on line. All
6828 glyphs have the same width. */
6829 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
6831 int x_before_this_char
= x
;
6832 int hpos_before_this_char
= it
->hpos
;
6834 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
6836 new_x
= x
+ single_glyph_width
;
6838 /* We want to leave anything reaching TO_X to the caller. */
6839 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
6841 if (BUFFER_POS_REACHED_P ())
6843 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
6844 goto buffer_pos_reached
;
6845 if (atpos_it
.sp
< 0)
6848 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
6853 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
6856 result
= MOVE_X_REACHED
;
6862 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
6867 if (/* Lines are continued. */
6868 it
->line_wrap
!= TRUNCATE
6869 && (/* And glyph doesn't fit on the line. */
6870 new_x
> it
->last_visible_x
6871 /* Or it fits exactly and we're on a window
6873 || (new_x
== it
->last_visible_x
6874 && FRAME_WINDOW_P (it
->f
))))
6876 if (/* IT->hpos == 0 means the very first glyph
6877 doesn't fit on the line, e.g. a wide image. */
6879 || (new_x
== it
->last_visible_x
6880 && FRAME_WINDOW_P (it
->f
)))
6883 it
->current_x
= new_x
;
6885 /* The character's last glyph just barely fits
6887 if (i
== it
->nglyphs
- 1)
6889 /* If this is the destination position,
6890 return a position *before* it in this row,
6891 now that we know it fits in this row. */
6892 if (BUFFER_POS_REACHED_P ())
6894 if (it
->line_wrap
!= WORD_WRAP
6897 it
->hpos
= hpos_before_this_char
;
6898 it
->current_x
= x_before_this_char
;
6899 result
= MOVE_POS_MATCH_OR_ZV
;
6902 if (it
->line_wrap
== WORD_WRAP
6906 atpos_it
.current_x
= x_before_this_char
;
6907 atpos_it
.hpos
= hpos_before_this_char
;
6911 set_iterator_to_next (it
, 1);
6912 /* On graphical terminals, newlines may
6913 "overflow" into the fringe if
6914 overflow-newline-into-fringe is non-nil.
6915 On text-only terminals, newlines may
6916 overflow into the last glyph on the
6918 if (!FRAME_WINDOW_P (it
->f
)
6919 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
6921 if (!get_next_display_element (it
))
6923 result
= MOVE_POS_MATCH_OR_ZV
;
6926 if (BUFFER_POS_REACHED_P ())
6928 if (ITERATOR_AT_END_OF_LINE_P (it
))
6929 result
= MOVE_POS_MATCH_OR_ZV
;
6931 result
= MOVE_LINE_CONTINUED
;
6934 if (ITERATOR_AT_END_OF_LINE_P (it
))
6936 result
= MOVE_NEWLINE_OR_CR
;
6943 IT_RESET_X_ASCENT_DESCENT (it
);
6945 if (wrap_it
.sp
>= 0)
6952 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
6954 result
= MOVE_LINE_CONTINUED
;
6958 if (BUFFER_POS_REACHED_P ())
6960 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
6961 goto buffer_pos_reached
;
6962 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
6965 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
6969 if (new_x
> it
->first_visible_x
)
6971 /* Glyph is visible. Increment number of glyphs that
6972 would be displayed. */
6977 if (result
!= MOVE_UNDEFINED
)
6980 else if (BUFFER_POS_REACHED_P ())
6983 IT_RESET_X_ASCENT_DESCENT (it
);
6984 result
= MOVE_POS_MATCH_OR_ZV
;
6987 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
6989 /* Stop when TO_X specified and reached. This check is
6990 necessary here because of lines consisting of a line end,
6991 only. The line end will not produce any glyphs and we
6992 would never get MOVE_X_REACHED. */
6993 xassert (it
->nglyphs
== 0);
6994 result
= MOVE_X_REACHED
;
6998 /* Is this a line end? If yes, we're done. */
6999 if (ITERATOR_AT_END_OF_LINE_P (it
))
7001 result
= MOVE_NEWLINE_OR_CR
;
7005 /* The current display element has been consumed. Advance
7007 set_iterator_to_next (it
, 1);
7009 /* Stop if lines are truncated and IT's current x-position is
7010 past the right edge of the window now. */
7011 if (it
->line_wrap
== TRUNCATE
7012 && it
->current_x
>= it
->last_visible_x
)
7014 if (!FRAME_WINDOW_P (it
->f
)
7015 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7017 if (!get_next_display_element (it
)
7018 || BUFFER_POS_REACHED_P ())
7020 result
= MOVE_POS_MATCH_OR_ZV
;
7023 if (ITERATOR_AT_END_OF_LINE_P (it
))
7025 result
= MOVE_NEWLINE_OR_CR
;
7029 result
= MOVE_LINE_TRUNCATED
;
7032 #undef IT_RESET_X_ASCENT_DESCENT
7035 #undef BUFFER_POS_REACHED_P
7037 /* If we scanned beyond to_pos and didn't find a point to wrap at,
7038 restore the saved iterator. */
7039 if (atpos_it
.sp
>= 0)
7041 else if (atx_it
.sp
>= 0)
7046 /* Restore the iterator settings altered at the beginning of this
7048 it
->glyph_row
= saved_glyph_row
;
7052 /* For external use. */
7054 move_it_in_display_line (struct it
*it
,
7055 EMACS_INT to_charpos
, int to_x
,
7056 enum move_operation_enum op
)
7058 if (it
->line_wrap
== WORD_WRAP
7059 && (op
& MOVE_TO_X
))
7061 struct it save_it
= *it
;
7062 int skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7063 /* When word-wrap is on, TO_X may lie past the end
7064 of a wrapped line. Then it->current is the
7065 character on the next line, so backtrack to the
7066 space before the wrap point. */
7067 if (skip
== MOVE_LINE_CONTINUED
)
7069 int prev_x
= max (it
->current_x
- 1, 0);
7071 move_it_in_display_line_to
7072 (it
, -1, prev_x
, MOVE_TO_X
);
7076 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7080 /* Move IT forward until it satisfies one or more of the criteria in
7081 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
7083 OP is a bit-mask that specifies where to stop, and in particular,
7084 which of those four position arguments makes a difference. See the
7085 description of enum move_operation_enum.
7087 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
7088 screen line, this function will set IT to the next position >
7092 move_it_to (it
, to_charpos
, to_x
, to_y
, to_vpos
, op
)
7094 int to_charpos
, to_x
, to_y
, to_vpos
;
7097 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
7098 int line_height
, line_start_x
= 0, reached
= 0;
7102 if (op
& MOVE_TO_VPOS
)
7104 /* If no TO_CHARPOS and no TO_X specified, stop at the
7105 start of the line TO_VPOS. */
7106 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
7108 if (it
->vpos
== to_vpos
)
7114 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
7118 /* TO_VPOS >= 0 means stop at TO_X in the line at
7119 TO_VPOS, or at TO_POS, whichever comes first. */
7120 if (it
->vpos
== to_vpos
)
7126 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7128 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
7133 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
7135 /* We have reached TO_X but not in the line we want. */
7136 skip
= move_it_in_display_line_to (it
, to_charpos
,
7138 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7146 else if (op
& MOVE_TO_Y
)
7148 struct it it_backup
;
7150 if (it
->line_wrap
== WORD_WRAP
)
7153 /* TO_Y specified means stop at TO_X in the line containing
7154 TO_Y---or at TO_CHARPOS if this is reached first. The
7155 problem is that we can't really tell whether the line
7156 contains TO_Y before we have completely scanned it, and
7157 this may skip past TO_X. What we do is to first scan to
7160 If TO_X is not specified, use a TO_X of zero. The reason
7161 is to make the outcome of this function more predictable.
7162 If we didn't use TO_X == 0, we would stop at the end of
7163 the line which is probably not what a caller would expect
7165 skip
= move_it_in_display_line_to
7166 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
7167 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
7169 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
7170 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7172 else if (skip
== MOVE_X_REACHED
)
7174 /* If TO_X was reached, we want to know whether TO_Y is
7175 in the line. We know this is the case if the already
7176 scanned glyphs make the line tall enough. Otherwise,
7177 we must check by scanning the rest of the line. */
7178 line_height
= it
->max_ascent
+ it
->max_descent
;
7179 if (to_y
>= it
->current_y
7180 && to_y
< it
->current_y
+ line_height
)
7186 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
7187 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
7189 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
7190 line_height
= it
->max_ascent
+ it
->max_descent
;
7191 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7193 if (to_y
>= it
->current_y
7194 && to_y
< it
->current_y
+ line_height
)
7196 /* If TO_Y is in this line and TO_X was reached
7197 above, we scanned too far. We have to restore
7198 IT's settings to the ones before skipping. */
7205 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7211 /* Check whether TO_Y is in this line. */
7212 line_height
= it
->max_ascent
+ it
->max_descent
;
7213 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7215 if (to_y
>= it
->current_y
7216 && to_y
< it
->current_y
+ line_height
)
7218 /* When word-wrap is on, TO_X may lie past the end
7219 of a wrapped line. Then it->current is the
7220 character on the next line, so backtrack to the
7221 space before the wrap point. */
7222 if (skip
== MOVE_LINE_CONTINUED
7223 && it
->line_wrap
== WORD_WRAP
)
7225 int prev_x
= max (it
->current_x
- 1, 0);
7227 skip
= move_it_in_display_line_to
7228 (it
, -1, prev_x
, MOVE_TO_X
);
7237 else if (BUFFERP (it
->object
)
7238 && (it
->method
== GET_FROM_BUFFER
7239 || it
->method
== GET_FROM_STRETCH
)
7240 && IT_CHARPOS (*it
) >= to_charpos
)
7241 skip
= MOVE_POS_MATCH_OR_ZV
;
7243 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
7247 case MOVE_POS_MATCH_OR_ZV
:
7251 case MOVE_NEWLINE_OR_CR
:
7252 set_iterator_to_next (it
, 1);
7253 it
->continuation_lines_width
= 0;
7256 case MOVE_LINE_TRUNCATED
:
7257 it
->continuation_lines_width
= 0;
7258 reseat_at_next_visible_line_start (it
, 0);
7259 if ((op
& MOVE_TO_POS
) != 0
7260 && IT_CHARPOS (*it
) > to_charpos
)
7267 case MOVE_LINE_CONTINUED
:
7268 /* For continued lines ending in a tab, some of the glyphs
7269 associated with the tab are displayed on the current
7270 line. Since it->current_x does not include these glyphs,
7271 we use it->last_visible_x instead. */
7274 it
->continuation_lines_width
+= it
->last_visible_x
;
7275 /* When moving by vpos, ensure that the iterator really
7276 advances to the next line (bug#847, bug#969). Fixme:
7277 do we need to do this in other circumstances? */
7278 if (it
->current_x
!= it
->last_visible_x
7279 && (op
& MOVE_TO_VPOS
)
7280 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
7282 line_start_x
= it
->current_x
+ it
->pixel_width
7283 - it
->last_visible_x
;
7284 set_iterator_to_next (it
, 0);
7288 it
->continuation_lines_width
+= it
->current_x
;
7295 /* Reset/increment for the next run. */
7296 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
7297 it
->current_x
= line_start_x
;
7300 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7302 last_height
= it
->max_ascent
+ it
->max_descent
;
7303 last_max_ascent
= it
->max_ascent
;
7304 it
->max_ascent
= it
->max_descent
= 0;
7309 /* On text terminals, we may stop at the end of a line in the middle
7310 of a multi-character glyph. If the glyph itself is continued,
7311 i.e. it is actually displayed on the next line, don't treat this
7312 stopping point as valid; move to the next line instead (unless
7313 that brings us offscreen). */
7314 if (!FRAME_WINDOW_P (it
->f
)
7316 && IT_CHARPOS (*it
) == to_charpos
7317 && it
->what
== IT_CHARACTER
7319 && it
->line_wrap
== WINDOW_WRAP
7320 && it
->current_x
== it
->last_visible_x
- 1
7323 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
7325 it
->continuation_lines_width
+= it
->current_x
;
7326 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
7327 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7329 last_height
= it
->max_ascent
+ it
->max_descent
;
7330 last_max_ascent
= it
->max_ascent
;
7333 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
7337 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
7339 If DY > 0, move IT backward at least that many pixels. DY = 0
7340 means move IT backward to the preceding line start or BEGV. This
7341 function may move over more than DY pixels if IT->current_y - DY
7342 ends up in the middle of a line; in this case IT->current_y will be
7343 set to the top of the line moved to. */
7346 move_it_vertically_backward (it
, dy
)
7357 start_pos
= IT_CHARPOS (*it
);
7359 /* Estimate how many newlines we must move back. */
7360 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
7362 /* Set the iterator's position that many lines back. */
7363 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
7364 back_to_previous_visible_line_start (it
);
7366 /* Reseat the iterator here. When moving backward, we don't want
7367 reseat to skip forward over invisible text, set up the iterator
7368 to deliver from overlay strings at the new position etc. So,
7369 use reseat_1 here. */
7370 reseat_1 (it
, it
->current
.pos
, 1);
7372 /* We are now surely at a line start. */
7373 it
->current_x
= it
->hpos
= 0;
7374 it
->continuation_lines_width
= 0;
7376 /* Move forward and see what y-distance we moved. First move to the
7377 start of the next line so that we get its height. We need this
7378 height to be able to tell whether we reached the specified
7381 it2
.max_ascent
= it2
.max_descent
= 0;
7384 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
7385 MOVE_TO_POS
| MOVE_TO_VPOS
);
7387 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
7388 xassert (IT_CHARPOS (*it
) >= BEGV
);
7391 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
7392 xassert (IT_CHARPOS (*it
) >= BEGV
);
7393 /* H is the actual vertical distance from the position in *IT
7394 and the starting position. */
7395 h
= it2
.current_y
- it
->current_y
;
7396 /* NLINES is the distance in number of lines. */
7397 nlines
= it2
.vpos
- it
->vpos
;
7399 /* Correct IT's y and vpos position
7400 so that they are relative to the starting point. */
7406 /* DY == 0 means move to the start of the screen line. The
7407 value of nlines is > 0 if continuation lines were involved. */
7409 move_it_by_lines (it
, nlines
, 1);
7413 /* The y-position we try to reach, relative to *IT.
7414 Note that H has been subtracted in front of the if-statement. */
7415 int target_y
= it
->current_y
+ h
- dy
;
7416 int y0
= it3
.current_y
;
7417 int y1
= line_bottom_y (&it3
);
7418 int line_height
= y1
- y0
;
7420 /* If we did not reach target_y, try to move further backward if
7421 we can. If we moved too far backward, try to move forward. */
7422 if (target_y
< it
->current_y
7423 /* This is heuristic. In a window that's 3 lines high, with
7424 a line height of 13 pixels each, recentering with point
7425 on the bottom line will try to move -39/2 = 19 pixels
7426 backward. Try to avoid moving into the first line. */
7427 && (it
->current_y
- target_y
7428 > min (window_box_height (it
->w
), line_height
* 2 / 3))
7429 && IT_CHARPOS (*it
) > BEGV
)
7431 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
7432 target_y
- it
->current_y
));
7433 dy
= it
->current_y
- target_y
;
7434 goto move_further_back
;
7436 else if (target_y
>= it
->current_y
+ line_height
7437 && IT_CHARPOS (*it
) < ZV
)
7439 /* Should move forward by at least one line, maybe more.
7441 Note: Calling move_it_by_lines can be expensive on
7442 terminal frames, where compute_motion is used (via
7443 vmotion) to do the job, when there are very long lines
7444 and truncate-lines is nil. That's the reason for
7445 treating terminal frames specially here. */
7447 if (!FRAME_WINDOW_P (it
->f
))
7448 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
7453 move_it_by_lines (it
, 1, 1);
7455 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
7462 /* Move IT by a specified amount of pixel lines DY. DY negative means
7463 move backwards. DY = 0 means move to start of screen line. At the
7464 end, IT will be on the start of a screen line. */
7467 move_it_vertically (it
, dy
)
7472 move_it_vertically_backward (it
, -dy
);
7475 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
7476 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
7477 MOVE_TO_POS
| MOVE_TO_Y
);
7478 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
7480 /* If buffer ends in ZV without a newline, move to the start of
7481 the line to satisfy the post-condition. */
7482 if (IT_CHARPOS (*it
) == ZV
7484 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
7485 move_it_by_lines (it
, 0, 0);
7490 /* Move iterator IT past the end of the text line it is in. */
7493 move_it_past_eol (it
)
7496 enum move_it_result rc
;
7498 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
7499 if (rc
== MOVE_NEWLINE_OR_CR
)
7500 set_iterator_to_next (it
, 0);
7504 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
7505 negative means move up. DVPOS == 0 means move to the start of the
7506 screen line. NEED_Y_P non-zero means calculate IT->current_y. If
7507 NEED_Y_P is zero, IT->current_y will be left unchanged.
7509 Further optimization ideas: If we would know that IT->f doesn't use
7510 a face with proportional font, we could be faster for
7511 truncate-lines nil. */
7514 move_it_by_lines (it
, dvpos
, need_y_p
)
7516 int dvpos
, need_y_p
;
7518 struct position pos
;
7520 /* The commented-out optimization uses vmotion on terminals. This
7521 gives bad results, because elements like it->what, on which
7522 callers such as pos_visible_p rely, aren't updated. */
7523 /* if (!FRAME_WINDOW_P (it->f))
7525 struct text_pos textpos;
7527 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
7528 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
7529 reseat (it, textpos, 1);
7530 it->vpos += pos.vpos;
7531 it->current_y += pos.vpos;
7537 /* DVPOS == 0 means move to the start of the screen line. */
7538 move_it_vertically_backward (it
, 0);
7539 xassert (it
->current_x
== 0 && it
->hpos
== 0);
7540 /* Let next call to line_bottom_y calculate real line height */
7545 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
7546 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
7547 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
7552 int start_charpos
, i
;
7554 /* Start at the beginning of the screen line containing IT's
7555 position. This may actually move vertically backwards,
7556 in case of overlays, so adjust dvpos accordingly. */
7558 move_it_vertically_backward (it
, 0);
7561 /* Go back -DVPOS visible lines and reseat the iterator there. */
7562 start_charpos
= IT_CHARPOS (*it
);
7563 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
7564 back_to_previous_visible_line_start (it
);
7565 reseat (it
, it
->current
.pos
, 1);
7567 /* Move further back if we end up in a string or an image. */
7568 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
7570 /* First try to move to start of display line. */
7572 move_it_vertically_backward (it
, 0);
7574 if (IT_POS_VALID_AFTER_MOVE_P (it
))
7576 /* If start of line is still in string or image,
7577 move further back. */
7578 back_to_previous_visible_line_start (it
);
7579 reseat (it
, it
->current
.pos
, 1);
7583 it
->current_x
= it
->hpos
= 0;
7585 /* Above call may have moved too far if continuation lines
7586 are involved. Scan forward and see if it did. */
7588 it2
.vpos
= it2
.current_y
= 0;
7589 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
7590 it
->vpos
-= it2
.vpos
;
7591 it
->current_y
-= it2
.current_y
;
7592 it
->current_x
= it
->hpos
= 0;
7594 /* If we moved too far back, move IT some lines forward. */
7595 if (it2
.vpos
> -dvpos
)
7597 int delta
= it2
.vpos
+ dvpos
;
7599 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
7600 /* Move back again if we got too far ahead. */
7601 if (IT_CHARPOS (*it
) >= start_charpos
)
7607 /* Return 1 if IT points into the middle of a display vector. */
7610 in_display_vector_p (it
)
7613 return (it
->method
== GET_FROM_DISPLAY_VECTOR
7614 && it
->current
.dpvec_index
> 0
7615 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
7619 /***********************************************************************
7621 ***********************************************************************/
7624 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
7628 add_to_log (format
, arg1
, arg2
)
7630 Lisp_Object arg1
, arg2
;
7632 Lisp_Object args
[3];
7633 Lisp_Object msg
, fmt
;
7636 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
7639 /* Do nothing if called asynchronously. Inserting text into
7640 a buffer may call after-change-functions and alike and
7641 that would means running Lisp asynchronously. */
7642 if (handling_signal
)
7646 GCPRO4 (fmt
, msg
, arg1
, arg2
);
7648 args
[0] = fmt
= build_string (format
);
7651 msg
= Fformat (3, args
);
7653 len
= SBYTES (msg
) + 1;
7654 SAFE_ALLOCA (buffer
, char *, len
);
7655 bcopy (SDATA (msg
), buffer
, len
);
7657 message_dolog (buffer
, len
- 1, 1, 0);
7664 /* Output a newline in the *Messages* buffer if "needs" one. */
7667 message_log_maybe_newline ()
7669 if (message_log_need_newline
)
7670 message_dolog ("", 0, 1, 0);
7674 /* Add a string M of length NBYTES to the message log, optionally
7675 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
7676 nonzero, means interpret the contents of M as multibyte. This
7677 function calls low-level routines in order to bypass text property
7678 hooks, etc. which might not be safe to run.
7680 This may GC (insert may run before/after change hooks),
7681 so the buffer M must NOT point to a Lisp string. */
7684 message_dolog (m
, nbytes
, nlflag
, multibyte
)
7686 int nbytes
, nlflag
, multibyte
;
7688 if (!NILP (Vmemory_full
))
7691 if (!NILP (Vmessage_log_max
))
7693 struct buffer
*oldbuf
;
7694 Lisp_Object oldpoint
, oldbegv
, oldzv
;
7695 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
7696 int point_at_end
= 0;
7698 Lisp_Object old_deactivate_mark
, tem
;
7699 struct gcpro gcpro1
;
7701 old_deactivate_mark
= Vdeactivate_mark
;
7702 oldbuf
= current_buffer
;
7703 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
7704 current_buffer
->undo_list
= Qt
;
7706 oldpoint
= message_dolog_marker1
;
7707 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
7708 oldbegv
= message_dolog_marker2
;
7709 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
7710 oldzv
= message_dolog_marker3
;
7711 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
7712 GCPRO1 (old_deactivate_mark
);
7720 BEGV_BYTE
= BEG_BYTE
;
7723 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
7725 /* Insert the string--maybe converting multibyte to single byte
7726 or vice versa, so that all the text fits the buffer. */
7728 && NILP (current_buffer
->enable_multibyte_characters
))
7730 int i
, c
, char_bytes
;
7731 unsigned char work
[1];
7733 /* Convert a multibyte string to single-byte
7734 for the *Message* buffer. */
7735 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
7737 c
= string_char_and_length (m
+ i
, &char_bytes
);
7738 work
[0] = (ASCII_CHAR_P (c
)
7740 : multibyte_char_to_unibyte (c
, Qnil
));
7741 insert_1_both (work
, 1, 1, 1, 0, 0);
7744 else if (! multibyte
7745 && ! NILP (current_buffer
->enable_multibyte_characters
))
7747 int i
, c
, char_bytes
;
7748 unsigned char *msg
= (unsigned char *) m
;
7749 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
7750 /* Convert a single-byte string to multibyte
7751 for the *Message* buffer. */
7752 for (i
= 0; i
< nbytes
; i
++)
7755 MAKE_CHAR_MULTIBYTE (c
);
7756 char_bytes
= CHAR_STRING (c
, str
);
7757 insert_1_both (str
, 1, char_bytes
, 1, 0, 0);
7761 insert_1 (m
, nbytes
, 1, 0, 0);
7765 int this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
, dup
;
7766 insert_1 ("\n", 1, 1, 0, 0);
7768 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
7770 this_bol_byte
= PT_BYTE
;
7772 /* See if this line duplicates the previous one.
7773 If so, combine duplicates. */
7776 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
7778 prev_bol_byte
= PT_BYTE
;
7780 dup
= message_log_check_duplicate (prev_bol
, prev_bol_byte
,
7781 this_bol
, this_bol_byte
);
7784 del_range_both (prev_bol
, prev_bol_byte
,
7785 this_bol
, this_bol_byte
, 0);
7791 /* If you change this format, don't forget to also
7792 change message_log_check_duplicate. */
7793 sprintf (dupstr
, " [%d times]", dup
);
7794 duplen
= strlen (dupstr
);
7795 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
7796 insert_1 (dupstr
, duplen
, 1, 0, 1);
7801 /* If we have more than the desired maximum number of lines
7802 in the *Messages* buffer now, delete the oldest ones.
7803 This is safe because we don't have undo in this buffer. */
7805 if (NATNUMP (Vmessage_log_max
))
7807 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
7808 -XFASTINT (Vmessage_log_max
) - 1, 0);
7809 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
7812 BEGV
= XMARKER (oldbegv
)->charpos
;
7813 BEGV_BYTE
= marker_byte_position (oldbegv
);
7822 ZV
= XMARKER (oldzv
)->charpos
;
7823 ZV_BYTE
= marker_byte_position (oldzv
);
7827 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
7829 /* We can't do Fgoto_char (oldpoint) because it will run some
7831 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
7832 XMARKER (oldpoint
)->bytepos
);
7835 unchain_marker (XMARKER (oldpoint
));
7836 unchain_marker (XMARKER (oldbegv
));
7837 unchain_marker (XMARKER (oldzv
));
7839 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
7840 set_buffer_internal (oldbuf
);
7842 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
7843 message_log_need_newline
= !nlflag
;
7844 Vdeactivate_mark
= old_deactivate_mark
;
7849 /* We are at the end of the buffer after just having inserted a newline.
7850 (Note: We depend on the fact we won't be crossing the gap.)
7851 Check to see if the most recent message looks a lot like the previous one.
7852 Return 0 if different, 1 if the new one should just replace it, or a
7853 value N > 1 if we should also append " [N times]". */
7856 message_log_check_duplicate (prev_bol
, prev_bol_byte
, this_bol
, this_bol_byte
)
7857 int prev_bol
, this_bol
;
7858 int prev_bol_byte
, this_bol_byte
;
7861 int len
= Z_BYTE
- 1 - this_bol_byte
;
7863 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
7864 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
7866 for (i
= 0; i
< len
; i
++)
7868 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
7876 if (*p1
++ == ' ' && *p1
++ == '[')
7879 while (*p1
>= '0' && *p1
<= '9')
7880 n
= n
* 10 + *p1
++ - '0';
7881 if (strncmp (p1
, " times]\n", 8) == 0)
7888 /* Display an echo area message M with a specified length of NBYTES
7889 bytes. The string may include null characters. If M is 0, clear
7890 out any existing message, and let the mini-buffer text show
7893 This may GC, so the buffer M must NOT point to a Lisp string. */
7896 message2 (m
, nbytes
, multibyte
)
7901 /* First flush out any partial line written with print. */
7902 message_log_maybe_newline ();
7904 message_dolog (m
, nbytes
, 1, multibyte
);
7905 message2_nolog (m
, nbytes
, multibyte
);
7909 /* The non-logging counterpart of message2. */
7912 message2_nolog (m
, nbytes
, multibyte
)
7914 int nbytes
, multibyte
;
7916 struct frame
*sf
= SELECTED_FRAME ();
7917 message_enable_multibyte
= multibyte
;
7919 if (FRAME_INITIAL_P (sf
))
7921 if (noninteractive_need_newline
)
7922 putc ('\n', stderr
);
7923 noninteractive_need_newline
= 0;
7925 fwrite (m
, nbytes
, 1, stderr
);
7926 if (cursor_in_echo_area
== 0)
7927 fprintf (stderr
, "\n");
7930 /* A null message buffer means that the frame hasn't really been
7931 initialized yet. Error messages get reported properly by
7932 cmd_error, so this must be just an informative message; toss it. */
7933 else if (INTERACTIVE
7934 && sf
->glyphs_initialized_p
7935 && FRAME_MESSAGE_BUF (sf
))
7937 Lisp_Object mini_window
;
7940 /* Get the frame containing the mini-buffer
7941 that the selected frame is using. */
7942 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
7943 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
7945 FRAME_SAMPLE_VISIBILITY (f
);
7946 if (FRAME_VISIBLE_P (sf
)
7947 && ! FRAME_VISIBLE_P (f
))
7948 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
7952 set_message (m
, Qnil
, nbytes
, multibyte
);
7953 if (minibuffer_auto_raise
)
7954 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
7957 clear_message (1, 1);
7959 do_pending_window_change (0);
7960 echo_area_display (1);
7961 do_pending_window_change (0);
7962 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
7963 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
7968 /* Display an echo area message M with a specified length of NBYTES
7969 bytes. The string may include null characters. If M is not a
7970 string, clear out any existing message, and let the mini-buffer
7973 This function cancels echoing. */
7976 message3 (m
, nbytes
, multibyte
)
7981 struct gcpro gcpro1
;
7984 clear_message (1,1);
7987 /* First flush out any partial line written with print. */
7988 message_log_maybe_newline ();
7994 SAFE_ALLOCA (buffer
, char *, nbytes
);
7995 bcopy (SDATA (m
), buffer
, nbytes
);
7996 message_dolog (buffer
, nbytes
, 1, multibyte
);
7999 message3_nolog (m
, nbytes
, multibyte
);
8005 /* The non-logging version of message3.
8006 This does not cancel echoing, because it is used for echoing.
8007 Perhaps we need to make a separate function for echoing
8008 and make this cancel echoing. */
8011 message3_nolog (m
, nbytes
, multibyte
)
8013 int nbytes
, multibyte
;
8015 struct frame
*sf
= SELECTED_FRAME ();
8016 message_enable_multibyte
= multibyte
;
8018 if (FRAME_INITIAL_P (sf
))
8020 if (noninteractive_need_newline
)
8021 putc ('\n', stderr
);
8022 noninteractive_need_newline
= 0;
8024 fwrite (SDATA (m
), nbytes
, 1, stderr
);
8025 if (cursor_in_echo_area
== 0)
8026 fprintf (stderr
, "\n");
8029 /* A null message buffer means that the frame hasn't really been
8030 initialized yet. Error messages get reported properly by
8031 cmd_error, so this must be just an informative message; toss it. */
8032 else if (INTERACTIVE
8033 && sf
->glyphs_initialized_p
8034 && FRAME_MESSAGE_BUF (sf
))
8036 Lisp_Object mini_window
;
8040 /* Get the frame containing the mini-buffer
8041 that the selected frame is using. */
8042 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8043 frame
= XWINDOW (mini_window
)->frame
;
8046 FRAME_SAMPLE_VISIBILITY (f
);
8047 if (FRAME_VISIBLE_P (sf
)
8048 && !FRAME_VISIBLE_P (f
))
8049 Fmake_frame_visible (frame
);
8051 if (STRINGP (m
) && SCHARS (m
) > 0)
8053 set_message (NULL
, m
, nbytes
, multibyte
);
8054 if (minibuffer_auto_raise
)
8055 Fraise_frame (frame
);
8056 /* Assume we are not echoing.
8057 (If we are, echo_now will override this.) */
8058 echo_message_buffer
= Qnil
;
8061 clear_message (1, 1);
8063 do_pending_window_change (0);
8064 echo_area_display (1);
8065 do_pending_window_change (0);
8066 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8067 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8072 /* Display a null-terminated echo area message M. If M is 0, clear
8073 out any existing message, and let the mini-buffer text show through.
8075 The buffer M must continue to exist until after the echo area gets
8076 cleared or some other message gets displayed there. Do not pass
8077 text that is stored in a Lisp string. Do not pass text in a buffer
8078 that was alloca'd. */
8084 message2 (m
, (m
? strlen (m
) : 0), 0);
8088 /* The non-logging counterpart of message1. */
8094 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
8097 /* Display a message M which contains a single %s
8098 which gets replaced with STRING. */
8101 message_with_string (m
, string
, log
)
8106 CHECK_STRING (string
);
8112 if (noninteractive_need_newline
)
8113 putc ('\n', stderr
);
8114 noninteractive_need_newline
= 0;
8115 fprintf (stderr
, m
, SDATA (string
));
8116 if (!cursor_in_echo_area
)
8117 fprintf (stderr
, "\n");
8121 else if (INTERACTIVE
)
8123 /* The frame whose minibuffer we're going to display the message on.
8124 It may be larger than the selected frame, so we need
8125 to use its buffer, not the selected frame's buffer. */
8126 Lisp_Object mini_window
;
8127 struct frame
*f
, *sf
= SELECTED_FRAME ();
8129 /* Get the frame containing the minibuffer
8130 that the selected frame is using. */
8131 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8132 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8134 /* A null message buffer means that the frame hasn't really been
8135 initialized yet. Error messages get reported properly by
8136 cmd_error, so this must be just an informative message; toss it. */
8137 if (FRAME_MESSAGE_BUF (f
))
8139 Lisp_Object args
[2], message
;
8140 struct gcpro gcpro1
, gcpro2
;
8142 args
[0] = build_string (m
);
8143 args
[1] = message
= string
;
8144 GCPRO2 (args
[0], message
);
8147 message
= Fformat (2, args
);
8150 message3 (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
8152 message3_nolog (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
8156 /* Print should start at the beginning of the message
8157 buffer next time. */
8158 message_buf_print
= 0;
8164 /* Dump an informative message to the minibuf. If M is 0, clear out
8165 any existing message, and let the mini-buffer text show through. */
8169 message (m
, a1
, a2
, a3
)
8171 EMACS_INT a1
, a2
, a3
;
8177 if (noninteractive_need_newline
)
8178 putc ('\n', stderr
);
8179 noninteractive_need_newline
= 0;
8180 fprintf (stderr
, m
, a1
, a2
, a3
);
8181 if (cursor_in_echo_area
== 0)
8182 fprintf (stderr
, "\n");
8186 else if (INTERACTIVE
)
8188 /* The frame whose mini-buffer we're going to display the message
8189 on. It may be larger than the selected frame, so we need to
8190 use its buffer, not the selected frame's buffer. */
8191 Lisp_Object mini_window
;
8192 struct frame
*f
, *sf
= SELECTED_FRAME ();
8194 /* Get the frame containing the mini-buffer
8195 that the selected frame is using. */
8196 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8197 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8199 /* A null message buffer means that the frame hasn't really been
8200 initialized yet. Error messages get reported properly by
8201 cmd_error, so this must be just an informative message; toss
8203 if (FRAME_MESSAGE_BUF (f
))
8214 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8215 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3, a
);
8217 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8218 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3,
8220 #endif /* NO_ARG_ARRAY */
8222 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
8227 /* Print should start at the beginning of the message
8228 buffer next time. */
8229 message_buf_print
= 0;
8235 /* The non-logging version of message. */
8238 message_nolog (m
, a1
, a2
, a3
)
8240 EMACS_INT a1
, a2
, a3
;
8242 Lisp_Object old_log_max
;
8243 old_log_max
= Vmessage_log_max
;
8244 Vmessage_log_max
= Qnil
;
8245 message (m
, a1
, a2
, a3
);
8246 Vmessage_log_max
= old_log_max
;
8250 /* Display the current message in the current mini-buffer. This is
8251 only called from error handlers in process.c, and is not time
8257 if (!NILP (echo_area_buffer
[0]))
8260 string
= Fcurrent_message ();
8261 message3 (string
, SBYTES (string
),
8262 !NILP (current_buffer
->enable_multibyte_characters
));
8267 /* Make sure echo area buffers in `echo_buffers' are live.
8268 If they aren't, make new ones. */
8271 ensure_echo_area_buffers ()
8275 for (i
= 0; i
< 2; ++i
)
8276 if (!BUFFERP (echo_buffer
[i
])
8277 || NILP (XBUFFER (echo_buffer
[i
])->name
))
8280 Lisp_Object old_buffer
;
8283 old_buffer
= echo_buffer
[i
];
8284 sprintf (name
, " *Echo Area %d*", i
);
8285 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
8286 XBUFFER (echo_buffer
[i
])->truncate_lines
= Qnil
;
8287 /* to force word wrap in echo area -
8288 it was decided to postpone this*/
8289 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
8291 for (j
= 0; j
< 2; ++j
)
8292 if (EQ (old_buffer
, echo_area_buffer
[j
]))
8293 echo_area_buffer
[j
] = echo_buffer
[i
];
8298 /* Call FN with args A1..A4 with either the current or last displayed
8299 echo_area_buffer as current buffer.
8301 WHICH zero means use the current message buffer
8302 echo_area_buffer[0]. If that is nil, choose a suitable buffer
8303 from echo_buffer[] and clear it.
8305 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
8306 suitable buffer from echo_buffer[] and clear it.
8308 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
8309 that the current message becomes the last displayed one, make
8310 choose a suitable buffer for echo_area_buffer[0], and clear it.
8312 Value is what FN returns. */
8315 with_echo_area_buffer (w
, which
, fn
, a1
, a2
, a3
, a4
)
8318 int (*fn
) P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
8324 int this_one
, the_other
, clear_buffer_p
, rc
;
8325 int count
= SPECPDL_INDEX ();
8327 /* If buffers aren't live, make new ones. */
8328 ensure_echo_area_buffers ();
8333 this_one
= 0, the_other
= 1;
8335 this_one
= 1, the_other
= 0;
8338 this_one
= 0, the_other
= 1;
8341 /* We need a fresh one in case the current echo buffer equals
8342 the one containing the last displayed echo area message. */
8343 if (!NILP (echo_area_buffer
[this_one
])
8344 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
8345 echo_area_buffer
[this_one
] = Qnil
;
8348 /* Choose a suitable buffer from echo_buffer[] is we don't
8350 if (NILP (echo_area_buffer
[this_one
]))
8352 echo_area_buffer
[this_one
]
8353 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
8354 ? echo_buffer
[the_other
]
8355 : echo_buffer
[this_one
]);
8359 buffer
= echo_area_buffer
[this_one
];
8361 /* Don't get confused by reusing the buffer used for echoing
8362 for a different purpose. */
8363 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
8366 record_unwind_protect (unwind_with_echo_area_buffer
,
8367 with_echo_area_buffer_unwind_data (w
));
8369 /* Make the echo area buffer current. Note that for display
8370 purposes, it is not necessary that the displayed window's buffer
8371 == current_buffer, except for text property lookup. So, let's
8372 only set that buffer temporarily here without doing a full
8373 Fset_window_buffer. We must also change w->pointm, though,
8374 because otherwise an assertions in unshow_buffer fails, and Emacs
8376 set_buffer_internal_1 (XBUFFER (buffer
));
8380 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
8383 current_buffer
->undo_list
= Qt
;
8384 current_buffer
->read_only
= Qnil
;
8385 specbind (Qinhibit_read_only
, Qt
);
8386 specbind (Qinhibit_modification_hooks
, Qt
);
8388 if (clear_buffer_p
&& Z
> BEG
)
8391 xassert (BEGV
>= BEG
);
8392 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8394 rc
= fn (a1
, a2
, a3
, a4
);
8396 xassert (BEGV
>= BEG
);
8397 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8399 unbind_to (count
, Qnil
);
8404 /* Save state that should be preserved around the call to the function
8405 FN called in with_echo_area_buffer. */
8408 with_echo_area_buffer_unwind_data (w
)
8412 Lisp_Object vector
, tmp
;
8414 /* Reduce consing by keeping one vector in
8415 Vwith_echo_area_save_vector. */
8416 vector
= Vwith_echo_area_save_vector
;
8417 Vwith_echo_area_save_vector
= Qnil
;
8420 vector
= Fmake_vector (make_number (7), Qnil
);
8422 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
8423 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
8424 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
8428 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
8429 ASET (vector
, i
, w
->buffer
); ++i
;
8430 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
8431 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
8436 for (; i
< end
; ++i
)
8437 ASET (vector
, i
, Qnil
);
8440 xassert (i
== ASIZE (vector
));
8445 /* Restore global state from VECTOR which was created by
8446 with_echo_area_buffer_unwind_data. */
8449 unwind_with_echo_area_buffer (vector
)
8452 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
8453 Vdeactivate_mark
= AREF (vector
, 1);
8454 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
8456 if (WINDOWP (AREF (vector
, 3)))
8459 Lisp_Object buffer
, charpos
, bytepos
;
8461 w
= XWINDOW (AREF (vector
, 3));
8462 buffer
= AREF (vector
, 4);
8463 charpos
= AREF (vector
, 5);
8464 bytepos
= AREF (vector
, 6);
8467 set_marker_both (w
->pointm
, buffer
,
8468 XFASTINT (charpos
), XFASTINT (bytepos
));
8471 Vwith_echo_area_save_vector
= vector
;
8476 /* Set up the echo area for use by print functions. MULTIBYTE_P
8477 non-zero means we will print multibyte. */
8480 setup_echo_area_for_printing (multibyte_p
)
8483 /* If we can't find an echo area any more, exit. */
8484 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8487 ensure_echo_area_buffers ();
8489 if (!message_buf_print
)
8491 /* A message has been output since the last time we printed.
8492 Choose a fresh echo area buffer. */
8493 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8494 echo_area_buffer
[0] = echo_buffer
[1];
8496 echo_area_buffer
[0] = echo_buffer
[0];
8498 /* Switch to that buffer and clear it. */
8499 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8500 current_buffer
->truncate_lines
= Qnil
;
8504 int count
= SPECPDL_INDEX ();
8505 specbind (Qinhibit_read_only
, Qt
);
8506 /* Note that undo recording is always disabled. */
8508 unbind_to (count
, Qnil
);
8510 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8512 /* Set up the buffer for the multibyteness we need. */
8514 != !NILP (current_buffer
->enable_multibyte_characters
))
8515 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
8517 /* Raise the frame containing the echo area. */
8518 if (minibuffer_auto_raise
)
8520 struct frame
*sf
= SELECTED_FRAME ();
8521 Lisp_Object mini_window
;
8522 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8523 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8526 message_log_maybe_newline ();
8527 message_buf_print
= 1;
8531 if (NILP (echo_area_buffer
[0]))
8533 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8534 echo_area_buffer
[0] = echo_buffer
[1];
8536 echo_area_buffer
[0] = echo_buffer
[0];
8539 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
8541 /* Someone switched buffers between print requests. */
8542 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8543 current_buffer
->truncate_lines
= Qnil
;
8549 /* Display an echo area message in window W. Value is non-zero if W's
8550 height is changed. If display_last_displayed_message_p is
8551 non-zero, display the message that was last displayed, otherwise
8552 display the current message. */
8555 display_echo_area (w
)
8558 int i
, no_message_p
, window_height_changed_p
, count
;
8560 /* Temporarily disable garbage collections while displaying the echo
8561 area. This is done because a GC can print a message itself.
8562 That message would modify the echo area buffer's contents while a
8563 redisplay of the buffer is going on, and seriously confuse
8565 count
= inhibit_garbage_collection ();
8567 /* If there is no message, we must call display_echo_area_1
8568 nevertheless because it resizes the window. But we will have to
8569 reset the echo_area_buffer in question to nil at the end because
8570 with_echo_area_buffer will sets it to an empty buffer. */
8571 i
= display_last_displayed_message_p
? 1 : 0;
8572 no_message_p
= NILP (echo_area_buffer
[i
]);
8574 window_height_changed_p
8575 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
8576 display_echo_area_1
,
8577 (EMACS_INT
) w
, Qnil
, 0, 0);
8580 echo_area_buffer
[i
] = Qnil
;
8582 unbind_to (count
, Qnil
);
8583 return window_height_changed_p
;
8587 /* Helper for display_echo_area. Display the current buffer which
8588 contains the current echo area message in window W, a mini-window,
8589 a pointer to which is passed in A1. A2..A4 are currently not used.
8590 Change the height of W so that all of the message is displayed.
8591 Value is non-zero if height of W was changed. */
8594 display_echo_area_1 (a1
, a2
, a3
, a4
)
8599 struct window
*w
= (struct window
*) a1
;
8601 struct text_pos start
;
8602 int window_height_changed_p
= 0;
8604 /* Do this before displaying, so that we have a large enough glyph
8605 matrix for the display. If we can't get enough space for the
8606 whole text, display the last N lines. That works by setting w->start. */
8607 window_height_changed_p
= resize_mini_window (w
, 0);
8609 /* Use the starting position chosen by resize_mini_window. */
8610 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
8613 clear_glyph_matrix (w
->desired_matrix
);
8614 XSETWINDOW (window
, w
);
8615 try_window (window
, start
, 0);
8617 return window_height_changed_p
;
8621 /* Resize the echo area window to exactly the size needed for the
8622 currently displayed message, if there is one. If a mini-buffer
8623 is active, don't shrink it. */
8626 resize_echo_area_exactly ()
8628 if (BUFFERP (echo_area_buffer
[0])
8629 && WINDOWP (echo_area_window
))
8631 struct window
*w
= XWINDOW (echo_area_window
);
8633 Lisp_Object resize_exactly
;
8635 if (minibuf_level
== 0)
8636 resize_exactly
= Qt
;
8638 resize_exactly
= Qnil
;
8640 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
8641 (EMACS_INT
) w
, resize_exactly
, 0, 0);
8644 ++windows_or_buffers_changed
;
8645 ++update_mode_lines
;
8646 redisplay_internal (0);
8652 /* Callback function for with_echo_area_buffer, when used from
8653 resize_echo_area_exactly. A1 contains a pointer to the window to
8654 resize, EXACTLY non-nil means resize the mini-window exactly to the
8655 size of the text displayed. A3 and A4 are not used. Value is what
8656 resize_mini_window returns. */
8659 resize_mini_window_1 (a1
, exactly
, a3
, a4
)
8661 Lisp_Object exactly
;
8664 return resize_mini_window ((struct window
*) a1
, !NILP (exactly
));
8668 /* Resize mini-window W to fit the size of its contents. EXACT_P
8669 means size the window exactly to the size needed. Otherwise, it's
8670 only enlarged until W's buffer is empty.
8672 Set W->start to the right place to begin display. If the whole
8673 contents fit, start at the beginning. Otherwise, start so as
8674 to make the end of the contents appear. This is particularly
8675 important for y-or-n-p, but seems desirable generally.
8677 Value is non-zero if the window height has been changed. */
8680 resize_mini_window (w
, exact_p
)
8684 struct frame
*f
= XFRAME (w
->frame
);
8685 int window_height_changed_p
= 0;
8687 xassert (MINI_WINDOW_P (w
));
8689 /* By default, start display at the beginning. */
8690 set_marker_both (w
->start
, w
->buffer
,
8691 BUF_BEGV (XBUFFER (w
->buffer
)),
8692 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
8694 /* Don't resize windows while redisplaying a window; it would
8695 confuse redisplay functions when the size of the window they are
8696 displaying changes from under them. Such a resizing can happen,
8697 for instance, when which-func prints a long message while
8698 we are running fontification-functions. We're running these
8699 functions with safe_call which binds inhibit-redisplay to t. */
8700 if (!NILP (Vinhibit_redisplay
))
8703 /* Nil means don't try to resize. */
8704 if (NILP (Vresize_mini_windows
)
8705 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
8708 if (!FRAME_MINIBUF_ONLY_P (f
))
8711 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
8712 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
8713 int height
, max_height
;
8714 int unit
= FRAME_LINE_HEIGHT (f
);
8715 struct text_pos start
;
8716 struct buffer
*old_current_buffer
= NULL
;
8718 if (current_buffer
!= XBUFFER (w
->buffer
))
8720 old_current_buffer
= current_buffer
;
8721 set_buffer_internal (XBUFFER (w
->buffer
));
8724 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8726 /* Compute the max. number of lines specified by the user. */
8727 if (FLOATP (Vmax_mini_window_height
))
8728 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
8729 else if (INTEGERP (Vmax_mini_window_height
))
8730 max_height
= XINT (Vmax_mini_window_height
);
8732 max_height
= total_height
/ 4;
8734 /* Correct that max. height if it's bogus. */
8735 max_height
= max (1, max_height
);
8736 max_height
= min (total_height
, max_height
);
8738 /* Find out the height of the text in the window. */
8739 if (it
.line_wrap
== TRUNCATE
)
8744 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
8745 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
8746 height
= it
.current_y
+ last_height
;
8748 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
8749 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
8750 height
= (height
+ unit
- 1) / unit
;
8753 /* Compute a suitable window start. */
8754 if (height
> max_height
)
8756 height
= max_height
;
8757 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8758 move_it_vertically_backward (&it
, (height
- 1) * unit
);
8759 start
= it
.current
.pos
;
8762 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
8763 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
8765 if (EQ (Vresize_mini_windows
, Qgrow_only
))
8767 /* Let it grow only, until we display an empty message, in which
8768 case the window shrinks again. */
8769 if (height
> WINDOW_TOTAL_LINES (w
))
8771 int old_height
= WINDOW_TOTAL_LINES (w
);
8772 freeze_window_starts (f
, 1);
8773 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8774 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8776 else if (height
< WINDOW_TOTAL_LINES (w
)
8777 && (exact_p
|| BEGV
== ZV
))
8779 int old_height
= WINDOW_TOTAL_LINES (w
);
8780 freeze_window_starts (f
, 0);
8781 shrink_mini_window (w
);
8782 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8787 /* Always resize to exact size needed. */
8788 if (height
> WINDOW_TOTAL_LINES (w
))
8790 int old_height
= WINDOW_TOTAL_LINES (w
);
8791 freeze_window_starts (f
, 1);
8792 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8793 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8795 else if (height
< WINDOW_TOTAL_LINES (w
))
8797 int old_height
= WINDOW_TOTAL_LINES (w
);
8798 freeze_window_starts (f
, 0);
8799 shrink_mini_window (w
);
8803 freeze_window_starts (f
, 1);
8804 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8807 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8811 if (old_current_buffer
)
8812 set_buffer_internal (old_current_buffer
);
8815 return window_height_changed_p
;
8819 /* Value is the current message, a string, or nil if there is no
8827 if (!BUFFERP (echo_area_buffer
[0]))
8831 with_echo_area_buffer (0, 0, current_message_1
,
8832 (EMACS_INT
) &msg
, Qnil
, 0, 0);
8834 echo_area_buffer
[0] = Qnil
;
8842 current_message_1 (a1
, a2
, a3
, a4
)
8847 Lisp_Object
*msg
= (Lisp_Object
*) a1
;
8850 *msg
= make_buffer_string (BEG
, Z
, 1);
8857 /* Push the current message on Vmessage_stack for later restauration
8858 by restore_message. Value is non-zero if the current message isn't
8859 empty. This is a relatively infrequent operation, so it's not
8860 worth optimizing. */
8866 msg
= current_message ();
8867 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
8868 return STRINGP (msg
);
8872 /* Restore message display from the top of Vmessage_stack. */
8879 xassert (CONSP (Vmessage_stack
));
8880 msg
= XCAR (Vmessage_stack
);
8882 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
8884 message3_nolog (msg
, 0, 0);
8888 /* Handler for record_unwind_protect calling pop_message. */
8891 pop_message_unwind (dummy
)
8898 /* Pop the top-most entry off Vmessage_stack. */
8903 xassert (CONSP (Vmessage_stack
));
8904 Vmessage_stack
= XCDR (Vmessage_stack
);
8908 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
8909 exits. If the stack is not empty, we have a missing pop_message
8913 check_message_stack ()
8915 if (!NILP (Vmessage_stack
))
8920 /* Truncate to NCHARS what will be displayed in the echo area the next
8921 time we display it---but don't redisplay it now. */
8924 truncate_echo_area (nchars
)
8928 echo_area_buffer
[0] = Qnil
;
8929 /* A null message buffer means that the frame hasn't really been
8930 initialized yet. Error messages get reported properly by
8931 cmd_error, so this must be just an informative message; toss it. */
8932 else if (!noninteractive
8934 && !NILP (echo_area_buffer
[0]))
8936 struct frame
*sf
= SELECTED_FRAME ();
8937 if (FRAME_MESSAGE_BUF (sf
))
8938 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
8943 /* Helper function for truncate_echo_area. Truncate the current
8944 message to at most NCHARS characters. */
8947 truncate_message_1 (nchars
, a2
, a3
, a4
)
8952 if (BEG
+ nchars
< Z
)
8953 del_range (BEG
+ nchars
, Z
);
8955 echo_area_buffer
[0] = Qnil
;
8960 /* Set the current message to a substring of S or STRING.
8962 If STRING is a Lisp string, set the message to the first NBYTES
8963 bytes from STRING. NBYTES zero means use the whole string. If
8964 STRING is multibyte, the message will be displayed multibyte.
8966 If S is not null, set the message to the first LEN bytes of S. LEN
8967 zero means use the whole string. MULTIBYTE_P non-zero means S is
8968 multibyte. Display the message multibyte in that case.
8970 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
8971 to t before calling set_message_1 (which calls insert).
8975 set_message (s
, string
, nbytes
, multibyte_p
)
8978 int nbytes
, multibyte_p
;
8980 message_enable_multibyte
8981 = ((s
&& multibyte_p
)
8982 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
8984 with_echo_area_buffer (0, -1, set_message_1
,
8985 (EMACS_INT
) s
, string
, nbytes
, multibyte_p
);
8986 message_buf_print
= 0;
8987 help_echo_showing_p
= 0;
8991 /* Helper function for set_message. Arguments have the same meaning
8992 as there, with A1 corresponding to S and A2 corresponding to STRING
8993 This function is called with the echo area buffer being
8997 set_message_1 (a1
, a2
, nbytes
, multibyte_p
)
9000 EMACS_INT nbytes
, multibyte_p
;
9002 const char *s
= (const char *) a1
;
9003 Lisp_Object string
= a2
;
9005 /* Change multibyteness of the echo buffer appropriately. */
9006 if (message_enable_multibyte
9007 != !NILP (current_buffer
->enable_multibyte_characters
))
9008 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
9010 current_buffer
->truncate_lines
= message_truncate_lines
? Qt
: Qnil
;
9012 /* Insert new message at BEG. */
9013 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9015 if (STRINGP (string
))
9020 nbytes
= SBYTES (string
);
9021 nchars
= string_byte_to_char (string
, nbytes
);
9023 /* This function takes care of single/multibyte conversion. We
9024 just have to ensure that the echo area buffer has the right
9025 setting of enable_multibyte_characters. */
9026 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
9031 nbytes
= strlen (s
);
9033 if (multibyte_p
&& NILP (current_buffer
->enable_multibyte_characters
))
9035 /* Convert from multi-byte to single-byte. */
9037 unsigned char work
[1];
9039 /* Convert a multibyte string to single-byte. */
9040 for (i
= 0; i
< nbytes
; i
+= n
)
9042 c
= string_char_and_length (s
+ i
, &n
);
9043 work
[0] = (ASCII_CHAR_P (c
)
9045 : multibyte_char_to_unibyte (c
, Qnil
));
9046 insert_1_both (work
, 1, 1, 1, 0, 0);
9049 else if (!multibyte_p
9050 && !NILP (current_buffer
->enable_multibyte_characters
))
9052 /* Convert from single-byte to multi-byte. */
9054 const unsigned char *msg
= (const unsigned char *) s
;
9055 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9057 /* Convert a single-byte string to multibyte. */
9058 for (i
= 0; i
< nbytes
; i
++)
9061 MAKE_CHAR_MULTIBYTE (c
);
9062 n
= CHAR_STRING (c
, str
);
9063 insert_1_both (str
, 1, n
, 1, 0, 0);
9067 insert_1 (s
, nbytes
, 1, 0, 0);
9074 /* Clear messages. CURRENT_P non-zero means clear the current
9075 message. LAST_DISPLAYED_P non-zero means clear the message
9079 clear_message (current_p
, last_displayed_p
)
9080 int current_p
, last_displayed_p
;
9084 echo_area_buffer
[0] = Qnil
;
9085 message_cleared_p
= 1;
9088 if (last_displayed_p
)
9089 echo_area_buffer
[1] = Qnil
;
9091 message_buf_print
= 0;
9094 /* Clear garbaged frames.
9096 This function is used where the old redisplay called
9097 redraw_garbaged_frames which in turn called redraw_frame which in
9098 turn called clear_frame. The call to clear_frame was a source of
9099 flickering. I believe a clear_frame is not necessary. It should
9100 suffice in the new redisplay to invalidate all current matrices,
9101 and ensure a complete redisplay of all windows. */
9104 clear_garbaged_frames ()
9108 Lisp_Object tail
, frame
;
9109 int changed_count
= 0;
9111 FOR_EACH_FRAME (tail
, frame
)
9113 struct frame
*f
= XFRAME (frame
);
9115 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
9119 Fredraw_frame (frame
);
9120 f
->force_flush_display_p
= 1;
9122 clear_current_matrices (f
);
9131 ++windows_or_buffers_changed
;
9136 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
9137 is non-zero update selected_frame. Value is non-zero if the
9138 mini-windows height has been changed. */
9141 echo_area_display (update_frame_p
)
9144 Lisp_Object mini_window
;
9147 int window_height_changed_p
= 0;
9148 struct frame
*sf
= SELECTED_FRAME ();
9150 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9151 w
= XWINDOW (mini_window
);
9152 f
= XFRAME (WINDOW_FRAME (w
));
9154 /* Don't display if frame is invisible or not yet initialized. */
9155 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
9158 #ifdef HAVE_WINDOW_SYSTEM
9159 /* When Emacs starts, selected_frame may be the initial terminal
9160 frame. If we let this through, a message would be displayed on
9162 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
9164 #endif /* HAVE_WINDOW_SYSTEM */
9166 /* Redraw garbaged frames. */
9168 clear_garbaged_frames ();
9170 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
9172 echo_area_window
= mini_window
;
9173 window_height_changed_p
= display_echo_area (w
);
9174 w
->must_be_updated_p
= 1;
9176 /* Update the display, unless called from redisplay_internal.
9177 Also don't update the screen during redisplay itself. The
9178 update will happen at the end of redisplay, and an update
9179 here could cause confusion. */
9180 if (update_frame_p
&& !redisplaying_p
)
9184 /* If the display update has been interrupted by pending
9185 input, update mode lines in the frame. Due to the
9186 pending input, it might have been that redisplay hasn't
9187 been called, so that mode lines above the echo area are
9188 garbaged. This looks odd, so we prevent it here. */
9189 if (!display_completed
)
9190 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
9192 if (window_height_changed_p
9193 /* Don't do this if Emacs is shutting down. Redisplay
9194 needs to run hooks. */
9195 && !NILP (Vrun_hooks
))
9197 /* Must update other windows. Likewise as in other
9198 cases, don't let this update be interrupted by
9200 int count
= SPECPDL_INDEX ();
9201 specbind (Qredisplay_dont_pause
, Qt
);
9202 windows_or_buffers_changed
= 1;
9203 redisplay_internal (0);
9204 unbind_to (count
, Qnil
);
9206 else if (FRAME_WINDOW_P (f
) && n
== 0)
9208 /* Window configuration is the same as before.
9209 Can do with a display update of the echo area,
9210 unless we displayed some mode lines. */
9211 update_single_window (w
, 1);
9212 FRAME_RIF (f
)->flush_display (f
);
9215 update_frame (f
, 1, 1);
9217 /* If cursor is in the echo area, make sure that the next
9218 redisplay displays the minibuffer, so that the cursor will
9219 be replaced with what the minibuffer wants. */
9220 if (cursor_in_echo_area
)
9221 ++windows_or_buffers_changed
;
9224 else if (!EQ (mini_window
, selected_window
))
9225 windows_or_buffers_changed
++;
9227 /* Last displayed message is now the current message. */
9228 echo_area_buffer
[1] = echo_area_buffer
[0];
9229 /* Inform read_char that we're not echoing. */
9230 echo_message_buffer
= Qnil
;
9232 /* Prevent redisplay optimization in redisplay_internal by resetting
9233 this_line_start_pos. This is done because the mini-buffer now
9234 displays the message instead of its buffer text. */
9235 if (EQ (mini_window
, selected_window
))
9236 CHARPOS (this_line_start_pos
) = 0;
9238 return window_height_changed_p
;
9243 /***********************************************************************
9244 Mode Lines and Frame Titles
9245 ***********************************************************************/
9247 /* A buffer for constructing non-propertized mode-line strings and
9248 frame titles in it; allocated from the heap in init_xdisp and
9249 resized as needed in store_mode_line_noprop_char. */
9251 static char *mode_line_noprop_buf
;
9253 /* The buffer's end, and a current output position in it. */
9255 static char *mode_line_noprop_buf_end
;
9256 static char *mode_line_noprop_ptr
;
9258 #define MODE_LINE_NOPROP_LEN(start) \
9259 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
9262 MODE_LINE_DISPLAY
= 0,
9268 /* Alist that caches the results of :propertize.
9269 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
9270 static Lisp_Object mode_line_proptrans_alist
;
9272 /* List of strings making up the mode-line. */
9273 static Lisp_Object mode_line_string_list
;
9275 /* Base face property when building propertized mode line string. */
9276 static Lisp_Object mode_line_string_face
;
9277 static Lisp_Object mode_line_string_face_prop
;
9280 /* Unwind data for mode line strings */
9282 static Lisp_Object Vmode_line_unwind_vector
;
9285 format_mode_line_unwind_data (struct buffer
*obuf
,
9289 Lisp_Object vector
, tmp
;
9291 /* Reduce consing by keeping one vector in
9292 Vwith_echo_area_save_vector. */
9293 vector
= Vmode_line_unwind_vector
;
9294 Vmode_line_unwind_vector
= Qnil
;
9297 vector
= Fmake_vector (make_number (8), Qnil
);
9299 ASET (vector
, 0, make_number (mode_line_target
));
9300 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
9301 ASET (vector
, 2, mode_line_string_list
);
9302 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
9303 ASET (vector
, 4, mode_line_string_face
);
9304 ASET (vector
, 5, mode_line_string_face_prop
);
9307 XSETBUFFER (tmp
, obuf
);
9310 ASET (vector
, 6, tmp
);
9311 ASET (vector
, 7, owin
);
9317 unwind_format_mode_line (vector
)
9320 mode_line_target
= XINT (AREF (vector
, 0));
9321 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
9322 mode_line_string_list
= AREF (vector
, 2);
9323 if (! EQ (AREF (vector
, 3), Qt
))
9324 mode_line_proptrans_alist
= AREF (vector
, 3);
9325 mode_line_string_face
= AREF (vector
, 4);
9326 mode_line_string_face_prop
= AREF (vector
, 5);
9328 if (!NILP (AREF (vector
, 7)))
9329 /* Select window before buffer, since it may change the buffer. */
9330 Fselect_window (AREF (vector
, 7), Qt
);
9332 if (!NILP (AREF (vector
, 6)))
9334 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
9335 ASET (vector
, 6, Qnil
);
9338 Vmode_line_unwind_vector
= vector
;
9343 /* Store a single character C for the frame title in mode_line_noprop_buf.
9344 Re-allocate mode_line_noprop_buf if necessary. */
9348 store_mode_line_noprop_char (char c
)
9350 store_mode_line_noprop_char (c
)
9354 /* If output position has reached the end of the allocated buffer,
9355 double the buffer's size. */
9356 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
9358 int len
= MODE_LINE_NOPROP_LEN (0);
9359 int new_size
= 2 * len
* sizeof *mode_line_noprop_buf
;
9360 mode_line_noprop_buf
= (char *) xrealloc (mode_line_noprop_buf
, new_size
);
9361 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ new_size
;
9362 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
9365 *mode_line_noprop_ptr
++ = c
;
9369 /* Store part of a frame title in mode_line_noprop_buf, beginning at
9370 mode_line_noprop_ptr. STR is the string to store. Do not copy
9371 characters that yield more columns than PRECISION; PRECISION <= 0
9372 means copy the whole string. Pad with spaces until FIELD_WIDTH
9373 number of characters have been copied; FIELD_WIDTH <= 0 means don't
9374 pad. Called from display_mode_element when it is used to build a
9378 store_mode_line_noprop (str
, field_width
, precision
)
9379 const unsigned char *str
;
9380 int field_width
, precision
;
9385 /* Copy at most PRECISION chars from STR. */
9386 nbytes
= strlen (str
);
9387 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
9389 store_mode_line_noprop_char (*str
++);
9391 /* Fill up with spaces until FIELD_WIDTH reached. */
9392 while (field_width
> 0
9395 store_mode_line_noprop_char (' ');
9402 /***********************************************************************
9404 ***********************************************************************/
9406 #ifdef HAVE_WINDOW_SYSTEM
9408 /* Set the title of FRAME, if it has changed. The title format is
9409 Vicon_title_format if FRAME is iconified, otherwise it is
9410 frame_title_format. */
9413 x_consider_frame_title (frame
)
9416 struct frame
*f
= XFRAME (frame
);
9418 if (FRAME_WINDOW_P (f
)
9419 || FRAME_MINIBUF_ONLY_P (f
)
9420 || f
->explicit_name
)
9422 /* Do we have more than one visible frame on this X display? */
9429 int count
= SPECPDL_INDEX ();
9431 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
9433 Lisp_Object other_frame
= XCAR (tail
);
9434 struct frame
*tf
= XFRAME (other_frame
);
9437 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
9438 && !FRAME_MINIBUF_ONLY_P (tf
)
9439 && !EQ (other_frame
, tip_frame
)
9440 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
9444 /* Set global variable indicating that multiple frames exist. */
9445 multiple_frames
= CONSP (tail
);
9447 /* Switch to the buffer of selected window of the frame. Set up
9448 mode_line_target so that display_mode_element will output into
9449 mode_line_noprop_buf; then display the title. */
9450 record_unwind_protect (unwind_format_mode_line
,
9451 format_mode_line_unwind_data
9452 (current_buffer
, selected_window
, 0));
9454 Fselect_window (f
->selected_window
, Qt
);
9455 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
9456 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
9458 mode_line_target
= MODE_LINE_TITLE
;
9459 title_start
= MODE_LINE_NOPROP_LEN (0);
9460 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
9461 NULL
, DEFAULT_FACE_ID
);
9462 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
9463 len
= MODE_LINE_NOPROP_LEN (title_start
);
9464 title
= mode_line_noprop_buf
+ title_start
;
9465 unbind_to (count
, Qnil
);
9467 /* Set the title only if it's changed. This avoids consing in
9468 the common case where it hasn't. (If it turns out that we've
9469 already wasted too much time by walking through the list with
9470 display_mode_element, then we might need to optimize at a
9471 higher level than this.) */
9472 if (! STRINGP (f
->name
)
9473 || SBYTES (f
->name
) != len
9474 || bcmp (title
, SDATA (f
->name
), len
) != 0)
9475 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
9479 #endif /* not HAVE_WINDOW_SYSTEM */
9484 /***********************************************************************
9486 ***********************************************************************/
9489 /* Prepare for redisplay by updating menu-bar item lists when
9490 appropriate. This can call eval. */
9493 prepare_menu_bars ()
9496 struct gcpro gcpro1
, gcpro2
;
9498 Lisp_Object tooltip_frame
;
9500 #ifdef HAVE_WINDOW_SYSTEM
9501 tooltip_frame
= tip_frame
;
9503 tooltip_frame
= Qnil
;
9506 /* Update all frame titles based on their buffer names, etc. We do
9507 this before the menu bars so that the buffer-menu will show the
9508 up-to-date frame titles. */
9509 #ifdef HAVE_WINDOW_SYSTEM
9510 if (windows_or_buffers_changed
|| update_mode_lines
)
9512 Lisp_Object tail
, frame
;
9514 FOR_EACH_FRAME (tail
, frame
)
9517 if (!EQ (frame
, tooltip_frame
)
9518 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
9519 x_consider_frame_title (frame
);
9522 #endif /* HAVE_WINDOW_SYSTEM */
9524 /* Update the menu bar item lists, if appropriate. This has to be
9525 done before any actual redisplay or generation of display lines. */
9526 all_windows
= (update_mode_lines
9527 || buffer_shared
> 1
9528 || windows_or_buffers_changed
);
9531 Lisp_Object tail
, frame
;
9532 int count
= SPECPDL_INDEX ();
9533 /* 1 means that update_menu_bar has run its hooks
9534 so any further calls to update_menu_bar shouldn't do so again. */
9535 int menu_bar_hooks_run
= 0;
9537 record_unwind_save_match_data ();
9539 FOR_EACH_FRAME (tail
, frame
)
9543 /* Ignore tooltip frame. */
9544 if (EQ (frame
, tooltip_frame
))
9547 /* If a window on this frame changed size, report that to
9548 the user and clear the size-change flag. */
9549 if (FRAME_WINDOW_SIZES_CHANGED (f
))
9551 Lisp_Object functions
;
9553 /* Clear flag first in case we get an error below. */
9554 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
9555 functions
= Vwindow_size_change_functions
;
9556 GCPRO2 (tail
, functions
);
9558 while (CONSP (functions
))
9560 if (!EQ (XCAR (functions
), Qt
))
9561 call1 (XCAR (functions
), frame
);
9562 functions
= XCDR (functions
);
9568 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
9569 #ifdef HAVE_WINDOW_SYSTEM
9570 update_tool_bar (f
, 0);
9573 if (windows_or_buffers_changed
)
9574 ns_set_doc_edited (f
, Fbuffer_modified_p
9575 (XWINDOW (f
->selected_window
)->buffer
));
9580 unbind_to (count
, Qnil
);
9584 struct frame
*sf
= SELECTED_FRAME ();
9585 update_menu_bar (sf
, 1, 0);
9586 #ifdef HAVE_WINDOW_SYSTEM
9587 update_tool_bar (sf
, 1);
9591 /* Motif needs this. See comment in xmenu.c. Turn it off when
9592 pending_menu_activation is not defined. */
9593 #ifdef USE_X_TOOLKIT
9594 pending_menu_activation
= 0;
9599 /* Update the menu bar item list for frame F. This has to be done
9600 before we start to fill in any display lines, because it can call
9603 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
9605 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
9606 already ran the menu bar hooks for this redisplay, so there
9607 is no need to run them again. The return value is the
9608 updated value of this flag, to pass to the next call. */
9611 update_menu_bar (f
, save_match_data
, hooks_run
)
9613 int save_match_data
;
9617 register struct window
*w
;
9619 /* If called recursively during a menu update, do nothing. This can
9620 happen when, for instance, an activate-menubar-hook causes a
9622 if (inhibit_menubar_update
)
9625 window
= FRAME_SELECTED_WINDOW (f
);
9626 w
= XWINDOW (window
);
9628 if (FRAME_WINDOW_P (f
)
9630 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9631 || defined (HAVE_NS) || defined (USE_GTK)
9632 FRAME_EXTERNAL_MENU_BAR (f
)
9634 FRAME_MENU_BAR_LINES (f
) > 0
9636 : FRAME_MENU_BAR_LINES (f
) > 0)
9638 /* If the user has switched buffers or windows, we need to
9639 recompute to reflect the new bindings. But we'll
9640 recompute when update_mode_lines is set too; that means
9641 that people can use force-mode-line-update to request
9642 that the menu bar be recomputed. The adverse effect on
9643 the rest of the redisplay algorithm is about the same as
9644 windows_or_buffers_changed anyway. */
9645 if (windows_or_buffers_changed
9646 /* This used to test w->update_mode_line, but we believe
9647 there is no need to recompute the menu in that case. */
9648 || update_mode_lines
9649 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9650 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9651 != !NILP (w
->last_had_star
))
9652 || ((!NILP (Vtransient_mark_mode
)
9653 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
9654 != !NILP (w
->region_showing
)))
9656 struct buffer
*prev
= current_buffer
;
9657 int count
= SPECPDL_INDEX ();
9659 specbind (Qinhibit_menubar_update
, Qt
);
9661 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9662 if (save_match_data
)
9663 record_unwind_save_match_data ();
9664 if (NILP (Voverriding_local_map_menu_flag
))
9666 specbind (Qoverriding_terminal_local_map
, Qnil
);
9667 specbind (Qoverriding_local_map
, Qnil
);
9672 /* Run the Lucid hook. */
9673 safe_run_hooks (Qactivate_menubar_hook
);
9675 /* If it has changed current-menubar from previous value,
9676 really recompute the menu-bar from the value. */
9677 if (! NILP (Vlucid_menu_bar_dirty_flag
))
9678 call0 (Qrecompute_lucid_menubar
);
9680 safe_run_hooks (Qmenu_bar_update_hook
);
9685 XSETFRAME (Vmenu_updating_frame
, f
);
9686 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
9688 /* Redisplay the menu bar in case we changed it. */
9689 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9690 || defined (HAVE_NS) || defined (USE_GTK)
9691 if (FRAME_WINDOW_P (f
))
9693 #if defined (HAVE_NS)
9694 /* All frames on Mac OS share the same menubar. So only
9695 the selected frame should be allowed to set it. */
9696 if (f
== SELECTED_FRAME ())
9698 set_frame_menubar (f
, 0, 0);
9701 /* On a terminal screen, the menu bar is an ordinary screen
9702 line, and this makes it get updated. */
9703 w
->update_mode_line
= Qt
;
9704 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9705 /* In the non-toolkit version, the menu bar is an ordinary screen
9706 line, and this makes it get updated. */
9707 w
->update_mode_line
= Qt
;
9708 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9710 unbind_to (count
, Qnil
);
9711 set_buffer_internal_1 (prev
);
9720 /***********************************************************************
9722 ***********************************************************************/
9724 #ifdef HAVE_WINDOW_SYSTEM
9727 Nominal cursor position -- where to draw output.
9728 HPOS and VPOS are window relative glyph matrix coordinates.
9729 X and Y are window relative pixel coordinates. */
9731 struct cursor_pos output_cursor
;
9735 Set the global variable output_cursor to CURSOR. All cursor
9736 positions are relative to updated_window. */
9739 set_output_cursor (cursor
)
9740 struct cursor_pos
*cursor
;
9742 output_cursor
.hpos
= cursor
->hpos
;
9743 output_cursor
.vpos
= cursor
->vpos
;
9744 output_cursor
.x
= cursor
->x
;
9745 output_cursor
.y
= cursor
->y
;
9750 Set a nominal cursor position.
9752 HPOS and VPOS are column/row positions in a window glyph matrix. X
9753 and Y are window text area relative pixel positions.
9755 If this is done during an update, updated_window will contain the
9756 window that is being updated and the position is the future output
9757 cursor position for that window. If updated_window is null, use
9758 selected_window and display the cursor at the given position. */
9761 x_cursor_to (vpos
, hpos
, y
, x
)
9762 int vpos
, hpos
, y
, x
;
9766 /* If updated_window is not set, work on selected_window. */
9770 w
= XWINDOW (selected_window
);
9772 /* Set the output cursor. */
9773 output_cursor
.hpos
= hpos
;
9774 output_cursor
.vpos
= vpos
;
9775 output_cursor
.x
= x
;
9776 output_cursor
.y
= y
;
9778 /* If not called as part of an update, really display the cursor.
9779 This will also set the cursor position of W. */
9780 if (updated_window
== NULL
)
9783 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
9784 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
9785 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
9790 #endif /* HAVE_WINDOW_SYSTEM */
9793 /***********************************************************************
9795 ***********************************************************************/
9797 #ifdef HAVE_WINDOW_SYSTEM
9799 /* Where the mouse was last time we reported a mouse event. */
9801 FRAME_PTR last_mouse_frame
;
9803 /* Tool-bar item index of the item on which a mouse button was pressed
9806 int last_tool_bar_item
;
9810 update_tool_bar_unwind (frame
)
9813 selected_frame
= frame
;
9817 /* Update the tool-bar item list for frame F. This has to be done
9818 before we start to fill in any display lines. Called from
9819 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
9820 and restore it here. */
9823 update_tool_bar (f
, save_match_data
)
9825 int save_match_data
;
9827 #if defined (USE_GTK) || defined (HAVE_NS)
9828 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
9830 int do_update
= WINDOWP (f
->tool_bar_window
)
9831 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
9839 window
= FRAME_SELECTED_WINDOW (f
);
9840 w
= XWINDOW (window
);
9842 /* If the user has switched buffers or windows, we need to
9843 recompute to reflect the new bindings. But we'll
9844 recompute when update_mode_lines is set too; that means
9845 that people can use force-mode-line-update to request
9846 that the menu bar be recomputed. The adverse effect on
9847 the rest of the redisplay algorithm is about the same as
9848 windows_or_buffers_changed anyway. */
9849 if (windows_or_buffers_changed
9850 || !NILP (w
->update_mode_line
)
9851 || update_mode_lines
9852 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9853 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9854 != !NILP (w
->last_had_star
))
9855 || ((!NILP (Vtransient_mark_mode
)
9856 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
9857 != !NILP (w
->region_showing
)))
9859 struct buffer
*prev
= current_buffer
;
9860 int count
= SPECPDL_INDEX ();
9861 Lisp_Object frame
, new_tool_bar
;
9863 struct gcpro gcpro1
;
9865 /* Set current_buffer to the buffer of the selected
9866 window of the frame, so that we get the right local
9868 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9870 /* Save match data, if we must. */
9871 if (save_match_data
)
9872 record_unwind_save_match_data ();
9874 /* Make sure that we don't accidentally use bogus keymaps. */
9875 if (NILP (Voverriding_local_map_menu_flag
))
9877 specbind (Qoverriding_terminal_local_map
, Qnil
);
9878 specbind (Qoverriding_local_map
, Qnil
);
9881 GCPRO1 (new_tool_bar
);
9883 /* We must temporarily set the selected frame to this frame
9884 before calling tool_bar_items, because the calculation of
9885 the tool-bar keymap uses the selected frame (see
9886 `tool-bar-make-keymap' in tool-bar.el). */
9887 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
9888 XSETFRAME (frame
, f
);
9889 selected_frame
= frame
;
9891 /* Build desired tool-bar items from keymaps. */
9892 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
9895 /* Redisplay the tool-bar if we changed it. */
9896 if (new_n_tool_bar
!= f
->n_tool_bar_items
9897 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
9899 /* Redisplay that happens asynchronously due to an expose event
9900 may access f->tool_bar_items. Make sure we update both
9901 variables within BLOCK_INPUT so no such event interrupts. */
9903 f
->tool_bar_items
= new_tool_bar
;
9904 f
->n_tool_bar_items
= new_n_tool_bar
;
9905 w
->update_mode_line
= Qt
;
9911 unbind_to (count
, Qnil
);
9912 set_buffer_internal_1 (prev
);
9918 /* Set F->desired_tool_bar_string to a Lisp string representing frame
9919 F's desired tool-bar contents. F->tool_bar_items must have
9920 been set up previously by calling prepare_menu_bars. */
9923 build_desired_tool_bar_string (f
)
9926 int i
, size
, size_needed
;
9927 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9928 Lisp_Object image
, plist
, props
;
9930 image
= plist
= props
= Qnil
;
9931 GCPRO3 (image
, plist
, props
);
9933 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
9934 Otherwise, make a new string. */
9936 /* The size of the string we might be able to reuse. */
9937 size
= (STRINGP (f
->desired_tool_bar_string
)
9938 ? SCHARS (f
->desired_tool_bar_string
)
9941 /* We need one space in the string for each image. */
9942 size_needed
= f
->n_tool_bar_items
;
9944 /* Reuse f->desired_tool_bar_string, if possible. */
9945 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
9946 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
9950 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
9951 Fremove_text_properties (make_number (0), make_number (size
),
9952 props
, f
->desired_tool_bar_string
);
9955 /* Put a `display' property on the string for the images to display,
9956 put a `menu_item' property on tool-bar items with a value that
9957 is the index of the item in F's tool-bar item vector. */
9958 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
9960 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
9962 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
9963 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
9964 int hmargin
, vmargin
, relief
, idx
, end
;
9965 extern Lisp_Object QCrelief
, QCmargin
, QCconversion
;
9967 /* If image is a vector, choose the image according to the
9969 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
9970 if (VECTORP (image
))
9974 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
9975 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
9978 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
9979 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
9981 xassert (ASIZE (image
) >= idx
);
9982 image
= AREF (image
, idx
);
9987 /* Ignore invalid image specifications. */
9988 if (!valid_image_p (image
))
9991 /* Display the tool-bar button pressed, or depressed. */
9992 plist
= Fcopy_sequence (XCDR (image
));
9994 /* Compute margin and relief to draw. */
9995 relief
= (tool_bar_button_relief
>= 0
9996 ? tool_bar_button_relief
9997 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
9998 hmargin
= vmargin
= relief
;
10000 if (INTEGERP (Vtool_bar_button_margin
)
10001 && XINT (Vtool_bar_button_margin
) > 0)
10003 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
10004 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
10006 else if (CONSP (Vtool_bar_button_margin
))
10008 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
10009 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
10010 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
10012 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
10013 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
10014 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
10017 if (auto_raise_tool_bar_buttons_p
)
10019 /* Add a `:relief' property to the image spec if the item is
10023 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
10030 /* If image is selected, display it pressed, i.e. with a
10031 negative relief. If it's not selected, display it with a
10033 plist
= Fplist_put (plist
, QCrelief
,
10035 ? make_number (-relief
)
10036 : make_number (relief
)));
10041 /* Put a margin around the image. */
10042 if (hmargin
|| vmargin
)
10044 if (hmargin
== vmargin
)
10045 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
10047 plist
= Fplist_put (plist
, QCmargin
,
10048 Fcons (make_number (hmargin
),
10049 make_number (vmargin
)));
10052 /* If button is not enabled, and we don't have special images
10053 for the disabled state, make the image appear disabled by
10054 applying an appropriate algorithm to it. */
10055 if (!enabled_p
&& idx
< 0)
10056 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
10058 /* Put a `display' text property on the string for the image to
10059 display. Put a `menu-item' property on the string that gives
10060 the start of this item's properties in the tool-bar items
10062 image
= Fcons (Qimage
, plist
);
10063 props
= list4 (Qdisplay
, image
,
10064 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
10066 /* Let the last image hide all remaining spaces in the tool bar
10067 string. The string can be longer than needed when we reuse a
10068 previous string. */
10069 if (i
+ 1 == f
->n_tool_bar_items
)
10070 end
= SCHARS (f
->desired_tool_bar_string
);
10073 Fadd_text_properties (make_number (i
), make_number (end
),
10074 props
, f
->desired_tool_bar_string
);
10082 /* Display one line of the tool-bar of frame IT->f.
10084 HEIGHT specifies the desired height of the tool-bar line.
10085 If the actual height of the glyph row is less than HEIGHT, the
10086 row's height is increased to HEIGHT, and the icons are centered
10087 vertically in the new height.
10089 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
10090 count a final empty row in case the tool-bar width exactly matches
10095 display_tool_bar_line (it
, height
)
10099 struct glyph_row
*row
= it
->glyph_row
;
10100 int max_x
= it
->last_visible_x
;
10101 struct glyph
*last
;
10103 prepare_desired_row (row
);
10104 row
->y
= it
->current_y
;
10106 /* Note that this isn't made use of if the face hasn't a box,
10107 so there's no need to check the face here. */
10108 it
->start_of_box_run_p
= 1;
10110 while (it
->current_x
< max_x
)
10112 int x
, n_glyphs_before
, i
, nglyphs
;
10113 struct it it_before
;
10115 /* Get the next display element. */
10116 if (!get_next_display_element (it
))
10118 /* Don't count empty row if we are counting needed tool-bar lines. */
10119 if (height
< 0 && !it
->hpos
)
10124 /* Produce glyphs. */
10125 n_glyphs_before
= row
->used
[TEXT_AREA
];
10128 PRODUCE_GLYPHS (it
);
10130 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
10132 x
= it_before
.current_x
;
10133 while (i
< nglyphs
)
10135 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
10137 if (x
+ glyph
->pixel_width
> max_x
)
10139 /* Glyph doesn't fit on line. Backtrack. */
10140 row
->used
[TEXT_AREA
] = n_glyphs_before
;
10142 /* If this is the only glyph on this line, it will never fit on the
10143 toolbar, so skip it. But ensure there is at least one glyph,
10144 so we don't accidentally disable the tool-bar. */
10145 if (n_glyphs_before
== 0
10146 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
10152 x
+= glyph
->pixel_width
;
10156 /* Stop at line ends. */
10157 if (ITERATOR_AT_END_OF_LINE_P (it
))
10160 set_iterator_to_next (it
, 1);
10165 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
10167 /* Use default face for the border below the tool bar.
10169 FIXME: When auto-resize-tool-bars is grow-only, there is
10170 no additional border below the possibly empty tool-bar lines.
10171 So to make the extra empty lines look "normal", we have to
10172 use the tool-bar face for the border too. */
10173 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
10174 it
->face_id
= DEFAULT_FACE_ID
;
10176 extend_face_to_end_of_line (it
);
10177 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
10178 last
->right_box_line_p
= 1;
10179 if (last
== row
->glyphs
[TEXT_AREA
])
10180 last
->left_box_line_p
= 1;
10182 /* Make line the desired height and center it vertically. */
10183 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
10185 /* Don't add more than one line height. */
10186 height
%= FRAME_LINE_HEIGHT (it
->f
);
10187 it
->max_ascent
+= height
/ 2;
10188 it
->max_descent
+= (height
+ 1) / 2;
10191 compute_line_metrics (it
);
10193 /* If line is empty, make it occupy the rest of the tool-bar. */
10194 if (!row
->displays_text_p
)
10196 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
10197 row
->visible_height
= row
->height
;
10198 row
->ascent
= row
->phys_ascent
= 0;
10199 row
->extra_line_spacing
= 0;
10202 row
->full_width_p
= 1;
10203 row
->continued_p
= 0;
10204 row
->truncated_on_left_p
= 0;
10205 row
->truncated_on_right_p
= 0;
10207 it
->current_x
= it
->hpos
= 0;
10208 it
->current_y
+= row
->height
;
10214 /* Max tool-bar height. */
10216 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
10217 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
10219 /* Value is the number of screen lines needed to make all tool-bar
10220 items of frame F visible. The number of actual rows needed is
10221 returned in *N_ROWS if non-NULL. */
10224 tool_bar_lines_needed (f
, n_rows
)
10228 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10230 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
10231 the desired matrix, so use (unused) mode-line row as temporary row to
10232 avoid destroying the first tool-bar row. */
10233 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
10235 /* Initialize an iterator for iteration over
10236 F->desired_tool_bar_string in the tool-bar window of frame F. */
10237 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
10238 it
.first_visible_x
= 0;
10239 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10240 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10242 while (!ITERATOR_AT_END_P (&it
))
10244 clear_glyph_row (temp_row
);
10245 it
.glyph_row
= temp_row
;
10246 display_tool_bar_line (&it
, -1);
10248 clear_glyph_row (temp_row
);
10250 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
10252 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
10254 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
10258 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
10260 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
10269 frame
= selected_frame
;
10271 CHECK_FRAME (frame
);
10272 f
= XFRAME (frame
);
10274 if (WINDOWP (f
->tool_bar_window
)
10275 || (w
= XWINDOW (f
->tool_bar_window
),
10276 WINDOW_TOTAL_LINES (w
) > 0))
10278 update_tool_bar (f
, 1);
10279 if (f
->n_tool_bar_items
)
10281 build_desired_tool_bar_string (f
);
10282 nlines
= tool_bar_lines_needed (f
, NULL
);
10286 return make_number (nlines
);
10290 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
10291 height should be changed. */
10294 redisplay_tool_bar (f
)
10299 struct glyph_row
*row
;
10301 #if defined (USE_GTK) || defined (HAVE_NS)
10302 if (FRAME_EXTERNAL_TOOL_BAR (f
))
10303 update_frame_tool_bar (f
);
10307 /* If frame hasn't a tool-bar window or if it is zero-height, don't
10308 do anything. This means you must start with tool-bar-lines
10309 non-zero to get the auto-sizing effect. Or in other words, you
10310 can turn off tool-bars by specifying tool-bar-lines zero. */
10311 if (!WINDOWP (f
->tool_bar_window
)
10312 || (w
= XWINDOW (f
->tool_bar_window
),
10313 WINDOW_TOTAL_LINES (w
) == 0))
10316 /* Set up an iterator for the tool-bar window. */
10317 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
10318 it
.first_visible_x
= 0;
10319 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10320 row
= it
.glyph_row
;
10322 /* Build a string that represents the contents of the tool-bar. */
10323 build_desired_tool_bar_string (f
);
10324 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10326 if (f
->n_tool_bar_rows
== 0)
10330 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
10331 nlines
!= WINDOW_TOTAL_LINES (w
)))
10333 extern Lisp_Object Qtool_bar_lines
;
10335 int old_height
= WINDOW_TOTAL_LINES (w
);
10337 XSETFRAME (frame
, f
);
10338 Fmodify_frame_parameters (frame
,
10339 Fcons (Fcons (Qtool_bar_lines
,
10340 make_number (nlines
)),
10342 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10344 clear_glyph_matrix (w
->desired_matrix
);
10345 fonts_changed_p
= 1;
10351 /* Display as many lines as needed to display all tool-bar items. */
10353 if (f
->n_tool_bar_rows
> 0)
10355 int border
, rows
, height
, extra
;
10357 if (INTEGERP (Vtool_bar_border
))
10358 border
= XINT (Vtool_bar_border
);
10359 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
10360 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
10361 else if (EQ (Vtool_bar_border
, Qborder_width
))
10362 border
= f
->border_width
;
10368 rows
= f
->n_tool_bar_rows
;
10369 height
= max (1, (it
.last_visible_y
- border
) / rows
);
10370 extra
= it
.last_visible_y
- border
- height
* rows
;
10372 while (it
.current_y
< it
.last_visible_y
)
10375 if (extra
> 0 && rows
-- > 0)
10377 h
= (extra
+ rows
- 1) / rows
;
10380 display_tool_bar_line (&it
, height
+ h
);
10385 while (it
.current_y
< it
.last_visible_y
)
10386 display_tool_bar_line (&it
, 0);
10389 /* It doesn't make much sense to try scrolling in the tool-bar
10390 window, so don't do it. */
10391 w
->desired_matrix
->no_scrolling_p
= 1;
10392 w
->must_be_updated_p
= 1;
10394 if (!NILP (Vauto_resize_tool_bars
))
10396 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
10397 int change_height_p
= 0;
10399 /* If we couldn't display everything, change the tool-bar's
10400 height if there is room for more. */
10401 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
10402 && it
.current_y
< max_tool_bar_height
)
10403 change_height_p
= 1;
10405 row
= it
.glyph_row
- 1;
10407 /* If there are blank lines at the end, except for a partially
10408 visible blank line at the end that is smaller than
10409 FRAME_LINE_HEIGHT, change the tool-bar's height. */
10410 if (!row
->displays_text_p
10411 && row
->height
>= FRAME_LINE_HEIGHT (f
))
10412 change_height_p
= 1;
10414 /* If row displays tool-bar items, but is partially visible,
10415 change the tool-bar's height. */
10416 if (row
->displays_text_p
10417 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
10418 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
10419 change_height_p
= 1;
10421 /* Resize windows as needed by changing the `tool-bar-lines'
10422 frame parameter. */
10423 if (change_height_p
)
10425 extern Lisp_Object Qtool_bar_lines
;
10427 int old_height
= WINDOW_TOTAL_LINES (w
);
10429 int nlines
= tool_bar_lines_needed (f
, &nrows
);
10431 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
10432 && !f
->minimize_tool_bar_window_p
)
10433 ? (nlines
> old_height
)
10434 : (nlines
!= old_height
));
10435 f
->minimize_tool_bar_window_p
= 0;
10437 if (change_height_p
)
10439 XSETFRAME (frame
, f
);
10440 Fmodify_frame_parameters (frame
,
10441 Fcons (Fcons (Qtool_bar_lines
,
10442 make_number (nlines
)),
10444 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10446 clear_glyph_matrix (w
->desired_matrix
);
10447 f
->n_tool_bar_rows
= nrows
;
10448 fonts_changed_p
= 1;
10455 f
->minimize_tool_bar_window_p
= 0;
10460 /* Get information about the tool-bar item which is displayed in GLYPH
10461 on frame F. Return in *PROP_IDX the index where tool-bar item
10462 properties start in F->tool_bar_items. Value is zero if
10463 GLYPH doesn't display a tool-bar item. */
10466 tool_bar_item_info (f
, glyph
, prop_idx
)
10468 struct glyph
*glyph
;
10475 /* This function can be called asynchronously, which means we must
10476 exclude any possibility that Fget_text_property signals an
10478 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
10479 charpos
= max (0, charpos
);
10481 /* Get the text property `menu-item' at pos. The value of that
10482 property is the start index of this item's properties in
10483 F->tool_bar_items. */
10484 prop
= Fget_text_property (make_number (charpos
),
10485 Qmenu_item
, f
->current_tool_bar_string
);
10486 if (INTEGERP (prop
))
10488 *prop_idx
= XINT (prop
);
10498 /* Get information about the tool-bar item at position X/Y on frame F.
10499 Return in *GLYPH a pointer to the glyph of the tool-bar item in
10500 the current matrix of the tool-bar window of F, or NULL if not
10501 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
10502 item in F->tool_bar_items. Value is
10504 -1 if X/Y is not on a tool-bar item
10505 0 if X/Y is on the same item that was highlighted before.
10509 get_tool_bar_item (f
, x
, y
, glyph
, hpos
, vpos
, prop_idx
)
10512 struct glyph
**glyph
;
10513 int *hpos
, *vpos
, *prop_idx
;
10515 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10516 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10519 /* Find the glyph under X/Y. */
10520 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
10521 if (*glyph
== NULL
)
10524 /* Get the start of this tool-bar item's properties in
10525 f->tool_bar_items. */
10526 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
10529 /* Is mouse on the highlighted item? */
10530 if (EQ (f
->tool_bar_window
, dpyinfo
->mouse_face_window
)
10531 && *vpos
>= dpyinfo
->mouse_face_beg_row
10532 && *vpos
<= dpyinfo
->mouse_face_end_row
10533 && (*vpos
> dpyinfo
->mouse_face_beg_row
10534 || *hpos
>= dpyinfo
->mouse_face_beg_col
)
10535 && (*vpos
< dpyinfo
->mouse_face_end_row
10536 || *hpos
< dpyinfo
->mouse_face_end_col
10537 || dpyinfo
->mouse_face_past_end
))
10545 Handle mouse button event on the tool-bar of frame F, at
10546 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
10547 0 for button release. MODIFIERS is event modifiers for button
10551 handle_tool_bar_click (f
, x
, y
, down_p
, modifiers
)
10554 unsigned int modifiers
;
10556 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10557 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10558 int hpos
, vpos
, prop_idx
;
10559 struct glyph
*glyph
;
10560 Lisp_Object enabled_p
;
10562 /* If not on the highlighted tool-bar item, return. */
10563 frame_to_window_pixel_xy (w
, &x
, &y
);
10564 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
10567 /* If item is disabled, do nothing. */
10568 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10569 if (NILP (enabled_p
))
10574 /* Show item in pressed state. */
10575 show_mouse_face (dpyinfo
, DRAW_IMAGE_SUNKEN
);
10576 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
10577 last_tool_bar_item
= prop_idx
;
10581 Lisp_Object key
, frame
;
10582 struct input_event event
;
10583 EVENT_INIT (event
);
10585 /* Show item in released state. */
10586 show_mouse_face (dpyinfo
, DRAW_IMAGE_RAISED
);
10587 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
10589 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
10591 XSETFRAME (frame
, f
);
10592 event
.kind
= TOOL_BAR_EVENT
;
10593 event
.frame_or_window
= frame
;
10595 kbd_buffer_store_event (&event
);
10597 event
.kind
= TOOL_BAR_EVENT
;
10598 event
.frame_or_window
= frame
;
10600 event
.modifiers
= modifiers
;
10601 kbd_buffer_store_event (&event
);
10602 last_tool_bar_item
= -1;
10607 /* Possibly highlight a tool-bar item on frame F when mouse moves to
10608 tool-bar window-relative coordinates X/Y. Called from
10609 note_mouse_highlight. */
10612 note_tool_bar_highlight (f
, x
, y
)
10616 Lisp_Object window
= f
->tool_bar_window
;
10617 struct window
*w
= XWINDOW (window
);
10618 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10620 struct glyph
*glyph
;
10621 struct glyph_row
*row
;
10623 Lisp_Object enabled_p
;
10625 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
10626 int mouse_down_p
, rc
;
10628 /* Function note_mouse_highlight is called with negative x(y
10629 values when mouse moves outside of the frame. */
10630 if (x
<= 0 || y
<= 0)
10632 clear_mouse_face (dpyinfo
);
10636 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
10639 /* Not on tool-bar item. */
10640 clear_mouse_face (dpyinfo
);
10644 /* On same tool-bar item as before. */
10645 goto set_help_echo
;
10647 clear_mouse_face (dpyinfo
);
10649 /* Mouse is down, but on different tool-bar item? */
10650 mouse_down_p
= (dpyinfo
->grabbed
10651 && f
== last_mouse_frame
10652 && FRAME_LIVE_P (f
));
10654 && last_tool_bar_item
!= prop_idx
)
10657 dpyinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
10658 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
10660 /* If tool-bar item is not enabled, don't highlight it. */
10661 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10662 if (!NILP (enabled_p
))
10664 /* Compute the x-position of the glyph. In front and past the
10665 image is a space. We include this in the highlighted area. */
10666 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
10667 for (i
= x
= 0; i
< hpos
; ++i
)
10668 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
10670 /* Record this as the current active region. */
10671 dpyinfo
->mouse_face_beg_col
= hpos
;
10672 dpyinfo
->mouse_face_beg_row
= vpos
;
10673 dpyinfo
->mouse_face_beg_x
= x
;
10674 dpyinfo
->mouse_face_beg_y
= row
->y
;
10675 dpyinfo
->mouse_face_past_end
= 0;
10677 dpyinfo
->mouse_face_end_col
= hpos
+ 1;
10678 dpyinfo
->mouse_face_end_row
= vpos
;
10679 dpyinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
10680 dpyinfo
->mouse_face_end_y
= row
->y
;
10681 dpyinfo
->mouse_face_window
= window
;
10682 dpyinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
10684 /* Display it as active. */
10685 show_mouse_face (dpyinfo
, draw
);
10686 dpyinfo
->mouse_face_image_state
= draw
;
10691 /* Set help_echo_string to a help string to display for this tool-bar item.
10692 XTread_socket does the rest. */
10693 help_echo_object
= help_echo_window
= Qnil
;
10694 help_echo_pos
= -1;
10695 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
10696 if (NILP (help_echo_string
))
10697 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
10700 #endif /* HAVE_WINDOW_SYSTEM */
10704 /************************************************************************
10705 Horizontal scrolling
10706 ************************************************************************/
10708 static int hscroll_window_tree
P_ ((Lisp_Object
));
10709 static int hscroll_windows
P_ ((Lisp_Object
));
10711 /* For all leaf windows in the window tree rooted at WINDOW, set their
10712 hscroll value so that PT is (i) visible in the window, and (ii) so
10713 that it is not within a certain margin at the window's left and
10714 right border. Value is non-zero if any window's hscroll has been
10718 hscroll_window_tree (window
)
10719 Lisp_Object window
;
10721 int hscrolled_p
= 0;
10722 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
10723 int hscroll_step_abs
= 0;
10724 double hscroll_step_rel
= 0;
10726 if (hscroll_relative_p
)
10728 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
10729 if (hscroll_step_rel
< 0)
10731 hscroll_relative_p
= 0;
10732 hscroll_step_abs
= 0;
10735 else if (INTEGERP (Vhscroll_step
))
10737 hscroll_step_abs
= XINT (Vhscroll_step
);
10738 if (hscroll_step_abs
< 0)
10739 hscroll_step_abs
= 0;
10742 hscroll_step_abs
= 0;
10744 while (WINDOWP (window
))
10746 struct window
*w
= XWINDOW (window
);
10748 if (WINDOWP (w
->hchild
))
10749 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
10750 else if (WINDOWP (w
->vchild
))
10751 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
10752 else if (w
->cursor
.vpos
>= 0)
10755 int text_area_width
;
10756 struct glyph_row
*current_cursor_row
10757 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
10758 struct glyph_row
*desired_cursor_row
10759 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
10760 struct glyph_row
*cursor_row
10761 = (desired_cursor_row
->enabled_p
10762 ? desired_cursor_row
10763 : current_cursor_row
);
10765 text_area_width
= window_box_width (w
, TEXT_AREA
);
10767 /* Scroll when cursor is inside this scroll margin. */
10768 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
10770 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
10771 && ((XFASTINT (w
->hscroll
)
10772 && w
->cursor
.x
<= h_margin
)
10773 || (cursor_row
->enabled_p
10774 && cursor_row
->truncated_on_right_p
10775 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
10779 struct buffer
*saved_current_buffer
;
10783 /* Find point in a display of infinite width. */
10784 saved_current_buffer
= current_buffer
;
10785 current_buffer
= XBUFFER (w
->buffer
);
10787 if (w
== XWINDOW (selected_window
))
10788 pt
= BUF_PT (current_buffer
);
10791 pt
= marker_position (w
->pointm
);
10792 pt
= max (BEGV
, pt
);
10796 /* Move iterator to pt starting at cursor_row->start in
10797 a line with infinite width. */
10798 init_to_row_start (&it
, w
, cursor_row
);
10799 it
.last_visible_x
= INFINITY
;
10800 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
10801 current_buffer
= saved_current_buffer
;
10803 /* Position cursor in window. */
10804 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
10805 hscroll
= max (0, (it
.current_x
10806 - (ITERATOR_AT_END_OF_LINE_P (&it
)
10807 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
10808 : (text_area_width
/ 2))))
10809 / FRAME_COLUMN_WIDTH (it
.f
);
10810 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
10812 if (hscroll_relative_p
)
10813 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
10816 wanted_x
= text_area_width
10817 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10820 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10824 if (hscroll_relative_p
)
10825 wanted_x
= text_area_width
* hscroll_step_rel
10828 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10831 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10833 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
10835 /* Don't call Fset_window_hscroll if value hasn't
10836 changed because it will prevent redisplay
10838 if (XFASTINT (w
->hscroll
) != hscroll
)
10840 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
10841 w
->hscroll
= make_number (hscroll
);
10850 /* Value is non-zero if hscroll of any leaf window has been changed. */
10851 return hscrolled_p
;
10855 /* Set hscroll so that cursor is visible and not inside horizontal
10856 scroll margins for all windows in the tree rooted at WINDOW. See
10857 also hscroll_window_tree above. Value is non-zero if any window's
10858 hscroll has been changed. If it has, desired matrices on the frame
10859 of WINDOW are cleared. */
10862 hscroll_windows (window
)
10863 Lisp_Object window
;
10865 int hscrolled_p
= hscroll_window_tree (window
);
10867 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
10868 return hscrolled_p
;
10873 /************************************************************************
10875 ************************************************************************/
10877 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
10878 to a non-zero value. This is sometimes handy to have in a debugger
10883 /* First and last unchanged row for try_window_id. */
10885 int debug_first_unchanged_at_end_vpos
;
10886 int debug_last_unchanged_at_beg_vpos
;
10888 /* Delta vpos and y. */
10890 int debug_dvpos
, debug_dy
;
10892 /* Delta in characters and bytes for try_window_id. */
10894 int debug_delta
, debug_delta_bytes
;
10896 /* Values of window_end_pos and window_end_vpos at the end of
10899 EMACS_INT debug_end_pos
, debug_end_vpos
;
10901 /* Append a string to W->desired_matrix->method. FMT is a printf
10902 format string. A1...A9 are a supplement for a variable-length
10903 argument list. If trace_redisplay_p is non-zero also printf the
10904 resulting string to stderr. */
10907 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
10910 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
10913 char *method
= w
->desired_matrix
->method
;
10914 int len
= strlen (method
);
10915 int size
= sizeof w
->desired_matrix
->method
;
10916 int remaining
= size
- len
- 1;
10918 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
10919 if (len
&& remaining
)
10922 --remaining
, ++len
;
10925 strncpy (method
+ len
, buffer
, remaining
);
10927 if (trace_redisplay_p
)
10928 fprintf (stderr
, "%p (%s): %s\n",
10930 ((BUFFERP (w
->buffer
)
10931 && STRINGP (XBUFFER (w
->buffer
)->name
))
10932 ? (char *) SDATA (XBUFFER (w
->buffer
)->name
)
10937 #endif /* GLYPH_DEBUG */
10940 /* Value is non-zero if all changes in window W, which displays
10941 current_buffer, are in the text between START and END. START is a
10942 buffer position, END is given as a distance from Z. Used in
10943 redisplay_internal for display optimization. */
10946 text_outside_line_unchanged_p (w
, start
, end
)
10950 int unchanged_p
= 1;
10952 /* If text or overlays have changed, see where. */
10953 if (XFASTINT (w
->last_modified
) < MODIFF
10954 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
10956 /* Gap in the line? */
10957 if (GPT
< start
|| Z
- GPT
< end
)
10960 /* Changes start in front of the line, or end after it? */
10962 && (BEG_UNCHANGED
< start
- 1
10963 || END_UNCHANGED
< end
))
10966 /* If selective display, can't optimize if changes start at the
10967 beginning of the line. */
10969 && INTEGERP (current_buffer
->selective_display
)
10970 && XINT (current_buffer
->selective_display
) > 0
10971 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
10974 /* If there are overlays at the start or end of the line, these
10975 may have overlay strings with newlines in them. A change at
10976 START, for instance, may actually concern the display of such
10977 overlay strings as well, and they are displayed on different
10978 lines. So, quickly rule out this case. (For the future, it
10979 might be desirable to implement something more telling than
10980 just BEG/END_UNCHANGED.) */
10983 if (BEG
+ BEG_UNCHANGED
== start
10984 && overlay_touches_p (start
))
10986 if (END_UNCHANGED
== end
10987 && overlay_touches_p (Z
- end
))
10992 return unchanged_p
;
10996 /* Do a frame update, taking possible shortcuts into account. This is
10997 the main external entry point for redisplay.
10999 If the last redisplay displayed an echo area message and that message
11000 is no longer requested, we clear the echo area or bring back the
11001 mini-buffer if that is in use. */
11006 redisplay_internal (0);
11011 overlay_arrow_string_or_property (var
)
11016 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
11019 return Voverlay_arrow_string
;
11022 /* Return 1 if there are any overlay-arrows in current_buffer. */
11024 overlay_arrow_in_current_buffer_p ()
11028 for (vlist
= Voverlay_arrow_variable_list
;
11030 vlist
= XCDR (vlist
))
11032 Lisp_Object var
= XCAR (vlist
);
11035 if (!SYMBOLP (var
))
11037 val
= find_symbol_value (var
);
11039 && current_buffer
== XMARKER (val
)->buffer
)
11046 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
11050 overlay_arrows_changed_p ()
11054 for (vlist
= Voverlay_arrow_variable_list
;
11056 vlist
= XCDR (vlist
))
11058 Lisp_Object var
= XCAR (vlist
);
11059 Lisp_Object val
, pstr
;
11061 if (!SYMBOLP (var
))
11063 val
= find_symbol_value (var
);
11064 if (!MARKERP (val
))
11066 if (! EQ (COERCE_MARKER (val
),
11067 Fget (var
, Qlast_arrow_position
))
11068 || ! (pstr
= overlay_arrow_string_or_property (var
),
11069 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
11075 /* Mark overlay arrows to be updated on next redisplay. */
11078 update_overlay_arrows (up_to_date
)
11083 for (vlist
= Voverlay_arrow_variable_list
;
11085 vlist
= XCDR (vlist
))
11087 Lisp_Object var
= XCAR (vlist
);
11089 if (!SYMBOLP (var
))
11092 if (up_to_date
> 0)
11094 Lisp_Object val
= find_symbol_value (var
);
11095 Fput (var
, Qlast_arrow_position
,
11096 COERCE_MARKER (val
));
11097 Fput (var
, Qlast_arrow_string
,
11098 overlay_arrow_string_or_property (var
));
11100 else if (up_to_date
< 0
11101 || !NILP (Fget (var
, Qlast_arrow_position
)))
11103 Fput (var
, Qlast_arrow_position
, Qt
);
11104 Fput (var
, Qlast_arrow_string
, Qt
);
11110 /* Return overlay arrow string to display at row.
11111 Return integer (bitmap number) for arrow bitmap in left fringe.
11112 Return nil if no overlay arrow. */
11115 overlay_arrow_at_row (it
, row
)
11117 struct glyph_row
*row
;
11121 for (vlist
= Voverlay_arrow_variable_list
;
11123 vlist
= XCDR (vlist
))
11125 Lisp_Object var
= XCAR (vlist
);
11128 if (!SYMBOLP (var
))
11131 val
= find_symbol_value (var
);
11134 && current_buffer
== XMARKER (val
)->buffer
11135 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
11137 if (FRAME_WINDOW_P (it
->f
)
11138 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
11140 #ifdef HAVE_WINDOW_SYSTEM
11141 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
11144 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
11145 return make_number (fringe_bitmap
);
11148 return make_number (-1); /* Use default arrow bitmap */
11150 return overlay_arrow_string_or_property (var
);
11157 /* Return 1 if point moved out of or into a composition. Otherwise
11158 return 0. PREV_BUF and PREV_PT are the last point buffer and
11159 position. BUF and PT are the current point buffer and position. */
11162 check_point_in_composition (prev_buf
, prev_pt
, buf
, pt
)
11163 struct buffer
*prev_buf
, *buf
;
11166 EMACS_INT start
, end
;
11168 Lisp_Object buffer
;
11170 XSETBUFFER (buffer
, buf
);
11171 /* Check a composition at the last point if point moved within the
11173 if (prev_buf
== buf
)
11176 /* Point didn't move. */
11179 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
11180 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
11181 && COMPOSITION_VALID_P (start
, end
, prop
)
11182 && start
< prev_pt
&& end
> prev_pt
)
11183 /* The last point was within the composition. Return 1 iff
11184 point moved out of the composition. */
11185 return (pt
<= start
|| pt
>= end
);
11188 /* Check a composition at the current point. */
11189 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
11190 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
11191 && COMPOSITION_VALID_P (start
, end
, prop
)
11192 && start
< pt
&& end
> pt
);
11196 /* Reconsider the setting of B->clip_changed which is displayed
11200 reconsider_clip_changes (w
, b
)
11204 if (b
->clip_changed
11205 && !NILP (w
->window_end_valid
)
11206 && w
->current_matrix
->buffer
== b
11207 && w
->current_matrix
->zv
== BUF_ZV (b
)
11208 && w
->current_matrix
->begv
== BUF_BEGV (b
))
11209 b
->clip_changed
= 0;
11211 /* If display wasn't paused, and W is not a tool bar window, see if
11212 point has been moved into or out of a composition. In that case,
11213 we set b->clip_changed to 1 to force updating the screen. If
11214 b->clip_changed has already been set to 1, we can skip this
11216 if (!b
->clip_changed
11217 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
11221 if (w
== XWINDOW (selected_window
))
11222 pt
= BUF_PT (current_buffer
);
11224 pt
= marker_position (w
->pointm
);
11226 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
11227 || pt
!= XINT (w
->last_point
))
11228 && check_point_in_composition (w
->current_matrix
->buffer
,
11229 XINT (w
->last_point
),
11230 XBUFFER (w
->buffer
), pt
))
11231 b
->clip_changed
= 1;
11236 /* Select FRAME to forward the values of frame-local variables into C
11237 variables so that the redisplay routines can access those values
11241 select_frame_for_redisplay (frame
)
11244 Lisp_Object tail
, symbol
, val
;
11245 Lisp_Object old
= selected_frame
;
11246 struct Lisp_Symbol
*sym
;
11248 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
11250 selected_frame
= frame
;
11254 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
11255 if (CONSP (XCAR (tail
))
11256 && (symbol
= XCAR (XCAR (tail
)),
11258 && (sym
= indirect_variable (XSYMBOL (symbol
)),
11260 (BUFFER_LOCAL_VALUEP (val
)))
11261 && XBUFFER_LOCAL_VALUE (val
)->check_frame
)
11262 /* Use find_symbol_value rather than Fsymbol_value
11263 to avoid an error if it is void. */
11264 find_symbol_value (symbol
);
11265 } while (!EQ (frame
, old
) && (frame
= old
, 1));
11269 #define STOP_POLLING \
11270 do { if (! polling_stopped_here) stop_polling (); \
11271 polling_stopped_here = 1; } while (0)
11273 #define RESUME_POLLING \
11274 do { if (polling_stopped_here) start_polling (); \
11275 polling_stopped_here = 0; } while (0)
11278 /* If PRESERVE_ECHO_AREA is nonzero, it means this redisplay is not in
11279 response to any user action; therefore, we should preserve the echo
11280 area. (Actually, our caller does that job.) Perhaps in the future
11281 avoid recentering windows if it is not necessary; currently that
11282 causes some problems. */
11285 redisplay_internal (preserve_echo_area
)
11286 int preserve_echo_area
;
11288 struct window
*w
= XWINDOW (selected_window
);
11291 int must_finish
= 0;
11292 struct text_pos tlbufpos
, tlendpos
;
11293 int number_of_visible_frames
;
11296 int polling_stopped_here
= 0;
11297 Lisp_Object old_frame
= selected_frame
;
11299 /* Non-zero means redisplay has to consider all windows on all
11300 frames. Zero means, only selected_window is considered. */
11301 int consider_all_windows_p
;
11303 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
11305 /* No redisplay if running in batch mode or frame is not yet fully
11306 initialized, or redisplay is explicitly turned off by setting
11307 Vinhibit_redisplay. */
11308 if (FRAME_INITIAL_P (SELECTED_FRAME ())
11309 || !NILP (Vinhibit_redisplay
))
11312 /* Don't examine these until after testing Vinhibit_redisplay.
11313 When Emacs is shutting down, perhaps because its connection to
11314 X has dropped, we should not look at them at all. */
11315 f
= XFRAME (w
->frame
);
11316 sf
= SELECTED_FRAME ();
11318 if (!f
->glyphs_initialized_p
)
11321 /* The flag redisplay_performed_directly_p is set by
11322 direct_output_for_insert when it already did the whole screen
11323 update necessary. */
11324 if (redisplay_performed_directly_p
)
11326 redisplay_performed_directly_p
= 0;
11327 if (!hscroll_windows (selected_window
))
11331 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
11332 if (popup_activated ())
11336 /* I don't think this happens but let's be paranoid. */
11337 if (redisplaying_p
)
11340 /* Record a function that resets redisplaying_p to its old value
11341 when we leave this function. */
11342 count
= SPECPDL_INDEX ();
11343 record_unwind_protect (unwind_redisplay
,
11344 Fcons (make_number (redisplaying_p
), selected_frame
));
11346 specbind (Qinhibit_free_realized_faces
, Qnil
);
11349 Lisp_Object tail
, frame
;
11351 FOR_EACH_FRAME (tail
, frame
)
11353 struct frame
*f
= XFRAME (frame
);
11354 f
->already_hscrolled_p
= 0;
11359 if (!EQ (old_frame
, selected_frame
)
11360 && FRAME_LIVE_P (XFRAME (old_frame
)))
11361 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
11362 selected_frame and selected_window to be temporarily out-of-sync so
11363 when we come back here via `goto retry', we need to resync because we
11364 may need to run Elisp code (via prepare_menu_bars). */
11365 select_frame_for_redisplay (old_frame
);
11368 reconsider_clip_changes (w
, current_buffer
);
11369 last_escape_glyph_frame
= NULL
;
11370 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
11372 /* If new fonts have been loaded that make a glyph matrix adjustment
11373 necessary, do it. */
11374 if (fonts_changed_p
)
11376 adjust_glyphs (NULL
);
11377 ++windows_or_buffers_changed
;
11378 fonts_changed_p
= 0;
11381 /* If face_change_count is non-zero, init_iterator will free all
11382 realized faces, which includes the faces referenced from current
11383 matrices. So, we can't reuse current matrices in this case. */
11384 if (face_change_count
)
11385 ++windows_or_buffers_changed
;
11387 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11388 && FRAME_TTY (sf
)->previous_frame
!= sf
)
11390 /* Since frames on a single ASCII terminal share the same
11391 display area, displaying a different frame means redisplay
11392 the whole thing. */
11393 windows_or_buffers_changed
++;
11394 SET_FRAME_GARBAGED (sf
);
11396 set_tty_color_mode (FRAME_TTY (sf
), sf
);
11398 FRAME_TTY (sf
)->previous_frame
= sf
;
11401 /* Set the visible flags for all frames. Do this before checking
11402 for resized or garbaged frames; they want to know if their frames
11403 are visible. See the comment in frame.h for
11404 FRAME_SAMPLE_VISIBILITY. */
11406 Lisp_Object tail
, frame
;
11408 number_of_visible_frames
= 0;
11410 FOR_EACH_FRAME (tail
, frame
)
11412 struct frame
*f
= XFRAME (frame
);
11414 FRAME_SAMPLE_VISIBILITY (f
);
11415 if (FRAME_VISIBLE_P (f
))
11416 ++number_of_visible_frames
;
11417 clear_desired_matrices (f
);
11421 /* Notice any pending interrupt request to change frame size. */
11422 do_pending_window_change (1);
11424 /* Clear frames marked as garbaged. */
11425 if (frame_garbaged
)
11426 clear_garbaged_frames ();
11428 /* Build menubar and tool-bar items. */
11429 if (NILP (Vmemory_full
))
11430 prepare_menu_bars ();
11432 if (windows_or_buffers_changed
)
11433 update_mode_lines
++;
11435 /* Detect case that we need to write or remove a star in the mode line. */
11436 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
11438 w
->update_mode_line
= Qt
;
11439 if (buffer_shared
> 1)
11440 update_mode_lines
++;
11443 /* Avoid invocation of point motion hooks by `current_column' below. */
11444 count1
= SPECPDL_INDEX ();
11445 specbind (Qinhibit_point_motion_hooks
, Qt
);
11447 /* If %c is in the mode line, update it if needed. */
11448 if (!NILP (w
->column_number_displayed
)
11449 /* This alternative quickly identifies a common case
11450 where no change is needed. */
11451 && !(PT
== XFASTINT (w
->last_point
)
11452 && XFASTINT (w
->last_modified
) >= MODIFF
11453 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
11454 && (XFASTINT (w
->column_number_displayed
)
11455 != (int) current_column ())) /* iftc */
11456 w
->update_mode_line
= Qt
;
11458 unbind_to (count1
, Qnil
);
11460 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
11462 /* The variable buffer_shared is set in redisplay_window and
11463 indicates that we redisplay a buffer in different windows. See
11465 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
11466 || cursor_type_changed
);
11468 /* If specs for an arrow have changed, do thorough redisplay
11469 to ensure we remove any arrow that should no longer exist. */
11470 if (overlay_arrows_changed_p ())
11471 consider_all_windows_p
= windows_or_buffers_changed
= 1;
11473 /* Normally the message* functions will have already displayed and
11474 updated the echo area, but the frame may have been trashed, or
11475 the update may have been preempted, so display the echo area
11476 again here. Checking message_cleared_p captures the case that
11477 the echo area should be cleared. */
11478 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
11479 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
11480 || (message_cleared_p
11481 && minibuf_level
== 0
11482 /* If the mini-window is currently selected, this means the
11483 echo-area doesn't show through. */
11484 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
11486 int window_height_changed_p
= echo_area_display (0);
11489 /* If we don't display the current message, don't clear the
11490 message_cleared_p flag, because, if we did, we wouldn't clear
11491 the echo area in the next redisplay which doesn't preserve
11493 if (!display_last_displayed_message_p
)
11494 message_cleared_p
= 0;
11496 if (fonts_changed_p
)
11498 else if (window_height_changed_p
)
11500 consider_all_windows_p
= 1;
11501 ++update_mode_lines
;
11502 ++windows_or_buffers_changed
;
11504 /* If window configuration was changed, frames may have been
11505 marked garbaged. Clear them or we will experience
11506 surprises wrt scrolling. */
11507 if (frame_garbaged
)
11508 clear_garbaged_frames ();
11511 else if (EQ (selected_window
, minibuf_window
)
11512 && (current_buffer
->clip_changed
11513 || XFASTINT (w
->last_modified
) < MODIFF
11514 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11515 && resize_mini_window (w
, 0))
11517 /* Resized active mini-window to fit the size of what it is
11518 showing if its contents might have changed. */
11520 /* FIXME: this causes all frames to be updated, which seems unnecessary
11521 since only the current frame needs to be considered. This function needs
11522 to be rewritten with two variables, consider_all_windows and
11523 consider_all_frames. */
11524 consider_all_windows_p
= 1;
11525 ++windows_or_buffers_changed
;
11526 ++update_mode_lines
;
11528 /* If window configuration was changed, frames may have been
11529 marked garbaged. Clear them or we will experience
11530 surprises wrt scrolling. */
11531 if (frame_garbaged
)
11532 clear_garbaged_frames ();
11536 /* If showing the region, and mark has changed, we must redisplay
11537 the whole window. The assignment to this_line_start_pos prevents
11538 the optimization directly below this if-statement. */
11539 if (((!NILP (Vtransient_mark_mode
)
11540 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
11541 != !NILP (w
->region_showing
))
11542 || (!NILP (w
->region_showing
)
11543 && !EQ (w
->region_showing
,
11544 Fmarker_position (XBUFFER (w
->buffer
)->mark
))))
11545 CHARPOS (this_line_start_pos
) = 0;
11547 /* Optimize the case that only the line containing the cursor in the
11548 selected window has changed. Variables starting with this_ are
11549 set in display_line and record information about the line
11550 containing the cursor. */
11551 tlbufpos
= this_line_start_pos
;
11552 tlendpos
= this_line_end_pos
;
11553 if (!consider_all_windows_p
11554 && CHARPOS (tlbufpos
) > 0
11555 && NILP (w
->update_mode_line
)
11556 && !current_buffer
->clip_changed
11557 && !current_buffer
->prevent_redisplay_optimizations_p
11558 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
11559 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
11560 /* Make sure recorded data applies to current buffer, etc. */
11561 && this_line_buffer
== current_buffer
11562 && current_buffer
== XBUFFER (w
->buffer
)
11563 && NILP (w
->force_start
)
11564 && NILP (w
->optional_new_start
)
11565 /* Point must be on the line that we have info recorded about. */
11566 && PT
>= CHARPOS (tlbufpos
)
11567 && PT
<= Z
- CHARPOS (tlendpos
)
11568 /* All text outside that line, including its final newline,
11569 must be unchanged. */
11570 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
11571 CHARPOS (tlendpos
)))
11573 if (CHARPOS (tlbufpos
) > BEGV
11574 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
11575 && (CHARPOS (tlbufpos
) == ZV
11576 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
11577 /* Former continuation line has disappeared by becoming empty. */
11579 else if (XFASTINT (w
->last_modified
) < MODIFF
11580 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
11581 || MINI_WINDOW_P (w
))
11583 /* We have to handle the case of continuation around a
11584 wide-column character (see the comment in indent.c around
11587 For instance, in the following case:
11589 -------- Insert --------
11590 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
11591 J_I_ ==> J_I_ `^^' are cursors.
11595 As we have to redraw the line above, we cannot use this
11599 int line_height_before
= this_line_pixel_height
;
11601 /* Note that start_display will handle the case that the
11602 line starting at tlbufpos is a continuation line. */
11603 start_display (&it
, w
, tlbufpos
);
11605 /* Implementation note: It this still necessary? */
11606 if (it
.current_x
!= this_line_start_x
)
11609 TRACE ((stderr
, "trying display optimization 1\n"));
11610 w
->cursor
.vpos
= -1;
11611 overlay_arrow_seen
= 0;
11612 it
.vpos
= this_line_vpos
;
11613 it
.current_y
= this_line_y
;
11614 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
11615 display_line (&it
);
11617 /* If line contains point, is not continued,
11618 and ends at same distance from eob as before, we win. */
11619 if (w
->cursor
.vpos
>= 0
11620 /* Line is not continued, otherwise this_line_start_pos
11621 would have been set to 0 in display_line. */
11622 && CHARPOS (this_line_start_pos
)
11623 /* Line ends as before. */
11624 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
11625 /* Line has same height as before. Otherwise other lines
11626 would have to be shifted up or down. */
11627 && this_line_pixel_height
== line_height_before
)
11629 /* If this is not the window's last line, we must adjust
11630 the charstarts of the lines below. */
11631 if (it
.current_y
< it
.last_visible_y
)
11633 struct glyph_row
*row
11634 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
11635 int delta
, delta_bytes
;
11637 /* We used to distinguish between two cases here,
11638 conditioned by Z - CHARPOS (tlendpos) == ZV, for
11639 when the line ends in a newline or the end of the
11640 buffer's accessible portion. But both cases did
11641 the same, so they were collapsed. */
11643 - CHARPOS (tlendpos
)
11644 - MATRIX_ROW_START_CHARPOS (row
));
11645 delta_bytes
= (Z_BYTE
11646 - BYTEPOS (tlendpos
)
11647 - MATRIX_ROW_START_BYTEPOS (row
));
11649 increment_matrix_positions (w
->current_matrix
,
11650 this_line_vpos
+ 1,
11651 w
->current_matrix
->nrows
,
11652 delta
, delta_bytes
);
11655 /* If this row displays text now but previously didn't,
11656 or vice versa, w->window_end_vpos may have to be
11658 if ((it
.glyph_row
- 1)->displays_text_p
)
11660 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
11661 XSETINT (w
->window_end_vpos
, this_line_vpos
);
11663 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
11664 && this_line_vpos
> 0)
11665 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
11666 w
->window_end_valid
= Qnil
;
11668 /* Update hint: No need to try to scroll in update_window. */
11669 w
->desired_matrix
->no_scrolling_p
= 1;
11672 *w
->desired_matrix
->method
= 0;
11673 debug_method_add (w
, "optimization 1");
11675 #ifdef HAVE_WINDOW_SYSTEM
11676 update_window_fringes (w
, 0);
11683 else if (/* Cursor position hasn't changed. */
11684 PT
== XFASTINT (w
->last_point
)
11685 /* Make sure the cursor was last displayed
11686 in this window. Otherwise we have to reposition it. */
11687 && 0 <= w
->cursor
.vpos
11688 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
11692 do_pending_window_change (1);
11694 /* We used to always goto end_of_redisplay here, but this
11695 isn't enough if we have a blinking cursor. */
11696 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
11697 goto end_of_redisplay
;
11701 /* If highlighting the region, or if the cursor is in the echo area,
11702 then we can't just move the cursor. */
11703 else if (! (!NILP (Vtransient_mark_mode
)
11704 && !NILP (current_buffer
->mark_active
))
11705 && (EQ (selected_window
, current_buffer
->last_selected_window
)
11706 || highlight_nonselected_windows
)
11707 && NILP (w
->region_showing
)
11708 && NILP (Vshow_trailing_whitespace
)
11709 && !cursor_in_echo_area
)
11712 struct glyph_row
*row
;
11714 /* Skip from tlbufpos to PT and see where it is. Note that
11715 PT may be in invisible text. If so, we will end at the
11716 next visible position. */
11717 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
11718 NULL
, DEFAULT_FACE_ID
);
11719 it
.current_x
= this_line_start_x
;
11720 it
.current_y
= this_line_y
;
11721 it
.vpos
= this_line_vpos
;
11723 /* The call to move_it_to stops in front of PT, but
11724 moves over before-strings. */
11725 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
11727 if (it
.vpos
== this_line_vpos
11728 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
11731 xassert (this_line_vpos
== it
.vpos
);
11732 xassert (this_line_y
== it
.current_y
);
11733 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
11735 *w
->desired_matrix
->method
= 0;
11736 debug_method_add (w
, "optimization 3");
11745 /* Text changed drastically or point moved off of line. */
11746 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
11749 CHARPOS (this_line_start_pos
) = 0;
11750 consider_all_windows_p
|= buffer_shared
> 1;
11751 ++clear_face_cache_count
;
11752 #ifdef HAVE_WINDOW_SYSTEM
11753 ++clear_image_cache_count
;
11756 /* Build desired matrices, and update the display. If
11757 consider_all_windows_p is non-zero, do it for all windows on all
11758 frames. Otherwise do it for selected_window, only. */
11760 if (consider_all_windows_p
)
11762 Lisp_Object tail
, frame
;
11764 FOR_EACH_FRAME (tail
, frame
)
11765 XFRAME (frame
)->updated_p
= 0;
11767 /* Recompute # windows showing selected buffer. This will be
11768 incremented each time such a window is displayed. */
11771 FOR_EACH_FRAME (tail
, frame
)
11773 struct frame
*f
= XFRAME (frame
);
11775 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
11777 if (! EQ (frame
, selected_frame
))
11778 /* Select the frame, for the sake of frame-local
11780 select_frame_for_redisplay (frame
);
11782 /* Mark all the scroll bars to be removed; we'll redeem
11783 the ones we want when we redisplay their windows. */
11784 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
11785 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
11787 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11788 redisplay_windows (FRAME_ROOT_WINDOW (f
));
11790 /* The X error handler may have deleted that frame. */
11791 if (!FRAME_LIVE_P (f
))
11794 /* Any scroll bars which redisplay_windows should have
11795 nuked should now go away. */
11796 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
11797 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
11799 /* If fonts changed, display again. */
11800 /* ??? rms: I suspect it is a mistake to jump all the way
11801 back to retry here. It should just retry this frame. */
11802 if (fonts_changed_p
)
11805 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11807 /* See if we have to hscroll. */
11808 if (!f
->already_hscrolled_p
)
11810 f
->already_hscrolled_p
= 1;
11811 if (hscroll_windows (f
->root_window
))
11815 /* Prevent various kinds of signals during display
11816 update. stdio is not robust about handling
11817 signals, which can cause an apparent I/O
11819 if (interrupt_input
)
11820 unrequest_sigio ();
11823 /* Update the display. */
11824 set_window_update_flags (XWINDOW (f
->root_window
), 1);
11825 pause
|= update_frame (f
, 0, 0);
11831 if (!EQ (old_frame
, selected_frame
)
11832 && FRAME_LIVE_P (XFRAME (old_frame
)))
11833 /* We played a bit fast-and-loose above and allowed selected_frame
11834 and selected_window to be temporarily out-of-sync but let's make
11835 sure this stays contained. */
11836 select_frame_for_redisplay (old_frame
);
11837 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
11841 /* Do the mark_window_display_accurate after all windows have
11842 been redisplayed because this call resets flags in buffers
11843 which are needed for proper redisplay. */
11844 FOR_EACH_FRAME (tail
, frame
)
11846 struct frame
*f
= XFRAME (frame
);
11849 mark_window_display_accurate (f
->root_window
, 1);
11850 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
11851 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
11856 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
11858 Lisp_Object mini_window
;
11859 struct frame
*mini_frame
;
11861 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
11862 /* Use list_of_error, not Qerror, so that
11863 we catch only errors and don't run the debugger. */
11864 internal_condition_case_1 (redisplay_window_1
, selected_window
,
11866 redisplay_window_error
);
11868 /* Compare desired and current matrices, perform output. */
11871 /* If fonts changed, display again. */
11872 if (fonts_changed_p
)
11875 /* Prevent various kinds of signals during display update.
11876 stdio is not robust about handling signals,
11877 which can cause an apparent I/O error. */
11878 if (interrupt_input
)
11879 unrequest_sigio ();
11882 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
11884 if (hscroll_windows (selected_window
))
11887 XWINDOW (selected_window
)->must_be_updated_p
= 1;
11888 pause
= update_frame (sf
, 0, 0);
11891 /* We may have called echo_area_display at the top of this
11892 function. If the echo area is on another frame, that may
11893 have put text on a frame other than the selected one, so the
11894 above call to update_frame would not have caught it. Catch
11896 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
11897 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
11899 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
11901 XWINDOW (mini_window
)->must_be_updated_p
= 1;
11902 pause
|= update_frame (mini_frame
, 0, 0);
11903 if (!pause
&& hscroll_windows (mini_window
))
11908 /* If display was paused because of pending input, make sure we do a
11909 thorough update the next time. */
11912 /* Prevent the optimization at the beginning of
11913 redisplay_internal that tries a single-line update of the
11914 line containing the cursor in the selected window. */
11915 CHARPOS (this_line_start_pos
) = 0;
11917 /* Let the overlay arrow be updated the next time. */
11918 update_overlay_arrows (0);
11920 /* If we pause after scrolling, some rows in the current
11921 matrices of some windows are not valid. */
11922 if (!WINDOW_FULL_WIDTH_P (w
)
11923 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
11924 update_mode_lines
= 1;
11928 if (!consider_all_windows_p
)
11930 /* This has already been done above if
11931 consider_all_windows_p is set. */
11932 mark_window_display_accurate_1 (w
, 1);
11934 /* Say overlay arrows are up to date. */
11935 update_overlay_arrows (1);
11937 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
11938 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
11941 update_mode_lines
= 0;
11942 windows_or_buffers_changed
= 0;
11943 cursor_type_changed
= 0;
11946 /* Start SIGIO interrupts coming again. Having them off during the
11947 code above makes it less likely one will discard output, but not
11948 impossible, since there might be stuff in the system buffer here.
11949 But it is much hairier to try to do anything about that. */
11950 if (interrupt_input
)
11954 /* If a frame has become visible which was not before, redisplay
11955 again, so that we display it. Expose events for such a frame
11956 (which it gets when becoming visible) don't call the parts of
11957 redisplay constructing glyphs, so simply exposing a frame won't
11958 display anything in this case. So, we have to display these
11959 frames here explicitly. */
11962 Lisp_Object tail
, frame
;
11965 FOR_EACH_FRAME (tail
, frame
)
11967 int this_is_visible
= 0;
11969 if (XFRAME (frame
)->visible
)
11970 this_is_visible
= 1;
11971 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
11972 if (XFRAME (frame
)->visible
)
11973 this_is_visible
= 1;
11975 if (this_is_visible
)
11979 if (new_count
!= number_of_visible_frames
)
11980 windows_or_buffers_changed
++;
11983 /* Change frame size now if a change is pending. */
11984 do_pending_window_change (1);
11986 /* If we just did a pending size change, or have additional
11987 visible frames, redisplay again. */
11988 if (windows_or_buffers_changed
&& !pause
)
11991 /* Clear the face cache eventually. */
11992 if (consider_all_windows_p
)
11994 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
11996 clear_face_cache (0);
11997 clear_face_cache_count
= 0;
11999 #ifdef HAVE_WINDOW_SYSTEM
12000 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
12002 clear_image_caches (Qnil
);
12003 clear_image_cache_count
= 0;
12005 #endif /* HAVE_WINDOW_SYSTEM */
12009 unbind_to (count
, Qnil
);
12014 /* Redisplay, but leave alone any recent echo area message unless
12015 another message has been requested in its place.
12017 This is useful in situations where you need to redisplay but no
12018 user action has occurred, making it inappropriate for the message
12019 area to be cleared. See tracking_off and
12020 wait_reading_process_output for examples of these situations.
12022 FROM_WHERE is an integer saying from where this function was
12023 called. This is useful for debugging. */
12026 redisplay_preserve_echo_area (from_where
)
12029 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
12031 if (!NILP (echo_area_buffer
[1]))
12033 /* We have a previously displayed message, but no current
12034 message. Redisplay the previous message. */
12035 display_last_displayed_message_p
= 1;
12036 redisplay_internal (1);
12037 display_last_displayed_message_p
= 0;
12040 redisplay_internal (1);
12042 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
12043 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
12044 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
12048 /* Function registered with record_unwind_protect in
12049 redisplay_internal. Reset redisplaying_p to the value it had
12050 before redisplay_internal was called, and clear
12051 prevent_freeing_realized_faces_p. It also selects the previously
12052 selected frame, unless it has been deleted (by an X connection
12053 failure during redisplay, for example). */
12056 unwind_redisplay (val
)
12059 Lisp_Object old_redisplaying_p
, old_frame
;
12061 old_redisplaying_p
= XCAR (val
);
12062 redisplaying_p
= XFASTINT (old_redisplaying_p
);
12063 old_frame
= XCDR (val
);
12064 if (! EQ (old_frame
, selected_frame
)
12065 && FRAME_LIVE_P (XFRAME (old_frame
)))
12066 select_frame_for_redisplay (old_frame
);
12071 /* Mark the display of window W as accurate or inaccurate. If
12072 ACCURATE_P is non-zero mark display of W as accurate. If
12073 ACCURATE_P is zero, arrange for W to be redisplayed the next time
12074 redisplay_internal is called. */
12077 mark_window_display_accurate_1 (w
, accurate_p
)
12081 if (BUFFERP (w
->buffer
))
12083 struct buffer
*b
= XBUFFER (w
->buffer
);
12086 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
12087 w
->last_overlay_modified
12088 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
12090 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
12094 b
->clip_changed
= 0;
12095 b
->prevent_redisplay_optimizations_p
= 0;
12097 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
12098 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
12099 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
12100 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
12102 w
->current_matrix
->buffer
= b
;
12103 w
->current_matrix
->begv
= BUF_BEGV (b
);
12104 w
->current_matrix
->zv
= BUF_ZV (b
);
12106 w
->last_cursor
= w
->cursor
;
12107 w
->last_cursor_off_p
= w
->cursor_off_p
;
12109 if (w
== XWINDOW (selected_window
))
12110 w
->last_point
= make_number (BUF_PT (b
));
12112 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
12118 w
->window_end_valid
= w
->buffer
;
12119 w
->update_mode_line
= Qnil
;
12124 /* Mark the display of windows in the window tree rooted at WINDOW as
12125 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
12126 windows as accurate. If ACCURATE_P is zero, arrange for windows to
12127 be redisplayed the next time redisplay_internal is called. */
12130 mark_window_display_accurate (window
, accurate_p
)
12131 Lisp_Object window
;
12136 for (; !NILP (window
); window
= w
->next
)
12138 w
= XWINDOW (window
);
12139 mark_window_display_accurate_1 (w
, accurate_p
);
12141 if (!NILP (w
->vchild
))
12142 mark_window_display_accurate (w
->vchild
, accurate_p
);
12143 if (!NILP (w
->hchild
))
12144 mark_window_display_accurate (w
->hchild
, accurate_p
);
12149 update_overlay_arrows (1);
12153 /* Force a thorough redisplay the next time by setting
12154 last_arrow_position and last_arrow_string to t, which is
12155 unequal to any useful value of Voverlay_arrow_... */
12156 update_overlay_arrows (-1);
12161 /* Return value in display table DP (Lisp_Char_Table *) for character
12162 C. Since a display table doesn't have any parent, we don't have to
12163 follow parent. Do not call this function directly but use the
12164 macro DISP_CHAR_VECTOR. */
12167 disp_char_vector (dp
, c
)
12168 struct Lisp_Char_Table
*dp
;
12173 if (ASCII_CHAR_P (c
))
12176 if (SUB_CHAR_TABLE_P (val
))
12177 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
12183 XSETCHAR_TABLE (table
, dp
);
12184 val
= char_table_ref (table
, c
);
12193 /***********************************************************************
12195 ***********************************************************************/
12197 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
12200 redisplay_windows (window
)
12201 Lisp_Object window
;
12203 while (!NILP (window
))
12205 struct window
*w
= XWINDOW (window
);
12207 if (!NILP (w
->hchild
))
12208 redisplay_windows (w
->hchild
);
12209 else if (!NILP (w
->vchild
))
12210 redisplay_windows (w
->vchild
);
12211 else if (!NILP (w
->buffer
))
12213 displayed_buffer
= XBUFFER (w
->buffer
);
12214 /* Use list_of_error, not Qerror, so that
12215 we catch only errors and don't run the debugger. */
12216 internal_condition_case_1 (redisplay_window_0
, window
,
12218 redisplay_window_error
);
12226 redisplay_window_error ()
12228 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
12233 redisplay_window_0 (window
)
12234 Lisp_Object window
;
12236 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12237 redisplay_window (window
, 0);
12242 redisplay_window_1 (window
)
12243 Lisp_Object window
;
12245 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12246 redisplay_window (window
, 1);
12251 /* Increment GLYPH until it reaches END or CONDITION fails while
12252 adding (GLYPH)->pixel_width to X. */
12254 #define SKIP_GLYPHS(glyph, end, x, condition) \
12257 (x) += (glyph)->pixel_width; \
12260 while ((glyph) < (end) && (condition))
12263 /* Set cursor position of W. PT is assumed to be displayed in ROW.
12264 DELTA and DELTA_BYTES are the numbers of characters and bytes by
12265 which positions recorded in ROW differ from current buffer
12268 Return 0 if cursor is not on this row, 1 otherwise. */
12271 set_cursor_from_row (w
, row
, matrix
, delta
, delta_bytes
, dy
, dvpos
)
12273 struct glyph_row
*row
;
12274 struct glyph_matrix
*matrix
;
12275 int delta
, delta_bytes
, dy
, dvpos
;
12277 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
12278 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
12279 struct glyph
*cursor
= NULL
;
12280 /* The first glyph that starts a sequence of glyphs from a string
12281 that is a value of a display property. */
12282 struct glyph
*string_start
;
12283 /* The X coordinate of string_start. */
12284 int string_start_x
;
12285 /* The last known character position in row. */
12286 int last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12287 /* The last known character position before string_start. */
12288 int string_before_pos
;
12291 /* Last buffer position covered by an overlay. */
12292 int cursor_from_overlay_pos
= 0;
12293 int pt_old
= PT
- delta
;
12295 /* Skip over glyphs not having an object at the start of the row.
12296 These are special glyphs like truncation marks on terminal
12298 if (row
->displays_text_p
)
12300 && INTEGERP (glyph
->object
)
12301 && glyph
->charpos
< 0)
12303 x
+= glyph
->pixel_width
;
12307 string_start
= NULL
;
12309 && !INTEGERP (glyph
->object
)
12310 && (!BUFFERP (glyph
->object
)
12311 || (last_pos
= glyph
->charpos
) < pt_old
12312 || glyph
->avoid_cursor_p
))
12314 if (! STRINGP (glyph
->object
))
12316 string_start
= NULL
;
12317 x
+= glyph
->pixel_width
;
12319 /* If we are beyond the cursor position computed from the
12320 last overlay seen, that overlay is not in effect for
12321 current cursor position. Reset the cursor information
12322 computed from that overlay. */
12323 if (cursor_from_overlay_pos
12324 && last_pos
>= cursor_from_overlay_pos
)
12326 cursor_from_overlay_pos
= 0;
12332 if (string_start
== NULL
)
12334 string_before_pos
= last_pos
;
12335 string_start
= glyph
;
12336 string_start_x
= x
;
12338 /* Skip all glyphs from a string. */
12343 if ((cursor
== NULL
|| glyph
> cursor
)
12344 && (cprop
= Fget_char_property (make_number ((glyph
)->charpos
),
12345 Qcursor
, (glyph
)->object
),
12347 && (pos
= string_buffer_position (w
, glyph
->object
,
12348 string_before_pos
),
12349 (pos
== 0 /* from overlay */
12350 || pos
== pt_old
)))
12352 /* Compute the first buffer position after the overlay.
12353 If the `cursor' property tells us how many positions
12354 are associated with the overlay, use that. Otherwise,
12355 estimate from the buffer positions of the glyphs
12356 before and after the overlay. */
12357 cursor_from_overlay_pos
= (pos
? 0 : last_pos
12358 + (INTEGERP (cprop
) ? XINT (cprop
) : 0));
12362 x
+= glyph
->pixel_width
;
12365 while (glyph
< end
&& EQ (glyph
->object
, string_start
->object
));
12369 if (cursor
!= NULL
)
12374 else if (row
->ends_in_ellipsis_p
&& glyph
== end
)
12376 /* Scan back over the ellipsis glyphs, decrementing positions. */
12377 while (glyph
> row
->glyphs
[TEXT_AREA
]
12378 && (glyph
- 1)->charpos
== last_pos
)
12379 glyph
--, x
-= glyph
->pixel_width
;
12380 /* That loop always goes one position too far, including the
12381 glyph before the ellipsis. So scan forward over that one. */
12382 x
+= glyph
->pixel_width
;
12385 else if (string_start
12386 && (glyph
== end
|| !BUFFERP (glyph
->object
) || last_pos
> pt_old
))
12388 /* We may have skipped over point because the previous glyphs
12389 are from string. As there's no easy way to know the
12390 character position of the current glyph, find the correct
12391 glyph on point by scanning from string_start again. */
12393 Lisp_Object string
;
12394 struct glyph
*stop
= glyph
;
12397 limit
= make_number (pt_old
+ 1);
12398 glyph
= string_start
;
12399 x
= string_start_x
;
12400 string
= glyph
->object
;
12401 pos
= string_buffer_position (w
, string
, string_before_pos
);
12402 /* If POS == 0, STRING is from overlay. We skip such glyphs
12403 because we always put the cursor after overlay strings. */
12404 while (pos
== 0 && glyph
< stop
)
12406 string
= glyph
->object
;
12407 SKIP_GLYPHS (glyph
, stop
, x
, EQ (glyph
->object
, string
));
12409 pos
= string_buffer_position (w
, glyph
->object
, string_before_pos
);
12412 while (glyph
< stop
)
12414 pos
= XINT (Fnext_single_char_property_change
12415 (make_number (pos
), Qdisplay
, Qnil
, limit
));
12418 /* Skip glyphs from the same string. */
12419 string
= glyph
->object
;
12420 SKIP_GLYPHS (glyph
, stop
, x
, EQ (glyph
->object
, string
));
12421 /* Skip glyphs from an overlay. */
12422 while (glyph
< stop
12423 && ! string_buffer_position (w
, glyph
->object
, pos
))
12425 string
= glyph
->object
;
12426 SKIP_GLYPHS (glyph
, stop
, x
, EQ (glyph
->object
, string
));
12430 /* If we reached the end of the line, and END was from a string,
12431 the cursor is not on this line. */
12432 if (glyph
== end
&& row
->continued_p
)
12436 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
12438 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
12439 w
->cursor
.y
= row
->y
+ dy
;
12441 if (w
== XWINDOW (selected_window
))
12443 if (!row
->continued_p
12444 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
12447 this_line_buffer
= XBUFFER (w
->buffer
);
12449 CHARPOS (this_line_start_pos
)
12450 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
12451 BYTEPOS (this_line_start_pos
)
12452 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
12454 CHARPOS (this_line_end_pos
)
12455 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
12456 BYTEPOS (this_line_end_pos
)
12457 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
12459 this_line_y
= w
->cursor
.y
;
12460 this_line_pixel_height
= row
->height
;
12461 this_line_vpos
= w
->cursor
.vpos
;
12462 this_line_start_x
= row
->x
;
12465 CHARPOS (this_line_start_pos
) = 0;
12472 /* Run window scroll functions, if any, for WINDOW with new window
12473 start STARTP. Sets the window start of WINDOW to that position.
12475 We assume that the window's buffer is really current. */
12477 static INLINE
struct text_pos
12478 run_window_scroll_functions (window
, startp
)
12479 Lisp_Object window
;
12480 struct text_pos startp
;
12482 struct window
*w
= XWINDOW (window
);
12483 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
12485 if (current_buffer
!= XBUFFER (w
->buffer
))
12488 if (!NILP (Vwindow_scroll_functions
))
12490 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
12491 make_number (CHARPOS (startp
)));
12492 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12493 /* In case the hook functions switch buffers. */
12494 if (current_buffer
!= XBUFFER (w
->buffer
))
12495 set_buffer_internal_1 (XBUFFER (w
->buffer
));
12502 /* Make sure the line containing the cursor is fully visible.
12503 A value of 1 means there is nothing to be done.
12504 (Either the line is fully visible, or it cannot be made so,
12505 or we cannot tell.)
12507 If FORCE_P is non-zero, return 0 even if partial visible cursor row
12508 is higher than window.
12510 A value of 0 means the caller should do scrolling
12511 as if point had gone off the screen. */
12514 cursor_row_fully_visible_p (w
, force_p
, current_matrix_p
)
12517 int current_matrix_p
;
12519 struct glyph_matrix
*matrix
;
12520 struct glyph_row
*row
;
12523 if (!make_cursor_line_fully_visible_p
)
12526 /* It's not always possible to find the cursor, e.g, when a window
12527 is full of overlay strings. Don't do anything in that case. */
12528 if (w
->cursor
.vpos
< 0)
12531 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
12532 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
12534 /* If the cursor row is not partially visible, there's nothing to do. */
12535 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
12538 /* If the row the cursor is in is taller than the window's height,
12539 it's not clear what to do, so do nothing. */
12540 window_height
= window_box_height (w
);
12541 if (row
->height
>= window_height
)
12543 if (!force_p
|| MINI_WINDOW_P (w
)
12544 || w
->vscroll
|| w
->cursor
.vpos
== 0)
12551 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
12552 non-zero means only WINDOW is redisplayed in redisplay_internal.
12553 TEMP_SCROLL_STEP has the same meaning as scroll_step, and is used
12554 in redisplay_window to bring a partially visible line into view in
12555 the case that only the cursor has moved.
12557 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
12558 last screen line's vertical height extends past the end of the screen.
12562 1 if scrolling succeeded
12564 0 if scrolling didn't find point.
12566 -1 if new fonts have been loaded so that we must interrupt
12567 redisplay, adjust glyph matrices, and try again. */
12573 SCROLLING_NEED_LARGER_MATRICES
12577 try_scrolling (window
, just_this_one_p
, scroll_conservatively
,
12578 scroll_step
, temp_scroll_step
, last_line_misfit
)
12579 Lisp_Object window
;
12580 int just_this_one_p
;
12581 EMACS_INT scroll_conservatively
, scroll_step
;
12582 int temp_scroll_step
;
12583 int last_line_misfit
;
12585 struct window
*w
= XWINDOW (window
);
12586 struct frame
*f
= XFRAME (w
->frame
);
12587 struct text_pos pos
, startp
;
12589 int this_scroll_margin
, scroll_max
, rc
, height
;
12590 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
12591 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
12592 Lisp_Object aggressive
;
12593 int scroll_limit
= INT_MAX
/ FRAME_LINE_HEIGHT (f
);
12596 debug_method_add (w
, "try_scrolling");
12599 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12601 /* Compute scroll margin height in pixels. We scroll when point is
12602 within this distance from the top or bottom of the window. */
12603 if (scroll_margin
> 0)
12604 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
12605 * FRAME_LINE_HEIGHT (f
);
12607 this_scroll_margin
= 0;
12609 /* Force scroll_conservatively to have a reasonable value, to avoid
12610 overflow while computing how much to scroll. Note that the user
12611 can supply scroll-conservatively equal to `most-positive-fixnum',
12612 which can be larger than INT_MAX. */
12613 if (scroll_conservatively
> scroll_limit
)
12615 scroll_conservatively
= scroll_limit
;
12616 scroll_max
= INT_MAX
;
12618 else if (scroll_step
|| scroll_conservatively
|| temp_scroll_step
)
12619 /* Compute how much we should try to scroll maximally to bring
12620 point into view. */
12621 scroll_max
= (max (scroll_step
,
12622 max (scroll_conservatively
, temp_scroll_step
))
12623 * FRAME_LINE_HEIGHT (f
));
12624 else if (NUMBERP (current_buffer
->scroll_down_aggressively
)
12625 || NUMBERP (current_buffer
->scroll_up_aggressively
))
12626 /* We're trying to scroll because of aggressive scrolling but no
12627 scroll_step is set. Choose an arbitrary one. */
12628 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
12634 /* Decide whether to scroll down. */
12635 if (PT
> CHARPOS (startp
))
12637 int scroll_margin_y
;
12639 /* Compute the pixel ypos of the scroll margin, then move it to
12640 either that ypos or PT, whichever comes first. */
12641 start_display (&it
, w
, startp
);
12642 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
12643 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
12644 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
12645 (MOVE_TO_POS
| MOVE_TO_Y
));
12647 if (PT
> CHARPOS (it
.current
.pos
))
12649 int y0
= line_bottom_y (&it
);
12651 /* Compute the distance from the scroll margin to PT
12652 (including the height of the cursor line). Moving the
12653 iterator unconditionally to PT can be slow if PT is far
12654 away, so stop 10 lines past the window bottom (is there a
12655 way to do the right thing quickly?). */
12656 move_it_to (&it
, PT
, -1,
12657 it
.last_visible_y
+ 10 * FRAME_LINE_HEIGHT (f
),
12658 -1, MOVE_TO_POS
| MOVE_TO_Y
);
12659 dy
= line_bottom_y (&it
) - y0
;
12661 if (dy
> scroll_max
)
12662 return SCROLLING_FAILED
;
12670 /* Point is in or below the bottom scroll margin, so move the
12671 window start down. If scrolling conservatively, move it just
12672 enough down to make point visible. If scroll_step is set,
12673 move it down by scroll_step. */
12674 if (scroll_conservatively
)
12676 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
12677 FRAME_LINE_HEIGHT (f
) * scroll_conservatively
);
12678 else if (scroll_step
|| temp_scroll_step
)
12679 amount_to_scroll
= scroll_max
;
12682 aggressive
= current_buffer
->scroll_up_aggressively
;
12683 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
12684 if (NUMBERP (aggressive
))
12686 double float_amount
= XFLOATINT (aggressive
) * height
;
12687 amount_to_scroll
= float_amount
;
12688 if (amount_to_scroll
== 0 && float_amount
> 0)
12689 amount_to_scroll
= 1;
12693 if (amount_to_scroll
<= 0)
12694 return SCROLLING_FAILED
;
12696 start_display (&it
, w
, startp
);
12697 move_it_vertically (&it
, amount_to_scroll
);
12699 /* If STARTP is unchanged, move it down another screen line. */
12700 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
12701 move_it_by_lines (&it
, 1, 1);
12702 startp
= it
.current
.pos
;
12706 struct text_pos scroll_margin_pos
= startp
;
12708 /* See if point is inside the scroll margin at the top of the
12710 if (this_scroll_margin
)
12712 start_display (&it
, w
, startp
);
12713 move_it_vertically (&it
, this_scroll_margin
);
12714 scroll_margin_pos
= it
.current
.pos
;
12717 if (PT
< CHARPOS (scroll_margin_pos
))
12719 /* Point is in the scroll margin at the top of the window or
12720 above what is displayed in the window. */
12723 /* Compute the vertical distance from PT to the scroll
12724 margin position. Give up if distance is greater than
12726 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
12727 start_display (&it
, w
, pos
);
12729 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
12730 it
.last_visible_y
, -1,
12731 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
12732 dy
= it
.current_y
- y0
;
12733 if (dy
> scroll_max
)
12734 return SCROLLING_FAILED
;
12736 /* Compute new window start. */
12737 start_display (&it
, w
, startp
);
12739 if (scroll_conservatively
)
12741 = max (dy
, FRAME_LINE_HEIGHT (f
) * max (scroll_step
, temp_scroll_step
));
12742 else if (scroll_step
|| temp_scroll_step
)
12743 amount_to_scroll
= scroll_max
;
12746 aggressive
= current_buffer
->scroll_down_aggressively
;
12747 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
12748 if (NUMBERP (aggressive
))
12750 double float_amount
= XFLOATINT (aggressive
) * height
;
12751 amount_to_scroll
= float_amount
;
12752 if (amount_to_scroll
== 0 && float_amount
> 0)
12753 amount_to_scroll
= 1;
12757 if (amount_to_scroll
<= 0)
12758 return SCROLLING_FAILED
;
12760 move_it_vertically_backward (&it
, amount_to_scroll
);
12761 startp
= it
.current
.pos
;
12765 /* Run window scroll functions. */
12766 startp
= run_window_scroll_functions (window
, startp
);
12768 /* Display the window. Give up if new fonts are loaded, or if point
12770 if (!try_window (window
, startp
, 0))
12771 rc
= SCROLLING_NEED_LARGER_MATRICES
;
12772 else if (w
->cursor
.vpos
< 0)
12774 clear_glyph_matrix (w
->desired_matrix
);
12775 rc
= SCROLLING_FAILED
;
12779 /* Maybe forget recorded base line for line number display. */
12780 if (!just_this_one_p
12781 || current_buffer
->clip_changed
12782 || BEG_UNCHANGED
< CHARPOS (startp
))
12783 w
->base_line_number
= Qnil
;
12785 /* If cursor ends up on a partially visible line,
12786 treat that as being off the bottom of the screen. */
12787 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0))
12789 clear_glyph_matrix (w
->desired_matrix
);
12790 ++extra_scroll_margin_lines
;
12793 rc
= SCROLLING_SUCCESS
;
12800 /* Compute a suitable window start for window W if display of W starts
12801 on a continuation line. Value is non-zero if a new window start
12804 The new window start will be computed, based on W's width, starting
12805 from the start of the continued line. It is the start of the
12806 screen line with the minimum distance from the old start W->start. */
12809 compute_window_start_on_continuation_line (w
)
12812 struct text_pos pos
, start_pos
;
12813 int window_start_changed_p
= 0;
12815 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
12817 /* If window start is on a continuation line... Window start may be
12818 < BEGV in case there's invisible text at the start of the
12819 buffer (M-x rmail, for example). */
12820 if (CHARPOS (start_pos
) > BEGV
12821 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
12824 struct glyph_row
*row
;
12826 /* Handle the case that the window start is out of range. */
12827 if (CHARPOS (start_pos
) < BEGV
)
12828 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
12829 else if (CHARPOS (start_pos
) > ZV
)
12830 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
12832 /* Find the start of the continued line. This should be fast
12833 because scan_buffer is fast (newline cache). */
12834 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
12835 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
12836 row
, DEFAULT_FACE_ID
);
12837 reseat_at_previous_visible_line_start (&it
);
12839 /* If the line start is "too far" away from the window start,
12840 say it takes too much time to compute a new window start. */
12841 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
12842 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
12844 int min_distance
, distance
;
12846 /* Move forward by display lines to find the new window
12847 start. If window width was enlarged, the new start can
12848 be expected to be > the old start. If window width was
12849 decreased, the new window start will be < the old start.
12850 So, we're looking for the display line start with the
12851 minimum distance from the old window start. */
12852 pos
= it
.current
.pos
;
12853 min_distance
= INFINITY
;
12854 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
12855 distance
< min_distance
)
12857 min_distance
= distance
;
12858 pos
= it
.current
.pos
;
12859 move_it_by_lines (&it
, 1, 0);
12862 /* Set the window start there. */
12863 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
12864 window_start_changed_p
= 1;
12868 return window_start_changed_p
;
12872 /* Try cursor movement in case text has not changed in window WINDOW,
12873 with window start STARTP. Value is
12875 CURSOR_MOVEMENT_SUCCESS if successful
12877 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
12879 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
12880 display. *SCROLL_STEP is set to 1, under certain circumstances, if
12881 we want to scroll as if scroll-step were set to 1. See the code.
12883 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
12884 which case we have to abort this redisplay, and adjust matrices
12889 CURSOR_MOVEMENT_SUCCESS
,
12890 CURSOR_MOVEMENT_CANNOT_BE_USED
,
12891 CURSOR_MOVEMENT_MUST_SCROLL
,
12892 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
12896 try_cursor_movement (window
, startp
, scroll_step
)
12897 Lisp_Object window
;
12898 struct text_pos startp
;
12901 struct window
*w
= XWINDOW (window
);
12902 struct frame
*f
= XFRAME (w
->frame
);
12903 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
12906 if (inhibit_try_cursor_movement
)
12910 /* Handle case where text has not changed, only point, and it has
12911 not moved off the frame. */
12912 if (/* Point may be in this window. */
12913 PT
>= CHARPOS (startp
)
12914 /* Selective display hasn't changed. */
12915 && !current_buffer
->clip_changed
12916 /* Function force-mode-line-update is used to force a thorough
12917 redisplay. It sets either windows_or_buffers_changed or
12918 update_mode_lines. So don't take a shortcut here for these
12920 && !update_mode_lines
12921 && !windows_or_buffers_changed
12922 && !cursor_type_changed
12923 /* Can't use this case if highlighting a region. When a
12924 region exists, cursor movement has to do more than just
12926 && !(!NILP (Vtransient_mark_mode
)
12927 && !NILP (current_buffer
->mark_active
))
12928 && NILP (w
->region_showing
)
12929 && NILP (Vshow_trailing_whitespace
)
12930 /* Right after splitting windows, last_point may be nil. */
12931 && INTEGERP (w
->last_point
)
12932 /* This code is not used for mini-buffer for the sake of the case
12933 of redisplaying to replace an echo area message; since in
12934 that case the mini-buffer contents per se are usually
12935 unchanged. This code is of no real use in the mini-buffer
12936 since the handling of this_line_start_pos, etc., in redisplay
12937 handles the same cases. */
12938 && !EQ (window
, minibuf_window
)
12939 /* When splitting windows or for new windows, it happens that
12940 redisplay is called with a nil window_end_vpos or one being
12941 larger than the window. This should really be fixed in
12942 window.c. I don't have this on my list, now, so we do
12943 approximately the same as the old redisplay code. --gerd. */
12944 && INTEGERP (w
->window_end_vpos
)
12945 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
12946 && (FRAME_WINDOW_P (f
)
12947 || !overlay_arrow_in_current_buffer_p ()))
12949 int this_scroll_margin
, top_scroll_margin
;
12950 struct glyph_row
*row
= NULL
;
12953 debug_method_add (w
, "cursor movement");
12956 /* Scroll if point within this distance from the top or bottom
12957 of the window. This is a pixel value. */
12958 if (scroll_margin
> 0)
12960 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
12961 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
12964 this_scroll_margin
= 0;
12966 top_scroll_margin
= this_scroll_margin
;
12967 if (WINDOW_WANTS_HEADER_LINE_P (w
))
12968 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
12970 /* Start with the row the cursor was displayed during the last
12971 not paused redisplay. Give up if that row is not valid. */
12972 if (w
->last_cursor
.vpos
< 0
12973 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
12974 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
12977 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
12978 if (row
->mode_line_p
)
12980 if (!row
->enabled_p
)
12981 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
12984 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
12987 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
12989 if (PT
> XFASTINT (w
->last_point
))
12991 /* Point has moved forward. */
12992 while (MATRIX_ROW_END_CHARPOS (row
) < PT
12993 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
12995 xassert (row
->enabled_p
);
12999 /* The end position of a row equals the start position
13000 of the next row. If PT is there, we would rather
13001 display it in the next line. */
13002 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13003 && MATRIX_ROW_END_CHARPOS (row
) == PT
13004 && !cursor_row_p (w
, row
))
13007 /* If within the scroll margin, scroll. Note that
13008 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
13009 the next line would be drawn, and that
13010 this_scroll_margin can be zero. */
13011 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
13012 || PT
> MATRIX_ROW_END_CHARPOS (row
)
13013 /* Line is completely visible last line in window
13014 and PT is to be set in the next line. */
13015 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
13016 && PT
== MATRIX_ROW_END_CHARPOS (row
)
13017 && !row
->ends_at_zv_p
13018 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
13021 else if (PT
< XFASTINT (w
->last_point
))
13023 /* Cursor has to be moved backward. Note that PT >=
13024 CHARPOS (startp) because of the outer if-statement. */
13025 while (!row
->mode_line_p
13026 && (MATRIX_ROW_START_CHARPOS (row
) > PT
13027 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13028 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
13029 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
13030 row
> w
->current_matrix
->rows
13031 && (row
-1)->ends_in_newline_from_string_p
))))
13032 && (row
->y
> top_scroll_margin
13033 || CHARPOS (startp
) == BEGV
))
13035 xassert (row
->enabled_p
);
13039 /* Consider the following case: Window starts at BEGV,
13040 there is invisible, intangible text at BEGV, so that
13041 display starts at some point START > BEGV. It can
13042 happen that we are called with PT somewhere between
13043 BEGV and START. Try to handle that case. */
13044 if (row
< w
->current_matrix
->rows
13045 || row
->mode_line_p
)
13047 row
= w
->current_matrix
->rows
;
13048 if (row
->mode_line_p
)
13052 /* Due to newlines in overlay strings, we may have to
13053 skip forward over overlay strings. */
13054 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13055 && MATRIX_ROW_END_CHARPOS (row
) == PT
13056 && !cursor_row_p (w
, row
))
13059 /* If within the scroll margin, scroll. */
13060 if (row
->y
< top_scroll_margin
13061 && CHARPOS (startp
) != BEGV
)
13066 /* Cursor did not move. So don't scroll even if cursor line
13067 is partially visible, as it was so before. */
13068 rc
= CURSOR_MOVEMENT_SUCCESS
;
13071 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
13072 || PT
> MATRIX_ROW_END_CHARPOS (row
))
13074 /* if PT is not in the glyph row, give up. */
13075 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13077 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13078 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
13079 && make_cursor_line_fully_visible_p
)
13081 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
13082 && !row
->ends_at_zv_p
13083 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
13084 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13085 else if (row
->height
> window_box_height (w
))
13087 /* If we end up in a partially visible line, let's
13088 make it fully visible, except when it's taller
13089 than the window, in which case we can't do much
13092 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13096 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13097 if (!cursor_row_fully_visible_p (w
, 0, 1))
13098 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13100 rc
= CURSOR_MOVEMENT_SUCCESS
;
13104 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13109 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
13111 rc
= CURSOR_MOVEMENT_SUCCESS
;
13116 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13117 && MATRIX_ROW_START_CHARPOS (row
) == PT
13118 && cursor_row_p (w
, row
));
13127 set_vertical_scroll_bar (w
)
13130 int start
, end
, whole
;
13132 /* Calculate the start and end positions for the current window.
13133 At some point, it would be nice to choose between scrollbars
13134 which reflect the whole buffer size, with special markers
13135 indicating narrowing, and scrollbars which reflect only the
13138 Note that mini-buffers sometimes aren't displaying any text. */
13139 if (!MINI_WINDOW_P (w
)
13140 || (w
== XWINDOW (minibuf_window
)
13141 && NILP (echo_area_buffer
[0])))
13143 struct buffer
*buf
= XBUFFER (w
->buffer
);
13144 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
13145 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
13146 /* I don't think this is guaranteed to be right. For the
13147 moment, we'll pretend it is. */
13148 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
13152 if (whole
< (end
- start
))
13153 whole
= end
- start
;
13156 start
= end
= whole
= 0;
13158 /* Indicate what this scroll bar ought to be displaying now. */
13159 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13160 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13161 (w
, end
- start
, whole
, start
);
13165 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
13166 selected_window is redisplayed.
13168 We can return without actually redisplaying the window if
13169 fonts_changed_p is nonzero. In that case, redisplay_internal will
13173 redisplay_window (window
, just_this_one_p
)
13174 Lisp_Object window
;
13175 int just_this_one_p
;
13177 struct window
*w
= XWINDOW (window
);
13178 struct frame
*f
= XFRAME (w
->frame
);
13179 struct buffer
*buffer
= XBUFFER (w
->buffer
);
13180 struct buffer
*old
= current_buffer
;
13181 struct text_pos lpoint
, opoint
, startp
;
13182 int update_mode_line
;
13185 /* Record it now because it's overwritten. */
13186 int current_matrix_up_to_date_p
= 0;
13187 int used_current_matrix_p
= 0;
13188 /* This is less strict than current_matrix_up_to_date_p.
13189 It indictes that the buffer contents and narrowing are unchanged. */
13190 int buffer_unchanged_p
= 0;
13191 int temp_scroll_step
= 0;
13192 int count
= SPECPDL_INDEX ();
13194 int centering_position
= -1;
13195 int last_line_misfit
= 0;
13196 int beg_unchanged
, end_unchanged
;
13198 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13201 /* W must be a leaf window here. */
13202 xassert (!NILP (w
->buffer
));
13204 *w
->desired_matrix
->method
= 0;
13208 reconsider_clip_changes (w
, buffer
);
13210 /* Has the mode line to be updated? */
13211 update_mode_line
= (!NILP (w
->update_mode_line
)
13212 || update_mode_lines
13213 || buffer
->clip_changed
13214 || buffer
->prevent_redisplay_optimizations_p
);
13216 if (MINI_WINDOW_P (w
))
13218 if (w
== XWINDOW (echo_area_window
)
13219 && !NILP (echo_area_buffer
[0]))
13221 if (update_mode_line
)
13222 /* We may have to update a tty frame's menu bar or a
13223 tool-bar. Example `M-x C-h C-h C-g'. */
13224 goto finish_menu_bars
;
13226 /* We've already displayed the echo area glyphs in this window. */
13227 goto finish_scroll_bars
;
13229 else if ((w
!= XWINDOW (minibuf_window
)
13230 || minibuf_level
== 0)
13231 /* When buffer is nonempty, redisplay window normally. */
13232 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
13233 /* Quail displays non-mini buffers in minibuffer window.
13234 In that case, redisplay the window normally. */
13235 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
13237 /* W is a mini-buffer window, but it's not active, so clear
13239 int yb
= window_text_bottom_y (w
);
13240 struct glyph_row
*row
;
13243 for (y
= 0, row
= w
->desired_matrix
->rows
;
13245 y
+= row
->height
, ++row
)
13246 blank_row (w
, row
, y
);
13247 goto finish_scroll_bars
;
13250 clear_glyph_matrix (w
->desired_matrix
);
13253 /* Otherwise set up data on this window; select its buffer and point
13255 /* Really select the buffer, for the sake of buffer-local
13257 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13259 current_matrix_up_to_date_p
13260 = (!NILP (w
->window_end_valid
)
13261 && !current_buffer
->clip_changed
13262 && !current_buffer
->prevent_redisplay_optimizations_p
13263 && XFASTINT (w
->last_modified
) >= MODIFF
13264 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13266 /* Run the window-bottom-change-functions
13267 if it is possible that the text on the screen has changed
13268 (either due to modification of the text, or any other reason). */
13269 if (!current_matrix_up_to_date_p
13270 && !NILP (Vwindow_text_change_functions
))
13272 safe_run_hooks (Qwindow_text_change_functions
);
13276 beg_unchanged
= BEG_UNCHANGED
;
13277 end_unchanged
= END_UNCHANGED
;
13279 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
13281 specbind (Qinhibit_point_motion_hooks
, Qt
);
13284 = (!NILP (w
->window_end_valid
)
13285 && !current_buffer
->clip_changed
13286 && XFASTINT (w
->last_modified
) >= MODIFF
13287 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13289 /* When windows_or_buffers_changed is non-zero, we can't rely on
13290 the window end being valid, so set it to nil there. */
13291 if (windows_or_buffers_changed
)
13293 /* If window starts on a continuation line, maybe adjust the
13294 window start in case the window's width changed. */
13295 if (XMARKER (w
->start
)->buffer
== current_buffer
)
13296 compute_window_start_on_continuation_line (w
);
13298 w
->window_end_valid
= Qnil
;
13301 /* Some sanity checks. */
13302 CHECK_WINDOW_END (w
);
13303 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
13305 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
13308 /* If %c is in mode line, update it if needed. */
13309 if (!NILP (w
->column_number_displayed
)
13310 /* This alternative quickly identifies a common case
13311 where no change is needed. */
13312 && !(PT
== XFASTINT (w
->last_point
)
13313 && XFASTINT (w
->last_modified
) >= MODIFF
13314 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
13315 && (XFASTINT (w
->column_number_displayed
)
13316 != (int) current_column ())) /* iftc */
13317 update_mode_line
= 1;
13319 /* Count number of windows showing the selected buffer. An indirect
13320 buffer counts as its base buffer. */
13321 if (!just_this_one_p
)
13323 struct buffer
*current_base
, *window_base
;
13324 current_base
= current_buffer
;
13325 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13326 if (current_base
->base_buffer
)
13327 current_base
= current_base
->base_buffer
;
13328 if (window_base
->base_buffer
)
13329 window_base
= window_base
->base_buffer
;
13330 if (current_base
== window_base
)
13334 /* Point refers normally to the selected window. For any other
13335 window, set up appropriate value. */
13336 if (!EQ (window
, selected_window
))
13338 int new_pt
= XMARKER (w
->pointm
)->charpos
;
13339 int new_pt_byte
= marker_byte_position (w
->pointm
);
13343 new_pt_byte
= BEGV_BYTE
;
13344 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
13346 else if (new_pt
> (ZV
- 1))
13349 new_pt_byte
= ZV_BYTE
;
13350 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
13353 /* We don't use SET_PT so that the point-motion hooks don't run. */
13354 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
13357 /* If any of the character widths specified in the display table
13358 have changed, invalidate the width run cache. It's true that
13359 this may be a bit late to catch such changes, but the rest of
13360 redisplay goes (non-fatally) haywire when the display table is
13361 changed, so why should we worry about doing any better? */
13362 if (current_buffer
->width_run_cache
)
13364 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
13366 if (! disptab_matches_widthtab (disptab
,
13367 XVECTOR (current_buffer
->width_table
)))
13369 invalidate_region_cache (current_buffer
,
13370 current_buffer
->width_run_cache
,
13372 recompute_width_table (current_buffer
, disptab
);
13376 /* If window-start is screwed up, choose a new one. */
13377 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
13380 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13382 /* If someone specified a new starting point but did not insist,
13383 check whether it can be used. */
13384 if (!NILP (w
->optional_new_start
)
13385 && CHARPOS (startp
) >= BEGV
13386 && CHARPOS (startp
) <= ZV
)
13388 w
->optional_new_start
= Qnil
;
13389 start_display (&it
, w
, startp
);
13390 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
13391 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13392 if (IT_CHARPOS (it
) == PT
)
13393 w
->force_start
= Qt
;
13394 /* IT may overshoot PT if text at PT is invisible. */
13395 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
13396 w
->force_start
= Qt
;
13401 /* Handle case where place to start displaying has been specified,
13402 unless the specified location is outside the accessible range. */
13403 if (!NILP (w
->force_start
)
13404 || w
->frozen_window_start_p
)
13406 /* We set this later on if we have to adjust point. */
13409 w
->force_start
= Qnil
;
13411 w
->window_end_valid
= Qnil
;
13413 /* Forget any recorded base line for line number display. */
13414 if (!buffer_unchanged_p
)
13415 w
->base_line_number
= Qnil
;
13417 /* Redisplay the mode line. Select the buffer properly for that.
13418 Also, run the hook window-scroll-functions
13419 because we have scrolled. */
13420 /* Note, we do this after clearing force_start because
13421 if there's an error, it is better to forget about force_start
13422 than to get into an infinite loop calling the hook functions
13423 and having them get more errors. */
13424 if (!update_mode_line
13425 || ! NILP (Vwindow_scroll_functions
))
13427 update_mode_line
= 1;
13428 w
->update_mode_line
= Qt
;
13429 startp
= run_window_scroll_functions (window
, startp
);
13432 w
->last_modified
= make_number (0);
13433 w
->last_overlay_modified
= make_number (0);
13434 if (CHARPOS (startp
) < BEGV
)
13435 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
13436 else if (CHARPOS (startp
) > ZV
)
13437 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
13439 /* Redisplay, then check if cursor has been set during the
13440 redisplay. Give up if new fonts were loaded. */
13441 /* We used to issue a CHECK_MARGINS argument to try_window here,
13442 but this causes scrolling to fail when point begins inside
13443 the scroll margin (bug#148) -- cyd */
13444 if (!try_window (window
, startp
, 0))
13446 w
->force_start
= Qt
;
13447 clear_glyph_matrix (w
->desired_matrix
);
13448 goto need_larger_matrices
;
13451 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
13453 /* If point does not appear, try to move point so it does
13454 appear. The desired matrix has been built above, so we
13455 can use it here. */
13456 new_vpos
= window_box_height (w
) / 2;
13459 if (!cursor_row_fully_visible_p (w
, 0, 0))
13461 /* Point does appear, but on a line partly visible at end of window.
13462 Move it back to a fully-visible line. */
13463 new_vpos
= window_box_height (w
);
13466 /* If we need to move point for either of the above reasons,
13467 now actually do it. */
13470 struct glyph_row
*row
;
13472 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
13473 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
13476 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
13477 MATRIX_ROW_START_BYTEPOS (row
));
13479 if (w
!= XWINDOW (selected_window
))
13480 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
13481 else if (current_buffer
== old
)
13482 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13484 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
13486 /* If we are highlighting the region, then we just changed
13487 the region, so redisplay to show it. */
13488 if (!NILP (Vtransient_mark_mode
)
13489 && !NILP (current_buffer
->mark_active
))
13491 clear_glyph_matrix (w
->desired_matrix
);
13492 if (!try_window (window
, startp
, 0))
13493 goto need_larger_matrices
;
13498 debug_method_add (w
, "forced window start");
13503 /* Handle case where text has not changed, only point, and it has
13504 not moved off the frame, and we are not retrying after hscroll.
13505 (current_matrix_up_to_date_p is nonzero when retrying.) */
13506 if (current_matrix_up_to_date_p
13507 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
13508 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
13512 case CURSOR_MOVEMENT_SUCCESS
:
13513 used_current_matrix_p
= 1;
13516 case CURSOR_MOVEMENT_MUST_SCROLL
:
13517 goto try_to_scroll
;
13523 /* If current starting point was originally the beginning of a line
13524 but no longer is, find a new starting point. */
13525 else if (!NILP (w
->start_at_line_beg
)
13526 && !(CHARPOS (startp
) <= BEGV
13527 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
13530 debug_method_add (w
, "recenter 1");
13535 /* Try scrolling with try_window_id. Value is > 0 if update has
13536 been done, it is -1 if we know that the same window start will
13537 not work. It is 0 if unsuccessful for some other reason. */
13538 else if ((tem
= try_window_id (w
)) != 0)
13541 debug_method_add (w
, "try_window_id %d", tem
);
13544 if (fonts_changed_p
)
13545 goto need_larger_matrices
;
13549 /* Otherwise try_window_id has returned -1 which means that we
13550 don't want the alternative below this comment to execute. */
13552 else if (CHARPOS (startp
) >= BEGV
13553 && CHARPOS (startp
) <= ZV
13554 && PT
>= CHARPOS (startp
)
13555 && (CHARPOS (startp
) < ZV
13556 /* Avoid starting at end of buffer. */
13557 || CHARPOS (startp
) == BEGV
13558 || (XFASTINT (w
->last_modified
) >= MODIFF
13559 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
13562 /* If first window line is a continuation line, and window start
13563 is inside the modified region, but the first change is before
13564 current window start, we must select a new window start.
13566 However, if this is the result of a down-mouse event (e.g. by
13567 extending the mouse-drag-overlay), we don't want to select a
13568 new window start, since that would change the position under
13569 the mouse, resulting in an unwanted mouse-movement rather
13570 than a simple mouse-click. */
13571 if (NILP (w
->start_at_line_beg
)
13572 && NILP (do_mouse_tracking
)
13573 && CHARPOS (startp
) > BEGV
13574 && CHARPOS (startp
) > BEG
+ beg_unchanged
13575 && CHARPOS (startp
) <= Z
- end_unchanged
13576 /* Even if w->start_at_line_beg is nil, a new window may
13577 start at a line_beg, since that's how set_buffer_window
13578 sets it. So, we need to check the return value of
13579 compute_window_start_on_continuation_line. (See also
13581 && XMARKER (w
->start
)->buffer
== current_buffer
13582 && compute_window_start_on_continuation_line (w
))
13584 w
->force_start
= Qt
;
13585 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13590 debug_method_add (w
, "same window start");
13593 /* Try to redisplay starting at same place as before.
13594 If point has not moved off frame, accept the results. */
13595 if (!current_matrix_up_to_date_p
13596 /* Don't use try_window_reusing_current_matrix in this case
13597 because a window scroll function can have changed the
13599 || !NILP (Vwindow_scroll_functions
)
13600 || MINI_WINDOW_P (w
)
13601 || !(used_current_matrix_p
13602 = try_window_reusing_current_matrix (w
)))
13604 IF_DEBUG (debug_method_add (w
, "1"));
13605 if (try_window (window
, startp
, 1) < 0)
13606 /* -1 means we need to scroll.
13607 0 means we need new matrices, but fonts_changed_p
13608 is set in that case, so we will detect it below. */
13609 goto try_to_scroll
;
13612 if (fonts_changed_p
)
13613 goto need_larger_matrices
;
13615 if (w
->cursor
.vpos
>= 0)
13617 if (!just_this_one_p
13618 || current_buffer
->clip_changed
13619 || BEG_UNCHANGED
< CHARPOS (startp
))
13620 /* Forget any recorded base line for line number display. */
13621 w
->base_line_number
= Qnil
;
13623 if (!cursor_row_fully_visible_p (w
, 1, 0))
13625 clear_glyph_matrix (w
->desired_matrix
);
13626 last_line_misfit
= 1;
13628 /* Drop through and scroll. */
13633 clear_glyph_matrix (w
->desired_matrix
);
13638 w
->last_modified
= make_number (0);
13639 w
->last_overlay_modified
= make_number (0);
13641 /* Redisplay the mode line. Select the buffer properly for that. */
13642 if (!update_mode_line
)
13644 update_mode_line
= 1;
13645 w
->update_mode_line
= Qt
;
13648 /* Try to scroll by specified few lines. */
13649 if ((scroll_conservatively
13651 || temp_scroll_step
13652 || NUMBERP (current_buffer
->scroll_up_aggressively
)
13653 || NUMBERP (current_buffer
->scroll_down_aggressively
))
13654 && !current_buffer
->clip_changed
13655 && CHARPOS (startp
) >= BEGV
13656 && CHARPOS (startp
) <= ZV
)
13658 /* The function returns -1 if new fonts were loaded, 1 if
13659 successful, 0 if not successful. */
13660 int rc
= try_scrolling (window
, just_this_one_p
,
13661 scroll_conservatively
,
13663 temp_scroll_step
, last_line_misfit
);
13666 case SCROLLING_SUCCESS
:
13669 case SCROLLING_NEED_LARGER_MATRICES
:
13670 goto need_larger_matrices
;
13672 case SCROLLING_FAILED
:
13680 /* Finally, just choose place to start which centers point */
13683 if (centering_position
< 0)
13684 centering_position
= window_box_height (w
) / 2;
13687 debug_method_add (w
, "recenter");
13690 /* w->vscroll = 0; */
13692 /* Forget any previously recorded base line for line number display. */
13693 if (!buffer_unchanged_p
)
13694 w
->base_line_number
= Qnil
;
13696 /* Move backward half the height of the window. */
13697 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
13698 it
.current_y
= it
.last_visible_y
;
13699 move_it_vertically_backward (&it
, centering_position
);
13700 xassert (IT_CHARPOS (it
) >= BEGV
);
13702 /* The function move_it_vertically_backward may move over more
13703 than the specified y-distance. If it->w is small, e.g. a
13704 mini-buffer window, we may end up in front of the window's
13705 display area. Start displaying at the start of the line
13706 containing PT in this case. */
13707 if (it
.current_y
<= 0)
13709 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
13710 move_it_vertically_backward (&it
, 0);
13714 it
.current_x
= it
.hpos
= 0;
13716 /* Set startp here explicitly in case that helps avoid an infinite loop
13717 in case the window-scroll-functions functions get errors. */
13718 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
13720 /* Run scroll hooks. */
13721 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
13723 /* Redisplay the window. */
13724 if (!current_matrix_up_to_date_p
13725 || windows_or_buffers_changed
13726 || cursor_type_changed
13727 /* Don't use try_window_reusing_current_matrix in this case
13728 because it can have changed the buffer. */
13729 || !NILP (Vwindow_scroll_functions
)
13730 || !just_this_one_p
13731 || MINI_WINDOW_P (w
)
13732 || !(used_current_matrix_p
13733 = try_window_reusing_current_matrix (w
)))
13734 try_window (window
, startp
, 0);
13736 /* If new fonts have been loaded (due to fontsets), give up. We
13737 have to start a new redisplay since we need to re-adjust glyph
13739 if (fonts_changed_p
)
13740 goto need_larger_matrices
;
13742 /* If cursor did not appear assume that the middle of the window is
13743 in the first line of the window. Do it again with the next line.
13744 (Imagine a window of height 100, displaying two lines of height
13745 60. Moving back 50 from it->last_visible_y will end in the first
13747 if (w
->cursor
.vpos
< 0)
13749 if (!NILP (w
->window_end_valid
)
13750 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
13752 clear_glyph_matrix (w
->desired_matrix
);
13753 move_it_by_lines (&it
, 1, 0);
13754 try_window (window
, it
.current
.pos
, 0);
13756 else if (PT
< IT_CHARPOS (it
))
13758 clear_glyph_matrix (w
->desired_matrix
);
13759 move_it_by_lines (&it
, -1, 0);
13760 try_window (window
, it
.current
.pos
, 0);
13764 /* Not much we can do about it. */
13768 /* Consider the following case: Window starts at BEGV, there is
13769 invisible, intangible text at BEGV, so that display starts at
13770 some point START > BEGV. It can happen that we are called with
13771 PT somewhere between BEGV and START. Try to handle that case. */
13772 if (w
->cursor
.vpos
< 0)
13774 struct glyph_row
*row
= w
->current_matrix
->rows
;
13775 if (row
->mode_line_p
)
13777 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13780 if (!cursor_row_fully_visible_p (w
, 0, 0))
13782 /* If vscroll is enabled, disable it and try again. */
13786 clear_glyph_matrix (w
->desired_matrix
);
13790 /* If centering point failed to make the whole line visible,
13791 put point at the top instead. That has to make the whole line
13792 visible, if it can be done. */
13793 if (centering_position
== 0)
13796 clear_glyph_matrix (w
->desired_matrix
);
13797 centering_position
= 0;
13803 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13804 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
13805 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
13808 /* Display the mode line, if we must. */
13809 if ((update_mode_line
13810 /* If window not full width, must redo its mode line
13811 if (a) the window to its side is being redone and
13812 (b) we do a frame-based redisplay. This is a consequence
13813 of how inverted lines are drawn in frame-based redisplay. */
13814 || (!just_this_one_p
13815 && !FRAME_WINDOW_P (f
)
13816 && !WINDOW_FULL_WIDTH_P (w
))
13817 /* Line number to display. */
13818 || INTEGERP (w
->base_line_pos
)
13819 /* Column number is displayed and different from the one displayed. */
13820 || (!NILP (w
->column_number_displayed
)
13821 && (XFASTINT (w
->column_number_displayed
)
13822 != (int) current_column ()))) /* iftc */
13823 /* This means that the window has a mode line. */
13824 && (WINDOW_WANTS_MODELINE_P (w
)
13825 || WINDOW_WANTS_HEADER_LINE_P (w
)))
13827 display_mode_lines (w
);
13829 /* If mode line height has changed, arrange for a thorough
13830 immediate redisplay using the correct mode line height. */
13831 if (WINDOW_WANTS_MODELINE_P (w
)
13832 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
13834 fonts_changed_p
= 1;
13835 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
13836 = DESIRED_MODE_LINE_HEIGHT (w
);
13839 /* If header line height has changed, arrange for a thorough
13840 immediate redisplay using the correct header line height. */
13841 if (WINDOW_WANTS_HEADER_LINE_P (w
)
13842 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
13844 fonts_changed_p
= 1;
13845 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
13846 = DESIRED_HEADER_LINE_HEIGHT (w
);
13849 if (fonts_changed_p
)
13850 goto need_larger_matrices
;
13853 if (!line_number_displayed
13854 && !BUFFERP (w
->base_line_pos
))
13856 w
->base_line_pos
= Qnil
;
13857 w
->base_line_number
= Qnil
;
13862 /* When we reach a frame's selected window, redo the frame's menu bar. */
13863 if (update_mode_line
13864 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
13866 int redisplay_menu_p
= 0;
13867 int redisplay_tool_bar_p
= 0;
13869 if (FRAME_WINDOW_P (f
))
13871 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
13872 || defined (HAVE_NS) || defined (USE_GTK)
13873 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
13875 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
13879 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
13881 if (redisplay_menu_p
)
13882 display_menu_bar (w
);
13884 #ifdef HAVE_WINDOW_SYSTEM
13885 if (FRAME_WINDOW_P (f
))
13887 #if defined (USE_GTK) || defined (HAVE_NS)
13888 redisplay_tool_bar_p
= FRAME_EXTERNAL_TOOL_BAR (f
);
13890 redisplay_tool_bar_p
= WINDOWP (f
->tool_bar_window
)
13891 && (FRAME_TOOL_BAR_LINES (f
) > 0
13892 || !NILP (Vauto_resize_tool_bars
));
13895 if (redisplay_tool_bar_p
&& redisplay_tool_bar (f
))
13897 extern int ignore_mouse_drag_p
;
13898 ignore_mouse_drag_p
= 1;
13904 #ifdef HAVE_WINDOW_SYSTEM
13905 if (FRAME_WINDOW_P (f
)
13906 && update_window_fringes (w
, (just_this_one_p
13907 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
13908 || w
->pseudo_window_p
)))
13912 if (draw_window_fringes (w
, 1))
13913 x_draw_vertical_border (w
);
13917 #endif /* HAVE_WINDOW_SYSTEM */
13919 /* We go to this label, with fonts_changed_p nonzero,
13920 if it is necessary to try again using larger glyph matrices.
13921 We have to redeem the scroll bar even in this case,
13922 because the loop in redisplay_internal expects that. */
13923 need_larger_matrices
:
13925 finish_scroll_bars
:
13927 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
13929 /* Set the thumb's position and size. */
13930 set_vertical_scroll_bar (w
);
13932 /* Note that we actually used the scroll bar attached to this
13933 window, so it shouldn't be deleted at the end of redisplay. */
13934 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
13935 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
13938 /* Restore current_buffer and value of point in it. */
13939 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
13940 set_buffer_internal_1 (old
);
13941 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
13942 shorter. This can be caused by log truncation in *Messages*. */
13943 if (CHARPOS (lpoint
) <= ZV
)
13944 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
13946 unbind_to (count
, Qnil
);
13950 /* Build the complete desired matrix of WINDOW with a window start
13951 buffer position POS.
13953 Value is 1 if successful. It is zero if fonts were loaded during
13954 redisplay which makes re-adjusting glyph matrices necessary, and -1
13955 if point would appear in the scroll margins.
13956 (We check that only if CHECK_MARGINS is nonzero. */
13959 try_window (window
, pos
, check_margins
)
13960 Lisp_Object window
;
13961 struct text_pos pos
;
13964 struct window
*w
= XWINDOW (window
);
13966 struct glyph_row
*last_text_row
= NULL
;
13967 struct frame
*f
= XFRAME (w
->frame
);
13969 /* Make POS the new window start. */
13970 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
13972 /* Mark cursor position as unknown. No overlay arrow seen. */
13973 w
->cursor
.vpos
= -1;
13974 overlay_arrow_seen
= 0;
13976 /* Initialize iterator and info to start at POS. */
13977 start_display (&it
, w
, pos
);
13979 /* Display all lines of W. */
13980 while (it
.current_y
< it
.last_visible_y
)
13982 if (display_line (&it
))
13983 last_text_row
= it
.glyph_row
- 1;
13984 if (fonts_changed_p
)
13988 /* Don't let the cursor end in the scroll margins. */
13990 && !MINI_WINDOW_P (w
))
13992 int this_scroll_margin
;
13994 if (scroll_margin
> 0)
13996 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
13997 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14000 this_scroll_margin
= 0;
14002 if ((w
->cursor
.y
>= 0 /* not vscrolled */
14003 && w
->cursor
.y
< this_scroll_margin
14004 && CHARPOS (pos
) > BEGV
14005 && IT_CHARPOS (it
) < ZV
)
14006 /* rms: considering make_cursor_line_fully_visible_p here
14007 seems to give wrong results. We don't want to recenter
14008 when the last line is partly visible, we want to allow
14009 that case to be handled in the usual way. */
14010 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
14012 w
->cursor
.vpos
= -1;
14013 clear_glyph_matrix (w
->desired_matrix
);
14018 /* If bottom moved off end of frame, change mode line percentage. */
14019 if (XFASTINT (w
->window_end_pos
) <= 0
14020 && Z
!= IT_CHARPOS (it
))
14021 w
->update_mode_line
= Qt
;
14023 /* Set window_end_pos to the offset of the last character displayed
14024 on the window from the end of current_buffer. Set
14025 window_end_vpos to its row number. */
14028 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
14029 w
->window_end_bytepos
14030 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14032 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14034 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14035 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
14036 ->displays_text_p
);
14040 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14041 w
->window_end_pos
= make_number (Z
- ZV
);
14042 w
->window_end_vpos
= make_number (0);
14045 /* But that is not valid info until redisplay finishes. */
14046 w
->window_end_valid
= Qnil
;
14052 /************************************************************************
14053 Window redisplay reusing current matrix when buffer has not changed
14054 ************************************************************************/
14056 /* Try redisplay of window W showing an unchanged buffer with a
14057 different window start than the last time it was displayed by
14058 reusing its current matrix. Value is non-zero if successful.
14059 W->start is the new window start. */
14062 try_window_reusing_current_matrix (w
)
14065 struct frame
*f
= XFRAME (w
->frame
);
14066 struct glyph_row
*row
, *bottom_row
;
14069 struct text_pos start
, new_start
;
14070 int nrows_scrolled
, i
;
14071 struct glyph_row
*last_text_row
;
14072 struct glyph_row
*last_reused_text_row
;
14073 struct glyph_row
*start_row
;
14074 int start_vpos
, min_y
, max_y
;
14077 if (inhibit_try_window_reusing
)
14081 if (/* This function doesn't handle terminal frames. */
14082 !FRAME_WINDOW_P (f
)
14083 /* Don't try to reuse the display if windows have been split
14085 || windows_or_buffers_changed
14086 || cursor_type_changed
)
14089 /* Can't do this if region may have changed. */
14090 if ((!NILP (Vtransient_mark_mode
)
14091 && !NILP (current_buffer
->mark_active
))
14092 || !NILP (w
->region_showing
)
14093 || !NILP (Vshow_trailing_whitespace
))
14096 /* If top-line visibility has changed, give up. */
14097 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14098 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
14101 /* Give up if old or new display is scrolled vertically. We could
14102 make this function handle this, but right now it doesn't. */
14103 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14104 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
14107 /* The variable new_start now holds the new window start. The old
14108 start `start' can be determined from the current matrix. */
14109 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
14110 start
= start_row
->start
.pos
;
14111 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14113 /* Clear the desired matrix for the display below. */
14114 clear_glyph_matrix (w
->desired_matrix
);
14116 if (CHARPOS (new_start
) <= CHARPOS (start
))
14120 /* Don't use this method if the display starts with an ellipsis
14121 displayed for invisible text. It's not easy to handle that case
14122 below, and it's certainly not worth the effort since this is
14123 not a frequent case. */
14124 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
14127 IF_DEBUG (debug_method_add (w
, "twu1"));
14129 /* Display up to a row that can be reused. The variable
14130 last_text_row is set to the last row displayed that displays
14131 text. Note that it.vpos == 0 if or if not there is a
14132 header-line; it's not the same as the MATRIX_ROW_VPOS! */
14133 start_display (&it
, w
, new_start
);
14134 first_row_y
= it
.current_y
;
14135 w
->cursor
.vpos
= -1;
14136 last_text_row
= last_reused_text_row
= NULL
;
14138 while (it
.current_y
< it
.last_visible_y
14139 && !fonts_changed_p
)
14141 /* If we have reached into the characters in the START row,
14142 that means the line boundaries have changed. So we
14143 can't start copying with the row START. Maybe it will
14144 work to start copying with the following row. */
14145 while (IT_CHARPOS (it
) > CHARPOS (start
))
14147 /* Advance to the next row as the "start". */
14149 start
= start_row
->start
.pos
;
14150 /* If there are no more rows to try, or just one, give up. */
14151 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
14152 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
14153 || CHARPOS (start
) == ZV
)
14155 clear_glyph_matrix (w
->desired_matrix
);
14159 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14161 /* If we have reached alignment,
14162 we can copy the rest of the rows. */
14163 if (IT_CHARPOS (it
) == CHARPOS (start
))
14166 if (display_line (&it
))
14167 last_text_row
= it
.glyph_row
- 1;
14170 /* A value of current_y < last_visible_y means that we stopped
14171 at the previous window start, which in turn means that we
14172 have at least one reusable row. */
14173 if (it
.current_y
< it
.last_visible_y
)
14175 /* IT.vpos always starts from 0; it counts text lines. */
14176 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
14178 /* Find PT if not already found in the lines displayed. */
14179 if (w
->cursor
.vpos
< 0)
14181 int dy
= it
.current_y
- start_row
->y
;
14183 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14184 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
14186 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
14187 dy
, nrows_scrolled
);
14190 clear_glyph_matrix (w
->desired_matrix
);
14195 /* Scroll the display. Do it before the current matrix is
14196 changed. The problem here is that update has not yet
14197 run, i.e. part of the current matrix is not up to date.
14198 scroll_run_hook will clear the cursor, and use the
14199 current matrix to get the height of the row the cursor is
14201 run
.current_y
= start_row
->y
;
14202 run
.desired_y
= it
.current_y
;
14203 run
.height
= it
.last_visible_y
- it
.current_y
;
14205 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
14208 FRAME_RIF (f
)->update_window_begin_hook (w
);
14209 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14210 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14211 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14215 /* Shift current matrix down by nrows_scrolled lines. */
14216 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14217 rotate_matrix (w
->current_matrix
,
14219 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14222 /* Disable lines that must be updated. */
14223 for (i
= 0; i
< nrows_scrolled
; ++i
)
14224 (start_row
+ i
)->enabled_p
= 0;
14226 /* Re-compute Y positions. */
14227 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14228 max_y
= it
.last_visible_y
;
14229 for (row
= start_row
+ nrows_scrolled
;
14233 row
->y
= it
.current_y
;
14234 row
->visible_height
= row
->height
;
14236 if (row
->y
< min_y
)
14237 row
->visible_height
-= min_y
- row
->y
;
14238 if (row
->y
+ row
->height
> max_y
)
14239 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14240 row
->redraw_fringe_bitmaps_p
= 1;
14242 it
.current_y
+= row
->height
;
14244 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14245 last_reused_text_row
= row
;
14246 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
14250 /* Disable lines in the current matrix which are now
14251 below the window. */
14252 for (++row
; row
< bottom_row
; ++row
)
14253 row
->enabled_p
= row
->mode_line_p
= 0;
14256 /* Update window_end_pos etc.; last_reused_text_row is the last
14257 reused row from the current matrix containing text, if any.
14258 The value of last_text_row is the last displayed line
14259 containing text. */
14260 if (last_reused_text_row
)
14262 w
->window_end_bytepos
14263 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
14265 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
14267 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
14268 w
->current_matrix
));
14270 else if (last_text_row
)
14272 w
->window_end_bytepos
14273 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14275 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14277 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14281 /* This window must be completely empty. */
14282 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14283 w
->window_end_pos
= make_number (Z
- ZV
);
14284 w
->window_end_vpos
= make_number (0);
14286 w
->window_end_valid
= Qnil
;
14288 /* Update hint: don't try scrolling again in update_window. */
14289 w
->desired_matrix
->no_scrolling_p
= 1;
14292 debug_method_add (w
, "try_window_reusing_current_matrix 1");
14296 else if (CHARPOS (new_start
) > CHARPOS (start
))
14298 struct glyph_row
*pt_row
, *row
;
14299 struct glyph_row
*first_reusable_row
;
14300 struct glyph_row
*first_row_to_display
;
14302 int yb
= window_text_bottom_y (w
);
14304 /* Find the row starting at new_start, if there is one. Don't
14305 reuse a partially visible line at the end. */
14306 first_reusable_row
= start_row
;
14307 while (first_reusable_row
->enabled_p
14308 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
14309 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14310 < CHARPOS (new_start
)))
14311 ++first_reusable_row
;
14313 /* Give up if there is no row to reuse. */
14314 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
14315 || !first_reusable_row
->enabled_p
14316 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14317 != CHARPOS (new_start
)))
14320 /* We can reuse fully visible rows beginning with
14321 first_reusable_row to the end of the window. Set
14322 first_row_to_display to the first row that cannot be reused.
14323 Set pt_row to the row containing point, if there is any. */
14325 for (first_row_to_display
= first_reusable_row
;
14326 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
14327 ++first_row_to_display
)
14329 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
14330 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
14331 pt_row
= first_row_to_display
;
14334 /* Start displaying at the start of first_row_to_display. */
14335 xassert (first_row_to_display
->y
< yb
);
14336 init_to_row_start (&it
, w
, first_row_to_display
);
14338 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
14340 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
14342 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
14343 + WINDOW_HEADER_LINE_HEIGHT (w
));
14345 /* Display lines beginning with first_row_to_display in the
14346 desired matrix. Set last_text_row to the last row displayed
14347 that displays text. */
14348 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
14349 if (pt_row
== NULL
)
14350 w
->cursor
.vpos
= -1;
14351 last_text_row
= NULL
;
14352 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
14353 if (display_line (&it
))
14354 last_text_row
= it
.glyph_row
- 1;
14356 /* If point is in a reused row, adjust y and vpos of the cursor
14360 w
->cursor
.vpos
-= nrows_scrolled
;
14361 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
14364 /* Give up if point isn't in a row displayed or reused. (This
14365 also handles the case where w->cursor.vpos < nrows_scrolled
14366 after the calls to display_line, which can happen with scroll
14367 margins. See bug#1295.) */
14368 if (w
->cursor
.vpos
< 0)
14370 clear_glyph_matrix (w
->desired_matrix
);
14374 /* Scroll the display. */
14375 run
.current_y
= first_reusable_row
->y
;
14376 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14377 run
.height
= it
.last_visible_y
- run
.current_y
;
14378 dy
= run
.current_y
- run
.desired_y
;
14383 FRAME_RIF (f
)->update_window_begin_hook (w
);
14384 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14385 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14386 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14390 /* Adjust Y positions of reused rows. */
14391 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14392 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14393 max_y
= it
.last_visible_y
;
14394 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
14397 row
->visible_height
= row
->height
;
14398 if (row
->y
< min_y
)
14399 row
->visible_height
-= min_y
- row
->y
;
14400 if (row
->y
+ row
->height
> max_y
)
14401 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14402 row
->redraw_fringe_bitmaps_p
= 1;
14405 /* Scroll the current matrix. */
14406 xassert (nrows_scrolled
> 0);
14407 rotate_matrix (w
->current_matrix
,
14409 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14412 /* Disable rows not reused. */
14413 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
14414 row
->enabled_p
= 0;
14416 /* Point may have moved to a different line, so we cannot assume that
14417 the previous cursor position is valid; locate the correct row. */
14420 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
14421 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
14425 w
->cursor
.y
= row
->y
;
14427 if (row
< bottom_row
)
14429 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
14430 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
14433 && (!BUFFERP (glyph
->object
)
14434 || glyph
->charpos
< PT
);
14438 w
->cursor
.x
+= glyph
->pixel_width
;
14443 /* Adjust window end. A null value of last_text_row means that
14444 the window end is in reused rows which in turn means that
14445 only its vpos can have changed. */
14448 w
->window_end_bytepos
14449 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14451 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14453 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14458 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
14461 w
->window_end_valid
= Qnil
;
14462 w
->desired_matrix
->no_scrolling_p
= 1;
14465 debug_method_add (w
, "try_window_reusing_current_matrix 2");
14475 /************************************************************************
14476 Window redisplay reusing current matrix when buffer has changed
14477 ************************************************************************/
14479 static struct glyph_row
*find_last_unchanged_at_beg_row
P_ ((struct window
*));
14480 static struct glyph_row
*find_first_unchanged_at_end_row
P_ ((struct window
*,
14482 static struct glyph_row
*
14483 find_last_row_displaying_text
P_ ((struct glyph_matrix
*, struct it
*,
14484 struct glyph_row
*));
14487 /* Return the last row in MATRIX displaying text. If row START is
14488 non-null, start searching with that row. IT gives the dimensions
14489 of the display. Value is null if matrix is empty; otherwise it is
14490 a pointer to the row found. */
14492 static struct glyph_row
*
14493 find_last_row_displaying_text (matrix
, it
, start
)
14494 struct glyph_matrix
*matrix
;
14496 struct glyph_row
*start
;
14498 struct glyph_row
*row
, *row_found
;
14500 /* Set row_found to the last row in IT->w's current matrix
14501 displaying text. The loop looks funny but think of partially
14504 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
14505 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14507 xassert (row
->enabled_p
);
14509 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
14518 /* Return the last row in the current matrix of W that is not affected
14519 by changes at the start of current_buffer that occurred since W's
14520 current matrix was built. Value is null if no such row exists.
14522 BEG_UNCHANGED us the number of characters unchanged at the start of
14523 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
14524 first changed character in current_buffer. Characters at positions <
14525 BEG + BEG_UNCHANGED are at the same buffer positions as they were
14526 when the current matrix was built. */
14528 static struct glyph_row
*
14529 find_last_unchanged_at_beg_row (w
)
14532 int first_changed_pos
= BEG
+ BEG_UNCHANGED
;
14533 struct glyph_row
*row
;
14534 struct glyph_row
*row_found
= NULL
;
14535 int yb
= window_text_bottom_y (w
);
14537 /* Find the last row displaying unchanged text. */
14538 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14539 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
14540 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
14543 if (/* If row ends before first_changed_pos, it is unchanged,
14544 except in some case. */
14545 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
14546 /* When row ends in ZV and we write at ZV it is not
14548 && !row
->ends_at_zv_p
14549 /* When first_changed_pos is the end of a continued line,
14550 row is not unchanged because it may be no longer
14552 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
14553 && (row
->continued_p
14554 || row
->exact_window_width_line_p
)))
14557 /* Stop if last visible row. */
14558 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
14566 /* Find the first glyph row in the current matrix of W that is not
14567 affected by changes at the end of current_buffer since the
14568 time W's current matrix was built.
14570 Return in *DELTA the number of chars by which buffer positions in
14571 unchanged text at the end of current_buffer must be adjusted.
14573 Return in *DELTA_BYTES the corresponding number of bytes.
14575 Value is null if no such row exists, i.e. all rows are affected by
14578 static struct glyph_row
*
14579 find_first_unchanged_at_end_row (w
, delta
, delta_bytes
)
14581 int *delta
, *delta_bytes
;
14583 struct glyph_row
*row
;
14584 struct glyph_row
*row_found
= NULL
;
14586 *delta
= *delta_bytes
= 0;
14588 /* Display must not have been paused, otherwise the current matrix
14589 is not up to date. */
14590 eassert (!NILP (w
->window_end_valid
));
14592 /* A value of window_end_pos >= END_UNCHANGED means that the window
14593 end is in the range of changed text. If so, there is no
14594 unchanged row at the end of W's current matrix. */
14595 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
14598 /* Set row to the last row in W's current matrix displaying text. */
14599 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
14601 /* If matrix is entirely empty, no unchanged row exists. */
14602 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14604 /* The value of row is the last glyph row in the matrix having a
14605 meaningful buffer position in it. The end position of row
14606 corresponds to window_end_pos. This allows us to translate
14607 buffer positions in the current matrix to current buffer
14608 positions for characters not in changed text. */
14609 int Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
14610 int Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
14611 int last_unchanged_pos
, last_unchanged_pos_old
;
14612 struct glyph_row
*first_text_row
14613 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14615 *delta
= Z
- Z_old
;
14616 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
14618 /* Set last_unchanged_pos to the buffer position of the last
14619 character in the buffer that has not been changed. Z is the
14620 index + 1 of the last character in current_buffer, i.e. by
14621 subtracting END_UNCHANGED we get the index of the last
14622 unchanged character, and we have to add BEG to get its buffer
14624 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
14625 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
14627 /* Search backward from ROW for a row displaying a line that
14628 starts at a minimum position >= last_unchanged_pos_old. */
14629 for (; row
> first_text_row
; --row
)
14631 /* This used to abort, but it can happen.
14632 It is ok to just stop the search instead here. KFS. */
14633 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14636 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
14641 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
14647 /* Make sure that glyph rows in the current matrix of window W
14648 reference the same glyph memory as corresponding rows in the
14649 frame's frame matrix. This function is called after scrolling W's
14650 current matrix on a terminal frame in try_window_id and
14651 try_window_reusing_current_matrix. */
14654 sync_frame_with_window_matrix_rows (w
)
14657 struct frame
*f
= XFRAME (w
->frame
);
14658 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
14660 /* Preconditions: W must be a leaf window and full-width. Its frame
14661 must have a frame matrix. */
14662 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
14663 xassert (WINDOW_FULL_WIDTH_P (w
));
14664 xassert (!FRAME_WINDOW_P (f
));
14666 /* If W is a full-width window, glyph pointers in W's current matrix
14667 have, by definition, to be the same as glyph pointers in the
14668 corresponding frame matrix. Note that frame matrices have no
14669 marginal areas (see build_frame_matrix). */
14670 window_row
= w
->current_matrix
->rows
;
14671 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
14672 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
14673 while (window_row
< window_row_end
)
14675 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
14676 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
14678 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
14679 frame_row
->glyphs
[TEXT_AREA
] = start
;
14680 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
14681 frame_row
->glyphs
[LAST_AREA
] = end
;
14683 /* Disable frame rows whose corresponding window rows have
14684 been disabled in try_window_id. */
14685 if (!window_row
->enabled_p
)
14686 frame_row
->enabled_p
= 0;
14688 ++window_row
, ++frame_row
;
14693 /* Find the glyph row in window W containing CHARPOS. Consider all
14694 rows between START and END (not inclusive). END null means search
14695 all rows to the end of the display area of W. Value is the row
14696 containing CHARPOS or null. */
14699 row_containing_pos (w
, charpos
, start
, end
, dy
)
14702 struct glyph_row
*start
, *end
;
14705 struct glyph_row
*row
= start
;
14708 /* If we happen to start on a header-line, skip that. */
14709 if (row
->mode_line_p
)
14712 if ((end
&& row
>= end
) || !row
->enabled_p
)
14715 last_y
= window_text_bottom_y (w
) - dy
;
14719 /* Give up if we have gone too far. */
14720 if (end
&& row
>= end
)
14722 /* This formerly returned if they were equal.
14723 I think that both quantities are of a "last plus one" type;
14724 if so, when they are equal, the row is within the screen. -- rms. */
14725 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
14728 /* If it is in this row, return this row. */
14729 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
14730 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
14731 /* The end position of a row equals the start
14732 position of the next row. If CHARPOS is there, we
14733 would rather display it in the next line, except
14734 when this line ends in ZV. */
14735 && !row
->ends_at_zv_p
14736 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
14737 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
14744 /* Try to redisplay window W by reusing its existing display. W's
14745 current matrix must be up to date when this function is called,
14746 i.e. window_end_valid must not be nil.
14750 1 if display has been updated
14751 0 if otherwise unsuccessful
14752 -1 if redisplay with same window start is known not to succeed
14754 The following steps are performed:
14756 1. Find the last row in the current matrix of W that is not
14757 affected by changes at the start of current_buffer. If no such row
14760 2. Find the first row in W's current matrix that is not affected by
14761 changes at the end of current_buffer. Maybe there is no such row.
14763 3. Display lines beginning with the row + 1 found in step 1 to the
14764 row found in step 2 or, if step 2 didn't find a row, to the end of
14767 4. If cursor is not known to appear on the window, give up.
14769 5. If display stopped at the row found in step 2, scroll the
14770 display and current matrix as needed.
14772 6. Maybe display some lines at the end of W, if we must. This can
14773 happen under various circumstances, like a partially visible line
14774 becoming fully visible, or because newly displayed lines are displayed
14775 in smaller font sizes.
14777 7. Update W's window end information. */
14783 struct frame
*f
= XFRAME (w
->frame
);
14784 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
14785 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
14786 struct glyph_row
*last_unchanged_at_beg_row
;
14787 struct glyph_row
*first_unchanged_at_end_row
;
14788 struct glyph_row
*row
;
14789 struct glyph_row
*bottom_row
;
14792 int delta
= 0, delta_bytes
= 0, stop_pos
, dvpos
, dy
;
14793 struct text_pos start_pos
;
14795 int first_unchanged_at_end_vpos
= 0;
14796 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
14797 struct text_pos start
;
14798 int first_changed_charpos
, last_changed_charpos
;
14801 if (inhibit_try_window_id
)
14805 /* This is handy for debugging. */
14807 #define GIVE_UP(X) \
14809 fprintf (stderr, "try_window_id give up %d\n", (X)); \
14813 #define GIVE_UP(X) return 0
14816 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
14818 /* Don't use this for mini-windows because these can show
14819 messages and mini-buffers, and we don't handle that here. */
14820 if (MINI_WINDOW_P (w
))
14823 /* This flag is used to prevent redisplay optimizations. */
14824 if (windows_or_buffers_changed
|| cursor_type_changed
)
14827 /* Verify that narrowing has not changed.
14828 Also verify that we were not told to prevent redisplay optimizations.
14829 It would be nice to further
14830 reduce the number of cases where this prevents try_window_id. */
14831 if (current_buffer
->clip_changed
14832 || current_buffer
->prevent_redisplay_optimizations_p
)
14835 /* Window must either use window-based redisplay or be full width. */
14836 if (!FRAME_WINDOW_P (f
)
14837 && (!FRAME_LINE_INS_DEL_OK (f
)
14838 || !WINDOW_FULL_WIDTH_P (w
)))
14841 /* Give up if point is known NOT to appear in W. */
14842 if (PT
< CHARPOS (start
))
14845 /* Another way to prevent redisplay optimizations. */
14846 if (XFASTINT (w
->last_modified
) == 0)
14849 /* Verify that window is not hscrolled. */
14850 if (XFASTINT (w
->hscroll
) != 0)
14853 /* Verify that display wasn't paused. */
14854 if (NILP (w
->window_end_valid
))
14857 /* Can't use this if highlighting a region because a cursor movement
14858 will do more than just set the cursor. */
14859 if (!NILP (Vtransient_mark_mode
)
14860 && !NILP (current_buffer
->mark_active
))
14863 /* Likewise if highlighting trailing whitespace. */
14864 if (!NILP (Vshow_trailing_whitespace
))
14867 /* Likewise if showing a region. */
14868 if (!NILP (w
->region_showing
))
14871 /* Can't use this if overlay arrow position and/or string have
14873 if (overlay_arrows_changed_p ())
14876 /* When word-wrap is on, adding a space to the first word of a
14877 wrapped line can change the wrap position, altering the line
14878 above it. It might be worthwhile to handle this more
14879 intelligently, but for now just redisplay from scratch. */
14880 if (!NILP (XBUFFER (w
->buffer
)->word_wrap
))
14883 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
14884 only if buffer has really changed. The reason is that the gap is
14885 initially at Z for freshly visited files. The code below would
14886 set end_unchanged to 0 in that case. */
14887 if (MODIFF
> SAVE_MODIFF
14888 /* This seems to happen sometimes after saving a buffer. */
14889 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
14891 if (GPT
- BEG
< BEG_UNCHANGED
)
14892 BEG_UNCHANGED
= GPT
- BEG
;
14893 if (Z
- GPT
< END_UNCHANGED
)
14894 END_UNCHANGED
= Z
- GPT
;
14897 /* The position of the first and last character that has been changed. */
14898 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
14899 last_changed_charpos
= Z
- END_UNCHANGED
;
14901 /* If window starts after a line end, and the last change is in
14902 front of that newline, then changes don't affect the display.
14903 This case happens with stealth-fontification. Note that although
14904 the display is unchanged, glyph positions in the matrix have to
14905 be adjusted, of course. */
14906 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
14907 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
14908 && ((last_changed_charpos
< CHARPOS (start
)
14909 && CHARPOS (start
) == BEGV
)
14910 || (last_changed_charpos
< CHARPOS (start
) - 1
14911 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
14913 int Z_old
, delta
, Z_BYTE_old
, delta_bytes
;
14914 struct glyph_row
*r0
;
14916 /* Compute how many chars/bytes have been added to or removed
14917 from the buffer. */
14918 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
14919 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
14921 delta_bytes
= Z_BYTE
- Z_BYTE_old
;
14923 /* Give up if PT is not in the window. Note that it already has
14924 been checked at the start of try_window_id that PT is not in
14925 front of the window start. */
14926 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + delta
)
14929 /* If window start is unchanged, we can reuse the whole matrix
14930 as is, after adjusting glyph positions. No need to compute
14931 the window end again, since its offset from Z hasn't changed. */
14932 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
14933 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + delta
14934 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + delta_bytes
14935 /* PT must not be in a partially visible line. */
14936 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + delta
14937 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
14939 /* Adjust positions in the glyph matrix. */
14940 if (delta
|| delta_bytes
)
14942 struct glyph_row
*r1
14943 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
14944 increment_matrix_positions (w
->current_matrix
,
14945 MATRIX_ROW_VPOS (r0
, current_matrix
),
14946 MATRIX_ROW_VPOS (r1
, current_matrix
),
14947 delta
, delta_bytes
);
14950 /* Set the cursor. */
14951 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
14953 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
14960 /* Handle the case that changes are all below what is displayed in
14961 the window, and that PT is in the window. This shortcut cannot
14962 be taken if ZV is visible in the window, and text has been added
14963 there that is visible in the window. */
14964 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
14965 /* ZV is not visible in the window, or there are no
14966 changes at ZV, actually. */
14967 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
14968 || first_changed_charpos
== last_changed_charpos
))
14970 struct glyph_row
*r0
;
14972 /* Give up if PT is not in the window. Note that it already has
14973 been checked at the start of try_window_id that PT is not in
14974 front of the window start. */
14975 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
14978 /* If window start is unchanged, we can reuse the whole matrix
14979 as is, without changing glyph positions since no text has
14980 been added/removed in front of the window end. */
14981 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
14982 if (TEXT_POS_EQUAL_P (start
, r0
->start
.pos
)
14983 /* PT must not be in a partially visible line. */
14984 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
14985 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
14987 /* We have to compute the window end anew since text
14988 can have been added/removed after it. */
14990 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
14991 w
->window_end_bytepos
14992 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
14994 /* Set the cursor. */
14995 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
14997 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15004 /* Give up if window start is in the changed area.
15006 The condition used to read
15008 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
15010 but why that was tested escapes me at the moment. */
15011 if (CHARPOS (start
) >= first_changed_charpos
15012 && CHARPOS (start
) <= last_changed_charpos
)
15015 /* Check that window start agrees with the start of the first glyph
15016 row in its current matrix. Check this after we know the window
15017 start is not in changed text, otherwise positions would not be
15019 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15020 if (!TEXT_POS_EQUAL_P (start
, row
->start
.pos
))
15023 /* Give up if the window ends in strings. Overlay strings
15024 at the end are difficult to handle, so don't try. */
15025 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
15026 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
15029 /* Compute the position at which we have to start displaying new
15030 lines. Some of the lines at the top of the window might be
15031 reusable because they are not displaying changed text. Find the
15032 last row in W's current matrix not affected by changes at the
15033 start of current_buffer. Value is null if changes start in the
15034 first line of window. */
15035 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
15036 if (last_unchanged_at_beg_row
)
15038 /* Avoid starting to display in the moddle of a character, a TAB
15039 for instance. This is easier than to set up the iterator
15040 exactly, and it's not a frequent case, so the additional
15041 effort wouldn't really pay off. */
15042 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
15043 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
15044 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
15045 --last_unchanged_at_beg_row
;
15047 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
15050 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
15052 start_pos
= it
.current
.pos
;
15054 /* Start displaying new lines in the desired matrix at the same
15055 vpos we would use in the current matrix, i.e. below
15056 last_unchanged_at_beg_row. */
15057 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
15059 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15060 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
15062 xassert (it
.hpos
== 0 && it
.current_x
== 0);
15066 /* There are no reusable lines at the start of the window.
15067 Start displaying in the first text line. */
15068 start_display (&it
, w
, start
);
15069 it
.vpos
= it
.first_vpos
;
15070 start_pos
= it
.current
.pos
;
15073 /* Find the first row that is not affected by changes at the end of
15074 the buffer. Value will be null if there is no unchanged row, in
15075 which case we must redisplay to the end of the window. delta
15076 will be set to the value by which buffer positions beginning with
15077 first_unchanged_at_end_row have to be adjusted due to text
15079 first_unchanged_at_end_row
15080 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
15081 IF_DEBUG (debug_delta
= delta
);
15082 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
15084 /* Set stop_pos to the buffer position up to which we will have to
15085 display new lines. If first_unchanged_at_end_row != NULL, this
15086 is the buffer position of the start of the line displayed in that
15087 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
15088 that we don't stop at a buffer position. */
15090 if (first_unchanged_at_end_row
)
15092 xassert (last_unchanged_at_beg_row
== NULL
15093 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
15095 /* If this is a continuation line, move forward to the next one
15096 that isn't. Changes in lines above affect this line.
15097 Caution: this may move first_unchanged_at_end_row to a row
15098 not displaying text. */
15099 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
15100 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15101 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15102 < it
.last_visible_y
))
15103 ++first_unchanged_at_end_row
;
15105 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15106 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15107 >= it
.last_visible_y
))
15108 first_unchanged_at_end_row
= NULL
;
15111 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
15113 first_unchanged_at_end_vpos
15114 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
15115 xassert (stop_pos
>= Z
- END_UNCHANGED
);
15118 else if (last_unchanged_at_beg_row
== NULL
)
15124 /* Either there is no unchanged row at the end, or the one we have
15125 now displays text. This is a necessary condition for the window
15126 end pos calculation at the end of this function. */
15127 xassert (first_unchanged_at_end_row
== NULL
15128 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
15130 debug_last_unchanged_at_beg_vpos
15131 = (last_unchanged_at_beg_row
15132 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
15134 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
15136 #endif /* GLYPH_DEBUG != 0 */
15139 /* Display new lines. Set last_text_row to the last new line
15140 displayed which has text on it, i.e. might end up as being the
15141 line where the window_end_vpos is. */
15142 w
->cursor
.vpos
= -1;
15143 last_text_row
= NULL
;
15144 overlay_arrow_seen
= 0;
15145 while (it
.current_y
< it
.last_visible_y
15146 && !fonts_changed_p
15147 && (first_unchanged_at_end_row
== NULL
15148 || IT_CHARPOS (it
) < stop_pos
))
15150 if (display_line (&it
))
15151 last_text_row
= it
.glyph_row
- 1;
15154 if (fonts_changed_p
)
15158 /* Compute differences in buffer positions, y-positions etc. for
15159 lines reused at the bottom of the window. Compute what we can
15161 if (first_unchanged_at_end_row
15162 /* No lines reused because we displayed everything up to the
15163 bottom of the window. */
15164 && it
.current_y
< it
.last_visible_y
)
15167 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
15169 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
15170 run
.current_y
= first_unchanged_at_end_row
->y
;
15171 run
.desired_y
= run
.current_y
+ dy
;
15172 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
15176 delta
= delta_bytes
= dvpos
= dy
15177 = run
.current_y
= run
.desired_y
= run
.height
= 0;
15178 first_unchanged_at_end_row
= NULL
;
15180 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
15183 /* Find the cursor if not already found. We have to decide whether
15184 PT will appear on this window (it sometimes doesn't, but this is
15185 not a very frequent case.) This decision has to be made before
15186 the current matrix is altered. A value of cursor.vpos < 0 means
15187 that PT is either in one of the lines beginning at
15188 first_unchanged_at_end_row or below the window. Don't care for
15189 lines that might be displayed later at the window end; as
15190 mentioned, this is not a frequent case. */
15191 if (w
->cursor
.vpos
< 0)
15193 /* Cursor in unchanged rows at the top? */
15194 if (PT
< CHARPOS (start_pos
)
15195 && last_unchanged_at_beg_row
)
15197 row
= row_containing_pos (w
, PT
,
15198 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
15199 last_unchanged_at_beg_row
+ 1, 0);
15201 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15204 /* Start from first_unchanged_at_end_row looking for PT. */
15205 else if (first_unchanged_at_end_row
)
15207 row
= row_containing_pos (w
, PT
- delta
,
15208 first_unchanged_at_end_row
, NULL
, 0);
15210 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
15211 delta_bytes
, dy
, dvpos
);
15214 /* Give up if cursor was not found. */
15215 if (w
->cursor
.vpos
< 0)
15217 clear_glyph_matrix (w
->desired_matrix
);
15222 /* Don't let the cursor end in the scroll margins. */
15224 int this_scroll_margin
, cursor_height
;
15226 this_scroll_margin
= max (0, scroll_margin
);
15227 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15228 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
15229 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
15231 if ((w
->cursor
.y
< this_scroll_margin
15232 && CHARPOS (start
) > BEGV
)
15233 /* Old redisplay didn't take scroll margin into account at the bottom,
15234 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
15235 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
15236 ? cursor_height
+ this_scroll_margin
15237 : 1)) > it
.last_visible_y
)
15239 w
->cursor
.vpos
= -1;
15240 clear_glyph_matrix (w
->desired_matrix
);
15245 /* Scroll the display. Do it before changing the current matrix so
15246 that xterm.c doesn't get confused about where the cursor glyph is
15248 if (dy
&& run
.height
)
15252 if (FRAME_WINDOW_P (f
))
15254 FRAME_RIF (f
)->update_window_begin_hook (w
);
15255 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15256 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15257 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15261 /* Terminal frame. In this case, dvpos gives the number of
15262 lines to scroll by; dvpos < 0 means scroll up. */
15263 int first_unchanged_at_end_vpos
15264 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
15265 int from
= WINDOW_TOP_EDGE_LINE (w
) + first_unchanged_at_end_vpos
;
15266 int end
= (WINDOW_TOP_EDGE_LINE (w
)
15267 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
15268 + window_internal_height (w
));
15270 /* Perform the operation on the screen. */
15273 /* Scroll last_unchanged_at_beg_row to the end of the
15274 window down dvpos lines. */
15275 set_terminal_window (f
, end
);
15277 /* On dumb terminals delete dvpos lines at the end
15278 before inserting dvpos empty lines. */
15279 if (!FRAME_SCROLL_REGION_OK (f
))
15280 ins_del_lines (f
, end
- dvpos
, -dvpos
);
15282 /* Insert dvpos empty lines in front of
15283 last_unchanged_at_beg_row. */
15284 ins_del_lines (f
, from
, dvpos
);
15286 else if (dvpos
< 0)
15288 /* Scroll up last_unchanged_at_beg_vpos to the end of
15289 the window to last_unchanged_at_beg_vpos - |dvpos|. */
15290 set_terminal_window (f
, end
);
15292 /* Delete dvpos lines in front of
15293 last_unchanged_at_beg_vpos. ins_del_lines will set
15294 the cursor to the given vpos and emit |dvpos| delete
15296 ins_del_lines (f
, from
+ dvpos
, dvpos
);
15298 /* On a dumb terminal insert dvpos empty lines at the
15300 if (!FRAME_SCROLL_REGION_OK (f
))
15301 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
15304 set_terminal_window (f
, 0);
15310 /* Shift reused rows of the current matrix to the right position.
15311 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
15313 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15314 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
15317 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
15318 bottom_vpos
, dvpos
);
15319 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
15322 else if (dvpos
> 0)
15324 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
15325 bottom_vpos
, dvpos
);
15326 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
15327 first_unchanged_at_end_vpos
+ dvpos
, 0);
15330 /* For frame-based redisplay, make sure that current frame and window
15331 matrix are in sync with respect to glyph memory. */
15332 if (!FRAME_WINDOW_P (f
))
15333 sync_frame_with_window_matrix_rows (w
);
15335 /* Adjust buffer positions in reused rows. */
15336 if (delta
|| delta_bytes
)
15337 increment_matrix_positions (current_matrix
,
15338 first_unchanged_at_end_vpos
+ dvpos
,
15339 bottom_vpos
, delta
, delta_bytes
);
15341 /* Adjust Y positions. */
15343 shift_glyph_matrix (w
, current_matrix
,
15344 first_unchanged_at_end_vpos
+ dvpos
,
15347 if (first_unchanged_at_end_row
)
15349 first_unchanged_at_end_row
+= dvpos
;
15350 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
15351 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
15352 first_unchanged_at_end_row
= NULL
;
15355 /* If scrolling up, there may be some lines to display at the end of
15357 last_text_row_at_end
= NULL
;
15360 /* Scrolling up can leave for example a partially visible line
15361 at the end of the window to be redisplayed. */
15362 /* Set last_row to the glyph row in the current matrix where the
15363 window end line is found. It has been moved up or down in
15364 the matrix by dvpos. */
15365 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
15366 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
15368 /* If last_row is the window end line, it should display text. */
15369 xassert (last_row
->displays_text_p
);
15371 /* If window end line was partially visible before, begin
15372 displaying at that line. Otherwise begin displaying with the
15373 line following it. */
15374 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
15376 init_to_row_start (&it
, w
, last_row
);
15377 it
.vpos
= last_vpos
;
15378 it
.current_y
= last_row
->y
;
15382 init_to_row_end (&it
, w
, last_row
);
15383 it
.vpos
= 1 + last_vpos
;
15384 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
15388 /* We may start in a continuation line. If so, we have to
15389 get the right continuation_lines_width and current_x. */
15390 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
15391 it
.hpos
= it
.current_x
= 0;
15393 /* Display the rest of the lines at the window end. */
15394 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15395 while (it
.current_y
< it
.last_visible_y
15396 && !fonts_changed_p
)
15398 /* Is it always sure that the display agrees with lines in
15399 the current matrix? I don't think so, so we mark rows
15400 displayed invalid in the current matrix by setting their
15401 enabled_p flag to zero. */
15402 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
15403 if (display_line (&it
))
15404 last_text_row_at_end
= it
.glyph_row
- 1;
15408 /* Update window_end_pos and window_end_vpos. */
15409 if (first_unchanged_at_end_row
15410 && !last_text_row_at_end
)
15412 /* Window end line if one of the preserved rows from the current
15413 matrix. Set row to the last row displaying text in current
15414 matrix starting at first_unchanged_at_end_row, after
15416 xassert (first_unchanged_at_end_row
->displays_text_p
);
15417 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
15418 first_unchanged_at_end_row
);
15419 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
15421 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15422 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15424 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
15425 xassert (w
->window_end_bytepos
>= 0);
15426 IF_DEBUG (debug_method_add (w
, "A"));
15428 else if (last_text_row_at_end
)
15431 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
15432 w
->window_end_bytepos
15433 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
15435 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
15436 xassert (w
->window_end_bytepos
>= 0);
15437 IF_DEBUG (debug_method_add (w
, "B"));
15439 else if (last_text_row
)
15441 /* We have displayed either to the end of the window or at the
15442 end of the window, i.e. the last row with text is to be found
15443 in the desired matrix. */
15445 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15446 w
->window_end_bytepos
15447 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15449 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
15450 xassert (w
->window_end_bytepos
>= 0);
15452 else if (first_unchanged_at_end_row
== NULL
15453 && last_text_row
== NULL
15454 && last_text_row_at_end
== NULL
)
15456 /* Displayed to end of window, but no line containing text was
15457 displayed. Lines were deleted at the end of the window. */
15458 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
15459 int vpos
= XFASTINT (w
->window_end_vpos
);
15460 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
15461 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
15464 row
== NULL
&& vpos
>= first_vpos
;
15465 --vpos
, --current_row
, --desired_row
)
15467 if (desired_row
->enabled_p
)
15469 if (desired_row
->displays_text_p
)
15472 else if (current_row
->displays_text_p
)
15476 xassert (row
!= NULL
);
15477 w
->window_end_vpos
= make_number (vpos
+ 1);
15478 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15479 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15480 xassert (w
->window_end_bytepos
>= 0);
15481 IF_DEBUG (debug_method_add (w
, "C"));
15486 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
15487 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
15489 /* Record that display has not been completed. */
15490 w
->window_end_valid
= Qnil
;
15491 w
->desired_matrix
->no_scrolling_p
= 1;
15499 /***********************************************************************
15500 More debugging support
15501 ***********************************************************************/
15505 void dump_glyph_row
P_ ((struct glyph_row
*, int, int));
15506 void dump_glyph_matrix
P_ ((struct glyph_matrix
*, int));
15507 void dump_glyph
P_ ((struct glyph_row
*, struct glyph
*, int));
15510 /* Dump the contents of glyph matrix MATRIX on stderr.
15512 GLYPHS 0 means don't show glyph contents.
15513 GLYPHS 1 means show glyphs in short form
15514 GLYPHS > 1 means show glyphs in long form. */
15517 dump_glyph_matrix (matrix
, glyphs
)
15518 struct glyph_matrix
*matrix
;
15522 for (i
= 0; i
< matrix
->nrows
; ++i
)
15523 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
15527 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
15528 the glyph row and area where the glyph comes from. */
15531 dump_glyph (row
, glyph
, area
)
15532 struct glyph_row
*row
;
15533 struct glyph
*glyph
;
15536 if (glyph
->type
== CHAR_GLYPH
)
15539 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15540 glyph
- row
->glyphs
[TEXT_AREA
],
15543 (BUFFERP (glyph
->object
)
15545 : (STRINGP (glyph
->object
)
15548 glyph
->pixel_width
,
15550 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
15554 glyph
->left_box_line_p
,
15555 glyph
->right_box_line_p
);
15557 else if (glyph
->type
== STRETCH_GLYPH
)
15560 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15561 glyph
- row
->glyphs
[TEXT_AREA
],
15564 (BUFFERP (glyph
->object
)
15566 : (STRINGP (glyph
->object
)
15569 glyph
->pixel_width
,
15573 glyph
->left_box_line_p
,
15574 glyph
->right_box_line_p
);
15576 else if (glyph
->type
== IMAGE_GLYPH
)
15579 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15580 glyph
- row
->glyphs
[TEXT_AREA
],
15583 (BUFFERP (glyph
->object
)
15585 : (STRINGP (glyph
->object
)
15588 glyph
->pixel_width
,
15592 glyph
->left_box_line_p
,
15593 glyph
->right_box_line_p
);
15595 else if (glyph
->type
== COMPOSITE_GLYPH
)
15598 " %5d %4c %6d %c %3d 0x%05x",
15599 glyph
- row
->glyphs
[TEXT_AREA
],
15602 (BUFFERP (glyph
->object
)
15604 : (STRINGP (glyph
->object
)
15607 glyph
->pixel_width
,
15609 if (glyph
->u
.cmp
.automatic
)
15612 glyph
->u
.cmp
.from
, glyph
->u
.cmp
.to
);
15613 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
15615 glyph
->left_box_line_p
,
15616 glyph
->right_box_line_p
);
15621 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
15622 GLYPHS 0 means don't show glyph contents.
15623 GLYPHS 1 means show glyphs in short form
15624 GLYPHS > 1 means show glyphs in long form. */
15627 dump_glyph_row (row
, vpos
, glyphs
)
15628 struct glyph_row
*row
;
15633 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
15634 fprintf (stderr
, "======================================================================\n");
15636 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d\
15637 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
15639 MATRIX_ROW_START_CHARPOS (row
),
15640 MATRIX_ROW_END_CHARPOS (row
),
15641 row
->used
[TEXT_AREA
],
15642 row
->contains_overlapping_glyphs_p
,
15644 row
->truncated_on_left_p
,
15645 row
->truncated_on_right_p
,
15647 MATRIX_ROW_CONTINUATION_LINE_P (row
),
15648 row
->displays_text_p
,
15651 row
->ends_in_middle_of_char_p
,
15652 row
->starts_in_middle_of_char_p
,
15658 row
->visible_height
,
15661 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
15662 row
->end
.overlay_string_index
,
15663 row
->continuation_lines_width
);
15664 fprintf (stderr
, "%9d %5d\n",
15665 CHARPOS (row
->start
.string_pos
),
15666 CHARPOS (row
->end
.string_pos
));
15667 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
15668 row
->end
.dpvec_index
);
15675 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
15677 struct glyph
*glyph
= row
->glyphs
[area
];
15678 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
15680 /* Glyph for a line end in text. */
15681 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
15684 if (glyph
< glyph_end
)
15685 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
15687 for (; glyph
< glyph_end
; ++glyph
)
15688 dump_glyph (row
, glyph
, area
);
15691 else if (glyphs
== 1)
15695 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
15697 char *s
= (char *) alloca (row
->used
[area
] + 1);
15700 for (i
= 0; i
< row
->used
[area
]; ++i
)
15702 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
15703 if (glyph
->type
== CHAR_GLYPH
15704 && glyph
->u
.ch
< 0x80
15705 && glyph
->u
.ch
>= ' ')
15706 s
[i
] = glyph
->u
.ch
;
15712 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
15718 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
15719 Sdump_glyph_matrix
, 0, 1, "p",
15720 doc
: /* Dump the current matrix of the selected window to stderr.
15721 Shows contents of glyph row structures. With non-nil
15722 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
15723 glyphs in short form, otherwise show glyphs in long form. */)
15725 Lisp_Object glyphs
;
15727 struct window
*w
= XWINDOW (selected_window
);
15728 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15730 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
15731 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
15732 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
15733 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
15734 fprintf (stderr
, "=============================================\n");
15735 dump_glyph_matrix (w
->current_matrix
,
15736 NILP (glyphs
) ? 0 : XINT (glyphs
));
15741 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
15742 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
15745 struct frame
*f
= XFRAME (selected_frame
);
15746 dump_glyph_matrix (f
->current_matrix
, 1);
15751 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
15752 doc
: /* Dump glyph row ROW to stderr.
15753 GLYPH 0 means don't dump glyphs.
15754 GLYPH 1 means dump glyphs in short form.
15755 GLYPH > 1 or omitted means dump glyphs in long form. */)
15757 Lisp_Object row
, glyphs
;
15759 struct glyph_matrix
*matrix
;
15762 CHECK_NUMBER (row
);
15763 matrix
= XWINDOW (selected_window
)->current_matrix
;
15765 if (vpos
>= 0 && vpos
< matrix
->nrows
)
15766 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
15768 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
15773 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
15774 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
15775 GLYPH 0 means don't dump glyphs.
15776 GLYPH 1 means dump glyphs in short form.
15777 GLYPH > 1 or omitted means dump glyphs in long form. */)
15779 Lisp_Object row
, glyphs
;
15781 struct frame
*sf
= SELECTED_FRAME ();
15782 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
15785 CHECK_NUMBER (row
);
15787 if (vpos
>= 0 && vpos
< m
->nrows
)
15788 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
15789 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
15794 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
15795 doc
: /* Toggle tracing of redisplay.
15796 With ARG, turn tracing on if and only if ARG is positive. */)
15801 trace_redisplay_p
= !trace_redisplay_p
;
15804 arg
= Fprefix_numeric_value (arg
);
15805 trace_redisplay_p
= XINT (arg
) > 0;
15812 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
15813 doc
: /* Like `format', but print result to stderr.
15814 usage: (trace-to-stderr STRING &rest OBJECTS) */)
15819 Lisp_Object s
= Fformat (nargs
, args
);
15820 fprintf (stderr
, "%s", SDATA (s
));
15824 #endif /* GLYPH_DEBUG */
15828 /***********************************************************************
15829 Building Desired Matrix Rows
15830 ***********************************************************************/
15832 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
15833 Used for non-window-redisplay windows, and for windows w/o left fringe. */
15835 static struct glyph_row
*
15836 get_overlay_arrow_glyph_row (w
, overlay_arrow_string
)
15838 Lisp_Object overlay_arrow_string
;
15840 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
15841 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15842 struct buffer
*old
= current_buffer
;
15843 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
15844 int arrow_len
= SCHARS (overlay_arrow_string
);
15845 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
15846 const unsigned char *p
;
15849 int n_glyphs_before
;
15851 set_buffer_temp (buffer
);
15852 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
15853 it
.glyph_row
->used
[TEXT_AREA
] = 0;
15854 SET_TEXT_POS (it
.position
, 0, 0);
15856 multibyte_p
= !NILP (buffer
->enable_multibyte_characters
);
15858 while (p
< arrow_end
)
15860 Lisp_Object face
, ilisp
;
15862 /* Get the next character. */
15864 it
.c
= string_char_and_length (p
, &it
.len
);
15866 it
.c
= *p
, it
.len
= 1;
15869 /* Get its face. */
15870 ilisp
= make_number (p
- arrow_string
);
15871 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
15872 it
.face_id
= compute_char_face (f
, it
.c
, face
);
15874 /* Compute its width, get its glyphs. */
15875 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
15876 SET_TEXT_POS (it
.position
, -1, -1);
15877 PRODUCE_GLYPHS (&it
);
15879 /* If this character doesn't fit any more in the line, we have
15880 to remove some glyphs. */
15881 if (it
.current_x
> it
.last_visible_x
)
15883 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
15888 set_buffer_temp (old
);
15889 return it
.glyph_row
;
15893 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
15894 glyphs are only inserted for terminal frames since we can't really
15895 win with truncation glyphs when partially visible glyphs are
15896 involved. Which glyphs to insert is determined by
15897 produce_special_glyphs. */
15900 insert_left_trunc_glyphs (it
)
15903 struct it truncate_it
;
15904 struct glyph
*from
, *end
, *to
, *toend
;
15906 xassert (!FRAME_WINDOW_P (it
->f
));
15908 /* Get the truncation glyphs. */
15910 truncate_it
.current_x
= 0;
15911 truncate_it
.face_id
= DEFAULT_FACE_ID
;
15912 truncate_it
.glyph_row
= &scratch_glyph_row
;
15913 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
15914 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
15915 truncate_it
.object
= make_number (0);
15916 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
15918 /* Overwrite glyphs from IT with truncation glyphs. */
15919 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
15920 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
15921 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
15922 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
15927 /* There may be padding glyphs left over. Overwrite them too. */
15928 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
15930 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
15936 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
15940 /* Compute the pixel height and width of IT->glyph_row.
15942 Most of the time, ascent and height of a display line will be equal
15943 to the max_ascent and max_height values of the display iterator
15944 structure. This is not the case if
15946 1. We hit ZV without displaying anything. In this case, max_ascent
15947 and max_height will be zero.
15949 2. We have some glyphs that don't contribute to the line height.
15950 (The glyph row flag contributes_to_line_height_p is for future
15951 pixmap extensions).
15953 The first case is easily covered by using default values because in
15954 these cases, the line height does not really matter, except that it
15955 must not be zero. */
15958 compute_line_metrics (it
)
15961 struct glyph_row
*row
= it
->glyph_row
;
15964 if (FRAME_WINDOW_P (it
->f
))
15966 int i
, min_y
, max_y
;
15968 /* The line may consist of one space only, that was added to
15969 place the cursor on it. If so, the row's height hasn't been
15971 if (row
->height
== 0)
15973 if (it
->max_ascent
+ it
->max_descent
== 0)
15974 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
15975 row
->ascent
= it
->max_ascent
;
15976 row
->height
= it
->max_ascent
+ it
->max_descent
;
15977 row
->phys_ascent
= it
->max_phys_ascent
;
15978 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
15979 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
15982 /* Compute the width of this line. */
15983 row
->pixel_width
= row
->x
;
15984 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
15985 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
15987 xassert (row
->pixel_width
>= 0);
15988 xassert (row
->ascent
>= 0 && row
->height
> 0);
15990 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
15991 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
15993 /* If first line's physical ascent is larger than its logical
15994 ascent, use the physical ascent, and make the row taller.
15995 This makes accented characters fully visible. */
15996 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
15997 && row
->phys_ascent
> row
->ascent
)
15999 row
->height
+= row
->phys_ascent
- row
->ascent
;
16000 row
->ascent
= row
->phys_ascent
;
16003 /* Compute how much of the line is visible. */
16004 row
->visible_height
= row
->height
;
16006 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
16007 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
16009 if (row
->y
< min_y
)
16010 row
->visible_height
-= min_y
- row
->y
;
16011 if (row
->y
+ row
->height
> max_y
)
16012 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16016 row
->pixel_width
= row
->used
[TEXT_AREA
];
16017 if (row
->continued_p
)
16018 row
->pixel_width
-= it
->continuation_pixel_width
;
16019 else if (row
->truncated_on_right_p
)
16020 row
->pixel_width
-= it
->truncation_pixel_width
;
16021 row
->ascent
= row
->phys_ascent
= 0;
16022 row
->height
= row
->phys_height
= row
->visible_height
= 1;
16023 row
->extra_line_spacing
= 0;
16026 /* Compute a hash code for this row. */
16028 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16029 for (i
= 0; i
< row
->used
[area
]; ++i
)
16030 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
16031 + row
->glyphs
[area
][i
].u
.val
16032 + row
->glyphs
[area
][i
].face_id
16033 + row
->glyphs
[area
][i
].padding_p
16034 + (row
->glyphs
[area
][i
].type
<< 2));
16036 it
->max_ascent
= it
->max_descent
= 0;
16037 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
16041 /* Append one space to the glyph row of iterator IT if doing a
16042 window-based redisplay. The space has the same face as
16043 IT->face_id. Value is non-zero if a space was added.
16045 This function is called to make sure that there is always one glyph
16046 at the end of a glyph row that the cursor can be set on under
16047 window-systems. (If there weren't such a glyph we would not know
16048 how wide and tall a box cursor should be displayed).
16050 At the same time this space let's a nicely handle clearing to the
16051 end of the line if the row ends in italic text. */
16054 append_space_for_newline (it
, default_face_p
)
16056 int default_face_p
;
16058 if (FRAME_WINDOW_P (it
->f
))
16060 int n
= it
->glyph_row
->used
[TEXT_AREA
];
16062 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
16063 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
16065 /* Save some values that must not be changed.
16066 Must save IT->c and IT->len because otherwise
16067 ITERATOR_AT_END_P wouldn't work anymore after
16068 append_space_for_newline has been called. */
16069 enum display_element_type saved_what
= it
->what
;
16070 int saved_c
= it
->c
, saved_len
= it
->len
;
16071 int saved_x
= it
->current_x
;
16072 int saved_face_id
= it
->face_id
;
16073 struct text_pos saved_pos
;
16074 Lisp_Object saved_object
;
16077 saved_object
= it
->object
;
16078 saved_pos
= it
->position
;
16080 it
->what
= IT_CHARACTER
;
16081 bzero (&it
->position
, sizeof it
->position
);
16082 it
->object
= make_number (0);
16086 if (default_face_p
)
16087 it
->face_id
= DEFAULT_FACE_ID
;
16088 else if (it
->face_before_selective_p
)
16089 it
->face_id
= it
->saved_face_id
;
16090 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
16091 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
16093 PRODUCE_GLYPHS (it
);
16095 it
->override_ascent
= -1;
16096 it
->constrain_row_ascent_descent_p
= 0;
16097 it
->current_x
= saved_x
;
16098 it
->object
= saved_object
;
16099 it
->position
= saved_pos
;
16100 it
->what
= saved_what
;
16101 it
->face_id
= saved_face_id
;
16102 it
->len
= saved_len
;
16112 /* Extend the face of the last glyph in the text area of IT->glyph_row
16113 to the end of the display line. Called from display_line.
16114 If the glyph row is empty, add a space glyph to it so that we
16115 know the face to draw. Set the glyph row flag fill_line_p. */
16118 extend_face_to_end_of_line (it
)
16122 struct frame
*f
= it
->f
;
16124 /* If line is already filled, do nothing. */
16125 if (it
->current_x
>= it
->last_visible_x
)
16128 /* Face extension extends the background and box of IT->face_id
16129 to the end of the line. If the background equals the background
16130 of the frame, we don't have to do anything. */
16131 if (it
->face_before_selective_p
)
16132 face
= FACE_FROM_ID (it
->f
, it
->saved_face_id
);
16134 face
= FACE_FROM_ID (f
, it
->face_id
);
16136 if (FRAME_WINDOW_P (f
)
16137 && it
->glyph_row
->displays_text_p
16138 && face
->box
== FACE_NO_BOX
16139 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
16143 /* Set the glyph row flag indicating that the face of the last glyph
16144 in the text area has to be drawn to the end of the text area. */
16145 it
->glyph_row
->fill_line_p
= 1;
16147 /* If current character of IT is not ASCII, make sure we have the
16148 ASCII face. This will be automatically undone the next time
16149 get_next_display_element returns a multibyte character. Note
16150 that the character will always be single byte in unibyte
16152 if (!ASCII_CHAR_P (it
->c
))
16154 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
16157 if (FRAME_WINDOW_P (f
))
16159 /* If the row is empty, add a space with the current face of IT,
16160 so that we know which face to draw. */
16161 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
16163 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
16164 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
16165 it
->glyph_row
->used
[TEXT_AREA
] = 1;
16170 /* Save some values that must not be changed. */
16171 int saved_x
= it
->current_x
;
16172 struct text_pos saved_pos
;
16173 Lisp_Object saved_object
;
16174 enum display_element_type saved_what
= it
->what
;
16175 int saved_face_id
= it
->face_id
;
16177 saved_object
= it
->object
;
16178 saved_pos
= it
->position
;
16180 it
->what
= IT_CHARACTER
;
16181 bzero (&it
->position
, sizeof it
->position
);
16182 it
->object
= make_number (0);
16185 it
->face_id
= face
->id
;
16187 PRODUCE_GLYPHS (it
);
16189 while (it
->current_x
<= it
->last_visible_x
)
16190 PRODUCE_GLYPHS (it
);
16192 /* Don't count these blanks really. It would let us insert a left
16193 truncation glyph below and make us set the cursor on them, maybe. */
16194 it
->current_x
= saved_x
;
16195 it
->object
= saved_object
;
16196 it
->position
= saved_pos
;
16197 it
->what
= saved_what
;
16198 it
->face_id
= saved_face_id
;
16203 /* Value is non-zero if text starting at CHARPOS in current_buffer is
16204 trailing whitespace. */
16207 trailing_whitespace_p (charpos
)
16210 int bytepos
= CHAR_TO_BYTE (charpos
);
16213 while (bytepos
< ZV_BYTE
16214 && (c
= FETCH_CHAR (bytepos
),
16215 c
== ' ' || c
== '\t'))
16218 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
16220 if (bytepos
!= PT_BYTE
)
16227 /* Highlight trailing whitespace, if any, in ROW. */
16230 highlight_trailing_whitespace (f
, row
)
16232 struct glyph_row
*row
;
16234 int used
= row
->used
[TEXT_AREA
];
16238 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
16239 struct glyph
*glyph
= start
+ used
- 1;
16241 /* Skip over glyphs inserted to display the cursor at the
16242 end of a line, for extending the face of the last glyph
16243 to the end of the line on terminals, and for truncation
16244 and continuation glyphs. */
16245 while (glyph
>= start
16246 && glyph
->type
== CHAR_GLYPH
16247 && INTEGERP (glyph
->object
))
16250 /* If last glyph is a space or stretch, and it's trailing
16251 whitespace, set the face of all trailing whitespace glyphs in
16252 IT->glyph_row to `trailing-whitespace'. */
16254 && BUFFERP (glyph
->object
)
16255 && (glyph
->type
== STRETCH_GLYPH
16256 || (glyph
->type
== CHAR_GLYPH
16257 && glyph
->u
.ch
== ' '))
16258 && trailing_whitespace_p (glyph
->charpos
))
16260 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
16264 while (glyph
>= start
16265 && BUFFERP (glyph
->object
)
16266 && (glyph
->type
== STRETCH_GLYPH
16267 || (glyph
->type
== CHAR_GLYPH
16268 && glyph
->u
.ch
== ' ')))
16269 (glyph
--)->face_id
= face_id
;
16275 /* Value is non-zero if glyph row ROW in window W should be
16276 used to hold the cursor. */
16279 cursor_row_p (w
, row
)
16281 struct glyph_row
*row
;
16283 int cursor_row_p
= 1;
16285 if (PT
== MATRIX_ROW_END_CHARPOS (row
))
16287 /* Suppose the row ends on a string.
16288 Unless the row is continued, that means it ends on a newline
16289 in the string. If it's anything other than a display string
16290 (e.g. a before-string from an overlay), we don't want the
16291 cursor there. (This heuristic seems to give the optimal
16292 behavior for the various types of multi-line strings.) */
16293 if (CHARPOS (row
->end
.string_pos
) >= 0)
16295 if (row
->continued_p
)
16299 /* Check for `display' property. */
16300 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
16301 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
16302 struct glyph
*glyph
;
16305 for (glyph
= end
; glyph
>= beg
; --glyph
)
16306 if (STRINGP (glyph
->object
))
16309 = Fget_char_property (make_number (PT
),
16313 && display_prop_string_p (prop
, glyph
->object
));
16318 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
16320 /* If the row ends in middle of a real character,
16321 and the line is continued, we want the cursor here.
16322 That's because MATRIX_ROW_END_CHARPOS would equal
16323 PT if PT is before the character. */
16324 if (!row
->ends_in_ellipsis_p
)
16325 cursor_row_p
= row
->continued_p
;
16327 /* If the row ends in an ellipsis, then
16328 MATRIX_ROW_END_CHARPOS will equal point after the invisible text.
16329 We want that position to be displayed after the ellipsis. */
16332 /* If the row ends at ZV, display the cursor at the end of that
16333 row instead of at the start of the row below. */
16334 else if (row
->ends_at_zv_p
)
16340 return cursor_row_p
;
16345 /* Push the display property PROP so that it will be rendered at the
16346 current position in IT. Return 1 if PROP was successfully pushed,
16350 push_display_prop (struct it
*it
, Lisp_Object prop
)
16354 if (STRINGP (prop
))
16356 if (SCHARS (prop
) == 0)
16363 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
16364 it
->current
.overlay_string_index
= -1;
16365 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
16366 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
16367 it
->method
= GET_FROM_STRING
;
16368 it
->stop_charpos
= 0;
16370 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
16372 it
->method
= GET_FROM_STRETCH
;
16375 #ifdef HAVE_WINDOW_SYSTEM
16376 else if (IMAGEP (prop
))
16378 it
->what
= IT_IMAGE
;
16379 it
->image_id
= lookup_image (it
->f
, prop
);
16380 it
->method
= GET_FROM_IMAGE
;
16382 #endif /* HAVE_WINDOW_SYSTEM */
16385 pop_it (it
); /* bogus display property, give up */
16392 /* Return the character-property PROP at the current position in IT. */
16395 get_it_property (it
, prop
)
16399 Lisp_Object position
;
16401 if (STRINGP (it
->object
))
16402 position
= make_number (IT_STRING_CHARPOS (*it
));
16403 else if (BUFFERP (it
->object
))
16404 position
= make_number (IT_CHARPOS (*it
));
16408 return Fget_char_property (position
, prop
, it
->object
);
16411 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
16414 handle_line_prefix (struct it
*it
)
16416 Lisp_Object prefix
;
16417 if (it
->continuation_lines_width
> 0)
16419 prefix
= get_it_property (it
, Qwrap_prefix
);
16421 prefix
= Vwrap_prefix
;
16425 prefix
= get_it_property (it
, Qline_prefix
);
16427 prefix
= Vline_prefix
;
16429 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
16431 /* If the prefix is wider than the window, and we try to wrap
16432 it, it would acquire its own wrap prefix, and so on till the
16433 iterator stack overflows. So, don't wrap the prefix. */
16434 it
->line_wrap
= TRUNCATE
;
16435 it
->avoid_cursor_p
= 1;
16441 /* Construct the glyph row IT->glyph_row in the desired matrix of
16442 IT->w from text at the current position of IT. See dispextern.h
16443 for an overview of struct it. Value is non-zero if
16444 IT->glyph_row displays text, as opposed to a line displaying ZV
16451 struct glyph_row
*row
= it
->glyph_row
;
16452 Lisp_Object overlay_arrow_string
;
16454 int may_wrap
= 0, wrap_x
;
16455 int wrap_row_used
= -1, wrap_row_ascent
, wrap_row_height
;
16456 int wrap_row_phys_ascent
, wrap_row_phys_height
;
16457 int wrap_row_extra_line_spacing
;
16459 /* We always start displaying at hpos zero even if hscrolled. */
16460 xassert (it
->hpos
== 0 && it
->current_x
== 0);
16462 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
16463 >= it
->w
->desired_matrix
->nrows
)
16465 it
->w
->nrows_scale_factor
++;
16466 fonts_changed_p
= 1;
16470 /* Is IT->w showing the region? */
16471 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
16473 /* Clear the result glyph row and enable it. */
16474 prepare_desired_row (row
);
16476 row
->y
= it
->current_y
;
16477 row
->start
= it
->start
;
16478 row
->continuation_lines_width
= it
->continuation_lines_width
;
16479 row
->displays_text_p
= 1;
16480 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
16481 it
->starts_in_middle_of_char_p
= 0;
16483 /* Arrange the overlays nicely for our purposes. Usually, we call
16484 display_line on only one line at a time, in which case this
16485 can't really hurt too much, or we call it on lines which appear
16486 one after another in the buffer, in which case all calls to
16487 recenter_overlay_lists but the first will be pretty cheap. */
16488 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
16490 /* Move over display elements that are not visible because we are
16491 hscrolled. This may stop at an x-position < IT->first_visible_x
16492 if the first glyph is partially visible or if we hit a line end. */
16493 if (it
->current_x
< it
->first_visible_x
)
16495 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
16496 MOVE_TO_POS
| MOVE_TO_X
);
16500 /* We only do this when not calling `move_it_in_display_line_to'
16501 above, because move_it_in_display_line_to calls
16502 handle_line_prefix itself. */
16503 handle_line_prefix (it
);
16506 /* Get the initial row height. This is either the height of the
16507 text hscrolled, if there is any, or zero. */
16508 row
->ascent
= it
->max_ascent
;
16509 row
->height
= it
->max_ascent
+ it
->max_descent
;
16510 row
->phys_ascent
= it
->max_phys_ascent
;
16511 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16512 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
16514 /* Loop generating characters. The loop is left with IT on the next
16515 character to display. */
16518 int n_glyphs_before
, hpos_before
, x_before
;
16520 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
16522 /* Retrieve the next thing to display. Value is zero if end of
16524 if (!get_next_display_element (it
))
16526 /* Maybe add a space at the end of this line that is used to
16527 display the cursor there under X. Set the charpos of the
16528 first glyph of blank lines not corresponding to any text
16530 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16531 row
->exact_window_width_line_p
= 1;
16532 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
16533 || row
->used
[TEXT_AREA
] == 0)
16535 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
16536 row
->displays_text_p
= 0;
16538 if (!NILP (XBUFFER (it
->w
->buffer
)->indicate_empty_lines
)
16539 && (!MINI_WINDOW_P (it
->w
)
16540 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
16541 row
->indicate_empty_line_p
= 1;
16544 it
->continuation_lines_width
= 0;
16545 row
->ends_at_zv_p
= 1;
16549 /* Now, get the metrics of what we want to display. This also
16550 generates glyphs in `row' (which is IT->glyph_row). */
16551 n_glyphs_before
= row
->used
[TEXT_AREA
];
16554 /* Remember the line height so far in case the next element doesn't
16555 fit on the line. */
16556 if (it
->line_wrap
!= TRUNCATE
)
16558 ascent
= it
->max_ascent
;
16559 descent
= it
->max_descent
;
16560 phys_ascent
= it
->max_phys_ascent
;
16561 phys_descent
= it
->max_phys_descent
;
16563 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
16565 if (IT_DISPLAYING_WHITESPACE (it
))
16571 wrap_row_used
= row
->used
[TEXT_AREA
];
16572 wrap_row_ascent
= row
->ascent
;
16573 wrap_row_height
= row
->height
;
16574 wrap_row_phys_ascent
= row
->phys_ascent
;
16575 wrap_row_phys_height
= row
->phys_height
;
16576 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
16582 PRODUCE_GLYPHS (it
);
16584 /* If this display element was in marginal areas, continue with
16586 if (it
->area
!= TEXT_AREA
)
16588 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
16589 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
16590 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
16591 row
->phys_height
= max (row
->phys_height
,
16592 it
->max_phys_ascent
+ it
->max_phys_descent
);
16593 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
16594 it
->max_extra_line_spacing
);
16595 set_iterator_to_next (it
, 1);
16599 /* Does the display element fit on the line? If we truncate
16600 lines, we should draw past the right edge of the window. If
16601 we don't truncate, we want to stop so that we can display the
16602 continuation glyph before the right margin. If lines are
16603 continued, there are two possible strategies for characters
16604 resulting in more than 1 glyph (e.g. tabs): Display as many
16605 glyphs as possible in this line and leave the rest for the
16606 continuation line, or display the whole element in the next
16607 line. Original redisplay did the former, so we do it also. */
16608 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
16609 hpos_before
= it
->hpos
;
16612 if (/* Not a newline. */
16614 /* Glyphs produced fit entirely in the line. */
16615 && it
->current_x
< it
->last_visible_x
)
16617 it
->hpos
+= nglyphs
;
16618 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
16619 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
16620 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
16621 row
->phys_height
= max (row
->phys_height
,
16622 it
->max_phys_ascent
+ it
->max_phys_descent
);
16623 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
16624 it
->max_extra_line_spacing
);
16625 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
16626 row
->x
= x
- it
->first_visible_x
;
16631 struct glyph
*glyph
;
16633 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
16635 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
16636 new_x
= x
+ glyph
->pixel_width
;
16638 if (/* Lines are continued. */
16639 it
->line_wrap
!= TRUNCATE
16640 && (/* Glyph doesn't fit on the line. */
16641 new_x
> it
->last_visible_x
16642 /* Or it fits exactly on a window system frame. */
16643 || (new_x
== it
->last_visible_x
16644 && FRAME_WINDOW_P (it
->f
))))
16646 /* End of a continued line. */
16649 || (new_x
== it
->last_visible_x
16650 && FRAME_WINDOW_P (it
->f
)))
16652 /* Current glyph is the only one on the line or
16653 fits exactly on the line. We must continue
16654 the line because we can't draw the cursor
16655 after the glyph. */
16656 row
->continued_p
= 1;
16657 it
->current_x
= new_x
;
16658 it
->continuation_lines_width
+= new_x
;
16660 if (i
== nglyphs
- 1)
16662 /* If line-wrap is on, check if a previous
16663 wrap point was found. */
16664 if (wrap_row_used
> 0
16665 /* Even if there is a previous wrap
16666 point, continue the line here as
16667 usual, if (i) the previous character
16668 was a space or tab AND (ii) the
16669 current character is not. */
16671 || IT_DISPLAYING_WHITESPACE (it
)))
16674 set_iterator_to_next (it
, 1);
16675 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16677 if (!get_next_display_element (it
))
16679 row
->exact_window_width_line_p
= 1;
16680 it
->continuation_lines_width
= 0;
16681 row
->continued_p
= 0;
16682 row
->ends_at_zv_p
= 1;
16684 else if (ITERATOR_AT_END_OF_LINE_P (it
))
16686 row
->continued_p
= 0;
16687 row
->exact_window_width_line_p
= 1;
16692 else if (CHAR_GLYPH_PADDING_P (*glyph
)
16693 && !FRAME_WINDOW_P (it
->f
))
16695 /* A padding glyph that doesn't fit on this line.
16696 This means the whole character doesn't fit
16698 row
->used
[TEXT_AREA
] = n_glyphs_before
;
16700 /* Fill the rest of the row with continuation
16701 glyphs like in 20.x. */
16702 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
16703 < row
->glyphs
[1 + TEXT_AREA
])
16704 produce_special_glyphs (it
, IT_CONTINUATION
);
16706 row
->continued_p
= 1;
16707 it
->current_x
= x_before
;
16708 it
->continuation_lines_width
+= x_before
;
16710 /* Restore the height to what it was before the
16711 element not fitting on the line. */
16712 it
->max_ascent
= ascent
;
16713 it
->max_descent
= descent
;
16714 it
->max_phys_ascent
= phys_ascent
;
16715 it
->max_phys_descent
= phys_descent
;
16717 else if (wrap_row_used
> 0)
16721 it
->continuation_lines_width
+= wrap_x
;
16722 row
->used
[TEXT_AREA
] = wrap_row_used
;
16723 row
->ascent
= wrap_row_ascent
;
16724 row
->height
= wrap_row_height
;
16725 row
->phys_ascent
= wrap_row_phys_ascent
;
16726 row
->phys_height
= wrap_row_phys_height
;
16727 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
16728 row
->continued_p
= 1;
16729 row
->ends_at_zv_p
= 0;
16730 row
->exact_window_width_line_p
= 0;
16731 it
->continuation_lines_width
+= x
;
16733 /* Make sure that a non-default face is extended
16734 up to the right margin of the window. */
16735 extend_face_to_end_of_line (it
);
16737 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
16739 /* A TAB that extends past the right edge of the
16740 window. This produces a single glyph on
16741 window system frames. We leave the glyph in
16742 this row and let it fill the row, but don't
16743 consume the TAB. */
16744 it
->continuation_lines_width
+= it
->last_visible_x
;
16745 row
->ends_in_middle_of_char_p
= 1;
16746 row
->continued_p
= 1;
16747 glyph
->pixel_width
= it
->last_visible_x
- x
;
16748 it
->starts_in_middle_of_char_p
= 1;
16752 /* Something other than a TAB that draws past
16753 the right edge of the window. Restore
16754 positions to values before the element. */
16755 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
16757 /* Display continuation glyphs. */
16758 if (!FRAME_WINDOW_P (it
->f
))
16759 produce_special_glyphs (it
, IT_CONTINUATION
);
16760 row
->continued_p
= 1;
16762 it
->current_x
= x_before
;
16763 it
->continuation_lines_width
+= x
;
16764 extend_face_to_end_of_line (it
);
16766 if (nglyphs
> 1 && i
> 0)
16768 row
->ends_in_middle_of_char_p
= 1;
16769 it
->starts_in_middle_of_char_p
= 1;
16772 /* Restore the height to what it was before the
16773 element not fitting on the line. */
16774 it
->max_ascent
= ascent
;
16775 it
->max_descent
= descent
;
16776 it
->max_phys_ascent
= phys_ascent
;
16777 it
->max_phys_descent
= phys_descent
;
16782 else if (new_x
> it
->first_visible_x
)
16784 /* Increment number of glyphs actually displayed. */
16787 if (x
< it
->first_visible_x
)
16788 /* Glyph is partially visible, i.e. row starts at
16789 negative X position. */
16790 row
->x
= x
- it
->first_visible_x
;
16794 /* Glyph is completely off the left margin of the
16795 window. This should not happen because of the
16796 move_it_in_display_line at the start of this
16797 function, unless the text display area of the
16798 window is empty. */
16799 xassert (it
->first_visible_x
<= it
->last_visible_x
);
16803 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
16804 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
16805 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
16806 row
->phys_height
= max (row
->phys_height
,
16807 it
->max_phys_ascent
+ it
->max_phys_descent
);
16808 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
16809 it
->max_extra_line_spacing
);
16811 /* End of this display line if row is continued. */
16812 if (row
->continued_p
|| row
->ends_at_zv_p
)
16817 /* Is this a line end? If yes, we're also done, after making
16818 sure that a non-default face is extended up to the right
16819 margin of the window. */
16820 if (ITERATOR_AT_END_OF_LINE_P (it
))
16822 int used_before
= row
->used
[TEXT_AREA
];
16824 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
16826 /* Add a space at the end of the line that is used to
16827 display the cursor there. */
16828 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16829 append_space_for_newline (it
, 0);
16831 /* Extend the face to the end of the line. */
16832 extend_face_to_end_of_line (it
);
16834 /* Make sure we have the position. */
16835 if (used_before
== 0)
16836 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
16838 /* Consume the line end. This skips over invisible lines. */
16839 set_iterator_to_next (it
, 1);
16840 it
->continuation_lines_width
= 0;
16844 /* Proceed with next display element. Note that this skips
16845 over lines invisible because of selective display. */
16846 set_iterator_to_next (it
, 1);
16848 /* If we truncate lines, we are done when the last displayed
16849 glyphs reach past the right margin of the window. */
16850 if (it
->line_wrap
== TRUNCATE
16851 && (FRAME_WINDOW_P (it
->f
)
16852 ? (it
->current_x
>= it
->last_visible_x
)
16853 : (it
->current_x
> it
->last_visible_x
)))
16855 /* Maybe add truncation glyphs. */
16856 if (!FRAME_WINDOW_P (it
->f
))
16860 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
16861 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
16864 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
16866 row
->used
[TEXT_AREA
] = i
;
16867 produce_special_glyphs (it
, IT_TRUNCATION
);
16870 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16872 /* Don't truncate if we can overflow newline into fringe. */
16873 if (!get_next_display_element (it
))
16875 it
->continuation_lines_width
= 0;
16876 row
->ends_at_zv_p
= 1;
16877 row
->exact_window_width_line_p
= 1;
16880 if (ITERATOR_AT_END_OF_LINE_P (it
))
16882 row
->exact_window_width_line_p
= 1;
16883 goto at_end_of_line
;
16887 row
->truncated_on_right_p
= 1;
16888 it
->continuation_lines_width
= 0;
16889 reseat_at_next_visible_line_start (it
, 0);
16890 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
16891 it
->hpos
= hpos_before
;
16892 it
->current_x
= x_before
;
16897 /* If line is not empty and hscrolled, maybe insert truncation glyphs
16898 at the left window margin. */
16899 if (it
->first_visible_x
16900 && IT_CHARPOS (*it
) != MATRIX_ROW_START_CHARPOS (row
))
16902 if (!FRAME_WINDOW_P (it
->f
))
16903 insert_left_trunc_glyphs (it
);
16904 row
->truncated_on_left_p
= 1;
16907 /* If the start of this line is the overlay arrow-position, then
16908 mark this glyph row as the one containing the overlay arrow.
16909 This is clearly a mess with variable size fonts. It would be
16910 better to let it be displayed like cursors under X. */
16911 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
16912 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
16913 !NILP (overlay_arrow_string
)))
16915 /* Overlay arrow in window redisplay is a fringe bitmap. */
16916 if (STRINGP (overlay_arrow_string
))
16918 struct glyph_row
*arrow_row
16919 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
16920 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
16921 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
16922 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
16923 struct glyph
*p2
, *end
;
16925 /* Copy the arrow glyphs. */
16926 while (glyph
< arrow_end
)
16929 /* Throw away padding glyphs. */
16931 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16932 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
16938 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
16943 xassert (INTEGERP (overlay_arrow_string
));
16944 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
16946 overlay_arrow_seen
= 1;
16949 /* Compute pixel dimensions of this line. */
16950 compute_line_metrics (it
);
16952 /* Remember the position at which this line ends. */
16953 row
->end
= it
->current
;
16955 /* Record whether this row ends inside an ellipsis. */
16956 row
->ends_in_ellipsis_p
16957 = (it
->method
== GET_FROM_DISPLAY_VECTOR
16958 && it
->ellipsis_p
);
16960 /* Save fringe bitmaps in this row. */
16961 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
16962 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
16963 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
16964 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
16966 it
->left_user_fringe_bitmap
= 0;
16967 it
->left_user_fringe_face_id
= 0;
16968 it
->right_user_fringe_bitmap
= 0;
16969 it
->right_user_fringe_face_id
= 0;
16971 /* Maybe set the cursor. */
16972 if (it
->w
->cursor
.vpos
< 0
16973 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
16974 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
16975 && cursor_row_p (it
->w
, row
))
16976 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
16978 /* Highlight trailing whitespace. */
16979 if (!NILP (Vshow_trailing_whitespace
))
16980 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
16982 /* Prepare for the next line. This line starts horizontally at (X
16983 HPOS) = (0 0). Vertical positions are incremented. As a
16984 convenience for the caller, IT->glyph_row is set to the next
16986 it
->current_x
= it
->hpos
= 0;
16987 it
->current_y
+= row
->height
;
16990 it
->start
= it
->current
;
16991 return row
->displays_text_p
;
16996 /***********************************************************************
16998 ***********************************************************************/
17000 /* Redisplay the menu bar in the frame for window W.
17002 The menu bar of X frames that don't have X toolkit support is
17003 displayed in a special window W->frame->menu_bar_window.
17005 The menu bar of terminal frames is treated specially as far as
17006 glyph matrices are concerned. Menu bar lines are not part of
17007 windows, so the update is done directly on the frame matrix rows
17008 for the menu bar. */
17011 display_menu_bar (w
)
17014 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
17019 /* Don't do all this for graphical frames. */
17021 if (FRAME_W32_P (f
))
17024 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
17030 if (FRAME_NS_P (f
))
17032 #endif /* HAVE_NS */
17034 #ifdef USE_X_TOOLKIT
17035 xassert (!FRAME_WINDOW_P (f
));
17036 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
17037 it
.first_visible_x
= 0;
17038 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
17039 #else /* not USE_X_TOOLKIT */
17040 if (FRAME_WINDOW_P (f
))
17042 /* Menu bar lines are displayed in the desired matrix of the
17043 dummy window menu_bar_window. */
17044 struct window
*menu_w
;
17045 xassert (WINDOWP (f
->menu_bar_window
));
17046 menu_w
= XWINDOW (f
->menu_bar_window
);
17047 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
17049 it
.first_visible_x
= 0;
17050 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
17054 /* This is a TTY frame, i.e. character hpos/vpos are used as
17056 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
17058 it
.first_visible_x
= 0;
17059 it
.last_visible_x
= FRAME_COLS (f
);
17061 #endif /* not USE_X_TOOLKIT */
17063 if (! mode_line_inverse_video
)
17064 /* Force the menu-bar to be displayed in the default face. */
17065 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
17067 /* Clear all rows of the menu bar. */
17068 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
17070 struct glyph_row
*row
= it
.glyph_row
+ i
;
17071 clear_glyph_row (row
);
17072 row
->enabled_p
= 1;
17073 row
->full_width_p
= 1;
17076 /* Display all items of the menu bar. */
17077 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
17078 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
17080 Lisp_Object string
;
17082 /* Stop at nil string. */
17083 string
= AREF (items
, i
+ 1);
17087 /* Remember where item was displayed. */
17088 ASET (items
, i
+ 3, make_number (it
.hpos
));
17090 /* Display the item, pad with one space. */
17091 if (it
.current_x
< it
.last_visible_x
)
17092 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
17093 SCHARS (string
) + 1, 0, 0, -1);
17096 /* Fill out the line with spaces. */
17097 if (it
.current_x
< it
.last_visible_x
)
17098 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
17100 /* Compute the total height of the lines. */
17101 compute_line_metrics (&it
);
17106 /***********************************************************************
17108 ***********************************************************************/
17110 /* Redisplay mode lines in the window tree whose root is WINDOW. If
17111 FORCE is non-zero, redisplay mode lines unconditionally.
17112 Otherwise, redisplay only mode lines that are garbaged. Value is
17113 the number of windows whose mode lines were redisplayed. */
17116 redisplay_mode_lines (window
, force
)
17117 Lisp_Object window
;
17122 while (!NILP (window
))
17124 struct window
*w
= XWINDOW (window
);
17126 if (WINDOWP (w
->hchild
))
17127 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
17128 else if (WINDOWP (w
->vchild
))
17129 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
17131 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
17132 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
17134 struct text_pos lpoint
;
17135 struct buffer
*old
= current_buffer
;
17137 /* Set the window's buffer for the mode line display. */
17138 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
17139 set_buffer_internal_1 (XBUFFER (w
->buffer
));
17141 /* Point refers normally to the selected window. For any
17142 other window, set up appropriate value. */
17143 if (!EQ (window
, selected_window
))
17145 struct text_pos pt
;
17147 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
17148 if (CHARPOS (pt
) < BEGV
)
17149 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
17150 else if (CHARPOS (pt
) > (ZV
- 1))
17151 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
17153 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
17156 /* Display mode lines. */
17157 clear_glyph_matrix (w
->desired_matrix
);
17158 if (display_mode_lines (w
))
17161 w
->must_be_updated_p
= 1;
17164 /* Restore old settings. */
17165 set_buffer_internal_1 (old
);
17166 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
17176 /* Display the mode and/or header line of window W. Value is the
17177 sum number of mode lines and header lines displayed. */
17180 display_mode_lines (w
)
17183 Lisp_Object old_selected_window
, old_selected_frame
;
17186 old_selected_frame
= selected_frame
;
17187 selected_frame
= w
->frame
;
17188 old_selected_window
= selected_window
;
17189 XSETWINDOW (selected_window
, w
);
17191 /* These will be set while the mode line specs are processed. */
17192 line_number_displayed
= 0;
17193 w
->column_number_displayed
= Qnil
;
17195 if (WINDOW_WANTS_MODELINE_P (w
))
17197 struct window
*sel_w
= XWINDOW (old_selected_window
);
17199 /* Select mode line face based on the real selected window. */
17200 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
17201 current_buffer
->mode_line_format
);
17205 if (WINDOW_WANTS_HEADER_LINE_P (w
))
17207 display_mode_line (w
, HEADER_LINE_FACE_ID
,
17208 current_buffer
->header_line_format
);
17212 selected_frame
= old_selected_frame
;
17213 selected_window
= old_selected_window
;
17218 /* Display mode or header line of window W. FACE_ID specifies which
17219 line to display; it is either MODE_LINE_FACE_ID or
17220 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
17221 display. Value is the pixel height of the mode/header line
17225 display_mode_line (w
, face_id
, format
)
17227 enum face_id face_id
;
17228 Lisp_Object format
;
17232 int count
= SPECPDL_INDEX ();
17234 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
17235 /* Don't extend on a previously drawn mode-line.
17236 This may happen if called from pos_visible_p. */
17237 it
.glyph_row
->enabled_p
= 0;
17238 prepare_desired_row (it
.glyph_row
);
17240 it
.glyph_row
->mode_line_p
= 1;
17242 if (! mode_line_inverse_video
)
17243 /* Force the mode-line to be displayed in the default face. */
17244 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
17246 record_unwind_protect (unwind_format_mode_line
,
17247 format_mode_line_unwind_data (NULL
, Qnil
, 0));
17249 mode_line_target
= MODE_LINE_DISPLAY
;
17251 /* Temporarily make frame's keyboard the current kboard so that
17252 kboard-local variables in the mode_line_format will get the right
17254 push_kboard (FRAME_KBOARD (it
.f
));
17255 record_unwind_save_match_data ();
17256 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
17259 unbind_to (count
, Qnil
);
17261 /* Fill up with spaces. */
17262 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
17264 compute_line_metrics (&it
);
17265 it
.glyph_row
->full_width_p
= 1;
17266 it
.glyph_row
->continued_p
= 0;
17267 it
.glyph_row
->truncated_on_left_p
= 0;
17268 it
.glyph_row
->truncated_on_right_p
= 0;
17270 /* Make a 3D mode-line have a shadow at its right end. */
17271 face
= FACE_FROM_ID (it
.f
, face_id
);
17272 extend_face_to_end_of_line (&it
);
17273 if (face
->box
!= FACE_NO_BOX
)
17275 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
17276 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
17277 last
->right_box_line_p
= 1;
17280 return it
.glyph_row
->height
;
17283 /* Move element ELT in LIST to the front of LIST.
17284 Return the updated list. */
17287 move_elt_to_front (elt
, list
)
17288 Lisp_Object elt
, list
;
17290 register Lisp_Object tail
, prev
;
17291 register Lisp_Object tem
;
17295 while (CONSP (tail
))
17301 /* Splice out the link TAIL. */
17303 list
= XCDR (tail
);
17305 Fsetcdr (prev
, XCDR (tail
));
17307 /* Now make it the first. */
17308 Fsetcdr (tail
, list
);
17313 tail
= XCDR (tail
);
17317 /* Not found--return unchanged LIST. */
17321 /* Contribute ELT to the mode line for window IT->w. How it
17322 translates into text depends on its data type.
17324 IT describes the display environment in which we display, as usual.
17326 DEPTH is the depth in recursion. It is used to prevent
17327 infinite recursion here.
17329 FIELD_WIDTH is the number of characters the display of ELT should
17330 occupy in the mode line, and PRECISION is the maximum number of
17331 characters to display from ELT's representation. See
17332 display_string for details.
17334 Returns the hpos of the end of the text generated by ELT.
17336 PROPS is a property list to add to any string we encounter.
17338 If RISKY is nonzero, remove (disregard) any properties in any string
17339 we encounter, and ignore :eval and :propertize.
17341 The global variable `mode_line_target' determines whether the
17342 output is passed to `store_mode_line_noprop',
17343 `store_mode_line_string', or `display_string'. */
17346 display_mode_element (it
, depth
, field_width
, precision
, elt
, props
, risky
)
17349 int field_width
, precision
;
17350 Lisp_Object elt
, props
;
17353 int n
= 0, field
, prec
;
17358 elt
= build_string ("*too-deep*");
17362 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
17366 /* A string: output it and check for %-constructs within it. */
17370 if (SCHARS (elt
) > 0
17371 && (!NILP (props
) || risky
))
17373 Lisp_Object oprops
, aelt
;
17374 oprops
= Ftext_properties_at (make_number (0), elt
);
17376 /* If the starting string's properties are not what
17377 we want, translate the string. Also, if the string
17378 is risky, do that anyway. */
17380 if (NILP (Fequal (props
, oprops
)) || risky
)
17382 /* If the starting string has properties,
17383 merge the specified ones onto the existing ones. */
17384 if (! NILP (oprops
) && !risky
)
17388 oprops
= Fcopy_sequence (oprops
);
17390 while (CONSP (tem
))
17392 oprops
= Fplist_put (oprops
, XCAR (tem
),
17393 XCAR (XCDR (tem
)));
17394 tem
= XCDR (XCDR (tem
));
17399 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
17400 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
17402 /* AELT is what we want. Move it to the front
17403 without consing. */
17405 mode_line_proptrans_alist
17406 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
17412 /* If AELT has the wrong props, it is useless.
17413 so get rid of it. */
17415 mode_line_proptrans_alist
17416 = Fdelq (aelt
, mode_line_proptrans_alist
);
17418 elt
= Fcopy_sequence (elt
);
17419 Fset_text_properties (make_number (0), Flength (elt
),
17421 /* Add this item to mode_line_proptrans_alist. */
17422 mode_line_proptrans_alist
17423 = Fcons (Fcons (elt
, props
),
17424 mode_line_proptrans_alist
);
17425 /* Truncate mode_line_proptrans_alist
17426 to at most 50 elements. */
17427 tem
= Fnthcdr (make_number (50),
17428 mode_line_proptrans_alist
);
17430 XSETCDR (tem
, Qnil
);
17439 prec
= precision
- n
;
17440 switch (mode_line_target
)
17442 case MODE_LINE_NOPROP
:
17443 case MODE_LINE_TITLE
:
17444 n
+= store_mode_line_noprop (SDATA (elt
), -1, prec
);
17446 case MODE_LINE_STRING
:
17447 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
17449 case MODE_LINE_DISPLAY
:
17450 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
17451 0, prec
, 0, STRING_MULTIBYTE (elt
));
17458 /* Handle the non-literal case. */
17460 while ((precision
<= 0 || n
< precision
)
17461 && SREF (elt
, offset
) != 0
17462 && (mode_line_target
!= MODE_LINE_DISPLAY
17463 || it
->current_x
< it
->last_visible_x
))
17465 int last_offset
= offset
;
17467 /* Advance to end of string or next format specifier. */
17468 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
17471 if (offset
- 1 != last_offset
)
17473 int nchars
, nbytes
;
17475 /* Output to end of string or up to '%'. Field width
17476 is length of string. Don't output more than
17477 PRECISION allows us. */
17480 prec
= c_string_width (SDATA (elt
) + last_offset
,
17481 offset
- last_offset
, precision
- n
,
17484 switch (mode_line_target
)
17486 case MODE_LINE_NOPROP
:
17487 case MODE_LINE_TITLE
:
17488 n
+= store_mode_line_noprop (SDATA (elt
) + last_offset
, 0, prec
);
17490 case MODE_LINE_STRING
:
17492 int bytepos
= last_offset
;
17493 int charpos
= string_byte_to_char (elt
, bytepos
);
17494 int endpos
= (precision
<= 0
17495 ? string_byte_to_char (elt
, offset
)
17496 : charpos
+ nchars
);
17498 n
+= store_mode_line_string (NULL
,
17499 Fsubstring (elt
, make_number (charpos
),
17500 make_number (endpos
)),
17504 case MODE_LINE_DISPLAY
:
17506 int bytepos
= last_offset
;
17507 int charpos
= string_byte_to_char (elt
, bytepos
);
17509 if (precision
<= 0)
17510 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
17511 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
17513 STRING_MULTIBYTE (elt
));
17518 else /* c == '%' */
17520 int percent_position
= offset
;
17522 /* Get the specified minimum width. Zero means
17525 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
17526 field
= field
* 10 + c
- '0';
17528 /* Don't pad beyond the total padding allowed. */
17529 if (field_width
- n
> 0 && field
> field_width
- n
)
17530 field
= field_width
- n
;
17532 /* Note that either PRECISION <= 0 or N < PRECISION. */
17533 prec
= precision
- n
;
17536 n
+= display_mode_element (it
, depth
, field
, prec
,
17537 Vglobal_mode_string
, props
,
17542 int bytepos
, charpos
;
17543 unsigned char *spec
;
17544 Lisp_Object string
;
17546 bytepos
= percent_position
;
17547 charpos
= (STRING_MULTIBYTE (elt
)
17548 ? string_byte_to_char (elt
, bytepos
)
17550 spec
= decode_mode_spec (it
->w
, c
, field
, prec
, &string
);
17551 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
17553 switch (mode_line_target
)
17555 case MODE_LINE_NOPROP
:
17556 case MODE_LINE_TITLE
:
17557 n
+= store_mode_line_noprop (spec
, field
, prec
);
17559 case MODE_LINE_STRING
:
17561 int len
= strlen (spec
);
17562 Lisp_Object tem
= make_string (spec
, len
);
17563 props
= Ftext_properties_at (make_number (charpos
), elt
);
17564 /* Should only keep face property in props */
17565 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
17568 case MODE_LINE_DISPLAY
:
17570 int nglyphs_before
, nwritten
;
17572 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
17573 nwritten
= display_string (spec
, string
, elt
,
17578 /* Assign to the glyphs written above the
17579 string where the `%x' came from, position
17583 struct glyph
*glyph
17584 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
17588 for (i
= 0; i
< nwritten
; ++i
)
17590 glyph
[i
].object
= elt
;
17591 glyph
[i
].charpos
= charpos
;
17608 /* A symbol: process the value of the symbol recursively
17609 as if it appeared here directly. Avoid error if symbol void.
17610 Special case: if value of symbol is a string, output the string
17613 register Lisp_Object tem
;
17615 /* If the variable is not marked as risky to set
17616 then its contents are risky to use. */
17617 if (NILP (Fget (elt
, Qrisky_local_variable
)))
17620 tem
= Fboundp (elt
);
17623 tem
= Fsymbol_value (elt
);
17624 /* If value is a string, output that string literally:
17625 don't check for % within it. */
17629 if (!EQ (tem
, elt
))
17631 /* Give up right away for nil or t. */
17641 register Lisp_Object car
, tem
;
17643 /* A cons cell: five distinct cases.
17644 If first element is :eval or :propertize, do something special.
17645 If first element is a string or a cons, process all the elements
17646 and effectively concatenate them.
17647 If first element is a negative number, truncate displaying cdr to
17648 at most that many characters. If positive, pad (with spaces)
17649 to at least that many characters.
17650 If first element is a symbol, process the cadr or caddr recursively
17651 according to whether the symbol's value is non-nil or nil. */
17653 if (EQ (car
, QCeval
))
17655 /* An element of the form (:eval FORM) means evaluate FORM
17656 and use the result as mode line elements. */
17661 if (CONSP (XCDR (elt
)))
17664 spec
= safe_eval (XCAR (XCDR (elt
)));
17665 n
+= display_mode_element (it
, depth
, field_width
- n
,
17666 precision
- n
, spec
, props
,
17670 else if (EQ (car
, QCpropertize
))
17672 /* An element of the form (:propertize ELT PROPS...)
17673 means display ELT but applying properties PROPS. */
17678 if (CONSP (XCDR (elt
)))
17679 n
+= display_mode_element (it
, depth
, field_width
- n
,
17680 precision
- n
, XCAR (XCDR (elt
)),
17681 XCDR (XCDR (elt
)), risky
);
17683 else if (SYMBOLP (car
))
17685 tem
= Fboundp (car
);
17689 /* elt is now the cdr, and we know it is a cons cell.
17690 Use its car if CAR has a non-nil value. */
17693 tem
= Fsymbol_value (car
);
17700 /* Symbol's value is nil (or symbol is unbound)
17701 Get the cddr of the original list
17702 and if possible find the caddr and use that. */
17706 else if (!CONSP (elt
))
17711 else if (INTEGERP (car
))
17713 register int lim
= XINT (car
);
17717 /* Negative int means reduce maximum width. */
17718 if (precision
<= 0)
17721 precision
= min (precision
, -lim
);
17725 /* Padding specified. Don't let it be more than
17726 current maximum. */
17728 lim
= min (precision
, lim
);
17730 /* If that's more padding than already wanted, queue it.
17731 But don't reduce padding already specified even if
17732 that is beyond the current truncation point. */
17733 field_width
= max (lim
, field_width
);
17737 else if (STRINGP (car
) || CONSP (car
))
17739 Lisp_Object halftail
= elt
;
17743 && (precision
<= 0 || n
< precision
))
17745 n
+= display_mode_element (it
, depth
,
17746 /* Do padding only after the last
17747 element in the list. */
17748 (! CONSP (XCDR (elt
))
17751 precision
- n
, XCAR (elt
),
17755 if ((len
& 1) == 0)
17756 halftail
= XCDR (halftail
);
17757 /* Check for cycle. */
17758 if (EQ (halftail
, elt
))
17767 elt
= build_string ("*invalid*");
17771 /* Pad to FIELD_WIDTH. */
17772 if (field_width
> 0 && n
< field_width
)
17774 switch (mode_line_target
)
17776 case MODE_LINE_NOPROP
:
17777 case MODE_LINE_TITLE
:
17778 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
17780 case MODE_LINE_STRING
:
17781 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
17783 case MODE_LINE_DISPLAY
:
17784 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
17793 /* Store a mode-line string element in mode_line_string_list.
17795 If STRING is non-null, display that C string. Otherwise, the Lisp
17796 string LISP_STRING is displayed.
17798 FIELD_WIDTH is the minimum number of output glyphs to produce.
17799 If STRING has fewer characters than FIELD_WIDTH, pad to the right
17800 with spaces. FIELD_WIDTH <= 0 means don't pad.
17802 PRECISION is the maximum number of characters to output from
17803 STRING. PRECISION <= 0 means don't truncate the string.
17805 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
17806 properties to the string.
17808 PROPS are the properties to add to the string.
17809 The mode_line_string_face face property is always added to the string.
17813 store_mode_line_string (string
, lisp_string
, copy_string
, field_width
, precision
, props
)
17815 Lisp_Object lisp_string
;
17824 if (string
!= NULL
)
17826 len
= strlen (string
);
17827 if (precision
> 0 && len
> precision
)
17829 lisp_string
= make_string (string
, len
);
17831 props
= mode_line_string_face_prop
;
17832 else if (!NILP (mode_line_string_face
))
17834 Lisp_Object face
= Fplist_get (props
, Qface
);
17835 props
= Fcopy_sequence (props
);
17837 face
= mode_line_string_face
;
17839 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
17840 props
= Fplist_put (props
, Qface
, face
);
17842 Fadd_text_properties (make_number (0), make_number (len
),
17843 props
, lisp_string
);
17847 len
= XFASTINT (Flength (lisp_string
));
17848 if (precision
> 0 && len
> precision
)
17851 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
17854 if (!NILP (mode_line_string_face
))
17858 props
= Ftext_properties_at (make_number (0), lisp_string
);
17859 face
= Fplist_get (props
, Qface
);
17861 face
= mode_line_string_face
;
17863 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
17864 props
= Fcons (Qface
, Fcons (face
, Qnil
));
17866 lisp_string
= Fcopy_sequence (lisp_string
);
17869 Fadd_text_properties (make_number (0), make_number (len
),
17870 props
, lisp_string
);
17875 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
17879 if (field_width
> len
)
17881 field_width
-= len
;
17882 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
17884 Fadd_text_properties (make_number (0), make_number (field_width
),
17885 props
, lisp_string
);
17886 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
17894 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
17896 doc
: /* Format a string out of a mode line format specification.
17897 First arg FORMAT specifies the mode line format (see `mode-line-format'
17898 for details) to use.
17900 Optional second arg FACE specifies the face property to put
17901 on all characters for which no face is specified.
17902 The value t means whatever face the window's mode line currently uses
17903 \(either `mode-line' or `mode-line-inactive', depending).
17904 A value of nil means the default is no face property.
17905 If FACE is an integer, the value string has no text properties.
17907 Optional third and fourth args WINDOW and BUFFER specify the window
17908 and buffer to use as the context for the formatting (defaults
17909 are the selected window and the window's buffer). */)
17910 (format
, face
, window
, buffer
)
17911 Lisp_Object format
, face
, window
, buffer
;
17916 struct buffer
*old_buffer
= NULL
;
17918 int no_props
= INTEGERP (face
);
17919 int count
= SPECPDL_INDEX ();
17921 int string_start
= 0;
17924 window
= selected_window
;
17925 CHECK_WINDOW (window
);
17926 w
= XWINDOW (window
);
17929 buffer
= w
->buffer
;
17930 CHECK_BUFFER (buffer
);
17932 /* Make formatting the modeline a non-op when noninteractive, otherwise
17933 there will be problems later caused by a partially initialized frame. */
17934 if (NILP (format
) || noninteractive
)
17935 return empty_unibyte_string
;
17943 face
= (EQ (window
, selected_window
) ? Qmode_line
: Qmode_line_inactive
);
17944 face_id
= lookup_named_face (XFRAME (WINDOW_FRAME (w
)), face
, 0);
17948 face_id
= DEFAULT_FACE_ID
;
17950 if (XBUFFER (buffer
) != current_buffer
)
17951 old_buffer
= current_buffer
;
17953 /* Save things including mode_line_proptrans_alist,
17954 and set that to nil so that we don't alter the outer value. */
17955 record_unwind_protect (unwind_format_mode_line
,
17956 format_mode_line_unwind_data
17957 (old_buffer
, selected_window
, 1));
17958 mode_line_proptrans_alist
= Qnil
;
17960 Fselect_window (window
, Qt
);
17962 set_buffer_internal_1 (XBUFFER (buffer
));
17964 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
17968 mode_line_target
= MODE_LINE_NOPROP
;
17969 mode_line_string_face_prop
= Qnil
;
17970 mode_line_string_list
= Qnil
;
17971 string_start
= MODE_LINE_NOPROP_LEN (0);
17975 mode_line_target
= MODE_LINE_STRING
;
17976 mode_line_string_list
= Qnil
;
17977 mode_line_string_face
= face
;
17978 mode_line_string_face_prop
17979 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
17982 push_kboard (FRAME_KBOARD (it
.f
));
17983 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
17988 len
= MODE_LINE_NOPROP_LEN (string_start
);
17989 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
17993 mode_line_string_list
= Fnreverse (mode_line_string_list
);
17994 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
17995 empty_unibyte_string
);
17998 unbind_to (count
, Qnil
);
18002 /* Write a null-terminated, right justified decimal representation of
18003 the positive integer D to BUF using a minimal field width WIDTH. */
18006 pint2str (buf
, width
, d
)
18007 register char *buf
;
18008 register int width
;
18011 register char *p
= buf
;
18019 *p
++ = d
% 10 + '0';
18024 for (width
-= (int) (p
- buf
); width
> 0; --width
)
18035 /* Write a null-terminated, right justified decimal and "human
18036 readable" representation of the nonnegative integer D to BUF using
18037 a minimal field width WIDTH. D should be smaller than 999.5e24. */
18039 static const char power_letter
[] =
18053 pint2hrstr (buf
, width
, d
)
18058 /* We aim to represent the nonnegative integer D as
18059 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
18062 /* -1 means: do not use TENTHS. */
18066 /* Length of QUOTIENT.TENTHS as a string. */
18072 if (1000 <= quotient
)
18074 /* Scale to the appropriate EXPONENT. */
18077 remainder
= quotient
% 1000;
18081 while (1000 <= quotient
);
18083 /* Round to nearest and decide whether to use TENTHS or not. */
18086 tenths
= remainder
/ 100;
18087 if (50 <= remainder
% 100)
18094 if (quotient
== 10)
18102 if (500 <= remainder
)
18104 if (quotient
< 999)
18115 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
18116 if (tenths
== -1 && quotient
<= 99)
18123 p
= psuffix
= buf
+ max (width
, length
);
18125 /* Print EXPONENT. */
18127 *psuffix
++ = power_letter
[exponent
];
18130 /* Print TENTHS. */
18133 *--p
= '0' + tenths
;
18137 /* Print QUOTIENT. */
18140 int digit
= quotient
% 10;
18141 *--p
= '0' + digit
;
18143 while ((quotient
/= 10) != 0);
18145 /* Print leading spaces. */
18150 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
18151 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
18152 type of CODING_SYSTEM. Return updated pointer into BUF. */
18154 static unsigned char invalid_eol_type
[] = "(*invalid*)";
18157 decode_mode_spec_coding (coding_system
, buf
, eol_flag
)
18158 Lisp_Object coding_system
;
18159 register char *buf
;
18163 int multibyte
= !NILP (current_buffer
->enable_multibyte_characters
);
18164 const unsigned char *eol_str
;
18166 /* The EOL conversion we are using. */
18167 Lisp_Object eoltype
;
18169 val
= CODING_SYSTEM_SPEC (coding_system
);
18172 if (!VECTORP (val
)) /* Not yet decided. */
18177 eoltype
= eol_mnemonic_undecided
;
18178 /* Don't mention EOL conversion if it isn't decided. */
18183 Lisp_Object eolvalue
;
18185 attrs
= AREF (val
, 0);
18186 eolvalue
= AREF (val
, 2);
18189 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
18193 /* The EOL conversion that is normal on this system. */
18195 if (NILP (eolvalue
)) /* Not yet decided. */
18196 eoltype
= eol_mnemonic_undecided
;
18197 else if (VECTORP (eolvalue
)) /* Not yet decided. */
18198 eoltype
= eol_mnemonic_undecided
;
18199 else /* eolvalue is Qunix, Qdos, or Qmac. */
18200 eoltype
= (EQ (eolvalue
, Qunix
)
18201 ? eol_mnemonic_unix
18202 : (EQ (eolvalue
, Qdos
) == 1
18203 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
18209 /* Mention the EOL conversion if it is not the usual one. */
18210 if (STRINGP (eoltype
))
18212 eol_str
= SDATA (eoltype
);
18213 eol_str_len
= SBYTES (eoltype
);
18215 else if (CHARACTERP (eoltype
))
18217 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
18218 eol_str_len
= CHAR_STRING (XINT (eoltype
), tmp
);
18223 eol_str
= invalid_eol_type
;
18224 eol_str_len
= sizeof (invalid_eol_type
) - 1;
18226 bcopy (eol_str
, buf
, eol_str_len
);
18227 buf
+= eol_str_len
;
18233 /* Return a string for the output of a mode line %-spec for window W,
18234 generated by character C. PRECISION >= 0 means don't return a
18235 string longer than that value. FIELD_WIDTH > 0 means pad the
18236 string returned with spaces to that value. Return a Lisp string in
18237 *STRING if the resulting string is taken from that Lisp string.
18239 Note we operate on the current buffer for most purposes,
18240 the exception being w->base_line_pos. */
18242 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
18245 decode_mode_spec (w
, c
, field_width
, precision
, string
)
18248 int field_width
, precision
;
18249 Lisp_Object
*string
;
18252 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18253 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
18254 struct buffer
*b
= current_buffer
;
18262 if (!NILP (b
->read_only
))
18264 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
18269 /* This differs from %* only for a modified read-only buffer. */
18270 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
18272 if (!NILP (b
->read_only
))
18277 /* This differs from %* in ignoring read-only-ness. */
18278 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
18290 if (command_loop_level
> 5)
18292 p
= decode_mode_spec_buf
;
18293 for (i
= 0; i
< command_loop_level
; i
++)
18296 return decode_mode_spec_buf
;
18304 if (command_loop_level
> 5)
18306 p
= decode_mode_spec_buf
;
18307 for (i
= 0; i
< command_loop_level
; i
++)
18310 return decode_mode_spec_buf
;
18317 /* Let lots_of_dashes be a string of infinite length. */
18318 if (mode_line_target
== MODE_LINE_NOPROP
||
18319 mode_line_target
== MODE_LINE_STRING
)
18321 if (field_width
<= 0
18322 || field_width
> sizeof (lots_of_dashes
))
18324 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
18325 decode_mode_spec_buf
[i
] = '-';
18326 decode_mode_spec_buf
[i
] = '\0';
18327 return decode_mode_spec_buf
;
18330 return lots_of_dashes
;
18338 /* %c and %l are ignored in `frame-title-format'.
18339 (In redisplay_internal, the frame title is drawn _before_ the
18340 windows are updated, so the stuff which depends on actual
18341 window contents (such as %l) may fail to render properly, or
18342 even crash emacs.) */
18343 if (mode_line_target
== MODE_LINE_TITLE
)
18347 int col
= (int) current_column (); /* iftc */
18348 w
->column_number_displayed
= make_number (col
);
18349 pint2str (decode_mode_spec_buf
, field_width
, col
);
18350 return decode_mode_spec_buf
;
18354 #ifndef SYSTEM_MALLOC
18356 if (NILP (Vmemory_full
))
18359 return "!MEM FULL! ";
18366 /* %F displays the frame name. */
18367 if (!NILP (f
->title
))
18368 return (char *) SDATA (f
->title
);
18369 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
18370 return (char *) SDATA (f
->name
);
18379 int size
= ZV
- BEGV
;
18380 pint2str (decode_mode_spec_buf
, field_width
, size
);
18381 return decode_mode_spec_buf
;
18386 int size
= ZV
- BEGV
;
18387 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
18388 return decode_mode_spec_buf
;
18393 int startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
18394 int topline
, nlines
, junk
, height
;
18396 /* %c and %l are ignored in `frame-title-format'. */
18397 if (mode_line_target
== MODE_LINE_TITLE
)
18400 startpos
= XMARKER (w
->start
)->charpos
;
18401 startpos_byte
= marker_byte_position (w
->start
);
18402 height
= WINDOW_TOTAL_LINES (w
);
18404 /* If we decided that this buffer isn't suitable for line numbers,
18405 don't forget that too fast. */
18406 if (EQ (w
->base_line_pos
, w
->buffer
))
18408 /* But do forget it, if the window shows a different buffer now. */
18409 else if (BUFFERP (w
->base_line_pos
))
18410 w
->base_line_pos
= Qnil
;
18412 /* If the buffer is very big, don't waste time. */
18413 if (INTEGERP (Vline_number_display_limit
)
18414 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
18416 w
->base_line_pos
= Qnil
;
18417 w
->base_line_number
= Qnil
;
18421 if (INTEGERP (w
->base_line_number
)
18422 && INTEGERP (w
->base_line_pos
)
18423 && XFASTINT (w
->base_line_pos
) <= startpos
)
18425 line
= XFASTINT (w
->base_line_number
);
18426 linepos
= XFASTINT (w
->base_line_pos
);
18427 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
18432 linepos
= BUF_BEGV (b
);
18433 linepos_byte
= BUF_BEGV_BYTE (b
);
18436 /* Count lines from base line to window start position. */
18437 nlines
= display_count_lines (linepos
, linepos_byte
,
18441 topline
= nlines
+ line
;
18443 /* Determine a new base line, if the old one is too close
18444 or too far away, or if we did not have one.
18445 "Too close" means it's plausible a scroll-down would
18446 go back past it. */
18447 if (startpos
== BUF_BEGV (b
))
18449 w
->base_line_number
= make_number (topline
);
18450 w
->base_line_pos
= make_number (BUF_BEGV (b
));
18452 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
18453 || linepos
== BUF_BEGV (b
))
18455 int limit
= BUF_BEGV (b
);
18456 int limit_byte
= BUF_BEGV_BYTE (b
);
18458 int distance
= (height
* 2 + 30) * line_number_display_limit_width
;
18460 if (startpos
- distance
> limit
)
18462 limit
= startpos
- distance
;
18463 limit_byte
= CHAR_TO_BYTE (limit
);
18466 nlines
= display_count_lines (startpos
, startpos_byte
,
18468 - (height
* 2 + 30),
18470 /* If we couldn't find the lines we wanted within
18471 line_number_display_limit_width chars per line,
18472 give up on line numbers for this window. */
18473 if (position
== limit_byte
&& limit
== startpos
- distance
)
18475 w
->base_line_pos
= w
->buffer
;
18476 w
->base_line_number
= Qnil
;
18480 w
->base_line_number
= make_number (topline
- nlines
);
18481 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
18484 /* Now count lines from the start pos to point. */
18485 nlines
= display_count_lines (startpos
, startpos_byte
,
18486 PT_BYTE
, PT
, &junk
);
18488 /* Record that we did display the line number. */
18489 line_number_displayed
= 1;
18491 /* Make the string to show. */
18492 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
18493 return decode_mode_spec_buf
;
18496 char* p
= decode_mode_spec_buf
;
18497 int pad
= field_width
- 2;
18503 return decode_mode_spec_buf
;
18509 obj
= b
->mode_name
;
18513 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
18519 int pos
= marker_position (w
->start
);
18520 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
18522 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
18524 if (pos
<= BUF_BEGV (b
))
18529 else if (pos
<= BUF_BEGV (b
))
18533 if (total
> 1000000)
18534 /* Do it differently for a large value, to avoid overflow. */
18535 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
18537 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
18538 /* We can't normally display a 3-digit number,
18539 so get us a 2-digit number that is close. */
18542 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
18543 return decode_mode_spec_buf
;
18547 /* Display percentage of size above the bottom of the screen. */
18550 int toppos
= marker_position (w
->start
);
18551 int botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
18552 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
18554 if (botpos
>= BUF_ZV (b
))
18556 if (toppos
<= BUF_BEGV (b
))
18563 if (total
> 1000000)
18564 /* Do it differently for a large value, to avoid overflow. */
18565 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
18567 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
18568 /* We can't normally display a 3-digit number,
18569 so get us a 2-digit number that is close. */
18572 if (toppos
<= BUF_BEGV (b
))
18573 sprintf (decode_mode_spec_buf
, "Top%2d%%", total
);
18575 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
18576 return decode_mode_spec_buf
;
18581 /* status of process */
18582 obj
= Fget_buffer_process (Fcurrent_buffer ());
18584 return "no process";
18585 #ifdef subprocesses
18586 obj
= Fsymbol_name (Fprocess_status (obj
));
18592 int count
= inhibit_garbage_collection ();
18593 Lisp_Object val
= call1 (intern ("file-remote-p"),
18594 current_buffer
->directory
);
18595 unbind_to (count
, Qnil
);
18603 case 't': /* indicate TEXT or BINARY */
18604 #ifdef MODE_LINE_BINARY_TEXT
18605 return MODE_LINE_BINARY_TEXT (b
);
18611 /* coding-system (not including end-of-line format) */
18613 /* coding-system (including end-of-line type) */
18615 int eol_flag
= (c
== 'Z');
18616 char *p
= decode_mode_spec_buf
;
18618 if (! FRAME_WINDOW_P (f
))
18620 /* No need to mention EOL here--the terminal never needs
18621 to do EOL conversion. */
18622 p
= decode_mode_spec_coding (CODING_ID_NAME
18623 (FRAME_KEYBOARD_CODING (f
)->id
),
18625 p
= decode_mode_spec_coding (CODING_ID_NAME
18626 (FRAME_TERMINAL_CODING (f
)->id
),
18629 p
= decode_mode_spec_coding (b
->buffer_file_coding_system
,
18632 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
18633 #ifdef subprocesses
18634 obj
= Fget_buffer_process (Fcurrent_buffer ());
18635 if (PROCESSP (obj
))
18637 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
18639 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
18642 #endif /* subprocesses */
18645 return decode_mode_spec_buf
;
18652 return (char *) SDATA (obj
);
18659 /* Count up to COUNT lines starting from START / START_BYTE.
18660 But don't go beyond LIMIT_BYTE.
18661 Return the number of lines thus found (always nonnegative).
18663 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
18666 display_count_lines (start
, start_byte
, limit_byte
, count
, byte_pos_ptr
)
18667 int start
, start_byte
, limit_byte
, count
;
18670 register unsigned char *cursor
;
18671 unsigned char *base
;
18673 register int ceiling
;
18674 register unsigned char *ceiling_addr
;
18675 int orig_count
= count
;
18677 /* If we are not in selective display mode,
18678 check only for newlines. */
18679 int selective_display
= (!NILP (current_buffer
->selective_display
)
18680 && !INTEGERP (current_buffer
->selective_display
));
18684 while (start_byte
< limit_byte
)
18686 ceiling
= BUFFER_CEILING_OF (start_byte
);
18687 ceiling
= min (limit_byte
- 1, ceiling
);
18688 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
18689 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
18692 if (selective_display
)
18693 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
18696 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
18699 if (cursor
!= ceiling_addr
)
18703 start_byte
+= cursor
- base
+ 1;
18704 *byte_pos_ptr
= start_byte
;
18708 if (++cursor
== ceiling_addr
)
18714 start_byte
+= cursor
- base
;
18719 while (start_byte
> limit_byte
)
18721 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
18722 ceiling
= max (limit_byte
, ceiling
);
18723 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
18724 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
18727 if (selective_display
)
18728 while (--cursor
!= ceiling_addr
18729 && *cursor
!= '\n' && *cursor
!= 015)
18732 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
18735 if (cursor
!= ceiling_addr
)
18739 start_byte
+= cursor
- base
+ 1;
18740 *byte_pos_ptr
= start_byte
;
18741 /* When scanning backwards, we should
18742 not count the newline posterior to which we stop. */
18743 return - orig_count
- 1;
18749 /* Here we add 1 to compensate for the last decrement
18750 of CURSOR, which took it past the valid range. */
18751 start_byte
+= cursor
- base
+ 1;
18755 *byte_pos_ptr
= limit_byte
;
18758 return - orig_count
+ count
;
18759 return orig_count
- count
;
18765 /***********************************************************************
18767 ***********************************************************************/
18769 /* Display a NUL-terminated string, starting with index START.
18771 If STRING is non-null, display that C string. Otherwise, the Lisp
18772 string LISP_STRING is displayed. There's a case that STRING is
18773 non-null and LISP_STRING is not nil. It means STRING is a string
18774 data of LISP_STRING. In that case, we display LISP_STRING while
18775 ignoring its text properties.
18777 If FACE_STRING is not nil, FACE_STRING_POS is a position in
18778 FACE_STRING. Display STRING or LISP_STRING with the face at
18779 FACE_STRING_POS in FACE_STRING:
18781 Display the string in the environment given by IT, but use the
18782 standard display table, temporarily.
18784 FIELD_WIDTH is the minimum number of output glyphs to produce.
18785 If STRING has fewer characters than FIELD_WIDTH, pad to the right
18786 with spaces. If STRING has more characters, more than FIELD_WIDTH
18787 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
18789 PRECISION is the maximum number of characters to output from
18790 STRING. PRECISION < 0 means don't truncate the string.
18792 This is roughly equivalent to printf format specifiers:
18794 FIELD_WIDTH PRECISION PRINTF
18795 ----------------------------------------
18801 MULTIBYTE zero means do not display multibyte chars, > 0 means do
18802 display them, and < 0 means obey the current buffer's value of
18803 enable_multibyte_characters.
18805 Value is the number of columns displayed. */
18808 display_string (string
, lisp_string
, face_string
, face_string_pos
,
18809 start
, it
, field_width
, precision
, max_x
, multibyte
)
18810 unsigned char *string
;
18811 Lisp_Object lisp_string
;
18812 Lisp_Object face_string
;
18813 EMACS_INT face_string_pos
;
18816 int field_width
, precision
, max_x
;
18819 int hpos_at_start
= it
->hpos
;
18820 int saved_face_id
= it
->face_id
;
18821 struct glyph_row
*row
= it
->glyph_row
;
18823 /* Initialize the iterator IT for iteration over STRING beginning
18824 with index START. */
18825 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
18826 precision
, field_width
, multibyte
);
18827 if (string
&& STRINGP (lisp_string
))
18828 /* LISP_STRING is the one returned by decode_mode_spec. We should
18829 ignore its text properties. */
18830 it
->stop_charpos
= -1;
18832 /* If displaying STRING, set up the face of the iterator
18833 from LISP_STRING, if that's given. */
18834 if (STRINGP (face_string
))
18840 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
18841 0, it
->region_beg_charpos
,
18842 it
->region_end_charpos
,
18843 &endptr
, it
->base_face_id
, 0);
18844 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18845 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
18848 /* Set max_x to the maximum allowed X position. Don't let it go
18849 beyond the right edge of the window. */
18851 max_x
= it
->last_visible_x
;
18853 max_x
= min (max_x
, it
->last_visible_x
);
18855 /* Skip over display elements that are not visible. because IT->w is
18857 if (it
->current_x
< it
->first_visible_x
)
18858 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
18859 MOVE_TO_POS
| MOVE_TO_X
);
18861 row
->ascent
= it
->max_ascent
;
18862 row
->height
= it
->max_ascent
+ it
->max_descent
;
18863 row
->phys_ascent
= it
->max_phys_ascent
;
18864 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18865 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18867 /* This condition is for the case that we are called with current_x
18868 past last_visible_x. */
18869 while (it
->current_x
< max_x
)
18871 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
18873 /* Get the next display element. */
18874 if (!get_next_display_element (it
))
18877 /* Produce glyphs. */
18878 x_before
= it
->current_x
;
18879 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
18880 PRODUCE_GLYPHS (it
);
18882 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
18885 while (i
< nglyphs
)
18887 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
18889 if (it
->line_wrap
!= TRUNCATE
18890 && x
+ glyph
->pixel_width
> max_x
)
18892 /* End of continued line or max_x reached. */
18893 if (CHAR_GLYPH_PADDING_P (*glyph
))
18895 /* A wide character is unbreakable. */
18896 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18897 it
->current_x
= x_before
;
18901 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
18906 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
18908 /* Glyph is at least partially visible. */
18910 if (x
< it
->first_visible_x
)
18911 it
->glyph_row
->x
= x
- it
->first_visible_x
;
18915 /* Glyph is off the left margin of the display area.
18916 Should not happen. */
18920 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18921 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18922 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18923 row
->phys_height
= max (row
->phys_height
,
18924 it
->max_phys_ascent
+ it
->max_phys_descent
);
18925 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18926 it
->max_extra_line_spacing
);
18927 x
+= glyph
->pixel_width
;
18931 /* Stop if max_x reached. */
18935 /* Stop at line ends. */
18936 if (ITERATOR_AT_END_OF_LINE_P (it
))
18938 it
->continuation_lines_width
= 0;
18942 set_iterator_to_next (it
, 1);
18944 /* Stop if truncating at the right edge. */
18945 if (it
->line_wrap
== TRUNCATE
18946 && it
->current_x
>= it
->last_visible_x
)
18948 /* Add truncation mark, but don't do it if the line is
18949 truncated at a padding space. */
18950 if (IT_CHARPOS (*it
) < it
->string_nchars
)
18952 if (!FRAME_WINDOW_P (it
->f
))
18956 if (it
->current_x
> it
->last_visible_x
)
18958 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
18959 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
18961 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
18963 row
->used
[TEXT_AREA
] = i
;
18964 produce_special_glyphs (it
, IT_TRUNCATION
);
18967 produce_special_glyphs (it
, IT_TRUNCATION
);
18969 it
->glyph_row
->truncated_on_right_p
= 1;
18975 /* Maybe insert a truncation at the left. */
18976 if (it
->first_visible_x
18977 && IT_CHARPOS (*it
) > 0)
18979 if (!FRAME_WINDOW_P (it
->f
))
18980 insert_left_trunc_glyphs (it
);
18981 it
->glyph_row
->truncated_on_left_p
= 1;
18984 it
->face_id
= saved_face_id
;
18986 /* Value is number of columns displayed. */
18987 return it
->hpos
- hpos_at_start
;
18992 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
18993 appears as an element of LIST or as the car of an element of LIST.
18994 If PROPVAL is a list, compare each element against LIST in that
18995 way, and return 1/2 if any element of PROPVAL is found in LIST.
18996 Otherwise return 0. This function cannot quit.
18997 The return value is 2 if the text is invisible but with an ellipsis
18998 and 1 if it's invisible and without an ellipsis. */
19001 invisible_p (propval
, list
)
19002 register Lisp_Object propval
;
19005 register Lisp_Object tail
, proptail
;
19007 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
19009 register Lisp_Object tem
;
19011 if (EQ (propval
, tem
))
19013 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
19014 return NILP (XCDR (tem
)) ? 1 : 2;
19017 if (CONSP (propval
))
19019 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
19021 Lisp_Object propelt
;
19022 propelt
= XCAR (proptail
);
19023 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
19025 register Lisp_Object tem
;
19027 if (EQ (propelt
, tem
))
19029 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
19030 return NILP (XCDR (tem
)) ? 1 : 2;
19038 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
19039 doc
: /* Non-nil if the property makes the text invisible.
19040 POS-OR-PROP can be a marker or number, in which case it is taken to be
19041 a position in the current buffer and the value of the `invisible' property
19042 is checked; or it can be some other value, which is then presumed to be the
19043 value of the `invisible' property of the text of interest.
19044 The non-nil value returned can be t for truly invisible text or something
19045 else if the text is replaced by an ellipsis. */)
19047 Lisp_Object pos_or_prop
;
19050 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
19051 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
19053 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
19054 return (invis
== 0 ? Qnil
19056 : make_number (invis
));
19059 /* Calculate a width or height in pixels from a specification using
19060 the following elements:
19063 NUM - a (fractional) multiple of the default font width/height
19064 (NUM) - specifies exactly NUM pixels
19065 UNIT - a fixed number of pixels, see below.
19066 ELEMENT - size of a display element in pixels, see below.
19067 (NUM . SPEC) - equals NUM * SPEC
19068 (+ SPEC SPEC ...) - add pixel values
19069 (- SPEC SPEC ...) - subtract pixel values
19070 (- SPEC) - negate pixel value
19073 INT or FLOAT - a number constant
19074 SYMBOL - use symbol's (buffer local) variable binding.
19077 in - pixels per inch *)
19078 mm - pixels per 1/1000 meter *)
19079 cm - pixels per 1/100 meter *)
19080 width - width of current font in pixels.
19081 height - height of current font in pixels.
19083 *) using the ratio(s) defined in display-pixels-per-inch.
19087 left-fringe - left fringe width in pixels
19088 right-fringe - right fringe width in pixels
19090 left-margin - left margin width in pixels
19091 right-margin - right margin width in pixels
19093 scroll-bar - scroll-bar area width in pixels
19097 Pixels corresponding to 5 inches:
19100 Total width of non-text areas on left side of window (if scroll-bar is on left):
19101 '(space :width (+ left-fringe left-margin scroll-bar))
19103 Align to first text column (in header line):
19104 '(space :align-to 0)
19106 Align to middle of text area minus half the width of variable `my-image'
19107 containing a loaded image:
19108 '(space :align-to (0.5 . (- text my-image)))
19110 Width of left margin minus width of 1 character in the default font:
19111 '(space :width (- left-margin 1))
19113 Width of left margin minus width of 2 characters in the current font:
19114 '(space :width (- left-margin (2 . width)))
19116 Center 1 character over left-margin (in header line):
19117 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
19119 Different ways to express width of left fringe plus left margin minus one pixel:
19120 '(space :width (- (+ left-fringe left-margin) (1)))
19121 '(space :width (+ left-fringe left-margin (- (1))))
19122 '(space :width (+ left-fringe left-margin (-1)))
19126 #define NUMVAL(X) \
19127 ((INTEGERP (X) || FLOATP (X)) \
19132 calc_pixel_width_or_height (res
, it
, prop
, font
, width_p
, align_to
)
19137 int width_p
, *align_to
;
19141 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
19142 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
19145 return OK_PIXELS (0);
19147 xassert (FRAME_LIVE_P (it
->f
));
19149 if (SYMBOLP (prop
))
19151 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
19153 char *unit
= SDATA (SYMBOL_NAME (prop
));
19155 if (unit
[0] == 'i' && unit
[1] == 'n')
19157 else if (unit
[0] == 'm' && unit
[1] == 'm')
19159 else if (unit
[0] == 'c' && unit
[1] == 'm')
19166 #ifdef HAVE_WINDOW_SYSTEM
19167 if (FRAME_WINDOW_P (it
->f
)
19169 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
19170 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
19172 return OK_PIXELS (ppi
/ pixels
);
19175 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
19176 || (CONSP (Vdisplay_pixels_per_inch
)
19178 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
19179 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
19181 return OK_PIXELS (ppi
/ pixels
);
19187 #ifdef HAVE_WINDOW_SYSTEM
19188 if (EQ (prop
, Qheight
))
19189 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
19190 if (EQ (prop
, Qwidth
))
19191 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
19193 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
19194 return OK_PIXELS (1);
19197 if (EQ (prop
, Qtext
))
19198 return OK_PIXELS (width_p
19199 ? window_box_width (it
->w
, TEXT_AREA
)
19200 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
19202 if (align_to
&& *align_to
< 0)
19205 if (EQ (prop
, Qleft
))
19206 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
19207 if (EQ (prop
, Qright
))
19208 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
19209 if (EQ (prop
, Qcenter
))
19210 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
19211 + window_box_width (it
->w
, TEXT_AREA
) / 2);
19212 if (EQ (prop
, Qleft_fringe
))
19213 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
19214 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
19215 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
19216 if (EQ (prop
, Qright_fringe
))
19217 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
19218 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
19219 : window_box_right_offset (it
->w
, TEXT_AREA
));
19220 if (EQ (prop
, Qleft_margin
))
19221 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
19222 if (EQ (prop
, Qright_margin
))
19223 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
19224 if (EQ (prop
, Qscroll_bar
))
19225 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
19227 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
19228 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
19229 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
19234 if (EQ (prop
, Qleft_fringe
))
19235 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
19236 if (EQ (prop
, Qright_fringe
))
19237 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
19238 if (EQ (prop
, Qleft_margin
))
19239 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
19240 if (EQ (prop
, Qright_margin
))
19241 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
19242 if (EQ (prop
, Qscroll_bar
))
19243 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
19246 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
19249 if (INTEGERP (prop
) || FLOATP (prop
))
19251 int base_unit
= (width_p
19252 ? FRAME_COLUMN_WIDTH (it
->f
)
19253 : FRAME_LINE_HEIGHT (it
->f
));
19254 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
19259 Lisp_Object car
= XCAR (prop
);
19260 Lisp_Object cdr
= XCDR (prop
);
19264 #ifdef HAVE_WINDOW_SYSTEM
19265 if (FRAME_WINDOW_P (it
->f
)
19266 && valid_image_p (prop
))
19268 int id
= lookup_image (it
->f
, prop
);
19269 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
19271 return OK_PIXELS (width_p
? img
->width
: img
->height
);
19274 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
19280 while (CONSP (cdr
))
19282 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
19283 font
, width_p
, align_to
))
19286 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
19291 if (EQ (car
, Qminus
))
19293 return OK_PIXELS (pixels
);
19296 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
19299 if (INTEGERP (car
) || FLOATP (car
))
19302 pixels
= XFLOATINT (car
);
19304 return OK_PIXELS (pixels
);
19305 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
19306 font
, width_p
, align_to
))
19307 return OK_PIXELS (pixels
* fact
);
19318 /***********************************************************************
19320 ***********************************************************************/
19322 #ifdef HAVE_WINDOW_SYSTEM
19327 dump_glyph_string (s
)
19328 struct glyph_string
*s
;
19330 fprintf (stderr
, "glyph string\n");
19331 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
19332 s
->x
, s
->y
, s
->width
, s
->height
);
19333 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
19334 fprintf (stderr
, " hl = %d\n", s
->hl
);
19335 fprintf (stderr
, " left overhang = %d, right = %d\n",
19336 s
->left_overhang
, s
->right_overhang
);
19337 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
19338 fprintf (stderr
, " extends to end of line = %d\n",
19339 s
->extends_to_end_of_line_p
);
19340 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
19341 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
19344 #endif /* GLYPH_DEBUG */
19346 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
19347 of XChar2b structures for S; it can't be allocated in
19348 init_glyph_string because it must be allocated via `alloca'. W
19349 is the window on which S is drawn. ROW and AREA are the glyph row
19350 and area within the row from which S is constructed. START is the
19351 index of the first glyph structure covered by S. HL is a
19352 face-override for drawing S. */
19355 #define OPTIONAL_HDC(hdc) hdc,
19356 #define DECLARE_HDC(hdc) HDC hdc;
19357 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
19358 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
19361 #ifndef OPTIONAL_HDC
19362 #define OPTIONAL_HDC(hdc)
19363 #define DECLARE_HDC(hdc)
19364 #define ALLOCATE_HDC(hdc, f)
19365 #define RELEASE_HDC(hdc, f)
19369 init_glyph_string (s
, OPTIONAL_HDC (hdc
) char2b
, w
, row
, area
, start
, hl
)
19370 struct glyph_string
*s
;
19374 struct glyph_row
*row
;
19375 enum glyph_row_area area
;
19377 enum draw_glyphs_face hl
;
19379 bzero (s
, sizeof *s
);
19381 s
->f
= XFRAME (w
->frame
);
19385 s
->display
= FRAME_X_DISPLAY (s
->f
);
19386 s
->window
= FRAME_X_WINDOW (s
->f
);
19387 s
->char2b
= char2b
;
19391 s
->first_glyph
= row
->glyphs
[area
] + start
;
19392 s
->height
= row
->height
;
19393 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
19394 s
->ybase
= s
->y
+ row
->ascent
;
19398 /* Append the list of glyph strings with head H and tail T to the list
19399 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
19402 append_glyph_string_lists (head
, tail
, h
, t
)
19403 struct glyph_string
**head
, **tail
;
19404 struct glyph_string
*h
, *t
;
19418 /* Prepend the list of glyph strings with head H and tail T to the
19419 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
19423 prepend_glyph_string_lists (head
, tail
, h
, t
)
19424 struct glyph_string
**head
, **tail
;
19425 struct glyph_string
*h
, *t
;
19439 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
19440 Set *HEAD and *TAIL to the resulting list. */
19443 append_glyph_string (head
, tail
, s
)
19444 struct glyph_string
**head
, **tail
;
19445 struct glyph_string
*s
;
19447 s
->next
= s
->prev
= NULL
;
19448 append_glyph_string_lists (head
, tail
, s
, s
);
19452 /* Get face and two-byte form of character C in face FACE_ID on frame
19453 F. The encoding of C is returned in *CHAR2B. MULTIBYTE_P non-zero
19454 means we want to display multibyte text. DISPLAY_P non-zero means
19455 make sure that X resources for the face returned are allocated.
19456 Value is a pointer to a realized face that is ready for display if
19457 DISPLAY_P is non-zero. */
19459 static INLINE
struct face
*
19460 get_char_face_and_encoding (f
, c
, face_id
, char2b
, multibyte_p
, display_p
)
19464 int multibyte_p
, display_p
;
19466 struct face
*face
= FACE_FROM_ID (f
, face_id
);
19470 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
19472 if (code
!= FONT_INVALID_CODE
)
19473 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
19475 STORE_XCHAR2B (char2b
, 0, 0);
19478 /* Make sure X resources of the face are allocated. */
19479 #ifdef HAVE_X_WINDOWS
19483 xassert (face
!= NULL
);
19484 PREPARE_FACE_FOR_DISPLAY (f
, face
);
19491 /* Get face and two-byte form of character glyph GLYPH on frame F.
19492 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
19493 a pointer to a realized face that is ready for display. */
19495 static INLINE
struct face
*
19496 get_glyph_face_and_encoding (f
, glyph
, char2b
, two_byte_p
)
19498 struct glyph
*glyph
;
19504 xassert (glyph
->type
== CHAR_GLYPH
);
19505 face
= FACE_FROM_ID (f
, glyph
->face_id
);
19512 unsigned 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 /* Fill glyph string S with composition components specified by S->cmp.
19529 BASE_FACE is the base face of the composition.
19530 S->cmp_from is the index of the first component for S.
19532 OVERLAPS non-zero means S should draw the foreground only, and use
19533 its physical height for clipping. See also draw_glyphs.
19535 Value is the index of a component not in S. */
19538 fill_composite_glyph_string (s
, base_face
, overlaps
)
19539 struct glyph_string
*s
;
19540 struct face
*base_face
;
19544 /* For all glyphs of this composition, starting at the offset
19545 S->cmp_from, until we reach the end of the definition or encounter a
19546 glyph that requires the different face, add it to S. */
19551 s
->for_overlaps
= overlaps
;
19554 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
19556 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
19560 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
19563 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
19564 s
->char2b
+ i
, 1, 1);
19570 s
->font
= s
->face
->font
;
19572 else if (s
->face
!= face
)
19580 /* All glyph strings for the same composition has the same width,
19581 i.e. the width set for the first component of the composition. */
19582 s
->width
= s
->first_glyph
->pixel_width
;
19584 /* If the specified font could not be loaded, use the frame's
19585 default font, but record the fact that we couldn't load it in
19586 the glyph string so that we can draw rectangles for the
19587 characters of the glyph string. */
19588 if (s
->font
== NULL
)
19590 s
->font_not_found_p
= 1;
19591 s
->font
= FRAME_FONT (s
->f
);
19594 /* Adjust base line for subscript/superscript text. */
19595 s
->ybase
+= s
->first_glyph
->voffset
;
19597 /* This glyph string must always be drawn with 16-bit functions. */
19604 fill_gstring_glyph_string (s
, face_id
, start
, end
, overlaps
)
19605 struct glyph_string
*s
;
19607 int start
, end
, overlaps
;
19609 struct glyph
*glyph
, *last
;
19610 Lisp_Object lgstring
;
19613 s
->for_overlaps
= overlaps
;
19614 glyph
= s
->row
->glyphs
[s
->area
] + start
;
19615 last
= s
->row
->glyphs
[s
->area
] + end
;
19616 s
->cmp_id
= glyph
->u
.cmp
.id
;
19617 s
->cmp_from
= glyph
->u
.cmp
.from
;
19618 s
->cmp_to
= glyph
->u
.cmp
.to
+ 1;
19619 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
19620 lgstring
= composition_gstring_from_id (s
->cmp_id
);
19621 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
19623 while (glyph
< last
19624 && glyph
->u
.cmp
.automatic
19625 && glyph
->u
.cmp
.id
== s
->cmp_id
19626 && s
->cmp_to
== glyph
->u
.cmp
.from
)
19627 s
->cmp_to
= (glyph
++)->u
.cmp
.to
+ 1;
19629 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
19631 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
19632 unsigned code
= LGLYPH_CODE (lglyph
);
19634 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
19636 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
19637 return glyph
- s
->row
->glyphs
[s
->area
];
19641 /* Fill glyph string S from a sequence of character glyphs.
19643 FACE_ID is the face id of the string. START is the index of the
19644 first glyph to consider, END is the index of the last + 1.
19645 OVERLAPS non-zero means S should draw the foreground only, and use
19646 its physical height for clipping. See also draw_glyphs.
19648 Value is the index of the first glyph not in S. */
19651 fill_glyph_string (s
, face_id
, start
, end
, overlaps
)
19652 struct glyph_string
*s
;
19654 int start
, end
, overlaps
;
19656 struct glyph
*glyph
, *last
;
19658 int glyph_not_available_p
;
19660 xassert (s
->f
== XFRAME (s
->w
->frame
));
19661 xassert (s
->nchars
== 0);
19662 xassert (start
>= 0 && end
> start
);
19664 s
->for_overlaps
= overlaps
;
19665 glyph
= s
->row
->glyphs
[s
->area
] + start
;
19666 last
= s
->row
->glyphs
[s
->area
] + end
;
19667 voffset
= glyph
->voffset
;
19668 s
->padding_p
= glyph
->padding_p
;
19669 glyph_not_available_p
= glyph
->glyph_not_available_p
;
19671 while (glyph
< last
19672 && glyph
->type
== CHAR_GLYPH
19673 && glyph
->voffset
== voffset
19674 /* Same face id implies same font, nowadays. */
19675 && glyph
->face_id
== face_id
19676 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
19680 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
19681 s
->char2b
+ s
->nchars
,
19683 s
->two_byte_p
= two_byte_p
;
19685 xassert (s
->nchars
<= end
- start
);
19686 s
->width
+= glyph
->pixel_width
;
19687 if (glyph
++->padding_p
!= s
->padding_p
)
19691 s
->font
= s
->face
->font
;
19693 /* If the specified font could not be loaded, use the frame's font,
19694 but record the fact that we couldn't load it in
19695 S->font_not_found_p so that we can draw rectangles for the
19696 characters of the glyph string. */
19697 if (s
->font
== NULL
|| glyph_not_available_p
)
19699 s
->font_not_found_p
= 1;
19700 s
->font
= FRAME_FONT (s
->f
);
19703 /* Adjust base line for subscript/superscript text. */
19704 s
->ybase
+= voffset
;
19706 xassert (s
->face
&& s
->face
->gc
);
19707 return glyph
- s
->row
->glyphs
[s
->area
];
19711 /* Fill glyph string S from image glyph S->first_glyph. */
19714 fill_image_glyph_string (s
)
19715 struct glyph_string
*s
;
19717 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
19718 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
19720 s
->slice
= s
->first_glyph
->slice
;
19721 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
19722 s
->font
= s
->face
->font
;
19723 s
->width
= s
->first_glyph
->pixel_width
;
19725 /* Adjust base line for subscript/superscript text. */
19726 s
->ybase
+= s
->first_glyph
->voffset
;
19730 /* Fill glyph string S from a sequence of stretch glyphs.
19732 ROW is the glyph row in which the glyphs are found, AREA is the
19733 area within the row. START is the index of the first glyph to
19734 consider, END is the index of the last + 1.
19736 Value is the index of the first glyph not in S. */
19739 fill_stretch_glyph_string (s
, row
, area
, start
, end
)
19740 struct glyph_string
*s
;
19741 struct glyph_row
*row
;
19742 enum glyph_row_area area
;
19745 struct glyph
*glyph
, *last
;
19746 int voffset
, face_id
;
19748 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
19750 glyph
= s
->row
->glyphs
[s
->area
] + start
;
19751 last
= s
->row
->glyphs
[s
->area
] + end
;
19752 face_id
= glyph
->face_id
;
19753 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
19754 s
->font
= s
->face
->font
;
19755 s
->width
= glyph
->pixel_width
;
19757 voffset
= glyph
->voffset
;
19761 && glyph
->type
== STRETCH_GLYPH
19762 && glyph
->voffset
== voffset
19763 && glyph
->face_id
== face_id
);
19765 s
->width
+= glyph
->pixel_width
;
19767 /* Adjust base line for subscript/superscript text. */
19768 s
->ybase
+= voffset
;
19770 /* The case that face->gc == 0 is handled when drawing the glyph
19771 string by calling PREPARE_FACE_FOR_DISPLAY. */
19773 return glyph
- s
->row
->glyphs
[s
->area
];
19776 static struct font_metrics
*
19777 get_per_char_metric (f
, font
, char2b
)
19782 static struct font_metrics metrics
;
19783 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
19785 if (! font
|| code
== FONT_INVALID_CODE
)
19787 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
19792 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
19793 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
19794 assumed to be zero. */
19797 x_get_glyph_overhangs (glyph
, f
, left
, right
)
19798 struct glyph
*glyph
;
19802 *left
= *right
= 0;
19804 if (glyph
->type
== CHAR_GLYPH
)
19808 struct font_metrics
*pcm
;
19810 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
19811 if (face
->font
&& (pcm
= get_per_char_metric (f
, face
->font
, &char2b
)))
19813 if (pcm
->rbearing
> pcm
->width
)
19814 *right
= pcm
->rbearing
- pcm
->width
;
19815 if (pcm
->lbearing
< 0)
19816 *left
= -pcm
->lbearing
;
19819 else if (glyph
->type
== COMPOSITE_GLYPH
)
19821 if (! glyph
->u
.cmp
.automatic
)
19823 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
19825 if (cmp
->rbearing
> cmp
->pixel_width
)
19826 *right
= cmp
->rbearing
- cmp
->pixel_width
;
19827 if (cmp
->lbearing
< 0)
19828 *left
= - cmp
->lbearing
;
19832 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
19833 struct font_metrics metrics
;
19835 composition_gstring_width (gstring
, glyph
->u
.cmp
.from
,
19836 glyph
->u
.cmp
.to
+ 1, &metrics
);
19837 if (metrics
.rbearing
> metrics
.width
)
19838 *right
= metrics
.rbearing
- metrics
.width
;
19839 if (metrics
.lbearing
< 0)
19840 *left
= - metrics
.lbearing
;
19846 /* Return the index of the first glyph preceding glyph string S that
19847 is overwritten by S because of S's left overhang. Value is -1
19848 if no glyphs are overwritten. */
19851 left_overwritten (s
)
19852 struct glyph_string
*s
;
19856 if (s
->left_overhang
)
19859 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19860 int first
= s
->first_glyph
- glyphs
;
19862 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
19863 x
-= glyphs
[i
].pixel_width
;
19874 /* Return the index of the first glyph preceding glyph string S that
19875 is overwriting S because of its right overhang. Value is -1 if no
19876 glyph in front of S overwrites S. */
19879 left_overwriting (s
)
19880 struct glyph_string
*s
;
19883 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19884 int first
= s
->first_glyph
- glyphs
;
19888 for (i
= first
- 1; i
>= 0; --i
)
19891 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
19894 x
-= glyphs
[i
].pixel_width
;
19901 /* Return the index of the last glyph following glyph string S that is
19902 overwritten by S because of S's right overhang. Value is -1 if
19903 no such glyph is found. */
19906 right_overwritten (s
)
19907 struct glyph_string
*s
;
19911 if (s
->right_overhang
)
19914 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19915 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
19916 int end
= s
->row
->used
[s
->area
];
19918 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
19919 x
+= glyphs
[i
].pixel_width
;
19928 /* Return the index of the last glyph following glyph string S that
19929 overwrites S because of its left overhang. Value is negative
19930 if no such glyph is found. */
19933 right_overwriting (s
)
19934 struct glyph_string
*s
;
19937 int end
= s
->row
->used
[s
->area
];
19938 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19939 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
19943 for (i
= first
; i
< end
; ++i
)
19946 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
19949 x
+= glyphs
[i
].pixel_width
;
19956 /* Set background width of glyph string S. START is the index of the
19957 first glyph following S. LAST_X is the right-most x-position + 1
19958 in the drawing area. */
19961 set_glyph_string_background_width (s
, start
, last_x
)
19962 struct glyph_string
*s
;
19966 /* If the face of this glyph string has to be drawn to the end of
19967 the drawing area, set S->extends_to_end_of_line_p. */
19969 if (start
== s
->row
->used
[s
->area
]
19970 && s
->area
== TEXT_AREA
19971 && ((s
->row
->fill_line_p
19972 && (s
->hl
== DRAW_NORMAL_TEXT
19973 || s
->hl
== DRAW_IMAGE_RAISED
19974 || s
->hl
== DRAW_IMAGE_SUNKEN
))
19975 || s
->hl
== DRAW_MOUSE_FACE
))
19976 s
->extends_to_end_of_line_p
= 1;
19978 /* If S extends its face to the end of the line, set its
19979 background_width to the distance to the right edge of the drawing
19981 if (s
->extends_to_end_of_line_p
)
19982 s
->background_width
= last_x
- s
->x
+ 1;
19984 s
->background_width
= s
->width
;
19988 /* Compute overhangs and x-positions for glyph string S and its
19989 predecessors, or successors. X is the starting x-position for S.
19990 BACKWARD_P non-zero means process predecessors. */
19993 compute_overhangs_and_x (s
, x
, backward_p
)
19994 struct glyph_string
*s
;
20002 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
20003 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
20013 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
20014 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
20024 /* The following macros are only called from draw_glyphs below.
20025 They reference the following parameters of that function directly:
20026 `w', `row', `area', and `overlap_p'
20027 as well as the following local variables:
20028 `s', `f', and `hdc' (in W32) */
20031 /* On W32, silently add local `hdc' variable to argument list of
20032 init_glyph_string. */
20033 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
20034 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
20036 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
20037 init_glyph_string (s, char2b, w, row, area, start, hl)
20040 /* Add a glyph string for a stretch glyph to the list of strings
20041 between HEAD and TAIL. START is the index of the stretch glyph in
20042 row area AREA of glyph row ROW. END is the index of the last glyph
20043 in that glyph row area. X is the current output position assigned
20044 to the new glyph string constructed. HL overrides that face of the
20045 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
20046 is the right-most x-position of the drawing area. */
20048 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
20049 and below -- keep them on one line. */
20050 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
20053 s = (struct glyph_string *) alloca (sizeof *s); \
20054 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
20055 START = fill_stretch_glyph_string (s, row, area, START, END); \
20056 append_glyph_string (&HEAD, &TAIL, s); \
20062 /* Add a glyph string for an image glyph to the list of strings
20063 between HEAD and TAIL. START is the index of the image glyph in
20064 row area AREA of glyph row ROW. END is the index of the last glyph
20065 in that glyph row area. X is the current output position assigned
20066 to the new glyph string constructed. HL overrides that face of the
20067 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
20068 is the right-most x-position of the drawing area. */
20070 #define BUILD_IMAGE_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 fill_image_glyph_string (s); \
20076 append_glyph_string (&HEAD, &TAIL, s); \
20083 /* Add a glyph string for a sequence of character glyphs to the list
20084 of strings between HEAD and TAIL. START is the index of the first
20085 glyph in row area AREA of glyph row ROW that is part of the new
20086 glyph string. END is the index of the last glyph in that glyph row
20087 area. X is the current output position assigned to the new glyph
20088 string constructed. HL overrides that face of the glyph; e.g. it
20089 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
20090 right-most x-position of the drawing area. */
20092 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
20098 face_id = (row)->glyphs[area][START].face_id; \
20100 s = (struct glyph_string *) alloca (sizeof *s); \
20101 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
20102 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
20103 append_glyph_string (&HEAD, &TAIL, s); \
20105 START = fill_glyph_string (s, face_id, START, END, overlaps); \
20110 /* Add a glyph string for a composite sequence to the list of strings
20111 between HEAD and TAIL. START is the index of the first glyph in
20112 row area AREA of glyph row ROW that is part of the new glyph
20113 string. END is the index of the last glyph in that glyph row area.
20114 X is the current output position assigned to the new glyph string
20115 constructed. HL overrides that face of the glyph; e.g. it is
20116 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
20117 x-position of the drawing area. */
20119 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
20121 int face_id = (row)->glyphs[area][START].face_id; \
20122 struct face *base_face = FACE_FROM_ID (f, face_id); \
20123 int cmp_id = (row)->glyphs[area][START].u.cmp.id; \
20124 struct composition *cmp = composition_table[cmp_id]; \
20126 struct glyph_string *first_s; \
20129 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
20131 /* Make glyph_strings for each glyph sequence that is drawable by \
20132 the same face, and append them to HEAD/TAIL. */ \
20133 for (n = 0; n < cmp->glyph_len;) \
20135 s = (struct glyph_string *) alloca (sizeof *s); \
20136 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
20137 append_glyph_string (&(HEAD), &(TAIL), s); \
20143 n = fill_composite_glyph_string (s, base_face, overlaps); \
20151 /* Add a glyph string for a glyph-string sequence to the list of strings
20152 between HEAD and TAIL. */
20154 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
20158 Lisp_Object gstring; \
20160 face_id = (row)->glyphs[area][START].face_id; \
20161 gstring = (composition_gstring_from_id \
20162 ((row)->glyphs[area][START].u.cmp.id)); \
20163 s = (struct glyph_string *) alloca (sizeof *s); \
20164 char2b = (XChar2b *) alloca ((sizeof *char2b) \
20165 * LGSTRING_GLYPH_LEN (gstring)); \
20166 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
20167 append_glyph_string (&(HEAD), &(TAIL), s); \
20169 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
20173 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
20174 of AREA of glyph row ROW on window W between indices START and END.
20175 HL overrides the face for drawing glyph strings, e.g. it is
20176 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
20177 x-positions of the drawing area.
20179 This is an ugly monster macro construct because we must use alloca
20180 to allocate glyph strings (because draw_glyphs can be called
20181 asynchronously). */
20183 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
20186 HEAD = TAIL = NULL; \
20187 while (START < END) \
20189 struct glyph *first_glyph = (row)->glyphs[area] + START; \
20190 switch (first_glyph->type) \
20193 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
20197 case COMPOSITE_GLYPH: \
20198 if (first_glyph->u.cmp.automatic) \
20199 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
20202 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
20206 case STRETCH_GLYPH: \
20207 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
20211 case IMAGE_GLYPH: \
20212 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
20222 set_glyph_string_background_width (s, START, LAST_X); \
20229 /* Draw glyphs between START and END in AREA of ROW on window W,
20230 starting at x-position X. X is relative to AREA in W. HL is a
20231 face-override with the following meaning:
20233 DRAW_NORMAL_TEXT draw normally
20234 DRAW_CURSOR draw in cursor face
20235 DRAW_MOUSE_FACE draw in mouse face.
20236 DRAW_INVERSE_VIDEO draw in mode line face
20237 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
20238 DRAW_IMAGE_RAISED draw an image with a raised relief around it
20240 If OVERLAPS is non-zero, draw only the foreground of characters and
20241 clip to the physical height of ROW. Non-zero value also defines
20242 the overlapping part to be drawn:
20244 OVERLAPS_PRED overlap with preceding rows
20245 OVERLAPS_SUCC overlap with succeeding rows
20246 OVERLAPS_BOTH overlap with both preceding/succeeding rows
20247 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
20249 Value is the x-position reached, relative to AREA of W. */
20252 draw_glyphs (w
, x
, row
, area
, start
, end
, hl
, overlaps
)
20255 struct glyph_row
*row
;
20256 enum glyph_row_area area
;
20257 EMACS_INT start
, end
;
20258 enum draw_glyphs_face hl
;
20261 struct glyph_string
*head
, *tail
;
20262 struct glyph_string
*s
;
20263 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
20264 int i
, j
, x_reached
, last_x
, area_left
= 0;
20265 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
20268 ALLOCATE_HDC (hdc
, f
);
20270 /* Let's rather be paranoid than getting a SEGV. */
20271 end
= min (end
, row
->used
[area
]);
20272 start
= max (0, start
);
20273 start
= min (end
, start
);
20275 /* Translate X to frame coordinates. Set last_x to the right
20276 end of the drawing area. */
20277 if (row
->full_width_p
)
20279 /* X is relative to the left edge of W, without scroll bars
20281 area_left
= WINDOW_LEFT_EDGE_X (w
);
20282 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
20286 area_left
= window_box_left (w
, area
);
20287 last_x
= area_left
+ window_box_width (w
, area
);
20291 /* Build a doubly-linked list of glyph_string structures between
20292 head and tail from what we have to draw. Note that the macro
20293 BUILD_GLYPH_STRINGS will modify its start parameter. That's
20294 the reason we use a separate variable `i'. */
20296 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
20298 x_reached
= tail
->x
+ tail
->background_width
;
20302 /* If there are any glyphs with lbearing < 0 or rbearing > width in
20303 the row, redraw some glyphs in front or following the glyph
20304 strings built above. */
20305 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
20307 struct glyph_string
*h
, *t
;
20308 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
20309 int mouse_beg_col
, mouse_end_col
, check_mouse_face
= 0;
20312 /* If mouse highlighting is on, we may need to draw adjacent
20313 glyphs using mouse-face highlighting. */
20314 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
20316 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
20318 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
20319 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
20321 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
20323 check_mouse_face
= 1;
20324 mouse_beg_col
= (row
== mouse_beg_row
)
20325 ? dpyinfo
->mouse_face_beg_col
: 0;
20326 mouse_end_col
= (row
== mouse_end_row
)
20327 ? dpyinfo
->mouse_face_end_col
20328 : row
->used
[TEXT_AREA
];
20332 /* Compute overhangs for all glyph strings. */
20333 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
20334 for (s
= head
; s
; s
= s
->next
)
20335 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
20337 /* Prepend glyph strings for glyphs in front of the first glyph
20338 string that are overwritten because of the first glyph
20339 string's left overhang. The background of all strings
20340 prepended must be drawn because the first glyph string
20342 i
= left_overwritten (head
);
20345 enum draw_glyphs_face overlap_hl
;
20347 /* If this row contains mouse highlighting, attempt to draw
20348 the overlapped glyphs with the correct highlight. This
20349 code fails if the overlap encompasses more than one glyph
20350 and mouse-highlight spans only some of these glyphs.
20351 However, making it work perfectly involves a lot more
20352 code, and I don't know if the pathological case occurs in
20353 practice, so we'll stick to this for now. --- cyd */
20354 if (check_mouse_face
20355 && mouse_beg_col
< start
&& mouse_end_col
> i
)
20356 overlap_hl
= DRAW_MOUSE_FACE
;
20358 overlap_hl
= DRAW_NORMAL_TEXT
;
20361 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
20362 overlap_hl
, dummy_x
, last_x
);
20364 compute_overhangs_and_x (t
, head
->x
, 1);
20365 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
20369 /* Prepend glyph strings for glyphs in front of the first glyph
20370 string that overwrite that glyph string because of their
20371 right overhang. For these strings, only the foreground must
20372 be drawn, because it draws over the glyph string at `head'.
20373 The background must not be drawn because this would overwrite
20374 right overhangs of preceding glyphs for which no glyph
20376 i
= left_overwriting (head
);
20379 enum draw_glyphs_face overlap_hl
;
20381 if (check_mouse_face
20382 && mouse_beg_col
< start
&& mouse_end_col
> i
)
20383 overlap_hl
= DRAW_MOUSE_FACE
;
20385 overlap_hl
= DRAW_NORMAL_TEXT
;
20388 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
20389 overlap_hl
, dummy_x
, last_x
);
20390 for (s
= h
; s
; s
= s
->next
)
20391 s
->background_filled_p
= 1;
20392 compute_overhangs_and_x (t
, head
->x
, 1);
20393 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
20396 /* Append glyphs strings for glyphs following the last glyph
20397 string tail that are overwritten by tail. The background of
20398 these strings has to be drawn because tail's foreground draws
20400 i
= right_overwritten (tail
);
20403 enum draw_glyphs_face overlap_hl
;
20405 if (check_mouse_face
20406 && mouse_beg_col
< i
&& mouse_end_col
> end
)
20407 overlap_hl
= DRAW_MOUSE_FACE
;
20409 overlap_hl
= DRAW_NORMAL_TEXT
;
20411 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
20412 overlap_hl
, x
, last_x
);
20413 /* Because BUILD_GLYPH_STRINGS updates the first argument,
20414 we don't have `end = i;' here. */
20415 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
20416 append_glyph_string_lists (&head
, &tail
, h
, t
);
20420 /* Append glyph strings for glyphs following the last glyph
20421 string tail that overwrite tail. The foreground of such
20422 glyphs has to be drawn because it writes into the background
20423 of tail. The background must not be drawn because it could
20424 paint over the foreground of following glyphs. */
20425 i
= right_overwriting (tail
);
20428 enum draw_glyphs_face overlap_hl
;
20429 if (check_mouse_face
20430 && mouse_beg_col
< i
&& mouse_end_col
> end
)
20431 overlap_hl
= DRAW_MOUSE_FACE
;
20433 overlap_hl
= DRAW_NORMAL_TEXT
;
20436 i
++; /* We must include the Ith glyph. */
20437 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
20438 overlap_hl
, x
, last_x
);
20439 for (s
= h
; s
; s
= s
->next
)
20440 s
->background_filled_p
= 1;
20441 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
20442 append_glyph_string_lists (&head
, &tail
, h
, t
);
20444 if (clip_head
|| clip_tail
)
20445 for (s
= head
; s
; s
= s
->next
)
20447 s
->clip_head
= clip_head
;
20448 s
->clip_tail
= clip_tail
;
20452 /* Draw all strings. */
20453 for (s
= head
; s
; s
= s
->next
)
20454 FRAME_RIF (f
)->draw_glyph_string (s
);
20457 /* When focus a sole frame and move horizontally, this sets on_p to 0
20458 causing a failure to erase prev cursor position. */
20459 if (area
== TEXT_AREA
20460 && !row
->full_width_p
20461 /* When drawing overlapping rows, only the glyph strings'
20462 foreground is drawn, which doesn't erase a cursor
20466 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
20467 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
20468 : (tail
? tail
->x
+ tail
->background_width
: x
));
20472 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
20473 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
20477 /* Value is the x-position up to which drawn, relative to AREA of W.
20478 This doesn't include parts drawn because of overhangs. */
20479 if (row
->full_width_p
)
20480 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
20482 x_reached
-= area_left
;
20484 RELEASE_HDC (hdc
, f
);
20489 /* Expand row matrix if too narrow. Don't expand if area
20492 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
20494 if (!fonts_changed_p \
20495 && (it->glyph_row->glyphs[area] \
20496 < it->glyph_row->glyphs[area + 1])) \
20498 it->w->ncols_scale_factor++; \
20499 fonts_changed_p = 1; \
20503 /* Store one glyph for IT->char_to_display in IT->glyph_row.
20504 Called from x_produce_glyphs when IT->glyph_row is non-null. */
20510 struct glyph
*glyph
;
20511 enum glyph_row_area area
= it
->area
;
20513 xassert (it
->glyph_row
);
20514 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
20516 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20517 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20519 glyph
->charpos
= CHARPOS (it
->position
);
20520 glyph
->object
= it
->object
;
20521 if (it
->pixel_width
> 0)
20523 glyph
->pixel_width
= it
->pixel_width
;
20524 glyph
->padding_p
= 0;
20528 /* Assure at least 1-pixel width. Otherwise, cursor can't
20529 be displayed correctly. */
20530 glyph
->pixel_width
= 1;
20531 glyph
->padding_p
= 1;
20533 glyph
->ascent
= it
->ascent
;
20534 glyph
->descent
= it
->descent
;
20535 glyph
->voffset
= it
->voffset
;
20536 glyph
->type
= CHAR_GLYPH
;
20537 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
20538 glyph
->multibyte_p
= it
->multibyte_p
;
20539 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20540 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20541 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
20542 || it
->phys_descent
> it
->descent
);
20543 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
20544 glyph
->face_id
= it
->face_id
;
20545 glyph
->u
.ch
= it
->char_to_display
;
20546 glyph
->slice
= null_glyph_slice
;
20547 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20548 ++it
->glyph_row
->used
[area
];
20551 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20554 /* Store one glyph for the composition IT->cmp_it.id in
20555 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
20559 append_composite_glyph (it
)
20562 struct glyph
*glyph
;
20563 enum glyph_row_area area
= it
->area
;
20565 xassert (it
->glyph_row
);
20567 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20568 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20570 glyph
->charpos
= CHARPOS (it
->position
);
20571 glyph
->object
= it
->object
;
20572 glyph
->pixel_width
= it
->pixel_width
;
20573 glyph
->ascent
= it
->ascent
;
20574 glyph
->descent
= it
->descent
;
20575 glyph
->voffset
= it
->voffset
;
20576 glyph
->type
= COMPOSITE_GLYPH
;
20577 if (it
->cmp_it
.ch
< 0)
20579 glyph
->u
.cmp
.automatic
= 0;
20580 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
20584 glyph
->u
.cmp
.automatic
= 1;
20585 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
20586 glyph
->u
.cmp
.from
= it
->cmp_it
.from
;
20587 glyph
->u
.cmp
.to
= it
->cmp_it
.to
- 1;
20589 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
20590 glyph
->multibyte_p
= it
->multibyte_p
;
20591 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20592 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20593 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
20594 || it
->phys_descent
> it
->descent
);
20595 glyph
->padding_p
= 0;
20596 glyph
->glyph_not_available_p
= 0;
20597 glyph
->face_id
= it
->face_id
;
20598 glyph
->slice
= null_glyph_slice
;
20599 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20600 ++it
->glyph_row
->used
[area
];
20603 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20607 /* Change IT->ascent and IT->height according to the setting of
20611 take_vertical_position_into_account (it
)
20616 if (it
->voffset
< 0)
20617 /* Increase the ascent so that we can display the text higher
20619 it
->ascent
-= it
->voffset
;
20621 /* Increase the descent so that we can display the text lower
20623 it
->descent
+= it
->voffset
;
20628 /* Produce glyphs/get display metrics for the image IT is loaded with.
20629 See the description of struct display_iterator in dispextern.h for
20630 an overview of struct display_iterator. */
20633 produce_image_glyph (it
)
20638 int glyph_ascent
, crop
;
20639 struct glyph_slice slice
;
20641 xassert (it
->what
== IT_IMAGE
);
20643 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20645 /* Make sure X resources of the face is loaded. */
20646 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
20648 if (it
->image_id
< 0)
20650 /* Fringe bitmap. */
20651 it
->ascent
= it
->phys_ascent
= 0;
20652 it
->descent
= it
->phys_descent
= 0;
20653 it
->pixel_width
= 0;
20658 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
20660 /* Make sure X resources of the image is loaded. */
20661 prepare_image_for_display (it
->f
, img
);
20663 slice
.x
= slice
.y
= 0;
20664 slice
.width
= img
->width
;
20665 slice
.height
= img
->height
;
20667 if (INTEGERP (it
->slice
.x
))
20668 slice
.x
= XINT (it
->slice
.x
);
20669 else if (FLOATP (it
->slice
.x
))
20670 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
20672 if (INTEGERP (it
->slice
.y
))
20673 slice
.y
= XINT (it
->slice
.y
);
20674 else if (FLOATP (it
->slice
.y
))
20675 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
20677 if (INTEGERP (it
->slice
.width
))
20678 slice
.width
= XINT (it
->slice
.width
);
20679 else if (FLOATP (it
->slice
.width
))
20680 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
20682 if (INTEGERP (it
->slice
.height
))
20683 slice
.height
= XINT (it
->slice
.height
);
20684 else if (FLOATP (it
->slice
.height
))
20685 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
20687 if (slice
.x
>= img
->width
)
20688 slice
.x
= img
->width
;
20689 if (slice
.y
>= img
->height
)
20690 slice
.y
= img
->height
;
20691 if (slice
.x
+ slice
.width
>= img
->width
)
20692 slice
.width
= img
->width
- slice
.x
;
20693 if (slice
.y
+ slice
.height
> img
->height
)
20694 slice
.height
= img
->height
- slice
.y
;
20696 if (slice
.width
== 0 || slice
.height
== 0)
20699 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
20701 it
->descent
= slice
.height
- glyph_ascent
;
20703 it
->descent
+= img
->vmargin
;
20704 if (slice
.y
+ slice
.height
== img
->height
)
20705 it
->descent
+= img
->vmargin
;
20706 it
->phys_descent
= it
->descent
;
20708 it
->pixel_width
= slice
.width
;
20710 it
->pixel_width
+= img
->hmargin
;
20711 if (slice
.x
+ slice
.width
== img
->width
)
20712 it
->pixel_width
+= img
->hmargin
;
20714 /* It's quite possible for images to have an ascent greater than
20715 their height, so don't get confused in that case. */
20716 if (it
->descent
< 0)
20721 if (face
->box
!= FACE_NO_BOX
)
20723 if (face
->box_line_width
> 0)
20726 it
->ascent
+= face
->box_line_width
;
20727 if (slice
.y
+ slice
.height
== img
->height
)
20728 it
->descent
+= face
->box_line_width
;
20731 if (it
->start_of_box_run_p
&& slice
.x
== 0)
20732 it
->pixel_width
+= eabs (face
->box_line_width
);
20733 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
20734 it
->pixel_width
+= eabs (face
->box_line_width
);
20737 take_vertical_position_into_account (it
);
20739 /* Automatically crop wide image glyphs at right edge so we can
20740 draw the cursor on same display row. */
20741 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
20742 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
20744 it
->pixel_width
-= crop
;
20745 slice
.width
-= crop
;
20750 struct glyph
*glyph
;
20751 enum glyph_row_area area
= it
->area
;
20753 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20754 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20756 glyph
->charpos
= CHARPOS (it
->position
);
20757 glyph
->object
= it
->object
;
20758 glyph
->pixel_width
= it
->pixel_width
;
20759 glyph
->ascent
= glyph_ascent
;
20760 glyph
->descent
= it
->descent
;
20761 glyph
->voffset
= it
->voffset
;
20762 glyph
->type
= IMAGE_GLYPH
;
20763 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
20764 glyph
->multibyte_p
= it
->multibyte_p
;
20765 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20766 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20767 glyph
->overlaps_vertically_p
= 0;
20768 glyph
->padding_p
= 0;
20769 glyph
->glyph_not_available_p
= 0;
20770 glyph
->face_id
= it
->face_id
;
20771 glyph
->u
.img_id
= img
->id
;
20772 glyph
->slice
= slice
;
20773 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20774 ++it
->glyph_row
->used
[area
];
20777 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20782 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
20783 of the glyph, WIDTH and HEIGHT are the width and height of the
20784 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
20787 append_stretch_glyph (it
, object
, width
, height
, ascent
)
20789 Lisp_Object object
;
20793 struct glyph
*glyph
;
20794 enum glyph_row_area area
= it
->area
;
20796 xassert (ascent
>= 0 && ascent
<= height
);
20798 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20799 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20801 glyph
->charpos
= CHARPOS (it
->position
);
20802 glyph
->object
= object
;
20803 glyph
->pixel_width
= width
;
20804 glyph
->ascent
= ascent
;
20805 glyph
->descent
= height
- ascent
;
20806 glyph
->voffset
= it
->voffset
;
20807 glyph
->type
= STRETCH_GLYPH
;
20808 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
20809 glyph
->multibyte_p
= it
->multibyte_p
;
20810 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20811 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20812 glyph
->overlaps_vertically_p
= 0;
20813 glyph
->padding_p
= 0;
20814 glyph
->glyph_not_available_p
= 0;
20815 glyph
->face_id
= it
->face_id
;
20816 glyph
->u
.stretch
.ascent
= ascent
;
20817 glyph
->u
.stretch
.height
= height
;
20818 glyph
->slice
= null_glyph_slice
;
20819 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20820 ++it
->glyph_row
->used
[area
];
20823 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20827 /* Produce a stretch glyph for iterator IT. IT->object is the value
20828 of the glyph property displayed. The value must be a list
20829 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
20832 1. `:width WIDTH' specifies that the space should be WIDTH *
20833 canonical char width wide. WIDTH may be an integer or floating
20836 2. `:relative-width FACTOR' specifies that the width of the stretch
20837 should be computed from the width of the first character having the
20838 `glyph' property, and should be FACTOR times that width.
20840 3. `:align-to HPOS' specifies that the space should be wide enough
20841 to reach HPOS, a value in canonical character units.
20843 Exactly one of the above pairs must be present.
20845 4. `:height HEIGHT' specifies that the height of the stretch produced
20846 should be HEIGHT, measured in canonical character units.
20848 5. `:relative-height FACTOR' specifies that the height of the
20849 stretch should be FACTOR times the height of the characters having
20850 the glyph property.
20852 Either none or exactly one of 4 or 5 must be present.
20854 6. `:ascent ASCENT' specifies that ASCENT percent of the height
20855 of the stretch should be used for the ascent of the stretch.
20856 ASCENT must be in the range 0 <= ASCENT <= 100. */
20859 produce_stretch_glyph (it
)
20862 /* (space :width WIDTH :height HEIGHT ...) */
20863 Lisp_Object prop
, plist
;
20864 int width
= 0, height
= 0, align_to
= -1;
20865 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
20868 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20869 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
20871 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
20873 /* List should start with `space'. */
20874 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
20875 plist
= XCDR (it
->object
);
20877 /* Compute the width of the stretch. */
20878 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
20879 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
20881 /* Absolute width `:width WIDTH' specified and valid. */
20882 zero_width_ok_p
= 1;
20885 else if (prop
= Fplist_get (plist
, QCrelative_width
),
20888 /* Relative width `:relative-width FACTOR' specified and valid.
20889 Compute the width of the characters having the `glyph'
20892 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
20895 if (it
->multibyte_p
)
20897 int maxlen
= ((IT_BYTEPOS (*it
) >= GPT
? ZV
: GPT
)
20898 - IT_BYTEPOS (*it
));
20899 it2
.c
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
20902 it2
.c
= *p
, it2
.len
= 1;
20904 it2
.glyph_row
= NULL
;
20905 it2
.what
= IT_CHARACTER
;
20906 x_produce_glyphs (&it2
);
20907 width
= NUMVAL (prop
) * it2
.pixel_width
;
20909 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
20910 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
20912 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
20913 align_to
= (align_to
< 0
20915 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
20916 else if (align_to
< 0)
20917 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
20918 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
20919 zero_width_ok_p
= 1;
20922 /* Nothing specified -> width defaults to canonical char width. */
20923 width
= FRAME_COLUMN_WIDTH (it
->f
);
20925 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
20928 /* Compute height. */
20929 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
20930 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
20933 zero_height_ok_p
= 1;
20935 else if (prop
= Fplist_get (plist
, QCrelative_height
),
20937 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
20939 height
= FONT_HEIGHT (font
);
20941 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
20944 /* Compute percentage of height used for ascent. If
20945 `:ascent ASCENT' is present and valid, use that. Otherwise,
20946 derive the ascent from the font in use. */
20947 if (prop
= Fplist_get (plist
, QCascent
),
20948 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
20949 ascent
= height
* NUMVAL (prop
) / 100.0;
20950 else if (!NILP (prop
)
20951 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
20952 ascent
= min (max (0, (int)tem
), height
);
20954 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
20956 if (width
> 0 && it
->line_wrap
!= TRUNCATE
20957 && it
->current_x
+ width
> it
->last_visible_x
)
20958 width
= it
->last_visible_x
- it
->current_x
- 1;
20960 if (width
> 0 && height
> 0 && it
->glyph_row
)
20962 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
20963 if (!STRINGP (object
))
20964 object
= it
->w
->buffer
;
20965 append_stretch_glyph (it
, object
, width
, height
, ascent
);
20968 it
->pixel_width
= width
;
20969 it
->ascent
= it
->phys_ascent
= ascent
;
20970 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
20971 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
20973 take_vertical_position_into_account (it
);
20976 /* Calculate line-height and line-spacing properties.
20977 An integer value specifies explicit pixel value.
20978 A float value specifies relative value to current face height.
20979 A cons (float . face-name) specifies relative value to
20980 height of specified face font.
20982 Returns height in pixels, or nil. */
20986 calc_line_height_property (it
, val
, font
, boff
, override
)
20990 int boff
, override
;
20992 Lisp_Object face_name
= Qnil
;
20993 int ascent
, descent
, height
;
20995 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
21000 face_name
= XCAR (val
);
21002 if (!NUMBERP (val
))
21003 val
= make_number (1);
21004 if (NILP (face_name
))
21006 height
= it
->ascent
+ it
->descent
;
21011 if (NILP (face_name
))
21013 font
= FRAME_FONT (it
->f
);
21014 boff
= FRAME_BASELINE_OFFSET (it
->f
);
21016 else if (EQ (face_name
, Qt
))
21025 face_id
= lookup_named_face (it
->f
, face_name
, 0);
21027 return make_number (-1);
21029 face
= FACE_FROM_ID (it
->f
, face_id
);
21032 return make_number (-1);
21033 boff
= font
->baseline_offset
;
21034 if (font
->vertical_centering
)
21035 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
21038 ascent
= FONT_BASE (font
) + boff
;
21039 descent
= FONT_DESCENT (font
) - boff
;
21043 it
->override_ascent
= ascent
;
21044 it
->override_descent
= descent
;
21045 it
->override_boff
= boff
;
21048 height
= ascent
+ descent
;
21052 height
= (int)(XFLOAT_DATA (val
) * height
);
21053 else if (INTEGERP (val
))
21054 height
*= XINT (val
);
21056 return make_number (height
);
21061 Produce glyphs/get display metrics for the display element IT is
21062 loaded with. See the description of struct it in dispextern.h
21063 for an overview of struct it. */
21066 x_produce_glyphs (it
)
21069 int extra_line_spacing
= it
->extra_line_spacing
;
21071 it
->glyph_not_available_p
= 0;
21073 if (it
->what
== IT_CHARACTER
)
21077 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21078 struct font_metrics
*pcm
;
21079 int font_not_found_p
;
21080 int boff
; /* baseline offset */
21081 /* We may change it->multibyte_p upon unibyte<->multibyte
21082 conversion. So, save the current value now and restore it
21085 Note: It seems that we don't have to record multibyte_p in
21086 struct glyph because the character code itself tells whether
21087 or not the character is multibyte. Thus, in the future, we
21088 must consider eliminating the field `multibyte_p' in the
21090 int saved_multibyte_p
= it
->multibyte_p
;
21092 /* Maybe translate single-byte characters to multibyte, or the
21094 it
->char_to_display
= it
->c
;
21095 if (!ASCII_BYTE_P (it
->c
)
21096 && ! it
->multibyte_p
)
21098 if (SINGLE_BYTE_CHAR_P (it
->c
)
21099 && unibyte_display_via_language_environment
)
21101 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
21103 /* get_next_display_element assures that this decoding
21105 it
->char_to_display
= DECODE_CHAR (unibyte
, it
->c
);
21106 it
->multibyte_p
= 1;
21107 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
,
21109 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21113 /* Get font to use. Encode IT->char_to_display. */
21114 get_char_face_and_encoding (it
->f
, it
->char_to_display
, it
->face_id
,
21115 &char2b
, it
->multibyte_p
, 0);
21118 font_not_found_p
= font
== NULL
;
21119 if (font_not_found_p
)
21121 /* When no suitable font found, display an empty box based
21122 on the metrics of the font of the default face (or what
21124 struct face
*no_font_face
21125 = FACE_FROM_ID (it
->f
,
21126 NILP (Vface_remapping_alist
) ? DEFAULT_FACE_ID
21127 : lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
21128 font
= no_font_face
->font
;
21129 boff
= font
->baseline_offset
;
21133 boff
= font
->baseline_offset
;
21134 if (font
->vertical_centering
)
21135 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
21138 if (it
->char_to_display
>= ' '
21139 && (!it
->multibyte_p
|| it
->char_to_display
< 128))
21141 /* Either unibyte or ASCII. */
21146 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
21148 if (it
->override_ascent
>= 0)
21150 it
->ascent
= it
->override_ascent
;
21151 it
->descent
= it
->override_descent
;
21152 boff
= it
->override_boff
;
21156 it
->ascent
= FONT_BASE (font
) + boff
;
21157 it
->descent
= FONT_DESCENT (font
) - boff
;
21162 it
->phys_ascent
= pcm
->ascent
+ boff
;
21163 it
->phys_descent
= pcm
->descent
- boff
;
21164 it
->pixel_width
= pcm
->width
;
21168 it
->glyph_not_available_p
= 1;
21169 it
->phys_ascent
= it
->ascent
;
21170 it
->phys_descent
= it
->descent
;
21171 it
->pixel_width
= FONT_WIDTH (font
);
21174 if (it
->constrain_row_ascent_descent_p
)
21176 if (it
->descent
> it
->max_descent
)
21178 it
->ascent
+= it
->descent
- it
->max_descent
;
21179 it
->descent
= it
->max_descent
;
21181 if (it
->ascent
> it
->max_ascent
)
21183 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
21184 it
->ascent
= it
->max_ascent
;
21186 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
21187 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
21188 extra_line_spacing
= 0;
21191 /* If this is a space inside a region of text with
21192 `space-width' property, change its width. */
21193 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
21195 it
->pixel_width
*= XFLOATINT (it
->space_width
);
21197 /* If face has a box, add the box thickness to the character
21198 height. If character has a box line to the left and/or
21199 right, add the box line width to the character's width. */
21200 if (face
->box
!= FACE_NO_BOX
)
21202 int thick
= face
->box_line_width
;
21206 it
->ascent
+= thick
;
21207 it
->descent
+= thick
;
21212 if (it
->start_of_box_run_p
)
21213 it
->pixel_width
+= thick
;
21214 if (it
->end_of_box_run_p
)
21215 it
->pixel_width
+= thick
;
21218 /* If face has an overline, add the height of the overline
21219 (1 pixel) and a 1 pixel margin to the character height. */
21220 if (face
->overline_p
)
21221 it
->ascent
+= overline_margin
;
21223 if (it
->constrain_row_ascent_descent_p
)
21225 if (it
->ascent
> it
->max_ascent
)
21226 it
->ascent
= it
->max_ascent
;
21227 if (it
->descent
> it
->max_descent
)
21228 it
->descent
= it
->max_descent
;
21231 take_vertical_position_into_account (it
);
21233 /* If we have to actually produce glyphs, do it. */
21238 /* Translate a space with a `space-width' property
21239 into a stretch glyph. */
21240 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
21241 / FONT_HEIGHT (font
));
21242 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
21243 it
->ascent
+ it
->descent
, ascent
);
21248 /* If characters with lbearing or rbearing are displayed
21249 in this line, record that fact in a flag of the
21250 glyph row. This is used to optimize X output code. */
21251 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
21252 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
21254 if (! stretched_p
&& it
->pixel_width
== 0)
21255 /* We assure that all visible glyphs have at least 1-pixel
21257 it
->pixel_width
= 1;
21259 else if (it
->char_to_display
== '\n')
21261 /* A newline has no width, but we need the height of the
21262 line. But if previous part of the line sets a height,
21263 don't increase that height */
21265 Lisp_Object height
;
21266 Lisp_Object total_height
= Qnil
;
21268 it
->override_ascent
= -1;
21269 it
->pixel_width
= 0;
21272 height
= get_it_property(it
, Qline_height
);
21273 /* Split (line-height total-height) list */
21275 && CONSP (XCDR (height
))
21276 && NILP (XCDR (XCDR (height
))))
21278 total_height
= XCAR (XCDR (height
));
21279 height
= XCAR (height
);
21281 height
= calc_line_height_property(it
, height
, font
, boff
, 1);
21283 if (it
->override_ascent
>= 0)
21285 it
->ascent
= it
->override_ascent
;
21286 it
->descent
= it
->override_descent
;
21287 boff
= it
->override_boff
;
21291 it
->ascent
= FONT_BASE (font
) + boff
;
21292 it
->descent
= FONT_DESCENT (font
) - boff
;
21295 if (EQ (height
, Qt
))
21297 if (it
->descent
> it
->max_descent
)
21299 it
->ascent
+= it
->descent
- it
->max_descent
;
21300 it
->descent
= it
->max_descent
;
21302 if (it
->ascent
> it
->max_ascent
)
21304 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
21305 it
->ascent
= it
->max_ascent
;
21307 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
21308 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
21309 it
->constrain_row_ascent_descent_p
= 1;
21310 extra_line_spacing
= 0;
21314 Lisp_Object spacing
;
21316 it
->phys_ascent
= it
->ascent
;
21317 it
->phys_descent
= it
->descent
;
21319 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
21320 && face
->box
!= FACE_NO_BOX
21321 && face
->box_line_width
> 0)
21323 it
->ascent
+= face
->box_line_width
;
21324 it
->descent
+= face
->box_line_width
;
21327 && XINT (height
) > it
->ascent
+ it
->descent
)
21328 it
->ascent
= XINT (height
) - it
->descent
;
21330 if (!NILP (total_height
))
21331 spacing
= calc_line_height_property(it
, total_height
, font
, boff
, 0);
21334 spacing
= get_it_property(it
, Qline_spacing
);
21335 spacing
= calc_line_height_property(it
, spacing
, font
, boff
, 0);
21337 if (INTEGERP (spacing
))
21339 extra_line_spacing
= XINT (spacing
);
21340 if (!NILP (total_height
))
21341 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
21345 else if (it
->char_to_display
== '\t')
21347 if (font
->space_width
> 0)
21349 int tab_width
= it
->tab_width
* font
->space_width
;
21350 int x
= it
->current_x
+ it
->continuation_lines_width
;
21351 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
21353 /* If the distance from the current position to the next tab
21354 stop is less than a space character width, use the
21355 tab stop after that. */
21356 if (next_tab_x
- x
< font
->space_width
)
21357 next_tab_x
+= tab_width
;
21359 it
->pixel_width
= next_tab_x
- x
;
21361 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
21362 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
21366 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
21367 it
->ascent
+ it
->descent
, it
->ascent
);
21372 it
->pixel_width
= 0;
21378 /* A multi-byte character. Assume that the display width of the
21379 character is the width of the character multiplied by the
21380 width of the font. */
21382 /* If we found a font, this font should give us the right
21383 metrics. If we didn't find a font, use the frame's
21384 default font and calculate the width of the character by
21385 multiplying the width of font by the width of the
21388 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
21390 if (font_not_found_p
|| !pcm
)
21392 int char_width
= CHAR_WIDTH (it
->char_to_display
);
21394 if (char_width
== 0)
21395 /* This is a non spacing character. But, as we are
21396 going to display an empty box, the box must occupy
21397 at least one column. */
21399 it
->glyph_not_available_p
= 1;
21400 it
->pixel_width
= font
->space_width
* char_width
;
21401 it
->phys_ascent
= FONT_BASE (font
) + boff
;
21402 it
->phys_descent
= FONT_DESCENT (font
) - boff
;
21406 it
->pixel_width
= pcm
->width
;
21407 it
->phys_ascent
= pcm
->ascent
+ boff
;
21408 it
->phys_descent
= pcm
->descent
- boff
;
21410 && (pcm
->lbearing
< 0
21411 || pcm
->rbearing
> pcm
->width
))
21412 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
21415 it
->ascent
= FONT_BASE (font
) + boff
;
21416 it
->descent
= FONT_DESCENT (font
) - boff
;
21417 if (face
->box
!= FACE_NO_BOX
)
21419 int thick
= face
->box_line_width
;
21423 it
->ascent
+= thick
;
21424 it
->descent
+= thick
;
21429 if (it
->start_of_box_run_p
)
21430 it
->pixel_width
+= thick
;
21431 if (it
->end_of_box_run_p
)
21432 it
->pixel_width
+= thick
;
21435 /* If face has an overline, add the height of the overline
21436 (1 pixel) and a 1 pixel margin to the character height. */
21437 if (face
->overline_p
)
21438 it
->ascent
+= overline_margin
;
21440 take_vertical_position_into_account (it
);
21442 if (it
->ascent
< 0)
21444 if (it
->descent
< 0)
21449 if (it
->pixel_width
== 0)
21450 /* We assure that all visible glyphs have at least 1-pixel
21452 it
->pixel_width
= 1;
21454 it
->multibyte_p
= saved_multibyte_p
;
21456 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
21458 /* A static composition.
21460 Note: A composition is represented as one glyph in the
21461 glyph matrix. There are no padding glyphs.
21463 Important note: pixel_width, ascent, and descent are the
21464 values of what is drawn by draw_glyphs (i.e. the values of
21465 the overall glyphs composed). */
21466 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21467 int boff
; /* baseline offset */
21468 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
21469 int glyph_len
= cmp
->glyph_len
;
21470 struct font
*font
= face
->font
;
21474 /* If we have not yet calculated pixel size data of glyphs of
21475 the composition for the current face font, calculate them
21476 now. Theoretically, we have to check all fonts for the
21477 glyphs, but that requires much time and memory space. So,
21478 here we check only the font of the first glyph. This may
21479 lead to incorrect display, but it's very rare, and C-l
21480 (recenter-top-bottom) can correct the display anyway. */
21481 if (! cmp
->font
|| cmp
->font
!= font
)
21483 /* Ascent and descent of the font of the first character
21484 of this composition (adjusted by baseline offset).
21485 Ascent and descent of overall glyphs should not be less
21486 than these, respectively. */
21487 int font_ascent
, font_descent
, font_height
;
21488 /* Bounding box of the overall glyphs. */
21489 int leftmost
, rightmost
, lowest
, highest
;
21490 int lbearing
, rbearing
;
21491 int i
, width
, ascent
, descent
;
21492 int left_padded
= 0, right_padded
= 0;
21495 struct font_metrics
*pcm
;
21496 int font_not_found_p
;
21499 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
21500 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
21502 if (glyph_len
< cmp
->glyph_len
)
21504 for (i
= 0; i
< glyph_len
; i
++)
21506 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
21508 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
21513 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
21514 : IT_CHARPOS (*it
));
21515 /* If no suitable font is found, use the default font. */
21516 font_not_found_p
= font
== NULL
;
21517 if (font_not_found_p
)
21519 face
= face
->ascii_face
;
21522 boff
= font
->baseline_offset
;
21523 if (font
->vertical_centering
)
21524 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
21525 font_ascent
= FONT_BASE (font
) + boff
;
21526 font_descent
= FONT_DESCENT (font
) - boff
;
21527 font_height
= FONT_HEIGHT (font
);
21529 cmp
->font
= (void *) font
;
21532 if (! font_not_found_p
)
21534 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
21535 &char2b
, it
->multibyte_p
, 0);
21536 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
21539 /* Initialize the bounding box. */
21542 width
= pcm
->width
;
21543 ascent
= pcm
->ascent
;
21544 descent
= pcm
->descent
;
21545 lbearing
= pcm
->lbearing
;
21546 rbearing
= pcm
->rbearing
;
21550 width
= FONT_WIDTH (font
);
21551 ascent
= FONT_BASE (font
);
21552 descent
= FONT_DESCENT (font
);
21559 lowest
= - descent
+ boff
;
21560 highest
= ascent
+ boff
;
21562 if (! font_not_found_p
21563 && font
->default_ascent
21564 && CHAR_TABLE_P (Vuse_default_ascent
)
21565 && !NILP (Faref (Vuse_default_ascent
,
21566 make_number (it
->char_to_display
))))
21567 highest
= font
->default_ascent
+ boff
;
21569 /* Draw the first glyph at the normal position. It may be
21570 shifted to right later if some other glyphs are drawn
21572 cmp
->offsets
[i
* 2] = 0;
21573 cmp
->offsets
[i
* 2 + 1] = boff
;
21574 cmp
->lbearing
= lbearing
;
21575 cmp
->rbearing
= rbearing
;
21577 /* Set cmp->offsets for the remaining glyphs. */
21578 for (i
++; i
< glyph_len
; i
++)
21580 int left
, right
, btm
, top
;
21581 int ch
= COMPOSITION_GLYPH (cmp
, i
);
21583 struct face
*this_face
;
21588 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
21589 this_face
= FACE_FROM_ID (it
->f
, face_id
);
21590 font
= this_face
->font
;
21596 this_boff
= font
->baseline_offset
;
21597 if (font
->vertical_centering
)
21598 this_boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
21599 get_char_face_and_encoding (it
->f
, ch
, face_id
,
21600 &char2b
, it
->multibyte_p
, 0);
21601 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
21604 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
21607 width
= pcm
->width
;
21608 ascent
= pcm
->ascent
;
21609 descent
= pcm
->descent
;
21610 lbearing
= pcm
->lbearing
;
21611 rbearing
= pcm
->rbearing
;
21612 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
21614 /* Relative composition with or without
21615 alternate chars. */
21616 left
= (leftmost
+ rightmost
- width
) / 2;
21617 btm
= - descent
+ boff
;
21618 if (font
->relative_compose
21619 && (! CHAR_TABLE_P (Vignore_relative_composition
)
21620 || NILP (Faref (Vignore_relative_composition
,
21621 make_number (ch
)))))
21624 if (- descent
>= font
->relative_compose
)
21625 /* One extra pixel between two glyphs. */
21627 else if (ascent
<= 0)
21628 /* One extra pixel between two glyphs. */
21629 btm
= lowest
- 1 - ascent
- descent
;
21634 /* A composition rule is specified by an integer
21635 value that encodes global and new reference
21636 points (GREF and NREF). GREF and NREF are
21637 specified by numbers as below:
21639 0---1---2 -- ascent
21643 9--10--11 -- center
21645 ---3---4---5--- baseline
21647 6---7---8 -- descent
21649 int rule
= COMPOSITION_RULE (cmp
, i
);
21650 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
21652 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
21653 grefx
= gref
% 3, nrefx
= nref
% 3;
21654 grefy
= gref
/ 3, nrefy
= nref
/ 3;
21656 xoff
= font_height
* (xoff
- 128) / 256;
21658 yoff
= font_height
* (yoff
- 128) / 256;
21661 + grefx
* (rightmost
- leftmost
) / 2
21662 - nrefx
* width
/ 2
21665 btm
= ((grefy
== 0 ? highest
21667 : grefy
== 2 ? lowest
21668 : (highest
+ lowest
) / 2)
21669 - (nrefy
== 0 ? ascent
+ descent
21670 : nrefy
== 1 ? descent
- boff
21672 : (ascent
+ descent
) / 2)
21676 cmp
->offsets
[i
* 2] = left
;
21677 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
21679 /* Update the bounding box of the overall glyphs. */
21682 right
= left
+ width
;
21683 if (left
< leftmost
)
21685 if (right
> rightmost
)
21688 top
= btm
+ descent
+ ascent
;
21694 if (cmp
->lbearing
> left
+ lbearing
)
21695 cmp
->lbearing
= left
+ lbearing
;
21696 if (cmp
->rbearing
< left
+ rbearing
)
21697 cmp
->rbearing
= left
+ rbearing
;
21701 /* If there are glyphs whose x-offsets are negative,
21702 shift all glyphs to the right and make all x-offsets
21706 for (i
= 0; i
< cmp
->glyph_len
; i
++)
21707 cmp
->offsets
[i
* 2] -= leftmost
;
21708 rightmost
-= leftmost
;
21709 cmp
->lbearing
-= leftmost
;
21710 cmp
->rbearing
-= leftmost
;
21713 if (left_padded
&& cmp
->lbearing
< 0)
21715 for (i
= 0; i
< cmp
->glyph_len
; i
++)
21716 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
21717 rightmost
-= cmp
->lbearing
;
21718 cmp
->rbearing
-= cmp
->lbearing
;
21721 if (right_padded
&& rightmost
< cmp
->rbearing
)
21723 rightmost
= cmp
->rbearing
;
21726 cmp
->pixel_width
= rightmost
;
21727 cmp
->ascent
= highest
;
21728 cmp
->descent
= - lowest
;
21729 if (cmp
->ascent
< font_ascent
)
21730 cmp
->ascent
= font_ascent
;
21731 if (cmp
->descent
< font_descent
)
21732 cmp
->descent
= font_descent
;
21736 && (cmp
->lbearing
< 0
21737 || cmp
->rbearing
> cmp
->pixel_width
))
21738 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
21740 it
->pixel_width
= cmp
->pixel_width
;
21741 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
21742 it
->descent
= it
->phys_descent
= cmp
->descent
;
21743 if (face
->box
!= FACE_NO_BOX
)
21745 int thick
= face
->box_line_width
;
21749 it
->ascent
+= thick
;
21750 it
->descent
+= thick
;
21755 if (it
->start_of_box_run_p
)
21756 it
->pixel_width
+= thick
;
21757 if (it
->end_of_box_run_p
)
21758 it
->pixel_width
+= thick
;
21761 /* If face has an overline, add the height of the overline
21762 (1 pixel) and a 1 pixel margin to the character height. */
21763 if (face
->overline_p
)
21764 it
->ascent
+= overline_margin
;
21766 take_vertical_position_into_account (it
);
21767 if (it
->ascent
< 0)
21769 if (it
->descent
< 0)
21773 append_composite_glyph (it
);
21775 else if (it
->what
== IT_COMPOSITION
)
21777 /* A dynamic (automatic) composition. */
21778 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21779 Lisp_Object gstring
;
21780 struct font_metrics metrics
;
21782 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
21784 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
21787 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
21788 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
21789 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
21790 it
->descent
= it
->phys_descent
= metrics
.descent
;
21791 if (face
->box
!= FACE_NO_BOX
)
21793 int thick
= face
->box_line_width
;
21797 it
->ascent
+= thick
;
21798 it
->descent
+= thick
;
21803 if (it
->start_of_box_run_p
)
21804 it
->pixel_width
+= thick
;
21805 if (it
->end_of_box_run_p
)
21806 it
->pixel_width
+= thick
;
21808 /* If face has an overline, add the height of the overline
21809 (1 pixel) and a 1 pixel margin to the character height. */
21810 if (face
->overline_p
)
21811 it
->ascent
+= overline_margin
;
21812 take_vertical_position_into_account (it
);
21813 if (it
->ascent
< 0)
21815 if (it
->descent
< 0)
21819 append_composite_glyph (it
);
21821 else if (it
->what
== IT_IMAGE
)
21822 produce_image_glyph (it
);
21823 else if (it
->what
== IT_STRETCH
)
21824 produce_stretch_glyph (it
);
21826 /* Accumulate dimensions. Note: can't assume that it->descent > 0
21827 because this isn't true for images with `:ascent 100'. */
21828 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
21829 if (it
->area
== TEXT_AREA
)
21830 it
->current_x
+= it
->pixel_width
;
21832 if (extra_line_spacing
> 0)
21834 it
->descent
+= extra_line_spacing
;
21835 if (extra_line_spacing
> it
->max_extra_line_spacing
)
21836 it
->max_extra_line_spacing
= extra_line_spacing
;
21839 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
21840 it
->max_descent
= max (it
->max_descent
, it
->descent
);
21841 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
21842 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
21846 Output LEN glyphs starting at START at the nominal cursor position.
21847 Advance the nominal cursor over the text. The global variable
21848 updated_window contains the window being updated, updated_row is
21849 the glyph row being updated, and updated_area is the area of that
21850 row being updated. */
21853 x_write_glyphs (start
, len
)
21854 struct glyph
*start
;
21859 xassert (updated_window
&& updated_row
);
21862 /* Write glyphs. */
21864 hpos
= start
- updated_row
->glyphs
[updated_area
];
21865 x
= draw_glyphs (updated_window
, output_cursor
.x
,
21866 updated_row
, updated_area
,
21868 DRAW_NORMAL_TEXT
, 0);
21870 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
21871 if (updated_area
== TEXT_AREA
21872 && updated_window
->phys_cursor_on_p
21873 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
21874 && updated_window
->phys_cursor
.hpos
>= hpos
21875 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
21876 updated_window
->phys_cursor_on_p
= 0;
21880 /* Advance the output cursor. */
21881 output_cursor
.hpos
+= len
;
21882 output_cursor
.x
= x
;
21887 Insert LEN glyphs from START at the nominal cursor position. */
21890 x_insert_glyphs (start
, len
)
21891 struct glyph
*start
;
21896 int line_height
, shift_by_width
, shifted_region_width
;
21897 struct glyph_row
*row
;
21898 struct glyph
*glyph
;
21899 int frame_x
, frame_y
;
21902 xassert (updated_window
&& updated_row
);
21904 w
= updated_window
;
21905 f
= XFRAME (WINDOW_FRAME (w
));
21907 /* Get the height of the line we are in. */
21909 line_height
= row
->height
;
21911 /* Get the width of the glyphs to insert. */
21912 shift_by_width
= 0;
21913 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
21914 shift_by_width
+= glyph
->pixel_width
;
21916 /* Get the width of the region to shift right. */
21917 shifted_region_width
= (window_box_width (w
, updated_area
)
21922 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
21923 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
21925 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
21926 line_height
, shift_by_width
);
21928 /* Write the glyphs. */
21929 hpos
= start
- row
->glyphs
[updated_area
];
21930 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
21932 DRAW_NORMAL_TEXT
, 0);
21934 /* Advance the output cursor. */
21935 output_cursor
.hpos
+= len
;
21936 output_cursor
.x
+= shift_by_width
;
21942 Erase the current text line from the nominal cursor position
21943 (inclusive) to pixel column TO_X (exclusive). The idea is that
21944 everything from TO_X onward is already erased.
21946 TO_X is a pixel position relative to updated_area of
21947 updated_window. TO_X == -1 means clear to the end of this area. */
21950 x_clear_end_of_line (to_x
)
21954 struct window
*w
= updated_window
;
21955 int max_x
, min_y
, max_y
;
21956 int from_x
, from_y
, to_y
;
21958 xassert (updated_window
&& updated_row
);
21959 f
= XFRAME (w
->frame
);
21961 if (updated_row
->full_width_p
)
21962 max_x
= WINDOW_TOTAL_WIDTH (w
);
21964 max_x
= window_box_width (w
, updated_area
);
21965 max_y
= window_text_bottom_y (w
);
21967 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
21968 of window. For TO_X > 0, truncate to end of drawing area. */
21974 to_x
= min (to_x
, max_x
);
21976 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
21978 /* Notice if the cursor will be cleared by this operation. */
21979 if (!updated_row
->full_width_p
)
21980 notice_overwritten_cursor (w
, updated_area
,
21981 output_cursor
.x
, -1,
21983 MATRIX_ROW_BOTTOM_Y (updated_row
));
21985 from_x
= output_cursor
.x
;
21987 /* Translate to frame coordinates. */
21988 if (updated_row
->full_width_p
)
21990 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
21991 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
21995 int area_left
= window_box_left (w
, updated_area
);
21996 from_x
+= area_left
;
22000 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
22001 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
22002 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
22004 /* Prevent inadvertently clearing to end of the X window. */
22005 if (to_x
> from_x
&& to_y
> from_y
)
22008 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
22009 to_x
- from_x
, to_y
- from_y
);
22014 #endif /* HAVE_WINDOW_SYSTEM */
22018 /***********************************************************************
22020 ***********************************************************************/
22022 /* Value is the internal representation of the specified cursor type
22023 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
22024 of the bar cursor. */
22026 static enum text_cursor_kinds
22027 get_specified_cursor_type (arg
, width
)
22031 enum text_cursor_kinds type
;
22036 if (EQ (arg
, Qbox
))
22037 return FILLED_BOX_CURSOR
;
22039 if (EQ (arg
, Qhollow
))
22040 return HOLLOW_BOX_CURSOR
;
22042 if (EQ (arg
, Qbar
))
22049 && EQ (XCAR (arg
), Qbar
)
22050 && INTEGERP (XCDR (arg
))
22051 && XINT (XCDR (arg
)) >= 0)
22053 *width
= XINT (XCDR (arg
));
22057 if (EQ (arg
, Qhbar
))
22060 return HBAR_CURSOR
;
22064 && EQ (XCAR (arg
), Qhbar
)
22065 && INTEGERP (XCDR (arg
))
22066 && XINT (XCDR (arg
)) >= 0)
22068 *width
= XINT (XCDR (arg
));
22069 return HBAR_CURSOR
;
22072 /* Treat anything unknown as "hollow box cursor".
22073 It was bad to signal an error; people have trouble fixing
22074 .Xdefaults with Emacs, when it has something bad in it. */
22075 type
= HOLLOW_BOX_CURSOR
;
22080 /* Set the default cursor types for specified frame. */
22082 set_frame_cursor_types (f
, arg
)
22089 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
22090 FRAME_CURSOR_WIDTH (f
) = width
;
22092 /* By default, set up the blink-off state depending on the on-state. */
22094 tem
= Fassoc (arg
, Vblink_cursor_alist
);
22097 FRAME_BLINK_OFF_CURSOR (f
)
22098 = get_specified_cursor_type (XCDR (tem
), &width
);
22099 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
22102 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
22106 /* Return the cursor we want to be displayed in window W. Return
22107 width of bar/hbar cursor through WIDTH arg. Return with
22108 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
22109 (i.e. if the `system caret' should track this cursor).
22111 In a mini-buffer window, we want the cursor only to appear if we
22112 are reading input from this window. For the selected window, we
22113 want the cursor type given by the frame parameter or buffer local
22114 setting of cursor-type. If explicitly marked off, draw no cursor.
22115 In all other cases, we want a hollow box cursor. */
22117 static enum text_cursor_kinds
22118 get_window_cursor_type (w
, glyph
, width
, active_cursor
)
22120 struct glyph
*glyph
;
22122 int *active_cursor
;
22124 struct frame
*f
= XFRAME (w
->frame
);
22125 struct buffer
*b
= XBUFFER (w
->buffer
);
22126 int cursor_type
= DEFAULT_CURSOR
;
22127 Lisp_Object alt_cursor
;
22128 int non_selected
= 0;
22130 *active_cursor
= 1;
22133 if (cursor_in_echo_area
22134 && FRAME_HAS_MINIBUF_P (f
)
22135 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
22137 if (w
== XWINDOW (echo_area_window
))
22139 if (EQ (b
->cursor_type
, Qt
) || NILP (b
->cursor_type
))
22141 *width
= FRAME_CURSOR_WIDTH (f
);
22142 return FRAME_DESIRED_CURSOR (f
);
22145 return get_specified_cursor_type (b
->cursor_type
, width
);
22148 *active_cursor
= 0;
22152 /* Detect a nonselected window or nonselected frame. */
22153 else if (w
!= XWINDOW (f
->selected_window
)
22154 #ifdef HAVE_WINDOW_SYSTEM
22155 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
22159 *active_cursor
= 0;
22161 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
22167 /* Never display a cursor in a window in which cursor-type is nil. */
22168 if (NILP (b
->cursor_type
))
22171 /* Get the normal cursor type for this window. */
22172 if (EQ (b
->cursor_type
, Qt
))
22174 cursor_type
= FRAME_DESIRED_CURSOR (f
);
22175 *width
= FRAME_CURSOR_WIDTH (f
);
22178 cursor_type
= get_specified_cursor_type (b
->cursor_type
, width
);
22180 /* Use cursor-in-non-selected-windows instead
22181 for non-selected window or frame. */
22184 alt_cursor
= b
->cursor_in_non_selected_windows
;
22185 if (!EQ (Qt
, alt_cursor
))
22186 return get_specified_cursor_type (alt_cursor
, width
);
22187 /* t means modify the normal cursor type. */
22188 if (cursor_type
== FILLED_BOX_CURSOR
)
22189 cursor_type
= HOLLOW_BOX_CURSOR
;
22190 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
22192 return cursor_type
;
22195 /* Use normal cursor if not blinked off. */
22196 if (!w
->cursor_off_p
)
22198 #ifdef HAVE_WINDOW_SYSTEM
22199 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
22201 if (cursor_type
== FILLED_BOX_CURSOR
)
22203 /* Using a block cursor on large images can be very annoying.
22204 So use a hollow cursor for "large" images.
22205 If image is not transparent (no mask), also use hollow cursor. */
22206 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
22207 if (img
!= NULL
&& IMAGEP (img
->spec
))
22209 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
22210 where N = size of default frame font size.
22211 This should cover most of the "tiny" icons people may use. */
22213 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
22214 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
22215 cursor_type
= HOLLOW_BOX_CURSOR
;
22218 else if (cursor_type
!= NO_CURSOR
)
22220 /* Display current only supports BOX and HOLLOW cursors for images.
22221 So for now, unconditionally use a HOLLOW cursor when cursor is
22222 not a solid box cursor. */
22223 cursor_type
= HOLLOW_BOX_CURSOR
;
22227 return cursor_type
;
22230 /* Cursor is blinked off, so determine how to "toggle" it. */
22232 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
22233 if ((alt_cursor
= Fassoc (b
->cursor_type
, Vblink_cursor_alist
), !NILP (alt_cursor
)))
22234 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
22236 /* Then see if frame has specified a specific blink off cursor type. */
22237 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
22239 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
22240 return FRAME_BLINK_OFF_CURSOR (f
);
22244 /* Some people liked having a permanently visible blinking cursor,
22245 while others had very strong opinions against it. So it was
22246 decided to remove it. KFS 2003-09-03 */
22248 /* Finally perform built-in cursor blinking:
22249 filled box <-> hollow box
22250 wide [h]bar <-> narrow [h]bar
22251 narrow [h]bar <-> no cursor
22252 other type <-> no cursor */
22254 if (cursor_type
== FILLED_BOX_CURSOR
)
22255 return HOLLOW_BOX_CURSOR
;
22257 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
22260 return cursor_type
;
22268 #ifdef HAVE_WINDOW_SYSTEM
22270 /* Notice when the text cursor of window W has been completely
22271 overwritten by a drawing operation that outputs glyphs in AREA
22272 starting at X0 and ending at X1 in the line starting at Y0 and
22273 ending at Y1. X coordinates are area-relative. X1 < 0 means all
22274 the rest of the line after X0 has been written. Y coordinates
22275 are window-relative. */
22278 notice_overwritten_cursor (w
, area
, x0
, x1
, y0
, y1
)
22280 enum glyph_row_area area
;
22281 int x0
, y0
, x1
, y1
;
22283 int cx0
, cx1
, cy0
, cy1
;
22284 struct glyph_row
*row
;
22286 if (!w
->phys_cursor_on_p
)
22288 if (area
!= TEXT_AREA
)
22291 if (w
->phys_cursor
.vpos
< 0
22292 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
22293 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
22294 !(row
->enabled_p
&& row
->displays_text_p
)))
22297 if (row
->cursor_in_fringe_p
)
22299 row
->cursor_in_fringe_p
= 0;
22300 draw_fringe_bitmap (w
, row
, 0);
22301 w
->phys_cursor_on_p
= 0;
22305 cx0
= w
->phys_cursor
.x
;
22306 cx1
= cx0
+ w
->phys_cursor_width
;
22307 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
22310 /* The cursor image will be completely removed from the
22311 screen if the output area intersects the cursor area in
22312 y-direction. When we draw in [y0 y1[, and some part of
22313 the cursor is at y < y0, that part must have been drawn
22314 before. When scrolling, the cursor is erased before
22315 actually scrolling, so we don't come here. When not
22316 scrolling, the rows above the old cursor row must have
22317 changed, and in this case these rows must have written
22318 over the cursor image.
22320 Likewise if part of the cursor is below y1, with the
22321 exception of the cursor being in the first blank row at
22322 the buffer and window end because update_text_area
22323 doesn't draw that row. (Except when it does, but
22324 that's handled in update_text_area.) */
22326 cy0
= w
->phys_cursor
.y
;
22327 cy1
= cy0
+ w
->phys_cursor_height
;
22328 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
22331 w
->phys_cursor_on_p
= 0;
22334 #endif /* HAVE_WINDOW_SYSTEM */
22337 /************************************************************************
22339 ************************************************************************/
22341 #ifdef HAVE_WINDOW_SYSTEM
22344 Fix the display of area AREA of overlapping row ROW in window W
22345 with respect to the overlapping part OVERLAPS. */
22348 x_fix_overlapping_area (w
, row
, area
, overlaps
)
22350 struct glyph_row
*row
;
22351 enum glyph_row_area area
;
22359 for (i
= 0; i
< row
->used
[area
];)
22361 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
22363 int start
= i
, start_x
= x
;
22367 x
+= row
->glyphs
[area
][i
].pixel_width
;
22370 while (i
< row
->used
[area
]
22371 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
22373 draw_glyphs (w
, start_x
, row
, area
,
22375 DRAW_NORMAL_TEXT
, overlaps
);
22379 x
+= row
->glyphs
[area
][i
].pixel_width
;
22389 Draw the cursor glyph of window W in glyph row ROW. See the
22390 comment of draw_glyphs for the meaning of HL. */
22393 draw_phys_cursor_glyph (w
, row
, hl
)
22395 struct glyph_row
*row
;
22396 enum draw_glyphs_face hl
;
22398 /* If cursor hpos is out of bounds, don't draw garbage. This can
22399 happen in mini-buffer windows when switching between echo area
22400 glyphs and mini-buffer. */
22401 if (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])
22403 int on_p
= w
->phys_cursor_on_p
;
22405 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
22406 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
22408 w
->phys_cursor_on_p
= on_p
;
22410 if (hl
== DRAW_CURSOR
)
22411 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
22412 /* When we erase the cursor, and ROW is overlapped by other
22413 rows, make sure that these overlapping parts of other rows
22415 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
22417 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
22419 if (row
> w
->current_matrix
->rows
22420 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
22421 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
22422 OVERLAPS_ERASED_CURSOR
);
22424 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
22425 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
22426 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
22427 OVERLAPS_ERASED_CURSOR
);
22434 Erase the image of a cursor of window W from the screen. */
22437 erase_phys_cursor (w
)
22440 struct frame
*f
= XFRAME (w
->frame
);
22441 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
22442 int hpos
= w
->phys_cursor
.hpos
;
22443 int vpos
= w
->phys_cursor
.vpos
;
22444 int mouse_face_here_p
= 0;
22445 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
22446 struct glyph_row
*cursor_row
;
22447 struct glyph
*cursor_glyph
;
22448 enum draw_glyphs_face hl
;
22450 /* No cursor displayed or row invalidated => nothing to do on the
22452 if (w
->phys_cursor_type
== NO_CURSOR
)
22453 goto mark_cursor_off
;
22455 /* VPOS >= active_glyphs->nrows means that window has been resized.
22456 Don't bother to erase the cursor. */
22457 if (vpos
>= active_glyphs
->nrows
)
22458 goto mark_cursor_off
;
22460 /* If row containing cursor is marked invalid, there is nothing we
22462 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
22463 if (!cursor_row
->enabled_p
)
22464 goto mark_cursor_off
;
22466 /* If line spacing is > 0, old cursor may only be partially visible in
22467 window after split-window. So adjust visible height. */
22468 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
22469 window_text_bottom_y (w
) - cursor_row
->y
);
22471 /* If row is completely invisible, don't attempt to delete a cursor which
22472 isn't there. This can happen if cursor is at top of a window, and
22473 we switch to a buffer with a header line in that window. */
22474 if (cursor_row
->visible_height
<= 0)
22475 goto mark_cursor_off
;
22477 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
22478 if (cursor_row
->cursor_in_fringe_p
)
22480 cursor_row
->cursor_in_fringe_p
= 0;
22481 draw_fringe_bitmap (w
, cursor_row
, 0);
22482 goto mark_cursor_off
;
22485 /* This can happen when the new row is shorter than the old one.
22486 In this case, either draw_glyphs or clear_end_of_line
22487 should have cleared the cursor. Note that we wouldn't be
22488 able to erase the cursor in this case because we don't have a
22489 cursor glyph at hand. */
22490 if (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])
22491 goto mark_cursor_off
;
22493 /* If the cursor is in the mouse face area, redisplay that when
22494 we clear the cursor. */
22495 if (! NILP (dpyinfo
->mouse_face_window
)
22496 && w
== XWINDOW (dpyinfo
->mouse_face_window
)
22497 && (vpos
> dpyinfo
->mouse_face_beg_row
22498 || (vpos
== dpyinfo
->mouse_face_beg_row
22499 && hpos
>= dpyinfo
->mouse_face_beg_col
))
22500 && (vpos
< dpyinfo
->mouse_face_end_row
22501 || (vpos
== dpyinfo
->mouse_face_end_row
22502 && hpos
< dpyinfo
->mouse_face_end_col
))
22503 /* Don't redraw the cursor's spot in mouse face if it is at the
22504 end of a line (on a newline). The cursor appears there, but
22505 mouse highlighting does not. */
22506 && cursor_row
->used
[TEXT_AREA
] > hpos
)
22507 mouse_face_here_p
= 1;
22509 /* Maybe clear the display under the cursor. */
22510 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
22513 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
22516 cursor_glyph
= get_phys_cursor_glyph (w
);
22517 if (cursor_glyph
== NULL
)
22518 goto mark_cursor_off
;
22520 width
= cursor_glyph
->pixel_width
;
22521 left_x
= window_box_left_offset (w
, TEXT_AREA
);
22522 x
= w
->phys_cursor
.x
;
22524 width
-= left_x
- x
;
22525 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
22526 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
22527 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
22530 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
22533 /* Erase the cursor by redrawing the character underneath it. */
22534 if (mouse_face_here_p
)
22535 hl
= DRAW_MOUSE_FACE
;
22537 hl
= DRAW_NORMAL_TEXT
;
22538 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
22541 w
->phys_cursor_on_p
= 0;
22542 w
->phys_cursor_type
= NO_CURSOR
;
22547 Display or clear cursor of window W. If ON is zero, clear the
22548 cursor. If it is non-zero, display the cursor. If ON is nonzero,
22549 where to put the cursor is specified by HPOS, VPOS, X and Y. */
22552 display_and_set_cursor (w
, on
, hpos
, vpos
, x
, y
)
22554 int on
, hpos
, vpos
, x
, y
;
22556 struct frame
*f
= XFRAME (w
->frame
);
22557 int new_cursor_type
;
22558 int new_cursor_width
;
22560 struct glyph_row
*glyph_row
;
22561 struct glyph
*glyph
;
22563 /* This is pointless on invisible frames, and dangerous on garbaged
22564 windows and frames; in the latter case, the frame or window may
22565 be in the midst of changing its size, and x and y may be off the
22567 if (! FRAME_VISIBLE_P (f
)
22568 || FRAME_GARBAGED_P (f
)
22569 || vpos
>= w
->current_matrix
->nrows
22570 || hpos
>= w
->current_matrix
->matrix_w
)
22573 /* If cursor is off and we want it off, return quickly. */
22574 if (!on
&& !w
->phys_cursor_on_p
)
22577 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
22578 /* If cursor row is not enabled, we don't really know where to
22579 display the cursor. */
22580 if (!glyph_row
->enabled_p
)
22582 w
->phys_cursor_on_p
= 0;
22587 if (!glyph_row
->exact_window_width_line_p
22588 || hpos
< glyph_row
->used
[TEXT_AREA
])
22589 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
22591 xassert (interrupt_input_blocked
);
22593 /* Set new_cursor_type to the cursor we want to be displayed. */
22594 new_cursor_type
= get_window_cursor_type (w
, glyph
,
22595 &new_cursor_width
, &active_cursor
);
22597 /* If cursor is currently being shown and we don't want it to be or
22598 it is in the wrong place, or the cursor type is not what we want,
22600 if (w
->phys_cursor_on_p
22602 || w
->phys_cursor
.x
!= x
22603 || w
->phys_cursor
.y
!= y
22604 || new_cursor_type
!= w
->phys_cursor_type
22605 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
22606 && new_cursor_width
!= w
->phys_cursor_width
)))
22607 erase_phys_cursor (w
);
22609 /* Don't check phys_cursor_on_p here because that flag is only set
22610 to zero in some cases where we know that the cursor has been
22611 completely erased, to avoid the extra work of erasing the cursor
22612 twice. In other words, phys_cursor_on_p can be 1 and the cursor
22613 still not be visible, or it has only been partly erased. */
22616 w
->phys_cursor_ascent
= glyph_row
->ascent
;
22617 w
->phys_cursor_height
= glyph_row
->height
;
22619 /* Set phys_cursor_.* before x_draw_.* is called because some
22620 of them may need the information. */
22621 w
->phys_cursor
.x
= x
;
22622 w
->phys_cursor
.y
= glyph_row
->y
;
22623 w
->phys_cursor
.hpos
= hpos
;
22624 w
->phys_cursor
.vpos
= vpos
;
22627 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
22628 new_cursor_type
, new_cursor_width
,
22629 on
, active_cursor
);
22633 /* Switch the display of W's cursor on or off, according to the value
22637 update_window_cursor (w
, on
)
22641 /* Don't update cursor in windows whose frame is in the process
22642 of being deleted. */
22643 if (w
->current_matrix
)
22646 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
22647 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
22653 /* Call update_window_cursor with parameter ON_P on all leaf windows
22654 in the window tree rooted at W. */
22657 update_cursor_in_window_tree (w
, on_p
)
22663 if (!NILP (w
->hchild
))
22664 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
22665 else if (!NILP (w
->vchild
))
22666 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
22668 update_window_cursor (w
, on_p
);
22670 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
22676 Display the cursor on window W, or clear it, according to ON_P.
22677 Don't change the cursor's position. */
22680 x_update_cursor (f
, on_p
)
22684 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
22689 Clear the cursor of window W to background color, and mark the
22690 cursor as not shown. This is used when the text where the cursor
22691 is about to be rewritten. */
22697 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
22698 update_window_cursor (w
, 0);
22703 Display the active region described by mouse_face_* according to DRAW. */
22706 show_mouse_face (dpyinfo
, draw
)
22707 Display_Info
*dpyinfo
;
22708 enum draw_glyphs_face draw
;
22710 struct window
*w
= XWINDOW (dpyinfo
->mouse_face_window
);
22711 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22713 if (/* If window is in the process of being destroyed, don't bother
22715 w
->current_matrix
!= NULL
22716 /* Don't update mouse highlight if hidden */
22717 && (draw
!= DRAW_MOUSE_FACE
|| !dpyinfo
->mouse_face_hidden
)
22718 /* Recognize when we are called to operate on rows that don't exist
22719 anymore. This can happen when a window is split. */
22720 && dpyinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
22722 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
22723 struct glyph_row
*row
, *first
, *last
;
22725 first
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
22726 last
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
22728 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
22730 int start_hpos
, end_hpos
, start_x
;
22732 /* For all but the first row, the highlight starts at column 0. */
22735 start_hpos
= dpyinfo
->mouse_face_beg_col
;
22736 start_x
= dpyinfo
->mouse_face_beg_x
;
22745 end_hpos
= dpyinfo
->mouse_face_end_col
;
22748 end_hpos
= row
->used
[TEXT_AREA
];
22749 if (draw
== DRAW_NORMAL_TEXT
)
22750 row
->fill_line_p
= 1; /* Clear to end of line */
22753 if (end_hpos
> start_hpos
)
22755 draw_glyphs (w
, start_x
, row
, TEXT_AREA
,
22756 start_hpos
, end_hpos
,
22760 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
22764 /* When we've written over the cursor, arrange for it to
22765 be displayed again. */
22766 if (phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
22769 display_and_set_cursor (w
, 1,
22770 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
22771 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
22776 /* Change the mouse cursor. */
22777 if (draw
== DRAW_NORMAL_TEXT
&& !EQ (dpyinfo
->mouse_face_window
, f
->tool_bar_window
))
22778 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
22779 else if (draw
== DRAW_MOUSE_FACE
)
22780 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
22782 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
22786 Clear out the mouse-highlighted active region.
22787 Redraw it un-highlighted first. Value is non-zero if mouse
22788 face was actually drawn unhighlighted. */
22791 clear_mouse_face (dpyinfo
)
22792 Display_Info
*dpyinfo
;
22796 if (!dpyinfo
->mouse_face_hidden
&& !NILP (dpyinfo
->mouse_face_window
))
22798 show_mouse_face (dpyinfo
, DRAW_NORMAL_TEXT
);
22802 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
22803 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
22804 dpyinfo
->mouse_face_window
= Qnil
;
22805 dpyinfo
->mouse_face_overlay
= Qnil
;
22811 Non-zero if physical cursor of window W is within mouse face. */
22814 cursor_in_mouse_face_p (w
)
22817 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
22818 int in_mouse_face
= 0;
22820 if (WINDOWP (dpyinfo
->mouse_face_window
)
22821 && XWINDOW (dpyinfo
->mouse_face_window
) == w
)
22823 int hpos
= w
->phys_cursor
.hpos
;
22824 int vpos
= w
->phys_cursor
.vpos
;
22826 if (vpos
>= dpyinfo
->mouse_face_beg_row
22827 && vpos
<= dpyinfo
->mouse_face_end_row
22828 && (vpos
> dpyinfo
->mouse_face_beg_row
22829 || hpos
>= dpyinfo
->mouse_face_beg_col
)
22830 && (vpos
< dpyinfo
->mouse_face_end_row
22831 || hpos
< dpyinfo
->mouse_face_end_col
22832 || dpyinfo
->mouse_face_past_end
))
22836 return in_mouse_face
;
22842 /* This function sets the mouse_face_* elements of DPYINFO, assuming
22843 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
22844 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
22845 for the overlay or run of text properties specifying the mouse
22846 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
22847 before-string and after-string that must also be highlighted.
22848 DISPLAY_STRING, if non-nil, is a display string that may cover some
22849 or all of the highlighted text. */
22852 mouse_face_from_buffer_pos (Lisp_Object window
,
22853 Display_Info
*dpyinfo
,
22854 EMACS_INT mouse_charpos
,
22855 EMACS_INT start_charpos
,
22856 EMACS_INT end_charpos
,
22857 Lisp_Object before_string
,
22858 Lisp_Object after_string
,
22859 Lisp_Object display_string
)
22861 struct window
*w
= XWINDOW (window
);
22862 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
22863 struct glyph_row
*row
;
22864 struct glyph
*glyph
, *end
;
22868 xassert (NILP (display_string
) || STRINGP (display_string
));
22869 xassert (NILP (before_string
) || STRINGP (before_string
));
22870 xassert (NILP (after_string
) || STRINGP (after_string
));
22872 /* Find the first highlighted glyph. */
22873 if (start_charpos
< MATRIX_ROW_START_CHARPOS (first
))
22875 dpyinfo
->mouse_face_beg_col
= 0;
22876 dpyinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (first
, w
->current_matrix
);
22877 dpyinfo
->mouse_face_beg_x
= first
->x
;
22878 dpyinfo
->mouse_face_beg_y
= first
->y
;
22882 row
= row_containing_pos (w
, start_charpos
, first
, NULL
, 0);
22884 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
22886 /* If the before-string or display-string contains newlines,
22887 row_containing_pos skips to its last row. Move back. */
22888 if (!NILP (before_string
) || !NILP (display_string
))
22890 struct glyph_row
*prev
;
22891 while ((prev
= row
- 1, prev
>= first
)
22892 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
22893 && prev
->used
[TEXT_AREA
] > 0)
22895 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
22896 glyph
= beg
+ prev
->used
[TEXT_AREA
];
22897 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
22899 || !(EQ (glyph
->object
, before_string
)
22900 || EQ (glyph
->object
, display_string
)))
22906 glyph
= row
->glyphs
[TEXT_AREA
];
22907 end
= glyph
+ row
->used
[TEXT_AREA
];
22909 dpyinfo
->mouse_face_beg_y
= row
->y
;
22910 dpyinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
22912 /* Skip truncation glyphs at the start of the glyph row. */
22913 if (row
->displays_text_p
)
22915 && INTEGERP (glyph
->object
)
22916 && glyph
->charpos
< 0;
22918 x
+= glyph
->pixel_width
;
22920 /* Scan the glyph row, stopping before BEFORE_STRING or
22921 DISPLAY_STRING or START_CHARPOS. */
22923 && !INTEGERP (glyph
->object
)
22924 && !EQ (glyph
->object
, before_string
)
22925 && !EQ (glyph
->object
, display_string
)
22926 && !(BUFFERP (glyph
->object
)
22927 && glyph
->charpos
>= start_charpos
);
22929 x
+= glyph
->pixel_width
;
22931 dpyinfo
->mouse_face_beg_x
= x
;
22932 dpyinfo
->mouse_face_beg_col
= glyph
- row
->glyphs
[TEXT_AREA
];
22935 /* Find the last highlighted glyph. */
22936 row
= row_containing_pos (w
, end_charpos
, first
, NULL
, 0);
22939 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
22940 dpyinfo
->mouse_face_past_end
= 1;
22942 else if (!NILP (after_string
))
22944 /* If the after-string has newlines, advance to its last row. */
22945 struct glyph_row
*next
;
22946 struct glyph_row
*last
22947 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
22949 for (next
= row
+ 1;
22951 && next
->used
[TEXT_AREA
] > 0
22952 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
22957 glyph
= row
->glyphs
[TEXT_AREA
];
22958 end
= glyph
+ row
->used
[TEXT_AREA
];
22960 dpyinfo
->mouse_face_end_y
= row
->y
;
22961 dpyinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
22963 /* Skip truncation glyphs at the start of the row. */
22964 if (row
->displays_text_p
)
22966 && INTEGERP (glyph
->object
)
22967 && glyph
->charpos
< 0;
22969 x
+= glyph
->pixel_width
;
22971 /* Scan the glyph row, stopping at END_CHARPOS or when we encounter
22974 && !INTEGERP (glyph
->object
)
22975 && !EQ (glyph
->object
, after_string
)
22976 && !(BUFFERP (glyph
->object
) && glyph
->charpos
>= end_charpos
);
22978 x
+= glyph
->pixel_width
;
22980 /* If we found AFTER_STRING, consume it and stop. */
22981 if (EQ (glyph
->object
, after_string
))
22983 for (; EQ (glyph
->object
, after_string
) && glyph
< end
; ++glyph
)
22984 x
+= glyph
->pixel_width
;
22988 /* If there's no after-string, we must check if we overshot,
22989 which might be the case if we stopped after a string glyph.
22990 That glyph may belong to a before-string or display-string
22991 associated with the end position, which must not be
22993 Lisp_Object prev_object
;
22996 while (glyph
> row
->glyphs
[TEXT_AREA
])
22998 prev_object
= (glyph
- 1)->object
;
22999 if (!STRINGP (prev_object
) || EQ (prev_object
, display_string
))
23002 pos
= string_buffer_position (w
, prev_object
, end_charpos
);
23003 if (pos
&& pos
< end_charpos
)
23006 for (; glyph
> row
->glyphs
[TEXT_AREA
]
23007 && EQ ((glyph
- 1)->object
, prev_object
);
23009 x
-= (glyph
- 1)->pixel_width
;
23013 dpyinfo
->mouse_face_end_x
= x
;
23014 dpyinfo
->mouse_face_end_col
= glyph
- row
->glyphs
[TEXT_AREA
];
23015 dpyinfo
->mouse_face_window
= window
;
23016 dpyinfo
->mouse_face_face_id
23017 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
23019 !dpyinfo
->mouse_face_hidden
, -1);
23020 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23024 /* Find the position of the glyph for position POS in OBJECT in
23025 window W's current matrix, and return in *X, *Y the pixel
23026 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
23028 RIGHT_P non-zero means return the position of the right edge of the
23029 glyph, RIGHT_P zero means return the left edge position.
23031 If no glyph for POS exists in the matrix, return the position of
23032 the glyph with the next smaller position that is in the matrix, if
23033 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
23034 exists in the matrix, return the position of the glyph with the
23035 next larger position in OBJECT.
23037 Value is non-zero if a glyph was found. */
23040 fast_find_string_pos (w
, pos
, object
, hpos
, vpos
, x
, y
, right_p
)
23043 Lisp_Object object
;
23044 int *hpos
, *vpos
, *x
, *y
;
23047 int yb
= window_text_bottom_y (w
);
23048 struct glyph_row
*r
;
23049 struct glyph
*best_glyph
= NULL
;
23050 struct glyph_row
*best_row
= NULL
;
23053 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
23054 r
->enabled_p
&& r
->y
< yb
;
23057 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
23058 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
23061 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
23062 if (EQ (g
->object
, object
))
23064 if (g
->charpos
== pos
)
23071 else if (best_glyph
== NULL
23072 || ((eabs (g
->charpos
- pos
)
23073 < eabs (best_glyph
->charpos
- pos
))
23076 : g
->charpos
> pos
)))
23090 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
23094 *x
+= best_glyph
->pixel_width
;
23099 *vpos
= best_row
- w
->current_matrix
->rows
;
23102 return best_glyph
!= NULL
;
23106 /* See if position X, Y is within a hot-spot of an image. */
23109 on_hot_spot_p (hot_spot
, x
, y
)
23110 Lisp_Object hot_spot
;
23113 if (!CONSP (hot_spot
))
23116 if (EQ (XCAR (hot_spot
), Qrect
))
23118 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
23119 Lisp_Object rect
= XCDR (hot_spot
);
23123 if (!CONSP (XCAR (rect
)))
23125 if (!CONSP (XCDR (rect
)))
23127 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
23129 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
23131 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
23133 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
23137 else if (EQ (XCAR (hot_spot
), Qcircle
))
23139 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
23140 Lisp_Object circ
= XCDR (hot_spot
);
23141 Lisp_Object lr
, lx0
, ly0
;
23143 && CONSP (XCAR (circ
))
23144 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
23145 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
23146 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
23148 double r
= XFLOATINT (lr
);
23149 double dx
= XINT (lx0
) - x
;
23150 double dy
= XINT (ly0
) - y
;
23151 return (dx
* dx
+ dy
* dy
<= r
* r
);
23154 else if (EQ (XCAR (hot_spot
), Qpoly
))
23156 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
23157 if (VECTORP (XCDR (hot_spot
)))
23159 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
23160 Lisp_Object
*poly
= v
->contents
;
23164 Lisp_Object lx
, ly
;
23167 /* Need an even number of coordinates, and at least 3 edges. */
23168 if (n
< 6 || n
& 1)
23171 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
23172 If count is odd, we are inside polygon. Pixels on edges
23173 may or may not be included depending on actual geometry of the
23175 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
23176 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
23178 x0
= XINT (lx
), y0
= XINT (ly
);
23179 for (i
= 0; i
< n
; i
+= 2)
23181 int x1
= x0
, y1
= y0
;
23182 if ((lx
= poly
[i
], !INTEGERP (lx
))
23183 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
23185 x0
= XINT (lx
), y0
= XINT (ly
);
23187 /* Does this segment cross the X line? */
23195 if (y
> y0
&& y
> y1
)
23197 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
23207 find_hot_spot (map
, x
, y
)
23211 while (CONSP (map
))
23213 if (CONSP (XCAR (map
))
23214 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
23222 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
23224 doc
: /* Lookup in image map MAP coordinates X and Y.
23225 An image map is an alist where each element has the format (AREA ID PLIST).
23226 An AREA is specified as either a rectangle, a circle, or a polygon:
23227 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
23228 pixel coordinates of the upper left and bottom right corners.
23229 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
23230 and the radius of the circle; r may be a float or integer.
23231 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
23232 vector describes one corner in the polygon.
23233 Returns the alist element for the first matching AREA in MAP. */)
23244 return find_hot_spot (map
, XINT (x
), XINT (y
));
23248 /* Display frame CURSOR, optionally using shape defined by POINTER. */
23250 define_frame_cursor1 (f
, cursor
, pointer
)
23253 Lisp_Object pointer
;
23255 /* Do not change cursor shape while dragging mouse. */
23256 if (!NILP (do_mouse_tracking
))
23259 if (!NILP (pointer
))
23261 if (EQ (pointer
, Qarrow
))
23262 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23263 else if (EQ (pointer
, Qhand
))
23264 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
23265 else if (EQ (pointer
, Qtext
))
23266 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
23267 else if (EQ (pointer
, intern ("hdrag")))
23268 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
23269 #ifdef HAVE_X_WINDOWS
23270 else if (EQ (pointer
, intern ("vdrag")))
23271 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
23273 else if (EQ (pointer
, intern ("hourglass")))
23274 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
23275 else if (EQ (pointer
, Qmodeline
))
23276 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
23278 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23281 if (cursor
!= No_Cursor
)
23282 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
23285 /* Take proper action when mouse has moved to the mode or header line
23286 or marginal area AREA of window W, x-position X and y-position Y.
23287 X is relative to the start of the text display area of W, so the
23288 width of bitmap areas and scroll bars must be subtracted to get a
23289 position relative to the start of the mode line. */
23292 note_mode_line_or_margin_highlight (window
, x
, y
, area
)
23293 Lisp_Object window
;
23295 enum window_part area
;
23297 struct window
*w
= XWINDOW (window
);
23298 struct frame
*f
= XFRAME (w
->frame
);
23299 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
23300 Cursor cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23301 Lisp_Object pointer
= Qnil
;
23302 int charpos
, dx
, dy
, width
, height
;
23303 Lisp_Object string
, object
= Qnil
;
23304 Lisp_Object pos
, help
;
23306 Lisp_Object mouse_face
;
23307 int original_x_pixel
= x
;
23308 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
23309 struct glyph_row
*row
;
23311 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
23316 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
23317 &object
, &dx
, &dy
, &width
, &height
);
23319 row
= (area
== ON_MODE_LINE
23320 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
23321 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
23324 if (row
->mode_line_p
&& row
->enabled_p
)
23326 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
23327 end
= glyph
+ row
->used
[TEXT_AREA
];
23329 for (x0
= original_x_pixel
;
23330 glyph
< end
&& x0
>= glyph
->pixel_width
;
23332 x0
-= glyph
->pixel_width
;
23340 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
23341 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
23342 &object
, &dx
, &dy
, &width
, &height
);
23347 if (IMAGEP (object
))
23349 Lisp_Object image_map
, hotspot
;
23350 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
23352 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
23354 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
23356 Lisp_Object area_id
, plist
;
23358 area_id
= XCAR (hotspot
);
23359 /* Could check AREA_ID to see if we enter/leave this hot-spot.
23360 If so, we could look for mouse-enter, mouse-leave
23361 properties in PLIST (and do something...). */
23362 hotspot
= XCDR (hotspot
);
23363 if (CONSP (hotspot
)
23364 && (plist
= XCAR (hotspot
), CONSP (plist
)))
23366 pointer
= Fplist_get (plist
, Qpointer
);
23367 if (NILP (pointer
))
23369 help
= Fplist_get (plist
, Qhelp_echo
);
23372 help_echo_string
= help
;
23373 /* Is this correct? ++kfs */
23374 XSETWINDOW (help_echo_window
, w
);
23375 help_echo_object
= w
->buffer
;
23376 help_echo_pos
= charpos
;
23380 if (NILP (pointer
))
23381 pointer
= Fplist_get (XCDR (object
), QCpointer
);
23384 if (STRINGP (string
))
23386 pos
= make_number (charpos
);
23387 /* If we're on a string with `help-echo' text property, arrange
23388 for the help to be displayed. This is done by setting the
23389 global variable help_echo_string to the help string. */
23392 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
23395 help_echo_string
= help
;
23396 XSETWINDOW (help_echo_window
, w
);
23397 help_echo_object
= string
;
23398 help_echo_pos
= charpos
;
23402 if (NILP (pointer
))
23403 pointer
= Fget_text_property (pos
, Qpointer
, string
);
23405 /* Change the mouse pointer according to what is under X/Y. */
23406 if (NILP (pointer
) && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
23409 map
= Fget_text_property (pos
, Qlocal_map
, string
);
23410 if (!KEYMAPP (map
))
23411 map
= Fget_text_property (pos
, Qkeymap
, string
);
23412 if (!KEYMAPP (map
))
23413 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
23416 /* Change the mouse face according to what is under X/Y. */
23417 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
23418 if (!NILP (mouse_face
)
23419 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
23424 struct glyph
* tmp_glyph
;
23428 int total_pixel_width
;
23433 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
23434 Qmouse_face
, string
, Qnil
);
23436 b
= make_number (0);
23438 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
23440 e
= make_number (SCHARS (string
));
23442 /* Calculate the position(glyph position: GPOS) of GLYPH in
23443 displayed string. GPOS is different from CHARPOS.
23445 CHARPOS is the position of glyph in internal string
23446 object. A mode line string format has structures which
23447 is converted to a flatten by emacs lisp interpreter.
23448 The internal string is an element of the structures.
23449 The displayed string is the flatten string. */
23451 if (glyph
> row_start_glyph
)
23453 tmp_glyph
= glyph
- 1;
23454 while (tmp_glyph
>= row_start_glyph
23455 && tmp_glyph
->charpos
>= XINT (b
)
23456 && EQ (tmp_glyph
->object
, glyph
->object
))
23463 /* Calculate the lenght(glyph sequence length: GSEQ_LENGTH) of
23464 displayed string holding GLYPH.
23466 GSEQ_LENGTH is different from SCHARS (STRING).
23467 SCHARS (STRING) returns the length of the internal string. */
23468 for (tmp_glyph
= glyph
, gseq_length
= gpos
;
23469 tmp_glyph
->charpos
< XINT (e
);
23470 tmp_glyph
++, gseq_length
++)
23472 if (!EQ (tmp_glyph
->object
, glyph
->object
))
23476 total_pixel_width
= 0;
23477 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
23478 total_pixel_width
+= tmp_glyph
->pixel_width
;
23480 /* Pre calculation of re-rendering position */
23482 hpos
= (area
== ON_MODE_LINE
23483 ? (w
->current_matrix
)->nrows
- 1
23486 /* If the re-rendering position is included in the last
23487 re-rendering area, we should do nothing. */
23488 if ( EQ (window
, dpyinfo
->mouse_face_window
)
23489 && dpyinfo
->mouse_face_beg_col
<= vpos
23490 && vpos
< dpyinfo
->mouse_face_end_col
23491 && dpyinfo
->mouse_face_beg_row
== hpos
)
23494 if (clear_mouse_face (dpyinfo
))
23495 cursor
= No_Cursor
;
23497 dpyinfo
->mouse_face_beg_col
= vpos
;
23498 dpyinfo
->mouse_face_beg_row
= hpos
;
23500 dpyinfo
->mouse_face_beg_x
= original_x_pixel
- (total_pixel_width
+ dx
);
23501 dpyinfo
->mouse_face_beg_y
= 0;
23503 dpyinfo
->mouse_face_end_col
= vpos
+ gseq_length
;
23504 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_beg_row
;
23506 dpyinfo
->mouse_face_end_x
= 0;
23507 dpyinfo
->mouse_face_end_y
= 0;
23509 dpyinfo
->mouse_face_past_end
= 0;
23510 dpyinfo
->mouse_face_window
= window
;
23512 dpyinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
23515 glyph
->face_id
, 1);
23516 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23518 if (NILP (pointer
))
23521 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
23522 clear_mouse_face (dpyinfo
);
23524 define_frame_cursor1 (f
, cursor
, pointer
);
23529 Take proper action when the mouse has moved to position X, Y on
23530 frame F as regards highlighting characters that have mouse-face
23531 properties. Also de-highlighting chars where the mouse was before.
23532 X and Y can be negative or out of range. */
23535 note_mouse_highlight (f
, x
, y
)
23539 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
23540 enum window_part part
;
23541 Lisp_Object window
;
23543 Cursor cursor
= No_Cursor
;
23544 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
23547 /* When a menu is active, don't highlight because this looks odd. */
23548 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
23549 if (popup_activated ())
23553 if (NILP (Vmouse_highlight
)
23554 || !f
->glyphs_initialized_p
23555 || f
->pointer_invisible
)
23558 dpyinfo
->mouse_face_mouse_x
= x
;
23559 dpyinfo
->mouse_face_mouse_y
= y
;
23560 dpyinfo
->mouse_face_mouse_frame
= f
;
23562 if (dpyinfo
->mouse_face_defer
)
23565 if (gc_in_progress
)
23567 dpyinfo
->mouse_face_deferred_gc
= 1;
23571 /* Which window is that in? */
23572 window
= window_from_coordinates (f
, x
, y
, &part
, 0, 0, 1);
23574 /* If we were displaying active text in another window, clear that.
23575 Also clear if we move out of text area in same window. */
23576 if (! EQ (window
, dpyinfo
->mouse_face_window
)
23577 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
23578 && !NILP (dpyinfo
->mouse_face_window
)))
23579 clear_mouse_face (dpyinfo
);
23581 /* Not on a window -> return. */
23582 if (!WINDOWP (window
))
23585 /* Reset help_echo_string. It will get recomputed below. */
23586 help_echo_string
= Qnil
;
23588 /* Convert to window-relative pixel coordinates. */
23589 w
= XWINDOW (window
);
23590 frame_to_window_pixel_xy (w
, &x
, &y
);
23592 /* Handle tool-bar window differently since it doesn't display a
23594 if (EQ (window
, f
->tool_bar_window
))
23596 note_tool_bar_highlight (f
, x
, y
);
23600 /* Mouse is on the mode, header line or margin? */
23601 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
23602 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
23604 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
23608 if (part
== ON_VERTICAL_BORDER
)
23610 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
23611 help_echo_string
= build_string ("drag-mouse-1: resize");
23613 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
23614 || part
== ON_SCROLL_BAR
)
23615 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23617 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
23619 /* Are we in a window whose display is up to date?
23620 And verify the buffer's text has not changed. */
23621 b
= XBUFFER (w
->buffer
);
23622 if (part
== ON_TEXT
23623 && EQ (w
->window_end_valid
, w
->buffer
)
23624 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
23625 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
23627 int hpos
, vpos
, pos
, i
, dx
, dy
, area
;
23628 struct glyph
*glyph
;
23629 Lisp_Object object
;
23630 Lisp_Object mouse_face
= Qnil
, overlay
= Qnil
, position
;
23631 Lisp_Object
*overlay_vec
= NULL
;
23633 struct buffer
*obuf
;
23634 int obegv
, ozv
, same_region
;
23636 /* Find the glyph under X/Y. */
23637 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
23639 /* Look for :pointer property on image. */
23640 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
23642 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
23643 if (img
!= NULL
&& IMAGEP (img
->spec
))
23645 Lisp_Object image_map
, hotspot
;
23646 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
23648 && (hotspot
= find_hot_spot (image_map
,
23649 glyph
->slice
.x
+ dx
,
23650 glyph
->slice
.y
+ dy
),
23652 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
23654 Lisp_Object area_id
, plist
;
23656 area_id
= XCAR (hotspot
);
23657 /* Could check AREA_ID to see if we enter/leave this hot-spot.
23658 If so, we could look for mouse-enter, mouse-leave
23659 properties in PLIST (and do something...). */
23660 hotspot
= XCDR (hotspot
);
23661 if (CONSP (hotspot
)
23662 && (plist
= XCAR (hotspot
), CONSP (plist
)))
23664 pointer
= Fplist_get (plist
, Qpointer
);
23665 if (NILP (pointer
))
23667 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
23668 if (!NILP (help_echo_string
))
23670 help_echo_window
= window
;
23671 help_echo_object
= glyph
->object
;
23672 help_echo_pos
= glyph
->charpos
;
23676 if (NILP (pointer
))
23677 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
23681 /* Clear mouse face if X/Y not over text. */
23683 || area
!= TEXT_AREA
23684 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
)
23686 if (clear_mouse_face (dpyinfo
))
23687 cursor
= No_Cursor
;
23688 if (NILP (pointer
))
23690 if (area
!= TEXT_AREA
)
23691 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23693 pointer
= Vvoid_text_area_pointer
;
23698 pos
= glyph
->charpos
;
23699 object
= glyph
->object
;
23700 if (!STRINGP (object
) && !BUFFERP (object
))
23703 /* If we get an out-of-range value, return now; avoid an error. */
23704 if (BUFFERP (object
) && pos
> BUF_Z (b
))
23707 /* Make the window's buffer temporarily current for
23708 overlays_at and compute_char_face. */
23709 obuf
= current_buffer
;
23710 current_buffer
= b
;
23716 /* Is this char mouse-active or does it have help-echo? */
23717 position
= make_number (pos
);
23719 if (BUFFERP (object
))
23721 /* Put all the overlays we want in a vector in overlay_vec. */
23722 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
23723 /* Sort overlays into increasing priority order. */
23724 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
23729 same_region
= (EQ (window
, dpyinfo
->mouse_face_window
)
23730 && vpos
>= dpyinfo
->mouse_face_beg_row
23731 && vpos
<= dpyinfo
->mouse_face_end_row
23732 && (vpos
> dpyinfo
->mouse_face_beg_row
23733 || hpos
>= dpyinfo
->mouse_face_beg_col
)
23734 && (vpos
< dpyinfo
->mouse_face_end_row
23735 || hpos
< dpyinfo
->mouse_face_end_col
23736 || dpyinfo
->mouse_face_past_end
));
23739 cursor
= No_Cursor
;
23741 /* Check mouse-face highlighting. */
23743 /* If there exists an overlay with mouse-face overlapping
23744 the one we are currently highlighting, we have to
23745 check if we enter the overlapping overlay, and then
23746 highlight only that. */
23747 || (OVERLAYP (dpyinfo
->mouse_face_overlay
)
23748 && mouse_face_overlay_overlaps (dpyinfo
->mouse_face_overlay
)))
23750 /* Find the highest priority overlay with a mouse-face. */
23752 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
23754 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
23755 if (!NILP (mouse_face
))
23756 overlay
= overlay_vec
[i
];
23759 /* If we're highlighting the same overlay as before, there's
23760 no need to do that again. */
23761 if (!NILP (overlay
) && EQ (overlay
, dpyinfo
->mouse_face_overlay
))
23762 goto check_help_echo
;
23763 dpyinfo
->mouse_face_overlay
= overlay
;
23765 /* Clear the display of the old active region, if any. */
23766 if (clear_mouse_face (dpyinfo
))
23767 cursor
= No_Cursor
;
23769 /* If no overlay applies, get a text property. */
23770 if (NILP (overlay
))
23771 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
23773 /* Next, compute the bounds of the mouse highlighting and
23775 if (!NILP (mouse_face
) && STRINGP (object
))
23777 /* The mouse-highlighting comes from a display string
23778 with a mouse-face. */
23782 b
= Fprevious_single_property_change
23783 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
23784 e
= Fnext_single_property_change
23785 (position
, Qmouse_face
, object
, Qnil
);
23787 b
= make_number (0);
23789 e
= make_number (SCHARS (object
) - 1);
23791 fast_find_string_pos (w
, XINT (b
), object
,
23792 &dpyinfo
->mouse_face_beg_col
,
23793 &dpyinfo
->mouse_face_beg_row
,
23794 &dpyinfo
->mouse_face_beg_x
,
23795 &dpyinfo
->mouse_face_beg_y
, 0);
23796 fast_find_string_pos (w
, XINT (e
), object
,
23797 &dpyinfo
->mouse_face_end_col
,
23798 &dpyinfo
->mouse_face_end_row
,
23799 &dpyinfo
->mouse_face_end_x
,
23800 &dpyinfo
->mouse_face_end_y
, 1);
23801 dpyinfo
->mouse_face_past_end
= 0;
23802 dpyinfo
->mouse_face_window
= window
;
23803 dpyinfo
->mouse_face_face_id
23804 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
23805 glyph
->face_id
, 1);
23806 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23807 cursor
= No_Cursor
;
23811 /* The mouse-highlighting, if any, comes from an overlay
23812 or text property in the buffer. */
23813 Lisp_Object buffer
, display_string
;
23815 if (STRINGP (object
))
23817 /* If we are on a display string with no mouse-face,
23818 check if the text under it has one. */
23819 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
23820 int start
= MATRIX_ROW_START_CHARPOS (r
);
23821 pos
= string_buffer_position (w
, object
, start
);
23824 mouse_face
= get_char_property_and_overlay
23825 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
23826 buffer
= w
->buffer
;
23827 display_string
= object
;
23833 display_string
= Qnil
;
23836 if (!NILP (mouse_face
))
23838 Lisp_Object before
, after
;
23839 Lisp_Object before_string
, after_string
;
23841 if (NILP (overlay
))
23843 /* Handle the text property case. */
23844 before
= Fprevious_single_property_change
23845 (make_number (pos
+ 1), Qmouse_face
, buffer
,
23846 Fmarker_position (w
->start
));
23847 after
= Fnext_single_property_change
23848 (make_number (pos
), Qmouse_face
, buffer
,
23849 make_number (BUF_Z (XBUFFER (buffer
))
23850 - XFASTINT (w
->window_end_pos
)));
23851 before_string
= after_string
= Qnil
;
23855 /* Handle the overlay case. */
23856 before
= Foverlay_start (overlay
);
23857 after
= Foverlay_end (overlay
);
23858 before_string
= Foverlay_get (overlay
, Qbefore_string
);
23859 after_string
= Foverlay_get (overlay
, Qafter_string
);
23861 if (!STRINGP (before_string
)) before_string
= Qnil
;
23862 if (!STRINGP (after_string
)) after_string
= Qnil
;
23865 mouse_face_from_buffer_pos (window
, dpyinfo
, pos
,
23868 before_string
, after_string
,
23870 cursor
= No_Cursor
;
23877 /* Look for a `help-echo' property. */
23878 if (NILP (help_echo_string
)) {
23879 Lisp_Object help
, overlay
;
23881 /* Check overlays first. */
23882 help
= overlay
= Qnil
;
23883 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
23885 overlay
= overlay_vec
[i
];
23886 help
= Foverlay_get (overlay
, Qhelp_echo
);
23891 help_echo_string
= help
;
23892 help_echo_window
= window
;
23893 help_echo_object
= overlay
;
23894 help_echo_pos
= pos
;
23898 Lisp_Object object
= glyph
->object
;
23899 int charpos
= glyph
->charpos
;
23901 /* Try text properties. */
23902 if (STRINGP (object
)
23904 && charpos
< SCHARS (object
))
23906 help
= Fget_text_property (make_number (charpos
),
23907 Qhelp_echo
, object
);
23910 /* If the string itself doesn't specify a help-echo,
23911 see if the buffer text ``under'' it does. */
23912 struct glyph_row
*r
23913 = MATRIX_ROW (w
->current_matrix
, vpos
);
23914 int start
= MATRIX_ROW_START_CHARPOS (r
);
23915 int pos
= string_buffer_position (w
, object
, start
);
23918 help
= Fget_char_property (make_number (pos
),
23919 Qhelp_echo
, w
->buffer
);
23923 object
= w
->buffer
;
23928 else if (BUFFERP (object
)
23931 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
23936 help_echo_string
= help
;
23937 help_echo_window
= window
;
23938 help_echo_object
= object
;
23939 help_echo_pos
= charpos
;
23944 /* Look for a `pointer' property. */
23945 if (NILP (pointer
))
23947 /* Check overlays first. */
23948 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
23949 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
23951 if (NILP (pointer
))
23953 Lisp_Object object
= glyph
->object
;
23954 int charpos
= glyph
->charpos
;
23956 /* Try text properties. */
23957 if (STRINGP (object
)
23959 && charpos
< SCHARS (object
))
23961 pointer
= Fget_text_property (make_number (charpos
),
23963 if (NILP (pointer
))
23965 /* If the string itself doesn't specify a pointer,
23966 see if the buffer text ``under'' it does. */
23967 struct glyph_row
*r
23968 = MATRIX_ROW (w
->current_matrix
, vpos
);
23969 int start
= MATRIX_ROW_START_CHARPOS (r
);
23970 int pos
= string_buffer_position (w
, object
, start
);
23972 pointer
= Fget_char_property (make_number (pos
),
23973 Qpointer
, w
->buffer
);
23976 else if (BUFFERP (object
)
23979 pointer
= Fget_text_property (make_number (charpos
),
23986 current_buffer
= obuf
;
23991 define_frame_cursor1 (f
, cursor
, pointer
);
23996 Clear any mouse-face on window W. This function is part of the
23997 redisplay interface, and is called from try_window_id and similar
23998 functions to ensure the mouse-highlight is off. */
24001 x_clear_window_mouse_face (w
)
24004 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
24005 Lisp_Object window
;
24008 XSETWINDOW (window
, w
);
24009 if (EQ (window
, dpyinfo
->mouse_face_window
))
24010 clear_mouse_face (dpyinfo
);
24016 Just discard the mouse face information for frame F, if any.
24017 This is used when the size of F is changed. */
24020 cancel_mouse_face (f
)
24023 Lisp_Object window
;
24024 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24026 window
= dpyinfo
->mouse_face_window
;
24027 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
24029 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
24030 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
24031 dpyinfo
->mouse_face_window
= Qnil
;
24036 #endif /* HAVE_WINDOW_SYSTEM */
24039 /***********************************************************************
24041 ***********************************************************************/
24043 #ifdef HAVE_WINDOW_SYSTEM
24045 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
24046 which intersects rectangle R. R is in window-relative coordinates. */
24049 expose_area (w
, row
, r
, area
)
24051 struct glyph_row
*row
;
24053 enum glyph_row_area area
;
24055 struct glyph
*first
= row
->glyphs
[area
];
24056 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
24057 struct glyph
*last
;
24058 int first_x
, start_x
, x
;
24060 if (area
== TEXT_AREA
&& row
->fill_line_p
)
24061 /* If row extends face to end of line write the whole line. */
24062 draw_glyphs (w
, 0, row
, area
,
24063 0, row
->used
[area
],
24064 DRAW_NORMAL_TEXT
, 0);
24067 /* Set START_X to the window-relative start position for drawing glyphs of
24068 AREA. The first glyph of the text area can be partially visible.
24069 The first glyphs of other areas cannot. */
24070 start_x
= window_box_left_offset (w
, area
);
24072 if (area
== TEXT_AREA
)
24075 /* Find the first glyph that must be redrawn. */
24077 && x
+ first
->pixel_width
< r
->x
)
24079 x
+= first
->pixel_width
;
24083 /* Find the last one. */
24087 && x
< r
->x
+ r
->width
)
24089 x
+= last
->pixel_width
;
24095 draw_glyphs (w
, first_x
- start_x
, row
, area
,
24096 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
24097 DRAW_NORMAL_TEXT
, 0);
24102 /* Redraw the parts of the glyph row ROW on window W intersecting
24103 rectangle R. R is in window-relative coordinates. Value is
24104 non-zero if mouse-face was overwritten. */
24107 expose_line (w
, row
, r
)
24109 struct glyph_row
*row
;
24112 xassert (row
->enabled_p
);
24114 if (row
->mode_line_p
|| w
->pseudo_window_p
)
24115 draw_glyphs (w
, 0, row
, TEXT_AREA
,
24116 0, row
->used
[TEXT_AREA
],
24117 DRAW_NORMAL_TEXT
, 0);
24120 if (row
->used
[LEFT_MARGIN_AREA
])
24121 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
24122 if (row
->used
[TEXT_AREA
])
24123 expose_area (w
, row
, r
, TEXT_AREA
);
24124 if (row
->used
[RIGHT_MARGIN_AREA
])
24125 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
24126 draw_row_fringe_bitmaps (w
, row
);
24129 return row
->mouse_face_p
;
24133 /* Redraw those parts of glyphs rows during expose event handling that
24134 overlap other rows. Redrawing of an exposed line writes over parts
24135 of lines overlapping that exposed line; this function fixes that.
24137 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
24138 row in W's current matrix that is exposed and overlaps other rows.
24139 LAST_OVERLAPPING_ROW is the last such row. */
24142 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
, r
)
24144 struct glyph_row
*first_overlapping_row
;
24145 struct glyph_row
*last_overlapping_row
;
24148 struct glyph_row
*row
;
24150 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
24151 if (row
->overlapping_p
)
24153 xassert (row
->enabled_p
&& !row
->mode_line_p
);
24156 if (row
->used
[LEFT_MARGIN_AREA
])
24157 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
24159 if (row
->used
[TEXT_AREA
])
24160 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
24162 if (row
->used
[RIGHT_MARGIN_AREA
])
24163 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
24169 /* Return non-zero if W's cursor intersects rectangle R. */
24172 phys_cursor_in_rect_p (w
, r
)
24176 XRectangle cr
, result
;
24177 struct glyph
*cursor_glyph
;
24178 struct glyph_row
*row
;
24180 if (w
->phys_cursor
.vpos
>= 0
24181 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
24182 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
24184 && row
->cursor_in_fringe_p
)
24186 /* Cursor is in the fringe. */
24187 cr
.x
= window_box_right_offset (w
,
24188 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
24189 ? RIGHT_MARGIN_AREA
24192 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
24193 cr
.height
= row
->height
;
24194 return x_intersect_rectangles (&cr
, r
, &result
);
24197 cursor_glyph
= get_phys_cursor_glyph (w
);
24200 /* r is relative to W's box, but w->phys_cursor.x is relative
24201 to left edge of W's TEXT area. Adjust it. */
24202 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
24203 cr
.y
= w
->phys_cursor
.y
;
24204 cr
.width
= cursor_glyph
->pixel_width
;
24205 cr
.height
= w
->phys_cursor_height
;
24206 /* ++KFS: W32 version used W32-specific IntersectRect here, but
24207 I assume the effect is the same -- and this is portable. */
24208 return x_intersect_rectangles (&cr
, r
, &result
);
24210 /* If we don't understand the format, pretend we're not in the hot-spot. */
24216 Draw a vertical window border to the right of window W if W doesn't
24217 have vertical scroll bars. */
24220 x_draw_vertical_border (w
)
24223 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
24225 /* We could do better, if we knew what type of scroll-bar the adjacent
24226 windows (on either side) have... But we don't :-(
24227 However, I think this works ok. ++KFS 2003-04-25 */
24229 /* Redraw borders between horizontally adjacent windows. Don't
24230 do it for frames with vertical scroll bars because either the
24231 right scroll bar of a window, or the left scroll bar of its
24232 neighbor will suffice as a border. */
24233 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
24236 if (!WINDOW_RIGHTMOST_P (w
)
24237 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
24239 int x0
, x1
, y0
, y1
;
24241 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
24244 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
24247 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
24249 else if (!WINDOW_LEFTMOST_P (w
)
24250 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
24252 int x0
, x1
, y0
, y1
;
24254 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
24257 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
24260 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
24265 /* Redraw the part of window W intersection rectangle FR. Pixel
24266 coordinates in FR are frame-relative. Call this function with
24267 input blocked. Value is non-zero if the exposure overwrites
24271 expose_window (w
, fr
)
24275 struct frame
*f
= XFRAME (w
->frame
);
24277 int mouse_face_overwritten_p
= 0;
24279 /* If window is not yet fully initialized, do nothing. This can
24280 happen when toolkit scroll bars are used and a window is split.
24281 Reconfiguring the scroll bar will generate an expose for a newly
24283 if (w
->current_matrix
== NULL
)
24286 /* When we're currently updating the window, display and current
24287 matrix usually don't agree. Arrange for a thorough display
24289 if (w
== updated_window
)
24291 SET_FRAME_GARBAGED (f
);
24295 /* Frame-relative pixel rectangle of W. */
24296 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
24297 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
24298 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
24299 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
24301 if (x_intersect_rectangles (fr
, &wr
, &r
))
24303 int yb
= window_text_bottom_y (w
);
24304 struct glyph_row
*row
;
24305 int cursor_cleared_p
;
24306 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
24308 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
24309 r
.x
, r
.y
, r
.width
, r
.height
));
24311 /* Convert to window coordinates. */
24312 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
24313 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
24315 /* Turn off the cursor. */
24316 if (!w
->pseudo_window_p
24317 && phys_cursor_in_rect_p (w
, &r
))
24319 x_clear_cursor (w
);
24320 cursor_cleared_p
= 1;
24323 cursor_cleared_p
= 0;
24325 /* Update lines intersecting rectangle R. */
24326 first_overlapping_row
= last_overlapping_row
= NULL
;
24327 for (row
= w
->current_matrix
->rows
;
24332 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
24334 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
24335 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
24336 || (r
.y
>= y0
&& r
.y
< y1
)
24337 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
24339 /* A header line may be overlapping, but there is no need
24340 to fix overlapping areas for them. KFS 2005-02-12 */
24341 if (row
->overlapping_p
&& !row
->mode_line_p
)
24343 if (first_overlapping_row
== NULL
)
24344 first_overlapping_row
= row
;
24345 last_overlapping_row
= row
;
24349 if (expose_line (w
, row
, &r
))
24350 mouse_face_overwritten_p
= 1;
24353 else if (row
->overlapping_p
)
24355 /* We must redraw a row overlapping the exposed area. */
24357 ? y0
+ row
->phys_height
> r
.y
24358 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
24360 if (first_overlapping_row
== NULL
)
24361 first_overlapping_row
= row
;
24362 last_overlapping_row
= row
;
24370 /* Display the mode line if there is one. */
24371 if (WINDOW_WANTS_MODELINE_P (w
)
24372 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
24374 && row
->y
< r
.y
+ r
.height
)
24376 if (expose_line (w
, row
, &r
))
24377 mouse_face_overwritten_p
= 1;
24380 if (!w
->pseudo_window_p
)
24382 /* Fix the display of overlapping rows. */
24383 if (first_overlapping_row
)
24384 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
24387 /* Draw border between windows. */
24388 x_draw_vertical_border (w
);
24390 /* Turn the cursor on again. */
24391 if (cursor_cleared_p
)
24392 update_window_cursor (w
, 1);
24396 return mouse_face_overwritten_p
;
24401 /* Redraw (parts) of all windows in the window tree rooted at W that
24402 intersect R. R contains frame pixel coordinates. Value is
24403 non-zero if the exposure overwrites mouse-face. */
24406 expose_window_tree (w
, r
)
24410 struct frame
*f
= XFRAME (w
->frame
);
24411 int mouse_face_overwritten_p
= 0;
24413 while (w
&& !FRAME_GARBAGED_P (f
))
24415 if (!NILP (w
->hchild
))
24416 mouse_face_overwritten_p
24417 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
24418 else if (!NILP (w
->vchild
))
24419 mouse_face_overwritten_p
24420 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
24422 mouse_face_overwritten_p
|= expose_window (w
, r
);
24424 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
24427 return mouse_face_overwritten_p
;
24432 Redisplay an exposed area of frame F. X and Y are the upper-left
24433 corner of the exposed rectangle. W and H are width and height of
24434 the exposed area. All are pixel values. W or H zero means redraw
24435 the entire frame. */
24438 expose_frame (f
, x
, y
, w
, h
)
24443 int mouse_face_overwritten_p
= 0;
24445 TRACE ((stderr
, "expose_frame "));
24447 /* No need to redraw if frame will be redrawn soon. */
24448 if (FRAME_GARBAGED_P (f
))
24450 TRACE ((stderr
, " garbaged\n"));
24454 /* If basic faces haven't been realized yet, there is no point in
24455 trying to redraw anything. This can happen when we get an expose
24456 event while Emacs is starting, e.g. by moving another window. */
24457 if (FRAME_FACE_CACHE (f
) == NULL
24458 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
24460 TRACE ((stderr
, " no faces\n"));
24464 if (w
== 0 || h
== 0)
24467 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
24468 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
24478 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
24479 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
24481 if (WINDOWP (f
->tool_bar_window
))
24482 mouse_face_overwritten_p
24483 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
24485 #ifdef HAVE_X_WINDOWS
24487 #ifndef USE_X_TOOLKIT
24488 if (WINDOWP (f
->menu_bar_window
))
24489 mouse_face_overwritten_p
24490 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
24491 #endif /* not USE_X_TOOLKIT */
24495 /* Some window managers support a focus-follows-mouse style with
24496 delayed raising of frames. Imagine a partially obscured frame,
24497 and moving the mouse into partially obscured mouse-face on that
24498 frame. The visible part of the mouse-face will be highlighted,
24499 then the WM raises the obscured frame. With at least one WM, KDE
24500 2.1, Emacs is not getting any event for the raising of the frame
24501 (even tried with SubstructureRedirectMask), only Expose events.
24502 These expose events will draw text normally, i.e. not
24503 highlighted. Which means we must redo the highlight here.
24504 Subsume it under ``we love X''. --gerd 2001-08-15 */
24505 /* Included in Windows version because Windows most likely does not
24506 do the right thing if any third party tool offers
24507 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
24508 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
24510 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24511 if (f
== dpyinfo
->mouse_face_mouse_frame
)
24513 int x
= dpyinfo
->mouse_face_mouse_x
;
24514 int y
= dpyinfo
->mouse_face_mouse_y
;
24515 clear_mouse_face (dpyinfo
);
24516 note_mouse_highlight (f
, x
, y
);
24523 Determine the intersection of two rectangles R1 and R2. Return
24524 the intersection in *RESULT. Value is non-zero if RESULT is not
24528 x_intersect_rectangles (r1
, r2
, result
)
24529 XRectangle
*r1
, *r2
, *result
;
24531 XRectangle
*left
, *right
;
24532 XRectangle
*upper
, *lower
;
24533 int intersection_p
= 0;
24535 /* Rearrange so that R1 is the left-most rectangle. */
24537 left
= r1
, right
= r2
;
24539 left
= r2
, right
= r1
;
24541 /* X0 of the intersection is right.x0, if this is inside R1,
24542 otherwise there is no intersection. */
24543 if (right
->x
<= left
->x
+ left
->width
)
24545 result
->x
= right
->x
;
24547 /* The right end of the intersection is the minimum of the
24548 the right ends of left and right. */
24549 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
24552 /* Same game for Y. */
24554 upper
= r1
, lower
= r2
;
24556 upper
= r2
, lower
= r1
;
24558 /* The upper end of the intersection is lower.y0, if this is inside
24559 of upper. Otherwise, there is no intersection. */
24560 if (lower
->y
<= upper
->y
+ upper
->height
)
24562 result
->y
= lower
->y
;
24564 /* The lower end of the intersection is the minimum of the lower
24565 ends of upper and lower. */
24566 result
->height
= (min (lower
->y
+ lower
->height
,
24567 upper
->y
+ upper
->height
)
24569 intersection_p
= 1;
24573 return intersection_p
;
24576 #endif /* HAVE_WINDOW_SYSTEM */
24579 /***********************************************************************
24581 ***********************************************************************/
24586 Vwith_echo_area_save_vector
= Qnil
;
24587 staticpro (&Vwith_echo_area_save_vector
);
24589 Vmessage_stack
= Qnil
;
24590 staticpro (&Vmessage_stack
);
24592 Qinhibit_redisplay
= intern_c_string ("inhibit-redisplay");
24593 staticpro (&Qinhibit_redisplay
);
24595 message_dolog_marker1
= Fmake_marker ();
24596 staticpro (&message_dolog_marker1
);
24597 message_dolog_marker2
= Fmake_marker ();
24598 staticpro (&message_dolog_marker2
);
24599 message_dolog_marker3
= Fmake_marker ();
24600 staticpro (&message_dolog_marker3
);
24603 defsubr (&Sdump_frame_glyph_matrix
);
24604 defsubr (&Sdump_glyph_matrix
);
24605 defsubr (&Sdump_glyph_row
);
24606 defsubr (&Sdump_tool_bar_row
);
24607 defsubr (&Strace_redisplay
);
24608 defsubr (&Strace_to_stderr
);
24610 #ifdef HAVE_WINDOW_SYSTEM
24611 defsubr (&Stool_bar_lines_needed
);
24612 defsubr (&Slookup_image_map
);
24614 defsubr (&Sformat_mode_line
);
24615 defsubr (&Sinvisible_p
);
24617 staticpro (&Qmenu_bar_update_hook
);
24618 Qmenu_bar_update_hook
= intern_c_string ("menu-bar-update-hook");
24620 staticpro (&Qoverriding_terminal_local_map
);
24621 Qoverriding_terminal_local_map
= intern_c_string ("overriding-terminal-local-map");
24623 staticpro (&Qoverriding_local_map
);
24624 Qoverriding_local_map
= intern_c_string ("overriding-local-map");
24626 staticpro (&Qwindow_scroll_functions
);
24627 Qwindow_scroll_functions
= intern_c_string ("window-scroll-functions");
24629 staticpro (&Qwindow_text_change_functions
);
24630 Qwindow_text_change_functions
= intern_c_string ("window-text-change-functions");
24632 staticpro (&Qredisplay_end_trigger_functions
);
24633 Qredisplay_end_trigger_functions
= intern_c_string ("redisplay-end-trigger-functions");
24635 staticpro (&Qinhibit_point_motion_hooks
);
24636 Qinhibit_point_motion_hooks
= intern_c_string ("inhibit-point-motion-hooks");
24638 Qeval
= intern_c_string ("eval");
24639 staticpro (&Qeval
);
24641 QCdata
= intern_c_string (":data");
24642 staticpro (&QCdata
);
24643 Qdisplay
= intern_c_string ("display");
24644 staticpro (&Qdisplay
);
24645 Qspace_width
= intern_c_string ("space-width");
24646 staticpro (&Qspace_width
);
24647 Qraise
= intern_c_string ("raise");
24648 staticpro (&Qraise
);
24649 Qslice
= intern_c_string ("slice");
24650 staticpro (&Qslice
);
24651 Qspace
= intern_c_string ("space");
24652 staticpro (&Qspace
);
24653 Qmargin
= intern_c_string ("margin");
24654 staticpro (&Qmargin
);
24655 Qpointer
= intern_c_string ("pointer");
24656 staticpro (&Qpointer
);
24657 Qleft_margin
= intern_c_string ("left-margin");
24658 staticpro (&Qleft_margin
);
24659 Qright_margin
= intern_c_string ("right-margin");
24660 staticpro (&Qright_margin
);
24661 Qcenter
= intern_c_string ("center");
24662 staticpro (&Qcenter
);
24663 Qline_height
= intern_c_string ("line-height");
24664 staticpro (&Qline_height
);
24665 QCalign_to
= intern_c_string (":align-to");
24666 staticpro (&QCalign_to
);
24667 QCrelative_width
= intern_c_string (":relative-width");
24668 staticpro (&QCrelative_width
);
24669 QCrelative_height
= intern_c_string (":relative-height");
24670 staticpro (&QCrelative_height
);
24671 QCeval
= intern_c_string (":eval");
24672 staticpro (&QCeval
);
24673 QCpropertize
= intern_c_string (":propertize");
24674 staticpro (&QCpropertize
);
24675 QCfile
= intern_c_string (":file");
24676 staticpro (&QCfile
);
24677 Qfontified
= intern_c_string ("fontified");
24678 staticpro (&Qfontified
);
24679 Qfontification_functions
= intern_c_string ("fontification-functions");
24680 staticpro (&Qfontification_functions
);
24681 Qtrailing_whitespace
= intern_c_string ("trailing-whitespace");
24682 staticpro (&Qtrailing_whitespace
);
24683 Qescape_glyph
= intern_c_string ("escape-glyph");
24684 staticpro (&Qescape_glyph
);
24685 Qnobreak_space
= intern_c_string ("nobreak-space");
24686 staticpro (&Qnobreak_space
);
24687 Qimage
= intern_c_string ("image");
24688 staticpro (&Qimage
);
24689 QCmap
= intern_c_string (":map");
24690 staticpro (&QCmap
);
24691 QCpointer
= intern_c_string (":pointer");
24692 staticpro (&QCpointer
);
24693 Qrect
= intern_c_string ("rect");
24694 staticpro (&Qrect
);
24695 Qcircle
= intern_c_string ("circle");
24696 staticpro (&Qcircle
);
24697 Qpoly
= intern_c_string ("poly");
24698 staticpro (&Qpoly
);
24699 Qmessage_truncate_lines
= intern_c_string ("message-truncate-lines");
24700 staticpro (&Qmessage_truncate_lines
);
24701 Qgrow_only
= intern_c_string ("grow-only");
24702 staticpro (&Qgrow_only
);
24703 Qinhibit_menubar_update
= intern_c_string ("inhibit-menubar-update");
24704 staticpro (&Qinhibit_menubar_update
);
24705 Qinhibit_eval_during_redisplay
= intern_c_string ("inhibit-eval-during-redisplay");
24706 staticpro (&Qinhibit_eval_during_redisplay
);
24707 Qposition
= intern_c_string ("position");
24708 staticpro (&Qposition
);
24709 Qbuffer_position
= intern_c_string ("buffer-position");
24710 staticpro (&Qbuffer_position
);
24711 Qobject
= intern_c_string ("object");
24712 staticpro (&Qobject
);
24713 Qbar
= intern_c_string ("bar");
24715 Qhbar
= intern_c_string ("hbar");
24716 staticpro (&Qhbar
);
24717 Qbox
= intern_c_string ("box");
24719 Qhollow
= intern_c_string ("hollow");
24720 staticpro (&Qhollow
);
24721 Qhand
= intern_c_string ("hand");
24722 staticpro (&Qhand
);
24723 Qarrow
= intern_c_string ("arrow");
24724 staticpro (&Qarrow
);
24725 Qtext
= intern_c_string ("text");
24726 staticpro (&Qtext
);
24727 Qrisky_local_variable
= intern_c_string ("risky-local-variable");
24728 staticpro (&Qrisky_local_variable
);
24729 Qinhibit_free_realized_faces
= intern_c_string ("inhibit-free-realized-faces");
24730 staticpro (&Qinhibit_free_realized_faces
);
24732 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
24733 Fcons (intern_c_string ("void-variable"), Qnil
)),
24735 staticpro (&list_of_error
);
24737 Qlast_arrow_position
= intern_c_string ("last-arrow-position");
24738 staticpro (&Qlast_arrow_position
);
24739 Qlast_arrow_string
= intern_c_string ("last-arrow-string");
24740 staticpro (&Qlast_arrow_string
);
24742 Qoverlay_arrow_string
= intern_c_string ("overlay-arrow-string");
24743 staticpro (&Qoverlay_arrow_string
);
24744 Qoverlay_arrow_bitmap
= intern_c_string ("overlay-arrow-bitmap");
24745 staticpro (&Qoverlay_arrow_bitmap
);
24747 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
24748 staticpro (&echo_buffer
[0]);
24749 staticpro (&echo_buffer
[1]);
24751 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
24752 staticpro (&echo_area_buffer
[0]);
24753 staticpro (&echo_area_buffer
[1]);
24755 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
24756 staticpro (&Vmessages_buffer_name
);
24758 mode_line_proptrans_alist
= Qnil
;
24759 staticpro (&mode_line_proptrans_alist
);
24760 mode_line_string_list
= Qnil
;
24761 staticpro (&mode_line_string_list
);
24762 mode_line_string_face
= Qnil
;
24763 staticpro (&mode_line_string_face
);
24764 mode_line_string_face_prop
= Qnil
;
24765 staticpro (&mode_line_string_face_prop
);
24766 Vmode_line_unwind_vector
= Qnil
;
24767 staticpro (&Vmode_line_unwind_vector
);
24769 help_echo_string
= Qnil
;
24770 staticpro (&help_echo_string
);
24771 help_echo_object
= Qnil
;
24772 staticpro (&help_echo_object
);
24773 help_echo_window
= Qnil
;
24774 staticpro (&help_echo_window
);
24775 previous_help_echo_string
= Qnil
;
24776 staticpro (&previous_help_echo_string
);
24777 help_echo_pos
= -1;
24779 #ifdef HAVE_WINDOW_SYSTEM
24780 DEFVAR_BOOL ("x-stretch-cursor", &x_stretch_cursor_p
,
24781 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
24782 For example, if a block cursor is over a tab, it will be drawn as
24783 wide as that tab on the display. */);
24784 x_stretch_cursor_p
= 0;
24787 DEFVAR_LISP ("show-trailing-whitespace", &Vshow_trailing_whitespace
,
24788 doc
: /* *Non-nil means highlight trailing whitespace.
24789 The face used for trailing whitespace is `trailing-whitespace'. */);
24790 Vshow_trailing_whitespace
= Qnil
;
24792 DEFVAR_LISP ("nobreak-char-display", &Vnobreak_char_display
,
24793 doc
: /* *Control highlighting of nobreak space and soft hyphen.
24794 A value of t means highlight the character itself (for nobreak space,
24795 use face `nobreak-space').
24796 A value of nil means no highlighting.
24797 Other values mean display the escape glyph followed by an ordinary
24798 space or ordinary hyphen. */);
24799 Vnobreak_char_display
= Qt
;
24801 DEFVAR_LISP ("void-text-area-pointer", &Vvoid_text_area_pointer
,
24802 doc
: /* *The pointer shape to show in void text areas.
24803 A value of nil means to show the text pointer. Other options are `arrow',
24804 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
24805 Vvoid_text_area_pointer
= Qarrow
;
24807 DEFVAR_LISP ("inhibit-redisplay", &Vinhibit_redisplay
,
24808 doc
: /* Non-nil means don't actually do any redisplay.
24809 This is used for internal purposes. */);
24810 Vinhibit_redisplay
= Qnil
;
24812 DEFVAR_LISP ("global-mode-string", &Vglobal_mode_string
,
24813 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
24814 Vglobal_mode_string
= Qnil
;
24816 DEFVAR_LISP ("overlay-arrow-position", &Voverlay_arrow_position
,
24817 doc
: /* Marker for where to display an arrow on top of the buffer text.
24818 This must be the beginning of a line in order to work.
24819 See also `overlay-arrow-string'. */);
24820 Voverlay_arrow_position
= Qnil
;
24822 DEFVAR_LISP ("overlay-arrow-string", &Voverlay_arrow_string
,
24823 doc
: /* String to display as an arrow in non-window frames.
24824 See also `overlay-arrow-position'. */);
24825 Voverlay_arrow_string
= make_pure_c_string ("=>");
24827 DEFVAR_LISP ("overlay-arrow-variable-list", &Voverlay_arrow_variable_list
,
24828 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
24829 The symbols on this list are examined during redisplay to determine
24830 where to display overlay arrows. */);
24831 Voverlay_arrow_variable_list
24832 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
24834 DEFVAR_INT ("scroll-step", &scroll_step
,
24835 doc
: /* *The number of lines to try scrolling a window by when point moves out.
24836 If that fails to bring point back on frame, point is centered instead.
24837 If this is zero, point is always centered after it moves off frame.
24838 If you want scrolling to always be a line at a time, you should set
24839 `scroll-conservatively' to a large value rather than set this to 1. */);
24841 DEFVAR_INT ("scroll-conservatively", &scroll_conservatively
,
24842 doc
: /* *Scroll up to this many lines, to bring point back on screen.
24843 If point moves off-screen, redisplay will scroll by up to
24844 `scroll-conservatively' lines in order to bring point just barely
24845 onto the screen again. If that cannot be done, then redisplay
24846 recenters point as usual.
24848 A value of zero means always recenter point if it moves off screen. */);
24849 scroll_conservatively
= 0;
24851 DEFVAR_INT ("scroll-margin", &scroll_margin
,
24852 doc
: /* *Number of lines of margin at the top and bottom of a window.
24853 Recenter the window whenever point gets within this many lines
24854 of the top or bottom of the window. */);
24857 DEFVAR_LISP ("display-pixels-per-inch", &Vdisplay_pixels_per_inch
,
24858 doc
: /* Pixels per inch value for non-window system displays.
24859 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
24860 Vdisplay_pixels_per_inch
= make_float (72.0);
24863 DEFVAR_INT ("debug-end-pos", &debug_end_pos
, doc
: /* Don't ask. */);
24866 DEFVAR_LISP ("truncate-partial-width-windows",
24867 &Vtruncate_partial_width_windows
,
24868 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
24869 For an integer value, truncate lines in each window narrower than the
24870 full frame width, provided the window width is less than that integer;
24871 otherwise, respect the value of `truncate-lines'.
24873 For any other non-nil value, truncate lines in all windows that do
24874 not span the full frame width.
24876 A value of nil means to respect the value of `truncate-lines'.
24878 If `word-wrap' is enabled, you might want to reduce this. */);
24879 Vtruncate_partial_width_windows
= make_number (50);
24881 DEFVAR_BOOL ("mode-line-inverse-video", &mode_line_inverse_video
,
24882 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
24883 Any other value means to use the appropriate face, `mode-line',
24884 `header-line', or `menu' respectively. */);
24885 mode_line_inverse_video
= 1;
24887 DEFVAR_LISP ("line-number-display-limit", &Vline_number_display_limit
,
24888 doc
: /* *Maximum buffer size for which line number should be displayed.
24889 If the buffer is bigger than this, the line number does not appear
24890 in the mode line. A value of nil means no limit. */);
24891 Vline_number_display_limit
= Qnil
;
24893 DEFVAR_INT ("line-number-display-limit-width",
24894 &line_number_display_limit_width
,
24895 doc
: /* *Maximum line width (in characters) for line number display.
24896 If the average length of the lines near point is bigger than this, then the
24897 line number may be omitted from the mode line. */);
24898 line_number_display_limit_width
= 200;
24900 DEFVAR_BOOL ("highlight-nonselected-windows", &highlight_nonselected_windows
,
24901 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
24902 highlight_nonselected_windows
= 0;
24904 DEFVAR_BOOL ("multiple-frames", &multiple_frames
,
24905 doc
: /* Non-nil if more than one frame is visible on this display.
24906 Minibuffer-only frames don't count, but iconified frames do.
24907 This variable is not guaranteed to be accurate except while processing
24908 `frame-title-format' and `icon-title-format'. */);
24910 DEFVAR_LISP ("frame-title-format", &Vframe_title_format
,
24911 doc
: /* Template for displaying the title bar of visible frames.
24912 \(Assuming the window manager supports this feature.)
24914 This variable has the same structure as `mode-line-format', except that
24915 the %c and %l constructs are ignored. It is used only on frames for
24916 which no explicit name has been set \(see `modify-frame-parameters'). */);
24918 DEFVAR_LISP ("icon-title-format", &Vicon_title_format
,
24919 doc
: /* Template for displaying the title bar of an iconified frame.
24920 \(Assuming the window manager supports this feature.)
24921 This variable has the same structure as `mode-line-format' (which see),
24922 and is used only on frames for which no explicit name has been set
24923 \(see `modify-frame-parameters'). */);
24925 = Vframe_title_format
24926 = pure_cons (intern_c_string ("multiple-frames"),
24927 pure_cons (make_pure_c_string ("%b"),
24928 pure_cons (pure_cons (empty_unibyte_string
,
24929 pure_cons (intern_c_string ("invocation-name"),
24930 pure_cons (make_pure_c_string ("@"),
24931 pure_cons (intern_c_string ("system-name"),
24935 DEFVAR_LISP ("message-log-max", &Vmessage_log_max
,
24936 doc
: /* Maximum number of lines to keep in the message log buffer.
24937 If nil, disable message logging. If t, log messages but don't truncate
24938 the buffer when it becomes large. */);
24939 Vmessage_log_max
= make_number (100);
24941 DEFVAR_LISP ("window-size-change-functions", &Vwindow_size_change_functions
,
24942 doc
: /* Functions called before redisplay, if window sizes have changed.
24943 The value should be a list of functions that take one argument.
24944 Just before redisplay, for each frame, if any of its windows have changed
24945 size since the last redisplay, or have been split or deleted,
24946 all the functions in the list are called, with the frame as argument. */);
24947 Vwindow_size_change_functions
= Qnil
;
24949 DEFVAR_LISP ("window-scroll-functions", &Vwindow_scroll_functions
,
24950 doc
: /* List of functions to call before redisplaying a window with scrolling.
24951 Each function is called with two arguments, the window and its new
24952 display-start position. Note that these functions are also called by
24953 `set-window-buffer'. Also note that the value of `window-end' is not
24954 valid when these functions are called. */);
24955 Vwindow_scroll_functions
= Qnil
;
24957 DEFVAR_LISP ("window-text-change-functions",
24958 &Vwindow_text_change_functions
,
24959 doc
: /* Functions to call in redisplay when text in the window might change. */);
24960 Vwindow_text_change_functions
= Qnil
;
24962 DEFVAR_LISP ("redisplay-end-trigger-functions", &Vredisplay_end_trigger_functions
,
24963 doc
: /* Functions called when redisplay of a window reaches the end trigger.
24964 Each function is called with two arguments, the window and the end trigger value.
24965 See `set-window-redisplay-end-trigger'. */);
24966 Vredisplay_end_trigger_functions
= Qnil
;
24968 DEFVAR_LISP ("mouse-autoselect-window", &Vmouse_autoselect_window
,
24969 doc
: /* *Non-nil means autoselect window with mouse pointer.
24970 If nil, do not autoselect windows.
24971 A positive number means delay autoselection by that many seconds: a
24972 window is autoselected only after the mouse has remained in that
24973 window for the duration of the delay.
24974 A negative number has a similar effect, but causes windows to be
24975 autoselected only after the mouse has stopped moving. \(Because of
24976 the way Emacs compares mouse events, you will occasionally wait twice
24977 that time before the window gets selected.\)
24978 Any other value means to autoselect window instantaneously when the
24979 mouse pointer enters it.
24981 Autoselection selects the minibuffer only if it is active, and never
24982 unselects the minibuffer if it is active.
24984 When customizing this variable make sure that the actual value of
24985 `focus-follows-mouse' matches the behavior of your window manager. */);
24986 Vmouse_autoselect_window
= Qnil
;
24988 DEFVAR_LISP ("auto-resize-tool-bars", &Vauto_resize_tool_bars
,
24989 doc
: /* *Non-nil means automatically resize tool-bars.
24990 This dynamically changes the tool-bar's height to the minimum height
24991 that is needed to make all tool-bar items visible.
24992 If value is `grow-only', the tool-bar's height is only increased
24993 automatically; to decrease the tool-bar height, use \\[recenter]. */);
24994 Vauto_resize_tool_bars
= Qt
;
24996 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", &auto_raise_tool_bar_buttons_p
,
24997 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
24998 auto_raise_tool_bar_buttons_p
= 1;
25000 DEFVAR_BOOL ("make-cursor-line-fully-visible", &make_cursor_line_fully_visible_p
,
25001 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
25002 make_cursor_line_fully_visible_p
= 1;
25004 DEFVAR_LISP ("tool-bar-border", &Vtool_bar_border
,
25005 doc
: /* *Border below tool-bar in pixels.
25006 If an integer, use it as the height of the border.
25007 If it is one of `internal-border-width' or `border-width', use the
25008 value of the corresponding frame parameter.
25009 Otherwise, no border is added below the tool-bar. */);
25010 Vtool_bar_border
= Qinternal_border_width
;
25012 DEFVAR_LISP ("tool-bar-button-margin", &Vtool_bar_button_margin
,
25013 doc
: /* *Margin around tool-bar buttons in pixels.
25014 If an integer, use that for both horizontal and vertical margins.
25015 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
25016 HORZ specifying the horizontal margin, and VERT specifying the
25017 vertical margin. */);
25018 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
25020 DEFVAR_INT ("tool-bar-button-relief", &tool_bar_button_relief
,
25021 doc
: /* *Relief thickness of tool-bar buttons. */);
25022 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
25024 DEFVAR_LISP ("fontification-functions", &Vfontification_functions
,
25025 doc
: /* List of functions to call to fontify regions of text.
25026 Each function is called with one argument POS. Functions must
25027 fontify a region starting at POS in the current buffer, and give
25028 fontified regions the property `fontified'. */);
25029 Vfontification_functions
= Qnil
;
25030 Fmake_variable_buffer_local (Qfontification_functions
);
25032 DEFVAR_BOOL ("unibyte-display-via-language-environment",
25033 &unibyte_display_via_language_environment
,
25034 doc
: /* *Non-nil means display unibyte text according to language environment.
25035 Specifically, this means that raw bytes in the range 160-255 decimal
25036 are displayed by converting them to the equivalent multibyte characters
25037 according to the current language environment. As a result, they are
25038 displayed according to the current fontset.
25040 Note that this variable affects only how these bytes are displayed,
25041 but does not change the fact they are interpreted as raw bytes. */);
25042 unibyte_display_via_language_environment
= 0;
25044 DEFVAR_LISP ("max-mini-window-height", &Vmax_mini_window_height
,
25045 doc
: /* *Maximum height for resizing mini-windows.
25046 If a float, it specifies a fraction of the mini-window frame's height.
25047 If an integer, it specifies a number of lines. */);
25048 Vmax_mini_window_height
= make_float (0.25);
25050 DEFVAR_LISP ("resize-mini-windows", &Vresize_mini_windows
,
25051 doc
: /* *How to resize mini-windows.
25052 A value of nil means don't automatically resize mini-windows.
25053 A value of t means resize them to fit the text displayed in them.
25054 A value of `grow-only', the default, means let mini-windows grow
25055 only, until their display becomes empty, at which point the windows
25056 go back to their normal size. */);
25057 Vresize_mini_windows
= Qgrow_only
;
25059 DEFVAR_LISP ("blink-cursor-alist", &Vblink_cursor_alist
,
25060 doc
: /* Alist specifying how to blink the cursor off.
25061 Each element has the form (ON-STATE . OFF-STATE). Whenever the
25062 `cursor-type' frame-parameter or variable equals ON-STATE,
25063 comparing using `equal', Emacs uses OFF-STATE to specify
25064 how to blink it off. ON-STATE and OFF-STATE are values for
25065 the `cursor-type' frame parameter.
25067 If a frame's ON-STATE has no entry in this list,
25068 the frame's other specifications determine how to blink the cursor off. */);
25069 Vblink_cursor_alist
= Qnil
;
25071 DEFVAR_BOOL ("auto-hscroll-mode", &automatic_hscrolling_p
,
25072 doc
: /* *Non-nil means scroll the display automatically to make point visible. */);
25073 automatic_hscrolling_p
= 1;
25074 Qauto_hscroll_mode
= intern_c_string ("auto-hscroll-mode");
25075 staticpro (&Qauto_hscroll_mode
);
25077 DEFVAR_INT ("hscroll-margin", &hscroll_margin
,
25078 doc
: /* *How many columns away from the window edge point is allowed to get
25079 before automatic hscrolling will horizontally scroll the window. */);
25080 hscroll_margin
= 5;
25082 DEFVAR_LISP ("hscroll-step", &Vhscroll_step
,
25083 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
25084 When point is less than `hscroll-margin' columns from the window
25085 edge, automatic hscrolling will scroll the window by the amount of columns
25086 determined by this variable. If its value is a positive integer, scroll that
25087 many columns. If it's a positive floating-point number, it specifies the
25088 fraction of the window's width to scroll. If it's nil or zero, point will be
25089 centered horizontally after the scroll. Any other value, including negative
25090 numbers, are treated as if the value were zero.
25092 Automatic hscrolling always moves point outside the scroll margin, so if
25093 point was more than scroll step columns inside the margin, the window will
25094 scroll more than the value given by the scroll step.
25096 Note that the lower bound for automatic hscrolling specified by `scroll-left'
25097 and `scroll-right' overrides this variable's effect. */);
25098 Vhscroll_step
= make_number (0);
25100 DEFVAR_BOOL ("message-truncate-lines", &message_truncate_lines
,
25101 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
25102 Bind this around calls to `message' to let it take effect. */);
25103 message_truncate_lines
= 0;
25105 DEFVAR_LISP ("menu-bar-update-hook", &Vmenu_bar_update_hook
,
25106 doc
: /* Normal hook run to update the menu bar definitions.
25107 Redisplay runs this hook before it redisplays the menu bar.
25108 This is used to update submenus such as Buffers,
25109 whose contents depend on various data. */);
25110 Vmenu_bar_update_hook
= Qnil
;
25112 DEFVAR_LISP ("menu-updating-frame", &Vmenu_updating_frame
,
25113 doc
: /* Frame for which we are updating a menu.
25114 The enable predicate for a menu binding should check this variable. */);
25115 Vmenu_updating_frame
= Qnil
;
25117 DEFVAR_BOOL ("inhibit-menubar-update", &inhibit_menubar_update
,
25118 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
25119 inhibit_menubar_update
= 0;
25121 DEFVAR_LISP ("wrap-prefix", &Vwrap_prefix
,
25122 doc
: /* Prefix prepended to all continuation lines at display time.
25123 The value may be a string, an image, or a stretch-glyph; it is
25124 interpreted in the same way as the value of a `display' text property.
25126 This variable is overridden by any `wrap-prefix' text or overlay
25129 To add a prefix to non-continuation lines, use `line-prefix'. */);
25130 Vwrap_prefix
= Qnil
;
25131 staticpro (&Qwrap_prefix
);
25132 Qwrap_prefix
= intern_c_string ("wrap-prefix");
25133 Fmake_variable_buffer_local (Qwrap_prefix
);
25135 DEFVAR_LISP ("line-prefix", &Vline_prefix
,
25136 doc
: /* Prefix prepended to all non-continuation lines at display time.
25137 The value may be a string, an image, or a stretch-glyph; it is
25138 interpreted in the same way as the value of a `display' text property.
25140 This variable is overridden by any `line-prefix' text or overlay
25143 To add a prefix to continuation lines, use `wrap-prefix'. */);
25144 Vline_prefix
= Qnil
;
25145 staticpro (&Qline_prefix
);
25146 Qline_prefix
= intern_c_string ("line-prefix");
25147 Fmake_variable_buffer_local (Qline_prefix
);
25149 DEFVAR_BOOL ("inhibit-eval-during-redisplay", &inhibit_eval_during_redisplay
,
25150 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
25151 inhibit_eval_during_redisplay
= 0;
25153 DEFVAR_BOOL ("inhibit-free-realized-faces", &inhibit_free_realized_faces
,
25154 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
25155 inhibit_free_realized_faces
= 0;
25158 DEFVAR_BOOL ("inhibit-try-window-id", &inhibit_try_window_id
,
25159 doc
: /* Inhibit try_window_id display optimization. */);
25160 inhibit_try_window_id
= 0;
25162 DEFVAR_BOOL ("inhibit-try-window-reusing", &inhibit_try_window_reusing
,
25163 doc
: /* Inhibit try_window_reusing display optimization. */);
25164 inhibit_try_window_reusing
= 0;
25166 DEFVAR_BOOL ("inhibit-try-cursor-movement", &inhibit_try_cursor_movement
,
25167 doc
: /* Inhibit try_cursor_movement display optimization. */);
25168 inhibit_try_cursor_movement
= 0;
25169 #endif /* GLYPH_DEBUG */
25171 DEFVAR_INT ("overline-margin", &overline_margin
,
25172 doc
: /* *Space between overline and text, in pixels.
25173 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
25174 margin to the caracter height. */);
25175 overline_margin
= 2;
25177 DEFVAR_INT ("underline-minimum-offset",
25178 &underline_minimum_offset
,
25179 doc
: /* Minimum distance between baseline and underline.
25180 This can improve legibility of underlined text at small font sizes,
25181 particularly when using variable `x-use-underline-position-properties'
25182 with fonts that specify an UNDERLINE_POSITION relatively close to the
25183 baseline. The default value is 1. */);
25184 underline_minimum_offset
= 1;
25186 DEFVAR_BOOL ("display-hourglass", &display_hourglass_p
,
25187 doc
: /* Non-zero means Emacs displays an hourglass pointer on window systems. */);
25188 display_hourglass_p
= 1;
25190 DEFVAR_LISP ("hourglass-delay", &Vhourglass_delay
,
25191 doc
: /* *Seconds to wait before displaying an hourglass pointer.
25192 Value must be an integer or float. */);
25193 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
25195 hourglass_atimer
= NULL
;
25196 hourglass_shown_p
= 0;
25200 /* Initialize this module when Emacs starts. */
25205 Lisp_Object root_window
;
25206 struct window
*mini_w
;
25208 current_header_line_height
= current_mode_line_height
= -1;
25210 CHARPOS (this_line_start_pos
) = 0;
25212 mini_w
= XWINDOW (minibuf_window
);
25213 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
25215 if (!noninteractive
)
25217 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
25220 XWINDOW (root_window
)->top_line
= make_number (FRAME_TOP_MARGIN (f
));
25221 set_window_height (root_window
,
25222 FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
),
25224 mini_w
->top_line
= make_number (FRAME_LINES (f
) - 1);
25225 set_window_height (minibuf_window
, 1, 0);
25227 XWINDOW (root_window
)->total_cols
= make_number (FRAME_COLS (f
));
25228 mini_w
->total_cols
= make_number (FRAME_COLS (f
));
25230 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
25231 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
25232 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
25234 /* The default ellipsis glyphs `...'. */
25235 for (i
= 0; i
< 3; ++i
)
25236 default_invis_vector
[i
] = make_number ('.');
25240 /* Allocate the buffer for frame titles.
25241 Also used for `format-mode-line'. */
25243 mode_line_noprop_buf
= (char *) xmalloc (size
);
25244 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
25245 mode_line_noprop_ptr
= mode_line_noprop_buf
;
25246 mode_line_target
= MODE_LINE_DISPLAY
;
25249 help_echo_showing_p
= 0;
25252 /* Since w32 does not support atimers, it defines its own implementation of
25253 the following three functions in w32fns.c. */
25256 /* Platform-independent portion of hourglass implementation. */
25258 /* Return non-zero if houglass timer has been started or hourglass is shown. */
25260 hourglass_started ()
25262 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
25265 /* Cancel a currently active hourglass timer, and start a new one. */
25269 #if defined (HAVE_WINDOW_SYSTEM)
25271 int secs
, usecs
= 0;
25273 cancel_hourglass ();
25275 if (INTEGERP (Vhourglass_delay
)
25276 && XINT (Vhourglass_delay
) > 0)
25277 secs
= XFASTINT (Vhourglass_delay
);
25278 else if (FLOATP (Vhourglass_delay
)
25279 && XFLOAT_DATA (Vhourglass_delay
) > 0)
25282 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
25283 secs
= XFASTINT (tem
);
25284 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
25287 secs
= DEFAULT_HOURGLASS_DELAY
;
25289 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
25290 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
25291 show_hourglass
, NULL
);
25296 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
25299 cancel_hourglass ()
25301 #if defined (HAVE_WINDOW_SYSTEM)
25302 if (hourglass_atimer
)
25304 cancel_atimer (hourglass_atimer
);
25305 hourglass_atimer
= NULL
;
25308 if (hourglass_shown_p
)
25312 #endif /* ! WINDOWSNT */
25314 /* arch-tag: eacc864d-bb6a-4b74-894a-1a4399a1358b
25315 (do not change this comment) */