1 /* Display generation from window structure and buffer text.
2 Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995,
3 1997, 1998, 1999, 2000, 2001, 2002, 2003,
4 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
21 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>.
25 Emacs separates the task of updating the display from code
26 modifying global state, e.g. buffer text. This way functions
27 operating on buffers don't also have to be concerned with updating
30 Updating the display is triggered by the Lisp interpreter when it
31 decides it's time to do it. This is done either automatically for
32 you as part of the interpreter's command loop or as the result of
33 calling Lisp functions like `sit-for'. The C function `redisplay'
34 in xdisp.c is the only entry into the inner redisplay code. (Or,
35 let's say almost---see the description of direct update
38 The following diagram shows how redisplay code is invoked. As you
39 can see, Lisp calls redisplay and vice versa. Under window systems
40 like X, some portions of the redisplay code are also called
41 asynchronously during mouse movement or expose events. It is very
42 important that these code parts do NOT use the C library (malloc,
43 free) because many C libraries under Unix are not reentrant. They
44 may also NOT call functions of the Lisp interpreter which could
45 change the interpreter's state. If you don't follow these rules,
46 you will encounter bugs which are very hard to explain.
48 (Direct functions, see below)
49 direct_output_for_insert,
50 direct_forward_char (dispnew.c)
51 +---------------------------------+
54 +--------------+ redisplay +----------------+
55 | Lisp machine |---------------->| Redisplay code |<--+
56 +--------------+ (xdisp.c) +----------------+ |
58 +----------------------------------+ |
59 Don't use this path when called |
62 expose_window (asynchronous) |
64 X expose events -----+
66 What does redisplay do? Obviously, it has to figure out somehow what
67 has been changed since the last time the display has been updated,
68 and to make these changes visible. Preferably it would do that in
69 a moderately intelligent way, i.e. fast.
71 Changes in buffer text can be deduced from window and buffer
72 structures, and from some global variables like `beg_unchanged' and
73 `end_unchanged'. The contents of the display are additionally
74 recorded in a `glyph matrix', a two-dimensional matrix of glyph
75 structures. Each row in such a matrix corresponds to a line on the
76 display, and each glyph in a row corresponds to a column displaying
77 a character, an image, or what else. This matrix is called the
78 `current glyph matrix' or `current matrix' in redisplay
81 For buffer parts that have been changed since the last update, a
82 second glyph matrix is constructed, the so called `desired glyph
83 matrix' or short `desired matrix'. Current and desired matrix are
84 then compared to find a cheap way to update the display, e.g. by
85 reusing part of the display by scrolling lines.
90 You will find a lot of redisplay optimizations when you start
91 looking at the innards of redisplay. The overall goal of all these
92 optimizations is to make redisplay fast because it is done
95 Two optimizations are not found in xdisp.c. These are the direct
96 operations mentioned above. As the name suggests they follow a
97 different principle than the rest of redisplay. Instead of
98 building a desired matrix and then comparing it with the current
99 display, they perform their actions directly on the display and on
102 One direct operation updates the display after one character has
103 been entered. The other one moves the cursor by one position
104 forward or backward. You find these functions under the names
105 `direct_output_for_insert' and `direct_output_forward_char' in
111 Desired matrices are always built per Emacs window. The function
112 `display_line' is the central function to look at if you are
113 interested. It constructs one row in a desired matrix given an
114 iterator structure containing both a buffer position and a
115 description of the environment in which the text is to be
116 displayed. But this is too early, read on.
118 Characters and pixmaps displayed for a range of buffer text depend
119 on various settings of buffers and windows, on overlays and text
120 properties, on display tables, on selective display. The good news
121 is that all this hairy stuff is hidden behind a small set of
122 interface functions taking an iterator structure (struct it)
125 Iteration over things to be displayed is then simple. It is
126 started by initializing an iterator with a call to init_iterator.
127 Calls to get_next_display_element fill the iterator structure with
128 relevant information about the next thing to display. Calls to
129 set_iterator_to_next move the iterator to the next thing.
131 Besides this, an iterator also contains information about the
132 display environment in which glyphs for display elements are to be
133 produced. It has fields for the width and height of the display,
134 the information whether long lines are truncated or continued, a
135 current X and Y position, and lots of other stuff you can better
138 Glyphs in a desired matrix are normally constructed in a loop
139 calling get_next_display_element and then produce_glyphs. The call
140 to produce_glyphs will fill the iterator structure with pixel
141 information about the element being displayed and at the same time
142 produce glyphs for it. If the display element fits on the line
143 being displayed, set_iterator_to_next is called next, otherwise the
144 glyphs produced are discarded.
149 That just couldn't be all, could it? What about terminal types not
150 supporting operations on sub-windows of the screen? To update the
151 display on such a terminal, window-based glyph matrices are not
152 well suited. To be able to reuse part of the display (scrolling
153 lines up and down), we must instead have a view of the whole
154 screen. This is what `frame matrices' are for. They are a trick.
156 Frames on terminals like above have a glyph pool. Windows on such
157 a frame sub-allocate their glyph memory from their frame's glyph
158 pool. The frame itself is given its own glyph matrices. By
159 coincidence---or maybe something else---rows in window glyph
160 matrices are slices of corresponding rows in frame matrices. Thus
161 writing to window matrices implicitly updates a frame matrix which
162 provides us with the view of the whole screen that we originally
163 wanted to have without having to move many bytes around. To be
164 honest, there is a little bit more done, but not much more. If you
165 plan to extend that code, take a look at dispnew.c. The function
166 build_frame_matrix is a good starting point. */
172 #include "keyboard.h"
175 #include "termchar.h"
176 #include "dispextern.h"
178 #include "character.h"
181 #include "commands.h"
185 #include "termhooks.h"
186 #include "intervals.h"
189 #include "region-cache.h"
191 #include "blockinput.h"
193 #ifdef HAVE_X_WINDOWS
208 #ifndef FRAME_X_OUTPUT
209 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
212 #define INFINITY 10000000
214 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
215 || defined(HAVE_NS) || defined (USE_GTK)
216 extern void set_frame_menubar
P_ ((struct frame
*f
, int, int));
217 extern int pending_menu_activation
;
220 extern int interrupt_input
;
221 extern int command_loop_level
;
223 extern Lisp_Object do_mouse_tracking
;
225 extern int minibuffer_auto_raise
;
226 extern Lisp_Object Vminibuffer_list
;
228 extern Lisp_Object Qface
;
229 extern Lisp_Object Qmode_line
, Qmode_line_inactive
, Qheader_line
;
231 extern Lisp_Object Voverriding_local_map
;
232 extern Lisp_Object Voverriding_local_map_menu_flag
;
233 extern Lisp_Object Qmenu_item
;
234 extern Lisp_Object Qwhen
;
235 extern Lisp_Object Qhelp_echo
;
237 Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
238 Lisp_Object Qwindow_scroll_functions
, Vwindow_scroll_functions
;
239 Lisp_Object Qwindow_text_change_functions
, Vwindow_text_change_functions
;
240 Lisp_Object Qredisplay_end_trigger_functions
, Vredisplay_end_trigger_functions
;
241 Lisp_Object Qinhibit_point_motion_hooks
;
242 Lisp_Object QCeval
, QCfile
, QCdata
, QCpropertize
;
243 Lisp_Object Qfontified
;
244 Lisp_Object Qgrow_only
;
245 Lisp_Object Qinhibit_eval_during_redisplay
;
246 Lisp_Object Qbuffer_position
, Qposition
, Qobject
;
249 Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
252 Lisp_Object Qarrow
, Qhand
, Qtext
;
254 Lisp_Object Qrisky_local_variable
;
256 /* Holds the list (error). */
257 Lisp_Object list_of_error
;
259 /* Functions called to fontify regions of text. */
261 Lisp_Object Vfontification_functions
;
262 Lisp_Object Qfontification_functions
;
264 /* Non-nil means automatically select any window when the mouse
265 cursor moves into it. */
266 Lisp_Object Vmouse_autoselect_window
;
268 Lisp_Object Vwrap_prefix
, Qwrap_prefix
;
269 Lisp_Object Vline_prefix
, Qline_prefix
;
271 /* Non-zero means draw tool bar buttons raised when the mouse moves
274 int auto_raise_tool_bar_buttons_p
;
276 /* Non-zero means to reposition window if cursor line is only partially visible. */
278 int make_cursor_line_fully_visible_p
;
280 /* Margin below tool bar in pixels. 0 or nil means no margin.
281 If value is `internal-border-width' or `border-width',
282 the corresponding frame parameter is used. */
284 Lisp_Object Vtool_bar_border
;
286 /* Margin around tool bar buttons in pixels. */
288 Lisp_Object Vtool_bar_button_margin
;
290 /* Thickness of shadow to draw around tool bar buttons. */
292 EMACS_INT tool_bar_button_relief
;
294 /* Non-nil means automatically resize tool-bars so that all tool-bar
295 items are visible, and no blank lines remain.
297 If value is `grow-only', only make tool-bar bigger. */
299 Lisp_Object Vauto_resize_tool_bars
;
301 /* Non-zero means draw block and hollow cursor as wide as the glyph
302 under it. For example, if a block cursor is over a tab, it will be
303 drawn as wide as that tab on the display. */
305 int x_stretch_cursor_p
;
307 /* Non-nil means don't actually do any redisplay. */
309 Lisp_Object Vinhibit_redisplay
, Qinhibit_redisplay
;
311 /* Non-zero means Lisp evaluation during redisplay is inhibited. */
313 int inhibit_eval_during_redisplay
;
315 /* Names of text properties relevant for redisplay. */
317 Lisp_Object Qdisplay
;
318 extern Lisp_Object Qface
, Qinvisible
, Qwidth
;
320 /* Symbols used in text property values. */
322 Lisp_Object Vdisplay_pixels_per_inch
;
323 Lisp_Object Qspace
, QCalign_to
, QCrelative_width
, QCrelative_height
;
324 Lisp_Object Qleft_margin
, Qright_margin
, Qspace_width
, Qraise
;
327 Lisp_Object Qmargin
, Qpointer
;
328 Lisp_Object Qline_height
;
329 extern Lisp_Object Qheight
;
330 extern Lisp_Object QCwidth
, QCheight
, QCascent
;
331 extern Lisp_Object Qscroll_bar
;
332 extern Lisp_Object Qcursor
;
334 /* Non-nil means highlight trailing whitespace. */
336 Lisp_Object Vshow_trailing_whitespace
;
338 /* Non-nil means escape non-break space and hyphens. */
340 Lisp_Object Vnobreak_char_display
;
342 #ifdef HAVE_WINDOW_SYSTEM
343 extern Lisp_Object Voverflow_newline_into_fringe
;
345 /* Test if overflow newline into fringe. Called with iterator IT
346 at or past right window margin, and with IT->current_x set. */
348 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) \
349 (!NILP (Voverflow_newline_into_fringe) \
350 && FRAME_WINDOW_P (it->f) \
351 && WINDOW_RIGHT_FRINGE_WIDTH (it->w) > 0 \
352 && it->current_x == it->last_visible_x \
353 && it->line_wrap != WORD_WRAP)
355 #endif /* HAVE_WINDOW_SYSTEM */
357 /* Test if the display element loaded in IT is a space or tab
358 character. This is used to determine word wrapping. */
360 #define IT_DISPLAYING_WHITESPACE(it) \
361 (it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t'))
363 /* Non-nil means show the text cursor in void text areas
364 i.e. in blank areas after eol and eob. This used to be
365 the default in 21.3. */
367 Lisp_Object Vvoid_text_area_pointer
;
369 /* Name of the face used to highlight trailing whitespace. */
371 Lisp_Object Qtrailing_whitespace
;
373 /* Name and number of the face used to highlight escape glyphs. */
375 Lisp_Object Qescape_glyph
;
377 /* Name and number of the face used to highlight non-breaking spaces. */
379 Lisp_Object Qnobreak_space
;
381 /* The symbol `image' which is the car of the lists used to represent
386 /* The image map types. */
387 Lisp_Object QCmap
, QCpointer
;
388 Lisp_Object Qrect
, Qcircle
, Qpoly
;
390 /* Non-zero means print newline to stdout before next mini-buffer
393 int noninteractive_need_newline
;
395 /* Non-zero means print newline to message log before next message. */
397 static int message_log_need_newline
;
399 /* Three markers that message_dolog uses.
400 It could allocate them itself, but that causes trouble
401 in handling memory-full errors. */
402 static Lisp_Object message_dolog_marker1
;
403 static Lisp_Object message_dolog_marker2
;
404 static Lisp_Object message_dolog_marker3
;
406 /* The buffer position of the first character appearing entirely or
407 partially on the line of the selected window which contains the
408 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
409 redisplay optimization in redisplay_internal. */
411 static struct text_pos this_line_start_pos
;
413 /* Number of characters past the end of the line above, including the
414 terminating newline. */
416 static struct text_pos this_line_end_pos
;
418 /* The vertical positions and the height of this line. */
420 static int this_line_vpos
;
421 static int this_line_y
;
422 static int this_line_pixel_height
;
424 /* X position at which this display line starts. Usually zero;
425 negative if first character is partially visible. */
427 static int this_line_start_x
;
429 /* Buffer that this_line_.* variables are referring to. */
431 static struct buffer
*this_line_buffer
;
433 /* Nonzero means truncate lines in all windows less wide than the
436 Lisp_Object Vtruncate_partial_width_windows
;
438 /* A flag to control how to display unibyte 8-bit character. */
440 int unibyte_display_via_language_environment
;
442 /* Nonzero means we have more than one non-mini-buffer-only frame.
443 Not guaranteed to be accurate except while parsing
444 frame-title-format. */
448 Lisp_Object Vglobal_mode_string
;
451 /* List of variables (symbols) which hold markers for overlay arrows.
452 The symbols on this list are examined during redisplay to determine
453 where to display overlay arrows. */
455 Lisp_Object Voverlay_arrow_variable_list
;
457 /* Marker for where to display an arrow on top of the buffer text. */
459 Lisp_Object Voverlay_arrow_position
;
461 /* String to display for the arrow. Only used on terminal frames. */
463 Lisp_Object Voverlay_arrow_string
;
465 /* Values of those variables at last redisplay are stored as
466 properties on `overlay-arrow-position' symbol. However, if
467 Voverlay_arrow_position is a marker, last-arrow-position is its
468 numerical position. */
470 Lisp_Object Qlast_arrow_position
, Qlast_arrow_string
;
472 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
473 properties on a symbol in overlay-arrow-variable-list. */
475 Lisp_Object Qoverlay_arrow_string
, Qoverlay_arrow_bitmap
;
477 /* Like mode-line-format, but for the title bar on a visible frame. */
479 Lisp_Object Vframe_title_format
;
481 /* Like mode-line-format, but for the title bar on an iconified frame. */
483 Lisp_Object Vicon_title_format
;
485 /* List of functions to call when a window's size changes. These
486 functions get one arg, a frame on which one or more windows' sizes
489 static Lisp_Object Vwindow_size_change_functions
;
491 Lisp_Object Qmenu_bar_update_hook
, Vmenu_bar_update_hook
;
493 /* Nonzero if an overlay arrow has been displayed in this window. */
495 static int overlay_arrow_seen
;
497 /* Nonzero means highlight the region even in nonselected windows. */
499 int highlight_nonselected_windows
;
501 /* If cursor motion alone moves point off frame, try scrolling this
502 many lines up or down if that will bring it back. */
504 static EMACS_INT scroll_step
;
506 /* Nonzero means scroll just far enough to bring point back on the
507 screen, when appropriate. */
509 static EMACS_INT scroll_conservatively
;
511 /* Recenter the window whenever point gets within this many lines of
512 the top or bottom of the window. This value is translated into a
513 pixel value by multiplying it with FRAME_LINE_HEIGHT, which means
514 that there is really a fixed pixel height scroll margin. */
516 EMACS_INT scroll_margin
;
518 /* Number of windows showing the buffer of the selected window (or
519 another buffer with the same base buffer). keyboard.c refers to
524 /* Vector containing glyphs for an ellipsis `...'. */
526 static Lisp_Object default_invis_vector
[3];
528 /* Zero means display the mode-line/header-line/menu-bar in the default face
529 (this slightly odd definition is for compatibility with previous versions
530 of emacs), non-zero means display them using their respective faces.
532 This variable is deprecated. */
534 int mode_line_inverse_video
;
536 /* Prompt to display in front of the mini-buffer contents. */
538 Lisp_Object minibuf_prompt
;
540 /* Width of current mini-buffer prompt. Only set after display_line
541 of the line that contains the prompt. */
543 int minibuf_prompt_width
;
545 /* This is the window where the echo area message was displayed. It
546 is always a mini-buffer window, but it may not be the same window
547 currently active as a mini-buffer. */
549 Lisp_Object echo_area_window
;
551 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
552 pushes the current message and the value of
553 message_enable_multibyte on the stack, the function restore_message
554 pops the stack and displays MESSAGE again. */
556 Lisp_Object Vmessage_stack
;
558 /* Nonzero means multibyte characters were enabled when the echo area
559 message was specified. */
561 int message_enable_multibyte
;
563 /* Nonzero if we should redraw the mode lines on the next redisplay. */
565 int update_mode_lines
;
567 /* Nonzero if window sizes or contents have changed since last
568 redisplay that finished. */
570 int windows_or_buffers_changed
;
572 /* Nonzero means a frame's cursor type has been changed. */
574 int cursor_type_changed
;
576 /* Nonzero after display_mode_line if %l was used and it displayed a
579 int line_number_displayed
;
581 /* Maximum buffer size for which to display line numbers. */
583 Lisp_Object Vline_number_display_limit
;
585 /* Line width to consider when repositioning for line number display. */
587 static EMACS_INT line_number_display_limit_width
;
589 /* Number of lines to keep in the message log buffer. t means
590 infinite. nil means don't log at all. */
592 Lisp_Object Vmessage_log_max
;
594 /* The name of the *Messages* buffer, a string. */
596 static Lisp_Object Vmessages_buffer_name
;
598 /* Current, index 0, and last displayed echo area message. Either
599 buffers from echo_buffers, or nil to indicate no message. */
601 Lisp_Object echo_area_buffer
[2];
603 /* The buffers referenced from echo_area_buffer. */
605 static Lisp_Object echo_buffer
[2];
607 /* A vector saved used in with_area_buffer to reduce consing. */
609 static Lisp_Object Vwith_echo_area_save_vector
;
611 /* Non-zero means display_echo_area should display the last echo area
612 message again. Set by redisplay_preserve_echo_area. */
614 static int display_last_displayed_message_p
;
616 /* Nonzero if echo area is being used by print; zero if being used by
619 int message_buf_print
;
621 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
623 Lisp_Object Qinhibit_menubar_update
;
624 int inhibit_menubar_update
;
626 /* When evaluating expressions from menu bar items (enable conditions,
627 for instance), this is the frame they are being processed for. */
629 Lisp_Object Vmenu_updating_frame
;
631 /* Maximum height for resizing mini-windows. Either a float
632 specifying a fraction of the available height, or an integer
633 specifying a number of lines. */
635 Lisp_Object Vmax_mini_window_height
;
637 /* Non-zero means messages should be displayed with truncated
638 lines instead of being continued. */
640 int message_truncate_lines
;
641 Lisp_Object Qmessage_truncate_lines
;
643 /* Set to 1 in clear_message to make redisplay_internal aware
644 of an emptied echo area. */
646 static int message_cleared_p
;
648 /* How to blink the default frame cursor off. */
649 Lisp_Object Vblink_cursor_alist
;
651 /* A scratch glyph row with contents used for generating truncation
652 glyphs. Also used in direct_output_for_insert. */
654 #define MAX_SCRATCH_GLYPHS 100
655 struct glyph_row scratch_glyph_row
;
656 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
658 /* Ascent and height of the last line processed by move_it_to. */
660 static int last_max_ascent
, last_height
;
662 /* Non-zero if there's a help-echo in the echo area. */
664 int help_echo_showing_p
;
666 /* If >= 0, computed, exact values of mode-line and header-line height
667 to use in the macros CURRENT_MODE_LINE_HEIGHT and
668 CURRENT_HEADER_LINE_HEIGHT. */
670 int current_mode_line_height
, current_header_line_height
;
672 /* The maximum distance to look ahead for text properties. Values
673 that are too small let us call compute_char_face and similar
674 functions too often which is expensive. Values that are too large
675 let us call compute_char_face and alike too often because we
676 might not be interested in text properties that far away. */
678 #define TEXT_PROP_DISTANCE_LIMIT 100
682 /* Variables to turn off display optimizations from Lisp. */
684 int inhibit_try_window_id
, inhibit_try_window_reusing
;
685 int inhibit_try_cursor_movement
;
687 /* Non-zero means print traces of redisplay if compiled with
690 int trace_redisplay_p
;
692 #endif /* GLYPH_DEBUG */
694 #ifdef DEBUG_TRACE_MOVE
695 /* Non-zero means trace with TRACE_MOVE to stderr. */
698 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
700 #define TRACE_MOVE(x) (void) 0
703 /* Non-zero means automatically scroll windows horizontally to make
706 int automatic_hscrolling_p
;
707 Lisp_Object Qauto_hscroll_mode
;
709 /* How close to the margin can point get before the window is scrolled
711 EMACS_INT hscroll_margin
;
713 /* How much to scroll horizontally when point is inside the above margin. */
714 Lisp_Object Vhscroll_step
;
716 /* The variable `resize-mini-windows'. If nil, don't resize
717 mini-windows. If t, always resize them to fit the text they
718 display. If `grow-only', let mini-windows grow only until they
721 Lisp_Object Vresize_mini_windows
;
723 /* Buffer being redisplayed -- for redisplay_window_error. */
725 struct buffer
*displayed_buffer
;
727 /* Space between overline and text. */
729 EMACS_INT overline_margin
;
731 /* Require underline to be at least this many screen pixels below baseline
732 This to avoid underline "merging" with the base of letters at small
733 font sizes, particularly when x_use_underline_position_properties is on. */
735 EMACS_INT underline_minimum_offset
;
737 /* Value returned from text property handlers (see below). */
742 HANDLED_RECOMPUTE_PROPS
,
743 HANDLED_OVERLAY_STRING_CONSUMED
,
747 /* A description of text properties that redisplay is interested
752 /* The name of the property. */
755 /* A unique index for the property. */
758 /* A handler function called to set up iterator IT from the property
759 at IT's current position. Value is used to steer handle_stop. */
760 enum prop_handled (*handler
) P_ ((struct it
*it
));
763 static enum prop_handled handle_face_prop
P_ ((struct it
*));
764 static enum prop_handled handle_invisible_prop
P_ ((struct it
*));
765 static enum prop_handled handle_display_prop
P_ ((struct it
*));
766 static enum prop_handled handle_composition_prop
P_ ((struct it
*));
767 static enum prop_handled handle_overlay_change
P_ ((struct it
*));
768 static enum prop_handled handle_fontified_prop
P_ ((struct it
*));
769 static enum prop_handled handle_auto_composed_prop
P_ ((struct it
*));
771 /* Properties handled by iterators. */
773 static struct props it_props
[] =
775 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
776 /* Handle `face' before `display' because some sub-properties of
777 `display' need to know the face. */
778 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
779 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
780 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
781 {&Qauto_composed
, AUTO_COMPOSED_PROP_IDX
, handle_auto_composed_prop
},
782 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
786 /* Value is the position described by X. If X is a marker, value is
787 the marker_position of X. Otherwise, value is X. */
789 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
791 /* Enumeration returned by some move_it_.* functions internally. */
795 /* Not used. Undefined value. */
798 /* Move ended at the requested buffer position or ZV. */
799 MOVE_POS_MATCH_OR_ZV
,
801 /* Move ended at the requested X pixel position. */
804 /* Move within a line ended at the end of a line that must be
808 /* Move within a line ended at the end of a line that would
809 be displayed truncated. */
812 /* Move within a line ended at a line end. */
816 /* This counter is used to clear the face cache every once in a while
817 in redisplay_internal. It is incremented for each redisplay.
818 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
821 #define CLEAR_FACE_CACHE_COUNT 500
822 static int clear_face_cache_count
;
824 /* Similarly for the image cache. */
826 #ifdef HAVE_WINDOW_SYSTEM
827 #define CLEAR_IMAGE_CACHE_COUNT 101
828 static int clear_image_cache_count
;
831 /* Non-zero while redisplay_internal is in progress. */
835 /* Non-zero means don't free realized faces. Bound while freeing
836 realized faces is dangerous because glyph matrices might still
839 int inhibit_free_realized_faces
;
840 Lisp_Object Qinhibit_free_realized_faces
;
842 /* If a string, XTread_socket generates an event to display that string.
843 (The display is done in read_char.) */
845 Lisp_Object help_echo_string
;
846 Lisp_Object help_echo_window
;
847 Lisp_Object help_echo_object
;
850 /* Temporary variable for XTread_socket. */
852 Lisp_Object previous_help_echo_string
;
854 /* Null glyph slice */
856 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
858 /* Platform-independent portion of hourglass implementation. */
860 /* Non-zero means we're allowed to display a hourglass pointer. */
861 int display_hourglass_p
;
863 /* Non-zero means an hourglass cursor is currently shown. */
864 int hourglass_shown_p
;
866 /* If non-null, an asynchronous timer that, when it expires, displays
867 an hourglass cursor on all frames. */
868 struct atimer
*hourglass_atimer
;
870 /* Number of seconds to wait before displaying an hourglass cursor. */
871 Lisp_Object Vhourglass_delay
;
873 /* Default number of seconds to wait before displaying an hourglass
875 #define DEFAULT_HOURGLASS_DELAY 1
878 /* Function prototypes. */
880 static void setup_for_ellipsis
P_ ((struct it
*, int));
881 static void mark_window_display_accurate_1
P_ ((struct window
*, int));
882 static int single_display_spec_string_p
P_ ((Lisp_Object
, Lisp_Object
));
883 static int display_prop_string_p
P_ ((Lisp_Object
, Lisp_Object
));
884 static int cursor_row_p
P_ ((struct window
*, struct glyph_row
*));
885 static int redisplay_mode_lines
P_ ((Lisp_Object
, int));
886 static char *decode_mode_spec_coding
P_ ((Lisp_Object
, char *, int));
888 static Lisp_Object get_it_property
P_ ((struct it
*it
, Lisp_Object prop
));
890 static void handle_line_prefix
P_ ((struct it
*));
893 static int invisible_text_between_p
P_ ((struct it
*, int, int));
896 static void pint2str
P_ ((char *, int, int));
897 static void pint2hrstr
P_ ((char *, int, int));
898 static struct text_pos run_window_scroll_functions
P_ ((Lisp_Object
,
900 static void reconsider_clip_changes
P_ ((struct window
*, struct buffer
*));
901 static int text_outside_line_unchanged_p
P_ ((struct window
*, int, int));
902 static void store_mode_line_noprop_char
P_ ((char));
903 static int store_mode_line_noprop
P_ ((const unsigned char *, int, int));
904 static void x_consider_frame_title
P_ ((Lisp_Object
));
905 static void handle_stop
P_ ((struct it
*));
906 static int tool_bar_lines_needed
P_ ((struct frame
*, int *));
907 static int single_display_spec_intangible_p
P_ ((Lisp_Object
));
908 static void ensure_echo_area_buffers
P_ ((void));
909 static Lisp_Object unwind_with_echo_area_buffer
P_ ((Lisp_Object
));
910 static Lisp_Object with_echo_area_buffer_unwind_data
P_ ((struct window
*));
911 static int with_echo_area_buffer
P_ ((struct window
*, int,
912 int (*) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
913 EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
914 static void clear_garbaged_frames
P_ ((void));
915 static int current_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
916 static int truncate_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
917 static int set_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
918 static int display_echo_area
P_ ((struct window
*));
919 static int display_echo_area_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
920 static int resize_mini_window_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
921 static Lisp_Object unwind_redisplay
P_ ((Lisp_Object
));
922 static int string_char_and_length
P_ ((const unsigned char *, int, int *));
923 static struct text_pos display_prop_end
P_ ((struct it
*, Lisp_Object
,
925 static int compute_window_start_on_continuation_line
P_ ((struct window
*));
926 static Lisp_Object safe_eval_handler
P_ ((Lisp_Object
));
927 static void insert_left_trunc_glyphs
P_ ((struct it
*));
928 static struct glyph_row
*get_overlay_arrow_glyph_row
P_ ((struct window
*,
930 static void extend_face_to_end_of_line
P_ ((struct it
*));
931 static int append_space_for_newline
P_ ((struct it
*, int));
932 static int cursor_row_fully_visible_p
P_ ((struct window
*, int, int));
933 static int try_scrolling
P_ ((Lisp_Object
, int, EMACS_INT
, EMACS_INT
, int, int));
934 static int try_cursor_movement
P_ ((Lisp_Object
, struct text_pos
, int *));
935 static int trailing_whitespace_p
P_ ((int));
936 static int message_log_check_duplicate
P_ ((int, int, int, int));
937 static void push_it
P_ ((struct it
*));
938 static void pop_it
P_ ((struct it
*));
939 static void sync_frame_with_window_matrix_rows
P_ ((struct window
*));
940 static void select_frame_for_redisplay
P_ ((Lisp_Object
));
941 static void redisplay_internal
P_ ((int));
942 static int echo_area_display
P_ ((int));
943 static void redisplay_windows
P_ ((Lisp_Object
));
944 static void redisplay_window
P_ ((Lisp_Object
, int));
945 static Lisp_Object
redisplay_window_error ();
946 static Lisp_Object redisplay_window_0
P_ ((Lisp_Object
));
947 static Lisp_Object redisplay_window_1
P_ ((Lisp_Object
));
948 static int update_menu_bar
P_ ((struct frame
*, int, int));
949 static int try_window_reusing_current_matrix
P_ ((struct window
*));
950 static int try_window_id
P_ ((struct window
*));
951 static int display_line
P_ ((struct it
*));
952 static int display_mode_lines
P_ ((struct window
*));
953 static int display_mode_line
P_ ((struct window
*, enum face_id
, Lisp_Object
));
954 static int display_mode_element
P_ ((struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int));
955 static int store_mode_line_string
P_ ((char *, Lisp_Object
, int, int, int, Lisp_Object
));
956 static char *decode_mode_spec
P_ ((struct window
*, int, int, int, int *));
957 static void display_menu_bar
P_ ((struct window
*));
958 static int display_count_lines
P_ ((int, int, int, int, int *));
959 static int display_string
P_ ((unsigned char *, Lisp_Object
, Lisp_Object
,
960 EMACS_INT
, EMACS_INT
, struct it
*, int, int, int, int));
961 static void compute_line_metrics
P_ ((struct it
*));
962 static void run_redisplay_end_trigger_hook
P_ ((struct it
*));
963 static int get_overlay_strings
P_ ((struct it
*, int));
964 static int get_overlay_strings_1
P_ ((struct it
*, int, int));
965 static void next_overlay_string
P_ ((struct it
*));
966 static void reseat
P_ ((struct it
*, struct text_pos
, int));
967 static void reseat_1
P_ ((struct it
*, struct text_pos
, int));
968 static void back_to_previous_visible_line_start
P_ ((struct it
*));
969 void reseat_at_previous_visible_line_start
P_ ((struct it
*));
970 static void reseat_at_next_visible_line_start
P_ ((struct it
*, int));
971 static int next_element_from_ellipsis
P_ ((struct it
*));
972 static int next_element_from_display_vector
P_ ((struct it
*));
973 static int next_element_from_string
P_ ((struct it
*));
974 static int next_element_from_c_string
P_ ((struct it
*));
975 static int next_element_from_buffer
P_ ((struct it
*));
976 static int next_element_from_composition
P_ ((struct it
*));
977 static int next_element_from_image
P_ ((struct it
*));
978 static int next_element_from_stretch
P_ ((struct it
*));
979 static void load_overlay_strings
P_ ((struct it
*, int));
980 static int init_from_display_pos
P_ ((struct it
*, struct window
*,
981 struct display_pos
*));
982 static void reseat_to_string
P_ ((struct it
*, unsigned char *,
983 Lisp_Object
, int, int, int, int));
984 static enum move_it_result
985 move_it_in_display_line_to (struct it
*, EMACS_INT
, int,
986 enum move_operation_enum
);
987 void move_it_vertically_backward
P_ ((struct it
*, int));
988 static void init_to_row_start
P_ ((struct it
*, struct window
*,
989 struct glyph_row
*));
990 static int init_to_row_end
P_ ((struct it
*, struct window
*,
991 struct glyph_row
*));
992 static void back_to_previous_line_start
P_ ((struct it
*));
993 static int forward_to_next_line_start
P_ ((struct it
*, int *));
994 static struct text_pos string_pos_nchars_ahead
P_ ((struct text_pos
,
996 static struct text_pos string_pos
P_ ((int, Lisp_Object
));
997 static struct text_pos c_string_pos
P_ ((int, unsigned char *, int));
998 static int number_of_chars
P_ ((unsigned char *, int));
999 static void compute_stop_pos
P_ ((struct it
*));
1000 static void compute_string_pos
P_ ((struct text_pos
*, struct text_pos
,
1002 static int face_before_or_after_it_pos
P_ ((struct it
*, int));
1003 static EMACS_INT next_overlay_change
P_ ((EMACS_INT
));
1004 static int handle_single_display_spec
P_ ((struct it
*, Lisp_Object
,
1005 Lisp_Object
, Lisp_Object
,
1006 struct text_pos
*, int));
1007 static int underlying_face_id
P_ ((struct it
*));
1008 static int in_ellipses_for_invisible_text_p
P_ ((struct display_pos
*,
1011 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
1012 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
1014 #ifdef HAVE_WINDOW_SYSTEM
1016 static void update_tool_bar
P_ ((struct frame
*, int));
1017 static void build_desired_tool_bar_string
P_ ((struct frame
*f
));
1018 static int redisplay_tool_bar
P_ ((struct frame
*));
1019 static void display_tool_bar_line
P_ ((struct it
*, int));
1020 static void notice_overwritten_cursor
P_ ((struct window
*,
1021 enum glyph_row_area
,
1022 int, int, int, int));
1026 #endif /* HAVE_WINDOW_SYSTEM */
1029 /***********************************************************************
1030 Window display dimensions
1031 ***********************************************************************/
1033 /* Return the bottom boundary y-position for text lines in window W.
1034 This is the first y position at which a line cannot start.
1035 It is relative to the top of the window.
1037 This is the height of W minus the height of a mode line, if any. */
1040 window_text_bottom_y (w
)
1043 int height
= WINDOW_TOTAL_HEIGHT (w
);
1045 if (WINDOW_WANTS_MODELINE_P (w
))
1046 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
1050 /* Return the pixel width of display area AREA of window W. AREA < 0
1051 means return the total width of W, not including fringes to
1052 the left and right of the window. */
1055 window_box_width (w
, area
)
1059 int cols
= XFASTINT (w
->total_cols
);
1062 if (!w
->pseudo_window_p
)
1064 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
1066 if (area
== TEXT_AREA
)
1068 if (INTEGERP (w
->left_margin_cols
))
1069 cols
-= XFASTINT (w
->left_margin_cols
);
1070 if (INTEGERP (w
->right_margin_cols
))
1071 cols
-= XFASTINT (w
->right_margin_cols
);
1072 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
1074 else if (area
== LEFT_MARGIN_AREA
)
1076 cols
= (INTEGERP (w
->left_margin_cols
)
1077 ? XFASTINT (w
->left_margin_cols
) : 0);
1080 else if (area
== RIGHT_MARGIN_AREA
)
1082 cols
= (INTEGERP (w
->right_margin_cols
)
1083 ? XFASTINT (w
->right_margin_cols
) : 0);
1088 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
1092 /* Return the pixel height of the display area of window W, not
1093 including mode lines of W, if any. */
1096 window_box_height (w
)
1099 struct frame
*f
= XFRAME (w
->frame
);
1100 int height
= WINDOW_TOTAL_HEIGHT (w
);
1102 xassert (height
>= 0);
1104 /* Note: the code below that determines the mode-line/header-line
1105 height is essentially the same as that contained in the macro
1106 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
1107 the appropriate glyph row has its `mode_line_p' flag set,
1108 and if it doesn't, uses estimate_mode_line_height instead. */
1110 if (WINDOW_WANTS_MODELINE_P (w
))
1112 struct glyph_row
*ml_row
1113 = (w
->current_matrix
&& w
->current_matrix
->rows
1114 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1116 if (ml_row
&& ml_row
->mode_line_p
)
1117 height
-= ml_row
->height
;
1119 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1122 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1124 struct glyph_row
*hl_row
1125 = (w
->current_matrix
&& w
->current_matrix
->rows
1126 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1128 if (hl_row
&& hl_row
->mode_line_p
)
1129 height
-= hl_row
->height
;
1131 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1134 /* With a very small font and a mode-line that's taller than
1135 default, we might end up with a negative height. */
1136 return max (0, height
);
1139 /* Return the window-relative coordinate of the left edge of display
1140 area AREA of window W. AREA < 0 means return the left edge of the
1141 whole window, to the right of the left fringe of W. */
1144 window_box_left_offset (w
, area
)
1150 if (w
->pseudo_window_p
)
1153 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1155 if (area
== TEXT_AREA
)
1156 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1157 + window_box_width (w
, LEFT_MARGIN_AREA
));
1158 else if (area
== RIGHT_MARGIN_AREA
)
1159 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1160 + window_box_width (w
, LEFT_MARGIN_AREA
)
1161 + window_box_width (w
, TEXT_AREA
)
1162 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1164 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1165 else if (area
== LEFT_MARGIN_AREA
1166 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1167 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1173 /* Return the window-relative coordinate of the right edge of display
1174 area AREA of window W. AREA < 0 means return the left edge of the
1175 whole window, to the left of the right fringe of W. */
1178 window_box_right_offset (w
, area
)
1182 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1185 /* Return the frame-relative coordinate of the left edge of display
1186 area AREA of window W. AREA < 0 means return the left edge of the
1187 whole window, to the right of the left fringe of W. */
1190 window_box_left (w
, area
)
1194 struct frame
*f
= XFRAME (w
->frame
);
1197 if (w
->pseudo_window_p
)
1198 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1200 x
= (WINDOW_LEFT_EDGE_X (w
)
1201 + window_box_left_offset (w
, area
));
1207 /* Return the frame-relative coordinate of the right edge of display
1208 area AREA of window W. AREA < 0 means return the left edge of the
1209 whole window, to the left of the right fringe of W. */
1212 window_box_right (w
, area
)
1216 return window_box_left (w
, area
) + window_box_width (w
, area
);
1219 /* Get the bounding box of the display area AREA of window W, without
1220 mode lines, in frame-relative coordinates. AREA < 0 means the
1221 whole window, not including the left and right fringes of
1222 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1223 coordinates of the upper-left corner of the box. Return in
1224 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1227 window_box (w
, area
, box_x
, box_y
, box_width
, box_height
)
1230 int *box_x
, *box_y
, *box_width
, *box_height
;
1233 *box_width
= window_box_width (w
, area
);
1235 *box_height
= window_box_height (w
);
1237 *box_x
= window_box_left (w
, area
);
1240 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1241 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1242 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1247 /* Get the bounding box of the display area AREA of window W, without
1248 mode lines. AREA < 0 means the whole window, not including the
1249 left and right fringe of the window. Return in *TOP_LEFT_X
1250 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1251 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1252 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1256 window_box_edges (w
, area
, top_left_x
, top_left_y
,
1257 bottom_right_x
, bottom_right_y
)
1260 int *top_left_x
, *top_left_y
, *bottom_right_x
, *bottom_right_y
;
1262 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1264 *bottom_right_x
+= *top_left_x
;
1265 *bottom_right_y
+= *top_left_y
;
1270 /***********************************************************************
1272 ***********************************************************************/
1274 /* Return the bottom y-position of the line the iterator IT is in.
1275 This can modify IT's settings. */
1281 int line_height
= it
->max_ascent
+ it
->max_descent
;
1282 int line_top_y
= it
->current_y
;
1284 if (line_height
== 0)
1287 line_height
= last_height
;
1288 else if (IT_CHARPOS (*it
) < ZV
)
1290 move_it_by_lines (it
, 1, 1);
1291 line_height
= (it
->max_ascent
|| it
->max_descent
1292 ? it
->max_ascent
+ it
->max_descent
1297 struct glyph_row
*row
= it
->glyph_row
;
1299 /* Use the default character height. */
1300 it
->glyph_row
= NULL
;
1301 it
->what
= IT_CHARACTER
;
1304 PRODUCE_GLYPHS (it
);
1305 line_height
= it
->ascent
+ it
->descent
;
1306 it
->glyph_row
= row
;
1310 return line_top_y
+ line_height
;
1314 /* Return 1 if position CHARPOS is visible in window W.
1315 CHARPOS < 0 means return info about WINDOW_END position.
1316 If visible, set *X and *Y to pixel coordinates of top left corner.
1317 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1318 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1321 pos_visible_p (w
, charpos
, x
, y
, rtop
, rbot
, rowh
, vpos
)
1323 int charpos
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
;
1326 struct text_pos top
;
1328 struct buffer
*old_buffer
= NULL
;
1333 if (XBUFFER (w
->buffer
) != current_buffer
)
1335 old_buffer
= current_buffer
;
1336 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1339 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1341 /* Compute exact mode line heights. */
1342 if (WINDOW_WANTS_MODELINE_P (w
))
1343 current_mode_line_height
1344 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1345 current_buffer
->mode_line_format
);
1347 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1348 current_header_line_height
1349 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1350 current_buffer
->header_line_format
);
1352 start_display (&it
, w
, top
);
1353 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1354 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1356 /* Note that we may overshoot because of invisible text. */
1357 if (charpos
>= 0 && IT_CHARPOS (it
) >= charpos
)
1359 int top_x
= it
.current_x
;
1360 int top_y
= it
.current_y
;
1361 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1362 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1364 if (top_y
< window_top_y
)
1365 visible_p
= bottom_y
> window_top_y
;
1366 else if (top_y
< it
.last_visible_y
)
1370 if (it
.method
== GET_FROM_BUFFER
)
1372 Lisp_Object window
, prop
;
1374 XSETWINDOW (window
, w
);
1375 prop
= Fget_char_property (make_number (it
.position
.charpos
),
1376 Qinvisible
, window
);
1378 /* If charpos coincides with invisible text covered with an
1379 ellipsis, use the first glyph of the ellipsis to compute
1380 the pixel positions. */
1381 if (TEXT_PROP_MEANS_INVISIBLE (prop
) == 2)
1383 struct glyph_row
*row
= it
.glyph_row
;
1384 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1385 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
1388 for (; glyph
< end
&& glyph
->charpos
< charpos
; glyph
++)
1389 x
+= glyph
->pixel_width
;
1396 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1397 *rtop
= max (0, window_top_y
- top_y
);
1398 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1399 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1400 - max (top_y
, window_top_y
)));
1409 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1410 move_it_by_lines (&it
, 1, 0);
1411 if (charpos
< IT_CHARPOS (it
)
1412 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1415 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1417 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1418 *rtop
= max (0, -it2
.current_y
);
1419 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1420 - it
.last_visible_y
));
1421 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1423 - max (it2
.current_y
,
1424 WINDOW_HEADER_LINE_HEIGHT (w
))));
1430 set_buffer_internal_1 (old_buffer
);
1432 current_header_line_height
= current_mode_line_height
= -1;
1434 if (visible_p
&& XFASTINT (w
->hscroll
) > 0)
1435 *x
-= XFASTINT (w
->hscroll
) * WINDOW_FRAME_COLUMN_WIDTH (w
);
1438 /* Debugging code. */
1440 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1441 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1443 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1450 /* Return the next character from STR which is MAXLEN bytes long.
1451 Return in *LEN the length of the character. This is like
1452 STRING_CHAR_AND_LENGTH but never returns an invalid character. If
1453 we find one, we return a `?', but with the length of the invalid
1457 string_char_and_length (str
, maxlen
, len
)
1458 const unsigned char *str
;
1463 c
= STRING_CHAR_AND_LENGTH (str
, maxlen
, *len
);
1464 if (!CHAR_VALID_P (c
, 1))
1465 /* We may not change the length here because other places in Emacs
1466 don't use this function, i.e. they silently accept invalid
1475 /* Given a position POS containing a valid character and byte position
1476 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1478 static struct text_pos
1479 string_pos_nchars_ahead (pos
, string
, nchars
)
1480 struct text_pos pos
;
1484 xassert (STRINGP (string
) && nchars
>= 0);
1486 if (STRING_MULTIBYTE (string
))
1488 int rest
= SBYTES (string
) - BYTEPOS (pos
);
1489 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1494 string_char_and_length (p
, rest
, &len
);
1495 p
+= len
, rest
-= len
;
1496 xassert (rest
>= 0);
1498 BYTEPOS (pos
) += len
;
1502 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1508 /* Value is the text position, i.e. character and byte position,
1509 for character position CHARPOS in STRING. */
1511 static INLINE
struct text_pos
1512 string_pos (charpos
, string
)
1516 struct text_pos pos
;
1517 xassert (STRINGP (string
));
1518 xassert (charpos
>= 0);
1519 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1524 /* Value is a text position, i.e. character and byte position, for
1525 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1526 means recognize multibyte characters. */
1528 static struct text_pos
1529 c_string_pos (charpos
, s
, multibyte_p
)
1534 struct text_pos pos
;
1536 xassert (s
!= NULL
);
1537 xassert (charpos
>= 0);
1541 int rest
= strlen (s
), len
;
1543 SET_TEXT_POS (pos
, 0, 0);
1546 string_char_and_length (s
, rest
, &len
);
1547 s
+= len
, rest
-= len
;
1548 xassert (rest
>= 0);
1550 BYTEPOS (pos
) += len
;
1554 SET_TEXT_POS (pos
, charpos
, charpos
);
1560 /* Value is the number of characters in C string S. MULTIBYTE_P
1561 non-zero means recognize multibyte characters. */
1564 number_of_chars (s
, multibyte_p
)
1572 int rest
= strlen (s
), len
;
1573 unsigned char *p
= (unsigned char *) s
;
1575 for (nchars
= 0; rest
> 0; ++nchars
)
1577 string_char_and_length (p
, rest
, &len
);
1578 rest
-= len
, p
+= len
;
1582 nchars
= strlen (s
);
1588 /* Compute byte position NEWPOS->bytepos corresponding to
1589 NEWPOS->charpos. POS is a known position in string STRING.
1590 NEWPOS->charpos must be >= POS.charpos. */
1593 compute_string_pos (newpos
, pos
, string
)
1594 struct text_pos
*newpos
, pos
;
1597 xassert (STRINGP (string
));
1598 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1600 if (STRING_MULTIBYTE (string
))
1601 *newpos
= string_pos_nchars_ahead (pos
, string
,
1602 CHARPOS (*newpos
) - CHARPOS (pos
));
1604 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1608 Return an estimation of the pixel height of mode or top lines on
1609 frame F. FACE_ID specifies what line's height to estimate. */
1612 estimate_mode_line_height (f
, face_id
)
1614 enum face_id face_id
;
1616 #ifdef HAVE_WINDOW_SYSTEM
1617 if (FRAME_WINDOW_P (f
))
1619 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1621 /* This function is called so early when Emacs starts that the face
1622 cache and mode line face are not yet initialized. */
1623 if (FRAME_FACE_CACHE (f
))
1625 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1629 height
= FONT_HEIGHT (face
->font
);
1630 if (face
->box_line_width
> 0)
1631 height
+= 2 * face
->box_line_width
;
1642 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1643 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1644 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1645 not force the value into range. */
1648 pixel_to_glyph_coords (f
, pix_x
, pix_y
, x
, y
, bounds
, noclip
)
1650 register int pix_x
, pix_y
;
1652 NativeRectangle
*bounds
;
1656 #ifdef HAVE_WINDOW_SYSTEM
1657 if (FRAME_WINDOW_P (f
))
1659 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1660 even for negative values. */
1662 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1664 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1666 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1667 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1670 STORE_NATIVE_RECT (*bounds
,
1671 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1672 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1673 FRAME_COLUMN_WIDTH (f
) - 1,
1674 FRAME_LINE_HEIGHT (f
) - 1);
1680 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1681 pix_x
= FRAME_TOTAL_COLS (f
);
1685 else if (pix_y
> FRAME_LINES (f
))
1686 pix_y
= FRAME_LINES (f
);
1696 /* Given HPOS/VPOS in the current matrix of W, return corresponding
1697 frame-relative pixel positions in *FRAME_X and *FRAME_Y. If we
1698 can't tell the positions because W's display is not up to date,
1702 glyph_to_pixel_coords (w
, hpos
, vpos
, frame_x
, frame_y
)
1705 int *frame_x
, *frame_y
;
1707 #ifdef HAVE_WINDOW_SYSTEM
1708 if (FRAME_WINDOW_P (XFRAME (WINDOW_FRAME (w
))))
1712 xassert (hpos
>= 0 && hpos
< w
->current_matrix
->matrix_w
);
1713 xassert (vpos
>= 0 && vpos
< w
->current_matrix
->matrix_h
);
1715 if (display_completed
)
1717 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
1718 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1719 struct glyph
*end
= glyph
+ min (hpos
, row
->used
[TEXT_AREA
]);
1725 hpos
+= glyph
->pixel_width
;
1729 /* If first glyph is partially visible, its first visible position is still 0. */
1741 *frame_x
= WINDOW_TO_FRAME_PIXEL_X (w
, hpos
);
1742 *frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, vpos
);
1753 #ifdef HAVE_WINDOW_SYSTEM
1755 /* Find the glyph under window-relative coordinates X/Y in window W.
1756 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1757 strings. Return in *HPOS and *VPOS the row and column number of
1758 the glyph found. Return in *AREA the glyph area containing X.
1759 Value is a pointer to the glyph found or null if X/Y is not on
1760 text, or we can't tell because W's current matrix is not up to
1765 x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, dx
, dy
, area
)
1768 int *hpos
, *vpos
, *dx
, *dy
, *area
;
1770 struct glyph
*glyph
, *end
;
1771 struct glyph_row
*row
= NULL
;
1774 /* Find row containing Y. Give up if some row is not enabled. */
1775 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1777 row
= MATRIX_ROW (w
->current_matrix
, i
);
1778 if (!row
->enabled_p
)
1780 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1787 /* Give up if Y is not in the window. */
1788 if (i
== w
->current_matrix
->nrows
)
1791 /* Get the glyph area containing X. */
1792 if (w
->pseudo_window_p
)
1799 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1801 *area
= LEFT_MARGIN_AREA
;
1802 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1804 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1807 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1811 *area
= RIGHT_MARGIN_AREA
;
1812 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1816 /* Find glyph containing X. */
1817 glyph
= row
->glyphs
[*area
];
1818 end
= glyph
+ row
->used
[*area
];
1820 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1822 x
-= glyph
->pixel_width
;
1832 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1835 *hpos
= glyph
- row
->glyphs
[*area
];
1841 Convert frame-relative x/y to coordinates relative to window W.
1842 Takes pseudo-windows into account. */
1845 frame_to_window_pixel_xy (w
, x
, y
)
1849 if (w
->pseudo_window_p
)
1851 /* A pseudo-window is always full-width, and starts at the
1852 left edge of the frame, plus a frame border. */
1853 struct frame
*f
= XFRAME (w
->frame
);
1854 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1855 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1859 *x
-= WINDOW_LEFT_EDGE_X (w
);
1860 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1865 Return in RECTS[] at most N clipping rectangles for glyph string S.
1866 Return the number of stored rectangles. */
1869 get_glyph_string_clip_rects (s
, rects
, n
)
1870 struct glyph_string
*s
;
1871 NativeRectangle
*rects
;
1879 if (s
->row
->full_width_p
)
1881 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1882 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1883 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1885 /* Unless displaying a mode or menu bar line, which are always
1886 fully visible, clip to the visible part of the row. */
1887 if (s
->w
->pseudo_window_p
)
1888 r
.height
= s
->row
->visible_height
;
1890 r
.height
= s
->height
;
1894 /* This is a text line that may be partially visible. */
1895 r
.x
= window_box_left (s
->w
, s
->area
);
1896 r
.width
= window_box_width (s
->w
, s
->area
);
1897 r
.height
= s
->row
->visible_height
;
1901 if (r
.x
< s
->clip_head
->x
)
1903 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1904 r
.width
-= s
->clip_head
->x
- r
.x
;
1907 r
.x
= s
->clip_head
->x
;
1910 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1912 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1913 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1918 /* If S draws overlapping rows, it's sufficient to use the top and
1919 bottom of the window for clipping because this glyph string
1920 intentionally draws over other lines. */
1921 if (s
->for_overlaps
)
1923 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1924 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1926 /* Alas, the above simple strategy does not work for the
1927 environments with anti-aliased text: if the same text is
1928 drawn onto the same place multiple times, it gets thicker.
1929 If the overlap we are processing is for the erased cursor, we
1930 take the intersection with the rectagle of the cursor. */
1931 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
1933 XRectangle rc
, r_save
= r
;
1935 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
1936 rc
.y
= s
->w
->phys_cursor
.y
;
1937 rc
.width
= s
->w
->phys_cursor_width
;
1938 rc
.height
= s
->w
->phys_cursor_height
;
1940 x_intersect_rectangles (&r_save
, &rc
, &r
);
1945 /* Don't use S->y for clipping because it doesn't take partially
1946 visible lines into account. For example, it can be negative for
1947 partially visible lines at the top of a window. */
1948 if (!s
->row
->full_width_p
1949 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
1950 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1952 r
.y
= max (0, s
->row
->y
);
1954 /* If drawing a tool-bar window, draw it over the internal border
1955 at the top of the window. */
1956 if (WINDOWP (s
->f
->tool_bar_window
)
1957 && s
->w
== XWINDOW (s
->f
->tool_bar_window
))
1958 r
.y
-= FRAME_INTERNAL_BORDER_WIDTH (s
->f
);
1961 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
1963 /* If drawing the cursor, don't let glyph draw outside its
1964 advertised boundaries. Cleartype does this under some circumstances. */
1965 if (s
->hl
== DRAW_CURSOR
)
1967 struct glyph
*glyph
= s
->first_glyph
;
1972 r
.width
-= s
->x
- r
.x
;
1975 r
.width
= min (r
.width
, glyph
->pixel_width
);
1977 /* If r.y is below window bottom, ensure that we still see a cursor. */
1978 height
= min (glyph
->ascent
+ glyph
->descent
,
1979 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
1980 max_y
= window_text_bottom_y (s
->w
) - height
;
1981 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
1982 if (s
->ybase
- glyph
->ascent
> max_y
)
1989 /* Don't draw cursor glyph taller than our actual glyph. */
1990 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
1991 if (height
< r
.height
)
1993 max_y
= r
.y
+ r
.height
;
1994 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
1995 r
.height
= min (max_y
- r
.y
, height
);
2002 XRectangle r_save
= r
;
2004 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
2008 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
2009 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
2011 #ifdef CONVERT_FROM_XRECT
2012 CONVERT_FROM_XRECT (r
, *rects
);
2020 /* If we are processing overlapping and allowed to return
2021 multiple clipping rectangles, we exclude the row of the glyph
2022 string from the clipping rectangle. This is to avoid drawing
2023 the same text on the environment with anti-aliasing. */
2024 #ifdef CONVERT_FROM_XRECT
2027 XRectangle
*rs
= rects
;
2029 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2031 if (s
->for_overlaps
& OVERLAPS_PRED
)
2034 if (r
.y
+ r
.height
> row_y
)
2037 rs
[i
].height
= row_y
- r
.y
;
2043 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2046 if (r
.y
< row_y
+ s
->row
->visible_height
)
2048 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2050 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2051 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2060 #ifdef CONVERT_FROM_XRECT
2061 for (i
= 0; i
< n
; i
++)
2062 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2069 Return in *NR the clipping rectangle for glyph string S. */
2072 get_glyph_string_clip_rect (s
, nr
)
2073 struct glyph_string
*s
;
2074 NativeRectangle
*nr
;
2076 get_glyph_string_clip_rects (s
, nr
, 1);
2081 Return the position and height of the phys cursor in window W.
2082 Set w->phys_cursor_width to width of phys cursor.
2086 get_phys_cursor_geometry (w
, row
, glyph
, xp
, yp
, heightp
)
2088 struct glyph_row
*row
;
2089 struct glyph
*glyph
;
2090 int *xp
, *yp
, *heightp
;
2092 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2093 int x
, y
, wd
, h
, h0
, y0
;
2095 /* Compute the width of the rectangle to draw. If on a stretch
2096 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2097 rectangle as wide as the glyph, but use a canonical character
2099 wd
= glyph
->pixel_width
- 1;
2104 x
= w
->phys_cursor
.x
;
2111 if (glyph
->type
== STRETCH_GLYPH
2112 && !x_stretch_cursor_p
)
2113 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2114 w
->phys_cursor_width
= wd
;
2116 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
2118 /* If y is below window bottom, ensure that we still see a cursor. */
2119 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2121 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
2122 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
2124 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2127 h
= max (h
- (y0
- y
) + 1, h0
);
2132 y0
= window_text_bottom_y (w
) - h0
;
2140 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2141 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2146 * Remember which glyph the mouse is over.
2150 remember_mouse_glyph (f
, gx
, gy
, rect
)
2153 NativeRectangle
*rect
;
2157 struct glyph_row
*r
, *gr
, *end_row
;
2158 enum window_part part
;
2159 enum glyph_row_area area
;
2160 int x
, y
, width
, height
;
2162 /* Try to determine frame pixel position and size of the glyph under
2163 frame pixel coordinates X/Y on frame F. */
2165 if (!f
->glyphs_initialized_p
2166 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, &x
, &y
, 0),
2169 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2170 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2174 w
= XWINDOW (window
);
2175 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2176 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2178 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2179 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2181 if (w
->pseudo_window_p
)
2184 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2190 case ON_LEFT_MARGIN
:
2191 area
= LEFT_MARGIN_AREA
;
2194 case ON_RIGHT_MARGIN
:
2195 area
= RIGHT_MARGIN_AREA
;
2198 case ON_HEADER_LINE
:
2200 gr
= (part
== ON_HEADER_LINE
2201 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2202 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2205 goto text_glyph_row_found
;
2212 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2213 if (r
->y
+ r
->height
> y
)
2219 text_glyph_row_found
:
2222 struct glyph
*g
= gr
->glyphs
[area
];
2223 struct glyph
*end
= g
+ gr
->used
[area
];
2225 height
= gr
->height
;
2226 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2227 if (gx
+ g
->pixel_width
> x
)
2232 if (g
->type
== IMAGE_GLYPH
)
2234 /* Don't remember when mouse is over image, as
2235 image may have hot-spots. */
2236 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2239 width
= g
->pixel_width
;
2243 /* Use nominal char spacing at end of line. */
2245 gx
+= (x
/ width
) * width
;
2248 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2249 gx
+= window_box_left_offset (w
, area
);
2253 /* Use nominal line height at end of window. */
2254 gx
= (x
/ width
) * width
;
2256 gy
+= (y
/ height
) * height
;
2260 case ON_LEFT_FRINGE
:
2261 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2262 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2263 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2264 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2267 case ON_RIGHT_FRINGE
:
2268 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2269 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2270 : window_box_right_offset (w
, TEXT_AREA
));
2271 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2275 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2277 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2278 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2279 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2281 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2285 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2286 if (r
->y
+ r
->height
> y
)
2293 height
= gr
->height
;
2296 /* Use nominal line height at end of window. */
2298 gy
+= (y
/ height
) * height
;
2305 /* If there is no glyph under the mouse, then we divide the screen
2306 into a grid of the smallest glyph in the frame, and use that
2309 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2310 round down even for negative values. */
2316 gx
= (gx
/ width
) * width
;
2317 gy
= (gy
/ height
) * height
;
2322 gx
+= WINDOW_LEFT_EDGE_X (w
);
2323 gy
+= WINDOW_TOP_EDGE_Y (w
);
2326 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2328 /* Visible feedback for debugging. */
2331 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2332 f
->output_data
.x
->normal_gc
,
2333 gx
, gy
, width
, height
);
2339 #endif /* HAVE_WINDOW_SYSTEM */
2342 /***********************************************************************
2343 Lisp form evaluation
2344 ***********************************************************************/
2346 /* Error handler for safe_eval and safe_call. */
2349 safe_eval_handler (arg
)
2352 add_to_log ("Error during redisplay: %s", arg
, Qnil
);
2357 /* Evaluate SEXPR and return the result, or nil if something went
2358 wrong. Prevent redisplay during the evaluation. */
2360 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
2361 Return the result, or nil if something went wrong. Prevent
2362 redisplay during the evaluation. */
2365 safe_call (nargs
, args
)
2371 if (inhibit_eval_during_redisplay
)
2375 int count
= SPECPDL_INDEX ();
2376 struct gcpro gcpro1
;
2379 gcpro1
.nvars
= nargs
;
2380 specbind (Qinhibit_redisplay
, Qt
);
2381 /* Use Qt to ensure debugger does not run,
2382 so there is no possibility of wanting to redisplay. */
2383 val
= internal_condition_case_2 (Ffuncall
, nargs
, args
, Qt
,
2386 val
= unbind_to (count
, val
);
2393 /* Call function FN with one argument ARG.
2394 Return the result, or nil if something went wrong. */
2397 safe_call1 (fn
, arg
)
2398 Lisp_Object fn
, arg
;
2400 Lisp_Object args
[2];
2403 return safe_call (2, args
);
2406 static Lisp_Object Qeval
;
2409 safe_eval (Lisp_Object sexpr
)
2411 return safe_call1 (Qeval
, sexpr
);
2414 /* Call function FN with one argument ARG.
2415 Return the result, or nil if something went wrong. */
2418 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2420 Lisp_Object args
[3];
2424 return safe_call (3, args
);
2429 /***********************************************************************
2431 ***********************************************************************/
2435 /* Define CHECK_IT to perform sanity checks on iterators.
2436 This is for debugging. It is too slow to do unconditionally. */
2442 if (it
->method
== GET_FROM_STRING
)
2444 xassert (STRINGP (it
->string
));
2445 xassert (IT_STRING_CHARPOS (*it
) >= 0);
2449 xassert (IT_STRING_CHARPOS (*it
) < 0);
2450 if (it
->method
== GET_FROM_BUFFER
)
2452 /* Check that character and byte positions agree. */
2453 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2458 xassert (it
->current
.dpvec_index
>= 0);
2460 xassert (it
->current
.dpvec_index
< 0);
2463 #define CHECK_IT(IT) check_it ((IT))
2467 #define CHECK_IT(IT) (void) 0
2474 /* Check that the window end of window W is what we expect it
2475 to be---the last row in the current matrix displaying text. */
2478 check_window_end (w
)
2481 if (!MINI_WINDOW_P (w
)
2482 && !NILP (w
->window_end_valid
))
2484 struct glyph_row
*row
;
2485 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
2486 XFASTINT (w
->window_end_vpos
)),
2488 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2489 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2493 #define CHECK_WINDOW_END(W) check_window_end ((W))
2495 #else /* not GLYPH_DEBUG */
2497 #define CHECK_WINDOW_END(W) (void) 0
2499 #endif /* not GLYPH_DEBUG */
2503 /***********************************************************************
2504 Iterator initialization
2505 ***********************************************************************/
2507 /* Initialize IT for displaying current_buffer in window W, starting
2508 at character position CHARPOS. CHARPOS < 0 means that no buffer
2509 position is specified which is useful when the iterator is assigned
2510 a position later. BYTEPOS is the byte position corresponding to
2511 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2513 If ROW is not null, calls to produce_glyphs with IT as parameter
2514 will produce glyphs in that row.
2516 BASE_FACE_ID is the id of a base face to use. It must be one of
2517 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2518 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2519 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2521 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2522 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2523 will be initialized to use the corresponding mode line glyph row of
2524 the desired matrix of W. */
2527 init_iterator (it
, w
, charpos
, bytepos
, row
, base_face_id
)
2530 int charpos
, bytepos
;
2531 struct glyph_row
*row
;
2532 enum face_id base_face_id
;
2534 int highlight_region_p
;
2535 enum face_id remapped_base_face_id
= base_face_id
;
2537 /* Some precondition checks. */
2538 xassert (w
!= NULL
&& it
!= NULL
);
2539 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2542 /* If face attributes have been changed since the last redisplay,
2543 free realized faces now because they depend on face definitions
2544 that might have changed. Don't free faces while there might be
2545 desired matrices pending which reference these faces. */
2546 if (face_change_count
&& !inhibit_free_realized_faces
)
2548 face_change_count
= 0;
2549 free_all_realized_faces (Qnil
);
2552 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2553 if (! NILP (Vface_remapping_alist
))
2554 remapped_base_face_id
= lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2556 /* Use one of the mode line rows of W's desired matrix if
2560 if (base_face_id
== MODE_LINE_FACE_ID
2561 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2562 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2563 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2564 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2568 bzero (it
, sizeof *it
);
2569 it
->current
.overlay_string_index
= -1;
2570 it
->current
.dpvec_index
= -1;
2571 it
->base_face_id
= remapped_base_face_id
;
2573 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2575 /* The window in which we iterate over current_buffer: */
2576 XSETWINDOW (it
->window
, w
);
2578 it
->f
= XFRAME (w
->frame
);
2580 /* Extra space between lines (on window systems only). */
2581 if (base_face_id
== DEFAULT_FACE_ID
2582 && FRAME_WINDOW_P (it
->f
))
2584 if (NATNUMP (current_buffer
->extra_line_spacing
))
2585 it
->extra_line_spacing
= XFASTINT (current_buffer
->extra_line_spacing
);
2586 else if (FLOATP (current_buffer
->extra_line_spacing
))
2587 it
->extra_line_spacing
= (XFLOAT_DATA (current_buffer
->extra_line_spacing
)
2588 * FRAME_LINE_HEIGHT (it
->f
));
2589 else if (it
->f
->extra_line_spacing
> 0)
2590 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2591 it
->max_extra_line_spacing
= 0;
2594 /* If realized faces have been removed, e.g. because of face
2595 attribute changes of named faces, recompute them. When running
2596 in batch mode, the face cache of the initial frame is null. If
2597 we happen to get called, make a dummy face cache. */
2598 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2599 init_frame_faces (it
->f
);
2600 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2601 recompute_basic_faces (it
->f
);
2603 /* Current value of the `slice', `space-width', and 'height' properties. */
2604 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2605 it
->space_width
= Qnil
;
2606 it
->font_height
= Qnil
;
2607 it
->override_ascent
= -1;
2609 /* Are control characters displayed as `^C'? */
2610 it
->ctl_arrow_p
= !NILP (current_buffer
->ctl_arrow
);
2612 /* -1 means everything between a CR and the following line end
2613 is invisible. >0 means lines indented more than this value are
2615 it
->selective
= (INTEGERP (current_buffer
->selective_display
)
2616 ? XFASTINT (current_buffer
->selective_display
)
2617 : (!NILP (current_buffer
->selective_display
)
2619 it
->selective_display_ellipsis_p
2620 = !NILP (current_buffer
->selective_display_ellipses
);
2622 /* Display table to use. */
2623 it
->dp
= window_display_table (w
);
2625 /* Are multibyte characters enabled in current_buffer? */
2626 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
2628 /* Non-zero if we should highlight the region. */
2630 = (!NILP (Vtransient_mark_mode
)
2631 && !NILP (current_buffer
->mark_active
)
2632 && XMARKER (current_buffer
->mark
)->buffer
!= 0);
2634 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2635 start and end of a visible region in window IT->w. Set both to
2636 -1 to indicate no region. */
2637 if (highlight_region_p
2638 /* Maybe highlight only in selected window. */
2639 && (/* Either show region everywhere. */
2640 highlight_nonselected_windows
2641 /* Or show region in the selected window. */
2642 || w
== XWINDOW (selected_window
)
2643 /* Or show the region if we are in the mini-buffer and W is
2644 the window the mini-buffer refers to. */
2645 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2646 && WINDOWP (minibuf_selected_window
)
2647 && w
== XWINDOW (minibuf_selected_window
))))
2649 int charpos
= marker_position (current_buffer
->mark
);
2650 it
->region_beg_charpos
= min (PT
, charpos
);
2651 it
->region_end_charpos
= max (PT
, charpos
);
2654 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2656 /* Get the position at which the redisplay_end_trigger hook should
2657 be run, if it is to be run at all. */
2658 if (MARKERP (w
->redisplay_end_trigger
)
2659 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2660 it
->redisplay_end_trigger_charpos
2661 = marker_position (w
->redisplay_end_trigger
);
2662 else if (INTEGERP (w
->redisplay_end_trigger
))
2663 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
2665 /* Correct bogus values of tab_width. */
2666 it
->tab_width
= XINT (current_buffer
->tab_width
);
2667 if (it
->tab_width
<= 0 || it
->tab_width
> 1000)
2670 /* Are lines in the display truncated? */
2671 if (base_face_id
!= DEFAULT_FACE_ID
2672 || XINT (it
->w
->hscroll
)
2673 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2674 && ((!NILP (Vtruncate_partial_width_windows
)
2675 && !INTEGERP (Vtruncate_partial_width_windows
))
2676 || (INTEGERP (Vtruncate_partial_width_windows
)
2677 && (WINDOW_TOTAL_COLS (it
->w
)
2678 < XINT (Vtruncate_partial_width_windows
))))))
2679 it
->line_wrap
= TRUNCATE
;
2680 else if (NILP (current_buffer
->truncate_lines
))
2681 it
->line_wrap
= NILP (current_buffer
->word_wrap
)
2682 ? WINDOW_WRAP
: WORD_WRAP
;
2684 it
->line_wrap
= TRUNCATE
;
2686 /* Get dimensions of truncation and continuation glyphs. These are
2687 displayed as fringe bitmaps under X, so we don't need them for such
2689 if (!FRAME_WINDOW_P (it
->f
))
2691 if (it
->line_wrap
== TRUNCATE
)
2693 /* We will need the truncation glyph. */
2694 xassert (it
->glyph_row
== NULL
);
2695 produce_special_glyphs (it
, IT_TRUNCATION
);
2696 it
->truncation_pixel_width
= it
->pixel_width
;
2700 /* We will need the continuation glyph. */
2701 xassert (it
->glyph_row
== NULL
);
2702 produce_special_glyphs (it
, IT_CONTINUATION
);
2703 it
->continuation_pixel_width
= it
->pixel_width
;
2706 /* Reset these values to zero because the produce_special_glyphs
2707 above has changed them. */
2708 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2709 it
->phys_ascent
= it
->phys_descent
= 0;
2712 /* Set this after getting the dimensions of truncation and
2713 continuation glyphs, so that we don't produce glyphs when calling
2714 produce_special_glyphs, above. */
2715 it
->glyph_row
= row
;
2716 it
->area
= TEXT_AREA
;
2718 /* Get the dimensions of the display area. The display area
2719 consists of the visible window area plus a horizontally scrolled
2720 part to the left of the window. All x-values are relative to the
2721 start of this total display area. */
2722 if (base_face_id
!= DEFAULT_FACE_ID
)
2724 /* Mode lines, menu bar in terminal frames. */
2725 it
->first_visible_x
= 0;
2726 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2731 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2732 it
->last_visible_x
= (it
->first_visible_x
2733 + window_box_width (w
, TEXT_AREA
));
2735 /* If we truncate lines, leave room for the truncator glyph(s) at
2736 the right margin. Otherwise, leave room for the continuation
2737 glyph(s). Truncation and continuation glyphs are not inserted
2738 for window-based redisplay. */
2739 if (!FRAME_WINDOW_P (it
->f
))
2741 if (it
->line_wrap
== TRUNCATE
)
2742 it
->last_visible_x
-= it
->truncation_pixel_width
;
2744 it
->last_visible_x
-= it
->continuation_pixel_width
;
2747 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2748 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2751 /* Leave room for a border glyph. */
2752 if (!FRAME_WINDOW_P (it
->f
)
2753 && !WINDOW_RIGHTMOST_P (it
->w
))
2754 it
->last_visible_x
-= 1;
2756 it
->last_visible_y
= window_text_bottom_y (w
);
2758 /* For mode lines and alike, arrange for the first glyph having a
2759 left box line if the face specifies a box. */
2760 if (base_face_id
!= DEFAULT_FACE_ID
)
2764 it
->face_id
= remapped_base_face_id
;
2766 /* If we have a boxed mode line, make the first character appear
2767 with a left box line. */
2768 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2769 if (face
->box
!= FACE_NO_BOX
)
2770 it
->start_of_box_run_p
= 1;
2773 /* If a buffer position was specified, set the iterator there,
2774 getting overlays and face properties from that position. */
2775 if (charpos
>= BUF_BEG (current_buffer
))
2777 it
->end_charpos
= ZV
;
2779 IT_CHARPOS (*it
) = charpos
;
2781 /* Compute byte position if not specified. */
2782 if (bytepos
< charpos
)
2783 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2785 IT_BYTEPOS (*it
) = bytepos
;
2787 it
->start
= it
->current
;
2789 /* Compute faces etc. */
2790 reseat (it
, it
->current
.pos
, 1);
2797 /* Initialize IT for the display of window W with window start POS. */
2800 start_display (it
, w
, pos
)
2803 struct text_pos pos
;
2805 struct glyph_row
*row
;
2806 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2808 row
= w
->desired_matrix
->rows
+ first_vpos
;
2809 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2810 it
->first_vpos
= first_vpos
;
2812 /* Don't reseat to previous visible line start if current start
2813 position is in a string or image. */
2814 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2816 int start_at_line_beg_p
;
2817 int first_y
= it
->current_y
;
2819 /* If window start is not at a line start, skip forward to POS to
2820 get the correct continuation lines width. */
2821 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2822 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2823 if (!start_at_line_beg_p
)
2827 reseat_at_previous_visible_line_start (it
);
2828 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2830 new_x
= it
->current_x
+ it
->pixel_width
;
2832 /* If lines are continued, this line may end in the middle
2833 of a multi-glyph character (e.g. a control character
2834 displayed as \003, or in the middle of an overlay
2835 string). In this case move_it_to above will not have
2836 taken us to the start of the continuation line but to the
2837 end of the continued line. */
2838 if (it
->current_x
> 0
2839 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2840 && (/* And glyph doesn't fit on the line. */
2841 new_x
> it
->last_visible_x
2842 /* Or it fits exactly and we're on a window
2844 || (new_x
== it
->last_visible_x
2845 && FRAME_WINDOW_P (it
->f
))))
2847 if (it
->current
.dpvec_index
>= 0
2848 || it
->current
.overlay_string_index
>= 0)
2850 set_iterator_to_next (it
, 1);
2851 move_it_in_display_line_to (it
, -1, -1, 0);
2854 it
->continuation_lines_width
+= it
->current_x
;
2857 /* We're starting a new display line, not affected by the
2858 height of the continued line, so clear the appropriate
2859 fields in the iterator structure. */
2860 it
->max_ascent
= it
->max_descent
= 0;
2861 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2863 it
->current_y
= first_y
;
2865 it
->current_x
= it
->hpos
= 0;
2869 #if 0 /* Don't assert the following because start_display is sometimes
2870 called intentionally with a window start that is not at a
2871 line start. Please leave this code in as a comment. */
2873 /* Window start should be on a line start, now. */
2874 xassert (it
->continuation_lines_width
2875 || IT_CHARPOS (it
) == BEGV
2876 || FETCH_BYTE (IT_BYTEPOS (it
) - 1) == '\n');
2881 /* Return 1 if POS is a position in ellipses displayed for invisible
2882 text. W is the window we display, for text property lookup. */
2885 in_ellipses_for_invisible_text_p (pos
, w
)
2886 struct display_pos
*pos
;
2889 Lisp_Object prop
, window
;
2891 int charpos
= CHARPOS (pos
->pos
);
2893 /* If POS specifies a position in a display vector, this might
2894 be for an ellipsis displayed for invisible text. We won't
2895 get the iterator set up for delivering that ellipsis unless
2896 we make sure that it gets aware of the invisible text. */
2897 if (pos
->dpvec_index
>= 0
2898 && pos
->overlay_string_index
< 0
2899 && CHARPOS (pos
->string_pos
) < 0
2901 && (XSETWINDOW (window
, w
),
2902 prop
= Fget_char_property (make_number (charpos
),
2903 Qinvisible
, window
),
2904 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2906 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2908 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2915 /* Initialize IT for stepping through current_buffer in window W,
2916 starting at position POS that includes overlay string and display
2917 vector/ control character translation position information. Value
2918 is zero if there are overlay strings with newlines at POS. */
2921 init_from_display_pos (it
, w
, pos
)
2924 struct display_pos
*pos
;
2926 int charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
2927 int i
, overlay_strings_with_newlines
= 0;
2929 /* If POS specifies a position in a display vector, this might
2930 be for an ellipsis displayed for invisible text. We won't
2931 get the iterator set up for delivering that ellipsis unless
2932 we make sure that it gets aware of the invisible text. */
2933 if (in_ellipses_for_invisible_text_p (pos
, w
))
2939 /* Keep in mind: the call to reseat in init_iterator skips invisible
2940 text, so we might end up at a position different from POS. This
2941 is only a problem when POS is a row start after a newline and an
2942 overlay starts there with an after-string, and the overlay has an
2943 invisible property. Since we don't skip invisible text in
2944 display_line and elsewhere immediately after consuming the
2945 newline before the row start, such a POS will not be in a string,
2946 but the call to init_iterator below will move us to the
2948 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
2950 /* This only scans the current chunk -- it should scan all chunks.
2951 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
2952 to 16 in 22.1 to make this a lesser problem. */
2953 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
2955 const char *s
= SDATA (it
->overlay_strings
[i
]);
2956 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
2958 while (s
< e
&& *s
!= '\n')
2963 overlay_strings_with_newlines
= 1;
2968 /* If position is within an overlay string, set up IT to the right
2970 if (pos
->overlay_string_index
>= 0)
2974 /* If the first overlay string happens to have a `display'
2975 property for an image, the iterator will be set up for that
2976 image, and we have to undo that setup first before we can
2977 correct the overlay string index. */
2978 if (it
->method
== GET_FROM_IMAGE
)
2981 /* We already have the first chunk of overlay strings in
2982 IT->overlay_strings. Load more until the one for
2983 pos->overlay_string_index is in IT->overlay_strings. */
2984 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
2986 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
2987 it
->current
.overlay_string_index
= 0;
2990 load_overlay_strings (it
, 0);
2991 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
2995 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
2996 relative_index
= (it
->current
.overlay_string_index
2997 % OVERLAY_STRING_CHUNK_SIZE
);
2998 it
->string
= it
->overlay_strings
[relative_index
];
2999 xassert (STRINGP (it
->string
));
3000 it
->current
.string_pos
= pos
->string_pos
;
3001 it
->method
= GET_FROM_STRING
;
3004 #if 0 /* This is bogus because POS not having an overlay string
3005 position does not mean it's after the string. Example: A
3006 line starting with a before-string and initialization of IT
3007 to the previous row's end position. */
3008 else if (it
->current
.overlay_string_index
>= 0)
3010 /* If POS says we're already after an overlay string ending at
3011 POS, make sure to pop the iterator because it will be in
3012 front of that overlay string. When POS is ZV, we've thereby
3013 also ``processed'' overlay strings at ZV. */
3016 xassert (it
->current
.overlay_string_index
== -1);
3017 xassert (it
->method
== GET_FROM_BUFFER
);
3018 if (CHARPOS (pos
->pos
) == ZV
)
3019 it
->overlay_strings_at_end_processed_p
= 1;
3023 if (CHARPOS (pos
->string_pos
) >= 0)
3025 /* Recorded position is not in an overlay string, but in another
3026 string. This can only be a string from a `display' property.
3027 IT should already be filled with that string. */
3028 it
->current
.string_pos
= pos
->string_pos
;
3029 xassert (STRINGP (it
->string
));
3032 /* Restore position in display vector translations, control
3033 character translations or ellipses. */
3034 if (pos
->dpvec_index
>= 0)
3036 if (it
->dpvec
== NULL
)
3037 get_next_display_element (it
);
3038 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3039 it
->current
.dpvec_index
= pos
->dpvec_index
;
3043 return !overlay_strings_with_newlines
;
3047 /* Initialize IT for stepping through current_buffer in window W
3048 starting at ROW->start. */
3051 init_to_row_start (it
, w
, row
)
3054 struct glyph_row
*row
;
3056 init_from_display_pos (it
, w
, &row
->start
);
3057 it
->start
= row
->start
;
3058 it
->continuation_lines_width
= row
->continuation_lines_width
;
3063 /* Initialize IT for stepping through current_buffer in window W
3064 starting in the line following ROW, i.e. starting at ROW->end.
3065 Value is zero if there are overlay strings with newlines at ROW's
3069 init_to_row_end (it
, w
, row
)
3072 struct glyph_row
*row
;
3076 if (init_from_display_pos (it
, w
, &row
->end
))
3078 if (row
->continued_p
)
3079 it
->continuation_lines_width
3080 = row
->continuation_lines_width
+ row
->pixel_width
;
3091 /***********************************************************************
3093 ***********************************************************************/
3095 /* Called when IT reaches IT->stop_charpos. Handle text property and
3096 overlay changes. Set IT->stop_charpos to the next position where
3103 enum prop_handled handled
;
3104 int handle_overlay_change_p
;
3108 it
->current
.dpvec_index
= -1;
3109 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3110 it
->ignore_overlay_strings_at_pos_p
= 0;
3112 /* Use face of preceding text for ellipsis (if invisible) */
3113 if (it
->selective_display_ellipsis_p
)
3114 it
->saved_face_id
= it
->face_id
;
3118 handled
= HANDLED_NORMALLY
;
3120 /* Call text property handlers. */
3121 for (p
= it_props
; p
->handler
; ++p
)
3123 handled
= p
->handler (it
);
3125 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3127 else if (handled
== HANDLED_RETURN
)
3129 /* We still want to show before and after strings from
3130 overlays even if the actual buffer text is replaced. */
3131 if (!handle_overlay_change_p
|| it
->sp
> 1)
3133 if (!get_overlay_strings_1 (it
, 0, 0))
3135 it
->ignore_overlay_strings_at_pos_p
= 1;
3136 it
->string_from_display_prop_p
= 0;
3137 handle_overlay_change_p
= 0;
3138 handled
= HANDLED_RECOMPUTE_PROPS
;
3141 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3142 handle_overlay_change_p
= 0;
3145 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3147 /* Don't check for overlay strings below when set to deliver
3148 characters from a display vector. */
3149 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3150 handle_overlay_change_p
= 0;
3152 /* Handle overlay changes.
3153 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3154 if it finds overlays. */
3155 if (handle_overlay_change_p
)
3156 handled
= handle_overlay_change (it
);
3159 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3161 /* Determine where to stop next. */
3162 if (handled
== HANDLED_NORMALLY
)
3163 compute_stop_pos (it
);
3167 /* Compute IT->stop_charpos from text property and overlay change
3168 information for IT's current position. */
3171 compute_stop_pos (it
)
3174 register INTERVAL iv
, next_iv
;
3175 Lisp_Object object
, limit
, position
;
3177 /* If nowhere else, stop at the end. */
3178 it
->stop_charpos
= it
->end_charpos
;
3180 if (STRINGP (it
->string
))
3182 /* Strings are usually short, so don't limit the search for
3184 object
= it
->string
;
3186 position
= make_number (IT_STRING_CHARPOS (*it
));
3192 /* If next overlay change is in front of the current stop pos
3193 (which is IT->end_charpos), stop there. Note: value of
3194 next_overlay_change is point-max if no overlay change
3196 charpos
= next_overlay_change (IT_CHARPOS (*it
));
3197 if (charpos
< it
->stop_charpos
)
3198 it
->stop_charpos
= charpos
;
3200 /* If showing the region, we have to stop at the region
3201 start or end because the face might change there. */
3202 if (it
->region_beg_charpos
> 0)
3204 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3205 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3206 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3207 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3210 /* Set up variables for computing the stop position from text
3211 property changes. */
3212 XSETBUFFER (object
, current_buffer
);
3213 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3214 position
= make_number (IT_CHARPOS (*it
));
3218 /* Get the interval containing IT's position. Value is a null
3219 interval if there isn't such an interval. */
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 xassert (STRINGP (it
->string
)
3264 || (it
->stop_charpos
>= BEGV
3265 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3269 /* Return the position of the next overlay change after POS in
3270 current_buffer. Value is point-max if no overlay change
3271 follows. This is like `next-overlay-change' but doesn't use
3275 next_overlay_change (pos
)
3280 Lisp_Object
*overlays
;
3283 /* Get all overlays at the given position. */
3284 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3286 /* If any of these overlays ends before endpos,
3287 use its ending point instead. */
3288 for (i
= 0; i
< noverlays
; ++i
)
3293 oend
= OVERLAY_END (overlays
[i
]);
3294 oendpos
= OVERLAY_POSITION (oend
);
3295 endpos
= min (endpos
, oendpos
);
3303 /***********************************************************************
3305 ***********************************************************************/
3307 /* Handle changes in the `fontified' property of the current buffer by
3308 calling hook functions from Qfontification_functions to fontify
3311 static enum prop_handled
3312 handle_fontified_prop (it
)
3315 Lisp_Object prop
, pos
;
3316 enum prop_handled handled
= HANDLED_NORMALLY
;
3318 if (!NILP (Vmemory_full
))
3321 /* Get the value of the `fontified' property at IT's current buffer
3322 position. (The `fontified' property doesn't have a special
3323 meaning in strings.) If the value is nil, call functions from
3324 Qfontification_functions. */
3325 if (!STRINGP (it
->string
)
3327 && !NILP (Vfontification_functions
)
3328 && !NILP (Vrun_hooks
)
3329 && (pos
= make_number (IT_CHARPOS (*it
)),
3330 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3331 /* Ignore the special cased nil value always present at EOB since
3332 no amount of fontifying will be able to change it. */
3333 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3335 int count
= SPECPDL_INDEX ();
3338 val
= Vfontification_functions
;
3339 specbind (Qfontification_functions
, Qnil
);
3341 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3342 safe_call1 (val
, pos
);
3345 Lisp_Object globals
, fn
;
3346 struct gcpro gcpro1
, gcpro2
;
3349 GCPRO2 (val
, globals
);
3351 for (; CONSP (val
); val
= XCDR (val
))
3357 /* A value of t indicates this hook has a local
3358 binding; it means to run the global binding too.
3359 In a global value, t should not occur. If it
3360 does, we must ignore it to avoid an endless
3362 for (globals
= Fdefault_value (Qfontification_functions
);
3364 globals
= XCDR (globals
))
3366 fn
= XCAR (globals
);
3368 safe_call1 (fn
, pos
);
3372 safe_call1 (fn
, pos
);
3378 unbind_to (count
, Qnil
);
3380 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3381 something. This avoids an endless loop if they failed to
3382 fontify the text for which reason ever. */
3383 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3384 handled
= HANDLED_RECOMPUTE_PROPS
;
3392 /***********************************************************************
3394 ***********************************************************************/
3396 /* Set up iterator IT from face properties at its current position.
3397 Called from handle_stop. */
3399 static enum prop_handled
3400 handle_face_prop (it
)
3404 EMACS_INT next_stop
;
3406 if (!STRINGP (it
->string
))
3409 = face_at_buffer_position (it
->w
,
3411 it
->region_beg_charpos
,
3412 it
->region_end_charpos
,
3415 + TEXT_PROP_DISTANCE_LIMIT
),
3418 /* Is this a start of a run of characters with box face?
3419 Caveat: this can be called for a freshly initialized
3420 iterator; face_id is -1 in this case. We know that the new
3421 face will not change until limit, i.e. if the new face has a
3422 box, all characters up to limit will have one. But, as
3423 usual, we don't know whether limit is really the end. */
3424 if (new_face_id
!= it
->face_id
)
3426 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3428 /* If new face has a box but old face has not, this is
3429 the start of a run of characters with box, i.e. it has
3430 a shadow on the left side. The value of face_id of the
3431 iterator will be -1 if this is the initial call that gets
3432 the face. In this case, we have to look in front of IT's
3433 position and see whether there is a face != new_face_id. */
3434 it
->start_of_box_run_p
3435 = (new_face
->box
!= FACE_NO_BOX
3436 && (it
->face_id
>= 0
3437 || IT_CHARPOS (*it
) == BEG
3438 || new_face_id
!= face_before_it_pos (it
)));
3439 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3444 int base_face_id
, bufpos
;
3446 Lisp_Object from_overlay
3447 = (it
->current
.overlay_string_index
>= 0
3448 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3451 /* See if we got to this string directly or indirectly from
3452 an overlay property. That includes the before-string or
3453 after-string of an overlay, strings in display properties
3454 provided by an overlay, their text properties, etc.
3456 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3457 if (! NILP (from_overlay
))
3458 for (i
= it
->sp
- 1; i
>= 0; i
--)
3460 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3462 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3463 else if (! NILP (it
->stack
[i
].from_overlay
))
3464 from_overlay
= it
->stack
[i
].from_overlay
;
3466 if (!NILP (from_overlay
))
3470 if (! NILP (from_overlay
))
3472 bufpos
= IT_CHARPOS (*it
);
3473 /* For a string from an overlay, the base face depends
3474 only on text properties and ignores overlays. */
3476 = face_for_overlay_string (it
->w
,
3478 it
->region_beg_charpos
,
3479 it
->region_end_charpos
,
3482 + TEXT_PROP_DISTANCE_LIMIT
),
3490 /* For strings from a `display' property, use the face at
3491 IT's current buffer position as the base face to merge
3492 with, so that overlay strings appear in the same face as
3493 surrounding text, unless they specify their own
3495 base_face_id
= underlying_face_id (it
);
3498 new_face_id
= face_at_string_position (it
->w
,
3500 IT_STRING_CHARPOS (*it
),
3502 it
->region_beg_charpos
,
3503 it
->region_end_charpos
,
3507 #if 0 /* This shouldn't be neccessary. Let's check it. */
3508 /* If IT is used to display a mode line we would really like to
3509 use the mode line face instead of the frame's default face. */
3510 if (it
->glyph_row
== MATRIX_MODE_LINE_ROW (it
->w
->desired_matrix
)
3511 && new_face_id
== DEFAULT_FACE_ID
)
3512 new_face_id
= CURRENT_MODE_LINE_FACE_ID (it
->w
);
3515 /* Is this a start of a run of characters with box? Caveat:
3516 this can be called for a freshly allocated iterator; face_id
3517 is -1 is this case. We know that the new face will not
3518 change until the next check pos, i.e. if the new face has a
3519 box, all characters up to that position will have a
3520 box. But, as usual, we don't know whether that position
3521 is really the end. */
3522 if (new_face_id
!= it
->face_id
)
3524 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3525 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3527 /* If new face has a box but old face hasn't, this is the
3528 start of a run of characters with box, i.e. it has a
3529 shadow on the left side. */
3530 it
->start_of_box_run_p
3531 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3532 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3536 it
->face_id
= new_face_id
;
3537 return HANDLED_NORMALLY
;
3541 /* Return the ID of the face ``underlying'' IT's current position,
3542 which is in a string. If the iterator is associated with a
3543 buffer, return the face at IT's current buffer position.
3544 Otherwise, use the iterator's base_face_id. */
3547 underlying_face_id (it
)
3550 int face_id
= it
->base_face_id
, i
;
3552 xassert (STRINGP (it
->string
));
3554 for (i
= it
->sp
- 1; i
>= 0; --i
)
3555 if (NILP (it
->stack
[i
].string
))
3556 face_id
= it
->stack
[i
].face_id
;
3562 /* Compute the face one character before or after the current position
3563 of IT. BEFORE_P non-zero means get the face in front of IT's
3564 position. Value is the id of the face. */
3567 face_before_or_after_it_pos (it
, before_p
)
3572 EMACS_INT next_check_charpos
;
3573 struct text_pos pos
;
3575 xassert (it
->s
== NULL
);
3577 if (STRINGP (it
->string
))
3579 int bufpos
, base_face_id
;
3581 /* No face change past the end of the string (for the case
3582 we are padding with spaces). No face change before the
3584 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3585 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3588 /* Set pos to the position before or after IT's current position. */
3590 pos
= string_pos (IT_STRING_CHARPOS (*it
) - 1, it
->string
);
3592 /* For composition, we must check the character after the
3594 pos
= (it
->what
== IT_COMPOSITION
3595 ? string_pos (IT_STRING_CHARPOS (*it
) + it
->cmp_len
, it
->string
)
3596 : string_pos (IT_STRING_CHARPOS (*it
) + 1, it
->string
));
3598 if (it
->current
.overlay_string_index
>= 0)
3599 bufpos
= IT_CHARPOS (*it
);
3603 base_face_id
= underlying_face_id (it
);
3605 /* Get the face for ASCII, or unibyte. */
3606 face_id
= face_at_string_position (it
->w
,
3610 it
->region_beg_charpos
,
3611 it
->region_end_charpos
,
3612 &next_check_charpos
,
3615 /* Correct the face for charsets different from ASCII. Do it
3616 for the multibyte case only. The face returned above is
3617 suitable for unibyte text if IT->string is unibyte. */
3618 if (STRING_MULTIBYTE (it
->string
))
3620 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos
);
3621 int rest
= SBYTES (it
->string
) - BYTEPOS (pos
);
3623 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3625 c
= string_char_and_length (p
, rest
, &len
);
3626 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), it
->string
);
3631 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3632 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3635 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3636 pos
= it
->current
.pos
;
3639 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3642 if (it
->what
== IT_COMPOSITION
)
3643 /* For composition, we must check the position after the
3645 pos
.charpos
+= it
->cmp_len
, pos
.bytepos
+= it
->len
;
3647 INC_TEXT_POS (pos
, it
->multibyte_p
);
3650 /* Determine face for CHARSET_ASCII, or unibyte. */
3651 face_id
= face_at_buffer_position (it
->w
,
3653 it
->region_beg_charpos
,
3654 it
->region_end_charpos
,
3655 &next_check_charpos
,
3658 /* Correct the face for charsets different from ASCII. Do it
3659 for the multibyte case only. The face returned above is
3660 suitable for unibyte text if current_buffer is unibyte. */
3661 if (it
->multibyte_p
)
3663 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3664 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3665 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3674 /***********************************************************************
3676 ***********************************************************************/
3678 /* Set up iterator IT from invisible properties at its current
3679 position. Called from handle_stop. */
3681 static enum prop_handled
3682 handle_invisible_prop (it
)
3685 enum prop_handled handled
= HANDLED_NORMALLY
;
3687 if (STRINGP (it
->string
))
3689 extern Lisp_Object Qinvisible
;
3690 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3692 /* Get the value of the invisible text property at the
3693 current position. Value will be nil if there is no such
3695 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3696 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3699 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3701 handled
= HANDLED_RECOMPUTE_PROPS
;
3703 /* Get the position at which the next change of the
3704 invisible text property can be found in IT->string.
3705 Value will be nil if the property value is the same for
3706 all the rest of IT->string. */
3707 XSETINT (limit
, SCHARS (it
->string
));
3708 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3711 /* Text at current position is invisible. The next
3712 change in the property is at position end_charpos.
3713 Move IT's current position to that position. */
3714 if (INTEGERP (end_charpos
)
3715 && XFASTINT (end_charpos
) < XFASTINT (limit
))
3717 struct text_pos old
;
3718 old
= it
->current
.string_pos
;
3719 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3720 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
3724 /* The rest of the string is invisible. If this is an
3725 overlay string, proceed with the next overlay string
3726 or whatever comes and return a character from there. */
3727 if (it
->current
.overlay_string_index
>= 0)
3729 next_overlay_string (it
);
3730 /* Don't check for overlay strings when we just
3731 finished processing them. */
3732 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
3736 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
3737 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
3745 EMACS_INT newpos
, next_stop
, start_charpos
;
3746 Lisp_Object pos
, prop
, overlay
;
3748 /* First of all, is there invisible text at this position? */
3749 start_charpos
= IT_CHARPOS (*it
);
3750 pos
= make_number (IT_CHARPOS (*it
));
3751 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
3753 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3755 /* If we are on invisible text, skip over it. */
3756 if (invis_p
&& IT_CHARPOS (*it
) < it
->end_charpos
)
3758 /* Record whether we have to display an ellipsis for the
3760 int display_ellipsis_p
= invis_p
== 2;
3762 handled
= HANDLED_RECOMPUTE_PROPS
;
3764 /* Loop skipping over invisible text. The loop is left at
3765 ZV or with IT on the first char being visible again. */
3768 /* Try to skip some invisible text. Return value is the
3769 position reached which can be equal to IT's position
3770 if there is nothing invisible here. This skips both
3771 over invisible text properties and overlays with
3772 invisible property. */
3773 newpos
= skip_invisible (IT_CHARPOS (*it
),
3774 &next_stop
, ZV
, it
->window
);
3776 /* If we skipped nothing at all we weren't at invisible
3777 text in the first place. If everything to the end of
3778 the buffer was skipped, end the loop. */
3779 if (newpos
== IT_CHARPOS (*it
) || newpos
>= ZV
)
3783 /* We skipped some characters but not necessarily
3784 all there are. Check if we ended up on visible
3785 text. Fget_char_property returns the property of
3786 the char before the given position, i.e. if we
3787 get invis_p = 0, this means that the char at
3788 newpos is visible. */
3789 pos
= make_number (newpos
);
3790 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
3791 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3794 /* If we ended up on invisible text, proceed to
3795 skip starting with next_stop. */
3797 IT_CHARPOS (*it
) = next_stop
;
3799 /* If there are adjacent invisible texts, don't lose the
3800 second one's ellipsis. */
3802 display_ellipsis_p
= 1;
3806 /* The position newpos is now either ZV or on visible text. */
3807 IT_CHARPOS (*it
) = newpos
;
3808 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
3810 /* If there are before-strings at the start of invisible
3811 text, and the text is invisible because of a text
3812 property, arrange to show before-strings because 20.x did
3813 it that way. (If the text is invisible because of an
3814 overlay property instead of a text property, this is
3815 already handled in the overlay code.) */
3817 && get_overlay_strings (it
, start_charpos
))
3819 handled
= HANDLED_RECOMPUTE_PROPS
;
3820 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
3822 else if (display_ellipsis_p
)
3824 /* Make sure that the glyphs of the ellipsis will get
3825 correct `charpos' values. If we would not update
3826 it->position here, the glyphs would belong to the
3827 last visible character _before_ the invisible
3828 text, which confuses `set_cursor_from_row'.
3830 We use the last invisible position instead of the
3831 first because this way the cursor is always drawn on
3832 the first "." of the ellipsis, whenever PT is inside
3833 the invisible text. Otherwise the cursor would be
3834 placed _after_ the ellipsis when the point is after the
3835 first invisible character. */
3836 if (!STRINGP (it
->object
))
3838 it
->position
.charpos
= IT_CHARPOS (*it
) - 1;
3839 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
3841 setup_for_ellipsis (it
, 0);
3842 /* Let the ellipsis display before
3843 considering any properties of the following char.
3844 Fixes jasonr@gnu.org 01 Oct 07 bug. */
3845 handled
= HANDLED_RETURN
;
3854 /* Make iterator IT return `...' next.
3855 Replaces LEN characters from buffer. */
3858 setup_for_ellipsis (it
, len
)
3862 /* Use the display table definition for `...'. Invalid glyphs
3863 will be handled by the method returning elements from dpvec. */
3864 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
3866 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
3867 it
->dpvec
= v
->contents
;
3868 it
->dpend
= v
->contents
+ v
->size
;
3872 /* Default `...'. */
3873 it
->dpvec
= default_invis_vector
;
3874 it
->dpend
= default_invis_vector
+ 3;
3877 it
->dpvec_char_len
= len
;
3878 it
->current
.dpvec_index
= 0;
3879 it
->dpvec_face_id
= -1;
3881 /* Remember the current face id in case glyphs specify faces.
3882 IT's face is restored in set_iterator_to_next.
3883 saved_face_id was set to preceding char's face in handle_stop. */
3884 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
3885 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
3887 it
->method
= GET_FROM_DISPLAY_VECTOR
;
3893 /***********************************************************************
3895 ***********************************************************************/
3897 /* Set up iterator IT from `display' property at its current position.
3898 Called from handle_stop.
3899 We return HANDLED_RETURN if some part of the display property
3900 overrides the display of the buffer text itself.
3901 Otherwise we return HANDLED_NORMALLY. */
3903 static enum prop_handled
3904 handle_display_prop (it
)
3907 Lisp_Object prop
, object
, overlay
;
3908 struct text_pos
*position
;
3909 /* Nonzero if some property replaces the display of the text itself. */
3910 int display_replaced_p
= 0;
3912 if (STRINGP (it
->string
))
3914 object
= it
->string
;
3915 position
= &it
->current
.string_pos
;
3919 XSETWINDOW (object
, it
->w
);
3920 position
= &it
->current
.pos
;
3923 /* Reset those iterator values set from display property values. */
3924 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
3925 it
->space_width
= Qnil
;
3926 it
->font_height
= Qnil
;
3929 /* We don't support recursive `display' properties, i.e. string
3930 values that have a string `display' property, that have a string
3931 `display' property etc. */
3932 if (!it
->string_from_display_prop_p
)
3933 it
->area
= TEXT_AREA
;
3935 prop
= get_char_property_and_overlay (make_number (position
->charpos
),
3936 Qdisplay
, object
, &overlay
);
3938 return HANDLED_NORMALLY
;
3939 /* Now OVERLAY is the overlay that gave us this property, or nil
3940 if it was a text property. */
3942 if (!STRINGP (it
->string
))
3943 object
= it
->w
->buffer
;
3946 /* Simple properties. */
3947 && !EQ (XCAR (prop
), Qimage
)
3948 && !EQ (XCAR (prop
), Qspace
)
3949 && !EQ (XCAR (prop
), Qwhen
)
3950 && !EQ (XCAR (prop
), Qslice
)
3951 && !EQ (XCAR (prop
), Qspace_width
)
3952 && !EQ (XCAR (prop
), Qheight
)
3953 && !EQ (XCAR (prop
), Qraise
)
3954 /* Marginal area specifications. */
3955 && !(CONSP (XCAR (prop
)) && EQ (XCAR (XCAR (prop
)), Qmargin
))
3956 && !EQ (XCAR (prop
), Qleft_fringe
)
3957 && !EQ (XCAR (prop
), Qright_fringe
)
3958 && !NILP (XCAR (prop
)))
3960 for (; CONSP (prop
); prop
= XCDR (prop
))
3962 if (handle_single_display_spec (it
, XCAR (prop
), object
, overlay
,
3963 position
, display_replaced_p
))
3965 display_replaced_p
= 1;
3966 /* If some text in a string is replaced, `position' no
3967 longer points to the position of `object'. */
3968 if (STRINGP (object
))
3973 else if (VECTORP (prop
))
3976 for (i
= 0; i
< ASIZE (prop
); ++i
)
3977 if (handle_single_display_spec (it
, AREF (prop
, i
), object
, overlay
,
3978 position
, display_replaced_p
))
3980 display_replaced_p
= 1;
3981 /* If some text in a string is replaced, `position' no
3982 longer points to the position of `object'. */
3983 if (STRINGP (object
))
3989 int ret
= handle_single_display_spec (it
, prop
, object
, overlay
,
3991 if (ret
< 0) /* Replaced by "", i.e. nothing. */
3992 return HANDLED_RECOMPUTE_PROPS
;
3994 display_replaced_p
= 1;
3997 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4001 /* Value is the position of the end of the `display' property starting
4002 at START_POS in OBJECT. */
4004 static struct text_pos
4005 display_prop_end (it
, object
, start_pos
)
4008 struct text_pos start_pos
;
4011 struct text_pos end_pos
;
4013 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4014 Qdisplay
, object
, Qnil
);
4015 CHARPOS (end_pos
) = XFASTINT (end
);
4016 if (STRINGP (object
))
4017 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4019 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4025 /* Set up IT from a single `display' specification PROP. OBJECT
4026 is the object in which the `display' property was found. *POSITION
4027 is the position at which it was found. DISPLAY_REPLACED_P non-zero
4028 means that we previously saw a display specification which already
4029 replaced text display with something else, for example an image;
4030 we ignore such properties after the first one has been processed.
4032 OVERLAY is the overlay this `display' property came from,
4033 or nil if it was a text property.
4035 If PROP is a `space' or `image' specification, and in some other
4036 cases too, set *POSITION to the position where the `display'
4039 Value is non-zero if something was found which replaces the display
4040 of buffer or string text. Specifically, the value is -1 if that
4041 "something" is "nothing". */
4044 handle_single_display_spec (it
, spec
, object
, overlay
, position
,
4045 display_replaced_before_p
)
4049 Lisp_Object overlay
;
4050 struct text_pos
*position
;
4051 int display_replaced_before_p
;
4054 Lisp_Object location
, value
;
4055 struct text_pos start_pos
, save_pos
;
4058 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4059 If the result is non-nil, use VALUE instead of SPEC. */
4061 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4070 if (!NILP (form
) && !EQ (form
, Qt
))
4072 int count
= SPECPDL_INDEX ();
4073 struct gcpro gcpro1
;
4075 /* Bind `object' to the object having the `display' property, a
4076 buffer or string. Bind `position' to the position in the
4077 object where the property was found, and `buffer-position'
4078 to the current position in the buffer. */
4079 specbind (Qobject
, object
);
4080 specbind (Qposition
, make_number (CHARPOS (*position
)));
4081 specbind (Qbuffer_position
,
4082 make_number (STRINGP (object
)
4083 ? IT_CHARPOS (*it
) : CHARPOS (*position
)));
4085 form
= safe_eval (form
);
4087 unbind_to (count
, Qnil
);
4093 /* Handle `(height HEIGHT)' specifications. */
4095 && EQ (XCAR (spec
), Qheight
)
4096 && CONSP (XCDR (spec
)))
4098 if (!FRAME_WINDOW_P (it
->f
))
4101 it
->font_height
= XCAR (XCDR (spec
));
4102 if (!NILP (it
->font_height
))
4104 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4105 int new_height
= -1;
4107 if (CONSP (it
->font_height
)
4108 && (EQ (XCAR (it
->font_height
), Qplus
)
4109 || EQ (XCAR (it
->font_height
), Qminus
))
4110 && CONSP (XCDR (it
->font_height
))
4111 && INTEGERP (XCAR (XCDR (it
->font_height
))))
4113 /* `(+ N)' or `(- N)' where N is an integer. */
4114 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4115 if (EQ (XCAR (it
->font_height
), Qplus
))
4117 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4119 else if (FUNCTIONP (it
->font_height
))
4121 /* Call function with current height as argument.
4122 Value is the new height. */
4124 height
= safe_call1 (it
->font_height
,
4125 face
->lface
[LFACE_HEIGHT_INDEX
]);
4126 if (NUMBERP (height
))
4127 new_height
= XFLOATINT (height
);
4129 else if (NUMBERP (it
->font_height
))
4131 /* Value is a multiple of the canonical char height. */
4134 face
= FACE_FROM_ID (it
->f
,
4135 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4136 new_height
= (XFLOATINT (it
->font_height
)
4137 * XINT (face
->lface
[LFACE_HEIGHT_INDEX
]));
4141 /* Evaluate IT->font_height with `height' bound to the
4142 current specified height to get the new height. */
4143 int count
= SPECPDL_INDEX ();
4145 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4146 value
= safe_eval (it
->font_height
);
4147 unbind_to (count
, Qnil
);
4149 if (NUMBERP (value
))
4150 new_height
= XFLOATINT (value
);
4154 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4160 /* Handle `(space-width WIDTH)'. */
4162 && EQ (XCAR (spec
), Qspace_width
)
4163 && CONSP (XCDR (spec
)))
4165 if (!FRAME_WINDOW_P (it
->f
))
4168 value
= XCAR (XCDR (spec
));
4169 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4170 it
->space_width
= value
;
4175 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4177 && EQ (XCAR (spec
), Qslice
))
4181 if (!FRAME_WINDOW_P (it
->f
))
4184 if (tem
= XCDR (spec
), CONSP (tem
))
4186 it
->slice
.x
= XCAR (tem
);
4187 if (tem
= XCDR (tem
), CONSP (tem
))
4189 it
->slice
.y
= XCAR (tem
);
4190 if (tem
= XCDR (tem
), CONSP (tem
))
4192 it
->slice
.width
= XCAR (tem
);
4193 if (tem
= XCDR (tem
), CONSP (tem
))
4194 it
->slice
.height
= XCAR (tem
);
4202 /* Handle `(raise FACTOR)'. */
4204 && EQ (XCAR (spec
), Qraise
)
4205 && CONSP (XCDR (spec
)))
4207 if (!FRAME_WINDOW_P (it
->f
))
4210 #ifdef HAVE_WINDOW_SYSTEM
4211 value
= XCAR (XCDR (spec
));
4212 if (NUMBERP (value
))
4214 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4215 it
->voffset
= - (XFLOATINT (value
)
4216 * (FONT_HEIGHT (face
->font
)));
4218 #endif /* HAVE_WINDOW_SYSTEM */
4223 /* Don't handle the other kinds of display specifications
4224 inside a string that we got from a `display' property. */
4225 if (it
->string_from_display_prop_p
)
4228 /* Characters having this form of property are not displayed, so
4229 we have to find the end of the property. */
4230 start_pos
= *position
;
4231 *position
= display_prop_end (it
, object
, start_pos
);
4234 /* Stop the scan at that end position--we assume that all
4235 text properties change there. */
4236 it
->stop_charpos
= position
->charpos
;
4238 /* Handle `(left-fringe BITMAP [FACE])'
4239 and `(right-fringe BITMAP [FACE])'. */
4241 && (EQ (XCAR (spec
), Qleft_fringe
)
4242 || EQ (XCAR (spec
), Qright_fringe
))
4243 && CONSP (XCDR (spec
)))
4245 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
4248 if (!FRAME_WINDOW_P (it
->f
))
4249 /* If we return here, POSITION has been advanced
4250 across the text with this property. */
4253 #ifdef HAVE_WINDOW_SYSTEM
4254 value
= XCAR (XCDR (spec
));
4255 if (!SYMBOLP (value
)
4256 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4257 /* If we return here, POSITION has been advanced
4258 across the text with this property. */
4261 if (CONSP (XCDR (XCDR (spec
))))
4263 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4264 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4270 /* Save current settings of IT so that we can restore them
4271 when we are finished with the glyph property value. */
4273 save_pos
= it
->position
;
4274 it
->position
= *position
;
4276 it
->position
= save_pos
;
4278 it
->area
= TEXT_AREA
;
4279 it
->what
= IT_IMAGE
;
4280 it
->image_id
= -1; /* no image */
4281 it
->position
= start_pos
;
4282 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4283 it
->method
= GET_FROM_IMAGE
;
4284 it
->from_overlay
= Qnil
;
4285 it
->face_id
= face_id
;
4287 /* Say that we haven't consumed the characters with
4288 `display' property yet. The call to pop_it in
4289 set_iterator_to_next will clean this up. */
4290 *position
= start_pos
;
4292 if (EQ (XCAR (spec
), Qleft_fringe
))
4294 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4295 it
->left_user_fringe_face_id
= face_id
;
4299 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4300 it
->right_user_fringe_face_id
= face_id
;
4302 #endif /* HAVE_WINDOW_SYSTEM */
4306 /* Prepare to handle `((margin left-margin) ...)',
4307 `((margin right-margin) ...)' and `((margin nil) ...)'
4308 prefixes for display specifications. */
4309 location
= Qunbound
;
4310 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4314 value
= XCDR (spec
);
4316 value
= XCAR (value
);
4319 if (EQ (XCAR (tem
), Qmargin
)
4320 && (tem
= XCDR (tem
),
4321 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4323 || EQ (tem
, Qleft_margin
)
4324 || EQ (tem
, Qright_margin
))))
4328 if (EQ (location
, Qunbound
))
4334 /* After this point, VALUE is the property after any
4335 margin prefix has been stripped. It must be a string,
4336 an image specification, or `(space ...)'.
4338 LOCATION specifies where to display: `left-margin',
4339 `right-margin' or nil. */
4341 valid_p
= (STRINGP (value
)
4342 #ifdef HAVE_WINDOW_SYSTEM
4343 || (FRAME_WINDOW_P (it
->f
) && valid_image_p (value
))
4344 #endif /* not HAVE_WINDOW_SYSTEM */
4345 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4347 if (valid_p
&& !display_replaced_before_p
)
4349 /* Save current settings of IT so that we can restore them
4350 when we are finished with the glyph property value. */
4351 save_pos
= it
->position
;
4352 it
->position
= *position
;
4354 it
->position
= save_pos
;
4355 it
->from_overlay
= overlay
;
4357 if (NILP (location
))
4358 it
->area
= TEXT_AREA
;
4359 else if (EQ (location
, Qleft_margin
))
4360 it
->area
= LEFT_MARGIN_AREA
;
4362 it
->area
= RIGHT_MARGIN_AREA
;
4364 if (STRINGP (value
))
4366 if (SCHARS (value
) == 0)
4369 return -1; /* Replaced by "", i.e. nothing. */
4372 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4373 it
->current
.overlay_string_index
= -1;
4374 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4375 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4376 it
->method
= GET_FROM_STRING
;
4377 it
->stop_charpos
= 0;
4378 it
->string_from_display_prop_p
= 1;
4379 /* Say that we haven't consumed the characters with
4380 `display' property yet. The call to pop_it in
4381 set_iterator_to_next will clean this up. */
4382 if (BUFFERP (object
))
4383 *position
= start_pos
;
4385 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4387 it
->method
= GET_FROM_STRETCH
;
4389 *position
= it
->position
= start_pos
;
4391 #ifdef HAVE_WINDOW_SYSTEM
4394 it
->what
= IT_IMAGE
;
4395 it
->image_id
= lookup_image (it
->f
, value
);
4396 it
->position
= start_pos
;
4397 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4398 it
->method
= GET_FROM_IMAGE
;
4400 /* Say that we haven't consumed the characters with
4401 `display' property yet. The call to pop_it in
4402 set_iterator_to_next will clean this up. */
4403 *position
= start_pos
;
4405 #endif /* HAVE_WINDOW_SYSTEM */
4410 /* Invalid property or property not supported. Restore
4411 POSITION to what it was before. */
4412 *position
= start_pos
;
4417 /* Check if SPEC is a display sub-property value whose text should be
4418 treated as intangible. */
4421 single_display_spec_intangible_p (prop
)
4424 /* Skip over `when FORM'. */
4425 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4439 /* Skip over `margin LOCATION'. If LOCATION is in the margins,
4440 we don't need to treat text as intangible. */
4441 if (EQ (XCAR (prop
), Qmargin
))
4449 || EQ (XCAR (prop
), Qleft_margin
)
4450 || EQ (XCAR (prop
), Qright_margin
))
4454 return (CONSP (prop
)
4455 && (EQ (XCAR (prop
), Qimage
)
4456 || EQ (XCAR (prop
), Qspace
)));
4460 /* Check if PROP is a display property value whose text should be
4461 treated as intangible. */
4464 display_prop_intangible_p (prop
)
4468 && CONSP (XCAR (prop
))
4469 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4471 /* A list of sub-properties. */
4472 while (CONSP (prop
))
4474 if (single_display_spec_intangible_p (XCAR (prop
)))
4479 else if (VECTORP (prop
))
4481 /* A vector of sub-properties. */
4483 for (i
= 0; i
< ASIZE (prop
); ++i
)
4484 if (single_display_spec_intangible_p (AREF (prop
, i
)))
4488 return single_display_spec_intangible_p (prop
);
4494 /* Return 1 if PROP is a display sub-property value containing STRING. */
4497 single_display_spec_string_p (prop
, string
)
4498 Lisp_Object prop
, string
;
4500 if (EQ (string
, prop
))
4503 /* Skip over `when FORM'. */
4504 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4513 /* Skip over `margin LOCATION'. */
4514 if (EQ (XCAR (prop
), Qmargin
))
4525 return CONSP (prop
) && EQ (XCAR (prop
), string
);
4529 /* Return 1 if STRING appears in the `display' property PROP. */
4532 display_prop_string_p (prop
, string
)
4533 Lisp_Object prop
, string
;
4536 && CONSP (XCAR (prop
))
4537 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4539 /* A list of sub-properties. */
4540 while (CONSP (prop
))
4542 if (single_display_spec_string_p (XCAR (prop
), string
))
4547 else if (VECTORP (prop
))
4549 /* A vector of sub-properties. */
4551 for (i
= 0; i
< ASIZE (prop
); ++i
)
4552 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4556 return single_display_spec_string_p (prop
, string
);
4562 /* Determine from which buffer position in W's buffer STRING comes
4563 from. AROUND_CHARPOS is an approximate position where it could
4564 be from. Value is the buffer position or 0 if it couldn't be
4567 W's buffer must be current.
4569 This function is necessary because we don't record buffer positions
4570 in glyphs generated from strings (to keep struct glyph small).
4571 This function may only use code that doesn't eval because it is
4572 called asynchronously from note_mouse_highlight. */
4575 string_buffer_position (w
, string
, around_charpos
)
4580 Lisp_Object limit
, prop
, pos
;
4581 const int MAX_DISTANCE
= 1000;
4584 pos
= make_number (around_charpos
);
4585 limit
= make_number (min (XINT (pos
) + MAX_DISTANCE
, ZV
));
4586 while (!found
&& !EQ (pos
, limit
))
4588 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4589 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4592 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
, limit
);
4597 pos
= make_number (around_charpos
);
4598 limit
= make_number (max (XINT (pos
) - MAX_DISTANCE
, BEGV
));
4599 while (!found
&& !EQ (pos
, limit
))
4601 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4602 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4605 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
4610 return found
? XINT (pos
) : 0;
4615 /***********************************************************************
4616 `composition' property
4617 ***********************************************************************/
4619 static enum prop_handled
4620 handle_auto_composed_prop (it
)
4623 enum prop_handled handled
= HANDLED_NORMALLY
;
4625 if (FUNCTIONP (Vauto_composition_function
))
4627 Lisp_Object val
= Qnil
;
4628 EMACS_INT pos
, limit
= -1;
4630 if (STRINGP (it
->string
))
4631 pos
= IT_STRING_CHARPOS (*it
);
4633 pos
= IT_CHARPOS (*it
);
4635 val
= Fget_text_property (make_number (pos
), Qauto_composed
, it
->string
);
4638 Lisp_Object cmp_prop
;
4639 EMACS_INT cmp_start
, cmp_end
;
4641 if (get_property_and_range (pos
, Qcomposition
, &cmp_prop
,
4642 &cmp_start
, &cmp_end
, it
->string
)
4644 && COMPOSITION_METHOD (cmp_prop
) == COMPOSITION_WITH_GLYPH_STRING
)
4646 Lisp_Object gstring
= COMPOSITION_COMPONENTS (cmp_prop
);
4647 Lisp_Object font_object
= LGSTRING_FONT (gstring
);
4649 if (! EQ (font_object
,
4650 font_at (-1, pos
, FACE_FROM_ID (it
->f
, it
->face_id
),
4651 it
->w
, it
->string
)))
4652 /* We must re-compute the composition for the
4661 /* As Fnext_single_char_property_change is very slow, we
4662 limit the search to the current line. */
4663 if (STRINGP (it
->string
))
4664 limit
= SCHARS (it
->string
);
4666 limit
= find_next_newline_no_quit (pos
, 1);
4667 end
= Fnext_single_char_property_change (make_number (pos
),
4670 make_number (limit
));
4672 if (XINT (end
) < limit
)
4673 /* The current point is auto-composed, but there exist
4674 characters not yet composed beyond the
4675 auto-composed region. There's a possiblity that
4676 the last characters in the region may be newly
4681 if (NILP (val
) && ! STRINGP (it
->string
))
4684 limit
= (STRINGP (it
->string
) ? SCHARS (it
->string
)
4685 : find_next_newline_no_quit (pos
, 1));
4688 int count
= SPECPDL_INDEX ();
4689 Lisp_Object args
[5];
4691 if (FRAME_WINDOW_P (it
->f
))
4692 limit
= font_range (pos
, limit
,
4693 FACE_FROM_ID (it
->f
, it
->face_id
),
4695 args
[0] = Vauto_composition_function
;
4696 specbind (Qauto_composition_function
, Qnil
);
4697 args
[1] = make_number (pos
);
4698 args
[2] = make_number (limit
);
4699 args
[3] = it
->window
;
4700 args
[4] = it
->string
;
4701 safe_call (5, args
);
4702 unbind_to (count
, Qnil
);
4710 /* Set up iterator IT from `composition' property at its current
4711 position. Called from handle_stop. */
4713 static enum prop_handled
4714 handle_composition_prop (it
)
4717 Lisp_Object prop
, string
;
4718 EMACS_INT pos
, pos_byte
, start
, end
;
4719 enum prop_handled handled
= HANDLED_NORMALLY
;
4721 if (STRINGP (it
->string
))
4725 pos
= IT_STRING_CHARPOS (*it
);
4726 pos_byte
= IT_STRING_BYTEPOS (*it
);
4727 string
= it
->string
;
4728 s
= SDATA (string
) + pos_byte
;
4729 it
->c
= STRING_CHAR (s
, 0);
4733 pos
= IT_CHARPOS (*it
);
4734 pos_byte
= IT_BYTEPOS (*it
);
4736 it
->c
= FETCH_CHAR (pos_byte
);
4739 /* If there's a valid composition and point is not inside of the
4740 composition (in the case that the composition is from the current
4741 buffer), draw a glyph composed from the composition components. */
4742 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
4743 && COMPOSITION_VALID_P (start
, end
, prop
)
4744 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
4750 if (STRINGP (it
->string
))
4751 pos_byte
= string_char_to_byte (it
->string
, start
);
4753 pos_byte
= CHAR_TO_BYTE (start
);
4755 id
= get_composition_id (start
, pos_byte
, end
- start
, prop
, string
);
4759 struct composition
*cmp
= composition_table
[id
];
4761 if (cmp
->glyph_len
== 0)
4764 if (STRINGP (it
->string
))
4766 IT_STRING_CHARPOS (*it
) = end
;
4767 IT_STRING_BYTEPOS (*it
) = string_char_to_byte (it
->string
,
4772 IT_CHARPOS (*it
) = end
;
4773 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (end
);
4775 return HANDLED_RECOMPUTE_PROPS
;
4778 it
->stop_charpos
= end
;
4781 it
->method
= GET_FROM_COMPOSITION
;
4783 it
->cmp_len
= COMPOSITION_LENGTH (prop
);
4784 /* For a terminal, draw only the first (non-TAB) character
4785 of the components. */
4786 if (composition_table
[id
]->method
== COMPOSITION_WITH_GLYPH_STRING
)
4788 /* FIXME: This doesn't do anything!?! */
4789 Lisp_Object lgstring
= AREF (XHASH_TABLE (composition_hash_table
)
4791 cmp
->hash_index
* 2);
4797 for (i
= 0; i
< cmp
->glyph_len
; i
++)
4798 if ((it
->c
= COMPOSITION_GLYPH (composition_table
[id
], i
))
4804 it
->len
= (STRINGP (it
->string
)
4805 ? string_char_to_byte (it
->string
, end
)
4806 : CHAR_TO_BYTE (end
)) - pos_byte
;
4807 handled
= HANDLED_RETURN
;
4816 /***********************************************************************
4818 ***********************************************************************/
4820 /* The following structure is used to record overlay strings for
4821 later sorting in load_overlay_strings. */
4823 struct overlay_entry
4825 Lisp_Object overlay
;
4832 /* Set up iterator IT from overlay strings at its current position.
4833 Called from handle_stop. */
4835 static enum prop_handled
4836 handle_overlay_change (it
)
4839 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
4840 return HANDLED_RECOMPUTE_PROPS
;
4842 return HANDLED_NORMALLY
;
4846 /* Set up the next overlay string for delivery by IT, if there is an
4847 overlay string to deliver. Called by set_iterator_to_next when the
4848 end of the current overlay string is reached. If there are more
4849 overlay strings to display, IT->string and
4850 IT->current.overlay_string_index are set appropriately here.
4851 Otherwise IT->string is set to nil. */
4854 next_overlay_string (it
)
4857 ++it
->current
.overlay_string_index
;
4858 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
4860 /* No more overlay strings. Restore IT's settings to what
4861 they were before overlay strings were processed, and
4862 continue to deliver from current_buffer. */
4863 int display_ellipsis_p
= it
->stack
[it
->sp
- 1].display_ellipsis_p
;
4867 || it
->method
== GET_FROM_COMPOSITION
4868 || (NILP (it
->string
)
4869 && it
->method
== GET_FROM_BUFFER
4870 && it
->stop_charpos
>= BEGV
4871 && it
->stop_charpos
<= it
->end_charpos
));
4872 it
->current
.overlay_string_index
= -1;
4873 it
->n_overlay_strings
= 0;
4875 /* If we're at the end of the buffer, record that we have
4876 processed the overlay strings there already, so that
4877 next_element_from_buffer doesn't try it again. */
4878 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
4879 it
->overlay_strings_at_end_processed_p
= 1;
4881 /* If we have to display `...' for invisible text, set
4882 the iterator up for that. */
4883 if (display_ellipsis_p
)
4884 setup_for_ellipsis (it
, 0);
4888 /* There are more overlay strings to process. If
4889 IT->current.overlay_string_index has advanced to a position
4890 where we must load IT->overlay_strings with more strings, do
4892 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
4894 if (it
->current
.overlay_string_index
&& i
== 0)
4895 load_overlay_strings (it
, 0);
4897 /* Initialize IT to deliver display elements from the overlay
4899 it
->string
= it
->overlay_strings
[i
];
4900 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4901 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
4902 it
->method
= GET_FROM_STRING
;
4903 it
->stop_charpos
= 0;
4910 /* Compare two overlay_entry structures E1 and E2. Used as a
4911 comparison function for qsort in load_overlay_strings. Overlay
4912 strings for the same position are sorted so that
4914 1. All after-strings come in front of before-strings, except
4915 when they come from the same overlay.
4917 2. Within after-strings, strings are sorted so that overlay strings
4918 from overlays with higher priorities come first.
4920 2. Within before-strings, strings are sorted so that overlay
4921 strings from overlays with higher priorities come last.
4923 Value is analogous to strcmp. */
4927 compare_overlay_entries (e1
, e2
)
4930 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
4931 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
4934 if (entry1
->after_string_p
!= entry2
->after_string_p
)
4936 /* Let after-strings appear in front of before-strings if
4937 they come from different overlays. */
4938 if (EQ (entry1
->overlay
, entry2
->overlay
))
4939 result
= entry1
->after_string_p
? 1 : -1;
4941 result
= entry1
->after_string_p
? -1 : 1;
4943 else if (entry1
->after_string_p
)
4944 /* After-strings sorted in order of decreasing priority. */
4945 result
= entry2
->priority
- entry1
->priority
;
4947 /* Before-strings sorted in order of increasing priority. */
4948 result
= entry1
->priority
- entry2
->priority
;
4954 /* Load the vector IT->overlay_strings with overlay strings from IT's
4955 current buffer position, or from CHARPOS if that is > 0. Set
4956 IT->n_overlays to the total number of overlay strings found.
4958 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
4959 a time. On entry into load_overlay_strings,
4960 IT->current.overlay_string_index gives the number of overlay
4961 strings that have already been loaded by previous calls to this
4964 IT->add_overlay_start contains an additional overlay start
4965 position to consider for taking overlay strings from, if non-zero.
4966 This position comes into play when the overlay has an `invisible'
4967 property, and both before and after-strings. When we've skipped to
4968 the end of the overlay, because of its `invisible' property, we
4969 nevertheless want its before-string to appear.
4970 IT->add_overlay_start will contain the overlay start position
4973 Overlay strings are sorted so that after-string strings come in
4974 front of before-string strings. Within before and after-strings,
4975 strings are sorted by overlay priority. See also function
4976 compare_overlay_entries. */
4979 load_overlay_strings (it
, charpos
)
4983 extern Lisp_Object Qafter_string
, Qbefore_string
, Qwindow
, Qpriority
;
4984 Lisp_Object overlay
, window
, str
, invisible
;
4985 struct Lisp_Overlay
*ov
;
4988 int n
= 0, i
, j
, invis_p
;
4989 struct overlay_entry
*entries
4990 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
4993 charpos
= IT_CHARPOS (*it
);
4995 /* Append the overlay string STRING of overlay OVERLAY to vector
4996 `entries' which has size `size' and currently contains `n'
4997 elements. AFTER_P non-zero means STRING is an after-string of
4999 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5002 Lisp_Object priority; \
5006 int new_size = 2 * size; \
5007 struct overlay_entry *old = entries; \
5009 (struct overlay_entry *) alloca (new_size \
5010 * sizeof *entries); \
5011 bcopy (old, entries, size * sizeof *entries); \
5015 entries[n].string = (STRING); \
5016 entries[n].overlay = (OVERLAY); \
5017 priority = Foverlay_get ((OVERLAY), Qpriority); \
5018 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5019 entries[n].after_string_p = (AFTER_P); \
5024 /* Process overlay before the overlay center. */
5025 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5027 XSETMISC (overlay
, ov
);
5028 xassert (OVERLAYP (overlay
));
5029 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5030 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5035 /* Skip this overlay if it doesn't start or end at IT's current
5037 if (end
!= charpos
&& start
!= charpos
)
5040 /* Skip this overlay if it doesn't apply to IT->w. */
5041 window
= Foverlay_get (overlay
, Qwindow
);
5042 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5045 /* If the text ``under'' the overlay is invisible, both before-
5046 and after-strings from this overlay are visible; start and
5047 end position are indistinguishable. */
5048 invisible
= Foverlay_get (overlay
, Qinvisible
);
5049 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5051 /* If overlay has a non-empty before-string, record it. */
5052 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5053 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5055 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5057 /* If overlay has a non-empty after-string, record it. */
5058 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5059 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5061 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5064 /* Process overlays after the overlay center. */
5065 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5067 XSETMISC (overlay
, ov
);
5068 xassert (OVERLAYP (overlay
));
5069 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5070 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5072 if (start
> charpos
)
5075 /* Skip this overlay if it doesn't start or end at IT's current
5077 if (end
!= charpos
&& start
!= charpos
)
5080 /* Skip this overlay if it doesn't apply to IT->w. */
5081 window
= Foverlay_get (overlay
, Qwindow
);
5082 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5085 /* If the text ``under'' the overlay is invisible, it has a zero
5086 dimension, and both before- and after-strings apply. */
5087 invisible
= Foverlay_get (overlay
, Qinvisible
);
5088 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5090 /* If overlay has a non-empty before-string, record it. */
5091 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5092 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5094 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5096 /* If overlay has a non-empty after-string, record it. */
5097 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5098 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5100 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5103 #undef RECORD_OVERLAY_STRING
5107 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5109 /* Record the total number of strings to process. */
5110 it
->n_overlay_strings
= n
;
5112 /* IT->current.overlay_string_index is the number of overlay strings
5113 that have already been consumed by IT. Copy some of the
5114 remaining overlay strings to IT->overlay_strings. */
5116 j
= it
->current
.overlay_string_index
;
5117 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5119 it
->overlay_strings
[i
] = entries
[j
].string
;
5120 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5127 /* Get the first chunk of overlay strings at IT's current buffer
5128 position, or at CHARPOS if that is > 0. Value is non-zero if at
5129 least one overlay string was found. */
5132 get_overlay_strings_1 (it
, charpos
, compute_stop_p
)
5137 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5138 process. This fills IT->overlay_strings with strings, and sets
5139 IT->n_overlay_strings to the total number of strings to process.
5140 IT->pos.overlay_string_index has to be set temporarily to zero
5141 because load_overlay_strings needs this; it must be set to -1
5142 when no overlay strings are found because a zero value would
5143 indicate a position in the first overlay string. */
5144 it
->current
.overlay_string_index
= 0;
5145 load_overlay_strings (it
, charpos
);
5147 /* If we found overlay strings, set up IT to deliver display
5148 elements from the first one. Otherwise set up IT to deliver
5149 from current_buffer. */
5150 if (it
->n_overlay_strings
)
5152 /* Make sure we know settings in current_buffer, so that we can
5153 restore meaningful values when we're done with the overlay
5156 compute_stop_pos (it
);
5157 xassert (it
->face_id
>= 0);
5159 /* Save IT's settings. They are restored after all overlay
5160 strings have been processed. */
5161 xassert (!compute_stop_p
|| it
->sp
== 0);
5164 /* Set up IT to deliver display elements from the first overlay
5166 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5167 it
->string
= it
->overlay_strings
[0];
5168 it
->from_overlay
= Qnil
;
5169 it
->stop_charpos
= 0;
5170 xassert (STRINGP (it
->string
));
5171 it
->end_charpos
= SCHARS (it
->string
);
5172 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5173 it
->method
= GET_FROM_STRING
;
5177 it
->current
.overlay_string_index
= -1;
5182 get_overlay_strings (it
, charpos
)
5187 it
->method
= GET_FROM_BUFFER
;
5189 (void) get_overlay_strings_1 (it
, charpos
, 1);
5193 /* Value is non-zero if we found at least one overlay string. */
5194 return STRINGP (it
->string
);
5199 /***********************************************************************
5200 Saving and restoring state
5201 ***********************************************************************/
5203 /* Save current settings of IT on IT->stack. Called, for example,
5204 before setting up IT for an overlay string, to be able to restore
5205 IT's settings to what they were after the overlay string has been
5212 struct iterator_stack_entry
*p
;
5214 xassert (it
->sp
< IT_STACK_SIZE
);
5215 p
= it
->stack
+ it
->sp
;
5217 p
->stop_charpos
= it
->stop_charpos
;
5218 xassert (it
->face_id
>= 0);
5219 p
->face_id
= it
->face_id
;
5220 p
->string
= it
->string
;
5221 p
->method
= it
->method
;
5222 p
->from_overlay
= it
->from_overlay
;
5225 case GET_FROM_IMAGE
:
5226 p
->u
.image
.object
= it
->object
;
5227 p
->u
.image
.image_id
= it
->image_id
;
5228 p
->u
.image
.slice
= it
->slice
;
5230 case GET_FROM_COMPOSITION
:
5231 p
->u
.comp
.object
= it
->object
;
5232 p
->u
.comp
.c
= it
->c
;
5233 p
->u
.comp
.len
= it
->len
;
5234 p
->u
.comp
.cmp_id
= it
->cmp_id
;
5235 p
->u
.comp
.cmp_len
= it
->cmp_len
;
5237 case GET_FROM_STRETCH
:
5238 p
->u
.stretch
.object
= it
->object
;
5241 p
->position
= it
->position
;
5242 p
->current
= it
->current
;
5243 p
->end_charpos
= it
->end_charpos
;
5244 p
->string_nchars
= it
->string_nchars
;
5246 p
->multibyte_p
= it
->multibyte_p
;
5247 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5248 p
->space_width
= it
->space_width
;
5249 p
->font_height
= it
->font_height
;
5250 p
->voffset
= it
->voffset
;
5251 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5252 p
->display_ellipsis_p
= 0;
5257 /* Restore IT's settings from IT->stack. Called, for example, when no
5258 more overlay strings must be processed, and we return to delivering
5259 display elements from a buffer, or when the end of a string from a
5260 `display' property is reached and we return to delivering display
5261 elements from an overlay string, or from a buffer. */
5267 struct iterator_stack_entry
*p
;
5269 xassert (it
->sp
> 0);
5271 p
= it
->stack
+ it
->sp
;
5272 it
->stop_charpos
= p
->stop_charpos
;
5273 it
->face_id
= p
->face_id
;
5274 it
->current
= p
->current
;
5275 it
->position
= p
->position
;
5276 it
->string
= p
->string
;
5277 it
->from_overlay
= p
->from_overlay
;
5278 if (NILP (it
->string
))
5279 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5280 it
->method
= p
->method
;
5283 case GET_FROM_IMAGE
:
5284 it
->image_id
= p
->u
.image
.image_id
;
5285 it
->object
= p
->u
.image
.object
;
5286 it
->slice
= p
->u
.image
.slice
;
5288 case GET_FROM_COMPOSITION
:
5289 it
->object
= p
->u
.comp
.object
;
5290 it
->c
= p
->u
.comp
.c
;
5291 it
->len
= p
->u
.comp
.len
;
5292 it
->cmp_id
= p
->u
.comp
.cmp_id
;
5293 it
->cmp_len
= p
->u
.comp
.cmp_len
;
5295 case GET_FROM_STRETCH
:
5296 it
->object
= p
->u
.comp
.object
;
5298 case GET_FROM_BUFFER
:
5299 it
->object
= it
->w
->buffer
;
5301 case GET_FROM_STRING
:
5302 it
->object
= it
->string
;
5305 it
->end_charpos
= p
->end_charpos
;
5306 it
->string_nchars
= p
->string_nchars
;
5308 it
->multibyte_p
= p
->multibyte_p
;
5309 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5310 it
->space_width
= p
->space_width
;
5311 it
->font_height
= p
->font_height
;
5312 it
->voffset
= p
->voffset
;
5313 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5318 /***********************************************************************
5320 ***********************************************************************/
5322 /* Set IT's current position to the previous line start. */
5325 back_to_previous_line_start (it
)
5328 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5329 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5333 /* Move IT to the next line start.
5335 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5336 we skipped over part of the text (as opposed to moving the iterator
5337 continuously over the text). Otherwise, don't change the value
5340 Newlines may come from buffer text, overlay strings, or strings
5341 displayed via the `display' property. That's the reason we can't
5342 simply use find_next_newline_no_quit.
5344 Note that this function may not skip over invisible text that is so
5345 because of text properties and immediately follows a newline. If
5346 it would, function reseat_at_next_visible_line_start, when called
5347 from set_iterator_to_next, would effectively make invisible
5348 characters following a newline part of the wrong glyph row, which
5349 leads to wrong cursor motion. */
5352 forward_to_next_line_start (it
, skipped_p
)
5356 int old_selective
, newline_found_p
, n
;
5357 const int MAX_NEWLINE_DISTANCE
= 500;
5359 /* If already on a newline, just consume it to avoid unintended
5360 skipping over invisible text below. */
5361 if (it
->what
== IT_CHARACTER
5363 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5365 set_iterator_to_next (it
, 0);
5370 /* Don't handle selective display in the following. It's (a)
5371 unnecessary because it's done by the caller, and (b) leads to an
5372 infinite recursion because next_element_from_ellipsis indirectly
5373 calls this function. */
5374 old_selective
= it
->selective
;
5377 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5378 from buffer text. */
5379 for (n
= newline_found_p
= 0;
5380 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5381 n
+= STRINGP (it
->string
) ? 0 : 1)
5383 if (!get_next_display_element (it
))
5385 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5386 set_iterator_to_next (it
, 0);
5389 /* If we didn't find a newline near enough, see if we can use a
5391 if (!newline_found_p
)
5393 int start
= IT_CHARPOS (*it
);
5394 int limit
= find_next_newline_no_quit (start
, 1);
5397 xassert (!STRINGP (it
->string
));
5399 /* If there isn't any `display' property in sight, and no
5400 overlays, we can just use the position of the newline in
5402 if (it
->stop_charpos
>= limit
5403 || ((pos
= Fnext_single_property_change (make_number (start
),
5405 Qnil
, make_number (limit
)),
5407 && next_overlay_change (start
) == ZV
))
5409 IT_CHARPOS (*it
) = limit
;
5410 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5411 *skipped_p
= newline_found_p
= 1;
5415 while (get_next_display_element (it
)
5416 && !newline_found_p
)
5418 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5419 set_iterator_to_next (it
, 0);
5424 it
->selective
= old_selective
;
5425 return newline_found_p
;
5429 /* Set IT's current position to the previous visible line start. Skip
5430 invisible text that is so either due to text properties or due to
5431 selective display. Caution: this does not change IT->current_x and
5435 back_to_previous_visible_line_start (it
)
5438 while (IT_CHARPOS (*it
) > BEGV
)
5440 back_to_previous_line_start (it
);
5442 if (IT_CHARPOS (*it
) <= BEGV
)
5445 /* If selective > 0, then lines indented more than that values
5447 if (it
->selective
> 0
5448 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5449 (double) it
->selective
)) /* iftc */
5452 /* Check the newline before point for invisibility. */
5455 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5456 Qinvisible
, it
->window
);
5457 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5461 if (IT_CHARPOS (*it
) <= BEGV
)
5468 Lisp_Object val
, overlay
;
5470 /* If newline is part of a composition, continue from start of composition */
5471 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5472 && beg
< IT_CHARPOS (*it
))
5475 /* If newline is replaced by a display property, find start of overlay
5476 or interval and continue search from that point. */
5478 pos
= --IT_CHARPOS (it2
);
5481 it2
.string_from_display_prop_p
= 0;
5482 if (handle_display_prop (&it2
) == HANDLED_RETURN
5483 && !NILP (val
= get_char_property_and_overlay
5484 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5485 && (OVERLAYP (overlay
)
5486 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5487 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5490 /* Newline is not replaced by anything -- so we are done. */
5496 IT_CHARPOS (*it
) = beg
;
5497 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5501 it
->continuation_lines_width
= 0;
5503 xassert (IT_CHARPOS (*it
) >= BEGV
);
5504 xassert (IT_CHARPOS (*it
) == BEGV
5505 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5510 /* Reseat iterator IT at the previous visible line start. Skip
5511 invisible text that is so either due to text properties or due to
5512 selective display. At the end, update IT's overlay information,
5513 face information etc. */
5516 reseat_at_previous_visible_line_start (it
)
5519 back_to_previous_visible_line_start (it
);
5520 reseat (it
, it
->current
.pos
, 1);
5525 /* Reseat iterator IT on the next visible line start in the current
5526 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5527 preceding the line start. Skip over invisible text that is so
5528 because of selective display. Compute faces, overlays etc at the
5529 new position. Note that this function does not skip over text that
5530 is invisible because of text properties. */
5533 reseat_at_next_visible_line_start (it
, on_newline_p
)
5537 int newline_found_p
, skipped_p
= 0;
5539 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5541 /* Skip over lines that are invisible because they are indented
5542 more than the value of IT->selective. */
5543 if (it
->selective
> 0)
5544 while (IT_CHARPOS (*it
) < ZV
5545 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5546 (double) it
->selective
)) /* iftc */
5548 xassert (IT_BYTEPOS (*it
) == BEGV
5549 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5550 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5553 /* Position on the newline if that's what's requested. */
5554 if (on_newline_p
&& newline_found_p
)
5556 if (STRINGP (it
->string
))
5558 if (IT_STRING_CHARPOS (*it
) > 0)
5560 --IT_STRING_CHARPOS (*it
);
5561 --IT_STRING_BYTEPOS (*it
);
5564 else if (IT_CHARPOS (*it
) > BEGV
)
5568 reseat (it
, it
->current
.pos
, 0);
5572 reseat (it
, it
->current
.pos
, 0);
5579 /***********************************************************************
5580 Changing an iterator's position
5581 ***********************************************************************/
5583 /* Change IT's current position to POS in current_buffer. If FORCE_P
5584 is non-zero, always check for text properties at the new position.
5585 Otherwise, text properties are only looked up if POS >=
5586 IT->check_charpos of a property. */
5589 reseat (it
, pos
, force_p
)
5591 struct text_pos pos
;
5594 int original_pos
= IT_CHARPOS (*it
);
5596 reseat_1 (it
, pos
, 0);
5598 /* Determine where to check text properties. Avoid doing it
5599 where possible because text property lookup is very expensive. */
5601 || CHARPOS (pos
) > it
->stop_charpos
5602 || CHARPOS (pos
) < original_pos
)
5609 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
5610 IT->stop_pos to POS, also. */
5613 reseat_1 (it
, pos
, set_stop_p
)
5615 struct text_pos pos
;
5618 /* Don't call this function when scanning a C string. */
5619 xassert (it
->s
== NULL
);
5621 /* POS must be a reasonable value. */
5622 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
5624 it
->current
.pos
= it
->position
= pos
;
5625 it
->end_charpos
= ZV
;
5627 it
->current
.dpvec_index
= -1;
5628 it
->current
.overlay_string_index
= -1;
5629 IT_STRING_CHARPOS (*it
) = -1;
5630 IT_STRING_BYTEPOS (*it
) = -1;
5632 it
->string_from_display_prop_p
= 0;
5633 it
->method
= GET_FROM_BUFFER
;
5634 it
->object
= it
->w
->buffer
;
5635 it
->area
= TEXT_AREA
;
5636 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
5638 it
->string_from_display_prop_p
= 0;
5639 it
->face_before_selective_p
= 0;
5642 it
->stop_charpos
= CHARPOS (pos
);
5646 /* Set up IT for displaying a string, starting at CHARPOS in window W.
5647 If S is non-null, it is a C string to iterate over. Otherwise,
5648 STRING gives a Lisp string to iterate over.
5650 If PRECISION > 0, don't return more then PRECISION number of
5651 characters from the string.
5653 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
5654 characters have been returned. FIELD_WIDTH < 0 means an infinite
5657 MULTIBYTE = 0 means disable processing of multibyte characters,
5658 MULTIBYTE > 0 means enable it,
5659 MULTIBYTE < 0 means use IT->multibyte_p.
5661 IT must be initialized via a prior call to init_iterator before
5662 calling this function. */
5665 reseat_to_string (it
, s
, string
, charpos
, precision
, field_width
, multibyte
)
5670 int precision
, field_width
, multibyte
;
5672 /* No region in strings. */
5673 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
5675 /* No text property checks performed by default, but see below. */
5676 it
->stop_charpos
= -1;
5678 /* Set iterator position and end position. */
5679 bzero (&it
->current
, sizeof it
->current
);
5680 it
->current
.overlay_string_index
= -1;
5681 it
->current
.dpvec_index
= -1;
5682 xassert (charpos
>= 0);
5684 /* If STRING is specified, use its multibyteness, otherwise use the
5685 setting of MULTIBYTE, if specified. */
5687 it
->multibyte_p
= multibyte
> 0;
5691 xassert (STRINGP (string
));
5692 it
->string
= string
;
5694 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
5695 it
->method
= GET_FROM_STRING
;
5696 it
->current
.string_pos
= string_pos (charpos
, string
);
5703 /* Note that we use IT->current.pos, not it->current.string_pos,
5704 for displaying C strings. */
5705 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
5706 if (it
->multibyte_p
)
5708 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
5709 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
5713 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
5714 it
->end_charpos
= it
->string_nchars
= strlen (s
);
5717 it
->method
= GET_FROM_C_STRING
;
5720 /* PRECISION > 0 means don't return more than PRECISION characters
5722 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
5723 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
5725 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
5726 characters have been returned. FIELD_WIDTH == 0 means don't pad,
5727 FIELD_WIDTH < 0 means infinite field width. This is useful for
5728 padding with `-' at the end of a mode line. */
5729 if (field_width
< 0)
5730 field_width
= INFINITY
;
5731 if (field_width
> it
->end_charpos
- charpos
)
5732 it
->end_charpos
= charpos
+ field_width
;
5734 /* Use the standard display table for displaying strings. */
5735 if (DISP_TABLE_P (Vstandard_display_table
))
5736 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
5738 it
->stop_charpos
= charpos
;
5744 /***********************************************************************
5746 ***********************************************************************/
5748 /* Map enum it_method value to corresponding next_element_from_* function. */
5750 static int (* get_next_element
[NUM_IT_METHODS
]) P_ ((struct it
*it
)) =
5752 next_element_from_buffer
,
5753 next_element_from_display_vector
,
5754 next_element_from_composition
,
5755 next_element_from_string
,
5756 next_element_from_c_string
,
5757 next_element_from_image
,
5758 next_element_from_stretch
5761 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
5763 /* Load IT's display element fields with information about the next
5764 display element from the current position of IT. Value is zero if
5765 end of buffer (or C string) is reached. */
5767 static struct frame
*last_escape_glyph_frame
= NULL
;
5768 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
5769 static int last_escape_glyph_merged_face_id
= 0;
5772 get_next_display_element (it
)
5775 /* Non-zero means that we found a display element. Zero means that
5776 we hit the end of what we iterate over. Performance note: the
5777 function pointer `method' used here turns out to be faster than
5778 using a sequence of if-statements. */
5782 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
5784 if (it
->what
== IT_CHARACTER
)
5786 /* Map via display table or translate control characters.
5787 IT->c, IT->len etc. have been set to the next character by
5788 the function call above. If we have a display table, and it
5789 contains an entry for IT->c, translate it. Don't do this if
5790 IT->c itself comes from a display table, otherwise we could
5791 end up in an infinite recursion. (An alternative could be to
5792 count the recursion depth of this function and signal an
5793 error when a certain maximum depth is reached.) Is it worth
5795 if (success_p
&& it
->dpvec
== NULL
)
5800 && (dv
= DISP_CHAR_VECTOR (it
->dp
, it
->c
),
5803 struct Lisp_Vector
*v
= XVECTOR (dv
);
5805 /* Return the first character from the display table
5806 entry, if not empty. If empty, don't display the
5807 current character. */
5810 it
->dpvec_char_len
= it
->len
;
5811 it
->dpvec
= v
->contents
;
5812 it
->dpend
= v
->contents
+ v
->size
;
5813 it
->current
.dpvec_index
= 0;
5814 it
->dpvec_face_id
= -1;
5815 it
->saved_face_id
= it
->face_id
;
5816 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5821 set_iterator_to_next (it
, 0);
5826 /* Translate control characters into `\003' or `^C' form.
5827 Control characters coming from a display table entry are
5828 currently not translated because we use IT->dpvec to hold
5829 the translation. This could easily be changed but I
5830 don't believe that it is worth doing.
5832 If it->multibyte_p is nonzero, non-printable non-ASCII
5833 characters are also translated to octal form.
5835 If it->multibyte_p is zero, eight-bit characters that
5836 don't have corresponding multibyte char code are also
5837 translated to octal form. */
5838 else if ((it
->c
< ' '
5839 ? (it
->area
!= TEXT_AREA
5840 /* In mode line, treat \n, \t like other crl chars. */
5842 && it
->glyph_row
&& it
->glyph_row
->mode_line_p
)
5843 || (it
->c
!= '\n' && it
->c
!= '\t'))
5845 ? (!CHAR_PRINTABLE_P (it
->c
)
5846 || (!NILP (Vnobreak_char_display
)
5847 && (it
->c
== 0xA0 /* NO-BREAK SPACE */
5848 || it
->c
== 0xAD /* SOFT HYPHEN */)))
5850 && (! unibyte_display_via_language_environment
5851 || (UNIBYTE_CHAR_HAS_MULTIBYTE_P (it
->c
)))))))
5853 /* IT->c is a control character which must be displayed
5854 either as '\003' or as `^C' where the '\\' and '^'
5855 can be defined in the display table. Fill
5856 IT->ctl_chars with glyphs for what we have to
5857 display. Then, set IT->dpvec to these glyphs. */
5860 int face_id
, lface_id
= 0 ;
5863 /* Handle control characters with ^. */
5865 if (it
->c
< 128 && it
->ctl_arrow_p
)
5869 g
= '^'; /* default glyph for Control */
5870 /* Set IT->ctl_chars[0] to the glyph for `^'. */
5872 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5873 && GLYPH_CODE_CHAR_VALID_P (gc
))
5875 g
= GLYPH_CODE_CHAR (gc
);
5876 lface_id
= GLYPH_CODE_FACE (gc
);
5880 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
5882 else if (it
->f
== last_escape_glyph_frame
5883 && it
->face_id
== last_escape_glyph_face_id
)
5885 face_id
= last_escape_glyph_merged_face_id
;
5889 /* Merge the escape-glyph face into the current face. */
5890 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5892 last_escape_glyph_frame
= it
->f
;
5893 last_escape_glyph_face_id
= it
->face_id
;
5894 last_escape_glyph_merged_face_id
= face_id
;
5897 XSETINT (it
->ctl_chars
[0], g
);
5898 XSETINT (it
->ctl_chars
[1], it
->c
^ 0100);
5900 goto display_control
;
5903 /* Handle non-break space in the mode where it only gets
5906 if (EQ (Vnobreak_char_display
, Qt
)
5909 /* Merge the no-break-space face into the current face. */
5910 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
5914 XSETINT (it
->ctl_chars
[0], ' ');
5916 goto display_control
;
5919 /* Handle sequences that start with the "escape glyph". */
5921 /* the default escape glyph is \. */
5922 escape_glyph
= '\\';
5925 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5926 && GLYPH_CODE_CHAR_VALID_P (gc
))
5928 escape_glyph
= GLYPH_CODE_CHAR (gc
);
5929 lface_id
= GLYPH_CODE_FACE (gc
);
5933 /* The display table specified a face.
5934 Merge it into face_id and also into escape_glyph. */
5935 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
5938 else if (it
->f
== last_escape_glyph_frame
5939 && it
->face_id
== last_escape_glyph_face_id
)
5941 face_id
= last_escape_glyph_merged_face_id
;
5945 /* Merge the escape-glyph face into the current face. */
5946 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5948 last_escape_glyph_frame
= it
->f
;
5949 last_escape_glyph_face_id
= it
->face_id
;
5950 last_escape_glyph_merged_face_id
= face_id
;
5953 /* Handle soft hyphens in the mode where they only get
5956 if (EQ (Vnobreak_char_display
, Qt
)
5960 XSETINT (it
->ctl_chars
[0], '-');
5962 goto display_control
;
5965 /* Handle non-break space and soft hyphen
5966 with the escape glyph. */
5968 if (it
->c
== 0xA0 || it
->c
== 0xAD)
5970 XSETINT (it
->ctl_chars
[0], escape_glyph
);
5971 it
->c
= (it
->c
== 0xA0 ? ' ' : '-');
5972 XSETINT (it
->ctl_chars
[1], it
->c
);
5974 goto display_control
;
5978 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
5982 /* Set IT->ctl_chars[0] to the glyph for `\\'. */
5983 if (CHAR_BYTE8_P (it
->c
))
5985 str
[0] = CHAR_TO_BYTE8 (it
->c
);
5988 else if (it
->c
< 256)
5995 /* It's an invalid character, which shouldn't
5996 happen actually, but due to bugs it may
5997 happen. Let's print the char as is, there's
5998 not much meaningful we can do with it. */
6000 str
[1] = it
->c
>> 8;
6001 str
[2] = it
->c
>> 16;
6002 str
[3] = it
->c
>> 24;
6006 for (i
= 0; i
< len
; i
++)
6009 XSETINT (it
->ctl_chars
[i
* 4], escape_glyph
);
6010 /* Insert three more glyphs into IT->ctl_chars for
6011 the octal display of the character. */
6012 g
= ((str
[i
] >> 6) & 7) + '0';
6013 XSETINT (it
->ctl_chars
[i
* 4 + 1], g
);
6014 g
= ((str
[i
] >> 3) & 7) + '0';
6015 XSETINT (it
->ctl_chars
[i
* 4 + 2], g
);
6016 g
= (str
[i
] & 7) + '0';
6017 XSETINT (it
->ctl_chars
[i
* 4 + 3], g
);
6023 /* Set up IT->dpvec and return first character from it. */
6024 it
->dpvec_char_len
= it
->len
;
6025 it
->dpvec
= it
->ctl_chars
;
6026 it
->dpend
= it
->dpvec
+ ctl_len
;
6027 it
->current
.dpvec_index
= 0;
6028 it
->dpvec_face_id
= face_id
;
6029 it
->saved_face_id
= it
->face_id
;
6030 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6037 /* Adjust face id for a multibyte character. There are no multibyte
6038 character in unibyte text. */
6039 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
6042 && FRAME_WINDOW_P (it
->f
))
6044 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6045 int pos
= (it
->s
? -1
6046 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
6047 : IT_CHARPOS (*it
));
6049 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->c
, pos
, it
->string
);
6052 /* Is this character the last one of a run of characters with
6053 box? If yes, set IT->end_of_box_run_p to 1. */
6060 it
->end_of_box_run_p
6061 = ((face_id
= face_after_it_pos (it
),
6062 face_id
!= it
->face_id
)
6063 && (face
= FACE_FROM_ID (it
->f
, face_id
),
6064 face
->box
== FACE_NO_BOX
));
6067 /* Value is 0 if end of buffer or string reached. */
6072 /* Move IT to the next display element.
6074 RESEAT_P non-zero means if called on a newline in buffer text,
6075 skip to the next visible line start.
6077 Functions get_next_display_element and set_iterator_to_next are
6078 separate because I find this arrangement easier to handle than a
6079 get_next_display_element function that also increments IT's
6080 position. The way it is we can first look at an iterator's current
6081 display element, decide whether it fits on a line, and if it does,
6082 increment the iterator position. The other way around we probably
6083 would either need a flag indicating whether the iterator has to be
6084 incremented the next time, or we would have to implement a
6085 decrement position function which would not be easy to write. */
6088 set_iterator_to_next (it
, reseat_p
)
6092 /* Reset flags indicating start and end of a sequence of characters
6093 with box. Reset them at the start of this function because
6094 moving the iterator to a new position might set them. */
6095 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6099 case GET_FROM_BUFFER
:
6100 /* The current display element of IT is a character from
6101 current_buffer. Advance in the buffer, and maybe skip over
6102 invisible lines that are so because of selective display. */
6103 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6104 reseat_at_next_visible_line_start (it
, 0);
6107 xassert (it
->len
!= 0);
6108 IT_BYTEPOS (*it
) += it
->len
;
6109 IT_CHARPOS (*it
) += 1;
6110 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6114 case GET_FROM_COMPOSITION
:
6115 xassert (it
->cmp_id
>= 0 && it
->cmp_id
< n_compositions
);
6116 xassert (it
->sp
> 0);
6118 if (it
->method
== GET_FROM_STRING
)
6120 IT_STRING_BYTEPOS (*it
) += it
->len
;
6121 IT_STRING_CHARPOS (*it
) += it
->cmp_len
;
6122 goto consider_string_end
;
6124 else if (it
->method
== GET_FROM_BUFFER
)
6126 IT_BYTEPOS (*it
) += it
->len
;
6127 IT_CHARPOS (*it
) += it
->cmp_len
;
6131 case GET_FROM_C_STRING
:
6132 /* Current display element of IT is from a C string. */
6133 IT_BYTEPOS (*it
) += it
->len
;
6134 IT_CHARPOS (*it
) += 1;
6137 case GET_FROM_DISPLAY_VECTOR
:
6138 /* Current display element of IT is from a display table entry.
6139 Advance in the display table definition. Reset it to null if
6140 end reached, and continue with characters from buffers/
6142 ++it
->current
.dpvec_index
;
6144 /* Restore face of the iterator to what they were before the
6145 display vector entry (these entries may contain faces). */
6146 it
->face_id
= it
->saved_face_id
;
6148 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6150 int recheck_faces
= it
->ellipsis_p
;
6153 it
->method
= GET_FROM_C_STRING
;
6154 else if (STRINGP (it
->string
))
6155 it
->method
= GET_FROM_STRING
;
6158 it
->method
= GET_FROM_BUFFER
;
6159 it
->object
= it
->w
->buffer
;
6163 it
->current
.dpvec_index
= -1;
6165 /* Skip over characters which were displayed via IT->dpvec. */
6166 if (it
->dpvec_char_len
< 0)
6167 reseat_at_next_visible_line_start (it
, 1);
6168 else if (it
->dpvec_char_len
> 0)
6170 if (it
->method
== GET_FROM_STRING
6171 && it
->n_overlay_strings
> 0)
6172 it
->ignore_overlay_strings_at_pos_p
= 1;
6173 it
->len
= it
->dpvec_char_len
;
6174 set_iterator_to_next (it
, reseat_p
);
6177 /* Maybe recheck faces after display vector */
6179 it
->stop_charpos
= IT_CHARPOS (*it
);
6183 case GET_FROM_STRING
:
6184 /* Current display element is a character from a Lisp string. */
6185 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6186 IT_STRING_BYTEPOS (*it
) += it
->len
;
6187 IT_STRING_CHARPOS (*it
) += 1;
6189 consider_string_end
:
6191 if (it
->current
.overlay_string_index
>= 0)
6193 /* IT->string is an overlay string. Advance to the
6194 next, if there is one. */
6195 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6196 next_overlay_string (it
);
6200 /* IT->string is not an overlay string. If we reached
6201 its end, and there is something on IT->stack, proceed
6202 with what is on the stack. This can be either another
6203 string, this time an overlay string, or a buffer. */
6204 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
6208 if (it
->method
== GET_FROM_STRING
)
6209 goto consider_string_end
;
6214 case GET_FROM_IMAGE
:
6215 case GET_FROM_STRETCH
:
6216 /* The position etc with which we have to proceed are on
6217 the stack. The position may be at the end of a string,
6218 if the `display' property takes up the whole string. */
6219 xassert (it
->sp
> 0);
6221 if (it
->method
== GET_FROM_STRING
)
6222 goto consider_string_end
;
6226 /* There are no other methods defined, so this should be a bug. */
6230 xassert (it
->method
!= GET_FROM_STRING
6231 || (STRINGP (it
->string
)
6232 && IT_STRING_CHARPOS (*it
) >= 0));
6235 /* Load IT's display element fields with information about the next
6236 display element which comes from a display table entry or from the
6237 result of translating a control character to one of the forms `^C'
6240 IT->dpvec holds the glyphs to return as characters.
6241 IT->saved_face_id holds the face id before the display vector--
6242 it is restored into IT->face_idin set_iterator_to_next. */
6245 next_element_from_display_vector (it
)
6251 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
6253 it
->face_id
= it
->saved_face_id
;
6255 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
6256 That seemed totally bogus - so I changed it... */
6257 gc
= it
->dpvec
[it
->current
.dpvec_index
];
6259 if (GLYPH_CODE_P (gc
) && GLYPH_CODE_CHAR_VALID_P (gc
))
6261 it
->c
= GLYPH_CODE_CHAR (gc
);
6262 it
->len
= CHAR_BYTES (it
->c
);
6264 /* The entry may contain a face id to use. Such a face id is
6265 the id of a Lisp face, not a realized face. A face id of
6266 zero means no face is specified. */
6267 if (it
->dpvec_face_id
>= 0)
6268 it
->face_id
= it
->dpvec_face_id
;
6271 int lface_id
= GLYPH_CODE_FACE (gc
);
6273 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6278 /* Display table entry is invalid. Return a space. */
6279 it
->c
= ' ', it
->len
= 1;
6281 /* Don't change position and object of the iterator here. They are
6282 still the values of the character that had this display table
6283 entry or was translated, and that's what we want. */
6284 it
->what
= IT_CHARACTER
;
6289 /* Load IT with the next display element from Lisp string IT->string.
6290 IT->current.string_pos is the current position within the string.
6291 If IT->current.overlay_string_index >= 0, the Lisp string is an
6295 next_element_from_string (it
)
6298 struct text_pos position
;
6300 xassert (STRINGP (it
->string
));
6301 xassert (IT_STRING_CHARPOS (*it
) >= 0);
6302 position
= it
->current
.string_pos
;
6304 /* Time to check for invisible text? */
6305 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
6306 && IT_STRING_CHARPOS (*it
) == it
->stop_charpos
)
6310 /* Since a handler may have changed IT->method, we must
6312 return GET_NEXT_DISPLAY_ELEMENT (it
);
6315 if (it
->current
.overlay_string_index
>= 0)
6317 /* Get the next character from an overlay string. In overlay
6318 strings, There is no field width or padding with spaces to
6320 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6325 else if (STRING_MULTIBYTE (it
->string
))
6327 int remaining
= SBYTES (it
->string
) - IT_STRING_BYTEPOS (*it
);
6328 const unsigned char *s
= (SDATA (it
->string
)
6329 + IT_STRING_BYTEPOS (*it
));
6330 it
->c
= string_char_and_length (s
, remaining
, &it
->len
);
6334 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6340 /* Get the next character from a Lisp string that is not an
6341 overlay string. Such strings come from the mode line, for
6342 example. We may have to pad with spaces, or truncate the
6343 string. See also next_element_from_c_string. */
6344 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
6349 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
6351 /* Pad with spaces. */
6352 it
->c
= ' ', it
->len
= 1;
6353 CHARPOS (position
) = BYTEPOS (position
) = -1;
6355 else if (STRING_MULTIBYTE (it
->string
))
6357 int maxlen
= SBYTES (it
->string
) - IT_STRING_BYTEPOS (*it
);
6358 const unsigned char *s
= (SDATA (it
->string
)
6359 + IT_STRING_BYTEPOS (*it
));
6360 it
->c
= string_char_and_length (s
, maxlen
, &it
->len
);
6364 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6369 /* Record what we have and where it came from. */
6370 it
->what
= IT_CHARACTER
;
6371 it
->object
= it
->string
;
6372 it
->position
= position
;
6377 /* Load IT with next display element from C string IT->s.
6378 IT->string_nchars is the maximum number of characters to return
6379 from the string. IT->end_charpos may be greater than
6380 IT->string_nchars when this function is called, in which case we
6381 may have to return padding spaces. Value is zero if end of string
6382 reached, including padding spaces. */
6385 next_element_from_c_string (it
)
6391 it
->what
= IT_CHARACTER
;
6392 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
6395 /* IT's position can be greater IT->string_nchars in case a field
6396 width or precision has been specified when the iterator was
6398 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6400 /* End of the game. */
6404 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
6406 /* Pad with spaces. */
6407 it
->c
= ' ', it
->len
= 1;
6408 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
6410 else if (it
->multibyte_p
)
6412 /* Implementation note: The calls to strlen apparently aren't a
6413 performance problem because there is no noticeable performance
6414 difference between Emacs running in unibyte or multibyte mode. */
6415 int maxlen
= strlen (it
->s
) - IT_BYTEPOS (*it
);
6416 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
),
6420 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
6426 /* Set up IT to return characters from an ellipsis, if appropriate.
6427 The definition of the ellipsis glyphs may come from a display table
6428 entry. This function Fills IT with the first glyph from the
6429 ellipsis if an ellipsis is to be displayed. */
6432 next_element_from_ellipsis (it
)
6435 if (it
->selective_display_ellipsis_p
)
6436 setup_for_ellipsis (it
, it
->len
);
6439 /* The face at the current position may be different from the
6440 face we find after the invisible text. Remember what it
6441 was in IT->saved_face_id, and signal that it's there by
6442 setting face_before_selective_p. */
6443 it
->saved_face_id
= it
->face_id
;
6444 it
->method
= GET_FROM_BUFFER
;
6445 it
->object
= it
->w
->buffer
;
6446 reseat_at_next_visible_line_start (it
, 1);
6447 it
->face_before_selective_p
= 1;
6450 return GET_NEXT_DISPLAY_ELEMENT (it
);
6454 /* Deliver an image display element. The iterator IT is already
6455 filled with image information (done in handle_display_prop). Value
6460 next_element_from_image (it
)
6463 it
->what
= IT_IMAGE
;
6468 /* Fill iterator IT with next display element from a stretch glyph
6469 property. IT->object is the value of the text property. Value is
6473 next_element_from_stretch (it
)
6476 it
->what
= IT_STRETCH
;
6481 /* Load IT with the next display element from current_buffer. Value
6482 is zero if end of buffer reached. IT->stop_charpos is the next
6483 position at which to stop and check for text properties or buffer
6487 next_element_from_buffer (it
)
6492 /* Check this assumption, otherwise, we would never enter the
6493 if-statement, below. */
6494 xassert (IT_CHARPOS (*it
) >= BEGV
6495 && IT_CHARPOS (*it
) <= it
->stop_charpos
);
6497 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
6499 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6501 int overlay_strings_follow_p
;
6503 /* End of the game, except when overlay strings follow that
6504 haven't been returned yet. */
6505 if (it
->overlay_strings_at_end_processed_p
)
6506 overlay_strings_follow_p
= 0;
6509 it
->overlay_strings_at_end_processed_p
= 1;
6510 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
6513 if (overlay_strings_follow_p
)
6514 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6518 it
->position
= it
->current
.pos
;
6525 return GET_NEXT_DISPLAY_ELEMENT (it
);
6530 /* No face changes, overlays etc. in sight, so just return a
6531 character from current_buffer. */
6534 /* Maybe run the redisplay end trigger hook. Performance note:
6535 This doesn't seem to cost measurable time. */
6536 if (it
->redisplay_end_trigger_charpos
6538 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
6539 run_redisplay_end_trigger_hook (it
);
6541 /* Get the next character, maybe multibyte. */
6542 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
6543 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
6545 int maxlen
= ((IT_BYTEPOS (*it
) >= GPT_BYTE
? ZV_BYTE
: GPT_BYTE
)
6546 - IT_BYTEPOS (*it
));
6547 it
->c
= string_char_and_length (p
, maxlen
, &it
->len
);
6550 it
->c
= *p
, it
->len
= 1;
6552 /* Record what we have and where it came from. */
6553 it
->what
= IT_CHARACTER
;
6554 it
->object
= it
->w
->buffer
;
6555 it
->position
= it
->current
.pos
;
6557 /* Normally we return the character found above, except when we
6558 really want to return an ellipsis for selective display. */
6563 /* A value of selective > 0 means hide lines indented more
6564 than that number of columns. */
6565 if (it
->selective
> 0
6566 && IT_CHARPOS (*it
) + 1 < ZV
6567 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
6568 IT_BYTEPOS (*it
) + 1,
6569 (double) it
->selective
)) /* iftc */
6571 success_p
= next_element_from_ellipsis (it
);
6572 it
->dpvec_char_len
= -1;
6575 else if (it
->c
== '\r' && it
->selective
== -1)
6577 /* A value of selective == -1 means that everything from the
6578 CR to the end of the line is invisible, with maybe an
6579 ellipsis displayed for it. */
6580 success_p
= next_element_from_ellipsis (it
);
6581 it
->dpvec_char_len
= -1;
6586 /* Value is zero if end of buffer reached. */
6587 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
6592 /* Run the redisplay end trigger hook for IT. */
6595 run_redisplay_end_trigger_hook (it
)
6598 Lisp_Object args
[3];
6600 /* IT->glyph_row should be non-null, i.e. we should be actually
6601 displaying something, or otherwise we should not run the hook. */
6602 xassert (it
->glyph_row
);
6604 /* Set up hook arguments. */
6605 args
[0] = Qredisplay_end_trigger_functions
;
6606 args
[1] = it
->window
;
6607 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
6608 it
->redisplay_end_trigger_charpos
= 0;
6610 /* Since we are *trying* to run these functions, don't try to run
6611 them again, even if they get an error. */
6612 it
->w
->redisplay_end_trigger
= Qnil
;
6613 Frun_hook_with_args (3, args
);
6615 /* Notice if it changed the face of the character we are on. */
6616 handle_face_prop (it
);
6620 /* Deliver a composition display element. The iterator IT is already
6621 filled with composition information (done in
6622 handle_composition_prop). Value is always 1. */
6625 next_element_from_composition (it
)
6628 it
->what
= IT_COMPOSITION
;
6629 it
->position
= (STRINGP (it
->string
)
6630 ? it
->current
.string_pos
6632 if (STRINGP (it
->string
))
6633 it
->object
= it
->string
;
6635 it
->object
= it
->w
->buffer
;
6641 /***********************************************************************
6642 Moving an iterator without producing glyphs
6643 ***********************************************************************/
6645 /* Check if iterator is at a position corresponding to a valid buffer
6646 position after some move_it_ call. */
6648 #define IT_POS_VALID_AFTER_MOVE_P(it) \
6649 ((it)->method == GET_FROM_STRING \
6650 ? IT_STRING_CHARPOS (*it) == 0 \
6654 /* Move iterator IT to a specified buffer or X position within one
6655 line on the display without producing glyphs.
6657 OP should be a bit mask including some or all of these bits:
6658 MOVE_TO_X: Stop on reaching x-position TO_X.
6659 MOVE_TO_POS: Stop on reaching buffer or string position TO_CHARPOS.
6660 Regardless of OP's value, stop in reaching the end of the display line.
6662 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
6663 This means, in particular, that TO_X includes window's horizontal
6666 The return value has several possible values that
6667 say what condition caused the scan to stop:
6669 MOVE_POS_MATCH_OR_ZV
6670 - when TO_POS or ZV was reached.
6673 -when TO_X was reached before TO_POS or ZV were reached.
6676 - when we reached the end of the display area and the line must
6680 - when we reached the end of the display area and the line is
6684 - when we stopped at a line end, i.e. a newline or a CR and selective
6687 static enum move_it_result
6688 move_it_in_display_line_to (struct it
*it
,
6689 EMACS_INT to_charpos
, int to_x
,
6690 enum move_operation_enum op
)
6692 enum move_it_result result
= MOVE_UNDEFINED
;
6693 struct glyph_row
*saved_glyph_row
;
6694 struct it wrap_it
, atpos_it
, atx_it
;
6697 /* Don't produce glyphs in produce_glyphs. */
6698 saved_glyph_row
= it
->glyph_row
;
6699 it
->glyph_row
= NULL
;
6701 /* Use wrap_it to save a copy of IT wherever a word wrap could
6702 occur. Use atpos_it to save a copy of IT at the desired buffer
6703 position, if found, so that we can scan ahead and check if the
6704 word later overshoots the window edge. Use atx_it similarly, for
6710 #define BUFFER_POS_REACHED_P() \
6711 ((op & MOVE_TO_POS) != 0 \
6712 && BUFFERP (it->object) \
6713 && IT_CHARPOS (*it) >= to_charpos \
6714 && (it->method == GET_FROM_BUFFER \
6715 || (it->method == GET_FROM_DISPLAY_VECTOR \
6716 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
6718 /* If there's a line-/wrap-prefix, handle it. */
6719 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
6720 && it
->current_y
< it
->last_visible_y
)
6721 handle_line_prefix (it
);
6725 int x
, i
, ascent
= 0, descent
= 0;
6727 /* Utility macro to reset an iterator with x, ascent, and descent. */
6728 #define IT_RESET_X_ASCENT_DESCENT(IT) \
6729 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
6730 (IT)->max_descent = descent)
6732 /* Stop if we move beyond TO_CHARPOS (after an image or stretch
6734 if ((op
& MOVE_TO_POS
) != 0
6735 && BUFFERP (it
->object
)
6736 && it
->method
== GET_FROM_BUFFER
6737 && IT_CHARPOS (*it
) > to_charpos
)
6739 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
6741 result
= MOVE_POS_MATCH_OR_ZV
;
6744 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
6745 /* If wrap_it is valid, the current position might be in a
6746 word that is wrapped. So, save the iterator in
6747 atpos_it and continue to see if wrapping happens. */
6751 /* Stop when ZV reached.
6752 We used to stop here when TO_CHARPOS reached as well, but that is
6753 too soon if this glyph does not fit on this line. So we handle it
6754 explicitly below. */
6755 if (!get_next_display_element (it
))
6757 result
= MOVE_POS_MATCH_OR_ZV
;
6761 if (it
->line_wrap
== TRUNCATE
)
6763 if (BUFFER_POS_REACHED_P ())
6765 result
= MOVE_POS_MATCH_OR_ZV
;
6771 if (it
->line_wrap
== WORD_WRAP
)
6773 if (IT_DISPLAYING_WHITESPACE (it
))
6777 /* We have reached a glyph that follows one or more
6778 whitespace characters. If the position is
6779 already found, we are done. */
6780 if (atpos_it
.sp
>= 0)
6783 result
= MOVE_POS_MATCH_OR_ZV
;
6789 result
= MOVE_X_REACHED
;
6792 /* Otherwise, we can wrap here. */
6799 /* Remember the line height for the current line, in case
6800 the next element doesn't fit on the line. */
6801 ascent
= it
->max_ascent
;
6802 descent
= it
->max_descent
;
6804 /* The call to produce_glyphs will get the metrics of the
6805 display element IT is loaded with. Record the x-position
6806 before this display element, in case it doesn't fit on the
6810 PRODUCE_GLYPHS (it
);
6812 if (it
->area
!= TEXT_AREA
)
6814 set_iterator_to_next (it
, 1);
6818 /* The number of glyphs we get back in IT->nglyphs will normally
6819 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
6820 character on a terminal frame, or (iii) a line end. For the
6821 second case, IT->nglyphs - 1 padding glyphs will be present
6822 (on X frames, there is only one glyph produced for a
6823 composite character.
6825 The behavior implemented below means, for continuation lines,
6826 that as many spaces of a TAB as fit on the current line are
6827 displayed there. For terminal frames, as many glyphs of a
6828 multi-glyph character are displayed in the current line, too.
6829 This is what the old redisplay code did, and we keep it that
6830 way. Under X, the whole shape of a complex character must
6831 fit on the line or it will be completely displayed in the
6834 Note that both for tabs and padding glyphs, all glyphs have
6838 /* More than one glyph or glyph doesn't fit on line. All
6839 glyphs have the same width. */
6840 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
6842 int x_before_this_char
= x
;
6843 int hpos_before_this_char
= it
->hpos
;
6845 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
6847 new_x
= x
+ single_glyph_width
;
6849 /* We want to leave anything reaching TO_X to the caller. */
6850 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
6852 if (BUFFER_POS_REACHED_P ())
6854 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
6855 goto buffer_pos_reached
;
6856 if (atpos_it
.sp
< 0)
6859 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
6864 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
6867 result
= MOVE_X_REACHED
;
6873 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
6878 if (/* Lines are continued. */
6879 it
->line_wrap
!= TRUNCATE
6880 && (/* And glyph doesn't fit on the line. */
6881 new_x
> it
->last_visible_x
6882 /* Or it fits exactly and we're on a window
6884 || (new_x
== it
->last_visible_x
6885 && FRAME_WINDOW_P (it
->f
))))
6887 if (/* IT->hpos == 0 means the very first glyph
6888 doesn't fit on the line, e.g. a wide image. */
6890 || (new_x
== it
->last_visible_x
6891 && FRAME_WINDOW_P (it
->f
)))
6894 it
->current_x
= new_x
;
6896 /* The character's last glyph just barely fits
6898 if (i
== it
->nglyphs
- 1)
6900 /* If this is the destination position,
6901 return a position *before* it in this row,
6902 now that we know it fits in this row. */
6903 if (BUFFER_POS_REACHED_P ())
6905 if (it
->line_wrap
!= WORD_WRAP
6908 it
->hpos
= hpos_before_this_char
;
6909 it
->current_x
= x_before_this_char
;
6910 result
= MOVE_POS_MATCH_OR_ZV
;
6913 if (it
->line_wrap
== WORD_WRAP
6917 atpos_it
.current_x
= x_before_this_char
;
6918 atpos_it
.hpos
= hpos_before_this_char
;
6922 set_iterator_to_next (it
, 1);
6923 #ifdef HAVE_WINDOW_SYSTEM
6924 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
6926 if (!get_next_display_element (it
))
6928 result
= MOVE_POS_MATCH_OR_ZV
;
6931 if (BUFFER_POS_REACHED_P ())
6933 if (ITERATOR_AT_END_OF_LINE_P (it
))
6934 result
= MOVE_POS_MATCH_OR_ZV
;
6936 result
= MOVE_LINE_CONTINUED
;
6939 if (ITERATOR_AT_END_OF_LINE_P (it
))
6941 result
= MOVE_NEWLINE_OR_CR
;
6945 #endif /* HAVE_WINDOW_SYSTEM */
6949 IT_RESET_X_ASCENT_DESCENT (it
);
6951 if (wrap_it
.sp
>= 0)
6958 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
6960 result
= MOVE_LINE_CONTINUED
;
6964 if (BUFFER_POS_REACHED_P ())
6966 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
6967 goto buffer_pos_reached
;
6968 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
6971 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
6975 if (new_x
> it
->first_visible_x
)
6977 /* Glyph is visible. Increment number of glyphs that
6978 would be displayed. */
6983 if (result
!= MOVE_UNDEFINED
)
6986 else if (BUFFER_POS_REACHED_P ())
6989 IT_RESET_X_ASCENT_DESCENT (it
);
6990 result
= MOVE_POS_MATCH_OR_ZV
;
6993 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
6995 /* Stop when TO_X specified and reached. This check is
6996 necessary here because of lines consisting of a line end,
6997 only. The line end will not produce any glyphs and we
6998 would never get MOVE_X_REACHED. */
6999 xassert (it
->nglyphs
== 0);
7000 result
= MOVE_X_REACHED
;
7004 /* Is this a line end? If yes, we're done. */
7005 if (ITERATOR_AT_END_OF_LINE_P (it
))
7007 result
= MOVE_NEWLINE_OR_CR
;
7011 /* The current display element has been consumed. Advance
7013 set_iterator_to_next (it
, 1);
7015 /* Stop if lines are truncated and IT's current x-position is
7016 past the right edge of the window now. */
7017 if (it
->line_wrap
== TRUNCATE
7018 && it
->current_x
>= it
->last_visible_x
)
7020 #ifdef HAVE_WINDOW_SYSTEM
7021 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7023 if (!get_next_display_element (it
)
7024 || BUFFER_POS_REACHED_P ())
7026 result
= MOVE_POS_MATCH_OR_ZV
;
7029 if (ITERATOR_AT_END_OF_LINE_P (it
))
7031 result
= MOVE_NEWLINE_OR_CR
;
7035 #endif /* HAVE_WINDOW_SYSTEM */
7036 result
= MOVE_LINE_TRUNCATED
;
7039 #undef IT_RESET_X_ASCENT_DESCENT
7042 #undef BUFFER_POS_REACHED_P
7044 /* If we scanned beyond to_pos and didn't find a point to wrap at,
7045 restore the saved iterator. */
7046 if (atpos_it
.sp
>= 0)
7048 else if (atx_it
.sp
>= 0)
7053 /* Restore the iterator settings altered at the beginning of this
7055 it
->glyph_row
= saved_glyph_row
;
7059 /* For external use. */
7061 move_it_in_display_line (struct it
*it
,
7062 EMACS_INT to_charpos
, int to_x
,
7063 enum move_operation_enum op
)
7065 if (it
->line_wrap
== WORD_WRAP
7066 && (op
& MOVE_TO_X
))
7068 struct it save_it
= *it
;
7069 int skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7070 /* When word-wrap is on, TO_X may lie past the end
7071 of a wrapped line. Then it->current is the
7072 character on the next line, so backtrack to the
7073 space before the wrap point. */
7074 if (skip
== MOVE_LINE_CONTINUED
)
7076 int prev_x
= max (it
->current_x
- 1, 0);
7078 move_it_in_display_line_to
7079 (it
, -1, prev_x
, MOVE_TO_X
);
7083 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7087 /* Move IT forward until it satisfies one or more of the criteria in
7088 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
7090 OP is a bit-mask that specifies where to stop, and in particular,
7091 which of those four position arguments makes a difference. See the
7092 description of enum move_operation_enum.
7094 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
7095 screen line, this function will set IT to the next position >
7099 move_it_to (it
, to_charpos
, to_x
, to_y
, to_vpos
, op
)
7101 int to_charpos
, to_x
, to_y
, to_vpos
;
7104 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
7110 if (op
& MOVE_TO_VPOS
)
7112 /* If no TO_CHARPOS and no TO_X specified, stop at the
7113 start of the line TO_VPOS. */
7114 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
7116 if (it
->vpos
== to_vpos
)
7122 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
7126 /* TO_VPOS >= 0 means stop at TO_X in the line at
7127 TO_VPOS, or at TO_POS, whichever comes first. */
7128 if (it
->vpos
== to_vpos
)
7134 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7136 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
7141 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
7143 /* We have reached TO_X but not in the line we want. */
7144 skip
= move_it_in_display_line_to (it
, to_charpos
,
7146 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7154 else if (op
& MOVE_TO_Y
)
7156 struct it it_backup
;
7158 if (it
->line_wrap
== WORD_WRAP
)
7161 /* TO_Y specified means stop at TO_X in the line containing
7162 TO_Y---or at TO_CHARPOS if this is reached first. The
7163 problem is that we can't really tell whether the line
7164 contains TO_Y before we have completely scanned it, and
7165 this may skip past TO_X. What we do is to first scan to
7168 If TO_X is not specified, use a TO_X of zero. The reason
7169 is to make the outcome of this function more predictable.
7170 If we didn't use TO_X == 0, we would stop at the end of
7171 the line which is probably not what a caller would expect
7173 skip
= move_it_in_display_line_to
7174 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
7175 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
7177 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
7178 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7180 else if (skip
== MOVE_X_REACHED
)
7182 /* If TO_X was reached, we want to know whether TO_Y is
7183 in the line. We know this is the case if the already
7184 scanned glyphs make the line tall enough. Otherwise,
7185 we must check by scanning the rest of the line. */
7186 line_height
= it
->max_ascent
+ it
->max_descent
;
7187 if (to_y
>= it
->current_y
7188 && to_y
< it
->current_y
+ line_height
)
7194 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
7195 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
7197 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
7198 line_height
= it
->max_ascent
+ it
->max_descent
;
7199 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7201 if (to_y
>= it
->current_y
7202 && to_y
< it
->current_y
+ line_height
)
7204 /* If TO_Y is in this line and TO_X was reached
7205 above, we scanned too far. We have to restore
7206 IT's settings to the ones before skipping. */
7213 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7219 /* Check whether TO_Y is in this line. */
7220 line_height
= it
->max_ascent
+ it
->max_descent
;
7221 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7223 if (to_y
>= it
->current_y
7224 && to_y
< it
->current_y
+ line_height
)
7226 /* When word-wrap is on, TO_X may lie past the end
7227 of a wrapped line. Then it->current is the
7228 character on the next line, so backtrack to the
7229 space before the wrap point. */
7230 if (skip
== MOVE_LINE_CONTINUED
7231 && it
->line_wrap
== WORD_WRAP
)
7233 int prev_x
= max (it
->current_x
- 1, 0);
7235 skip
= move_it_in_display_line_to
7236 (it
, -1, prev_x
, MOVE_TO_X
);
7245 else if (BUFFERP (it
->object
)
7246 && it
->method
== GET_FROM_BUFFER
7247 && IT_CHARPOS (*it
) >= to_charpos
)
7248 skip
= MOVE_POS_MATCH_OR_ZV
;
7250 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
7254 case MOVE_POS_MATCH_OR_ZV
:
7258 case MOVE_NEWLINE_OR_CR
:
7259 set_iterator_to_next (it
, 1);
7260 it
->continuation_lines_width
= 0;
7263 case MOVE_LINE_TRUNCATED
:
7264 it
->continuation_lines_width
= 0;
7265 reseat_at_next_visible_line_start (it
, 0);
7266 if ((op
& MOVE_TO_POS
) != 0
7267 && IT_CHARPOS (*it
) > to_charpos
)
7274 case MOVE_LINE_CONTINUED
:
7275 /* For continued lines ending in a tab, some of the glyphs
7276 associated with the tab are displayed on the current
7277 line. Since it->current_x does not include these glyphs,
7278 we use it->last_visible_x instead. */
7279 it
->continuation_lines_width
+=
7280 (it
->c
== '\t') ? it
->last_visible_x
: it
->current_x
;
7287 /* Reset/increment for the next run. */
7288 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
7289 it
->current_x
= it
->hpos
= 0;
7290 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7292 last_height
= it
->max_ascent
+ it
->max_descent
;
7293 last_max_ascent
= it
->max_ascent
;
7294 it
->max_ascent
= it
->max_descent
= 0;
7299 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
7303 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
7305 If DY > 0, move IT backward at least that many pixels. DY = 0
7306 means move IT backward to the preceding line start or BEGV. This
7307 function may move over more than DY pixels if IT->current_y - DY
7308 ends up in the middle of a line; in this case IT->current_y will be
7309 set to the top of the line moved to. */
7312 move_it_vertically_backward (it
, dy
)
7323 start_pos
= IT_CHARPOS (*it
);
7325 /* Estimate how many newlines we must move back. */
7326 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
7328 /* Set the iterator's position that many lines back. */
7329 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
7330 back_to_previous_visible_line_start (it
);
7332 /* Reseat the iterator here. When moving backward, we don't want
7333 reseat to skip forward over invisible text, set up the iterator
7334 to deliver from overlay strings at the new position etc. So,
7335 use reseat_1 here. */
7336 reseat_1 (it
, it
->current
.pos
, 1);
7338 /* We are now surely at a line start. */
7339 it
->current_x
= it
->hpos
= 0;
7340 it
->continuation_lines_width
= 0;
7342 /* Move forward and see what y-distance we moved. First move to the
7343 start of the next line so that we get its height. We need this
7344 height to be able to tell whether we reached the specified
7347 it2
.max_ascent
= it2
.max_descent
= 0;
7350 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
7351 MOVE_TO_POS
| MOVE_TO_VPOS
);
7353 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
7354 xassert (IT_CHARPOS (*it
) >= BEGV
);
7357 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
7358 xassert (IT_CHARPOS (*it
) >= BEGV
);
7359 /* H is the actual vertical distance from the position in *IT
7360 and the starting position. */
7361 h
= it2
.current_y
- it
->current_y
;
7362 /* NLINES is the distance in number of lines. */
7363 nlines
= it2
.vpos
- it
->vpos
;
7365 /* Correct IT's y and vpos position
7366 so that they are relative to the starting point. */
7372 /* DY == 0 means move to the start of the screen line. The
7373 value of nlines is > 0 if continuation lines were involved. */
7375 move_it_by_lines (it
, nlines
, 1);
7377 /* I think this assert is bogus if buffer contains
7378 invisible text or images. KFS. */
7379 xassert (IT_CHARPOS (*it
) <= start_pos
);
7384 /* The y-position we try to reach, relative to *IT.
7385 Note that H has been subtracted in front of the if-statement. */
7386 int target_y
= it
->current_y
+ h
- dy
;
7387 int y0
= it3
.current_y
;
7388 int y1
= line_bottom_y (&it3
);
7389 int line_height
= y1
- y0
;
7391 /* If we did not reach target_y, try to move further backward if
7392 we can. If we moved too far backward, try to move forward. */
7393 if (target_y
< it
->current_y
7394 /* This is heuristic. In a window that's 3 lines high, with
7395 a line height of 13 pixels each, recentering with point
7396 on the bottom line will try to move -39/2 = 19 pixels
7397 backward. Try to avoid moving into the first line. */
7398 && (it
->current_y
- target_y
7399 > min (window_box_height (it
->w
), line_height
* 2 / 3))
7400 && IT_CHARPOS (*it
) > BEGV
)
7402 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
7403 target_y
- it
->current_y
));
7404 dy
= it
->current_y
- target_y
;
7405 goto move_further_back
;
7407 else if (target_y
>= it
->current_y
+ line_height
7408 && IT_CHARPOS (*it
) < ZV
)
7410 /* Should move forward by at least one line, maybe more.
7412 Note: Calling move_it_by_lines can be expensive on
7413 terminal frames, where compute_motion is used (via
7414 vmotion) to do the job, when there are very long lines
7415 and truncate-lines is nil. That's the reason for
7416 treating terminal frames specially here. */
7418 if (!FRAME_WINDOW_P (it
->f
))
7419 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
7424 move_it_by_lines (it
, 1, 1);
7426 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
7430 /* I think this assert is bogus if buffer contains
7431 invisible text or images. KFS. */
7432 xassert (IT_CHARPOS (*it
) >= BEGV
);
7439 /* Move IT by a specified amount of pixel lines DY. DY negative means
7440 move backwards. DY = 0 means move to start of screen line. At the
7441 end, IT will be on the start of a screen line. */
7444 move_it_vertically (it
, dy
)
7449 move_it_vertically_backward (it
, -dy
);
7452 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
7453 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
7454 MOVE_TO_POS
| MOVE_TO_Y
);
7455 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
7457 /* If buffer ends in ZV without a newline, move to the start of
7458 the line to satisfy the post-condition. */
7459 if (IT_CHARPOS (*it
) == ZV
7461 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
7462 move_it_by_lines (it
, 0, 0);
7467 /* Move iterator IT past the end of the text line it is in. */
7470 move_it_past_eol (it
)
7473 enum move_it_result rc
;
7475 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
7476 if (rc
== MOVE_NEWLINE_OR_CR
)
7477 set_iterator_to_next (it
, 0);
7481 #if 0 /* Currently not used. */
7483 /* Return non-zero if some text between buffer positions START_CHARPOS
7484 and END_CHARPOS is invisible. IT->window is the window for text
7488 invisible_text_between_p (it
, start_charpos
, end_charpos
)
7490 int start_charpos
, end_charpos
;
7492 Lisp_Object prop
, limit
;
7493 int invisible_found_p
;
7495 xassert (it
!= NULL
&& start_charpos
<= end_charpos
);
7497 /* Is text at START invisible? */
7498 prop
= Fget_char_property (make_number (start_charpos
), Qinvisible
,
7500 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
7501 invisible_found_p
= 1;
7504 limit
= Fnext_single_char_property_change (make_number (start_charpos
),
7506 make_number (end_charpos
));
7507 invisible_found_p
= XFASTINT (limit
) < end_charpos
;
7510 return invisible_found_p
;
7516 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
7517 negative means move up. DVPOS == 0 means move to the start of the
7518 screen line. NEED_Y_P non-zero means calculate IT->current_y. If
7519 NEED_Y_P is zero, IT->current_y will be left unchanged.
7521 Further optimization ideas: If we would know that IT->f doesn't use
7522 a face with proportional font, we could be faster for
7523 truncate-lines nil. */
7526 move_it_by_lines (it
, dvpos
, need_y_p
)
7528 int dvpos
, need_y_p
;
7530 struct position pos
;
7532 /* The commented-out optimization uses vmotion on terminals. This
7533 gives bad results, because elements like it->what, on which
7534 callers such as pos_visible_p rely, aren't updated. */
7535 /* if (!FRAME_WINDOW_P (it->f))
7537 struct text_pos textpos;
7539 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
7540 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
7541 reseat (it, textpos, 1);
7542 it->vpos += pos.vpos;
7543 it->current_y += pos.vpos;
7549 /* DVPOS == 0 means move to the start of the screen line. */
7550 move_it_vertically_backward (it
, 0);
7551 xassert (it
->current_x
== 0 && it
->hpos
== 0);
7552 /* Let next call to line_bottom_y calculate real line height */
7557 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
7558 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
7559 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
7564 int start_charpos
, i
;
7566 /* Start at the beginning of the screen line containing IT's
7567 position. This may actually move vertically backwards,
7568 in case of overlays, so adjust dvpos accordingly. */
7570 move_it_vertically_backward (it
, 0);
7573 /* Go back -DVPOS visible lines and reseat the iterator there. */
7574 start_charpos
= IT_CHARPOS (*it
);
7575 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
7576 back_to_previous_visible_line_start (it
);
7577 reseat (it
, it
->current
.pos
, 1);
7579 /* Move further back if we end up in a string or an image. */
7580 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
7582 /* First try to move to start of display line. */
7584 move_it_vertically_backward (it
, 0);
7586 if (IT_POS_VALID_AFTER_MOVE_P (it
))
7588 /* If start of line is still in string or image,
7589 move further back. */
7590 back_to_previous_visible_line_start (it
);
7591 reseat (it
, it
->current
.pos
, 1);
7595 it
->current_x
= it
->hpos
= 0;
7597 /* Above call may have moved too far if continuation lines
7598 are involved. Scan forward and see if it did. */
7600 it2
.vpos
= it2
.current_y
= 0;
7601 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
7602 it
->vpos
-= it2
.vpos
;
7603 it
->current_y
-= it2
.current_y
;
7604 it
->current_x
= it
->hpos
= 0;
7606 /* If we moved too far back, move IT some lines forward. */
7607 if (it2
.vpos
> -dvpos
)
7609 int delta
= it2
.vpos
+ dvpos
;
7611 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
7612 /* Move back again if we got too far ahead. */
7613 if (IT_CHARPOS (*it
) >= start_charpos
)
7619 /* Return 1 if IT points into the middle of a display vector. */
7622 in_display_vector_p (it
)
7625 return (it
->method
== GET_FROM_DISPLAY_VECTOR
7626 && it
->current
.dpvec_index
> 0
7627 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
7631 /***********************************************************************
7633 ***********************************************************************/
7636 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
7640 add_to_log (format
, arg1
, arg2
)
7642 Lisp_Object arg1
, arg2
;
7644 Lisp_Object args
[3];
7645 Lisp_Object msg
, fmt
;
7648 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
7651 /* Do nothing if called asynchronously. Inserting text into
7652 a buffer may call after-change-functions and alike and
7653 that would means running Lisp asynchronously. */
7654 if (handling_signal
)
7658 GCPRO4 (fmt
, msg
, arg1
, arg2
);
7660 args
[0] = fmt
= build_string (format
);
7663 msg
= Fformat (3, args
);
7665 len
= SBYTES (msg
) + 1;
7666 SAFE_ALLOCA (buffer
, char *, len
);
7667 bcopy (SDATA (msg
), buffer
, len
);
7669 message_dolog (buffer
, len
- 1, 1, 0);
7676 /* Output a newline in the *Messages* buffer if "needs" one. */
7679 message_log_maybe_newline ()
7681 if (message_log_need_newline
)
7682 message_dolog ("", 0, 1, 0);
7686 /* Add a string M of length NBYTES to the message log, optionally
7687 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
7688 nonzero, means interpret the contents of M as multibyte. This
7689 function calls low-level routines in order to bypass text property
7690 hooks, etc. which might not be safe to run.
7692 This may GC (insert may run before/after change hooks),
7693 so the buffer M must NOT point to a Lisp string. */
7696 message_dolog (m
, nbytes
, nlflag
, multibyte
)
7698 int nbytes
, nlflag
, multibyte
;
7700 if (!NILP (Vmemory_full
))
7703 if (!NILP (Vmessage_log_max
))
7705 struct buffer
*oldbuf
;
7706 Lisp_Object oldpoint
, oldbegv
, oldzv
;
7707 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
7708 int point_at_end
= 0;
7710 Lisp_Object old_deactivate_mark
, tem
;
7711 struct gcpro gcpro1
;
7713 old_deactivate_mark
= Vdeactivate_mark
;
7714 oldbuf
= current_buffer
;
7715 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
7716 current_buffer
->undo_list
= Qt
;
7718 oldpoint
= message_dolog_marker1
;
7719 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
7720 oldbegv
= message_dolog_marker2
;
7721 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
7722 oldzv
= message_dolog_marker3
;
7723 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
7724 GCPRO1 (old_deactivate_mark
);
7732 BEGV_BYTE
= BEG_BYTE
;
7735 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
7737 /* Insert the string--maybe converting multibyte to single byte
7738 or vice versa, so that all the text fits the buffer. */
7740 && NILP (current_buffer
->enable_multibyte_characters
))
7742 int i
, c
, char_bytes
;
7743 unsigned char work
[1];
7745 /* Convert a multibyte string to single-byte
7746 for the *Message* buffer. */
7747 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
7749 c
= string_char_and_length (m
+ i
, nbytes
- i
, &char_bytes
);
7750 work
[0] = (ASCII_CHAR_P (c
)
7752 : multibyte_char_to_unibyte (c
, Qnil
));
7753 insert_1_both (work
, 1, 1, 1, 0, 0);
7756 else if (! multibyte
7757 && ! NILP (current_buffer
->enable_multibyte_characters
))
7759 int i
, c
, char_bytes
;
7760 unsigned char *msg
= (unsigned char *) m
;
7761 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
7762 /* Convert a single-byte string to multibyte
7763 for the *Message* buffer. */
7764 for (i
= 0; i
< nbytes
; i
++)
7767 c
= unibyte_char_to_multibyte (c
);
7768 char_bytes
= CHAR_STRING (c
, str
);
7769 insert_1_both (str
, 1, char_bytes
, 1, 0, 0);
7773 insert_1 (m
, nbytes
, 1, 0, 0);
7777 int this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
, dup
;
7778 insert_1 ("\n", 1, 1, 0, 0);
7780 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
7782 this_bol_byte
= PT_BYTE
;
7784 /* See if this line duplicates the previous one.
7785 If so, combine duplicates. */
7788 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
7790 prev_bol_byte
= PT_BYTE
;
7792 dup
= message_log_check_duplicate (prev_bol
, prev_bol_byte
,
7793 this_bol
, this_bol_byte
);
7796 del_range_both (prev_bol
, prev_bol_byte
,
7797 this_bol
, this_bol_byte
, 0);
7803 /* If you change this format, don't forget to also
7804 change message_log_check_duplicate. */
7805 sprintf (dupstr
, " [%d times]", dup
);
7806 duplen
= strlen (dupstr
);
7807 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
7808 insert_1 (dupstr
, duplen
, 1, 0, 1);
7813 /* If we have more than the desired maximum number of lines
7814 in the *Messages* buffer now, delete the oldest ones.
7815 This is safe because we don't have undo in this buffer. */
7817 if (NATNUMP (Vmessage_log_max
))
7819 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
7820 -XFASTINT (Vmessage_log_max
) - 1, 0);
7821 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
7824 BEGV
= XMARKER (oldbegv
)->charpos
;
7825 BEGV_BYTE
= marker_byte_position (oldbegv
);
7834 ZV
= XMARKER (oldzv
)->charpos
;
7835 ZV_BYTE
= marker_byte_position (oldzv
);
7839 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
7841 /* We can't do Fgoto_char (oldpoint) because it will run some
7843 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
7844 XMARKER (oldpoint
)->bytepos
);
7847 unchain_marker (XMARKER (oldpoint
));
7848 unchain_marker (XMARKER (oldbegv
));
7849 unchain_marker (XMARKER (oldzv
));
7851 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
7852 set_buffer_internal (oldbuf
);
7854 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
7855 message_log_need_newline
= !nlflag
;
7856 Vdeactivate_mark
= old_deactivate_mark
;
7861 /* We are at the end of the buffer after just having inserted a newline.
7862 (Note: We depend on the fact we won't be crossing the gap.)
7863 Check to see if the most recent message looks a lot like the previous one.
7864 Return 0 if different, 1 if the new one should just replace it, or a
7865 value N > 1 if we should also append " [N times]". */
7868 message_log_check_duplicate (prev_bol
, prev_bol_byte
, this_bol
, this_bol_byte
)
7869 int prev_bol
, this_bol
;
7870 int prev_bol_byte
, this_bol_byte
;
7873 int len
= Z_BYTE
- 1 - this_bol_byte
;
7875 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
7876 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
7878 for (i
= 0; i
< len
; i
++)
7880 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
7888 if (*p1
++ == ' ' && *p1
++ == '[')
7891 while (*p1
>= '0' && *p1
<= '9')
7892 n
= n
* 10 + *p1
++ - '0';
7893 if (strncmp (p1
, " times]\n", 8) == 0)
7900 /* Display an echo area message M with a specified length of NBYTES
7901 bytes. The string may include null characters. If M is 0, clear
7902 out any existing message, and let the mini-buffer text show
7905 This may GC, so the buffer M must NOT point to a Lisp string. */
7908 message2 (m
, nbytes
, multibyte
)
7913 /* First flush out any partial line written with print. */
7914 message_log_maybe_newline ();
7916 message_dolog (m
, nbytes
, 1, multibyte
);
7917 message2_nolog (m
, nbytes
, multibyte
);
7921 /* The non-logging counterpart of message2. */
7924 message2_nolog (m
, nbytes
, multibyte
)
7926 int nbytes
, multibyte
;
7928 struct frame
*sf
= SELECTED_FRAME ();
7929 message_enable_multibyte
= multibyte
;
7933 if (noninteractive_need_newline
)
7934 putc ('\n', stderr
);
7935 noninteractive_need_newline
= 0;
7937 fwrite (m
, nbytes
, 1, stderr
);
7938 if (cursor_in_echo_area
== 0)
7939 fprintf (stderr
, "\n");
7942 /* A null message buffer means that the frame hasn't really been
7943 initialized yet. Error messages get reported properly by
7944 cmd_error, so this must be just an informative message; toss it. */
7945 else if (INTERACTIVE
7946 && sf
->glyphs_initialized_p
7947 && FRAME_MESSAGE_BUF (sf
))
7949 Lisp_Object mini_window
;
7952 /* Get the frame containing the mini-buffer
7953 that the selected frame is using. */
7954 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
7955 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
7957 FRAME_SAMPLE_VISIBILITY (f
);
7958 if (FRAME_VISIBLE_P (sf
)
7959 && ! FRAME_VISIBLE_P (f
))
7960 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
7964 set_message (m
, Qnil
, nbytes
, multibyte
);
7965 if (minibuffer_auto_raise
)
7966 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
7969 clear_message (1, 1);
7971 do_pending_window_change (0);
7972 echo_area_display (1);
7973 do_pending_window_change (0);
7974 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
7975 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
7980 /* Display an echo area message M with a specified length of NBYTES
7981 bytes. The string may include null characters. If M is not a
7982 string, clear out any existing message, and let the mini-buffer
7985 This function cancels echoing. */
7988 message3 (m
, nbytes
, multibyte
)
7993 struct gcpro gcpro1
;
7996 clear_message (1,1);
7999 /* First flush out any partial line written with print. */
8000 message_log_maybe_newline ();
8006 SAFE_ALLOCA (buffer
, char *, nbytes
);
8007 bcopy (SDATA (m
), buffer
, nbytes
);
8008 message_dolog (buffer
, nbytes
, 1, multibyte
);
8011 message3_nolog (m
, nbytes
, multibyte
);
8017 /* The non-logging version of message3.
8018 This does not cancel echoing, because it is used for echoing.
8019 Perhaps we need to make a separate function for echoing
8020 and make this cancel echoing. */
8023 message3_nolog (m
, nbytes
, multibyte
)
8025 int nbytes
, multibyte
;
8027 struct frame
*sf
= SELECTED_FRAME ();
8028 message_enable_multibyte
= multibyte
;
8032 if (noninteractive_need_newline
)
8033 putc ('\n', stderr
);
8034 noninteractive_need_newline
= 0;
8036 fwrite (SDATA (m
), nbytes
, 1, stderr
);
8037 if (cursor_in_echo_area
== 0)
8038 fprintf (stderr
, "\n");
8041 /* A null message buffer means that the frame hasn't really been
8042 initialized yet. Error messages get reported properly by
8043 cmd_error, so this must be just an informative message; toss it. */
8044 else if (INTERACTIVE
8045 && sf
->glyphs_initialized_p
8046 && FRAME_MESSAGE_BUF (sf
))
8048 Lisp_Object mini_window
;
8052 /* Get the frame containing the mini-buffer
8053 that the selected frame is using. */
8054 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8055 frame
= XWINDOW (mini_window
)->frame
;
8058 FRAME_SAMPLE_VISIBILITY (f
);
8059 if (FRAME_VISIBLE_P (sf
)
8060 && !FRAME_VISIBLE_P (f
))
8061 Fmake_frame_visible (frame
);
8063 if (STRINGP (m
) && SCHARS (m
) > 0)
8065 set_message (NULL
, m
, nbytes
, multibyte
);
8066 if (minibuffer_auto_raise
)
8067 Fraise_frame (frame
);
8068 /* Assume we are not echoing.
8069 (If we are, echo_now will override this.) */
8070 echo_message_buffer
= Qnil
;
8073 clear_message (1, 1);
8075 do_pending_window_change (0);
8076 echo_area_display (1);
8077 do_pending_window_change (0);
8078 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8079 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8084 /* Display a null-terminated echo area message M. If M is 0, clear
8085 out any existing message, and let the mini-buffer text show through.
8087 The buffer M must continue to exist until after the echo area gets
8088 cleared or some other message gets displayed there. Do not pass
8089 text that is stored in a Lisp string. Do not pass text in a buffer
8090 that was alloca'd. */
8096 message2 (m
, (m
? strlen (m
) : 0), 0);
8100 /* The non-logging counterpart of message1. */
8106 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
8109 /* Display a message M which contains a single %s
8110 which gets replaced with STRING. */
8113 message_with_string (m
, string
, log
)
8118 CHECK_STRING (string
);
8124 if (noninteractive_need_newline
)
8125 putc ('\n', stderr
);
8126 noninteractive_need_newline
= 0;
8127 fprintf (stderr
, m
, SDATA (string
));
8128 if (cursor_in_echo_area
== 0)
8129 fprintf (stderr
, "\n");
8133 else if (INTERACTIVE
)
8135 /* The frame whose minibuffer we're going to display the message on.
8136 It may be larger than the selected frame, so we need
8137 to use its buffer, not the selected frame's buffer. */
8138 Lisp_Object mini_window
;
8139 struct frame
*f
, *sf
= SELECTED_FRAME ();
8141 /* Get the frame containing the minibuffer
8142 that the selected frame is using. */
8143 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8144 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8146 /* A null message buffer means that the frame hasn't really been
8147 initialized yet. Error messages get reported properly by
8148 cmd_error, so this must be just an informative message; toss it. */
8149 if (FRAME_MESSAGE_BUF (f
))
8151 Lisp_Object args
[2], message
;
8152 struct gcpro gcpro1
, gcpro2
;
8154 args
[0] = build_string (m
);
8155 args
[1] = message
= string
;
8156 GCPRO2 (args
[0], message
);
8159 message
= Fformat (2, args
);
8162 message3 (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
8164 message3_nolog (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
8168 /* Print should start at the beginning of the message
8169 buffer next time. */
8170 message_buf_print
= 0;
8176 /* Dump an informative message to the minibuf. If M is 0, clear out
8177 any existing message, and let the mini-buffer text show through. */
8181 message (m
, a1
, a2
, a3
)
8183 EMACS_INT a1
, a2
, a3
;
8189 if (noninteractive_need_newline
)
8190 putc ('\n', stderr
);
8191 noninteractive_need_newline
= 0;
8192 fprintf (stderr
, m
, a1
, a2
, a3
);
8193 if (cursor_in_echo_area
== 0)
8194 fprintf (stderr
, "\n");
8198 else if (INTERACTIVE
)
8200 /* The frame whose mini-buffer we're going to display the message
8201 on. It may be larger than the selected frame, so we need to
8202 use its buffer, not the selected frame's buffer. */
8203 Lisp_Object mini_window
;
8204 struct frame
*f
, *sf
= SELECTED_FRAME ();
8206 /* Get the frame containing the mini-buffer
8207 that the selected frame is using. */
8208 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8209 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8211 /* A null message buffer means that the frame hasn't really been
8212 initialized yet. Error messages get reported properly by
8213 cmd_error, so this must be just an informative message; toss
8215 if (FRAME_MESSAGE_BUF (f
))
8226 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8227 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3, a
);
8229 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8230 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3,
8232 #endif /* NO_ARG_ARRAY */
8234 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
8239 /* Print should start at the beginning of the message
8240 buffer next time. */
8241 message_buf_print
= 0;
8247 /* The non-logging version of message. */
8250 message_nolog (m
, a1
, a2
, a3
)
8252 EMACS_INT a1
, a2
, a3
;
8254 Lisp_Object old_log_max
;
8255 old_log_max
= Vmessage_log_max
;
8256 Vmessage_log_max
= Qnil
;
8257 message (m
, a1
, a2
, a3
);
8258 Vmessage_log_max
= old_log_max
;
8262 /* Display the current message in the current mini-buffer. This is
8263 only called from error handlers in process.c, and is not time
8269 if (!NILP (echo_area_buffer
[0]))
8272 string
= Fcurrent_message ();
8273 message3 (string
, SBYTES (string
),
8274 !NILP (current_buffer
->enable_multibyte_characters
));
8279 /* Make sure echo area buffers in `echo_buffers' are live.
8280 If they aren't, make new ones. */
8283 ensure_echo_area_buffers ()
8287 for (i
= 0; i
< 2; ++i
)
8288 if (!BUFFERP (echo_buffer
[i
])
8289 || NILP (XBUFFER (echo_buffer
[i
])->name
))
8292 Lisp_Object old_buffer
;
8295 old_buffer
= echo_buffer
[i
];
8296 sprintf (name
, " *Echo Area %d*", i
);
8297 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
8298 XBUFFER (echo_buffer
[i
])->truncate_lines
= Qnil
;
8300 for (j
= 0; j
< 2; ++j
)
8301 if (EQ (old_buffer
, echo_area_buffer
[j
]))
8302 echo_area_buffer
[j
] = echo_buffer
[i
];
8307 /* Call FN with args A1..A4 with either the current or last displayed
8308 echo_area_buffer as current buffer.
8310 WHICH zero means use the current message buffer
8311 echo_area_buffer[0]. If that is nil, choose a suitable buffer
8312 from echo_buffer[] and clear it.
8314 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
8315 suitable buffer from echo_buffer[] and clear it.
8317 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
8318 that the current message becomes the last displayed one, make
8319 choose a suitable buffer for echo_area_buffer[0], and clear it.
8321 Value is what FN returns. */
8324 with_echo_area_buffer (w
, which
, fn
, a1
, a2
, a3
, a4
)
8327 int (*fn
) P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
8333 int this_one
, the_other
, clear_buffer_p
, rc
;
8334 int count
= SPECPDL_INDEX ();
8336 /* If buffers aren't live, make new ones. */
8337 ensure_echo_area_buffers ();
8342 this_one
= 0, the_other
= 1;
8344 this_one
= 1, the_other
= 0;
8347 this_one
= 0, the_other
= 1;
8350 /* We need a fresh one in case the current echo buffer equals
8351 the one containing the last displayed echo area message. */
8352 if (!NILP (echo_area_buffer
[this_one
])
8353 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
8354 echo_area_buffer
[this_one
] = Qnil
;
8357 /* Choose a suitable buffer from echo_buffer[] is we don't
8359 if (NILP (echo_area_buffer
[this_one
]))
8361 echo_area_buffer
[this_one
]
8362 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
8363 ? echo_buffer
[the_other
]
8364 : echo_buffer
[this_one
]);
8368 buffer
= echo_area_buffer
[this_one
];
8370 /* Don't get confused by reusing the buffer used for echoing
8371 for a different purpose. */
8372 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
8375 record_unwind_protect (unwind_with_echo_area_buffer
,
8376 with_echo_area_buffer_unwind_data (w
));
8378 /* Make the echo area buffer current. Note that for display
8379 purposes, it is not necessary that the displayed window's buffer
8380 == current_buffer, except for text property lookup. So, let's
8381 only set that buffer temporarily here without doing a full
8382 Fset_window_buffer. We must also change w->pointm, though,
8383 because otherwise an assertions in unshow_buffer fails, and Emacs
8385 set_buffer_internal_1 (XBUFFER (buffer
));
8389 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
8392 current_buffer
->undo_list
= Qt
;
8393 current_buffer
->read_only
= Qnil
;
8394 specbind (Qinhibit_read_only
, Qt
);
8395 specbind (Qinhibit_modification_hooks
, Qt
);
8397 if (clear_buffer_p
&& Z
> BEG
)
8400 xassert (BEGV
>= BEG
);
8401 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8403 rc
= fn (a1
, a2
, a3
, a4
);
8405 xassert (BEGV
>= BEG
);
8406 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8408 unbind_to (count
, Qnil
);
8413 /* Save state that should be preserved around the call to the function
8414 FN called in with_echo_area_buffer. */
8417 with_echo_area_buffer_unwind_data (w
)
8421 Lisp_Object vector
, tmp
;
8423 /* Reduce consing by keeping one vector in
8424 Vwith_echo_area_save_vector. */
8425 vector
= Vwith_echo_area_save_vector
;
8426 Vwith_echo_area_save_vector
= Qnil
;
8429 vector
= Fmake_vector (make_number (7), Qnil
);
8431 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
8432 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
8433 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
8437 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
8438 ASET (vector
, i
, w
->buffer
); ++i
;
8439 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
8440 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
8445 for (; i
< end
; ++i
)
8446 ASET (vector
, i
, Qnil
);
8449 xassert (i
== ASIZE (vector
));
8454 /* Restore global state from VECTOR which was created by
8455 with_echo_area_buffer_unwind_data. */
8458 unwind_with_echo_area_buffer (vector
)
8461 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
8462 Vdeactivate_mark
= AREF (vector
, 1);
8463 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
8465 if (WINDOWP (AREF (vector
, 3)))
8468 Lisp_Object buffer
, charpos
, bytepos
;
8470 w
= XWINDOW (AREF (vector
, 3));
8471 buffer
= AREF (vector
, 4);
8472 charpos
= AREF (vector
, 5);
8473 bytepos
= AREF (vector
, 6);
8476 set_marker_both (w
->pointm
, buffer
,
8477 XFASTINT (charpos
), XFASTINT (bytepos
));
8480 Vwith_echo_area_save_vector
= vector
;
8485 /* Set up the echo area for use by print functions. MULTIBYTE_P
8486 non-zero means we will print multibyte. */
8489 setup_echo_area_for_printing (multibyte_p
)
8492 /* If we can't find an echo area any more, exit. */
8493 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8496 ensure_echo_area_buffers ();
8498 if (!message_buf_print
)
8500 /* A message has been output since the last time we printed.
8501 Choose a fresh echo area buffer. */
8502 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8503 echo_area_buffer
[0] = echo_buffer
[1];
8505 echo_area_buffer
[0] = echo_buffer
[0];
8507 /* Switch to that buffer and clear it. */
8508 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8509 current_buffer
->truncate_lines
= Qnil
;
8513 int count
= SPECPDL_INDEX ();
8514 specbind (Qinhibit_read_only
, Qt
);
8515 /* Note that undo recording is always disabled. */
8517 unbind_to (count
, Qnil
);
8519 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8521 /* Set up the buffer for the multibyteness we need. */
8523 != !NILP (current_buffer
->enable_multibyte_characters
))
8524 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
8526 /* Raise the frame containing the echo area. */
8527 if (minibuffer_auto_raise
)
8529 struct frame
*sf
= SELECTED_FRAME ();
8530 Lisp_Object mini_window
;
8531 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8532 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8535 message_log_maybe_newline ();
8536 message_buf_print
= 1;
8540 if (NILP (echo_area_buffer
[0]))
8542 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8543 echo_area_buffer
[0] = echo_buffer
[1];
8545 echo_area_buffer
[0] = echo_buffer
[0];
8548 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
8550 /* Someone switched buffers between print requests. */
8551 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8552 current_buffer
->truncate_lines
= Qnil
;
8558 /* Display an echo area message in window W. Value is non-zero if W's
8559 height is changed. If display_last_displayed_message_p is
8560 non-zero, display the message that was last displayed, otherwise
8561 display the current message. */
8564 display_echo_area (w
)
8567 int i
, no_message_p
, window_height_changed_p
, count
;
8569 /* Temporarily disable garbage collections while displaying the echo
8570 area. This is done because a GC can print a message itself.
8571 That message would modify the echo area buffer's contents while a
8572 redisplay of the buffer is going on, and seriously confuse
8574 count
= inhibit_garbage_collection ();
8576 /* If there is no message, we must call display_echo_area_1
8577 nevertheless because it resizes the window. But we will have to
8578 reset the echo_area_buffer in question to nil at the end because
8579 with_echo_area_buffer will sets it to an empty buffer. */
8580 i
= display_last_displayed_message_p
? 1 : 0;
8581 no_message_p
= NILP (echo_area_buffer
[i
]);
8583 window_height_changed_p
8584 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
8585 display_echo_area_1
,
8586 (EMACS_INT
) w
, Qnil
, 0, 0);
8589 echo_area_buffer
[i
] = Qnil
;
8591 unbind_to (count
, Qnil
);
8592 return window_height_changed_p
;
8596 /* Helper for display_echo_area. Display the current buffer which
8597 contains the current echo area message in window W, a mini-window,
8598 a pointer to which is passed in A1. A2..A4 are currently not used.
8599 Change the height of W so that all of the message is displayed.
8600 Value is non-zero if height of W was changed. */
8603 display_echo_area_1 (a1
, a2
, a3
, a4
)
8608 struct window
*w
= (struct window
*) a1
;
8610 struct text_pos start
;
8611 int window_height_changed_p
= 0;
8613 /* Do this before displaying, so that we have a large enough glyph
8614 matrix for the display. If we can't get enough space for the
8615 whole text, display the last N lines. That works by setting w->start. */
8616 window_height_changed_p
= resize_mini_window (w
, 0);
8618 /* Use the starting position chosen by resize_mini_window. */
8619 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
8622 clear_glyph_matrix (w
->desired_matrix
);
8623 XSETWINDOW (window
, w
);
8624 try_window (window
, start
, 0);
8626 return window_height_changed_p
;
8630 /* Resize the echo area window to exactly the size needed for the
8631 currently displayed message, if there is one. If a mini-buffer
8632 is active, don't shrink it. */
8635 resize_echo_area_exactly ()
8637 if (BUFFERP (echo_area_buffer
[0])
8638 && WINDOWP (echo_area_window
))
8640 struct window
*w
= XWINDOW (echo_area_window
);
8642 Lisp_Object resize_exactly
;
8644 if (minibuf_level
== 0)
8645 resize_exactly
= Qt
;
8647 resize_exactly
= Qnil
;
8649 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
8650 (EMACS_INT
) w
, resize_exactly
, 0, 0);
8653 ++windows_or_buffers_changed
;
8654 ++update_mode_lines
;
8655 redisplay_internal (0);
8661 /* Callback function for with_echo_area_buffer, when used from
8662 resize_echo_area_exactly. A1 contains a pointer to the window to
8663 resize, EXACTLY non-nil means resize the mini-window exactly to the
8664 size of the text displayed. A3 and A4 are not used. Value is what
8665 resize_mini_window returns. */
8668 resize_mini_window_1 (a1
, exactly
, a3
, a4
)
8670 Lisp_Object exactly
;
8673 return resize_mini_window ((struct window
*) a1
, !NILP (exactly
));
8677 /* Resize mini-window W to fit the size of its contents. EXACT_P
8678 means size the window exactly to the size needed. Otherwise, it's
8679 only enlarged until W's buffer is empty.
8681 Set W->start to the right place to begin display. If the whole
8682 contents fit, start at the beginning. Otherwise, start so as
8683 to make the end of the contents appear. This is particularly
8684 important for y-or-n-p, but seems desirable generally.
8686 Value is non-zero if the window height has been changed. */
8689 resize_mini_window (w
, exact_p
)
8693 struct frame
*f
= XFRAME (w
->frame
);
8694 int window_height_changed_p
= 0;
8696 xassert (MINI_WINDOW_P (w
));
8698 /* By default, start display at the beginning. */
8699 set_marker_both (w
->start
, w
->buffer
,
8700 BUF_BEGV (XBUFFER (w
->buffer
)),
8701 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
8703 /* Don't resize windows while redisplaying a window; it would
8704 confuse redisplay functions when the size of the window they are
8705 displaying changes from under them. Such a resizing can happen,
8706 for instance, when which-func prints a long message while
8707 we are running fontification-functions. We're running these
8708 functions with safe_call which binds inhibit-redisplay to t. */
8709 if (!NILP (Vinhibit_redisplay
))
8712 /* Nil means don't try to resize. */
8713 if (NILP (Vresize_mini_windows
)
8714 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
8717 if (!FRAME_MINIBUF_ONLY_P (f
))
8720 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
8721 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
8722 int height
, max_height
;
8723 int unit
= FRAME_LINE_HEIGHT (f
);
8724 struct text_pos start
;
8725 struct buffer
*old_current_buffer
= NULL
;
8727 if (current_buffer
!= XBUFFER (w
->buffer
))
8729 old_current_buffer
= current_buffer
;
8730 set_buffer_internal (XBUFFER (w
->buffer
));
8733 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8735 /* Compute the max. number of lines specified by the user. */
8736 if (FLOATP (Vmax_mini_window_height
))
8737 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
8738 else if (INTEGERP (Vmax_mini_window_height
))
8739 max_height
= XINT (Vmax_mini_window_height
);
8741 max_height
= total_height
/ 4;
8743 /* Correct that max. height if it's bogus. */
8744 max_height
= max (1, max_height
);
8745 max_height
= min (total_height
, max_height
);
8747 /* Find out the height of the text in the window. */
8748 if (it
.line_wrap
== TRUNCATE
)
8753 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
8754 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
8755 height
= it
.current_y
+ last_height
;
8757 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
8758 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
8759 height
= (height
+ unit
- 1) / unit
;
8762 /* Compute a suitable window start. */
8763 if (height
> max_height
)
8765 height
= max_height
;
8766 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8767 move_it_vertically_backward (&it
, (height
- 1) * unit
);
8768 start
= it
.current
.pos
;
8771 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
8772 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
8774 if (EQ (Vresize_mini_windows
, Qgrow_only
))
8776 /* Let it grow only, until we display an empty message, in which
8777 case the window shrinks again. */
8778 if (height
> WINDOW_TOTAL_LINES (w
))
8780 int old_height
= WINDOW_TOTAL_LINES (w
);
8781 freeze_window_starts (f
, 1);
8782 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8783 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8785 else if (height
< WINDOW_TOTAL_LINES (w
)
8786 && (exact_p
|| BEGV
== ZV
))
8788 int old_height
= WINDOW_TOTAL_LINES (w
);
8789 freeze_window_starts (f
, 0);
8790 shrink_mini_window (w
);
8791 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8796 /* Always resize to exact size needed. */
8797 if (height
> WINDOW_TOTAL_LINES (w
))
8799 int old_height
= WINDOW_TOTAL_LINES (w
);
8800 freeze_window_starts (f
, 1);
8801 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8802 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8804 else if (height
< WINDOW_TOTAL_LINES (w
))
8806 int old_height
= WINDOW_TOTAL_LINES (w
);
8807 freeze_window_starts (f
, 0);
8808 shrink_mini_window (w
);
8812 freeze_window_starts (f
, 1);
8813 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8816 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8820 if (old_current_buffer
)
8821 set_buffer_internal (old_current_buffer
);
8824 return window_height_changed_p
;
8828 /* Value is the current message, a string, or nil if there is no
8836 if (!BUFFERP (echo_area_buffer
[0]))
8840 with_echo_area_buffer (0, 0, current_message_1
,
8841 (EMACS_INT
) &msg
, Qnil
, 0, 0);
8843 echo_area_buffer
[0] = Qnil
;
8851 current_message_1 (a1
, a2
, a3
, a4
)
8856 Lisp_Object
*msg
= (Lisp_Object
*) a1
;
8859 *msg
= make_buffer_string (BEG
, Z
, 1);
8866 /* Push the current message on Vmessage_stack for later restauration
8867 by restore_message. Value is non-zero if the current message isn't
8868 empty. This is a relatively infrequent operation, so it's not
8869 worth optimizing. */
8875 msg
= current_message ();
8876 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
8877 return STRINGP (msg
);
8881 /* Restore message display from the top of Vmessage_stack. */
8888 xassert (CONSP (Vmessage_stack
));
8889 msg
= XCAR (Vmessage_stack
);
8891 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
8893 message3_nolog (msg
, 0, 0);
8897 /* Handler for record_unwind_protect calling pop_message. */
8900 pop_message_unwind (dummy
)
8907 /* Pop the top-most entry off Vmessage_stack. */
8912 xassert (CONSP (Vmessage_stack
));
8913 Vmessage_stack
= XCDR (Vmessage_stack
);
8917 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
8918 exits. If the stack is not empty, we have a missing pop_message
8922 check_message_stack ()
8924 if (!NILP (Vmessage_stack
))
8929 /* Truncate to NCHARS what will be displayed in the echo area the next
8930 time we display it---but don't redisplay it now. */
8933 truncate_echo_area (nchars
)
8937 echo_area_buffer
[0] = Qnil
;
8938 /* A null message buffer means that the frame hasn't really been
8939 initialized yet. Error messages get reported properly by
8940 cmd_error, so this must be just an informative message; toss it. */
8941 else if (!noninteractive
8943 && !NILP (echo_area_buffer
[0]))
8945 struct frame
*sf
= SELECTED_FRAME ();
8946 if (FRAME_MESSAGE_BUF (sf
))
8947 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
8952 /* Helper function for truncate_echo_area. Truncate the current
8953 message to at most NCHARS characters. */
8956 truncate_message_1 (nchars
, a2
, a3
, a4
)
8961 if (BEG
+ nchars
< Z
)
8962 del_range (BEG
+ nchars
, Z
);
8964 echo_area_buffer
[0] = Qnil
;
8969 /* Set the current message to a substring of S or STRING.
8971 If STRING is a Lisp string, set the message to the first NBYTES
8972 bytes from STRING. NBYTES zero means use the whole string. If
8973 STRING is multibyte, the message will be displayed multibyte.
8975 If S is not null, set the message to the first LEN bytes of S. LEN
8976 zero means use the whole string. MULTIBYTE_P non-zero means S is
8977 multibyte. Display the message multibyte in that case.
8979 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
8980 to t before calling set_message_1 (which calls insert).
8984 set_message (s
, string
, nbytes
, multibyte_p
)
8987 int nbytes
, multibyte_p
;
8989 message_enable_multibyte
8990 = ((s
&& multibyte_p
)
8991 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
8993 with_echo_area_buffer (0, -1, set_message_1
,
8994 (EMACS_INT
) s
, string
, nbytes
, multibyte_p
);
8995 message_buf_print
= 0;
8996 help_echo_showing_p
= 0;
9000 /* Helper function for set_message. Arguments have the same meaning
9001 as there, with A1 corresponding to S and A2 corresponding to STRING
9002 This function is called with the echo area buffer being
9006 set_message_1 (a1
, a2
, nbytes
, multibyte_p
)
9009 EMACS_INT nbytes
, multibyte_p
;
9011 const char *s
= (const char *) a1
;
9012 Lisp_Object string
= a2
;
9014 /* Change multibyteness of the echo buffer appropriately. */
9015 if (message_enable_multibyte
9016 != !NILP (current_buffer
->enable_multibyte_characters
))
9017 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
9019 current_buffer
->truncate_lines
= message_truncate_lines
? Qt
: Qnil
;
9021 /* Insert new message at BEG. */
9022 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9024 if (STRINGP (string
))
9029 nbytes
= SBYTES (string
);
9030 nchars
= string_byte_to_char (string
, nbytes
);
9032 /* This function takes care of single/multibyte conversion. We
9033 just have to ensure that the echo area buffer has the right
9034 setting of enable_multibyte_characters. */
9035 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
9040 nbytes
= strlen (s
);
9042 if (multibyte_p
&& NILP (current_buffer
->enable_multibyte_characters
))
9044 /* Convert from multi-byte to single-byte. */
9046 unsigned char work
[1];
9048 /* Convert a multibyte string to single-byte. */
9049 for (i
= 0; i
< nbytes
; i
+= n
)
9051 c
= string_char_and_length (s
+ i
, nbytes
- i
, &n
);
9052 work
[0] = (ASCII_CHAR_P (c
)
9054 : multibyte_char_to_unibyte (c
, Qnil
));
9055 insert_1_both (work
, 1, 1, 1, 0, 0);
9058 else if (!multibyte_p
9059 && !NILP (current_buffer
->enable_multibyte_characters
))
9061 /* Convert from single-byte to multi-byte. */
9063 const unsigned char *msg
= (const unsigned char *) s
;
9064 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9066 /* Convert a single-byte string to multibyte. */
9067 for (i
= 0; i
< nbytes
; i
++)
9070 c
= unibyte_char_to_multibyte (c
);
9071 n
= CHAR_STRING (c
, str
);
9072 insert_1_both (str
, 1, n
, 1, 0, 0);
9076 insert_1 (s
, nbytes
, 1, 0, 0);
9083 /* Clear messages. CURRENT_P non-zero means clear the current
9084 message. LAST_DISPLAYED_P non-zero means clear the message
9088 clear_message (current_p
, last_displayed_p
)
9089 int current_p
, last_displayed_p
;
9093 echo_area_buffer
[0] = Qnil
;
9094 message_cleared_p
= 1;
9097 if (last_displayed_p
)
9098 echo_area_buffer
[1] = Qnil
;
9100 message_buf_print
= 0;
9103 /* Clear garbaged frames.
9105 This function is used where the old redisplay called
9106 redraw_garbaged_frames which in turn called redraw_frame which in
9107 turn called clear_frame. The call to clear_frame was a source of
9108 flickering. I believe a clear_frame is not necessary. It should
9109 suffice in the new redisplay to invalidate all current matrices,
9110 and ensure a complete redisplay of all windows. */
9113 clear_garbaged_frames ()
9117 Lisp_Object tail
, frame
;
9118 int changed_count
= 0;
9120 FOR_EACH_FRAME (tail
, frame
)
9122 struct frame
*f
= XFRAME (frame
);
9124 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
9128 Fredraw_frame (frame
);
9129 f
->force_flush_display_p
= 1;
9131 clear_current_matrices (f
);
9140 ++windows_or_buffers_changed
;
9145 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
9146 is non-zero update selected_frame. Value is non-zero if the
9147 mini-windows height has been changed. */
9150 echo_area_display (update_frame_p
)
9153 Lisp_Object mini_window
;
9156 int window_height_changed_p
= 0;
9157 struct frame
*sf
= SELECTED_FRAME ();
9159 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9160 w
= XWINDOW (mini_window
);
9161 f
= XFRAME (WINDOW_FRAME (w
));
9163 /* Don't display if frame is invisible or not yet initialized. */
9164 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
9167 #ifdef HAVE_WINDOW_SYSTEM
9168 /* When Emacs starts, selected_frame may be the initial terminal
9169 frame. If we let this through, a message would be displayed on
9171 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
9173 #endif /* HAVE_WINDOW_SYSTEM */
9175 /* Redraw garbaged frames. */
9177 clear_garbaged_frames ();
9179 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
9181 echo_area_window
= mini_window
;
9182 window_height_changed_p
= display_echo_area (w
);
9183 w
->must_be_updated_p
= 1;
9185 /* Update the display, unless called from redisplay_internal.
9186 Also don't update the screen during redisplay itself. The
9187 update will happen at the end of redisplay, and an update
9188 here could cause confusion. */
9189 if (update_frame_p
&& !redisplaying_p
)
9193 /* If the display update has been interrupted by pending
9194 input, update mode lines in the frame. Due to the
9195 pending input, it might have been that redisplay hasn't
9196 been called, so that mode lines above the echo area are
9197 garbaged. This looks odd, so we prevent it here. */
9198 if (!display_completed
)
9199 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
9201 if (window_height_changed_p
9202 /* Don't do this if Emacs is shutting down. Redisplay
9203 needs to run hooks. */
9204 && !NILP (Vrun_hooks
))
9206 /* Must update other windows. Likewise as in other
9207 cases, don't let this update be interrupted by
9209 int count
= SPECPDL_INDEX ();
9210 specbind (Qredisplay_dont_pause
, Qt
);
9211 windows_or_buffers_changed
= 1;
9212 redisplay_internal (0);
9213 unbind_to (count
, Qnil
);
9215 else if (FRAME_WINDOW_P (f
) && n
== 0)
9217 /* Window configuration is the same as before.
9218 Can do with a display update of the echo area,
9219 unless we displayed some mode lines. */
9220 update_single_window (w
, 1);
9221 FRAME_RIF (f
)->flush_display (f
);
9224 update_frame (f
, 1, 1);
9226 /* If cursor is in the echo area, make sure that the next
9227 redisplay displays the minibuffer, so that the cursor will
9228 be replaced with what the minibuffer wants. */
9229 if (cursor_in_echo_area
)
9230 ++windows_or_buffers_changed
;
9233 else if (!EQ (mini_window
, selected_window
))
9234 windows_or_buffers_changed
++;
9236 /* Last displayed message is now the current message. */
9237 echo_area_buffer
[1] = echo_area_buffer
[0];
9238 /* Inform read_char that we're not echoing. */
9239 echo_message_buffer
= Qnil
;
9241 /* Prevent redisplay optimization in redisplay_internal by resetting
9242 this_line_start_pos. This is done because the mini-buffer now
9243 displays the message instead of its buffer text. */
9244 if (EQ (mini_window
, selected_window
))
9245 CHARPOS (this_line_start_pos
) = 0;
9247 return window_height_changed_p
;
9252 /***********************************************************************
9253 Mode Lines and Frame Titles
9254 ***********************************************************************/
9256 /* A buffer for constructing non-propertized mode-line strings and
9257 frame titles in it; allocated from the heap in init_xdisp and
9258 resized as needed in store_mode_line_noprop_char. */
9260 static char *mode_line_noprop_buf
;
9262 /* The buffer's end, and a current output position in it. */
9264 static char *mode_line_noprop_buf_end
;
9265 static char *mode_line_noprop_ptr
;
9267 #define MODE_LINE_NOPROP_LEN(start) \
9268 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
9271 MODE_LINE_DISPLAY
= 0,
9277 /* Alist that caches the results of :propertize.
9278 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
9279 static Lisp_Object mode_line_proptrans_alist
;
9281 /* List of strings making up the mode-line. */
9282 static Lisp_Object mode_line_string_list
;
9284 /* Base face property when building propertized mode line string. */
9285 static Lisp_Object mode_line_string_face
;
9286 static Lisp_Object mode_line_string_face_prop
;
9289 /* Unwind data for mode line strings */
9291 static Lisp_Object Vmode_line_unwind_vector
;
9294 format_mode_line_unwind_data (struct buffer
*obuf
,
9298 Lisp_Object vector
, tmp
;
9300 /* Reduce consing by keeping one vector in
9301 Vwith_echo_area_save_vector. */
9302 vector
= Vmode_line_unwind_vector
;
9303 Vmode_line_unwind_vector
= Qnil
;
9306 vector
= Fmake_vector (make_number (8), Qnil
);
9308 ASET (vector
, 0, make_number (mode_line_target
));
9309 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
9310 ASET (vector
, 2, mode_line_string_list
);
9311 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
9312 ASET (vector
, 4, mode_line_string_face
);
9313 ASET (vector
, 5, mode_line_string_face_prop
);
9316 XSETBUFFER (tmp
, obuf
);
9319 ASET (vector
, 6, tmp
);
9320 ASET (vector
, 7, owin
);
9326 unwind_format_mode_line (vector
)
9329 mode_line_target
= XINT (AREF (vector
, 0));
9330 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
9331 mode_line_string_list
= AREF (vector
, 2);
9332 if (! EQ (AREF (vector
, 3), Qt
))
9333 mode_line_proptrans_alist
= AREF (vector
, 3);
9334 mode_line_string_face
= AREF (vector
, 4);
9335 mode_line_string_face_prop
= AREF (vector
, 5);
9337 if (!NILP (AREF (vector
, 7)))
9338 /* Select window before buffer, since it may change the buffer. */
9339 Fselect_window (AREF (vector
, 7), Qt
);
9341 if (!NILP (AREF (vector
, 6)))
9343 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
9344 ASET (vector
, 6, Qnil
);
9347 Vmode_line_unwind_vector
= vector
;
9352 /* Store a single character C for the frame title in mode_line_noprop_buf.
9353 Re-allocate mode_line_noprop_buf if necessary. */
9357 store_mode_line_noprop_char (char c
)
9359 store_mode_line_noprop_char (c
)
9363 /* If output position has reached the end of the allocated buffer,
9364 double the buffer's size. */
9365 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
9367 int len
= MODE_LINE_NOPROP_LEN (0);
9368 int new_size
= 2 * len
* sizeof *mode_line_noprop_buf
;
9369 mode_line_noprop_buf
= (char *) xrealloc (mode_line_noprop_buf
, new_size
);
9370 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ new_size
;
9371 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
9374 *mode_line_noprop_ptr
++ = c
;
9378 /* Store part of a frame title in mode_line_noprop_buf, beginning at
9379 mode_line_noprop_ptr. STR is the string to store. Do not copy
9380 characters that yield more columns than PRECISION; PRECISION <= 0
9381 means copy the whole string. Pad with spaces until FIELD_WIDTH
9382 number of characters have been copied; FIELD_WIDTH <= 0 means don't
9383 pad. Called from display_mode_element when it is used to build a
9387 store_mode_line_noprop (str
, field_width
, precision
)
9388 const unsigned char *str
;
9389 int field_width
, precision
;
9394 /* Copy at most PRECISION chars from STR. */
9395 nbytes
= strlen (str
);
9396 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
9398 store_mode_line_noprop_char (*str
++);
9400 /* Fill up with spaces until FIELD_WIDTH reached. */
9401 while (field_width
> 0
9404 store_mode_line_noprop_char (' ');
9411 /***********************************************************************
9413 ***********************************************************************/
9415 #ifdef HAVE_WINDOW_SYSTEM
9417 /* Set the title of FRAME, if it has changed. The title format is
9418 Vicon_title_format if FRAME is iconified, otherwise it is
9419 frame_title_format. */
9422 x_consider_frame_title (frame
)
9425 struct frame
*f
= XFRAME (frame
);
9427 if (FRAME_WINDOW_P (f
)
9428 || FRAME_MINIBUF_ONLY_P (f
)
9429 || f
->explicit_name
)
9431 /* Do we have more than one visible frame on this X display? */
9438 int count
= SPECPDL_INDEX ();
9440 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
9442 Lisp_Object other_frame
= XCAR (tail
);
9443 struct frame
*tf
= XFRAME (other_frame
);
9446 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
9447 && !FRAME_MINIBUF_ONLY_P (tf
)
9448 && !EQ (other_frame
, tip_frame
)
9449 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
9453 /* Set global variable indicating that multiple frames exist. */
9454 multiple_frames
= CONSP (tail
);
9456 /* Switch to the buffer of selected window of the frame. Set up
9457 mode_line_target so that display_mode_element will output into
9458 mode_line_noprop_buf; then display the title. */
9459 record_unwind_protect (unwind_format_mode_line
,
9460 format_mode_line_unwind_data
9461 (current_buffer
, selected_window
, 0));
9463 Fselect_window (f
->selected_window
, Qt
);
9464 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
9465 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
9467 mode_line_target
= MODE_LINE_TITLE
;
9468 title_start
= MODE_LINE_NOPROP_LEN (0);
9469 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
9470 NULL
, DEFAULT_FACE_ID
);
9471 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
9472 len
= MODE_LINE_NOPROP_LEN (title_start
);
9473 title
= mode_line_noprop_buf
+ title_start
;
9474 unbind_to (count
, Qnil
);
9476 /* Set the title only if it's changed. This avoids consing in
9477 the common case where it hasn't. (If it turns out that we've
9478 already wasted too much time by walking through the list with
9479 display_mode_element, then we might need to optimize at a
9480 higher level than this.) */
9481 if (! STRINGP (f
->name
)
9482 || SBYTES (f
->name
) != len
9483 || bcmp (title
, SDATA (f
->name
), len
) != 0)
9488 if (!MINI_WINDOW_P(XWINDOW(f
->selected_window
)))
9491 ns_set_name_as_filename (f
);
9493 x_implicitly_set_name (f
, make_string(title
, len
),
9499 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
9504 /* do this also for frames with explicit names */
9505 ns_implicitly_set_icon_type(f
);
9506 ns_set_doc_edited(f
, Fbuffer_modified_p
9507 (XWINDOW (f
->selected_window
)->buffer
), Qnil
);
9513 #endif /* not HAVE_WINDOW_SYSTEM */
9518 /***********************************************************************
9520 ***********************************************************************/
9523 /* Prepare for redisplay by updating menu-bar item lists when
9524 appropriate. This can call eval. */
9527 prepare_menu_bars ()
9530 struct gcpro gcpro1
, gcpro2
;
9532 Lisp_Object tooltip_frame
;
9534 #ifdef HAVE_WINDOW_SYSTEM
9535 tooltip_frame
= tip_frame
;
9537 tooltip_frame
= Qnil
;
9540 /* Update all frame titles based on their buffer names, etc. We do
9541 this before the menu bars so that the buffer-menu will show the
9542 up-to-date frame titles. */
9543 #ifdef HAVE_WINDOW_SYSTEM
9544 if (windows_or_buffers_changed
|| update_mode_lines
)
9546 Lisp_Object tail
, frame
;
9548 FOR_EACH_FRAME (tail
, frame
)
9551 if (!EQ (frame
, tooltip_frame
)
9552 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
9553 x_consider_frame_title (frame
);
9556 #endif /* HAVE_WINDOW_SYSTEM */
9558 /* Update the menu bar item lists, if appropriate. This has to be
9559 done before any actual redisplay or generation of display lines. */
9560 all_windows
= (update_mode_lines
9561 || buffer_shared
> 1
9562 || windows_or_buffers_changed
);
9565 Lisp_Object tail
, frame
;
9566 int count
= SPECPDL_INDEX ();
9567 /* 1 means that update_menu_bar has run its hooks
9568 so any further calls to update_menu_bar shouldn't do so again. */
9569 int menu_bar_hooks_run
= 0;
9571 record_unwind_save_match_data ();
9573 FOR_EACH_FRAME (tail
, frame
)
9577 /* Ignore tooltip frame. */
9578 if (EQ (frame
, tooltip_frame
))
9581 /* If a window on this frame changed size, report that to
9582 the user and clear the size-change flag. */
9583 if (FRAME_WINDOW_SIZES_CHANGED (f
))
9585 Lisp_Object functions
;
9587 /* Clear flag first in case we get an error below. */
9588 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
9589 functions
= Vwindow_size_change_functions
;
9590 GCPRO2 (tail
, functions
);
9592 while (CONSP (functions
))
9594 call1 (XCAR (functions
), frame
);
9595 functions
= XCDR (functions
);
9601 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
9602 #ifdef HAVE_WINDOW_SYSTEM
9603 update_tool_bar (f
, 0);
9608 unbind_to (count
, Qnil
);
9612 struct frame
*sf
= SELECTED_FRAME ();
9613 update_menu_bar (sf
, 1, 0);
9614 #ifdef HAVE_WINDOW_SYSTEM
9615 update_tool_bar (sf
, 1);
9619 /* Motif needs this. See comment in xmenu.c. Turn it off when
9620 pending_menu_activation is not defined. */
9621 #ifdef USE_X_TOOLKIT
9622 pending_menu_activation
= 0;
9627 /* Update the menu bar item list for frame F. This has to be done
9628 before we start to fill in any display lines, because it can call
9631 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
9633 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
9634 already ran the menu bar hooks for this redisplay, so there
9635 is no need to run them again. The return value is the
9636 updated value of this flag, to pass to the next call. */
9639 update_menu_bar (f
, save_match_data
, hooks_run
)
9641 int save_match_data
;
9645 register struct window
*w
;
9647 /* If called recursively during a menu update, do nothing. This can
9648 happen when, for instance, an activate-menubar-hook causes a
9650 if (inhibit_menubar_update
)
9653 window
= FRAME_SELECTED_WINDOW (f
);
9654 w
= XWINDOW (window
);
9656 #if 0 /* The if statement below this if statement used to include the
9657 condition !NILP (w->update_mode_line), rather than using
9658 update_mode_lines directly, and this if statement may have
9659 been added to make that condition work. Now the if
9660 statement below matches its comment, this isn't needed. */
9661 if (update_mode_lines
)
9662 w
->update_mode_line
= Qt
;
9665 if (FRAME_WINDOW_P (f
)
9667 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9668 || defined (HAVE_NS) || defined (USE_GTK)
9669 FRAME_EXTERNAL_MENU_BAR (f
)
9671 FRAME_MENU_BAR_LINES (f
) > 0
9673 : FRAME_MENU_BAR_LINES (f
) > 0)
9675 /* If the user has switched buffers or windows, we need to
9676 recompute to reflect the new bindings. But we'll
9677 recompute when update_mode_lines is set too; that means
9678 that people can use force-mode-line-update to request
9679 that the menu bar be recomputed. The adverse effect on
9680 the rest of the redisplay algorithm is about the same as
9681 windows_or_buffers_changed anyway. */
9682 if (windows_or_buffers_changed
9683 /* This used to test w->update_mode_line, but we believe
9684 there is no need to recompute the menu in that case. */
9685 || update_mode_lines
9686 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9687 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9688 != !NILP (w
->last_had_star
))
9689 || ((!NILP (Vtransient_mark_mode
)
9690 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
9691 != !NILP (w
->region_showing
)))
9693 struct buffer
*prev
= current_buffer
;
9694 int count
= SPECPDL_INDEX ();
9696 specbind (Qinhibit_menubar_update
, Qt
);
9698 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9699 if (save_match_data
)
9700 record_unwind_save_match_data ();
9701 if (NILP (Voverriding_local_map_menu_flag
))
9703 specbind (Qoverriding_terminal_local_map
, Qnil
);
9704 specbind (Qoverriding_local_map
, Qnil
);
9709 /* Run the Lucid hook. */
9710 safe_run_hooks (Qactivate_menubar_hook
);
9712 /* If it has changed current-menubar from previous value,
9713 really recompute the menu-bar from the value. */
9714 if (! NILP (Vlucid_menu_bar_dirty_flag
))
9715 call0 (Qrecompute_lucid_menubar
);
9717 safe_run_hooks (Qmenu_bar_update_hook
);
9722 XSETFRAME (Vmenu_updating_frame
, f
);
9723 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
9725 /* Redisplay the menu bar in case we changed it. */
9726 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9727 || defined (HAVE_NS) || defined (USE_GTK)
9728 if (FRAME_WINDOW_P (f
))
9730 #if defined (HAVE_NS)
9731 /* All frames on Mac OS share the same menubar. So only
9732 the selected frame should be allowed to set it. */
9733 if (f
== SELECTED_FRAME ())
9735 set_frame_menubar (f
, 0, 0);
9738 /* On a terminal screen, the menu bar is an ordinary screen
9739 line, and this makes it get updated. */
9740 w
->update_mode_line
= Qt
;
9741 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9742 /* In the non-toolkit version, the menu bar is an ordinary screen
9743 line, and this makes it get updated. */
9744 w
->update_mode_line
= Qt
;
9745 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9747 unbind_to (count
, Qnil
);
9748 set_buffer_internal_1 (prev
);
9757 /***********************************************************************
9759 ***********************************************************************/
9761 #ifdef HAVE_WINDOW_SYSTEM
9764 Nominal cursor position -- where to draw output.
9765 HPOS and VPOS are window relative glyph matrix coordinates.
9766 X and Y are window relative pixel coordinates. */
9768 struct cursor_pos output_cursor
;
9772 Set the global variable output_cursor to CURSOR. All cursor
9773 positions are relative to updated_window. */
9776 set_output_cursor (cursor
)
9777 struct cursor_pos
*cursor
;
9779 output_cursor
.hpos
= cursor
->hpos
;
9780 output_cursor
.vpos
= cursor
->vpos
;
9781 output_cursor
.x
= cursor
->x
;
9782 output_cursor
.y
= cursor
->y
;
9787 Set a nominal cursor position.
9789 HPOS and VPOS are column/row positions in a window glyph matrix. X
9790 and Y are window text area relative pixel positions.
9792 If this is done during an update, updated_window will contain the
9793 window that is being updated and the position is the future output
9794 cursor position for that window. If updated_window is null, use
9795 selected_window and display the cursor at the given position. */
9798 x_cursor_to (vpos
, hpos
, y
, x
)
9799 int vpos
, hpos
, y
, x
;
9803 /* If updated_window is not set, work on selected_window. */
9807 w
= XWINDOW (selected_window
);
9809 /* Set the output cursor. */
9810 output_cursor
.hpos
= hpos
;
9811 output_cursor
.vpos
= vpos
;
9812 output_cursor
.x
= x
;
9813 output_cursor
.y
= y
;
9815 /* If not called as part of an update, really display the cursor.
9816 This will also set the cursor position of W. */
9817 if (updated_window
== NULL
)
9820 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
9821 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
9822 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
9827 #endif /* HAVE_WINDOW_SYSTEM */
9830 /***********************************************************************
9832 ***********************************************************************/
9834 #ifdef HAVE_WINDOW_SYSTEM
9836 /* Where the mouse was last time we reported a mouse event. */
9838 FRAME_PTR last_mouse_frame
;
9840 /* Tool-bar item index of the item on which a mouse button was pressed
9843 int last_tool_bar_item
;
9846 /* Update the tool-bar item list for frame F. This has to be done
9847 before we start to fill in any display lines. Called from
9848 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
9849 and restore it here. */
9852 update_tool_bar (f
, save_match_data
)
9854 int save_match_data
;
9856 #if defined (USE_GTK) || defined (HAVE_NS) || USE_MAC_TOOLBAR
9857 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
9859 int do_update
= WINDOWP (f
->tool_bar_window
)
9860 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
9868 window
= FRAME_SELECTED_WINDOW (f
);
9869 w
= XWINDOW (window
);
9871 /* If the user has switched buffers or windows, we need to
9872 recompute to reflect the new bindings. But we'll
9873 recompute when update_mode_lines is set too; that means
9874 that people can use force-mode-line-update to request
9875 that the menu bar be recomputed. The adverse effect on
9876 the rest of the redisplay algorithm is about the same as
9877 windows_or_buffers_changed anyway. */
9878 if (windows_or_buffers_changed
9879 || !NILP (w
->update_mode_line
)
9880 || update_mode_lines
9881 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9882 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9883 != !NILP (w
->last_had_star
))
9884 || ((!NILP (Vtransient_mark_mode
)
9885 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
9886 != !NILP (w
->region_showing
)))
9888 struct buffer
*prev
= current_buffer
;
9889 int count
= SPECPDL_INDEX ();
9890 Lisp_Object new_tool_bar
;
9892 struct gcpro gcpro1
;
9894 /* Set current_buffer to the buffer of the selected
9895 window of the frame, so that we get the right local
9897 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9899 /* Save match data, if we must. */
9900 if (save_match_data
)
9901 record_unwind_save_match_data ();
9903 /* Make sure that we don't accidentally use bogus keymaps. */
9904 if (NILP (Voverriding_local_map_menu_flag
))
9906 specbind (Qoverriding_terminal_local_map
, Qnil
);
9907 specbind (Qoverriding_local_map
, Qnil
);
9910 GCPRO1 (new_tool_bar
);
9912 /* Build desired tool-bar items from keymaps. */
9913 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
9916 /* Redisplay the tool-bar if we changed it. */
9917 if (new_n_tool_bar
!= f
->n_tool_bar_items
9918 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
9920 /* Redisplay that happens asynchronously due to an expose event
9921 may access f->tool_bar_items. Make sure we update both
9922 variables within BLOCK_INPUT so no such event interrupts. */
9924 f
->tool_bar_items
= new_tool_bar
;
9925 f
->n_tool_bar_items
= new_n_tool_bar
;
9926 w
->update_mode_line
= Qt
;
9932 unbind_to (count
, Qnil
);
9933 set_buffer_internal_1 (prev
);
9939 /* Set F->desired_tool_bar_string to a Lisp string representing frame
9940 F's desired tool-bar contents. F->tool_bar_items must have
9941 been set up previously by calling prepare_menu_bars. */
9944 build_desired_tool_bar_string (f
)
9947 int i
, size
, size_needed
;
9948 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9949 Lisp_Object image
, plist
, props
;
9951 image
= plist
= props
= Qnil
;
9952 GCPRO3 (image
, plist
, props
);
9954 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
9955 Otherwise, make a new string. */
9957 /* The size of the string we might be able to reuse. */
9958 size
= (STRINGP (f
->desired_tool_bar_string
)
9959 ? SCHARS (f
->desired_tool_bar_string
)
9962 /* We need one space in the string for each image. */
9963 size_needed
= f
->n_tool_bar_items
;
9965 /* Reuse f->desired_tool_bar_string, if possible. */
9966 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
9967 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
9971 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
9972 Fremove_text_properties (make_number (0), make_number (size
),
9973 props
, f
->desired_tool_bar_string
);
9976 /* Put a `display' property on the string for the images to display,
9977 put a `menu_item' property on tool-bar items with a value that
9978 is the index of the item in F's tool-bar item vector. */
9979 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
9981 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
9983 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
9984 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
9985 int hmargin
, vmargin
, relief
, idx
, end
;
9986 extern Lisp_Object QCrelief
, QCmargin
, QCconversion
;
9988 /* If image is a vector, choose the image according to the
9990 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
9991 if (VECTORP (image
))
9995 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
9996 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
9999 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
10000 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
10002 xassert (ASIZE (image
) >= idx
);
10003 image
= AREF (image
, idx
);
10008 /* Ignore invalid image specifications. */
10009 if (!valid_image_p (image
))
10012 /* Display the tool-bar button pressed, or depressed. */
10013 plist
= Fcopy_sequence (XCDR (image
));
10015 /* Compute margin and relief to draw. */
10016 relief
= (tool_bar_button_relief
>= 0
10017 ? tool_bar_button_relief
10018 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
10019 hmargin
= vmargin
= relief
;
10021 if (INTEGERP (Vtool_bar_button_margin
)
10022 && XINT (Vtool_bar_button_margin
) > 0)
10024 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
10025 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
10027 else if (CONSP (Vtool_bar_button_margin
))
10029 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
10030 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
10031 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
10033 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
10034 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
10035 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
10038 if (auto_raise_tool_bar_buttons_p
)
10040 /* Add a `:relief' property to the image spec if the item is
10044 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
10051 /* If image is selected, display it pressed, i.e. with a
10052 negative relief. If it's not selected, display it with a
10054 plist
= Fplist_put (plist
, QCrelief
,
10056 ? make_number (-relief
)
10057 : make_number (relief
)));
10062 /* Put a margin around the image. */
10063 if (hmargin
|| vmargin
)
10065 if (hmargin
== vmargin
)
10066 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
10068 plist
= Fplist_put (plist
, QCmargin
,
10069 Fcons (make_number (hmargin
),
10070 make_number (vmargin
)));
10073 /* If button is not enabled, and we don't have special images
10074 for the disabled state, make the image appear disabled by
10075 applying an appropriate algorithm to it. */
10076 if (!enabled_p
&& idx
< 0)
10077 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
10079 /* Put a `display' text property on the string for the image to
10080 display. Put a `menu-item' property on the string that gives
10081 the start of this item's properties in the tool-bar items
10083 image
= Fcons (Qimage
, plist
);
10084 props
= list4 (Qdisplay
, image
,
10085 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
10087 /* Let the last image hide all remaining spaces in the tool bar
10088 string. The string can be longer than needed when we reuse a
10089 previous string. */
10090 if (i
+ 1 == f
->n_tool_bar_items
)
10091 end
= SCHARS (f
->desired_tool_bar_string
);
10094 Fadd_text_properties (make_number (i
), make_number (end
),
10095 props
, f
->desired_tool_bar_string
);
10103 /* Display one line of the tool-bar of frame IT->f.
10105 HEIGHT specifies the desired height of the tool-bar line.
10106 If the actual height of the glyph row is less than HEIGHT, the
10107 row's height is increased to HEIGHT, and the icons are centered
10108 vertically in the new height.
10110 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
10111 count a final empty row in case the tool-bar width exactly matches
10116 display_tool_bar_line (it
, height
)
10120 struct glyph_row
*row
= it
->glyph_row
;
10121 int max_x
= it
->last_visible_x
;
10122 struct glyph
*last
;
10124 prepare_desired_row (row
);
10125 row
->y
= it
->current_y
;
10127 /* Note that this isn't made use of if the face hasn't a box,
10128 so there's no need to check the face here. */
10129 it
->start_of_box_run_p
= 1;
10131 while (it
->current_x
< max_x
)
10133 int x
, n_glyphs_before
, i
, nglyphs
;
10134 struct it it_before
;
10136 /* Get the next display element. */
10137 if (!get_next_display_element (it
))
10139 /* Don't count empty row if we are counting needed tool-bar lines. */
10140 if (height
< 0 && !it
->hpos
)
10145 /* Produce glyphs. */
10146 n_glyphs_before
= row
->used
[TEXT_AREA
];
10149 PRODUCE_GLYPHS (it
);
10151 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
10153 x
= it_before
.current_x
;
10154 while (i
< nglyphs
)
10156 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
10158 if (x
+ glyph
->pixel_width
> max_x
)
10160 /* Glyph doesn't fit on line. Backtrack. */
10161 row
->used
[TEXT_AREA
] = n_glyphs_before
;
10163 /* If this is the only glyph on this line, it will never fit on the
10164 toolbar, so skip it. But ensure there is at least one glyph,
10165 so we don't accidentally disable the tool-bar. */
10166 if (n_glyphs_before
== 0
10167 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
10173 x
+= glyph
->pixel_width
;
10177 /* Stop at line ends. */
10178 if (ITERATOR_AT_END_OF_LINE_P (it
))
10181 set_iterator_to_next (it
, 1);
10186 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
10188 /* Use default face for the border below the tool bar.
10190 FIXME: When auto-resize-tool-bars is grow-only, there is
10191 no additional border below the possibly empty tool-bar lines.
10192 So to make the extra empty lines look "normal", we have to
10193 use the tool-bar face for the border too. */
10194 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
10195 it
->face_id
= DEFAULT_FACE_ID
;
10197 extend_face_to_end_of_line (it
);
10198 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
10199 last
->right_box_line_p
= 1;
10200 if (last
== row
->glyphs
[TEXT_AREA
])
10201 last
->left_box_line_p
= 1;
10203 /* Make line the desired height and center it vertically. */
10204 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
10206 /* Don't add more than one line height. */
10207 height
%= FRAME_LINE_HEIGHT (it
->f
);
10208 it
->max_ascent
+= height
/ 2;
10209 it
->max_descent
+= (height
+ 1) / 2;
10212 compute_line_metrics (it
);
10214 /* If line is empty, make it occupy the rest of the tool-bar. */
10215 if (!row
->displays_text_p
)
10217 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
10218 row
->visible_height
= row
->height
;
10219 row
->ascent
= row
->phys_ascent
= 0;
10220 row
->extra_line_spacing
= 0;
10223 row
->full_width_p
= 1;
10224 row
->continued_p
= 0;
10225 row
->truncated_on_left_p
= 0;
10226 row
->truncated_on_right_p
= 0;
10228 it
->current_x
= it
->hpos
= 0;
10229 it
->current_y
+= row
->height
;
10235 /* Max tool-bar height. */
10237 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
10238 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
10240 /* Value is the number of screen lines needed to make all tool-bar
10241 items of frame F visible. The number of actual rows needed is
10242 returned in *N_ROWS if non-NULL. */
10245 tool_bar_lines_needed (f
, n_rows
)
10249 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10251 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
10252 the desired matrix, so use (unused) mode-line row as temporary row to
10253 avoid destroying the first tool-bar row. */
10254 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
10256 /* Initialize an iterator for iteration over
10257 F->desired_tool_bar_string in the tool-bar window of frame F. */
10258 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
10259 it
.first_visible_x
= 0;
10260 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10261 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10263 while (!ITERATOR_AT_END_P (&it
))
10265 clear_glyph_row (temp_row
);
10266 it
.glyph_row
= temp_row
;
10267 display_tool_bar_line (&it
, -1);
10269 clear_glyph_row (temp_row
);
10271 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
10273 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
10275 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
10279 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
10281 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
10290 frame
= selected_frame
;
10292 CHECK_FRAME (frame
);
10293 f
= XFRAME (frame
);
10295 if (WINDOWP (f
->tool_bar_window
)
10296 || (w
= XWINDOW (f
->tool_bar_window
),
10297 WINDOW_TOTAL_LINES (w
) > 0))
10299 update_tool_bar (f
, 1);
10300 if (f
->n_tool_bar_items
)
10302 build_desired_tool_bar_string (f
);
10303 nlines
= tool_bar_lines_needed (f
, NULL
);
10307 return make_number (nlines
);
10311 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
10312 height should be changed. */
10315 redisplay_tool_bar (f
)
10320 struct glyph_row
*row
;
10322 #if defined (USE_GTK) || defined (HAVE_NS) || USE_MAC_TOOLBAR
10323 if (FRAME_EXTERNAL_TOOL_BAR (f
))
10324 update_frame_tool_bar (f
);
10328 /* If frame hasn't a tool-bar window or if it is zero-height, don't
10329 do anything. This means you must start with tool-bar-lines
10330 non-zero to get the auto-sizing effect. Or in other words, you
10331 can turn off tool-bars by specifying tool-bar-lines zero. */
10332 if (!WINDOWP (f
->tool_bar_window
)
10333 || (w
= XWINDOW (f
->tool_bar_window
),
10334 WINDOW_TOTAL_LINES (w
) == 0))
10337 /* Set up an iterator for the tool-bar window. */
10338 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
10339 it
.first_visible_x
= 0;
10340 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10341 row
= it
.glyph_row
;
10343 /* Build a string that represents the contents of the tool-bar. */
10344 build_desired_tool_bar_string (f
);
10345 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10347 if (f
->n_tool_bar_rows
== 0)
10351 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
10352 nlines
!= WINDOW_TOTAL_LINES (w
)))
10354 extern Lisp_Object Qtool_bar_lines
;
10356 int old_height
= WINDOW_TOTAL_LINES (w
);
10358 XSETFRAME (frame
, f
);
10359 Fmodify_frame_parameters (frame
,
10360 Fcons (Fcons (Qtool_bar_lines
,
10361 make_number (nlines
)),
10363 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10365 clear_glyph_matrix (w
->desired_matrix
);
10366 fonts_changed_p
= 1;
10372 /* Display as many lines as needed to display all tool-bar items. */
10374 if (f
->n_tool_bar_rows
> 0)
10376 int border
, rows
, height
, extra
;
10378 if (INTEGERP (Vtool_bar_border
))
10379 border
= XINT (Vtool_bar_border
);
10380 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
10381 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
10382 else if (EQ (Vtool_bar_border
, Qborder_width
))
10383 border
= f
->border_width
;
10389 rows
= f
->n_tool_bar_rows
;
10390 height
= max (1, (it
.last_visible_y
- border
) / rows
);
10391 extra
= it
.last_visible_y
- border
- height
* rows
;
10393 while (it
.current_y
< it
.last_visible_y
)
10396 if (extra
> 0 && rows
-- > 0)
10398 h
= (extra
+ rows
- 1) / rows
;
10401 display_tool_bar_line (&it
, height
+ h
);
10406 while (it
.current_y
< it
.last_visible_y
)
10407 display_tool_bar_line (&it
, 0);
10410 /* It doesn't make much sense to try scrolling in the tool-bar
10411 window, so don't do it. */
10412 w
->desired_matrix
->no_scrolling_p
= 1;
10413 w
->must_be_updated_p
= 1;
10415 if (!NILP (Vauto_resize_tool_bars
))
10417 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
10418 int change_height_p
= 0;
10420 /* If we couldn't display everything, change the tool-bar's
10421 height if there is room for more. */
10422 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
10423 && it
.current_y
< max_tool_bar_height
)
10424 change_height_p
= 1;
10426 row
= it
.glyph_row
- 1;
10428 /* If there are blank lines at the end, except for a partially
10429 visible blank line at the end that is smaller than
10430 FRAME_LINE_HEIGHT, change the tool-bar's height. */
10431 if (!row
->displays_text_p
10432 && row
->height
>= FRAME_LINE_HEIGHT (f
))
10433 change_height_p
= 1;
10435 /* If row displays tool-bar items, but is partially visible,
10436 change the tool-bar's height. */
10437 if (row
->displays_text_p
10438 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
10439 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
10440 change_height_p
= 1;
10442 /* Resize windows as needed by changing the `tool-bar-lines'
10443 frame parameter. */
10444 if (change_height_p
)
10446 extern Lisp_Object Qtool_bar_lines
;
10448 int old_height
= WINDOW_TOTAL_LINES (w
);
10450 int nlines
= tool_bar_lines_needed (f
, &nrows
);
10452 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
10453 && !f
->minimize_tool_bar_window_p
)
10454 ? (nlines
> old_height
)
10455 : (nlines
!= old_height
));
10456 f
->minimize_tool_bar_window_p
= 0;
10458 if (change_height_p
)
10460 XSETFRAME (frame
, f
);
10461 Fmodify_frame_parameters (frame
,
10462 Fcons (Fcons (Qtool_bar_lines
,
10463 make_number (nlines
)),
10465 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10467 clear_glyph_matrix (w
->desired_matrix
);
10468 f
->n_tool_bar_rows
= nrows
;
10469 fonts_changed_p
= 1;
10476 f
->minimize_tool_bar_window_p
= 0;
10481 /* Get information about the tool-bar item which is displayed in GLYPH
10482 on frame F. Return in *PROP_IDX the index where tool-bar item
10483 properties start in F->tool_bar_items. Value is zero if
10484 GLYPH doesn't display a tool-bar item. */
10487 tool_bar_item_info (f
, glyph
, prop_idx
)
10489 struct glyph
*glyph
;
10496 /* This function can be called asynchronously, which means we must
10497 exclude any possibility that Fget_text_property signals an
10499 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
10500 charpos
= max (0, charpos
);
10502 /* Get the text property `menu-item' at pos. The value of that
10503 property is the start index of this item's properties in
10504 F->tool_bar_items. */
10505 prop
= Fget_text_property (make_number (charpos
),
10506 Qmenu_item
, f
->current_tool_bar_string
);
10507 if (INTEGERP (prop
))
10509 *prop_idx
= XINT (prop
);
10519 /* Get information about the tool-bar item at position X/Y on frame F.
10520 Return in *GLYPH a pointer to the glyph of the tool-bar item in
10521 the current matrix of the tool-bar window of F, or NULL if not
10522 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
10523 item in F->tool_bar_items. Value is
10525 -1 if X/Y is not on a tool-bar item
10526 0 if X/Y is on the same item that was highlighted before.
10530 get_tool_bar_item (f
, x
, y
, glyph
, hpos
, vpos
, prop_idx
)
10533 struct glyph
**glyph
;
10534 int *hpos
, *vpos
, *prop_idx
;
10536 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10537 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10540 /* Find the glyph under X/Y. */
10541 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
10542 if (*glyph
== NULL
)
10545 /* Get the start of this tool-bar item's properties in
10546 f->tool_bar_items. */
10547 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
10550 /* Is mouse on the highlighted item? */
10551 if (EQ (f
->tool_bar_window
, dpyinfo
->mouse_face_window
)
10552 && *vpos
>= dpyinfo
->mouse_face_beg_row
10553 && *vpos
<= dpyinfo
->mouse_face_end_row
10554 && (*vpos
> dpyinfo
->mouse_face_beg_row
10555 || *hpos
>= dpyinfo
->mouse_face_beg_col
)
10556 && (*vpos
< dpyinfo
->mouse_face_end_row
10557 || *hpos
< dpyinfo
->mouse_face_end_col
10558 || dpyinfo
->mouse_face_past_end
))
10566 Handle mouse button event on the tool-bar of frame F, at
10567 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
10568 0 for button release. MODIFIERS is event modifiers for button
10572 handle_tool_bar_click (f
, x
, y
, down_p
, modifiers
)
10575 unsigned int modifiers
;
10577 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10578 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10579 int hpos
, vpos
, prop_idx
;
10580 struct glyph
*glyph
;
10581 Lisp_Object enabled_p
;
10583 /* If not on the highlighted tool-bar item, return. */
10584 frame_to_window_pixel_xy (w
, &x
, &y
);
10585 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
10588 /* If item is disabled, do nothing. */
10589 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10590 if (NILP (enabled_p
))
10595 /* Show item in pressed state. */
10596 show_mouse_face (dpyinfo
, DRAW_IMAGE_SUNKEN
);
10597 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
10598 last_tool_bar_item
= prop_idx
;
10602 Lisp_Object key
, frame
;
10603 struct input_event event
;
10604 EVENT_INIT (event
);
10606 /* Show item in released state. */
10607 show_mouse_face (dpyinfo
, DRAW_IMAGE_RAISED
);
10608 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
10610 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
10612 XSETFRAME (frame
, f
);
10613 event
.kind
= TOOL_BAR_EVENT
;
10614 event
.frame_or_window
= frame
;
10616 kbd_buffer_store_event (&event
);
10618 event
.kind
= TOOL_BAR_EVENT
;
10619 event
.frame_or_window
= frame
;
10621 event
.modifiers
= modifiers
;
10622 kbd_buffer_store_event (&event
);
10623 last_tool_bar_item
= -1;
10628 /* Possibly highlight a tool-bar item on frame F when mouse moves to
10629 tool-bar window-relative coordinates X/Y. Called from
10630 note_mouse_highlight. */
10633 note_tool_bar_highlight (f
, x
, y
)
10637 Lisp_Object window
= f
->tool_bar_window
;
10638 struct window
*w
= XWINDOW (window
);
10639 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10641 struct glyph
*glyph
;
10642 struct glyph_row
*row
;
10644 Lisp_Object enabled_p
;
10646 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
10647 int mouse_down_p
, rc
;
10649 /* Function note_mouse_highlight is called with negative x(y
10650 values when mouse moves outside of the frame. */
10651 if (x
<= 0 || y
<= 0)
10653 clear_mouse_face (dpyinfo
);
10657 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
10660 /* Not on tool-bar item. */
10661 clear_mouse_face (dpyinfo
);
10665 /* On same tool-bar item as before. */
10666 goto set_help_echo
;
10668 clear_mouse_face (dpyinfo
);
10670 /* Mouse is down, but on different tool-bar item? */
10671 mouse_down_p
= (dpyinfo
->grabbed
10672 && f
== last_mouse_frame
10673 && FRAME_LIVE_P (f
));
10675 && last_tool_bar_item
!= prop_idx
)
10678 dpyinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
10679 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
10681 /* If tool-bar item is not enabled, don't highlight it. */
10682 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10683 if (!NILP (enabled_p
))
10685 /* Compute the x-position of the glyph. In front and past the
10686 image is a space. We include this in the highlighted area. */
10687 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
10688 for (i
= x
= 0; i
< hpos
; ++i
)
10689 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
10691 /* Record this as the current active region. */
10692 dpyinfo
->mouse_face_beg_col
= hpos
;
10693 dpyinfo
->mouse_face_beg_row
= vpos
;
10694 dpyinfo
->mouse_face_beg_x
= x
;
10695 dpyinfo
->mouse_face_beg_y
= row
->y
;
10696 dpyinfo
->mouse_face_past_end
= 0;
10698 dpyinfo
->mouse_face_end_col
= hpos
+ 1;
10699 dpyinfo
->mouse_face_end_row
= vpos
;
10700 dpyinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
10701 dpyinfo
->mouse_face_end_y
= row
->y
;
10702 dpyinfo
->mouse_face_window
= window
;
10703 dpyinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
10705 /* Display it as active. */
10706 show_mouse_face (dpyinfo
, draw
);
10707 dpyinfo
->mouse_face_image_state
= draw
;
10712 /* Set help_echo_string to a help string to display for this tool-bar item.
10713 XTread_socket does the rest. */
10714 help_echo_object
= help_echo_window
= Qnil
;
10715 help_echo_pos
= -1;
10716 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
10717 if (NILP (help_echo_string
))
10718 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
10721 #endif /* HAVE_WINDOW_SYSTEM */
10725 /************************************************************************
10726 Horizontal scrolling
10727 ************************************************************************/
10729 static int hscroll_window_tree
P_ ((Lisp_Object
));
10730 static int hscroll_windows
P_ ((Lisp_Object
));
10732 /* For all leaf windows in the window tree rooted at WINDOW, set their
10733 hscroll value so that PT is (i) visible in the window, and (ii) so
10734 that it is not within a certain margin at the window's left and
10735 right border. Value is non-zero if any window's hscroll has been
10739 hscroll_window_tree (window
)
10740 Lisp_Object window
;
10742 int hscrolled_p
= 0;
10743 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
10744 int hscroll_step_abs
= 0;
10745 double hscroll_step_rel
= 0;
10747 if (hscroll_relative_p
)
10749 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
10750 if (hscroll_step_rel
< 0)
10752 hscroll_relative_p
= 0;
10753 hscroll_step_abs
= 0;
10756 else if (INTEGERP (Vhscroll_step
))
10758 hscroll_step_abs
= XINT (Vhscroll_step
);
10759 if (hscroll_step_abs
< 0)
10760 hscroll_step_abs
= 0;
10763 hscroll_step_abs
= 0;
10765 while (WINDOWP (window
))
10767 struct window
*w
= XWINDOW (window
);
10769 if (WINDOWP (w
->hchild
))
10770 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
10771 else if (WINDOWP (w
->vchild
))
10772 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
10773 else if (w
->cursor
.vpos
>= 0)
10776 int text_area_width
;
10777 struct glyph_row
*current_cursor_row
10778 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
10779 struct glyph_row
*desired_cursor_row
10780 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
10781 struct glyph_row
*cursor_row
10782 = (desired_cursor_row
->enabled_p
10783 ? desired_cursor_row
10784 : current_cursor_row
);
10786 text_area_width
= window_box_width (w
, TEXT_AREA
);
10788 /* Scroll when cursor is inside this scroll margin. */
10789 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
10791 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
10792 && ((XFASTINT (w
->hscroll
)
10793 && w
->cursor
.x
<= h_margin
)
10794 || (cursor_row
->enabled_p
10795 && cursor_row
->truncated_on_right_p
10796 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
10800 struct buffer
*saved_current_buffer
;
10804 /* Find point in a display of infinite width. */
10805 saved_current_buffer
= current_buffer
;
10806 current_buffer
= XBUFFER (w
->buffer
);
10808 if (w
== XWINDOW (selected_window
))
10809 pt
= BUF_PT (current_buffer
);
10812 pt
= marker_position (w
->pointm
);
10813 pt
= max (BEGV
, pt
);
10817 /* Move iterator to pt starting at cursor_row->start in
10818 a line with infinite width. */
10819 init_to_row_start (&it
, w
, cursor_row
);
10820 it
.last_visible_x
= INFINITY
;
10821 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
10822 current_buffer
= saved_current_buffer
;
10824 /* Position cursor in window. */
10825 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
10826 hscroll
= max (0, (it
.current_x
10827 - (ITERATOR_AT_END_OF_LINE_P (&it
)
10828 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
10829 : (text_area_width
/ 2))))
10830 / FRAME_COLUMN_WIDTH (it
.f
);
10831 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
10833 if (hscroll_relative_p
)
10834 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
10837 wanted_x
= text_area_width
10838 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10841 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10845 if (hscroll_relative_p
)
10846 wanted_x
= text_area_width
* hscroll_step_rel
10849 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10852 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10854 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
10856 /* Don't call Fset_window_hscroll if value hasn't
10857 changed because it will prevent redisplay
10859 if (XFASTINT (w
->hscroll
) != hscroll
)
10861 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
10862 w
->hscroll
= make_number (hscroll
);
10871 /* Value is non-zero if hscroll of any leaf window has been changed. */
10872 return hscrolled_p
;
10876 /* Set hscroll so that cursor is visible and not inside horizontal
10877 scroll margins for all windows in the tree rooted at WINDOW. See
10878 also hscroll_window_tree above. Value is non-zero if any window's
10879 hscroll has been changed. If it has, desired matrices on the frame
10880 of WINDOW are cleared. */
10883 hscroll_windows (window
)
10884 Lisp_Object window
;
10886 int hscrolled_p
= hscroll_window_tree (window
);
10888 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
10889 return hscrolled_p
;
10894 /************************************************************************
10896 ************************************************************************/
10898 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
10899 to a non-zero value. This is sometimes handy to have in a debugger
10904 /* First and last unchanged row for try_window_id. */
10906 int debug_first_unchanged_at_end_vpos
;
10907 int debug_last_unchanged_at_beg_vpos
;
10909 /* Delta vpos and y. */
10911 int debug_dvpos
, debug_dy
;
10913 /* Delta in characters and bytes for try_window_id. */
10915 int debug_delta
, debug_delta_bytes
;
10917 /* Values of window_end_pos and window_end_vpos at the end of
10920 EMACS_INT debug_end_pos
, debug_end_vpos
;
10922 /* Append a string to W->desired_matrix->method. FMT is a printf
10923 format string. A1...A9 are a supplement for a variable-length
10924 argument list. If trace_redisplay_p is non-zero also printf the
10925 resulting string to stderr. */
10928 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
10931 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
10934 char *method
= w
->desired_matrix
->method
;
10935 int len
= strlen (method
);
10936 int size
= sizeof w
->desired_matrix
->method
;
10937 int remaining
= size
- len
- 1;
10939 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
10940 if (len
&& remaining
)
10943 --remaining
, ++len
;
10946 strncpy (method
+ len
, buffer
, remaining
);
10948 if (trace_redisplay_p
)
10949 fprintf (stderr
, "%p (%s): %s\n",
10951 ((BUFFERP (w
->buffer
)
10952 && STRINGP (XBUFFER (w
->buffer
)->name
))
10953 ? (char *) SDATA (XBUFFER (w
->buffer
)->name
)
10958 #endif /* GLYPH_DEBUG */
10961 /* Value is non-zero if all changes in window W, which displays
10962 current_buffer, are in the text between START and END. START is a
10963 buffer position, END is given as a distance from Z. Used in
10964 redisplay_internal for display optimization. */
10967 text_outside_line_unchanged_p (w
, start
, end
)
10971 int unchanged_p
= 1;
10973 /* If text or overlays have changed, see where. */
10974 if (XFASTINT (w
->last_modified
) < MODIFF
10975 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
10977 /* Gap in the line? */
10978 if (GPT
< start
|| Z
- GPT
< end
)
10981 /* Changes start in front of the line, or end after it? */
10983 && (BEG_UNCHANGED
< start
- 1
10984 || END_UNCHANGED
< end
))
10987 /* If selective display, can't optimize if changes start at the
10988 beginning of the line. */
10990 && INTEGERP (current_buffer
->selective_display
)
10991 && XINT (current_buffer
->selective_display
) > 0
10992 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
10995 /* If there are overlays at the start or end of the line, these
10996 may have overlay strings with newlines in them. A change at
10997 START, for instance, may actually concern the display of such
10998 overlay strings as well, and they are displayed on different
10999 lines. So, quickly rule out this case. (For the future, it
11000 might be desirable to implement something more telling than
11001 just BEG/END_UNCHANGED.) */
11004 if (BEG
+ BEG_UNCHANGED
== start
11005 && overlay_touches_p (start
))
11007 if (END_UNCHANGED
== end
11008 && overlay_touches_p (Z
- end
))
11013 return unchanged_p
;
11017 /* Do a frame update, taking possible shortcuts into account. This is
11018 the main external entry point for redisplay.
11020 If the last redisplay displayed an echo area message and that message
11021 is no longer requested, we clear the echo area or bring back the
11022 mini-buffer if that is in use. */
11027 redisplay_internal (0);
11032 overlay_arrow_string_or_property (var
)
11037 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
11040 return Voverlay_arrow_string
;
11043 /* Return 1 if there are any overlay-arrows in current_buffer. */
11045 overlay_arrow_in_current_buffer_p ()
11049 for (vlist
= Voverlay_arrow_variable_list
;
11051 vlist
= XCDR (vlist
))
11053 Lisp_Object var
= XCAR (vlist
);
11056 if (!SYMBOLP (var
))
11058 val
= find_symbol_value (var
);
11060 && current_buffer
== XMARKER (val
)->buffer
)
11067 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
11071 overlay_arrows_changed_p ()
11075 for (vlist
= Voverlay_arrow_variable_list
;
11077 vlist
= XCDR (vlist
))
11079 Lisp_Object var
= XCAR (vlist
);
11080 Lisp_Object val
, pstr
;
11082 if (!SYMBOLP (var
))
11084 val
= find_symbol_value (var
);
11085 if (!MARKERP (val
))
11087 if (! EQ (COERCE_MARKER (val
),
11088 Fget (var
, Qlast_arrow_position
))
11089 || ! (pstr
= overlay_arrow_string_or_property (var
),
11090 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
11096 /* Mark overlay arrows to be updated on next redisplay. */
11099 update_overlay_arrows (up_to_date
)
11104 for (vlist
= Voverlay_arrow_variable_list
;
11106 vlist
= XCDR (vlist
))
11108 Lisp_Object var
= XCAR (vlist
);
11110 if (!SYMBOLP (var
))
11113 if (up_to_date
> 0)
11115 Lisp_Object val
= find_symbol_value (var
);
11116 Fput (var
, Qlast_arrow_position
,
11117 COERCE_MARKER (val
));
11118 Fput (var
, Qlast_arrow_string
,
11119 overlay_arrow_string_or_property (var
));
11121 else if (up_to_date
< 0
11122 || !NILP (Fget (var
, Qlast_arrow_position
)))
11124 Fput (var
, Qlast_arrow_position
, Qt
);
11125 Fput (var
, Qlast_arrow_string
, Qt
);
11131 /* Return overlay arrow string to display at row.
11132 Return integer (bitmap number) for arrow bitmap in left fringe.
11133 Return nil if no overlay arrow. */
11136 overlay_arrow_at_row (it
, row
)
11138 struct glyph_row
*row
;
11142 for (vlist
= Voverlay_arrow_variable_list
;
11144 vlist
= XCDR (vlist
))
11146 Lisp_Object var
= XCAR (vlist
);
11149 if (!SYMBOLP (var
))
11152 val
= find_symbol_value (var
);
11155 && current_buffer
== XMARKER (val
)->buffer
11156 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
11158 if (FRAME_WINDOW_P (it
->f
)
11159 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
11161 #ifdef HAVE_WINDOW_SYSTEM
11162 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
11165 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
11166 return make_number (fringe_bitmap
);
11169 return make_number (-1); /* Use default arrow bitmap */
11171 return overlay_arrow_string_or_property (var
);
11178 /* Return 1 if point moved out of or into a composition. Otherwise
11179 return 0. PREV_BUF and PREV_PT are the last point buffer and
11180 position. BUF and PT are the current point buffer and position. */
11183 check_point_in_composition (prev_buf
, prev_pt
, buf
, pt
)
11184 struct buffer
*prev_buf
, *buf
;
11187 EMACS_INT start
, end
;
11189 Lisp_Object buffer
;
11191 XSETBUFFER (buffer
, buf
);
11192 /* Check a composition at the last point if point moved within the
11194 if (prev_buf
== buf
)
11197 /* Point didn't move. */
11200 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
11201 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
11202 && COMPOSITION_VALID_P (start
, end
, prop
)
11203 && start
< prev_pt
&& end
> prev_pt
)
11204 /* The last point was within the composition. Return 1 iff
11205 point moved out of the composition. */
11206 return (pt
<= start
|| pt
>= end
);
11209 /* Check a composition at the current point. */
11210 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
11211 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
11212 && COMPOSITION_VALID_P (start
, end
, prop
)
11213 && start
< pt
&& end
> pt
);
11217 /* Reconsider the setting of B->clip_changed which is displayed
11221 reconsider_clip_changes (w
, b
)
11225 if (b
->clip_changed
11226 && !NILP (w
->window_end_valid
)
11227 && w
->current_matrix
->buffer
== b
11228 && w
->current_matrix
->zv
== BUF_ZV (b
)
11229 && w
->current_matrix
->begv
== BUF_BEGV (b
))
11230 b
->clip_changed
= 0;
11232 /* If display wasn't paused, and W is not a tool bar window, see if
11233 point has been moved into or out of a composition. In that case,
11234 we set b->clip_changed to 1 to force updating the screen. If
11235 b->clip_changed has already been set to 1, we can skip this
11237 if (!b
->clip_changed
11238 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
11242 if (w
== XWINDOW (selected_window
))
11243 pt
= BUF_PT (current_buffer
);
11245 pt
= marker_position (w
->pointm
);
11247 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
11248 || pt
!= XINT (w
->last_point
))
11249 && check_point_in_composition (w
->current_matrix
->buffer
,
11250 XINT (w
->last_point
),
11251 XBUFFER (w
->buffer
), pt
))
11252 b
->clip_changed
= 1;
11257 /* Select FRAME to forward the values of frame-local variables into C
11258 variables so that the redisplay routines can access those values
11262 select_frame_for_redisplay (frame
)
11265 Lisp_Object tail
, symbol
, val
;
11266 Lisp_Object old
= selected_frame
;
11267 struct Lisp_Symbol
*sym
;
11269 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
11271 selected_frame
= frame
;
11275 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
11276 if (CONSP (XCAR (tail
))
11277 && (symbol
= XCAR (XCAR (tail
)),
11279 && (sym
= indirect_variable (XSYMBOL (symbol
)),
11281 (BUFFER_LOCAL_VALUEP (val
)))
11282 && XBUFFER_LOCAL_VALUE (val
)->check_frame
)
11283 /* Use find_symbol_value rather than Fsymbol_value
11284 to avoid an error if it is void. */
11285 find_symbol_value (symbol
);
11286 } while (!EQ (frame
, old
) && (frame
= old
, 1));
11290 #define STOP_POLLING \
11291 do { if (! polling_stopped_here) stop_polling (); \
11292 polling_stopped_here = 1; } while (0)
11294 #define RESUME_POLLING \
11295 do { if (polling_stopped_here) start_polling (); \
11296 polling_stopped_here = 0; } while (0)
11299 /* If PRESERVE_ECHO_AREA is nonzero, it means this redisplay is not in
11300 response to any user action; therefore, we should preserve the echo
11301 area. (Actually, our caller does that job.) Perhaps in the future
11302 avoid recentering windows if it is not necessary; currently that
11303 causes some problems. */
11306 redisplay_internal (preserve_echo_area
)
11307 int preserve_echo_area
;
11309 struct window
*w
= XWINDOW (selected_window
);
11312 int must_finish
= 0;
11313 struct text_pos tlbufpos
, tlendpos
;
11314 int number_of_visible_frames
;
11317 int polling_stopped_here
= 0;
11318 Lisp_Object old_frame
= selected_frame
;
11320 /* Non-zero means redisplay has to consider all windows on all
11321 frames. Zero means, only selected_window is considered. */
11322 int consider_all_windows_p
;
11324 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
11326 /* No redisplay if running in batch mode or frame is not yet fully
11327 initialized, or redisplay is explicitly turned off by setting
11328 Vinhibit_redisplay. */
11330 || !NILP (Vinhibit_redisplay
))
11333 /* Don't examine these until after testing Vinhibit_redisplay.
11334 When Emacs is shutting down, perhaps because its connection to
11335 X has dropped, we should not look at them at all. */
11336 f
= XFRAME (w
->frame
);
11337 sf
= SELECTED_FRAME ();
11339 if (!f
->glyphs_initialized_p
)
11342 /* The flag redisplay_performed_directly_p is set by
11343 direct_output_for_insert when it already did the whole screen
11344 update necessary. */
11345 if (redisplay_performed_directly_p
)
11347 redisplay_performed_directly_p
= 0;
11348 if (!hscroll_windows (selected_window
))
11352 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
11353 if (popup_activated ())
11357 /* I don't think this happens but let's be paranoid. */
11358 if (redisplaying_p
)
11361 /* Record a function that resets redisplaying_p to its old value
11362 when we leave this function. */
11363 count
= SPECPDL_INDEX ();
11364 record_unwind_protect (unwind_redisplay
,
11365 Fcons (make_number (redisplaying_p
), selected_frame
));
11367 specbind (Qinhibit_free_realized_faces
, Qnil
);
11370 Lisp_Object tail
, frame
;
11372 FOR_EACH_FRAME (tail
, frame
)
11374 struct frame
*f
= XFRAME (frame
);
11375 f
->already_hscrolled_p
= 0;
11380 if (!EQ (old_frame
, selected_frame
)
11381 && FRAME_LIVE_P (XFRAME (old_frame
)))
11382 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
11383 selected_frame and selected_window to be temporarily out-of-sync so
11384 when we come back here via `goto retry', we need to resync because we
11385 may need to run Elisp code (via prepare_menu_bars). */
11386 select_frame_for_redisplay (old_frame
);
11389 reconsider_clip_changes (w
, current_buffer
);
11390 last_escape_glyph_frame
= NULL
;
11391 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
11393 /* If new fonts have been loaded that make a glyph matrix adjustment
11394 necessary, do it. */
11395 if (fonts_changed_p
)
11397 adjust_glyphs (NULL
);
11398 ++windows_or_buffers_changed
;
11399 fonts_changed_p
= 0;
11402 /* If face_change_count is non-zero, init_iterator will free all
11403 realized faces, which includes the faces referenced from current
11404 matrices. So, we can't reuse current matrices in this case. */
11405 if (face_change_count
)
11406 ++windows_or_buffers_changed
;
11408 if (FRAME_TERMCAP_P (sf
)
11409 && FRAME_TTY (sf
)->previous_frame
!= sf
)
11411 /* Since frames on a single ASCII terminal share the same
11412 display area, displaying a different frame means redisplay
11413 the whole thing. */
11414 windows_or_buffers_changed
++;
11415 SET_FRAME_GARBAGED (sf
);
11417 set_tty_color_mode (FRAME_TTY (sf
), sf
);
11419 FRAME_TTY (sf
)->previous_frame
= sf
;
11422 /* Set the visible flags for all frames. Do this before checking
11423 for resized or garbaged frames; they want to know if their frames
11424 are visible. See the comment in frame.h for
11425 FRAME_SAMPLE_VISIBILITY. */
11427 Lisp_Object tail
, frame
;
11429 number_of_visible_frames
= 0;
11431 FOR_EACH_FRAME (tail
, frame
)
11433 struct frame
*f
= XFRAME (frame
);
11435 FRAME_SAMPLE_VISIBILITY (f
);
11436 if (FRAME_VISIBLE_P (f
))
11437 ++number_of_visible_frames
;
11438 clear_desired_matrices (f
);
11443 /* Notice any pending interrupt request to change frame size. */
11444 do_pending_window_change (1);
11446 /* Clear frames marked as garbaged. */
11447 if (frame_garbaged
)
11448 clear_garbaged_frames ();
11450 /* Build menubar and tool-bar items. */
11451 if (NILP (Vmemory_full
))
11452 prepare_menu_bars ();
11454 if (windows_or_buffers_changed
)
11455 update_mode_lines
++;
11457 /* Detect case that we need to write or remove a star in the mode line. */
11458 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
11460 w
->update_mode_line
= Qt
;
11461 if (buffer_shared
> 1)
11462 update_mode_lines
++;
11465 /* Avoid invocation of point motion hooks by `current_column' below. */
11466 count1
= SPECPDL_INDEX ();
11467 specbind (Qinhibit_point_motion_hooks
, Qt
);
11469 /* If %c is in the mode line, update it if needed. */
11470 if (!NILP (w
->column_number_displayed
)
11471 /* This alternative quickly identifies a common case
11472 where no change is needed. */
11473 && !(PT
== XFASTINT (w
->last_point
)
11474 && XFASTINT (w
->last_modified
) >= MODIFF
11475 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
11476 && (XFASTINT (w
->column_number_displayed
)
11477 != (int) current_column ())) /* iftc */
11478 w
->update_mode_line
= Qt
;
11480 unbind_to (count1
, Qnil
);
11482 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
11484 /* The variable buffer_shared is set in redisplay_window and
11485 indicates that we redisplay a buffer in different windows. See
11487 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
11488 || cursor_type_changed
);
11490 /* If specs for an arrow have changed, do thorough redisplay
11491 to ensure we remove any arrow that should no longer exist. */
11492 if (overlay_arrows_changed_p ())
11493 consider_all_windows_p
= windows_or_buffers_changed
= 1;
11495 /* Normally the message* functions will have already displayed and
11496 updated the echo area, but the frame may have been trashed, or
11497 the update may have been preempted, so display the echo area
11498 again here. Checking message_cleared_p captures the case that
11499 the echo area should be cleared. */
11500 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
11501 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
11502 || (message_cleared_p
11503 && minibuf_level
== 0
11504 /* If the mini-window is currently selected, this means the
11505 echo-area doesn't show through. */
11506 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
11508 int window_height_changed_p
= echo_area_display (0);
11511 /* If we don't display the current message, don't clear the
11512 message_cleared_p flag, because, if we did, we wouldn't clear
11513 the echo area in the next redisplay which doesn't preserve
11515 if (!display_last_displayed_message_p
)
11516 message_cleared_p
= 0;
11518 if (fonts_changed_p
)
11520 else if (window_height_changed_p
)
11522 consider_all_windows_p
= 1;
11523 ++update_mode_lines
;
11524 ++windows_or_buffers_changed
;
11526 /* If window configuration was changed, frames may have been
11527 marked garbaged. Clear them or we will experience
11528 surprises wrt scrolling. */
11529 if (frame_garbaged
)
11530 clear_garbaged_frames ();
11533 else if (EQ (selected_window
, minibuf_window
)
11534 && (current_buffer
->clip_changed
11535 || XFASTINT (w
->last_modified
) < MODIFF
11536 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11537 && resize_mini_window (w
, 0))
11539 /* Resized active mini-window to fit the size of what it is
11540 showing if its contents might have changed. */
11542 /* FIXME: this causes all frames to be updated, which seems unnecessary
11543 since only the current frame needs to be considered. This function needs
11544 to be rewritten with two variables, consider_all_windows and
11545 consider_all_frames. */
11546 consider_all_windows_p
= 1;
11547 ++windows_or_buffers_changed
;
11548 ++update_mode_lines
;
11550 /* If window configuration was changed, frames may have been
11551 marked garbaged. Clear them or we will experience
11552 surprises wrt scrolling. */
11553 if (frame_garbaged
)
11554 clear_garbaged_frames ();
11558 /* If showing the region, and mark has changed, we must redisplay
11559 the whole window. The assignment to this_line_start_pos prevents
11560 the optimization directly below this if-statement. */
11561 if (((!NILP (Vtransient_mark_mode
)
11562 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
11563 != !NILP (w
->region_showing
))
11564 || (!NILP (w
->region_showing
)
11565 && !EQ (w
->region_showing
,
11566 Fmarker_position (XBUFFER (w
->buffer
)->mark
))))
11567 CHARPOS (this_line_start_pos
) = 0;
11569 /* Optimize the case that only the line containing the cursor in the
11570 selected window has changed. Variables starting with this_ are
11571 set in display_line and record information about the line
11572 containing the cursor. */
11573 tlbufpos
= this_line_start_pos
;
11574 tlendpos
= this_line_end_pos
;
11575 if (!consider_all_windows_p
11576 && CHARPOS (tlbufpos
) > 0
11577 && NILP (w
->update_mode_line
)
11578 && !current_buffer
->clip_changed
11579 && !current_buffer
->prevent_redisplay_optimizations_p
11580 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
11581 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
11582 /* Make sure recorded data applies to current buffer, etc. */
11583 && this_line_buffer
== current_buffer
11584 && current_buffer
== XBUFFER (w
->buffer
)
11585 && NILP (w
->force_start
)
11586 && NILP (w
->optional_new_start
)
11587 /* Point must be on the line that we have info recorded about. */
11588 && PT
>= CHARPOS (tlbufpos
)
11589 && PT
<= Z
- CHARPOS (tlendpos
)
11590 /* All text outside that line, including its final newline,
11591 must be unchanged */
11592 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
11593 CHARPOS (tlendpos
)))
11595 if (CHARPOS (tlbufpos
) > BEGV
11596 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
11597 && (CHARPOS (tlbufpos
) == ZV
11598 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
11599 /* Former continuation line has disappeared by becoming empty */
11601 else if (XFASTINT (w
->last_modified
) < MODIFF
11602 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
11603 || MINI_WINDOW_P (w
))
11605 /* We have to handle the case of continuation around a
11606 wide-column character (See the comment in indent.c around
11609 For instance, in the following case:
11611 -------- Insert --------
11612 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
11613 J_I_ ==> J_I_ `^^' are cursors.
11617 As we have to redraw the line above, we should goto cancel. */
11620 int line_height_before
= this_line_pixel_height
;
11622 /* Note that start_display will handle the case that the
11623 line starting at tlbufpos is a continuation lines. */
11624 start_display (&it
, w
, tlbufpos
);
11626 /* Implementation note: It this still necessary? */
11627 if (it
.current_x
!= this_line_start_x
)
11630 TRACE ((stderr
, "trying display optimization 1\n"));
11631 w
->cursor
.vpos
= -1;
11632 overlay_arrow_seen
= 0;
11633 it
.vpos
= this_line_vpos
;
11634 it
.current_y
= this_line_y
;
11635 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
11636 display_line (&it
);
11638 /* If line contains point, is not continued,
11639 and ends at same distance from eob as before, we win */
11640 if (w
->cursor
.vpos
>= 0
11641 /* Line is not continued, otherwise this_line_start_pos
11642 would have been set to 0 in display_line. */
11643 && CHARPOS (this_line_start_pos
)
11644 /* Line ends as before. */
11645 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
11646 /* Line has same height as before. Otherwise other lines
11647 would have to be shifted up or down. */
11648 && this_line_pixel_height
== line_height_before
)
11650 /* If this is not the window's last line, we must adjust
11651 the charstarts of the lines below. */
11652 if (it
.current_y
< it
.last_visible_y
)
11654 struct glyph_row
*row
11655 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
11656 int delta
, delta_bytes
;
11658 if (Z
- CHARPOS (tlendpos
) == ZV
)
11660 /* This line ends at end of (accessible part of)
11661 buffer. There is no newline to count. */
11663 - CHARPOS (tlendpos
)
11664 - MATRIX_ROW_START_CHARPOS (row
));
11665 delta_bytes
= (Z_BYTE
11666 - BYTEPOS (tlendpos
)
11667 - MATRIX_ROW_START_BYTEPOS (row
));
11671 /* This line ends in a newline. Must take
11672 account of the newline and the rest of the
11673 text that follows. */
11675 - CHARPOS (tlendpos
)
11676 - MATRIX_ROW_START_CHARPOS (row
));
11677 delta_bytes
= (Z_BYTE
11678 - BYTEPOS (tlendpos
)
11679 - MATRIX_ROW_START_BYTEPOS (row
));
11682 increment_matrix_positions (w
->current_matrix
,
11683 this_line_vpos
+ 1,
11684 w
->current_matrix
->nrows
,
11685 delta
, delta_bytes
);
11688 /* If this row displays text now but previously didn't,
11689 or vice versa, w->window_end_vpos may have to be
11691 if ((it
.glyph_row
- 1)->displays_text_p
)
11693 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
11694 XSETINT (w
->window_end_vpos
, this_line_vpos
);
11696 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
11697 && this_line_vpos
> 0)
11698 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
11699 w
->window_end_valid
= Qnil
;
11701 /* Update hint: No need to try to scroll in update_window. */
11702 w
->desired_matrix
->no_scrolling_p
= 1;
11705 *w
->desired_matrix
->method
= 0;
11706 debug_method_add (w
, "optimization 1");
11708 #ifdef HAVE_WINDOW_SYSTEM
11709 update_window_fringes (w
, 0);
11716 else if (/* Cursor position hasn't changed. */
11717 PT
== XFASTINT (w
->last_point
)
11718 /* Make sure the cursor was last displayed
11719 in this window. Otherwise we have to reposition it. */
11720 && 0 <= w
->cursor
.vpos
11721 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
11725 do_pending_window_change (1);
11727 /* We used to always goto end_of_redisplay here, but this
11728 isn't enough if we have a blinking cursor. */
11729 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
11730 goto end_of_redisplay
;
11734 /* If highlighting the region, or if the cursor is in the echo area,
11735 then we can't just move the cursor. */
11736 else if (! (!NILP (Vtransient_mark_mode
)
11737 && !NILP (current_buffer
->mark_active
))
11738 && (EQ (selected_window
, current_buffer
->last_selected_window
)
11739 || highlight_nonselected_windows
)
11740 && NILP (w
->region_showing
)
11741 && NILP (Vshow_trailing_whitespace
)
11742 && !cursor_in_echo_area
)
11745 struct glyph_row
*row
;
11747 /* Skip from tlbufpos to PT and see where it is. Note that
11748 PT may be in invisible text. If so, we will end at the
11749 next visible position. */
11750 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
11751 NULL
, DEFAULT_FACE_ID
);
11752 it
.current_x
= this_line_start_x
;
11753 it
.current_y
= this_line_y
;
11754 it
.vpos
= this_line_vpos
;
11756 /* The call to move_it_to stops in front of PT, but
11757 moves over before-strings. */
11758 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
11760 if (it
.vpos
== this_line_vpos
11761 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
11764 xassert (this_line_vpos
== it
.vpos
);
11765 xassert (this_line_y
== it
.current_y
);
11766 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
11768 *w
->desired_matrix
->method
= 0;
11769 debug_method_add (w
, "optimization 3");
11778 /* Text changed drastically or point moved off of line. */
11779 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
11782 CHARPOS (this_line_start_pos
) = 0;
11783 consider_all_windows_p
|= buffer_shared
> 1;
11784 ++clear_face_cache_count
;
11785 #ifdef HAVE_WINDOW_SYSTEM
11786 ++clear_image_cache_count
;
11789 /* Build desired matrices, and update the display. If
11790 consider_all_windows_p is non-zero, do it for all windows on all
11791 frames. Otherwise do it for selected_window, only. */
11793 if (consider_all_windows_p
)
11795 Lisp_Object tail
, frame
;
11797 FOR_EACH_FRAME (tail
, frame
)
11798 XFRAME (frame
)->updated_p
= 0;
11800 /* Recompute # windows showing selected buffer. This will be
11801 incremented each time such a window is displayed. */
11804 FOR_EACH_FRAME (tail
, frame
)
11806 struct frame
*f
= XFRAME (frame
);
11808 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
11810 if (! EQ (frame
, selected_frame
))
11811 /* Select the frame, for the sake of frame-local
11813 select_frame_for_redisplay (frame
);
11815 /* Mark all the scroll bars to be removed; we'll redeem
11816 the ones we want when we redisplay their windows. */
11817 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
11818 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
11820 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11821 redisplay_windows (FRAME_ROOT_WINDOW (f
));
11823 /* Any scroll bars which redisplay_windows should have
11824 nuked should now go away. */
11825 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
11826 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
11828 /* If fonts changed, display again. */
11829 /* ??? rms: I suspect it is a mistake to jump all the way
11830 back to retry here. It should just retry this frame. */
11831 if (fonts_changed_p
)
11834 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11836 /* See if we have to hscroll. */
11837 if (!f
->already_hscrolled_p
)
11839 f
->already_hscrolled_p
= 1;
11840 if (hscroll_windows (f
->root_window
))
11844 /* Prevent various kinds of signals during display
11845 update. stdio is not robust about handling
11846 signals, which can cause an apparent I/O
11848 if (interrupt_input
)
11849 unrequest_sigio ();
11852 /* Update the display. */
11853 set_window_update_flags (XWINDOW (f
->root_window
), 1);
11854 pause
|= update_frame (f
, 0, 0);
11855 #if 0 /* Exiting the loop can leave the wrong value for buffer_shared. */
11865 if (!EQ (old_frame
, selected_frame
)
11866 && FRAME_LIVE_P (XFRAME (old_frame
)))
11867 /* We played a bit fast-and-loose above and allowed selected_frame
11868 and selected_window to be temporarily out-of-sync but let's make
11869 sure this stays contained. */
11870 select_frame_for_redisplay (old_frame
);
11871 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
11875 /* Do the mark_window_display_accurate after all windows have
11876 been redisplayed because this call resets flags in buffers
11877 which are needed for proper redisplay. */
11878 FOR_EACH_FRAME (tail
, frame
)
11880 struct frame
*f
= XFRAME (frame
);
11883 mark_window_display_accurate (f
->root_window
, 1);
11884 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
11885 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
11890 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
11892 Lisp_Object mini_window
;
11893 struct frame
*mini_frame
;
11895 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
11896 /* Use list_of_error, not Qerror, so that
11897 we catch only errors and don't run the debugger. */
11898 internal_condition_case_1 (redisplay_window_1
, selected_window
,
11900 redisplay_window_error
);
11902 /* Compare desired and current matrices, perform output. */
11905 /* If fonts changed, display again. */
11906 if (fonts_changed_p
)
11909 /* Prevent various kinds of signals during display update.
11910 stdio is not robust about handling signals,
11911 which can cause an apparent I/O error. */
11912 if (interrupt_input
)
11913 unrequest_sigio ();
11916 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
11918 if (hscroll_windows (selected_window
))
11921 XWINDOW (selected_window
)->must_be_updated_p
= 1;
11922 pause
= update_frame (sf
, 0, 0);
11925 /* We may have called echo_area_display at the top of this
11926 function. If the echo area is on another frame, that may
11927 have put text on a frame other than the selected one, so the
11928 above call to update_frame would not have caught it. Catch
11930 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
11931 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
11933 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
11935 XWINDOW (mini_window
)->must_be_updated_p
= 1;
11936 pause
|= update_frame (mini_frame
, 0, 0);
11937 if (!pause
&& hscroll_windows (mini_window
))
11942 /* If display was paused because of pending input, make sure we do a
11943 thorough update the next time. */
11946 /* Prevent the optimization at the beginning of
11947 redisplay_internal that tries a single-line update of the
11948 line containing the cursor in the selected window. */
11949 CHARPOS (this_line_start_pos
) = 0;
11951 /* Let the overlay arrow be updated the next time. */
11952 update_overlay_arrows (0);
11954 /* If we pause after scrolling, some rows in the current
11955 matrices of some windows are not valid. */
11956 if (!WINDOW_FULL_WIDTH_P (w
)
11957 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
11958 update_mode_lines
= 1;
11962 if (!consider_all_windows_p
)
11964 /* This has already been done above if
11965 consider_all_windows_p is set. */
11966 mark_window_display_accurate_1 (w
, 1);
11968 /* Say overlay arrows are up to date. */
11969 update_overlay_arrows (1);
11971 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
11972 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
11975 update_mode_lines
= 0;
11976 windows_or_buffers_changed
= 0;
11977 cursor_type_changed
= 0;
11980 /* Start SIGIO interrupts coming again. Having them off during the
11981 code above makes it less likely one will discard output, but not
11982 impossible, since there might be stuff in the system buffer here.
11983 But it is much hairier to try to do anything about that. */
11984 if (interrupt_input
)
11988 /* If a frame has become visible which was not before, redisplay
11989 again, so that we display it. Expose events for such a frame
11990 (which it gets when becoming visible) don't call the parts of
11991 redisplay constructing glyphs, so simply exposing a frame won't
11992 display anything in this case. So, we have to display these
11993 frames here explicitly. */
11996 Lisp_Object tail
, frame
;
11999 FOR_EACH_FRAME (tail
, frame
)
12001 int this_is_visible
= 0;
12003 if (XFRAME (frame
)->visible
)
12004 this_is_visible
= 1;
12005 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
12006 if (XFRAME (frame
)->visible
)
12007 this_is_visible
= 1;
12009 if (this_is_visible
)
12013 if (new_count
!= number_of_visible_frames
)
12014 windows_or_buffers_changed
++;
12017 /* Change frame size now if a change is pending. */
12018 do_pending_window_change (1);
12020 /* If we just did a pending size change, or have additional
12021 visible frames, redisplay again. */
12022 if (windows_or_buffers_changed
&& !pause
)
12025 /* Clear the face cache eventually. */
12026 if (consider_all_windows_p
)
12028 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
12030 clear_face_cache (0);
12031 clear_face_cache_count
= 0;
12033 #ifdef HAVE_WINDOW_SYSTEM
12034 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
12036 clear_image_caches (Qnil
);
12037 clear_image_cache_count
= 0;
12039 #endif /* HAVE_WINDOW_SYSTEM */
12043 unbind_to (count
, Qnil
);
12048 /* Redisplay, but leave alone any recent echo area message unless
12049 another message has been requested in its place.
12051 This is useful in situations where you need to redisplay but no
12052 user action has occurred, making it inappropriate for the message
12053 area to be cleared. See tracking_off and
12054 wait_reading_process_output for examples of these situations.
12056 FROM_WHERE is an integer saying from where this function was
12057 called. This is useful for debugging. */
12060 redisplay_preserve_echo_area (from_where
)
12063 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
12065 if (!NILP (echo_area_buffer
[1]))
12067 /* We have a previously displayed message, but no current
12068 message. Redisplay the previous message. */
12069 display_last_displayed_message_p
= 1;
12070 redisplay_internal (1);
12071 display_last_displayed_message_p
= 0;
12074 redisplay_internal (1);
12076 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
12077 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
12078 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
12082 /* Function registered with record_unwind_protect in
12083 redisplay_internal. Reset redisplaying_p to the value it had
12084 before redisplay_internal was called, and clear
12085 prevent_freeing_realized_faces_p. It also selects the previously
12086 selected frame, unless it has been deleted (by an X connection
12087 failure during redisplay, for example). */
12090 unwind_redisplay (val
)
12093 Lisp_Object old_redisplaying_p
, old_frame
;
12095 old_redisplaying_p
= XCAR (val
);
12096 redisplaying_p
= XFASTINT (old_redisplaying_p
);
12097 old_frame
= XCDR (val
);
12098 if (! EQ (old_frame
, selected_frame
)
12099 && FRAME_LIVE_P (XFRAME (old_frame
)))
12100 select_frame_for_redisplay (old_frame
);
12105 /* Mark the display of window W as accurate or inaccurate. If
12106 ACCURATE_P is non-zero mark display of W as accurate. If
12107 ACCURATE_P is zero, arrange for W to be redisplayed the next time
12108 redisplay_internal is called. */
12111 mark_window_display_accurate_1 (w
, accurate_p
)
12115 if (BUFFERP (w
->buffer
))
12117 struct buffer
*b
= XBUFFER (w
->buffer
);
12120 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
12121 w
->last_overlay_modified
12122 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
12124 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
12128 b
->clip_changed
= 0;
12129 b
->prevent_redisplay_optimizations_p
= 0;
12131 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
12132 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
12133 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
12134 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
12136 w
->current_matrix
->buffer
= b
;
12137 w
->current_matrix
->begv
= BUF_BEGV (b
);
12138 w
->current_matrix
->zv
= BUF_ZV (b
);
12140 w
->last_cursor
= w
->cursor
;
12141 w
->last_cursor_off_p
= w
->cursor_off_p
;
12143 if (w
== XWINDOW (selected_window
))
12144 w
->last_point
= make_number (BUF_PT (b
));
12146 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
12152 w
->window_end_valid
= w
->buffer
;
12153 #if 0 /* This is incorrect with variable-height lines. */
12154 xassert (XINT (w
->window_end_vpos
)
12155 < (WINDOW_TOTAL_LINES (w
)
12156 - (WINDOW_WANTS_MODELINE_P (w
) ? 1 : 0)));
12158 w
->update_mode_line
= Qnil
;
12163 /* Mark the display of windows in the window tree rooted at WINDOW as
12164 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
12165 windows as accurate. If ACCURATE_P is zero, arrange for windows to
12166 be redisplayed the next time redisplay_internal is called. */
12169 mark_window_display_accurate (window
, accurate_p
)
12170 Lisp_Object window
;
12175 for (; !NILP (window
); window
= w
->next
)
12177 w
= XWINDOW (window
);
12178 mark_window_display_accurate_1 (w
, accurate_p
);
12180 if (!NILP (w
->vchild
))
12181 mark_window_display_accurate (w
->vchild
, accurate_p
);
12182 if (!NILP (w
->hchild
))
12183 mark_window_display_accurate (w
->hchild
, accurate_p
);
12188 update_overlay_arrows (1);
12192 /* Force a thorough redisplay the next time by setting
12193 last_arrow_position and last_arrow_string to t, which is
12194 unequal to any useful value of Voverlay_arrow_... */
12195 update_overlay_arrows (-1);
12200 /* Return value in display table DP (Lisp_Char_Table *) for character
12201 C. Since a display table doesn't have any parent, we don't have to
12202 follow parent. Do not call this function directly but use the
12203 macro DISP_CHAR_VECTOR. */
12206 disp_char_vector (dp
, c
)
12207 struct Lisp_Char_Table
*dp
;
12212 if (ASCII_CHAR_P (c
))
12215 if (SUB_CHAR_TABLE_P (val
))
12216 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
12222 XSETCHAR_TABLE (table
, dp
);
12223 val
= char_table_ref (table
, c
);
12232 /***********************************************************************
12234 ***********************************************************************/
12236 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
12239 redisplay_windows (window
)
12240 Lisp_Object window
;
12242 while (!NILP (window
))
12244 struct window
*w
= XWINDOW (window
);
12246 if (!NILP (w
->hchild
))
12247 redisplay_windows (w
->hchild
);
12248 else if (!NILP (w
->vchild
))
12249 redisplay_windows (w
->vchild
);
12252 displayed_buffer
= XBUFFER (w
->buffer
);
12253 /* Use list_of_error, not Qerror, so that
12254 we catch only errors and don't run the debugger. */
12255 internal_condition_case_1 (redisplay_window_0
, window
,
12257 redisplay_window_error
);
12265 redisplay_window_error ()
12267 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
12272 redisplay_window_0 (window
)
12273 Lisp_Object window
;
12275 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12276 redisplay_window (window
, 0);
12281 redisplay_window_1 (window
)
12282 Lisp_Object window
;
12284 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12285 redisplay_window (window
, 1);
12290 /* Increment GLYPH until it reaches END or CONDITION fails while
12291 adding (GLYPH)->pixel_width to X. */
12293 #define SKIP_GLYPHS(glyph, end, x, condition) \
12296 (x) += (glyph)->pixel_width; \
12299 while ((glyph) < (end) && (condition))
12302 /* Set cursor position of W. PT is assumed to be displayed in ROW.
12303 DELTA is the number of bytes by which positions recorded in ROW
12304 differ from current buffer positions.
12306 Return 0 if cursor is not on this row. 1 otherwise. */
12309 set_cursor_from_row (w
, row
, matrix
, delta
, delta_bytes
, dy
, dvpos
)
12311 struct glyph_row
*row
;
12312 struct glyph_matrix
*matrix
;
12313 int delta
, delta_bytes
, dy
, dvpos
;
12315 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
12316 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
12317 struct glyph
*cursor
= NULL
;
12318 /* The first glyph that starts a sequence of glyphs from string. */
12319 struct glyph
*string_start
;
12320 /* The X coordinate of string_start. */
12321 int string_start_x
;
12322 /* The last known character position. */
12323 int last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12324 /* The last known character position before string_start. */
12325 int string_before_pos
;
12328 int cursor_from_overlay_pos
= 0;
12329 int pt_old
= PT
- delta
;
12331 /* Skip over glyphs not having an object at the start of the row.
12332 These are special glyphs like truncation marks on terminal
12334 if (row
->displays_text_p
)
12336 && INTEGERP (glyph
->object
)
12337 && glyph
->charpos
< 0)
12339 x
+= glyph
->pixel_width
;
12343 string_start
= NULL
;
12345 && !INTEGERP (glyph
->object
)
12346 && (!BUFFERP (glyph
->object
)
12347 || (last_pos
= glyph
->charpos
) < pt_old
12348 || glyph
->avoid_cursor_p
))
12350 if (! STRINGP (glyph
->object
))
12352 string_start
= NULL
;
12353 x
+= glyph
->pixel_width
;
12355 if (cursor_from_overlay_pos
12356 && last_pos
>= cursor_from_overlay_pos
)
12358 cursor_from_overlay_pos
= 0;
12364 if (string_start
== NULL
)
12366 string_before_pos
= last_pos
;
12367 string_start
= glyph
;
12368 string_start_x
= x
;
12370 /* Skip all glyphs from string. */
12375 if ((cursor
== NULL
|| glyph
> cursor
)
12376 && (cprop
= Fget_char_property (make_number ((glyph
)->charpos
),
12377 Qcursor
, (glyph
)->object
),
12379 && (pos
= string_buffer_position (w
, glyph
->object
,
12380 string_before_pos
),
12381 (pos
== 0 /* From overlay */
12382 || pos
== pt_old
)))
12384 /* Estimate overlay buffer position from the buffer
12385 positions of the glyphs before and after the overlay.
12386 Add 1 to last_pos so that if point corresponds to the
12387 glyph right after the overlay, we still use a 'cursor'
12388 property found in that overlay. */
12389 cursor_from_overlay_pos
= (pos
? 0 : last_pos
12390 + (INTEGERP (cprop
) ? XINT (cprop
) : 0));
12394 x
+= glyph
->pixel_width
;
12397 while (glyph
< end
&& EQ (glyph
->object
, string_start
->object
));
12401 if (cursor
!= NULL
)
12406 else if (row
->ends_in_ellipsis_p
&& glyph
== end
)
12408 /* Scan back over the ellipsis glyphs, decrementing positions. */
12409 while (glyph
> row
->glyphs
[TEXT_AREA
]
12410 && (glyph
- 1)->charpos
== last_pos
)
12411 glyph
--, x
-= glyph
->pixel_width
;
12412 /* That loop always goes one position too far,
12413 including the glyph before the ellipsis.
12414 So scan forward over that one. */
12415 x
+= glyph
->pixel_width
;
12418 else if (string_start
12419 && (glyph
== end
|| !BUFFERP (glyph
->object
) || last_pos
> pt_old
))
12421 /* We may have skipped over point because the previous glyphs
12422 are from string. As there's no easy way to know the
12423 character position of the current glyph, find the correct
12424 glyph on point by scanning from string_start again. */
12426 Lisp_Object string
;
12427 struct glyph
*stop
= glyph
;
12430 limit
= make_number (pt_old
+ 1);
12431 glyph
= string_start
;
12432 x
= string_start_x
;
12433 string
= glyph
->object
;
12434 pos
= string_buffer_position (w
, string
, string_before_pos
);
12435 /* If STRING is from overlay, LAST_POS == 0. We skip such glyphs
12436 because we always put cursor after overlay strings. */
12437 while (pos
== 0 && glyph
< stop
)
12439 string
= glyph
->object
;
12440 SKIP_GLYPHS (glyph
, stop
, x
, EQ (glyph
->object
, string
));
12442 pos
= string_buffer_position (w
, glyph
->object
, string_before_pos
);
12445 while (glyph
< stop
)
12447 pos
= XINT (Fnext_single_char_property_change
12448 (make_number (pos
), Qdisplay
, Qnil
, limit
));
12451 /* Skip glyphs from the same string. */
12452 string
= glyph
->object
;
12453 SKIP_GLYPHS (glyph
, stop
, x
, EQ (glyph
->object
, string
));
12454 /* Skip glyphs from an overlay. */
12455 while (glyph
< stop
12456 && ! string_buffer_position (w
, glyph
->object
, pos
))
12458 string
= glyph
->object
;
12459 SKIP_GLYPHS (glyph
, stop
, x
, EQ (glyph
->object
, string
));
12463 /* If we reached the end of the line, and end was from a string,
12464 cursor is not on this line. */
12465 if (glyph
== end
&& row
->continued_p
)
12469 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
12471 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
12472 w
->cursor
.y
= row
->y
+ dy
;
12474 if (w
== XWINDOW (selected_window
))
12476 if (!row
->continued_p
12477 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
12480 this_line_buffer
= XBUFFER (w
->buffer
);
12482 CHARPOS (this_line_start_pos
)
12483 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
12484 BYTEPOS (this_line_start_pos
)
12485 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
12487 CHARPOS (this_line_end_pos
)
12488 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
12489 BYTEPOS (this_line_end_pos
)
12490 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
12492 this_line_y
= w
->cursor
.y
;
12493 this_line_pixel_height
= row
->height
;
12494 this_line_vpos
= w
->cursor
.vpos
;
12495 this_line_start_x
= row
->x
;
12498 CHARPOS (this_line_start_pos
) = 0;
12505 /* Run window scroll functions, if any, for WINDOW with new window
12506 start STARTP. Sets the window start of WINDOW to that position.
12508 We assume that the window's buffer is really current. */
12510 static INLINE
struct text_pos
12511 run_window_scroll_functions (window
, startp
)
12512 Lisp_Object window
;
12513 struct text_pos startp
;
12515 struct window
*w
= XWINDOW (window
);
12516 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
12518 if (current_buffer
!= XBUFFER (w
->buffer
))
12521 if (!NILP (Vwindow_scroll_functions
))
12523 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
12524 make_number (CHARPOS (startp
)));
12525 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12526 /* In case the hook functions switch buffers. */
12527 if (current_buffer
!= XBUFFER (w
->buffer
))
12528 set_buffer_internal_1 (XBUFFER (w
->buffer
));
12535 /* Make sure the line containing the cursor is fully visible.
12536 A value of 1 means there is nothing to be done.
12537 (Either the line is fully visible, or it cannot be made so,
12538 or we cannot tell.)
12540 If FORCE_P is non-zero, return 0 even if partial visible cursor row
12541 is higher than window.
12543 A value of 0 means the caller should do scrolling
12544 as if point had gone off the screen. */
12547 cursor_row_fully_visible_p (w
, force_p
, current_matrix_p
)
12550 int current_matrix_p
;
12552 struct glyph_matrix
*matrix
;
12553 struct glyph_row
*row
;
12556 if (!make_cursor_line_fully_visible_p
)
12559 /* It's not always possible to find the cursor, e.g, when a window
12560 is full of overlay strings. Don't do anything in that case. */
12561 if (w
->cursor
.vpos
< 0)
12564 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
12565 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
12567 /* If the cursor row is not partially visible, there's nothing to do. */
12568 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
12571 /* If the row the cursor is in is taller than the window's height,
12572 it's not clear what to do, so do nothing. */
12573 window_height
= window_box_height (w
);
12574 if (row
->height
>= window_height
)
12576 if (!force_p
|| MINI_WINDOW_P (w
)
12577 || w
->vscroll
|| w
->cursor
.vpos
== 0)
12583 /* This code used to try to scroll the window just enough to make
12584 the line visible. It returned 0 to say that the caller should
12585 allocate larger glyph matrices. */
12587 if (MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (w
, row
))
12589 int dy
= row
->height
- row
->visible_height
;
12592 shift_glyph_matrix (w
, matrix
, 0, matrix
->nrows
, dy
);
12594 else /* MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P (w, row)) */
12596 int dy
= - (row
->height
- row
->visible_height
);
12599 shift_glyph_matrix (w
, matrix
, 0, matrix
->nrows
, dy
);
12602 /* When we change the cursor y-position of the selected window,
12603 change this_line_y as well so that the display optimization for
12604 the cursor line of the selected window in redisplay_internal uses
12605 the correct y-position. */
12606 if (w
== XWINDOW (selected_window
))
12607 this_line_y
= w
->cursor
.y
;
12609 /* If vscrolling requires a larger glyph matrix, arrange for a fresh
12610 redisplay with larger matrices. */
12611 if (matrix
->nrows
< required_matrix_height (w
))
12613 fonts_changed_p
= 1;
12622 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
12623 non-zero means only WINDOW is redisplayed in redisplay_internal.
12624 TEMP_SCROLL_STEP has the same meaning as scroll_step, and is used
12625 in redisplay_window to bring a partially visible line into view in
12626 the case that only the cursor has moved.
12628 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
12629 last screen line's vertical height extends past the end of the screen.
12633 1 if scrolling succeeded
12635 0 if scrolling didn't find point.
12637 -1 if new fonts have been loaded so that we must interrupt
12638 redisplay, adjust glyph matrices, and try again. */
12644 SCROLLING_NEED_LARGER_MATRICES
12648 try_scrolling (window
, just_this_one_p
, scroll_conservatively
,
12649 scroll_step
, temp_scroll_step
, last_line_misfit
)
12650 Lisp_Object window
;
12651 int just_this_one_p
;
12652 EMACS_INT scroll_conservatively
, scroll_step
;
12653 int temp_scroll_step
;
12654 int last_line_misfit
;
12656 struct window
*w
= XWINDOW (window
);
12657 struct frame
*f
= XFRAME (w
->frame
);
12658 struct text_pos scroll_margin_pos
;
12659 struct text_pos pos
;
12660 struct text_pos startp
;
12662 Lisp_Object window_end
;
12663 int this_scroll_margin
;
12667 int amount_to_scroll
= 0;
12668 Lisp_Object aggressive
;
12670 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
12673 debug_method_add (w
, "try_scrolling");
12676 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12678 /* Compute scroll margin height in pixels. We scroll when point is
12679 within this distance from the top or bottom of the window. */
12680 if (scroll_margin
> 0)
12682 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
12683 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
12686 this_scroll_margin
= 0;
12688 /* Force scroll_conservatively to have a reasonable value so it doesn't
12689 cause an overflow while computing how much to scroll. */
12690 if (scroll_conservatively
)
12691 scroll_conservatively
= min (scroll_conservatively
,
12692 MOST_POSITIVE_FIXNUM
/ FRAME_LINE_HEIGHT (f
));
12694 /* Compute how much we should try to scroll maximally to bring point
12696 if (scroll_step
|| scroll_conservatively
|| temp_scroll_step
)
12697 scroll_max
= max (scroll_step
,
12698 max (scroll_conservatively
, temp_scroll_step
));
12699 else if (NUMBERP (current_buffer
->scroll_down_aggressively
)
12700 || NUMBERP (current_buffer
->scroll_up_aggressively
))
12701 /* We're trying to scroll because of aggressive scrolling
12702 but no scroll_step is set. Choose an arbitrary one. Maybe
12703 there should be a variable for this. */
12707 scroll_max
*= FRAME_LINE_HEIGHT (f
);
12709 /* Decide whether we have to scroll down. Start at the window end
12710 and move this_scroll_margin up to find the position of the scroll
12712 window_end
= Fwindow_end (window
, Qt
);
12716 CHARPOS (scroll_margin_pos
) = XINT (window_end
);
12717 BYTEPOS (scroll_margin_pos
) = CHAR_TO_BYTE (CHARPOS (scroll_margin_pos
));
12719 if (this_scroll_margin
|| extra_scroll_margin_lines
)
12721 start_display (&it
, w
, scroll_margin_pos
);
12722 if (this_scroll_margin
)
12723 move_it_vertically_backward (&it
, this_scroll_margin
);
12724 if (extra_scroll_margin_lines
)
12725 move_it_by_lines (&it
, - extra_scroll_margin_lines
, 0);
12726 scroll_margin_pos
= it
.current
.pos
;
12729 if (PT
>= CHARPOS (scroll_margin_pos
))
12733 /* Point is in the scroll margin at the bottom of the window, or
12734 below. Compute a new window start that makes point visible. */
12736 /* Compute the distance from the scroll margin to PT.
12737 Give up if the distance is greater than scroll_max. */
12738 start_display (&it
, w
, scroll_margin_pos
);
12740 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
12741 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
12743 /* To make point visible, we have to move the window start
12744 down so that the line the cursor is in is visible, which
12745 means we have to add in the height of the cursor line. */
12746 dy
= line_bottom_y (&it
) - y0
;
12748 if (dy
> scroll_max
)
12749 return SCROLLING_FAILED
;
12751 /* Move the window start down. If scrolling conservatively,
12752 move it just enough down to make point visible. If
12753 scroll_step is set, move it down by scroll_step. */
12754 start_display (&it
, w
, startp
);
12756 if (scroll_conservatively
)
12757 /* Set AMOUNT_TO_SCROLL to at least one line,
12758 and at most scroll_conservatively lines. */
12760 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
12761 FRAME_LINE_HEIGHT (f
) * scroll_conservatively
);
12762 else if (scroll_step
|| temp_scroll_step
)
12763 amount_to_scroll
= scroll_max
;
12766 aggressive
= current_buffer
->scroll_up_aggressively
;
12767 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
12768 if (NUMBERP (aggressive
))
12770 double float_amount
= XFLOATINT (aggressive
) * height
;
12771 amount_to_scroll
= float_amount
;
12772 if (amount_to_scroll
== 0 && float_amount
> 0)
12773 amount_to_scroll
= 1;
12777 if (amount_to_scroll
<= 0)
12778 return SCROLLING_FAILED
;
12780 /* If moving by amount_to_scroll leaves STARTP unchanged,
12781 move it down one screen line. */
12783 move_it_vertically (&it
, amount_to_scroll
);
12784 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
12785 move_it_by_lines (&it
, 1, 1);
12786 startp
= it
.current
.pos
;
12790 /* See if point is inside the scroll margin at the top of the
12792 scroll_margin_pos
= startp
;
12793 if (this_scroll_margin
)
12795 start_display (&it
, w
, startp
);
12796 move_it_vertically (&it
, this_scroll_margin
);
12797 scroll_margin_pos
= it
.current
.pos
;
12800 if (PT
< CHARPOS (scroll_margin_pos
))
12802 /* Point is in the scroll margin at the top of the window or
12803 above what is displayed in the window. */
12806 /* Compute the vertical distance from PT to the scroll
12807 margin position. Give up if distance is greater than
12809 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
12810 start_display (&it
, w
, pos
);
12812 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
12813 it
.last_visible_y
, -1,
12814 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
12815 dy
= it
.current_y
- y0
;
12816 if (dy
> scroll_max
)
12817 return SCROLLING_FAILED
;
12819 /* Compute new window start. */
12820 start_display (&it
, w
, startp
);
12822 if (scroll_conservatively
)
12824 = max (dy
, FRAME_LINE_HEIGHT (f
) * max (scroll_step
, temp_scroll_step
));
12825 else if (scroll_step
|| temp_scroll_step
)
12826 amount_to_scroll
= scroll_max
;
12829 aggressive
= current_buffer
->scroll_down_aggressively
;
12830 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
12831 if (NUMBERP (aggressive
))
12833 double float_amount
= XFLOATINT (aggressive
) * height
;
12834 amount_to_scroll
= float_amount
;
12835 if (amount_to_scroll
== 0 && float_amount
> 0)
12836 amount_to_scroll
= 1;
12840 if (amount_to_scroll
<= 0)
12841 return SCROLLING_FAILED
;
12843 move_it_vertically_backward (&it
, amount_to_scroll
);
12844 startp
= it
.current
.pos
;
12848 /* Run window scroll functions. */
12849 startp
= run_window_scroll_functions (window
, startp
);
12851 /* Display the window. Give up if new fonts are loaded, or if point
12853 if (!try_window (window
, startp
, 0))
12854 rc
= SCROLLING_NEED_LARGER_MATRICES
;
12855 else if (w
->cursor
.vpos
< 0)
12857 clear_glyph_matrix (w
->desired_matrix
);
12858 rc
= SCROLLING_FAILED
;
12862 /* Maybe forget recorded base line for line number display. */
12863 if (!just_this_one_p
12864 || current_buffer
->clip_changed
12865 || BEG_UNCHANGED
< CHARPOS (startp
))
12866 w
->base_line_number
= Qnil
;
12868 /* If cursor ends up on a partially visible line,
12869 treat that as being off the bottom of the screen. */
12870 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0))
12872 clear_glyph_matrix (w
->desired_matrix
);
12873 ++extra_scroll_margin_lines
;
12876 rc
= SCROLLING_SUCCESS
;
12883 /* Compute a suitable window start for window W if display of W starts
12884 on a continuation line. Value is non-zero if a new window start
12887 The new window start will be computed, based on W's width, starting
12888 from the start of the continued line. It is the start of the
12889 screen line with the minimum distance from the old start W->start. */
12892 compute_window_start_on_continuation_line (w
)
12895 struct text_pos pos
, start_pos
;
12896 int window_start_changed_p
= 0;
12898 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
12900 /* If window start is on a continuation line... Window start may be
12901 < BEGV in case there's invisible text at the start of the
12902 buffer (M-x rmail, for example). */
12903 if (CHARPOS (start_pos
) > BEGV
12904 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
12907 struct glyph_row
*row
;
12909 /* Handle the case that the window start is out of range. */
12910 if (CHARPOS (start_pos
) < BEGV
)
12911 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
12912 else if (CHARPOS (start_pos
) > ZV
)
12913 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
12915 /* Find the start of the continued line. This should be fast
12916 because scan_buffer is fast (newline cache). */
12917 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
12918 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
12919 row
, DEFAULT_FACE_ID
);
12920 reseat_at_previous_visible_line_start (&it
);
12922 /* If the line start is "too far" away from the window start,
12923 say it takes too much time to compute a new window start. */
12924 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
12925 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
12927 int min_distance
, distance
;
12929 /* Move forward by display lines to find the new window
12930 start. If window width was enlarged, the new start can
12931 be expected to be > the old start. If window width was
12932 decreased, the new window start will be < the old start.
12933 So, we're looking for the display line start with the
12934 minimum distance from the old window start. */
12935 pos
= it
.current
.pos
;
12936 min_distance
= INFINITY
;
12937 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
12938 distance
< min_distance
)
12940 min_distance
= distance
;
12941 pos
= it
.current
.pos
;
12942 move_it_by_lines (&it
, 1, 0);
12945 /* Set the window start there. */
12946 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
12947 window_start_changed_p
= 1;
12951 return window_start_changed_p
;
12955 /* Try cursor movement in case text has not changed in window WINDOW,
12956 with window start STARTP. Value is
12958 CURSOR_MOVEMENT_SUCCESS if successful
12960 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
12962 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
12963 display. *SCROLL_STEP is set to 1, under certain circumstances, if
12964 we want to scroll as if scroll-step were set to 1. See the code.
12966 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
12967 which case we have to abort this redisplay, and adjust matrices
12972 CURSOR_MOVEMENT_SUCCESS
,
12973 CURSOR_MOVEMENT_CANNOT_BE_USED
,
12974 CURSOR_MOVEMENT_MUST_SCROLL
,
12975 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
12979 try_cursor_movement (window
, startp
, scroll_step
)
12980 Lisp_Object window
;
12981 struct text_pos startp
;
12984 struct window
*w
= XWINDOW (window
);
12985 struct frame
*f
= XFRAME (w
->frame
);
12986 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
12989 if (inhibit_try_cursor_movement
)
12993 /* Handle case where text has not changed, only point, and it has
12994 not moved off the frame. */
12995 if (/* Point may be in this window. */
12996 PT
>= CHARPOS (startp
)
12997 /* Selective display hasn't changed. */
12998 && !current_buffer
->clip_changed
12999 /* Function force-mode-line-update is used to force a thorough
13000 redisplay. It sets either windows_or_buffers_changed or
13001 update_mode_lines. So don't take a shortcut here for these
13003 && !update_mode_lines
13004 && !windows_or_buffers_changed
13005 && !cursor_type_changed
13006 /* Can't use this case if highlighting a region. When a
13007 region exists, cursor movement has to do more than just
13009 && !(!NILP (Vtransient_mark_mode
)
13010 && !NILP (current_buffer
->mark_active
))
13011 && NILP (w
->region_showing
)
13012 && NILP (Vshow_trailing_whitespace
)
13013 /* Right after splitting windows, last_point may be nil. */
13014 && INTEGERP (w
->last_point
)
13015 /* This code is not used for mini-buffer for the sake of the case
13016 of redisplaying to replace an echo area message; since in
13017 that case the mini-buffer contents per se are usually
13018 unchanged. This code is of no real use in the mini-buffer
13019 since the handling of this_line_start_pos, etc., in redisplay
13020 handles the same cases. */
13021 && !EQ (window
, minibuf_window
)
13022 /* When splitting windows or for new windows, it happens that
13023 redisplay is called with a nil window_end_vpos or one being
13024 larger than the window. This should really be fixed in
13025 window.c. I don't have this on my list, now, so we do
13026 approximately the same as the old redisplay code. --gerd. */
13027 && INTEGERP (w
->window_end_vpos
)
13028 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
13029 && (FRAME_WINDOW_P (f
)
13030 || !overlay_arrow_in_current_buffer_p ()))
13032 int this_scroll_margin
, top_scroll_margin
;
13033 struct glyph_row
*row
= NULL
;
13036 debug_method_add (w
, "cursor movement");
13039 /* Scroll if point within this distance from the top or bottom
13040 of the window. This is a pixel value. */
13041 this_scroll_margin
= max (0, scroll_margin
);
13042 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
13043 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
13045 top_scroll_margin
= this_scroll_margin
;
13046 if (WINDOW_WANTS_HEADER_LINE_P (w
))
13047 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
13049 /* Start with the row the cursor was displayed during the last
13050 not paused redisplay. Give up if that row is not valid. */
13051 if (w
->last_cursor
.vpos
< 0
13052 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
13053 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13056 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
13057 if (row
->mode_line_p
)
13059 if (!row
->enabled_p
)
13060 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13063 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
13066 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
13068 if (PT
> XFASTINT (w
->last_point
))
13070 /* Point has moved forward. */
13071 while (MATRIX_ROW_END_CHARPOS (row
) < PT
13072 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
13074 xassert (row
->enabled_p
);
13078 /* The end position of a row equals the start position
13079 of the next row. If PT is there, we would rather
13080 display it in the next line. */
13081 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13082 && MATRIX_ROW_END_CHARPOS (row
) == PT
13083 && !cursor_row_p (w
, row
))
13086 /* If within the scroll margin, scroll. Note that
13087 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
13088 the next line would be drawn, and that
13089 this_scroll_margin can be zero. */
13090 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
13091 || PT
> MATRIX_ROW_END_CHARPOS (row
)
13092 /* Line is completely visible last line in window
13093 and PT is to be set in the next line. */
13094 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
13095 && PT
== MATRIX_ROW_END_CHARPOS (row
)
13096 && !row
->ends_at_zv_p
13097 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
13100 else if (PT
< XFASTINT (w
->last_point
))
13102 /* Cursor has to be moved backward. Note that PT >=
13103 CHARPOS (startp) because of the outer if-statement. */
13104 while (!row
->mode_line_p
13105 && (MATRIX_ROW_START_CHARPOS (row
) > PT
13106 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13107 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
13108 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
13109 row
> w
->current_matrix
->rows
13110 && (row
-1)->ends_in_newline_from_string_p
))))
13111 && (row
->y
> top_scroll_margin
13112 || CHARPOS (startp
) == BEGV
))
13114 xassert (row
->enabled_p
);
13118 /* Consider the following case: Window starts at BEGV,
13119 there is invisible, intangible text at BEGV, so that
13120 display starts at some point START > BEGV. It can
13121 happen that we are called with PT somewhere between
13122 BEGV and START. Try to handle that case. */
13123 if (row
< w
->current_matrix
->rows
13124 || row
->mode_line_p
)
13126 row
= w
->current_matrix
->rows
;
13127 if (row
->mode_line_p
)
13131 /* Due to newlines in overlay strings, we may have to
13132 skip forward over overlay strings. */
13133 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13134 && MATRIX_ROW_END_CHARPOS (row
) == PT
13135 && !cursor_row_p (w
, row
))
13138 /* If within the scroll margin, scroll. */
13139 if (row
->y
< top_scroll_margin
13140 && CHARPOS (startp
) != BEGV
)
13145 /* Cursor did not move. So don't scroll even if cursor line
13146 is partially visible, as it was so before. */
13147 rc
= CURSOR_MOVEMENT_SUCCESS
;
13150 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
13151 || PT
> MATRIX_ROW_END_CHARPOS (row
))
13153 /* if PT is not in the glyph row, give up. */
13154 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13156 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13157 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
13158 && make_cursor_line_fully_visible_p
)
13160 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
13161 && !row
->ends_at_zv_p
13162 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
13163 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13164 else if (row
->height
> window_box_height (w
))
13166 /* If we end up in a partially visible line, let's
13167 make it fully visible, except when it's taller
13168 than the window, in which case we can't do much
13171 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13175 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13176 if (!cursor_row_fully_visible_p (w
, 0, 1))
13177 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13179 rc
= CURSOR_MOVEMENT_SUCCESS
;
13183 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13188 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
13190 rc
= CURSOR_MOVEMENT_SUCCESS
;
13195 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13196 && MATRIX_ROW_START_CHARPOS (row
) == PT
13197 && cursor_row_p (w
, row
));
13206 set_vertical_scroll_bar (w
)
13209 int start
, end
, whole
;
13211 /* Calculate the start and end positions for the current window.
13212 At some point, it would be nice to choose between scrollbars
13213 which reflect the whole buffer size, with special markers
13214 indicating narrowing, and scrollbars which reflect only the
13217 Note that mini-buffers sometimes aren't displaying any text. */
13218 if (!MINI_WINDOW_P (w
)
13219 || (w
== XWINDOW (minibuf_window
)
13220 && NILP (echo_area_buffer
[0])))
13222 struct buffer
*buf
= XBUFFER (w
->buffer
);
13223 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
13224 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
13225 /* I don't think this is guaranteed to be right. For the
13226 moment, we'll pretend it is. */
13227 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
13231 if (whole
< (end
- start
))
13232 whole
= end
- start
;
13235 start
= end
= whole
= 0;
13237 /* Indicate what this scroll bar ought to be displaying now. */
13238 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13239 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13240 (w
, end
- start
, whole
, start
);
13244 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
13245 selected_window is redisplayed.
13247 We can return without actually redisplaying the window if
13248 fonts_changed_p is nonzero. In that case, redisplay_internal will
13252 redisplay_window (window
, just_this_one_p
)
13253 Lisp_Object window
;
13254 int just_this_one_p
;
13256 struct window
*w
= XWINDOW (window
);
13257 struct frame
*f
= XFRAME (w
->frame
);
13258 struct buffer
*buffer
= XBUFFER (w
->buffer
);
13259 struct buffer
*old
= current_buffer
;
13260 struct text_pos lpoint
, opoint
, startp
;
13261 int update_mode_line
;
13264 /* Record it now because it's overwritten. */
13265 int current_matrix_up_to_date_p
= 0;
13266 int used_current_matrix_p
= 0;
13267 /* This is less strict than current_matrix_up_to_date_p.
13268 It indictes that the buffer contents and narrowing are unchanged. */
13269 int buffer_unchanged_p
= 0;
13270 int temp_scroll_step
= 0;
13271 int count
= SPECPDL_INDEX ();
13273 int centering_position
= -1;
13274 int last_line_misfit
= 0;
13275 int beg_unchanged
, end_unchanged
;
13277 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13280 /* W must be a leaf window here. */
13281 xassert (!NILP (w
->buffer
));
13283 *w
->desired_matrix
->method
= 0;
13287 reconsider_clip_changes (w
, buffer
);
13289 /* Has the mode line to be updated? */
13290 update_mode_line
= (!NILP (w
->update_mode_line
)
13291 || update_mode_lines
13292 || buffer
->clip_changed
13293 || buffer
->prevent_redisplay_optimizations_p
);
13295 if (MINI_WINDOW_P (w
))
13297 if (w
== XWINDOW (echo_area_window
)
13298 && !NILP (echo_area_buffer
[0]))
13300 if (update_mode_line
)
13301 /* We may have to update a tty frame's menu bar or a
13302 tool-bar. Example `M-x C-h C-h C-g'. */
13303 goto finish_menu_bars
;
13305 /* We've already displayed the echo area glyphs in this window. */
13306 goto finish_scroll_bars
;
13308 else if ((w
!= XWINDOW (minibuf_window
)
13309 || minibuf_level
== 0)
13310 /* When buffer is nonempty, redisplay window normally. */
13311 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
13312 /* Quail displays non-mini buffers in minibuffer window.
13313 In that case, redisplay the window normally. */
13314 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
13316 /* W is a mini-buffer window, but it's not active, so clear
13318 int yb
= window_text_bottom_y (w
);
13319 struct glyph_row
*row
;
13322 for (y
= 0, row
= w
->desired_matrix
->rows
;
13324 y
+= row
->height
, ++row
)
13325 blank_row (w
, row
, y
);
13326 goto finish_scroll_bars
;
13329 clear_glyph_matrix (w
->desired_matrix
);
13332 /* Otherwise set up data on this window; select its buffer and point
13334 /* Really select the buffer, for the sake of buffer-local
13336 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13338 current_matrix_up_to_date_p
13339 = (!NILP (w
->window_end_valid
)
13340 && !current_buffer
->clip_changed
13341 && !current_buffer
->prevent_redisplay_optimizations_p
13342 && XFASTINT (w
->last_modified
) >= MODIFF
13343 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13345 /* Run the window-bottom-change-functions
13346 if it is possible that the text on the screen has changed
13347 (either due to modification of the text, or any other reason). */
13348 if (!current_matrix_up_to_date_p
13349 && !NILP (Vwindow_text_change_functions
))
13351 safe_run_hooks (Qwindow_text_change_functions
);
13355 beg_unchanged
= BEG_UNCHANGED
;
13356 end_unchanged
= END_UNCHANGED
;
13358 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
13360 specbind (Qinhibit_point_motion_hooks
, Qt
);
13363 = (!NILP (w
->window_end_valid
)
13364 && !current_buffer
->clip_changed
13365 && XFASTINT (w
->last_modified
) >= MODIFF
13366 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13368 /* When windows_or_buffers_changed is non-zero, we can't rely on
13369 the window end being valid, so set it to nil there. */
13370 if (windows_or_buffers_changed
)
13372 /* If window starts on a continuation line, maybe adjust the
13373 window start in case the window's width changed. */
13374 if (XMARKER (w
->start
)->buffer
== current_buffer
)
13375 compute_window_start_on_continuation_line (w
);
13377 w
->window_end_valid
= Qnil
;
13380 /* Some sanity checks. */
13381 CHECK_WINDOW_END (w
);
13382 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
13384 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
13387 /* If %c is in mode line, update it if needed. */
13388 if (!NILP (w
->column_number_displayed
)
13389 /* This alternative quickly identifies a common case
13390 where no change is needed. */
13391 && !(PT
== XFASTINT (w
->last_point
)
13392 && XFASTINT (w
->last_modified
) >= MODIFF
13393 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
13394 && (XFASTINT (w
->column_number_displayed
)
13395 != (int) current_column ())) /* iftc */
13396 update_mode_line
= 1;
13398 /* Count number of windows showing the selected buffer. An indirect
13399 buffer counts as its base buffer. */
13400 if (!just_this_one_p
)
13402 struct buffer
*current_base
, *window_base
;
13403 current_base
= current_buffer
;
13404 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13405 if (current_base
->base_buffer
)
13406 current_base
= current_base
->base_buffer
;
13407 if (window_base
->base_buffer
)
13408 window_base
= window_base
->base_buffer
;
13409 if (current_base
== window_base
)
13413 /* Point refers normally to the selected window. For any other
13414 window, set up appropriate value. */
13415 if (!EQ (window
, selected_window
))
13417 int new_pt
= XMARKER (w
->pointm
)->charpos
;
13418 int new_pt_byte
= marker_byte_position (w
->pointm
);
13422 new_pt_byte
= BEGV_BYTE
;
13423 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
13425 else if (new_pt
> (ZV
- 1))
13428 new_pt_byte
= ZV_BYTE
;
13429 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
13432 /* We don't use SET_PT so that the point-motion hooks don't run. */
13433 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
13436 /* If any of the character widths specified in the display table
13437 have changed, invalidate the width run cache. It's true that
13438 this may be a bit late to catch such changes, but the rest of
13439 redisplay goes (non-fatally) haywire when the display table is
13440 changed, so why should we worry about doing any better? */
13441 if (current_buffer
->width_run_cache
)
13443 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
13445 if (! disptab_matches_widthtab (disptab
,
13446 XVECTOR (current_buffer
->width_table
)))
13448 invalidate_region_cache (current_buffer
,
13449 current_buffer
->width_run_cache
,
13451 recompute_width_table (current_buffer
, disptab
);
13455 /* If window-start is screwed up, choose a new one. */
13456 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
13459 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13461 /* If someone specified a new starting point but did not insist,
13462 check whether it can be used. */
13463 if (!NILP (w
->optional_new_start
)
13464 && CHARPOS (startp
) >= BEGV
13465 && CHARPOS (startp
) <= ZV
)
13467 w
->optional_new_start
= Qnil
;
13468 start_display (&it
, w
, startp
);
13469 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
13470 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13471 if (IT_CHARPOS (it
) == PT
)
13472 w
->force_start
= Qt
;
13473 /* IT may overshoot PT if text at PT is invisible. */
13474 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
13475 w
->force_start
= Qt
;
13480 /* Handle case where place to start displaying has been specified,
13481 unless the specified location is outside the accessible range. */
13482 if (!NILP (w
->force_start
)
13483 || w
->frozen_window_start_p
)
13485 /* We set this later on if we have to adjust point. */
13489 w
->force_start
= Qnil
;
13491 w
->window_end_valid
= Qnil
;
13493 /* Forget any recorded base line for line number display. */
13494 if (!buffer_unchanged_p
)
13495 w
->base_line_number
= Qnil
;
13497 /* Redisplay the mode line. Select the buffer properly for that.
13498 Also, run the hook window-scroll-functions
13499 because we have scrolled. */
13500 /* Note, we do this after clearing force_start because
13501 if there's an error, it is better to forget about force_start
13502 than to get into an infinite loop calling the hook functions
13503 and having them get more errors. */
13504 if (!update_mode_line
13505 || ! NILP (Vwindow_scroll_functions
))
13507 update_mode_line
= 1;
13508 w
->update_mode_line
= Qt
;
13509 startp
= run_window_scroll_functions (window
, startp
);
13512 w
->last_modified
= make_number (0);
13513 w
->last_overlay_modified
= make_number (0);
13514 if (CHARPOS (startp
) < BEGV
)
13515 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
13516 else if (CHARPOS (startp
) > ZV
)
13517 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
13519 /* Redisplay, then check if cursor has been set during the
13520 redisplay. Give up if new fonts were loaded. */
13521 val
= try_window (window
, startp
, 1);
13524 w
->force_start
= Qt
;
13525 clear_glyph_matrix (w
->desired_matrix
);
13526 goto need_larger_matrices
;
13528 /* Point was outside the scroll margins. */
13530 new_vpos
= window_box_height (w
) / 2;
13532 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
13534 /* If point does not appear, try to move point so it does
13535 appear. The desired matrix has been built above, so we
13536 can use it here. */
13537 new_vpos
= window_box_height (w
) / 2;
13540 if (!cursor_row_fully_visible_p (w
, 0, 0))
13542 /* Point does appear, but on a line partly visible at end of window.
13543 Move it back to a fully-visible line. */
13544 new_vpos
= window_box_height (w
);
13547 /* If we need to move point for either of the above reasons,
13548 now actually do it. */
13551 struct glyph_row
*row
;
13553 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
13554 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
13557 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
13558 MATRIX_ROW_START_BYTEPOS (row
));
13560 if (w
!= XWINDOW (selected_window
))
13561 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
13562 else if (current_buffer
== old
)
13563 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13565 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
13567 /* If we are highlighting the region, then we just changed
13568 the region, so redisplay to show it. */
13569 if (!NILP (Vtransient_mark_mode
)
13570 && !NILP (current_buffer
->mark_active
))
13572 clear_glyph_matrix (w
->desired_matrix
);
13573 if (!try_window (window
, startp
, 0))
13574 goto need_larger_matrices
;
13579 debug_method_add (w
, "forced window start");
13584 /* Handle case where text has not changed, only point, and it has
13585 not moved off the frame, and we are not retrying after hscroll.
13586 (current_matrix_up_to_date_p is nonzero when retrying.) */
13587 if (current_matrix_up_to_date_p
13588 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
13589 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
13593 case CURSOR_MOVEMENT_SUCCESS
:
13594 used_current_matrix_p
= 1;
13597 #if 0 /* try_cursor_movement never returns this value. */
13598 case CURSOR_MOVEMENT_NEED_LARGER_MATRICES
:
13599 goto need_larger_matrices
;
13602 case CURSOR_MOVEMENT_MUST_SCROLL
:
13603 goto try_to_scroll
;
13609 /* If current starting point was originally the beginning of a line
13610 but no longer is, find a new starting point. */
13611 else if (!NILP (w
->start_at_line_beg
)
13612 && !(CHARPOS (startp
) <= BEGV
13613 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
13616 debug_method_add (w
, "recenter 1");
13621 /* Try scrolling with try_window_id. Value is > 0 if update has
13622 been done, it is -1 if we know that the same window start will
13623 not work. It is 0 if unsuccessful for some other reason. */
13624 else if ((tem
= try_window_id (w
)) != 0)
13627 debug_method_add (w
, "try_window_id %d", tem
);
13630 if (fonts_changed_p
)
13631 goto need_larger_matrices
;
13635 /* Otherwise try_window_id has returned -1 which means that we
13636 don't want the alternative below this comment to execute. */
13638 else if (CHARPOS (startp
) >= BEGV
13639 && CHARPOS (startp
) <= ZV
13640 && PT
>= CHARPOS (startp
)
13641 && (CHARPOS (startp
) < ZV
13642 /* Avoid starting at end of buffer. */
13643 || CHARPOS (startp
) == BEGV
13644 || (XFASTINT (w
->last_modified
) >= MODIFF
13645 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
13648 /* If first window line is a continuation line, and window start
13649 is inside the modified region, but the first change is before
13650 current window start, we must select a new window start.
13652 However, if this is the result of a down-mouse event (e.g. by
13653 extending the mouse-drag-overlay), we don't want to select a
13654 new window start, since that would change the position under
13655 the mouse, resulting in an unwanted mouse-movement rather
13656 than a simple mouse-click. */
13657 if (NILP (w
->start_at_line_beg
)
13658 && NILP (do_mouse_tracking
)
13659 && CHARPOS (startp
) > BEGV
13660 && CHARPOS (startp
) > BEG
+ beg_unchanged
13661 && CHARPOS (startp
) <= Z
- end_unchanged
)
13663 w
->force_start
= Qt
;
13664 if (XMARKER (w
->start
)->buffer
== current_buffer
)
13665 compute_window_start_on_continuation_line (w
);
13666 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13671 debug_method_add (w
, "same window start");
13674 /* Try to redisplay starting at same place as before.
13675 If point has not moved off frame, accept the results. */
13676 if (!current_matrix_up_to_date_p
13677 /* Don't use try_window_reusing_current_matrix in this case
13678 because a window scroll function can have changed the
13680 || !NILP (Vwindow_scroll_functions
)
13681 || MINI_WINDOW_P (w
)
13682 || !(used_current_matrix_p
13683 = try_window_reusing_current_matrix (w
)))
13685 IF_DEBUG (debug_method_add (w
, "1"));
13686 if (try_window (window
, startp
, 1) < 0)
13687 /* -1 means we need to scroll.
13688 0 means we need new matrices, but fonts_changed_p
13689 is set in that case, so we will detect it below. */
13690 goto try_to_scroll
;
13693 if (fonts_changed_p
)
13694 goto need_larger_matrices
;
13696 if (w
->cursor
.vpos
>= 0)
13698 if (!just_this_one_p
13699 || current_buffer
->clip_changed
13700 || BEG_UNCHANGED
< CHARPOS (startp
))
13701 /* Forget any recorded base line for line number display. */
13702 w
->base_line_number
= Qnil
;
13704 if (!cursor_row_fully_visible_p (w
, 1, 0))
13706 clear_glyph_matrix (w
->desired_matrix
);
13707 last_line_misfit
= 1;
13709 /* Drop through and scroll. */
13714 clear_glyph_matrix (w
->desired_matrix
);
13719 w
->last_modified
= make_number (0);
13720 w
->last_overlay_modified
= make_number (0);
13722 /* Redisplay the mode line. Select the buffer properly for that. */
13723 if (!update_mode_line
)
13725 update_mode_line
= 1;
13726 w
->update_mode_line
= Qt
;
13729 /* Try to scroll by specified few lines. */
13730 if ((scroll_conservatively
13732 || temp_scroll_step
13733 || NUMBERP (current_buffer
->scroll_up_aggressively
)
13734 || NUMBERP (current_buffer
->scroll_down_aggressively
))
13735 && !current_buffer
->clip_changed
13736 && CHARPOS (startp
) >= BEGV
13737 && CHARPOS (startp
) <= ZV
)
13739 /* The function returns -1 if new fonts were loaded, 1 if
13740 successful, 0 if not successful. */
13741 int rc
= try_scrolling (window
, just_this_one_p
,
13742 scroll_conservatively
,
13744 temp_scroll_step
, last_line_misfit
);
13747 case SCROLLING_SUCCESS
:
13750 case SCROLLING_NEED_LARGER_MATRICES
:
13751 goto need_larger_matrices
;
13753 case SCROLLING_FAILED
:
13761 /* Finally, just choose place to start which centers point */
13764 if (centering_position
< 0)
13765 centering_position
= window_box_height (w
) / 2;
13768 debug_method_add (w
, "recenter");
13771 /* w->vscroll = 0; */
13773 /* Forget any previously recorded base line for line number display. */
13774 if (!buffer_unchanged_p
)
13775 w
->base_line_number
= Qnil
;
13777 /* Move backward half the height of the window. */
13778 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
13779 it
.current_y
= it
.last_visible_y
;
13780 move_it_vertically_backward (&it
, centering_position
);
13781 xassert (IT_CHARPOS (it
) >= BEGV
);
13783 /* The function move_it_vertically_backward may move over more
13784 than the specified y-distance. If it->w is small, e.g. a
13785 mini-buffer window, we may end up in front of the window's
13786 display area. Start displaying at the start of the line
13787 containing PT in this case. */
13788 if (it
.current_y
<= 0)
13790 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
13791 move_it_vertically_backward (&it
, 0);
13793 /* I think this assert is bogus if buffer contains
13794 invisible text or images. KFS. */
13795 xassert (IT_CHARPOS (it
) <= PT
);
13800 it
.current_x
= it
.hpos
= 0;
13802 /* Set startp here explicitly in case that helps avoid an infinite loop
13803 in case the window-scroll-functions functions get errors. */
13804 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
13806 /* Run scroll hooks. */
13807 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
13809 /* Redisplay the window. */
13810 if (!current_matrix_up_to_date_p
13811 || windows_or_buffers_changed
13812 || cursor_type_changed
13813 /* Don't use try_window_reusing_current_matrix in this case
13814 because it can have changed the buffer. */
13815 || !NILP (Vwindow_scroll_functions
)
13816 || !just_this_one_p
13817 || MINI_WINDOW_P (w
)
13818 || !(used_current_matrix_p
13819 = try_window_reusing_current_matrix (w
)))
13820 try_window (window
, startp
, 0);
13822 /* If new fonts have been loaded (due to fontsets), give up. We
13823 have to start a new redisplay since we need to re-adjust glyph
13825 if (fonts_changed_p
)
13826 goto need_larger_matrices
;
13828 /* If cursor did not appear assume that the middle of the window is
13829 in the first line of the window. Do it again with the next line.
13830 (Imagine a window of height 100, displaying two lines of height
13831 60. Moving back 50 from it->last_visible_y will end in the first
13833 if (w
->cursor
.vpos
< 0)
13835 if (!NILP (w
->window_end_valid
)
13836 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
13838 clear_glyph_matrix (w
->desired_matrix
);
13839 move_it_by_lines (&it
, 1, 0);
13840 try_window (window
, it
.current
.pos
, 0);
13842 else if (PT
< IT_CHARPOS (it
))
13844 clear_glyph_matrix (w
->desired_matrix
);
13845 move_it_by_lines (&it
, -1, 0);
13846 try_window (window
, it
.current
.pos
, 0);
13850 /* Not much we can do about it. */
13854 /* Consider the following case: Window starts at BEGV, there is
13855 invisible, intangible text at BEGV, so that display starts at
13856 some point START > BEGV. It can happen that we are called with
13857 PT somewhere between BEGV and START. Try to handle that case. */
13858 if (w
->cursor
.vpos
< 0)
13860 struct glyph_row
*row
= w
->current_matrix
->rows
;
13861 if (row
->mode_line_p
)
13863 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13866 if (!cursor_row_fully_visible_p (w
, 0, 0))
13868 /* If vscroll is enabled, disable it and try again. */
13872 clear_glyph_matrix (w
->desired_matrix
);
13876 /* If centering point failed to make the whole line visible,
13877 put point at the top instead. That has to make the whole line
13878 visible, if it can be done. */
13879 if (centering_position
== 0)
13882 clear_glyph_matrix (w
->desired_matrix
);
13883 centering_position
= 0;
13889 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13890 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
13891 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
13894 /* Display the mode line, if we must. */
13895 if ((update_mode_line
13896 /* If window not full width, must redo its mode line
13897 if (a) the window to its side is being redone and
13898 (b) we do a frame-based redisplay. This is a consequence
13899 of how inverted lines are drawn in frame-based redisplay. */
13900 || (!just_this_one_p
13901 && !FRAME_WINDOW_P (f
)
13902 && !WINDOW_FULL_WIDTH_P (w
))
13903 /* Line number to display. */
13904 || INTEGERP (w
->base_line_pos
)
13905 /* Column number is displayed and different from the one displayed. */
13906 || (!NILP (w
->column_number_displayed
)
13907 && (XFASTINT (w
->column_number_displayed
)
13908 != (int) current_column ()))) /* iftc */
13909 /* This means that the window has a mode line. */
13910 && (WINDOW_WANTS_MODELINE_P (w
)
13911 || WINDOW_WANTS_HEADER_LINE_P (w
)))
13913 display_mode_lines (w
);
13915 /* If mode line height has changed, arrange for a thorough
13916 immediate redisplay using the correct mode line height. */
13917 if (WINDOW_WANTS_MODELINE_P (w
)
13918 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
13920 fonts_changed_p
= 1;
13921 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
13922 = DESIRED_MODE_LINE_HEIGHT (w
);
13925 /* If top line height has changed, arrange for a thorough
13926 immediate redisplay using the correct mode line height. */
13927 if (WINDOW_WANTS_HEADER_LINE_P (w
)
13928 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
13930 fonts_changed_p
= 1;
13931 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
13932 = DESIRED_HEADER_LINE_HEIGHT (w
);
13935 if (fonts_changed_p
)
13936 goto need_larger_matrices
;
13939 if (!line_number_displayed
13940 && !BUFFERP (w
->base_line_pos
))
13942 w
->base_line_pos
= Qnil
;
13943 w
->base_line_number
= Qnil
;
13948 /* When we reach a frame's selected window, redo the frame's menu bar. */
13949 if (update_mode_line
13950 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
13952 int redisplay_menu_p
= 0;
13953 int redisplay_tool_bar_p
= 0;
13955 if (FRAME_WINDOW_P (f
))
13957 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
13958 || defined (HAVE_NS) || defined (USE_GTK)
13959 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
13961 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
13965 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
13967 if (redisplay_menu_p
)
13968 display_menu_bar (w
);
13970 #ifdef HAVE_WINDOW_SYSTEM
13971 if (FRAME_WINDOW_P (f
))
13973 #if defined (USE_GTK) || defined (HAVE_NS) || USE_MAC_TOOLBAR
13974 redisplay_tool_bar_p
= FRAME_EXTERNAL_TOOL_BAR (f
);
13976 redisplay_tool_bar_p
= WINDOWP (f
->tool_bar_window
)
13977 && (FRAME_TOOL_BAR_LINES (f
) > 0
13978 || !NILP (Vauto_resize_tool_bars
));
13981 if (redisplay_tool_bar_p
&& redisplay_tool_bar (f
))
13983 extern int ignore_mouse_drag_p
;
13984 ignore_mouse_drag_p
= 1;
13990 #ifdef HAVE_WINDOW_SYSTEM
13991 if (FRAME_WINDOW_P (f
)
13992 && update_window_fringes (w
, (just_this_one_p
13993 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
13994 || w
->pseudo_window_p
)))
13998 if (draw_window_fringes (w
, 1))
13999 x_draw_vertical_border (w
);
14003 #endif /* HAVE_WINDOW_SYSTEM */
14005 /* We go to this label, with fonts_changed_p nonzero,
14006 if it is necessary to try again using larger glyph matrices.
14007 We have to redeem the scroll bar even in this case,
14008 because the loop in redisplay_internal expects that. */
14009 need_larger_matrices
:
14011 finish_scroll_bars
:
14013 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
14015 /* Set the thumb's position and size. */
14016 set_vertical_scroll_bar (w
);
14018 /* Note that we actually used the scroll bar attached to this
14019 window, so it shouldn't be deleted at the end of redisplay. */
14020 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
14021 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
14024 /* Restore current_buffer and value of point in it. */
14025 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
14026 set_buffer_internal_1 (old
);
14027 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
14028 shorter. This can be caused by log truncation in *Messages*. */
14029 if (CHARPOS (lpoint
) <= ZV
)
14030 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
14032 unbind_to (count
, Qnil
);
14036 /* Build the complete desired matrix of WINDOW with a window start
14037 buffer position POS.
14039 Value is 1 if successful. It is zero if fonts were loaded during
14040 redisplay which makes re-adjusting glyph matrices necessary, and -1
14041 if point would appear in the scroll margins.
14042 (We check that only if CHECK_MARGINS is nonzero. */
14045 try_window (window
, pos
, check_margins
)
14046 Lisp_Object window
;
14047 struct text_pos pos
;
14050 struct window
*w
= XWINDOW (window
);
14052 struct glyph_row
*last_text_row
= NULL
;
14053 struct frame
*f
= XFRAME (w
->frame
);
14055 /* Make POS the new window start. */
14056 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
14058 /* Mark cursor position as unknown. No overlay arrow seen. */
14059 w
->cursor
.vpos
= -1;
14060 overlay_arrow_seen
= 0;
14062 /* Initialize iterator and info to start at POS. */
14063 start_display (&it
, w
, pos
);
14065 /* Display all lines of W. */
14066 while (it
.current_y
< it
.last_visible_y
)
14068 if (display_line (&it
))
14069 last_text_row
= it
.glyph_row
- 1;
14070 if (fonts_changed_p
)
14074 /* Don't let the cursor end in the scroll margins. */
14076 && !MINI_WINDOW_P (w
))
14078 int this_scroll_margin
;
14080 this_scroll_margin
= max (0, scroll_margin
);
14081 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14082 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
14084 if ((w
->cursor
.y
>= 0 /* not vscrolled */
14085 && w
->cursor
.y
< this_scroll_margin
14086 && CHARPOS (pos
) > BEGV
14087 && IT_CHARPOS (it
) < ZV
)
14088 /* rms: considering make_cursor_line_fully_visible_p here
14089 seems to give wrong results. We don't want to recenter
14090 when the last line is partly visible, we want to allow
14091 that case to be handled in the usual way. */
14092 || (w
->cursor
.y
+ 1) > it
.last_visible_y
)
14094 w
->cursor
.vpos
= -1;
14095 clear_glyph_matrix (w
->desired_matrix
);
14100 /* If bottom moved off end of frame, change mode line percentage. */
14101 if (XFASTINT (w
->window_end_pos
) <= 0
14102 && Z
!= IT_CHARPOS (it
))
14103 w
->update_mode_line
= Qt
;
14105 /* Set window_end_pos to the offset of the last character displayed
14106 on the window from the end of current_buffer. Set
14107 window_end_vpos to its row number. */
14110 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
14111 w
->window_end_bytepos
14112 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14114 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14116 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14117 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
14118 ->displays_text_p
);
14122 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14123 w
->window_end_pos
= make_number (Z
- ZV
);
14124 w
->window_end_vpos
= make_number (0);
14127 /* But that is not valid info until redisplay finishes. */
14128 w
->window_end_valid
= Qnil
;
14134 /************************************************************************
14135 Window redisplay reusing current matrix when buffer has not changed
14136 ************************************************************************/
14138 /* Try redisplay of window W showing an unchanged buffer with a
14139 different window start than the last time it was displayed by
14140 reusing its current matrix. Value is non-zero if successful.
14141 W->start is the new window start. */
14144 try_window_reusing_current_matrix (w
)
14147 struct frame
*f
= XFRAME (w
->frame
);
14148 struct glyph_row
*row
, *bottom_row
;
14151 struct text_pos start
, new_start
;
14152 int nrows_scrolled
, i
;
14153 struct glyph_row
*last_text_row
;
14154 struct glyph_row
*last_reused_text_row
;
14155 struct glyph_row
*start_row
;
14156 int start_vpos
, min_y
, max_y
;
14159 if (inhibit_try_window_reusing
)
14163 if (/* This function doesn't handle terminal frames. */
14164 !FRAME_WINDOW_P (f
)
14165 /* Don't try to reuse the display if windows have been split
14167 || windows_or_buffers_changed
14168 || cursor_type_changed
)
14171 /* Can't do this if region may have changed. */
14172 if ((!NILP (Vtransient_mark_mode
)
14173 && !NILP (current_buffer
->mark_active
))
14174 || !NILP (w
->region_showing
)
14175 || !NILP (Vshow_trailing_whitespace
))
14178 /* If top-line visibility has changed, give up. */
14179 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14180 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
14183 /* Give up if old or new display is scrolled vertically. We could
14184 make this function handle this, but right now it doesn't. */
14185 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14186 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
14189 /* The variable new_start now holds the new window start. The old
14190 start `start' can be determined from the current matrix. */
14191 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
14192 start
= start_row
->start
.pos
;
14193 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14195 /* Clear the desired matrix for the display below. */
14196 clear_glyph_matrix (w
->desired_matrix
);
14198 if (CHARPOS (new_start
) <= CHARPOS (start
))
14202 /* Don't use this method if the display starts with an ellipsis
14203 displayed for invisible text. It's not easy to handle that case
14204 below, and it's certainly not worth the effort since this is
14205 not a frequent case. */
14206 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
14209 IF_DEBUG (debug_method_add (w
, "twu1"));
14211 /* Display up to a row that can be reused. The variable
14212 last_text_row is set to the last row displayed that displays
14213 text. Note that it.vpos == 0 if or if not there is a
14214 header-line; it's not the same as the MATRIX_ROW_VPOS! */
14215 start_display (&it
, w
, new_start
);
14216 first_row_y
= it
.current_y
;
14217 w
->cursor
.vpos
= -1;
14218 last_text_row
= last_reused_text_row
= NULL
;
14220 while (it
.current_y
< it
.last_visible_y
14221 && !fonts_changed_p
)
14223 /* If we have reached into the characters in the START row,
14224 that means the line boundaries have changed. So we
14225 can't start copying with the row START. Maybe it will
14226 work to start copying with the following row. */
14227 while (IT_CHARPOS (it
) > CHARPOS (start
))
14229 /* Advance to the next row as the "start". */
14231 start
= start_row
->start
.pos
;
14232 /* If there are no more rows to try, or just one, give up. */
14233 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
14234 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
14235 || CHARPOS (start
) == ZV
)
14237 clear_glyph_matrix (w
->desired_matrix
);
14241 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14243 /* If we have reached alignment,
14244 we can copy the rest of the rows. */
14245 if (IT_CHARPOS (it
) == CHARPOS (start
))
14248 if (display_line (&it
))
14249 last_text_row
= it
.glyph_row
- 1;
14252 /* A value of current_y < last_visible_y means that we stopped
14253 at the previous window start, which in turn means that we
14254 have at least one reusable row. */
14255 if (it
.current_y
< it
.last_visible_y
)
14257 /* IT.vpos always starts from 0; it counts text lines. */
14258 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
14260 /* Find PT if not already found in the lines displayed. */
14261 if (w
->cursor
.vpos
< 0)
14263 int dy
= it
.current_y
- start_row
->y
;
14265 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14266 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
14268 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
14269 dy
, nrows_scrolled
);
14272 clear_glyph_matrix (w
->desired_matrix
);
14277 /* Scroll the display. Do it before the current matrix is
14278 changed. The problem here is that update has not yet
14279 run, i.e. part of the current matrix is not up to date.
14280 scroll_run_hook will clear the cursor, and use the
14281 current matrix to get the height of the row the cursor is
14283 run
.current_y
= start_row
->y
;
14284 run
.desired_y
= it
.current_y
;
14285 run
.height
= it
.last_visible_y
- it
.current_y
;
14287 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
14290 FRAME_RIF (f
)->update_window_begin_hook (w
);
14291 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14292 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14293 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14297 /* Shift current matrix down by nrows_scrolled lines. */
14298 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14299 rotate_matrix (w
->current_matrix
,
14301 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14304 /* Disable lines that must be updated. */
14305 for (i
= 0; i
< nrows_scrolled
; ++i
)
14306 (start_row
+ i
)->enabled_p
= 0;
14308 /* Re-compute Y positions. */
14309 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14310 max_y
= it
.last_visible_y
;
14311 for (row
= start_row
+ nrows_scrolled
;
14315 row
->y
= it
.current_y
;
14316 row
->visible_height
= row
->height
;
14318 if (row
->y
< min_y
)
14319 row
->visible_height
-= min_y
- row
->y
;
14320 if (row
->y
+ row
->height
> max_y
)
14321 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14322 row
->redraw_fringe_bitmaps_p
= 1;
14324 it
.current_y
+= row
->height
;
14326 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14327 last_reused_text_row
= row
;
14328 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
14332 /* Disable lines in the current matrix which are now
14333 below the window. */
14334 for (++row
; row
< bottom_row
; ++row
)
14335 row
->enabled_p
= row
->mode_line_p
= 0;
14338 /* Update window_end_pos etc.; last_reused_text_row is the last
14339 reused row from the current matrix containing text, if any.
14340 The value of last_text_row is the last displayed line
14341 containing text. */
14342 if (last_reused_text_row
)
14344 w
->window_end_bytepos
14345 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
14347 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
14349 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
14350 w
->current_matrix
));
14352 else if (last_text_row
)
14354 w
->window_end_bytepos
14355 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14357 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14359 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14363 /* This window must be completely empty. */
14364 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14365 w
->window_end_pos
= make_number (Z
- ZV
);
14366 w
->window_end_vpos
= make_number (0);
14368 w
->window_end_valid
= Qnil
;
14370 /* Update hint: don't try scrolling again in update_window. */
14371 w
->desired_matrix
->no_scrolling_p
= 1;
14374 debug_method_add (w
, "try_window_reusing_current_matrix 1");
14378 else if (CHARPOS (new_start
) > CHARPOS (start
))
14380 struct glyph_row
*pt_row
, *row
;
14381 struct glyph_row
*first_reusable_row
;
14382 struct glyph_row
*first_row_to_display
;
14384 int yb
= window_text_bottom_y (w
);
14386 /* Find the row starting at new_start, if there is one. Don't
14387 reuse a partially visible line at the end. */
14388 first_reusable_row
= start_row
;
14389 while (first_reusable_row
->enabled_p
14390 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
14391 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14392 < CHARPOS (new_start
)))
14393 ++first_reusable_row
;
14395 /* Give up if there is no row to reuse. */
14396 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
14397 || !first_reusable_row
->enabled_p
14398 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14399 != CHARPOS (new_start
)))
14402 /* We can reuse fully visible rows beginning with
14403 first_reusable_row to the end of the window. Set
14404 first_row_to_display to the first row that cannot be reused.
14405 Set pt_row to the row containing point, if there is any. */
14407 for (first_row_to_display
= first_reusable_row
;
14408 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
14409 ++first_row_to_display
)
14411 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
14412 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
14413 pt_row
= first_row_to_display
;
14416 /* Start displaying at the start of first_row_to_display. */
14417 xassert (first_row_to_display
->y
< yb
);
14418 init_to_row_start (&it
, w
, first_row_to_display
);
14420 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
14422 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
14424 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
14425 + WINDOW_HEADER_LINE_HEIGHT (w
));
14427 /* Display lines beginning with first_row_to_display in the
14428 desired matrix. Set last_text_row to the last row displayed
14429 that displays text. */
14430 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
14431 if (pt_row
== NULL
)
14432 w
->cursor
.vpos
= -1;
14433 last_text_row
= NULL
;
14434 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
14435 if (display_line (&it
))
14436 last_text_row
= it
.glyph_row
- 1;
14438 /* Give up If point isn't in a row displayed or reused. */
14439 if (w
->cursor
.vpos
< 0)
14441 clear_glyph_matrix (w
->desired_matrix
);
14445 /* If point is in a reused row, adjust y and vpos of the cursor
14449 w
->cursor
.vpos
-= nrows_scrolled
;
14450 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
14453 /* Scroll the display. */
14454 run
.current_y
= first_reusable_row
->y
;
14455 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14456 run
.height
= it
.last_visible_y
- run
.current_y
;
14457 dy
= run
.current_y
- run
.desired_y
;
14462 FRAME_RIF (f
)->update_window_begin_hook (w
);
14463 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14464 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14465 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14469 /* Adjust Y positions of reused rows. */
14470 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14471 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14472 max_y
= it
.last_visible_y
;
14473 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
14476 row
->visible_height
= row
->height
;
14477 if (row
->y
< min_y
)
14478 row
->visible_height
-= min_y
- row
->y
;
14479 if (row
->y
+ row
->height
> max_y
)
14480 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14481 row
->redraw_fringe_bitmaps_p
= 1;
14484 /* Scroll the current matrix. */
14485 xassert (nrows_scrolled
> 0);
14486 rotate_matrix (w
->current_matrix
,
14488 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14491 /* Disable rows not reused. */
14492 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
14493 row
->enabled_p
= 0;
14495 /* Point may have moved to a different line, so we cannot assume that
14496 the previous cursor position is valid; locate the correct row. */
14499 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
14500 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
14504 w
->cursor
.y
= row
->y
;
14506 if (row
< bottom_row
)
14508 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
14509 while (glyph
->charpos
< PT
)
14512 w
->cursor
.x
+= glyph
->pixel_width
;
14518 /* Adjust window end. A null value of last_text_row means that
14519 the window end is in reused rows which in turn means that
14520 only its vpos can have changed. */
14523 w
->window_end_bytepos
14524 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14526 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14528 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14533 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
14536 w
->window_end_valid
= Qnil
;
14537 w
->desired_matrix
->no_scrolling_p
= 1;
14540 debug_method_add (w
, "try_window_reusing_current_matrix 2");
14550 /************************************************************************
14551 Window redisplay reusing current matrix when buffer has changed
14552 ************************************************************************/
14554 static struct glyph_row
*find_last_unchanged_at_beg_row
P_ ((struct window
*));
14555 static struct glyph_row
*find_first_unchanged_at_end_row
P_ ((struct window
*,
14557 static struct glyph_row
*
14558 find_last_row_displaying_text
P_ ((struct glyph_matrix
*, struct it
*,
14559 struct glyph_row
*));
14562 /* Return the last row in MATRIX displaying text. If row START is
14563 non-null, start searching with that row. IT gives the dimensions
14564 of the display. Value is null if matrix is empty; otherwise it is
14565 a pointer to the row found. */
14567 static struct glyph_row
*
14568 find_last_row_displaying_text (matrix
, it
, start
)
14569 struct glyph_matrix
*matrix
;
14571 struct glyph_row
*start
;
14573 struct glyph_row
*row
, *row_found
;
14575 /* Set row_found to the last row in IT->w's current matrix
14576 displaying text. The loop looks funny but think of partially
14579 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
14580 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14582 xassert (row
->enabled_p
);
14584 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
14593 /* Return the last row in the current matrix of W that is not affected
14594 by changes at the start of current_buffer that occurred since W's
14595 current matrix was built. Value is null if no such row exists.
14597 BEG_UNCHANGED us the number of characters unchanged at the start of
14598 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
14599 first changed character in current_buffer. Characters at positions <
14600 BEG + BEG_UNCHANGED are at the same buffer positions as they were
14601 when the current matrix was built. */
14603 static struct glyph_row
*
14604 find_last_unchanged_at_beg_row (w
)
14607 int first_changed_pos
= BEG
+ BEG_UNCHANGED
;
14608 struct glyph_row
*row
;
14609 struct glyph_row
*row_found
= NULL
;
14610 int yb
= window_text_bottom_y (w
);
14612 /* Find the last row displaying unchanged text. */
14613 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14614 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
14615 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
14618 if (/* If row ends before first_changed_pos, it is unchanged,
14619 except in some case. */
14620 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
14621 /* When row ends in ZV and we write at ZV it is not
14623 && !row
->ends_at_zv_p
14624 /* When first_changed_pos is the end of a continued line,
14625 row is not unchanged because it may be no longer
14627 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
14628 && (row
->continued_p
14629 || row
->exact_window_width_line_p
)))
14632 /* Stop if last visible row. */
14633 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
14641 /* Find the first glyph row in the current matrix of W that is not
14642 affected by changes at the end of current_buffer since the
14643 time W's current matrix was built.
14645 Return in *DELTA the number of chars by which buffer positions in
14646 unchanged text at the end of current_buffer must be adjusted.
14648 Return in *DELTA_BYTES the corresponding number of bytes.
14650 Value is null if no such row exists, i.e. all rows are affected by
14653 static struct glyph_row
*
14654 find_first_unchanged_at_end_row (w
, delta
, delta_bytes
)
14656 int *delta
, *delta_bytes
;
14658 struct glyph_row
*row
;
14659 struct glyph_row
*row_found
= NULL
;
14661 *delta
= *delta_bytes
= 0;
14663 /* Display must not have been paused, otherwise the current matrix
14664 is not up to date. */
14665 eassert (!NILP (w
->window_end_valid
));
14667 /* A value of window_end_pos >= END_UNCHANGED means that the window
14668 end is in the range of changed text. If so, there is no
14669 unchanged row at the end of W's current matrix. */
14670 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
14673 /* Set row to the last row in W's current matrix displaying text. */
14674 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
14676 /* If matrix is entirely empty, no unchanged row exists. */
14677 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14679 /* The value of row is the last glyph row in the matrix having a
14680 meaningful buffer position in it. The end position of row
14681 corresponds to window_end_pos. This allows us to translate
14682 buffer positions in the current matrix to current buffer
14683 positions for characters not in changed text. */
14684 int Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
14685 int Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
14686 int last_unchanged_pos
, last_unchanged_pos_old
;
14687 struct glyph_row
*first_text_row
14688 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14690 *delta
= Z
- Z_old
;
14691 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
14693 /* Set last_unchanged_pos to the buffer position of the last
14694 character in the buffer that has not been changed. Z is the
14695 index + 1 of the last character in current_buffer, i.e. by
14696 subtracting END_UNCHANGED we get the index of the last
14697 unchanged character, and we have to add BEG to get its buffer
14699 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
14700 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
14702 /* Search backward from ROW for a row displaying a line that
14703 starts at a minimum position >= last_unchanged_pos_old. */
14704 for (; row
> first_text_row
; --row
)
14706 /* This used to abort, but it can happen.
14707 It is ok to just stop the search instead here. KFS. */
14708 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14711 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
14716 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
14722 /* Make sure that glyph rows in the current matrix of window W
14723 reference the same glyph memory as corresponding rows in the
14724 frame's frame matrix. This function is called after scrolling W's
14725 current matrix on a terminal frame in try_window_id and
14726 try_window_reusing_current_matrix. */
14729 sync_frame_with_window_matrix_rows (w
)
14732 struct frame
*f
= XFRAME (w
->frame
);
14733 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
14735 /* Preconditions: W must be a leaf window and full-width. Its frame
14736 must have a frame matrix. */
14737 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
14738 xassert (WINDOW_FULL_WIDTH_P (w
));
14739 xassert (!FRAME_WINDOW_P (f
));
14741 /* If W is a full-width window, glyph pointers in W's current matrix
14742 have, by definition, to be the same as glyph pointers in the
14743 corresponding frame matrix. Note that frame matrices have no
14744 marginal areas (see build_frame_matrix). */
14745 window_row
= w
->current_matrix
->rows
;
14746 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
14747 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
14748 while (window_row
< window_row_end
)
14750 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
14751 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
14753 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
14754 frame_row
->glyphs
[TEXT_AREA
] = start
;
14755 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
14756 frame_row
->glyphs
[LAST_AREA
] = end
;
14758 /* Disable frame rows whose corresponding window rows have
14759 been disabled in try_window_id. */
14760 if (!window_row
->enabled_p
)
14761 frame_row
->enabled_p
= 0;
14763 ++window_row
, ++frame_row
;
14768 /* Find the glyph row in window W containing CHARPOS. Consider all
14769 rows between START and END (not inclusive). END null means search
14770 all rows to the end of the display area of W. Value is the row
14771 containing CHARPOS or null. */
14774 row_containing_pos (w
, charpos
, start
, end
, dy
)
14777 struct glyph_row
*start
, *end
;
14780 struct glyph_row
*row
= start
;
14783 /* If we happen to start on a header-line, skip that. */
14784 if (row
->mode_line_p
)
14787 if ((end
&& row
>= end
) || !row
->enabled_p
)
14790 last_y
= window_text_bottom_y (w
) - dy
;
14794 /* Give up if we have gone too far. */
14795 if (end
&& row
>= end
)
14797 /* This formerly returned if they were equal.
14798 I think that both quantities are of a "last plus one" type;
14799 if so, when they are equal, the row is within the screen. -- rms. */
14800 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
14803 /* If it is in this row, return this row. */
14804 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
14805 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
14806 /* The end position of a row equals the start
14807 position of the next row. If CHARPOS is there, we
14808 would rather display it in the next line, except
14809 when this line ends in ZV. */
14810 && !row
->ends_at_zv_p
14811 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
14812 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
14819 /* Try to redisplay window W by reusing its existing display. W's
14820 current matrix must be up to date when this function is called,
14821 i.e. window_end_valid must not be nil.
14825 1 if display has been updated
14826 0 if otherwise unsuccessful
14827 -1 if redisplay with same window start is known not to succeed
14829 The following steps are performed:
14831 1. Find the last row in the current matrix of W that is not
14832 affected by changes at the start of current_buffer. If no such row
14835 2. Find the first row in W's current matrix that is not affected by
14836 changes at the end of current_buffer. Maybe there is no such row.
14838 3. Display lines beginning with the row + 1 found in step 1 to the
14839 row found in step 2 or, if step 2 didn't find a row, to the end of
14842 4. If cursor is not known to appear on the window, give up.
14844 5. If display stopped at the row found in step 2, scroll the
14845 display and current matrix as needed.
14847 6. Maybe display some lines at the end of W, if we must. This can
14848 happen under various circumstances, like a partially visible line
14849 becoming fully visible, or because newly displayed lines are displayed
14850 in smaller font sizes.
14852 7. Update W's window end information. */
14858 struct frame
*f
= XFRAME (w
->frame
);
14859 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
14860 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
14861 struct glyph_row
*last_unchanged_at_beg_row
;
14862 struct glyph_row
*first_unchanged_at_end_row
;
14863 struct glyph_row
*row
;
14864 struct glyph_row
*bottom_row
;
14867 int delta
= 0, delta_bytes
= 0, stop_pos
, dvpos
, dy
;
14868 struct text_pos start_pos
;
14870 int first_unchanged_at_end_vpos
= 0;
14871 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
14872 struct text_pos start
;
14873 int first_changed_charpos
, last_changed_charpos
;
14876 if (inhibit_try_window_id
)
14880 /* This is handy for debugging. */
14882 #define GIVE_UP(X) \
14884 fprintf (stderr, "try_window_id give up %d\n", (X)); \
14888 #define GIVE_UP(X) return 0
14891 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
14893 /* Don't use this for mini-windows because these can show
14894 messages and mini-buffers, and we don't handle that here. */
14895 if (MINI_WINDOW_P (w
))
14898 /* This flag is used to prevent redisplay optimizations. */
14899 if (windows_or_buffers_changed
|| cursor_type_changed
)
14902 /* Verify that narrowing has not changed.
14903 Also verify that we were not told to prevent redisplay optimizations.
14904 It would be nice to further
14905 reduce the number of cases where this prevents try_window_id. */
14906 if (current_buffer
->clip_changed
14907 || current_buffer
->prevent_redisplay_optimizations_p
)
14910 /* Window must either use window-based redisplay or be full width. */
14911 if (!FRAME_WINDOW_P (f
)
14912 && (!FRAME_LINE_INS_DEL_OK (f
)
14913 || !WINDOW_FULL_WIDTH_P (w
)))
14916 /* Give up if point is not known NOT to appear in W. */
14917 if (PT
< CHARPOS (start
))
14920 /* Another way to prevent redisplay optimizations. */
14921 if (XFASTINT (w
->last_modified
) == 0)
14924 /* Verify that window is not hscrolled. */
14925 if (XFASTINT (w
->hscroll
) != 0)
14928 /* Verify that display wasn't paused. */
14929 if (NILP (w
->window_end_valid
))
14932 /* Can't use this if highlighting a region because a cursor movement
14933 will do more than just set the cursor. */
14934 if (!NILP (Vtransient_mark_mode
)
14935 && !NILP (current_buffer
->mark_active
))
14938 /* Likewise if highlighting trailing whitespace. */
14939 if (!NILP (Vshow_trailing_whitespace
))
14942 /* Likewise if showing a region. */
14943 if (!NILP (w
->region_showing
))
14946 /* Can use this if overlay arrow position and or string have changed. */
14947 if (overlay_arrows_changed_p ())
14950 /* When word-wrap is on, adding a space to the first word of a
14951 wrapped line can change the wrap position, altering the line
14952 above it. It might be worthwhile to handle this more
14953 intelligently, but for now just redisplay from scratch. */
14954 if (!NILP (XBUFFER (w
->buffer
)->word_wrap
))
14957 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
14958 only if buffer has really changed. The reason is that the gap is
14959 initially at Z for freshly visited files. The code below would
14960 set end_unchanged to 0 in that case. */
14961 if (MODIFF
> SAVE_MODIFF
14962 /* This seems to happen sometimes after saving a buffer. */
14963 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
14965 if (GPT
- BEG
< BEG_UNCHANGED
)
14966 BEG_UNCHANGED
= GPT
- BEG
;
14967 if (Z
- GPT
< END_UNCHANGED
)
14968 END_UNCHANGED
= Z
- GPT
;
14971 /* The position of the first and last character that has been changed. */
14972 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
14973 last_changed_charpos
= Z
- END_UNCHANGED
;
14975 /* If window starts after a line end, and the last change is in
14976 front of that newline, then changes don't affect the display.
14977 This case happens with stealth-fontification. Note that although
14978 the display is unchanged, glyph positions in the matrix have to
14979 be adjusted, of course. */
14980 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
14981 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
14982 && ((last_changed_charpos
< CHARPOS (start
)
14983 && CHARPOS (start
) == BEGV
)
14984 || (last_changed_charpos
< CHARPOS (start
) - 1
14985 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
14987 int Z_old
, delta
, Z_BYTE_old
, delta_bytes
;
14988 struct glyph_row
*r0
;
14990 /* Compute how many chars/bytes have been added to or removed
14991 from the buffer. */
14992 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
14993 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
14995 delta_bytes
= Z_BYTE
- Z_BYTE_old
;
14997 /* Give up if PT is not in the window. Note that it already has
14998 been checked at the start of try_window_id that PT is not in
14999 front of the window start. */
15000 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + delta
)
15003 /* If window start is unchanged, we can reuse the whole matrix
15004 as is, after adjusting glyph positions. No need to compute
15005 the window end again, since its offset from Z hasn't changed. */
15006 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15007 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + delta
15008 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + delta_bytes
15009 /* PT must not be in a partially visible line. */
15010 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + delta
15011 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15013 /* Adjust positions in the glyph matrix. */
15014 if (delta
|| delta_bytes
)
15016 struct glyph_row
*r1
15017 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15018 increment_matrix_positions (w
->current_matrix
,
15019 MATRIX_ROW_VPOS (r0
, current_matrix
),
15020 MATRIX_ROW_VPOS (r1
, current_matrix
),
15021 delta
, delta_bytes
);
15024 /* Set the cursor. */
15025 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15027 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15034 /* Handle the case that changes are all below what is displayed in
15035 the window, and that PT is in the window. This shortcut cannot
15036 be taken if ZV is visible in the window, and text has been added
15037 there that is visible in the window. */
15038 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
15039 /* ZV is not visible in the window, or there are no
15040 changes at ZV, actually. */
15041 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
15042 || first_changed_charpos
== last_changed_charpos
))
15044 struct glyph_row
*r0
;
15046 /* Give up if PT is not in the window. Note that it already has
15047 been checked at the start of try_window_id that PT is not in
15048 front of the window start. */
15049 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
15052 /* If window start is unchanged, we can reuse the whole matrix
15053 as is, without changing glyph positions since no text has
15054 been added/removed in front of the window end. */
15055 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15056 if (TEXT_POS_EQUAL_P (start
, r0
->start
.pos
)
15057 /* PT must not be in a partially visible line. */
15058 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
15059 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15061 /* We have to compute the window end anew since text
15062 can have been added/removed after it. */
15064 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15065 w
->window_end_bytepos
15066 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15068 /* Set the cursor. */
15069 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15071 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15078 /* Give up if window start is in the changed area.
15080 The condition used to read
15082 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
15084 but why that was tested escapes me at the moment. */
15085 if (CHARPOS (start
) >= first_changed_charpos
15086 && CHARPOS (start
) <= last_changed_charpos
)
15089 /* Check that window start agrees with the start of the first glyph
15090 row in its current matrix. Check this after we know the window
15091 start is not in changed text, otherwise positions would not be
15093 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15094 if (!TEXT_POS_EQUAL_P (start
, row
->start
.pos
))
15097 /* Give up if the window ends in strings. Overlay strings
15098 at the end are difficult to handle, so don't try. */
15099 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
15100 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
15103 /* Compute the position at which we have to start displaying new
15104 lines. Some of the lines at the top of the window might be
15105 reusable because they are not displaying changed text. Find the
15106 last row in W's current matrix not affected by changes at the
15107 start of current_buffer. Value is null if changes start in the
15108 first line of window. */
15109 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
15110 if (last_unchanged_at_beg_row
)
15112 /* Avoid starting to display in the moddle of a character, a TAB
15113 for instance. This is easier than to set up the iterator
15114 exactly, and it's not a frequent case, so the additional
15115 effort wouldn't really pay off. */
15116 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
15117 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
15118 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
15119 --last_unchanged_at_beg_row
;
15121 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
15124 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
15126 start_pos
= it
.current
.pos
;
15128 /* Start displaying new lines in the desired matrix at the same
15129 vpos we would use in the current matrix, i.e. below
15130 last_unchanged_at_beg_row. */
15131 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
15133 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15134 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
15136 xassert (it
.hpos
== 0 && it
.current_x
== 0);
15140 /* There are no reusable lines at the start of the window.
15141 Start displaying in the first text line. */
15142 start_display (&it
, w
, start
);
15143 it
.vpos
= it
.first_vpos
;
15144 start_pos
= it
.current
.pos
;
15147 /* Find the first row that is not affected by changes at the end of
15148 the buffer. Value will be null if there is no unchanged row, in
15149 which case we must redisplay to the end of the window. delta
15150 will be set to the value by which buffer positions beginning with
15151 first_unchanged_at_end_row have to be adjusted due to text
15153 first_unchanged_at_end_row
15154 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
15155 IF_DEBUG (debug_delta
= delta
);
15156 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
15158 /* Set stop_pos to the buffer position up to which we will have to
15159 display new lines. If first_unchanged_at_end_row != NULL, this
15160 is the buffer position of the start of the line displayed in that
15161 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
15162 that we don't stop at a buffer position. */
15164 if (first_unchanged_at_end_row
)
15166 xassert (last_unchanged_at_beg_row
== NULL
15167 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
15169 /* If this is a continuation line, move forward to the next one
15170 that isn't. Changes in lines above affect this line.
15171 Caution: this may move first_unchanged_at_end_row to a row
15172 not displaying text. */
15173 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
15174 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15175 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15176 < it
.last_visible_y
))
15177 ++first_unchanged_at_end_row
;
15179 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15180 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15181 >= it
.last_visible_y
))
15182 first_unchanged_at_end_row
= NULL
;
15185 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
15187 first_unchanged_at_end_vpos
15188 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
15189 xassert (stop_pos
>= Z
- END_UNCHANGED
);
15192 else if (last_unchanged_at_beg_row
== NULL
)
15198 /* Either there is no unchanged row at the end, or the one we have
15199 now displays text. This is a necessary condition for the window
15200 end pos calculation at the end of this function. */
15201 xassert (first_unchanged_at_end_row
== NULL
15202 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
15204 debug_last_unchanged_at_beg_vpos
15205 = (last_unchanged_at_beg_row
15206 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
15208 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
15210 #endif /* GLYPH_DEBUG != 0 */
15213 /* Display new lines. Set last_text_row to the last new line
15214 displayed which has text on it, i.e. might end up as being the
15215 line where the window_end_vpos is. */
15216 w
->cursor
.vpos
= -1;
15217 last_text_row
= NULL
;
15218 overlay_arrow_seen
= 0;
15219 while (it
.current_y
< it
.last_visible_y
15220 && !fonts_changed_p
15221 && (first_unchanged_at_end_row
== NULL
15222 || IT_CHARPOS (it
) < stop_pos
))
15224 if (display_line (&it
))
15225 last_text_row
= it
.glyph_row
- 1;
15228 if (fonts_changed_p
)
15232 /* Compute differences in buffer positions, y-positions etc. for
15233 lines reused at the bottom of the window. Compute what we can
15235 if (first_unchanged_at_end_row
15236 /* No lines reused because we displayed everything up to the
15237 bottom of the window. */
15238 && it
.current_y
< it
.last_visible_y
)
15241 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
15243 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
15244 run
.current_y
= first_unchanged_at_end_row
->y
;
15245 run
.desired_y
= run
.current_y
+ dy
;
15246 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
15250 delta
= delta_bytes
= dvpos
= dy
15251 = run
.current_y
= run
.desired_y
= run
.height
= 0;
15252 first_unchanged_at_end_row
= NULL
;
15254 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
15257 /* Find the cursor if not already found. We have to decide whether
15258 PT will appear on this window (it sometimes doesn't, but this is
15259 not a very frequent case.) This decision has to be made before
15260 the current matrix is altered. A value of cursor.vpos < 0 means
15261 that PT is either in one of the lines beginning at
15262 first_unchanged_at_end_row or below the window. Don't care for
15263 lines that might be displayed later at the window end; as
15264 mentioned, this is not a frequent case. */
15265 if (w
->cursor
.vpos
< 0)
15267 /* Cursor in unchanged rows at the top? */
15268 if (PT
< CHARPOS (start_pos
)
15269 && last_unchanged_at_beg_row
)
15271 row
= row_containing_pos (w
, PT
,
15272 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
15273 last_unchanged_at_beg_row
+ 1, 0);
15275 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15278 /* Start from first_unchanged_at_end_row looking for PT. */
15279 else if (first_unchanged_at_end_row
)
15281 row
= row_containing_pos (w
, PT
- delta
,
15282 first_unchanged_at_end_row
, NULL
, 0);
15284 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
15285 delta_bytes
, dy
, dvpos
);
15288 /* Give up if cursor was not found. */
15289 if (w
->cursor
.vpos
< 0)
15291 clear_glyph_matrix (w
->desired_matrix
);
15296 /* Don't let the cursor end in the scroll margins. */
15298 int this_scroll_margin
, cursor_height
;
15300 this_scroll_margin
= max (0, scroll_margin
);
15301 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15302 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
15303 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
15305 if ((w
->cursor
.y
< this_scroll_margin
15306 && CHARPOS (start
) > BEGV
)
15307 /* Old redisplay didn't take scroll margin into account at the bottom,
15308 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
15309 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
15310 ? cursor_height
+ this_scroll_margin
15311 : 1)) > it
.last_visible_y
)
15313 w
->cursor
.vpos
= -1;
15314 clear_glyph_matrix (w
->desired_matrix
);
15319 /* Scroll the display. Do it before changing the current matrix so
15320 that xterm.c doesn't get confused about where the cursor glyph is
15322 if (dy
&& run
.height
)
15326 if (FRAME_WINDOW_P (f
))
15328 FRAME_RIF (f
)->update_window_begin_hook (w
);
15329 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15330 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15331 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15335 /* Terminal frame. In this case, dvpos gives the number of
15336 lines to scroll by; dvpos < 0 means scroll up. */
15337 int first_unchanged_at_end_vpos
15338 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
15339 int from
= WINDOW_TOP_EDGE_LINE (w
) + first_unchanged_at_end_vpos
;
15340 int end
= (WINDOW_TOP_EDGE_LINE (w
)
15341 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
15342 + window_internal_height (w
));
15344 /* Perform the operation on the screen. */
15347 /* Scroll last_unchanged_at_beg_row to the end of the
15348 window down dvpos lines. */
15349 set_terminal_window (f
, end
);
15351 /* On dumb terminals delete dvpos lines at the end
15352 before inserting dvpos empty lines. */
15353 if (!FRAME_SCROLL_REGION_OK (f
))
15354 ins_del_lines (f
, end
- dvpos
, -dvpos
);
15356 /* Insert dvpos empty lines in front of
15357 last_unchanged_at_beg_row. */
15358 ins_del_lines (f
, from
, dvpos
);
15360 else if (dvpos
< 0)
15362 /* Scroll up last_unchanged_at_beg_vpos to the end of
15363 the window to last_unchanged_at_beg_vpos - |dvpos|. */
15364 set_terminal_window (f
, end
);
15366 /* Delete dvpos lines in front of
15367 last_unchanged_at_beg_vpos. ins_del_lines will set
15368 the cursor to the given vpos and emit |dvpos| delete
15370 ins_del_lines (f
, from
+ dvpos
, dvpos
);
15372 /* On a dumb terminal insert dvpos empty lines at the
15374 if (!FRAME_SCROLL_REGION_OK (f
))
15375 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
15378 set_terminal_window (f
, 0);
15384 /* Shift reused rows of the current matrix to the right position.
15385 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
15387 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15388 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
15391 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
15392 bottom_vpos
, dvpos
);
15393 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
15396 else if (dvpos
> 0)
15398 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
15399 bottom_vpos
, dvpos
);
15400 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
15401 first_unchanged_at_end_vpos
+ dvpos
, 0);
15404 /* For frame-based redisplay, make sure that current frame and window
15405 matrix are in sync with respect to glyph memory. */
15406 if (!FRAME_WINDOW_P (f
))
15407 sync_frame_with_window_matrix_rows (w
);
15409 /* Adjust buffer positions in reused rows. */
15410 if (delta
|| delta_bytes
)
15411 increment_matrix_positions (current_matrix
,
15412 first_unchanged_at_end_vpos
+ dvpos
,
15413 bottom_vpos
, delta
, delta_bytes
);
15415 /* Adjust Y positions. */
15417 shift_glyph_matrix (w
, current_matrix
,
15418 first_unchanged_at_end_vpos
+ dvpos
,
15421 if (first_unchanged_at_end_row
)
15423 first_unchanged_at_end_row
+= dvpos
;
15424 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
15425 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
15426 first_unchanged_at_end_row
= NULL
;
15429 /* If scrolling up, there may be some lines to display at the end of
15431 last_text_row_at_end
= NULL
;
15434 /* Scrolling up can leave for example a partially visible line
15435 at the end of the window to be redisplayed. */
15436 /* Set last_row to the glyph row in the current matrix where the
15437 window end line is found. It has been moved up or down in
15438 the matrix by dvpos. */
15439 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
15440 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
15442 /* If last_row is the window end line, it should display text. */
15443 xassert (last_row
->displays_text_p
);
15445 /* If window end line was partially visible before, begin
15446 displaying at that line. Otherwise begin displaying with the
15447 line following it. */
15448 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
15450 init_to_row_start (&it
, w
, last_row
);
15451 it
.vpos
= last_vpos
;
15452 it
.current_y
= last_row
->y
;
15456 init_to_row_end (&it
, w
, last_row
);
15457 it
.vpos
= 1 + last_vpos
;
15458 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
15462 /* We may start in a continuation line. If so, we have to
15463 get the right continuation_lines_width and current_x. */
15464 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
15465 it
.hpos
= it
.current_x
= 0;
15467 /* Display the rest of the lines at the window end. */
15468 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15469 while (it
.current_y
< it
.last_visible_y
15470 && !fonts_changed_p
)
15472 /* Is it always sure that the display agrees with lines in
15473 the current matrix? I don't think so, so we mark rows
15474 displayed invalid in the current matrix by setting their
15475 enabled_p flag to zero. */
15476 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
15477 if (display_line (&it
))
15478 last_text_row_at_end
= it
.glyph_row
- 1;
15482 /* Update window_end_pos and window_end_vpos. */
15483 if (first_unchanged_at_end_row
15484 && !last_text_row_at_end
)
15486 /* Window end line if one of the preserved rows from the current
15487 matrix. Set row to the last row displaying text in current
15488 matrix starting at first_unchanged_at_end_row, after
15490 xassert (first_unchanged_at_end_row
->displays_text_p
);
15491 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
15492 first_unchanged_at_end_row
);
15493 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
15495 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15496 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15498 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
15499 xassert (w
->window_end_bytepos
>= 0);
15500 IF_DEBUG (debug_method_add (w
, "A"));
15502 else if (last_text_row_at_end
)
15505 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
15506 w
->window_end_bytepos
15507 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
15509 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
15510 xassert (w
->window_end_bytepos
>= 0);
15511 IF_DEBUG (debug_method_add (w
, "B"));
15513 else if (last_text_row
)
15515 /* We have displayed either to the end of the window or at the
15516 end of the window, i.e. the last row with text is to be found
15517 in the desired matrix. */
15519 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15520 w
->window_end_bytepos
15521 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15523 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
15524 xassert (w
->window_end_bytepos
>= 0);
15526 else if (first_unchanged_at_end_row
== NULL
15527 && last_text_row
== NULL
15528 && last_text_row_at_end
== NULL
)
15530 /* Displayed to end of window, but no line containing text was
15531 displayed. Lines were deleted at the end of the window. */
15532 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
15533 int vpos
= XFASTINT (w
->window_end_vpos
);
15534 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
15535 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
15538 row
== NULL
&& vpos
>= first_vpos
;
15539 --vpos
, --current_row
, --desired_row
)
15541 if (desired_row
->enabled_p
)
15543 if (desired_row
->displays_text_p
)
15546 else if (current_row
->displays_text_p
)
15550 xassert (row
!= NULL
);
15551 w
->window_end_vpos
= make_number (vpos
+ 1);
15552 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15553 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15554 xassert (w
->window_end_bytepos
>= 0);
15555 IF_DEBUG (debug_method_add (w
, "C"));
15560 #if 0 /* This leads to problems, for instance when the cursor is
15561 at ZV, and the cursor line displays no text. */
15562 /* Disable rows below what's displayed in the window. This makes
15563 debugging easier. */
15564 enable_glyph_matrix_rows (current_matrix
,
15565 XFASTINT (w
->window_end_vpos
) + 1,
15569 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
15570 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
15572 /* Record that display has not been completed. */
15573 w
->window_end_valid
= Qnil
;
15574 w
->desired_matrix
->no_scrolling_p
= 1;
15582 /***********************************************************************
15583 More debugging support
15584 ***********************************************************************/
15588 void dump_glyph_row
P_ ((struct glyph_row
*, int, int));
15589 void dump_glyph_matrix
P_ ((struct glyph_matrix
*, int));
15590 void dump_glyph
P_ ((struct glyph_row
*, struct glyph
*, int));
15593 /* Dump the contents of glyph matrix MATRIX on stderr.
15595 GLYPHS 0 means don't show glyph contents.
15596 GLYPHS 1 means show glyphs in short form
15597 GLYPHS > 1 means show glyphs in long form. */
15600 dump_glyph_matrix (matrix
, glyphs
)
15601 struct glyph_matrix
*matrix
;
15605 for (i
= 0; i
< matrix
->nrows
; ++i
)
15606 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
15610 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
15611 the glyph row and area where the glyph comes from. */
15614 dump_glyph (row
, glyph
, area
)
15615 struct glyph_row
*row
;
15616 struct glyph
*glyph
;
15619 if (glyph
->type
== CHAR_GLYPH
)
15622 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15623 glyph
- row
->glyphs
[TEXT_AREA
],
15626 (BUFFERP (glyph
->object
)
15628 : (STRINGP (glyph
->object
)
15631 glyph
->pixel_width
,
15633 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
15637 glyph
->left_box_line_p
,
15638 glyph
->right_box_line_p
);
15640 else if (glyph
->type
== STRETCH_GLYPH
)
15643 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15644 glyph
- row
->glyphs
[TEXT_AREA
],
15647 (BUFFERP (glyph
->object
)
15649 : (STRINGP (glyph
->object
)
15652 glyph
->pixel_width
,
15656 glyph
->left_box_line_p
,
15657 glyph
->right_box_line_p
);
15659 else if (glyph
->type
== IMAGE_GLYPH
)
15662 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15663 glyph
- row
->glyphs
[TEXT_AREA
],
15666 (BUFFERP (glyph
->object
)
15668 : (STRINGP (glyph
->object
)
15671 glyph
->pixel_width
,
15675 glyph
->left_box_line_p
,
15676 glyph
->right_box_line_p
);
15678 else if (glyph
->type
== COMPOSITE_GLYPH
)
15681 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15682 glyph
- row
->glyphs
[TEXT_AREA
],
15685 (BUFFERP (glyph
->object
)
15687 : (STRINGP (glyph
->object
)
15690 glyph
->pixel_width
,
15694 glyph
->left_box_line_p
,
15695 glyph
->right_box_line_p
);
15700 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
15701 GLYPHS 0 means don't show glyph contents.
15702 GLYPHS 1 means show glyphs in short form
15703 GLYPHS > 1 means show glyphs in long form. */
15706 dump_glyph_row (row
, vpos
, glyphs
)
15707 struct glyph_row
*row
;
15712 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
15713 fprintf (stderr
, "======================================================================\n");
15715 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d\
15716 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
15718 MATRIX_ROW_START_CHARPOS (row
),
15719 MATRIX_ROW_END_CHARPOS (row
),
15720 row
->used
[TEXT_AREA
],
15721 row
->contains_overlapping_glyphs_p
,
15723 row
->truncated_on_left_p
,
15724 row
->truncated_on_right_p
,
15726 MATRIX_ROW_CONTINUATION_LINE_P (row
),
15727 row
->displays_text_p
,
15730 row
->ends_in_middle_of_char_p
,
15731 row
->starts_in_middle_of_char_p
,
15737 row
->visible_height
,
15740 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
15741 row
->end
.overlay_string_index
,
15742 row
->continuation_lines_width
);
15743 fprintf (stderr
, "%9d %5d\n",
15744 CHARPOS (row
->start
.string_pos
),
15745 CHARPOS (row
->end
.string_pos
));
15746 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
15747 row
->end
.dpvec_index
);
15754 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
15756 struct glyph
*glyph
= row
->glyphs
[area
];
15757 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
15759 /* Glyph for a line end in text. */
15760 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
15763 if (glyph
< glyph_end
)
15764 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
15766 for (; glyph
< glyph_end
; ++glyph
)
15767 dump_glyph (row
, glyph
, area
);
15770 else if (glyphs
== 1)
15774 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
15776 char *s
= (char *) alloca (row
->used
[area
] + 1);
15779 for (i
= 0; i
< row
->used
[area
]; ++i
)
15781 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
15782 if (glyph
->type
== CHAR_GLYPH
15783 && glyph
->u
.ch
< 0x80
15784 && glyph
->u
.ch
>= ' ')
15785 s
[i
] = glyph
->u
.ch
;
15791 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
15797 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
15798 Sdump_glyph_matrix
, 0, 1, "p",
15799 doc
: /* Dump the current matrix of the selected window to stderr.
15800 Shows contents of glyph row structures. With non-nil
15801 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
15802 glyphs in short form, otherwise show glyphs in long form. */)
15804 Lisp_Object glyphs
;
15806 struct window
*w
= XWINDOW (selected_window
);
15807 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15809 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
15810 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
15811 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
15812 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
15813 fprintf (stderr
, "=============================================\n");
15814 dump_glyph_matrix (w
->current_matrix
,
15815 NILP (glyphs
) ? 0 : XINT (glyphs
));
15820 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
15821 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
15824 struct frame
*f
= XFRAME (selected_frame
);
15825 dump_glyph_matrix (f
->current_matrix
, 1);
15830 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
15831 doc
: /* Dump glyph row ROW to stderr.
15832 GLYPH 0 means don't dump glyphs.
15833 GLYPH 1 means dump glyphs in short form.
15834 GLYPH > 1 or omitted means dump glyphs in long form. */)
15836 Lisp_Object row
, glyphs
;
15838 struct glyph_matrix
*matrix
;
15841 CHECK_NUMBER (row
);
15842 matrix
= XWINDOW (selected_window
)->current_matrix
;
15844 if (vpos
>= 0 && vpos
< matrix
->nrows
)
15845 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
15847 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
15852 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
15853 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
15854 GLYPH 0 means don't dump glyphs.
15855 GLYPH 1 means dump glyphs in short form.
15856 GLYPH > 1 or omitted means dump glyphs in long form. */)
15858 Lisp_Object row
, glyphs
;
15860 struct frame
*sf
= SELECTED_FRAME ();
15861 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
15864 CHECK_NUMBER (row
);
15866 if (vpos
>= 0 && vpos
< m
->nrows
)
15867 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
15868 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
15873 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
15874 doc
: /* Toggle tracing of redisplay.
15875 With ARG, turn tracing on if and only if ARG is positive. */)
15880 trace_redisplay_p
= !trace_redisplay_p
;
15883 arg
= Fprefix_numeric_value (arg
);
15884 trace_redisplay_p
= XINT (arg
) > 0;
15891 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
15892 doc
: /* Like `format', but print result to stderr.
15893 usage: (trace-to-stderr STRING &rest OBJECTS) */)
15898 Lisp_Object s
= Fformat (nargs
, args
);
15899 fprintf (stderr
, "%s", SDATA (s
));
15903 #endif /* GLYPH_DEBUG */
15907 /***********************************************************************
15908 Building Desired Matrix Rows
15909 ***********************************************************************/
15911 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
15912 Used for non-window-redisplay windows, and for windows w/o left fringe. */
15914 static struct glyph_row
*
15915 get_overlay_arrow_glyph_row (w
, overlay_arrow_string
)
15917 Lisp_Object overlay_arrow_string
;
15919 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
15920 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15921 struct buffer
*old
= current_buffer
;
15922 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
15923 int arrow_len
= SCHARS (overlay_arrow_string
);
15924 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
15925 const unsigned char *p
;
15928 int n_glyphs_before
;
15930 set_buffer_temp (buffer
);
15931 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
15932 it
.glyph_row
->used
[TEXT_AREA
] = 0;
15933 SET_TEXT_POS (it
.position
, 0, 0);
15935 multibyte_p
= !NILP (buffer
->enable_multibyte_characters
);
15937 while (p
< arrow_end
)
15939 Lisp_Object face
, ilisp
;
15941 /* Get the next character. */
15943 it
.c
= string_char_and_length (p
, arrow_len
, &it
.len
);
15945 it
.c
= *p
, it
.len
= 1;
15948 /* Get its face. */
15949 ilisp
= make_number (p
- arrow_string
);
15950 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
15951 it
.face_id
= compute_char_face (f
, it
.c
, face
);
15953 /* Compute its width, get its glyphs. */
15954 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
15955 SET_TEXT_POS (it
.position
, -1, -1);
15956 PRODUCE_GLYPHS (&it
);
15958 /* If this character doesn't fit any more in the line, we have
15959 to remove some glyphs. */
15960 if (it
.current_x
> it
.last_visible_x
)
15962 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
15967 set_buffer_temp (old
);
15968 return it
.glyph_row
;
15972 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
15973 glyphs are only inserted for terminal frames since we can't really
15974 win with truncation glyphs when partially visible glyphs are
15975 involved. Which glyphs to insert is determined by
15976 produce_special_glyphs. */
15979 insert_left_trunc_glyphs (it
)
15982 struct it truncate_it
;
15983 struct glyph
*from
, *end
, *to
, *toend
;
15985 xassert (!FRAME_WINDOW_P (it
->f
));
15987 /* Get the truncation glyphs. */
15989 truncate_it
.current_x
= 0;
15990 truncate_it
.face_id
= DEFAULT_FACE_ID
;
15991 truncate_it
.glyph_row
= &scratch_glyph_row
;
15992 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
15993 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
15994 truncate_it
.object
= make_number (0);
15995 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
15997 /* Overwrite glyphs from IT with truncation glyphs. */
15998 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
15999 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
16000 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16001 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
16006 /* There may be padding glyphs left over. Overwrite them too. */
16007 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
16009 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16015 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
16019 /* Compute the pixel height and width of IT->glyph_row.
16021 Most of the time, ascent and height of a display line will be equal
16022 to the max_ascent and max_height values of the display iterator
16023 structure. This is not the case if
16025 1. We hit ZV without displaying anything. In this case, max_ascent
16026 and max_height will be zero.
16028 2. We have some glyphs that don't contribute to the line height.
16029 (The glyph row flag contributes_to_line_height_p is for future
16030 pixmap extensions).
16032 The first case is easily covered by using default values because in
16033 these cases, the line height does not really matter, except that it
16034 must not be zero. */
16037 compute_line_metrics (it
)
16040 struct glyph_row
*row
= it
->glyph_row
;
16043 if (FRAME_WINDOW_P (it
->f
))
16045 int i
, min_y
, max_y
;
16047 /* The line may consist of one space only, that was added to
16048 place the cursor on it. If so, the row's height hasn't been
16050 if (row
->height
== 0)
16052 if (it
->max_ascent
+ it
->max_descent
== 0)
16053 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
16054 row
->ascent
= it
->max_ascent
;
16055 row
->height
= it
->max_ascent
+ it
->max_descent
;
16056 row
->phys_ascent
= it
->max_phys_ascent
;
16057 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16058 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
16061 /* Compute the width of this line. */
16062 row
->pixel_width
= row
->x
;
16063 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
16064 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
16066 xassert (row
->pixel_width
>= 0);
16067 xassert (row
->ascent
>= 0 && row
->height
> 0);
16069 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
16070 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
16072 /* If first line's physical ascent is larger than its logical
16073 ascent, use the physical ascent, and make the row taller.
16074 This makes accented characters fully visible. */
16075 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
16076 && row
->phys_ascent
> row
->ascent
)
16078 row
->height
+= row
->phys_ascent
- row
->ascent
;
16079 row
->ascent
= row
->phys_ascent
;
16082 /* Compute how much of the line is visible. */
16083 row
->visible_height
= row
->height
;
16085 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
16086 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
16088 if (row
->y
< min_y
)
16089 row
->visible_height
-= min_y
- row
->y
;
16090 if (row
->y
+ row
->height
> max_y
)
16091 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16095 row
->pixel_width
= row
->used
[TEXT_AREA
];
16096 if (row
->continued_p
)
16097 row
->pixel_width
-= it
->continuation_pixel_width
;
16098 else if (row
->truncated_on_right_p
)
16099 row
->pixel_width
-= it
->truncation_pixel_width
;
16100 row
->ascent
= row
->phys_ascent
= 0;
16101 row
->height
= row
->phys_height
= row
->visible_height
= 1;
16102 row
->extra_line_spacing
= 0;
16105 /* Compute a hash code for this row. */
16107 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16108 for (i
= 0; i
< row
->used
[area
]; ++i
)
16109 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
16110 + row
->glyphs
[area
][i
].u
.val
16111 + row
->glyphs
[area
][i
].face_id
16112 + row
->glyphs
[area
][i
].padding_p
16113 + (row
->glyphs
[area
][i
].type
<< 2));
16115 it
->max_ascent
= it
->max_descent
= 0;
16116 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
16120 /* Append one space to the glyph row of iterator IT if doing a
16121 window-based redisplay. The space has the same face as
16122 IT->face_id. Value is non-zero if a space was added.
16124 This function is called to make sure that there is always one glyph
16125 at the end of a glyph row that the cursor can be set on under
16126 window-systems. (If there weren't such a glyph we would not know
16127 how wide and tall a box cursor should be displayed).
16129 At the same time this space let's a nicely handle clearing to the
16130 end of the line if the row ends in italic text. */
16133 append_space_for_newline (it
, default_face_p
)
16135 int default_face_p
;
16137 if (FRAME_WINDOW_P (it
->f
))
16139 int n
= it
->glyph_row
->used
[TEXT_AREA
];
16141 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
16142 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
16144 /* Save some values that must not be changed.
16145 Must save IT->c and IT->len because otherwise
16146 ITERATOR_AT_END_P wouldn't work anymore after
16147 append_space_for_newline has been called. */
16148 enum display_element_type saved_what
= it
->what
;
16149 int saved_c
= it
->c
, saved_len
= it
->len
;
16150 int saved_x
= it
->current_x
;
16151 int saved_face_id
= it
->face_id
;
16152 struct text_pos saved_pos
;
16153 Lisp_Object saved_object
;
16156 saved_object
= it
->object
;
16157 saved_pos
= it
->position
;
16159 it
->what
= IT_CHARACTER
;
16160 bzero (&it
->position
, sizeof it
->position
);
16161 it
->object
= make_number (0);
16165 if (default_face_p
)
16166 it
->face_id
= DEFAULT_FACE_ID
;
16167 else if (it
->face_before_selective_p
)
16168 it
->face_id
= it
->saved_face_id
;
16169 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
16170 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
16172 PRODUCE_GLYPHS (it
);
16174 it
->override_ascent
= -1;
16175 it
->constrain_row_ascent_descent_p
= 0;
16176 it
->current_x
= saved_x
;
16177 it
->object
= saved_object
;
16178 it
->position
= saved_pos
;
16179 it
->what
= saved_what
;
16180 it
->face_id
= saved_face_id
;
16181 it
->len
= saved_len
;
16191 /* Extend the face of the last glyph in the text area of IT->glyph_row
16192 to the end of the display line. Called from display_line.
16193 If the glyph row is empty, add a space glyph to it so that we
16194 know the face to draw. Set the glyph row flag fill_line_p. */
16197 extend_face_to_end_of_line (it
)
16201 struct frame
*f
= it
->f
;
16203 /* If line is already filled, do nothing. */
16204 if (it
->current_x
>= it
->last_visible_x
)
16207 /* Face extension extends the background and box of IT->face_id
16208 to the end of the line. If the background equals the background
16209 of the frame, we don't have to do anything. */
16210 if (it
->face_before_selective_p
)
16211 face
= FACE_FROM_ID (it
->f
, it
->saved_face_id
);
16213 face
= FACE_FROM_ID (f
, it
->face_id
);
16215 if (FRAME_WINDOW_P (f
)
16216 && it
->glyph_row
->displays_text_p
16217 && face
->box
== FACE_NO_BOX
16218 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
16222 /* Set the glyph row flag indicating that the face of the last glyph
16223 in the text area has to be drawn to the end of the text area. */
16224 it
->glyph_row
->fill_line_p
= 1;
16226 /* If current character of IT is not ASCII, make sure we have the
16227 ASCII face. This will be automatically undone the next time
16228 get_next_display_element returns a multibyte character. Note
16229 that the character will always be single byte in unibyte text. */
16230 if (!ASCII_CHAR_P (it
->c
))
16232 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
16235 if (FRAME_WINDOW_P (f
))
16237 /* If the row is empty, add a space with the current face of IT,
16238 so that we know which face to draw. */
16239 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
16241 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
16242 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
16243 it
->glyph_row
->used
[TEXT_AREA
] = 1;
16248 /* Save some values that must not be changed. */
16249 int saved_x
= it
->current_x
;
16250 struct text_pos saved_pos
;
16251 Lisp_Object saved_object
;
16252 enum display_element_type saved_what
= it
->what
;
16253 int saved_face_id
= it
->face_id
;
16255 saved_object
= it
->object
;
16256 saved_pos
= it
->position
;
16258 it
->what
= IT_CHARACTER
;
16259 bzero (&it
->position
, sizeof it
->position
);
16260 it
->object
= make_number (0);
16263 it
->face_id
= face
->id
;
16265 PRODUCE_GLYPHS (it
);
16267 while (it
->current_x
<= it
->last_visible_x
)
16268 PRODUCE_GLYPHS (it
);
16270 /* Don't count these blanks really. It would let us insert a left
16271 truncation glyph below and make us set the cursor on them, maybe. */
16272 it
->current_x
= saved_x
;
16273 it
->object
= saved_object
;
16274 it
->position
= saved_pos
;
16275 it
->what
= saved_what
;
16276 it
->face_id
= saved_face_id
;
16281 /* Value is non-zero if text starting at CHARPOS in current_buffer is
16282 trailing whitespace. */
16285 trailing_whitespace_p (charpos
)
16288 int bytepos
= CHAR_TO_BYTE (charpos
);
16291 while (bytepos
< ZV_BYTE
16292 && (c
= FETCH_CHAR (bytepos
),
16293 c
== ' ' || c
== '\t'))
16296 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
16298 if (bytepos
!= PT_BYTE
)
16305 /* Highlight trailing whitespace, if any, in ROW. */
16308 highlight_trailing_whitespace (f
, row
)
16310 struct glyph_row
*row
;
16312 int used
= row
->used
[TEXT_AREA
];
16316 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
16317 struct glyph
*glyph
= start
+ used
- 1;
16319 /* Skip over glyphs inserted to display the cursor at the
16320 end of a line, for extending the face of the last glyph
16321 to the end of the line on terminals, and for truncation
16322 and continuation glyphs. */
16323 while (glyph
>= start
16324 && glyph
->type
== CHAR_GLYPH
16325 && INTEGERP (glyph
->object
))
16328 /* If last glyph is a space or stretch, and it's trailing
16329 whitespace, set the face of all trailing whitespace glyphs in
16330 IT->glyph_row to `trailing-whitespace'. */
16332 && BUFFERP (glyph
->object
)
16333 && (glyph
->type
== STRETCH_GLYPH
16334 || (glyph
->type
== CHAR_GLYPH
16335 && glyph
->u
.ch
== ' '))
16336 && trailing_whitespace_p (glyph
->charpos
))
16338 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
16342 while (glyph
>= start
16343 && BUFFERP (glyph
->object
)
16344 && (glyph
->type
== STRETCH_GLYPH
16345 || (glyph
->type
== CHAR_GLYPH
16346 && glyph
->u
.ch
== ' ')))
16347 (glyph
--)->face_id
= face_id
;
16353 /* Value is non-zero if glyph row ROW in window W should be
16354 used to hold the cursor. */
16357 cursor_row_p (w
, row
)
16359 struct glyph_row
*row
;
16361 int cursor_row_p
= 1;
16363 if (PT
== MATRIX_ROW_END_CHARPOS (row
))
16365 /* Suppose the row ends on a string.
16366 Unless the row is continued, that means it ends on a newline
16367 in the string. If it's anything other than a display string
16368 (e.g. a before-string from an overlay), we don't want the
16369 cursor there. (This heuristic seems to give the optimal
16370 behavior for the various types of multi-line strings.) */
16371 if (CHARPOS (row
->end
.string_pos
) >= 0)
16373 if (row
->continued_p
)
16377 /* Check for `display' property. */
16378 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
16379 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
16380 struct glyph
*glyph
;
16383 for (glyph
= end
; glyph
>= beg
; --glyph
)
16384 if (STRINGP (glyph
->object
))
16387 = Fget_char_property (make_number (PT
),
16391 && display_prop_string_p (prop
, glyph
->object
));
16396 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
16398 /* If the row ends in middle of a real character,
16399 and the line is continued, we want the cursor here.
16400 That's because MATRIX_ROW_END_CHARPOS would equal
16401 PT if PT is before the character. */
16402 if (!row
->ends_in_ellipsis_p
)
16403 cursor_row_p
= row
->continued_p
;
16405 /* If the row ends in an ellipsis, then
16406 MATRIX_ROW_END_CHARPOS will equal point after the invisible text.
16407 We want that position to be displayed after the ellipsis. */
16410 /* If the row ends at ZV, display the cursor at the end of that
16411 row instead of at the start of the row below. */
16412 else if (row
->ends_at_zv_p
)
16418 return cursor_row_p
;
16423 /* Push the display property PROP so that it will be rendered at the
16424 current position in IT. */
16427 push_display_prop (struct it
*it
, Lisp_Object prop
)
16431 /* Never display a cursor on the prefix. */
16432 it
->avoid_cursor_p
= 1;
16434 if (STRINGP (prop
))
16436 if (SCHARS (prop
) == 0)
16443 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
16444 it
->current
.overlay_string_index
= -1;
16445 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
16446 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
16447 it
->method
= GET_FROM_STRING
;
16448 it
->stop_charpos
= 0;
16450 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
16452 it
->method
= GET_FROM_STRETCH
;
16455 #ifdef HAVE_WINDOW_SYSTEM
16456 else if (IMAGEP (prop
))
16458 it
->what
= IT_IMAGE
;
16459 it
->image_id
= lookup_image (it
->f
, prop
);
16460 it
->method
= GET_FROM_IMAGE
;
16462 #endif /* HAVE_WINDOW_SYSTEM */
16465 pop_it (it
); /* bogus display property, give up */
16470 /* Return the character-property PROP at the current position in IT. */
16473 get_it_property (it
, prop
)
16477 Lisp_Object position
;
16479 if (STRINGP (it
->object
))
16480 position
= make_number (IT_STRING_CHARPOS (*it
));
16481 else if (BUFFERP (it
->object
))
16482 position
= make_number (IT_CHARPOS (*it
));
16486 return Fget_char_property (position
, prop
, it
->object
);
16489 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
16492 handle_line_prefix (struct it
*it
)
16494 Lisp_Object prefix
;
16495 if (it
->continuation_lines_width
> 0)
16497 prefix
= get_it_property (it
, Qwrap_prefix
);
16499 prefix
= Vwrap_prefix
;
16503 prefix
= get_it_property (it
, Qline_prefix
);
16505 prefix
= Vline_prefix
;
16507 if (! NILP (prefix
))
16508 push_display_prop (it
, prefix
);
16513 /* Construct the glyph row IT->glyph_row in the desired matrix of
16514 IT->w from text at the current position of IT. See dispextern.h
16515 for an overview of struct it. Value is non-zero if
16516 IT->glyph_row displays text, as opposed to a line displaying ZV
16523 struct glyph_row
*row
= it
->glyph_row
;
16524 Lisp_Object overlay_arrow_string
;
16526 int may_wrap
= 0, wrap_x
;
16527 int wrap_row_used
= -1, wrap_row_ascent
, wrap_row_height
;
16528 int wrap_row_phys_ascent
, wrap_row_phys_height
;
16529 int wrap_row_extra_line_spacing
;
16531 /* We always start displaying at hpos zero even if hscrolled. */
16532 xassert (it
->hpos
== 0 && it
->current_x
== 0);
16534 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
16535 >= it
->w
->desired_matrix
->nrows
)
16537 it
->w
->nrows_scale_factor
++;
16538 fonts_changed_p
= 1;
16542 /* Is IT->w showing the region? */
16543 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
16545 /* Clear the result glyph row and enable it. */
16546 prepare_desired_row (row
);
16548 row
->y
= it
->current_y
;
16549 row
->start
= it
->start
;
16550 row
->continuation_lines_width
= it
->continuation_lines_width
;
16551 row
->displays_text_p
= 1;
16552 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
16553 it
->starts_in_middle_of_char_p
= 0;
16555 /* Arrange the overlays nicely for our purposes. Usually, we call
16556 display_line on only one line at a time, in which case this
16557 can't really hurt too much, or we call it on lines which appear
16558 one after another in the buffer, in which case all calls to
16559 recenter_overlay_lists but the first will be pretty cheap. */
16560 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
16562 /* Move over display elements that are not visible because we are
16563 hscrolled. This may stop at an x-position < IT->first_visible_x
16564 if the first glyph is partially visible or if we hit a line end. */
16565 if (it
->current_x
< it
->first_visible_x
)
16567 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
16568 MOVE_TO_POS
| MOVE_TO_X
);
16572 /* We only do this when not calling `move_it_in_display_line_to'
16573 above, because move_it_in_display_line_to calls
16574 handle_line_prefix itself. */
16575 handle_line_prefix (it
);
16578 /* Get the initial row height. This is either the height of the
16579 text hscrolled, if there is any, or zero. */
16580 row
->ascent
= it
->max_ascent
;
16581 row
->height
= it
->max_ascent
+ it
->max_descent
;
16582 row
->phys_ascent
= it
->max_phys_ascent
;
16583 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16584 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
16586 /* Loop generating characters. The loop is left with IT on the next
16587 character to display. */
16590 int n_glyphs_before
, hpos_before
, x_before
;
16592 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
16594 /* Retrieve the next thing to display. Value is zero if end of
16596 if (!get_next_display_element (it
))
16598 /* Maybe add a space at the end of this line that is used to
16599 display the cursor there under X. Set the charpos of the
16600 first glyph of blank lines not corresponding to any text
16602 #ifdef HAVE_WINDOW_SYSTEM
16603 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16604 row
->exact_window_width_line_p
= 1;
16606 #endif /* HAVE_WINDOW_SYSTEM */
16607 if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
16608 || row
->used
[TEXT_AREA
] == 0)
16610 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
16611 row
->displays_text_p
= 0;
16613 if (!NILP (XBUFFER (it
->w
->buffer
)->indicate_empty_lines
)
16614 && (!MINI_WINDOW_P (it
->w
)
16615 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
16616 row
->indicate_empty_line_p
= 1;
16619 it
->continuation_lines_width
= 0;
16620 row
->ends_at_zv_p
= 1;
16624 /* Now, get the metrics of what we want to display. This also
16625 generates glyphs in `row' (which is IT->glyph_row). */
16626 n_glyphs_before
= row
->used
[TEXT_AREA
];
16629 /* Remember the line height so far in case the next element doesn't
16630 fit on the line. */
16631 if (it
->line_wrap
!= TRUNCATE
)
16633 ascent
= it
->max_ascent
;
16634 descent
= it
->max_descent
;
16635 phys_ascent
= it
->max_phys_ascent
;
16636 phys_descent
= it
->max_phys_descent
;
16638 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
16640 if (IT_DISPLAYING_WHITESPACE (it
))
16646 wrap_row_used
= row
->used
[TEXT_AREA
];
16647 wrap_row_ascent
= row
->ascent
;
16648 wrap_row_height
= row
->height
;
16649 wrap_row_phys_ascent
= row
->phys_ascent
;
16650 wrap_row_phys_height
= row
->phys_height
;
16651 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
16657 PRODUCE_GLYPHS (it
);
16659 /* If this display element was in marginal areas, continue with
16661 if (it
->area
!= TEXT_AREA
)
16663 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
16664 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
16665 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
16666 row
->phys_height
= max (row
->phys_height
,
16667 it
->max_phys_ascent
+ it
->max_phys_descent
);
16668 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
16669 it
->max_extra_line_spacing
);
16670 set_iterator_to_next (it
, 1);
16674 /* Does the display element fit on the line? If we truncate
16675 lines, we should draw past the right edge of the window. If
16676 we don't truncate, we want to stop so that we can display the
16677 continuation glyph before the right margin. If lines are
16678 continued, there are two possible strategies for characters
16679 resulting in more than 1 glyph (e.g. tabs): Display as many
16680 glyphs as possible in this line and leave the rest for the
16681 continuation line, or display the whole element in the next
16682 line. Original redisplay did the former, so we do it also. */
16683 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
16684 hpos_before
= it
->hpos
;
16687 if (/* Not a newline. */
16689 /* Glyphs produced fit entirely in the line. */
16690 && it
->current_x
< it
->last_visible_x
)
16692 it
->hpos
+= nglyphs
;
16693 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
16694 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
16695 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
16696 row
->phys_height
= max (row
->phys_height
,
16697 it
->max_phys_ascent
+ it
->max_phys_descent
);
16698 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
16699 it
->max_extra_line_spacing
);
16700 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
16701 row
->x
= x
- it
->first_visible_x
;
16706 struct glyph
*glyph
;
16708 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
16710 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
16711 new_x
= x
+ glyph
->pixel_width
;
16713 if (/* Lines are continued. */
16714 it
->line_wrap
!= TRUNCATE
16715 && (/* Glyph doesn't fit on the line. */
16716 new_x
> it
->last_visible_x
16717 /* Or it fits exactly on a window system frame. */
16718 || (new_x
== it
->last_visible_x
16719 && FRAME_WINDOW_P (it
->f
))))
16721 /* End of a continued line. */
16724 || (new_x
== it
->last_visible_x
16725 && FRAME_WINDOW_P (it
->f
)))
16727 /* Current glyph is the only one on the line or
16728 fits exactly on the line. We must continue
16729 the line because we can't draw the cursor
16730 after the glyph. */
16731 row
->continued_p
= 1;
16732 it
->current_x
= new_x
;
16733 it
->continuation_lines_width
+= new_x
;
16735 if (i
== nglyphs
- 1)
16737 /* If line-wrap is on, check if a previous
16738 wrap point was found. */
16739 if (wrap_row_used
> 0
16740 /* Even if there is a previous wrap
16741 point, continue the line here as
16742 usual, if (i) the previous character
16743 was a space or tab AND (ii) the
16744 current character is not. */
16746 || IT_DISPLAYING_WHITESPACE (it
)))
16749 set_iterator_to_next (it
, 1);
16750 #ifdef HAVE_WINDOW_SYSTEM
16751 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16753 if (!get_next_display_element (it
))
16755 row
->exact_window_width_line_p
= 1;
16756 it
->continuation_lines_width
= 0;
16757 row
->continued_p
= 0;
16758 row
->ends_at_zv_p
= 1;
16760 else if (ITERATOR_AT_END_OF_LINE_P (it
))
16762 row
->continued_p
= 0;
16763 row
->exact_window_width_line_p
= 1;
16766 #endif /* HAVE_WINDOW_SYSTEM */
16769 else if (CHAR_GLYPH_PADDING_P (*glyph
)
16770 && !FRAME_WINDOW_P (it
->f
))
16772 /* A padding glyph that doesn't fit on this line.
16773 This means the whole character doesn't fit
16775 row
->used
[TEXT_AREA
] = n_glyphs_before
;
16777 /* Fill the rest of the row with continuation
16778 glyphs like in 20.x. */
16779 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
16780 < row
->glyphs
[1 + TEXT_AREA
])
16781 produce_special_glyphs (it
, IT_CONTINUATION
);
16783 row
->continued_p
= 1;
16784 it
->current_x
= x_before
;
16785 it
->continuation_lines_width
+= x_before
;
16787 /* Restore the height to what it was before the
16788 element not fitting on the line. */
16789 it
->max_ascent
= ascent
;
16790 it
->max_descent
= descent
;
16791 it
->max_phys_ascent
= phys_ascent
;
16792 it
->max_phys_descent
= phys_descent
;
16794 else if (wrap_row_used
> 0)
16798 it
->continuation_lines_width
+= wrap_x
;
16799 row
->used
[TEXT_AREA
] = wrap_row_used
;
16800 row
->ascent
= wrap_row_ascent
;
16801 row
->height
= wrap_row_height
;
16802 row
->phys_ascent
= wrap_row_phys_ascent
;
16803 row
->phys_height
= wrap_row_phys_height
;
16804 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
16805 row
->continued_p
= 1;
16806 row
->ends_at_zv_p
= 0;
16807 row
->exact_window_width_line_p
= 0;
16808 it
->continuation_lines_width
+= x
;
16810 /* Make sure that a non-default face is extended
16811 up to the right margin of the window. */
16812 extend_face_to_end_of_line (it
);
16814 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
16816 /* A TAB that extends past the right edge of the
16817 window. This produces a single glyph on
16818 window system frames. We leave the glyph in
16819 this row and let it fill the row, but don't
16820 consume the TAB. */
16821 it
->continuation_lines_width
+= it
->last_visible_x
;
16822 row
->ends_in_middle_of_char_p
= 1;
16823 row
->continued_p
= 1;
16824 glyph
->pixel_width
= it
->last_visible_x
- x
;
16825 it
->starts_in_middle_of_char_p
= 1;
16829 /* Something other than a TAB that draws past
16830 the right edge of the window. Restore
16831 positions to values before the element. */
16832 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
16834 /* Display continuation glyphs. */
16835 if (!FRAME_WINDOW_P (it
->f
))
16836 produce_special_glyphs (it
, IT_CONTINUATION
);
16837 row
->continued_p
= 1;
16839 it
->current_x
= x_before
;
16840 it
->continuation_lines_width
+= x
;
16841 extend_face_to_end_of_line (it
);
16843 if (nglyphs
> 1 && i
> 0)
16845 row
->ends_in_middle_of_char_p
= 1;
16846 it
->starts_in_middle_of_char_p
= 1;
16849 /* Restore the height to what it was before the
16850 element not fitting on the line. */
16851 it
->max_ascent
= ascent
;
16852 it
->max_descent
= descent
;
16853 it
->max_phys_ascent
= phys_ascent
;
16854 it
->max_phys_descent
= phys_descent
;
16859 else if (new_x
> it
->first_visible_x
)
16861 /* Increment number of glyphs actually displayed. */
16864 if (x
< it
->first_visible_x
)
16865 /* Glyph is partially visible, i.e. row starts at
16866 negative X position. */
16867 row
->x
= x
- it
->first_visible_x
;
16871 /* Glyph is completely off the left margin of the
16872 window. This should not happen because of the
16873 move_it_in_display_line at the start of this
16874 function, unless the text display area of the
16875 window is empty. */
16876 xassert (it
->first_visible_x
<= it
->last_visible_x
);
16880 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
16881 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
16882 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
16883 row
->phys_height
= max (row
->phys_height
,
16884 it
->max_phys_ascent
+ it
->max_phys_descent
);
16885 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
16886 it
->max_extra_line_spacing
);
16888 /* End of this display line if row is continued. */
16889 if (row
->continued_p
|| row
->ends_at_zv_p
)
16894 /* Is this a line end? If yes, we're also done, after making
16895 sure that a non-default face is extended up to the right
16896 margin of the window. */
16897 if (ITERATOR_AT_END_OF_LINE_P (it
))
16899 int used_before
= row
->used
[TEXT_AREA
];
16901 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
16903 #ifdef HAVE_WINDOW_SYSTEM
16904 /* Add a space at the end of the line that is used to
16905 display the cursor there. */
16906 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16907 append_space_for_newline (it
, 0);
16908 #endif /* HAVE_WINDOW_SYSTEM */
16910 /* Extend the face to the end of the line. */
16911 extend_face_to_end_of_line (it
);
16913 /* Make sure we have the position. */
16914 if (used_before
== 0)
16915 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
16917 /* Consume the line end. This skips over invisible lines. */
16918 set_iterator_to_next (it
, 1);
16919 it
->continuation_lines_width
= 0;
16923 /* Proceed with next display element. Note that this skips
16924 over lines invisible because of selective display. */
16925 set_iterator_to_next (it
, 1);
16927 /* If we truncate lines, we are done when the last displayed
16928 glyphs reach past the right margin of the window. */
16929 if (it
->line_wrap
== TRUNCATE
16930 && (FRAME_WINDOW_P (it
->f
)
16931 ? (it
->current_x
>= it
->last_visible_x
)
16932 : (it
->current_x
> it
->last_visible_x
)))
16934 /* Maybe add truncation glyphs. */
16935 if (!FRAME_WINDOW_P (it
->f
))
16939 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
16940 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
16943 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
16945 row
->used
[TEXT_AREA
] = i
;
16946 produce_special_glyphs (it
, IT_TRUNCATION
);
16949 #ifdef HAVE_WINDOW_SYSTEM
16952 /* Don't truncate if we can overflow newline into fringe. */
16953 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16955 if (!get_next_display_element (it
))
16957 it
->continuation_lines_width
= 0;
16958 row
->ends_at_zv_p
= 1;
16959 row
->exact_window_width_line_p
= 1;
16962 if (ITERATOR_AT_END_OF_LINE_P (it
))
16964 row
->exact_window_width_line_p
= 1;
16965 goto at_end_of_line
;
16969 #endif /* HAVE_WINDOW_SYSTEM */
16971 row
->truncated_on_right_p
= 1;
16972 it
->continuation_lines_width
= 0;
16973 reseat_at_next_visible_line_start (it
, 0);
16974 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
16975 it
->hpos
= hpos_before
;
16976 it
->current_x
= x_before
;
16981 /* If line is not empty and hscrolled, maybe insert truncation glyphs
16982 at the left window margin. */
16983 if (it
->first_visible_x
16984 && IT_CHARPOS (*it
) != MATRIX_ROW_START_CHARPOS (row
))
16986 if (!FRAME_WINDOW_P (it
->f
))
16987 insert_left_trunc_glyphs (it
);
16988 row
->truncated_on_left_p
= 1;
16991 /* If the start of this line is the overlay arrow-position, then
16992 mark this glyph row as the one containing the overlay arrow.
16993 This is clearly a mess with variable size fonts. It would be
16994 better to let it be displayed like cursors under X. */
16995 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
16996 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
16997 !NILP (overlay_arrow_string
)))
16999 /* Overlay arrow in window redisplay is a fringe bitmap. */
17000 if (STRINGP (overlay_arrow_string
))
17002 struct glyph_row
*arrow_row
17003 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
17004 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
17005 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
17006 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
17007 struct glyph
*p2
, *end
;
17009 /* Copy the arrow glyphs. */
17010 while (glyph
< arrow_end
)
17013 /* Throw away padding glyphs. */
17015 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17016 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
17022 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
17027 xassert (INTEGERP (overlay_arrow_string
));
17028 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
17030 overlay_arrow_seen
= 1;
17033 /* Compute pixel dimensions of this line. */
17034 compute_line_metrics (it
);
17036 /* Remember the position at which this line ends. */
17037 row
->end
= it
->current
;
17039 /* Record whether this row ends inside an ellipsis. */
17040 row
->ends_in_ellipsis_p
17041 = (it
->method
== GET_FROM_DISPLAY_VECTOR
17042 && it
->ellipsis_p
);
17044 /* Save fringe bitmaps in this row. */
17045 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
17046 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
17047 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
17048 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
17050 it
->left_user_fringe_bitmap
= 0;
17051 it
->left_user_fringe_face_id
= 0;
17052 it
->right_user_fringe_bitmap
= 0;
17053 it
->right_user_fringe_face_id
= 0;
17055 /* Maybe set the cursor. */
17056 if (it
->w
->cursor
.vpos
< 0
17057 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
17058 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
17059 && cursor_row_p (it
->w
, row
))
17060 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
17062 /* Highlight trailing whitespace. */
17063 if (!NILP (Vshow_trailing_whitespace
))
17064 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
17066 /* Prepare for the next line. This line starts horizontally at (X
17067 HPOS) = (0 0). Vertical positions are incremented. As a
17068 convenience for the caller, IT->glyph_row is set to the next
17070 it
->current_x
= it
->hpos
= 0;
17071 it
->current_y
+= row
->height
;
17074 it
->start
= it
->current
;
17075 return row
->displays_text_p
;
17080 /***********************************************************************
17082 ***********************************************************************/
17084 /* Redisplay the menu bar in the frame for window W.
17086 The menu bar of X frames that don't have X toolkit support is
17087 displayed in a special window W->frame->menu_bar_window.
17089 The menu bar of terminal frames is treated specially as far as
17090 glyph matrices are concerned. Menu bar lines are not part of
17091 windows, so the update is done directly on the frame matrix rows
17092 for the menu bar. */
17095 display_menu_bar (w
)
17098 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
17103 /* Don't do all this for graphical frames. */
17105 if (FRAME_W32_P (f
))
17108 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
17114 if (FRAME_NS_P (f
))
17116 #endif /* HAVE_NS */
17118 #ifdef USE_X_TOOLKIT
17119 xassert (!FRAME_WINDOW_P (f
));
17120 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
17121 it
.first_visible_x
= 0;
17122 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
17123 #else /* not USE_X_TOOLKIT */
17124 if (FRAME_WINDOW_P (f
))
17126 /* Menu bar lines are displayed in the desired matrix of the
17127 dummy window menu_bar_window. */
17128 struct window
*menu_w
;
17129 xassert (WINDOWP (f
->menu_bar_window
));
17130 menu_w
= XWINDOW (f
->menu_bar_window
);
17131 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
17133 it
.first_visible_x
= 0;
17134 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
17138 /* This is a TTY frame, i.e. character hpos/vpos are used as
17140 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
17142 it
.first_visible_x
= 0;
17143 it
.last_visible_x
= FRAME_COLS (f
);
17145 #endif /* not USE_X_TOOLKIT */
17147 if (! mode_line_inverse_video
)
17148 /* Force the menu-bar to be displayed in the default face. */
17149 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
17151 /* Clear all rows of the menu bar. */
17152 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
17154 struct glyph_row
*row
= it
.glyph_row
+ i
;
17155 clear_glyph_row (row
);
17156 row
->enabled_p
= 1;
17157 row
->full_width_p
= 1;
17160 /* Display all items of the menu bar. */
17161 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
17162 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
17164 Lisp_Object string
;
17166 /* Stop at nil string. */
17167 string
= AREF (items
, i
+ 1);
17171 /* Remember where item was displayed. */
17172 ASET (items
, i
+ 3, make_number (it
.hpos
));
17174 /* Display the item, pad with one space. */
17175 if (it
.current_x
< it
.last_visible_x
)
17176 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
17177 SCHARS (string
) + 1, 0, 0, -1);
17180 /* Fill out the line with spaces. */
17181 if (it
.current_x
< it
.last_visible_x
)
17182 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
17184 /* Compute the total height of the lines. */
17185 compute_line_metrics (&it
);
17190 /***********************************************************************
17192 ***********************************************************************/
17194 /* Redisplay mode lines in the window tree whose root is WINDOW. If
17195 FORCE is non-zero, redisplay mode lines unconditionally.
17196 Otherwise, redisplay only mode lines that are garbaged. Value is
17197 the number of windows whose mode lines were redisplayed. */
17200 redisplay_mode_lines (window
, force
)
17201 Lisp_Object window
;
17206 while (!NILP (window
))
17208 struct window
*w
= XWINDOW (window
);
17210 if (WINDOWP (w
->hchild
))
17211 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
17212 else if (WINDOWP (w
->vchild
))
17213 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
17215 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
17216 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
17218 struct text_pos lpoint
;
17219 struct buffer
*old
= current_buffer
;
17221 /* Set the window's buffer for the mode line display. */
17222 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
17223 set_buffer_internal_1 (XBUFFER (w
->buffer
));
17225 /* Point refers normally to the selected window. For any
17226 other window, set up appropriate value. */
17227 if (!EQ (window
, selected_window
))
17229 struct text_pos pt
;
17231 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
17232 if (CHARPOS (pt
) < BEGV
)
17233 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
17234 else if (CHARPOS (pt
) > (ZV
- 1))
17235 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
17237 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
17240 /* Display mode lines. */
17241 clear_glyph_matrix (w
->desired_matrix
);
17242 if (display_mode_lines (w
))
17245 w
->must_be_updated_p
= 1;
17248 /* Restore old settings. */
17249 set_buffer_internal_1 (old
);
17250 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
17260 /* Display the mode and/or top line of window W. Value is the number
17261 of mode lines displayed. */
17264 display_mode_lines (w
)
17267 Lisp_Object old_selected_window
, old_selected_frame
;
17270 old_selected_frame
= selected_frame
;
17271 selected_frame
= w
->frame
;
17272 old_selected_window
= selected_window
;
17273 XSETWINDOW (selected_window
, w
);
17275 /* These will be set while the mode line specs are processed. */
17276 line_number_displayed
= 0;
17277 w
->column_number_displayed
= Qnil
;
17279 if (WINDOW_WANTS_MODELINE_P (w
))
17281 struct window
*sel_w
= XWINDOW (old_selected_window
);
17283 /* Select mode line face based on the real selected window. */
17284 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
17285 current_buffer
->mode_line_format
);
17289 if (WINDOW_WANTS_HEADER_LINE_P (w
))
17291 display_mode_line (w
, HEADER_LINE_FACE_ID
,
17292 current_buffer
->header_line_format
);
17296 selected_frame
= old_selected_frame
;
17297 selected_window
= old_selected_window
;
17302 /* Display mode or top line of window W. FACE_ID specifies which line
17303 to display; it is either MODE_LINE_FACE_ID or HEADER_LINE_FACE_ID.
17304 FORMAT is the mode line format to display. Value is the pixel
17305 height of the mode line displayed. */
17308 display_mode_line (w
, face_id
, format
)
17310 enum face_id face_id
;
17311 Lisp_Object format
;
17315 int count
= SPECPDL_INDEX ();
17317 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
17318 /* Don't extend on a previously drawn mode-line.
17319 This may happen if called from pos_visible_p. */
17320 it
.glyph_row
->enabled_p
= 0;
17321 prepare_desired_row (it
.glyph_row
);
17323 it
.glyph_row
->mode_line_p
= 1;
17325 if (! mode_line_inverse_video
)
17326 /* Force the mode-line to be displayed in the default face. */
17327 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
17329 record_unwind_protect (unwind_format_mode_line
,
17330 format_mode_line_unwind_data (NULL
, Qnil
, 0));
17332 mode_line_target
= MODE_LINE_DISPLAY
;
17334 /* Temporarily make frame's keyboard the current kboard so that
17335 kboard-local variables in the mode_line_format will get the right
17337 push_kboard (FRAME_KBOARD (it
.f
));
17338 record_unwind_save_match_data ();
17339 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
17342 unbind_to (count
, Qnil
);
17344 /* Fill up with spaces. */
17345 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
17347 compute_line_metrics (&it
);
17348 it
.glyph_row
->full_width_p
= 1;
17349 it
.glyph_row
->continued_p
= 0;
17350 it
.glyph_row
->truncated_on_left_p
= 0;
17351 it
.glyph_row
->truncated_on_right_p
= 0;
17353 /* Make a 3D mode-line have a shadow at its right end. */
17354 face
= FACE_FROM_ID (it
.f
, face_id
);
17355 extend_face_to_end_of_line (&it
);
17356 if (face
->box
!= FACE_NO_BOX
)
17358 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
17359 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
17360 last
->right_box_line_p
= 1;
17363 return it
.glyph_row
->height
;
17366 /* Move element ELT in LIST to the front of LIST.
17367 Return the updated list. */
17370 move_elt_to_front (elt
, list
)
17371 Lisp_Object elt
, list
;
17373 register Lisp_Object tail
, prev
;
17374 register Lisp_Object tem
;
17378 while (CONSP (tail
))
17384 /* Splice out the link TAIL. */
17386 list
= XCDR (tail
);
17388 Fsetcdr (prev
, XCDR (tail
));
17390 /* Now make it the first. */
17391 Fsetcdr (tail
, list
);
17396 tail
= XCDR (tail
);
17400 /* Not found--return unchanged LIST. */
17404 /* Contribute ELT to the mode line for window IT->w. How it
17405 translates into text depends on its data type.
17407 IT describes the display environment in which we display, as usual.
17409 DEPTH is the depth in recursion. It is used to prevent
17410 infinite recursion here.
17412 FIELD_WIDTH is the number of characters the display of ELT should
17413 occupy in the mode line, and PRECISION is the maximum number of
17414 characters to display from ELT's representation. See
17415 display_string for details.
17417 Returns the hpos of the end of the text generated by ELT.
17419 PROPS is a property list to add to any string we encounter.
17421 If RISKY is nonzero, remove (disregard) any properties in any string
17422 we encounter, and ignore :eval and :propertize.
17424 The global variable `mode_line_target' determines whether the
17425 output is passed to `store_mode_line_noprop',
17426 `store_mode_line_string', or `display_string'. */
17429 display_mode_element (it
, depth
, field_width
, precision
, elt
, props
, risky
)
17432 int field_width
, precision
;
17433 Lisp_Object elt
, props
;
17436 int n
= 0, field
, prec
;
17441 elt
= build_string ("*too-deep*");
17445 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
17449 /* A string: output it and check for %-constructs within it. */
17453 if (SCHARS (elt
) > 0
17454 && (!NILP (props
) || risky
))
17456 Lisp_Object oprops
, aelt
;
17457 oprops
= Ftext_properties_at (make_number (0), elt
);
17459 /* If the starting string's properties are not what
17460 we want, translate the string. Also, if the string
17461 is risky, do that anyway. */
17463 if (NILP (Fequal (props
, oprops
)) || risky
)
17465 /* If the starting string has properties,
17466 merge the specified ones onto the existing ones. */
17467 if (! NILP (oprops
) && !risky
)
17471 oprops
= Fcopy_sequence (oprops
);
17473 while (CONSP (tem
))
17475 oprops
= Fplist_put (oprops
, XCAR (tem
),
17476 XCAR (XCDR (tem
)));
17477 tem
= XCDR (XCDR (tem
));
17482 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
17483 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
17485 /* AELT is what we want. Move it to the front
17486 without consing. */
17488 mode_line_proptrans_alist
17489 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
17495 /* If AELT has the wrong props, it is useless.
17496 so get rid of it. */
17498 mode_line_proptrans_alist
17499 = Fdelq (aelt
, mode_line_proptrans_alist
);
17501 elt
= Fcopy_sequence (elt
);
17502 Fset_text_properties (make_number (0), Flength (elt
),
17504 /* Add this item to mode_line_proptrans_alist. */
17505 mode_line_proptrans_alist
17506 = Fcons (Fcons (elt
, props
),
17507 mode_line_proptrans_alist
);
17508 /* Truncate mode_line_proptrans_alist
17509 to at most 50 elements. */
17510 tem
= Fnthcdr (make_number (50),
17511 mode_line_proptrans_alist
);
17513 XSETCDR (tem
, Qnil
);
17522 prec
= precision
- n
;
17523 switch (mode_line_target
)
17525 case MODE_LINE_NOPROP
:
17526 case MODE_LINE_TITLE
:
17527 n
+= store_mode_line_noprop (SDATA (elt
), -1, prec
);
17529 case MODE_LINE_STRING
:
17530 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
17532 case MODE_LINE_DISPLAY
:
17533 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
17534 0, prec
, 0, STRING_MULTIBYTE (elt
));
17541 /* Handle the non-literal case. */
17543 while ((precision
<= 0 || n
< precision
)
17544 && SREF (elt
, offset
) != 0
17545 && (mode_line_target
!= MODE_LINE_DISPLAY
17546 || it
->current_x
< it
->last_visible_x
))
17548 int last_offset
= offset
;
17550 /* Advance to end of string or next format specifier. */
17551 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
17554 if (offset
- 1 != last_offset
)
17556 int nchars
, nbytes
;
17558 /* Output to end of string or up to '%'. Field width
17559 is length of string. Don't output more than
17560 PRECISION allows us. */
17563 prec
= c_string_width (SDATA (elt
) + last_offset
,
17564 offset
- last_offset
, precision
- n
,
17567 switch (mode_line_target
)
17569 case MODE_LINE_NOPROP
:
17570 case MODE_LINE_TITLE
:
17571 n
+= store_mode_line_noprop (SDATA (elt
) + last_offset
, 0, prec
);
17573 case MODE_LINE_STRING
:
17575 int bytepos
= last_offset
;
17576 int charpos
= string_byte_to_char (elt
, bytepos
);
17577 int endpos
= (precision
<= 0
17578 ? string_byte_to_char (elt
, offset
)
17579 : charpos
+ nchars
);
17581 n
+= store_mode_line_string (NULL
,
17582 Fsubstring (elt
, make_number (charpos
),
17583 make_number (endpos
)),
17587 case MODE_LINE_DISPLAY
:
17589 int bytepos
= last_offset
;
17590 int charpos
= string_byte_to_char (elt
, bytepos
);
17592 if (precision
<= 0)
17593 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
17594 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
17596 STRING_MULTIBYTE (elt
));
17601 else /* c == '%' */
17603 int percent_position
= offset
;
17605 /* Get the specified minimum width. Zero means
17608 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
17609 field
= field
* 10 + c
- '0';
17611 /* Don't pad beyond the total padding allowed. */
17612 if (field_width
- n
> 0 && field
> field_width
- n
)
17613 field
= field_width
- n
;
17615 /* Note that either PRECISION <= 0 or N < PRECISION. */
17616 prec
= precision
- n
;
17619 n
+= display_mode_element (it
, depth
, field
, prec
,
17620 Vglobal_mode_string
, props
,
17625 int bytepos
, charpos
;
17626 unsigned char *spec
;
17628 bytepos
= percent_position
;
17629 charpos
= (STRING_MULTIBYTE (elt
)
17630 ? string_byte_to_char (elt
, bytepos
)
17633 = decode_mode_spec (it
->w
, c
, field
, prec
, &multibyte
);
17635 switch (mode_line_target
)
17637 case MODE_LINE_NOPROP
:
17638 case MODE_LINE_TITLE
:
17639 n
+= store_mode_line_noprop (spec
, field
, prec
);
17641 case MODE_LINE_STRING
:
17643 int len
= strlen (spec
);
17644 Lisp_Object tem
= make_string (spec
, len
);
17645 props
= Ftext_properties_at (make_number (charpos
), elt
);
17646 /* Should only keep face property in props */
17647 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
17650 case MODE_LINE_DISPLAY
:
17652 int nglyphs_before
, nwritten
;
17654 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
17655 nwritten
= display_string (spec
, Qnil
, elt
,
17660 /* Assign to the glyphs written above the
17661 string where the `%x' came from, position
17665 struct glyph
*glyph
17666 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
17670 for (i
= 0; i
< nwritten
; ++i
)
17672 glyph
[i
].object
= elt
;
17673 glyph
[i
].charpos
= charpos
;
17690 /* A symbol: process the value of the symbol recursively
17691 as if it appeared here directly. Avoid error if symbol void.
17692 Special case: if value of symbol is a string, output the string
17695 register Lisp_Object tem
;
17697 /* If the variable is not marked as risky to set
17698 then its contents are risky to use. */
17699 if (NILP (Fget (elt
, Qrisky_local_variable
)))
17702 tem
= Fboundp (elt
);
17705 tem
= Fsymbol_value (elt
);
17706 /* If value is a string, output that string literally:
17707 don't check for % within it. */
17711 if (!EQ (tem
, elt
))
17713 /* Give up right away for nil or t. */
17723 register Lisp_Object car
, tem
;
17725 /* A cons cell: five distinct cases.
17726 If first element is :eval or :propertize, do something special.
17727 If first element is a string or a cons, process all the elements
17728 and effectively concatenate them.
17729 If first element is a negative number, truncate displaying cdr to
17730 at most that many characters. If positive, pad (with spaces)
17731 to at least that many characters.
17732 If first element is a symbol, process the cadr or caddr recursively
17733 according to whether the symbol's value is non-nil or nil. */
17735 if (EQ (car
, QCeval
))
17737 /* An element of the form (:eval FORM) means evaluate FORM
17738 and use the result as mode line elements. */
17743 if (CONSP (XCDR (elt
)))
17746 spec
= safe_eval (XCAR (XCDR (elt
)));
17747 n
+= display_mode_element (it
, depth
, field_width
- n
,
17748 precision
- n
, spec
, props
,
17752 else if (EQ (car
, QCpropertize
))
17754 /* An element of the form (:propertize ELT PROPS...)
17755 means display ELT but applying properties PROPS. */
17760 if (CONSP (XCDR (elt
)))
17761 n
+= display_mode_element (it
, depth
, field_width
- n
,
17762 precision
- n
, XCAR (XCDR (elt
)),
17763 XCDR (XCDR (elt
)), risky
);
17765 else if (SYMBOLP (car
))
17767 tem
= Fboundp (car
);
17771 /* elt is now the cdr, and we know it is a cons cell.
17772 Use its car if CAR has a non-nil value. */
17775 tem
= Fsymbol_value (car
);
17782 /* Symbol's value is nil (or symbol is unbound)
17783 Get the cddr of the original list
17784 and if possible find the caddr and use that. */
17788 else if (!CONSP (elt
))
17793 else if (INTEGERP (car
))
17795 register int lim
= XINT (car
);
17799 /* Negative int means reduce maximum width. */
17800 if (precision
<= 0)
17803 precision
= min (precision
, -lim
);
17807 /* Padding specified. Don't let it be more than
17808 current maximum. */
17810 lim
= min (precision
, lim
);
17812 /* If that's more padding than already wanted, queue it.
17813 But don't reduce padding already specified even if
17814 that is beyond the current truncation point. */
17815 field_width
= max (lim
, field_width
);
17819 else if (STRINGP (car
) || CONSP (car
))
17821 register int limit
= 50;
17822 /* Limit is to protect against circular lists. */
17825 && (precision
<= 0 || n
< precision
))
17827 n
+= display_mode_element (it
, depth
,
17828 /* Do padding only after the last
17829 element in the list. */
17830 (! CONSP (XCDR (elt
))
17833 precision
- n
, XCAR (elt
),
17843 elt
= build_string ("*invalid*");
17847 /* Pad to FIELD_WIDTH. */
17848 if (field_width
> 0 && n
< field_width
)
17850 switch (mode_line_target
)
17852 case MODE_LINE_NOPROP
:
17853 case MODE_LINE_TITLE
:
17854 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
17856 case MODE_LINE_STRING
:
17857 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
17859 case MODE_LINE_DISPLAY
:
17860 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
17869 /* Store a mode-line string element in mode_line_string_list.
17871 If STRING is non-null, display that C string. Otherwise, the Lisp
17872 string LISP_STRING is displayed.
17874 FIELD_WIDTH is the minimum number of output glyphs to produce.
17875 If STRING has fewer characters than FIELD_WIDTH, pad to the right
17876 with spaces. FIELD_WIDTH <= 0 means don't pad.
17878 PRECISION is the maximum number of characters to output from
17879 STRING. PRECISION <= 0 means don't truncate the string.
17881 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
17882 properties to the string.
17884 PROPS are the properties to add to the string.
17885 The mode_line_string_face face property is always added to the string.
17889 store_mode_line_string (string
, lisp_string
, copy_string
, field_width
, precision
, props
)
17891 Lisp_Object lisp_string
;
17900 if (string
!= NULL
)
17902 len
= strlen (string
);
17903 if (precision
> 0 && len
> precision
)
17905 lisp_string
= make_string (string
, len
);
17907 props
= mode_line_string_face_prop
;
17908 else if (!NILP (mode_line_string_face
))
17910 Lisp_Object face
= Fplist_get (props
, Qface
);
17911 props
= Fcopy_sequence (props
);
17913 face
= mode_line_string_face
;
17915 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
17916 props
= Fplist_put (props
, Qface
, face
);
17918 Fadd_text_properties (make_number (0), make_number (len
),
17919 props
, lisp_string
);
17923 len
= XFASTINT (Flength (lisp_string
));
17924 if (precision
> 0 && len
> precision
)
17927 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
17930 if (!NILP (mode_line_string_face
))
17934 props
= Ftext_properties_at (make_number (0), lisp_string
);
17935 face
= Fplist_get (props
, Qface
);
17937 face
= mode_line_string_face
;
17939 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
17940 props
= Fcons (Qface
, Fcons (face
, Qnil
));
17942 lisp_string
= Fcopy_sequence (lisp_string
);
17945 Fadd_text_properties (make_number (0), make_number (len
),
17946 props
, lisp_string
);
17951 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
17955 if (field_width
> len
)
17957 field_width
-= len
;
17958 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
17960 Fadd_text_properties (make_number (0), make_number (field_width
),
17961 props
, lisp_string
);
17962 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
17970 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
17972 doc
: /* Format a string out of a mode line format specification.
17973 First arg FORMAT specifies the mode line format (see `mode-line-format'
17974 for details) to use.
17976 Optional second arg FACE specifies the face property to put
17977 on all characters for which no face is specified.
17978 The value t means whatever face the window's mode line currently uses
17979 \(either `mode-line' or `mode-line-inactive', depending).
17980 A value of nil means the default is no face property.
17981 If FACE is an integer, the value string has no text properties.
17983 Optional third and fourth args WINDOW and BUFFER specify the window
17984 and buffer to use as the context for the formatting (defaults
17985 are the selected window and the window's buffer). */)
17986 (format
, face
, window
, buffer
)
17987 Lisp_Object format
, face
, window
, buffer
;
17992 struct buffer
*old_buffer
= NULL
;
17994 int no_props
= INTEGERP (face
);
17995 int count
= SPECPDL_INDEX ();
17997 int string_start
= 0;
18000 window
= selected_window
;
18001 CHECK_WINDOW (window
);
18002 w
= XWINDOW (window
);
18005 buffer
= w
->buffer
;
18006 CHECK_BUFFER (buffer
);
18008 /* Make formatting the modeline a non-op when noninteractive, otherwise
18009 there will be problems later caused by a partially initialized frame. */
18010 if (NILP (format
) || noninteractive
)
18011 return empty_unibyte_string
;
18019 face
= (EQ (window
, selected_window
) ? Qmode_line
: Qmode_line_inactive
);
18020 face_id
= lookup_named_face (XFRAME (WINDOW_FRAME (w
)), face
, 0);
18024 face_id
= DEFAULT_FACE_ID
;
18026 if (XBUFFER (buffer
) != current_buffer
)
18027 old_buffer
= current_buffer
;
18029 /* Save things including mode_line_proptrans_alist,
18030 and set that to nil so that we don't alter the outer value. */
18031 record_unwind_protect (unwind_format_mode_line
,
18032 format_mode_line_unwind_data
18033 (old_buffer
, selected_window
, 1));
18034 mode_line_proptrans_alist
= Qnil
;
18036 Fselect_window (window
, Qt
);
18038 set_buffer_internal_1 (XBUFFER (buffer
));
18040 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
18044 mode_line_target
= MODE_LINE_NOPROP
;
18045 mode_line_string_face_prop
= Qnil
;
18046 mode_line_string_list
= Qnil
;
18047 string_start
= MODE_LINE_NOPROP_LEN (0);
18051 mode_line_target
= MODE_LINE_STRING
;
18052 mode_line_string_list
= Qnil
;
18053 mode_line_string_face
= face
;
18054 mode_line_string_face_prop
18055 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
18058 push_kboard (FRAME_KBOARD (it
.f
));
18059 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
18064 len
= MODE_LINE_NOPROP_LEN (string_start
);
18065 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
18069 mode_line_string_list
= Fnreverse (mode_line_string_list
);
18070 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
18071 empty_unibyte_string
);
18074 unbind_to (count
, Qnil
);
18078 /* Write a null-terminated, right justified decimal representation of
18079 the positive integer D to BUF using a minimal field width WIDTH. */
18082 pint2str (buf
, width
, d
)
18083 register char *buf
;
18084 register int width
;
18087 register char *p
= buf
;
18095 *p
++ = d
% 10 + '0';
18100 for (width
-= (int) (p
- buf
); width
> 0; --width
)
18111 /* Write a null-terminated, right justified decimal and "human
18112 readable" representation of the nonnegative integer D to BUF using
18113 a minimal field width WIDTH. D should be smaller than 999.5e24. */
18115 static const char power_letter
[] =
18129 pint2hrstr (buf
, width
, d
)
18134 /* We aim to represent the nonnegative integer D as
18135 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
18138 /* -1 means: do not use TENTHS. */
18142 /* Length of QUOTIENT.TENTHS as a string. */
18148 if (1000 <= quotient
)
18150 /* Scale to the appropriate EXPONENT. */
18153 remainder
= quotient
% 1000;
18157 while (1000 <= quotient
);
18159 /* Round to nearest and decide whether to use TENTHS or not. */
18162 tenths
= remainder
/ 100;
18163 if (50 <= remainder
% 100)
18170 if (quotient
== 10)
18178 if (500 <= remainder
)
18180 if (quotient
< 999)
18191 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
18192 if (tenths
== -1 && quotient
<= 99)
18199 p
= psuffix
= buf
+ max (width
, length
);
18201 /* Print EXPONENT. */
18203 *psuffix
++ = power_letter
[exponent
];
18206 /* Print TENTHS. */
18209 *--p
= '0' + tenths
;
18213 /* Print QUOTIENT. */
18216 int digit
= quotient
% 10;
18217 *--p
= '0' + digit
;
18219 while ((quotient
/= 10) != 0);
18221 /* Print leading spaces. */
18226 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
18227 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
18228 type of CODING_SYSTEM. Return updated pointer into BUF. */
18230 static unsigned char invalid_eol_type
[] = "(*invalid*)";
18233 decode_mode_spec_coding (coding_system
, buf
, eol_flag
)
18234 Lisp_Object coding_system
;
18235 register char *buf
;
18239 int multibyte
= !NILP (current_buffer
->enable_multibyte_characters
);
18240 const unsigned char *eol_str
;
18242 /* The EOL conversion we are using. */
18243 Lisp_Object eoltype
;
18245 val
= CODING_SYSTEM_SPEC (coding_system
);
18248 if (!VECTORP (val
)) /* Not yet decided. */
18253 eoltype
= eol_mnemonic_undecided
;
18254 /* Don't mention EOL conversion if it isn't decided. */
18259 Lisp_Object eolvalue
;
18261 attrs
= AREF (val
, 0);
18262 eolvalue
= AREF (val
, 2);
18265 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
18269 /* The EOL conversion that is normal on this system. */
18271 if (NILP (eolvalue
)) /* Not yet decided. */
18272 eoltype
= eol_mnemonic_undecided
;
18273 else if (VECTORP (eolvalue
)) /* Not yet decided. */
18274 eoltype
= eol_mnemonic_undecided
;
18275 else /* eolvalue is Qunix, Qdos, or Qmac. */
18276 eoltype
= (EQ (eolvalue
, Qunix
)
18277 ? eol_mnemonic_unix
18278 : (EQ (eolvalue
, Qdos
) == 1
18279 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
18285 /* Mention the EOL conversion if it is not the usual one. */
18286 if (STRINGP (eoltype
))
18288 eol_str
= SDATA (eoltype
);
18289 eol_str_len
= SBYTES (eoltype
);
18291 else if (CHARACTERP (eoltype
))
18293 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
18294 eol_str_len
= CHAR_STRING (XINT (eoltype
), tmp
);
18299 eol_str
= invalid_eol_type
;
18300 eol_str_len
= sizeof (invalid_eol_type
) - 1;
18302 bcopy (eol_str
, buf
, eol_str_len
);
18303 buf
+= eol_str_len
;
18309 /* Return a string for the output of a mode line %-spec for window W,
18310 generated by character C. PRECISION >= 0 means don't return a
18311 string longer than that value. FIELD_WIDTH > 0 means pad the
18312 string returned with spaces to that value. Return 1 in *MULTIBYTE
18313 if the result is multibyte text.
18315 Note we operate on the current buffer for most purposes,
18316 the exception being w->base_line_pos. */
18318 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
18321 decode_mode_spec (w
, c
, field_width
, precision
, multibyte
)
18324 int field_width
, precision
;
18328 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18329 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
18330 struct buffer
*b
= current_buffer
;
18338 if (!NILP (b
->read_only
))
18340 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
18345 /* This differs from %* only for a modified read-only buffer. */
18346 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
18348 if (!NILP (b
->read_only
))
18353 /* This differs from %* in ignoring read-only-ness. */
18354 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
18366 if (command_loop_level
> 5)
18368 p
= decode_mode_spec_buf
;
18369 for (i
= 0; i
< command_loop_level
; i
++)
18372 return decode_mode_spec_buf
;
18380 if (command_loop_level
> 5)
18382 p
= decode_mode_spec_buf
;
18383 for (i
= 0; i
< command_loop_level
; i
++)
18386 return decode_mode_spec_buf
;
18393 /* Let lots_of_dashes be a string of infinite length. */
18394 if (mode_line_target
== MODE_LINE_NOPROP
||
18395 mode_line_target
== MODE_LINE_STRING
)
18397 if (field_width
<= 0
18398 || field_width
> sizeof (lots_of_dashes
))
18400 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
18401 decode_mode_spec_buf
[i
] = '-';
18402 decode_mode_spec_buf
[i
] = '\0';
18403 return decode_mode_spec_buf
;
18406 return lots_of_dashes
;
18414 /* %c and %l are ignored in `frame-title-format'.
18415 (In redisplay_internal, the frame title is drawn _before_ the
18416 windows are updated, so the stuff which depends on actual
18417 window contents (such as %l) may fail to render properly, or
18418 even crash emacs.) */
18419 if (mode_line_target
== MODE_LINE_TITLE
)
18423 int col
= (int) current_column (); /* iftc */
18424 w
->column_number_displayed
= make_number (col
);
18425 pint2str (decode_mode_spec_buf
, field_width
, col
);
18426 return decode_mode_spec_buf
;
18430 #ifndef SYSTEM_MALLOC
18432 if (NILP (Vmemory_full
))
18435 return "!MEM FULL! ";
18442 /* %F displays the frame name. */
18443 if (!NILP (f
->title
))
18444 return (char *) SDATA (f
->title
);
18445 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
18446 return (char *) SDATA (f
->name
);
18455 int size
= ZV
- BEGV
;
18456 pint2str (decode_mode_spec_buf
, field_width
, size
);
18457 return decode_mode_spec_buf
;
18462 int size
= ZV
- BEGV
;
18463 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
18464 return decode_mode_spec_buf
;
18469 int startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
18470 int topline
, nlines
, junk
, height
;
18472 /* %c and %l are ignored in `frame-title-format'. */
18473 if (mode_line_target
== MODE_LINE_TITLE
)
18476 startpos
= XMARKER (w
->start
)->charpos
;
18477 startpos_byte
= marker_byte_position (w
->start
);
18478 height
= WINDOW_TOTAL_LINES (w
);
18480 /* If we decided that this buffer isn't suitable for line numbers,
18481 don't forget that too fast. */
18482 if (EQ (w
->base_line_pos
, w
->buffer
))
18484 /* But do forget it, if the window shows a different buffer now. */
18485 else if (BUFFERP (w
->base_line_pos
))
18486 w
->base_line_pos
= Qnil
;
18488 /* If the buffer is very big, don't waste time. */
18489 if (INTEGERP (Vline_number_display_limit
)
18490 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
18492 w
->base_line_pos
= Qnil
;
18493 w
->base_line_number
= Qnil
;
18497 if (INTEGERP (w
->base_line_number
)
18498 && INTEGERP (w
->base_line_pos
)
18499 && XFASTINT (w
->base_line_pos
) <= startpos
)
18501 line
= XFASTINT (w
->base_line_number
);
18502 linepos
= XFASTINT (w
->base_line_pos
);
18503 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
18508 linepos
= BUF_BEGV (b
);
18509 linepos_byte
= BUF_BEGV_BYTE (b
);
18512 /* Count lines from base line to window start position. */
18513 nlines
= display_count_lines (linepos
, linepos_byte
,
18517 topline
= nlines
+ line
;
18519 /* Determine a new base line, if the old one is too close
18520 or too far away, or if we did not have one.
18521 "Too close" means it's plausible a scroll-down would
18522 go back past it. */
18523 if (startpos
== BUF_BEGV (b
))
18525 w
->base_line_number
= make_number (topline
);
18526 w
->base_line_pos
= make_number (BUF_BEGV (b
));
18528 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
18529 || linepos
== BUF_BEGV (b
))
18531 int limit
= BUF_BEGV (b
);
18532 int limit_byte
= BUF_BEGV_BYTE (b
);
18534 int distance
= (height
* 2 + 30) * line_number_display_limit_width
;
18536 if (startpos
- distance
> limit
)
18538 limit
= startpos
- distance
;
18539 limit_byte
= CHAR_TO_BYTE (limit
);
18542 nlines
= display_count_lines (startpos
, startpos_byte
,
18544 - (height
* 2 + 30),
18546 /* If we couldn't find the lines we wanted within
18547 line_number_display_limit_width chars per line,
18548 give up on line numbers for this window. */
18549 if (position
== limit_byte
&& limit
== startpos
- distance
)
18551 w
->base_line_pos
= w
->buffer
;
18552 w
->base_line_number
= Qnil
;
18556 w
->base_line_number
= make_number (topline
- nlines
);
18557 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
18560 /* Now count lines from the start pos to point. */
18561 nlines
= display_count_lines (startpos
, startpos_byte
,
18562 PT_BYTE
, PT
, &junk
);
18564 /* Record that we did display the line number. */
18565 line_number_displayed
= 1;
18567 /* Make the string to show. */
18568 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
18569 return decode_mode_spec_buf
;
18572 char* p
= decode_mode_spec_buf
;
18573 int pad
= field_width
- 2;
18579 return decode_mode_spec_buf
;
18585 obj
= b
->mode_name
;
18589 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
18595 int pos
= marker_position (w
->start
);
18596 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
18598 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
18600 if (pos
<= BUF_BEGV (b
))
18605 else if (pos
<= BUF_BEGV (b
))
18609 if (total
> 1000000)
18610 /* Do it differently for a large value, to avoid overflow. */
18611 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
18613 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
18614 /* We can't normally display a 3-digit number,
18615 so get us a 2-digit number that is close. */
18618 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
18619 return decode_mode_spec_buf
;
18623 /* Display percentage of size above the bottom of the screen. */
18626 int toppos
= marker_position (w
->start
);
18627 int botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
18628 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
18630 if (botpos
>= BUF_ZV (b
))
18632 if (toppos
<= BUF_BEGV (b
))
18639 if (total
> 1000000)
18640 /* Do it differently for a large value, to avoid overflow. */
18641 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
18643 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
18644 /* We can't normally display a 3-digit number,
18645 so get us a 2-digit number that is close. */
18648 if (toppos
<= BUF_BEGV (b
))
18649 sprintf (decode_mode_spec_buf
, "Top%2d%%", total
);
18651 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
18652 return decode_mode_spec_buf
;
18657 /* status of process */
18658 obj
= Fget_buffer_process (Fcurrent_buffer ());
18660 return "no process";
18661 #ifdef subprocesses
18662 obj
= Fsymbol_name (Fprocess_status (obj
));
18669 val
= call1 (intern ("file-remote-p"), current_buffer
->directory
);
18676 case 't': /* indicate TEXT or BINARY */
18677 #ifdef MODE_LINE_BINARY_TEXT
18678 return MODE_LINE_BINARY_TEXT (b
);
18684 /* coding-system (not including end-of-line format) */
18686 /* coding-system (including end-of-line type) */
18688 int eol_flag
= (c
== 'Z');
18689 char *p
= decode_mode_spec_buf
;
18691 if (! FRAME_WINDOW_P (f
))
18693 /* No need to mention EOL here--the terminal never needs
18694 to do EOL conversion. */
18695 p
= decode_mode_spec_coding (CODING_ID_NAME
18696 (FRAME_KEYBOARD_CODING (f
)->id
),
18698 p
= decode_mode_spec_coding (CODING_ID_NAME
18699 (FRAME_TERMINAL_CODING (f
)->id
),
18702 p
= decode_mode_spec_coding (b
->buffer_file_coding_system
,
18705 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
18706 #ifdef subprocesses
18707 obj
= Fget_buffer_process (Fcurrent_buffer ());
18708 if (PROCESSP (obj
))
18710 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
18712 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
18715 #endif /* subprocesses */
18718 return decode_mode_spec_buf
;
18724 *multibyte
= STRING_MULTIBYTE (obj
);
18725 return (char *) SDATA (obj
);
18732 /* Count up to COUNT lines starting from START / START_BYTE.
18733 But don't go beyond LIMIT_BYTE.
18734 Return the number of lines thus found (always nonnegative).
18736 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
18739 display_count_lines (start
, start_byte
, limit_byte
, count
, byte_pos_ptr
)
18740 int start
, start_byte
, limit_byte
, count
;
18743 register unsigned char *cursor
;
18744 unsigned char *base
;
18746 register int ceiling
;
18747 register unsigned char *ceiling_addr
;
18748 int orig_count
= count
;
18750 /* If we are not in selective display mode,
18751 check only for newlines. */
18752 int selective_display
= (!NILP (current_buffer
->selective_display
)
18753 && !INTEGERP (current_buffer
->selective_display
));
18757 while (start_byte
< limit_byte
)
18759 ceiling
= BUFFER_CEILING_OF (start_byte
);
18760 ceiling
= min (limit_byte
- 1, ceiling
);
18761 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
18762 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
18765 if (selective_display
)
18766 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
18769 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
18772 if (cursor
!= ceiling_addr
)
18776 start_byte
+= cursor
- base
+ 1;
18777 *byte_pos_ptr
= start_byte
;
18781 if (++cursor
== ceiling_addr
)
18787 start_byte
+= cursor
- base
;
18792 while (start_byte
> limit_byte
)
18794 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
18795 ceiling
= max (limit_byte
, ceiling
);
18796 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
18797 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
18800 if (selective_display
)
18801 while (--cursor
!= ceiling_addr
18802 && *cursor
!= '\n' && *cursor
!= 015)
18805 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
18808 if (cursor
!= ceiling_addr
)
18812 start_byte
+= cursor
- base
+ 1;
18813 *byte_pos_ptr
= start_byte
;
18814 /* When scanning backwards, we should
18815 not count the newline posterior to which we stop. */
18816 return - orig_count
- 1;
18822 /* Here we add 1 to compensate for the last decrement
18823 of CURSOR, which took it past the valid range. */
18824 start_byte
+= cursor
- base
+ 1;
18828 *byte_pos_ptr
= limit_byte
;
18831 return - orig_count
+ count
;
18832 return orig_count
- count
;
18838 /***********************************************************************
18840 ***********************************************************************/
18842 /* Display a NUL-terminated string, starting with index START.
18844 If STRING is non-null, display that C string. Otherwise, the Lisp
18845 string LISP_STRING is displayed.
18847 If FACE_STRING is not nil, FACE_STRING_POS is a position in
18848 FACE_STRING. Display STRING or LISP_STRING with the face at
18849 FACE_STRING_POS in FACE_STRING:
18851 Display the string in the environment given by IT, but use the
18852 standard display table, temporarily.
18854 FIELD_WIDTH is the minimum number of output glyphs to produce.
18855 If STRING has fewer characters than FIELD_WIDTH, pad to the right
18856 with spaces. If STRING has more characters, more than FIELD_WIDTH
18857 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
18859 PRECISION is the maximum number of characters to output from
18860 STRING. PRECISION < 0 means don't truncate the string.
18862 This is roughly equivalent to printf format specifiers:
18864 FIELD_WIDTH PRECISION PRINTF
18865 ----------------------------------------
18871 MULTIBYTE zero means do not display multibyte chars, > 0 means do
18872 display them, and < 0 means obey the current buffer's value of
18873 enable_multibyte_characters.
18875 Value is the number of columns displayed. */
18878 display_string (string
, lisp_string
, face_string
, face_string_pos
,
18879 start
, it
, field_width
, precision
, max_x
, multibyte
)
18880 unsigned char *string
;
18881 Lisp_Object lisp_string
;
18882 Lisp_Object face_string
;
18883 EMACS_INT face_string_pos
;
18886 int field_width
, precision
, max_x
;
18889 int hpos_at_start
= it
->hpos
;
18890 int saved_face_id
= it
->face_id
;
18891 struct glyph_row
*row
= it
->glyph_row
;
18893 /* Initialize the iterator IT for iteration over STRING beginning
18894 with index START. */
18895 reseat_to_string (it
, string
, lisp_string
, start
,
18896 precision
, field_width
, multibyte
);
18898 /* If displaying STRING, set up the face of the iterator
18899 from LISP_STRING, if that's given. */
18900 if (STRINGP (face_string
))
18906 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
18907 0, it
->region_beg_charpos
,
18908 it
->region_end_charpos
,
18909 &endptr
, it
->base_face_id
, 0);
18910 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18911 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
18914 /* Set max_x to the maximum allowed X position. Don't let it go
18915 beyond the right edge of the window. */
18917 max_x
= it
->last_visible_x
;
18919 max_x
= min (max_x
, it
->last_visible_x
);
18921 /* Skip over display elements that are not visible. because IT->w is
18923 if (it
->current_x
< it
->first_visible_x
)
18924 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
18925 MOVE_TO_POS
| MOVE_TO_X
);
18927 row
->ascent
= it
->max_ascent
;
18928 row
->height
= it
->max_ascent
+ it
->max_descent
;
18929 row
->phys_ascent
= it
->max_phys_ascent
;
18930 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18931 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18933 /* This condition is for the case that we are called with current_x
18934 past last_visible_x. */
18935 while (it
->current_x
< max_x
)
18937 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
18939 /* Get the next display element. */
18940 if (!get_next_display_element (it
))
18943 /* Produce glyphs. */
18944 x_before
= it
->current_x
;
18945 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
18946 PRODUCE_GLYPHS (it
);
18948 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
18951 while (i
< nglyphs
)
18953 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
18955 if (it
->line_wrap
!= TRUNCATE
18956 && x
+ glyph
->pixel_width
> max_x
)
18958 /* End of continued line or max_x reached. */
18959 if (CHAR_GLYPH_PADDING_P (*glyph
))
18961 /* A wide character is unbreakable. */
18962 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18963 it
->current_x
= x_before
;
18967 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
18972 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
18974 /* Glyph is at least partially visible. */
18976 if (x
< it
->first_visible_x
)
18977 it
->glyph_row
->x
= x
- it
->first_visible_x
;
18981 /* Glyph is off the left margin of the display area.
18982 Should not happen. */
18986 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18987 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18988 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18989 row
->phys_height
= max (row
->phys_height
,
18990 it
->max_phys_ascent
+ it
->max_phys_descent
);
18991 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18992 it
->max_extra_line_spacing
);
18993 x
+= glyph
->pixel_width
;
18997 /* Stop if max_x reached. */
19001 /* Stop at line ends. */
19002 if (ITERATOR_AT_END_OF_LINE_P (it
))
19004 it
->continuation_lines_width
= 0;
19008 set_iterator_to_next (it
, 1);
19010 /* Stop if truncating at the right edge. */
19011 if (it
->line_wrap
== TRUNCATE
19012 && it
->current_x
>= it
->last_visible_x
)
19014 /* Add truncation mark, but don't do it if the line is
19015 truncated at a padding space. */
19016 if (IT_CHARPOS (*it
) < it
->string_nchars
)
19018 if (!FRAME_WINDOW_P (it
->f
))
19022 if (it
->current_x
> it
->last_visible_x
)
19024 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
19025 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19027 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
19029 row
->used
[TEXT_AREA
] = i
;
19030 produce_special_glyphs (it
, IT_TRUNCATION
);
19033 produce_special_glyphs (it
, IT_TRUNCATION
);
19035 it
->glyph_row
->truncated_on_right_p
= 1;
19041 /* Maybe insert a truncation at the left. */
19042 if (it
->first_visible_x
19043 && IT_CHARPOS (*it
) > 0)
19045 if (!FRAME_WINDOW_P (it
->f
))
19046 insert_left_trunc_glyphs (it
);
19047 it
->glyph_row
->truncated_on_left_p
= 1;
19050 it
->face_id
= saved_face_id
;
19052 /* Value is number of columns displayed. */
19053 return it
->hpos
- hpos_at_start
;
19058 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
19059 appears as an element of LIST or as the car of an element of LIST.
19060 If PROPVAL is a list, compare each element against LIST in that
19061 way, and return 1/2 if any element of PROPVAL is found in LIST.
19062 Otherwise return 0. This function cannot quit.
19063 The return value is 2 if the text is invisible but with an ellipsis
19064 and 1 if it's invisible and without an ellipsis. */
19067 invisible_p (propval
, list
)
19068 register Lisp_Object propval
;
19071 register Lisp_Object tail
, proptail
;
19073 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
19075 register Lisp_Object tem
;
19077 if (EQ (propval
, tem
))
19079 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
19080 return NILP (XCDR (tem
)) ? 1 : 2;
19083 if (CONSP (propval
))
19085 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
19087 Lisp_Object propelt
;
19088 propelt
= XCAR (proptail
);
19089 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
19091 register Lisp_Object tem
;
19093 if (EQ (propelt
, tem
))
19095 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
19096 return NILP (XCDR (tem
)) ? 1 : 2;
19104 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
19105 doc
: /* Non-nil if the property makes the text invisible.
19106 POS-OR-PROP can be a marker or number, in which case it is taken to be
19107 a position in the current buffer and the value of the `invisible' property
19108 is checked; or it can be some other value, which is then presumed to be the
19109 value of the `invisible' property of the text of interest.
19110 The non-nil value returned can be t for truly invisible text or something
19111 else if the text is replaced by an ellipsis. */)
19113 Lisp_Object pos_or_prop
;
19116 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
19117 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
19119 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
19120 return (invis
== 0 ? Qnil
19122 : make_number (invis
));
19125 /* Calculate a width or height in pixels from a specification using
19126 the following elements:
19129 NUM - a (fractional) multiple of the default font width/height
19130 (NUM) - specifies exactly NUM pixels
19131 UNIT - a fixed number of pixels, see below.
19132 ELEMENT - size of a display element in pixels, see below.
19133 (NUM . SPEC) - equals NUM * SPEC
19134 (+ SPEC SPEC ...) - add pixel values
19135 (- SPEC SPEC ...) - subtract pixel values
19136 (- SPEC) - negate pixel value
19139 INT or FLOAT - a number constant
19140 SYMBOL - use symbol's (buffer local) variable binding.
19143 in - pixels per inch *)
19144 mm - pixels per 1/1000 meter *)
19145 cm - pixels per 1/100 meter *)
19146 width - width of current font in pixels.
19147 height - height of current font in pixels.
19149 *) using the ratio(s) defined in display-pixels-per-inch.
19153 left-fringe - left fringe width in pixels
19154 right-fringe - right fringe width in pixels
19156 left-margin - left margin width in pixels
19157 right-margin - right margin width in pixels
19159 scroll-bar - scroll-bar area width in pixels
19163 Pixels corresponding to 5 inches:
19166 Total width of non-text areas on left side of window (if scroll-bar is on left):
19167 '(space :width (+ left-fringe left-margin scroll-bar))
19169 Align to first text column (in header line):
19170 '(space :align-to 0)
19172 Align to middle of text area minus half the width of variable `my-image'
19173 containing a loaded image:
19174 '(space :align-to (0.5 . (- text my-image)))
19176 Width of left margin minus width of 1 character in the default font:
19177 '(space :width (- left-margin 1))
19179 Width of left margin minus width of 2 characters in the current font:
19180 '(space :width (- left-margin (2 . width)))
19182 Center 1 character over left-margin (in header line):
19183 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
19185 Different ways to express width of left fringe plus left margin minus one pixel:
19186 '(space :width (- (+ left-fringe left-margin) (1)))
19187 '(space :width (+ left-fringe left-margin (- (1))))
19188 '(space :width (+ left-fringe left-margin (-1)))
19192 #define NUMVAL(X) \
19193 ((INTEGERP (X) || FLOATP (X)) \
19198 calc_pixel_width_or_height (res
, it
, prop
, font
, width_p
, align_to
)
19203 int width_p
, *align_to
;
19207 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
19208 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
19211 return OK_PIXELS (0);
19213 xassert (FRAME_LIVE_P (it
->f
));
19215 if (SYMBOLP (prop
))
19217 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
19219 char *unit
= SDATA (SYMBOL_NAME (prop
));
19221 if (unit
[0] == 'i' && unit
[1] == 'n')
19223 else if (unit
[0] == 'm' && unit
[1] == 'm')
19225 else if (unit
[0] == 'c' && unit
[1] == 'm')
19232 #ifdef HAVE_WINDOW_SYSTEM
19233 if (FRAME_WINDOW_P (it
->f
)
19235 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
19236 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
19238 return OK_PIXELS (ppi
/ pixels
);
19241 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
19242 || (CONSP (Vdisplay_pixels_per_inch
)
19244 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
19245 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
19247 return OK_PIXELS (ppi
/ pixels
);
19253 #ifdef HAVE_WINDOW_SYSTEM
19254 if (EQ (prop
, Qheight
))
19255 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
19256 if (EQ (prop
, Qwidth
))
19257 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
19259 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
19260 return OK_PIXELS (1);
19263 if (EQ (prop
, Qtext
))
19264 return OK_PIXELS (width_p
19265 ? window_box_width (it
->w
, TEXT_AREA
)
19266 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
19268 if (align_to
&& *align_to
< 0)
19271 if (EQ (prop
, Qleft
))
19272 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
19273 if (EQ (prop
, Qright
))
19274 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
19275 if (EQ (prop
, Qcenter
))
19276 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
19277 + window_box_width (it
->w
, TEXT_AREA
) / 2);
19278 if (EQ (prop
, Qleft_fringe
))
19279 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
19280 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
19281 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
19282 if (EQ (prop
, Qright_fringe
))
19283 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
19284 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
19285 : window_box_right_offset (it
->w
, TEXT_AREA
));
19286 if (EQ (prop
, Qleft_margin
))
19287 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
19288 if (EQ (prop
, Qright_margin
))
19289 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
19290 if (EQ (prop
, Qscroll_bar
))
19291 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
19293 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
19294 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
19295 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
19300 if (EQ (prop
, Qleft_fringe
))
19301 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
19302 if (EQ (prop
, Qright_fringe
))
19303 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
19304 if (EQ (prop
, Qleft_margin
))
19305 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
19306 if (EQ (prop
, Qright_margin
))
19307 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
19308 if (EQ (prop
, Qscroll_bar
))
19309 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
19312 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
19315 if (INTEGERP (prop
) || FLOATP (prop
))
19317 int base_unit
= (width_p
19318 ? FRAME_COLUMN_WIDTH (it
->f
)
19319 : FRAME_LINE_HEIGHT (it
->f
));
19320 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
19325 Lisp_Object car
= XCAR (prop
);
19326 Lisp_Object cdr
= XCDR (prop
);
19330 #ifdef HAVE_WINDOW_SYSTEM
19331 if (FRAME_WINDOW_P (it
->f
)
19332 && valid_image_p (prop
))
19334 int id
= lookup_image (it
->f
, prop
);
19335 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
19337 return OK_PIXELS (width_p
? img
->width
: img
->height
);
19340 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
19346 while (CONSP (cdr
))
19348 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
19349 font
, width_p
, align_to
))
19352 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
19357 if (EQ (car
, Qminus
))
19359 return OK_PIXELS (pixels
);
19362 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
19365 if (INTEGERP (car
) || FLOATP (car
))
19368 pixels
= XFLOATINT (car
);
19370 return OK_PIXELS (pixels
);
19371 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
19372 font
, width_p
, align_to
))
19373 return OK_PIXELS (pixels
* fact
);
19384 /***********************************************************************
19386 ***********************************************************************/
19388 #ifdef HAVE_WINDOW_SYSTEM
19393 dump_glyph_string (s
)
19394 struct glyph_string
*s
;
19396 fprintf (stderr
, "glyph string\n");
19397 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
19398 s
->x
, s
->y
, s
->width
, s
->height
);
19399 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
19400 fprintf (stderr
, " hl = %d\n", s
->hl
);
19401 fprintf (stderr
, " left overhang = %d, right = %d\n",
19402 s
->left_overhang
, s
->right_overhang
);
19403 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
19404 fprintf (stderr
, " extends to end of line = %d\n",
19405 s
->extends_to_end_of_line_p
);
19406 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
19407 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
19410 #endif /* GLYPH_DEBUG */
19412 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
19413 of XChar2b structures for S; it can't be allocated in
19414 init_glyph_string because it must be allocated via `alloca'. W
19415 is the window on which S is drawn. ROW and AREA are the glyph row
19416 and area within the row from which S is constructed. START is the
19417 index of the first glyph structure covered by S. HL is a
19418 face-override for drawing S. */
19421 #define OPTIONAL_HDC(hdc) hdc,
19422 #define DECLARE_HDC(hdc) HDC hdc;
19423 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
19424 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
19427 #ifndef OPTIONAL_HDC
19428 #define OPTIONAL_HDC(hdc)
19429 #define DECLARE_HDC(hdc)
19430 #define ALLOCATE_HDC(hdc, f)
19431 #define RELEASE_HDC(hdc, f)
19435 init_glyph_string (s
, OPTIONAL_HDC (hdc
) char2b
, w
, row
, area
, start
, hl
)
19436 struct glyph_string
*s
;
19440 struct glyph_row
*row
;
19441 enum glyph_row_area area
;
19443 enum draw_glyphs_face hl
;
19445 bzero (s
, sizeof *s
);
19447 s
->f
= XFRAME (w
->frame
);
19451 s
->display
= FRAME_X_DISPLAY (s
->f
);
19452 s
->window
= FRAME_X_WINDOW (s
->f
);
19453 s
->char2b
= char2b
;
19457 s
->first_glyph
= row
->glyphs
[area
] + start
;
19458 s
->height
= row
->height
;
19459 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
19461 /* Display the internal border below the tool-bar window. */
19462 if (WINDOWP (s
->f
->tool_bar_window
)
19463 && s
->w
== XWINDOW (s
->f
->tool_bar_window
))
19464 s
->y
-= FRAME_INTERNAL_BORDER_WIDTH (s
->f
);
19466 s
->ybase
= s
->y
+ row
->ascent
;
19470 /* Append the list of glyph strings with head H and tail T to the list
19471 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
19474 append_glyph_string_lists (head
, tail
, h
, t
)
19475 struct glyph_string
**head
, **tail
;
19476 struct glyph_string
*h
, *t
;
19490 /* Prepend the list of glyph strings with head H and tail T to the
19491 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
19495 prepend_glyph_string_lists (head
, tail
, h
, t
)
19496 struct glyph_string
**head
, **tail
;
19497 struct glyph_string
*h
, *t
;
19511 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
19512 Set *HEAD and *TAIL to the resulting list. */
19515 append_glyph_string (head
, tail
, s
)
19516 struct glyph_string
**head
, **tail
;
19517 struct glyph_string
*s
;
19519 s
->next
= s
->prev
= NULL
;
19520 append_glyph_string_lists (head
, tail
, s
, s
);
19524 /* Get face and two-byte form of character C in face FACE_ID on frame
19525 F. The encoding of C is returned in *CHAR2B. MULTIBYTE_P non-zero
19526 means we want to display multibyte text. DISPLAY_P non-zero means
19527 make sure that X resources for the face returned are allocated.
19528 Value is a pointer to a realized face that is ready for display if
19529 DISPLAY_P is non-zero. */
19531 static INLINE
struct face
*
19532 get_char_face_and_encoding (f
, c
, face_id
, char2b
, multibyte_p
, display_p
)
19536 int multibyte_p
, display_p
;
19538 struct face
*face
= FACE_FROM_ID (f
, face_id
);
19542 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
19544 if (code
!= FONT_INVALID_CODE
)
19545 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
19547 STORE_XCHAR2B (char2b
, 0, 0);
19550 /* Make sure X resources of the face are allocated. */
19551 #ifdef HAVE_X_WINDOWS
19555 xassert (face
!= NULL
);
19556 PREPARE_FACE_FOR_DISPLAY (f
, face
);
19563 /* Get face and two-byte form of character glyph GLYPH on frame F.
19564 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
19565 a pointer to a realized face that is ready for display. */
19567 static INLINE
struct face
*
19568 get_glyph_face_and_encoding (f
, glyph
, char2b
, two_byte_p
)
19570 struct glyph
*glyph
;
19576 xassert (glyph
->type
== CHAR_GLYPH
);
19577 face
= FACE_FROM_ID (f
, glyph
->face_id
);
19584 unsigned code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
19586 if (code
!= FONT_INVALID_CODE
)
19587 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
19589 STORE_XCHAR2B (char2b
, 0, 0);
19592 /* Make sure X resources of the face are allocated. */
19593 xassert (face
!= NULL
);
19594 PREPARE_FACE_FOR_DISPLAY (f
, face
);
19599 /* Fill glyph string S with composition components specified by S->cmp.
19601 BASE_FACE is the base face of the composition.
19602 S->gidx is the index of the first component for S.
19604 OVERLAPS non-zero means S should draw the foreground only, and use
19605 its physical height for clipping. See also draw_glyphs.
19607 Value is the index of a component not in S. */
19610 fill_composite_glyph_string (s
, base_face
, overlaps
)
19611 struct glyph_string
*s
;
19612 struct face
*base_face
;
19619 s
->for_overlaps
= overlaps
;
19621 if (s
->cmp
->method
== COMPOSITION_WITH_GLYPH_STRING
)
19623 Lisp_Object gstring
19624 = AREF (XHASH_TABLE (composition_hash_table
)->key_and_value
,
19625 s
->cmp
->hash_index
* 2);
19627 s
->face
= base_face
;
19628 s
->font
= base_face
->font
;
19629 for (i
= 0, s
->nchars
= 0; i
< s
->cmp
->glyph_len
; i
++, s
->nchars
++)
19631 Lisp_Object g
= LGSTRING_GLYPH (gstring
, i
);
19633 XChar2b
* store_pos
;
19636 code
= LGLYPH_CODE (g
);
19637 store_pos
= s
->char2b
+ i
;
19638 STORE_XCHAR2B (store_pos
, code
>> 8, code
& 0xFF);
19640 s
->width
= s
->cmp
->pixel_width
;
19644 /* For all glyphs of this composition, starting at the offset
19645 S->gidx, until we reach the end of the definition or encounter a
19646 glyph that requires the different face, add it to S. */
19651 for (i
= s
->gidx
; i
< s
->cmp
->glyph_len
; i
++)
19653 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
19657 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
19660 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
19661 s
->char2b
+ i
, 1, 1);
19667 s
->font
= s
->face
->font
;
19669 else if (s
->face
!= face
)
19676 /* All glyph strings for the same composition has the same width,
19677 i.e. the width set for the first component of the composition. */
19678 s
->width
= s
->first_glyph
->pixel_width
;
19681 /* If the specified font could not be loaded, use the frame's
19682 default font, but record the fact that we couldn't load it in
19683 the glyph string so that we can draw rectangles for the
19684 characters of the glyph string. */
19685 if (s
->font
== NULL
)
19687 s
->font_not_found_p
= 1;
19688 s
->font
= FRAME_FONT (s
->f
);
19691 /* Adjust base line for subscript/superscript text. */
19692 s
->ybase
+= s
->first_glyph
->voffset
;
19694 /* This glyph string must always be drawn with 16-bit functions. */
19697 return s
->gidx
+ s
->nchars
;
19701 /* Fill glyph string S from a sequence of character glyphs.
19703 FACE_ID is the face id of the string. START is the index of the
19704 first glyph to consider, END is the index of the last + 1.
19705 OVERLAPS non-zero means S should draw the foreground only, and use
19706 its physical height for clipping. See also draw_glyphs.
19708 Value is the index of the first glyph not in S. */
19711 fill_glyph_string (s
, face_id
, start
, end
, overlaps
)
19712 struct glyph_string
*s
;
19714 int start
, end
, overlaps
;
19716 struct glyph
*glyph
, *last
;
19718 int glyph_not_available_p
;
19720 xassert (s
->f
== XFRAME (s
->w
->frame
));
19721 xassert (s
->nchars
== 0);
19722 xassert (start
>= 0 && end
> start
);
19724 s
->for_overlaps
= overlaps
,
19725 glyph
= s
->row
->glyphs
[s
->area
] + start
;
19726 last
= s
->row
->glyphs
[s
->area
] + end
;
19727 voffset
= glyph
->voffset
;
19728 s
->padding_p
= glyph
->padding_p
;
19729 glyph_not_available_p
= glyph
->glyph_not_available_p
;
19731 while (glyph
< last
19732 && glyph
->type
== CHAR_GLYPH
19733 && glyph
->voffset
== voffset
19734 /* Same face id implies same font, nowadays. */
19735 && glyph
->face_id
== face_id
19736 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
19740 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
19741 s
->char2b
+ s
->nchars
,
19743 s
->two_byte_p
= two_byte_p
;
19745 xassert (s
->nchars
<= end
- start
);
19746 s
->width
+= glyph
->pixel_width
;
19747 if (glyph
++->padding_p
!= s
->padding_p
)
19751 s
->font
= s
->face
->font
;
19753 /* If the specified font could not be loaded, use the frame's font,
19754 but record the fact that we couldn't load it in
19755 S->font_not_found_p so that we can draw rectangles for the
19756 characters of the glyph string. */
19757 if (s
->font
== NULL
|| glyph_not_available_p
)
19759 s
->font_not_found_p
= 1;
19760 s
->font
= FRAME_FONT (s
->f
);
19763 /* Adjust base line for subscript/superscript text. */
19764 s
->ybase
+= voffset
;
19766 xassert (s
->face
&& s
->face
->gc
);
19767 return glyph
- s
->row
->glyphs
[s
->area
];
19771 /* Fill glyph string S from image glyph S->first_glyph. */
19774 fill_image_glyph_string (s
)
19775 struct glyph_string
*s
;
19777 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
19778 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
19780 s
->slice
= s
->first_glyph
->slice
;
19781 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
19782 s
->font
= s
->face
->font
;
19783 s
->width
= s
->first_glyph
->pixel_width
;
19785 /* Adjust base line for subscript/superscript text. */
19786 s
->ybase
+= s
->first_glyph
->voffset
;
19790 /* Fill glyph string S from a sequence of stretch glyphs.
19792 ROW is the glyph row in which the glyphs are found, AREA is the
19793 area within the row. START is the index of the first glyph to
19794 consider, END is the index of the last + 1.
19796 Value is the index of the first glyph not in S. */
19799 fill_stretch_glyph_string (s
, row
, area
, start
, end
)
19800 struct glyph_string
*s
;
19801 struct glyph_row
*row
;
19802 enum glyph_row_area area
;
19805 struct glyph
*glyph
, *last
;
19806 int voffset
, face_id
;
19808 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
19810 glyph
= s
->row
->glyphs
[s
->area
] + start
;
19811 last
= s
->row
->glyphs
[s
->area
] + end
;
19812 face_id
= glyph
->face_id
;
19813 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
19814 s
->font
= s
->face
->font
;
19815 s
->width
= glyph
->pixel_width
;
19817 voffset
= glyph
->voffset
;
19821 && glyph
->type
== STRETCH_GLYPH
19822 && glyph
->voffset
== voffset
19823 && glyph
->face_id
== face_id
);
19825 s
->width
+= glyph
->pixel_width
;
19827 /* Adjust base line for subscript/superscript text. */
19828 s
->ybase
+= voffset
;
19830 /* The case that face->gc == 0 is handled when drawing the glyph
19831 string by calling PREPARE_FACE_FOR_DISPLAY. */
19833 return glyph
- s
->row
->glyphs
[s
->area
];
19836 static struct font_metrics
*
19837 get_per_char_metric (f
, font
, char2b
)
19842 static struct font_metrics metrics
;
19843 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
19844 struct font
*fontp
;
19846 if (! font
|| code
== FONT_INVALID_CODE
)
19848 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
19853 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
19854 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
19855 assumed to be zero. */
19858 x_get_glyph_overhangs (glyph
, f
, left
, right
)
19859 struct glyph
*glyph
;
19863 *left
= *right
= 0;
19865 if (glyph
->type
== CHAR_GLYPH
)
19869 struct font_metrics
*pcm
;
19871 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
19872 if (face
->font
&& (pcm
= get_per_char_metric (f
, face
->font
, &char2b
)))
19874 if (pcm
->rbearing
> pcm
->width
)
19875 *right
= pcm
->rbearing
- pcm
->width
;
19876 if (pcm
->lbearing
< 0)
19877 *left
= -pcm
->lbearing
;
19880 else if (glyph
->type
== COMPOSITE_GLYPH
)
19882 struct composition
*cmp
= composition_table
[glyph
->u
.cmp_id
];
19884 *right
= cmp
->rbearing
- cmp
->pixel_width
;
19885 *left
= - cmp
->lbearing
;
19890 /* Return the index of the first glyph preceding glyph string S that
19891 is overwritten by S because of S's left overhang. Value is -1
19892 if no glyphs are overwritten. */
19895 left_overwritten (s
)
19896 struct glyph_string
*s
;
19900 if (s
->left_overhang
)
19903 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19904 int first
= s
->first_glyph
- glyphs
;
19906 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
19907 x
-= glyphs
[i
].pixel_width
;
19918 /* Return the index of the first glyph preceding glyph string S that
19919 is overwriting S because of its right overhang. Value is -1 if no
19920 glyph in front of S overwrites S. */
19923 left_overwriting (s
)
19924 struct glyph_string
*s
;
19927 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19928 int first
= s
->first_glyph
- glyphs
;
19932 for (i
= first
- 1; i
>= 0; --i
)
19935 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
19938 x
-= glyphs
[i
].pixel_width
;
19945 /* Return the index of the last glyph following glyph string S that is
19946 overwritten by S because of S's right overhang. Value is -1 if
19947 no such glyph is found. */
19950 right_overwritten (s
)
19951 struct glyph_string
*s
;
19955 if (s
->right_overhang
)
19958 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19959 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
19960 int end
= s
->row
->used
[s
->area
];
19962 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
19963 x
+= glyphs
[i
].pixel_width
;
19972 /* Return the index of the last glyph following glyph string S that
19973 overwrites S because of its left overhang. Value is negative
19974 if no such glyph is found. */
19977 right_overwriting (s
)
19978 struct glyph_string
*s
;
19981 int end
= s
->row
->used
[s
->area
];
19982 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19983 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
19987 for (i
= first
; i
< end
; ++i
)
19990 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
19993 x
+= glyphs
[i
].pixel_width
;
20000 /* Set background width of glyph string S. START is the index of the
20001 first glyph following S. LAST_X is the right-most x-position + 1
20002 in the drawing area. */
20005 set_glyph_string_background_width (s
, start
, last_x
)
20006 struct glyph_string
*s
;
20010 /* If the face of this glyph string has to be drawn to the end of
20011 the drawing area, set S->extends_to_end_of_line_p. */
20013 if (start
== s
->row
->used
[s
->area
]
20014 && s
->area
== TEXT_AREA
20015 && ((s
->row
->fill_line_p
20016 && (s
->hl
== DRAW_NORMAL_TEXT
20017 || s
->hl
== DRAW_IMAGE_RAISED
20018 || s
->hl
== DRAW_IMAGE_SUNKEN
))
20019 || s
->hl
== DRAW_MOUSE_FACE
))
20020 s
->extends_to_end_of_line_p
= 1;
20022 /* If S extends its face to the end of the line, set its
20023 background_width to the distance to the right edge of the drawing
20025 if (s
->extends_to_end_of_line_p
)
20026 s
->background_width
= last_x
- s
->x
+ 1;
20028 s
->background_width
= s
->width
;
20032 /* Compute overhangs and x-positions for glyph string S and its
20033 predecessors, or successors. X is the starting x-position for S.
20034 BACKWARD_P non-zero means process predecessors. */
20037 compute_overhangs_and_x (s
, x
, backward_p
)
20038 struct glyph_string
*s
;
20046 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
20047 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
20057 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
20058 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
20068 /* The following macros are only called from draw_glyphs below.
20069 They reference the following parameters of that function directly:
20070 `w', `row', `area', and `overlap_p'
20071 as well as the following local variables:
20072 `s', `f', and `hdc' (in W32) */
20075 /* On W32, silently add local `hdc' variable to argument list of
20076 init_glyph_string. */
20077 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
20078 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
20080 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
20081 init_glyph_string (s, char2b, w, row, area, start, hl)
20084 /* Add a glyph string for a stretch glyph to the list of strings
20085 between HEAD and TAIL. START is the index of the stretch glyph in
20086 row area AREA of glyph row ROW. END is the index of the last glyph
20087 in that glyph row area. X is the current output position assigned
20088 to the new glyph string constructed. HL overrides that face of the
20089 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
20090 is the right-most x-position of the drawing area. */
20092 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
20093 and below -- keep them on one line. */
20094 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
20097 s = (struct glyph_string *) alloca (sizeof *s); \
20098 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
20099 START = fill_stretch_glyph_string (s, row, area, START, END); \
20100 append_glyph_string (&HEAD, &TAIL, s); \
20106 /* Add a glyph string for an image glyph to the list of strings
20107 between HEAD and TAIL. START is the index of the image glyph in
20108 row area AREA of glyph row ROW. END is the index of the last glyph
20109 in that glyph row area. X is the current output position assigned
20110 to the new glyph string constructed. HL overrides that face of the
20111 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
20112 is the right-most x-position of the drawing area. */
20114 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
20117 s = (struct glyph_string *) alloca (sizeof *s); \
20118 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
20119 fill_image_glyph_string (s); \
20120 append_glyph_string (&HEAD, &TAIL, s); \
20127 /* Add a glyph string for a sequence of character glyphs to the list
20128 of strings between HEAD and TAIL. START is the index of the first
20129 glyph in row area AREA of glyph row ROW that is part of the new
20130 glyph string. END is the index of the last glyph in that glyph row
20131 area. X is the current output position assigned to the new glyph
20132 string constructed. HL overrides that face of the glyph; e.g. it
20133 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
20134 right-most x-position of the drawing area. */
20136 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
20142 face_id = (row)->glyphs[area][START].face_id; \
20144 s = (struct glyph_string *) alloca (sizeof *s); \
20145 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
20146 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
20147 append_glyph_string (&HEAD, &TAIL, s); \
20149 START = fill_glyph_string (s, face_id, START, END, overlaps); \
20154 /* Add a glyph string for a composite sequence to the list of strings
20155 between HEAD and TAIL. START is the index of the first glyph in
20156 row area AREA of glyph row ROW that is part of the new glyph
20157 string. END is the index of the last glyph in that glyph row area.
20158 X is the current output position assigned to the new glyph string
20159 constructed. HL overrides that face of the glyph; e.g. it is
20160 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
20161 x-position of the drawing area. */
20163 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
20165 int face_id = (row)->glyphs[area][START].face_id; \
20166 struct face *base_face = FACE_FROM_ID (f, face_id); \
20167 int cmp_id = (row)->glyphs[area][START].u.cmp_id; \
20168 struct composition *cmp = composition_table[cmp_id]; \
20170 struct glyph_string *first_s; \
20173 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
20175 /* Make glyph_strings for each glyph sequence that is drawable by \
20176 the same face, and append them to HEAD/TAIL. */ \
20177 for (n = 0; n < cmp->glyph_len;) \
20179 s = (struct glyph_string *) alloca (sizeof *s); \
20180 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
20181 append_glyph_string (&(HEAD), &(TAIL), s); \
20187 n = fill_composite_glyph_string (s, base_face, overlaps); \
20195 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
20196 of AREA of glyph row ROW on window W between indices START and END.
20197 HL overrides the face for drawing glyph strings, e.g. it is
20198 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
20199 x-positions of the drawing area.
20201 This is an ugly monster macro construct because we must use alloca
20202 to allocate glyph strings (because draw_glyphs can be called
20203 asynchronously). */
20205 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
20208 HEAD = TAIL = NULL; \
20209 while (START < END) \
20211 struct glyph *first_glyph = (row)->glyphs[area] + START; \
20212 switch (first_glyph->type) \
20215 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
20219 case COMPOSITE_GLYPH: \
20220 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
20224 case STRETCH_GLYPH: \
20225 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
20229 case IMAGE_GLYPH: \
20230 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
20240 set_glyph_string_background_width (s, START, LAST_X); \
20248 /* Draw glyphs between START and END in AREA of ROW on window W,
20249 starting at x-position X. X is relative to AREA in W. HL is a
20250 face-override with the following meaning:
20252 DRAW_NORMAL_TEXT draw normally
20253 DRAW_CURSOR draw in cursor face
20254 DRAW_MOUSE_FACE draw in mouse face.
20255 DRAW_INVERSE_VIDEO draw in mode line face
20256 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
20257 DRAW_IMAGE_RAISED draw an image with a raised relief around it
20259 If OVERLAPS is non-zero, draw only the foreground of characters and
20260 clip to the physical height of ROW. Non-zero value also defines
20261 the overlapping part to be drawn:
20263 OVERLAPS_PRED overlap with preceding rows
20264 OVERLAPS_SUCC overlap with succeeding rows
20265 OVERLAPS_BOTH overlap with both preceding/succeeding rows
20266 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
20268 Value is the x-position reached, relative to AREA of W. */
20271 draw_glyphs (w
, x
, row
, area
, start
, end
, hl
, overlaps
)
20274 struct glyph_row
*row
;
20275 enum glyph_row_area area
;
20276 EMACS_INT start
, end
;
20277 enum draw_glyphs_face hl
;
20280 struct glyph_string
*head
, *tail
;
20281 struct glyph_string
*s
;
20282 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
20283 int i
, j
, x_reached
, last_x
, area_left
= 0;
20284 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
20287 ALLOCATE_HDC (hdc
, f
);
20289 /* Let's rather be paranoid than getting a SEGV. */
20290 end
= min (end
, row
->used
[area
]);
20291 start
= max (0, start
);
20292 start
= min (end
, start
);
20294 /* Translate X to frame coordinates. Set last_x to the right
20295 end of the drawing area. */
20296 if (row
->full_width_p
)
20298 /* X is relative to the left edge of W, without scroll bars
20300 area_left
= WINDOW_LEFT_EDGE_X (w
);
20301 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
20305 area_left
= window_box_left (w
, area
);
20306 last_x
= area_left
+ window_box_width (w
, area
);
20310 /* Build a doubly-linked list of glyph_string structures between
20311 head and tail from what we have to draw. Note that the macro
20312 BUILD_GLYPH_STRINGS will modify its start parameter. That's
20313 the reason we use a separate variable `i'. */
20315 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
20317 x_reached
= tail
->x
+ tail
->background_width
;
20321 /* If there are any glyphs with lbearing < 0 or rbearing > width in
20322 the row, redraw some glyphs in front or following the glyph
20323 strings built above. */
20324 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
20326 struct glyph_string
*h
, *t
;
20327 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
20328 int mouse_beg_col
, mouse_end_col
, check_mouse_face
= 0;
20331 /* If mouse highlighting is on, we may need to draw adjacent
20332 glyphs using mouse-face highlighting. */
20333 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
20335 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
20337 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
20338 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
20340 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
20342 check_mouse_face
= 1;
20343 mouse_beg_col
= (row
== mouse_beg_row
)
20344 ? dpyinfo
->mouse_face_beg_col
: 0;
20345 mouse_end_col
= (row
== mouse_end_row
)
20346 ? dpyinfo
->mouse_face_end_col
20347 : row
->used
[TEXT_AREA
];
20351 /* Compute overhangs for all glyph strings. */
20352 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
20353 for (s
= head
; s
; s
= s
->next
)
20354 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
20356 /* Prepend glyph strings for glyphs in front of the first glyph
20357 string that are overwritten because of the first glyph
20358 string's left overhang. The background of all strings
20359 prepended must be drawn because the first glyph string
20361 i
= left_overwritten (head
);
20364 enum draw_glyphs_face overlap_hl
;
20366 /* If this row contains mouse highlighting, attempt to draw
20367 the overlapped glyphs with the correct highlight. This
20368 code fails if the overlap encompasses more than one glyph
20369 and mouse-highlight spans only some of these glyphs.
20370 However, making it work perfectly involves a lot more
20371 code, and I don't know if the pathological case occurs in
20372 practice, so we'll stick to this for now. --- cyd */
20373 if (check_mouse_face
20374 && mouse_beg_col
< start
&& mouse_end_col
> i
)
20375 overlap_hl
= DRAW_MOUSE_FACE
;
20377 overlap_hl
= DRAW_NORMAL_TEXT
;
20380 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
20381 overlap_hl
, dummy_x
, last_x
);
20382 compute_overhangs_and_x (t
, head
->x
, 1);
20383 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
20387 /* Prepend glyph strings for glyphs in front of the first glyph
20388 string that overwrite that glyph string because of their
20389 right overhang. For these strings, only the foreground must
20390 be drawn, because it draws over the glyph string at `head'.
20391 The background must not be drawn because this would overwrite
20392 right overhangs of preceding glyphs for which no glyph
20394 i
= left_overwriting (head
);
20397 enum draw_glyphs_face overlap_hl
;
20399 if (check_mouse_face
20400 && mouse_beg_col
< start
&& mouse_end_col
> i
)
20401 overlap_hl
= DRAW_MOUSE_FACE
;
20403 overlap_hl
= DRAW_NORMAL_TEXT
;
20406 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
20407 overlap_hl
, dummy_x
, last_x
);
20408 for (s
= h
; s
; s
= s
->next
)
20409 s
->background_filled_p
= 1;
20410 compute_overhangs_and_x (t
, head
->x
, 1);
20411 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
20414 /* Append glyphs strings for glyphs following the last glyph
20415 string tail that are overwritten by tail. The background of
20416 these strings has to be drawn because tail's foreground draws
20418 i
= right_overwritten (tail
);
20421 enum draw_glyphs_face overlap_hl
;
20423 if (check_mouse_face
20424 && mouse_beg_col
< i
&& mouse_end_col
> end
)
20425 overlap_hl
= DRAW_MOUSE_FACE
;
20427 overlap_hl
= DRAW_NORMAL_TEXT
;
20429 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
20430 overlap_hl
, x
, last_x
);
20431 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
20432 append_glyph_string_lists (&head
, &tail
, h
, t
);
20436 /* Append glyph strings for glyphs following the last glyph
20437 string tail that overwrite tail. The foreground of such
20438 glyphs has to be drawn because it writes into the background
20439 of tail. The background must not be drawn because it could
20440 paint over the foreground of following glyphs. */
20441 i
= right_overwriting (tail
);
20444 enum draw_glyphs_face overlap_hl
;
20445 if (check_mouse_face
20446 && mouse_beg_col
< i
&& mouse_end_col
> end
)
20447 overlap_hl
= DRAW_MOUSE_FACE
;
20449 overlap_hl
= DRAW_NORMAL_TEXT
;
20452 i
++; /* We must include the Ith glyph. */
20453 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
20454 overlap_hl
, x
, last_x
);
20455 for (s
= h
; s
; s
= s
->next
)
20456 s
->background_filled_p
= 1;
20457 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
20458 append_glyph_string_lists (&head
, &tail
, h
, t
);
20460 if (clip_head
|| clip_tail
)
20461 for (s
= head
; s
; s
= s
->next
)
20463 s
->clip_head
= clip_head
;
20464 s
->clip_tail
= clip_tail
;
20468 /* Draw all strings. */
20469 for (s
= head
; s
; s
= s
->next
)
20470 FRAME_RIF (f
)->draw_glyph_string (s
);
20472 if (area
== TEXT_AREA
20473 && !row
->full_width_p
20474 /* When drawing overlapping rows, only the glyph strings'
20475 foreground is drawn, which doesn't erase a cursor
20479 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
20480 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
20481 : (tail
? tail
->x
+ tail
->background_width
: x
));
20485 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
20486 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
20489 /* Value is the x-position up to which drawn, relative to AREA of W.
20490 This doesn't include parts drawn because of overhangs. */
20491 if (row
->full_width_p
)
20492 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
20494 x_reached
-= area_left
;
20496 RELEASE_HDC (hdc
, f
);
20501 /* Expand row matrix if too narrow. Don't expand if area
20504 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
20506 if (!fonts_changed_p \
20507 && (it->glyph_row->glyphs[area] \
20508 < it->glyph_row->glyphs[area + 1])) \
20510 it->w->ncols_scale_factor++; \
20511 fonts_changed_p = 1; \
20515 /* Store one glyph for IT->char_to_display in IT->glyph_row.
20516 Called from x_produce_glyphs when IT->glyph_row is non-null. */
20522 struct glyph
*glyph
;
20523 enum glyph_row_area area
= it
->area
;
20525 xassert (it
->glyph_row
);
20526 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
20528 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20529 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20531 glyph
->charpos
= CHARPOS (it
->position
);
20532 glyph
->object
= it
->object
;
20533 if (it
->pixel_width
> 0)
20535 glyph
->pixel_width
= it
->pixel_width
;
20536 glyph
->padding_p
= 0;
20540 /* Assure at least 1-pixel width. Otherwise, cursor can't
20541 be displayed correctly. */
20542 glyph
->pixel_width
= 1;
20543 glyph
->padding_p
= 1;
20545 glyph
->ascent
= it
->ascent
;
20546 glyph
->descent
= it
->descent
;
20547 glyph
->voffset
= it
->voffset
;
20548 glyph
->type
= CHAR_GLYPH
;
20549 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
20550 glyph
->multibyte_p
= it
->multibyte_p
;
20551 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20552 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20553 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
20554 || it
->phys_descent
> it
->descent
);
20555 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
20556 glyph
->face_id
= it
->face_id
;
20557 glyph
->u
.ch
= it
->char_to_display
;
20558 glyph
->slice
= null_glyph_slice
;
20559 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20560 ++it
->glyph_row
->used
[area
];
20563 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20566 /* Store one glyph for the composition IT->cmp_id in IT->glyph_row.
20567 Called from x_produce_glyphs when IT->glyph_row is non-null. */
20570 append_composite_glyph (it
)
20573 struct glyph
*glyph
;
20574 enum glyph_row_area area
= it
->area
;
20576 xassert (it
->glyph_row
);
20578 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20579 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20581 glyph
->charpos
= CHARPOS (it
->position
);
20582 glyph
->object
= it
->object
;
20583 glyph
->pixel_width
= it
->pixel_width
;
20584 glyph
->ascent
= it
->ascent
;
20585 glyph
->descent
= it
->descent
;
20586 glyph
->voffset
= it
->voffset
;
20587 glyph
->type
= COMPOSITE_GLYPH
;
20588 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
20589 glyph
->multibyte_p
= it
->multibyte_p
;
20590 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20591 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20592 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
20593 || it
->phys_descent
> it
->descent
);
20594 glyph
->padding_p
= 0;
20595 glyph
->glyph_not_available_p
= 0;
20596 glyph
->face_id
= it
->face_id
;
20597 glyph
->u
.cmp_id
= it
->cmp_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)
20719 #if 0 /* this breaks image tiling */
20720 /* If this glyph is alone on the last line, adjust it.ascent to minimum row ascent. */
20721 int face_ascent
= face
->font
? FONT_BASE (face
->font
) : FRAME_BASELINE_OFFSET (it
->f
);
20722 if (face_ascent
> it
->ascent
)
20723 it
->ascent
= it
->phys_ascent
= face_ascent
;
20728 if (face
->box
!= FACE_NO_BOX
)
20730 if (face
->box_line_width
> 0)
20733 it
->ascent
+= face
->box_line_width
;
20734 if (slice
.y
+ slice
.height
== img
->height
)
20735 it
->descent
+= face
->box_line_width
;
20738 if (it
->start_of_box_run_p
&& slice
.x
== 0)
20739 it
->pixel_width
+= eabs (face
->box_line_width
);
20740 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
20741 it
->pixel_width
+= eabs (face
->box_line_width
);
20744 take_vertical_position_into_account (it
);
20746 /* Automatically crop wide image glyphs at right edge so we can
20747 draw the cursor on same display row. */
20748 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
20749 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
20751 it
->pixel_width
-= crop
;
20752 slice
.width
-= crop
;
20757 struct glyph
*glyph
;
20758 enum glyph_row_area area
= it
->area
;
20760 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20761 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20763 glyph
->charpos
= CHARPOS (it
->position
);
20764 glyph
->object
= it
->object
;
20765 glyph
->pixel_width
= it
->pixel_width
;
20766 glyph
->ascent
= glyph_ascent
;
20767 glyph
->descent
= it
->descent
;
20768 glyph
->voffset
= it
->voffset
;
20769 glyph
->type
= IMAGE_GLYPH
;
20770 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
20771 glyph
->multibyte_p
= it
->multibyte_p
;
20772 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20773 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20774 glyph
->overlaps_vertically_p
= 0;
20775 glyph
->padding_p
= 0;
20776 glyph
->glyph_not_available_p
= 0;
20777 glyph
->face_id
= it
->face_id
;
20778 glyph
->u
.img_id
= img
->id
;
20779 glyph
->slice
= slice
;
20780 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20781 ++it
->glyph_row
->used
[area
];
20784 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20789 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
20790 of the glyph, WIDTH and HEIGHT are the width and height of the
20791 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
20794 append_stretch_glyph (it
, object
, width
, height
, ascent
)
20796 Lisp_Object object
;
20800 struct glyph
*glyph
;
20801 enum glyph_row_area area
= it
->area
;
20803 xassert (ascent
>= 0 && ascent
<= height
);
20805 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20806 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20808 glyph
->charpos
= CHARPOS (it
->position
);
20809 glyph
->object
= object
;
20810 glyph
->pixel_width
= width
;
20811 glyph
->ascent
= ascent
;
20812 glyph
->descent
= height
- ascent
;
20813 glyph
->voffset
= it
->voffset
;
20814 glyph
->type
= STRETCH_GLYPH
;
20815 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
20816 glyph
->multibyte_p
= it
->multibyte_p
;
20817 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20818 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20819 glyph
->overlaps_vertically_p
= 0;
20820 glyph
->padding_p
= 0;
20821 glyph
->glyph_not_available_p
= 0;
20822 glyph
->face_id
= it
->face_id
;
20823 glyph
->u
.stretch
.ascent
= ascent
;
20824 glyph
->u
.stretch
.height
= height
;
20825 glyph
->slice
= null_glyph_slice
;
20826 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20827 ++it
->glyph_row
->used
[area
];
20830 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20834 /* Produce a stretch glyph for iterator IT. IT->object is the value
20835 of the glyph property displayed. The value must be a list
20836 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
20839 1. `:width WIDTH' specifies that the space should be WIDTH *
20840 canonical char width wide. WIDTH may be an integer or floating
20843 2. `:relative-width FACTOR' specifies that the width of the stretch
20844 should be computed from the width of the first character having the
20845 `glyph' property, and should be FACTOR times that width.
20847 3. `:align-to HPOS' specifies that the space should be wide enough
20848 to reach HPOS, a value in canonical character units.
20850 Exactly one of the above pairs must be present.
20852 4. `:height HEIGHT' specifies that the height of the stretch produced
20853 should be HEIGHT, measured in canonical character units.
20855 5. `:relative-height FACTOR' specifies that the height of the
20856 stretch should be FACTOR times the height of the characters having
20857 the glyph property.
20859 Either none or exactly one of 4 or 5 must be present.
20861 6. `:ascent ASCENT' specifies that ASCENT percent of the height
20862 of the stretch should be used for the ascent of the stretch.
20863 ASCENT must be in the range 0 <= ASCENT <= 100. */
20866 produce_stretch_glyph (it
)
20869 /* (space :width WIDTH :height HEIGHT ...) */
20870 Lisp_Object prop
, plist
;
20871 int width
= 0, height
= 0, align_to
= -1;
20872 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
20875 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20876 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
20878 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
20880 /* List should start with `space'. */
20881 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
20882 plist
= XCDR (it
->object
);
20884 /* Compute the width of the stretch. */
20885 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
20886 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
20888 /* Absolute width `:width WIDTH' specified and valid. */
20889 zero_width_ok_p
= 1;
20892 else if (prop
= Fplist_get (plist
, QCrelative_width
),
20895 /* Relative width `:relative-width FACTOR' specified and valid.
20896 Compute the width of the characters having the `glyph'
20899 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
20902 if (it
->multibyte_p
)
20904 int maxlen
= ((IT_BYTEPOS (*it
) >= GPT
? ZV
: GPT
)
20905 - IT_BYTEPOS (*it
));
20906 it2
.c
= STRING_CHAR_AND_LENGTH (p
, maxlen
, it2
.len
);
20909 it2
.c
= *p
, it2
.len
= 1;
20911 it2
.glyph_row
= NULL
;
20912 it2
.what
= IT_CHARACTER
;
20913 x_produce_glyphs (&it2
);
20914 width
= NUMVAL (prop
) * it2
.pixel_width
;
20916 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
20917 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
20919 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
20920 align_to
= (align_to
< 0
20922 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
20923 else if (align_to
< 0)
20924 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
20925 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
20926 zero_width_ok_p
= 1;
20929 /* Nothing specified -> width defaults to canonical char width. */
20930 width
= FRAME_COLUMN_WIDTH (it
->f
);
20932 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
20935 /* Compute height. */
20936 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
20937 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
20940 zero_height_ok_p
= 1;
20942 else if (prop
= Fplist_get (plist
, QCrelative_height
),
20944 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
20946 height
= FONT_HEIGHT (font
);
20948 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
20951 /* Compute percentage of height used for ascent. If
20952 `:ascent ASCENT' is present and valid, use that. Otherwise,
20953 derive the ascent from the font in use. */
20954 if (prop
= Fplist_get (plist
, QCascent
),
20955 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
20956 ascent
= height
* NUMVAL (prop
) / 100.0;
20957 else if (!NILP (prop
)
20958 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
20959 ascent
= min (max (0, (int)tem
), height
);
20961 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
20963 if (width
> 0 && it
->line_wrap
!= TRUNCATE
20964 && it
->current_x
+ width
> it
->last_visible_x
)
20965 width
= it
->last_visible_x
- it
->current_x
- 1;
20967 if (width
> 0 && height
> 0 && it
->glyph_row
)
20969 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
20970 if (!STRINGP (object
))
20971 object
= it
->w
->buffer
;
20972 append_stretch_glyph (it
, object
, width
, height
, ascent
);
20975 it
->pixel_width
= width
;
20976 it
->ascent
= it
->phys_ascent
= ascent
;
20977 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
20978 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
20980 take_vertical_position_into_account (it
);
20983 /* Calculate line-height and line-spacing properties.
20984 An integer value specifies explicit pixel value.
20985 A float value specifies relative value to current face height.
20986 A cons (float . face-name) specifies relative value to
20987 height of specified face font.
20989 Returns height in pixels, or nil. */
20993 calc_line_height_property (it
, val
, font
, boff
, override
)
20997 int boff
, override
;
20999 Lisp_Object face_name
= Qnil
;
21000 int ascent
, descent
, height
;
21002 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
21007 face_name
= XCAR (val
);
21009 if (!NUMBERP (val
))
21010 val
= make_number (1);
21011 if (NILP (face_name
))
21013 height
= it
->ascent
+ it
->descent
;
21018 if (NILP (face_name
))
21020 font
= FRAME_FONT (it
->f
);
21021 boff
= FRAME_BASELINE_OFFSET (it
->f
);
21023 else if (EQ (face_name
, Qt
))
21032 face_id
= lookup_named_face (it
->f
, face_name
, 0);
21034 return make_number (-1);
21036 face
= FACE_FROM_ID (it
->f
, face_id
);
21039 return make_number (-1);
21040 boff
= font
->baseline_offset
;
21041 if (font
->vertical_centering
)
21042 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
21045 ascent
= FONT_BASE (font
) + boff
;
21046 descent
= FONT_DESCENT (font
) - boff
;
21050 it
->override_ascent
= ascent
;
21051 it
->override_descent
= descent
;
21052 it
->override_boff
= boff
;
21055 height
= ascent
+ descent
;
21059 height
= (int)(XFLOAT_DATA (val
) * height
);
21060 else if (INTEGERP (val
))
21061 height
*= XINT (val
);
21063 return make_number (height
);
21068 Produce glyphs/get display metrics for the display element IT is
21069 loaded with. See the description of struct it in dispextern.h
21070 for an overview of struct it. */
21073 x_produce_glyphs (it
)
21076 int extra_line_spacing
= it
->extra_line_spacing
;
21078 it
->glyph_not_available_p
= 0;
21080 if (it
->what
== IT_CHARACTER
)
21084 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21085 struct font_metrics
*pcm
;
21086 int font_not_found_p
;
21087 int boff
; /* baseline offset */
21088 /* We may change it->multibyte_p upon unibyte<->multibyte
21089 conversion. So, save the current value now and restore it
21092 Note: It seems that we don't have to record multibyte_p in
21093 struct glyph because the character code itself tells if or
21094 not the character is multibyte. Thus, in the future, we must
21095 consider eliminating the field `multibyte_p' in the struct
21097 int saved_multibyte_p
= it
->multibyte_p
;
21099 /* Maybe translate single-byte characters to multibyte, or the
21101 it
->char_to_display
= it
->c
;
21102 if (!ASCII_BYTE_P (it
->c
)
21103 && ! it
->multibyte_p
)
21105 if (SINGLE_BYTE_CHAR_P (it
->c
)
21106 && unibyte_display_via_language_environment
)
21107 it
->char_to_display
= unibyte_char_to_multibyte (it
->c
);
21108 if (! SINGLE_BYTE_CHAR_P (it
->char_to_display
))
21110 it
->multibyte_p
= 1;
21111 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
,
21113 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21117 /* Get font to use. Encode IT->char_to_display. */
21118 get_char_face_and_encoding (it
->f
, it
->char_to_display
, it
->face_id
,
21119 &char2b
, it
->multibyte_p
, 0);
21122 /* When no suitable font found, use the default font. */
21123 font_not_found_p
= font
== NULL
;
21124 if (font_not_found_p
)
21126 font
= FRAME_FONT (it
->f
);
21127 boff
= FRAME_BASELINE_OFFSET (it
->f
);
21131 boff
= font
->baseline_offset
;
21132 if (font
->vertical_centering
)
21133 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
21136 if (it
->char_to_display
>= ' '
21137 && (!it
->multibyte_p
|| it
->char_to_display
< 128))
21139 /* Either unibyte or ASCII. */
21144 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
21146 if (it
->override_ascent
>= 0)
21148 it
->ascent
= it
->override_ascent
;
21149 it
->descent
= it
->override_descent
;
21150 boff
= it
->override_boff
;
21154 it
->ascent
= FONT_BASE (font
) + boff
;
21155 it
->descent
= FONT_DESCENT (font
) - boff
;
21160 it
->phys_ascent
= pcm
->ascent
+ boff
;
21161 it
->phys_descent
= pcm
->descent
- boff
;
21162 it
->pixel_width
= pcm
->width
;
21166 it
->glyph_not_available_p
= 1;
21167 it
->phys_ascent
= it
->ascent
;
21168 it
->phys_descent
= it
->descent
;
21169 it
->pixel_width
= FONT_WIDTH (font
);
21172 if (it
->constrain_row_ascent_descent_p
)
21174 if (it
->descent
> it
->max_descent
)
21176 it
->ascent
+= it
->descent
- it
->max_descent
;
21177 it
->descent
= it
->max_descent
;
21179 if (it
->ascent
> it
->max_ascent
)
21181 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
21182 it
->ascent
= it
->max_ascent
;
21184 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
21185 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
21186 extra_line_spacing
= 0;
21189 /* If this is a space inside a region of text with
21190 `space-width' property, change its width. */
21191 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
21193 it
->pixel_width
*= XFLOATINT (it
->space_width
);
21195 /* If face has a box, add the box thickness to the character
21196 height. If character has a box line to the left and/or
21197 right, add the box line width to the character's width. */
21198 if (face
->box
!= FACE_NO_BOX
)
21200 int thick
= face
->box_line_width
;
21204 it
->ascent
+= thick
;
21205 it
->descent
+= thick
;
21210 if (it
->start_of_box_run_p
)
21211 it
->pixel_width
+= thick
;
21212 if (it
->end_of_box_run_p
)
21213 it
->pixel_width
+= thick
;
21216 /* If face has an overline, add the height of the overline
21217 (1 pixel) and a 1 pixel margin to the character height. */
21218 if (face
->overline_p
)
21219 it
->ascent
+= overline_margin
;
21221 if (it
->constrain_row_ascent_descent_p
)
21223 if (it
->ascent
> it
->max_ascent
)
21224 it
->ascent
= it
->max_ascent
;
21225 if (it
->descent
> it
->max_descent
)
21226 it
->descent
= it
->max_descent
;
21229 take_vertical_position_into_account (it
);
21231 /* If we have to actually produce glyphs, do it. */
21236 /* Translate a space with a `space-width' property
21237 into a stretch glyph. */
21238 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
21239 / FONT_HEIGHT (font
));
21240 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
21241 it
->ascent
+ it
->descent
, ascent
);
21246 /* If characters with lbearing or rbearing are displayed
21247 in this line, record that fact in a flag of the
21248 glyph row. This is used to optimize X output code. */
21249 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
21250 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
21252 if (! stretched_p
&& it
->pixel_width
== 0)
21253 /* We assure that all visible glyphs have at least 1-pixel
21255 it
->pixel_width
= 1;
21257 else if (it
->char_to_display
== '\n')
21259 /* A newline has no width but we need the height of the line.
21260 But if previous part of the line set a height, don't
21261 increase that height */
21263 Lisp_Object height
;
21264 Lisp_Object total_height
= Qnil
;
21266 it
->override_ascent
= -1;
21267 it
->pixel_width
= 0;
21270 height
= get_it_property(it
, Qline_height
);
21271 /* Split (line-height total-height) list */
21273 && CONSP (XCDR (height
))
21274 && NILP (XCDR (XCDR (height
))))
21276 total_height
= XCAR (XCDR (height
));
21277 height
= XCAR (height
);
21279 height
= calc_line_height_property(it
, height
, font
, boff
, 1);
21281 if (it
->override_ascent
>= 0)
21283 it
->ascent
= it
->override_ascent
;
21284 it
->descent
= it
->override_descent
;
21285 boff
= it
->override_boff
;
21289 it
->ascent
= FONT_BASE (font
) + boff
;
21290 it
->descent
= FONT_DESCENT (font
) - boff
;
21293 if (EQ (height
, Qt
))
21295 if (it
->descent
> it
->max_descent
)
21297 it
->ascent
+= it
->descent
- it
->max_descent
;
21298 it
->descent
= it
->max_descent
;
21300 if (it
->ascent
> it
->max_ascent
)
21302 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
21303 it
->ascent
= it
->max_ascent
;
21305 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
21306 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
21307 it
->constrain_row_ascent_descent_p
= 1;
21308 extra_line_spacing
= 0;
21312 Lisp_Object spacing
;
21314 it
->phys_ascent
= it
->ascent
;
21315 it
->phys_descent
= it
->descent
;
21317 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
21318 && face
->box
!= FACE_NO_BOX
21319 && face
->box_line_width
> 0)
21321 it
->ascent
+= face
->box_line_width
;
21322 it
->descent
+= face
->box_line_width
;
21325 && XINT (height
) > it
->ascent
+ it
->descent
)
21326 it
->ascent
= XINT (height
) - it
->descent
;
21328 if (!NILP (total_height
))
21329 spacing
= calc_line_height_property(it
, total_height
, font
, boff
, 0);
21332 spacing
= get_it_property(it
, Qline_spacing
);
21333 spacing
= calc_line_height_property(it
, spacing
, font
, boff
, 0);
21335 if (INTEGERP (spacing
))
21337 extra_line_spacing
= XINT (spacing
);
21338 if (!NILP (total_height
))
21339 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
21343 else if (it
->char_to_display
== '\t')
21345 int tab_width
= it
->tab_width
* font
->space_width
;
21346 int x
= it
->current_x
+ it
->continuation_lines_width
;
21347 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
21349 /* If the distance from the current position to the next tab
21350 stop is less than a space character width, use the
21351 tab stop after that. */
21352 if (next_tab_x
- x
< font
->space_width
)
21353 next_tab_x
+= tab_width
;
21355 it
->pixel_width
= next_tab_x
- x
;
21357 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
21358 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
21362 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
21363 it
->ascent
+ it
->descent
, it
->ascent
);
21368 /* A multi-byte character. Assume that the display width of the
21369 character is the width of the character multiplied by the
21370 width of the font. */
21372 /* If we found a font, this font should give us the right
21373 metrics. If we didn't find a font, use the frame's
21374 default font and calculate the width of the character by
21375 multiplying the width of font by the width of the
21378 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
21380 if (font_not_found_p
|| !pcm
)
21382 int char_width
= CHAR_WIDTH (it
->char_to_display
);
21384 if (char_width
== 0)
21385 /* This is a non spacing character. But, as we are
21386 going to display an empty box, the box must occupy
21387 at least one column. */
21389 it
->glyph_not_available_p
= 1;
21390 it
->pixel_width
= FRAME_COLUMN_WIDTH (it
->f
) * char_width
;
21391 it
->phys_ascent
= FONT_BASE (font
) + boff
;
21392 it
->phys_descent
= FONT_DESCENT (font
) - boff
;
21396 it
->pixel_width
= pcm
->width
;
21397 it
->phys_ascent
= pcm
->ascent
+ boff
;
21398 it
->phys_descent
= pcm
->descent
- boff
;
21400 && (pcm
->lbearing
< 0
21401 || pcm
->rbearing
> pcm
->width
))
21402 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
21405 it
->ascent
= FONT_BASE (font
) + boff
;
21406 it
->descent
= FONT_DESCENT (font
) - boff
;
21407 if (face
->box
!= FACE_NO_BOX
)
21409 int thick
= face
->box_line_width
;
21413 it
->ascent
+= thick
;
21414 it
->descent
+= thick
;
21419 if (it
->start_of_box_run_p
)
21420 it
->pixel_width
+= thick
;
21421 if (it
->end_of_box_run_p
)
21422 it
->pixel_width
+= thick
;
21425 /* If face has an overline, add the height of the overline
21426 (1 pixel) and a 1 pixel margin to the character height. */
21427 if (face
->overline_p
)
21428 it
->ascent
+= overline_margin
;
21430 take_vertical_position_into_account (it
);
21432 if (it
->ascent
< 0)
21434 if (it
->descent
< 0)
21439 if (it
->pixel_width
== 0)
21440 /* We assure that all visible glyphs have at least 1-pixel
21442 it
->pixel_width
= 1;
21444 it
->multibyte_p
= saved_multibyte_p
;
21446 else if (it
->what
== IT_COMPOSITION
)
21448 /* Note: A composition is represented as one glyph in the
21449 glyph matrix. There are no padding glyphs.
21451 Important is that pixel_width, ascent, and descent are the
21452 values of what is drawn by draw_glyphs (i.e. the values of
21453 the overall glyphs composed). */
21454 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21455 int boff
; /* baseline offset */
21456 struct composition
*cmp
= composition_table
[it
->cmp_id
];
21457 int glyph_len
= cmp
->glyph_len
;
21458 struct font
*font
= face
->font
;
21462 if (cmp
->method
== COMPOSITION_WITH_GLYPH_STRING
)
21464 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21465 font_prepare_composition (cmp
, it
->f
);
21468 /* If we have not yet calculated pixel size data of glyphs of
21469 the composition for the current face font, calculate them
21470 now. Theoretically, we have to check all fonts for the
21471 glyphs, but that requires much time and memory space. So,
21472 here we check only the font of the first glyph. This leads
21473 to incorrect display, but it's very rare, and C-l (recenter)
21474 can correct the display anyway. */
21475 if (! cmp
->font
|| cmp
->font
!= font
)
21477 /* Ascent and descent of the font of the first character
21478 of this composition (adjusted by baseline offset).
21479 Ascent and descent of overall glyphs should not be less
21480 than them respectively. */
21481 int font_ascent
, font_descent
, font_height
;
21482 /* Bounding box of the overall glyphs. */
21483 int leftmost
, rightmost
, lowest
, highest
;
21484 int lbearing
, rbearing
;
21485 int i
, width
, ascent
, descent
;
21486 int left_padded
= 0, right_padded
= 0;
21490 struct font_metrics
*pcm
;
21491 int font_not_found_p
;
21494 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
21495 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
21497 if (glyph_len
< cmp
->glyph_len
)
21499 for (i
= 0; i
< glyph_len
; i
++)
21501 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
21503 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
21508 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
21509 : IT_CHARPOS (*it
));
21510 /* When no suitable font found, use the default font. */
21511 font_not_found_p
= font
== NULL
;
21512 if (font_not_found_p
)
21514 face
= face
->ascii_face
;
21517 boff
= font
->baseline_offset
;
21518 if (font
->vertical_centering
)
21519 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
21520 font_ascent
= FONT_BASE (font
) + boff
;
21521 font_descent
= FONT_DESCENT (font
) - boff
;
21522 font_height
= FONT_HEIGHT (font
);
21524 cmp
->font
= (void *) font
;
21527 if (! font_not_found_p
)
21529 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
21530 &char2b
, it
->multibyte_p
, 0);
21531 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
21534 /* Initialize the bounding box. */
21537 width
= pcm
->width
;
21538 ascent
= pcm
->ascent
;
21539 descent
= pcm
->descent
;
21540 lbearing
= pcm
->lbearing
;
21541 rbearing
= pcm
->rbearing
;
21545 width
= FONT_WIDTH (font
);
21546 ascent
= FONT_BASE (font
);
21547 descent
= FONT_DESCENT (font
);
21554 lowest
= - descent
+ boff
;
21555 highest
= ascent
+ boff
;
21557 if (! font_not_found_p
21558 && font
->default_ascent
21559 && CHAR_TABLE_P (Vuse_default_ascent
)
21560 && !NILP (Faref (Vuse_default_ascent
,
21561 make_number (it
->char_to_display
))))
21562 highest
= font
->default_ascent
+ boff
;
21564 /* Draw the first glyph at the normal position. It may be
21565 shifted to right later if some other glyphs are drawn
21567 cmp
->offsets
[i
* 2] = 0;
21568 cmp
->offsets
[i
* 2 + 1] = boff
;
21569 cmp
->lbearing
= lbearing
;
21570 cmp
->rbearing
= rbearing
;
21572 /* Set cmp->offsets for the remaining glyphs. */
21573 for (i
++; i
< glyph_len
; i
++)
21575 int left
, right
, btm
, top
;
21576 int ch
= COMPOSITION_GLYPH (cmp
, i
);
21578 struct face
*this_face
;
21583 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
21584 this_face
= FACE_FROM_ID (it
->f
, face_id
);
21585 font
= this_face
->font
;
21591 this_boff
= font
->baseline_offset
;
21592 if (font
->vertical_centering
)
21593 this_boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
21594 get_char_face_and_encoding (it
->f
, ch
, face_id
,
21595 &char2b
, it
->multibyte_p
, 0);
21596 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
21599 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
21602 width
= pcm
->width
;
21603 ascent
= pcm
->ascent
;
21604 descent
= pcm
->descent
;
21605 lbearing
= pcm
->lbearing
;
21606 rbearing
= pcm
->rbearing
;
21607 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
21609 /* Relative composition with or without
21610 alternate chars. */
21611 left
= (leftmost
+ rightmost
- width
) / 2;
21612 btm
= - descent
+ boff
;
21613 if (font
->relative_compose
21614 && (! CHAR_TABLE_P (Vignore_relative_composition
)
21615 || NILP (Faref (Vignore_relative_composition
,
21616 make_number (ch
)))))
21619 if (- descent
>= font
->relative_compose
)
21620 /* One extra pixel between two glyphs. */
21622 else if (ascent
<= 0)
21623 /* One extra pixel between two glyphs. */
21624 btm
= lowest
- 1 - ascent
- descent
;
21629 /* A composition rule is specified by an integer
21630 value that encodes global and new reference
21631 points (GREF and NREF). GREF and NREF are
21632 specified by numbers as below:
21634 0---1---2 -- ascent
21638 9--10--11 -- center
21640 ---3---4---5--- baseline
21642 6---7---8 -- descent
21644 int rule
= COMPOSITION_RULE (cmp
, i
);
21645 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
21647 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
21648 grefx
= gref
% 3, nrefx
= nref
% 3;
21649 grefy
= gref
/ 3, nrefy
= nref
/ 3;
21651 xoff
= font_height
* (xoff
- 128) / 256;
21653 yoff
= font_height
* (yoff
- 128) / 256;
21656 + grefx
* (rightmost
- leftmost
) / 2
21657 - nrefx
* width
/ 2
21660 btm
= ((grefy
== 0 ? highest
21662 : grefy
== 2 ? lowest
21663 : (highest
+ lowest
) / 2)
21664 - (nrefy
== 0 ? ascent
+ descent
21665 : nrefy
== 1 ? descent
- boff
21667 : (ascent
+ descent
) / 2)
21671 cmp
->offsets
[i
* 2] = left
;
21672 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
21674 /* Update the bounding box of the overall glyphs. */
21677 right
= left
+ width
;
21678 if (left
< leftmost
)
21680 if (right
> rightmost
)
21683 top
= btm
+ descent
+ ascent
;
21689 if (cmp
->lbearing
> left
+ lbearing
)
21690 cmp
->lbearing
= left
+ lbearing
;
21691 if (cmp
->rbearing
< left
+ rbearing
)
21692 cmp
->rbearing
= left
+ rbearing
;
21696 /* If there are glyphs whose x-offsets are negative,
21697 shift all glyphs to the right and make all x-offsets
21701 for (i
= 0; i
< cmp
->glyph_len
; i
++)
21702 cmp
->offsets
[i
* 2] -= leftmost
;
21703 rightmost
-= leftmost
;
21704 cmp
->lbearing
-= leftmost
;
21705 cmp
->rbearing
-= leftmost
;
21708 if (left_padded
&& cmp
->lbearing
< 0)
21710 for (i
= 0; i
< cmp
->glyph_len
; i
++)
21711 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
21712 rightmost
-= cmp
->lbearing
;
21713 cmp
->rbearing
-= cmp
->lbearing
;
21716 if (right_padded
&& rightmost
< cmp
->rbearing
)
21718 rightmost
= cmp
->rbearing
;
21721 cmp
->pixel_width
= rightmost
;
21722 cmp
->ascent
= highest
;
21723 cmp
->descent
= - lowest
;
21724 if (cmp
->ascent
< font_ascent
)
21725 cmp
->ascent
= font_ascent
;
21726 if (cmp
->descent
< font_descent
)
21727 cmp
->descent
= font_descent
;
21731 && (cmp
->lbearing
< 0
21732 || cmp
->rbearing
> cmp
->pixel_width
))
21733 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
21735 it
->pixel_width
= cmp
->pixel_width
;
21736 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
21737 it
->descent
= it
->phys_descent
= cmp
->descent
;
21738 if (face
->box
!= FACE_NO_BOX
)
21740 int thick
= face
->box_line_width
;
21744 it
->ascent
+= thick
;
21745 it
->descent
+= thick
;
21750 if (it
->start_of_box_run_p
)
21751 it
->pixel_width
+= thick
;
21752 if (it
->end_of_box_run_p
)
21753 it
->pixel_width
+= thick
;
21756 /* If face has an overline, add the height of the overline
21757 (1 pixel) and a 1 pixel margin to the character height. */
21758 if (face
->overline_p
)
21759 it
->ascent
+= overline_margin
;
21761 take_vertical_position_into_account (it
);
21762 if (it
->ascent
< 0)
21764 if (it
->descent
< 0)
21768 append_composite_glyph (it
);
21770 else if (it
->what
== IT_IMAGE
)
21771 produce_image_glyph (it
);
21772 else if (it
->what
== IT_STRETCH
)
21773 produce_stretch_glyph (it
);
21775 /* Accumulate dimensions. Note: can't assume that it->descent > 0
21776 because this isn't true for images with `:ascent 100'. */
21777 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
21778 if (it
->area
== TEXT_AREA
)
21779 it
->current_x
+= it
->pixel_width
;
21781 if (extra_line_spacing
> 0)
21783 it
->descent
+= extra_line_spacing
;
21784 if (extra_line_spacing
> it
->max_extra_line_spacing
)
21785 it
->max_extra_line_spacing
= extra_line_spacing
;
21788 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
21789 it
->max_descent
= max (it
->max_descent
, it
->descent
);
21790 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
21791 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
21795 Output LEN glyphs starting at START at the nominal cursor position.
21796 Advance the nominal cursor over the text. The global variable
21797 updated_window contains the window being updated, updated_row is
21798 the glyph row being updated, and updated_area is the area of that
21799 row being updated. */
21802 x_write_glyphs (start
, len
)
21803 struct glyph
*start
;
21808 xassert (updated_window
&& updated_row
);
21811 /* Write glyphs. */
21813 hpos
= start
- updated_row
->glyphs
[updated_area
];
21814 x
= draw_glyphs (updated_window
, output_cursor
.x
,
21815 updated_row
, updated_area
,
21817 DRAW_NORMAL_TEXT
, 0);
21819 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
21820 if (updated_area
== TEXT_AREA
21821 && updated_window
->phys_cursor_on_p
21822 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
21823 && updated_window
->phys_cursor
.hpos
>= hpos
21824 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
21825 updated_window
->phys_cursor_on_p
= 0;
21829 /* Advance the output cursor. */
21830 output_cursor
.hpos
+= len
;
21831 output_cursor
.x
= x
;
21836 Insert LEN glyphs from START at the nominal cursor position. */
21839 x_insert_glyphs (start
, len
)
21840 struct glyph
*start
;
21845 int line_height
, shift_by_width
, shifted_region_width
;
21846 struct glyph_row
*row
;
21847 struct glyph
*glyph
;
21848 int frame_x
, frame_y
;
21851 xassert (updated_window
&& updated_row
);
21853 w
= updated_window
;
21854 f
= XFRAME (WINDOW_FRAME (w
));
21856 /* Get the height of the line we are in. */
21858 line_height
= row
->height
;
21860 /* Get the width of the glyphs to insert. */
21861 shift_by_width
= 0;
21862 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
21863 shift_by_width
+= glyph
->pixel_width
;
21865 /* Get the width of the region to shift right. */
21866 shifted_region_width
= (window_box_width (w
, updated_area
)
21871 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
21872 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
21874 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
21875 line_height
, shift_by_width
);
21877 /* Write the glyphs. */
21878 hpos
= start
- row
->glyphs
[updated_area
];
21879 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
21881 DRAW_NORMAL_TEXT
, 0);
21883 /* Advance the output cursor. */
21884 output_cursor
.hpos
+= len
;
21885 output_cursor
.x
+= shift_by_width
;
21891 Erase the current text line from the nominal cursor position
21892 (inclusive) to pixel column TO_X (exclusive). The idea is that
21893 everything from TO_X onward is already erased.
21895 TO_X is a pixel position relative to updated_area of
21896 updated_window. TO_X == -1 means clear to the end of this area. */
21899 x_clear_end_of_line (to_x
)
21903 struct window
*w
= updated_window
;
21904 int max_x
, min_y
, max_y
;
21905 int from_x
, from_y
, to_y
;
21907 xassert (updated_window
&& updated_row
);
21908 f
= XFRAME (w
->frame
);
21910 if (updated_row
->full_width_p
)
21911 max_x
= WINDOW_TOTAL_WIDTH (w
);
21913 max_x
= window_box_width (w
, updated_area
);
21914 max_y
= window_text_bottom_y (w
);
21916 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
21917 of window. For TO_X > 0, truncate to end of drawing area. */
21923 to_x
= min (to_x
, max_x
);
21925 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
21927 /* Notice if the cursor will be cleared by this operation. */
21928 if (!updated_row
->full_width_p
)
21929 notice_overwritten_cursor (w
, updated_area
,
21930 output_cursor
.x
, -1,
21932 MATRIX_ROW_BOTTOM_Y (updated_row
));
21934 from_x
= output_cursor
.x
;
21936 /* Translate to frame coordinates. */
21937 if (updated_row
->full_width_p
)
21939 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
21940 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
21944 int area_left
= window_box_left (w
, updated_area
);
21945 from_x
+= area_left
;
21949 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
21950 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
21951 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
21953 /* Prevent inadvertently clearing to end of the X window. */
21954 if (to_x
> from_x
&& to_y
> from_y
)
21957 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
21958 to_x
- from_x
, to_y
- from_y
);
21963 #endif /* HAVE_WINDOW_SYSTEM */
21967 /***********************************************************************
21969 ***********************************************************************/
21971 /* Value is the internal representation of the specified cursor type
21972 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
21973 of the bar cursor. */
21975 static enum text_cursor_kinds
21976 get_specified_cursor_type (arg
, width
)
21980 enum text_cursor_kinds type
;
21985 if (EQ (arg
, Qbox
))
21986 return FILLED_BOX_CURSOR
;
21988 if (EQ (arg
, Qhollow
))
21989 return HOLLOW_BOX_CURSOR
;
21991 if (EQ (arg
, Qbar
))
21998 && EQ (XCAR (arg
), Qbar
)
21999 && INTEGERP (XCDR (arg
))
22000 && XINT (XCDR (arg
)) >= 0)
22002 *width
= XINT (XCDR (arg
));
22006 if (EQ (arg
, Qhbar
))
22009 return HBAR_CURSOR
;
22013 && EQ (XCAR (arg
), Qhbar
)
22014 && INTEGERP (XCDR (arg
))
22015 && XINT (XCDR (arg
)) >= 0)
22017 *width
= XINT (XCDR (arg
));
22018 return HBAR_CURSOR
;
22021 /* Treat anything unknown as "hollow box cursor".
22022 It was bad to signal an error; people have trouble fixing
22023 .Xdefaults with Emacs, when it has something bad in it. */
22024 type
= HOLLOW_BOX_CURSOR
;
22029 /* Set the default cursor types for specified frame. */
22031 set_frame_cursor_types (f
, arg
)
22038 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
22039 FRAME_CURSOR_WIDTH (f
) = width
;
22041 /* By default, set up the blink-off state depending on the on-state. */
22043 tem
= Fassoc (arg
, Vblink_cursor_alist
);
22046 FRAME_BLINK_OFF_CURSOR (f
)
22047 = get_specified_cursor_type (XCDR (tem
), &width
);
22048 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
22051 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
22055 /* Return the cursor we want to be displayed in window W. Return
22056 width of bar/hbar cursor through WIDTH arg. Return with
22057 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
22058 (i.e. if the `system caret' should track this cursor).
22060 In a mini-buffer window, we want the cursor only to appear if we
22061 are reading input from this window. For the selected window, we
22062 want the cursor type given by the frame parameter or buffer local
22063 setting of cursor-type. If explicitly marked off, draw no cursor.
22064 In all other cases, we want a hollow box cursor. */
22066 static enum text_cursor_kinds
22067 get_window_cursor_type (w
, glyph
, width
, active_cursor
)
22069 struct glyph
*glyph
;
22071 int *active_cursor
;
22073 struct frame
*f
= XFRAME (w
->frame
);
22074 struct buffer
*b
= XBUFFER (w
->buffer
);
22075 int cursor_type
= DEFAULT_CURSOR
;
22076 Lisp_Object alt_cursor
;
22077 int non_selected
= 0;
22079 *active_cursor
= 1;
22082 if (cursor_in_echo_area
22083 && FRAME_HAS_MINIBUF_P (f
)
22084 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
22086 if (w
== XWINDOW (echo_area_window
))
22088 if (EQ (b
->cursor_type
, Qt
) || NILP (b
->cursor_type
))
22090 *width
= FRAME_CURSOR_WIDTH (f
);
22091 return FRAME_DESIRED_CURSOR (f
);
22094 return get_specified_cursor_type (b
->cursor_type
, width
);
22097 *active_cursor
= 0;
22101 /* Detect a nonselected window or nonselected frame. */
22102 else if (w
!= XWINDOW (f
->selected_window
)
22103 #ifdef HAVE_WINDOW_SYSTEM
22104 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
22108 *active_cursor
= 0;
22110 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
22116 /* Never display a cursor in a window in which cursor-type is nil. */
22117 if (NILP (b
->cursor_type
))
22120 /* Get the normal cursor type for this window. */
22121 if (EQ (b
->cursor_type
, Qt
))
22123 cursor_type
= FRAME_DESIRED_CURSOR (f
);
22124 *width
= FRAME_CURSOR_WIDTH (f
);
22127 cursor_type
= get_specified_cursor_type (b
->cursor_type
, width
);
22129 /* Use cursor-in-non-selected-windows instead
22130 for non-selected window or frame. */
22133 alt_cursor
= b
->cursor_in_non_selected_windows
;
22134 if (!EQ (Qt
, alt_cursor
))
22135 return get_specified_cursor_type (alt_cursor
, width
);
22136 /* t means modify the normal cursor type. */
22137 if (cursor_type
== FILLED_BOX_CURSOR
)
22138 cursor_type
= HOLLOW_BOX_CURSOR
;
22139 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
22141 return cursor_type
;
22144 /* Use normal cursor if not blinked off. */
22145 if (!w
->cursor_off_p
)
22147 #ifdef HAVE_WINDOW_SYSTEM
22148 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
22150 if (cursor_type
== FILLED_BOX_CURSOR
)
22152 /* Using a block cursor on large images can be very annoying.
22153 So use a hollow cursor for "large" images.
22154 If image is not transparent (no mask), also use hollow cursor. */
22155 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
22156 if (img
!= NULL
&& IMAGEP (img
->spec
))
22158 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
22159 where N = size of default frame font size.
22160 This should cover most of the "tiny" icons people may use. */
22162 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
22163 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
22164 cursor_type
= HOLLOW_BOX_CURSOR
;
22167 else if (cursor_type
!= NO_CURSOR
)
22169 /* Display current only supports BOX and HOLLOW cursors for images.
22170 So for now, unconditionally use a HOLLOW cursor when cursor is
22171 not a solid box cursor. */
22172 cursor_type
= HOLLOW_BOX_CURSOR
;
22176 return cursor_type
;
22179 /* Cursor is blinked off, so determine how to "toggle" it. */
22181 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
22182 if ((alt_cursor
= Fassoc (b
->cursor_type
, Vblink_cursor_alist
), !NILP (alt_cursor
)))
22183 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
22185 /* Then see if frame has specified a specific blink off cursor type. */
22186 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
22188 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
22189 return FRAME_BLINK_OFF_CURSOR (f
);
22193 /* Some people liked having a permanently visible blinking cursor,
22194 while others had very strong opinions against it. So it was
22195 decided to remove it. KFS 2003-09-03 */
22197 /* Finally perform built-in cursor blinking:
22198 filled box <-> hollow box
22199 wide [h]bar <-> narrow [h]bar
22200 narrow [h]bar <-> no cursor
22201 other type <-> no cursor */
22203 if (cursor_type
== FILLED_BOX_CURSOR
)
22204 return HOLLOW_BOX_CURSOR
;
22206 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
22209 return cursor_type
;
22217 #ifdef HAVE_WINDOW_SYSTEM
22219 /* Notice when the text cursor of window W has been completely
22220 overwritten by a drawing operation that outputs glyphs in AREA
22221 starting at X0 and ending at X1 in the line starting at Y0 and
22222 ending at Y1. X coordinates are area-relative. X1 < 0 means all
22223 the rest of the line after X0 has been written. Y coordinates
22224 are window-relative. */
22227 notice_overwritten_cursor (w
, area
, x0
, x1
, y0
, y1
)
22229 enum glyph_row_area area
;
22230 int x0
, y0
, x1
, y1
;
22232 int cx0
, cx1
, cy0
, cy1
;
22233 struct glyph_row
*row
;
22235 if (!w
->phys_cursor_on_p
)
22237 if (area
!= TEXT_AREA
)
22240 if (w
->phys_cursor
.vpos
< 0
22241 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
22242 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
22243 !(row
->enabled_p
&& row
->displays_text_p
)))
22246 if (row
->cursor_in_fringe_p
)
22248 row
->cursor_in_fringe_p
= 0;
22249 draw_fringe_bitmap (w
, row
, 0);
22250 w
->phys_cursor_on_p
= 0;
22254 cx0
= w
->phys_cursor
.x
;
22255 cx1
= cx0
+ w
->phys_cursor_width
;
22256 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
22259 /* The cursor image will be completely removed from the
22260 screen if the output area intersects the cursor area in
22261 y-direction. When we draw in [y0 y1[, and some part of
22262 the cursor is at y < y0, that part must have been drawn
22263 before. When scrolling, the cursor is erased before
22264 actually scrolling, so we don't come here. When not
22265 scrolling, the rows above the old cursor row must have
22266 changed, and in this case these rows must have written
22267 over the cursor image.
22269 Likewise if part of the cursor is below y1, with the
22270 exception of the cursor being in the first blank row at
22271 the buffer and window end because update_text_area
22272 doesn't draw that row. (Except when it does, but
22273 that's handled in update_text_area.) */
22275 cy0
= w
->phys_cursor
.y
;
22276 cy1
= cy0
+ w
->phys_cursor_height
;
22277 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
22280 w
->phys_cursor_on_p
= 0;
22283 #endif /* HAVE_WINDOW_SYSTEM */
22286 /************************************************************************
22288 ************************************************************************/
22290 #ifdef HAVE_WINDOW_SYSTEM
22293 Fix the display of area AREA of overlapping row ROW in window W
22294 with respect to the overlapping part OVERLAPS. */
22297 x_fix_overlapping_area (w
, row
, area
, overlaps
)
22299 struct glyph_row
*row
;
22300 enum glyph_row_area area
;
22308 for (i
= 0; i
< row
->used
[area
];)
22310 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
22312 int start
= i
, start_x
= x
;
22316 x
+= row
->glyphs
[area
][i
].pixel_width
;
22319 while (i
< row
->used
[area
]
22320 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
22322 draw_glyphs (w
, start_x
, row
, area
,
22324 DRAW_NORMAL_TEXT
, overlaps
);
22328 x
+= row
->glyphs
[area
][i
].pixel_width
;
22338 Draw the cursor glyph of window W in glyph row ROW. See the
22339 comment of draw_glyphs for the meaning of HL. */
22342 draw_phys_cursor_glyph (w
, row
, hl
)
22344 struct glyph_row
*row
;
22345 enum draw_glyphs_face hl
;
22347 /* If cursor hpos is out of bounds, don't draw garbage. This can
22348 happen in mini-buffer windows when switching between echo area
22349 glyphs and mini-buffer. */
22350 if (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])
22352 int on_p
= w
->phys_cursor_on_p
;
22354 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
22355 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
22357 w
->phys_cursor_on_p
= on_p
;
22359 if (hl
== DRAW_CURSOR
)
22360 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
22361 /* When we erase the cursor, and ROW is overlapped by other
22362 rows, make sure that these overlapping parts of other rows
22364 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
22366 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
22368 if (row
> w
->current_matrix
->rows
22369 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
22370 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
22371 OVERLAPS_ERASED_CURSOR
);
22373 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
22374 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
22375 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
22376 OVERLAPS_ERASED_CURSOR
);
22383 Erase the image of a cursor of window W from the screen. */
22386 erase_phys_cursor (w
)
22389 struct frame
*f
= XFRAME (w
->frame
);
22390 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
22391 int hpos
= w
->phys_cursor
.hpos
;
22392 int vpos
= w
->phys_cursor
.vpos
;
22393 int mouse_face_here_p
= 0;
22394 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
22395 struct glyph_row
*cursor_row
;
22396 struct glyph
*cursor_glyph
;
22397 enum draw_glyphs_face hl
;
22399 /* No cursor displayed or row invalidated => nothing to do on the
22401 if (w
->phys_cursor_type
== NO_CURSOR
)
22402 goto mark_cursor_off
;
22404 /* VPOS >= active_glyphs->nrows means that window has been resized.
22405 Don't bother to erase the cursor. */
22406 if (vpos
>= active_glyphs
->nrows
)
22407 goto mark_cursor_off
;
22409 /* If row containing cursor is marked invalid, there is nothing we
22411 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
22412 if (!cursor_row
->enabled_p
)
22413 goto mark_cursor_off
;
22415 /* If line spacing is > 0, old cursor may only be partially visible in
22416 window after split-window. So adjust visible height. */
22417 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
22418 window_text_bottom_y (w
) - cursor_row
->y
);
22420 /* If row is completely invisible, don't attempt to delete a cursor which
22421 isn't there. This can happen if cursor is at top of a window, and
22422 we switch to a buffer with a header line in that window. */
22423 if (cursor_row
->visible_height
<= 0)
22424 goto mark_cursor_off
;
22426 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
22427 if (cursor_row
->cursor_in_fringe_p
)
22429 cursor_row
->cursor_in_fringe_p
= 0;
22430 draw_fringe_bitmap (w
, cursor_row
, 0);
22431 goto mark_cursor_off
;
22434 /* This can happen when the new row is shorter than the old one.
22435 In this case, either draw_glyphs or clear_end_of_line
22436 should have cleared the cursor. Note that we wouldn't be
22437 able to erase the cursor in this case because we don't have a
22438 cursor glyph at hand. */
22439 if (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])
22440 goto mark_cursor_off
;
22442 /* If the cursor is in the mouse face area, redisplay that when
22443 we clear the cursor. */
22444 if (! NILP (dpyinfo
->mouse_face_window
)
22445 && w
== XWINDOW (dpyinfo
->mouse_face_window
)
22446 && (vpos
> dpyinfo
->mouse_face_beg_row
22447 || (vpos
== dpyinfo
->mouse_face_beg_row
22448 && hpos
>= dpyinfo
->mouse_face_beg_col
))
22449 && (vpos
< dpyinfo
->mouse_face_end_row
22450 || (vpos
== dpyinfo
->mouse_face_end_row
22451 && hpos
< dpyinfo
->mouse_face_end_col
))
22452 /* Don't redraw the cursor's spot in mouse face if it is at the
22453 end of a line (on a newline). The cursor appears there, but
22454 mouse highlighting does not. */
22455 && cursor_row
->used
[TEXT_AREA
] > hpos
)
22456 mouse_face_here_p
= 1;
22458 /* Maybe clear the display under the cursor. */
22459 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
22462 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
22465 cursor_glyph
= get_phys_cursor_glyph (w
);
22466 if (cursor_glyph
== NULL
)
22467 goto mark_cursor_off
;
22469 width
= cursor_glyph
->pixel_width
;
22470 left_x
= window_box_left_offset (w
, TEXT_AREA
);
22471 x
= w
->phys_cursor
.x
;
22473 width
-= left_x
- x
;
22474 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
22475 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
22476 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
22479 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
22482 /* Erase the cursor by redrawing the character underneath it. */
22483 if (mouse_face_here_p
)
22484 hl
= DRAW_MOUSE_FACE
;
22486 hl
= DRAW_NORMAL_TEXT
;
22487 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
22490 w
->phys_cursor_on_p
= 0;
22491 w
->phys_cursor_type
= NO_CURSOR
;
22496 Display or clear cursor of window W. If ON is zero, clear the
22497 cursor. If it is non-zero, display the cursor. If ON is nonzero,
22498 where to put the cursor is specified by HPOS, VPOS, X and Y. */
22501 display_and_set_cursor (w
, on
, hpos
, vpos
, x
, y
)
22503 int on
, hpos
, vpos
, x
, y
;
22505 struct frame
*f
= XFRAME (w
->frame
);
22506 int new_cursor_type
;
22507 int new_cursor_width
;
22509 struct glyph_row
*glyph_row
;
22510 struct glyph
*glyph
;
22512 /* This is pointless on invisible frames, and dangerous on garbaged
22513 windows and frames; in the latter case, the frame or window may
22514 be in the midst of changing its size, and x and y may be off the
22516 if (! FRAME_VISIBLE_P (f
)
22517 || FRAME_GARBAGED_P (f
)
22518 || vpos
>= w
->current_matrix
->nrows
22519 || hpos
>= w
->current_matrix
->matrix_w
)
22522 /* If cursor is off and we want it off, return quickly. */
22523 if (!on
&& !w
->phys_cursor_on_p
)
22526 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
22527 /* If cursor row is not enabled, we don't really know where to
22528 display the cursor. */
22529 if (!glyph_row
->enabled_p
)
22531 w
->phys_cursor_on_p
= 0;
22536 if (!glyph_row
->exact_window_width_line_p
22537 || hpos
< glyph_row
->used
[TEXT_AREA
])
22538 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
22540 xassert (interrupt_input_blocked
);
22542 /* Set new_cursor_type to the cursor we want to be displayed. */
22543 new_cursor_type
= get_window_cursor_type (w
, glyph
,
22544 &new_cursor_width
, &active_cursor
);
22546 /* If cursor is currently being shown and we don't want it to be or
22547 it is in the wrong place, or the cursor type is not what we want,
22549 if (w
->phys_cursor_on_p
22551 || w
->phys_cursor
.x
!= x
22552 || w
->phys_cursor
.y
!= y
22553 || new_cursor_type
!= w
->phys_cursor_type
22554 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
22555 && new_cursor_width
!= w
->phys_cursor_width
)))
22556 erase_phys_cursor (w
);
22558 /* Don't check phys_cursor_on_p here because that flag is only set
22559 to zero in some cases where we know that the cursor has been
22560 completely erased, to avoid the extra work of erasing the cursor
22561 twice. In other words, phys_cursor_on_p can be 1 and the cursor
22562 still not be visible, or it has only been partly erased. */
22565 w
->phys_cursor_ascent
= glyph_row
->ascent
;
22566 w
->phys_cursor_height
= glyph_row
->height
;
22568 /* Set phys_cursor_.* before x_draw_.* is called because some
22569 of them may need the information. */
22570 w
->phys_cursor
.x
= x
;
22571 w
->phys_cursor
.y
= glyph_row
->y
;
22572 w
->phys_cursor
.hpos
= hpos
;
22573 w
->phys_cursor
.vpos
= vpos
;
22576 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
22577 new_cursor_type
, new_cursor_width
,
22578 on
, active_cursor
);
22582 /* Switch the display of W's cursor on or off, according to the value
22589 update_window_cursor (w
, on
)
22593 /* Don't update cursor in windows whose frame is in the process
22594 of being deleted. */
22595 if (w
->current_matrix
)
22598 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
22599 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
22605 /* Call update_window_cursor with parameter ON_P on all leaf windows
22606 in the window tree rooted at W. */
22609 update_cursor_in_window_tree (w
, on_p
)
22615 if (!NILP (w
->hchild
))
22616 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
22617 else if (!NILP (w
->vchild
))
22618 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
22620 update_window_cursor (w
, on_p
);
22622 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
22628 Display the cursor on window W, or clear it, according to ON_P.
22629 Don't change the cursor's position. */
22632 x_update_cursor (f
, on_p
)
22636 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
22641 Clear the cursor of window W to background color, and mark the
22642 cursor as not shown. This is used when the text where the cursor
22643 is is about to be rewritten. */
22649 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
22650 update_window_cursor (w
, 0);
22655 Display the active region described by mouse_face_* according to DRAW. */
22658 show_mouse_face (dpyinfo
, draw
)
22659 Display_Info
*dpyinfo
;
22660 enum draw_glyphs_face draw
;
22662 struct window
*w
= XWINDOW (dpyinfo
->mouse_face_window
);
22663 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22665 if (/* If window is in the process of being destroyed, don't bother
22667 w
->current_matrix
!= NULL
22668 /* Don't update mouse highlight if hidden */
22669 && (draw
!= DRAW_MOUSE_FACE
|| !dpyinfo
->mouse_face_hidden
)
22670 /* Recognize when we are called to operate on rows that don't exist
22671 anymore. This can happen when a window is split. */
22672 && dpyinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
22674 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
22675 struct glyph_row
*row
, *first
, *last
;
22677 first
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
22678 last
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
22680 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
22682 int start_hpos
, end_hpos
, start_x
;
22684 /* For all but the first row, the highlight starts at column 0. */
22687 start_hpos
= dpyinfo
->mouse_face_beg_col
;
22688 start_x
= dpyinfo
->mouse_face_beg_x
;
22697 end_hpos
= dpyinfo
->mouse_face_end_col
;
22700 end_hpos
= row
->used
[TEXT_AREA
];
22701 if (draw
== DRAW_NORMAL_TEXT
)
22702 row
->fill_line_p
= 1; /* Clear to end of line */
22705 if (end_hpos
> start_hpos
)
22707 draw_glyphs (w
, start_x
, row
, TEXT_AREA
,
22708 start_hpos
, end_hpos
,
22712 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
22716 /* When we've written over the cursor, arrange for it to
22717 be displayed again. */
22718 if (phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
22721 display_and_set_cursor (w
, 1,
22722 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
22723 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
22728 /* Change the mouse cursor. */
22729 if (draw
== DRAW_NORMAL_TEXT
&& !EQ (dpyinfo
->mouse_face_window
, f
->tool_bar_window
))
22730 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
22731 else if (draw
== DRAW_MOUSE_FACE
)
22732 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
22734 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
22738 Clear out the mouse-highlighted active region.
22739 Redraw it un-highlighted first. Value is non-zero if mouse
22740 face was actually drawn unhighlighted. */
22743 clear_mouse_face (dpyinfo
)
22744 Display_Info
*dpyinfo
;
22748 if (!dpyinfo
->mouse_face_hidden
&& !NILP (dpyinfo
->mouse_face_window
))
22750 show_mouse_face (dpyinfo
, DRAW_NORMAL_TEXT
);
22754 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
22755 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
22756 dpyinfo
->mouse_face_window
= Qnil
;
22757 dpyinfo
->mouse_face_overlay
= Qnil
;
22763 Non-zero if physical cursor of window W is within mouse face. */
22766 cursor_in_mouse_face_p (w
)
22769 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
22770 int in_mouse_face
= 0;
22772 if (WINDOWP (dpyinfo
->mouse_face_window
)
22773 && XWINDOW (dpyinfo
->mouse_face_window
) == w
)
22775 int hpos
= w
->phys_cursor
.hpos
;
22776 int vpos
= w
->phys_cursor
.vpos
;
22778 if (vpos
>= dpyinfo
->mouse_face_beg_row
22779 && vpos
<= dpyinfo
->mouse_face_end_row
22780 && (vpos
> dpyinfo
->mouse_face_beg_row
22781 || hpos
>= dpyinfo
->mouse_face_beg_col
)
22782 && (vpos
< dpyinfo
->mouse_face_end_row
22783 || hpos
< dpyinfo
->mouse_face_end_col
22784 || dpyinfo
->mouse_face_past_end
))
22788 return in_mouse_face
;
22794 /* Find the glyph matrix position of buffer position CHARPOS in window
22795 *W. HPOS, *VPOS, *X, and *Y are set to the positions found. W's
22796 current glyphs must be up to date. If CHARPOS is above window
22797 start return (0, 0, 0, 0). If CHARPOS is after end of W, return end
22798 of last line in W. In the row containing CHARPOS, stop before glyphs
22799 having STOP as object. */
22801 #if 1 /* This is a version of fast_find_position that's more correct
22802 in the presence of hscrolling, for example. I didn't install
22803 it right away because the problem fixed is minor, it failed
22804 in 20.x as well, and I think it's too risky to install
22805 so near the release of 21.1. 2001-09-25 gerd. */
22809 fast_find_position (w
, charpos
, hpos
, vpos
, x
, y
, stop
)
22812 int *hpos
, *vpos
, *x
, *y
;
22815 struct glyph_row
*row
, *first
;
22816 struct glyph
*glyph
, *end
;
22819 first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
22820 if (charpos
< MATRIX_ROW_START_CHARPOS (first
))
22825 *vpos
= MATRIX_ROW_VPOS (first
, w
->current_matrix
);
22829 row
= row_containing_pos (w
, charpos
, first
, NULL
, 0);
22832 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
22836 /* If whole rows or last part of a row came from a display overlay,
22837 row_containing_pos will skip over such rows because their end pos
22838 equals the start pos of the overlay or interval.
22840 Move back if we have a STOP object and previous row's
22841 end glyph came from STOP. */
22844 struct glyph_row
*prev
;
22845 while ((prev
= row
- 1, prev
>= first
)
22846 && MATRIX_ROW_END_CHARPOS (prev
) == charpos
22847 && prev
->used
[TEXT_AREA
] > 0)
22849 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
22850 glyph
= beg
+ prev
->used
[TEXT_AREA
];
22851 while (--glyph
>= beg
22852 && INTEGERP (glyph
->object
));
22854 || !EQ (stop
, glyph
->object
))
22862 *vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
22864 glyph
= row
->glyphs
[TEXT_AREA
];
22865 end
= glyph
+ row
->used
[TEXT_AREA
];
22867 /* Skip over glyphs not having an object at the start of the row.
22868 These are special glyphs like truncation marks on terminal
22870 if (row
->displays_text_p
)
22872 && INTEGERP (glyph
->object
)
22873 && !EQ (stop
, glyph
->object
)
22874 && glyph
->charpos
< 0)
22876 *x
+= glyph
->pixel_width
;
22881 && !INTEGERP (glyph
->object
)
22882 && !EQ (stop
, glyph
->object
)
22883 && (!BUFFERP (glyph
->object
)
22884 || glyph
->charpos
< charpos
))
22886 *x
+= glyph
->pixel_width
;
22890 *hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
22897 fast_find_position (w
, pos
, hpos
, vpos
, x
, y
, stop
)
22900 int *hpos
, *vpos
, *x
, *y
;
22905 int maybe_next_line_p
= 0;
22906 int line_start_position
;
22907 int yb
= window_text_bottom_y (w
);
22908 struct glyph_row
*row
, *best_row
;
22909 int row_vpos
, best_row_vpos
;
22912 row
= best_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
22913 row_vpos
= best_row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
22915 while (row
->y
< yb
)
22917 if (row
->used
[TEXT_AREA
])
22918 line_start_position
= row
->glyphs
[TEXT_AREA
]->charpos
;
22920 line_start_position
= 0;
22922 if (line_start_position
> pos
)
22924 /* If the position sought is the end of the buffer,
22925 don't include the blank lines at the bottom of the window. */
22926 else if (line_start_position
== pos
22927 && pos
== BUF_ZV (XBUFFER (w
->buffer
)))
22929 maybe_next_line_p
= 1;
22932 else if (line_start_position
> 0)
22935 best_row_vpos
= row_vpos
;
22938 if (row
->y
+ row
->height
>= yb
)
22945 /* Find the right column within BEST_ROW. */
22947 current_x
= best_row
->x
;
22948 for (i
= 0; i
< best_row
->used
[TEXT_AREA
]; i
++)
22950 struct glyph
*glyph
= best_row
->glyphs
[TEXT_AREA
] + i
;
22951 int charpos
= glyph
->charpos
;
22953 if (BUFFERP (glyph
->object
))
22955 if (charpos
== pos
)
22958 *vpos
= best_row_vpos
;
22963 else if (charpos
> pos
)
22966 else if (EQ (glyph
->object
, stop
))
22971 current_x
+= glyph
->pixel_width
;
22974 /* If we're looking for the end of the buffer,
22975 and we didn't find it in the line we scanned,
22976 use the start of the following line. */
22977 if (maybe_next_line_p
)
22982 current_x
= best_row
->x
;
22985 *vpos
= best_row_vpos
;
22986 *hpos
= lastcol
+ 1;
22995 /* Find the position of the glyph for position POS in OBJECT in
22996 window W's current matrix, and return in *X, *Y the pixel
22997 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
22999 RIGHT_P non-zero means return the position of the right edge of the
23000 glyph, RIGHT_P zero means return the left edge position.
23002 If no glyph for POS exists in the matrix, return the position of
23003 the glyph with the next smaller position that is in the matrix, if
23004 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
23005 exists in the matrix, return the position of the glyph with the
23006 next larger position in OBJECT.
23008 Value is non-zero if a glyph was found. */
23011 fast_find_string_pos (w
, pos
, object
, hpos
, vpos
, x
, y
, right_p
)
23014 Lisp_Object object
;
23015 int *hpos
, *vpos
, *x
, *y
;
23018 int yb
= window_text_bottom_y (w
);
23019 struct glyph_row
*r
;
23020 struct glyph
*best_glyph
= NULL
;
23021 struct glyph_row
*best_row
= NULL
;
23024 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
23025 r
->enabled_p
&& r
->y
< yb
;
23028 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
23029 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
23032 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
23033 if (EQ (g
->object
, object
))
23035 if (g
->charpos
== pos
)
23042 else if (best_glyph
== NULL
23043 || ((eabs (g
->charpos
- pos
)
23044 < eabs (best_glyph
->charpos
- pos
))
23047 : g
->charpos
> pos
)))
23061 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
23065 *x
+= best_glyph
->pixel_width
;
23070 *vpos
= best_row
- w
->current_matrix
->rows
;
23073 return best_glyph
!= NULL
;
23077 /* See if position X, Y is within a hot-spot of an image. */
23080 on_hot_spot_p (hot_spot
, x
, y
)
23081 Lisp_Object hot_spot
;
23084 if (!CONSP (hot_spot
))
23087 if (EQ (XCAR (hot_spot
), Qrect
))
23089 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
23090 Lisp_Object rect
= XCDR (hot_spot
);
23094 if (!CONSP (XCAR (rect
)))
23096 if (!CONSP (XCDR (rect
)))
23098 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
23100 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
23102 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
23104 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
23108 else if (EQ (XCAR (hot_spot
), Qcircle
))
23110 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
23111 Lisp_Object circ
= XCDR (hot_spot
);
23112 Lisp_Object lr
, lx0
, ly0
;
23114 && CONSP (XCAR (circ
))
23115 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
23116 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
23117 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
23119 double r
= XFLOATINT (lr
);
23120 double dx
= XINT (lx0
) - x
;
23121 double dy
= XINT (ly0
) - y
;
23122 return (dx
* dx
+ dy
* dy
<= r
* r
);
23125 else if (EQ (XCAR (hot_spot
), Qpoly
))
23127 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
23128 if (VECTORP (XCDR (hot_spot
)))
23130 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
23131 Lisp_Object
*poly
= v
->contents
;
23135 Lisp_Object lx
, ly
;
23138 /* Need an even number of coordinates, and at least 3 edges. */
23139 if (n
< 6 || n
& 1)
23142 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
23143 If count is odd, we are inside polygon. Pixels on edges
23144 may or may not be included depending on actual geometry of the
23146 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
23147 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
23149 x0
= XINT (lx
), y0
= XINT (ly
);
23150 for (i
= 0; i
< n
; i
+= 2)
23152 int x1
= x0
, y1
= y0
;
23153 if ((lx
= poly
[i
], !INTEGERP (lx
))
23154 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
23156 x0
= XINT (lx
), y0
= XINT (ly
);
23158 /* Does this segment cross the X line? */
23166 if (y
> y0
&& y
> y1
)
23168 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
23178 find_hot_spot (map
, x
, y
)
23182 while (CONSP (map
))
23184 if (CONSP (XCAR (map
))
23185 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
23193 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
23195 doc
: /* Lookup in image map MAP coordinates X and Y.
23196 An image map is an alist where each element has the format (AREA ID PLIST).
23197 An AREA is specified as either a rectangle, a circle, or a polygon:
23198 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
23199 pixel coordinates of the upper left and bottom right corners.
23200 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
23201 and the radius of the circle; r may be a float or integer.
23202 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
23203 vector describes one corner in the polygon.
23204 Returns the alist element for the first matching AREA in MAP. */)
23215 return find_hot_spot (map
, XINT (x
), XINT (y
));
23219 /* Display frame CURSOR, optionally using shape defined by POINTER. */
23221 define_frame_cursor1 (f
, cursor
, pointer
)
23224 Lisp_Object pointer
;
23226 /* Do not change cursor shape while dragging mouse. */
23227 if (!NILP (do_mouse_tracking
))
23230 if (!NILP (pointer
))
23232 if (EQ (pointer
, Qarrow
))
23233 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23234 else if (EQ (pointer
, Qhand
))
23235 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
23236 else if (EQ (pointer
, Qtext
))
23237 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
23238 else if (EQ (pointer
, intern ("hdrag")))
23239 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
23240 #ifdef HAVE_X_WINDOWS
23241 else if (EQ (pointer
, intern ("vdrag")))
23242 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
23244 else if (EQ (pointer
, intern ("hourglass")))
23245 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
23246 else if (EQ (pointer
, Qmodeline
))
23247 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
23249 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23252 if (cursor
!= No_Cursor
)
23253 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
23256 /* Take proper action when mouse has moved to the mode or header line
23257 or marginal area AREA of window W, x-position X and y-position Y.
23258 X is relative to the start of the text display area of W, so the
23259 width of bitmap areas and scroll bars must be subtracted to get a
23260 position relative to the start of the mode line. */
23263 note_mode_line_or_margin_highlight (window
, x
, y
, area
)
23264 Lisp_Object window
;
23266 enum window_part area
;
23268 struct window
*w
= XWINDOW (window
);
23269 struct frame
*f
= XFRAME (w
->frame
);
23270 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
23271 Cursor cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23272 Lisp_Object pointer
= Qnil
;
23273 int charpos
, dx
, dy
, width
, height
;
23274 Lisp_Object string
, object
= Qnil
;
23275 Lisp_Object pos
, help
;
23277 Lisp_Object mouse_face
;
23278 int original_x_pixel
= x
;
23279 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
23280 struct glyph_row
*row
;
23282 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
23287 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
23288 &object
, &dx
, &dy
, &width
, &height
);
23290 row
= (area
== ON_MODE_LINE
23291 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
23292 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
23295 if (row
->mode_line_p
&& row
->enabled_p
)
23297 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
23298 end
= glyph
+ row
->used
[TEXT_AREA
];
23300 for (x0
= original_x_pixel
;
23301 glyph
< end
&& x0
>= glyph
->pixel_width
;
23303 x0
-= glyph
->pixel_width
;
23311 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
23312 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
23313 &object
, &dx
, &dy
, &width
, &height
);
23318 if (IMAGEP (object
))
23320 Lisp_Object image_map
, hotspot
;
23321 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
23323 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
23325 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
23327 Lisp_Object area_id
, plist
;
23329 area_id
= XCAR (hotspot
);
23330 /* Could check AREA_ID to see if we enter/leave this hot-spot.
23331 If so, we could look for mouse-enter, mouse-leave
23332 properties in PLIST (and do something...). */
23333 hotspot
= XCDR (hotspot
);
23334 if (CONSP (hotspot
)
23335 && (plist
= XCAR (hotspot
), CONSP (plist
)))
23337 pointer
= Fplist_get (plist
, Qpointer
);
23338 if (NILP (pointer
))
23340 help
= Fplist_get (plist
, Qhelp_echo
);
23343 help_echo_string
= help
;
23344 /* Is this correct? ++kfs */
23345 XSETWINDOW (help_echo_window
, w
);
23346 help_echo_object
= w
->buffer
;
23347 help_echo_pos
= charpos
;
23351 if (NILP (pointer
))
23352 pointer
= Fplist_get (XCDR (object
), QCpointer
);
23355 if (STRINGP (string
))
23357 pos
= make_number (charpos
);
23358 /* If we're on a string with `help-echo' text property, arrange
23359 for the help to be displayed. This is done by setting the
23360 global variable help_echo_string to the help string. */
23363 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
23366 help_echo_string
= help
;
23367 XSETWINDOW (help_echo_window
, w
);
23368 help_echo_object
= string
;
23369 help_echo_pos
= charpos
;
23373 if (NILP (pointer
))
23374 pointer
= Fget_text_property (pos
, Qpointer
, string
);
23376 /* Change the mouse pointer according to what is under X/Y. */
23377 if (NILP (pointer
) && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
23380 map
= Fget_text_property (pos
, Qlocal_map
, string
);
23381 if (!KEYMAPP (map
))
23382 map
= Fget_text_property (pos
, Qkeymap
, string
);
23383 if (!KEYMAPP (map
))
23384 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
23387 /* Change the mouse face according to what is under X/Y. */
23388 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
23389 if (!NILP (mouse_face
)
23390 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
23395 struct glyph
* tmp_glyph
;
23399 int total_pixel_width
;
23404 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
23405 Qmouse_face
, string
, Qnil
);
23407 b
= make_number (0);
23409 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
23411 e
= make_number (SCHARS (string
));
23413 /* Calculate the position(glyph position: GPOS) of GLYPH in
23414 displayed string. GPOS is different from CHARPOS.
23416 CHARPOS is the position of glyph in internal string
23417 object. A mode line string format has structures which
23418 is converted to a flatten by emacs lisp interpreter.
23419 The internal string is an element of the structures.
23420 The displayed string is the flatten string. */
23422 if (glyph
> row_start_glyph
)
23424 tmp_glyph
= glyph
- 1;
23425 while (tmp_glyph
>= row_start_glyph
23426 && tmp_glyph
->charpos
>= XINT (b
)
23427 && EQ (tmp_glyph
->object
, glyph
->object
))
23434 /* Calculate the lenght(glyph sequence length: GSEQ_LENGTH) of
23435 displayed string holding GLYPH.
23437 GSEQ_LENGTH is different from SCHARS (STRING).
23438 SCHARS (STRING) returns the length of the internal string. */
23439 for (tmp_glyph
= glyph
, gseq_length
= gpos
;
23440 tmp_glyph
->charpos
< XINT (e
);
23441 tmp_glyph
++, gseq_length
++)
23443 if (!EQ (tmp_glyph
->object
, glyph
->object
))
23447 total_pixel_width
= 0;
23448 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
23449 total_pixel_width
+= tmp_glyph
->pixel_width
;
23451 /* Pre calculation of re-rendering position */
23453 hpos
= (area
== ON_MODE_LINE
23454 ? (w
->current_matrix
)->nrows
- 1
23457 /* If the re-rendering position is included in the last
23458 re-rendering area, we should do nothing. */
23459 if ( EQ (window
, dpyinfo
->mouse_face_window
)
23460 && dpyinfo
->mouse_face_beg_col
<= vpos
23461 && vpos
< dpyinfo
->mouse_face_end_col
23462 && dpyinfo
->mouse_face_beg_row
== hpos
)
23465 if (clear_mouse_face (dpyinfo
))
23466 cursor
= No_Cursor
;
23468 dpyinfo
->mouse_face_beg_col
= vpos
;
23469 dpyinfo
->mouse_face_beg_row
= hpos
;
23471 dpyinfo
->mouse_face_beg_x
= original_x_pixel
- (total_pixel_width
+ dx
);
23472 dpyinfo
->mouse_face_beg_y
= 0;
23474 dpyinfo
->mouse_face_end_col
= vpos
+ gseq_length
;
23475 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_beg_row
;
23477 dpyinfo
->mouse_face_end_x
= 0;
23478 dpyinfo
->mouse_face_end_y
= 0;
23480 dpyinfo
->mouse_face_past_end
= 0;
23481 dpyinfo
->mouse_face_window
= window
;
23483 dpyinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
23486 glyph
->face_id
, 1);
23487 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23489 if (NILP (pointer
))
23492 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
23493 clear_mouse_face (dpyinfo
);
23495 define_frame_cursor1 (f
, cursor
, pointer
);
23500 Take proper action when the mouse has moved to position X, Y on
23501 frame F as regards highlighting characters that have mouse-face
23502 properties. Also de-highlighting chars where the mouse was before.
23503 X and Y can be negative or out of range. */
23506 note_mouse_highlight (f
, x
, y
)
23510 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
23511 enum window_part part
;
23512 Lisp_Object window
;
23514 Cursor cursor
= No_Cursor
;
23515 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
23518 /* When a menu is active, don't highlight because this looks odd. */
23519 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
23520 if (popup_activated ())
23524 if (NILP (Vmouse_highlight
)
23525 || !f
->glyphs_initialized_p
)
23528 dpyinfo
->mouse_face_mouse_x
= x
;
23529 dpyinfo
->mouse_face_mouse_y
= y
;
23530 dpyinfo
->mouse_face_mouse_frame
= f
;
23532 if (dpyinfo
->mouse_face_defer
)
23535 if (gc_in_progress
)
23537 dpyinfo
->mouse_face_deferred_gc
= 1;
23541 /* Which window is that in? */
23542 window
= window_from_coordinates (f
, x
, y
, &part
, 0, 0, 1);
23544 /* If we were displaying active text in another window, clear that.
23545 Also clear if we move out of text area in same window. */
23546 if (! EQ (window
, dpyinfo
->mouse_face_window
)
23547 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
23548 && !NILP (dpyinfo
->mouse_face_window
)))
23549 clear_mouse_face (dpyinfo
);
23551 /* Not on a window -> return. */
23552 if (!WINDOWP (window
))
23555 /* Reset help_echo_string. It will get recomputed below. */
23556 help_echo_string
= Qnil
;
23558 /* Convert to window-relative pixel coordinates. */
23559 w
= XWINDOW (window
);
23560 frame_to_window_pixel_xy (w
, &x
, &y
);
23562 /* Handle tool-bar window differently since it doesn't display a
23564 if (EQ (window
, f
->tool_bar_window
))
23566 note_tool_bar_highlight (f
, x
, y
);
23570 /* Mouse is on the mode, header line or margin? */
23571 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
23572 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
23574 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
23578 if (part
== ON_VERTICAL_BORDER
)
23580 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
23581 help_echo_string
= build_string ("drag-mouse-1: resize");
23583 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
23584 || part
== ON_SCROLL_BAR
)
23585 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23587 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
23589 /* Are we in a window whose display is up to date?
23590 And verify the buffer's text has not changed. */
23591 b
= XBUFFER (w
->buffer
);
23592 if (part
== ON_TEXT
23593 && EQ (w
->window_end_valid
, w
->buffer
)
23594 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
23595 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
23597 int hpos
, vpos
, pos
, i
, dx
, dy
, area
;
23598 struct glyph
*glyph
;
23599 Lisp_Object object
;
23600 Lisp_Object mouse_face
= Qnil
, overlay
= Qnil
, position
;
23601 Lisp_Object
*overlay_vec
= NULL
;
23603 struct buffer
*obuf
;
23604 int obegv
, ozv
, same_region
;
23606 /* Find the glyph under X/Y. */
23607 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
23609 /* Look for :pointer property on image. */
23610 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
23612 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
23613 if (img
!= NULL
&& IMAGEP (img
->spec
))
23615 Lisp_Object image_map
, hotspot
;
23616 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
23618 && (hotspot
= find_hot_spot (image_map
,
23619 glyph
->slice
.x
+ dx
,
23620 glyph
->slice
.y
+ dy
),
23622 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
23624 Lisp_Object area_id
, plist
;
23626 area_id
= XCAR (hotspot
);
23627 /* Could check AREA_ID to see if we enter/leave this hot-spot.
23628 If so, we could look for mouse-enter, mouse-leave
23629 properties in PLIST (and do something...). */
23630 hotspot
= XCDR (hotspot
);
23631 if (CONSP (hotspot
)
23632 && (plist
= XCAR (hotspot
), CONSP (plist
)))
23634 pointer
= Fplist_get (plist
, Qpointer
);
23635 if (NILP (pointer
))
23637 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
23638 if (!NILP (help_echo_string
))
23640 help_echo_window
= window
;
23641 help_echo_object
= glyph
->object
;
23642 help_echo_pos
= glyph
->charpos
;
23646 if (NILP (pointer
))
23647 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
23651 /* Clear mouse face if X/Y not over text. */
23653 || area
!= TEXT_AREA
23654 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
)
23656 if (clear_mouse_face (dpyinfo
))
23657 cursor
= No_Cursor
;
23658 if (NILP (pointer
))
23660 if (area
!= TEXT_AREA
)
23661 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23663 pointer
= Vvoid_text_area_pointer
;
23668 pos
= glyph
->charpos
;
23669 object
= glyph
->object
;
23670 if (!STRINGP (object
) && !BUFFERP (object
))
23673 /* If we get an out-of-range value, return now; avoid an error. */
23674 if (BUFFERP (object
) && pos
> BUF_Z (b
))
23677 /* Make the window's buffer temporarily current for
23678 overlays_at and compute_char_face. */
23679 obuf
= current_buffer
;
23680 current_buffer
= b
;
23686 /* Is this char mouse-active or does it have help-echo? */
23687 position
= make_number (pos
);
23689 if (BUFFERP (object
))
23691 /* Put all the overlays we want in a vector in overlay_vec. */
23692 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
23693 /* Sort overlays into increasing priority order. */
23694 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
23699 same_region
= (EQ (window
, dpyinfo
->mouse_face_window
)
23700 && vpos
>= dpyinfo
->mouse_face_beg_row
23701 && vpos
<= dpyinfo
->mouse_face_end_row
23702 && (vpos
> dpyinfo
->mouse_face_beg_row
23703 || hpos
>= dpyinfo
->mouse_face_beg_col
)
23704 && (vpos
< dpyinfo
->mouse_face_end_row
23705 || hpos
< dpyinfo
->mouse_face_end_col
23706 || dpyinfo
->mouse_face_past_end
));
23709 cursor
= No_Cursor
;
23711 /* Check mouse-face highlighting. */
23713 /* If there exists an overlay with mouse-face overlapping
23714 the one we are currently highlighting, we have to
23715 check if we enter the overlapping overlay, and then
23716 highlight only that. */
23717 || (OVERLAYP (dpyinfo
->mouse_face_overlay
)
23718 && mouse_face_overlay_overlaps (dpyinfo
->mouse_face_overlay
)))
23720 /* Find the highest priority overlay that has a mouse-face
23723 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
23725 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
23726 if (!NILP (mouse_face
))
23727 overlay
= overlay_vec
[i
];
23730 /* If we're actually highlighting the same overlay as
23731 before, there's no need to do that again. */
23732 if (!NILP (overlay
)
23733 && EQ (overlay
, dpyinfo
->mouse_face_overlay
))
23734 goto check_help_echo
;
23736 dpyinfo
->mouse_face_overlay
= overlay
;
23738 /* Clear the display of the old active region, if any. */
23739 if (clear_mouse_face (dpyinfo
))
23740 cursor
= No_Cursor
;
23742 /* If no overlay applies, get a text property. */
23743 if (NILP (overlay
))
23744 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
23746 /* Handle the overlay case. */
23747 if (!NILP (overlay
))
23749 /* Find the range of text around this char that
23750 should be active. */
23751 Lisp_Object before
, after
;
23754 before
= Foverlay_start (overlay
);
23755 after
= Foverlay_end (overlay
);
23756 /* Record this as the current active region. */
23757 fast_find_position (w
, XFASTINT (before
),
23758 &dpyinfo
->mouse_face_beg_col
,
23759 &dpyinfo
->mouse_face_beg_row
,
23760 &dpyinfo
->mouse_face_beg_x
,
23761 &dpyinfo
->mouse_face_beg_y
, Qnil
);
23763 dpyinfo
->mouse_face_past_end
23764 = !fast_find_position (w
, XFASTINT (after
),
23765 &dpyinfo
->mouse_face_end_col
,
23766 &dpyinfo
->mouse_face_end_row
,
23767 &dpyinfo
->mouse_face_end_x
,
23768 &dpyinfo
->mouse_face_end_y
, Qnil
);
23769 dpyinfo
->mouse_face_window
= window
;
23771 dpyinfo
->mouse_face_face_id
23772 = face_at_buffer_position (w
, pos
, 0, 0,
23774 !dpyinfo
->mouse_face_hidden
);
23776 /* Display it as active. */
23777 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23778 cursor
= No_Cursor
;
23780 /* Handle the text property case. */
23781 else if (!NILP (mouse_face
) && BUFFERP (object
))
23783 /* Find the range of text around this char that
23784 should be active. */
23785 Lisp_Object before
, after
, beginning
, end
;
23788 beginning
= Fmarker_position (w
->start
);
23789 end
= make_number (BUF_Z (XBUFFER (object
))
23790 - XFASTINT (w
->window_end_pos
));
23792 = Fprevious_single_property_change (make_number (pos
+ 1),
23794 object
, beginning
);
23796 = Fnext_single_property_change (position
, Qmouse_face
,
23799 /* Record this as the current active region. */
23800 fast_find_position (w
, XFASTINT (before
),
23801 &dpyinfo
->mouse_face_beg_col
,
23802 &dpyinfo
->mouse_face_beg_row
,
23803 &dpyinfo
->mouse_face_beg_x
,
23804 &dpyinfo
->mouse_face_beg_y
, Qnil
);
23805 dpyinfo
->mouse_face_past_end
23806 = !fast_find_position (w
, XFASTINT (after
),
23807 &dpyinfo
->mouse_face_end_col
,
23808 &dpyinfo
->mouse_face_end_row
,
23809 &dpyinfo
->mouse_face_end_x
,
23810 &dpyinfo
->mouse_face_end_y
, Qnil
);
23811 dpyinfo
->mouse_face_window
= window
;
23813 if (BUFFERP (object
))
23814 dpyinfo
->mouse_face_face_id
23815 = face_at_buffer_position (w
, pos
, 0, 0,
23817 !dpyinfo
->mouse_face_hidden
);
23819 /* Display it as active. */
23820 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23821 cursor
= No_Cursor
;
23823 else if (!NILP (mouse_face
) && STRINGP (object
))
23828 b
= Fprevious_single_property_change (make_number (pos
+ 1),
23831 e
= Fnext_single_property_change (position
, Qmouse_face
,
23834 b
= make_number (0);
23836 e
= make_number (SCHARS (object
) - 1);
23838 fast_find_string_pos (w
, XINT (b
), object
,
23839 &dpyinfo
->mouse_face_beg_col
,
23840 &dpyinfo
->mouse_face_beg_row
,
23841 &dpyinfo
->mouse_face_beg_x
,
23842 &dpyinfo
->mouse_face_beg_y
, 0);
23843 fast_find_string_pos (w
, XINT (e
), object
,
23844 &dpyinfo
->mouse_face_end_col
,
23845 &dpyinfo
->mouse_face_end_row
,
23846 &dpyinfo
->mouse_face_end_x
,
23847 &dpyinfo
->mouse_face_end_y
, 1);
23848 dpyinfo
->mouse_face_past_end
= 0;
23849 dpyinfo
->mouse_face_window
= window
;
23850 dpyinfo
->mouse_face_face_id
23851 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
23852 glyph
->face_id
, 1);
23853 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23854 cursor
= No_Cursor
;
23856 else if (STRINGP (object
) && NILP (mouse_face
))
23858 /* A string which doesn't have mouse-face, but
23859 the text ``under'' it might have. */
23860 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
23861 int start
= MATRIX_ROW_START_CHARPOS (r
);
23863 pos
= string_buffer_position (w
, object
, start
);
23865 mouse_face
= get_char_property_and_overlay (make_number (pos
),
23869 if (!NILP (mouse_face
) && !NILP (overlay
))
23871 Lisp_Object before
= Foverlay_start (overlay
);
23872 Lisp_Object after
= Foverlay_end (overlay
);
23875 /* Note that we might not be able to find position
23876 BEFORE in the glyph matrix if the overlay is
23877 entirely covered by a `display' property. In
23878 this case, we overshoot. So let's stop in
23879 the glyph matrix before glyphs for OBJECT. */
23880 fast_find_position (w
, XFASTINT (before
),
23881 &dpyinfo
->mouse_face_beg_col
,
23882 &dpyinfo
->mouse_face_beg_row
,
23883 &dpyinfo
->mouse_face_beg_x
,
23884 &dpyinfo
->mouse_face_beg_y
,
23887 dpyinfo
->mouse_face_past_end
23888 = !fast_find_position (w
, XFASTINT (after
),
23889 &dpyinfo
->mouse_face_end_col
,
23890 &dpyinfo
->mouse_face_end_row
,
23891 &dpyinfo
->mouse_face_end_x
,
23892 &dpyinfo
->mouse_face_end_y
,
23894 dpyinfo
->mouse_face_window
= window
;
23895 dpyinfo
->mouse_face_face_id
23896 = face_at_buffer_position (w
, pos
, 0, 0,
23898 !dpyinfo
->mouse_face_hidden
);
23900 /* Display it as active. */
23901 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23902 cursor
= No_Cursor
;
23909 /* Look for a `help-echo' property. */
23910 if (NILP (help_echo_string
)) {
23911 Lisp_Object help
, overlay
;
23913 /* Check overlays first. */
23914 help
= overlay
= Qnil
;
23915 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
23917 overlay
= overlay_vec
[i
];
23918 help
= Foverlay_get (overlay
, Qhelp_echo
);
23923 help_echo_string
= help
;
23924 help_echo_window
= window
;
23925 help_echo_object
= overlay
;
23926 help_echo_pos
= pos
;
23930 Lisp_Object object
= glyph
->object
;
23931 int charpos
= glyph
->charpos
;
23933 /* Try text properties. */
23934 if (STRINGP (object
)
23936 && charpos
< SCHARS (object
))
23938 help
= Fget_text_property (make_number (charpos
),
23939 Qhelp_echo
, object
);
23942 /* If the string itself doesn't specify a help-echo,
23943 see if the buffer text ``under'' it does. */
23944 struct glyph_row
*r
23945 = MATRIX_ROW (w
->current_matrix
, vpos
);
23946 int start
= MATRIX_ROW_START_CHARPOS (r
);
23947 int pos
= string_buffer_position (w
, object
, start
);
23950 help
= Fget_char_property (make_number (pos
),
23951 Qhelp_echo
, w
->buffer
);
23955 object
= w
->buffer
;
23960 else if (BUFFERP (object
)
23963 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
23968 help_echo_string
= help
;
23969 help_echo_window
= window
;
23970 help_echo_object
= object
;
23971 help_echo_pos
= charpos
;
23976 /* Look for a `pointer' property. */
23977 if (NILP (pointer
))
23979 /* Check overlays first. */
23980 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
23981 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
23983 if (NILP (pointer
))
23985 Lisp_Object object
= glyph
->object
;
23986 int charpos
= glyph
->charpos
;
23988 /* Try text properties. */
23989 if (STRINGP (object
)
23991 && charpos
< SCHARS (object
))
23993 pointer
= Fget_text_property (make_number (charpos
),
23995 if (NILP (pointer
))
23997 /* If the string itself doesn't specify a pointer,
23998 see if the buffer text ``under'' it does. */
23999 struct glyph_row
*r
24000 = MATRIX_ROW (w
->current_matrix
, vpos
);
24001 int start
= MATRIX_ROW_START_CHARPOS (r
);
24002 int pos
= string_buffer_position (w
, object
, start
);
24004 pointer
= Fget_char_property (make_number (pos
),
24005 Qpointer
, w
->buffer
);
24008 else if (BUFFERP (object
)
24011 pointer
= Fget_text_property (make_number (charpos
),
24018 current_buffer
= obuf
;
24023 define_frame_cursor1 (f
, cursor
, pointer
);
24028 Clear any mouse-face on window W. This function is part of the
24029 redisplay interface, and is called from try_window_id and similar
24030 functions to ensure the mouse-highlight is off. */
24033 x_clear_window_mouse_face (w
)
24036 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
24037 Lisp_Object window
;
24040 XSETWINDOW (window
, w
);
24041 if (EQ (window
, dpyinfo
->mouse_face_window
))
24042 clear_mouse_face (dpyinfo
);
24048 Just discard the mouse face information for frame F, if any.
24049 This is used when the size of F is changed. */
24052 cancel_mouse_face (f
)
24055 Lisp_Object window
;
24056 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24058 window
= dpyinfo
->mouse_face_window
;
24059 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
24061 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
24062 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
24063 dpyinfo
->mouse_face_window
= Qnil
;
24068 #endif /* HAVE_WINDOW_SYSTEM */
24071 /***********************************************************************
24073 ***********************************************************************/
24075 #ifdef HAVE_WINDOW_SYSTEM
24077 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
24078 which intersects rectangle R. R is in window-relative coordinates. */
24081 expose_area (w
, row
, r
, area
)
24083 struct glyph_row
*row
;
24085 enum glyph_row_area area
;
24087 struct glyph
*first
= row
->glyphs
[area
];
24088 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
24089 struct glyph
*last
;
24090 int first_x
, start_x
, x
;
24092 if (area
== TEXT_AREA
&& row
->fill_line_p
)
24093 /* If row extends face to end of line write the whole line. */
24094 draw_glyphs (w
, 0, row
, area
,
24095 0, row
->used
[area
],
24096 DRAW_NORMAL_TEXT
, 0);
24099 /* Set START_X to the window-relative start position for drawing glyphs of
24100 AREA. The first glyph of the text area can be partially visible.
24101 The first glyphs of other areas cannot. */
24102 start_x
= window_box_left_offset (w
, area
);
24104 if (area
== TEXT_AREA
)
24107 /* Find the first glyph that must be redrawn. */
24109 && x
+ first
->pixel_width
< r
->x
)
24111 x
+= first
->pixel_width
;
24115 /* Find the last one. */
24119 && x
< r
->x
+ r
->width
)
24121 x
+= last
->pixel_width
;
24127 draw_glyphs (w
, first_x
- start_x
, row
, area
,
24128 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
24129 DRAW_NORMAL_TEXT
, 0);
24134 /* Redraw the parts of the glyph row ROW on window W intersecting
24135 rectangle R. R is in window-relative coordinates. Value is
24136 non-zero if mouse-face was overwritten. */
24139 expose_line (w
, row
, r
)
24141 struct glyph_row
*row
;
24144 xassert (row
->enabled_p
);
24146 if (row
->mode_line_p
|| w
->pseudo_window_p
)
24147 draw_glyphs (w
, 0, row
, TEXT_AREA
,
24148 0, row
->used
[TEXT_AREA
],
24149 DRAW_NORMAL_TEXT
, 0);
24152 if (row
->used
[LEFT_MARGIN_AREA
])
24153 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
24154 if (row
->used
[TEXT_AREA
])
24155 expose_area (w
, row
, r
, TEXT_AREA
);
24156 if (row
->used
[RIGHT_MARGIN_AREA
])
24157 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
24158 draw_row_fringe_bitmaps (w
, row
);
24161 return row
->mouse_face_p
;
24165 /* Redraw those parts of glyphs rows during expose event handling that
24166 overlap other rows. Redrawing of an exposed line writes over parts
24167 of lines overlapping that exposed line; this function fixes that.
24169 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
24170 row in W's current matrix that is exposed and overlaps other rows.
24171 LAST_OVERLAPPING_ROW is the last such row. */
24174 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
, r
)
24176 struct glyph_row
*first_overlapping_row
;
24177 struct glyph_row
*last_overlapping_row
;
24180 struct glyph_row
*row
;
24182 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
24183 if (row
->overlapping_p
)
24185 xassert (row
->enabled_p
&& !row
->mode_line_p
);
24188 if (row
->used
[LEFT_MARGIN_AREA
])
24189 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
24191 if (row
->used
[TEXT_AREA
])
24192 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
24194 if (row
->used
[RIGHT_MARGIN_AREA
])
24195 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
24201 /* Return non-zero if W's cursor intersects rectangle R. */
24204 phys_cursor_in_rect_p (w
, r
)
24208 XRectangle cr
, result
;
24209 struct glyph
*cursor_glyph
;
24210 struct glyph_row
*row
;
24212 if (w
->phys_cursor
.vpos
>= 0
24213 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
24214 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
24216 && row
->cursor_in_fringe_p
)
24218 /* Cursor is in the fringe. */
24219 cr
.x
= window_box_right_offset (w
,
24220 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
24221 ? RIGHT_MARGIN_AREA
24224 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
24225 cr
.height
= row
->height
;
24226 return x_intersect_rectangles (&cr
, r
, &result
);
24229 cursor_glyph
= get_phys_cursor_glyph (w
);
24232 /* r is relative to W's box, but w->phys_cursor.x is relative
24233 to left edge of W's TEXT area. Adjust it. */
24234 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
24235 cr
.y
= w
->phys_cursor
.y
;
24236 cr
.width
= cursor_glyph
->pixel_width
;
24237 cr
.height
= w
->phys_cursor_height
;
24238 /* ++KFS: W32 version used W32-specific IntersectRect here, but
24239 I assume the effect is the same -- and this is portable. */
24240 return x_intersect_rectangles (&cr
, r
, &result
);
24242 /* If we don't understand the format, pretend we're not in the hot-spot. */
24248 Draw a vertical window border to the right of window W if W doesn't
24249 have vertical scroll bars. */
24252 x_draw_vertical_border (w
)
24255 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
24257 /* We could do better, if we knew what type of scroll-bar the adjacent
24258 windows (on either side) have... But we don't :-(
24259 However, I think this works ok. ++KFS 2003-04-25 */
24261 /* Redraw borders between horizontally adjacent windows. Don't
24262 do it for frames with vertical scroll bars because either the
24263 right scroll bar of a window, or the left scroll bar of its
24264 neighbor will suffice as a border. */
24265 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
24268 if (!WINDOW_RIGHTMOST_P (w
)
24269 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
24271 int x0
, x1
, y0
, y1
;
24273 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
24276 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
24279 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
24281 else if (!WINDOW_LEFTMOST_P (w
)
24282 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
24284 int x0
, x1
, y0
, y1
;
24286 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
24289 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
24292 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
24297 /* Redraw the part of window W intersection rectangle FR. Pixel
24298 coordinates in FR are frame-relative. Call this function with
24299 input blocked. Value is non-zero if the exposure overwrites
24303 expose_window (w
, fr
)
24307 struct frame
*f
= XFRAME (w
->frame
);
24309 int mouse_face_overwritten_p
= 0;
24311 /* If window is not yet fully initialized, do nothing. This can
24312 happen when toolkit scroll bars are used and a window is split.
24313 Reconfiguring the scroll bar will generate an expose for a newly
24315 if (w
->current_matrix
== NULL
)
24318 /* When we're currently updating the window, display and current
24319 matrix usually don't agree. Arrange for a thorough display
24321 if (w
== updated_window
)
24323 SET_FRAME_GARBAGED (f
);
24327 /* Frame-relative pixel rectangle of W. */
24328 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
24329 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
24330 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
24331 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
24333 if (x_intersect_rectangles (fr
, &wr
, &r
))
24335 int yb
= window_text_bottom_y (w
);
24336 struct glyph_row
*row
;
24337 int cursor_cleared_p
;
24338 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
24340 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
24341 r
.x
, r
.y
, r
.width
, r
.height
));
24343 /* Convert to window coordinates. */
24344 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
24345 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
24347 /* Turn off the cursor. */
24348 if (!w
->pseudo_window_p
24349 && phys_cursor_in_rect_p (w
, &r
))
24351 x_clear_cursor (w
);
24352 cursor_cleared_p
= 1;
24355 cursor_cleared_p
= 0;
24357 /* Update lines intersecting rectangle R. */
24358 first_overlapping_row
= last_overlapping_row
= NULL
;
24359 for (row
= w
->current_matrix
->rows
;
24364 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
24366 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
24367 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
24368 || (r
.y
>= y0
&& r
.y
< y1
)
24369 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
24371 /* A header line may be overlapping, but there is no need
24372 to fix overlapping areas for them. KFS 2005-02-12 */
24373 if (row
->overlapping_p
&& !row
->mode_line_p
)
24375 if (first_overlapping_row
== NULL
)
24376 first_overlapping_row
= row
;
24377 last_overlapping_row
= row
;
24381 if (expose_line (w
, row
, &r
))
24382 mouse_face_overwritten_p
= 1;
24385 else if (row
->overlapping_p
)
24387 /* We must redraw a row overlapping the exposed area. */
24389 ? y0
+ row
->phys_height
> r
.y
24390 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
24392 if (first_overlapping_row
== NULL
)
24393 first_overlapping_row
= row
;
24394 last_overlapping_row
= row
;
24402 /* Display the mode line if there is one. */
24403 if (WINDOW_WANTS_MODELINE_P (w
)
24404 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
24406 && row
->y
< r
.y
+ r
.height
)
24408 if (expose_line (w
, row
, &r
))
24409 mouse_face_overwritten_p
= 1;
24412 if (!w
->pseudo_window_p
)
24414 /* Fix the display of overlapping rows. */
24415 if (first_overlapping_row
)
24416 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
24419 /* Draw border between windows. */
24420 x_draw_vertical_border (w
);
24422 /* Turn the cursor on again. */
24423 if (cursor_cleared_p
)
24424 update_window_cursor (w
, 1);
24428 return mouse_face_overwritten_p
;
24433 /* Redraw (parts) of all windows in the window tree rooted at W that
24434 intersect R. R contains frame pixel coordinates. Value is
24435 non-zero if the exposure overwrites mouse-face. */
24438 expose_window_tree (w
, r
)
24442 struct frame
*f
= XFRAME (w
->frame
);
24443 int mouse_face_overwritten_p
= 0;
24445 while (w
&& !FRAME_GARBAGED_P (f
))
24447 if (!NILP (w
->hchild
))
24448 mouse_face_overwritten_p
24449 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
24450 else if (!NILP (w
->vchild
))
24451 mouse_face_overwritten_p
24452 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
24454 mouse_face_overwritten_p
|= expose_window (w
, r
);
24456 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
24459 return mouse_face_overwritten_p
;
24464 Redisplay an exposed area of frame F. X and Y are the upper-left
24465 corner of the exposed rectangle. W and H are width and height of
24466 the exposed area. All are pixel values. W or H zero means redraw
24467 the entire frame. */
24470 expose_frame (f
, x
, y
, w
, h
)
24475 int mouse_face_overwritten_p
= 0;
24477 TRACE ((stderr
, "expose_frame "));
24479 /* No need to redraw if frame will be redrawn soon. */
24480 if (FRAME_GARBAGED_P (f
))
24482 TRACE ((stderr
, " garbaged\n"));
24486 /* If basic faces haven't been realized yet, there is no point in
24487 trying to redraw anything. This can happen when we get an expose
24488 event while Emacs is starting, e.g. by moving another window. */
24489 if (FRAME_FACE_CACHE (f
) == NULL
24490 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
24492 TRACE ((stderr
, " no faces\n"));
24496 if (w
== 0 || h
== 0)
24499 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
24500 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
24510 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
24511 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
24513 if (WINDOWP (f
->tool_bar_window
))
24514 mouse_face_overwritten_p
24515 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
24517 #ifdef HAVE_X_WINDOWS
24519 #ifndef USE_X_TOOLKIT
24520 if (WINDOWP (f
->menu_bar_window
))
24521 mouse_face_overwritten_p
24522 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
24523 #endif /* not USE_X_TOOLKIT */
24527 /* Some window managers support a focus-follows-mouse style with
24528 delayed raising of frames. Imagine a partially obscured frame,
24529 and moving the mouse into partially obscured mouse-face on that
24530 frame. The visible part of the mouse-face will be highlighted,
24531 then the WM raises the obscured frame. With at least one WM, KDE
24532 2.1, Emacs is not getting any event for the raising of the frame
24533 (even tried with SubstructureRedirectMask), only Expose events.
24534 These expose events will draw text normally, i.e. not
24535 highlighted. Which means we must redo the highlight here.
24536 Subsume it under ``we love X''. --gerd 2001-08-15 */
24537 /* Included in Windows version because Windows most likely does not
24538 do the right thing if any third party tool offers
24539 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
24540 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
24542 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24543 if (f
== dpyinfo
->mouse_face_mouse_frame
)
24545 int x
= dpyinfo
->mouse_face_mouse_x
;
24546 int y
= dpyinfo
->mouse_face_mouse_y
;
24547 clear_mouse_face (dpyinfo
);
24548 note_mouse_highlight (f
, x
, y
);
24555 Determine the intersection of two rectangles R1 and R2. Return
24556 the intersection in *RESULT. Value is non-zero if RESULT is not
24560 x_intersect_rectangles (r1
, r2
, result
)
24561 XRectangle
*r1
, *r2
, *result
;
24563 XRectangle
*left
, *right
;
24564 XRectangle
*upper
, *lower
;
24565 int intersection_p
= 0;
24567 /* Rearrange so that R1 is the left-most rectangle. */
24569 left
= r1
, right
= r2
;
24571 left
= r2
, right
= r1
;
24573 /* X0 of the intersection is right.x0, if this is inside R1,
24574 otherwise there is no intersection. */
24575 if (right
->x
<= left
->x
+ left
->width
)
24577 result
->x
= right
->x
;
24579 /* The right end of the intersection is the minimum of the
24580 the right ends of left and right. */
24581 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
24584 /* Same game for Y. */
24586 upper
= r1
, lower
= r2
;
24588 upper
= r2
, lower
= r1
;
24590 /* The upper end of the intersection is lower.y0, if this is inside
24591 of upper. Otherwise, there is no intersection. */
24592 if (lower
->y
<= upper
->y
+ upper
->height
)
24594 result
->y
= lower
->y
;
24596 /* The lower end of the intersection is the minimum of the lower
24597 ends of upper and lower. */
24598 result
->height
= (min (lower
->y
+ lower
->height
,
24599 upper
->y
+ upper
->height
)
24601 intersection_p
= 1;
24605 return intersection_p
;
24608 #endif /* HAVE_WINDOW_SYSTEM */
24611 /***********************************************************************
24613 ***********************************************************************/
24618 Vwith_echo_area_save_vector
= Qnil
;
24619 staticpro (&Vwith_echo_area_save_vector
);
24621 Vmessage_stack
= Qnil
;
24622 staticpro (&Vmessage_stack
);
24624 Qinhibit_redisplay
= intern ("inhibit-redisplay");
24625 staticpro (&Qinhibit_redisplay
);
24627 message_dolog_marker1
= Fmake_marker ();
24628 staticpro (&message_dolog_marker1
);
24629 message_dolog_marker2
= Fmake_marker ();
24630 staticpro (&message_dolog_marker2
);
24631 message_dolog_marker3
= Fmake_marker ();
24632 staticpro (&message_dolog_marker3
);
24635 defsubr (&Sdump_frame_glyph_matrix
);
24636 defsubr (&Sdump_glyph_matrix
);
24637 defsubr (&Sdump_glyph_row
);
24638 defsubr (&Sdump_tool_bar_row
);
24639 defsubr (&Strace_redisplay
);
24640 defsubr (&Strace_to_stderr
);
24642 #ifdef HAVE_WINDOW_SYSTEM
24643 defsubr (&Stool_bar_lines_needed
);
24644 defsubr (&Slookup_image_map
);
24646 defsubr (&Sformat_mode_line
);
24647 defsubr (&Sinvisible_p
);
24649 staticpro (&Qmenu_bar_update_hook
);
24650 Qmenu_bar_update_hook
= intern ("menu-bar-update-hook");
24652 staticpro (&Qoverriding_terminal_local_map
);
24653 Qoverriding_terminal_local_map
= intern ("overriding-terminal-local-map");
24655 staticpro (&Qoverriding_local_map
);
24656 Qoverriding_local_map
= intern ("overriding-local-map");
24658 staticpro (&Qwindow_scroll_functions
);
24659 Qwindow_scroll_functions
= intern ("window-scroll-functions");
24661 staticpro (&Qwindow_text_change_functions
);
24662 Qwindow_text_change_functions
= intern ("window-text-change-functions");
24664 staticpro (&Qredisplay_end_trigger_functions
);
24665 Qredisplay_end_trigger_functions
= intern ("redisplay-end-trigger-functions");
24667 staticpro (&Qinhibit_point_motion_hooks
);
24668 Qinhibit_point_motion_hooks
= intern ("inhibit-point-motion-hooks");
24670 Qeval
= intern ("eval");
24671 staticpro (&Qeval
);
24673 QCdata
= intern (":data");
24674 staticpro (&QCdata
);
24675 Qdisplay
= intern ("display");
24676 staticpro (&Qdisplay
);
24677 Qspace_width
= intern ("space-width");
24678 staticpro (&Qspace_width
);
24679 Qraise
= intern ("raise");
24680 staticpro (&Qraise
);
24681 Qslice
= intern ("slice");
24682 staticpro (&Qslice
);
24683 Qspace
= intern ("space");
24684 staticpro (&Qspace
);
24685 Qmargin
= intern ("margin");
24686 staticpro (&Qmargin
);
24687 Qpointer
= intern ("pointer");
24688 staticpro (&Qpointer
);
24689 Qleft_margin
= intern ("left-margin");
24690 staticpro (&Qleft_margin
);
24691 Qright_margin
= intern ("right-margin");
24692 staticpro (&Qright_margin
);
24693 Qcenter
= intern ("center");
24694 staticpro (&Qcenter
);
24695 Qline_height
= intern ("line-height");
24696 staticpro (&Qline_height
);
24697 QCalign_to
= intern (":align-to");
24698 staticpro (&QCalign_to
);
24699 QCrelative_width
= intern (":relative-width");
24700 staticpro (&QCrelative_width
);
24701 QCrelative_height
= intern (":relative-height");
24702 staticpro (&QCrelative_height
);
24703 QCeval
= intern (":eval");
24704 staticpro (&QCeval
);
24705 QCpropertize
= intern (":propertize");
24706 staticpro (&QCpropertize
);
24707 QCfile
= intern (":file");
24708 staticpro (&QCfile
);
24709 Qfontified
= intern ("fontified");
24710 staticpro (&Qfontified
);
24711 Qfontification_functions
= intern ("fontification-functions");
24712 staticpro (&Qfontification_functions
);
24713 Qtrailing_whitespace
= intern ("trailing-whitespace");
24714 staticpro (&Qtrailing_whitespace
);
24715 Qescape_glyph
= intern ("escape-glyph");
24716 staticpro (&Qescape_glyph
);
24717 Qnobreak_space
= intern ("nobreak-space");
24718 staticpro (&Qnobreak_space
);
24719 Qimage
= intern ("image");
24720 staticpro (&Qimage
);
24721 QCmap
= intern (":map");
24722 staticpro (&QCmap
);
24723 QCpointer
= intern (":pointer");
24724 staticpro (&QCpointer
);
24725 Qrect
= intern ("rect");
24726 staticpro (&Qrect
);
24727 Qcircle
= intern ("circle");
24728 staticpro (&Qcircle
);
24729 Qpoly
= intern ("poly");
24730 staticpro (&Qpoly
);
24731 Qmessage_truncate_lines
= intern ("message-truncate-lines");
24732 staticpro (&Qmessage_truncate_lines
);
24733 Qgrow_only
= intern ("grow-only");
24734 staticpro (&Qgrow_only
);
24735 Qinhibit_menubar_update
= intern ("inhibit-menubar-update");
24736 staticpro (&Qinhibit_menubar_update
);
24737 Qinhibit_eval_during_redisplay
= intern ("inhibit-eval-during-redisplay");
24738 staticpro (&Qinhibit_eval_during_redisplay
);
24739 Qposition
= intern ("position");
24740 staticpro (&Qposition
);
24741 Qbuffer_position
= intern ("buffer-position");
24742 staticpro (&Qbuffer_position
);
24743 Qobject
= intern ("object");
24744 staticpro (&Qobject
);
24745 Qbar
= intern ("bar");
24747 Qhbar
= intern ("hbar");
24748 staticpro (&Qhbar
);
24749 Qbox
= intern ("box");
24751 Qhollow
= intern ("hollow");
24752 staticpro (&Qhollow
);
24753 Qhand
= intern ("hand");
24754 staticpro (&Qhand
);
24755 Qarrow
= intern ("arrow");
24756 staticpro (&Qarrow
);
24757 Qtext
= intern ("text");
24758 staticpro (&Qtext
);
24759 Qrisky_local_variable
= intern ("risky-local-variable");
24760 staticpro (&Qrisky_local_variable
);
24761 Qinhibit_free_realized_faces
= intern ("inhibit-free-realized-faces");
24762 staticpro (&Qinhibit_free_realized_faces
);
24764 list_of_error
= Fcons (Fcons (intern ("error"),
24765 Fcons (intern ("void-variable"), Qnil
)),
24767 staticpro (&list_of_error
);
24769 Qlast_arrow_position
= intern ("last-arrow-position");
24770 staticpro (&Qlast_arrow_position
);
24771 Qlast_arrow_string
= intern ("last-arrow-string");
24772 staticpro (&Qlast_arrow_string
);
24774 Qoverlay_arrow_string
= intern ("overlay-arrow-string");
24775 staticpro (&Qoverlay_arrow_string
);
24776 Qoverlay_arrow_bitmap
= intern ("overlay-arrow-bitmap");
24777 staticpro (&Qoverlay_arrow_bitmap
);
24779 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
24780 staticpro (&echo_buffer
[0]);
24781 staticpro (&echo_buffer
[1]);
24783 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
24784 staticpro (&echo_area_buffer
[0]);
24785 staticpro (&echo_area_buffer
[1]);
24787 Vmessages_buffer_name
= build_string ("*Messages*");
24788 staticpro (&Vmessages_buffer_name
);
24790 mode_line_proptrans_alist
= Qnil
;
24791 staticpro (&mode_line_proptrans_alist
);
24792 mode_line_string_list
= Qnil
;
24793 staticpro (&mode_line_string_list
);
24794 mode_line_string_face
= Qnil
;
24795 staticpro (&mode_line_string_face
);
24796 mode_line_string_face_prop
= Qnil
;
24797 staticpro (&mode_line_string_face_prop
);
24798 Vmode_line_unwind_vector
= Qnil
;
24799 staticpro (&Vmode_line_unwind_vector
);
24801 help_echo_string
= Qnil
;
24802 staticpro (&help_echo_string
);
24803 help_echo_object
= Qnil
;
24804 staticpro (&help_echo_object
);
24805 help_echo_window
= Qnil
;
24806 staticpro (&help_echo_window
);
24807 previous_help_echo_string
= Qnil
;
24808 staticpro (&previous_help_echo_string
);
24809 help_echo_pos
= -1;
24811 #ifdef HAVE_WINDOW_SYSTEM
24812 DEFVAR_BOOL ("x-stretch-cursor", &x_stretch_cursor_p
,
24813 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
24814 For example, if a block cursor is over a tab, it will be drawn as
24815 wide as that tab on the display. */);
24816 x_stretch_cursor_p
= 0;
24819 DEFVAR_LISP ("show-trailing-whitespace", &Vshow_trailing_whitespace
,
24820 doc
: /* *Non-nil means highlight trailing whitespace.
24821 The face used for trailing whitespace is `trailing-whitespace'. */);
24822 Vshow_trailing_whitespace
= Qnil
;
24824 DEFVAR_LISP ("nobreak-char-display", &Vnobreak_char_display
,
24825 doc
: /* *Control highlighting of nobreak space and soft hyphen.
24826 A value of t means highlight the character itself (for nobreak space,
24827 use face `nobreak-space').
24828 A value of nil means no highlighting.
24829 Other values mean display the escape glyph followed by an ordinary
24830 space or ordinary hyphen. */);
24831 Vnobreak_char_display
= Qt
;
24833 DEFVAR_LISP ("void-text-area-pointer", &Vvoid_text_area_pointer
,
24834 doc
: /* *The pointer shape to show in void text areas.
24835 A value of nil means to show the text pointer. Other options are `arrow',
24836 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
24837 Vvoid_text_area_pointer
= Qarrow
;
24839 DEFVAR_LISP ("inhibit-redisplay", &Vinhibit_redisplay
,
24840 doc
: /* Non-nil means don't actually do any redisplay.
24841 This is used for internal purposes. */);
24842 Vinhibit_redisplay
= Qnil
;
24844 DEFVAR_LISP ("global-mode-string", &Vglobal_mode_string
,
24845 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
24846 Vglobal_mode_string
= Qnil
;
24848 DEFVAR_LISP ("overlay-arrow-position", &Voverlay_arrow_position
,
24849 doc
: /* Marker for where to display an arrow on top of the buffer text.
24850 This must be the beginning of a line in order to work.
24851 See also `overlay-arrow-string'. */);
24852 Voverlay_arrow_position
= Qnil
;
24854 DEFVAR_LISP ("overlay-arrow-string", &Voverlay_arrow_string
,
24855 doc
: /* String to display as an arrow in non-window frames.
24856 See also `overlay-arrow-position'. */);
24857 Voverlay_arrow_string
= build_string ("=>");
24859 DEFVAR_LISP ("overlay-arrow-variable-list", &Voverlay_arrow_variable_list
,
24860 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
24861 The symbols on this list are examined during redisplay to determine
24862 where to display overlay arrows. */);
24863 Voverlay_arrow_variable_list
24864 = Fcons (intern ("overlay-arrow-position"), Qnil
);
24866 DEFVAR_INT ("scroll-step", &scroll_step
,
24867 doc
: /* *The number of lines to try scrolling a window by when point moves out.
24868 If that fails to bring point back on frame, point is centered instead.
24869 If this is zero, point is always centered after it moves off frame.
24870 If you want scrolling to always be a line at a time, you should set
24871 `scroll-conservatively' to a large value rather than set this to 1. */);
24873 DEFVAR_INT ("scroll-conservatively", &scroll_conservatively
,
24874 doc
: /* *Scroll up to this many lines, to bring point back on screen.
24875 If point moves off-screen, redisplay will scroll by up to
24876 `scroll-conservatively' lines in order to bring point just barely
24877 onto the screen again. If that cannot be done, then redisplay
24878 recenters point as usual.
24880 A value of zero means always recenter point if it moves off screen. */);
24881 scroll_conservatively
= 0;
24883 DEFVAR_INT ("scroll-margin", &scroll_margin
,
24884 doc
: /* *Number of lines of margin at the top and bottom of a window.
24885 Recenter the window whenever point gets within this many lines
24886 of the top or bottom of the window. */);
24889 DEFVAR_LISP ("display-pixels-per-inch", &Vdisplay_pixels_per_inch
,
24890 doc
: /* Pixels per inch value for non-window system displays.
24891 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
24892 Vdisplay_pixels_per_inch
= make_float (72.0);
24895 DEFVAR_INT ("debug-end-pos", &debug_end_pos
, doc
: /* Don't ask. */);
24898 DEFVAR_LISP ("truncate-partial-width-windows",
24899 &Vtruncate_partial_width_windows
,
24900 doc
: /* Non-nil means truncate lines in windows with less than the frame width.
24901 For an integer value, truncate lines in each window with less than the
24902 full frame width, provided the window width is less than that integer;
24903 otherwise, respect the value of `truncate-lines'.
24905 For any other non-nil value, truncate lines in all windows with
24906 less than the full frame width.
24908 A value of nil means to respect the value of `truncate-lines'. */);
24909 Vtruncate_partial_width_windows
= make_number (30);
24911 DEFVAR_BOOL ("mode-line-inverse-video", &mode_line_inverse_video
,
24912 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
24913 Any other value means to use the appropriate face, `mode-line',
24914 `header-line', or `menu' respectively. */);
24915 mode_line_inverse_video
= 1;
24917 DEFVAR_LISP ("line-number-display-limit", &Vline_number_display_limit
,
24918 doc
: /* *Maximum buffer size for which line number should be displayed.
24919 If the buffer is bigger than this, the line number does not appear
24920 in the mode line. A value of nil means no limit. */);
24921 Vline_number_display_limit
= Qnil
;
24923 DEFVAR_INT ("line-number-display-limit-width",
24924 &line_number_display_limit_width
,
24925 doc
: /* *Maximum line width (in characters) for line number display.
24926 If the average length of the lines near point is bigger than this, then the
24927 line number may be omitted from the mode line. */);
24928 line_number_display_limit_width
= 200;
24930 DEFVAR_BOOL ("highlight-nonselected-windows", &highlight_nonselected_windows
,
24931 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
24932 highlight_nonselected_windows
= 0;
24934 DEFVAR_BOOL ("multiple-frames", &multiple_frames
,
24935 doc
: /* Non-nil if more than one frame is visible on this display.
24936 Minibuffer-only frames don't count, but iconified frames do.
24937 This variable is not guaranteed to be accurate except while processing
24938 `frame-title-format' and `icon-title-format'. */);
24940 DEFVAR_LISP ("frame-title-format", &Vframe_title_format
,
24941 doc
: /* Template for displaying the title bar of visible frames.
24942 \(Assuming the window manager supports this feature.)
24944 This variable has the same structure as `mode-line-format', except that
24945 the %c and %l constructs are ignored. It is used only on frames for
24946 which no explicit name has been set \(see `modify-frame-parameters'). */);
24948 DEFVAR_LISP ("icon-title-format", &Vicon_title_format
,
24949 doc
: /* Template for displaying the title bar of an iconified frame.
24950 \(Assuming the window manager supports this feature.)
24951 This variable has the same structure as `mode-line-format' (which see),
24952 and is used only on frames for which no explicit name has been set
24953 \(see `modify-frame-parameters'). */);
24955 = Vframe_title_format
24956 = Fcons (intern ("multiple-frames"),
24957 Fcons (build_string ("%b"),
24958 Fcons (Fcons (empty_unibyte_string
,
24959 Fcons (intern ("invocation-name"),
24960 Fcons (build_string ("@"),
24961 Fcons (intern ("system-name"),
24965 DEFVAR_LISP ("message-log-max", &Vmessage_log_max
,
24966 doc
: /* Maximum number of lines to keep in the message log buffer.
24967 If nil, disable message logging. If t, log messages but don't truncate
24968 the buffer when it becomes large. */);
24969 Vmessage_log_max
= make_number (100);
24971 DEFVAR_LISP ("window-size-change-functions", &Vwindow_size_change_functions
,
24972 doc
: /* Functions called before redisplay, if window sizes have changed.
24973 The value should be a list of functions that take one argument.
24974 Just before redisplay, for each frame, if any of its windows have changed
24975 size since the last redisplay, or have been split or deleted,
24976 all the functions in the list are called, with the frame as argument. */);
24977 Vwindow_size_change_functions
= Qnil
;
24979 DEFVAR_LISP ("window-scroll-functions", &Vwindow_scroll_functions
,
24980 doc
: /* List of functions to call before redisplaying a window with scrolling.
24981 Each function is called with two arguments, the window
24982 and its new display-start position. Note that the value of `window-end'
24983 is not valid when these functions are called. */);
24984 Vwindow_scroll_functions
= Qnil
;
24986 DEFVAR_LISP ("window-text-change-functions",
24987 &Vwindow_text_change_functions
,
24988 doc
: /* Functions to call in redisplay when text in the window might change. */);
24989 Vwindow_text_change_functions
= Qnil
;
24991 DEFVAR_LISP ("redisplay-end-trigger-functions", &Vredisplay_end_trigger_functions
,
24992 doc
: /* Functions called when redisplay of a window reaches the end trigger.
24993 Each function is called with two arguments, the window and the end trigger value.
24994 See `set-window-redisplay-end-trigger'. */);
24995 Vredisplay_end_trigger_functions
= Qnil
;
24997 DEFVAR_LISP ("mouse-autoselect-window", &Vmouse_autoselect_window
,
24998 doc
: /* *Non-nil means autoselect window with mouse pointer.
24999 If nil, do not autoselect windows.
25000 A positive number means delay autoselection by that many seconds: a
25001 window is autoselected only after the mouse has remained in that
25002 window for the duration of the delay.
25003 A negative number has a similar effect, but causes windows to be
25004 autoselected only after the mouse has stopped moving. \(Because of
25005 the way Emacs compares mouse events, you will occasionally wait twice
25006 that time before the window gets selected.\)
25007 Any other value means to autoselect window instantaneously when the
25008 mouse pointer enters it.
25010 Autoselection selects the minibuffer only if it is active, and never
25011 unselects the minibuffer if it is active.
25013 When customizing this variable make sure that the actual value of
25014 `focus-follows-mouse' matches the behavior of your window manager. */);
25015 Vmouse_autoselect_window
= Qnil
;
25017 DEFVAR_LISP ("auto-resize-tool-bars", &Vauto_resize_tool_bars
,
25018 doc
: /* *Non-nil means automatically resize tool-bars.
25019 This dynamically changes the tool-bar's height to the minimum height
25020 that is needed to make all tool-bar items visible.
25021 If value is `grow-only', the tool-bar's height is only increased
25022 automatically; to decrease the tool-bar height, use \\[recenter]. */);
25023 Vauto_resize_tool_bars
= Qt
;
25025 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", &auto_raise_tool_bar_buttons_p
,
25026 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
25027 auto_raise_tool_bar_buttons_p
= 1;
25029 DEFVAR_BOOL ("make-cursor-line-fully-visible", &make_cursor_line_fully_visible_p
,
25030 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
25031 make_cursor_line_fully_visible_p
= 1;
25033 DEFVAR_LISP ("tool-bar-border", &Vtool_bar_border
,
25034 doc
: /* *Border below tool-bar in pixels.
25035 If an integer, use it as the height of the border.
25036 If it is one of `internal-border-width' or `border-width', use the
25037 value of the corresponding frame parameter.
25038 Otherwise, no border is added below the tool-bar. */);
25039 Vtool_bar_border
= Qinternal_border_width
;
25041 DEFVAR_LISP ("tool-bar-button-margin", &Vtool_bar_button_margin
,
25042 doc
: /* *Margin around tool-bar buttons in pixels.
25043 If an integer, use that for both horizontal and vertical margins.
25044 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
25045 HORZ specifying the horizontal margin, and VERT specifying the
25046 vertical margin. */);
25047 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
25049 DEFVAR_INT ("tool-bar-button-relief", &tool_bar_button_relief
,
25050 doc
: /* *Relief thickness of tool-bar buttons. */);
25051 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
25053 DEFVAR_LISP ("fontification-functions", &Vfontification_functions
,
25054 doc
: /* List of functions to call to fontify regions of text.
25055 Each function is called with one argument POS. Functions must
25056 fontify a region starting at POS in the current buffer, and give
25057 fontified regions the property `fontified'. */);
25058 Vfontification_functions
= Qnil
;
25059 Fmake_variable_buffer_local (Qfontification_functions
);
25061 DEFVAR_BOOL ("unibyte-display-via-language-environment",
25062 &unibyte_display_via_language_environment
,
25063 doc
: /* *Non-nil means display unibyte text according to language environment.
25064 Specifically this means that unibyte non-ASCII characters
25065 are displayed by converting them to the equivalent multibyte characters
25066 according to the current language environment. As a result, they are
25067 displayed according to the current fontset. */);
25068 unibyte_display_via_language_environment
= 0;
25070 DEFVAR_LISP ("max-mini-window-height", &Vmax_mini_window_height
,
25071 doc
: /* *Maximum height for resizing mini-windows.
25072 If a float, it specifies a fraction of the mini-window frame's height.
25073 If an integer, it specifies a number of lines. */);
25074 Vmax_mini_window_height
= make_float (0.25);
25076 DEFVAR_LISP ("resize-mini-windows", &Vresize_mini_windows
,
25077 doc
: /* *How to resize mini-windows.
25078 A value of nil means don't automatically resize mini-windows.
25079 A value of t means resize them to fit the text displayed in them.
25080 A value of `grow-only', the default, means let mini-windows grow
25081 only, until their display becomes empty, at which point the windows
25082 go back to their normal size. */);
25083 Vresize_mini_windows
= Qgrow_only
;
25085 DEFVAR_LISP ("blink-cursor-alist", &Vblink_cursor_alist
,
25086 doc
: /* Alist specifying how to blink the cursor off.
25087 Each element has the form (ON-STATE . OFF-STATE). Whenever the
25088 `cursor-type' frame-parameter or variable equals ON-STATE,
25089 comparing using `equal', Emacs uses OFF-STATE to specify
25090 how to blink it off. ON-STATE and OFF-STATE are values for
25091 the `cursor-type' frame parameter.
25093 If a frame's ON-STATE has no entry in this list,
25094 the frame's other specifications determine how to blink the cursor off. */);
25095 Vblink_cursor_alist
= Qnil
;
25097 DEFVAR_BOOL ("auto-hscroll-mode", &automatic_hscrolling_p
,
25098 doc
: /* *Non-nil means scroll the display automatically to make point visible. */);
25099 automatic_hscrolling_p
= 1;
25100 Qauto_hscroll_mode
= intern ("auto-hscroll-mode");
25101 staticpro (&Qauto_hscroll_mode
);
25103 DEFVAR_INT ("hscroll-margin", &hscroll_margin
,
25104 doc
: /* *How many columns away from the window edge point is allowed to get
25105 before automatic hscrolling will horizontally scroll the window. */);
25106 hscroll_margin
= 5;
25108 DEFVAR_LISP ("hscroll-step", &Vhscroll_step
,
25109 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
25110 When point is less than `hscroll-margin' columns from the window
25111 edge, automatic hscrolling will scroll the window by the amount of columns
25112 determined by this variable. If its value is a positive integer, scroll that
25113 many columns. If it's a positive floating-point number, it specifies the
25114 fraction of the window's width to scroll. If it's nil or zero, point will be
25115 centered horizontally after the scroll. Any other value, including negative
25116 numbers, are treated as if the value were zero.
25118 Automatic hscrolling always moves point outside the scroll margin, so if
25119 point was more than scroll step columns inside the margin, the window will
25120 scroll more than the value given by the scroll step.
25122 Note that the lower bound for automatic hscrolling specified by `scroll-left'
25123 and `scroll-right' overrides this variable's effect. */);
25124 Vhscroll_step
= make_number (0);
25126 DEFVAR_BOOL ("message-truncate-lines", &message_truncate_lines
,
25127 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
25128 Bind this around calls to `message' to let it take effect. */);
25129 message_truncate_lines
= 0;
25131 DEFVAR_LISP ("menu-bar-update-hook", &Vmenu_bar_update_hook
,
25132 doc
: /* Normal hook run to update the menu bar definitions.
25133 Redisplay runs this hook before it redisplays the menu bar.
25134 This is used to update submenus such as Buffers,
25135 whose contents depend on various data. */);
25136 Vmenu_bar_update_hook
= Qnil
;
25138 DEFVAR_LISP ("menu-updating-frame", &Vmenu_updating_frame
,
25139 doc
: /* Frame for which we are updating a menu.
25140 The enable predicate for a menu binding should check this variable. */);
25141 Vmenu_updating_frame
= Qnil
;
25143 DEFVAR_BOOL ("inhibit-menubar-update", &inhibit_menubar_update
,
25144 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
25145 inhibit_menubar_update
= 0;
25147 DEFVAR_LISP ("wrap-prefix", &Vwrap_prefix
,
25148 doc
: /* Prefix added to the beginning of all continuation lines at display-time.
25149 May be a string, an image, or a stretch-glyph such as used by the
25150 `display' text-property.
25152 This variable is overridden by any `wrap-prefix' text-property.
25154 To add a prefix to non-continuation lines, use the `line-prefix' variable. */);
25155 Vwrap_prefix
= Qnil
;
25156 staticpro (&Qwrap_prefix
);
25157 Qwrap_prefix
= intern ("wrap-prefix");
25158 Fmake_variable_buffer_local (Qwrap_prefix
);
25160 DEFVAR_LISP ("line-prefix", &Vline_prefix
,
25161 doc
: /* Prefix added to the beginning of all non-continuation lines at display-time.
25162 May be a string, an image, or a stretch-glyph such as used by the
25163 `display' text-property.
25165 This variable is overridden by any `line-prefix' text-property.
25167 To add a prefix to continuation lines, use the `wrap-prefix' variable. */);
25168 Vline_prefix
= Qnil
;
25169 staticpro (&Qline_prefix
);
25170 Qline_prefix
= intern ("line-prefix");
25171 Fmake_variable_buffer_local (Qline_prefix
);
25173 DEFVAR_BOOL ("inhibit-eval-during-redisplay", &inhibit_eval_during_redisplay
,
25174 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
25175 inhibit_eval_during_redisplay
= 0;
25177 DEFVAR_BOOL ("inhibit-free-realized-faces", &inhibit_free_realized_faces
,
25178 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
25179 inhibit_free_realized_faces
= 0;
25182 DEFVAR_BOOL ("inhibit-try-window-id", &inhibit_try_window_id
,
25183 doc
: /* Inhibit try_window_id display optimization. */);
25184 inhibit_try_window_id
= 0;
25186 DEFVAR_BOOL ("inhibit-try-window-reusing", &inhibit_try_window_reusing
,
25187 doc
: /* Inhibit try_window_reusing display optimization. */);
25188 inhibit_try_window_reusing
= 0;
25190 DEFVAR_BOOL ("inhibit-try-cursor-movement", &inhibit_try_cursor_movement
,
25191 doc
: /* Inhibit try_cursor_movement display optimization. */);
25192 inhibit_try_cursor_movement
= 0;
25193 #endif /* GLYPH_DEBUG */
25195 DEFVAR_INT ("overline-margin", &overline_margin
,
25196 doc
: /* *Space between overline and text, in pixels.
25197 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
25198 margin to the caracter height. */);
25199 overline_margin
= 2;
25201 DEFVAR_INT ("underline-minimum-offset",
25202 &underline_minimum_offset
,
25203 doc
: /* Minimum distance between baseline and underline.
25204 This can improve legibility of underlined text at small font sizes,
25205 particularly when using variable `x-use-underline-position-properties'
25206 with fonts that specify an UNDERLINE_POSITION relatively close to the
25207 baseline. The default value is 1. */);
25208 underline_minimum_offset
= 1;
25210 DEFVAR_BOOL ("display-hourglass", &display_hourglass_p
,
25211 doc
: /* Non-zero means Emacs displays an hourglass pointer on window systems. */);
25212 display_hourglass_p
= 1;
25214 DEFVAR_LISP ("hourglass-delay", &Vhourglass_delay
,
25215 doc
: /* *Seconds to wait before displaying an hourglass pointer.
25216 Value must be an integer or float. */);
25217 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
25219 hourglass_atimer
= NULL
;
25220 hourglass_shown_p
= 0;
25224 /* Initialize this module when Emacs starts. */
25229 Lisp_Object root_window
;
25230 struct window
*mini_w
;
25232 current_header_line_height
= current_mode_line_height
= -1;
25234 CHARPOS (this_line_start_pos
) = 0;
25236 mini_w
= XWINDOW (minibuf_window
);
25237 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
25239 if (!noninteractive
)
25241 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
25244 XWINDOW (root_window
)->top_line
= make_number (FRAME_TOP_MARGIN (f
));
25245 set_window_height (root_window
,
25246 FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
),
25248 mini_w
->top_line
= make_number (FRAME_LINES (f
) - 1);
25249 set_window_height (minibuf_window
, 1, 0);
25251 XWINDOW (root_window
)->total_cols
= make_number (FRAME_COLS (f
));
25252 mini_w
->total_cols
= make_number (FRAME_COLS (f
));
25254 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
25255 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
25256 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
25258 /* The default ellipsis glyphs `...'. */
25259 for (i
= 0; i
< 3; ++i
)
25260 default_invis_vector
[i
] = make_number ('.');
25264 /* Allocate the buffer for frame titles.
25265 Also used for `format-mode-line'. */
25267 mode_line_noprop_buf
= (char *) xmalloc (size
);
25268 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
25269 mode_line_noprop_ptr
= mode_line_noprop_buf
;
25270 mode_line_target
= MODE_LINE_DISPLAY
;
25273 help_echo_showing_p
= 0;
25276 /* Since w32 does not support atimers, it defines its own implementation of
25277 the following three functions in w32fns.c. */
25280 /* Platform-independent portion of hourglass implementation. */
25282 /* Return non-zero if houglass timer has been started or hourglass is shown. */
25284 hourglass_started ()
25286 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
25289 /* Cancel a currently active hourglass timer, and start a new one. */
25293 #if defined (HAVE_WINDOW_SYSTEM)
25295 int secs
, usecs
= 0;
25297 cancel_hourglass ();
25299 if (INTEGERP (Vhourglass_delay
)
25300 && XINT (Vhourglass_delay
) > 0)
25301 secs
= XFASTINT (Vhourglass_delay
);
25302 else if (FLOATP (Vhourglass_delay
)
25303 && XFLOAT_DATA (Vhourglass_delay
) > 0)
25306 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
25307 secs
= XFASTINT (tem
);
25308 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
25311 secs
= DEFAULT_HOURGLASS_DELAY
;
25313 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
25314 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
25315 show_hourglass
, NULL
);
25320 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
25323 cancel_hourglass ()
25325 #if defined (HAVE_WINDOW_SYSTEM)
25326 if (hourglass_atimer
)
25328 cancel_atimer (hourglass_atimer
);
25329 hourglass_atimer
= NULL
;
25332 if (hourglass_shown_p
)
25336 #endif /* ! WINDOWSNT */
25338 /* arch-tag: eacc864d-bb6a-4b74-894a-1a4399a1358b
25339 (do not change this comment) */