1 /* Display generation from window structure and buffer text.
2 Copyright (C) 1985,86,87,88,93,94,95,97,98,99,2000,01,02,03
3 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
22 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>.
26 Emacs separates the task of updating the display from code
27 modifying global state, e.g. buffer text. This way functions
28 operating on buffers don't also have to be concerned with updating
31 Updating the display is triggered by the Lisp interpreter when it
32 decides it's time to do it. This is done either automatically for
33 you as part of the interpreter's command loop or as the result of
34 calling Lisp functions like `sit-for'. The C function `redisplay'
35 in xdisp.c is the only entry into the inner redisplay code. (Or,
36 let's say almost---see the description of direct update
39 The following diagram shows how redisplay code is invoked. As you
40 can see, Lisp calls redisplay and vice versa. Under window systems
41 like X, some portions of the redisplay code are also called
42 asynchronously during mouse movement or expose events. It is very
43 important that these code parts do NOT use the C library (malloc,
44 free) because many C libraries under Unix are not reentrant. They
45 may also NOT call functions of the Lisp interpreter which could
46 change the interpreter's state. If you don't follow these rules,
47 you will encounter bugs which are very hard to explain.
49 (Direct functions, see below)
50 direct_output_for_insert,
51 direct_forward_char (dispnew.c)
52 +---------------------------------+
55 +--------------+ redisplay +----------------+
56 | Lisp machine |---------------->| Redisplay code |<--+
57 +--------------+ (xdisp.c) +----------------+ |
59 +----------------------------------+ |
60 Don't use this path when called |
63 expose_window (asynchronous) |
65 X expose events -----+
67 What does redisplay do? Obviously, it has to figure out somehow what
68 has been changed since the last time the display has been updated,
69 and to make these changes visible. Preferably it would do that in
70 a moderately intelligent way, i.e. fast.
72 Changes in buffer text can be deduced from window and buffer
73 structures, and from some global variables like `beg_unchanged' and
74 `end_unchanged'. The contents of the display are additionally
75 recorded in a `glyph matrix', a two-dimensional matrix of glyph
76 structures. Each row in such a matrix corresponds to a line on the
77 display, and each glyph in a row corresponds to a column displaying
78 a character, an image, or what else. This matrix is called the
79 `current glyph matrix' or `current matrix' in redisplay
82 For buffer parts that have been changed since the last update, a
83 second glyph matrix is constructed, the so called `desired glyph
84 matrix' or short `desired matrix'. Current and desired matrix are
85 then compared to find a cheap way to update the display, e.g. by
86 reusing part of the display by scrolling lines.
91 You will find a lot of redisplay optimizations when you start
92 looking at the innards of redisplay. The overall goal of all these
93 optimizations is to make redisplay fast because it is done
96 Two optimizations are not found in xdisp.c. These are the direct
97 operations mentioned above. As the name suggests they follow a
98 different principle than the rest of redisplay. Instead of
99 building a desired matrix and then comparing it with the current
100 display, they perform their actions directly on the display and on
103 One direct operation updates the display after one character has
104 been entered. The other one moves the cursor by one position
105 forward or backward. You find these functions under the names
106 `direct_output_for_insert' and `direct_output_forward_char' in
112 Desired matrices are always built per Emacs window. The function
113 `display_line' is the central function to look at if you are
114 interested. It constructs one row in a desired matrix given an
115 iterator structure containing both a buffer position and a
116 description of the environment in which the text is to be
117 displayed. But this is too early, read on.
119 Characters and pixmaps displayed for a range of buffer text depend
120 on various settings of buffers and windows, on overlays and text
121 properties, on display tables, on selective display. The good news
122 is that all this hairy stuff is hidden behind a small set of
123 interface functions taking an iterator structure (struct it)
126 Iteration over things to be displayed is then simple. It is
127 started by initializing an iterator with a call to init_iterator.
128 Calls to get_next_display_element fill the iterator structure with
129 relevant information about the next thing to display. Calls to
130 set_iterator_to_next move the iterator to the next thing.
132 Besides this, an iterator also contains information about the
133 display environment in which glyphs for display elements are to be
134 produced. It has fields for the width and height of the display,
135 the information whether long lines are truncated or continued, a
136 current X and Y position, and lots of other stuff you can better
139 Glyphs in a desired matrix are normally constructed in a loop
140 calling get_next_display_element and then produce_glyphs. The call
141 to produce_glyphs will fill the iterator structure with pixel
142 information about the element being displayed and at the same time
143 produce glyphs for it. If the display element fits on the line
144 being displayed, set_iterator_to_next is called next, otherwise the
145 glyphs produced are discarded.
150 That just couldn't be all, could it? What about terminal types not
151 supporting operations on sub-windows of the screen? To update the
152 display on such a terminal, window-based glyph matrices are not
153 well suited. To be able to reuse part of the display (scrolling
154 lines up and down), we must instead have a view of the whole
155 screen. This is what `frame matrices' are for. They are a trick.
157 Frames on terminals like above have a glyph pool. Windows on such
158 a frame sub-allocate their glyph memory from their frame's glyph
159 pool. The frame itself is given its own glyph matrices. By
160 coincidence---or maybe something else---rows in window glyph
161 matrices are slices of corresponding rows in frame matrices. Thus
162 writing to window matrices implicitly updates a frame matrix which
163 provides us with the view of the whole screen that we originally
164 wanted to have without having to move many bytes around. To be
165 honest, there is a little bit more done, but not much more. If you
166 plan to extend that code, take a look at dispnew.c. The function
167 build_frame_matrix is a good starting point. */
173 #include "keyboard.h"
176 #include "systty.h" /* For emacs_tty in termchar.h */
177 #include "termchar.h"
178 #include "dispextern.h"
182 #include "commands.h"
186 #include "termhooks.h"
187 #include "intervals.h"
190 #include "region-cache.h"
192 #include "blockinput.h"
194 #ifdef HAVE_X_WINDOWS
206 #ifndef FRAME_X_OUTPUT
207 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
210 #define INFINITY 10000000
212 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
214 extern void set_frame_menubar
P_ ((struct frame
*f
, int, int));
215 extern int pending_menu_activation
;
218 extern int interrupt_input
;
219 extern int command_loop_level
;
221 extern int minibuffer_auto_raise
;
222 extern Lisp_Object Vminibuffer_list
;
224 extern Lisp_Object Qface
;
225 extern Lisp_Object Qmode_line
, Qmode_line_inactive
, Qheader_line
;
227 extern Lisp_Object Voverriding_local_map
;
228 extern Lisp_Object Voverriding_local_map_menu_flag
;
229 extern Lisp_Object Qmenu_item
;
230 extern Lisp_Object Qwhen
;
231 extern Lisp_Object Qhelp_echo
;
233 Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
234 Lisp_Object Qwindow_scroll_functions
, Vwindow_scroll_functions
;
235 Lisp_Object Qredisplay_end_trigger_functions
;
236 Lisp_Object Qinhibit_point_motion_hooks
;
237 Lisp_Object QCeval
, QCfile
, QCdata
, QCpropertize
;
238 Lisp_Object Qfontified
;
239 Lisp_Object Qgrow_only
;
240 Lisp_Object Qinhibit_eval_during_redisplay
;
241 Lisp_Object Qbuffer_position
, Qposition
, Qobject
;
244 Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
246 Lisp_Object Qrisky_local_variable
;
248 /* Holds the list (error). */
249 Lisp_Object list_of_error
;
251 /* Functions called to fontify regions of text. */
253 Lisp_Object Vfontification_functions
;
254 Lisp_Object Qfontification_functions
;
256 /* Non-zero means automatically select any window when the mouse
257 cursor moves into it. */
258 int mouse_autoselect_window
;
260 /* Non-zero means draw tool bar buttons raised when the mouse moves
263 int auto_raise_tool_bar_buttons_p
;
265 /* Margin around tool bar buttons in pixels. */
267 Lisp_Object Vtool_bar_button_margin
;
269 /* Thickness of shadow to draw around tool bar buttons. */
271 EMACS_INT tool_bar_button_relief
;
273 /* Non-zero means automatically resize tool-bars so that all tool-bar
274 items are visible, and no blank lines remain. */
276 int auto_resize_tool_bars_p
;
278 /* Non-zero means draw block and hollow cursor as wide as the glyph
279 under it. For example, if a block cursor is over a tab, it will be
280 drawn as wide as that tab on the display. */
282 int x_stretch_cursor_p
;
284 /* Non-nil means don't actually do any redisplay. */
286 Lisp_Object Vinhibit_redisplay
, Qinhibit_redisplay
;
288 /* Non-zero means Lisp evaluation during redisplay is inhibited. */
290 int inhibit_eval_during_redisplay
;
292 /* Names of text properties relevant for redisplay. */
294 Lisp_Object Qdisplay
, Qrelative_width
, Qalign_to
;
295 extern Lisp_Object Qface
, Qinvisible
, Qwidth
;
297 /* Symbols used in text property values. */
299 Lisp_Object Vdisplay_pixels_per_inch
;
300 Lisp_Object Qspace
, QCalign_to
, QCrelative_width
, QCrelative_height
;
301 Lisp_Object Qleft_margin
, Qright_margin
, Qspace_width
, Qraise
;
303 extern Lisp_Object Qheight
;
304 extern Lisp_Object QCwidth
, QCheight
, QCascent
;
305 extern Lisp_Object Qscroll_bar
;
307 /* Non-nil means highlight trailing whitespace. */
309 Lisp_Object Vshow_trailing_whitespace
;
311 /* Non-nil means show the text cursor in void text areas
312 i.e. in blank areas after eol and eob. This used to be
313 the default in 21.3. */
315 Lisp_Object Vshow_text_cursor_in_void
;
317 /* Name of the face used to highlight trailing whitespace. */
319 Lisp_Object Qtrailing_whitespace
;
321 /* The symbol `image' which is the car of the lists used to represent
326 /* Non-zero means print newline to stdout before next mini-buffer
329 int noninteractive_need_newline
;
331 /* Non-zero means print newline to message log before next message. */
333 static int message_log_need_newline
;
335 /* Three markers that message_dolog uses.
336 It could allocate them itself, but that causes trouble
337 in handling memory-full errors. */
338 static Lisp_Object message_dolog_marker1
;
339 static Lisp_Object message_dolog_marker2
;
340 static Lisp_Object message_dolog_marker3
;
342 /* The buffer position of the first character appearing entirely or
343 partially on the line of the selected window which contains the
344 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
345 redisplay optimization in redisplay_internal. */
347 static struct text_pos this_line_start_pos
;
349 /* Number of characters past the end of the line above, including the
350 terminating newline. */
352 static struct text_pos this_line_end_pos
;
354 /* The vertical positions and the height of this line. */
356 static int this_line_vpos
;
357 static int this_line_y
;
358 static int this_line_pixel_height
;
360 /* X position at which this display line starts. Usually zero;
361 negative if first character is partially visible. */
363 static int this_line_start_x
;
365 /* Buffer that this_line_.* variables are referring to. */
367 static struct buffer
*this_line_buffer
;
369 /* Nonzero means truncate lines in all windows less wide than the
372 int truncate_partial_width_windows
;
374 /* A flag to control how to display unibyte 8-bit character. */
376 int unibyte_display_via_language_environment
;
378 /* Nonzero means we have more than one non-mini-buffer-only frame.
379 Not guaranteed to be accurate except while parsing
380 frame-title-format. */
384 Lisp_Object Vglobal_mode_string
;
386 /* Marker for where to display an arrow on top of the buffer text. */
388 Lisp_Object Voverlay_arrow_position
;
390 /* String to display for the arrow. Only used on terminal frames. */
392 Lisp_Object Voverlay_arrow_string
;
394 /* Values of those variables at last redisplay. However, if
395 Voverlay_arrow_position is a marker, last_arrow_position is its
396 numerical position. */
398 static Lisp_Object last_arrow_position
, last_arrow_string
;
400 /* Like mode-line-format, but for the title bar on a visible frame. */
402 Lisp_Object Vframe_title_format
;
404 /* Like mode-line-format, but for the title bar on an iconified frame. */
406 Lisp_Object Vicon_title_format
;
408 /* List of functions to call when a window's size changes. These
409 functions get one arg, a frame on which one or more windows' sizes
412 static Lisp_Object Vwindow_size_change_functions
;
414 Lisp_Object Qmenu_bar_update_hook
, Vmenu_bar_update_hook
;
416 /* Nonzero if overlay arrow has been displayed once in this window. */
418 static int overlay_arrow_seen
;
420 /* Nonzero means highlight the region even in nonselected windows. */
422 int highlight_nonselected_windows
;
424 /* If cursor motion alone moves point off frame, try scrolling this
425 many lines up or down if that will bring it back. */
427 static EMACS_INT scroll_step
;
429 /* Nonzero means scroll just far enough to bring point back on the
430 screen, when appropriate. */
432 static EMACS_INT scroll_conservatively
;
434 /* Recenter the window whenever point gets within this many lines of
435 the top or bottom of the window. This value is translated into a
436 pixel value by multiplying it with FRAME_LINE_HEIGHT, which means
437 that there is really a fixed pixel height scroll margin. */
439 EMACS_INT scroll_margin
;
441 /* Number of windows showing the buffer of the selected window (or
442 another buffer with the same base buffer). keyboard.c refers to
447 /* Vector containing glyphs for an ellipsis `...'. */
449 static Lisp_Object default_invis_vector
[3];
451 /* Zero means display the mode-line/header-line/menu-bar in the default face
452 (this slightly odd definition is for compatibility with previous versions
453 of emacs), non-zero means display them using their respective faces.
455 This variable is deprecated. */
457 int mode_line_inverse_video
;
459 /* Prompt to display in front of the mini-buffer contents. */
461 Lisp_Object minibuf_prompt
;
463 /* Width of current mini-buffer prompt. Only set after display_line
464 of the line that contains the prompt. */
466 int minibuf_prompt_width
;
468 /* This is the window where the echo area message was displayed. It
469 is always a mini-buffer window, but it may not be the same window
470 currently active as a mini-buffer. */
472 Lisp_Object echo_area_window
;
474 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
475 pushes the current message and the value of
476 message_enable_multibyte on the stack, the function restore_message
477 pops the stack and displays MESSAGE again. */
479 Lisp_Object Vmessage_stack
;
481 /* Nonzero means multibyte characters were enabled when the echo area
482 message was specified. */
484 int message_enable_multibyte
;
486 /* Nonzero if we should redraw the mode lines on the next redisplay. */
488 int update_mode_lines
;
490 /* Nonzero if window sizes or contents have changed since last
491 redisplay that finished. */
493 int windows_or_buffers_changed
;
495 /* Nonzero means a frame's cursor type has been changed. */
497 int cursor_type_changed
;
499 /* Nonzero after display_mode_line if %l was used and it displayed a
502 int line_number_displayed
;
504 /* Maximum buffer size for which to display line numbers. */
506 Lisp_Object Vline_number_display_limit
;
508 /* Line width to consider when repositioning for line number display. */
510 static EMACS_INT line_number_display_limit_width
;
512 /* Number of lines to keep in the message log buffer. t means
513 infinite. nil means don't log at all. */
515 Lisp_Object Vmessage_log_max
;
517 /* The name of the *Messages* buffer, a string. */
519 static Lisp_Object Vmessages_buffer_name
;
521 /* Current, index 0, and last displayed echo area message. Either
522 buffers from echo_buffers, or nil to indicate no message. */
524 Lisp_Object echo_area_buffer
[2];
526 /* The buffers referenced from echo_area_buffer. */
528 static Lisp_Object echo_buffer
[2];
530 /* A vector saved used in with_area_buffer to reduce consing. */
532 static Lisp_Object Vwith_echo_area_save_vector
;
534 /* Non-zero means display_echo_area should display the last echo area
535 message again. Set by redisplay_preserve_echo_area. */
537 static int display_last_displayed_message_p
;
539 /* Nonzero if echo area is being used by print; zero if being used by
542 int message_buf_print
;
544 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
546 Lisp_Object Qinhibit_menubar_update
;
547 int inhibit_menubar_update
;
549 /* Maximum height for resizing mini-windows. Either a float
550 specifying a fraction of the available height, or an integer
551 specifying a number of lines. */
553 Lisp_Object Vmax_mini_window_height
;
555 /* Non-zero means messages should be displayed with truncated
556 lines instead of being continued. */
558 int message_truncate_lines
;
559 Lisp_Object Qmessage_truncate_lines
;
561 /* Set to 1 in clear_message to make redisplay_internal aware
562 of an emptied echo area. */
564 static int message_cleared_p
;
566 /* Non-zero means we want a hollow cursor in windows that are not
567 selected. Zero means there's no cursor in such windows. */
569 Lisp_Object Vcursor_in_non_selected_windows
;
570 Lisp_Object Qcursor_in_non_selected_windows
;
572 /* How to blink the default frame cursor off. */
573 Lisp_Object Vblink_cursor_alist
;
575 /* A scratch glyph row with contents used for generating truncation
576 glyphs. Also used in direct_output_for_insert. */
578 #define MAX_SCRATCH_GLYPHS 100
579 struct glyph_row scratch_glyph_row
;
580 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
582 /* Ascent and height of the last line processed by move_it_to. */
584 static int last_max_ascent
, last_height
;
586 /* Non-zero if there's a help-echo in the echo area. */
588 int help_echo_showing_p
;
590 /* If >= 0, computed, exact values of mode-line and header-line height
591 to use in the macros CURRENT_MODE_LINE_HEIGHT and
592 CURRENT_HEADER_LINE_HEIGHT. */
594 int current_mode_line_height
, current_header_line_height
;
596 /* The maximum distance to look ahead for text properties. Values
597 that are too small let us call compute_char_face and similar
598 functions too often which is expensive. Values that are too large
599 let us call compute_char_face and alike too often because we
600 might not be interested in text properties that far away. */
602 #define TEXT_PROP_DISTANCE_LIMIT 100
606 /* Variables to turn off display optimizations from Lisp. */
608 int inhibit_try_window_id
, inhibit_try_window_reusing
;
609 int inhibit_try_cursor_movement
;
611 /* Non-zero means print traces of redisplay if compiled with
614 int trace_redisplay_p
;
616 #endif /* GLYPH_DEBUG */
618 #ifdef DEBUG_TRACE_MOVE
619 /* Non-zero means trace with TRACE_MOVE to stderr. */
622 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
624 #define TRACE_MOVE(x) (void) 0
627 /* Non-zero means automatically scroll windows horizontally to make
630 int automatic_hscrolling_p
;
632 /* How close to the margin can point get before the window is scrolled
634 EMACS_INT hscroll_margin
;
636 /* How much to scroll horizontally when point is inside the above margin. */
637 Lisp_Object Vhscroll_step
;
639 /* A list of symbols, one for each supported image type. */
641 Lisp_Object Vimage_types
;
643 /* The variable `resize-mini-windows'. If nil, don't resize
644 mini-windows. If t, always resize them to fit the text they
645 display. If `grow-only', let mini-windows grow only until they
648 Lisp_Object Vresize_mini_windows
;
650 /* Buffer being redisplayed -- for redisplay_window_error. */
652 struct buffer
*displayed_buffer
;
654 /* Value returned from text property handlers (see below). */
659 HANDLED_RECOMPUTE_PROPS
,
660 HANDLED_OVERLAY_STRING_CONSUMED
,
664 /* A description of text properties that redisplay is interested
669 /* The name of the property. */
672 /* A unique index for the property. */
675 /* A handler function called to set up iterator IT from the property
676 at IT's current position. Value is used to steer handle_stop. */
677 enum prop_handled (*handler
) P_ ((struct it
*it
));
680 static enum prop_handled handle_face_prop
P_ ((struct it
*));
681 static enum prop_handled handle_invisible_prop
P_ ((struct it
*));
682 static enum prop_handled handle_display_prop
P_ ((struct it
*));
683 static enum prop_handled handle_composition_prop
P_ ((struct it
*));
684 static enum prop_handled handle_overlay_change
P_ ((struct it
*));
685 static enum prop_handled handle_fontified_prop
P_ ((struct it
*));
687 /* Properties handled by iterators. */
689 static struct props it_props
[] =
691 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
692 /* Handle `face' before `display' because some sub-properties of
693 `display' need to know the face. */
694 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
695 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
696 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
697 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
701 /* Value is the position described by X. If X is a marker, value is
702 the marker_position of X. Otherwise, value is X. */
704 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
706 /* Enumeration returned by some move_it_.* functions internally. */
710 /* Not used. Undefined value. */
713 /* Move ended at the requested buffer position or ZV. */
714 MOVE_POS_MATCH_OR_ZV
,
716 /* Move ended at the requested X pixel position. */
719 /* Move within a line ended at the end of a line that must be
723 /* Move within a line ended at the end of a line that would
724 be displayed truncated. */
727 /* Move within a line ended at a line end. */
731 /* This counter is used to clear the face cache every once in a while
732 in redisplay_internal. It is incremented for each redisplay.
733 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
736 #define CLEAR_FACE_CACHE_COUNT 500
737 static int clear_face_cache_count
;
739 /* Non-zero while redisplay_internal is in progress. */
743 /* Non-zero means don't free realized faces. Bound while freeing
744 realized faces is dangerous because glyph matrices might still
747 int inhibit_free_realized_faces
;
748 Lisp_Object Qinhibit_free_realized_faces
;
750 /* If a string, XTread_socket generates an event to display that string.
751 (The display is done in read_char.) */
753 Lisp_Object help_echo_string
;
754 Lisp_Object help_echo_window
;
755 Lisp_Object help_echo_object
;
758 /* Temporary variable for XTread_socket. */
760 Lisp_Object previous_help_echo_string
;
764 /* Function prototypes. */
766 static void setup_for_ellipsis
P_ ((struct it
*));
767 static void mark_window_display_accurate_1
P_ ((struct window
*, int));
768 static int single_display_prop_string_p
P_ ((Lisp_Object
, Lisp_Object
));
769 static int display_prop_string_p
P_ ((Lisp_Object
, Lisp_Object
));
770 static int cursor_row_p
P_ ((struct window
*, struct glyph_row
*));
771 static int redisplay_mode_lines
P_ ((Lisp_Object
, int));
772 static char *decode_mode_spec_coding
P_ ((Lisp_Object
, char *, int));
775 static int invisible_text_between_p
P_ ((struct it
*, int, int));
778 static int next_element_from_ellipsis
P_ ((struct it
*));
779 static void pint2str
P_ ((char *, int, int));
780 static void pint2hrstr
P_ ((char *, int, int));
781 static struct text_pos run_window_scroll_functions
P_ ((Lisp_Object
,
783 static void reconsider_clip_changes
P_ ((struct window
*, struct buffer
*));
784 static int text_outside_line_unchanged_p
P_ ((struct window
*, int, int));
785 static void store_frame_title_char
P_ ((char));
786 static int store_frame_title
P_ ((const unsigned char *, int, int));
787 static void x_consider_frame_title
P_ ((Lisp_Object
));
788 static void handle_stop
P_ ((struct it
*));
789 static int tool_bar_lines_needed
P_ ((struct frame
*));
790 static int single_display_prop_intangible_p
P_ ((Lisp_Object
));
791 static void ensure_echo_area_buffers
P_ ((void));
792 static Lisp_Object unwind_with_echo_area_buffer
P_ ((Lisp_Object
));
793 static Lisp_Object with_echo_area_buffer_unwind_data
P_ ((struct window
*));
794 static int with_echo_area_buffer
P_ ((struct window
*, int,
795 int (*) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
796 EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
797 static void clear_garbaged_frames
P_ ((void));
798 static int current_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
799 static int truncate_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
800 static int set_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
801 static int display_echo_area
P_ ((struct window
*));
802 static int display_echo_area_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
803 static int resize_mini_window_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
804 static Lisp_Object unwind_redisplay
P_ ((Lisp_Object
));
805 static int string_char_and_length
P_ ((const unsigned char *, int, int *));
806 static struct text_pos display_prop_end
P_ ((struct it
*, Lisp_Object
,
808 static int compute_window_start_on_continuation_line
P_ ((struct window
*));
809 static Lisp_Object safe_eval_handler
P_ ((Lisp_Object
));
810 static void insert_left_trunc_glyphs
P_ ((struct it
*));
811 static struct glyph_row
*get_overlay_arrow_glyph_row
P_ ((struct window
*));
812 static void extend_face_to_end_of_line
P_ ((struct it
*));
813 static int append_space
P_ ((struct it
*, int));
814 static int make_cursor_line_fully_visible
P_ ((struct window
*));
815 static int try_scrolling
P_ ((Lisp_Object
, int, EMACS_INT
, EMACS_INT
, int, int));
816 static int try_cursor_movement
P_ ((Lisp_Object
, struct text_pos
, int *));
817 static int trailing_whitespace_p
P_ ((int));
818 static int message_log_check_duplicate
P_ ((int, int, int, int));
819 static void push_it
P_ ((struct it
*));
820 static void pop_it
P_ ((struct it
*));
821 static void sync_frame_with_window_matrix_rows
P_ ((struct window
*));
822 static void select_frame_for_redisplay
P_ ((Lisp_Object
));
823 static void redisplay_internal
P_ ((int));
824 static int echo_area_display
P_ ((int));
825 static void redisplay_windows
P_ ((Lisp_Object
));
826 static void redisplay_window
P_ ((Lisp_Object
, int));
827 static Lisp_Object
redisplay_window_error ();
828 static Lisp_Object redisplay_window_0
P_ ((Lisp_Object
));
829 static Lisp_Object redisplay_window_1
P_ ((Lisp_Object
));
830 static void update_menu_bar
P_ ((struct frame
*, int));
831 static int try_window_reusing_current_matrix
P_ ((struct window
*));
832 static int try_window_id
P_ ((struct window
*));
833 static int display_line
P_ ((struct it
*));
834 static int display_mode_lines
P_ ((struct window
*));
835 static int display_mode_line
P_ ((struct window
*, enum face_id
, Lisp_Object
));
836 static int display_mode_element
P_ ((struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int));
837 static int store_mode_line_string
P_ ((char *, Lisp_Object
, int, int, int, Lisp_Object
));
838 static char *decode_mode_spec
P_ ((struct window
*, int, int, int, int *));
839 static void display_menu_bar
P_ ((struct window
*));
840 static int display_count_lines
P_ ((int, int, int, int, int *));
841 static int display_string
P_ ((unsigned char *, Lisp_Object
, Lisp_Object
,
842 int, int, struct it
*, int, int, int, int));
843 static void compute_line_metrics
P_ ((struct it
*));
844 static void run_redisplay_end_trigger_hook
P_ ((struct it
*));
845 static int get_overlay_strings
P_ ((struct it
*, int));
846 static void next_overlay_string
P_ ((struct it
*));
847 static void reseat
P_ ((struct it
*, struct text_pos
, int));
848 static void reseat_1
P_ ((struct it
*, struct text_pos
, int));
849 static void back_to_previous_visible_line_start
P_ ((struct it
*));
850 static void reseat_at_previous_visible_line_start
P_ ((struct it
*));
851 static void reseat_at_next_visible_line_start
P_ ((struct it
*, int));
852 static int next_element_from_display_vector
P_ ((struct it
*));
853 static int next_element_from_string
P_ ((struct it
*));
854 static int next_element_from_c_string
P_ ((struct it
*));
855 static int next_element_from_buffer
P_ ((struct it
*));
856 static int next_element_from_composition
P_ ((struct it
*));
857 static int next_element_from_image
P_ ((struct it
*));
858 static int next_element_from_stretch
P_ ((struct it
*));
859 static void load_overlay_strings
P_ ((struct it
*, int));
860 static int init_from_display_pos
P_ ((struct it
*, struct window
*,
861 struct display_pos
*));
862 static void reseat_to_string
P_ ((struct it
*, unsigned char *,
863 Lisp_Object
, int, int, int, int));
864 static enum move_it_result move_it_in_display_line_to
P_ ((struct it
*,
866 void move_it_vertically_backward
P_ ((struct it
*, int));
867 static void init_to_row_start
P_ ((struct it
*, struct window
*,
868 struct glyph_row
*));
869 static int init_to_row_end
P_ ((struct it
*, struct window
*,
870 struct glyph_row
*));
871 static void back_to_previous_line_start
P_ ((struct it
*));
872 static int forward_to_next_line_start
P_ ((struct it
*, int *));
873 static struct text_pos string_pos_nchars_ahead
P_ ((struct text_pos
,
875 static struct text_pos string_pos
P_ ((int, Lisp_Object
));
876 static struct text_pos c_string_pos
P_ ((int, unsigned char *, int));
877 static int number_of_chars
P_ ((unsigned char *, int));
878 static void compute_stop_pos
P_ ((struct it
*));
879 static void compute_string_pos
P_ ((struct text_pos
*, struct text_pos
,
881 static int face_before_or_after_it_pos
P_ ((struct it
*, int));
882 static int next_overlay_change
P_ ((int));
883 static int handle_single_display_prop
P_ ((struct it
*, Lisp_Object
,
884 Lisp_Object
, struct text_pos
*,
886 static int underlying_face_id
P_ ((struct it
*));
887 static int in_ellipses_for_invisible_text_p
P_ ((struct display_pos
*,
890 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
891 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
893 #ifdef HAVE_WINDOW_SYSTEM
895 static void update_tool_bar
P_ ((struct frame
*, int));
896 static void build_desired_tool_bar_string
P_ ((struct frame
*f
));
897 static int redisplay_tool_bar
P_ ((struct frame
*));
898 static void display_tool_bar_line
P_ ((struct it
*));
899 static void notice_overwritten_cursor
P_ ((struct window
*,
901 int, int, int, int));
905 #endif /* HAVE_WINDOW_SYSTEM */
908 /***********************************************************************
909 Window display dimensions
910 ***********************************************************************/
912 /* Return the bottom boundary y-position for text lines in window W.
913 This is the first y position at which a line cannot start.
914 It is relative to the top of the window.
916 This is the height of W minus the height of a mode line, if any. */
919 window_text_bottom_y (w
)
922 int height
= WINDOW_TOTAL_HEIGHT (w
);
924 if (WINDOW_WANTS_MODELINE_P (w
))
925 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
929 /* Return the pixel width of display area AREA of window W. AREA < 0
930 means return the total width of W, not including fringes to
931 the left and right of the window. */
934 window_box_width (w
, area
)
938 int cols
= XFASTINT (w
->total_cols
);
941 if (!w
->pseudo_window_p
)
943 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
945 if (area
== TEXT_AREA
)
947 if (INTEGERP (w
->left_margin_cols
))
948 cols
-= XFASTINT (w
->left_margin_cols
);
949 if (INTEGERP (w
->right_margin_cols
))
950 cols
-= XFASTINT (w
->right_margin_cols
);
951 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
953 else if (area
== LEFT_MARGIN_AREA
)
955 cols
= (INTEGERP (w
->left_margin_cols
)
956 ? XFASTINT (w
->left_margin_cols
) : 0);
959 else if (area
== RIGHT_MARGIN_AREA
)
961 cols
= (INTEGERP (w
->right_margin_cols
)
962 ? XFASTINT (w
->right_margin_cols
) : 0);
967 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
971 /* Return the pixel height of the display area of window W, not
972 including mode lines of W, if any. */
975 window_box_height (w
)
978 struct frame
*f
= XFRAME (w
->frame
);
979 int height
= WINDOW_TOTAL_HEIGHT (w
);
981 xassert (height
>= 0);
983 /* Note: the code below that determines the mode-line/header-line
984 height is essentially the same as that contained in the macro
985 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
986 the appropriate glyph row has its `mode_line_p' flag set,
987 and if it doesn't, uses estimate_mode_line_height instead. */
989 if (WINDOW_WANTS_MODELINE_P (w
))
991 struct glyph_row
*ml_row
992 = (w
->current_matrix
&& w
->current_matrix
->rows
993 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
995 if (ml_row
&& ml_row
->mode_line_p
)
996 height
-= ml_row
->height
;
998 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1001 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1003 struct glyph_row
*hl_row
1004 = (w
->current_matrix
&& w
->current_matrix
->rows
1005 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1007 if (hl_row
&& hl_row
->mode_line_p
)
1008 height
-= hl_row
->height
;
1010 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1013 /* With a very small font and a mode-line that's taller than
1014 default, we might end up with a negative height. */
1015 return max (0, height
);
1018 /* Return the window-relative coordinate of the left edge of display
1019 area AREA of window W. AREA < 0 means return the left edge of the
1020 whole window, to the right of the left fringe of W. */
1023 window_box_left_offset (w
, area
)
1029 if (w
->pseudo_window_p
)
1032 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1034 if (area
== TEXT_AREA
)
1035 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1036 + window_box_width (w
, LEFT_MARGIN_AREA
));
1037 else if (area
== RIGHT_MARGIN_AREA
)
1038 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1039 + window_box_width (w
, LEFT_MARGIN_AREA
)
1040 + window_box_width (w
, TEXT_AREA
)
1041 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1043 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1044 else if (area
== LEFT_MARGIN_AREA
1045 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1046 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1052 /* Return the window-relative coordinate of the right edge of display
1053 area AREA of window W. AREA < 0 means return the left edge of the
1054 whole window, to the left of the right fringe of W. */
1057 window_box_right_offset (w
, area
)
1061 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1064 /* Return the frame-relative coordinate of the left edge of display
1065 area AREA of window W. AREA < 0 means return the left edge of the
1066 whole window, to the right of the left fringe of W. */
1069 window_box_left (w
, area
)
1073 struct frame
*f
= XFRAME (w
->frame
);
1076 if (w
->pseudo_window_p
)
1077 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1079 x
= (WINDOW_LEFT_EDGE_X (w
)
1080 + window_box_left_offset (w
, area
));
1086 /* Return the frame-relative coordinate of the right edge of display
1087 area AREA of window W. AREA < 0 means return the left edge of the
1088 whole window, to the left of the right fringe of W. */
1091 window_box_right (w
, area
)
1095 return window_box_left (w
, area
) + window_box_width (w
, area
);
1098 /* Get the bounding box of the display area AREA of window W, without
1099 mode lines, in frame-relative coordinates. AREA < 0 means the
1100 whole window, not including the left and right fringes of
1101 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1102 coordinates of the upper-left corner of the box. Return in
1103 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1106 window_box (w
, area
, box_x
, box_y
, box_width
, box_height
)
1109 int *box_x
, *box_y
, *box_width
, *box_height
;
1112 *box_width
= window_box_width (w
, area
);
1114 *box_height
= window_box_height (w
);
1116 *box_x
= window_box_left (w
, area
);
1119 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1120 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1121 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1126 /* Get the bounding box of the display area AREA of window W, without
1127 mode lines. AREA < 0 means the whole window, not including the
1128 left and right fringe of the window. Return in *TOP_LEFT_X
1129 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1130 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1131 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1135 window_box_edges (w
, area
, top_left_x
, top_left_y
,
1136 bottom_right_x
, bottom_right_y
)
1139 int *top_left_x
, *top_left_y
, *bottom_right_x
, *bottom_right_y
;
1141 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1143 *bottom_right_x
+= *top_left_x
;
1144 *bottom_right_y
+= *top_left_y
;
1149 /***********************************************************************
1151 ***********************************************************************/
1153 /* Return the bottom y-position of the line the iterator IT is in.
1154 This can modify IT's settings. */
1160 int line_height
= it
->max_ascent
+ it
->max_descent
;
1161 int line_top_y
= it
->current_y
;
1163 if (line_height
== 0)
1166 line_height
= last_height
;
1167 else if (IT_CHARPOS (*it
) < ZV
)
1169 move_it_by_lines (it
, 1, 1);
1170 line_height
= (it
->max_ascent
|| it
->max_descent
1171 ? it
->max_ascent
+ it
->max_descent
1176 struct glyph_row
*row
= it
->glyph_row
;
1178 /* Use the default character height. */
1179 it
->glyph_row
= NULL
;
1180 it
->what
= IT_CHARACTER
;
1183 PRODUCE_GLYPHS (it
);
1184 line_height
= it
->ascent
+ it
->descent
;
1185 it
->glyph_row
= row
;
1189 return line_top_y
+ line_height
;
1193 /* Return 1 if position CHARPOS is visible in window W. Set *FULLY to
1194 1 if POS is visible and the line containing POS is fully visible.
1195 EXACT_MODE_LINE_HEIGHTS_P non-zero means compute exact mode-line
1196 and header-lines heights. */
1199 pos_visible_p (w
, charpos
, fully
, exact_mode_line_heights_p
)
1201 int charpos
, *fully
, exact_mode_line_heights_p
;
1204 struct text_pos top
;
1206 struct buffer
*old_buffer
= NULL
;
1208 if (XBUFFER (w
->buffer
) != current_buffer
)
1210 old_buffer
= current_buffer
;
1211 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1214 *fully
= visible_p
= 0;
1215 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1217 /* Compute exact mode line heights, if requested. */
1218 if (exact_mode_line_heights_p
)
1220 if (WINDOW_WANTS_MODELINE_P (w
))
1221 current_mode_line_height
1222 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1223 current_buffer
->mode_line_format
);
1225 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1226 current_header_line_height
1227 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1228 current_buffer
->header_line_format
);
1231 start_display (&it
, w
, top
);
1232 move_it_to (&it
, charpos
, 0, it
.last_visible_y
, -1,
1233 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
1235 /* Note that we may overshoot because of invisible text. */
1236 if (IT_CHARPOS (it
) >= charpos
)
1238 int top_y
= it
.current_y
;
1239 int bottom_y
= line_bottom_y (&it
);
1240 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1242 if (top_y
< window_top_y
)
1243 visible_p
= bottom_y
> window_top_y
;
1244 else if (top_y
< it
.last_visible_y
)
1247 *fully
= bottom_y
<= it
.last_visible_y
;
1250 else if (it
.current_y
+ it
.max_ascent
+ it
.max_descent
> it
.last_visible_y
)
1252 move_it_by_lines (&it
, 1, 0);
1253 if (charpos
< IT_CHARPOS (it
))
1261 set_buffer_internal_1 (old_buffer
);
1263 current_header_line_height
= current_mode_line_height
= -1;
1268 /* Return the next character from STR which is MAXLEN bytes long.
1269 Return in *LEN the length of the character. This is like
1270 STRING_CHAR_AND_LENGTH but never returns an invalid character. If
1271 we find one, we return a `?', but with the length of the invalid
1275 string_char_and_length (str
, maxlen
, len
)
1276 const unsigned char *str
;
1281 c
= STRING_CHAR_AND_LENGTH (str
, maxlen
, *len
);
1282 if (!CHAR_VALID_P (c
, 1))
1283 /* We may not change the length here because other places in Emacs
1284 don't use this function, i.e. they silently accept invalid
1293 /* Given a position POS containing a valid character and byte position
1294 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1296 static struct text_pos
1297 string_pos_nchars_ahead (pos
, string
, nchars
)
1298 struct text_pos pos
;
1302 xassert (STRINGP (string
) && nchars
>= 0);
1304 if (STRING_MULTIBYTE (string
))
1306 int rest
= SBYTES (string
) - BYTEPOS (pos
);
1307 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1312 string_char_and_length (p
, rest
, &len
);
1313 p
+= len
, rest
-= len
;
1314 xassert (rest
>= 0);
1316 BYTEPOS (pos
) += len
;
1320 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1326 /* Value is the text position, i.e. character and byte position,
1327 for character position CHARPOS in STRING. */
1329 static INLINE
struct text_pos
1330 string_pos (charpos
, string
)
1334 struct text_pos pos
;
1335 xassert (STRINGP (string
));
1336 xassert (charpos
>= 0);
1337 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1342 /* Value is a text position, i.e. character and byte position, for
1343 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1344 means recognize multibyte characters. */
1346 static struct text_pos
1347 c_string_pos (charpos
, s
, multibyte_p
)
1352 struct text_pos pos
;
1354 xassert (s
!= NULL
);
1355 xassert (charpos
>= 0);
1359 int rest
= strlen (s
), len
;
1361 SET_TEXT_POS (pos
, 0, 0);
1364 string_char_and_length (s
, rest
, &len
);
1365 s
+= len
, rest
-= len
;
1366 xassert (rest
>= 0);
1368 BYTEPOS (pos
) += len
;
1372 SET_TEXT_POS (pos
, charpos
, charpos
);
1378 /* Value is the number of characters in C string S. MULTIBYTE_P
1379 non-zero means recognize multibyte characters. */
1382 number_of_chars (s
, multibyte_p
)
1390 int rest
= strlen (s
), len
;
1391 unsigned char *p
= (unsigned char *) s
;
1393 for (nchars
= 0; rest
> 0; ++nchars
)
1395 string_char_and_length (p
, rest
, &len
);
1396 rest
-= len
, p
+= len
;
1400 nchars
= strlen (s
);
1406 /* Compute byte position NEWPOS->bytepos corresponding to
1407 NEWPOS->charpos. POS is a known position in string STRING.
1408 NEWPOS->charpos must be >= POS.charpos. */
1411 compute_string_pos (newpos
, pos
, string
)
1412 struct text_pos
*newpos
, pos
;
1415 xassert (STRINGP (string
));
1416 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1418 if (STRING_MULTIBYTE (string
))
1419 *newpos
= string_pos_nchars_ahead (pos
, string
,
1420 CHARPOS (*newpos
) - CHARPOS (pos
));
1422 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1426 Return an estimation of the pixel height of mode or top lines on
1427 frame F. FACE_ID specifies what line's height to estimate. */
1430 estimate_mode_line_height (f
, face_id
)
1432 enum face_id face_id
;
1434 #ifdef HAVE_WINDOW_SYSTEM
1435 if (FRAME_WINDOW_P (f
))
1437 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1439 /* This function is called so early when Emacs starts that the face
1440 cache and mode line face are not yet initialized. */
1441 if (FRAME_FACE_CACHE (f
))
1443 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1447 height
= FONT_HEIGHT (face
->font
);
1448 if (face
->box_line_width
> 0)
1449 height
+= 2 * face
->box_line_width
;
1460 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1461 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1462 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1463 not force the value into range. */
1466 pixel_to_glyph_coords (f
, pix_x
, pix_y
, x
, y
, bounds
, noclip
)
1468 register int pix_x
, pix_y
;
1470 NativeRectangle
*bounds
;
1474 #ifdef HAVE_WINDOW_SYSTEM
1475 if (FRAME_WINDOW_P (f
))
1477 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1478 even for negative values. */
1480 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1482 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1484 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1485 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1488 STORE_NATIVE_RECT (*bounds
,
1489 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1490 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1491 FRAME_COLUMN_WIDTH (f
) - 1,
1492 FRAME_LINE_HEIGHT (f
) - 1);
1498 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1499 pix_x
= FRAME_TOTAL_COLS (f
);
1503 else if (pix_y
> FRAME_LINES (f
))
1504 pix_y
= FRAME_LINES (f
);
1514 /* Given HPOS/VPOS in the current matrix of W, return corresponding
1515 frame-relative pixel positions in *FRAME_X and *FRAME_Y. If we
1516 can't tell the positions because W's display is not up to date,
1520 glyph_to_pixel_coords (w
, hpos
, vpos
, frame_x
, frame_y
)
1523 int *frame_x
, *frame_y
;
1525 #ifdef HAVE_WINDOW_SYSTEM
1526 if (FRAME_WINDOW_P (XFRAME (WINDOW_FRAME (w
))))
1530 xassert (hpos
>= 0 && hpos
< w
->current_matrix
->matrix_w
);
1531 xassert (vpos
>= 0 && vpos
< w
->current_matrix
->matrix_h
);
1533 if (display_completed
)
1535 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
1536 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1537 struct glyph
*end
= glyph
+ min (hpos
, row
->used
[TEXT_AREA
]);
1543 hpos
+= glyph
->pixel_width
;
1547 /* If first glyph is partially visible, its first visible position is still 0. */
1559 *frame_x
= WINDOW_TO_FRAME_PIXEL_X (w
, hpos
);
1560 *frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, vpos
);
1571 #ifdef HAVE_WINDOW_SYSTEM
1573 /* Find the glyph under window-relative coordinates X/Y in window W.
1574 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1575 strings. Return in *HPOS and *VPOS the row and column number of
1576 the glyph found. Return in *AREA the glyph area containing X.
1577 Value is a pointer to the glyph found or null if X/Y is not on
1578 text, or we can't tell because W's current matrix is not up to
1581 static struct glyph
*
1582 x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, area
, buffer_only_p
)
1585 int *hpos
, *vpos
, *area
;
1588 struct glyph
*glyph
, *end
;
1589 struct glyph_row
*row
= NULL
;
1592 /* Find row containing Y. Give up if some row is not enabled. */
1593 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1595 row
= MATRIX_ROW (w
->current_matrix
, i
);
1596 if (!row
->enabled_p
)
1598 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1605 /* Give up if Y is not in the window. */
1606 if (i
== w
->current_matrix
->nrows
)
1609 /* Get the glyph area containing X. */
1610 if (w
->pseudo_window_p
)
1617 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1619 *area
= LEFT_MARGIN_AREA
;
1620 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1622 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1625 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1629 *area
= RIGHT_MARGIN_AREA
;
1630 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1634 /* Find glyph containing X. */
1635 glyph
= row
->glyphs
[*area
];
1636 end
= glyph
+ row
->used
[*area
];
1639 if (x
< x0
+ glyph
->pixel_width
)
1641 if (w
->pseudo_window_p
)
1643 else if (!buffer_only_p
|| BUFFERP (glyph
->object
))
1647 x0
+= glyph
->pixel_width
;
1654 *hpos
= glyph
- row
->glyphs
[*area
];
1660 Convert frame-relative x/y to coordinates relative to window W.
1661 Takes pseudo-windows into account. */
1664 frame_to_window_pixel_xy (w
, x
, y
)
1668 if (w
->pseudo_window_p
)
1670 /* A pseudo-window is always full-width, and starts at the
1671 left edge of the frame, plus a frame border. */
1672 struct frame
*f
= XFRAME (w
->frame
);
1673 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1674 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1678 *x
-= WINDOW_LEFT_EDGE_X (w
);
1679 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1684 Return in *R the clipping rectangle for glyph string S. */
1687 get_glyph_string_clip_rect (s
, nr
)
1688 struct glyph_string
*s
;
1689 NativeRectangle
*nr
;
1693 if (s
->row
->full_width_p
)
1695 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1696 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1697 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1699 /* Unless displaying a mode or menu bar line, which are always
1700 fully visible, clip to the visible part of the row. */
1701 if (s
->w
->pseudo_window_p
)
1702 r
.height
= s
->row
->visible_height
;
1704 r
.height
= s
->height
;
1708 /* This is a text line that may be partially visible. */
1709 r
.x
= window_box_left (s
->w
, s
->area
);
1710 r
.width
= window_box_width (s
->w
, s
->area
);
1711 r
.height
= s
->row
->visible_height
;
1714 /* If S draws overlapping rows, it's sufficient to use the top and
1715 bottom of the window for clipping because this glyph string
1716 intentionally draws over other lines. */
1717 if (s
->for_overlaps_p
)
1719 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1720 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1724 /* Don't use S->y for clipping because it doesn't take partially
1725 visible lines into account. For example, it can be negative for
1726 partially visible lines at the top of a window. */
1727 if (!s
->row
->full_width_p
1728 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
1729 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1731 r
.y
= max (0, s
->row
->y
);
1733 /* If drawing a tool-bar window, draw it over the internal border
1734 at the top of the window. */
1735 if (s
->w
== XWINDOW (s
->f
->tool_bar_window
))
1736 r
.y
-= FRAME_INTERNAL_BORDER_WIDTH (s
->f
);
1739 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
1742 /* ++KFS: From W32 port, but it looks ok for all platforms to me. */
1743 /* If drawing the cursor, don't let glyph draw outside its
1744 advertised boundaries. Cleartype does this under some circumstances. */
1745 if (s
->hl
== DRAW_CURSOR
)
1749 r
.width
-= s
->x
- r
.x
;
1752 r
.width
= min (r
.width
, s
->first_glyph
->pixel_width
);
1756 #ifdef CONVERT_FROM_XRECT
1757 CONVERT_FROM_XRECT (r
, *nr
);
1763 #endif /* HAVE_WINDOW_SYSTEM */
1766 /***********************************************************************
1767 Lisp form evaluation
1768 ***********************************************************************/
1770 /* Error handler for safe_eval and safe_call. */
1773 safe_eval_handler (arg
)
1776 add_to_log ("Error during redisplay: %s", arg
, Qnil
);
1781 /* Evaluate SEXPR and return the result, or nil if something went
1782 wrong. Prevent redisplay during the evaluation. */
1790 if (inhibit_eval_during_redisplay
)
1794 int count
= SPECPDL_INDEX ();
1795 struct gcpro gcpro1
;
1798 specbind (Qinhibit_redisplay
, Qt
);
1799 /* Use Qt to ensure debugger does not run,
1800 so there is no possibility of wanting to redisplay. */
1801 val
= internal_condition_case_1 (Feval
, sexpr
, Qt
,
1804 val
= unbind_to (count
, val
);
1811 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
1812 Return the result, or nil if something went wrong. Prevent
1813 redisplay during the evaluation. */
1816 safe_call (nargs
, args
)
1822 if (inhibit_eval_during_redisplay
)
1826 int count
= SPECPDL_INDEX ();
1827 struct gcpro gcpro1
;
1830 gcpro1
.nvars
= nargs
;
1831 specbind (Qinhibit_redisplay
, Qt
);
1832 /* Use Qt to ensure debugger does not run,
1833 so there is no possibility of wanting to redisplay. */
1834 val
= internal_condition_case_2 (Ffuncall
, nargs
, args
, Qt
,
1837 val
= unbind_to (count
, val
);
1844 /* Call function FN with one argument ARG.
1845 Return the result, or nil if something went wrong. */
1848 safe_call1 (fn
, arg
)
1849 Lisp_Object fn
, arg
;
1851 Lisp_Object args
[2];
1854 return safe_call (2, args
);
1859 /***********************************************************************
1861 ***********************************************************************/
1865 /* Define CHECK_IT to perform sanity checks on iterators.
1866 This is for debugging. It is too slow to do unconditionally. */
1872 if (it
->method
== next_element_from_string
)
1874 xassert (STRINGP (it
->string
));
1875 xassert (IT_STRING_CHARPOS (*it
) >= 0);
1877 else if (it
->method
== next_element_from_buffer
)
1879 /* Check that character and byte positions agree. */
1880 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
1884 xassert (it
->current
.dpvec_index
>= 0);
1886 xassert (it
->current
.dpvec_index
< 0);
1889 #define CHECK_IT(IT) check_it ((IT))
1893 #define CHECK_IT(IT) (void) 0
1900 /* Check that the window end of window W is what we expect it
1901 to be---the last row in the current matrix displaying text. */
1904 check_window_end (w
)
1907 if (!MINI_WINDOW_P (w
)
1908 && !NILP (w
->window_end_valid
))
1910 struct glyph_row
*row
;
1911 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
1912 XFASTINT (w
->window_end_vpos
)),
1914 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
1915 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
1919 #define CHECK_WINDOW_END(W) check_window_end ((W))
1921 #else /* not GLYPH_DEBUG */
1923 #define CHECK_WINDOW_END(W) (void) 0
1925 #endif /* not GLYPH_DEBUG */
1929 /***********************************************************************
1930 Iterator initialization
1931 ***********************************************************************/
1933 /* Initialize IT for displaying current_buffer in window W, starting
1934 at character position CHARPOS. CHARPOS < 0 means that no buffer
1935 position is specified which is useful when the iterator is assigned
1936 a position later. BYTEPOS is the byte position corresponding to
1937 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
1939 If ROW is not null, calls to produce_glyphs with IT as parameter
1940 will produce glyphs in that row.
1942 BASE_FACE_ID is the id of a base face to use. It must be one of
1943 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
1944 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
1945 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
1947 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
1948 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
1949 will be initialized to use the corresponding mode line glyph row of
1950 the desired matrix of W. */
1953 init_iterator (it
, w
, charpos
, bytepos
, row
, base_face_id
)
1956 int charpos
, bytepos
;
1957 struct glyph_row
*row
;
1958 enum face_id base_face_id
;
1960 int highlight_region_p
;
1962 /* Some precondition checks. */
1963 xassert (w
!= NULL
&& it
!= NULL
);
1964 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
1967 /* If face attributes have been changed since the last redisplay,
1968 free realized faces now because they depend on face definitions
1969 that might have changed. Don't free faces while there might be
1970 desired matrices pending which reference these faces. */
1971 if (face_change_count
&& !inhibit_free_realized_faces
)
1973 face_change_count
= 0;
1974 free_all_realized_faces (Qnil
);
1977 /* Use one of the mode line rows of W's desired matrix if
1981 if (base_face_id
== MODE_LINE_FACE_ID
1982 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
1983 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
1984 else if (base_face_id
== HEADER_LINE_FACE_ID
)
1985 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
1989 bzero (it
, sizeof *it
);
1990 it
->current
.overlay_string_index
= -1;
1991 it
->current
.dpvec_index
= -1;
1992 it
->base_face_id
= base_face_id
;
1994 /* The window in which we iterate over current_buffer: */
1995 XSETWINDOW (it
->window
, w
);
1997 it
->f
= XFRAME (w
->frame
);
1999 /* Extra space between lines (on window systems only). */
2000 if (base_face_id
== DEFAULT_FACE_ID
2001 && FRAME_WINDOW_P (it
->f
))
2003 if (NATNUMP (current_buffer
->extra_line_spacing
))
2004 it
->extra_line_spacing
= XFASTINT (current_buffer
->extra_line_spacing
);
2005 else if (it
->f
->extra_line_spacing
> 0)
2006 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2009 /* If realized faces have been removed, e.g. because of face
2010 attribute changes of named faces, recompute them. When running
2011 in batch mode, the face cache of the initial frame is null. If
2012 we happen to get called, make a dummy face cache. */
2013 if (noninteractive
&& FRAME_FACE_CACHE (it
->f
) == NULL
)
2014 init_frame_faces (it
->f
);
2015 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2016 recompute_basic_faces (it
->f
);
2018 /* Current value of the `space-width', and 'height' properties. */
2019 it
->space_width
= Qnil
;
2020 it
->font_height
= Qnil
;
2022 /* Are control characters displayed as `^C'? */
2023 it
->ctl_arrow_p
= !NILP (current_buffer
->ctl_arrow
);
2025 /* -1 means everything between a CR and the following line end
2026 is invisible. >0 means lines indented more than this value are
2028 it
->selective
= (INTEGERP (current_buffer
->selective_display
)
2029 ? XFASTINT (current_buffer
->selective_display
)
2030 : (!NILP (current_buffer
->selective_display
)
2032 it
->selective_display_ellipsis_p
2033 = !NILP (current_buffer
->selective_display_ellipses
);
2035 /* Display table to use. */
2036 it
->dp
= window_display_table (w
);
2038 /* Are multibyte characters enabled in current_buffer? */
2039 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
2041 /* Non-zero if we should highlight the region. */
2043 = (!NILP (Vtransient_mark_mode
)
2044 && !NILP (current_buffer
->mark_active
)
2045 && XMARKER (current_buffer
->mark
)->buffer
!= 0);
2047 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2048 start and end of a visible region in window IT->w. Set both to
2049 -1 to indicate no region. */
2050 if (highlight_region_p
2051 /* Maybe highlight only in selected window. */
2052 && (/* Either show region everywhere. */
2053 highlight_nonselected_windows
2054 /* Or show region in the selected window. */
2055 || w
== XWINDOW (selected_window
)
2056 /* Or show the region if we are in the mini-buffer and W is
2057 the window the mini-buffer refers to. */
2058 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2059 && WINDOWP (minibuf_selected_window
)
2060 && w
== XWINDOW (minibuf_selected_window
))))
2062 int charpos
= marker_position (current_buffer
->mark
);
2063 it
->region_beg_charpos
= min (PT
, charpos
);
2064 it
->region_end_charpos
= max (PT
, charpos
);
2067 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2069 /* Get the position at which the redisplay_end_trigger hook should
2070 be run, if it is to be run at all. */
2071 if (MARKERP (w
->redisplay_end_trigger
)
2072 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2073 it
->redisplay_end_trigger_charpos
2074 = marker_position (w
->redisplay_end_trigger
);
2075 else if (INTEGERP (w
->redisplay_end_trigger
))
2076 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
2078 /* Correct bogus values of tab_width. */
2079 it
->tab_width
= XINT (current_buffer
->tab_width
);
2080 if (it
->tab_width
<= 0 || it
->tab_width
> 1000)
2083 /* Are lines in the display truncated? */
2084 it
->truncate_lines_p
2085 = (base_face_id
!= DEFAULT_FACE_ID
2086 || XINT (it
->w
->hscroll
)
2087 || (truncate_partial_width_windows
2088 && !WINDOW_FULL_WIDTH_P (it
->w
))
2089 || !NILP (current_buffer
->truncate_lines
));
2091 /* Get dimensions of truncation and continuation glyphs. These are
2092 displayed as fringe bitmaps under X, so we don't need them for such
2094 if (!FRAME_WINDOW_P (it
->f
))
2096 if (it
->truncate_lines_p
)
2098 /* We will need the truncation glyph. */
2099 xassert (it
->glyph_row
== NULL
);
2100 produce_special_glyphs (it
, IT_TRUNCATION
);
2101 it
->truncation_pixel_width
= it
->pixel_width
;
2105 /* We will need the continuation glyph. */
2106 xassert (it
->glyph_row
== NULL
);
2107 produce_special_glyphs (it
, IT_CONTINUATION
);
2108 it
->continuation_pixel_width
= it
->pixel_width
;
2111 /* Reset these values to zero because the produce_special_glyphs
2112 above has changed them. */
2113 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2114 it
->phys_ascent
= it
->phys_descent
= 0;
2117 /* Set this after getting the dimensions of truncation and
2118 continuation glyphs, so that we don't produce glyphs when calling
2119 produce_special_glyphs, above. */
2120 it
->glyph_row
= row
;
2121 it
->area
= TEXT_AREA
;
2123 /* Get the dimensions of the display area. The display area
2124 consists of the visible window area plus a horizontally scrolled
2125 part to the left of the window. All x-values are relative to the
2126 start of this total display area. */
2127 if (base_face_id
!= DEFAULT_FACE_ID
)
2129 /* Mode lines, menu bar in terminal frames. */
2130 it
->first_visible_x
= 0;
2131 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2136 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2137 it
->last_visible_x
= (it
->first_visible_x
2138 + window_box_width (w
, TEXT_AREA
));
2140 /* If we truncate lines, leave room for the truncator glyph(s) at
2141 the right margin. Otherwise, leave room for the continuation
2142 glyph(s). Truncation and continuation glyphs are not inserted
2143 for window-based redisplay. */
2144 if (!FRAME_WINDOW_P (it
->f
))
2146 if (it
->truncate_lines_p
)
2147 it
->last_visible_x
-= it
->truncation_pixel_width
;
2149 it
->last_visible_x
-= it
->continuation_pixel_width
;
2152 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2153 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2156 /* Leave room for a border glyph. */
2157 if (!FRAME_WINDOW_P (it
->f
)
2158 && !WINDOW_RIGHTMOST_P (it
->w
))
2159 it
->last_visible_x
-= 1;
2161 it
->last_visible_y
= window_text_bottom_y (w
);
2163 /* For mode lines and alike, arrange for the first glyph having a
2164 left box line if the face specifies a box. */
2165 if (base_face_id
!= DEFAULT_FACE_ID
)
2169 it
->face_id
= base_face_id
;
2171 /* If we have a boxed mode line, make the first character appear
2172 with a left box line. */
2173 face
= FACE_FROM_ID (it
->f
, base_face_id
);
2174 if (face
->box
!= FACE_NO_BOX
)
2175 it
->start_of_box_run_p
= 1;
2178 /* If a buffer position was specified, set the iterator there,
2179 getting overlays and face properties from that position. */
2180 if (charpos
>= BUF_BEG (current_buffer
))
2182 it
->end_charpos
= ZV
;
2184 IT_CHARPOS (*it
) = charpos
;
2186 /* Compute byte position if not specified. */
2187 if (bytepos
< charpos
)
2188 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2190 IT_BYTEPOS (*it
) = bytepos
;
2192 it
->start
= it
->current
;
2194 /* Compute faces etc. */
2195 reseat (it
, it
->current
.pos
, 1);
2202 /* Initialize IT for the display of window W with window start POS. */
2205 start_display (it
, w
, pos
)
2208 struct text_pos pos
;
2210 struct glyph_row
*row
;
2211 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2213 row
= w
->desired_matrix
->rows
+ first_vpos
;
2214 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2215 it
->first_vpos
= first_vpos
;
2217 if (!it
->truncate_lines_p
)
2219 int start_at_line_beg_p
;
2220 int first_y
= it
->current_y
;
2222 /* If window start is not at a line start, skip forward to POS to
2223 get the correct continuation lines width. */
2224 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2225 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2226 if (!start_at_line_beg_p
)
2230 reseat_at_previous_visible_line_start (it
);
2231 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2233 new_x
= it
->current_x
+ it
->pixel_width
;
2235 /* If lines are continued, this line may end in the middle
2236 of a multi-glyph character (e.g. a control character
2237 displayed as \003, or in the middle of an overlay
2238 string). In this case move_it_to above will not have
2239 taken us to the start of the continuation line but to the
2240 end of the continued line. */
2241 if (it
->current_x
> 0
2242 && !it
->truncate_lines_p
/* Lines are continued. */
2243 && (/* And glyph doesn't fit on the line. */
2244 new_x
> it
->last_visible_x
2245 /* Or it fits exactly and we're on a window
2247 || (new_x
== it
->last_visible_x
2248 && FRAME_WINDOW_P (it
->f
))))
2250 if (it
->current
.dpvec_index
>= 0
2251 || it
->current
.overlay_string_index
>= 0)
2253 set_iterator_to_next (it
, 1);
2254 move_it_in_display_line_to (it
, -1, -1, 0);
2257 it
->continuation_lines_width
+= it
->current_x
;
2260 /* We're starting a new display line, not affected by the
2261 height of the continued line, so clear the appropriate
2262 fields in the iterator structure. */
2263 it
->max_ascent
= it
->max_descent
= 0;
2264 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2266 it
->current_y
= first_y
;
2268 it
->current_x
= it
->hpos
= 0;
2272 #if 0 /* Don't assert the following because start_display is sometimes
2273 called intentionally with a window start that is not at a
2274 line start. Please leave this code in as a comment. */
2276 /* Window start should be on a line start, now. */
2277 xassert (it
->continuation_lines_width
2278 || IT_CHARPOS (it
) == BEGV
2279 || FETCH_BYTE (IT_BYTEPOS (it
) - 1) == '\n');
2284 /* Return 1 if POS is a position in ellipses displayed for invisible
2285 text. W is the window we display, for text property lookup. */
2288 in_ellipses_for_invisible_text_p (pos
, w
)
2289 struct display_pos
*pos
;
2292 Lisp_Object prop
, window
;
2294 int charpos
= CHARPOS (pos
->pos
);
2296 /* If POS specifies a position in a display vector, this might
2297 be for an ellipsis displayed for invisible text. We won't
2298 get the iterator set up for delivering that ellipsis unless
2299 we make sure that it gets aware of the invisible text. */
2300 if (pos
->dpvec_index
>= 0
2301 && pos
->overlay_string_index
< 0
2302 && CHARPOS (pos
->string_pos
) < 0
2304 && (XSETWINDOW (window
, w
),
2305 prop
= Fget_char_property (make_number (charpos
),
2306 Qinvisible
, window
),
2307 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2309 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2311 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2318 /* Initialize IT for stepping through current_buffer in window W,
2319 starting at position POS that includes overlay string and display
2320 vector/ control character translation position information. Value
2321 is zero if there are overlay strings with newlines at POS. */
2324 init_from_display_pos (it
, w
, pos
)
2327 struct display_pos
*pos
;
2329 int charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
2330 int i
, overlay_strings_with_newlines
= 0;
2332 /* If POS specifies a position in a display vector, this might
2333 be for an ellipsis displayed for invisible text. We won't
2334 get the iterator set up for delivering that ellipsis unless
2335 we make sure that it gets aware of the invisible text. */
2336 if (in_ellipses_for_invisible_text_p (pos
, w
))
2342 /* Keep in mind: the call to reseat in init_iterator skips invisible
2343 text, so we might end up at a position different from POS. This
2344 is only a problem when POS is a row start after a newline and an
2345 overlay starts there with an after-string, and the overlay has an
2346 invisible property. Since we don't skip invisible text in
2347 display_line and elsewhere immediately after consuming the
2348 newline before the row start, such a POS will not be in a string,
2349 but the call to init_iterator below will move us to the
2351 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
2353 for (i
= 0; i
< it
->n_overlay_strings
; ++i
)
2355 const char *s
= SDATA (it
->overlay_strings
[i
]);
2356 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
2358 while (s
< e
&& *s
!= '\n')
2363 overlay_strings_with_newlines
= 1;
2368 /* If position is within an overlay string, set up IT to the right
2370 if (pos
->overlay_string_index
>= 0)
2374 /* If the first overlay string happens to have a `display'
2375 property for an image, the iterator will be set up for that
2376 image, and we have to undo that setup first before we can
2377 correct the overlay string index. */
2378 if (it
->method
== next_element_from_image
)
2381 /* We already have the first chunk of overlay strings in
2382 IT->overlay_strings. Load more until the one for
2383 pos->overlay_string_index is in IT->overlay_strings. */
2384 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
2386 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
2387 it
->current
.overlay_string_index
= 0;
2390 load_overlay_strings (it
, 0);
2391 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
2395 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
2396 relative_index
= (it
->current
.overlay_string_index
2397 % OVERLAY_STRING_CHUNK_SIZE
);
2398 it
->string
= it
->overlay_strings
[relative_index
];
2399 xassert (STRINGP (it
->string
));
2400 it
->current
.string_pos
= pos
->string_pos
;
2401 it
->method
= next_element_from_string
;
2404 #if 0 /* This is bogus because POS not having an overlay string
2405 position does not mean it's after the string. Example: A
2406 line starting with a before-string and initialization of IT
2407 to the previous row's end position. */
2408 else if (it
->current
.overlay_string_index
>= 0)
2410 /* If POS says we're already after an overlay string ending at
2411 POS, make sure to pop the iterator because it will be in
2412 front of that overlay string. When POS is ZV, we've thereby
2413 also ``processed'' overlay strings at ZV. */
2416 it
->current
.overlay_string_index
= -1;
2417 it
->method
= next_element_from_buffer
;
2418 if (CHARPOS (pos
->pos
) == ZV
)
2419 it
->overlay_strings_at_end_processed_p
= 1;
2423 if (CHARPOS (pos
->string_pos
) >= 0)
2425 /* Recorded position is not in an overlay string, but in another
2426 string. This can only be a string from a `display' property.
2427 IT should already be filled with that string. */
2428 it
->current
.string_pos
= pos
->string_pos
;
2429 xassert (STRINGP (it
->string
));
2432 /* Restore position in display vector translations, control
2433 character translations or ellipses. */
2434 if (pos
->dpvec_index
>= 0)
2436 if (it
->dpvec
== NULL
)
2437 get_next_display_element (it
);
2438 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
2439 it
->current
.dpvec_index
= pos
->dpvec_index
;
2443 return !overlay_strings_with_newlines
;
2447 /* Initialize IT for stepping through current_buffer in window W
2448 starting at ROW->start. */
2451 init_to_row_start (it
, w
, row
)
2454 struct glyph_row
*row
;
2456 init_from_display_pos (it
, w
, &row
->start
);
2457 it
->start
= row
->start
;
2458 it
->continuation_lines_width
= row
->continuation_lines_width
;
2463 /* Initialize IT for stepping through current_buffer in window W
2464 starting in the line following ROW, i.e. starting at ROW->end.
2465 Value is zero if there are overlay strings with newlines at ROW's
2469 init_to_row_end (it
, w
, row
)
2472 struct glyph_row
*row
;
2476 if (init_from_display_pos (it
, w
, &row
->end
))
2478 if (row
->continued_p
)
2479 it
->continuation_lines_width
2480 = row
->continuation_lines_width
+ row
->pixel_width
;
2491 /***********************************************************************
2493 ***********************************************************************/
2495 /* Called when IT reaches IT->stop_charpos. Handle text property and
2496 overlay changes. Set IT->stop_charpos to the next position where
2503 enum prop_handled handled
;
2504 int handle_overlay_change_p
= 1;
2508 it
->current
.dpvec_index
= -1;
2512 handled
= HANDLED_NORMALLY
;
2514 /* Call text property handlers. */
2515 for (p
= it_props
; p
->handler
; ++p
)
2517 handled
= p
->handler (it
);
2519 if (handled
== HANDLED_RECOMPUTE_PROPS
)
2521 else if (handled
== HANDLED_RETURN
)
2523 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
2524 handle_overlay_change_p
= 0;
2527 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
2529 /* Don't check for overlay strings below when set to deliver
2530 characters from a display vector. */
2531 if (it
->method
== next_element_from_display_vector
)
2532 handle_overlay_change_p
= 0;
2534 /* Handle overlay changes. */
2535 if (handle_overlay_change_p
)
2536 handled
= handle_overlay_change (it
);
2538 /* Determine where to stop next. */
2539 if (handled
== HANDLED_NORMALLY
)
2540 compute_stop_pos (it
);
2543 while (handled
== HANDLED_RECOMPUTE_PROPS
);
2547 /* Compute IT->stop_charpos from text property and overlay change
2548 information for IT's current position. */
2551 compute_stop_pos (it
)
2554 register INTERVAL iv
, next_iv
;
2555 Lisp_Object object
, limit
, position
;
2557 /* If nowhere else, stop at the end. */
2558 it
->stop_charpos
= it
->end_charpos
;
2560 if (STRINGP (it
->string
))
2562 /* Strings are usually short, so don't limit the search for
2564 object
= it
->string
;
2566 position
= make_number (IT_STRING_CHARPOS (*it
));
2572 /* If next overlay change is in front of the current stop pos
2573 (which is IT->end_charpos), stop there. Note: value of
2574 next_overlay_change is point-max if no overlay change
2576 charpos
= next_overlay_change (IT_CHARPOS (*it
));
2577 if (charpos
< it
->stop_charpos
)
2578 it
->stop_charpos
= charpos
;
2580 /* If showing the region, we have to stop at the region
2581 start or end because the face might change there. */
2582 if (it
->region_beg_charpos
> 0)
2584 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
2585 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
2586 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
2587 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
2590 /* Set up variables for computing the stop position from text
2591 property changes. */
2592 XSETBUFFER (object
, current_buffer
);
2593 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
2594 position
= make_number (IT_CHARPOS (*it
));
2598 /* Get the interval containing IT's position. Value is a null
2599 interval if there isn't such an interval. */
2600 iv
= validate_interval_range (object
, &position
, &position
, 0);
2601 if (!NULL_INTERVAL_P (iv
))
2603 Lisp_Object values_here
[LAST_PROP_IDX
];
2606 /* Get properties here. */
2607 for (p
= it_props
; p
->handler
; ++p
)
2608 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
2610 /* Look for an interval following iv that has different
2612 for (next_iv
= next_interval (iv
);
2613 (!NULL_INTERVAL_P (next_iv
)
2615 || XFASTINT (limit
) > next_iv
->position
));
2616 next_iv
= next_interval (next_iv
))
2618 for (p
= it_props
; p
->handler
; ++p
)
2620 Lisp_Object new_value
;
2622 new_value
= textget (next_iv
->plist
, *p
->name
);
2623 if (!EQ (values_here
[p
->idx
], new_value
))
2631 if (!NULL_INTERVAL_P (next_iv
))
2633 if (INTEGERP (limit
)
2634 && next_iv
->position
>= XFASTINT (limit
))
2635 /* No text property change up to limit. */
2636 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
2638 /* Text properties change in next_iv. */
2639 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
2643 xassert (STRINGP (it
->string
)
2644 || (it
->stop_charpos
>= BEGV
2645 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
2649 /* Return the position of the next overlay change after POS in
2650 current_buffer. Value is point-max if no overlay change
2651 follows. This is like `next-overlay-change' but doesn't use
2655 next_overlay_change (pos
)
2660 Lisp_Object
*overlays
;
2664 /* Get all overlays at the given position. */
2666 overlays
= (Lisp_Object
*) alloca (len
* sizeof *overlays
);
2667 noverlays
= overlays_at (pos
, 0, &overlays
, &len
, &endpos
, NULL
, 1);
2668 if (noverlays
> len
)
2671 overlays
= (Lisp_Object
*) alloca (len
* sizeof *overlays
);
2672 noverlays
= overlays_at (pos
, 0, &overlays
, &len
, &endpos
, NULL
, 1);
2675 /* If any of these overlays ends before endpos,
2676 use its ending point instead. */
2677 for (i
= 0; i
< noverlays
; ++i
)
2682 oend
= OVERLAY_END (overlays
[i
]);
2683 oendpos
= OVERLAY_POSITION (oend
);
2684 endpos
= min (endpos
, oendpos
);
2692 /***********************************************************************
2694 ***********************************************************************/
2696 /* Handle changes in the `fontified' property of the current buffer by
2697 calling hook functions from Qfontification_functions to fontify
2700 static enum prop_handled
2701 handle_fontified_prop (it
)
2704 Lisp_Object prop
, pos
;
2705 enum prop_handled handled
= HANDLED_NORMALLY
;
2707 /* Get the value of the `fontified' property at IT's current buffer
2708 position. (The `fontified' property doesn't have a special
2709 meaning in strings.) If the value is nil, call functions from
2710 Qfontification_functions. */
2711 if (!STRINGP (it
->string
)
2713 && !NILP (Vfontification_functions
)
2714 && !NILP (Vrun_hooks
)
2715 && (pos
= make_number (IT_CHARPOS (*it
)),
2716 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
2719 int count
= SPECPDL_INDEX ();
2722 val
= Vfontification_functions
;
2723 specbind (Qfontification_functions
, Qnil
);
2725 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
2726 safe_call1 (val
, pos
);
2729 Lisp_Object globals
, fn
;
2730 struct gcpro gcpro1
, gcpro2
;
2733 GCPRO2 (val
, globals
);
2735 for (; CONSP (val
); val
= XCDR (val
))
2741 /* A value of t indicates this hook has a local
2742 binding; it means to run the global binding too.
2743 In a global value, t should not occur. If it
2744 does, we must ignore it to avoid an endless
2746 for (globals
= Fdefault_value (Qfontification_functions
);
2748 globals
= XCDR (globals
))
2750 fn
= XCAR (globals
);
2752 safe_call1 (fn
, pos
);
2756 safe_call1 (fn
, pos
);
2762 unbind_to (count
, Qnil
);
2764 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
2765 something. This avoids an endless loop if they failed to
2766 fontify the text for which reason ever. */
2767 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
2768 handled
= HANDLED_RECOMPUTE_PROPS
;
2776 /***********************************************************************
2778 ***********************************************************************/
2780 /* Set up iterator IT from face properties at its current position.
2781 Called from handle_stop. */
2783 static enum prop_handled
2784 handle_face_prop (it
)
2787 int new_face_id
, next_stop
;
2789 if (!STRINGP (it
->string
))
2792 = face_at_buffer_position (it
->w
,
2794 it
->region_beg_charpos
,
2795 it
->region_end_charpos
,
2798 + TEXT_PROP_DISTANCE_LIMIT
),
2801 /* Is this a start of a run of characters with box face?
2802 Caveat: this can be called for a freshly initialized
2803 iterator; face_id is -1 in this case. We know that the new
2804 face will not change until limit, i.e. if the new face has a
2805 box, all characters up to limit will have one. But, as
2806 usual, we don't know whether limit is really the end. */
2807 if (new_face_id
!= it
->face_id
)
2809 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
2811 /* If new face has a box but old face has not, this is
2812 the start of a run of characters with box, i.e. it has
2813 a shadow on the left side. The value of face_id of the
2814 iterator will be -1 if this is the initial call that gets
2815 the face. In this case, we have to look in front of IT's
2816 position and see whether there is a face != new_face_id. */
2817 it
->start_of_box_run_p
2818 = (new_face
->box
!= FACE_NO_BOX
2819 && (it
->face_id
>= 0
2820 || IT_CHARPOS (*it
) == BEG
2821 || new_face_id
!= face_before_it_pos (it
)));
2822 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
2827 int base_face_id
, bufpos
;
2829 if (it
->current
.overlay_string_index
>= 0)
2830 bufpos
= IT_CHARPOS (*it
);
2834 /* For strings from a buffer, i.e. overlay strings or strings
2835 from a `display' property, use the face at IT's current
2836 buffer position as the base face to merge with, so that
2837 overlay strings appear in the same face as surrounding
2838 text, unless they specify their own faces. */
2839 base_face_id
= underlying_face_id (it
);
2841 new_face_id
= face_at_string_position (it
->w
,
2843 IT_STRING_CHARPOS (*it
),
2845 it
->region_beg_charpos
,
2846 it
->region_end_charpos
,
2850 #if 0 /* This shouldn't be neccessary. Let's check it. */
2851 /* If IT is used to display a mode line we would really like to
2852 use the mode line face instead of the frame's default face. */
2853 if (it
->glyph_row
== MATRIX_MODE_LINE_ROW (it
->w
->desired_matrix
)
2854 && new_face_id
== DEFAULT_FACE_ID
)
2855 new_face_id
= CURRENT_MODE_LINE_FACE_ID (it
->w
);
2858 /* Is this a start of a run of characters with box? Caveat:
2859 this can be called for a freshly allocated iterator; face_id
2860 is -1 is this case. We know that the new face will not
2861 change until the next check pos, i.e. if the new face has a
2862 box, all characters up to that position will have a
2863 box. But, as usual, we don't know whether that position
2864 is really the end. */
2865 if (new_face_id
!= it
->face_id
)
2867 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
2868 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
2870 /* If new face has a box but old face hasn't, this is the
2871 start of a run of characters with box, i.e. it has a
2872 shadow on the left side. */
2873 it
->start_of_box_run_p
2874 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
2875 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
2879 it
->face_id
= new_face_id
;
2880 return HANDLED_NORMALLY
;
2884 /* Return the ID of the face ``underlying'' IT's current position,
2885 which is in a string. If the iterator is associated with a
2886 buffer, return the face at IT's current buffer position.
2887 Otherwise, use the iterator's base_face_id. */
2890 underlying_face_id (it
)
2893 int face_id
= it
->base_face_id
, i
;
2895 xassert (STRINGP (it
->string
));
2897 for (i
= it
->sp
- 1; i
>= 0; --i
)
2898 if (NILP (it
->stack
[i
].string
))
2899 face_id
= it
->stack
[i
].face_id
;
2905 /* Compute the face one character before or after the current position
2906 of IT. BEFORE_P non-zero means get the face in front of IT's
2907 position. Value is the id of the face. */
2910 face_before_or_after_it_pos (it
, before_p
)
2915 int next_check_charpos
;
2916 struct text_pos pos
;
2918 xassert (it
->s
== NULL
);
2920 if (STRINGP (it
->string
))
2922 int bufpos
, base_face_id
;
2924 /* No face change past the end of the string (for the case
2925 we are padding with spaces). No face change before the
2927 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
2928 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
2931 /* Set pos to the position before or after IT's current position. */
2933 pos
= string_pos (IT_STRING_CHARPOS (*it
) - 1, it
->string
);
2935 /* For composition, we must check the character after the
2937 pos
= (it
->what
== IT_COMPOSITION
2938 ? string_pos (IT_STRING_CHARPOS (*it
) + it
->cmp_len
, it
->string
)
2939 : string_pos (IT_STRING_CHARPOS (*it
) + 1, it
->string
));
2941 if (it
->current
.overlay_string_index
>= 0)
2942 bufpos
= IT_CHARPOS (*it
);
2946 base_face_id
= underlying_face_id (it
);
2948 /* Get the face for ASCII, or unibyte. */
2949 face_id
= face_at_string_position (it
->w
,
2953 it
->region_beg_charpos
,
2954 it
->region_end_charpos
,
2955 &next_check_charpos
,
2958 /* Correct the face for charsets different from ASCII. Do it
2959 for the multibyte case only. The face returned above is
2960 suitable for unibyte text if IT->string is unibyte. */
2961 if (STRING_MULTIBYTE (it
->string
))
2963 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos
);
2964 int rest
= SBYTES (it
->string
) - BYTEPOS (pos
);
2966 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
2968 c
= string_char_and_length (p
, rest
, &len
);
2969 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
);
2974 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
2975 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
2978 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
2979 pos
= it
->current
.pos
;
2982 DEC_TEXT_POS (pos
, it
->multibyte_p
);
2985 if (it
->what
== IT_COMPOSITION
)
2986 /* For composition, we must check the position after the
2988 pos
.charpos
+= it
->cmp_len
, pos
.bytepos
+= it
->len
;
2990 INC_TEXT_POS (pos
, it
->multibyte_p
);
2993 /* Determine face for CHARSET_ASCII, or unibyte. */
2994 face_id
= face_at_buffer_position (it
->w
,
2996 it
->region_beg_charpos
,
2997 it
->region_end_charpos
,
2998 &next_check_charpos
,
3001 /* Correct the face for charsets different from ASCII. Do it
3002 for the multibyte case only. The face returned above is
3003 suitable for unibyte text if current_buffer is unibyte. */
3004 if (it
->multibyte_p
)
3006 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3007 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3008 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
);
3017 /***********************************************************************
3019 ***********************************************************************/
3021 /* Set up iterator IT from invisible properties at its current
3022 position. Called from handle_stop. */
3024 static enum prop_handled
3025 handle_invisible_prop (it
)
3028 enum prop_handled handled
= HANDLED_NORMALLY
;
3030 if (STRINGP (it
->string
))
3032 extern Lisp_Object Qinvisible
;
3033 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3035 /* Get the value of the invisible text property at the
3036 current position. Value will be nil if there is no such
3038 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3039 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3042 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3044 handled
= HANDLED_RECOMPUTE_PROPS
;
3046 /* Get the position at which the next change of the
3047 invisible text property can be found in IT->string.
3048 Value will be nil if the property value is the same for
3049 all the rest of IT->string. */
3050 XSETINT (limit
, SCHARS (it
->string
));
3051 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3054 /* Text at current position is invisible. The next
3055 change in the property is at position end_charpos.
3056 Move IT's current position to that position. */
3057 if (INTEGERP (end_charpos
)
3058 && XFASTINT (end_charpos
) < XFASTINT (limit
))
3060 struct text_pos old
;
3061 old
= it
->current
.string_pos
;
3062 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3063 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
3067 /* The rest of the string is invisible. If this is an
3068 overlay string, proceed with the next overlay string
3069 or whatever comes and return a character from there. */
3070 if (it
->current
.overlay_string_index
>= 0)
3072 next_overlay_string (it
);
3073 /* Don't check for overlay strings when we just
3074 finished processing them. */
3075 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
3079 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
3080 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
3087 int invis_p
, newpos
, next_stop
, start_charpos
;
3088 Lisp_Object pos
, prop
, overlay
;
3090 /* First of all, is there invisible text at this position? */
3091 start_charpos
= IT_CHARPOS (*it
);
3092 pos
= make_number (IT_CHARPOS (*it
));
3093 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
3095 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3097 /* If we are on invisible text, skip over it. */
3098 if (invis_p
&& IT_CHARPOS (*it
) < it
->end_charpos
)
3100 /* Record whether we have to display an ellipsis for the
3102 int display_ellipsis_p
= invis_p
== 2;
3104 handled
= HANDLED_RECOMPUTE_PROPS
;
3106 /* Loop skipping over invisible text. The loop is left at
3107 ZV or with IT on the first char being visible again. */
3110 /* Try to skip some invisible text. Return value is the
3111 position reached which can be equal to IT's position
3112 if there is nothing invisible here. This skips both
3113 over invisible text properties and overlays with
3114 invisible property. */
3115 newpos
= skip_invisible (IT_CHARPOS (*it
),
3116 &next_stop
, ZV
, it
->window
);
3118 /* If we skipped nothing at all we weren't at invisible
3119 text in the first place. If everything to the end of
3120 the buffer was skipped, end the loop. */
3121 if (newpos
== IT_CHARPOS (*it
) || newpos
>= ZV
)
3125 /* We skipped some characters but not necessarily
3126 all there are. Check if we ended up on visible
3127 text. Fget_char_property returns the property of
3128 the char before the given position, i.e. if we
3129 get invis_p = 0, this means that the char at
3130 newpos is visible. */
3131 pos
= make_number (newpos
);
3132 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
3133 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3136 /* If we ended up on invisible text, proceed to
3137 skip starting with next_stop. */
3139 IT_CHARPOS (*it
) = next_stop
;
3143 /* The position newpos is now either ZV or on visible text. */
3144 IT_CHARPOS (*it
) = newpos
;
3145 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
3147 /* If there are before-strings at the start of invisible
3148 text, and the text is invisible because of a text
3149 property, arrange to show before-strings because 20.x did
3150 it that way. (If the text is invisible because of an
3151 overlay property instead of a text property, this is
3152 already handled in the overlay code.) */
3154 && get_overlay_strings (it
, start_charpos
))
3156 handled
= HANDLED_RECOMPUTE_PROPS
;
3157 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
3159 else if (display_ellipsis_p
)
3160 setup_for_ellipsis (it
);
3168 /* Make iterator IT return `...' next. */
3171 setup_for_ellipsis (it
)
3175 && VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
3177 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
3178 it
->dpvec
= v
->contents
;
3179 it
->dpend
= v
->contents
+ v
->size
;
3183 /* Default `...'. */
3184 it
->dpvec
= default_invis_vector
;
3185 it
->dpend
= default_invis_vector
+ 3;
3188 /* The ellipsis display does not replace the display of the
3189 character at the new position. Indicate this by setting
3190 IT->dpvec_char_len to zero. */
3191 it
->dpvec_char_len
= 0;
3193 it
->current
.dpvec_index
= 0;
3194 it
->method
= next_element_from_display_vector
;
3199 /***********************************************************************
3201 ***********************************************************************/
3203 /* Set up iterator IT from `display' property at its current position.
3204 Called from handle_stop. */
3206 static enum prop_handled
3207 handle_display_prop (it
)
3210 Lisp_Object prop
, object
;
3211 struct text_pos
*position
;
3212 int display_replaced_p
= 0;
3214 if (STRINGP (it
->string
))
3216 object
= it
->string
;
3217 position
= &it
->current
.string_pos
;
3221 object
= it
->w
->buffer
;
3222 position
= &it
->current
.pos
;
3225 /* Reset those iterator values set from display property values. */
3226 it
->font_height
= Qnil
;
3227 it
->space_width
= Qnil
;
3230 /* We don't support recursive `display' properties, i.e. string
3231 values that have a string `display' property, that have a string
3232 `display' property etc. */
3233 if (!it
->string_from_display_prop_p
)
3234 it
->area
= TEXT_AREA
;
3236 prop
= Fget_char_property (make_number (position
->charpos
),
3239 return HANDLED_NORMALLY
;
3242 /* Simple properties. */
3243 && !EQ (XCAR (prop
), Qimage
)
3244 && !EQ (XCAR (prop
), Qspace
)
3245 && !EQ (XCAR (prop
), Qwhen
)
3246 && !EQ (XCAR (prop
), Qspace_width
)
3247 && !EQ (XCAR (prop
), Qheight
)
3248 && !EQ (XCAR (prop
), Qraise
)
3249 /* Marginal area specifications. */
3250 && !(CONSP (XCAR (prop
)) && EQ (XCAR (XCAR (prop
)), Qmargin
))
3251 && !NILP (XCAR (prop
)))
3253 for (; CONSP (prop
); prop
= XCDR (prop
))
3255 if (handle_single_display_prop (it
, XCAR (prop
), object
,
3256 position
, display_replaced_p
))
3257 display_replaced_p
= 1;
3260 else if (VECTORP (prop
))
3263 for (i
= 0; i
< ASIZE (prop
); ++i
)
3264 if (handle_single_display_prop (it
, AREF (prop
, i
), object
,
3265 position
, display_replaced_p
))
3266 display_replaced_p
= 1;
3270 if (handle_single_display_prop (it
, prop
, object
, position
, 0))
3271 display_replaced_p
= 1;
3274 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
3278 /* Value is the position of the end of the `display' property starting
3279 at START_POS in OBJECT. */
3281 static struct text_pos
3282 display_prop_end (it
, object
, start_pos
)
3285 struct text_pos start_pos
;
3288 struct text_pos end_pos
;
3290 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
3291 Qdisplay
, object
, Qnil
);
3292 CHARPOS (end_pos
) = XFASTINT (end
);
3293 if (STRINGP (object
))
3294 compute_string_pos (&end_pos
, start_pos
, it
->string
);
3296 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
3302 /* Set up IT from a single `display' sub-property value PROP. OBJECT
3303 is the object in which the `display' property was found. *POSITION
3304 is the position at which it was found. DISPLAY_REPLACED_P non-zero
3305 means that we previously saw a display sub-property which already
3306 replaced text display with something else, for example an image;
3307 ignore such properties after the first one has been processed.
3309 If PROP is a `space' or `image' sub-property, set *POSITION to the
3310 end position of the `display' property.
3312 Value is non-zero if something was found which replaces the display
3313 of buffer or string text. */
3316 handle_single_display_prop (it
, prop
, object
, position
,
3317 display_replaced_before_p
)
3321 struct text_pos
*position
;
3322 int display_replaced_before_p
;
3325 int replaces_text_display_p
= 0;
3328 /* If PROP is a list of the form `(when FORM . VALUE)', FORM is
3329 evaluated. If the result is nil, VALUE is ignored. */
3331 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
3340 if (!NILP (form
) && !EQ (form
, Qt
))
3342 int count
= SPECPDL_INDEX ();
3343 struct gcpro gcpro1
;
3345 /* Bind `object' to the object having the `display' property, a
3346 buffer or string. Bind `position' to the position in the
3347 object where the property was found, and `buffer-position'
3348 to the current position in the buffer. */
3349 specbind (Qobject
, object
);
3350 specbind (Qposition
, make_number (CHARPOS (*position
)));
3351 specbind (Qbuffer_position
,
3352 make_number (STRINGP (object
)
3353 ? IT_CHARPOS (*it
) : CHARPOS (*position
)));
3355 form
= safe_eval (form
);
3357 unbind_to (count
, Qnil
);
3364 && EQ (XCAR (prop
), Qheight
)
3365 && CONSP (XCDR (prop
)))
3367 if (FRAME_TERMCAP_P (it
->f
) || FRAME_MSDOS_P (it
->f
))
3370 /* `(height HEIGHT)'. */
3371 it
->font_height
= XCAR (XCDR (prop
));
3372 if (!NILP (it
->font_height
))
3374 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3375 int new_height
= -1;
3377 if (CONSP (it
->font_height
)
3378 && (EQ (XCAR (it
->font_height
), Qplus
)
3379 || EQ (XCAR (it
->font_height
), Qminus
))
3380 && CONSP (XCDR (it
->font_height
))
3381 && INTEGERP (XCAR (XCDR (it
->font_height
))))
3383 /* `(+ N)' or `(- N)' where N is an integer. */
3384 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
3385 if (EQ (XCAR (it
->font_height
), Qplus
))
3387 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
3389 else if (FUNCTIONP (it
->font_height
))
3391 /* Call function with current height as argument.
3392 Value is the new height. */
3394 height
= safe_call1 (it
->font_height
,
3395 face
->lface
[LFACE_HEIGHT_INDEX
]);
3396 if (NUMBERP (height
))
3397 new_height
= XFLOATINT (height
);
3399 else if (NUMBERP (it
->font_height
))
3401 /* Value is a multiple of the canonical char height. */
3404 face
= FACE_FROM_ID (it
->f
, DEFAULT_FACE_ID
);
3405 new_height
= (XFLOATINT (it
->font_height
)
3406 * XINT (face
->lface
[LFACE_HEIGHT_INDEX
]));
3410 /* Evaluate IT->font_height with `height' bound to the
3411 current specified height to get the new height. */
3413 int count
= SPECPDL_INDEX ();
3415 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
3416 value
= safe_eval (it
->font_height
);
3417 unbind_to (count
, Qnil
);
3419 if (NUMBERP (value
))
3420 new_height
= XFLOATINT (value
);
3424 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
3427 else if (CONSP (prop
)
3428 && EQ (XCAR (prop
), Qspace_width
)
3429 && CONSP (XCDR (prop
)))
3431 /* `(space_width WIDTH)'. */
3432 if (FRAME_TERMCAP_P (it
->f
) || FRAME_MSDOS_P (it
->f
))
3435 value
= XCAR (XCDR (prop
));
3436 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
3437 it
->space_width
= value
;
3439 else if (CONSP (prop
)
3440 && EQ (XCAR (prop
), Qraise
)
3441 && CONSP (XCDR (prop
)))
3443 /* `(raise FACTOR)'. */
3444 if (FRAME_TERMCAP_P (it
->f
) || FRAME_MSDOS_P (it
->f
))
3447 #ifdef HAVE_WINDOW_SYSTEM
3448 value
= XCAR (XCDR (prop
));
3449 if (NUMBERP (value
))
3451 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3452 it
->voffset
= - (XFLOATINT (value
)
3453 * (FONT_HEIGHT (face
->font
)));
3455 #endif /* HAVE_WINDOW_SYSTEM */
3457 else if (!it
->string_from_display_prop_p
)
3459 /* `((margin left-margin) VALUE)' or `((margin right-margin)
3460 VALUE) or `((margin nil) VALUE)' or VALUE. */
3461 Lisp_Object location
, value
;
3462 struct text_pos start_pos
;
3465 /* Characters having this form of property are not displayed, so
3466 we have to find the end of the property. */
3467 start_pos
= *position
;
3468 *position
= display_prop_end (it
, object
, start_pos
);
3471 /* Let's stop at the new position and assume that all
3472 text properties change there. */
3473 it
->stop_charpos
= position
->charpos
;
3475 location
= Qunbound
;
3476 if (CONSP (prop
) && CONSP (XCAR (prop
)))
3480 value
= XCDR (prop
);
3482 value
= XCAR (value
);
3485 if (EQ (XCAR (tem
), Qmargin
)
3486 && (tem
= XCDR (tem
),
3487 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
3489 || EQ (tem
, Qleft_margin
)
3490 || EQ (tem
, Qright_margin
))))
3494 if (EQ (location
, Qunbound
))
3500 #ifdef HAVE_WINDOW_SYSTEM
3501 if (FRAME_TERMCAP_P (it
->f
))
3502 valid_p
= STRINGP (value
);
3504 valid_p
= (STRINGP (value
)
3505 || (CONSP (value
) && EQ (XCAR (value
), Qspace
))
3506 || valid_image_p (value
));
3507 #else /* not HAVE_WINDOW_SYSTEM */
3508 valid_p
= STRINGP (value
);
3509 #endif /* not HAVE_WINDOW_SYSTEM */
3511 if ((EQ (location
, Qleft_margin
)
3512 || EQ (location
, Qright_margin
)
3515 && !display_replaced_before_p
)
3517 replaces_text_display_p
= 1;
3519 /* Save current settings of IT so that we can restore them
3520 when we are finished with the glyph property value. */
3523 if (NILP (location
))
3524 it
->area
= TEXT_AREA
;
3525 else if (EQ (location
, Qleft_margin
))
3526 it
->area
= LEFT_MARGIN_AREA
;
3528 it
->area
= RIGHT_MARGIN_AREA
;
3530 if (STRINGP (value
))
3533 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
3534 it
->current
.overlay_string_index
= -1;
3535 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
3536 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
3537 it
->method
= next_element_from_string
;
3538 it
->stop_charpos
= 0;
3539 it
->string_from_display_prop_p
= 1;
3540 /* Say that we haven't consumed the characters with
3541 `display' property yet. The call to pop_it in
3542 set_iterator_to_next will clean this up. */
3543 *position
= start_pos
;
3545 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
3547 it
->method
= next_element_from_stretch
;
3549 it
->current
.pos
= it
->position
= start_pos
;
3551 #ifdef HAVE_WINDOW_SYSTEM
3554 it
->what
= IT_IMAGE
;
3555 it
->image_id
= lookup_image (it
->f
, value
);
3556 it
->position
= start_pos
;
3557 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
3558 it
->method
= next_element_from_image
;
3560 /* Say that we haven't consumed the characters with
3561 `display' property yet. The call to pop_it in
3562 set_iterator_to_next will clean this up. */
3563 *position
= start_pos
;
3565 #endif /* HAVE_WINDOW_SYSTEM */
3568 /* Invalid property or property not supported. Restore
3569 the position to what it was before. */
3570 *position
= start_pos
;
3573 return replaces_text_display_p
;
3577 /* Check if PROP is a display sub-property value whose text should be
3578 treated as intangible. */
3581 single_display_prop_intangible_p (prop
)
3584 /* Skip over `when FORM'. */
3585 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
3599 /* Skip over `margin LOCATION'. If LOCATION is in the margins,
3600 we don't need to treat text as intangible. */
3601 if (EQ (XCAR (prop
), Qmargin
))
3609 || EQ (XCAR (prop
), Qleft_margin
)
3610 || EQ (XCAR (prop
), Qright_margin
))
3614 return (CONSP (prop
)
3615 && (EQ (XCAR (prop
), Qimage
)
3616 || EQ (XCAR (prop
), Qspace
)));
3620 /* Check if PROP is a display property value whose text should be
3621 treated as intangible. */
3624 display_prop_intangible_p (prop
)
3628 && CONSP (XCAR (prop
))
3629 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
3631 /* A list of sub-properties. */
3632 while (CONSP (prop
))
3634 if (single_display_prop_intangible_p (XCAR (prop
)))
3639 else if (VECTORP (prop
))
3641 /* A vector of sub-properties. */
3643 for (i
= 0; i
< ASIZE (prop
); ++i
)
3644 if (single_display_prop_intangible_p (AREF (prop
, i
)))
3648 return single_display_prop_intangible_p (prop
);
3654 /* Return 1 if PROP is a display sub-property value containing STRING. */
3657 single_display_prop_string_p (prop
, string
)
3658 Lisp_Object prop
, string
;
3660 if (EQ (string
, prop
))
3663 /* Skip over `when FORM'. */
3664 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
3673 /* Skip over `margin LOCATION'. */
3674 if (EQ (XCAR (prop
), Qmargin
))
3685 return CONSP (prop
) && EQ (XCAR (prop
), string
);
3689 /* Return 1 if STRING appears in the `display' property PROP. */
3692 display_prop_string_p (prop
, string
)
3693 Lisp_Object prop
, string
;
3696 && CONSP (XCAR (prop
))
3697 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
3699 /* A list of sub-properties. */
3700 while (CONSP (prop
))
3702 if (single_display_prop_string_p (XCAR (prop
), string
))
3707 else if (VECTORP (prop
))
3709 /* A vector of sub-properties. */
3711 for (i
= 0; i
< ASIZE (prop
); ++i
)
3712 if (single_display_prop_string_p (AREF (prop
, i
), string
))
3716 return single_display_prop_string_p (prop
, string
);
3722 /* Determine from which buffer position in W's buffer STRING comes
3723 from. AROUND_CHARPOS is an approximate position where it could
3724 be from. Value is the buffer position or 0 if it couldn't be
3727 W's buffer must be current.
3729 This function is necessary because we don't record buffer positions
3730 in glyphs generated from strings (to keep struct glyph small).
3731 This function may only use code that doesn't eval because it is
3732 called asynchronously from note_mouse_highlight. */
3735 string_buffer_position (w
, string
, around_charpos
)
3740 Lisp_Object limit
, prop
, pos
;
3741 const int MAX_DISTANCE
= 1000;
3744 pos
= make_number (around_charpos
);
3745 limit
= make_number (min (XINT (pos
) + MAX_DISTANCE
, ZV
));
3746 while (!found
&& !EQ (pos
, limit
))
3748 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
3749 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
3752 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
, limit
);
3757 pos
= make_number (around_charpos
);
3758 limit
= make_number (max (XINT (pos
) - MAX_DISTANCE
, BEGV
));
3759 while (!found
&& !EQ (pos
, limit
))
3761 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
3762 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
3765 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
3770 return found
? XINT (pos
) : 0;
3775 /***********************************************************************
3776 `composition' property
3777 ***********************************************************************/
3779 /* Set up iterator IT from `composition' property at its current
3780 position. Called from handle_stop. */
3782 static enum prop_handled
3783 handle_composition_prop (it
)
3786 Lisp_Object prop
, string
;
3787 int pos
, pos_byte
, end
;
3788 enum prop_handled handled
= HANDLED_NORMALLY
;
3790 if (STRINGP (it
->string
))
3792 pos
= IT_STRING_CHARPOS (*it
);
3793 pos_byte
= IT_STRING_BYTEPOS (*it
);
3794 string
= it
->string
;
3798 pos
= IT_CHARPOS (*it
);
3799 pos_byte
= IT_BYTEPOS (*it
);
3803 /* If there's a valid composition and point is not inside of the
3804 composition (in the case that the composition is from the current
3805 buffer), draw a glyph composed from the composition components. */
3806 if (find_composition (pos
, -1, &pos
, &end
, &prop
, string
)
3807 && COMPOSITION_VALID_P (pos
, end
, prop
)
3808 && (STRINGP (it
->string
) || (PT
<= pos
|| PT
>= end
)))
3810 int id
= get_composition_id (pos
, pos_byte
, end
- pos
, prop
, string
);
3814 it
->method
= next_element_from_composition
;
3816 it
->cmp_len
= COMPOSITION_LENGTH (prop
);
3817 /* For a terminal, draw only the first character of the
3819 it
->c
= COMPOSITION_GLYPH (composition_table
[id
], 0);
3820 it
->len
= (STRINGP (it
->string
)
3821 ? string_char_to_byte (it
->string
, end
)
3822 : CHAR_TO_BYTE (end
)) - pos_byte
;
3823 it
->stop_charpos
= end
;
3824 handled
= HANDLED_RETURN
;
3833 /***********************************************************************
3835 ***********************************************************************/
3837 /* The following structure is used to record overlay strings for
3838 later sorting in load_overlay_strings. */
3840 struct overlay_entry
3842 Lisp_Object overlay
;
3849 /* Set up iterator IT from overlay strings at its current position.
3850 Called from handle_stop. */
3852 static enum prop_handled
3853 handle_overlay_change (it
)
3856 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
3857 return HANDLED_RECOMPUTE_PROPS
;
3859 return HANDLED_NORMALLY
;
3863 /* Set up the next overlay string for delivery by IT, if there is an
3864 overlay string to deliver. Called by set_iterator_to_next when the
3865 end of the current overlay string is reached. If there are more
3866 overlay strings to display, IT->string and
3867 IT->current.overlay_string_index are set appropriately here.
3868 Otherwise IT->string is set to nil. */
3871 next_overlay_string (it
)
3874 ++it
->current
.overlay_string_index
;
3875 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
3877 /* No more overlay strings. Restore IT's settings to what
3878 they were before overlay strings were processed, and
3879 continue to deliver from current_buffer. */
3880 int display_ellipsis_p
= it
->stack
[it
->sp
- 1].display_ellipsis_p
;
3883 xassert (it
->stop_charpos
>= BEGV
3884 && it
->stop_charpos
<= it
->end_charpos
);
3886 it
->current
.overlay_string_index
= -1;
3887 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
3888 it
->n_overlay_strings
= 0;
3889 it
->method
= next_element_from_buffer
;
3891 /* If we're at the end of the buffer, record that we have
3892 processed the overlay strings there already, so that
3893 next_element_from_buffer doesn't try it again. */
3894 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
3895 it
->overlay_strings_at_end_processed_p
= 1;
3897 /* If we have to display `...' for invisible text, set
3898 the iterator up for that. */
3899 if (display_ellipsis_p
)
3900 setup_for_ellipsis (it
);
3904 /* There are more overlay strings to process. If
3905 IT->current.overlay_string_index has advanced to a position
3906 where we must load IT->overlay_strings with more strings, do
3908 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
3910 if (it
->current
.overlay_string_index
&& i
== 0)
3911 load_overlay_strings (it
, 0);
3913 /* Initialize IT to deliver display elements from the overlay
3915 it
->string
= it
->overlay_strings
[i
];
3916 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
3917 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
3918 it
->method
= next_element_from_string
;
3919 it
->stop_charpos
= 0;
3926 /* Compare two overlay_entry structures E1 and E2. Used as a
3927 comparison function for qsort in load_overlay_strings. Overlay
3928 strings for the same position are sorted so that
3930 1. All after-strings come in front of before-strings, except
3931 when they come from the same overlay.
3933 2. Within after-strings, strings are sorted so that overlay strings
3934 from overlays with higher priorities come first.
3936 2. Within before-strings, strings are sorted so that overlay
3937 strings from overlays with higher priorities come last.
3939 Value is analogous to strcmp. */
3943 compare_overlay_entries (e1
, e2
)
3946 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
3947 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
3950 if (entry1
->after_string_p
!= entry2
->after_string_p
)
3952 /* Let after-strings appear in front of before-strings if
3953 they come from different overlays. */
3954 if (EQ (entry1
->overlay
, entry2
->overlay
))
3955 result
= entry1
->after_string_p
? 1 : -1;
3957 result
= entry1
->after_string_p
? -1 : 1;
3959 else if (entry1
->after_string_p
)
3960 /* After-strings sorted in order of decreasing priority. */
3961 result
= entry2
->priority
- entry1
->priority
;
3963 /* Before-strings sorted in order of increasing priority. */
3964 result
= entry1
->priority
- entry2
->priority
;
3970 /* Load the vector IT->overlay_strings with overlay strings from IT's
3971 current buffer position, or from CHARPOS if that is > 0. Set
3972 IT->n_overlays to the total number of overlay strings found.
3974 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
3975 a time. On entry into load_overlay_strings,
3976 IT->current.overlay_string_index gives the number of overlay
3977 strings that have already been loaded by previous calls to this
3980 IT->add_overlay_start contains an additional overlay start
3981 position to consider for taking overlay strings from, if non-zero.
3982 This position comes into play when the overlay has an `invisible'
3983 property, and both before and after-strings. When we've skipped to
3984 the end of the overlay, because of its `invisible' property, we
3985 nevertheless want its before-string to appear.
3986 IT->add_overlay_start will contain the overlay start position
3989 Overlay strings are sorted so that after-string strings come in
3990 front of before-string strings. Within before and after-strings,
3991 strings are sorted by overlay priority. See also function
3992 compare_overlay_entries. */
3995 load_overlay_strings (it
, charpos
)
3999 extern Lisp_Object Qafter_string
, Qbefore_string
, Qwindow
, Qpriority
;
4000 Lisp_Object overlay
, window
, str
, invisible
;
4001 struct Lisp_Overlay
*ov
;
4004 int n
= 0, i
, j
, invis_p
;
4005 struct overlay_entry
*entries
4006 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
4009 charpos
= IT_CHARPOS (*it
);
4011 /* Append the overlay string STRING of overlay OVERLAY to vector
4012 `entries' which has size `size' and currently contains `n'
4013 elements. AFTER_P non-zero means STRING is an after-string of
4015 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
4018 Lisp_Object priority; \
4022 int new_size = 2 * size; \
4023 struct overlay_entry *old = entries; \
4025 (struct overlay_entry *) alloca (new_size \
4026 * sizeof *entries); \
4027 bcopy (old, entries, size * sizeof *entries); \
4031 entries[n].string = (STRING); \
4032 entries[n].overlay = (OVERLAY); \
4033 priority = Foverlay_get ((OVERLAY), Qpriority); \
4034 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
4035 entries[n].after_string_p = (AFTER_P); \
4040 /* Process overlay before the overlay center. */
4041 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
4043 XSETMISC (overlay
, ov
);
4044 xassert (OVERLAYP (overlay
));
4045 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4046 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4051 /* Skip this overlay if it doesn't start or end at IT's current
4053 if (end
!= charpos
&& start
!= charpos
)
4056 /* Skip this overlay if it doesn't apply to IT->w. */
4057 window
= Foverlay_get (overlay
, Qwindow
);
4058 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4061 /* If the text ``under'' the overlay is invisible, both before-
4062 and after-strings from this overlay are visible; start and
4063 end position are indistinguishable. */
4064 invisible
= Foverlay_get (overlay
, Qinvisible
);
4065 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4067 /* If overlay has a non-empty before-string, record it. */
4068 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4069 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4071 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4073 /* If overlay has a non-empty after-string, record it. */
4074 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4075 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4077 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4080 /* Process overlays after the overlay center. */
4081 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
4083 XSETMISC (overlay
, ov
);
4084 xassert (OVERLAYP (overlay
));
4085 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4086 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4088 if (start
> charpos
)
4091 /* Skip this overlay if it doesn't start or end at IT's current
4093 if (end
!= charpos
&& start
!= charpos
)
4096 /* Skip this overlay if it doesn't apply to IT->w. */
4097 window
= Foverlay_get (overlay
, Qwindow
);
4098 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4101 /* If the text ``under'' the overlay is invisible, it has a zero
4102 dimension, and both before- and after-strings apply. */
4103 invisible
= Foverlay_get (overlay
, Qinvisible
);
4104 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4106 /* If overlay has a non-empty before-string, record it. */
4107 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4108 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4110 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4112 /* If overlay has a non-empty after-string, record it. */
4113 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4114 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4116 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4119 #undef RECORD_OVERLAY_STRING
4123 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
4125 /* Record the total number of strings to process. */
4126 it
->n_overlay_strings
= n
;
4128 /* IT->current.overlay_string_index is the number of overlay strings
4129 that have already been consumed by IT. Copy some of the
4130 remaining overlay strings to IT->overlay_strings. */
4132 j
= it
->current
.overlay_string_index
;
4133 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
4134 it
->overlay_strings
[i
++] = entries
[j
++].string
;
4140 /* Get the first chunk of overlay strings at IT's current buffer
4141 position, or at CHARPOS if that is > 0. Value is non-zero if at
4142 least one overlay string was found. */
4145 get_overlay_strings (it
, charpos
)
4149 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
4150 process. This fills IT->overlay_strings with strings, and sets
4151 IT->n_overlay_strings to the total number of strings to process.
4152 IT->pos.overlay_string_index has to be set temporarily to zero
4153 because load_overlay_strings needs this; it must be set to -1
4154 when no overlay strings are found because a zero value would
4155 indicate a position in the first overlay string. */
4156 it
->current
.overlay_string_index
= 0;
4157 load_overlay_strings (it
, charpos
);
4159 /* If we found overlay strings, set up IT to deliver display
4160 elements from the first one. Otherwise set up IT to deliver
4161 from current_buffer. */
4162 if (it
->n_overlay_strings
)
4164 /* Make sure we know settings in current_buffer, so that we can
4165 restore meaningful values when we're done with the overlay
4167 compute_stop_pos (it
);
4168 xassert (it
->face_id
>= 0);
4170 /* Save IT's settings. They are restored after all overlay
4171 strings have been processed. */
4172 xassert (it
->sp
== 0);
4175 /* Set up IT to deliver display elements from the first overlay
4177 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4178 it
->string
= it
->overlay_strings
[0];
4179 it
->stop_charpos
= 0;
4180 xassert (STRINGP (it
->string
));
4181 it
->end_charpos
= SCHARS (it
->string
);
4182 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4183 it
->method
= next_element_from_string
;
4188 it
->current
.overlay_string_index
= -1;
4189 it
->method
= next_element_from_buffer
;
4194 /* Value is non-zero if we found at least one overlay string. */
4195 return STRINGP (it
->string
);
4200 /***********************************************************************
4201 Saving and restoring state
4202 ***********************************************************************/
4204 /* Save current settings of IT on IT->stack. Called, for example,
4205 before setting up IT for an overlay string, to be able to restore
4206 IT's settings to what they were after the overlay string has been
4213 struct iterator_stack_entry
*p
;
4215 xassert (it
->sp
< 2);
4216 p
= it
->stack
+ it
->sp
;
4218 p
->stop_charpos
= it
->stop_charpos
;
4219 xassert (it
->face_id
>= 0);
4220 p
->face_id
= it
->face_id
;
4221 p
->string
= it
->string
;
4222 p
->pos
= it
->current
;
4223 p
->end_charpos
= it
->end_charpos
;
4224 p
->string_nchars
= it
->string_nchars
;
4226 p
->multibyte_p
= it
->multibyte_p
;
4227 p
->space_width
= it
->space_width
;
4228 p
->font_height
= it
->font_height
;
4229 p
->voffset
= it
->voffset
;
4230 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
4231 p
->display_ellipsis_p
= 0;
4236 /* Restore IT's settings from IT->stack. Called, for example, when no
4237 more overlay strings must be processed, and we return to delivering
4238 display elements from a buffer, or when the end of a string from a
4239 `display' property is reached and we return to delivering display
4240 elements from an overlay string, or from a buffer. */
4246 struct iterator_stack_entry
*p
;
4248 xassert (it
->sp
> 0);
4250 p
= it
->stack
+ it
->sp
;
4251 it
->stop_charpos
= p
->stop_charpos
;
4252 it
->face_id
= p
->face_id
;
4253 it
->string
= p
->string
;
4254 it
->current
= p
->pos
;
4255 it
->end_charpos
= p
->end_charpos
;
4256 it
->string_nchars
= p
->string_nchars
;
4258 it
->multibyte_p
= p
->multibyte_p
;
4259 it
->space_width
= p
->space_width
;
4260 it
->font_height
= p
->font_height
;
4261 it
->voffset
= p
->voffset
;
4262 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
4267 /***********************************************************************
4269 ***********************************************************************/
4271 /* Set IT's current position to the previous line start. */
4274 back_to_previous_line_start (it
)
4277 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
4278 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
4282 /* Move IT to the next line start.
4284 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
4285 we skipped over part of the text (as opposed to moving the iterator
4286 continuously over the text). Otherwise, don't change the value
4289 Newlines may come from buffer text, overlay strings, or strings
4290 displayed via the `display' property. That's the reason we can't
4291 simply use find_next_newline_no_quit.
4293 Note that this function may not skip over invisible text that is so
4294 because of text properties and immediately follows a newline. If
4295 it would, function reseat_at_next_visible_line_start, when called
4296 from set_iterator_to_next, would effectively make invisible
4297 characters following a newline part of the wrong glyph row, which
4298 leads to wrong cursor motion. */
4301 forward_to_next_line_start (it
, skipped_p
)
4305 int old_selective
, newline_found_p
, n
;
4306 const int MAX_NEWLINE_DISTANCE
= 500;
4308 /* If already on a newline, just consume it to avoid unintended
4309 skipping over invisible text below. */
4310 if (it
->what
== IT_CHARACTER
4312 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
4314 set_iterator_to_next (it
, 0);
4319 /* Don't handle selective display in the following. It's (a)
4320 unnecessary because it's done by the caller, and (b) leads to an
4321 infinite recursion because next_element_from_ellipsis indirectly
4322 calls this function. */
4323 old_selective
= it
->selective
;
4326 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
4327 from buffer text. */
4328 for (n
= newline_found_p
= 0;
4329 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
4330 n
+= STRINGP (it
->string
) ? 0 : 1)
4332 if (!get_next_display_element (it
))
4334 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
4335 set_iterator_to_next (it
, 0);
4338 /* If we didn't find a newline near enough, see if we can use a
4340 if (!newline_found_p
)
4342 int start
= IT_CHARPOS (*it
);
4343 int limit
= find_next_newline_no_quit (start
, 1);
4346 xassert (!STRINGP (it
->string
));
4348 /* If there isn't any `display' property in sight, and no
4349 overlays, we can just use the position of the newline in
4351 if (it
->stop_charpos
>= limit
4352 || ((pos
= Fnext_single_property_change (make_number (start
),
4354 Qnil
, make_number (limit
)),
4356 && next_overlay_change (start
) == ZV
))
4358 IT_CHARPOS (*it
) = limit
;
4359 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
4360 *skipped_p
= newline_found_p
= 1;
4364 while (get_next_display_element (it
)
4365 && !newline_found_p
)
4367 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
4368 set_iterator_to_next (it
, 0);
4373 it
->selective
= old_selective
;
4374 return newline_found_p
;
4378 /* Set IT's current position to the previous visible line start. Skip
4379 invisible text that is so either due to text properties or due to
4380 selective display. Caution: this does not change IT->current_x and
4384 back_to_previous_visible_line_start (it
)
4389 /* Go back one newline if not on BEGV already. */
4390 if (IT_CHARPOS (*it
) > BEGV
)
4391 back_to_previous_line_start (it
);
4393 /* Move over lines that are invisible because of selective display
4394 or text properties. */
4395 while (IT_CHARPOS (*it
) > BEGV
4400 /* If selective > 0, then lines indented more than that values
4402 if (it
->selective
> 0
4403 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
4404 (double) it
->selective
)) /* iftc */
4410 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
)),
4411 Qinvisible
, it
->window
);
4412 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
4416 /* Back one more newline if the current one is invisible. */
4418 back_to_previous_line_start (it
);
4421 xassert (IT_CHARPOS (*it
) >= BEGV
);
4422 xassert (IT_CHARPOS (*it
) == BEGV
4423 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
4428 /* Reseat iterator IT at the previous visible line start. Skip
4429 invisible text that is so either due to text properties or due to
4430 selective display. At the end, update IT's overlay information,
4431 face information etc. */
4434 reseat_at_previous_visible_line_start (it
)
4437 back_to_previous_visible_line_start (it
);
4438 reseat (it
, it
->current
.pos
, 1);
4443 /* Reseat iterator IT on the next visible line start in the current
4444 buffer. ON_NEWLINE_P non-zero means position IT on the newline
4445 preceding the line start. Skip over invisible text that is so
4446 because of selective display. Compute faces, overlays etc at the
4447 new position. Note that this function does not skip over text that
4448 is invisible because of text properties. */
4451 reseat_at_next_visible_line_start (it
, on_newline_p
)
4455 int newline_found_p
, skipped_p
= 0;
4457 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
4459 /* Skip over lines that are invisible because they are indented
4460 more than the value of IT->selective. */
4461 if (it
->selective
> 0)
4462 while (IT_CHARPOS (*it
) < ZV
4463 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
4464 (double) it
->selective
)) /* iftc */
4466 xassert (FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
4467 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
4470 /* Position on the newline if that's what's requested. */
4471 if (on_newline_p
&& newline_found_p
)
4473 if (STRINGP (it
->string
))
4475 if (IT_STRING_CHARPOS (*it
) > 0)
4477 --IT_STRING_CHARPOS (*it
);
4478 --IT_STRING_BYTEPOS (*it
);
4481 else if (IT_CHARPOS (*it
) > BEGV
)
4485 reseat (it
, it
->current
.pos
, 0);
4489 reseat (it
, it
->current
.pos
, 0);
4496 /***********************************************************************
4497 Changing an iterator's position
4498 ***********************************************************************/
4500 /* Change IT's current position to POS in current_buffer. If FORCE_P
4501 is non-zero, always check for text properties at the new position.
4502 Otherwise, text properties are only looked up if POS >=
4503 IT->check_charpos of a property. */
4506 reseat (it
, pos
, force_p
)
4508 struct text_pos pos
;
4511 int original_pos
= IT_CHARPOS (*it
);
4513 reseat_1 (it
, pos
, 0);
4515 /* Determine where to check text properties. Avoid doing it
4516 where possible because text property lookup is very expensive. */
4518 || CHARPOS (pos
) > it
->stop_charpos
4519 || CHARPOS (pos
) < original_pos
)
4526 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
4527 IT->stop_pos to POS, also. */
4530 reseat_1 (it
, pos
, set_stop_p
)
4532 struct text_pos pos
;
4535 /* Don't call this function when scanning a C string. */
4536 xassert (it
->s
== NULL
);
4538 /* POS must be a reasonable value. */
4539 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
4541 it
->current
.pos
= it
->position
= pos
;
4542 XSETBUFFER (it
->object
, current_buffer
);
4543 it
->end_charpos
= ZV
;
4545 it
->current
.dpvec_index
= -1;
4546 it
->current
.overlay_string_index
= -1;
4547 IT_STRING_CHARPOS (*it
) = -1;
4548 IT_STRING_BYTEPOS (*it
) = -1;
4550 it
->method
= next_element_from_buffer
;
4551 /* RMS: I added this to fix a bug in move_it_vertically_backward
4552 where it->area continued to relate to the starting point
4553 for the backward motion. Bug report from
4554 Nick Roberts <nick@nick.uklinux.net> on 19 May 2003.
4555 However, I am not sure whether reseat still does the right thing
4556 in general after this change. */
4557 it
->area
= TEXT_AREA
;
4558 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
4560 it
->face_before_selective_p
= 0;
4563 it
->stop_charpos
= CHARPOS (pos
);
4567 /* Set up IT for displaying a string, starting at CHARPOS in window W.
4568 If S is non-null, it is a C string to iterate over. Otherwise,
4569 STRING gives a Lisp string to iterate over.
4571 If PRECISION > 0, don't return more then PRECISION number of
4572 characters from the string.
4574 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
4575 characters have been returned. FIELD_WIDTH < 0 means an infinite
4578 MULTIBYTE = 0 means disable processing of multibyte characters,
4579 MULTIBYTE > 0 means enable it,
4580 MULTIBYTE < 0 means use IT->multibyte_p.
4582 IT must be initialized via a prior call to init_iterator before
4583 calling this function. */
4586 reseat_to_string (it
, s
, string
, charpos
, precision
, field_width
, multibyte
)
4591 int precision
, field_width
, multibyte
;
4593 /* No region in strings. */
4594 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
4596 /* No text property checks performed by default, but see below. */
4597 it
->stop_charpos
= -1;
4599 /* Set iterator position and end position. */
4600 bzero (&it
->current
, sizeof it
->current
);
4601 it
->current
.overlay_string_index
= -1;
4602 it
->current
.dpvec_index
= -1;
4603 xassert (charpos
>= 0);
4605 /* If STRING is specified, use its multibyteness, otherwise use the
4606 setting of MULTIBYTE, if specified. */
4608 it
->multibyte_p
= multibyte
> 0;
4612 xassert (STRINGP (string
));
4613 it
->string
= string
;
4615 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
4616 it
->method
= next_element_from_string
;
4617 it
->current
.string_pos
= string_pos (charpos
, string
);
4624 /* Note that we use IT->current.pos, not it->current.string_pos,
4625 for displaying C strings. */
4626 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
4627 if (it
->multibyte_p
)
4629 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
4630 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
4634 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
4635 it
->end_charpos
= it
->string_nchars
= strlen (s
);
4638 it
->method
= next_element_from_c_string
;
4641 /* PRECISION > 0 means don't return more than PRECISION characters
4643 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
4644 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
4646 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
4647 characters have been returned. FIELD_WIDTH == 0 means don't pad,
4648 FIELD_WIDTH < 0 means infinite field width. This is useful for
4649 padding with `-' at the end of a mode line. */
4650 if (field_width
< 0)
4651 field_width
= INFINITY
;
4652 if (field_width
> it
->end_charpos
- charpos
)
4653 it
->end_charpos
= charpos
+ field_width
;
4655 /* Use the standard display table for displaying strings. */
4656 if (DISP_TABLE_P (Vstandard_display_table
))
4657 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
4659 it
->stop_charpos
= charpos
;
4665 /***********************************************************************
4667 ***********************************************************************/
4669 /* Load IT's display element fields with information about the next
4670 display element from the current position of IT. Value is zero if
4671 end of buffer (or C string) is reached. */
4674 get_next_display_element (it
)
4677 /* Non-zero means that we found a display element. Zero means that
4678 we hit the end of what we iterate over. Performance note: the
4679 function pointer `method' used here turns out to be faster than
4680 using a sequence of if-statements. */
4681 int success_p
= (*it
->method
) (it
);
4683 if (it
->what
== IT_CHARACTER
)
4685 /* Map via display table or translate control characters.
4686 IT->c, IT->len etc. have been set to the next character by
4687 the function call above. If we have a display table, and it
4688 contains an entry for IT->c, translate it. Don't do this if
4689 IT->c itself comes from a display table, otherwise we could
4690 end up in an infinite recursion. (An alternative could be to
4691 count the recursion depth of this function and signal an
4692 error when a certain maximum depth is reached.) Is it worth
4694 if (success_p
&& it
->dpvec
== NULL
)
4699 && (dv
= DISP_CHAR_VECTOR (it
->dp
, it
->c
),
4702 struct Lisp_Vector
*v
= XVECTOR (dv
);
4704 /* Return the first character from the display table
4705 entry, if not empty. If empty, don't display the
4706 current character. */
4709 it
->dpvec_char_len
= it
->len
;
4710 it
->dpvec
= v
->contents
;
4711 it
->dpend
= v
->contents
+ v
->size
;
4712 it
->current
.dpvec_index
= 0;
4713 it
->method
= next_element_from_display_vector
;
4714 success_p
= get_next_display_element (it
);
4718 set_iterator_to_next (it
, 0);
4719 success_p
= get_next_display_element (it
);
4723 /* Translate control characters into `\003' or `^C' form.
4724 Control characters coming from a display table entry are
4725 currently not translated because we use IT->dpvec to hold
4726 the translation. This could easily be changed but I
4727 don't believe that it is worth doing.
4729 If it->multibyte_p is nonzero, eight-bit characters and
4730 non-printable multibyte characters are also translated to
4733 If it->multibyte_p is zero, eight-bit characters that
4734 don't have corresponding multibyte char code are also
4735 translated to octal form. */
4736 else if ((it
->c
< ' '
4737 && (it
->area
!= TEXT_AREA
4738 || (it
->c
!= '\n' && it
->c
!= '\t')))
4742 || !CHAR_PRINTABLE_P (it
->c
))
4744 && it
->c
== unibyte_char_to_multibyte (it
->c
))))
4746 /* IT->c is a control character which must be displayed
4747 either as '\003' or as `^C' where the '\\' and '^'
4748 can be defined in the display table. Fill
4749 IT->ctl_chars with glyphs for what we have to
4750 display. Then, set IT->dpvec to these glyphs. */
4753 if (it
->c
< 128 && it
->ctl_arrow_p
)
4755 /* Set IT->ctl_chars[0] to the glyph for `^'. */
4757 && INTEGERP (DISP_CTRL_GLYPH (it
->dp
))
4758 && GLYPH_CHAR_VALID_P (XINT (DISP_CTRL_GLYPH (it
->dp
))))
4759 g
= XINT (DISP_CTRL_GLYPH (it
->dp
));
4761 g
= FAST_MAKE_GLYPH ('^', 0);
4762 XSETINT (it
->ctl_chars
[0], g
);
4764 g
= FAST_MAKE_GLYPH (it
->c
^ 0100, 0);
4765 XSETINT (it
->ctl_chars
[1], g
);
4767 /* Set up IT->dpvec and return first character from it. */
4768 it
->dpvec_char_len
= it
->len
;
4769 it
->dpvec
= it
->ctl_chars
;
4770 it
->dpend
= it
->dpvec
+ 2;
4771 it
->current
.dpvec_index
= 0;
4772 it
->method
= next_element_from_display_vector
;
4773 get_next_display_element (it
);
4777 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
4782 /* Set IT->ctl_chars[0] to the glyph for `\\'. */
4784 && INTEGERP (DISP_ESCAPE_GLYPH (it
->dp
))
4785 && GLYPH_CHAR_VALID_P (XFASTINT (DISP_ESCAPE_GLYPH (it
->dp
))))
4786 escape_glyph
= XFASTINT (DISP_ESCAPE_GLYPH (it
->dp
));
4788 escape_glyph
= FAST_MAKE_GLYPH ('\\', 0);
4790 if (SINGLE_BYTE_CHAR_P (it
->c
))
4791 str
[0] = it
->c
, len
= 1;
4794 len
= CHAR_STRING_NO_SIGNAL (it
->c
, str
);
4797 /* It's an invalid character, which
4798 shouldn't happen actually, but due to
4799 bugs it may happen. Let's print the char
4800 as is, there's not much meaningful we can
4803 str
[1] = it
->c
>> 8;
4804 str
[2] = it
->c
>> 16;
4805 str
[3] = it
->c
>> 24;
4810 for (i
= 0; i
< len
; i
++)
4812 XSETINT (it
->ctl_chars
[i
* 4], escape_glyph
);
4813 /* Insert three more glyphs into IT->ctl_chars for
4814 the octal display of the character. */
4815 g
= FAST_MAKE_GLYPH (((str
[i
] >> 6) & 7) + '0', 0);
4816 XSETINT (it
->ctl_chars
[i
* 4 + 1], g
);
4817 g
= FAST_MAKE_GLYPH (((str
[i
] >> 3) & 7) + '0', 0);
4818 XSETINT (it
->ctl_chars
[i
* 4 + 2], g
);
4819 g
= FAST_MAKE_GLYPH ((str
[i
] & 7) + '0', 0);
4820 XSETINT (it
->ctl_chars
[i
* 4 + 3], g
);
4823 /* Set up IT->dpvec and return the first character
4825 it
->dpvec_char_len
= it
->len
;
4826 it
->dpvec
= it
->ctl_chars
;
4827 it
->dpend
= it
->dpvec
+ len
* 4;
4828 it
->current
.dpvec_index
= 0;
4829 it
->method
= next_element_from_display_vector
;
4830 get_next_display_element (it
);
4835 /* Adjust face id for a multibyte character. There are no
4836 multibyte character in unibyte text. */
4839 && FRAME_WINDOW_P (it
->f
))
4841 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4842 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->c
);
4846 /* Is this character the last one of a run of characters with
4847 box? If yes, set IT->end_of_box_run_p to 1. */
4854 it
->end_of_box_run_p
4855 = ((face_id
= face_after_it_pos (it
),
4856 face_id
!= it
->face_id
)
4857 && (face
= FACE_FROM_ID (it
->f
, face_id
),
4858 face
->box
== FACE_NO_BOX
));
4861 /* Value is 0 if end of buffer or string reached. */
4866 /* Move IT to the next display element.
4868 RESEAT_P non-zero means if called on a newline in buffer text,
4869 skip to the next visible line start.
4871 Functions get_next_display_element and set_iterator_to_next are
4872 separate because I find this arrangement easier to handle than a
4873 get_next_display_element function that also increments IT's
4874 position. The way it is we can first look at an iterator's current
4875 display element, decide whether it fits on a line, and if it does,
4876 increment the iterator position. The other way around we probably
4877 would either need a flag indicating whether the iterator has to be
4878 incremented the next time, or we would have to implement a
4879 decrement position function which would not be easy to write. */
4882 set_iterator_to_next (it
, reseat_p
)
4886 /* Reset flags indicating start and end of a sequence of characters
4887 with box. Reset them at the start of this function because
4888 moving the iterator to a new position might set them. */
4889 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
4891 if (it
->method
== next_element_from_buffer
)
4893 /* The current display element of IT is a character from
4894 current_buffer. Advance in the buffer, and maybe skip over
4895 invisible lines that are so because of selective display. */
4896 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
4897 reseat_at_next_visible_line_start (it
, 0);
4900 xassert (it
->len
!= 0);
4901 IT_BYTEPOS (*it
) += it
->len
;
4902 IT_CHARPOS (*it
) += 1;
4903 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
4906 else if (it
->method
== next_element_from_composition
)
4908 xassert (it
->cmp_id
>= 0 && it
->cmp_id
< n_compositions
);
4909 if (STRINGP (it
->string
))
4911 IT_STRING_BYTEPOS (*it
) += it
->len
;
4912 IT_STRING_CHARPOS (*it
) += it
->cmp_len
;
4913 it
->method
= next_element_from_string
;
4914 goto consider_string_end
;
4918 IT_BYTEPOS (*it
) += it
->len
;
4919 IT_CHARPOS (*it
) += it
->cmp_len
;
4920 it
->method
= next_element_from_buffer
;
4923 else if (it
->method
== next_element_from_c_string
)
4925 /* Current display element of IT is from a C string. */
4926 IT_BYTEPOS (*it
) += it
->len
;
4927 IT_CHARPOS (*it
) += 1;
4929 else if (it
->method
== next_element_from_display_vector
)
4931 /* Current display element of IT is from a display table entry.
4932 Advance in the display table definition. Reset it to null if
4933 end reached, and continue with characters from buffers/
4935 ++it
->current
.dpvec_index
;
4937 /* Restore face of the iterator to what they were before the
4938 display vector entry (these entries may contain faces). */
4939 it
->face_id
= it
->saved_face_id
;
4941 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
4944 it
->method
= next_element_from_c_string
;
4945 else if (STRINGP (it
->string
))
4946 it
->method
= next_element_from_string
;
4948 it
->method
= next_element_from_buffer
;
4951 it
->current
.dpvec_index
= -1;
4953 /* Skip over characters which were displayed via IT->dpvec. */
4954 if (it
->dpvec_char_len
< 0)
4955 reseat_at_next_visible_line_start (it
, 1);
4956 else if (it
->dpvec_char_len
> 0)
4958 it
->len
= it
->dpvec_char_len
;
4959 set_iterator_to_next (it
, reseat_p
);
4963 else if (it
->method
== next_element_from_string
)
4965 /* Current display element is a character from a Lisp string. */
4966 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
4967 IT_STRING_BYTEPOS (*it
) += it
->len
;
4968 IT_STRING_CHARPOS (*it
) += 1;
4970 consider_string_end
:
4972 if (it
->current
.overlay_string_index
>= 0)
4974 /* IT->string is an overlay string. Advance to the
4975 next, if there is one. */
4976 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
4977 next_overlay_string (it
);
4981 /* IT->string is not an overlay string. If we reached
4982 its end, and there is something on IT->stack, proceed
4983 with what is on the stack. This can be either another
4984 string, this time an overlay string, or a buffer. */
4985 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
4989 if (!STRINGP (it
->string
))
4990 it
->method
= next_element_from_buffer
;
4992 goto consider_string_end
;
4996 else if (it
->method
== next_element_from_image
4997 || it
->method
== next_element_from_stretch
)
4999 /* The position etc with which we have to proceed are on
5000 the stack. The position may be at the end of a string,
5001 if the `display' property takes up the whole string. */
5004 if (STRINGP (it
->string
))
5006 it
->method
= next_element_from_string
;
5007 goto consider_string_end
;
5010 it
->method
= next_element_from_buffer
;
5013 /* There are no other methods defined, so this should be a bug. */
5016 xassert (it
->method
!= next_element_from_string
5017 || (STRINGP (it
->string
)
5018 && IT_STRING_CHARPOS (*it
) >= 0));
5022 /* Load IT's display element fields with information about the next
5023 display element which comes from a display table entry or from the
5024 result of translating a control character to one of the forms `^C'
5025 or `\003'. IT->dpvec holds the glyphs to return as characters. */
5028 next_element_from_display_vector (it
)
5032 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
5034 /* Remember the current face id in case glyphs specify faces.
5035 IT's face is restored in set_iterator_to_next. */
5036 it
->saved_face_id
= it
->face_id
;
5038 if (INTEGERP (*it
->dpvec
)
5039 && GLYPH_CHAR_VALID_P (XFASTINT (*it
->dpvec
)))
5044 g
= XFASTINT (it
->dpvec
[it
->current
.dpvec_index
]);
5045 it
->c
= FAST_GLYPH_CHAR (g
);
5046 it
->len
= CHAR_BYTES (it
->c
);
5048 /* The entry may contain a face id to use. Such a face id is
5049 the id of a Lisp face, not a realized face. A face id of
5050 zero means no face is specified. */
5051 lface_id
= FAST_GLYPH_FACE (g
);
5054 /* The function returns -1 if lface_id is invalid. */
5055 int face_id
= ascii_face_of_lisp_face (it
->f
, lface_id
);
5057 it
->face_id
= face_id
;
5061 /* Display table entry is invalid. Return a space. */
5062 it
->c
= ' ', it
->len
= 1;
5064 /* Don't change position and object of the iterator here. They are
5065 still the values of the character that had this display table
5066 entry or was translated, and that's what we want. */
5067 it
->what
= IT_CHARACTER
;
5072 /* Load IT with the next display element from Lisp string IT->string.
5073 IT->current.string_pos is the current position within the string.
5074 If IT->current.overlay_string_index >= 0, the Lisp string is an
5078 next_element_from_string (it
)
5081 struct text_pos position
;
5083 xassert (STRINGP (it
->string
));
5084 xassert (IT_STRING_CHARPOS (*it
) >= 0);
5085 position
= it
->current
.string_pos
;
5087 /* Time to check for invisible text? */
5088 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
5089 && IT_STRING_CHARPOS (*it
) == it
->stop_charpos
)
5093 /* Since a handler may have changed IT->method, we must
5095 return get_next_display_element (it
);
5098 if (it
->current
.overlay_string_index
>= 0)
5100 /* Get the next character from an overlay string. In overlay
5101 strings, There is no field width or padding with spaces to
5103 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
5108 else if (STRING_MULTIBYTE (it
->string
))
5110 int remaining
= SBYTES (it
->string
) - IT_STRING_BYTEPOS (*it
);
5111 const unsigned char *s
= (SDATA (it
->string
)
5112 + IT_STRING_BYTEPOS (*it
));
5113 it
->c
= string_char_and_length (s
, remaining
, &it
->len
);
5117 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
5123 /* Get the next character from a Lisp string that is not an
5124 overlay string. Such strings come from the mode line, for
5125 example. We may have to pad with spaces, or truncate the
5126 string. See also next_element_from_c_string. */
5127 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
5132 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
5134 /* Pad with spaces. */
5135 it
->c
= ' ', it
->len
= 1;
5136 CHARPOS (position
) = BYTEPOS (position
) = -1;
5138 else if (STRING_MULTIBYTE (it
->string
))
5140 int maxlen
= SBYTES (it
->string
) - IT_STRING_BYTEPOS (*it
);
5141 const unsigned char *s
= (SDATA (it
->string
)
5142 + IT_STRING_BYTEPOS (*it
));
5143 it
->c
= string_char_and_length (s
, maxlen
, &it
->len
);
5147 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
5152 /* Record what we have and where it came from. Note that we store a
5153 buffer position in IT->position although it could arguably be a
5155 it
->what
= IT_CHARACTER
;
5156 it
->object
= it
->string
;
5157 it
->position
= position
;
5162 /* Load IT with next display element from C string IT->s.
5163 IT->string_nchars is the maximum number of characters to return
5164 from the string. IT->end_charpos may be greater than
5165 IT->string_nchars when this function is called, in which case we
5166 may have to return padding spaces. Value is zero if end of string
5167 reached, including padding spaces. */
5170 next_element_from_c_string (it
)
5176 it
->what
= IT_CHARACTER
;
5177 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
5180 /* IT's position can be greater IT->string_nchars in case a field
5181 width or precision has been specified when the iterator was
5183 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
5185 /* End of the game. */
5189 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
5191 /* Pad with spaces. */
5192 it
->c
= ' ', it
->len
= 1;
5193 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
5195 else if (it
->multibyte_p
)
5197 /* Implementation note: The calls to strlen apparently aren't a
5198 performance problem because there is no noticeable performance
5199 difference between Emacs running in unibyte or multibyte mode. */
5200 int maxlen
= strlen (it
->s
) - IT_BYTEPOS (*it
);
5201 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
),
5205 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
5211 /* Set up IT to return characters from an ellipsis, if appropriate.
5212 The definition of the ellipsis glyphs may come from a display table
5213 entry. This function Fills IT with the first glyph from the
5214 ellipsis if an ellipsis is to be displayed. */
5217 next_element_from_ellipsis (it
)
5220 if (it
->selective_display_ellipsis_p
)
5222 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
5224 /* Use the display table definition for `...'. Invalid glyphs
5225 will be handled by the method returning elements from dpvec. */
5226 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
5227 it
->dpvec_char_len
= it
->len
;
5228 it
->dpvec
= v
->contents
;
5229 it
->dpend
= v
->contents
+ v
->size
;
5230 it
->current
.dpvec_index
= 0;
5231 it
->method
= next_element_from_display_vector
;
5235 /* Use default `...' which is stored in default_invis_vector. */
5236 it
->dpvec_char_len
= it
->len
;
5237 it
->dpvec
= default_invis_vector
;
5238 it
->dpend
= default_invis_vector
+ 3;
5239 it
->current
.dpvec_index
= 0;
5240 it
->method
= next_element_from_display_vector
;
5245 /* The face at the current position may be different from the
5246 face we find after the invisible text. Remember what it
5247 was in IT->saved_face_id, and signal that it's there by
5248 setting face_before_selective_p. */
5249 it
->saved_face_id
= it
->face_id
;
5250 it
->method
= next_element_from_buffer
;
5251 reseat_at_next_visible_line_start (it
, 1);
5252 it
->face_before_selective_p
= 1;
5255 return get_next_display_element (it
);
5259 /* Deliver an image display element. The iterator IT is already
5260 filled with image information (done in handle_display_prop). Value
5265 next_element_from_image (it
)
5268 it
->what
= IT_IMAGE
;
5273 /* Fill iterator IT with next display element from a stretch glyph
5274 property. IT->object is the value of the text property. Value is
5278 next_element_from_stretch (it
)
5281 it
->what
= IT_STRETCH
;
5286 /* Load IT with the next display element from current_buffer. Value
5287 is zero if end of buffer reached. IT->stop_charpos is the next
5288 position at which to stop and check for text properties or buffer
5292 next_element_from_buffer (it
)
5297 /* Check this assumption, otherwise, we would never enter the
5298 if-statement, below. */
5299 xassert (IT_CHARPOS (*it
) >= BEGV
5300 && IT_CHARPOS (*it
) <= it
->stop_charpos
);
5302 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
5304 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
5306 int overlay_strings_follow_p
;
5308 /* End of the game, except when overlay strings follow that
5309 haven't been returned yet. */
5310 if (it
->overlay_strings_at_end_processed_p
)
5311 overlay_strings_follow_p
= 0;
5314 it
->overlay_strings_at_end_processed_p
= 1;
5315 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
5318 if (overlay_strings_follow_p
)
5319 success_p
= get_next_display_element (it
);
5323 it
->position
= it
->current
.pos
;
5330 return get_next_display_element (it
);
5335 /* No face changes, overlays etc. in sight, so just return a
5336 character from current_buffer. */
5339 /* Maybe run the redisplay end trigger hook. Performance note:
5340 This doesn't seem to cost measurable time. */
5341 if (it
->redisplay_end_trigger_charpos
5343 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
5344 run_redisplay_end_trigger_hook (it
);
5346 /* Get the next character, maybe multibyte. */
5347 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
5348 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
5350 int maxlen
= ((IT_BYTEPOS (*it
) >= GPT_BYTE
? ZV_BYTE
: GPT_BYTE
)
5351 - IT_BYTEPOS (*it
));
5352 it
->c
= string_char_and_length (p
, maxlen
, &it
->len
);
5355 it
->c
= *p
, it
->len
= 1;
5357 /* Record what we have and where it came from. */
5358 it
->what
= IT_CHARACTER
;;
5359 it
->object
= it
->w
->buffer
;
5360 it
->position
= it
->current
.pos
;
5362 /* Normally we return the character found above, except when we
5363 really want to return an ellipsis for selective display. */
5368 /* A value of selective > 0 means hide lines indented more
5369 than that number of columns. */
5370 if (it
->selective
> 0
5371 && IT_CHARPOS (*it
) + 1 < ZV
5372 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
5373 IT_BYTEPOS (*it
) + 1,
5374 (double) it
->selective
)) /* iftc */
5376 success_p
= next_element_from_ellipsis (it
);
5377 it
->dpvec_char_len
= -1;
5380 else if (it
->c
== '\r' && it
->selective
== -1)
5382 /* A value of selective == -1 means that everything from the
5383 CR to the end of the line is invisible, with maybe an
5384 ellipsis displayed for it. */
5385 success_p
= next_element_from_ellipsis (it
);
5386 it
->dpvec_char_len
= -1;
5391 /* Value is zero if end of buffer reached. */
5392 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
5397 /* Run the redisplay end trigger hook for IT. */
5400 run_redisplay_end_trigger_hook (it
)
5403 Lisp_Object args
[3];
5405 /* IT->glyph_row should be non-null, i.e. we should be actually
5406 displaying something, or otherwise we should not run the hook. */
5407 xassert (it
->glyph_row
);
5409 /* Set up hook arguments. */
5410 args
[0] = Qredisplay_end_trigger_functions
;
5411 args
[1] = it
->window
;
5412 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
5413 it
->redisplay_end_trigger_charpos
= 0;
5415 /* Since we are *trying* to run these functions, don't try to run
5416 them again, even if they get an error. */
5417 it
->w
->redisplay_end_trigger
= Qnil
;
5418 Frun_hook_with_args (3, args
);
5420 /* Notice if it changed the face of the character we are on. */
5421 handle_face_prop (it
);
5425 /* Deliver a composition display element. The iterator IT is already
5426 filled with composition information (done in
5427 handle_composition_prop). Value is always 1. */
5430 next_element_from_composition (it
)
5433 it
->what
= IT_COMPOSITION
;
5434 it
->position
= (STRINGP (it
->string
)
5435 ? it
->current
.string_pos
5442 /***********************************************************************
5443 Moving an iterator without producing glyphs
5444 ***********************************************************************/
5446 /* Move iterator IT to a specified buffer or X position within one
5447 line on the display without producing glyphs.
5449 OP should be a bit mask including some or all of these bits:
5450 MOVE_TO_X: Stop on reaching x-position TO_X.
5451 MOVE_TO_POS: Stop on reaching buffer or string position TO_CHARPOS.
5452 Regardless of OP's value, stop in reaching the end of the display line.
5454 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
5455 This means, in particular, that TO_X includes window's horizontal
5458 The return value has several possible values that
5459 say what condition caused the scan to stop:
5461 MOVE_POS_MATCH_OR_ZV
5462 - when TO_POS or ZV was reached.
5465 -when TO_X was reached before TO_POS or ZV were reached.
5468 - when we reached the end of the display area and the line must
5472 - when we reached the end of the display area and the line is
5476 - when we stopped at a line end, i.e. a newline or a CR and selective
5479 static enum move_it_result
5480 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
)
5482 int to_charpos
, to_x
, op
;
5484 enum move_it_result result
= MOVE_UNDEFINED
;
5485 struct glyph_row
*saved_glyph_row
;
5487 /* Don't produce glyphs in produce_glyphs. */
5488 saved_glyph_row
= it
->glyph_row
;
5489 it
->glyph_row
= NULL
;
5493 int x
, i
, ascent
= 0, descent
= 0;
5495 /* Stop when ZV or TO_CHARPOS reached. */
5496 if (!get_next_display_element (it
)
5497 || ((op
& MOVE_TO_POS
) != 0
5498 && BUFFERP (it
->object
)
5499 && IT_CHARPOS (*it
) >= to_charpos
))
5501 result
= MOVE_POS_MATCH_OR_ZV
;
5505 /* The call to produce_glyphs will get the metrics of the
5506 display element IT is loaded with. We record in x the
5507 x-position before this display element in case it does not
5511 /* Remember the line height so far in case the next element doesn't
5513 if (!it
->truncate_lines_p
)
5515 ascent
= it
->max_ascent
;
5516 descent
= it
->max_descent
;
5519 PRODUCE_GLYPHS (it
);
5521 if (it
->area
!= TEXT_AREA
)
5523 set_iterator_to_next (it
, 1);
5527 /* The number of glyphs we get back in IT->nglyphs will normally
5528 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
5529 character on a terminal frame, or (iii) a line end. For the
5530 second case, IT->nglyphs - 1 padding glyphs will be present
5531 (on X frames, there is only one glyph produced for a
5532 composite character.
5534 The behavior implemented below means, for continuation lines,
5535 that as many spaces of a TAB as fit on the current line are
5536 displayed there. For terminal frames, as many glyphs of a
5537 multi-glyph character are displayed in the current line, too.
5538 This is what the old redisplay code did, and we keep it that
5539 way. Under X, the whole shape of a complex character must
5540 fit on the line or it will be completely displayed in the
5543 Note that both for tabs and padding glyphs, all glyphs have
5547 /* More than one glyph or glyph doesn't fit on line. All
5548 glyphs have the same width. */
5549 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
5552 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
5554 new_x
= x
+ single_glyph_width
;
5556 /* We want to leave anything reaching TO_X to the caller. */
5557 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
5560 result
= MOVE_X_REACHED
;
5563 else if (/* Lines are continued. */
5564 !it
->truncate_lines_p
5565 && (/* And glyph doesn't fit on the line. */
5566 new_x
> it
->last_visible_x
5567 /* Or it fits exactly and we're on a window
5569 || (new_x
== it
->last_visible_x
5570 && FRAME_WINDOW_P (it
->f
))))
5572 if (/* IT->hpos == 0 means the very first glyph
5573 doesn't fit on the line, e.g. a wide image. */
5575 || (new_x
== it
->last_visible_x
5576 && FRAME_WINDOW_P (it
->f
)))
5579 it
->current_x
= new_x
;
5580 if (i
== it
->nglyphs
- 1)
5581 set_iterator_to_next (it
, 1);
5586 it
->max_ascent
= ascent
;
5587 it
->max_descent
= descent
;
5590 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
5592 result
= MOVE_LINE_CONTINUED
;
5595 else if (new_x
> it
->first_visible_x
)
5597 /* Glyph is visible. Increment number of glyphs that
5598 would be displayed. */
5603 /* Glyph is completely off the left margin of the display
5604 area. Nothing to do. */
5608 if (result
!= MOVE_UNDEFINED
)
5611 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
5613 /* Stop when TO_X specified and reached. This check is
5614 necessary here because of lines consisting of a line end,
5615 only. The line end will not produce any glyphs and we
5616 would never get MOVE_X_REACHED. */
5617 xassert (it
->nglyphs
== 0);
5618 result
= MOVE_X_REACHED
;
5622 /* Is this a line end? If yes, we're done. */
5623 if (ITERATOR_AT_END_OF_LINE_P (it
))
5625 result
= MOVE_NEWLINE_OR_CR
;
5629 /* The current display element has been consumed. Advance
5631 set_iterator_to_next (it
, 1);
5633 /* Stop if lines are truncated and IT's current x-position is
5634 past the right edge of the window now. */
5635 if (it
->truncate_lines_p
5636 && it
->current_x
>= it
->last_visible_x
)
5638 result
= MOVE_LINE_TRUNCATED
;
5643 /* Restore the iterator settings altered at the beginning of this
5645 it
->glyph_row
= saved_glyph_row
;
5650 /* Move IT forward until it satisfies one or more of the criteria in
5651 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
5653 OP is a bit-mask that specifies where to stop, and in particular,
5654 which of those four position arguments makes a difference. See the
5655 description of enum move_operation_enum.
5657 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
5658 screen line, this function will set IT to the next position >
5662 move_it_to (it
, to_charpos
, to_x
, to_y
, to_vpos
, op
)
5664 int to_charpos
, to_x
, to_y
, to_vpos
;
5667 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
5673 if (op
& MOVE_TO_VPOS
)
5675 /* If no TO_CHARPOS and no TO_X specified, stop at the
5676 start of the line TO_VPOS. */
5677 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
5679 if (it
->vpos
== to_vpos
)
5685 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
5689 /* TO_VPOS >= 0 means stop at TO_X in the line at
5690 TO_VPOS, or at TO_POS, whichever comes first. */
5691 if (it
->vpos
== to_vpos
)
5697 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
5699 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
5704 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
5706 /* We have reached TO_X but not in the line we want. */
5707 skip
= move_it_in_display_line_to (it
, to_charpos
,
5709 if (skip
== MOVE_POS_MATCH_OR_ZV
)
5717 else if (op
& MOVE_TO_Y
)
5719 struct it it_backup
;
5721 /* TO_Y specified means stop at TO_X in the line containing
5722 TO_Y---or at TO_CHARPOS if this is reached first. The
5723 problem is that we can't really tell whether the line
5724 contains TO_Y before we have completely scanned it, and
5725 this may skip past TO_X. What we do is to first scan to
5728 If TO_X is not specified, use a TO_X of zero. The reason
5729 is to make the outcome of this function more predictable.
5730 If we didn't use TO_X == 0, we would stop at the end of
5731 the line which is probably not what a caller would expect
5733 skip
= move_it_in_display_line_to (it
, to_charpos
,
5737 | (op
& MOVE_TO_POS
)));
5739 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
5740 if (skip
== MOVE_POS_MATCH_OR_ZV
)
5746 /* If TO_X was reached, we would like to know whether TO_Y
5747 is in the line. This can only be said if we know the
5748 total line height which requires us to scan the rest of
5750 if (skip
== MOVE_X_REACHED
)
5753 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
5754 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
5756 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
5759 /* Now, decide whether TO_Y is in this line. */
5760 line_height
= it
->max_ascent
+ it
->max_descent
;
5761 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
5763 if (to_y
>= it
->current_y
5764 && to_y
< it
->current_y
+ line_height
)
5766 if (skip
== MOVE_X_REACHED
)
5767 /* If TO_Y is in this line and TO_X was reached above,
5768 we scanned too far. We have to restore IT's settings
5769 to the ones before skipping. */
5773 else if (skip
== MOVE_X_REACHED
)
5776 if (skip
== MOVE_POS_MATCH_OR_ZV
)
5784 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
5788 case MOVE_POS_MATCH_OR_ZV
:
5792 case MOVE_NEWLINE_OR_CR
:
5793 set_iterator_to_next (it
, 1);
5794 it
->continuation_lines_width
= 0;
5797 case MOVE_LINE_TRUNCATED
:
5798 it
->continuation_lines_width
= 0;
5799 reseat_at_next_visible_line_start (it
, 0);
5800 if ((op
& MOVE_TO_POS
) != 0
5801 && IT_CHARPOS (*it
) > to_charpos
)
5808 case MOVE_LINE_CONTINUED
:
5809 it
->continuation_lines_width
+= it
->current_x
;
5816 /* Reset/increment for the next run. */
5817 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
5818 it
->current_x
= it
->hpos
= 0;
5819 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
5821 last_height
= it
->max_ascent
+ it
->max_descent
;
5822 last_max_ascent
= it
->max_ascent
;
5823 it
->max_ascent
= it
->max_descent
= 0;
5828 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
5832 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
5834 If DY > 0, move IT backward at least that many pixels. DY = 0
5835 means move IT backward to the preceding line start or BEGV. This
5836 function may move over more than DY pixels if IT->current_y - DY
5837 ends up in the middle of a line; in this case IT->current_y will be
5838 set to the top of the line moved to. */
5841 move_it_vertically_backward (it
, dy
)
5847 int start_pos
= IT_CHARPOS (*it
);
5851 /* Estimate how many newlines we must move back. */
5852 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
5854 /* Set the iterator's position that many lines back. */
5855 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
5856 back_to_previous_visible_line_start (it
);
5858 /* Reseat the iterator here. When moving backward, we don't want
5859 reseat to skip forward over invisible text, set up the iterator
5860 to deliver from overlay strings at the new position etc. So,
5861 use reseat_1 here. */
5862 reseat_1 (it
, it
->current
.pos
, 1);
5864 /* We are now surely at a line start. */
5865 it
->current_x
= it
->hpos
= 0;
5866 it
->continuation_lines_width
= 0;
5868 /* Move forward and see what y-distance we moved. First move to the
5869 start of the next line so that we get its height. We need this
5870 height to be able to tell whether we reached the specified
5873 it2
.max_ascent
= it2
.max_descent
= 0;
5874 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
5875 MOVE_TO_POS
| MOVE_TO_VPOS
);
5876 xassert (IT_CHARPOS (*it
) >= BEGV
);
5879 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
5880 xassert (IT_CHARPOS (*it
) >= BEGV
);
5881 /* H is the actual vertical distance from the position in *IT
5882 and the starting position. */
5883 h
= it2
.current_y
- it
->current_y
;
5884 /* NLINES is the distance in number of lines. */
5885 nlines
= it2
.vpos
- it
->vpos
;
5887 /* Correct IT's y and vpos position
5888 so that they are relative to the starting point. */
5894 /* DY == 0 means move to the start of the screen line. The
5895 value of nlines is > 0 if continuation lines were involved. */
5897 move_it_by_lines (it
, nlines
, 1);
5898 xassert (IT_CHARPOS (*it
) <= start_pos
);
5902 /* The y-position we try to reach, relative to *IT.
5903 Note that H has been subtracted in front of the if-statement. */
5904 int target_y
= it
->current_y
+ h
- dy
;
5905 int y0
= it3
.current_y
;
5906 int y1
= line_bottom_y (&it3
);
5907 int line_height
= y1
- y0
;
5909 /* If we did not reach target_y, try to move further backward if
5910 we can. If we moved too far backward, try to move forward. */
5911 if (target_y
< it
->current_y
5912 /* This is heuristic. In a window that's 3 lines high, with
5913 a line height of 13 pixels each, recentering with point
5914 on the bottom line will try to move -39/2 = 19 pixels
5915 backward. Try to avoid moving into the first line. */
5916 && it
->current_y
- target_y
> line_height
/ 3 * 2
5917 && IT_CHARPOS (*it
) > BEGV
)
5919 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
5920 target_y
- it
->current_y
));
5921 move_it_vertically (it
, target_y
- it
->current_y
);
5922 xassert (IT_CHARPOS (*it
) >= BEGV
);
5924 else if (target_y
>= it
->current_y
+ line_height
5925 && IT_CHARPOS (*it
) < ZV
)
5927 /* Should move forward by at least one line, maybe more.
5929 Note: Calling move_it_by_lines can be expensive on
5930 terminal frames, where compute_motion is used (via
5931 vmotion) to do the job, when there are very long lines
5932 and truncate-lines is nil. That's the reason for
5933 treating terminal frames specially here. */
5935 if (!FRAME_WINDOW_P (it
->f
))
5936 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
5941 move_it_by_lines (it
, 1, 1);
5943 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
5946 xassert (IT_CHARPOS (*it
) >= BEGV
);
5952 /* Move IT by a specified amount of pixel lines DY. DY negative means
5953 move backwards. DY = 0 means move to start of screen line. At the
5954 end, IT will be on the start of a screen line. */
5957 move_it_vertically (it
, dy
)
5962 move_it_vertically_backward (it
, -dy
);
5965 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
5966 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
5967 MOVE_TO_POS
| MOVE_TO_Y
);
5968 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
5970 /* If buffer ends in ZV without a newline, move to the start of
5971 the line to satisfy the post-condition. */
5972 if (IT_CHARPOS (*it
) == ZV
5973 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
5974 move_it_by_lines (it
, 0, 0);
5979 /* Move iterator IT past the end of the text line it is in. */
5982 move_it_past_eol (it
)
5985 enum move_it_result rc
;
5987 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
5988 if (rc
== MOVE_NEWLINE_OR_CR
)
5989 set_iterator_to_next (it
, 0);
5993 #if 0 /* Currently not used. */
5995 /* Return non-zero if some text between buffer positions START_CHARPOS
5996 and END_CHARPOS is invisible. IT->window is the window for text
6000 invisible_text_between_p (it
, start_charpos
, end_charpos
)
6002 int start_charpos
, end_charpos
;
6004 Lisp_Object prop
, limit
;
6005 int invisible_found_p
;
6007 xassert (it
!= NULL
&& start_charpos
<= end_charpos
);
6009 /* Is text at START invisible? */
6010 prop
= Fget_char_property (make_number (start_charpos
), Qinvisible
,
6012 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
6013 invisible_found_p
= 1;
6016 limit
= Fnext_single_char_property_change (make_number (start_charpos
),
6018 make_number (end_charpos
));
6019 invisible_found_p
= XFASTINT (limit
) < end_charpos
;
6022 return invisible_found_p
;
6028 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
6029 negative means move up. DVPOS == 0 means move to the start of the
6030 screen line. NEED_Y_P non-zero means calculate IT->current_y. If
6031 NEED_Y_P is zero, IT->current_y will be left unchanged.
6033 Further optimization ideas: If we would know that IT->f doesn't use
6034 a face with proportional font, we could be faster for
6035 truncate-lines nil. */
6038 move_it_by_lines (it
, dvpos
, need_y_p
)
6040 int dvpos
, need_y_p
;
6042 struct position pos
;
6044 if (!FRAME_WINDOW_P (it
->f
))
6046 struct text_pos textpos
;
6048 /* We can use vmotion on frames without proportional fonts. */
6049 pos
= *vmotion (IT_CHARPOS (*it
), dvpos
, it
->w
);
6050 SET_TEXT_POS (textpos
, pos
.bufpos
, pos
.bytepos
);
6051 reseat (it
, textpos
, 1);
6052 it
->vpos
+= pos
.vpos
;
6053 it
->current_y
+= pos
.vpos
;
6055 else if (dvpos
== 0)
6057 /* DVPOS == 0 means move to the start of the screen line. */
6058 move_it_vertically_backward (it
, 0);
6059 xassert (it
->current_x
== 0 && it
->hpos
== 0);
6062 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
6066 int start_charpos
, i
;
6068 /* Start at the beginning of the screen line containing IT's
6070 move_it_vertically_backward (it
, 0);
6072 /* Go back -DVPOS visible lines and reseat the iterator there. */
6073 start_charpos
= IT_CHARPOS (*it
);
6074 for (i
= -dvpos
; i
&& IT_CHARPOS (*it
) > BEGV
; --i
)
6075 back_to_previous_visible_line_start (it
);
6076 reseat (it
, it
->current
.pos
, 1);
6077 it
->current_x
= it
->hpos
= 0;
6079 /* Above call may have moved too far if continuation lines
6080 are involved. Scan forward and see if it did. */
6082 it2
.vpos
= it2
.current_y
= 0;
6083 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
6084 it
->vpos
-= it2
.vpos
;
6085 it
->current_y
-= it2
.current_y
;
6086 it
->current_x
= it
->hpos
= 0;
6088 /* If we moved too far, move IT some lines forward. */
6089 if (it2
.vpos
> -dvpos
)
6091 int delta
= it2
.vpos
+ dvpos
;
6092 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
6097 /* Return 1 if IT points into the middle of a display vector. */
6100 in_display_vector_p (it
)
6103 return (it
->method
== next_element_from_display_vector
6104 && it
->current
.dpvec_index
> 0
6105 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
6109 /***********************************************************************
6111 ***********************************************************************/
6114 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
6118 add_to_log (format
, arg1
, arg2
)
6120 Lisp_Object arg1
, arg2
;
6122 Lisp_Object args
[3];
6123 Lisp_Object msg
, fmt
;
6126 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
6128 /* Do nothing if called asynchronously. Inserting text into
6129 a buffer may call after-change-functions and alike and
6130 that would means running Lisp asynchronously. */
6131 if (handling_signal
)
6135 GCPRO4 (fmt
, msg
, arg1
, arg2
);
6137 args
[0] = fmt
= build_string (format
);
6140 msg
= Fformat (3, args
);
6142 len
= SBYTES (msg
) + 1;
6143 buffer
= (char *) alloca (len
);
6144 bcopy (SDATA (msg
), buffer
, len
);
6146 message_dolog (buffer
, len
- 1, 1, 0);
6151 /* Output a newline in the *Messages* buffer if "needs" one. */
6154 message_log_maybe_newline ()
6156 if (message_log_need_newline
)
6157 message_dolog ("", 0, 1, 0);
6161 /* Add a string M of length NBYTES to the message log, optionally
6162 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
6163 nonzero, means interpret the contents of M as multibyte. This
6164 function calls low-level routines in order to bypass text property
6165 hooks, etc. which might not be safe to run. */
6168 message_dolog (m
, nbytes
, nlflag
, multibyte
)
6170 int nbytes
, nlflag
, multibyte
;
6172 if (!NILP (Vmemory_full
))
6175 if (!NILP (Vmessage_log_max
))
6177 struct buffer
*oldbuf
;
6178 Lisp_Object oldpoint
, oldbegv
, oldzv
;
6179 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
6180 int point_at_end
= 0;
6182 Lisp_Object old_deactivate_mark
, tem
;
6183 struct gcpro gcpro1
;
6185 old_deactivate_mark
= Vdeactivate_mark
;
6186 oldbuf
= current_buffer
;
6187 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
6188 current_buffer
->undo_list
= Qt
;
6190 oldpoint
= message_dolog_marker1
;
6191 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
6192 oldbegv
= message_dolog_marker2
;
6193 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
6194 oldzv
= message_dolog_marker3
;
6195 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
6196 GCPRO1 (old_deactivate_mark
);
6204 BEGV_BYTE
= BEG_BYTE
;
6207 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
6209 /* Insert the string--maybe converting multibyte to single byte
6210 or vice versa, so that all the text fits the buffer. */
6212 && NILP (current_buffer
->enable_multibyte_characters
))
6214 int i
, c
, char_bytes
;
6215 unsigned char work
[1];
6217 /* Convert a multibyte string to single-byte
6218 for the *Message* buffer. */
6219 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
6221 c
= string_char_and_length (m
+ i
, nbytes
- i
, &char_bytes
);
6222 work
[0] = (SINGLE_BYTE_CHAR_P (c
)
6224 : multibyte_char_to_unibyte (c
, Qnil
));
6225 insert_1_both (work
, 1, 1, 1, 0, 0);
6228 else if (! multibyte
6229 && ! NILP (current_buffer
->enable_multibyte_characters
))
6231 int i
, c
, char_bytes
;
6232 unsigned char *msg
= (unsigned char *) m
;
6233 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
6234 /* Convert a single-byte string to multibyte
6235 for the *Message* buffer. */
6236 for (i
= 0; i
< nbytes
; i
++)
6238 c
= unibyte_char_to_multibyte (msg
[i
]);
6239 char_bytes
= CHAR_STRING (c
, str
);
6240 insert_1_both (str
, 1, char_bytes
, 1, 0, 0);
6244 insert_1 (m
, nbytes
, 1, 0, 0);
6248 int this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
, dup
;
6249 insert_1 ("\n", 1, 1, 0, 0);
6251 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
6253 this_bol_byte
= PT_BYTE
;
6255 /* See if this line duplicates the previous one.
6256 If so, combine duplicates. */
6259 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
6261 prev_bol_byte
= PT_BYTE
;
6263 dup
= message_log_check_duplicate (prev_bol
, prev_bol_byte
,
6264 this_bol
, this_bol_byte
);
6267 del_range_both (prev_bol
, prev_bol_byte
,
6268 this_bol
, this_bol_byte
, 0);
6274 /* If you change this format, don't forget to also
6275 change message_log_check_duplicate. */
6276 sprintf (dupstr
, " [%d times]", dup
);
6277 duplen
= strlen (dupstr
);
6278 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
6279 insert_1 (dupstr
, duplen
, 1, 0, 1);
6284 /* If we have more than the desired maximum number of lines
6285 in the *Messages* buffer now, delete the oldest ones.
6286 This is safe because we don't have undo in this buffer. */
6288 if (NATNUMP (Vmessage_log_max
))
6290 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
6291 -XFASTINT (Vmessage_log_max
) - 1, 0);
6292 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
6295 BEGV
= XMARKER (oldbegv
)->charpos
;
6296 BEGV_BYTE
= marker_byte_position (oldbegv
);
6305 ZV
= XMARKER (oldzv
)->charpos
;
6306 ZV_BYTE
= marker_byte_position (oldzv
);
6310 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
6312 /* We can't do Fgoto_char (oldpoint) because it will run some
6314 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
6315 XMARKER (oldpoint
)->bytepos
);
6318 unchain_marker (XMARKER (oldpoint
));
6319 unchain_marker (XMARKER (oldbegv
));
6320 unchain_marker (XMARKER (oldzv
));
6322 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
6323 set_buffer_internal (oldbuf
);
6325 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
6326 message_log_need_newline
= !nlflag
;
6327 Vdeactivate_mark
= old_deactivate_mark
;
6332 /* We are at the end of the buffer after just having inserted a newline.
6333 (Note: We depend on the fact we won't be crossing the gap.)
6334 Check to see if the most recent message looks a lot like the previous one.
6335 Return 0 if different, 1 if the new one should just replace it, or a
6336 value N > 1 if we should also append " [N times]". */
6339 message_log_check_duplicate (prev_bol
, prev_bol_byte
, this_bol
, this_bol_byte
)
6340 int prev_bol
, this_bol
;
6341 int prev_bol_byte
, this_bol_byte
;
6344 int len
= Z_BYTE
- 1 - this_bol_byte
;
6346 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
6347 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
6349 for (i
= 0; i
< len
; i
++)
6351 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
6359 if (*p1
++ == ' ' && *p1
++ == '[')
6362 while (*p1
>= '0' && *p1
<= '9')
6363 n
= n
* 10 + *p1
++ - '0';
6364 if (strncmp (p1
, " times]\n", 8) == 0)
6371 /* Display an echo area message M with a specified length of NBYTES
6372 bytes. The string may include null characters. If M is 0, clear
6373 out any existing message, and let the mini-buffer text show
6376 The buffer M must continue to exist until after the echo area gets
6377 cleared or some other message gets displayed there. This means do
6378 not pass text that is stored in a Lisp string; do not pass text in
6379 a buffer that was alloca'd. */
6382 message2 (m
, nbytes
, multibyte
)
6387 /* First flush out any partial line written with print. */
6388 message_log_maybe_newline ();
6390 message_dolog (m
, nbytes
, 1, multibyte
);
6391 message2_nolog (m
, nbytes
, multibyte
);
6395 /* The non-logging counterpart of message2. */
6398 message2_nolog (m
, nbytes
, multibyte
)
6400 int nbytes
, multibyte
;
6402 struct frame
*sf
= SELECTED_FRAME ();
6403 message_enable_multibyte
= multibyte
;
6407 if (noninteractive_need_newline
)
6408 putc ('\n', stderr
);
6409 noninteractive_need_newline
= 0;
6411 fwrite (m
, nbytes
, 1, stderr
);
6412 if (cursor_in_echo_area
== 0)
6413 fprintf (stderr
, "\n");
6416 /* A null message buffer means that the frame hasn't really been
6417 initialized yet. Error messages get reported properly by
6418 cmd_error, so this must be just an informative message; toss it. */
6419 else if (INTERACTIVE
6420 && sf
->glyphs_initialized_p
6421 && FRAME_MESSAGE_BUF (sf
))
6423 Lisp_Object mini_window
;
6426 /* Get the frame containing the mini-buffer
6427 that the selected frame is using. */
6428 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
6429 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
6431 FRAME_SAMPLE_VISIBILITY (f
);
6432 if (FRAME_VISIBLE_P (sf
)
6433 && ! FRAME_VISIBLE_P (f
))
6434 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
6438 set_message (m
, Qnil
, nbytes
, multibyte
);
6439 if (minibuffer_auto_raise
)
6440 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
6443 clear_message (1, 1);
6445 do_pending_window_change (0);
6446 echo_area_display (1);
6447 do_pending_window_change (0);
6448 if (frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
6449 (*frame_up_to_date_hook
) (f
);
6454 /* Display an echo area message M with a specified length of NBYTES
6455 bytes. The string may include null characters. If M is not a
6456 string, clear out any existing message, and let the mini-buffer
6457 text show through. */
6460 message3 (m
, nbytes
, multibyte
)
6465 struct gcpro gcpro1
;
6469 /* First flush out any partial line written with print. */
6470 message_log_maybe_newline ();
6472 message_dolog (SDATA (m
), nbytes
, 1, multibyte
);
6473 message3_nolog (m
, nbytes
, multibyte
);
6479 /* The non-logging version of message3. */
6482 message3_nolog (m
, nbytes
, multibyte
)
6484 int nbytes
, multibyte
;
6486 struct frame
*sf
= SELECTED_FRAME ();
6487 message_enable_multibyte
= multibyte
;
6491 if (noninteractive_need_newline
)
6492 putc ('\n', stderr
);
6493 noninteractive_need_newline
= 0;
6495 fwrite (SDATA (m
), nbytes
, 1, stderr
);
6496 if (cursor_in_echo_area
== 0)
6497 fprintf (stderr
, "\n");
6500 /* A null message buffer means that the frame hasn't really been
6501 initialized yet. Error messages get reported properly by
6502 cmd_error, so this must be just an informative message; toss it. */
6503 else if (INTERACTIVE
6504 && sf
->glyphs_initialized_p
6505 && FRAME_MESSAGE_BUF (sf
))
6507 Lisp_Object mini_window
;
6511 /* Get the frame containing the mini-buffer
6512 that the selected frame is using. */
6513 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
6514 frame
= XWINDOW (mini_window
)->frame
;
6517 FRAME_SAMPLE_VISIBILITY (f
);
6518 if (FRAME_VISIBLE_P (sf
)
6519 && !FRAME_VISIBLE_P (f
))
6520 Fmake_frame_visible (frame
);
6522 if (STRINGP (m
) && SCHARS (m
) > 0)
6524 set_message (NULL
, m
, nbytes
, multibyte
);
6525 if (minibuffer_auto_raise
)
6526 Fraise_frame (frame
);
6529 clear_message (1, 1);
6531 do_pending_window_change (0);
6532 echo_area_display (1);
6533 do_pending_window_change (0);
6534 if (frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
6535 (*frame_up_to_date_hook
) (f
);
6540 /* Display a null-terminated echo area message M. If M is 0, clear
6541 out any existing message, and let the mini-buffer text show through.
6543 The buffer M must continue to exist until after the echo area gets
6544 cleared or some other message gets displayed there. Do not pass
6545 text that is stored in a Lisp string. Do not pass text in a buffer
6546 that was alloca'd. */
6552 message2 (m
, (m
? strlen (m
) : 0), 0);
6556 /* The non-logging counterpart of message1. */
6562 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
6565 /* Display a message M which contains a single %s
6566 which gets replaced with STRING. */
6569 message_with_string (m
, string
, log
)
6574 CHECK_STRING (string
);
6580 if (noninteractive_need_newline
)
6581 putc ('\n', stderr
);
6582 noninteractive_need_newline
= 0;
6583 fprintf (stderr
, m
, SDATA (string
));
6584 if (cursor_in_echo_area
== 0)
6585 fprintf (stderr
, "\n");
6589 else if (INTERACTIVE
)
6591 /* The frame whose minibuffer we're going to display the message on.
6592 It may be larger than the selected frame, so we need
6593 to use its buffer, not the selected frame's buffer. */
6594 Lisp_Object mini_window
;
6595 struct frame
*f
, *sf
= SELECTED_FRAME ();
6597 /* Get the frame containing the minibuffer
6598 that the selected frame is using. */
6599 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
6600 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
6602 /* A null message buffer means that the frame hasn't really been
6603 initialized yet. Error messages get reported properly by
6604 cmd_error, so this must be just an informative message; toss it. */
6605 if (FRAME_MESSAGE_BUF (f
))
6607 Lisp_Object args
[2], message
;
6608 struct gcpro gcpro1
, gcpro2
;
6610 args
[0] = build_string (m
);
6611 args
[1] = message
= string
;
6612 GCPRO2 (args
[0], message
);
6615 message
= Fformat (2, args
);
6618 message3 (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
6620 message3_nolog (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
6624 /* Print should start at the beginning of the message
6625 buffer next time. */
6626 message_buf_print
= 0;
6632 /* Dump an informative message to the minibuf. If M is 0, clear out
6633 any existing message, and let the mini-buffer text show through. */
6637 message (m
, a1
, a2
, a3
)
6639 EMACS_INT a1
, a2
, a3
;
6645 if (noninteractive_need_newline
)
6646 putc ('\n', stderr
);
6647 noninteractive_need_newline
= 0;
6648 fprintf (stderr
, m
, a1
, a2
, a3
);
6649 if (cursor_in_echo_area
== 0)
6650 fprintf (stderr
, "\n");
6654 else if (INTERACTIVE
)
6656 /* The frame whose mini-buffer we're going to display the message
6657 on. It may be larger than the selected frame, so we need to
6658 use its buffer, not the selected frame's buffer. */
6659 Lisp_Object mini_window
;
6660 struct frame
*f
, *sf
= SELECTED_FRAME ();
6662 /* Get the frame containing the mini-buffer
6663 that the selected frame is using. */
6664 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
6665 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
6667 /* A null message buffer means that the frame hasn't really been
6668 initialized yet. Error messages get reported properly by
6669 cmd_error, so this must be just an informative message; toss
6671 if (FRAME_MESSAGE_BUF (f
))
6682 len
= doprnt (FRAME_MESSAGE_BUF (f
),
6683 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3, a
);
6685 len
= doprnt (FRAME_MESSAGE_BUF (f
),
6686 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3,
6688 #endif /* NO_ARG_ARRAY */
6690 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
6695 /* Print should start at the beginning of the message
6696 buffer next time. */
6697 message_buf_print
= 0;
6703 /* The non-logging version of message. */
6706 message_nolog (m
, a1
, a2
, a3
)
6708 EMACS_INT a1
, a2
, a3
;
6710 Lisp_Object old_log_max
;
6711 old_log_max
= Vmessage_log_max
;
6712 Vmessage_log_max
= Qnil
;
6713 message (m
, a1
, a2
, a3
);
6714 Vmessage_log_max
= old_log_max
;
6718 /* Display the current message in the current mini-buffer. This is
6719 only called from error handlers in process.c, and is not time
6725 if (!NILP (echo_area_buffer
[0]))
6728 string
= Fcurrent_message ();
6729 message3 (string
, SBYTES (string
),
6730 !NILP (current_buffer
->enable_multibyte_characters
));
6735 /* Make sure echo area buffers in `echo_buffers' are live.
6736 If they aren't, make new ones. */
6739 ensure_echo_area_buffers ()
6743 for (i
= 0; i
< 2; ++i
)
6744 if (!BUFFERP (echo_buffer
[i
])
6745 || NILP (XBUFFER (echo_buffer
[i
])->name
))
6748 Lisp_Object old_buffer
;
6751 old_buffer
= echo_buffer
[i
];
6752 sprintf (name
, " *Echo Area %d*", i
);
6753 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
6754 XBUFFER (echo_buffer
[i
])->truncate_lines
= Qnil
;
6756 for (j
= 0; j
< 2; ++j
)
6757 if (EQ (old_buffer
, echo_area_buffer
[j
]))
6758 echo_area_buffer
[j
] = echo_buffer
[i
];
6763 /* Call FN with args A1..A4 with either the current or last displayed
6764 echo_area_buffer as current buffer.
6766 WHICH zero means use the current message buffer
6767 echo_area_buffer[0]. If that is nil, choose a suitable buffer
6768 from echo_buffer[] and clear it.
6770 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
6771 suitable buffer from echo_buffer[] and clear it.
6773 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
6774 that the current message becomes the last displayed one, make
6775 choose a suitable buffer for echo_area_buffer[0], and clear it.
6777 Value is what FN returns. */
6780 with_echo_area_buffer (w
, which
, fn
, a1
, a2
, a3
, a4
)
6783 int (*fn
) P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
6789 int this_one
, the_other
, clear_buffer_p
, rc
;
6790 int count
= SPECPDL_INDEX ();
6792 /* If buffers aren't live, make new ones. */
6793 ensure_echo_area_buffers ();
6798 this_one
= 0, the_other
= 1;
6800 this_one
= 1, the_other
= 0;
6803 this_one
= 0, the_other
= 1;
6806 /* We need a fresh one in case the current echo buffer equals
6807 the one containing the last displayed echo area message. */
6808 if (!NILP (echo_area_buffer
[this_one
])
6809 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
6810 echo_area_buffer
[this_one
] = Qnil
;
6813 /* Choose a suitable buffer from echo_buffer[] is we don't
6815 if (NILP (echo_area_buffer
[this_one
]))
6817 echo_area_buffer
[this_one
]
6818 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
6819 ? echo_buffer
[the_other
]
6820 : echo_buffer
[this_one
]);
6824 buffer
= echo_area_buffer
[this_one
];
6826 /* Don't get confused by reusing the buffer used for echoing
6827 for a different purpose. */
6828 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
6831 record_unwind_protect (unwind_with_echo_area_buffer
,
6832 with_echo_area_buffer_unwind_data (w
));
6834 /* Make the echo area buffer current. Note that for display
6835 purposes, it is not necessary that the displayed window's buffer
6836 == current_buffer, except for text property lookup. So, let's
6837 only set that buffer temporarily here without doing a full
6838 Fset_window_buffer. We must also change w->pointm, though,
6839 because otherwise an assertions in unshow_buffer fails, and Emacs
6841 set_buffer_internal_1 (XBUFFER (buffer
));
6845 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
6848 current_buffer
->undo_list
= Qt
;
6849 current_buffer
->read_only
= Qnil
;
6850 specbind (Qinhibit_read_only
, Qt
);
6851 specbind (Qinhibit_modification_hooks
, Qt
);
6853 if (clear_buffer_p
&& Z
> BEG
)
6856 xassert (BEGV
>= BEG
);
6857 xassert (ZV
<= Z
&& ZV
>= BEGV
);
6859 rc
= fn (a1
, a2
, a3
, a4
);
6861 xassert (BEGV
>= BEG
);
6862 xassert (ZV
<= Z
&& ZV
>= BEGV
);
6864 unbind_to (count
, Qnil
);
6869 /* Save state that should be preserved around the call to the function
6870 FN called in with_echo_area_buffer. */
6873 with_echo_area_buffer_unwind_data (w
)
6879 /* Reduce consing by keeping one vector in
6880 Vwith_echo_area_save_vector. */
6881 vector
= Vwith_echo_area_save_vector
;
6882 Vwith_echo_area_save_vector
= Qnil
;
6885 vector
= Fmake_vector (make_number (7), Qnil
);
6887 XSETBUFFER (AREF (vector
, i
), current_buffer
); ++i
;
6888 AREF (vector
, i
) = Vdeactivate_mark
, ++i
;
6889 AREF (vector
, i
) = make_number (windows_or_buffers_changed
), ++i
;
6893 XSETWINDOW (AREF (vector
, i
), w
); ++i
;
6894 AREF (vector
, i
) = w
->buffer
; ++i
;
6895 AREF (vector
, i
) = make_number (XMARKER (w
->pointm
)->charpos
); ++i
;
6896 AREF (vector
, i
) = make_number (XMARKER (w
->pointm
)->bytepos
); ++i
;
6901 for (; i
< end
; ++i
)
6902 AREF (vector
, i
) = Qnil
;
6905 xassert (i
== ASIZE (vector
));
6910 /* Restore global state from VECTOR which was created by
6911 with_echo_area_buffer_unwind_data. */
6914 unwind_with_echo_area_buffer (vector
)
6917 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
6918 Vdeactivate_mark
= AREF (vector
, 1);
6919 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
6921 if (WINDOWP (AREF (vector
, 3)))
6924 Lisp_Object buffer
, charpos
, bytepos
;
6926 w
= XWINDOW (AREF (vector
, 3));
6927 buffer
= AREF (vector
, 4);
6928 charpos
= AREF (vector
, 5);
6929 bytepos
= AREF (vector
, 6);
6932 set_marker_both (w
->pointm
, buffer
,
6933 XFASTINT (charpos
), XFASTINT (bytepos
));
6936 Vwith_echo_area_save_vector
= vector
;
6941 /* Set up the echo area for use by print functions. MULTIBYTE_P
6942 non-zero means we will print multibyte. */
6945 setup_echo_area_for_printing (multibyte_p
)
6948 /* If we can't find an echo area any more, exit. */
6949 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
6952 ensure_echo_area_buffers ();
6954 if (!message_buf_print
)
6956 /* A message has been output since the last time we printed.
6957 Choose a fresh echo area buffer. */
6958 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
6959 echo_area_buffer
[0] = echo_buffer
[1];
6961 echo_area_buffer
[0] = echo_buffer
[0];
6963 /* Switch to that buffer and clear it. */
6964 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
6965 current_buffer
->truncate_lines
= Qnil
;
6969 int count
= SPECPDL_INDEX ();
6970 specbind (Qinhibit_read_only
, Qt
);
6971 /* Note that undo recording is always disabled. */
6973 unbind_to (count
, Qnil
);
6975 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
6977 /* Set up the buffer for the multibyteness we need. */
6979 != !NILP (current_buffer
->enable_multibyte_characters
))
6980 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
6982 /* Raise the frame containing the echo area. */
6983 if (minibuffer_auto_raise
)
6985 struct frame
*sf
= SELECTED_FRAME ();
6986 Lisp_Object mini_window
;
6987 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
6988 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
6991 message_log_maybe_newline ();
6992 message_buf_print
= 1;
6996 if (NILP (echo_area_buffer
[0]))
6998 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
6999 echo_area_buffer
[0] = echo_buffer
[1];
7001 echo_area_buffer
[0] = echo_buffer
[0];
7004 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
7006 /* Someone switched buffers between print requests. */
7007 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
7008 current_buffer
->truncate_lines
= Qnil
;
7014 /* Display an echo area message in window W. Value is non-zero if W's
7015 height is changed. If display_last_displayed_message_p is
7016 non-zero, display the message that was last displayed, otherwise
7017 display the current message. */
7020 display_echo_area (w
)
7023 int i
, no_message_p
, window_height_changed_p
, count
;
7025 /* Temporarily disable garbage collections while displaying the echo
7026 area. This is done because a GC can print a message itself.
7027 That message would modify the echo area buffer's contents while a
7028 redisplay of the buffer is going on, and seriously confuse
7030 count
= inhibit_garbage_collection ();
7032 /* If there is no message, we must call display_echo_area_1
7033 nevertheless because it resizes the window. But we will have to
7034 reset the echo_area_buffer in question to nil at the end because
7035 with_echo_area_buffer will sets it to an empty buffer. */
7036 i
= display_last_displayed_message_p
? 1 : 0;
7037 no_message_p
= NILP (echo_area_buffer
[i
]);
7039 window_height_changed_p
7040 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
7041 display_echo_area_1
,
7042 (EMACS_INT
) w
, Qnil
, 0, 0);
7045 echo_area_buffer
[i
] = Qnil
;
7047 unbind_to (count
, Qnil
);
7048 return window_height_changed_p
;
7052 /* Helper for display_echo_area. Display the current buffer which
7053 contains the current echo area message in window W, a mini-window,
7054 a pointer to which is passed in A1. A2..A4 are currently not used.
7055 Change the height of W so that all of the message is displayed.
7056 Value is non-zero if height of W was changed. */
7059 display_echo_area_1 (a1
, a2
, a3
, a4
)
7064 struct window
*w
= (struct window
*) a1
;
7066 struct text_pos start
;
7067 int window_height_changed_p
= 0;
7069 /* Do this before displaying, so that we have a large enough glyph
7070 matrix for the display. */
7071 window_height_changed_p
= resize_mini_window (w
, 0);
7074 clear_glyph_matrix (w
->desired_matrix
);
7075 XSETWINDOW (window
, w
);
7076 SET_TEXT_POS (start
, BEG
, BEG_BYTE
);
7077 try_window (window
, start
);
7079 return window_height_changed_p
;
7083 /* Resize the echo area window to exactly the size needed for the
7084 currently displayed message, if there is one. If a mini-buffer
7085 is active, don't shrink it. */
7088 resize_echo_area_exactly ()
7090 if (BUFFERP (echo_area_buffer
[0])
7091 && WINDOWP (echo_area_window
))
7093 struct window
*w
= XWINDOW (echo_area_window
);
7095 Lisp_Object resize_exactly
;
7097 if (minibuf_level
== 0)
7098 resize_exactly
= Qt
;
7100 resize_exactly
= Qnil
;
7102 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
7103 (EMACS_INT
) w
, resize_exactly
, 0, 0);
7106 ++windows_or_buffers_changed
;
7107 ++update_mode_lines
;
7108 redisplay_internal (0);
7114 /* Callback function for with_echo_area_buffer, when used from
7115 resize_echo_area_exactly. A1 contains a pointer to the window to
7116 resize, EXACTLY non-nil means resize the mini-window exactly to the
7117 size of the text displayed. A3 and A4 are not used. Value is what
7118 resize_mini_window returns. */
7121 resize_mini_window_1 (a1
, exactly
, a3
, a4
)
7123 Lisp_Object exactly
;
7126 return resize_mini_window ((struct window
*) a1
, !NILP (exactly
));
7130 /* Resize mini-window W to fit the size of its contents. EXACT:P
7131 means size the window exactly to the size needed. Otherwise, it's
7132 only enlarged until W's buffer is empty. Value is non-zero if
7133 the window height has been changed. */
7136 resize_mini_window (w
, exact_p
)
7140 struct frame
*f
= XFRAME (w
->frame
);
7141 int window_height_changed_p
= 0;
7143 xassert (MINI_WINDOW_P (w
));
7145 /* Don't resize windows while redisplaying a window; it would
7146 confuse redisplay functions when the size of the window they are
7147 displaying changes from under them. Such a resizing can happen,
7148 for instance, when which-func prints a long message while
7149 we are running fontification-functions. We're running these
7150 functions with safe_call which binds inhibit-redisplay to t. */
7151 if (!NILP (Vinhibit_redisplay
))
7154 /* Nil means don't try to resize. */
7155 if (NILP (Vresize_mini_windows
)
7156 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
7159 if (!FRAME_MINIBUF_ONLY_P (f
))
7162 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
7163 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
7164 int height
, max_height
;
7165 int unit
= FRAME_LINE_HEIGHT (f
);
7166 struct text_pos start
;
7167 struct buffer
*old_current_buffer
= NULL
;
7169 if (current_buffer
!= XBUFFER (w
->buffer
))
7171 old_current_buffer
= current_buffer
;
7172 set_buffer_internal (XBUFFER (w
->buffer
));
7175 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
7177 /* Compute the max. number of lines specified by the user. */
7178 if (FLOATP (Vmax_mini_window_height
))
7179 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
7180 else if (INTEGERP (Vmax_mini_window_height
))
7181 max_height
= XINT (Vmax_mini_window_height
);
7183 max_height
= total_height
/ 4;
7185 /* Correct that max. height if it's bogus. */
7186 max_height
= max (1, max_height
);
7187 max_height
= min (total_height
, max_height
);
7189 /* Find out the height of the text in the window. */
7190 if (it
.truncate_lines_p
)
7195 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
7196 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
7197 height
= it
.current_y
+ last_height
;
7199 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
7200 height
-= it
.extra_line_spacing
;
7201 height
= (height
+ unit
- 1) / unit
;
7204 /* Compute a suitable window start. */
7205 if (height
> max_height
)
7207 height
= max_height
;
7208 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
7209 move_it_vertically_backward (&it
, (height
- 1) * unit
);
7210 start
= it
.current
.pos
;
7213 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
7214 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
7216 if (EQ (Vresize_mini_windows
, Qgrow_only
))
7218 /* Let it grow only, until we display an empty message, in which
7219 case the window shrinks again. */
7220 if (height
> WINDOW_TOTAL_LINES (w
))
7222 int old_height
= WINDOW_TOTAL_LINES (w
);
7223 freeze_window_starts (f
, 1);
7224 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
7225 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
7227 else if (height
< WINDOW_TOTAL_LINES (w
)
7228 && (exact_p
|| BEGV
== ZV
))
7230 int old_height
= WINDOW_TOTAL_LINES (w
);
7231 freeze_window_starts (f
, 0);
7232 shrink_mini_window (w
);
7233 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
7238 /* Always resize to exact size needed. */
7239 if (height
> WINDOW_TOTAL_LINES (w
))
7241 int old_height
= WINDOW_TOTAL_LINES (w
);
7242 freeze_window_starts (f
, 1);
7243 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
7244 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
7246 else if (height
< WINDOW_TOTAL_LINES (w
))
7248 int old_height
= WINDOW_TOTAL_LINES (w
);
7249 freeze_window_starts (f
, 0);
7250 shrink_mini_window (w
);
7254 freeze_window_starts (f
, 1);
7255 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
7258 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
7262 if (old_current_buffer
)
7263 set_buffer_internal (old_current_buffer
);
7266 return window_height_changed_p
;
7270 /* Value is the current message, a string, or nil if there is no
7278 if (NILP (echo_area_buffer
[0]))
7282 with_echo_area_buffer (0, 0, current_message_1
,
7283 (EMACS_INT
) &msg
, Qnil
, 0, 0);
7285 echo_area_buffer
[0] = Qnil
;
7293 current_message_1 (a1
, a2
, a3
, a4
)
7298 Lisp_Object
*msg
= (Lisp_Object
*) a1
;
7301 *msg
= make_buffer_string (BEG
, Z
, 1);
7308 /* Push the current message on Vmessage_stack for later restauration
7309 by restore_message. Value is non-zero if the current message isn't
7310 empty. This is a relatively infrequent operation, so it's not
7311 worth optimizing. */
7317 msg
= current_message ();
7318 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
7319 return STRINGP (msg
);
7323 /* Restore message display from the top of Vmessage_stack. */
7330 xassert (CONSP (Vmessage_stack
));
7331 msg
= XCAR (Vmessage_stack
);
7333 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
7335 message3_nolog (msg
, 0, 0);
7339 /* Handler for record_unwind_protect calling pop_message. */
7342 pop_message_unwind (dummy
)
7349 /* Pop the top-most entry off Vmessage_stack. */
7354 xassert (CONSP (Vmessage_stack
));
7355 Vmessage_stack
= XCDR (Vmessage_stack
);
7359 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
7360 exits. If the stack is not empty, we have a missing pop_message
7364 check_message_stack ()
7366 if (!NILP (Vmessage_stack
))
7371 /* Truncate to NCHARS what will be displayed in the echo area the next
7372 time we display it---but don't redisplay it now. */
7375 truncate_echo_area (nchars
)
7379 echo_area_buffer
[0] = Qnil
;
7380 /* A null message buffer means that the frame hasn't really been
7381 initialized yet. Error messages get reported properly by
7382 cmd_error, so this must be just an informative message; toss it. */
7383 else if (!noninteractive
7385 && !NILP (echo_area_buffer
[0]))
7387 struct frame
*sf
= SELECTED_FRAME ();
7388 if (FRAME_MESSAGE_BUF (sf
))
7389 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
7394 /* Helper function for truncate_echo_area. Truncate the current
7395 message to at most NCHARS characters. */
7398 truncate_message_1 (nchars
, a2
, a3
, a4
)
7403 if (BEG
+ nchars
< Z
)
7404 del_range (BEG
+ nchars
, Z
);
7406 echo_area_buffer
[0] = Qnil
;
7411 /* Set the current message to a substring of S or STRING.
7413 If STRING is a Lisp string, set the message to the first NBYTES
7414 bytes from STRING. NBYTES zero means use the whole string. If
7415 STRING is multibyte, the message will be displayed multibyte.
7417 If S is not null, set the message to the first LEN bytes of S. LEN
7418 zero means use the whole string. MULTIBYTE_P non-zero means S is
7419 multibyte. Display the message multibyte in that case. */
7422 set_message (s
, string
, nbytes
, multibyte_p
)
7425 int nbytes
, multibyte_p
;
7427 message_enable_multibyte
7428 = ((s
&& multibyte_p
)
7429 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
7431 with_echo_area_buffer (0, -1, set_message_1
,
7432 (EMACS_INT
) s
, string
, nbytes
, multibyte_p
);
7433 message_buf_print
= 0;
7434 help_echo_showing_p
= 0;
7438 /* Helper function for set_message. Arguments have the same meaning
7439 as there, with A1 corresponding to S and A2 corresponding to STRING
7440 This function is called with the echo area buffer being
7444 set_message_1 (a1
, a2
, nbytes
, multibyte_p
)
7447 EMACS_INT nbytes
, multibyte_p
;
7449 const char *s
= (const char *) a1
;
7450 Lisp_Object string
= a2
;
7454 /* Change multibyteness of the echo buffer appropriately. */
7455 if (message_enable_multibyte
7456 != !NILP (current_buffer
->enable_multibyte_characters
))
7457 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
7459 current_buffer
->truncate_lines
= message_truncate_lines
? Qt
: Qnil
;
7461 /* Insert new message at BEG. */
7462 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
7464 if (STRINGP (string
))
7469 nbytes
= SBYTES (string
);
7470 nchars
= string_byte_to_char (string
, nbytes
);
7472 /* This function takes care of single/multibyte conversion. We
7473 just have to ensure that the echo area buffer has the right
7474 setting of enable_multibyte_characters. */
7475 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
7480 nbytes
= strlen (s
);
7482 if (multibyte_p
&& NILP (current_buffer
->enable_multibyte_characters
))
7484 /* Convert from multi-byte to single-byte. */
7486 unsigned char work
[1];
7488 /* Convert a multibyte string to single-byte. */
7489 for (i
= 0; i
< nbytes
; i
+= n
)
7491 c
= string_char_and_length (s
+ i
, nbytes
- i
, &n
);
7492 work
[0] = (SINGLE_BYTE_CHAR_P (c
)
7494 : multibyte_char_to_unibyte (c
, Qnil
));
7495 insert_1_both (work
, 1, 1, 1, 0, 0);
7498 else if (!multibyte_p
7499 && !NILP (current_buffer
->enable_multibyte_characters
))
7501 /* Convert from single-byte to multi-byte. */
7503 const unsigned char *msg
= (const unsigned char *) s
;
7504 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
7506 /* Convert a single-byte string to multibyte. */
7507 for (i
= 0; i
< nbytes
; i
++)
7509 c
= unibyte_char_to_multibyte (msg
[i
]);
7510 n
= CHAR_STRING (c
, str
);
7511 insert_1_both (str
, 1, n
, 1, 0, 0);
7515 insert_1 (s
, nbytes
, 1, 0, 0);
7522 /* Clear messages. CURRENT_P non-zero means clear the current
7523 message. LAST_DISPLAYED_P non-zero means clear the message
7527 clear_message (current_p
, last_displayed_p
)
7528 int current_p
, last_displayed_p
;
7532 echo_area_buffer
[0] = Qnil
;
7533 message_cleared_p
= 1;
7536 if (last_displayed_p
)
7537 echo_area_buffer
[1] = Qnil
;
7539 message_buf_print
= 0;
7542 /* Clear garbaged frames.
7544 This function is used where the old redisplay called
7545 redraw_garbaged_frames which in turn called redraw_frame which in
7546 turn called clear_frame. The call to clear_frame was a source of
7547 flickering. I believe a clear_frame is not necessary. It should
7548 suffice in the new redisplay to invalidate all current matrices,
7549 and ensure a complete redisplay of all windows. */
7552 clear_garbaged_frames ()
7556 Lisp_Object tail
, frame
;
7557 int changed_count
= 0;
7559 FOR_EACH_FRAME (tail
, frame
)
7561 struct frame
*f
= XFRAME (frame
);
7563 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
7566 Fredraw_frame (frame
);
7567 clear_current_matrices (f
);
7576 ++windows_or_buffers_changed
;
7581 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
7582 is non-zero update selected_frame. Value is non-zero if the
7583 mini-windows height has been changed. */
7586 echo_area_display (update_frame_p
)
7589 Lisp_Object mini_window
;
7592 int window_height_changed_p
= 0;
7593 struct frame
*sf
= SELECTED_FRAME ();
7595 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
7596 w
= XWINDOW (mini_window
);
7597 f
= XFRAME (WINDOW_FRAME (w
));
7599 /* Don't display if frame is invisible or not yet initialized. */
7600 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
7603 /* The terminal frame is used as the first Emacs frame on the Mac OS. */
7605 #ifdef HAVE_WINDOW_SYSTEM
7606 /* When Emacs starts, selected_frame may be a visible terminal
7607 frame, even if we run under a window system. If we let this
7608 through, a message would be displayed on the terminal. */
7609 if (!FRAME_WINDOW_P (XFRAME (selected_frame
))
7610 && !NILP (Vwindow_system
))
7612 #endif /* HAVE_WINDOW_SYSTEM */
7615 /* Redraw garbaged frames. */
7617 clear_garbaged_frames ();
7619 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
7621 echo_area_window
= mini_window
;
7622 window_height_changed_p
= display_echo_area (w
);
7623 w
->must_be_updated_p
= 1;
7625 /* Update the display, unless called from redisplay_internal.
7626 Also don't update the screen during redisplay itself. The
7627 update will happen at the end of redisplay, and an update
7628 here could cause confusion. */
7629 if (update_frame_p
&& !redisplaying_p
)
7633 /* If the display update has been interrupted by pending
7634 input, update mode lines in the frame. Due to the
7635 pending input, it might have been that redisplay hasn't
7636 been called, so that mode lines above the echo area are
7637 garbaged. This looks odd, so we prevent it here. */
7638 if (!display_completed
)
7639 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
7641 if (window_height_changed_p
7642 /* Don't do this if Emacs is shutting down. Redisplay
7643 needs to run hooks. */
7644 && !NILP (Vrun_hooks
))
7646 /* Must update other windows. Likewise as in other
7647 cases, don't let this update be interrupted by
7649 int count
= SPECPDL_INDEX ();
7650 specbind (Qredisplay_dont_pause
, Qt
);
7651 windows_or_buffers_changed
= 1;
7652 redisplay_internal (0);
7653 unbind_to (count
, Qnil
);
7655 else if (FRAME_WINDOW_P (f
) && n
== 0)
7657 /* Window configuration is the same as before.
7658 Can do with a display update of the echo area,
7659 unless we displayed some mode lines. */
7660 update_single_window (w
, 1);
7661 rif
->flush_display (f
);
7664 update_frame (f
, 1, 1);
7666 /* If cursor is in the echo area, make sure that the next
7667 redisplay displays the minibuffer, so that the cursor will
7668 be replaced with what the minibuffer wants. */
7669 if (cursor_in_echo_area
)
7670 ++windows_or_buffers_changed
;
7673 else if (!EQ (mini_window
, selected_window
))
7674 windows_or_buffers_changed
++;
7676 /* Last displayed message is now the current message. */
7677 echo_area_buffer
[1] = echo_area_buffer
[0];
7679 /* Prevent redisplay optimization in redisplay_internal by resetting
7680 this_line_start_pos. This is done because the mini-buffer now
7681 displays the message instead of its buffer text. */
7682 if (EQ (mini_window
, selected_window
))
7683 CHARPOS (this_line_start_pos
) = 0;
7685 return window_height_changed_p
;
7690 /***********************************************************************
7692 ***********************************************************************/
7695 /* The frame title buffering code is also used by Fformat_mode_line.
7696 So it is not conditioned by HAVE_WINDOW_SYSTEM. */
7698 /* A buffer for constructing frame titles in it; allocated from the
7699 heap in init_xdisp and resized as needed in store_frame_title_char. */
7701 static char *frame_title_buf
;
7703 /* The buffer's end, and a current output position in it. */
7705 static char *frame_title_buf_end
;
7706 static char *frame_title_ptr
;
7709 /* Store a single character C for the frame title in frame_title_buf.
7710 Re-allocate frame_title_buf if necessary. */
7714 store_frame_title_char (char c
)
7716 store_frame_title_char (c
)
7720 /* If output position has reached the end of the allocated buffer,
7721 double the buffer's size. */
7722 if (frame_title_ptr
== frame_title_buf_end
)
7724 int len
= frame_title_ptr
- frame_title_buf
;
7725 int new_size
= 2 * len
* sizeof *frame_title_buf
;
7726 frame_title_buf
= (char *) xrealloc (frame_title_buf
, new_size
);
7727 frame_title_buf_end
= frame_title_buf
+ new_size
;
7728 frame_title_ptr
= frame_title_buf
+ len
;
7731 *frame_title_ptr
++ = c
;
7735 /* Store part of a frame title in frame_title_buf, beginning at
7736 frame_title_ptr. STR is the string to store. Do not copy
7737 characters that yield more columns than PRECISION; PRECISION <= 0
7738 means copy the whole string. Pad with spaces until FIELD_WIDTH
7739 number of characters have been copied; FIELD_WIDTH <= 0 means don't
7740 pad. Called from display_mode_element when it is used to build a
7744 store_frame_title (str
, field_width
, precision
)
7745 const unsigned char *str
;
7746 int field_width
, precision
;
7751 /* Copy at most PRECISION chars from STR. */
7752 nbytes
= strlen (str
);
7753 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
7755 store_frame_title_char (*str
++);
7757 /* Fill up with spaces until FIELD_WIDTH reached. */
7758 while (field_width
> 0
7761 store_frame_title_char (' ');
7768 #ifdef HAVE_WINDOW_SYSTEM
7770 /* Set the title of FRAME, if it has changed. The title format is
7771 Vicon_title_format if FRAME is iconified, otherwise it is
7772 frame_title_format. */
7775 x_consider_frame_title (frame
)
7778 struct frame
*f
= XFRAME (frame
);
7780 if (FRAME_WINDOW_P (f
)
7781 || FRAME_MINIBUF_ONLY_P (f
)
7782 || f
->explicit_name
)
7784 /* Do we have more than one visible frame on this X display? */
7787 struct buffer
*obuf
;
7791 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
7793 Lisp_Object other_frame
= XCAR (tail
);
7794 struct frame
*tf
= XFRAME (other_frame
);
7797 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
7798 && !FRAME_MINIBUF_ONLY_P (tf
)
7799 && !EQ (other_frame
, tip_frame
)
7800 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
7804 /* Set global variable indicating that multiple frames exist. */
7805 multiple_frames
= CONSP (tail
);
7807 /* Switch to the buffer of selected window of the frame. Set up
7808 frame_title_ptr so that display_mode_element will output into it;
7809 then display the title. */
7810 obuf
= current_buffer
;
7811 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
7812 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
7813 frame_title_ptr
= frame_title_buf
;
7814 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
7815 NULL
, DEFAULT_FACE_ID
);
7816 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
7817 len
= frame_title_ptr
- frame_title_buf
;
7818 frame_title_ptr
= NULL
;
7819 set_buffer_internal_1 (obuf
);
7821 /* Set the title only if it's changed. This avoids consing in
7822 the common case where it hasn't. (If it turns out that we've
7823 already wasted too much time by walking through the list with
7824 display_mode_element, then we might need to optimize at a
7825 higher level than this.) */
7826 if (! STRINGP (f
->name
)
7827 || SBYTES (f
->name
) != len
7828 || bcmp (frame_title_buf
, SDATA (f
->name
), len
) != 0)
7829 x_implicitly_set_name (f
, make_string (frame_title_buf
, len
), Qnil
);
7833 #endif /* not HAVE_WINDOW_SYSTEM */
7838 /***********************************************************************
7840 ***********************************************************************/
7843 /* Prepare for redisplay by updating menu-bar item lists when
7844 appropriate. This can call eval. */
7847 prepare_menu_bars ()
7850 struct gcpro gcpro1
, gcpro2
;
7852 Lisp_Object tooltip_frame
;
7854 #ifdef HAVE_WINDOW_SYSTEM
7855 tooltip_frame
= tip_frame
;
7857 tooltip_frame
= Qnil
;
7860 /* Update all frame titles based on their buffer names, etc. We do
7861 this before the menu bars so that the buffer-menu will show the
7862 up-to-date frame titles. */
7863 #ifdef HAVE_WINDOW_SYSTEM
7864 if (windows_or_buffers_changed
|| update_mode_lines
)
7866 Lisp_Object tail
, frame
;
7868 FOR_EACH_FRAME (tail
, frame
)
7871 if (!EQ (frame
, tooltip_frame
)
7872 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
7873 x_consider_frame_title (frame
);
7876 #endif /* HAVE_WINDOW_SYSTEM */
7878 /* Update the menu bar item lists, if appropriate. This has to be
7879 done before any actual redisplay or generation of display lines. */
7880 all_windows
= (update_mode_lines
7881 || buffer_shared
> 1
7882 || windows_or_buffers_changed
);
7885 Lisp_Object tail
, frame
;
7886 int count
= SPECPDL_INDEX ();
7888 record_unwind_protect (Fset_match_data
, Fmatch_data (Qnil
, Qnil
));
7890 FOR_EACH_FRAME (tail
, frame
)
7894 /* Ignore tooltip frame. */
7895 if (EQ (frame
, tooltip_frame
))
7898 /* If a window on this frame changed size, report that to
7899 the user and clear the size-change flag. */
7900 if (FRAME_WINDOW_SIZES_CHANGED (f
))
7902 Lisp_Object functions
;
7904 /* Clear flag first in case we get an error below. */
7905 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
7906 functions
= Vwindow_size_change_functions
;
7907 GCPRO2 (tail
, functions
);
7909 while (CONSP (functions
))
7911 call1 (XCAR (functions
), frame
);
7912 functions
= XCDR (functions
);
7918 update_menu_bar (f
, 0);
7919 #ifdef HAVE_WINDOW_SYSTEM
7920 update_tool_bar (f
, 0);
7925 unbind_to (count
, Qnil
);
7929 struct frame
*sf
= SELECTED_FRAME ();
7930 update_menu_bar (sf
, 1);
7931 #ifdef HAVE_WINDOW_SYSTEM
7932 update_tool_bar (sf
, 1);
7936 /* Motif needs this. See comment in xmenu.c. Turn it off when
7937 pending_menu_activation is not defined. */
7938 #ifdef USE_X_TOOLKIT
7939 pending_menu_activation
= 0;
7944 /* Update the menu bar item list for frame F. This has to be done
7945 before we start to fill in any display lines, because it can call
7948 If SAVE_MATCH_DATA is non-zero, we must save and restore it here. */
7951 update_menu_bar (f
, save_match_data
)
7953 int save_match_data
;
7956 register struct window
*w
;
7958 /* If called recursively during a menu update, do nothing. This can
7959 happen when, for instance, an activate-menubar-hook causes a
7961 if (inhibit_menubar_update
)
7964 window
= FRAME_SELECTED_WINDOW (f
);
7965 w
= XWINDOW (window
);
7967 #if 0 /* The if statement below this if statement used to include the
7968 condition !NILP (w->update_mode_line), rather than using
7969 update_mode_lines directly, and this if statement may have
7970 been added to make that condition work. Now the if
7971 statement below matches its comment, this isn't needed. */
7972 if (update_mode_lines
)
7973 w
->update_mode_line
= Qt
;
7976 if (FRAME_WINDOW_P (f
)
7978 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
7979 || defined (USE_GTK)
7980 FRAME_EXTERNAL_MENU_BAR (f
)
7982 FRAME_MENU_BAR_LINES (f
) > 0
7984 : FRAME_MENU_BAR_LINES (f
) > 0)
7986 /* If the user has switched buffers or windows, we need to
7987 recompute to reflect the new bindings. But we'll
7988 recompute when update_mode_lines is set too; that means
7989 that people can use force-mode-line-update to request
7990 that the menu bar be recomputed. The adverse effect on
7991 the rest of the redisplay algorithm is about the same as
7992 windows_or_buffers_changed anyway. */
7993 if (windows_or_buffers_changed
7994 /* This used to test w->update_mode_line, but we believe
7995 there is no need to recompute the menu in that case. */
7996 || update_mode_lines
7997 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
7998 < BUF_MODIFF (XBUFFER (w
->buffer
)))
7999 != !NILP (w
->last_had_star
))
8000 || ((!NILP (Vtransient_mark_mode
)
8001 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
8002 != !NILP (w
->region_showing
)))
8004 struct buffer
*prev
= current_buffer
;
8005 int count
= SPECPDL_INDEX ();
8007 specbind (Qinhibit_menubar_update
, Qt
);
8009 set_buffer_internal_1 (XBUFFER (w
->buffer
));
8010 if (save_match_data
)
8011 record_unwind_protect (Fset_match_data
, Fmatch_data (Qnil
, Qnil
));
8012 if (NILP (Voverriding_local_map_menu_flag
))
8014 specbind (Qoverriding_terminal_local_map
, Qnil
);
8015 specbind (Qoverriding_local_map
, Qnil
);
8018 /* Run the Lucid hook. */
8019 safe_run_hooks (Qactivate_menubar_hook
);
8021 /* If it has changed current-menubar from previous value,
8022 really recompute the menu-bar from the value. */
8023 if (! NILP (Vlucid_menu_bar_dirty_flag
))
8024 call0 (Qrecompute_lucid_menubar
);
8026 safe_run_hooks (Qmenu_bar_update_hook
);
8027 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
8029 /* Redisplay the menu bar in case we changed it. */
8030 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
8031 || defined (USE_GTK)
8032 if (FRAME_WINDOW_P (f
)
8033 #if defined (MAC_OS)
8034 /* All frames on Mac OS share the same menubar. So only the
8035 selected frame should be allowed to set it. */
8036 && f
== SELECTED_FRAME ()
8039 set_frame_menubar (f
, 0, 0);
8041 /* On a terminal screen, the menu bar is an ordinary screen
8042 line, and this makes it get updated. */
8043 w
->update_mode_line
= Qt
;
8044 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || MAC_OS || USE_GTK) */
8045 /* In the non-toolkit version, the menu bar is an ordinary screen
8046 line, and this makes it get updated. */
8047 w
->update_mode_line
= Qt
;
8048 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || MAC_OS || USE_GTK) */
8050 unbind_to (count
, Qnil
);
8051 set_buffer_internal_1 (prev
);
8058 /***********************************************************************
8060 ***********************************************************************/
8062 #ifdef HAVE_WINDOW_SYSTEM
8065 Nominal cursor position -- where to draw output.
8066 HPOS and VPOS are window relative glyph matrix coordinates.
8067 X and Y are window relative pixel coordinates. */
8069 struct cursor_pos output_cursor
;
8073 Set the global variable output_cursor to CURSOR. All cursor
8074 positions are relative to updated_window. */
8077 set_output_cursor (cursor
)
8078 struct cursor_pos
*cursor
;
8080 output_cursor
.hpos
= cursor
->hpos
;
8081 output_cursor
.vpos
= cursor
->vpos
;
8082 output_cursor
.x
= cursor
->x
;
8083 output_cursor
.y
= cursor
->y
;
8088 Set a nominal cursor position.
8090 HPOS and VPOS are column/row positions in a window glyph matrix. X
8091 and Y are window text area relative pixel positions.
8093 If this is done during an update, updated_window will contain the
8094 window that is being updated and the position is the future output
8095 cursor position for that window. If updated_window is null, use
8096 selected_window and display the cursor at the given position. */
8099 x_cursor_to (vpos
, hpos
, y
, x
)
8100 int vpos
, hpos
, y
, x
;
8104 /* If updated_window is not set, work on selected_window. */
8108 w
= XWINDOW (selected_window
);
8110 /* Set the output cursor. */
8111 output_cursor
.hpos
= hpos
;
8112 output_cursor
.vpos
= vpos
;
8113 output_cursor
.x
= x
;
8114 output_cursor
.y
= y
;
8116 /* If not called as part of an update, really display the cursor.
8117 This will also set the cursor position of W. */
8118 if (updated_window
== NULL
)
8121 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
8122 if (rif
->flush_display_optional
)
8123 rif
->flush_display_optional (SELECTED_FRAME ());
8128 #endif /* HAVE_WINDOW_SYSTEM */
8131 /***********************************************************************
8133 ***********************************************************************/
8135 #ifdef HAVE_WINDOW_SYSTEM
8137 /* Where the mouse was last time we reported a mouse event. */
8139 FRAME_PTR last_mouse_frame
;
8141 /* Tool-bar item index of the item on which a mouse button was pressed
8144 int last_tool_bar_item
;
8147 /* Update the tool-bar item list for frame F. This has to be done
8148 before we start to fill in any display lines. Called from
8149 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
8150 and restore it here. */
8153 update_tool_bar (f
, save_match_data
)
8155 int save_match_data
;
8158 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
8160 int do_update
= WINDOWP (f
->tool_bar_window
)
8161 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
8169 window
= FRAME_SELECTED_WINDOW (f
);
8170 w
= XWINDOW (window
);
8172 /* If the user has switched buffers or windows, we need to
8173 recompute to reflect the new bindings. But we'll
8174 recompute when update_mode_lines is set too; that means
8175 that people can use force-mode-line-update to request
8176 that the menu bar be recomputed. The adverse effect on
8177 the rest of the redisplay algorithm is about the same as
8178 windows_or_buffers_changed anyway. */
8179 if (windows_or_buffers_changed
8180 || !NILP (w
->update_mode_line
)
8181 || update_mode_lines
8182 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
8183 < BUF_MODIFF (XBUFFER (w
->buffer
)))
8184 != !NILP (w
->last_had_star
))
8185 || ((!NILP (Vtransient_mark_mode
)
8186 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
8187 != !NILP (w
->region_showing
)))
8189 struct buffer
*prev
= current_buffer
;
8190 int count
= SPECPDL_INDEX ();
8191 Lisp_Object old_tool_bar
;
8192 struct gcpro gcpro1
;
8194 /* Set current_buffer to the buffer of the selected
8195 window of the frame, so that we get the right local
8197 set_buffer_internal_1 (XBUFFER (w
->buffer
));
8199 /* Save match data, if we must. */
8200 if (save_match_data
)
8201 record_unwind_protect (Fset_match_data
, Fmatch_data (Qnil
, Qnil
));
8203 /* Make sure that we don't accidentally use bogus keymaps. */
8204 if (NILP (Voverriding_local_map_menu_flag
))
8206 specbind (Qoverriding_terminal_local_map
, Qnil
);
8207 specbind (Qoverriding_local_map
, Qnil
);
8210 old_tool_bar
= f
->tool_bar_items
;
8211 GCPRO1 (old_tool_bar
);
8213 /* Build desired tool-bar items from keymaps. */
8216 = tool_bar_items (f
->tool_bar_items
, &f
->n_tool_bar_items
);
8219 /* Redisplay the tool-bar if we changed it. */
8220 if (! NILP (Fequal (old_tool_bar
, f
->tool_bar_items
)))
8221 w
->update_mode_line
= Qt
;
8225 unbind_to (count
, Qnil
);
8226 set_buffer_internal_1 (prev
);
8232 /* Set F->desired_tool_bar_string to a Lisp string representing frame
8233 F's desired tool-bar contents. F->tool_bar_items must have
8234 been set up previously by calling prepare_menu_bars. */
8237 build_desired_tool_bar_string (f
)
8240 int i
, size
, size_needed
;
8241 struct gcpro gcpro1
, gcpro2
, gcpro3
;
8242 Lisp_Object image
, plist
, props
;
8244 image
= plist
= props
= Qnil
;
8245 GCPRO3 (image
, plist
, props
);
8247 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
8248 Otherwise, make a new string. */
8250 /* The size of the string we might be able to reuse. */
8251 size
= (STRINGP (f
->desired_tool_bar_string
)
8252 ? SCHARS (f
->desired_tool_bar_string
)
8255 /* We need one space in the string for each image. */
8256 size_needed
= f
->n_tool_bar_items
;
8258 /* Reuse f->desired_tool_bar_string, if possible. */
8259 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
8260 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
8264 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
8265 Fremove_text_properties (make_number (0), make_number (size
),
8266 props
, f
->desired_tool_bar_string
);
8269 /* Put a `display' property on the string for the images to display,
8270 put a `menu_item' property on tool-bar items with a value that
8271 is the index of the item in F's tool-bar item vector. */
8272 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
8274 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
8276 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
8277 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
8278 int hmargin
, vmargin
, relief
, idx
, end
;
8279 extern Lisp_Object QCrelief
, QCmargin
, QCconversion
, Qimage
;
8281 /* If image is a vector, choose the image according to the
8283 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
8284 if (VECTORP (image
))
8288 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
8289 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
8292 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
8293 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
8295 xassert (ASIZE (image
) >= idx
);
8296 image
= AREF (image
, idx
);
8301 /* Ignore invalid image specifications. */
8302 if (!valid_image_p (image
))
8305 /* Display the tool-bar button pressed, or depressed. */
8306 plist
= Fcopy_sequence (XCDR (image
));
8308 /* Compute margin and relief to draw. */
8309 relief
= (tool_bar_button_relief
>= 0
8310 ? tool_bar_button_relief
8311 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
8312 hmargin
= vmargin
= relief
;
8314 if (INTEGERP (Vtool_bar_button_margin
)
8315 && XINT (Vtool_bar_button_margin
) > 0)
8317 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
8318 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
8320 else if (CONSP (Vtool_bar_button_margin
))
8322 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
8323 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
8324 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
8326 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
8327 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
8328 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
8331 if (auto_raise_tool_bar_buttons_p
)
8333 /* Add a `:relief' property to the image spec if the item is
8337 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
8344 /* If image is selected, display it pressed, i.e. with a
8345 negative relief. If it's not selected, display it with a
8347 plist
= Fplist_put (plist
, QCrelief
,
8349 ? make_number (-relief
)
8350 : make_number (relief
)));
8355 /* Put a margin around the image. */
8356 if (hmargin
|| vmargin
)
8358 if (hmargin
== vmargin
)
8359 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
8361 plist
= Fplist_put (plist
, QCmargin
,
8362 Fcons (make_number (hmargin
),
8363 make_number (vmargin
)));
8366 /* If button is not enabled, and we don't have special images
8367 for the disabled state, make the image appear disabled by
8368 applying an appropriate algorithm to it. */
8369 if (!enabled_p
&& idx
< 0)
8370 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
8372 /* Put a `display' text property on the string for the image to
8373 display. Put a `menu-item' property on the string that gives
8374 the start of this item's properties in the tool-bar items
8376 image
= Fcons (Qimage
, plist
);
8377 props
= list4 (Qdisplay
, image
,
8378 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
8380 /* Let the last image hide all remaining spaces in the tool bar
8381 string. The string can be longer than needed when we reuse a
8383 if (i
+ 1 == f
->n_tool_bar_items
)
8384 end
= SCHARS (f
->desired_tool_bar_string
);
8387 Fadd_text_properties (make_number (i
), make_number (end
),
8388 props
, f
->desired_tool_bar_string
);
8396 /* Display one line of the tool-bar of frame IT->f. */
8399 display_tool_bar_line (it
)
8402 struct glyph_row
*row
= it
->glyph_row
;
8403 int max_x
= it
->last_visible_x
;
8406 prepare_desired_row (row
);
8407 row
->y
= it
->current_y
;
8409 /* Note that this isn't made use of if the face hasn't a box,
8410 so there's no need to check the face here. */
8411 it
->start_of_box_run_p
= 1;
8413 while (it
->current_x
< max_x
)
8415 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
8417 /* Get the next display element. */
8418 if (!get_next_display_element (it
))
8421 /* Produce glyphs. */
8422 x_before
= it
->current_x
;
8423 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
8424 PRODUCE_GLYPHS (it
);
8426 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
8431 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
8433 if (x
+ glyph
->pixel_width
> max_x
)
8435 /* Glyph doesn't fit on line. */
8436 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
8442 x
+= glyph
->pixel_width
;
8446 /* Stop at line ends. */
8447 if (ITERATOR_AT_END_OF_LINE_P (it
))
8450 set_iterator_to_next (it
, 1);
8455 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
8456 extend_face_to_end_of_line (it
);
8457 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
8458 last
->right_box_line_p
= 1;
8459 if (last
== row
->glyphs
[TEXT_AREA
])
8460 last
->left_box_line_p
= 1;
8461 compute_line_metrics (it
);
8463 /* If line is empty, make it occupy the rest of the tool-bar. */
8464 if (!row
->displays_text_p
)
8466 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
8467 row
->ascent
= row
->phys_ascent
= 0;
8470 row
->full_width_p
= 1;
8471 row
->continued_p
= 0;
8472 row
->truncated_on_left_p
= 0;
8473 row
->truncated_on_right_p
= 0;
8475 it
->current_x
= it
->hpos
= 0;
8476 it
->current_y
+= row
->height
;
8482 /* Value is the number of screen lines needed to make all tool-bar
8483 items of frame F visible. */
8486 tool_bar_lines_needed (f
)
8489 struct window
*w
= XWINDOW (f
->tool_bar_window
);
8492 /* Initialize an iterator for iteration over
8493 F->desired_tool_bar_string in the tool-bar window of frame F. */
8494 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
8495 it
.first_visible_x
= 0;
8496 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
8497 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
8499 while (!ITERATOR_AT_END_P (&it
))
8501 it
.glyph_row
= w
->desired_matrix
->rows
;
8502 clear_glyph_row (it
.glyph_row
);
8503 display_tool_bar_line (&it
);
8506 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
8510 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
8512 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
8521 frame
= selected_frame
;
8523 CHECK_FRAME (frame
);
8526 if (WINDOWP (f
->tool_bar_window
)
8527 || (w
= XWINDOW (f
->tool_bar_window
),
8528 WINDOW_TOTAL_LINES (w
) > 0))
8530 update_tool_bar (f
, 1);
8531 if (f
->n_tool_bar_items
)
8533 build_desired_tool_bar_string (f
);
8534 nlines
= tool_bar_lines_needed (f
);
8538 return make_number (nlines
);
8542 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
8543 height should be changed. */
8546 redisplay_tool_bar (f
)
8551 struct glyph_row
*row
;
8552 int change_height_p
= 0;
8555 if (FRAME_EXTERNAL_TOOL_BAR (f
))
8556 update_frame_tool_bar (f
);
8560 /* If frame hasn't a tool-bar window or if it is zero-height, don't
8561 do anything. This means you must start with tool-bar-lines
8562 non-zero to get the auto-sizing effect. Or in other words, you
8563 can turn off tool-bars by specifying tool-bar-lines zero. */
8564 if (!WINDOWP (f
->tool_bar_window
)
8565 || (w
= XWINDOW (f
->tool_bar_window
),
8566 WINDOW_TOTAL_LINES (w
) == 0))
8569 /* Set up an iterator for the tool-bar window. */
8570 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
8571 it
.first_visible_x
= 0;
8572 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
8575 /* Build a string that represents the contents of the tool-bar. */
8576 build_desired_tool_bar_string (f
);
8577 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
8579 /* Display as many lines as needed to display all tool-bar items. */
8580 while (it
.current_y
< it
.last_visible_y
)
8581 display_tool_bar_line (&it
);
8583 /* It doesn't make much sense to try scrolling in the tool-bar
8584 window, so don't do it. */
8585 w
->desired_matrix
->no_scrolling_p
= 1;
8586 w
->must_be_updated_p
= 1;
8588 if (auto_resize_tool_bars_p
)
8592 /* If we couldn't display everything, change the tool-bar's
8594 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
)
8595 change_height_p
= 1;
8597 /* If there are blank lines at the end, except for a partially
8598 visible blank line at the end that is smaller than
8599 FRAME_LINE_HEIGHT, change the tool-bar's height. */
8600 row
= it
.glyph_row
- 1;
8601 if (!row
->displays_text_p
8602 && row
->height
>= FRAME_LINE_HEIGHT (f
))
8603 change_height_p
= 1;
8605 /* If row displays tool-bar items, but is partially visible,
8606 change the tool-bar's height. */
8607 if (row
->displays_text_p
8608 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
)
8609 change_height_p
= 1;
8611 /* Resize windows as needed by changing the `tool-bar-lines'
8614 && (nlines
= tool_bar_lines_needed (f
),
8615 nlines
!= WINDOW_TOTAL_LINES (w
)))
8617 extern Lisp_Object Qtool_bar_lines
;
8619 int old_height
= WINDOW_TOTAL_LINES (w
);
8621 XSETFRAME (frame
, f
);
8622 clear_glyph_matrix (w
->desired_matrix
);
8623 Fmodify_frame_parameters (frame
,
8624 Fcons (Fcons (Qtool_bar_lines
,
8625 make_number (nlines
)),
8627 if (WINDOW_TOTAL_LINES (w
) != old_height
)
8628 fonts_changed_p
= 1;
8632 return change_height_p
;
8636 /* Get information about the tool-bar item which is displayed in GLYPH
8637 on frame F. Return in *PROP_IDX the index where tool-bar item
8638 properties start in F->tool_bar_items. Value is zero if
8639 GLYPH doesn't display a tool-bar item. */
8642 tool_bar_item_info (f
, glyph
, prop_idx
)
8644 struct glyph
*glyph
;
8651 /* This function can be called asynchronously, which means we must
8652 exclude any possibility that Fget_text_property signals an
8654 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
8655 charpos
= max (0, charpos
);
8657 /* Get the text property `menu-item' at pos. The value of that
8658 property is the start index of this item's properties in
8659 F->tool_bar_items. */
8660 prop
= Fget_text_property (make_number (charpos
),
8661 Qmenu_item
, f
->current_tool_bar_string
);
8662 if (INTEGERP (prop
))
8664 *prop_idx
= XINT (prop
);
8674 /* Get information about the tool-bar item at position X/Y on frame F.
8675 Return in *GLYPH a pointer to the glyph of the tool-bar item in
8676 the current matrix of the tool-bar window of F, or NULL if not
8677 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
8678 item in F->tool_bar_items. Value is
8680 -1 if X/Y is not on a tool-bar item
8681 0 if X/Y is on the same item that was highlighted before.
8685 get_tool_bar_item (f
, x
, y
, glyph
, hpos
, vpos
, prop_idx
)
8688 struct glyph
**glyph
;
8689 int *hpos
, *vpos
, *prop_idx
;
8691 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
8692 struct window
*w
= XWINDOW (f
->tool_bar_window
);
8695 /* Find the glyph under X/Y. */
8696 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, &area
, 0);
8700 /* Get the start of this tool-bar item's properties in
8701 f->tool_bar_items. */
8702 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
8705 /* Is mouse on the highlighted item? */
8706 if (EQ (f
->tool_bar_window
, dpyinfo
->mouse_face_window
)
8707 && *vpos
>= dpyinfo
->mouse_face_beg_row
8708 && *vpos
<= dpyinfo
->mouse_face_end_row
8709 && (*vpos
> dpyinfo
->mouse_face_beg_row
8710 || *hpos
>= dpyinfo
->mouse_face_beg_col
)
8711 && (*vpos
< dpyinfo
->mouse_face_end_row
8712 || *hpos
< dpyinfo
->mouse_face_end_col
8713 || dpyinfo
->mouse_face_past_end
))
8721 Handle mouse button event on the tool-bar of frame F, at
8722 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
8723 0 for button release. MODIFIERS is event modifiers for button
8727 handle_tool_bar_click (f
, x
, y
, down_p
, modifiers
)
8730 unsigned int modifiers
;
8732 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
8733 struct window
*w
= XWINDOW (f
->tool_bar_window
);
8734 int hpos
, vpos
, prop_idx
;
8735 struct glyph
*glyph
;
8736 Lisp_Object enabled_p
;
8738 /* If not on the highlighted tool-bar item, return. */
8739 frame_to_window_pixel_xy (w
, &x
, &y
);
8740 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
8743 /* If item is disabled, do nothing. */
8744 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
8745 if (NILP (enabled_p
))
8750 /* Show item in pressed state. */
8751 show_mouse_face (dpyinfo
, DRAW_IMAGE_SUNKEN
);
8752 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
8753 last_tool_bar_item
= prop_idx
;
8757 Lisp_Object key
, frame
;
8758 struct input_event event
;
8761 /* Show item in released state. */
8762 show_mouse_face (dpyinfo
, DRAW_IMAGE_RAISED
);
8763 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
8765 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
8767 XSETFRAME (frame
, f
);
8768 event
.kind
= TOOL_BAR_EVENT
;
8769 event
.frame_or_window
= frame
;
8771 kbd_buffer_store_event (&event
);
8773 event
.kind
= TOOL_BAR_EVENT
;
8774 event
.frame_or_window
= frame
;
8776 event
.modifiers
= modifiers
;
8777 kbd_buffer_store_event (&event
);
8778 last_tool_bar_item
= -1;
8783 /* Possibly highlight a tool-bar item on frame F when mouse moves to
8784 tool-bar window-relative coordinates X/Y. Called from
8785 note_mouse_highlight. */
8788 note_tool_bar_highlight (f
, x
, y
)
8792 Lisp_Object window
= f
->tool_bar_window
;
8793 struct window
*w
= XWINDOW (window
);
8794 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
8796 struct glyph
*glyph
;
8797 struct glyph_row
*row
;
8799 Lisp_Object enabled_p
;
8801 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
8802 int mouse_down_p
, rc
;
8804 /* Function note_mouse_highlight is called with negative x(y
8805 values when mouse moves outside of the frame. */
8806 if (x
<= 0 || y
<= 0)
8808 clear_mouse_face (dpyinfo
);
8812 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
8815 /* Not on tool-bar item. */
8816 clear_mouse_face (dpyinfo
);
8820 /* On same tool-bar item as before. */
8823 clear_mouse_face (dpyinfo
);
8825 /* Mouse is down, but on different tool-bar item? */
8826 mouse_down_p
= (dpyinfo
->grabbed
8827 && f
== last_mouse_frame
8828 && FRAME_LIVE_P (f
));
8830 && last_tool_bar_item
!= prop_idx
)
8833 dpyinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
8834 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
8836 /* If tool-bar item is not enabled, don't highlight it. */
8837 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
8838 if (!NILP (enabled_p
))
8840 /* Compute the x-position of the glyph. In front and past the
8841 image is a space. We include this in the highlighted area. */
8842 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
8843 for (i
= x
= 0; i
< hpos
; ++i
)
8844 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
8846 /* Record this as the current active region. */
8847 dpyinfo
->mouse_face_beg_col
= hpos
;
8848 dpyinfo
->mouse_face_beg_row
= vpos
;
8849 dpyinfo
->mouse_face_beg_x
= x
;
8850 dpyinfo
->mouse_face_beg_y
= row
->y
;
8851 dpyinfo
->mouse_face_past_end
= 0;
8853 dpyinfo
->mouse_face_end_col
= hpos
+ 1;
8854 dpyinfo
->mouse_face_end_row
= vpos
;
8855 dpyinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
8856 dpyinfo
->mouse_face_end_y
= row
->y
;
8857 dpyinfo
->mouse_face_window
= window
;
8858 dpyinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
8860 /* Display it as active. */
8861 show_mouse_face (dpyinfo
, draw
);
8862 dpyinfo
->mouse_face_image_state
= draw
;
8867 /* Set help_echo_string to a help string to display for this tool-bar item.
8868 XTread_socket does the rest. */
8869 help_echo_object
= help_echo_window
= Qnil
;
8871 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
8872 if (NILP (help_echo_string
))
8873 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
8876 #endif /* HAVE_WINDOW_SYSTEM */
8880 /***********************************************************************
8882 ***********************************************************************/
8884 #ifdef HAVE_WINDOW_SYSTEM
8886 /* An arrow like this: `<-'. */
8887 static unsigned char left_bits
[] = {
8888 0x18, 0x0c, 0x06, 0x3f, 0x3f, 0x06, 0x0c, 0x18};
8890 /* Right truncation arrow bitmap `->'. */
8891 static unsigned char right_bits
[] = {
8892 0x18, 0x30, 0x60, 0xfc, 0xfc, 0x60, 0x30, 0x18};
8894 /* Marker for continued lines. */
8895 static unsigned char continued_bits
[] = {
8896 0x3c, 0x7c, 0xc0, 0xe4, 0xfc, 0x7c, 0x3c, 0x7c};
8898 /* Marker for continuation lines. */
8899 static unsigned char continuation_bits
[] = {
8900 0x3c, 0x3e, 0x03, 0x27, 0x3f, 0x3e, 0x3c, 0x3e};
8902 /* Overlay arrow bitmap. A triangular arrow. */
8903 static unsigned char ov_bits
[] = {
8904 0x03, 0x0f, 0x1f, 0x3f, 0x3f, 0x1f, 0x0f, 0x03};
8906 /* Bitmap drawn to indicate lines not displaying text if
8907 `indicate-empty-lines' is non-nil. */
8908 static unsigned char zv_bits
[] = {
8909 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00,
8910 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00,
8911 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00,
8912 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00,
8913 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00,
8914 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00,
8915 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00,
8916 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00};
8918 struct fringe_bitmap fringe_bitmaps
[MAX_FRINGE_BITMAPS
] =
8920 { 0, 0, 0, NULL
/* NO_FRINGE_BITMAP */ },
8921 { 8, sizeof (left_bits
), 0, left_bits
},
8922 { 8, sizeof (right_bits
), 0, right_bits
},
8923 { 8, sizeof (continued_bits
), 0, continued_bits
},
8924 { 8, sizeof (continuation_bits
), 0, continuation_bits
},
8925 { 8, sizeof (ov_bits
), 0, ov_bits
},
8926 { 8, sizeof (zv_bits
), 3, zv_bits
}
8930 /* Draw the bitmap WHICH in one of the left or right fringes of
8931 window W. ROW is the glyph row for which to display the bitmap; it
8932 determines the vertical position at which the bitmap has to be
8936 draw_fringe_bitmap (w
, row
, which
, left_p
)
8938 struct glyph_row
*row
;
8939 enum fringe_bitmap_type which
;
8942 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
8943 struct draw_fringe_bitmap_params p
;
8945 /* Convert row to frame coordinates. */
8946 p
.y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
8949 p
.wd
= fringe_bitmaps
[which
].width
;
8951 p
.h
= fringe_bitmaps
[which
].height
;
8952 p
.dh
= (fringe_bitmaps
[which
].period
8953 ? (p
.y
% fringe_bitmaps
[which
].period
)
8956 /* Clip bitmap if too high. */
8957 if (p
.h
> row
->height
)
8960 p
.face
= FACE_FROM_ID (f
, FRINGE_FACE_ID
);
8961 PREPARE_FACE_FOR_DISPLAY (f
, p
.face
);
8963 /* Clear left fringe if no bitmap to draw or if bitmap doesn't fill
8968 int wd
= WINDOW_LEFT_FRINGE_WIDTH (w
);
8969 int x
= window_box_left (w
, (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
8974 p
.x
= x
- p
.wd
- (wd
- p
.wd
) / 2;
8976 if (p
.wd
< wd
|| row
->height
> p
.h
)
8978 /* If W has a vertical border to its left, don't draw over it. */
8979 wd
-= ((!WINDOW_LEFTMOST_P (w
)
8980 && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
8988 int x
= window_box_right (w
,
8989 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
8992 int wd
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
8995 p
.x
= x
+ (wd
- p
.wd
) / 2;
8996 /* Clear right fringe if no bitmap to draw of if bitmap doesn't fill
8998 if (p
.wd
< wd
|| row
->height
> p
.h
)
9007 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
9009 p
.by
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, row
->y
));
9010 p
.ny
= row
->visible_height
;
9013 /* Adjust y to the offset in the row to start drawing the bitmap. */
9014 p
.y
+= (row
->height
- p
.h
) / 2;
9016 rif
->draw_fringe_bitmap (w
, row
, &p
);
9019 /* Draw fringe bitmaps for glyph row ROW on window W. Call this
9020 function with input blocked. */
9023 draw_row_fringe_bitmaps (w
, row
)
9025 struct glyph_row
*row
;
9027 enum fringe_bitmap_type bitmap
;
9029 xassert (interrupt_input_blocked
);
9031 /* If row is completely invisible, because of vscrolling, we
9032 don't have to draw anything. */
9033 if (row
->visible_height
<= 0)
9036 if (WINDOW_LEFT_FRINGE_WIDTH (w
) != 0)
9038 /* Decide which bitmap to draw in the left fringe. */
9039 if (row
->overlay_arrow_p
)
9040 bitmap
= OVERLAY_ARROW_BITMAP
;
9041 else if (row
->truncated_on_left_p
)
9042 bitmap
= LEFT_TRUNCATION_BITMAP
;
9043 else if (MATRIX_ROW_CONTINUATION_LINE_P (row
))
9044 bitmap
= CONTINUATION_LINE_BITMAP
;
9045 else if (row
->indicate_empty_line_p
)
9046 bitmap
= ZV_LINE_BITMAP
;
9048 bitmap
= NO_FRINGE_BITMAP
;
9050 draw_fringe_bitmap (w
, row
, bitmap
, 1);
9053 if (WINDOW_RIGHT_FRINGE_WIDTH (w
) != 0)
9055 /* Decide which bitmap to draw in the right fringe. */
9056 if (row
->truncated_on_right_p
)
9057 bitmap
= RIGHT_TRUNCATION_BITMAP
;
9058 else if (row
->continued_p
)
9059 bitmap
= CONTINUED_LINE_BITMAP
;
9060 else if (row
->indicate_empty_line_p
&& WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
9061 bitmap
= ZV_LINE_BITMAP
;
9063 bitmap
= NO_FRINGE_BITMAP
;
9065 draw_fringe_bitmap (w
, row
, bitmap
, 0);
9070 /* Compute actual fringe widths for frame F.
9072 If REDRAW is 1, redraw F if the fringe settings was actually
9073 modified and F is visible.
9075 Since the combined left and right fringe must occupy an integral
9076 number of columns, we may need to add some pixels to each fringe.
9077 Typically, we add an equal amount (+/- 1 pixel) to each fringe,
9078 but a negative width value is taken literally (after negating it).
9080 We never make the fringes narrower than specified. It is planned
9081 to make fringe bitmaps customizable and expandable, and at that
9082 time, the user will typically specify the minimum number of pixels
9083 needed for his bitmaps, so we shouldn't select anything less than
9088 compute_fringe_widths (f
, redraw
)
9092 int o_left
= FRAME_LEFT_FRINGE_WIDTH (f
);
9093 int o_right
= FRAME_RIGHT_FRINGE_WIDTH (f
);
9094 int o_cols
= FRAME_FRINGE_COLS (f
);
9096 Lisp_Object left_fringe
= Fassq (Qleft_fringe
, f
->param_alist
);
9097 Lisp_Object right_fringe
= Fassq (Qright_fringe
, f
->param_alist
);
9098 int left_fringe_width
, right_fringe_width
;
9100 if (!NILP (left_fringe
))
9101 left_fringe
= Fcdr (left_fringe
);
9102 if (!NILP (right_fringe
))
9103 right_fringe
= Fcdr (right_fringe
);
9105 left_fringe_width
= ((NILP (left_fringe
) || !INTEGERP (left_fringe
)) ? 8 :
9106 XINT (left_fringe
));
9107 right_fringe_width
= ((NILP (right_fringe
) || !INTEGERP (right_fringe
)) ? 8 :
9108 XINT (right_fringe
));
9110 if (left_fringe_width
|| right_fringe_width
)
9112 int left_wid
= left_fringe_width
>= 0 ? left_fringe_width
: -left_fringe_width
;
9113 int right_wid
= right_fringe_width
>= 0 ? right_fringe_width
: -right_fringe_width
;
9114 int conf_wid
= left_wid
+ right_wid
;
9115 int font_wid
= FRAME_COLUMN_WIDTH (f
);
9116 int cols
= (left_wid
+ right_wid
+ font_wid
-1) / font_wid
;
9117 int real_wid
= cols
* font_wid
;
9118 if (left_wid
&& right_wid
)
9120 if (left_fringe_width
< 0)
9122 /* Left fringe width is fixed, adjust right fringe if necessary */
9123 FRAME_LEFT_FRINGE_WIDTH (f
) = left_wid
;
9124 FRAME_RIGHT_FRINGE_WIDTH (f
) = real_wid
- left_wid
;
9126 else if (right_fringe_width
< 0)
9128 /* Right fringe width is fixed, adjust left fringe if necessary */
9129 FRAME_LEFT_FRINGE_WIDTH (f
) = real_wid
- right_wid
;
9130 FRAME_RIGHT_FRINGE_WIDTH (f
) = right_wid
;
9134 /* Adjust both fringes with an equal amount.
9135 Note that we are doing integer arithmetic here, so don't
9136 lose a pixel if the total width is an odd number. */
9137 int fill
= real_wid
- conf_wid
;
9138 FRAME_LEFT_FRINGE_WIDTH (f
) = left_wid
+ fill
/2;
9139 FRAME_RIGHT_FRINGE_WIDTH (f
) = right_wid
+ fill
- fill
/2;
9142 else if (left_fringe_width
)
9144 FRAME_LEFT_FRINGE_WIDTH (f
) = real_wid
;
9145 FRAME_RIGHT_FRINGE_WIDTH (f
) = 0;
9149 FRAME_LEFT_FRINGE_WIDTH (f
) = 0;
9150 FRAME_RIGHT_FRINGE_WIDTH (f
) = real_wid
;
9152 FRAME_FRINGE_COLS (f
) = cols
;
9156 FRAME_LEFT_FRINGE_WIDTH (f
) = 0;
9157 FRAME_RIGHT_FRINGE_WIDTH (f
) = 0;
9158 FRAME_FRINGE_COLS (f
) = 0;
9161 if (redraw
&& FRAME_VISIBLE_P (f
))
9162 if (o_left
!= FRAME_LEFT_FRINGE_WIDTH (f
) ||
9163 o_right
!= FRAME_RIGHT_FRINGE_WIDTH (f
) ||
9164 o_cols
!= FRAME_FRINGE_COLS (f
))
9168 #endif /* HAVE_WINDOW_SYSTEM */
9172 /************************************************************************
9173 Horizontal scrolling
9174 ************************************************************************/
9176 static int hscroll_window_tree
P_ ((Lisp_Object
));
9177 static int hscroll_windows
P_ ((Lisp_Object
));
9179 /* For all leaf windows in the window tree rooted at WINDOW, set their
9180 hscroll value so that PT is (i) visible in the window, and (ii) so
9181 that it is not within a certain margin at the window's left and
9182 right border. Value is non-zero if any window's hscroll has been
9186 hscroll_window_tree (window
)
9189 int hscrolled_p
= 0;
9190 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
9191 int hscroll_step_abs
= 0;
9192 double hscroll_step_rel
= 0;
9194 if (hscroll_relative_p
)
9196 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
9197 if (hscroll_step_rel
< 0)
9199 hscroll_relative_p
= 0;
9200 hscroll_step_abs
= 0;
9203 else if (INTEGERP (Vhscroll_step
))
9205 hscroll_step_abs
= XINT (Vhscroll_step
);
9206 if (hscroll_step_abs
< 0)
9207 hscroll_step_abs
= 0;
9210 hscroll_step_abs
= 0;
9212 while (WINDOWP (window
))
9214 struct window
*w
= XWINDOW (window
);
9216 if (WINDOWP (w
->hchild
))
9217 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
9218 else if (WINDOWP (w
->vchild
))
9219 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
9220 else if (w
->cursor
.vpos
>= 0)
9223 int text_area_width
;
9224 struct glyph_row
*current_cursor_row
9225 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
9226 struct glyph_row
*desired_cursor_row
9227 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
9228 struct glyph_row
*cursor_row
9229 = (desired_cursor_row
->enabled_p
9230 ? desired_cursor_row
9231 : current_cursor_row
);
9233 text_area_width
= window_box_width (w
, TEXT_AREA
);
9235 /* Scroll when cursor is inside this scroll margin. */
9236 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
9238 if ((XFASTINT (w
->hscroll
)
9239 && w
->cursor
.x
<= h_margin
)
9240 || (cursor_row
->enabled_p
9241 && cursor_row
->truncated_on_right_p
9242 && (w
->cursor
.x
>= text_area_width
- h_margin
)))
9246 struct buffer
*saved_current_buffer
;
9250 /* Find point in a display of infinite width. */
9251 saved_current_buffer
= current_buffer
;
9252 current_buffer
= XBUFFER (w
->buffer
);
9254 if (w
== XWINDOW (selected_window
))
9255 pt
= BUF_PT (current_buffer
);
9258 pt
= marker_position (w
->pointm
);
9259 pt
= max (BEGV
, pt
);
9263 /* Move iterator to pt starting at cursor_row->start in
9264 a line with infinite width. */
9265 init_to_row_start (&it
, w
, cursor_row
);
9266 it
.last_visible_x
= INFINITY
;
9267 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
9268 current_buffer
= saved_current_buffer
;
9270 /* Position cursor in window. */
9271 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
9272 hscroll
= max (0, it
.current_x
- text_area_width
/ 2)
9273 / FRAME_COLUMN_WIDTH (it
.f
);
9274 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
9276 if (hscroll_relative_p
)
9277 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
9280 wanted_x
= text_area_width
9281 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
9284 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
9288 if (hscroll_relative_p
)
9289 wanted_x
= text_area_width
* hscroll_step_rel
9292 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
9295 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
9297 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
9299 /* Don't call Fset_window_hscroll if value hasn't
9300 changed because it will prevent redisplay
9302 if (XFASTINT (w
->hscroll
) != hscroll
)
9304 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
9305 w
->hscroll
= make_number (hscroll
);
9314 /* Value is non-zero if hscroll of any leaf window has been changed. */
9319 /* Set hscroll so that cursor is visible and not inside horizontal
9320 scroll margins for all windows in the tree rooted at WINDOW. See
9321 also hscroll_window_tree above. Value is non-zero if any window's
9322 hscroll has been changed. If it has, desired matrices on the frame
9323 of WINDOW are cleared. */
9326 hscroll_windows (window
)
9331 if (automatic_hscrolling_p
)
9333 hscrolled_p
= hscroll_window_tree (window
);
9335 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
9344 /************************************************************************
9346 ************************************************************************/
9348 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
9349 to a non-zero value. This is sometimes handy to have in a debugger
9354 /* First and last unchanged row for try_window_id. */
9356 int debug_first_unchanged_at_end_vpos
;
9357 int debug_last_unchanged_at_beg_vpos
;
9359 /* Delta vpos and y. */
9361 int debug_dvpos
, debug_dy
;
9363 /* Delta in characters and bytes for try_window_id. */
9365 int debug_delta
, debug_delta_bytes
;
9367 /* Values of window_end_pos and window_end_vpos at the end of
9370 EMACS_INT debug_end_pos
, debug_end_vpos
;
9372 /* Append a string to W->desired_matrix->method. FMT is a printf
9373 format string. A1...A9 are a supplement for a variable-length
9374 argument list. If trace_redisplay_p is non-zero also printf the
9375 resulting string to stderr. */
9378 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
9381 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
9384 char *method
= w
->desired_matrix
->method
;
9385 int len
= strlen (method
);
9386 int size
= sizeof w
->desired_matrix
->method
;
9387 int remaining
= size
- len
- 1;
9389 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
9390 if (len
&& remaining
)
9396 strncpy (method
+ len
, buffer
, remaining
);
9398 if (trace_redisplay_p
)
9399 fprintf (stderr
, "%p (%s): %s\n",
9401 ((BUFFERP (w
->buffer
)
9402 && STRINGP (XBUFFER (w
->buffer
)->name
))
9403 ? (char *) SDATA (XBUFFER (w
->buffer
)->name
)
9408 #endif /* GLYPH_DEBUG */
9411 /* Value is non-zero if all changes in window W, which displays
9412 current_buffer, are in the text between START and END. START is a
9413 buffer position, END is given as a distance from Z. Used in
9414 redisplay_internal for display optimization. */
9417 text_outside_line_unchanged_p (w
, start
, end
)
9421 int unchanged_p
= 1;
9423 /* If text or overlays have changed, see where. */
9424 if (XFASTINT (w
->last_modified
) < MODIFF
9425 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
9427 /* Gap in the line? */
9428 if (GPT
< start
|| Z
- GPT
< end
)
9431 /* Changes start in front of the line, or end after it? */
9433 && (BEG_UNCHANGED
< start
- 1
9434 || END_UNCHANGED
< end
))
9437 /* If selective display, can't optimize if changes start at the
9438 beginning of the line. */
9440 && INTEGERP (current_buffer
->selective_display
)
9441 && XINT (current_buffer
->selective_display
) > 0
9442 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
9445 /* If there are overlays at the start or end of the line, these
9446 may have overlay strings with newlines in them. A change at
9447 START, for instance, may actually concern the display of such
9448 overlay strings as well, and they are displayed on different
9449 lines. So, quickly rule out this case. (For the future, it
9450 might be desirable to implement something more telling than
9451 just BEG/END_UNCHANGED.) */
9454 if (BEG
+ BEG_UNCHANGED
== start
9455 && overlay_touches_p (start
))
9457 if (END_UNCHANGED
== end
9458 && overlay_touches_p (Z
- end
))
9467 /* Do a frame update, taking possible shortcuts into account. This is
9468 the main external entry point for redisplay.
9470 If the last redisplay displayed an echo area message and that message
9471 is no longer requested, we clear the echo area or bring back the
9472 mini-buffer if that is in use. */
9477 redisplay_internal (0);
9481 /* Return 1 if point moved out of or into a composition. Otherwise
9482 return 0. PREV_BUF and PREV_PT are the last point buffer and
9483 position. BUF and PT are the current point buffer and position. */
9486 check_point_in_composition (prev_buf
, prev_pt
, buf
, pt
)
9487 struct buffer
*prev_buf
, *buf
;
9494 XSETBUFFER (buffer
, buf
);
9495 /* Check a composition at the last point if point moved within the
9497 if (prev_buf
== buf
)
9500 /* Point didn't move. */
9503 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
9504 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
9505 && COMPOSITION_VALID_P (start
, end
, prop
)
9506 && start
< prev_pt
&& end
> prev_pt
)
9507 /* The last point was within the composition. Return 1 iff
9508 point moved out of the composition. */
9509 return (pt
<= start
|| pt
>= end
);
9512 /* Check a composition at the current point. */
9513 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
9514 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
9515 && COMPOSITION_VALID_P (start
, end
, prop
)
9516 && start
< pt
&& end
> pt
);
9520 /* Reconsider the setting of B->clip_changed which is displayed
9524 reconsider_clip_changes (w
, b
)
9529 && !NILP (w
->window_end_valid
)
9530 && w
->current_matrix
->buffer
== b
9531 && w
->current_matrix
->zv
== BUF_ZV (b
)
9532 && w
->current_matrix
->begv
== BUF_BEGV (b
))
9533 b
->clip_changed
= 0;
9535 /* If display wasn't paused, and W is not a tool bar window, see if
9536 point has been moved into or out of a composition. In that case,
9537 we set b->clip_changed to 1 to force updating the screen. If
9538 b->clip_changed has already been set to 1, we can skip this
9540 if (!b
->clip_changed
9541 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
9545 if (w
== XWINDOW (selected_window
))
9546 pt
= BUF_PT (current_buffer
);
9548 pt
= marker_position (w
->pointm
);
9550 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
9551 || pt
!= XINT (w
->last_point
))
9552 && check_point_in_composition (w
->current_matrix
->buffer
,
9553 XINT (w
->last_point
),
9554 XBUFFER (w
->buffer
), pt
))
9555 b
->clip_changed
= 1;
9560 /* Select FRAME to forward the values of frame-local variables into C
9561 variables so that the redisplay routines can access those values
9565 select_frame_for_redisplay (frame
)
9568 Lisp_Object tail
, sym
, val
;
9569 Lisp_Object old
= selected_frame
;
9571 selected_frame
= frame
;
9573 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
9574 if (CONSP (XCAR (tail
))
9575 && (sym
= XCAR (XCAR (tail
)),
9577 && (sym
= indirect_variable (sym
),
9578 val
= SYMBOL_VALUE (sym
),
9579 (BUFFER_LOCAL_VALUEP (val
)
9580 || SOME_BUFFER_LOCAL_VALUEP (val
)))
9581 && XBUFFER_LOCAL_VALUE (val
)->check_frame
)
9582 Fsymbol_value (sym
);
9584 for (tail
= XFRAME (old
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
9585 if (CONSP (XCAR (tail
))
9586 && (sym
= XCAR (XCAR (tail
)),
9588 && (sym
= indirect_variable (sym
),
9589 val
= SYMBOL_VALUE (sym
),
9590 (BUFFER_LOCAL_VALUEP (val
)
9591 || SOME_BUFFER_LOCAL_VALUEP (val
)))
9592 && XBUFFER_LOCAL_VALUE (val
)->check_frame
)
9593 Fsymbol_value (sym
);
9597 #define STOP_POLLING \
9598 do { if (! polling_stopped_here) stop_polling (); \
9599 polling_stopped_here = 1; } while (0)
9601 #define RESUME_POLLING \
9602 do { if (polling_stopped_here) start_polling (); \
9603 polling_stopped_here = 0; } while (0)
9606 /* If PRESERVE_ECHO_AREA is nonzero, it means this redisplay is not in
9607 response to any user action; therefore, we should preserve the echo
9608 area. (Actually, our caller does that job.) Perhaps in the future
9609 avoid recentering windows if it is not necessary; currently that
9610 causes some problems. */
9613 redisplay_internal (preserve_echo_area
)
9614 int preserve_echo_area
;
9616 struct window
*w
= XWINDOW (selected_window
);
9617 struct frame
*f
= XFRAME (w
->frame
);
9619 int must_finish
= 0;
9620 struct text_pos tlbufpos
, tlendpos
;
9621 int number_of_visible_frames
;
9623 struct frame
*sf
= SELECTED_FRAME ();
9624 int polling_stopped_here
= 0;
9626 /* Non-zero means redisplay has to consider all windows on all
9627 frames. Zero means, only selected_window is considered. */
9628 int consider_all_windows_p
;
9630 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
9632 /* No redisplay if running in batch mode or frame is not yet fully
9633 initialized, or redisplay is explicitly turned off by setting
9634 Vinhibit_redisplay. */
9636 || !NILP (Vinhibit_redisplay
)
9637 || !f
->glyphs_initialized_p
)
9640 /* The flag redisplay_performed_directly_p is set by
9641 direct_output_for_insert when it already did the whole screen
9642 update necessary. */
9643 if (redisplay_performed_directly_p
)
9645 redisplay_performed_directly_p
= 0;
9646 if (!hscroll_windows (selected_window
))
9650 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
9651 if (popup_activated ())
9655 /* I don't think this happens but let's be paranoid. */
9659 /* Record a function that resets redisplaying_p to its old value
9660 when we leave this function. */
9661 count
= SPECPDL_INDEX ();
9662 record_unwind_protect (unwind_redisplay
,
9663 Fcons (make_number (redisplaying_p
), selected_frame
));
9665 specbind (Qinhibit_free_realized_faces
, Qnil
);
9669 reconsider_clip_changes (w
, current_buffer
);
9671 /* If new fonts have been loaded that make a glyph matrix adjustment
9672 necessary, do it. */
9673 if (fonts_changed_p
)
9675 adjust_glyphs (NULL
);
9676 ++windows_or_buffers_changed
;
9677 fonts_changed_p
= 0;
9680 /* If face_change_count is non-zero, init_iterator will free all
9681 realized faces, which includes the faces referenced from current
9682 matrices. So, we can't reuse current matrices in this case. */
9683 if (face_change_count
)
9684 ++windows_or_buffers_changed
;
9686 if (FRAME_TERMCAP_P (sf
)
9687 && FRAME_TTY (sf
)->previous_terminal_frame
!= sf
)
9689 /* Since frames on a single ASCII terminal share the same
9690 display area, displaying a different frame means redisplay
9692 windows_or_buffers_changed
++;
9693 SET_FRAME_GARBAGED (sf
);
9694 FRAME_TTY (sf
)->previous_terminal_frame
= sf
;
9697 /* Set the visible flags for all frames. Do this before checking
9698 for resized or garbaged frames; they want to know if their frames
9699 are visible. See the comment in frame.h for
9700 FRAME_SAMPLE_VISIBILITY. */
9702 Lisp_Object tail
, frame
;
9704 number_of_visible_frames
= 0;
9706 FOR_EACH_FRAME (tail
, frame
)
9708 struct frame
*f
= XFRAME (frame
);
9710 FRAME_SAMPLE_VISIBILITY (f
);
9711 if (FRAME_VISIBLE_P (f
))
9712 ++number_of_visible_frames
;
9713 clear_desired_matrices (f
);
9718 /* Notice any pending interrupt request to change frame size. */
9719 do_pending_window_change (1);
9721 /* Clear frames marked as garbaged. */
9723 clear_garbaged_frames ();
9725 /* Build menubar and tool-bar items. */
9726 prepare_menu_bars ();
9728 if (windows_or_buffers_changed
)
9729 update_mode_lines
++;
9731 /* Detect case that we need to write or remove a star in the mode line. */
9732 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
9734 w
->update_mode_line
= Qt
;
9735 if (buffer_shared
> 1)
9736 update_mode_lines
++;
9739 /* If %c is in the mode line, update it if needed. */
9740 if (!NILP (w
->column_number_displayed
)
9741 /* This alternative quickly identifies a common case
9742 where no change is needed. */
9743 && !(PT
== XFASTINT (w
->last_point
)
9744 && XFASTINT (w
->last_modified
) >= MODIFF
9745 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
9746 && (XFASTINT (w
->column_number_displayed
)
9747 != (int) current_column ())) /* iftc */
9748 w
->update_mode_line
= Qt
;
9750 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
9752 /* The variable buffer_shared is set in redisplay_window and
9753 indicates that we redisplay a buffer in different windows. See
9755 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
9756 || cursor_type_changed
);
9758 /* If specs for an arrow have changed, do thorough redisplay
9759 to ensure we remove any arrow that should no longer exist. */
9760 if (! EQ (COERCE_MARKER (Voverlay_arrow_position
), last_arrow_position
)
9761 || ! EQ (Voverlay_arrow_string
, last_arrow_string
))
9762 consider_all_windows_p
= windows_or_buffers_changed
= 1;
9764 /* Normally the message* functions will have already displayed and
9765 updated the echo area, but the frame may have been trashed, or
9766 the update may have been preempted, so display the echo area
9767 again here. Checking message_cleared_p captures the case that
9768 the echo area should be cleared. */
9769 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
9770 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
9771 || (message_cleared_p
9772 && minibuf_level
== 0
9773 /* If the mini-window is currently selected, this means the
9774 echo-area doesn't show through. */
9775 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
9777 int window_height_changed_p
= echo_area_display (0);
9780 /* If we don't display the current message, don't clear the
9781 message_cleared_p flag, because, if we did, we wouldn't clear
9782 the echo area in the next redisplay which doesn't preserve
9784 if (!display_last_displayed_message_p
)
9785 message_cleared_p
= 0;
9787 if (fonts_changed_p
)
9789 else if (window_height_changed_p
)
9791 consider_all_windows_p
= 1;
9792 ++update_mode_lines
;
9793 ++windows_or_buffers_changed
;
9795 /* If window configuration was changed, frames may have been
9796 marked garbaged. Clear them or we will experience
9797 surprises wrt scrolling. */
9799 clear_garbaged_frames ();
9802 else if (EQ (selected_window
, minibuf_window
)
9803 && (current_buffer
->clip_changed
9804 || XFASTINT (w
->last_modified
) < MODIFF
9805 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
9806 && resize_mini_window (w
, 0))
9808 /* Resized active mini-window to fit the size of what it is
9809 showing if its contents might have changed. */
9811 consider_all_windows_p
= 1;
9812 ++windows_or_buffers_changed
;
9813 ++update_mode_lines
;
9815 /* If window configuration was changed, frames may have been
9816 marked garbaged. Clear them or we will experience
9817 surprises wrt scrolling. */
9819 clear_garbaged_frames ();
9823 /* If showing the region, and mark has changed, we must redisplay
9824 the whole window. The assignment to this_line_start_pos prevents
9825 the optimization directly below this if-statement. */
9826 if (((!NILP (Vtransient_mark_mode
)
9827 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
9828 != !NILP (w
->region_showing
))
9829 || (!NILP (w
->region_showing
)
9830 && !EQ (w
->region_showing
,
9831 Fmarker_position (XBUFFER (w
->buffer
)->mark
))))
9832 CHARPOS (this_line_start_pos
) = 0;
9834 /* Optimize the case that only the line containing the cursor in the
9835 selected window has changed. Variables starting with this_ are
9836 set in display_line and record information about the line
9837 containing the cursor. */
9838 tlbufpos
= this_line_start_pos
;
9839 tlendpos
= this_line_end_pos
;
9840 if (!consider_all_windows_p
9841 && CHARPOS (tlbufpos
) > 0
9842 && NILP (w
->update_mode_line
)
9843 && !current_buffer
->clip_changed
9844 && !current_buffer
->prevent_redisplay_optimizations_p
9845 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
9846 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
9847 /* Make sure recorded data applies to current buffer, etc. */
9848 && this_line_buffer
== current_buffer
9849 && current_buffer
== XBUFFER (w
->buffer
)
9850 && NILP (w
->force_start
)
9851 && NILP (w
->optional_new_start
)
9852 /* Point must be on the line that we have info recorded about. */
9853 && PT
>= CHARPOS (tlbufpos
)
9854 && PT
<= Z
- CHARPOS (tlendpos
)
9855 /* All text outside that line, including its final newline,
9856 must be unchanged */
9857 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
9858 CHARPOS (tlendpos
)))
9860 if (CHARPOS (tlbufpos
) > BEGV
9861 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
9862 && (CHARPOS (tlbufpos
) == ZV
9863 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
9864 /* Former continuation line has disappeared by becoming empty */
9866 else if (XFASTINT (w
->last_modified
) < MODIFF
9867 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
9868 || MINI_WINDOW_P (w
))
9870 /* We have to handle the case of continuation around a
9871 wide-column character (See the comment in indent.c around
9874 For instance, in the following case:
9876 -------- Insert --------
9877 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
9878 J_I_ ==> J_I_ `^^' are cursors.
9882 As we have to redraw the line above, we should goto cancel. */
9885 int line_height_before
= this_line_pixel_height
;
9887 /* Note that start_display will handle the case that the
9888 line starting at tlbufpos is a continuation lines. */
9889 start_display (&it
, w
, tlbufpos
);
9891 /* Implementation note: It this still necessary? */
9892 if (it
.current_x
!= this_line_start_x
)
9895 TRACE ((stderr
, "trying display optimization 1\n"));
9896 w
->cursor
.vpos
= -1;
9897 overlay_arrow_seen
= 0;
9898 it
.vpos
= this_line_vpos
;
9899 it
.current_y
= this_line_y
;
9900 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
9903 /* If line contains point, is not continued,
9904 and ends at same distance from eob as before, we win */
9905 if (w
->cursor
.vpos
>= 0
9906 /* Line is not continued, otherwise this_line_start_pos
9907 would have been set to 0 in display_line. */
9908 && CHARPOS (this_line_start_pos
)
9909 /* Line ends as before. */
9910 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
9911 /* Line has same height as before. Otherwise other lines
9912 would have to be shifted up or down. */
9913 && this_line_pixel_height
== line_height_before
)
9915 /* If this is not the window's last line, we must adjust
9916 the charstarts of the lines below. */
9917 if (it
.current_y
< it
.last_visible_y
)
9919 struct glyph_row
*row
9920 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
9921 int delta
, delta_bytes
;
9923 if (Z
- CHARPOS (tlendpos
) == ZV
)
9925 /* This line ends at end of (accessible part of)
9926 buffer. There is no newline to count. */
9928 - CHARPOS (tlendpos
)
9929 - MATRIX_ROW_START_CHARPOS (row
));
9930 delta_bytes
= (Z_BYTE
9931 - BYTEPOS (tlendpos
)
9932 - MATRIX_ROW_START_BYTEPOS (row
));
9936 /* This line ends in a newline. Must take
9937 account of the newline and the rest of the
9938 text that follows. */
9940 - CHARPOS (tlendpos
)
9941 - MATRIX_ROW_START_CHARPOS (row
));
9942 delta_bytes
= (Z_BYTE
9943 - BYTEPOS (tlendpos
)
9944 - MATRIX_ROW_START_BYTEPOS (row
));
9947 increment_matrix_positions (w
->current_matrix
,
9949 w
->current_matrix
->nrows
,
9950 delta
, delta_bytes
);
9953 /* If this row displays text now but previously didn't,
9954 or vice versa, w->window_end_vpos may have to be
9956 if ((it
.glyph_row
- 1)->displays_text_p
)
9958 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
9959 XSETINT (w
->window_end_vpos
, this_line_vpos
);
9961 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
9962 && this_line_vpos
> 0)
9963 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
9964 w
->window_end_valid
= Qnil
;
9966 /* Update hint: No need to try to scroll in update_window. */
9967 w
->desired_matrix
->no_scrolling_p
= 1;
9970 *w
->desired_matrix
->method
= 0;
9971 debug_method_add (w
, "optimization 1");
9978 else if (/* Cursor position hasn't changed. */
9979 PT
== XFASTINT (w
->last_point
)
9980 /* Make sure the cursor was last displayed
9981 in this window. Otherwise we have to reposition it. */
9982 && 0 <= w
->cursor
.vpos
9983 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
9987 do_pending_window_change (1);
9989 /* We used to always goto end_of_redisplay here, but this
9990 isn't enough if we have a blinking cursor. */
9991 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
9992 goto end_of_redisplay
;
9996 /* If highlighting the region, or if the cursor is in the echo area,
9997 then we can't just move the cursor. */
9998 else if (! (!NILP (Vtransient_mark_mode
)
9999 && !NILP (current_buffer
->mark_active
))
10000 && (EQ (selected_window
, current_buffer
->last_selected_window
)
10001 || highlight_nonselected_windows
)
10002 && NILP (w
->region_showing
)
10003 && NILP (Vshow_trailing_whitespace
)
10004 && !cursor_in_echo_area
)
10007 struct glyph_row
*row
;
10009 /* Skip from tlbufpos to PT and see where it is. Note that
10010 PT may be in invisible text. If so, we will end at the
10011 next visible position. */
10012 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
10013 NULL
, DEFAULT_FACE_ID
);
10014 it
.current_x
= this_line_start_x
;
10015 it
.current_y
= this_line_y
;
10016 it
.vpos
= this_line_vpos
;
10018 /* The call to move_it_to stops in front of PT, but
10019 moves over before-strings. */
10020 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
10022 if (it
.vpos
== this_line_vpos
10023 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
10026 xassert (this_line_vpos
== it
.vpos
);
10027 xassert (this_line_y
== it
.current_y
);
10028 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
10030 *w
->desired_matrix
->method
= 0;
10031 debug_method_add (w
, "optimization 3");
10040 /* Text changed drastically or point moved off of line. */
10041 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
10044 CHARPOS (this_line_start_pos
) = 0;
10045 consider_all_windows_p
|= buffer_shared
> 1;
10046 ++clear_face_cache_count
;
10049 /* Build desired matrices, and update the display. If
10050 consider_all_windows_p is non-zero, do it for all windows on all
10051 frames. Otherwise do it for selected_window, only. */
10053 if (consider_all_windows_p
)
10055 Lisp_Object tail
, frame
;
10056 int i
, n
= 0, size
= 50;
10057 struct frame
**updated
10058 = (struct frame
**) alloca (size
* sizeof *updated
);
10060 /* Clear the face cache eventually. */
10061 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
10063 clear_face_cache (0);
10064 clear_face_cache_count
= 0;
10067 /* Recompute # windows showing selected buffer. This will be
10068 incremented each time such a window is displayed. */
10071 FOR_EACH_FRAME (tail
, frame
)
10073 struct frame
*f
= XFRAME (frame
);
10075 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
10077 if (! EQ (frame
, selected_frame
))
10078 /* Select the frame, for the sake of frame-local
10080 select_frame_for_redisplay (frame
);
10082 #ifdef HAVE_WINDOW_SYSTEM
10083 if (clear_face_cache_count
% 50 == 0
10084 && FRAME_WINDOW_P (f
))
10085 clear_image_cache (f
, 0);
10086 #endif /* HAVE_WINDOW_SYSTEM */
10088 /* Mark all the scroll bars to be removed; we'll redeem
10089 the ones we want when we redisplay their windows. */
10090 if (condemn_scroll_bars_hook
)
10091 condemn_scroll_bars_hook (f
);
10093 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
10094 redisplay_windows (FRAME_ROOT_WINDOW (f
));
10096 /* Any scroll bars which redisplay_windows should have
10097 nuked should now go away. */
10098 if (judge_scroll_bars_hook
)
10099 judge_scroll_bars_hook (f
);
10101 /* If fonts changed, display again. */
10102 /* ??? rms: I suspect it is a mistake to jump all the way
10103 back to retry here. It should just retry this frame. */
10104 if (fonts_changed_p
)
10107 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
10109 /* See if we have to hscroll. */
10110 if (hscroll_windows (f
->root_window
))
10113 /* Prevent various kinds of signals during display
10114 update. stdio is not robust about handling
10115 signals, which can cause an apparent I/O
10117 if (interrupt_input
)
10118 unrequest_sigio ();
10121 /* Update the display. */
10122 set_window_update_flags (XWINDOW (f
->root_window
), 1);
10123 pause
|= update_frame (f
, 0, 0);
10124 #if 0 /* Exiting the loop can leave the wrong value for buffer_shared. */
10131 int nbytes
= size
* sizeof *updated
;
10132 struct frame
**p
= (struct frame
**) alloca (2 * nbytes
);
10133 bcopy (updated
, p
, nbytes
);
10144 /* Do the mark_window_display_accurate after all windows have
10145 been redisplayed because this call resets flags in buffers
10146 which are needed for proper redisplay. */
10147 for (i
= 0; i
< n
; ++i
)
10149 struct frame
*f
= updated
[i
];
10150 mark_window_display_accurate (f
->root_window
, 1);
10151 if (frame_up_to_date_hook
)
10152 frame_up_to_date_hook (f
);
10156 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
10158 Lisp_Object mini_window
;
10159 struct frame
*mini_frame
;
10161 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
10162 /* Use list_of_error, not Qerror, so that
10163 we catch only errors and don't run the debugger. */
10164 internal_condition_case_1 (redisplay_window_1
, selected_window
,
10166 redisplay_window_error
);
10168 /* Compare desired and current matrices, perform output. */
10171 /* If fonts changed, display again. */
10172 if (fonts_changed_p
)
10175 /* Prevent various kinds of signals during display update.
10176 stdio is not robust about handling signals,
10177 which can cause an apparent I/O error. */
10178 if (interrupt_input
)
10179 unrequest_sigio ();
10182 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
10184 if (hscroll_windows (selected_window
))
10187 XWINDOW (selected_window
)->must_be_updated_p
= 1;
10188 pause
= update_frame (sf
, 0, 0);
10191 /* We may have called echo_area_display at the top of this
10192 function. If the echo area is on another frame, that may
10193 have put text on a frame other than the selected one, so the
10194 above call to update_frame would not have caught it. Catch
10196 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10197 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10199 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
10201 XWINDOW (mini_window
)->must_be_updated_p
= 1;
10202 pause
|= update_frame (mini_frame
, 0, 0);
10203 if (!pause
&& hscroll_windows (mini_window
))
10208 /* If display was paused because of pending input, make sure we do a
10209 thorough update the next time. */
10212 /* Prevent the optimization at the beginning of
10213 redisplay_internal that tries a single-line update of the
10214 line containing the cursor in the selected window. */
10215 CHARPOS (this_line_start_pos
) = 0;
10217 /* Let the overlay arrow be updated the next time. */
10218 if (!NILP (last_arrow_position
))
10220 last_arrow_position
= Qt
;
10221 last_arrow_string
= Qt
;
10224 /* If we pause after scrolling, some rows in the current
10225 matrices of some windows are not valid. */
10226 if (!WINDOW_FULL_WIDTH_P (w
)
10227 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
10228 update_mode_lines
= 1;
10232 if (!consider_all_windows_p
)
10234 /* This has already been done above if
10235 consider_all_windows_p is set. */
10236 mark_window_display_accurate_1 (w
, 1);
10238 last_arrow_position
= COERCE_MARKER (Voverlay_arrow_position
);
10239 last_arrow_string
= Voverlay_arrow_string
;
10241 if (frame_up_to_date_hook
!= 0)
10242 frame_up_to_date_hook (sf
);
10245 update_mode_lines
= 0;
10246 windows_or_buffers_changed
= 0;
10247 cursor_type_changed
= 0;
10250 /* Start SIGIO interrupts coming again. Having them off during the
10251 code above makes it less likely one will discard output, but not
10252 impossible, since there might be stuff in the system buffer here.
10253 But it is much hairier to try to do anything about that. */
10254 if (interrupt_input
)
10258 /* If a frame has become visible which was not before, redisplay
10259 again, so that we display it. Expose events for such a frame
10260 (which it gets when becoming visible) don't call the parts of
10261 redisplay constructing glyphs, so simply exposing a frame won't
10262 display anything in this case. So, we have to display these
10263 frames here explicitly. */
10266 Lisp_Object tail
, frame
;
10269 FOR_EACH_FRAME (tail
, frame
)
10271 int this_is_visible
= 0;
10273 if (XFRAME (frame
)->visible
)
10274 this_is_visible
= 1;
10275 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
10276 if (XFRAME (frame
)->visible
)
10277 this_is_visible
= 1;
10279 if (this_is_visible
)
10283 if (new_count
!= number_of_visible_frames
)
10284 windows_or_buffers_changed
++;
10287 /* Change frame size now if a change is pending. */
10288 do_pending_window_change (1);
10290 /* If we just did a pending size change, or have additional
10291 visible frames, redisplay again. */
10292 if (windows_or_buffers_changed
&& !pause
)
10296 unbind_to (count
, Qnil
);
10301 /* Redisplay, but leave alone any recent echo area message unless
10302 another message has been requested in its place.
10304 This is useful in situations where you need to redisplay but no
10305 user action has occurred, making it inappropriate for the message
10306 area to be cleared. See tracking_off and
10307 wait_reading_process_input for examples of these situations.
10309 FROM_WHERE is an integer saying from where this function was
10310 called. This is useful for debugging. */
10313 redisplay_preserve_echo_area (from_where
)
10316 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
10318 if (!NILP (echo_area_buffer
[1]))
10320 /* We have a previously displayed message, but no current
10321 message. Redisplay the previous message. */
10322 display_last_displayed_message_p
= 1;
10323 redisplay_internal (1);
10324 display_last_displayed_message_p
= 0;
10327 redisplay_internal (1);
10331 /* Function registered with record_unwind_protect in
10332 redisplay_internal. Reset redisplaying_p to the value it had
10333 before redisplay_internal was called, and clear
10334 prevent_freeing_realized_faces_p. It also selects the previously
10338 unwind_redisplay (val
)
10341 Lisp_Object old_redisplaying_p
, old_frame
;
10343 old_redisplaying_p
= XCAR (val
);
10344 redisplaying_p
= XFASTINT (old_redisplaying_p
);
10345 old_frame
= XCDR (val
);
10346 if (! EQ (old_frame
, selected_frame
))
10347 select_frame_for_redisplay (old_frame
);
10352 /* Mark the display of window W as accurate or inaccurate. If
10353 ACCURATE_P is non-zero mark display of W as accurate. If
10354 ACCURATE_P is zero, arrange for W to be redisplayed the next time
10355 redisplay_internal is called. */
10358 mark_window_display_accurate_1 (w
, accurate_p
)
10362 if (BUFFERP (w
->buffer
))
10364 struct buffer
*b
= XBUFFER (w
->buffer
);
10367 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
10368 w
->last_overlay_modified
10369 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
10371 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
10375 b
->clip_changed
= 0;
10376 b
->prevent_redisplay_optimizations_p
= 0;
10378 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
10379 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
10380 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
10381 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
10383 w
->current_matrix
->buffer
= b
;
10384 w
->current_matrix
->begv
= BUF_BEGV (b
);
10385 w
->current_matrix
->zv
= BUF_ZV (b
);
10387 w
->last_cursor
= w
->cursor
;
10388 w
->last_cursor_off_p
= w
->cursor_off_p
;
10390 if (w
== XWINDOW (selected_window
))
10391 w
->last_point
= make_number (BUF_PT (b
));
10393 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
10399 w
->window_end_valid
= w
->buffer
;
10400 #if 0 /* This is incorrect with variable-height lines. */
10401 xassert (XINT (w
->window_end_vpos
)
10402 < (WINDOW_TOTAL_LINES (w
)
10403 - (WINDOW_WANTS_MODELINE_P (w
) ? 1 : 0)));
10405 w
->update_mode_line
= Qnil
;
10410 /* Mark the display of windows in the window tree rooted at WINDOW as
10411 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
10412 windows as accurate. If ACCURATE_P is zero, arrange for windows to
10413 be redisplayed the next time redisplay_internal is called. */
10416 mark_window_display_accurate (window
, accurate_p
)
10417 Lisp_Object window
;
10422 for (; !NILP (window
); window
= w
->next
)
10424 w
= XWINDOW (window
);
10425 mark_window_display_accurate_1 (w
, accurate_p
);
10427 if (!NILP (w
->vchild
))
10428 mark_window_display_accurate (w
->vchild
, accurate_p
);
10429 if (!NILP (w
->hchild
))
10430 mark_window_display_accurate (w
->hchild
, accurate_p
);
10435 last_arrow_position
= COERCE_MARKER (Voverlay_arrow_position
);
10436 last_arrow_string
= Voverlay_arrow_string
;
10440 /* Force a thorough redisplay the next time by setting
10441 last_arrow_position and last_arrow_string to t, which is
10442 unequal to any useful value of Voverlay_arrow_... */
10443 last_arrow_position
= Qt
;
10444 last_arrow_string
= Qt
;
10449 /* Return value in display table DP (Lisp_Char_Table *) for character
10450 C. Since a display table doesn't have any parent, we don't have to
10451 follow parent. Do not call this function directly but use the
10452 macro DISP_CHAR_VECTOR. */
10455 disp_char_vector (dp
, c
)
10456 struct Lisp_Char_Table
*dp
;
10462 if (SINGLE_BYTE_CHAR_P (c
))
10463 return (dp
->contents
[c
]);
10465 SPLIT_CHAR (c
, code
[0], code
[1], code
[2]);
10468 else if (code
[2] < 32)
10471 /* Here, the possible range of code[0] (== charset ID) is
10472 128..max_charset. Since the top level char table contains data
10473 for multibyte characters after 256th element, we must increment
10474 code[0] by 128 to get a correct index. */
10476 code
[3] = -1; /* anchor */
10478 for (i
= 0; code
[i
] >= 0; i
++, dp
= XCHAR_TABLE (val
))
10480 val
= dp
->contents
[code
[i
]];
10481 if (!SUB_CHAR_TABLE_P (val
))
10482 return (NILP (val
) ? dp
->defalt
: val
);
10485 /* Here, val is a sub char table. We return the default value of
10487 return (dp
->defalt
);
10492 /***********************************************************************
10494 ***********************************************************************/
10496 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
10499 redisplay_windows (window
)
10500 Lisp_Object window
;
10502 while (!NILP (window
))
10504 struct window
*w
= XWINDOW (window
);
10506 if (!NILP (w
->hchild
))
10507 redisplay_windows (w
->hchild
);
10508 else if (!NILP (w
->vchild
))
10509 redisplay_windows (w
->vchild
);
10512 displayed_buffer
= XBUFFER (w
->buffer
);
10513 /* Use list_of_error, not Qerror, so that
10514 we catch only errors and don't run the debugger. */
10515 internal_condition_case_1 (redisplay_window_0
, window
,
10517 redisplay_window_error
);
10525 redisplay_window_error ()
10527 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
10532 redisplay_window_0 (window
)
10533 Lisp_Object window
;
10535 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
10536 redisplay_window (window
, 0);
10541 redisplay_window_1 (window
)
10542 Lisp_Object window
;
10544 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
10545 redisplay_window (window
, 1);
10550 /* Increment GLYPH until it reaches END or CONDITION fails while
10551 adding (GLYPH)->pixel_width to X. */
10553 #define SKIP_GLYPHS(glyph, end, x, condition) \
10556 (x) += (glyph)->pixel_width; \
10559 while ((glyph) < (end) && (condition))
10562 /* Set cursor position of W. PT is assumed to be displayed in ROW.
10563 DELTA is the number of bytes by which positions recorded in ROW
10564 differ from current buffer positions. */
10567 set_cursor_from_row (w
, row
, matrix
, delta
, delta_bytes
, dy
, dvpos
)
10569 struct glyph_row
*row
;
10570 struct glyph_matrix
*matrix
;
10571 int delta
, delta_bytes
, dy
, dvpos
;
10573 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
10574 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
10575 /* The first glyph that starts a sequence of glyphs from string. */
10576 struct glyph
*string_start
;
10577 /* The X coordinate of string_start. */
10578 int string_start_x
;
10579 /* The last known character position. */
10580 int last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
10581 /* The last known character position before string_start. */
10582 int string_before_pos
;
10584 int pt_old
= PT
- delta
;
10586 /* Skip over glyphs not having an object at the start of the row.
10587 These are special glyphs like truncation marks on terminal
10589 if (row
->displays_text_p
)
10591 && INTEGERP (glyph
->object
)
10592 && glyph
->charpos
< 0)
10594 x
+= glyph
->pixel_width
;
10598 string_start
= NULL
;
10600 && !INTEGERP (glyph
->object
)
10601 && (!BUFFERP (glyph
->object
)
10602 || (last_pos
= glyph
->charpos
) < pt_old
))
10604 if (! STRINGP (glyph
->object
))
10606 string_start
= NULL
;
10607 x
+= glyph
->pixel_width
;
10612 string_before_pos
= last_pos
;
10613 string_start
= glyph
;
10614 string_start_x
= x
;
10615 /* Skip all glyphs from string. */
10616 SKIP_GLYPHS (glyph
, end
, x
, STRINGP (glyph
->object
));
10621 && (glyph
== end
|| !BUFFERP (glyph
->object
) || last_pos
> pt_old
))
10623 /* We may have skipped over point because the previous glyphs
10624 are from string. As there's no easy way to know the
10625 character position of the current glyph, find the correct
10626 glyph on point by scanning from string_start again. */
10628 Lisp_Object string
;
10631 limit
= make_number (pt_old
+ 1);
10633 glyph
= string_start
;
10634 x
= string_start_x
;
10635 string
= glyph
->object
;
10636 pos
= string_buffer_position (w
, string
, string_before_pos
);
10637 /* If STRING is from overlay, LAST_POS == 0. We skip such glyphs
10638 because we always put cursor after overlay strings. */
10639 while (pos
== 0 && glyph
< end
)
10641 string
= glyph
->object
;
10642 SKIP_GLYPHS (glyph
, end
, x
, EQ (glyph
->object
, string
));
10644 pos
= string_buffer_position (w
, glyph
->object
, string_before_pos
);
10647 while (glyph
< end
)
10649 pos
= XINT (Fnext_single_char_property_change
10650 (make_number (pos
), Qdisplay
, Qnil
, limit
));
10653 /* Skip glyphs from the same string. */
10654 string
= glyph
->object
;
10655 SKIP_GLYPHS (glyph
, end
, x
, EQ (glyph
->object
, string
));
10656 /* Skip glyphs from an overlay. */
10658 && ! string_buffer_position (w
, glyph
->object
, pos
))
10660 string
= glyph
->object
;
10661 SKIP_GLYPHS (glyph
, end
, x
, EQ (glyph
->object
, string
));
10666 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
10668 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
10669 w
->cursor
.y
= row
->y
+ dy
;
10671 if (w
== XWINDOW (selected_window
))
10673 if (!row
->continued_p
10674 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
10677 this_line_buffer
= XBUFFER (w
->buffer
);
10679 CHARPOS (this_line_start_pos
)
10680 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
10681 BYTEPOS (this_line_start_pos
)
10682 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
10684 CHARPOS (this_line_end_pos
)
10685 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
10686 BYTEPOS (this_line_end_pos
)
10687 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
10689 this_line_y
= w
->cursor
.y
;
10690 this_line_pixel_height
= row
->height
;
10691 this_line_vpos
= w
->cursor
.vpos
;
10692 this_line_start_x
= row
->x
;
10695 CHARPOS (this_line_start_pos
) = 0;
10700 /* Run window scroll functions, if any, for WINDOW with new window
10701 start STARTP. Sets the window start of WINDOW to that position.
10703 We assume that the window's buffer is really current. */
10705 static INLINE
struct text_pos
10706 run_window_scroll_functions (window
, startp
)
10707 Lisp_Object window
;
10708 struct text_pos startp
;
10710 struct window
*w
= XWINDOW (window
);
10711 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
10713 if (current_buffer
!= XBUFFER (w
->buffer
))
10716 if (!NILP (Vwindow_scroll_functions
))
10718 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
10719 make_number (CHARPOS (startp
)));
10720 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
10721 /* In case the hook functions switch buffers. */
10722 if (current_buffer
!= XBUFFER (w
->buffer
))
10723 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10730 /* Make sure the line containing the cursor is fully visible.
10731 A value of 1 means there is nothing to be done.
10732 (Either the line is fully visible, or it cannot be made so,
10733 or we cannot tell.)
10734 A value of 0 means the caller should do scrolling
10735 as if point had gone off the screen. */
10738 make_cursor_line_fully_visible (w
)
10741 struct glyph_matrix
*matrix
;
10742 struct glyph_row
*row
;
10745 /* It's not always possible to find the cursor, e.g, when a window
10746 is full of overlay strings. Don't do anything in that case. */
10747 if (w
->cursor
.vpos
< 0)
10750 matrix
= w
->desired_matrix
;
10751 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
10753 /* If the cursor row is not partially visible, there's nothing to do. */
10754 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (row
))
10757 /* If the row the cursor is in is taller than the window's height,
10758 it's not clear what to do, so do nothing. */
10759 window_height
= window_box_height (w
);
10760 if (row
->height
>= window_height
)
10766 /* This code used to try to scroll the window just enough to make
10767 the line visible. It returned 0 to say that the caller should
10768 allocate larger glyph matrices. */
10770 if (MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (w
, row
))
10772 int dy
= row
->height
- row
->visible_height
;
10775 shift_glyph_matrix (w
, matrix
, 0, matrix
->nrows
, dy
);
10777 else /* MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P (w, row)) */
10779 int dy
= - (row
->height
- row
->visible_height
);
10782 shift_glyph_matrix (w
, matrix
, 0, matrix
->nrows
, dy
);
10785 /* When we change the cursor y-position of the selected window,
10786 change this_line_y as well so that the display optimization for
10787 the cursor line of the selected window in redisplay_internal uses
10788 the correct y-position. */
10789 if (w
== XWINDOW (selected_window
))
10790 this_line_y
= w
->cursor
.y
;
10792 /* If vscrolling requires a larger glyph matrix, arrange for a fresh
10793 redisplay with larger matrices. */
10794 if (matrix
->nrows
< required_matrix_height (w
))
10796 fonts_changed_p
= 1;
10805 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
10806 non-zero means only WINDOW is redisplayed in redisplay_internal.
10807 TEMP_SCROLL_STEP has the same meaning as scroll_step, and is used
10808 in redisplay_window to bring a partially visible line into view in
10809 the case that only the cursor has moved.
10811 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
10812 last screen line's vertical height extends past the end of the screen.
10816 1 if scrolling succeeded
10818 0 if scrolling didn't find point.
10820 -1 if new fonts have been loaded so that we must interrupt
10821 redisplay, adjust glyph matrices, and try again. */
10827 SCROLLING_NEED_LARGER_MATRICES
10831 try_scrolling (window
, just_this_one_p
, scroll_conservatively
,
10832 scroll_step
, temp_scroll_step
, last_line_misfit
)
10833 Lisp_Object window
;
10834 int just_this_one_p
;
10835 EMACS_INT scroll_conservatively
, scroll_step
;
10836 int temp_scroll_step
;
10837 int last_line_misfit
;
10839 struct window
*w
= XWINDOW (window
);
10840 struct frame
*f
= XFRAME (w
->frame
);
10841 struct text_pos scroll_margin_pos
;
10842 struct text_pos pos
;
10843 struct text_pos startp
;
10845 Lisp_Object window_end
;
10846 int this_scroll_margin
;
10850 int amount_to_scroll
= 0;
10851 Lisp_Object aggressive
;
10853 int end_scroll_margin
;
10856 debug_method_add (w
, "try_scrolling");
10859 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
10861 /* Compute scroll margin height in pixels. We scroll when point is
10862 within this distance from the top or bottom of the window. */
10863 if (scroll_margin
> 0)
10865 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
10866 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
10869 this_scroll_margin
= 0;
10871 /* Compute how much we should try to scroll maximally to bring point
10873 if (scroll_step
|| scroll_conservatively
|| temp_scroll_step
)
10874 scroll_max
= max (scroll_step
,
10875 max (scroll_conservatively
, temp_scroll_step
));
10876 else if (NUMBERP (current_buffer
->scroll_down_aggressively
)
10877 || NUMBERP (current_buffer
->scroll_up_aggressively
))
10878 /* We're trying to scroll because of aggressive scrolling
10879 but no scroll_step is set. Choose an arbitrary one. Maybe
10880 there should be a variable for this. */
10884 scroll_max
*= FRAME_LINE_HEIGHT (f
);
10886 /* Decide whether we have to scroll down. Start at the window end
10887 and move this_scroll_margin up to find the position of the scroll
10889 window_end
= Fwindow_end (window
, Qt
);
10893 CHARPOS (scroll_margin_pos
) = XINT (window_end
);
10894 BYTEPOS (scroll_margin_pos
) = CHAR_TO_BYTE (CHARPOS (scroll_margin_pos
));
10896 end_scroll_margin
= this_scroll_margin
+ !!last_line_misfit
;
10897 if (end_scroll_margin
)
10899 start_display (&it
, w
, scroll_margin_pos
);
10900 move_it_vertically (&it
, - end_scroll_margin
);
10901 scroll_margin_pos
= it
.current
.pos
;
10904 if (PT
>= CHARPOS (scroll_margin_pos
))
10908 /* Point is in the scroll margin at the bottom of the window, or
10909 below. Compute a new window start that makes point visible. */
10911 /* Compute the distance from the scroll margin to PT.
10912 Give up if the distance is greater than scroll_max. */
10913 start_display (&it
, w
, scroll_margin_pos
);
10915 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
10916 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
10918 /* To make point visible, we have to move the window start
10919 down so that the line the cursor is in is visible, which
10920 means we have to add in the height of the cursor line. */
10921 dy
= line_bottom_y (&it
) - y0
;
10923 if (dy
> scroll_max
)
10924 return SCROLLING_FAILED
;
10926 /* Move the window start down. If scrolling conservatively,
10927 move it just enough down to make point visible. If
10928 scroll_step is set, move it down by scroll_step. */
10929 start_display (&it
, w
, startp
);
10931 if (scroll_conservatively
)
10932 /* Set AMOUNT_TO_SCROLL to at least one line,
10933 and at most scroll_conservatively lines. */
10935 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
10936 FRAME_LINE_HEIGHT (f
) * scroll_conservatively
);
10937 else if (scroll_step
|| temp_scroll_step
)
10938 amount_to_scroll
= scroll_max
;
10941 aggressive
= current_buffer
->scroll_up_aggressively
;
10942 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
10943 if (NUMBERP (aggressive
))
10944 amount_to_scroll
= XFLOATINT (aggressive
) * height
;
10947 if (amount_to_scroll
<= 0)
10948 return SCROLLING_FAILED
;
10950 /* If moving by amount_to_scroll leaves STARTP unchanged,
10951 move it down one screen line. */
10953 move_it_vertically (&it
, amount_to_scroll
);
10954 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
10955 move_it_by_lines (&it
, 1, 1);
10956 startp
= it
.current
.pos
;
10960 /* See if point is inside the scroll margin at the top of the
10962 scroll_margin_pos
= startp
;
10963 if (this_scroll_margin
)
10965 start_display (&it
, w
, startp
);
10966 move_it_vertically (&it
, this_scroll_margin
);
10967 scroll_margin_pos
= it
.current
.pos
;
10970 if (PT
< CHARPOS (scroll_margin_pos
))
10972 /* Point is in the scroll margin at the top of the window or
10973 above what is displayed in the window. */
10976 /* Compute the vertical distance from PT to the scroll
10977 margin position. Give up if distance is greater than
10979 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
10980 start_display (&it
, w
, pos
);
10982 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
10983 it
.last_visible_y
, -1,
10984 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
10985 dy
= it
.current_y
- y0
;
10986 if (dy
> scroll_max
)
10987 return SCROLLING_FAILED
;
10989 /* Compute new window start. */
10990 start_display (&it
, w
, startp
);
10992 if (scroll_conservatively
)
10994 max (dy
, FRAME_LINE_HEIGHT (f
) * max (scroll_step
, temp_scroll_step
));
10995 else if (scroll_step
|| temp_scroll_step
)
10996 amount_to_scroll
= scroll_max
;
10999 aggressive
= current_buffer
->scroll_down_aggressively
;
11000 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
11001 if (NUMBERP (aggressive
))
11002 amount_to_scroll
= XFLOATINT (aggressive
) * height
;
11005 if (amount_to_scroll
<= 0)
11006 return SCROLLING_FAILED
;
11008 move_it_vertically (&it
, - amount_to_scroll
);
11009 startp
= it
.current
.pos
;
11013 /* Run window scroll functions. */
11014 startp
= run_window_scroll_functions (window
, startp
);
11016 /* Display the window. Give up if new fonts are loaded, or if point
11018 if (!try_window (window
, startp
))
11019 rc
= SCROLLING_NEED_LARGER_MATRICES
;
11020 else if (w
->cursor
.vpos
< 0)
11022 clear_glyph_matrix (w
->desired_matrix
);
11023 rc
= SCROLLING_FAILED
;
11027 /* Maybe forget recorded base line for line number display. */
11028 if (!just_this_one_p
11029 || current_buffer
->clip_changed
11030 || BEG_UNCHANGED
< CHARPOS (startp
))
11031 w
->base_line_number
= Qnil
;
11033 /* If cursor ends up on a partially visible line,
11034 treat that as being off the bottom of the screen. */
11035 if (! make_cursor_line_fully_visible (w
))
11037 clear_glyph_matrix (w
->desired_matrix
);
11038 last_line_misfit
= 1;
11041 rc
= SCROLLING_SUCCESS
;
11048 /* Compute a suitable window start for window W if display of W starts
11049 on a continuation line. Value is non-zero if a new window start
11052 The new window start will be computed, based on W's width, starting
11053 from the start of the continued line. It is the start of the
11054 screen line with the minimum distance from the old start W->start. */
11057 compute_window_start_on_continuation_line (w
)
11060 struct text_pos pos
, start_pos
;
11061 int window_start_changed_p
= 0;
11063 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
11065 /* If window start is on a continuation line... Window start may be
11066 < BEGV in case there's invisible text at the start of the
11067 buffer (M-x rmail, for example). */
11068 if (CHARPOS (start_pos
) > BEGV
11069 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
11072 struct glyph_row
*row
;
11074 /* Handle the case that the window start is out of range. */
11075 if (CHARPOS (start_pos
) < BEGV
)
11076 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
11077 else if (CHARPOS (start_pos
) > ZV
)
11078 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
11080 /* Find the start of the continued line. This should be fast
11081 because scan_buffer is fast (newline cache). */
11082 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
11083 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
11084 row
, DEFAULT_FACE_ID
);
11085 reseat_at_previous_visible_line_start (&it
);
11087 /* If the line start is "too far" away from the window start,
11088 say it takes too much time to compute a new window start. */
11089 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
11090 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
11092 int min_distance
, distance
;
11094 /* Move forward by display lines to find the new window
11095 start. If window width was enlarged, the new start can
11096 be expected to be > the old start. If window width was
11097 decreased, the new window start will be < the old start.
11098 So, we're looking for the display line start with the
11099 minimum distance from the old window start. */
11100 pos
= it
.current
.pos
;
11101 min_distance
= INFINITY
;
11102 while ((distance
= abs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
11103 distance
< min_distance
)
11105 min_distance
= distance
;
11106 pos
= it
.current
.pos
;
11107 move_it_by_lines (&it
, 1, 0);
11110 /* Set the window start there. */
11111 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
11112 window_start_changed_p
= 1;
11116 return window_start_changed_p
;
11120 /* Try cursor movement in case text has not changed in window WINDOW,
11121 with window start STARTP. Value is
11123 CURSOR_MOVEMENT_SUCCESS if successful
11125 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
11127 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
11128 display. *SCROLL_STEP is set to 1, under certain circumstances, if
11129 we want to scroll as if scroll-step were set to 1. See the code.
11131 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
11132 which case we have to abort this redisplay, and adjust matrices
11137 CURSOR_MOVEMENT_SUCCESS
,
11138 CURSOR_MOVEMENT_CANNOT_BE_USED
,
11139 CURSOR_MOVEMENT_MUST_SCROLL
,
11140 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
11144 try_cursor_movement (window
, startp
, scroll_step
)
11145 Lisp_Object window
;
11146 struct text_pos startp
;
11149 struct window
*w
= XWINDOW (window
);
11150 struct frame
*f
= XFRAME (w
->frame
);
11151 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
11154 if (inhibit_try_cursor_movement
)
11158 /* Handle case where text has not changed, only point, and it has
11159 not moved off the frame. */
11160 if (/* Point may be in this window. */
11161 PT
>= CHARPOS (startp
)
11162 /* Selective display hasn't changed. */
11163 && !current_buffer
->clip_changed
11164 /* Function force-mode-line-update is used to force a thorough
11165 redisplay. It sets either windows_or_buffers_changed or
11166 update_mode_lines. So don't take a shortcut here for these
11168 && !update_mode_lines
11169 && !windows_or_buffers_changed
11170 && !cursor_type_changed
11171 /* Can't use this case if highlighting a region. When a
11172 region exists, cursor movement has to do more than just
11174 && !(!NILP (Vtransient_mark_mode
)
11175 && !NILP (current_buffer
->mark_active
))
11176 && NILP (w
->region_showing
)
11177 && NILP (Vshow_trailing_whitespace
)
11178 /* Right after splitting windows, last_point may be nil. */
11179 && INTEGERP (w
->last_point
)
11180 /* This code is not used for mini-buffer for the sake of the case
11181 of redisplaying to replace an echo area message; since in
11182 that case the mini-buffer contents per se are usually
11183 unchanged. This code is of no real use in the mini-buffer
11184 since the handling of this_line_start_pos, etc., in redisplay
11185 handles the same cases. */
11186 && !EQ (window
, minibuf_window
)
11187 /* When splitting windows or for new windows, it happens that
11188 redisplay is called with a nil window_end_vpos or one being
11189 larger than the window. This should really be fixed in
11190 window.c. I don't have this on my list, now, so we do
11191 approximately the same as the old redisplay code. --gerd. */
11192 && INTEGERP (w
->window_end_vpos
)
11193 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
11194 && (FRAME_WINDOW_P (f
)
11195 || !MARKERP (Voverlay_arrow_position
)
11196 || current_buffer
!= XMARKER (Voverlay_arrow_position
)->buffer
))
11198 int this_scroll_margin
;
11199 struct glyph_row
*row
= NULL
;
11202 debug_method_add (w
, "cursor movement");
11205 /* Scroll if point within this distance from the top or bottom
11206 of the window. This is a pixel value. */
11207 this_scroll_margin
= max (0, scroll_margin
);
11208 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
11209 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
11211 /* Start with the row the cursor was displayed during the last
11212 not paused redisplay. Give up if that row is not valid. */
11213 if (w
->last_cursor
.vpos
< 0
11214 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
11215 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
11218 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
11219 if (row
->mode_line_p
)
11221 if (!row
->enabled_p
)
11222 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
11225 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
11228 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
11230 if (PT
> XFASTINT (w
->last_point
))
11232 /* Point has moved forward. */
11233 while (MATRIX_ROW_END_CHARPOS (row
) < PT
11234 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
11236 xassert (row
->enabled_p
);
11240 /* The end position of a row equals the start position
11241 of the next row. If PT is there, we would rather
11242 display it in the next line. */
11243 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
11244 && MATRIX_ROW_END_CHARPOS (row
) == PT
11245 && !cursor_row_p (w
, row
))
11248 /* If within the scroll margin, scroll. Note that
11249 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
11250 the next line would be drawn, and that
11251 this_scroll_margin can be zero. */
11252 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
11253 || PT
> MATRIX_ROW_END_CHARPOS (row
)
11254 /* Line is completely visible last line in window
11255 and PT is to be set in the next line. */
11256 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
11257 && PT
== MATRIX_ROW_END_CHARPOS (row
)
11258 && !row
->ends_at_zv_p
11259 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
11262 else if (PT
< XFASTINT (w
->last_point
))
11264 /* Cursor has to be moved backward. Note that PT >=
11265 CHARPOS (startp) because of the outer
11267 while (!row
->mode_line_p
11268 && (MATRIX_ROW_START_CHARPOS (row
) > PT
11269 || (MATRIX_ROW_START_CHARPOS (row
) == PT
11270 && MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)))
11271 && (row
->y
> this_scroll_margin
11272 || CHARPOS (startp
) == BEGV
))
11274 xassert (row
->enabled_p
);
11278 /* Consider the following case: Window starts at BEGV,
11279 there is invisible, intangible text at BEGV, so that
11280 display starts at some point START > BEGV. It can
11281 happen that we are called with PT somewhere between
11282 BEGV and START. Try to handle that case. */
11283 if (row
< w
->current_matrix
->rows
11284 || row
->mode_line_p
)
11286 row
= w
->current_matrix
->rows
;
11287 if (row
->mode_line_p
)
11291 /* Due to newlines in overlay strings, we may have to
11292 skip forward over overlay strings. */
11293 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
11294 && MATRIX_ROW_END_CHARPOS (row
) == PT
11295 && !cursor_row_p (w
, row
))
11298 /* If within the scroll margin, scroll. */
11299 if (row
->y
< this_scroll_margin
11300 && CHARPOS (startp
) != BEGV
)
11304 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
11305 || PT
> MATRIX_ROW_END_CHARPOS (row
))
11307 /* if PT is not in the glyph row, give up. */
11308 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
11310 else if (MATRIX_ROW_PARTIALLY_VISIBLE_P (row
))
11312 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
11313 && !row
->ends_at_zv_p
11314 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
11315 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
11316 else if (row
->height
> window_box_height (w
))
11318 /* If we end up in a partially visible line, let's
11319 make it fully visible, except when it's taller
11320 than the window, in which case we can't do much
11323 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
11327 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
11328 if (!make_cursor_line_fully_visible (w
))
11329 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
11331 rc
= CURSOR_MOVEMENT_SUCCESS
;
11335 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
11338 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
11339 rc
= CURSOR_MOVEMENT_SUCCESS
;
11348 set_vertical_scroll_bar (w
)
11351 int start
, end
, whole
;
11353 /* Calculate the start and end positions for the current window.
11354 At some point, it would be nice to choose between scrollbars
11355 which reflect the whole buffer size, with special markers
11356 indicating narrowing, and scrollbars which reflect only the
11359 Note that mini-buffers sometimes aren't displaying any text. */
11360 if (!MINI_WINDOW_P (w
)
11361 || (w
== XWINDOW (minibuf_window
)
11362 && NILP (echo_area_buffer
[0])))
11364 struct buffer
*buf
= XBUFFER (w
->buffer
);
11365 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
11366 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
11367 /* I don't think this is guaranteed to be right. For the
11368 moment, we'll pretend it is. */
11369 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
11373 if (whole
< (end
- start
))
11374 whole
= end
- start
;
11377 start
= end
= whole
= 0;
11379 /* Indicate what this scroll bar ought to be displaying now. */
11380 set_vertical_scroll_bar_hook (w
, end
- start
, whole
, start
);
11383 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
11384 selected_window is redisplayed.
11386 We can return without actually redisplaying the window if
11387 fonts_changed_p is nonzero. In that case, redisplay_internal will
11391 redisplay_window (window
, just_this_one_p
)
11392 Lisp_Object window
;
11393 int just_this_one_p
;
11395 struct window
*w
= XWINDOW (window
);
11396 struct frame
*f
= XFRAME (w
->frame
);
11397 struct buffer
*buffer
= XBUFFER (w
->buffer
);
11398 struct buffer
*old
= current_buffer
;
11399 struct text_pos lpoint
, opoint
, startp
;
11400 int update_mode_line
;
11403 /* Record it now because it's overwritten. */
11404 int current_matrix_up_to_date_p
= 0;
11405 /* This is less strict than current_matrix_up_to_date_p.
11406 It indictes that the buffer contents and narrowing are unchanged. */
11407 int buffer_unchanged_p
= 0;
11408 int temp_scroll_step
= 0;
11409 int count
= SPECPDL_INDEX ();
11411 int centering_position
;
11412 int last_line_misfit
= 0;
11414 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
11417 /* W must be a leaf window here. */
11418 xassert (!NILP (w
->buffer
));
11420 *w
->desired_matrix
->method
= 0;
11423 specbind (Qinhibit_point_motion_hooks
, Qt
);
11425 reconsider_clip_changes (w
, buffer
);
11427 /* Has the mode line to be updated? */
11428 update_mode_line
= (!NILP (w
->update_mode_line
)
11429 || update_mode_lines
11430 || buffer
->clip_changed
11431 || buffer
->prevent_redisplay_optimizations_p
);
11433 if (MINI_WINDOW_P (w
))
11435 if (w
== XWINDOW (echo_area_window
)
11436 && !NILP (echo_area_buffer
[0]))
11438 if (update_mode_line
)
11439 /* We may have to update a tty frame's menu bar or a
11440 tool-bar. Example `M-x C-h C-h C-g'. */
11441 goto finish_menu_bars
;
11443 /* We've already displayed the echo area glyphs in this window. */
11444 goto finish_scroll_bars
;
11446 else if ((w
!= XWINDOW (minibuf_window
)
11447 || minibuf_level
== 0)
11448 /* When buffer is nonempty, redisplay window normally. */
11449 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
11450 /* Quail displays non-mini buffers in minibuffer window.
11451 In that case, redisplay the window normally. */
11452 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
11454 /* W is a mini-buffer window, but it's not active, so clear
11456 int yb
= window_text_bottom_y (w
);
11457 struct glyph_row
*row
;
11460 for (y
= 0, row
= w
->desired_matrix
->rows
;
11462 y
+= row
->height
, ++row
)
11463 blank_row (w
, row
, y
);
11464 goto finish_scroll_bars
;
11467 clear_glyph_matrix (w
->desired_matrix
);
11470 /* Otherwise set up data on this window; select its buffer and point
11472 /* Really select the buffer, for the sake of buffer-local
11474 set_buffer_internal_1 (XBUFFER (w
->buffer
));
11475 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
11477 current_matrix_up_to_date_p
11478 = (!NILP (w
->window_end_valid
)
11479 && !current_buffer
->clip_changed
11480 && !current_buffer
->prevent_redisplay_optimizations_p
11481 && XFASTINT (w
->last_modified
) >= MODIFF
11482 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
11485 = (!NILP (w
->window_end_valid
)
11486 && !current_buffer
->clip_changed
11487 && XFASTINT (w
->last_modified
) >= MODIFF
11488 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
11490 /* When windows_or_buffers_changed is non-zero, we can't rely on
11491 the window end being valid, so set it to nil there. */
11492 if (windows_or_buffers_changed
)
11494 /* If window starts on a continuation line, maybe adjust the
11495 window start in case the window's width changed. */
11496 if (XMARKER (w
->start
)->buffer
== current_buffer
)
11497 compute_window_start_on_continuation_line (w
);
11499 w
->window_end_valid
= Qnil
;
11502 /* Some sanity checks. */
11503 CHECK_WINDOW_END (w
);
11504 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
11506 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
11509 /* If %c is in mode line, update it if needed. */
11510 if (!NILP (w
->column_number_displayed
)
11511 /* This alternative quickly identifies a common case
11512 where no change is needed. */
11513 && !(PT
== XFASTINT (w
->last_point
)
11514 && XFASTINT (w
->last_modified
) >= MODIFF
11515 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
11516 && (XFASTINT (w
->column_number_displayed
)
11517 != (int) current_column ())) /* iftc */
11518 update_mode_line
= 1;
11520 /* Count number of windows showing the selected buffer. An indirect
11521 buffer counts as its base buffer. */
11522 if (!just_this_one_p
)
11524 struct buffer
*current_base
, *window_base
;
11525 current_base
= current_buffer
;
11526 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
11527 if (current_base
->base_buffer
)
11528 current_base
= current_base
->base_buffer
;
11529 if (window_base
->base_buffer
)
11530 window_base
= window_base
->base_buffer
;
11531 if (current_base
== window_base
)
11535 /* Point refers normally to the selected window. For any other
11536 window, set up appropriate value. */
11537 if (!EQ (window
, selected_window
))
11539 int new_pt
= XMARKER (w
->pointm
)->charpos
;
11540 int new_pt_byte
= marker_byte_position (w
->pointm
);
11544 new_pt_byte
= BEGV_BYTE
;
11545 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
11547 else if (new_pt
> (ZV
- 1))
11550 new_pt_byte
= ZV_BYTE
;
11551 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
11554 /* We don't use SET_PT so that the point-motion hooks don't run. */
11555 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
11558 /* If any of the character widths specified in the display table
11559 have changed, invalidate the width run cache. It's true that
11560 this may be a bit late to catch such changes, but the rest of
11561 redisplay goes (non-fatally) haywire when the display table is
11562 changed, so why should we worry about doing any better? */
11563 if (current_buffer
->width_run_cache
)
11565 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
11567 if (! disptab_matches_widthtab (disptab
,
11568 XVECTOR (current_buffer
->width_table
)))
11570 invalidate_region_cache (current_buffer
,
11571 current_buffer
->width_run_cache
,
11573 recompute_width_table (current_buffer
, disptab
);
11577 /* If window-start is screwed up, choose a new one. */
11578 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
11581 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
11583 /* If someone specified a new starting point but did not insist,
11584 check whether it can be used. */
11585 if (!NILP (w
->optional_new_start
)
11586 && CHARPOS (startp
) >= BEGV
11587 && CHARPOS (startp
) <= ZV
)
11589 w
->optional_new_start
= Qnil
;
11590 start_display (&it
, w
, startp
);
11591 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
11592 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
11593 if (IT_CHARPOS (it
) == PT
)
11594 w
->force_start
= Qt
;
11595 /* IT may overshoot PT if text at PT is invisible. */
11596 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
11597 w
->force_start
= Qt
;
11602 /* Handle case where place to start displaying has been specified,
11603 unless the specified location is outside the accessible range. */
11604 if (!NILP (w
->force_start
)
11605 || w
->frozen_window_start_p
)
11607 /* We set this later on if we have to adjust point. */
11610 w
->force_start
= Qnil
;
11612 w
->window_end_valid
= Qnil
;
11614 /* Forget any recorded base line for line number display. */
11615 if (!buffer_unchanged_p
)
11616 w
->base_line_number
= Qnil
;
11618 /* Redisplay the mode line. Select the buffer properly for that.
11619 Also, run the hook window-scroll-functions
11620 because we have scrolled. */
11621 /* Note, we do this after clearing force_start because
11622 if there's an error, it is better to forget about force_start
11623 than to get into an infinite loop calling the hook functions
11624 and having them get more errors. */
11625 if (!update_mode_line
11626 || ! NILP (Vwindow_scroll_functions
))
11628 update_mode_line
= 1;
11629 w
->update_mode_line
= Qt
;
11630 startp
= run_window_scroll_functions (window
, startp
);
11633 w
->last_modified
= make_number (0);
11634 w
->last_overlay_modified
= make_number (0);
11635 if (CHARPOS (startp
) < BEGV
)
11636 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
11637 else if (CHARPOS (startp
) > ZV
)
11638 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
11640 /* Redisplay, then check if cursor has been set during the
11641 redisplay. Give up if new fonts were loaded. */
11642 if (!try_window (window
, startp
))
11644 w
->force_start
= Qt
;
11645 clear_glyph_matrix (w
->desired_matrix
);
11646 goto need_larger_matrices
;
11649 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
11651 /* If point does not appear, try to move point so it does
11652 appear. The desired matrix has been built above, so we
11653 can use it here. */
11654 new_vpos
= window_box_height (w
) / 2;
11657 if (!make_cursor_line_fully_visible (w
))
11659 /* Point does appear, but on a line partly visible at end of window.
11660 Move it back to a fully-visible line. */
11661 new_vpos
= window_box_height (w
);
11664 /* If we need to move point for either of the above reasons,
11665 now actually do it. */
11668 struct glyph_row
*row
;
11670 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
11671 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
11674 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
11675 MATRIX_ROW_START_BYTEPOS (row
));
11677 if (w
!= XWINDOW (selected_window
))
11678 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
11679 else if (current_buffer
== old
)
11680 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
11682 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
11684 /* If we are highlighting the region, then we just changed
11685 the region, so redisplay to show it. */
11686 if (!NILP (Vtransient_mark_mode
)
11687 && !NILP (current_buffer
->mark_active
))
11689 clear_glyph_matrix (w
->desired_matrix
);
11690 if (!try_window (window
, startp
))
11691 goto need_larger_matrices
;
11696 debug_method_add (w
, "forced window start");
11701 /* Handle case where text has not changed, only point, and it has
11702 not moved off the frame, and we are not retrying after hscroll.
11703 (current_matrix_up_to_date_p is nonzero when retrying.) */
11704 if (current_matrix_up_to_date_p
11705 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
11706 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
11710 case CURSOR_MOVEMENT_SUCCESS
:
11713 #if 0 /* try_cursor_movement never returns this value. */
11714 case CURSOR_MOVEMENT_NEED_LARGER_MATRICES
:
11715 goto need_larger_matrices
;
11718 case CURSOR_MOVEMENT_MUST_SCROLL
:
11719 goto try_to_scroll
;
11725 /* If current starting point was originally the beginning of a line
11726 but no longer is, find a new starting point. */
11727 else if (!NILP (w
->start_at_line_beg
)
11728 && !(CHARPOS (startp
) <= BEGV
11729 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
11732 debug_method_add (w
, "recenter 1");
11737 /* Try scrolling with try_window_id. Value is > 0 if update has
11738 been done, it is -1 if we know that the same window start will
11739 not work. It is 0 if unsuccessful for some other reason. */
11740 else if ((tem
= try_window_id (w
)) != 0)
11743 debug_method_add (w
, "try_window_id %d", tem
);
11746 if (fonts_changed_p
)
11747 goto need_larger_matrices
;
11751 /* Otherwise try_window_id has returned -1 which means that we
11752 don't want the alternative below this comment to execute. */
11754 else if (CHARPOS (startp
) >= BEGV
11755 && CHARPOS (startp
) <= ZV
11756 && PT
>= CHARPOS (startp
)
11757 && (CHARPOS (startp
) < ZV
11758 /* Avoid starting at end of buffer. */
11759 || CHARPOS (startp
) == BEGV
11760 || (XFASTINT (w
->last_modified
) >= MODIFF
11761 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
11764 debug_method_add (w
, "same window start");
11767 /* Try to redisplay starting at same place as before.
11768 If point has not moved off frame, accept the results. */
11769 if (!current_matrix_up_to_date_p
11770 /* Don't use try_window_reusing_current_matrix in this case
11771 because a window scroll function can have changed the
11773 || !NILP (Vwindow_scroll_functions
)
11774 || MINI_WINDOW_P (w
)
11775 || !try_window_reusing_current_matrix (w
))
11777 IF_DEBUG (debug_method_add (w
, "1"));
11778 try_window (window
, startp
);
11781 if (fonts_changed_p
)
11782 goto need_larger_matrices
;
11784 if (w
->cursor
.vpos
>= 0)
11786 if (!just_this_one_p
11787 || current_buffer
->clip_changed
11788 || BEG_UNCHANGED
< CHARPOS (startp
))
11789 /* Forget any recorded base line for line number display. */
11790 w
->base_line_number
= Qnil
;
11792 if (!make_cursor_line_fully_visible (w
))
11794 clear_glyph_matrix (w
->desired_matrix
);
11795 last_line_misfit
= 1;
11797 /* Drop through and scroll. */
11802 clear_glyph_matrix (w
->desired_matrix
);
11807 w
->last_modified
= make_number (0);
11808 w
->last_overlay_modified
= make_number (0);
11810 /* Redisplay the mode line. Select the buffer properly for that. */
11811 if (!update_mode_line
)
11813 update_mode_line
= 1;
11814 w
->update_mode_line
= Qt
;
11817 /* Try to scroll by specified few lines. */
11818 if ((scroll_conservatively
11820 || temp_scroll_step
11821 || NUMBERP (current_buffer
->scroll_up_aggressively
)
11822 || NUMBERP (current_buffer
->scroll_down_aggressively
))
11823 && !current_buffer
->clip_changed
11824 && CHARPOS (startp
) >= BEGV
11825 && CHARPOS (startp
) <= ZV
)
11827 /* The function returns -1 if new fonts were loaded, 1 if
11828 successful, 0 if not successful. */
11829 int rc
= try_scrolling (window
, just_this_one_p
,
11830 scroll_conservatively
,
11832 temp_scroll_step
, last_line_misfit
);
11835 case SCROLLING_SUCCESS
:
11838 case SCROLLING_NEED_LARGER_MATRICES
:
11839 goto need_larger_matrices
;
11841 case SCROLLING_FAILED
:
11849 /* Finally, just choose place to start which centers point */
11852 centering_position
= window_box_height (w
) / 2;
11855 /* Jump here with centering_position already set to 0. */
11858 debug_method_add (w
, "recenter");
11861 /* w->vscroll = 0; */
11863 /* Forget any previously recorded base line for line number display. */
11864 if (!buffer_unchanged_p
)
11865 w
->base_line_number
= Qnil
;
11867 /* Move backward half the height of the window. */
11868 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
11869 it
.current_y
= it
.last_visible_y
;
11870 move_it_vertically_backward (&it
, centering_position
);
11871 xassert (IT_CHARPOS (it
) >= BEGV
);
11873 /* The function move_it_vertically_backward may move over more
11874 than the specified y-distance. If it->w is small, e.g. a
11875 mini-buffer window, we may end up in front of the window's
11876 display area. Start displaying at the start of the line
11877 containing PT in this case. */
11878 if (it
.current_y
<= 0)
11880 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
11881 move_it_vertically (&it
, 0);
11882 xassert (IT_CHARPOS (it
) <= PT
);
11886 it
.current_x
= it
.hpos
= 0;
11888 /* Set startp here explicitly in case that helps avoid an infinite loop
11889 in case the window-scroll-functions functions get errors. */
11890 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
11892 /* Run scroll hooks. */
11893 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
11895 /* Redisplay the window. */
11896 if (!current_matrix_up_to_date_p
11897 || windows_or_buffers_changed
11898 || cursor_type_changed
11899 /* Don't use try_window_reusing_current_matrix in this case
11900 because it can have changed the buffer. */
11901 || !NILP (Vwindow_scroll_functions
)
11902 || !just_this_one_p
11903 || MINI_WINDOW_P (w
)
11904 || !try_window_reusing_current_matrix (w
))
11905 try_window (window
, startp
);
11907 /* If new fonts have been loaded (due to fontsets), give up. We
11908 have to start a new redisplay since we need to re-adjust glyph
11910 if (fonts_changed_p
)
11911 goto need_larger_matrices
;
11913 /* If cursor did not appear assume that the middle of the window is
11914 in the first line of the window. Do it again with the next line.
11915 (Imagine a window of height 100, displaying two lines of height
11916 60. Moving back 50 from it->last_visible_y will end in the first
11918 if (w
->cursor
.vpos
< 0)
11920 if (!NILP (w
->window_end_valid
)
11921 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
11923 clear_glyph_matrix (w
->desired_matrix
);
11924 move_it_by_lines (&it
, 1, 0);
11925 try_window (window
, it
.current
.pos
);
11927 else if (PT
< IT_CHARPOS (it
))
11929 clear_glyph_matrix (w
->desired_matrix
);
11930 move_it_by_lines (&it
, -1, 0);
11931 try_window (window
, it
.current
.pos
);
11935 /* Not much we can do about it. */
11939 /* Consider the following case: Window starts at BEGV, there is
11940 invisible, intangible text at BEGV, so that display starts at
11941 some point START > BEGV. It can happen that we are called with
11942 PT somewhere between BEGV and START. Try to handle that case. */
11943 if (w
->cursor
.vpos
< 0)
11945 struct glyph_row
*row
= w
->current_matrix
->rows
;
11946 if (row
->mode_line_p
)
11948 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
11951 if (!make_cursor_line_fully_visible (w
))
11953 /* If vscroll is enabled, disable it and try again. */
11957 clear_glyph_matrix (w
->desired_matrix
);
11961 /* If centering point failed to make the whole line visible,
11962 put point at the top instead. That has to make the whole line
11963 visible, if it can be done. */
11964 centering_position
= 0;
11970 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
11971 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
11972 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
11975 /* Display the mode line, if we must. */
11976 if ((update_mode_line
11977 /* If window not full width, must redo its mode line
11978 if (a) the window to its side is being redone and
11979 (b) we do a frame-based redisplay. This is a consequence
11980 of how inverted lines are drawn in frame-based redisplay. */
11981 || (!just_this_one_p
11982 && !FRAME_WINDOW_P (f
)
11983 && !WINDOW_FULL_WIDTH_P (w
))
11984 /* Line number to display. */
11985 || INTEGERP (w
->base_line_pos
)
11986 /* Column number is displayed and different from the one displayed. */
11987 || (!NILP (w
->column_number_displayed
)
11988 && (XFASTINT (w
->column_number_displayed
)
11989 != (int) current_column ()))) /* iftc */
11990 /* This means that the window has a mode line. */
11991 && (WINDOW_WANTS_MODELINE_P (w
)
11992 || WINDOW_WANTS_HEADER_LINE_P (w
)))
11994 display_mode_lines (w
);
11996 /* If mode line height has changed, arrange for a thorough
11997 immediate redisplay using the correct mode line height. */
11998 if (WINDOW_WANTS_MODELINE_P (w
)
11999 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
12001 fonts_changed_p
= 1;
12002 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
12003 = DESIRED_MODE_LINE_HEIGHT (w
);
12006 /* If top line height has changed, arrange for a thorough
12007 immediate redisplay using the correct mode line height. */
12008 if (WINDOW_WANTS_HEADER_LINE_P (w
)
12009 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
12011 fonts_changed_p
= 1;
12012 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
12013 = DESIRED_HEADER_LINE_HEIGHT (w
);
12016 if (fonts_changed_p
)
12017 goto need_larger_matrices
;
12020 if (!line_number_displayed
12021 && !BUFFERP (w
->base_line_pos
))
12023 w
->base_line_pos
= Qnil
;
12024 w
->base_line_number
= Qnil
;
12029 /* When we reach a frame's selected window, redo the frame's menu bar. */
12030 if (update_mode_line
12031 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
12033 int redisplay_menu_p
= 0;
12034 int redisplay_tool_bar_p
= 0;
12036 if (FRAME_WINDOW_P (f
))
12038 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
12039 || defined (USE_GTK)
12040 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
12042 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
12046 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
12048 if (redisplay_menu_p
)
12049 display_menu_bar (w
);
12051 #ifdef HAVE_WINDOW_SYSTEM
12053 redisplay_tool_bar_p
= FRAME_EXTERNAL_TOOL_BAR (f
);
12055 redisplay_tool_bar_p
= WINDOWP (f
->tool_bar_window
)
12056 && (FRAME_TOOL_BAR_LINES (f
) > 0
12057 || auto_resize_tool_bars_p
);
12061 if (redisplay_tool_bar_p
)
12062 redisplay_tool_bar (f
);
12066 /* We go to this label, with fonts_changed_p nonzero,
12067 if it is necessary to try again using larger glyph matrices.
12068 We have to redeem the scroll bar even in this case,
12069 because the loop in redisplay_internal expects that. */
12070 need_larger_matrices
:
12072 finish_scroll_bars
:
12074 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
12076 /* Set the thumb's position and size. */
12077 set_vertical_scroll_bar (w
);
12079 /* Note that we actually used the scroll bar attached to this
12080 window, so it shouldn't be deleted at the end of redisplay. */
12081 redeem_scroll_bar_hook (w
);
12084 /* Restore current_buffer and value of point in it. */
12085 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
12086 set_buffer_internal_1 (old
);
12087 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
12089 unbind_to (count
, Qnil
);
12093 /* Build the complete desired matrix of WINDOW with a window start
12094 buffer position POS. Value is non-zero if successful. It is zero
12095 if fonts were loaded during redisplay which makes re-adjusting
12096 glyph matrices necessary. */
12099 try_window (window
, pos
)
12100 Lisp_Object window
;
12101 struct text_pos pos
;
12103 struct window
*w
= XWINDOW (window
);
12105 struct glyph_row
*last_text_row
= NULL
;
12107 /* Make POS the new window start. */
12108 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
12110 /* Mark cursor position as unknown. No overlay arrow seen. */
12111 w
->cursor
.vpos
= -1;
12112 overlay_arrow_seen
= 0;
12114 /* Initialize iterator and info to start at POS. */
12115 start_display (&it
, w
, pos
);
12117 /* Display all lines of W. */
12118 while (it
.current_y
< it
.last_visible_y
)
12120 if (display_line (&it
))
12121 last_text_row
= it
.glyph_row
- 1;
12122 if (fonts_changed_p
)
12126 /* If bottom moved off end of frame, change mode line percentage. */
12127 if (XFASTINT (w
->window_end_pos
) <= 0
12128 && Z
!= IT_CHARPOS (it
))
12129 w
->update_mode_line
= Qt
;
12131 /* Set window_end_pos to the offset of the last character displayed
12132 on the window from the end of current_buffer. Set
12133 window_end_vpos to its row number. */
12136 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
12137 w
->window_end_bytepos
12138 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
12140 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
12142 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
12143 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
12144 ->displays_text_p
);
12148 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
12149 w
->window_end_pos
= make_number (Z
- ZV
);
12150 w
->window_end_vpos
= make_number (0);
12153 /* But that is not valid info until redisplay finishes. */
12154 w
->window_end_valid
= Qnil
;
12160 /************************************************************************
12161 Window redisplay reusing current matrix when buffer has not changed
12162 ************************************************************************/
12164 /* Try redisplay of window W showing an unchanged buffer with a
12165 different window start than the last time it was displayed by
12166 reusing its current matrix. Value is non-zero if successful.
12167 W->start is the new window start. */
12170 try_window_reusing_current_matrix (w
)
12173 struct frame
*f
= XFRAME (w
->frame
);
12174 struct glyph_row
*row
, *bottom_row
;
12177 struct text_pos start
, new_start
;
12178 int nrows_scrolled
, i
;
12179 struct glyph_row
*last_text_row
;
12180 struct glyph_row
*last_reused_text_row
;
12181 struct glyph_row
*start_row
;
12182 int start_vpos
, min_y
, max_y
;
12185 if (inhibit_try_window_reusing
)
12189 if (/* This function doesn't handle terminal frames. */
12190 !FRAME_WINDOW_P (f
)
12191 /* Don't try to reuse the display if windows have been split
12193 || windows_or_buffers_changed
12194 || cursor_type_changed
)
12197 /* Can't do this if region may have changed. */
12198 if ((!NILP (Vtransient_mark_mode
)
12199 && !NILP (current_buffer
->mark_active
))
12200 || !NILP (w
->region_showing
)
12201 || !NILP (Vshow_trailing_whitespace
))
12204 /* If top-line visibility has changed, give up. */
12205 if (WINDOW_WANTS_HEADER_LINE_P (w
)
12206 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
12209 /* Give up if old or new display is scrolled vertically. We could
12210 make this function handle this, but right now it doesn't. */
12211 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
12212 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (start_row
))
12215 /* The variable new_start now holds the new window start. The old
12216 start `start' can be determined from the current matrix. */
12217 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
12218 start
= start_row
->start
.pos
;
12219 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
12221 /* Clear the desired matrix for the display below. */
12222 clear_glyph_matrix (w
->desired_matrix
);
12224 if (CHARPOS (new_start
) <= CHARPOS (start
))
12228 /* Don't use this method if the display starts with an ellipsis
12229 displayed for invisible text. It's not easy to handle that case
12230 below, and it's certainly not worth the effort since this is
12231 not a frequent case. */
12232 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
12235 IF_DEBUG (debug_method_add (w
, "twu1"));
12237 /* Display up to a row that can be reused. The variable
12238 last_text_row is set to the last row displayed that displays
12239 text. Note that it.vpos == 0 if or if not there is a
12240 header-line; it's not the same as the MATRIX_ROW_VPOS! */
12241 start_display (&it
, w
, new_start
);
12242 first_row_y
= it
.current_y
;
12243 w
->cursor
.vpos
= -1;
12244 last_text_row
= last_reused_text_row
= NULL
;
12246 while (it
.current_y
< it
.last_visible_y
12247 && IT_CHARPOS (it
) < CHARPOS (start
)
12248 && !fonts_changed_p
)
12249 if (display_line (&it
))
12250 last_text_row
= it
.glyph_row
- 1;
12252 /* A value of current_y < last_visible_y means that we stopped
12253 at the previous window start, which in turn means that we
12254 have at least one reusable row. */
12255 if (it
.current_y
< it
.last_visible_y
)
12257 /* IT.vpos always starts from 0; it counts text lines. */
12258 nrows_scrolled
= it
.vpos
;
12260 /* Find PT if not already found in the lines displayed. */
12261 if (w
->cursor
.vpos
< 0)
12263 int dy
= it
.current_y
- first_row_y
;
12265 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
12266 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
12268 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
12269 dy
, nrows_scrolled
);
12272 clear_glyph_matrix (w
->desired_matrix
);
12277 /* Scroll the display. Do it before the current matrix is
12278 changed. The problem here is that update has not yet
12279 run, i.e. part of the current matrix is not up to date.
12280 scroll_run_hook will clear the cursor, and use the
12281 current matrix to get the height of the row the cursor is
12283 run
.current_y
= first_row_y
;
12284 run
.desired_y
= it
.current_y
;
12285 run
.height
= it
.last_visible_y
- it
.current_y
;
12287 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
12290 rif
->update_window_begin_hook (w
);
12291 rif
->clear_window_mouse_face (w
);
12292 rif
->scroll_run_hook (w
, &run
);
12293 rif
->update_window_end_hook (w
, 0, 0);
12297 /* Shift current matrix down by nrows_scrolled lines. */
12298 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
12299 rotate_matrix (w
->current_matrix
,
12301 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
12304 /* Disable lines that must be updated. */
12305 for (i
= 0; i
< it
.vpos
; ++i
)
12306 (start_row
+ i
)->enabled_p
= 0;
12308 /* Re-compute Y positions. */
12309 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
12310 max_y
= it
.last_visible_y
;
12311 for (row
= start_row
+ nrows_scrolled
;
12315 row
->y
= it
.current_y
;
12316 row
->visible_height
= row
->height
;
12318 if (row
->y
< min_y
)
12319 row
->visible_height
-= min_y
- row
->y
;
12320 if (row
->y
+ row
->height
> max_y
)
12321 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
12323 it
.current_y
+= row
->height
;
12325 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
12326 last_reused_text_row
= row
;
12327 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
12331 /* Disable lines in the current matrix which are now
12332 below the window. */
12333 for (++row
; row
< bottom_row
; ++row
)
12334 row
->enabled_p
= 0;
12337 /* Update window_end_pos etc.; last_reused_text_row is the last
12338 reused row from the current matrix containing text, if any.
12339 The value of last_text_row is the last displayed line
12340 containing text. */
12341 if (last_reused_text_row
)
12343 w
->window_end_bytepos
12344 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
12346 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
12348 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
12349 w
->current_matrix
));
12351 else if (last_text_row
)
12353 w
->window_end_bytepos
12354 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
12356 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
12358 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
12362 /* This window must be completely empty. */
12363 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
12364 w
->window_end_pos
= make_number (Z
- ZV
);
12365 w
->window_end_vpos
= make_number (0);
12367 w
->window_end_valid
= Qnil
;
12369 /* Update hint: don't try scrolling again in update_window. */
12370 w
->desired_matrix
->no_scrolling_p
= 1;
12373 debug_method_add (w
, "try_window_reusing_current_matrix 1");
12377 else if (CHARPOS (new_start
) > CHARPOS (start
))
12379 struct glyph_row
*pt_row
, *row
;
12380 struct glyph_row
*first_reusable_row
;
12381 struct glyph_row
*first_row_to_display
;
12383 int yb
= window_text_bottom_y (w
);
12385 /* Find the row starting at new_start, if there is one. Don't
12386 reuse a partially visible line at the end. */
12387 first_reusable_row
= start_row
;
12388 while (first_reusable_row
->enabled_p
12389 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
12390 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
12391 < CHARPOS (new_start
)))
12392 ++first_reusable_row
;
12394 /* Give up if there is no row to reuse. */
12395 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
12396 || !first_reusable_row
->enabled_p
12397 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
12398 != CHARPOS (new_start
)))
12401 /* We can reuse fully visible rows beginning with
12402 first_reusable_row to the end of the window. Set
12403 first_row_to_display to the first row that cannot be reused.
12404 Set pt_row to the row containing point, if there is any. */
12406 for (first_row_to_display
= first_reusable_row
;
12407 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
12408 ++first_row_to_display
)
12410 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
12411 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
12412 pt_row
= first_row_to_display
;
12415 /* Start displaying at the start of first_row_to_display. */
12416 xassert (first_row_to_display
->y
< yb
);
12417 init_to_row_start (&it
, w
, first_row_to_display
);
12419 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
12421 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
12423 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
12424 + WINDOW_HEADER_LINE_HEIGHT (w
));
12426 /* Display lines beginning with first_row_to_display in the
12427 desired matrix. Set last_text_row to the last row displayed
12428 that displays text. */
12429 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
12430 if (pt_row
== NULL
)
12431 w
->cursor
.vpos
= -1;
12432 last_text_row
= NULL
;
12433 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
12434 if (display_line (&it
))
12435 last_text_row
= it
.glyph_row
- 1;
12437 /* Give up If point isn't in a row displayed or reused. */
12438 if (w
->cursor
.vpos
< 0)
12440 clear_glyph_matrix (w
->desired_matrix
);
12444 /* If point is in a reused row, adjust y and vpos of the cursor
12448 w
->cursor
.vpos
-= MATRIX_ROW_VPOS (first_reusable_row
,
12449 w
->current_matrix
);
12450 w
->cursor
.y
-= first_reusable_row
->y
;
12453 /* Scroll the display. */
12454 run
.current_y
= first_reusable_row
->y
;
12455 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
12456 run
.height
= it
.last_visible_y
- run
.current_y
;
12457 dy
= run
.current_y
- run
.desired_y
;
12461 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
12463 rif
->update_window_begin_hook (w
);
12464 rif
->clear_window_mouse_face (w
);
12465 rif
->scroll_run_hook (w
, &run
);
12466 rif
->update_window_end_hook (w
, 0, 0);
12470 /* Adjust Y positions of reused rows. */
12471 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
12472 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
12473 max_y
= it
.last_visible_y
;
12474 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
12477 row
->visible_height
= row
->height
;
12478 if (row
->y
< min_y
)
12479 row
->visible_height
-= min_y
- row
->y
;
12480 if (row
->y
+ row
->height
> max_y
)
12481 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
12484 /* Scroll the current matrix. */
12485 xassert (nrows_scrolled
> 0);
12486 rotate_matrix (w
->current_matrix
,
12488 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
12491 /* Disable rows not reused. */
12492 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
12493 row
->enabled_p
= 0;
12495 /* Adjust window end. A null value of last_text_row means that
12496 the window end is in reused rows which in turn means that
12497 only its vpos can have changed. */
12500 w
->window_end_bytepos
12501 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
12503 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
12505 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
12510 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
12513 w
->window_end_valid
= Qnil
;
12514 w
->desired_matrix
->no_scrolling_p
= 1;
12517 debug_method_add (w
, "try_window_reusing_current_matrix 2");
12527 /************************************************************************
12528 Window redisplay reusing current matrix when buffer has changed
12529 ************************************************************************/
12531 static struct glyph_row
*find_last_unchanged_at_beg_row
P_ ((struct window
*));
12532 static struct glyph_row
*find_first_unchanged_at_end_row
P_ ((struct window
*,
12534 static struct glyph_row
*
12535 find_last_row_displaying_text
P_ ((struct glyph_matrix
*, struct it
*,
12536 struct glyph_row
*));
12539 /* Return the last row in MATRIX displaying text. If row START is
12540 non-null, start searching with that row. IT gives the dimensions
12541 of the display. Value is null if matrix is empty; otherwise it is
12542 a pointer to the row found. */
12544 static struct glyph_row
*
12545 find_last_row_displaying_text (matrix
, it
, start
)
12546 struct glyph_matrix
*matrix
;
12548 struct glyph_row
*start
;
12550 struct glyph_row
*row
, *row_found
;
12552 /* Set row_found to the last row in IT->w's current matrix
12553 displaying text. The loop looks funny but think of partially
12556 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
12557 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
12559 xassert (row
->enabled_p
);
12561 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
12570 /* Return the last row in the current matrix of W that is not affected
12571 by changes at the start of current_buffer that occurred since W's
12572 current matrix was built. Value is null if no such row exists.
12574 BEG_UNCHANGED us the number of characters unchanged at the start of
12575 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
12576 first changed character in current_buffer. Characters at positions <
12577 BEG + BEG_UNCHANGED are at the same buffer positions as they were
12578 when the current matrix was built. */
12580 static struct glyph_row
*
12581 find_last_unchanged_at_beg_row (w
)
12584 int first_changed_pos
= BEG
+ BEG_UNCHANGED
;
12585 struct glyph_row
*row
;
12586 struct glyph_row
*row_found
= NULL
;
12587 int yb
= window_text_bottom_y (w
);
12589 /* Find the last row displaying unchanged text. */
12590 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
12591 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12592 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
)
12594 if (/* If row ends before first_changed_pos, it is unchanged,
12595 except in some case. */
12596 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
12597 /* When row ends in ZV and we write at ZV it is not
12599 && !row
->ends_at_zv_p
12600 /* When first_changed_pos is the end of a continued line,
12601 row is not unchanged because it may be no longer
12603 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
12604 && row
->continued_p
))
12607 /* Stop if last visible row. */
12608 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
12618 /* Find the first glyph row in the current matrix of W that is not
12619 affected by changes at the end of current_buffer since the
12620 time W's current matrix was built.
12622 Return in *DELTA the number of chars by which buffer positions in
12623 unchanged text at the end of current_buffer must be adjusted.
12625 Return in *DELTA_BYTES the corresponding number of bytes.
12627 Value is null if no such row exists, i.e. all rows are affected by
12630 static struct glyph_row
*
12631 find_first_unchanged_at_end_row (w
, delta
, delta_bytes
)
12633 int *delta
, *delta_bytes
;
12635 struct glyph_row
*row
;
12636 struct glyph_row
*row_found
= NULL
;
12638 *delta
= *delta_bytes
= 0;
12640 /* Display must not have been paused, otherwise the current matrix
12641 is not up to date. */
12642 if (NILP (w
->window_end_valid
))
12645 /* A value of window_end_pos >= END_UNCHANGED means that the window
12646 end is in the range of changed text. If so, there is no
12647 unchanged row at the end of W's current matrix. */
12648 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
12651 /* Set row to the last row in W's current matrix displaying text. */
12652 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
12654 /* If matrix is entirely empty, no unchanged row exists. */
12655 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
12657 /* The value of row is the last glyph row in the matrix having a
12658 meaningful buffer position in it. The end position of row
12659 corresponds to window_end_pos. This allows us to translate
12660 buffer positions in the current matrix to current buffer
12661 positions for characters not in changed text. */
12662 int Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
12663 int Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
12664 int last_unchanged_pos
, last_unchanged_pos_old
;
12665 struct glyph_row
*first_text_row
12666 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
12668 *delta
= Z
- Z_old
;
12669 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
12671 /* Set last_unchanged_pos to the buffer position of the last
12672 character in the buffer that has not been changed. Z is the
12673 index + 1 of the last character in current_buffer, i.e. by
12674 subtracting END_UNCHANGED we get the index of the last
12675 unchanged character, and we have to add BEG to get its buffer
12677 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
12678 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
12680 /* Search backward from ROW for a row displaying a line that
12681 starts at a minimum position >= last_unchanged_pos_old. */
12682 for (; row
> first_text_row
; --row
)
12684 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
12687 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
12692 if (row_found
&& !MATRIX_ROW_DISPLAYS_TEXT_P (row_found
))
12699 /* Make sure that glyph rows in the current matrix of window W
12700 reference the same glyph memory as corresponding rows in the
12701 frame's frame matrix. This function is called after scrolling W's
12702 current matrix on a terminal frame in try_window_id and
12703 try_window_reusing_current_matrix. */
12706 sync_frame_with_window_matrix_rows (w
)
12709 struct frame
*f
= XFRAME (w
->frame
);
12710 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
12712 /* Preconditions: W must be a leaf window and full-width. Its frame
12713 must have a frame matrix. */
12714 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
12715 xassert (WINDOW_FULL_WIDTH_P (w
));
12716 xassert (!FRAME_WINDOW_P (f
));
12718 /* If W is a full-width window, glyph pointers in W's current matrix
12719 have, by definition, to be the same as glyph pointers in the
12720 corresponding frame matrix. Note that frame matrices have no
12721 marginal areas (see build_frame_matrix). */
12722 window_row
= w
->current_matrix
->rows
;
12723 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
12724 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
12725 while (window_row
< window_row_end
)
12727 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
12728 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
12730 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
12731 frame_row
->glyphs
[TEXT_AREA
] = start
;
12732 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
12733 frame_row
->glyphs
[LAST_AREA
] = end
;
12735 /* Disable frame rows whose corresponding window rows have
12736 been disabled in try_window_id. */
12737 if (!window_row
->enabled_p
)
12738 frame_row
->enabled_p
= 0;
12740 ++window_row
, ++frame_row
;
12745 /* Find the glyph row in window W containing CHARPOS. Consider all
12746 rows between START and END (not inclusive). END null means search
12747 all rows to the end of the display area of W. Value is the row
12748 containing CHARPOS or null. */
12751 row_containing_pos (w
, charpos
, start
, end
, dy
)
12754 struct glyph_row
*start
, *end
;
12757 struct glyph_row
*row
= start
;
12760 /* If we happen to start on a header-line, skip that. */
12761 if (row
->mode_line_p
)
12764 if ((end
&& row
>= end
) || !row
->enabled_p
)
12767 last_y
= window_text_bottom_y (w
) - dy
;
12771 /* Give up if we have gone too far. */
12772 if (end
&& row
>= end
)
12774 /* This formerly returned if they were equal.
12775 I think that both quantities are of a "last plus one" type;
12776 if so, when they are equal, the row is within the screen. -- rms. */
12777 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
12780 /* If it is in this row, return this row. */
12781 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
12782 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
12783 /* The end position of a row equals the start
12784 position of the next row. If CHARPOS is there, we
12785 would rather display it in the next line, except
12786 when this line ends in ZV. */
12787 && !row
->ends_at_zv_p
12788 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
12789 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
12796 /* Try to redisplay window W by reusing its existing display. W's
12797 current matrix must be up to date when this function is called,
12798 i.e. window_end_valid must not be nil.
12802 1 if display has been updated
12803 0 if otherwise unsuccessful
12804 -1 if redisplay with same window start is known not to succeed
12806 The following steps are performed:
12808 1. Find the last row in the current matrix of W that is not
12809 affected by changes at the start of current_buffer. If no such row
12812 2. Find the first row in W's current matrix that is not affected by
12813 changes at the end of current_buffer. Maybe there is no such row.
12815 3. Display lines beginning with the row + 1 found in step 1 to the
12816 row found in step 2 or, if step 2 didn't find a row, to the end of
12819 4. If cursor is not known to appear on the window, give up.
12821 5. If display stopped at the row found in step 2, scroll the
12822 display and current matrix as needed.
12824 6. Maybe display some lines at the end of W, if we must. This can
12825 happen under various circumstances, like a partially visible line
12826 becoming fully visible, or because newly displayed lines are displayed
12827 in smaller font sizes.
12829 7. Update W's window end information. */
12835 struct frame
*f
= XFRAME (w
->frame
);
12836 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
12837 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
12838 struct glyph_row
*last_unchanged_at_beg_row
;
12839 struct glyph_row
*first_unchanged_at_end_row
;
12840 struct glyph_row
*row
;
12841 struct glyph_row
*bottom_row
;
12844 int delta
= 0, delta_bytes
= 0, stop_pos
, dvpos
, dy
;
12845 struct text_pos start_pos
;
12847 int first_unchanged_at_end_vpos
= 0;
12848 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
12849 struct text_pos start
;
12850 int first_changed_charpos
, last_changed_charpos
;
12853 if (inhibit_try_window_id
)
12857 /* This is handy for debugging. */
12859 #define GIVE_UP(X) \
12861 fprintf (stderr, "try_window_id give up %d\n", (X)); \
12865 #define GIVE_UP(X) return 0
12868 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
12870 /* Don't use this for mini-windows because these can show
12871 messages and mini-buffers, and we don't handle that here. */
12872 if (MINI_WINDOW_P (w
))
12875 /* This flag is used to prevent redisplay optimizations. */
12876 if (windows_or_buffers_changed
|| cursor_type_changed
)
12879 /* Verify that narrowing has not changed.
12880 Also verify that we were not told to prevent redisplay optimizations.
12881 It would be nice to further
12882 reduce the number of cases where this prevents try_window_id. */
12883 if (current_buffer
->clip_changed
12884 || current_buffer
->prevent_redisplay_optimizations_p
)
12887 /* Window must either use window-based redisplay or be full width. */
12888 if (!FRAME_WINDOW_P (f
)
12889 && (!TTY_LINE_INS_DEL_OK (CURTTY ())
12890 || !WINDOW_FULL_WIDTH_P (w
)))
12893 /* Give up if point is not known NOT to appear in W. */
12894 if (PT
< CHARPOS (start
))
12897 /* Another way to prevent redisplay optimizations. */
12898 if (XFASTINT (w
->last_modified
) == 0)
12901 /* Verify that window is not hscrolled. */
12902 if (XFASTINT (w
->hscroll
) != 0)
12905 /* Verify that display wasn't paused. */
12906 if (NILP (w
->window_end_valid
))
12909 /* Can't use this if highlighting a region because a cursor movement
12910 will do more than just set the cursor. */
12911 if (!NILP (Vtransient_mark_mode
)
12912 && !NILP (current_buffer
->mark_active
))
12915 /* Likewise if highlighting trailing whitespace. */
12916 if (!NILP (Vshow_trailing_whitespace
))
12919 /* Likewise if showing a region. */
12920 if (!NILP (w
->region_showing
))
12923 /* Can use this if overlay arrow position and or string have changed. */
12924 if (!EQ (last_arrow_position
, COERCE_MARKER (Voverlay_arrow_position
))
12925 || !EQ (last_arrow_string
, Voverlay_arrow_string
))
12929 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
12930 only if buffer has really changed. The reason is that the gap is
12931 initially at Z for freshly visited files. The code below would
12932 set end_unchanged to 0 in that case. */
12933 if (MODIFF
> SAVE_MODIFF
12934 /* This seems to happen sometimes after saving a buffer. */
12935 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
12937 if (GPT
- BEG
< BEG_UNCHANGED
)
12938 BEG_UNCHANGED
= GPT
- BEG
;
12939 if (Z
- GPT
< END_UNCHANGED
)
12940 END_UNCHANGED
= Z
- GPT
;
12943 /* The position of the first and last character that has been changed. */
12944 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
12945 last_changed_charpos
= Z
- END_UNCHANGED
;
12947 /* If window starts after a line end, and the last change is in
12948 front of that newline, then changes don't affect the display.
12949 This case happens with stealth-fontification. Note that although
12950 the display is unchanged, glyph positions in the matrix have to
12951 be adjusted, of course. */
12952 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
12953 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12954 && ((last_changed_charpos
< CHARPOS (start
)
12955 && CHARPOS (start
) == BEGV
)
12956 || (last_changed_charpos
< CHARPOS (start
) - 1
12957 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
12959 int Z_old
, delta
, Z_BYTE_old
, delta_bytes
;
12960 struct glyph_row
*r0
;
12962 /* Compute how many chars/bytes have been added to or removed
12963 from the buffer. */
12964 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
12965 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
12967 delta_bytes
= Z_BYTE
- Z_BYTE_old
;
12969 /* Give up if PT is not in the window. Note that it already has
12970 been checked at the start of try_window_id that PT is not in
12971 front of the window start. */
12972 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + delta
)
12975 /* If window start is unchanged, we can reuse the whole matrix
12976 as is, after adjusting glyph positions. No need to compute
12977 the window end again, since its offset from Z hasn't changed. */
12978 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
12979 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + delta
12980 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + delta_bytes
12981 /* PT must not be in a partially visible line. */
12982 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + delta
12983 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
12985 /* Adjust positions in the glyph matrix. */
12986 if (delta
|| delta_bytes
)
12988 struct glyph_row
*r1
12989 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
12990 increment_matrix_positions (w
->current_matrix
,
12991 MATRIX_ROW_VPOS (r0
, current_matrix
),
12992 MATRIX_ROW_VPOS (r1
, current_matrix
),
12993 delta
, delta_bytes
);
12996 /* Set the cursor. */
12997 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
12999 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
13006 /* Handle the case that changes are all below what is displayed in
13007 the window, and that PT is in the window. This shortcut cannot
13008 be taken if ZV is visible in the window, and text has been added
13009 there that is visible in the window. */
13010 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
13011 /* ZV is not visible in the window, or there are no
13012 changes at ZV, actually. */
13013 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
13014 || first_changed_charpos
== last_changed_charpos
))
13016 struct glyph_row
*r0
;
13018 /* Give up if PT is not in the window. Note that it already has
13019 been checked at the start of try_window_id that PT is not in
13020 front of the window start. */
13021 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
13024 /* If window start is unchanged, we can reuse the whole matrix
13025 as is, without changing glyph positions since no text has
13026 been added/removed in front of the window end. */
13027 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
13028 if (TEXT_POS_EQUAL_P (start
, r0
->start
.pos
)
13029 /* PT must not be in a partially visible line. */
13030 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
13031 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
13033 /* We have to compute the window end anew since text
13034 can have been added/removed after it. */
13036 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
13037 w
->window_end_bytepos
13038 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
13040 /* Set the cursor. */
13041 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
13043 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
13050 /* Give up if window start is in the changed area.
13052 The condition used to read
13054 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
13056 but why that was tested escapes me at the moment. */
13057 if (CHARPOS (start
) >= first_changed_charpos
13058 && CHARPOS (start
) <= last_changed_charpos
)
13061 /* Check that window start agrees with the start of the first glyph
13062 row in its current matrix. Check this after we know the window
13063 start is not in changed text, otherwise positions would not be
13065 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
13066 if (!TEXT_POS_EQUAL_P (start
, row
->start
.pos
))
13069 /* Give up if the window ends in strings. Overlay strings
13070 at the end are difficult to handle, so don't try. */
13071 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
13072 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
13075 /* Compute the position at which we have to start displaying new
13076 lines. Some of the lines at the top of the window might be
13077 reusable because they are not displaying changed text. Find the
13078 last row in W's current matrix not affected by changes at the
13079 start of current_buffer. Value is null if changes start in the
13080 first line of window. */
13081 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
13082 if (last_unchanged_at_beg_row
)
13084 /* Avoid starting to display in the moddle of a character, a TAB
13085 for instance. This is easier than to set up the iterator
13086 exactly, and it's not a frequent case, so the additional
13087 effort wouldn't really pay off. */
13088 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
13089 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
13090 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
13091 --last_unchanged_at_beg_row
;
13093 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
13096 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
13098 start_pos
= it
.current
.pos
;
13100 /* Start displaying new lines in the desired matrix at the same
13101 vpos we would use in the current matrix, i.e. below
13102 last_unchanged_at_beg_row. */
13103 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
13105 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
13106 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
13108 xassert (it
.hpos
== 0 && it
.current_x
== 0);
13112 /* There are no reusable lines at the start of the window.
13113 Start displaying in the first text line. */
13114 start_display (&it
, w
, start
);
13115 it
.vpos
= it
.first_vpos
;
13116 start_pos
= it
.current
.pos
;
13119 /* Find the first row that is not affected by changes at the end of
13120 the buffer. Value will be null if there is no unchanged row, in
13121 which case we must redisplay to the end of the window. delta
13122 will be set to the value by which buffer positions beginning with
13123 first_unchanged_at_end_row have to be adjusted due to text
13125 first_unchanged_at_end_row
13126 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
13127 IF_DEBUG (debug_delta
= delta
);
13128 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
13130 /* Set stop_pos to the buffer position up to which we will have to
13131 display new lines. If first_unchanged_at_end_row != NULL, this
13132 is the buffer position of the start of the line displayed in that
13133 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
13134 that we don't stop at a buffer position. */
13136 if (first_unchanged_at_end_row
)
13138 xassert (last_unchanged_at_beg_row
== NULL
13139 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
13141 /* If this is a continuation line, move forward to the next one
13142 that isn't. Changes in lines above affect this line.
13143 Caution: this may move first_unchanged_at_end_row to a row
13144 not displaying text. */
13145 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
13146 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
13147 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
13148 < it
.last_visible_y
))
13149 ++first_unchanged_at_end_row
;
13151 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
13152 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
13153 >= it
.last_visible_y
))
13154 first_unchanged_at_end_row
= NULL
;
13157 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
13159 first_unchanged_at_end_vpos
13160 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
13161 xassert (stop_pos
>= Z
- END_UNCHANGED
);
13164 else if (last_unchanged_at_beg_row
== NULL
)
13170 /* Either there is no unchanged row at the end, or the one we have
13171 now displays text. This is a necessary condition for the window
13172 end pos calculation at the end of this function. */
13173 xassert (first_unchanged_at_end_row
== NULL
13174 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
13176 debug_last_unchanged_at_beg_vpos
13177 = (last_unchanged_at_beg_row
13178 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
13180 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
13182 #endif /* GLYPH_DEBUG != 0 */
13185 /* Display new lines. Set last_text_row to the last new line
13186 displayed which has text on it, i.e. might end up as being the
13187 line where the window_end_vpos is. */
13188 w
->cursor
.vpos
= -1;
13189 last_text_row
= NULL
;
13190 overlay_arrow_seen
= 0;
13191 while (it
.current_y
< it
.last_visible_y
13192 && !fonts_changed_p
13193 && (first_unchanged_at_end_row
== NULL
13194 || IT_CHARPOS (it
) < stop_pos
))
13196 if (display_line (&it
))
13197 last_text_row
= it
.glyph_row
- 1;
13200 if (fonts_changed_p
)
13204 /* Compute differences in buffer positions, y-positions etc. for
13205 lines reused at the bottom of the window. Compute what we can
13207 if (first_unchanged_at_end_row
13208 /* No lines reused because we displayed everything up to the
13209 bottom of the window. */
13210 && it
.current_y
< it
.last_visible_y
)
13213 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
13215 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
13216 run
.current_y
= first_unchanged_at_end_row
->y
;
13217 run
.desired_y
= run
.current_y
+ dy
;
13218 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
13222 delta
= dvpos
= dy
= run
.current_y
= run
.desired_y
= run
.height
= 0;
13223 first_unchanged_at_end_row
= NULL
;
13225 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
13228 /* Find the cursor if not already found. We have to decide whether
13229 PT will appear on this window (it sometimes doesn't, but this is
13230 not a very frequent case.) This decision has to be made before
13231 the current matrix is altered. A value of cursor.vpos < 0 means
13232 that PT is either in one of the lines beginning at
13233 first_unchanged_at_end_row or below the window. Don't care for
13234 lines that might be displayed later at the window end; as
13235 mentioned, this is not a frequent case. */
13236 if (w
->cursor
.vpos
< 0)
13238 /* Cursor in unchanged rows at the top? */
13239 if (PT
< CHARPOS (start_pos
)
13240 && last_unchanged_at_beg_row
)
13242 row
= row_containing_pos (w
, PT
,
13243 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
13244 last_unchanged_at_beg_row
+ 1, 0);
13246 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13249 /* Start from first_unchanged_at_end_row looking for PT. */
13250 else if (first_unchanged_at_end_row
)
13252 row
= row_containing_pos (w
, PT
- delta
,
13253 first_unchanged_at_end_row
, NULL
, 0);
13255 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
13256 delta_bytes
, dy
, dvpos
);
13259 /* Give up if cursor was not found. */
13260 if (w
->cursor
.vpos
< 0)
13262 clear_glyph_matrix (w
->desired_matrix
);
13267 /* Don't let the cursor end in the scroll margins. */
13269 int this_scroll_margin
, cursor_height
;
13271 this_scroll_margin
= max (0, scroll_margin
);
13272 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
13273 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
13274 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
13276 if ((w
->cursor
.y
< this_scroll_margin
13277 && CHARPOS (start
) > BEGV
)
13278 /* Don't take scroll margin into account at the bottom because
13279 old redisplay didn't do it either. */
13280 || w
->cursor
.y
+ cursor_height
> it
.last_visible_y
)
13282 w
->cursor
.vpos
= -1;
13283 clear_glyph_matrix (w
->desired_matrix
);
13288 /* Scroll the display. Do it before changing the current matrix so
13289 that xterm.c doesn't get confused about where the cursor glyph is
13291 if (dy
&& run
.height
)
13295 if (FRAME_WINDOW_P (f
))
13297 rif
->update_window_begin_hook (w
);
13298 rif
->clear_window_mouse_face (w
);
13299 rif
->scroll_run_hook (w
, &run
);
13300 rif
->update_window_end_hook (w
, 0, 0);
13304 /* Terminal frame. In this case, dvpos gives the number of
13305 lines to scroll by; dvpos < 0 means scroll up. */
13306 int first_unchanged_at_end_vpos
13307 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
13308 int from
= WINDOW_TOP_EDGE_LINE (w
) + first_unchanged_at_end_vpos
;
13309 int end
= (WINDOW_TOP_EDGE_LINE (w
)
13310 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
13311 + window_internal_height (w
));
13313 /* Perform the operation on the screen. */
13316 /* Scroll last_unchanged_at_beg_row to the end of the
13317 window down dvpos lines. */
13318 set_terminal_window (end
);
13320 /* On dumb terminals delete dvpos lines at the end
13321 before inserting dvpos empty lines. */
13322 if (!TTY_SCROLL_REGION_OK (FRAME_TTY (f
)))
13323 ins_del_lines (end
- dvpos
, -dvpos
);
13325 /* Insert dvpos empty lines in front of
13326 last_unchanged_at_beg_row. */
13327 ins_del_lines (from
, dvpos
);
13329 else if (dvpos
< 0)
13331 /* Scroll up last_unchanged_at_beg_vpos to the end of
13332 the window to last_unchanged_at_beg_vpos - |dvpos|. */
13333 set_terminal_window (end
);
13335 /* Delete dvpos lines in front of
13336 last_unchanged_at_beg_vpos. ins_del_lines will set
13337 the cursor to the given vpos and emit |dvpos| delete
13339 ins_del_lines (from
+ dvpos
, dvpos
);
13341 /* On a dumb terminal insert dvpos empty lines at the
13343 if (!TTY_SCROLL_REGION_OK (FRAME_TTY (f
)))
13344 ins_del_lines (end
+ dvpos
, -dvpos
);
13347 set_terminal_window (0);
13353 /* Shift reused rows of the current matrix to the right position.
13354 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
13356 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
13357 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
13360 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
13361 bottom_vpos
, dvpos
);
13362 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
13365 else if (dvpos
> 0)
13367 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
13368 bottom_vpos
, dvpos
);
13369 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
13370 first_unchanged_at_end_vpos
+ dvpos
, 0);
13373 /* For frame-based redisplay, make sure that current frame and window
13374 matrix are in sync with respect to glyph memory. */
13375 if (!FRAME_WINDOW_P (f
))
13376 sync_frame_with_window_matrix_rows (w
);
13378 /* Adjust buffer positions in reused rows. */
13380 increment_matrix_positions (current_matrix
,
13381 first_unchanged_at_end_vpos
+ dvpos
,
13382 bottom_vpos
, delta
, delta_bytes
);
13384 /* Adjust Y positions. */
13386 shift_glyph_matrix (w
, current_matrix
,
13387 first_unchanged_at_end_vpos
+ dvpos
,
13390 if (first_unchanged_at_end_row
)
13391 first_unchanged_at_end_row
+= dvpos
;
13393 /* If scrolling up, there may be some lines to display at the end of
13395 last_text_row_at_end
= NULL
;
13398 /* Scrolling up can leave for example a partially visible line
13399 at the end of the window to be redisplayed. */
13400 /* Set last_row to the glyph row in the current matrix where the
13401 window end line is found. It has been moved up or down in
13402 the matrix by dvpos. */
13403 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
13404 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
13406 /* If last_row is the window end line, it should display text. */
13407 xassert (last_row
->displays_text_p
);
13409 /* If window end line was partially visible before, begin
13410 displaying at that line. Otherwise begin displaying with the
13411 line following it. */
13412 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
13414 init_to_row_start (&it
, w
, last_row
);
13415 it
.vpos
= last_vpos
;
13416 it
.current_y
= last_row
->y
;
13420 init_to_row_end (&it
, w
, last_row
);
13421 it
.vpos
= 1 + last_vpos
;
13422 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
13426 /* We may start in a continuation line. If so, we have to
13427 get the right continuation_lines_width and current_x. */
13428 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
13429 it
.hpos
= it
.current_x
= 0;
13431 /* Display the rest of the lines at the window end. */
13432 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
13433 while (it
.current_y
< it
.last_visible_y
13434 && !fonts_changed_p
)
13436 /* Is it always sure that the display agrees with lines in
13437 the current matrix? I don't think so, so we mark rows
13438 displayed invalid in the current matrix by setting their
13439 enabled_p flag to zero. */
13440 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
13441 if (display_line (&it
))
13442 last_text_row_at_end
= it
.glyph_row
- 1;
13446 /* Update window_end_pos and window_end_vpos. */
13447 if (first_unchanged_at_end_row
13448 && first_unchanged_at_end_row
->y
< it
.last_visible_y
13449 && !last_text_row_at_end
)
13451 /* Window end line if one of the preserved rows from the current
13452 matrix. Set row to the last row displaying text in current
13453 matrix starting at first_unchanged_at_end_row, after
13455 xassert (first_unchanged_at_end_row
->displays_text_p
);
13456 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
13457 first_unchanged_at_end_row
);
13458 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
13460 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
13461 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
13463 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
13464 xassert (w
->window_end_bytepos
>= 0);
13465 IF_DEBUG (debug_method_add (w
, "A"));
13467 else if (last_text_row_at_end
)
13470 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
13471 w
->window_end_bytepos
13472 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
13474 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
13475 xassert (w
->window_end_bytepos
>= 0);
13476 IF_DEBUG (debug_method_add (w
, "B"));
13478 else if (last_text_row
)
13480 /* We have displayed either to the end of the window or at the
13481 end of the window, i.e. the last row with text is to be found
13482 in the desired matrix. */
13484 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
13485 w
->window_end_bytepos
13486 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
13488 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
13489 xassert (w
->window_end_bytepos
>= 0);
13491 else if (first_unchanged_at_end_row
== NULL
13492 && last_text_row
== NULL
13493 && last_text_row_at_end
== NULL
)
13495 /* Displayed to end of window, but no line containing text was
13496 displayed. Lines were deleted at the end of the window. */
13497 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
13498 int vpos
= XFASTINT (w
->window_end_vpos
);
13499 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
13500 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
13503 row
== NULL
&& vpos
>= first_vpos
;
13504 --vpos
, --current_row
, --desired_row
)
13506 if (desired_row
->enabled_p
)
13508 if (desired_row
->displays_text_p
)
13511 else if (current_row
->displays_text_p
)
13515 xassert (row
!= NULL
);
13516 w
->window_end_vpos
= make_number (vpos
+ 1);
13517 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
13518 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
13519 xassert (w
->window_end_bytepos
>= 0);
13520 IF_DEBUG (debug_method_add (w
, "C"));
13525 #if 0 /* This leads to problems, for instance when the cursor is
13526 at ZV, and the cursor line displays no text. */
13527 /* Disable rows below what's displayed in the window. This makes
13528 debugging easier. */
13529 enable_glyph_matrix_rows (current_matrix
,
13530 XFASTINT (w
->window_end_vpos
) + 1,
13534 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
13535 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
13537 /* Record that display has not been completed. */
13538 w
->window_end_valid
= Qnil
;
13539 w
->desired_matrix
->no_scrolling_p
= 1;
13547 /***********************************************************************
13548 More debugging support
13549 ***********************************************************************/
13553 void dump_glyph_row
P_ ((struct glyph_row
*, int, int));
13554 void dump_glyph_matrix
P_ ((struct glyph_matrix
*, int));
13555 void dump_glyph
P_ ((struct glyph_row
*, struct glyph
*, int));
13558 /* Dump the contents of glyph matrix MATRIX on stderr.
13560 GLYPHS 0 means don't show glyph contents.
13561 GLYPHS 1 means show glyphs in short form
13562 GLYPHS > 1 means show glyphs in long form. */
13565 dump_glyph_matrix (matrix
, glyphs
)
13566 struct glyph_matrix
*matrix
;
13570 for (i
= 0; i
< matrix
->nrows
; ++i
)
13571 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
13575 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
13576 the glyph row and area where the glyph comes from. */
13579 dump_glyph (row
, glyph
, area
)
13580 struct glyph_row
*row
;
13581 struct glyph
*glyph
;
13584 if (glyph
->type
== CHAR_GLYPH
)
13587 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
13588 glyph
- row
->glyphs
[TEXT_AREA
],
13591 (BUFFERP (glyph
->object
)
13593 : (STRINGP (glyph
->object
)
13596 glyph
->pixel_width
,
13598 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
13602 glyph
->left_box_line_p
,
13603 glyph
->right_box_line_p
);
13605 else if (glyph
->type
== STRETCH_GLYPH
)
13608 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
13609 glyph
- row
->glyphs
[TEXT_AREA
],
13612 (BUFFERP (glyph
->object
)
13614 : (STRINGP (glyph
->object
)
13617 glyph
->pixel_width
,
13621 glyph
->left_box_line_p
,
13622 glyph
->right_box_line_p
);
13624 else if (glyph
->type
== IMAGE_GLYPH
)
13627 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
13628 glyph
- row
->glyphs
[TEXT_AREA
],
13631 (BUFFERP (glyph
->object
)
13633 : (STRINGP (glyph
->object
)
13636 glyph
->pixel_width
,
13640 glyph
->left_box_line_p
,
13641 glyph
->right_box_line_p
);
13646 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
13647 GLYPHS 0 means don't show glyph contents.
13648 GLYPHS 1 means show glyphs in short form
13649 GLYPHS > 1 means show glyphs in long form. */
13652 dump_glyph_row (row
, vpos
, glyphs
)
13653 struct glyph_row
*row
;
13658 fprintf (stderr
, "Row Start End Used oEI><O\\CTZFesm X Y W H V A P\n");
13659 fprintf (stderr
, "=======================================================================\n");
13661 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d%1.1d\
13662 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
13664 MATRIX_ROW_START_CHARPOS (row
),
13665 MATRIX_ROW_END_CHARPOS (row
),
13666 row
->used
[TEXT_AREA
],
13667 row
->contains_overlapping_glyphs_p
,
13669 row
->truncated_on_left_p
,
13670 row
->truncated_on_right_p
,
13671 row
->overlay_arrow_p
,
13673 MATRIX_ROW_CONTINUATION_LINE_P (row
),
13674 row
->displays_text_p
,
13677 row
->ends_in_middle_of_char_p
,
13678 row
->starts_in_middle_of_char_p
,
13684 row
->visible_height
,
13687 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
13688 row
->end
.overlay_string_index
,
13689 row
->continuation_lines_width
);
13690 fprintf (stderr
, "%9d %5d\n",
13691 CHARPOS (row
->start
.string_pos
),
13692 CHARPOS (row
->end
.string_pos
));
13693 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
13694 row
->end
.dpvec_index
);
13701 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
13703 struct glyph
*glyph
= row
->glyphs
[area
];
13704 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
13706 /* Glyph for a line end in text. */
13707 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
13710 if (glyph
< glyph_end
)
13711 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
13713 for (; glyph
< glyph_end
; ++glyph
)
13714 dump_glyph (row
, glyph
, area
);
13717 else if (glyphs
== 1)
13721 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
13723 char *s
= (char *) alloca (row
->used
[area
] + 1);
13726 for (i
= 0; i
< row
->used
[area
]; ++i
)
13728 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
13729 if (glyph
->type
== CHAR_GLYPH
13730 && glyph
->u
.ch
< 0x80
13731 && glyph
->u
.ch
>= ' ')
13732 s
[i
] = glyph
->u
.ch
;
13738 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
13744 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
13745 Sdump_glyph_matrix
, 0, 1, "p",
13746 doc
: /* Dump the current matrix of the selected window to stderr.
13747 Shows contents of glyph row structures. With non-nil
13748 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
13749 glyphs in short form, otherwise show glyphs in long form. */)
13751 Lisp_Object glyphs
;
13753 struct window
*w
= XWINDOW (selected_window
);
13754 struct buffer
*buffer
= XBUFFER (w
->buffer
);
13756 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
13757 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
13758 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
13759 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
13760 fprintf (stderr
, "=============================================\n");
13761 dump_glyph_matrix (w
->current_matrix
,
13762 NILP (glyphs
) ? 0 : XINT (glyphs
));
13767 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
13768 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
13771 struct frame
*f
= XFRAME (selected_frame
);
13772 dump_glyph_matrix (f
->current_matrix
, 1);
13777 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
13778 doc
: /* Dump glyph row ROW to stderr.
13779 GLYPH 0 means don't dump glyphs.
13780 GLYPH 1 means dump glyphs in short form.
13781 GLYPH > 1 or omitted means dump glyphs in long form. */)
13783 Lisp_Object row
, glyphs
;
13785 struct glyph_matrix
*matrix
;
13788 CHECK_NUMBER (row
);
13789 matrix
= XWINDOW (selected_window
)->current_matrix
;
13791 if (vpos
>= 0 && vpos
< matrix
->nrows
)
13792 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
13794 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
13799 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
13800 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
13801 GLYPH 0 means don't dump glyphs.
13802 GLYPH 1 means dump glyphs in short form.
13803 GLYPH > 1 or omitted means dump glyphs in long form. */)
13805 Lisp_Object row
, glyphs
;
13807 struct frame
*sf
= SELECTED_FRAME ();
13808 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
13811 CHECK_NUMBER (row
);
13813 if (vpos
>= 0 && vpos
< m
->nrows
)
13814 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
13815 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
13820 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
13821 doc
: /* Toggle tracing of redisplay.
13822 With ARG, turn tracing on if and only if ARG is positive. */)
13827 trace_redisplay_p
= !trace_redisplay_p
;
13830 arg
= Fprefix_numeric_value (arg
);
13831 trace_redisplay_p
= XINT (arg
) > 0;
13838 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
13839 doc
: /* Like `format', but print result to stderr.
13840 usage: (trace-to-stderr STRING &rest OBJECTS) */)
13845 Lisp_Object s
= Fformat (nargs
, args
);
13846 fprintf (stderr
, "%s", SDATA (s
));
13850 #endif /* GLYPH_DEBUG */
13854 /***********************************************************************
13855 Building Desired Matrix Rows
13856 ***********************************************************************/
13858 /* Return a temporary glyph row holding the glyphs of an overlay
13859 arrow. Only used for non-window-redisplay windows. */
13861 static struct glyph_row
*
13862 get_overlay_arrow_glyph_row (w
)
13865 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
13866 struct buffer
*buffer
= XBUFFER (w
->buffer
);
13867 struct buffer
*old
= current_buffer
;
13868 const unsigned char *arrow_string
= SDATA (Voverlay_arrow_string
);
13869 int arrow_len
= SCHARS (Voverlay_arrow_string
);
13870 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
13871 const unsigned char *p
;
13874 int n_glyphs_before
;
13876 set_buffer_temp (buffer
);
13877 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
13878 it
.glyph_row
->used
[TEXT_AREA
] = 0;
13879 SET_TEXT_POS (it
.position
, 0, 0);
13881 multibyte_p
= !NILP (buffer
->enable_multibyte_characters
);
13883 while (p
< arrow_end
)
13885 Lisp_Object face
, ilisp
;
13887 /* Get the next character. */
13889 it
.c
= string_char_and_length (p
, arrow_len
, &it
.len
);
13891 it
.c
= *p
, it
.len
= 1;
13894 /* Get its face. */
13895 ilisp
= make_number (p
- arrow_string
);
13896 face
= Fget_text_property (ilisp
, Qface
, Voverlay_arrow_string
);
13897 it
.face_id
= compute_char_face (f
, it
.c
, face
);
13899 /* Compute its width, get its glyphs. */
13900 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
13901 SET_TEXT_POS (it
.position
, -1, -1);
13902 PRODUCE_GLYPHS (&it
);
13904 /* If this character doesn't fit any more in the line, we have
13905 to remove some glyphs. */
13906 if (it
.current_x
> it
.last_visible_x
)
13908 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
13913 set_buffer_temp (old
);
13914 return it
.glyph_row
;
13918 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
13919 glyphs are only inserted for terminal frames since we can't really
13920 win with truncation glyphs when partially visible glyphs are
13921 involved. Which glyphs to insert is determined by
13922 produce_special_glyphs. */
13925 insert_left_trunc_glyphs (it
)
13928 struct it truncate_it
;
13929 struct glyph
*from
, *end
, *to
, *toend
;
13931 xassert (!FRAME_WINDOW_P (it
->f
));
13933 /* Get the truncation glyphs. */
13935 truncate_it
.current_x
= 0;
13936 truncate_it
.face_id
= DEFAULT_FACE_ID
;
13937 truncate_it
.glyph_row
= &scratch_glyph_row
;
13938 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
13939 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
13940 truncate_it
.object
= make_number (0);
13941 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
13943 /* Overwrite glyphs from IT with truncation glyphs. */
13944 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
13945 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
13946 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
13947 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
13952 /* There may be padding glyphs left over. Overwrite them too. */
13953 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
13955 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
13961 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
13965 /* Compute the pixel height and width of IT->glyph_row.
13967 Most of the time, ascent and height of a display line will be equal
13968 to the max_ascent and max_height values of the display iterator
13969 structure. This is not the case if
13971 1. We hit ZV without displaying anything. In this case, max_ascent
13972 and max_height will be zero.
13974 2. We have some glyphs that don't contribute to the line height.
13975 (The glyph row flag contributes_to_line_height_p is for future
13976 pixmap extensions).
13978 The first case is easily covered by using default values because in
13979 these cases, the line height does not really matter, except that it
13980 must not be zero. */
13983 compute_line_metrics (it
)
13986 struct glyph_row
*row
= it
->glyph_row
;
13989 if (FRAME_WINDOW_P (it
->f
))
13991 int i
, min_y
, max_y
;
13993 /* The line may consist of one space only, that was added to
13994 place the cursor on it. If so, the row's height hasn't been
13996 if (row
->height
== 0)
13998 if (it
->max_ascent
+ it
->max_descent
== 0)
13999 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
14000 row
->ascent
= it
->max_ascent
;
14001 row
->height
= it
->max_ascent
+ it
->max_descent
;
14002 row
->phys_ascent
= it
->max_phys_ascent
;
14003 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
14006 /* Compute the width of this line. */
14007 row
->pixel_width
= row
->x
;
14008 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
14009 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
14011 xassert (row
->pixel_width
>= 0);
14012 xassert (row
->ascent
>= 0 && row
->height
> 0);
14014 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
14015 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
14017 /* If first line's physical ascent is larger than its logical
14018 ascent, use the physical ascent, and make the row taller.
14019 This makes accented characters fully visible. */
14020 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
14021 && row
->phys_ascent
> row
->ascent
)
14023 row
->height
+= row
->phys_ascent
- row
->ascent
;
14024 row
->ascent
= row
->phys_ascent
;
14027 /* Compute how much of the line is visible. */
14028 row
->visible_height
= row
->height
;
14030 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
14031 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
14033 if (row
->y
< min_y
)
14034 row
->visible_height
-= min_y
- row
->y
;
14035 if (row
->y
+ row
->height
> max_y
)
14036 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14040 row
->pixel_width
= row
->used
[TEXT_AREA
];
14041 if (row
->continued_p
)
14042 row
->pixel_width
-= it
->continuation_pixel_width
;
14043 else if (row
->truncated_on_right_p
)
14044 row
->pixel_width
-= it
->truncation_pixel_width
;
14045 row
->ascent
= row
->phys_ascent
= 0;
14046 row
->height
= row
->phys_height
= row
->visible_height
= 1;
14049 /* Compute a hash code for this row. */
14051 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
14052 for (i
= 0; i
< row
->used
[area
]; ++i
)
14053 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
14054 + row
->glyphs
[area
][i
].u
.val
14055 + row
->glyphs
[area
][i
].face_id
14056 + row
->glyphs
[area
][i
].padding_p
14057 + (row
->glyphs
[area
][i
].type
<< 2));
14059 it
->max_ascent
= it
->max_descent
= 0;
14060 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
14064 /* Append one space to the glyph row of iterator IT if doing a
14065 window-based redisplay. DEFAULT_FACE_P non-zero means let the
14066 space have the default face, otherwise let it have the same face as
14067 IT->face_id. Value is non-zero if a space was added.
14069 This function is called to make sure that there is always one glyph
14070 at the end of a glyph row that the cursor can be set on under
14071 window-systems. (If there weren't such a glyph we would not know
14072 how wide and tall a box cursor should be displayed).
14074 At the same time this space let's a nicely handle clearing to the
14075 end of the line if the row ends in italic text. */
14078 append_space (it
, default_face_p
)
14080 int default_face_p
;
14082 if (FRAME_WINDOW_P (it
->f
))
14084 int n
= it
->glyph_row
->used
[TEXT_AREA
];
14086 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
14087 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
14089 /* Save some values that must not be changed.
14090 Must save IT->c and IT->len because otherwise
14091 ITERATOR_AT_END_P wouldn't work anymore after
14092 append_space has been called. */
14093 enum display_element_type saved_what
= it
->what
;
14094 int saved_c
= it
->c
, saved_len
= it
->len
;
14095 int saved_x
= it
->current_x
;
14096 int saved_face_id
= it
->face_id
;
14097 struct text_pos saved_pos
;
14098 Lisp_Object saved_object
;
14101 saved_object
= it
->object
;
14102 saved_pos
= it
->position
;
14104 it
->what
= IT_CHARACTER
;
14105 bzero (&it
->position
, sizeof it
->position
);
14106 it
->object
= make_number (0);
14110 if (default_face_p
)
14111 it
->face_id
= DEFAULT_FACE_ID
;
14112 else if (it
->face_before_selective_p
)
14113 it
->face_id
= it
->saved_face_id
;
14114 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
14115 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0);
14117 PRODUCE_GLYPHS (it
);
14119 it
->current_x
= saved_x
;
14120 it
->object
= saved_object
;
14121 it
->position
= saved_pos
;
14122 it
->what
= saved_what
;
14123 it
->face_id
= saved_face_id
;
14124 it
->len
= saved_len
;
14134 /* Extend the face of the last glyph in the text area of IT->glyph_row
14135 to the end of the display line. Called from display_line.
14136 If the glyph row is empty, add a space glyph to it so that we
14137 know the face to draw. Set the glyph row flag fill_line_p. */
14140 extend_face_to_end_of_line (it
)
14144 struct frame
*f
= it
->f
;
14146 /* If line is already filled, do nothing. */
14147 if (it
->current_x
>= it
->last_visible_x
)
14150 /* Face extension extends the background and box of IT->face_id
14151 to the end of the line. If the background equals the background
14152 of the frame, we don't have to do anything. */
14153 if (it
->face_before_selective_p
)
14154 face
= FACE_FROM_ID (it
->f
, it
->saved_face_id
);
14156 face
= FACE_FROM_ID (f
, it
->face_id
);
14158 if (FRAME_WINDOW_P (f
)
14159 && face
->box
== FACE_NO_BOX
14160 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
14164 /* Set the glyph row flag indicating that the face of the last glyph
14165 in the text area has to be drawn to the end of the text area. */
14166 it
->glyph_row
->fill_line_p
= 1;
14168 /* If current character of IT is not ASCII, make sure we have the
14169 ASCII face. This will be automatically undone the next time
14170 get_next_display_element returns a multibyte character. Note
14171 that the character will always be single byte in unibyte text. */
14172 if (!SINGLE_BYTE_CHAR_P (it
->c
))
14174 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0);
14177 if (FRAME_WINDOW_P (f
))
14179 /* If the row is empty, add a space with the current face of IT,
14180 so that we know which face to draw. */
14181 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
14183 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
14184 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
14185 it
->glyph_row
->used
[TEXT_AREA
] = 1;
14190 /* Save some values that must not be changed. */
14191 int saved_x
= it
->current_x
;
14192 struct text_pos saved_pos
;
14193 Lisp_Object saved_object
;
14194 enum display_element_type saved_what
= it
->what
;
14195 int saved_face_id
= it
->face_id
;
14197 saved_object
= it
->object
;
14198 saved_pos
= it
->position
;
14200 it
->what
= IT_CHARACTER
;
14201 bzero (&it
->position
, sizeof it
->position
);
14202 it
->object
= make_number (0);
14205 it
->face_id
= face
->id
;
14207 PRODUCE_GLYPHS (it
);
14209 while (it
->current_x
<= it
->last_visible_x
)
14210 PRODUCE_GLYPHS (it
);
14212 /* Don't count these blanks really. It would let us insert a left
14213 truncation glyph below and make us set the cursor on them, maybe. */
14214 it
->current_x
= saved_x
;
14215 it
->object
= saved_object
;
14216 it
->position
= saved_pos
;
14217 it
->what
= saved_what
;
14218 it
->face_id
= saved_face_id
;
14223 /* Value is non-zero if text starting at CHARPOS in current_buffer is
14224 trailing whitespace. */
14227 trailing_whitespace_p (charpos
)
14230 int bytepos
= CHAR_TO_BYTE (charpos
);
14233 while (bytepos
< ZV_BYTE
14234 && (c
= FETCH_CHAR (bytepos
),
14235 c
== ' ' || c
== '\t'))
14238 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
14240 if (bytepos
!= PT_BYTE
)
14247 /* Highlight trailing whitespace, if any, in ROW. */
14250 highlight_trailing_whitespace (f
, row
)
14252 struct glyph_row
*row
;
14254 int used
= row
->used
[TEXT_AREA
];
14258 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
14259 struct glyph
*glyph
= start
+ used
- 1;
14261 /* Skip over glyphs inserted to display the cursor at the
14262 end of a line, for extending the face of the last glyph
14263 to the end of the line on terminals, and for truncation
14264 and continuation glyphs. */
14265 while (glyph
>= start
14266 && glyph
->type
== CHAR_GLYPH
14267 && INTEGERP (glyph
->object
))
14270 /* If last glyph is a space or stretch, and it's trailing
14271 whitespace, set the face of all trailing whitespace glyphs in
14272 IT->glyph_row to `trailing-whitespace'. */
14274 && BUFFERP (glyph
->object
)
14275 && (glyph
->type
== STRETCH_GLYPH
14276 || (glyph
->type
== CHAR_GLYPH
14277 && glyph
->u
.ch
== ' '))
14278 && trailing_whitespace_p (glyph
->charpos
))
14280 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
14282 while (glyph
>= start
14283 && BUFFERP (glyph
->object
)
14284 && (glyph
->type
== STRETCH_GLYPH
14285 || (glyph
->type
== CHAR_GLYPH
14286 && glyph
->u
.ch
== ' ')))
14287 (glyph
--)->face_id
= face_id
;
14293 /* Value is non-zero if glyph row ROW in window W should be
14294 used to hold the cursor. */
14297 cursor_row_p (w
, row
)
14299 struct glyph_row
*row
;
14301 int cursor_row_p
= 1;
14303 if (PT
== MATRIX_ROW_END_CHARPOS (row
))
14305 /* If the row ends with a newline from a string, we don't want
14306 the cursor there (if the row is continued it doesn't end in a
14308 if (CHARPOS (row
->end
.string_pos
) >= 0
14309 || MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
14310 cursor_row_p
= row
->continued_p
;
14312 /* If the row ends at ZV, display the cursor at the end of that
14313 row instead of at the start of the row below. */
14314 else if (row
->ends_at_zv_p
)
14320 return cursor_row_p
;
14324 /* Construct the glyph row IT->glyph_row in the desired matrix of
14325 IT->w from text at the current position of IT. See dispextern.h
14326 for an overview of struct it. Value is non-zero if
14327 IT->glyph_row displays text, as opposed to a line displaying ZV
14334 struct glyph_row
*row
= it
->glyph_row
;
14336 /* We always start displaying at hpos zero even if hscrolled. */
14337 xassert (it
->hpos
== 0 && it
->current_x
== 0);
14339 /* We must not display in a row that's not a text row. */
14340 xassert (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
14341 < it
->w
->desired_matrix
->nrows
);
14343 /* Is IT->w showing the region? */
14344 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
14346 /* Clear the result glyph row and enable it. */
14347 prepare_desired_row (row
);
14349 row
->y
= it
->current_y
;
14350 row
->start
= it
->start
;
14351 row
->continuation_lines_width
= it
->continuation_lines_width
;
14352 row
->displays_text_p
= 1;
14353 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
14354 it
->starts_in_middle_of_char_p
= 0;
14356 /* Arrange the overlays nicely for our purposes. Usually, we call
14357 display_line on only one line at a time, in which case this
14358 can't really hurt too much, or we call it on lines which appear
14359 one after another in the buffer, in which case all calls to
14360 recenter_overlay_lists but the first will be pretty cheap. */
14361 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
14363 /* Move over display elements that are not visible because we are
14364 hscrolled. This may stop at an x-position < IT->first_visible_x
14365 if the first glyph is partially visible or if we hit a line end. */
14366 if (it
->current_x
< it
->first_visible_x
)
14367 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
14368 MOVE_TO_POS
| MOVE_TO_X
);
14370 /* Get the initial row height. This is either the height of the
14371 text hscrolled, if there is any, or zero. */
14372 row
->ascent
= it
->max_ascent
;
14373 row
->height
= it
->max_ascent
+ it
->max_descent
;
14374 row
->phys_ascent
= it
->max_phys_ascent
;
14375 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
14377 /* Loop generating characters. The loop is left with IT on the next
14378 character to display. */
14381 int n_glyphs_before
, hpos_before
, x_before
;
14383 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
14385 /* Retrieve the next thing to display. Value is zero if end of
14387 if (!get_next_display_element (it
))
14389 /* Maybe add a space at the end of this line that is used to
14390 display the cursor there under X. Set the charpos of the
14391 first glyph of blank lines not corresponding to any text
14393 if ((append_space (it
, 1) && row
->used
[TEXT_AREA
] == 1)
14394 || row
->used
[TEXT_AREA
] == 0)
14396 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
14397 row
->displays_text_p
= 0;
14399 if (!NILP (XBUFFER (it
->w
->buffer
)->indicate_empty_lines
)
14400 && (!MINI_WINDOW_P (it
->w
)
14401 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
14402 row
->indicate_empty_line_p
= 1;
14405 it
->continuation_lines_width
= 0;
14406 row
->ends_at_zv_p
= 1;
14410 /* Now, get the metrics of what we want to display. This also
14411 generates glyphs in `row' (which is IT->glyph_row). */
14412 n_glyphs_before
= row
->used
[TEXT_AREA
];
14415 /* Remember the line height so far in case the next element doesn't
14416 fit on the line. */
14417 if (!it
->truncate_lines_p
)
14419 ascent
= it
->max_ascent
;
14420 descent
= it
->max_descent
;
14421 phys_ascent
= it
->max_phys_ascent
;
14422 phys_descent
= it
->max_phys_descent
;
14425 PRODUCE_GLYPHS (it
);
14427 /* If this display element was in marginal areas, continue with
14429 if (it
->area
!= TEXT_AREA
)
14431 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
14432 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
14433 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
14434 row
->phys_height
= max (row
->phys_height
,
14435 it
->max_phys_ascent
+ it
->max_phys_descent
);
14436 set_iterator_to_next (it
, 1);
14440 /* Does the display element fit on the line? If we truncate
14441 lines, we should draw past the right edge of the window. If
14442 we don't truncate, we want to stop so that we can display the
14443 continuation glyph before the right margin. If lines are
14444 continued, there are two possible strategies for characters
14445 resulting in more than 1 glyph (e.g. tabs): Display as many
14446 glyphs as possible in this line and leave the rest for the
14447 continuation line, or display the whole element in the next
14448 line. Original redisplay did the former, so we do it also. */
14449 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
14450 hpos_before
= it
->hpos
;
14453 if (/* Not a newline. */
14455 /* Glyphs produced fit entirely in the line. */
14456 && it
->current_x
< it
->last_visible_x
)
14458 it
->hpos
+= nglyphs
;
14459 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
14460 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
14461 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
14462 row
->phys_height
= max (row
->phys_height
,
14463 it
->max_phys_ascent
+ it
->max_phys_descent
);
14464 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
14465 row
->x
= x
- it
->first_visible_x
;
14470 struct glyph
*glyph
;
14472 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
14474 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
14475 new_x
= x
+ glyph
->pixel_width
;
14477 if (/* Lines are continued. */
14478 !it
->truncate_lines_p
14479 && (/* Glyph doesn't fit on the line. */
14480 new_x
> it
->last_visible_x
14481 /* Or it fits exactly on a window system frame. */
14482 || (new_x
== it
->last_visible_x
14483 && FRAME_WINDOW_P (it
->f
))))
14485 /* End of a continued line. */
14488 || (new_x
== it
->last_visible_x
14489 && FRAME_WINDOW_P (it
->f
)))
14491 /* Current glyph is the only one on the line or
14492 fits exactly on the line. We must continue
14493 the line because we can't draw the cursor
14494 after the glyph. */
14495 row
->continued_p
= 1;
14496 it
->current_x
= new_x
;
14497 it
->continuation_lines_width
+= new_x
;
14499 if (i
== nglyphs
- 1)
14500 set_iterator_to_next (it
, 1);
14502 else if (CHAR_GLYPH_PADDING_P (*glyph
)
14503 && !FRAME_WINDOW_P (it
->f
))
14505 /* A padding glyph that doesn't fit on this line.
14506 This means the whole character doesn't fit
14508 row
->used
[TEXT_AREA
] = n_glyphs_before
;
14510 /* Fill the rest of the row with continuation
14511 glyphs like in 20.x. */
14512 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
14513 < row
->glyphs
[1 + TEXT_AREA
])
14514 produce_special_glyphs (it
, IT_CONTINUATION
);
14516 row
->continued_p
= 1;
14517 it
->current_x
= x_before
;
14518 it
->continuation_lines_width
+= x_before
;
14520 /* Restore the height to what it was before the
14521 element not fitting on the line. */
14522 it
->max_ascent
= ascent
;
14523 it
->max_descent
= descent
;
14524 it
->max_phys_ascent
= phys_ascent
;
14525 it
->max_phys_descent
= phys_descent
;
14527 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
14529 /* A TAB that extends past the right edge of the
14530 window. This produces a single glyph on
14531 window system frames. We leave the glyph in
14532 this row and let it fill the row, but don't
14533 consume the TAB. */
14534 it
->continuation_lines_width
+= it
->last_visible_x
;
14535 row
->ends_in_middle_of_char_p
= 1;
14536 row
->continued_p
= 1;
14537 glyph
->pixel_width
= it
->last_visible_x
- x
;
14538 it
->starts_in_middle_of_char_p
= 1;
14542 /* Something other than a TAB that draws past
14543 the right edge of the window. Restore
14544 positions to values before the element. */
14545 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
14547 /* Display continuation glyphs. */
14548 if (!FRAME_WINDOW_P (it
->f
))
14549 produce_special_glyphs (it
, IT_CONTINUATION
);
14550 row
->continued_p
= 1;
14552 it
->continuation_lines_width
+= x
;
14554 if (nglyphs
> 1 && i
> 0)
14556 row
->ends_in_middle_of_char_p
= 1;
14557 it
->starts_in_middle_of_char_p
= 1;
14560 /* Restore the height to what it was before the
14561 element not fitting on the line. */
14562 it
->max_ascent
= ascent
;
14563 it
->max_descent
= descent
;
14564 it
->max_phys_ascent
= phys_ascent
;
14565 it
->max_phys_descent
= phys_descent
;
14570 else if (new_x
> it
->first_visible_x
)
14572 /* Increment number of glyphs actually displayed. */
14575 if (x
< it
->first_visible_x
)
14576 /* Glyph is partially visible, i.e. row starts at
14577 negative X position. */
14578 row
->x
= x
- it
->first_visible_x
;
14582 /* Glyph is completely off the left margin of the
14583 window. This should not happen because of the
14584 move_it_in_display_line at the start of this
14585 function, unless the text display area of the
14586 window is empty. */
14587 xassert (it
->first_visible_x
<= it
->last_visible_x
);
14591 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
14592 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
14593 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
14594 row
->phys_height
= max (row
->phys_height
,
14595 it
->max_phys_ascent
+ it
->max_phys_descent
);
14597 /* End of this display line if row is continued. */
14598 if (row
->continued_p
)
14602 /* Is this a line end? If yes, we're also done, after making
14603 sure that a non-default face is extended up to the right
14604 margin of the window. */
14605 if (ITERATOR_AT_END_OF_LINE_P (it
))
14607 int used_before
= row
->used
[TEXT_AREA
];
14609 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
14611 /* Add a space at the end of the line that is used to
14612 display the cursor there. */
14613 append_space (it
, 0);
14615 /* Extend the face to the end of the line. */
14616 extend_face_to_end_of_line (it
);
14618 /* Make sure we have the position. */
14619 if (used_before
== 0)
14620 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
14622 /* Consume the line end. This skips over invisible lines. */
14623 set_iterator_to_next (it
, 1);
14624 it
->continuation_lines_width
= 0;
14628 /* Proceed with next display element. Note that this skips
14629 over lines invisible because of selective display. */
14630 set_iterator_to_next (it
, 1);
14632 /* If we truncate lines, we are done when the last displayed
14633 glyphs reach past the right margin of the window. */
14634 if (it
->truncate_lines_p
14635 && (FRAME_WINDOW_P (it
->f
)
14636 ? (it
->current_x
>= it
->last_visible_x
)
14637 : (it
->current_x
> it
->last_visible_x
)))
14639 /* Maybe add truncation glyphs. */
14640 if (!FRAME_WINDOW_P (it
->f
))
14644 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
14645 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
14648 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
14650 row
->used
[TEXT_AREA
] = i
;
14651 produce_special_glyphs (it
, IT_TRUNCATION
);
14655 row
->truncated_on_right_p
= 1;
14656 it
->continuation_lines_width
= 0;
14657 reseat_at_next_visible_line_start (it
, 0);
14658 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
14659 it
->hpos
= hpos_before
;
14660 it
->current_x
= x_before
;
14665 /* If line is not empty and hscrolled, maybe insert truncation glyphs
14666 at the left window margin. */
14667 if (it
->first_visible_x
14668 && IT_CHARPOS (*it
) != MATRIX_ROW_START_CHARPOS (row
))
14670 if (!FRAME_WINDOW_P (it
->f
))
14671 insert_left_trunc_glyphs (it
);
14672 row
->truncated_on_left_p
= 1;
14675 /* If the start of this line is the overlay arrow-position, then
14676 mark this glyph row as the one containing the overlay arrow.
14677 This is clearly a mess with variable size fonts. It would be
14678 better to let it be displayed like cursors under X. */
14679 if (MARKERP (Voverlay_arrow_position
)
14680 && current_buffer
== XMARKER (Voverlay_arrow_position
)->buffer
14681 && (MATRIX_ROW_START_CHARPOS (row
)
14682 == marker_position (Voverlay_arrow_position
))
14683 && STRINGP (Voverlay_arrow_string
)
14684 && ! overlay_arrow_seen
)
14686 /* Overlay arrow in window redisplay is a fringe bitmap. */
14687 if (!FRAME_WINDOW_P (it
->f
))
14689 struct glyph_row
*arrow_row
= get_overlay_arrow_glyph_row (it
->w
);
14690 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
14691 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
14692 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
14693 struct glyph
*p2
, *end
;
14695 /* Copy the arrow glyphs. */
14696 while (glyph
< arrow_end
)
14699 /* Throw away padding glyphs. */
14701 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
14702 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
14708 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
14712 overlay_arrow_seen
= 1;
14713 row
->overlay_arrow_p
= 1;
14716 /* Compute pixel dimensions of this line. */
14717 compute_line_metrics (it
);
14719 /* Remember the position at which this line ends. */
14720 row
->end
= it
->current
;
14722 /* Maybe set the cursor. */
14723 if (it
->w
->cursor
.vpos
< 0
14724 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
14725 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
14726 && cursor_row_p (it
->w
, row
))
14727 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
14729 /* Highlight trailing whitespace. */
14730 if (!NILP (Vshow_trailing_whitespace
))
14731 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
14733 /* Prepare for the next line. This line starts horizontally at (X
14734 HPOS) = (0 0). Vertical positions are incremented. As a
14735 convenience for the caller, IT->glyph_row is set to the next
14737 it
->current_x
= it
->hpos
= 0;
14738 it
->current_y
+= row
->height
;
14741 it
->start
= it
->current
;
14742 return row
->displays_text_p
;
14747 /***********************************************************************
14749 ***********************************************************************/
14751 /* Redisplay the menu bar in the frame for window W.
14753 The menu bar of X frames that don't have X toolkit support is
14754 displayed in a special window W->frame->menu_bar_window.
14756 The menu bar of terminal frames is treated specially as far as
14757 glyph matrices are concerned. Menu bar lines are not part of
14758 windows, so the update is done directly on the frame matrix rows
14759 for the menu bar. */
14762 display_menu_bar (w
)
14765 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
14770 /* Don't do all this for graphical frames. */
14772 if (!NILP (Vwindow_system
))
14775 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
14780 if (FRAME_MAC_P (f
))
14784 #ifdef USE_X_TOOLKIT
14785 xassert (!FRAME_WINDOW_P (f
));
14786 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
14787 it
.first_visible_x
= 0;
14788 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
14789 #else /* not USE_X_TOOLKIT */
14790 if (FRAME_WINDOW_P (f
))
14792 /* Menu bar lines are displayed in the desired matrix of the
14793 dummy window menu_bar_window. */
14794 struct window
*menu_w
;
14795 xassert (WINDOWP (f
->menu_bar_window
));
14796 menu_w
= XWINDOW (f
->menu_bar_window
);
14797 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
14799 it
.first_visible_x
= 0;
14800 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
14804 /* This is a TTY frame, i.e. character hpos/vpos are used as
14806 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
14808 it
.first_visible_x
= 0;
14809 it
.last_visible_x
= FRAME_COLS (f
);
14811 #endif /* not USE_X_TOOLKIT */
14813 if (! mode_line_inverse_video
)
14814 /* Force the menu-bar to be displayed in the default face. */
14815 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
14817 /* Clear all rows of the menu bar. */
14818 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
14820 struct glyph_row
*row
= it
.glyph_row
+ i
;
14821 clear_glyph_row (row
);
14822 row
->enabled_p
= 1;
14823 row
->full_width_p
= 1;
14826 /* Display all items of the menu bar. */
14827 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
14828 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
14830 Lisp_Object string
;
14832 /* Stop at nil string. */
14833 string
= AREF (items
, i
+ 1);
14837 /* Remember where item was displayed. */
14838 AREF (items
, i
+ 3) = make_number (it
.hpos
);
14840 /* Display the item, pad with one space. */
14841 if (it
.current_x
< it
.last_visible_x
)
14842 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
14843 SCHARS (string
) + 1, 0, 0, -1);
14846 /* Fill out the line with spaces. */
14847 if (it
.current_x
< it
.last_visible_x
)
14848 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
14850 /* Compute the total height of the lines. */
14851 compute_line_metrics (&it
);
14856 /***********************************************************************
14858 ***********************************************************************/
14860 /* Redisplay mode lines in the window tree whose root is WINDOW. If
14861 FORCE is non-zero, redisplay mode lines unconditionally.
14862 Otherwise, redisplay only mode lines that are garbaged. Value is
14863 the number of windows whose mode lines were redisplayed. */
14866 redisplay_mode_lines (window
, force
)
14867 Lisp_Object window
;
14872 while (!NILP (window
))
14874 struct window
*w
= XWINDOW (window
);
14876 if (WINDOWP (w
->hchild
))
14877 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
14878 else if (WINDOWP (w
->vchild
))
14879 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
14881 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
14882 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
14884 struct text_pos lpoint
;
14885 struct buffer
*old
= current_buffer
;
14887 /* Set the window's buffer for the mode line display. */
14888 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
14889 set_buffer_internal_1 (XBUFFER (w
->buffer
));
14891 /* Point refers normally to the selected window. For any
14892 other window, set up appropriate value. */
14893 if (!EQ (window
, selected_window
))
14895 struct text_pos pt
;
14897 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
14898 if (CHARPOS (pt
) < BEGV
)
14899 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
14900 else if (CHARPOS (pt
) > (ZV
- 1))
14901 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
14903 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
14906 /* Display mode lines. */
14907 clear_glyph_matrix (w
->desired_matrix
);
14908 if (display_mode_lines (w
))
14911 w
->must_be_updated_p
= 1;
14914 /* Restore old settings. */
14915 set_buffer_internal_1 (old
);
14916 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
14926 /* Display the mode and/or top line of window W. Value is the number
14927 of mode lines displayed. */
14930 display_mode_lines (w
)
14933 Lisp_Object old_selected_window
, old_selected_frame
;
14936 old_selected_frame
= selected_frame
;
14937 selected_frame
= w
->frame
;
14938 old_selected_window
= selected_window
;
14939 XSETWINDOW (selected_window
, w
);
14941 /* These will be set while the mode line specs are processed. */
14942 line_number_displayed
= 0;
14943 w
->column_number_displayed
= Qnil
;
14945 if (WINDOW_WANTS_MODELINE_P (w
))
14947 struct window
*sel_w
= XWINDOW (old_selected_window
);
14949 /* Select mode line face based on the real selected window. */
14950 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
14951 current_buffer
->mode_line_format
);
14955 if (WINDOW_WANTS_HEADER_LINE_P (w
))
14957 display_mode_line (w
, HEADER_LINE_FACE_ID
,
14958 current_buffer
->header_line_format
);
14962 selected_frame
= old_selected_frame
;
14963 selected_window
= old_selected_window
;
14968 /* Display mode or top line of window W. FACE_ID specifies which line
14969 to display; it is either MODE_LINE_FACE_ID or HEADER_LINE_FACE_ID.
14970 FORMAT is the mode line format to display. Value is the pixel
14971 height of the mode line displayed. */
14974 display_mode_line (w
, face_id
, format
)
14976 enum face_id face_id
;
14977 Lisp_Object format
;
14982 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
14983 prepare_desired_row (it
.glyph_row
);
14985 if (! mode_line_inverse_video
)
14986 /* Force the mode-line to be displayed in the default face. */
14987 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
14989 /* Temporarily make frame's keyboard the current kboard so that
14990 kboard-local variables in the mode_line_format will get the right
14992 push_frame_kboard (it
.f
);
14993 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
14994 pop_frame_kboard ();
14996 /* Fill up with spaces. */
14997 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
14999 compute_line_metrics (&it
);
15000 it
.glyph_row
->full_width_p
= 1;
15001 it
.glyph_row
->mode_line_p
= 1;
15002 it
.glyph_row
->continued_p
= 0;
15003 it
.glyph_row
->truncated_on_left_p
= 0;
15004 it
.glyph_row
->truncated_on_right_p
= 0;
15006 /* Make a 3D mode-line have a shadow at its right end. */
15007 face
= FACE_FROM_ID (it
.f
, face_id
);
15008 extend_face_to_end_of_line (&it
);
15009 if (face
->box
!= FACE_NO_BOX
)
15011 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
15012 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
15013 last
->right_box_line_p
= 1;
15016 return it
.glyph_row
->height
;
15019 /* Alist that caches the results of :propertize.
15020 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
15021 Lisp_Object mode_line_proptrans_alist
;
15023 /* List of strings making up the mode-line. */
15024 Lisp_Object mode_line_string_list
;
15026 /* Base face property when building propertized mode line string. */
15027 static Lisp_Object mode_line_string_face
;
15028 static Lisp_Object mode_line_string_face_prop
;
15031 /* Contribute ELT to the mode line for window IT->w. How it
15032 translates into text depends on its data type.
15034 IT describes the display environment in which we display, as usual.
15036 DEPTH is the depth in recursion. It is used to prevent
15037 infinite recursion here.
15039 FIELD_WIDTH is the number of characters the display of ELT should
15040 occupy in the mode line, and PRECISION is the maximum number of
15041 characters to display from ELT's representation. See
15042 display_string for details.
15044 Returns the hpos of the end of the text generated by ELT.
15046 PROPS is a property list to add to any string we encounter.
15048 If RISKY is nonzero, remove (disregard) any properties in any string
15049 we encounter, and ignore :eval and :propertize.
15051 If the global variable `frame_title_ptr' is non-NULL, then the output
15052 is passed to `store_frame_title' instead of `display_string'. */
15055 display_mode_element (it
, depth
, field_width
, precision
, elt
, props
, risky
)
15058 int field_width
, precision
;
15059 Lisp_Object elt
, props
;
15062 int n
= 0, field
, prec
;
15067 elt
= build_string ("*too-deep*");
15071 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
15075 /* A string: output it and check for %-constructs within it. */
15077 const unsigned char *this, *lisp_string
;
15079 if (!NILP (props
) || risky
)
15081 Lisp_Object oprops
, aelt
;
15082 oprops
= Ftext_properties_at (make_number (0), elt
);
15084 if (NILP (Fequal (props
, oprops
)) || risky
)
15086 /* If the starting string has properties,
15087 merge the specified ones onto the existing ones. */
15088 if (! NILP (oprops
) && !risky
)
15092 oprops
= Fcopy_sequence (oprops
);
15094 while (CONSP (tem
))
15096 oprops
= Fplist_put (oprops
, XCAR (tem
),
15097 XCAR (XCDR (tem
)));
15098 tem
= XCDR (XCDR (tem
));
15103 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
15104 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
15106 mode_line_proptrans_alist
15107 = Fcons (aelt
, Fdelq (aelt
, mode_line_proptrans_alist
));
15114 elt
= Fcopy_sequence (elt
);
15115 Fset_text_properties (make_number (0), Flength (elt
),
15117 /* Add this item to mode_line_proptrans_alist. */
15118 mode_line_proptrans_alist
15119 = Fcons (Fcons (elt
, props
),
15120 mode_line_proptrans_alist
);
15121 /* Truncate mode_line_proptrans_alist
15122 to at most 50 elements. */
15123 tem
= Fnthcdr (make_number (50),
15124 mode_line_proptrans_alist
);
15126 XSETCDR (tem
, Qnil
);
15131 this = SDATA (elt
);
15132 lisp_string
= this;
15136 prec
= precision
- n
;
15137 if (frame_title_ptr
)
15138 n
+= store_frame_title (SDATA (elt
), -1, prec
);
15139 else if (!NILP (mode_line_string_list
))
15140 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
15142 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
15143 0, prec
, 0, STRING_MULTIBYTE (elt
));
15148 while ((precision
<= 0 || n
< precision
)
15150 && (frame_title_ptr
15151 || !NILP (mode_line_string_list
)
15152 || it
->current_x
< it
->last_visible_x
))
15154 const unsigned char *last
= this;
15156 /* Advance to end of string or next format specifier. */
15157 while ((c
= *this++) != '\0' && c
!= '%')
15160 if (this - 1 != last
)
15162 /* Output to end of string or up to '%'. Field width
15163 is length of string. Don't output more than
15164 PRECISION allows us. */
15167 prec
= chars_in_text (last
, this - last
);
15168 if (precision
> 0 && prec
> precision
- n
)
15169 prec
= precision
- n
;
15171 if (frame_title_ptr
)
15172 n
+= store_frame_title (last
, 0, prec
);
15173 else if (!NILP (mode_line_string_list
))
15175 int bytepos
= last
- lisp_string
;
15176 int charpos
= string_byte_to_char (elt
, bytepos
);
15177 n
+= store_mode_line_string (NULL
,
15178 Fsubstring (elt
, make_number (charpos
),
15179 make_number (charpos
+ prec
)),
15184 int bytepos
= last
- lisp_string
;
15185 int charpos
= string_byte_to_char (elt
, bytepos
);
15186 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
15188 STRING_MULTIBYTE (elt
));
15191 else /* c == '%' */
15193 const unsigned char *percent_position
= this;
15195 /* Get the specified minimum width. Zero means
15198 while ((c
= *this++) >= '0' && c
<= '9')
15199 field
= field
* 10 + c
- '0';
15201 /* Don't pad beyond the total padding allowed. */
15202 if (field_width
- n
> 0 && field
> field_width
- n
)
15203 field
= field_width
- n
;
15205 /* Note that either PRECISION <= 0 or N < PRECISION. */
15206 prec
= precision
- n
;
15209 n
+= display_mode_element (it
, depth
, field
, prec
,
15210 Vglobal_mode_string
, props
,
15215 int bytepos
, charpos
;
15216 unsigned char *spec
;
15218 bytepos
= percent_position
- lisp_string
;
15219 charpos
= (STRING_MULTIBYTE (elt
)
15220 ? string_byte_to_char (elt
, bytepos
)
15224 = decode_mode_spec (it
->w
, c
, field
, prec
, &multibyte
);
15226 if (frame_title_ptr
)
15227 n
+= store_frame_title (spec
, field
, prec
);
15228 else if (!NILP (mode_line_string_list
))
15230 int len
= strlen (spec
);
15231 Lisp_Object tem
= make_string (spec
, len
);
15232 props
= Ftext_properties_at (make_number (charpos
), elt
);
15233 /* Should only keep face property in props */
15234 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
15238 int nglyphs_before
, nwritten
;
15240 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
15241 nwritten
= display_string (spec
, Qnil
, elt
,
15246 /* Assign to the glyphs written above the
15247 string where the `%x' came from, position
15251 struct glyph
*glyph
15252 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
15256 for (i
= 0; i
< nwritten
; ++i
)
15258 glyph
[i
].object
= elt
;
15259 glyph
[i
].charpos
= charpos
;
15274 /* A symbol: process the value of the symbol recursively
15275 as if it appeared here directly. Avoid error if symbol void.
15276 Special case: if value of symbol is a string, output the string
15279 register Lisp_Object tem
;
15281 /* If the variable is not marked as risky to set
15282 then its contents are risky to use. */
15283 if (NILP (Fget (elt
, Qrisky_local_variable
)))
15286 tem
= Fboundp (elt
);
15289 tem
= Fsymbol_value (elt
);
15290 /* If value is a string, output that string literally:
15291 don't check for % within it. */
15295 if (!EQ (tem
, elt
))
15297 /* Give up right away for nil or t. */
15307 register Lisp_Object car
, tem
;
15309 /* A cons cell: five distinct cases.
15310 If first element is :eval or :propertize, do something special.
15311 If first element is a string or a cons, process all the elements
15312 and effectively concatenate them.
15313 If first element is a negative number, truncate displaying cdr to
15314 at most that many characters. If positive, pad (with spaces)
15315 to at least that many characters.
15316 If first element is a symbol, process the cadr or caddr recursively
15317 according to whether the symbol's value is non-nil or nil. */
15319 if (EQ (car
, QCeval
))
15321 /* An element of the form (:eval FORM) means evaluate FORM
15322 and use the result as mode line elements. */
15327 if (CONSP (XCDR (elt
)))
15330 spec
= safe_eval (XCAR (XCDR (elt
)));
15331 n
+= display_mode_element (it
, depth
, field_width
- n
,
15332 precision
- n
, spec
, props
,
15336 else if (EQ (car
, QCpropertize
))
15338 /* An element of the form (:propertize ELT PROPS...)
15339 means display ELT but applying properties PROPS. */
15344 if (CONSP (XCDR (elt
)))
15345 n
+= display_mode_element (it
, depth
, field_width
- n
,
15346 precision
- n
, XCAR (XCDR (elt
)),
15347 XCDR (XCDR (elt
)), risky
);
15349 else if (SYMBOLP (car
))
15351 tem
= Fboundp (car
);
15355 /* elt is now the cdr, and we know it is a cons cell.
15356 Use its car if CAR has a non-nil value. */
15359 tem
= Fsymbol_value (car
);
15366 /* Symbol's value is nil (or symbol is unbound)
15367 Get the cddr of the original list
15368 and if possible find the caddr and use that. */
15372 else if (!CONSP (elt
))
15377 else if (INTEGERP (car
))
15379 register int lim
= XINT (car
);
15383 /* Negative int means reduce maximum width. */
15384 if (precision
<= 0)
15387 precision
= min (precision
, -lim
);
15391 /* Padding specified. Don't let it be more than
15392 current maximum. */
15394 lim
= min (precision
, lim
);
15396 /* If that's more padding than already wanted, queue it.
15397 But don't reduce padding already specified even if
15398 that is beyond the current truncation point. */
15399 field_width
= max (lim
, field_width
);
15403 else if (STRINGP (car
) || CONSP (car
))
15405 register int limit
= 50;
15406 /* Limit is to protect against circular lists. */
15409 && (precision
<= 0 || n
< precision
))
15411 n
+= display_mode_element (it
, depth
, field_width
- n
,
15412 precision
- n
, XCAR (elt
),
15422 elt
= build_string ("*invalid*");
15426 /* Pad to FIELD_WIDTH. */
15427 if (field_width
> 0 && n
< field_width
)
15429 if (frame_title_ptr
)
15430 n
+= store_frame_title ("", field_width
- n
, 0);
15431 else if (!NILP (mode_line_string_list
))
15432 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
15434 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
15441 /* Store a mode-line string element in mode_line_string_list.
15443 If STRING is non-null, display that C string. Otherwise, the Lisp
15444 string LISP_STRING is displayed.
15446 FIELD_WIDTH is the minimum number of output glyphs to produce.
15447 If STRING has fewer characters than FIELD_WIDTH, pad to the right
15448 with spaces. FIELD_WIDTH <= 0 means don't pad.
15450 PRECISION is the maximum number of characters to output from
15451 STRING. PRECISION <= 0 means don't truncate the string.
15453 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
15454 properties to the string.
15456 PROPS are the properties to add to the string.
15457 The mode_line_string_face face property is always added to the string.
15460 static int store_mode_line_string (string
, lisp_string
, copy_string
, field_width
, precision
, props
)
15462 Lisp_Object lisp_string
;
15471 if (string
!= NULL
)
15473 len
= strlen (string
);
15474 if (precision
> 0 && len
> precision
)
15476 lisp_string
= make_string (string
, len
);
15478 props
= mode_line_string_face_prop
;
15479 else if (!NILP (mode_line_string_face
))
15481 Lisp_Object face
= Fplist_get (props
, Qface
);
15482 props
= Fcopy_sequence (props
);
15484 face
= mode_line_string_face
;
15486 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
15487 props
= Fplist_put (props
, Qface
, face
);
15489 Fadd_text_properties (make_number (0), make_number (len
),
15490 props
, lisp_string
);
15494 len
= XFASTINT (Flength (lisp_string
));
15495 if (precision
> 0 && len
> precision
)
15498 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
15501 if (!NILP (mode_line_string_face
))
15505 props
= Ftext_properties_at (make_number (0), lisp_string
);
15506 face
= Fplist_get (props
, Qface
);
15508 face
= mode_line_string_face
;
15510 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
15511 props
= Fcons (Qface
, Fcons (face
, Qnil
));
15513 lisp_string
= Fcopy_sequence (lisp_string
);
15516 Fadd_text_properties (make_number (0), make_number (len
),
15517 props
, lisp_string
);
15522 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
15526 if (field_width
> len
)
15528 field_width
-= len
;
15529 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
15531 Fadd_text_properties (make_number (0), make_number (field_width
),
15532 props
, lisp_string
);
15533 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
15541 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
15543 doc
: /* Return the mode-line of selected window as a string.
15544 First optional arg FORMAT specifies a different format string (see
15545 `mode-line-format' for details) to use. If FORMAT is t, return
15546 the buffer's header-line. Second optional arg WINDOW specifies a
15547 different window to use as the context for the formatting.
15548 If third optional arg NO-PROPS is non-nil, string is not propertized. */)
15549 (format
, window
, no_props
)
15550 Lisp_Object format
, window
, no_props
;
15555 struct buffer
*old_buffer
= NULL
;
15556 enum face_id face_id
= DEFAULT_FACE_ID
;
15559 window
= selected_window
;
15560 CHECK_WINDOW (window
);
15561 w
= XWINDOW (window
);
15562 CHECK_BUFFER (w
->buffer
);
15564 if (XBUFFER (w
->buffer
) != current_buffer
)
15566 old_buffer
= current_buffer
;
15567 set_buffer_internal_1 (XBUFFER (w
->buffer
));
15570 if (NILP (format
) || EQ (format
, Qt
))
15572 face_id
= NILP (format
)
15573 ? CURRENT_MODE_LINE_FACE_ID (w
) :
15574 HEADER_LINE_FACE_ID
;
15575 format
= NILP (format
)
15576 ? current_buffer
->mode_line_format
15577 : current_buffer
->header_line_format
;
15580 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
15582 if (NILP (no_props
))
15584 mode_line_string_face
=
15585 (face_id
== MODE_LINE_FACE_ID
? Qmode_line
:
15586 face_id
== MODE_LINE_INACTIVE_FACE_ID
? Qmode_line_inactive
:
15587 face_id
== HEADER_LINE_FACE_ID
? Qheader_line
: Qnil
);
15589 mode_line_string_face_prop
=
15590 NILP (mode_line_string_face
) ? Qnil
:
15591 Fcons (Qface
, Fcons (mode_line_string_face
, Qnil
));
15593 /* We need a dummy last element in mode_line_string_list to
15594 indicate we are building the propertized mode-line string.
15595 Using mode_line_string_face_prop here GC protects it. */
15596 mode_line_string_list
=
15597 Fcons (mode_line_string_face_prop
, Qnil
);
15598 frame_title_ptr
= NULL
;
15602 mode_line_string_face_prop
= Qnil
;
15603 mode_line_string_list
= Qnil
;
15604 frame_title_ptr
= frame_title_buf
;
15607 push_frame_kboard (it
.f
);
15608 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
15609 pop_frame_kboard ();
15612 set_buffer_internal_1 (old_buffer
);
15614 if (NILP (no_props
))
15617 mode_line_string_list
= Fnreverse (mode_line_string_list
);
15618 str
= Fmapconcat (intern ("identity"), XCDR (mode_line_string_list
),
15619 make_string ("", 0));
15620 mode_line_string_face_prop
= Qnil
;
15621 mode_line_string_list
= Qnil
;
15625 len
= frame_title_ptr
- frame_title_buf
;
15626 if (len
> 0 && frame_title_ptr
[-1] == '-')
15628 /* Mode lines typically ends with numerous dashes; reduce to two dashes. */
15629 while (frame_title_ptr
> frame_title_buf
&& *--frame_title_ptr
== '-')
15631 frame_title_ptr
+= 3; /* restore last non-dash + two dashes */
15632 if (len
> frame_title_ptr
- frame_title_buf
)
15633 len
= frame_title_ptr
- frame_title_buf
;
15636 frame_title_ptr
= NULL
;
15637 return make_string (frame_title_buf
, len
);
15640 /* Write a null-terminated, right justified decimal representation of
15641 the positive integer D to BUF using a minimal field width WIDTH. */
15644 pint2str (buf
, width
, d
)
15645 register char *buf
;
15646 register int width
;
15649 register char *p
= buf
;
15657 *p
++ = d
% 10 + '0';
15662 for (width
-= (int) (p
- buf
); width
> 0; --width
)
15673 /* Write a null-terminated, right justified decimal and "human
15674 readable" representation of the nonnegative integer D to BUF using
15675 a minimal field width WIDTH. D should be smaller than 999.5e24. */
15677 static const char power_letter
[] =
15691 pint2hrstr (buf
, width
, d
)
15696 /* We aim to represent the nonnegative integer D as
15697 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
15700 /* -1 means: do not use TENTHS. */
15704 /* Length of QUOTIENT.TENTHS as a string. */
15710 if (1000 <= quotient
)
15712 /* Scale to the appropriate EXPONENT. */
15715 remainder
= quotient
% 1000;
15719 while (1000 <= quotient
);
15721 /* Round to nearest and decide whether to use TENTHS or not. */
15724 tenths
= remainder
/ 100;
15725 if (50 <= remainder
% 100)
15731 if (quotient
== 10)
15738 if (500 <= remainder
)
15739 if (quotient
< 999)
15749 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
15750 if (tenths
== -1 && quotient
<= 99)
15757 p
= psuffix
= buf
+ max (width
, length
);
15759 /* Print EXPONENT. */
15761 *psuffix
++ = power_letter
[exponent
];
15764 /* Print TENTHS. */
15767 *--p
= '0' + tenths
;
15771 /* Print QUOTIENT. */
15774 int digit
= quotient
% 10;
15775 *--p
= '0' + digit
;
15777 while ((quotient
/= 10) != 0);
15779 /* Print leading spaces. */
15784 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
15785 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
15786 type of CODING_SYSTEM. Return updated pointer into BUF. */
15788 static unsigned char invalid_eol_type
[] = "(*invalid*)";
15791 decode_mode_spec_coding (coding_system
, buf
, eol_flag
)
15792 Lisp_Object coding_system
;
15793 register char *buf
;
15797 int multibyte
= !NILP (current_buffer
->enable_multibyte_characters
);
15798 const unsigned char *eol_str
;
15800 /* The EOL conversion we are using. */
15801 Lisp_Object eoltype
;
15803 val
= Fget (coding_system
, Qcoding_system
);
15806 if (!VECTORP (val
)) /* Not yet decided. */
15811 eoltype
= eol_mnemonic_undecided
;
15812 /* Don't mention EOL conversion if it isn't decided. */
15816 Lisp_Object eolvalue
;
15818 eolvalue
= Fget (coding_system
, Qeol_type
);
15821 *buf
++ = XFASTINT (AREF (val
, 1));
15825 /* The EOL conversion that is normal on this system. */
15827 if (NILP (eolvalue
)) /* Not yet decided. */
15828 eoltype
= eol_mnemonic_undecided
;
15829 else if (VECTORP (eolvalue
)) /* Not yet decided. */
15830 eoltype
= eol_mnemonic_undecided
;
15831 else /* INTEGERP (eolvalue) -- 0:LF, 1:CRLF, 2:CR */
15832 eoltype
= (XFASTINT (eolvalue
) == 0
15833 ? eol_mnemonic_unix
15834 : (XFASTINT (eolvalue
) == 1
15835 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
15841 /* Mention the EOL conversion if it is not the usual one. */
15842 if (STRINGP (eoltype
))
15844 eol_str
= SDATA (eoltype
);
15845 eol_str_len
= SBYTES (eoltype
);
15847 else if (INTEGERP (eoltype
)
15848 && CHAR_VALID_P (XINT (eoltype
), 0))
15850 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
15851 eol_str_len
= CHAR_STRING (XINT (eoltype
), tmp
);
15856 eol_str
= invalid_eol_type
;
15857 eol_str_len
= sizeof (invalid_eol_type
) - 1;
15859 bcopy (eol_str
, buf
, eol_str_len
);
15860 buf
+= eol_str_len
;
15866 /* Return a string for the output of a mode line %-spec for window W,
15867 generated by character C. PRECISION >= 0 means don't return a
15868 string longer than that value. FIELD_WIDTH > 0 means pad the
15869 string returned with spaces to that value. Return 1 in *MULTIBYTE
15870 if the result is multibyte text. */
15872 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
15875 decode_mode_spec (w
, c
, field_width
, precision
, multibyte
)
15878 int field_width
, precision
;
15882 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
15883 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
15884 struct buffer
*b
= XBUFFER (w
->buffer
);
15892 if (!NILP (b
->read_only
))
15894 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
15899 /* This differs from %* only for a modified read-only buffer. */
15900 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
15902 if (!NILP (b
->read_only
))
15907 /* This differs from %* in ignoring read-only-ness. */
15908 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
15920 if (command_loop_level
> 5)
15922 p
= decode_mode_spec_buf
;
15923 for (i
= 0; i
< command_loop_level
; i
++)
15926 return decode_mode_spec_buf
;
15934 if (command_loop_level
> 5)
15936 p
= decode_mode_spec_buf
;
15937 for (i
= 0; i
< command_loop_level
; i
++)
15940 return decode_mode_spec_buf
;
15947 /* Let lots_of_dashes be a string of infinite length. */
15948 if (!NILP (mode_line_string_list
))
15950 if (field_width
<= 0
15951 || field_width
> sizeof (lots_of_dashes
))
15953 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
15954 decode_mode_spec_buf
[i
] = '-';
15955 decode_mode_spec_buf
[i
] = '\0';
15956 return decode_mode_spec_buf
;
15959 return lots_of_dashes
;
15968 int col
= (int) current_column (); /* iftc */
15969 w
->column_number_displayed
= make_number (col
);
15970 pint2str (decode_mode_spec_buf
, field_width
, col
);
15971 return decode_mode_spec_buf
;
15975 /* %F displays the frame name. */
15976 if (!NILP (f
->title
))
15977 return (char *) SDATA (f
->title
);
15978 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
15979 return (char *) SDATA (f
->name
);
15988 int size
= ZV
- BEGV
;
15989 pint2str (decode_mode_spec_buf
, field_width
, size
);
15990 return decode_mode_spec_buf
;
15995 int size
= ZV
- BEGV
;
15996 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
15997 return decode_mode_spec_buf
;
16002 int startpos
= XMARKER (w
->start
)->charpos
;
16003 int startpos_byte
= marker_byte_position (w
->start
);
16004 int line
, linepos
, linepos_byte
, topline
;
16006 int height
= WINDOW_TOTAL_LINES (w
);
16008 /* If we decided that this buffer isn't suitable for line numbers,
16009 don't forget that too fast. */
16010 if (EQ (w
->base_line_pos
, w
->buffer
))
16012 /* But do forget it, if the window shows a different buffer now. */
16013 else if (BUFFERP (w
->base_line_pos
))
16014 w
->base_line_pos
= Qnil
;
16016 /* If the buffer is very big, don't waste time. */
16017 if (INTEGERP (Vline_number_display_limit
)
16018 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
16020 w
->base_line_pos
= Qnil
;
16021 w
->base_line_number
= Qnil
;
16025 if (!NILP (w
->base_line_number
)
16026 && !NILP (w
->base_line_pos
)
16027 && XFASTINT (w
->base_line_pos
) <= startpos
)
16029 line
= XFASTINT (w
->base_line_number
);
16030 linepos
= XFASTINT (w
->base_line_pos
);
16031 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
16036 linepos
= BUF_BEGV (b
);
16037 linepos_byte
= BUF_BEGV_BYTE (b
);
16040 /* Count lines from base line to window start position. */
16041 nlines
= display_count_lines (linepos
, linepos_byte
,
16045 topline
= nlines
+ line
;
16047 /* Determine a new base line, if the old one is too close
16048 or too far away, or if we did not have one.
16049 "Too close" means it's plausible a scroll-down would
16050 go back past it. */
16051 if (startpos
== BUF_BEGV (b
))
16053 w
->base_line_number
= make_number (topline
);
16054 w
->base_line_pos
= make_number (BUF_BEGV (b
));
16056 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
16057 || linepos
== BUF_BEGV (b
))
16059 int limit
= BUF_BEGV (b
);
16060 int limit_byte
= BUF_BEGV_BYTE (b
);
16062 int distance
= (height
* 2 + 30) * line_number_display_limit_width
;
16064 if (startpos
- distance
> limit
)
16066 limit
= startpos
- distance
;
16067 limit_byte
= CHAR_TO_BYTE (limit
);
16070 nlines
= display_count_lines (startpos
, startpos_byte
,
16072 - (height
* 2 + 30),
16074 /* If we couldn't find the lines we wanted within
16075 line_number_display_limit_width chars per line,
16076 give up on line numbers for this window. */
16077 if (position
== limit_byte
&& limit
== startpos
- distance
)
16079 w
->base_line_pos
= w
->buffer
;
16080 w
->base_line_number
= Qnil
;
16084 w
->base_line_number
= make_number (topline
- nlines
);
16085 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
16088 /* Now count lines from the start pos to point. */
16089 nlines
= display_count_lines (startpos
, startpos_byte
,
16090 PT_BYTE
, PT
, &junk
);
16092 /* Record that we did display the line number. */
16093 line_number_displayed
= 1;
16095 /* Make the string to show. */
16096 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
16097 return decode_mode_spec_buf
;
16100 char* p
= decode_mode_spec_buf
;
16101 int pad
= field_width
- 2;
16107 return decode_mode_spec_buf
;
16113 obj
= b
->mode_name
;
16117 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
16123 int pos
= marker_position (w
->start
);
16124 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
16126 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
16128 if (pos
<= BUF_BEGV (b
))
16133 else if (pos
<= BUF_BEGV (b
))
16137 if (total
> 1000000)
16138 /* Do it differently for a large value, to avoid overflow. */
16139 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
16141 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
16142 /* We can't normally display a 3-digit number,
16143 so get us a 2-digit number that is close. */
16146 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
16147 return decode_mode_spec_buf
;
16151 /* Display percentage of size above the bottom of the screen. */
16154 int toppos
= marker_position (w
->start
);
16155 int botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
16156 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
16158 if (botpos
>= BUF_ZV (b
))
16160 if (toppos
<= BUF_BEGV (b
))
16167 if (total
> 1000000)
16168 /* Do it differently for a large value, to avoid overflow. */
16169 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
16171 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
16172 /* We can't normally display a 3-digit number,
16173 so get us a 2-digit number that is close. */
16176 if (toppos
<= BUF_BEGV (b
))
16177 sprintf (decode_mode_spec_buf
, "Top%2d%%", total
);
16179 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
16180 return decode_mode_spec_buf
;
16185 /* status of process */
16186 obj
= Fget_buffer_process (w
->buffer
);
16188 return "no process";
16189 #ifdef subprocesses
16190 obj
= Fsymbol_name (Fprocess_status (obj
));
16194 case 't': /* indicate TEXT or BINARY */
16195 #ifdef MODE_LINE_BINARY_TEXT
16196 return MODE_LINE_BINARY_TEXT (b
);
16202 /* coding-system (not including end-of-line format) */
16204 /* coding-system (including end-of-line type) */
16206 int eol_flag
= (c
== 'Z');
16207 char *p
= decode_mode_spec_buf
;
16209 if (! FRAME_WINDOW_P (f
))
16211 /* No need to mention EOL here--the terminal never needs
16212 to do EOL conversion. */
16213 p
= decode_mode_spec_coding (keyboard_coding
.symbol
, p
, 0);
16214 p
= decode_mode_spec_coding (terminal_coding
.symbol
, p
, 0);
16216 p
= decode_mode_spec_coding (b
->buffer_file_coding_system
,
16219 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
16220 #ifdef subprocesses
16221 obj
= Fget_buffer_process (Fcurrent_buffer ());
16222 if (PROCESSP (obj
))
16224 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
16226 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
16229 #endif /* subprocesses */
16232 return decode_mode_spec_buf
;
16238 *multibyte
= STRING_MULTIBYTE (obj
);
16239 return (char *) SDATA (obj
);
16246 /* Count up to COUNT lines starting from START / START_BYTE.
16247 But don't go beyond LIMIT_BYTE.
16248 Return the number of lines thus found (always nonnegative).
16250 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
16253 display_count_lines (start
, start_byte
, limit_byte
, count
, byte_pos_ptr
)
16254 int start
, start_byte
, limit_byte
, count
;
16257 register unsigned char *cursor
;
16258 unsigned char *base
;
16260 register int ceiling
;
16261 register unsigned char *ceiling_addr
;
16262 int orig_count
= count
;
16264 /* If we are not in selective display mode,
16265 check only for newlines. */
16266 int selective_display
= (!NILP (current_buffer
->selective_display
)
16267 && !INTEGERP (current_buffer
->selective_display
));
16271 while (start_byte
< limit_byte
)
16273 ceiling
= BUFFER_CEILING_OF (start_byte
);
16274 ceiling
= min (limit_byte
- 1, ceiling
);
16275 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
16276 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
16279 if (selective_display
)
16280 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
16283 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
16286 if (cursor
!= ceiling_addr
)
16290 start_byte
+= cursor
- base
+ 1;
16291 *byte_pos_ptr
= start_byte
;
16295 if (++cursor
== ceiling_addr
)
16301 start_byte
+= cursor
- base
;
16306 while (start_byte
> limit_byte
)
16308 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
16309 ceiling
= max (limit_byte
, ceiling
);
16310 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
16311 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
16314 if (selective_display
)
16315 while (--cursor
!= ceiling_addr
16316 && *cursor
!= '\n' && *cursor
!= 015)
16319 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
16322 if (cursor
!= ceiling_addr
)
16326 start_byte
+= cursor
- base
+ 1;
16327 *byte_pos_ptr
= start_byte
;
16328 /* When scanning backwards, we should
16329 not count the newline posterior to which we stop. */
16330 return - orig_count
- 1;
16336 /* Here we add 1 to compensate for the last decrement
16337 of CURSOR, which took it past the valid range. */
16338 start_byte
+= cursor
- base
+ 1;
16342 *byte_pos_ptr
= limit_byte
;
16345 return - orig_count
+ count
;
16346 return orig_count
- count
;
16352 /***********************************************************************
16354 ***********************************************************************/
16356 /* Display a NUL-terminated string, starting with index START.
16358 If STRING is non-null, display that C string. Otherwise, the Lisp
16359 string LISP_STRING is displayed.
16361 If FACE_STRING is not nil, FACE_STRING_POS is a position in
16362 FACE_STRING. Display STRING or LISP_STRING with the face at
16363 FACE_STRING_POS in FACE_STRING:
16365 Display the string in the environment given by IT, but use the
16366 standard display table, temporarily.
16368 FIELD_WIDTH is the minimum number of output glyphs to produce.
16369 If STRING has fewer characters than FIELD_WIDTH, pad to the right
16370 with spaces. If STRING has more characters, more than FIELD_WIDTH
16371 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
16373 PRECISION is the maximum number of characters to output from
16374 STRING. PRECISION < 0 means don't truncate the string.
16376 This is roughly equivalent to printf format specifiers:
16378 FIELD_WIDTH PRECISION PRINTF
16379 ----------------------------------------
16385 MULTIBYTE zero means do not display multibyte chars, > 0 means do
16386 display them, and < 0 means obey the current buffer's value of
16387 enable_multibyte_characters.
16389 Value is the number of glyphs produced. */
16392 display_string (string
, lisp_string
, face_string
, face_string_pos
,
16393 start
, it
, field_width
, precision
, max_x
, multibyte
)
16394 unsigned char *string
;
16395 Lisp_Object lisp_string
;
16396 Lisp_Object face_string
;
16397 int face_string_pos
;
16400 int field_width
, precision
, max_x
;
16403 int hpos_at_start
= it
->hpos
;
16404 int saved_face_id
= it
->face_id
;
16405 struct glyph_row
*row
= it
->glyph_row
;
16407 /* Initialize the iterator IT for iteration over STRING beginning
16408 with index START. */
16409 reseat_to_string (it
, string
, lisp_string
, start
,
16410 precision
, field_width
, multibyte
);
16412 /* If displaying STRING, set up the face of the iterator
16413 from LISP_STRING, if that's given. */
16414 if (STRINGP (face_string
))
16420 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
16421 0, it
->region_beg_charpos
,
16422 it
->region_end_charpos
,
16423 &endptr
, it
->base_face_id
, 0);
16424 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
16425 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
16428 /* Set max_x to the maximum allowed X position. Don't let it go
16429 beyond the right edge of the window. */
16431 max_x
= it
->last_visible_x
;
16433 max_x
= min (max_x
, it
->last_visible_x
);
16435 /* Skip over display elements that are not visible. because IT->w is
16437 if (it
->current_x
< it
->first_visible_x
)
16438 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
16439 MOVE_TO_POS
| MOVE_TO_X
);
16441 row
->ascent
= it
->max_ascent
;
16442 row
->height
= it
->max_ascent
+ it
->max_descent
;
16443 row
->phys_ascent
= it
->max_phys_ascent
;
16444 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16446 /* This condition is for the case that we are called with current_x
16447 past last_visible_x. */
16448 while (it
->current_x
< max_x
)
16450 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
16452 /* Get the next display element. */
16453 if (!get_next_display_element (it
))
16456 /* Produce glyphs. */
16457 x_before
= it
->current_x
;
16458 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
16459 PRODUCE_GLYPHS (it
);
16461 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
16464 while (i
< nglyphs
)
16466 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
16468 if (!it
->truncate_lines_p
16469 && x
+ glyph
->pixel_width
> max_x
)
16471 /* End of continued line or max_x reached. */
16472 if (CHAR_GLYPH_PADDING_P (*glyph
))
16474 /* A wide character is unbreakable. */
16475 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
16476 it
->current_x
= x_before
;
16480 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
16485 else if (x
+ glyph
->pixel_width
> it
->first_visible_x
)
16487 /* Glyph is at least partially visible. */
16489 if (x
< it
->first_visible_x
)
16490 it
->glyph_row
->x
= x
- it
->first_visible_x
;
16494 /* Glyph is off the left margin of the display area.
16495 Should not happen. */
16499 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
16500 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
16501 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
16502 row
->phys_height
= max (row
->phys_height
,
16503 it
->max_phys_ascent
+ it
->max_phys_descent
);
16504 x
+= glyph
->pixel_width
;
16508 /* Stop if max_x reached. */
16512 /* Stop at line ends. */
16513 if (ITERATOR_AT_END_OF_LINE_P (it
))
16515 it
->continuation_lines_width
= 0;
16519 set_iterator_to_next (it
, 1);
16521 /* Stop if truncating at the right edge. */
16522 if (it
->truncate_lines_p
16523 && it
->current_x
>= it
->last_visible_x
)
16525 /* Add truncation mark, but don't do it if the line is
16526 truncated at a padding space. */
16527 if (IT_CHARPOS (*it
) < it
->string_nchars
)
16529 if (!FRAME_WINDOW_P (it
->f
))
16533 if (it
->current_x
> it
->last_visible_x
)
16535 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
16536 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
16538 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
16540 row
->used
[TEXT_AREA
] = i
;
16541 produce_special_glyphs (it
, IT_TRUNCATION
);
16544 produce_special_glyphs (it
, IT_TRUNCATION
);
16546 it
->glyph_row
->truncated_on_right_p
= 1;
16552 /* Maybe insert a truncation at the left. */
16553 if (it
->first_visible_x
16554 && IT_CHARPOS (*it
) > 0)
16556 if (!FRAME_WINDOW_P (it
->f
))
16557 insert_left_trunc_glyphs (it
);
16558 it
->glyph_row
->truncated_on_left_p
= 1;
16561 it
->face_id
= saved_face_id
;
16563 /* Value is number of columns displayed. */
16564 return it
->hpos
- hpos_at_start
;
16569 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
16570 appears as an element of LIST or as the car of an element of LIST.
16571 If PROPVAL is a list, compare each element against LIST in that
16572 way, and return 1/2 if any element of PROPVAL is found in LIST.
16573 Otherwise return 0. This function cannot quit.
16574 The return value is 2 if the text is invisible but with an ellipsis
16575 and 1 if it's invisible and without an ellipsis. */
16578 invisible_p (propval
, list
)
16579 register Lisp_Object propval
;
16582 register Lisp_Object tail
, proptail
;
16584 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
16586 register Lisp_Object tem
;
16588 if (EQ (propval
, tem
))
16590 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
16591 return NILP (XCDR (tem
)) ? 1 : 2;
16594 if (CONSP (propval
))
16596 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
16598 Lisp_Object propelt
;
16599 propelt
= XCAR (proptail
);
16600 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
16602 register Lisp_Object tem
;
16604 if (EQ (propelt
, tem
))
16606 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
16607 return NILP (XCDR (tem
)) ? 1 : 2;
16616 /***********************************************************************
16618 ***********************************************************************/
16620 #ifdef HAVE_WINDOW_SYSTEM
16625 dump_glyph_string (s
)
16626 struct glyph_string
*s
;
16628 fprintf (stderr
, "glyph string\n");
16629 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
16630 s
->x
, s
->y
, s
->width
, s
->height
);
16631 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
16632 fprintf (stderr
, " hl = %d\n", s
->hl
);
16633 fprintf (stderr
, " left overhang = %d, right = %d\n",
16634 s
->left_overhang
, s
->right_overhang
);
16635 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
16636 fprintf (stderr
, " extends to end of line = %d\n",
16637 s
->extends_to_end_of_line_p
);
16638 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
16639 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
16642 #endif /* GLYPH_DEBUG */
16644 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
16645 of XChar2b structures for S; it can't be allocated in
16646 init_glyph_string because it must be allocated via `alloca'. W
16647 is the window on which S is drawn. ROW and AREA are the glyph row
16648 and area within the row from which S is constructed. START is the
16649 index of the first glyph structure covered by S. HL is a
16650 face-override for drawing S. */
16653 #define OPTIONAL_HDC(hdc) hdc,
16654 #define DECLARE_HDC(hdc) HDC hdc;
16655 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
16656 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
16659 #ifndef OPTIONAL_HDC
16660 #define OPTIONAL_HDC(hdc)
16661 #define DECLARE_HDC(hdc)
16662 #define ALLOCATE_HDC(hdc, f)
16663 #define RELEASE_HDC(hdc, f)
16667 init_glyph_string (s
, OPTIONAL_HDC (hdc
) char2b
, w
, row
, area
, start
, hl
)
16668 struct glyph_string
*s
;
16672 struct glyph_row
*row
;
16673 enum glyph_row_area area
;
16675 enum draw_glyphs_face hl
;
16677 bzero (s
, sizeof *s
);
16679 s
->f
= XFRAME (w
->frame
);
16683 s
->display
= FRAME_X_DISPLAY (s
->f
);
16684 s
->window
= FRAME_X_WINDOW (s
->f
);
16685 s
->char2b
= char2b
;
16689 s
->first_glyph
= row
->glyphs
[area
] + start
;
16690 s
->height
= row
->height
;
16691 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
16693 /* Display the internal border below the tool-bar window. */
16694 if (s
->w
== XWINDOW (s
->f
->tool_bar_window
))
16695 s
->y
-= FRAME_INTERNAL_BORDER_WIDTH (s
->f
);
16697 s
->ybase
= s
->y
+ row
->ascent
;
16701 /* Append the list of glyph strings with head H and tail T to the list
16702 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
16705 append_glyph_string_lists (head
, tail
, h
, t
)
16706 struct glyph_string
**head
, **tail
;
16707 struct glyph_string
*h
, *t
;
16721 /* Prepend the list of glyph strings with head H and tail T to the
16722 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
16726 prepend_glyph_string_lists (head
, tail
, h
, t
)
16727 struct glyph_string
**head
, **tail
;
16728 struct glyph_string
*h
, *t
;
16742 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
16743 Set *HEAD and *TAIL to the resulting list. */
16746 append_glyph_string (head
, tail
, s
)
16747 struct glyph_string
**head
, **tail
;
16748 struct glyph_string
*s
;
16750 s
->next
= s
->prev
= NULL
;
16751 append_glyph_string_lists (head
, tail
, s
, s
);
16755 /* Get face and two-byte form of character glyph GLYPH on frame F.
16756 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
16757 a pointer to a realized face that is ready for display. */
16759 static INLINE
struct face
*
16760 get_glyph_face_and_encoding (f
, glyph
, char2b
, two_byte_p
)
16762 struct glyph
*glyph
;
16768 xassert (glyph
->type
== CHAR_GLYPH
);
16769 face
= FACE_FROM_ID (f
, glyph
->face_id
);
16774 if (!glyph
->multibyte_p
)
16776 /* Unibyte case. We don't have to encode, but we have to make
16777 sure to use a face suitable for unibyte. */
16778 STORE_XCHAR2B (char2b
, 0, glyph
->u
.ch
);
16780 else if (glyph
->u
.ch
< 128
16781 && glyph
->face_id
< BASIC_FACE_ID_SENTINEL
)
16783 /* Case of ASCII in a face known to fit ASCII. */
16784 STORE_XCHAR2B (char2b
, 0, glyph
->u
.ch
);
16788 int c1
, c2
, charset
;
16790 /* Split characters into bytes. If c2 is -1 afterwards, C is
16791 really a one-byte character so that byte1 is zero. */
16792 SPLIT_CHAR (glyph
->u
.ch
, charset
, c1
, c2
);
16794 STORE_XCHAR2B (char2b
, c1
, c2
);
16796 STORE_XCHAR2B (char2b
, 0, c1
);
16798 /* Maybe encode the character in *CHAR2B. */
16799 if (charset
!= CHARSET_ASCII
)
16801 struct font_info
*font_info
16802 = FONT_INFO_FROM_ID (f
, face
->font_info_id
);
16805 = rif
->encode_char (glyph
->u
.ch
, char2b
, font_info
, two_byte_p
);
16809 /* Make sure X resources of the face are allocated. */
16810 xassert (face
!= NULL
);
16811 PREPARE_FACE_FOR_DISPLAY (f
, face
);
16816 /* Fill glyph string S with composition components specified by S->cmp.
16818 FACES is an array of faces for all components of this composition.
16819 S->gidx is the index of the first component for S.
16820 OVERLAPS_P non-zero means S should draw the foreground only, and
16821 use its physical height for clipping.
16823 Value is the index of a component not in S. */
16826 fill_composite_glyph_string (s
, faces
, overlaps_p
)
16827 struct glyph_string
*s
;
16828 struct face
**faces
;
16835 s
->for_overlaps_p
= overlaps_p
;
16837 s
->face
= faces
[s
->gidx
];
16838 s
->font
= s
->face
->font
;
16839 s
->font_info
= FONT_INFO_FROM_ID (s
->f
, s
->face
->font_info_id
);
16841 /* For all glyphs of this composition, starting at the offset
16842 S->gidx, until we reach the end of the definition or encounter a
16843 glyph that requires the different face, add it to S. */
16845 for (i
= s
->gidx
+ 1; i
< s
->cmp
->glyph_len
&& faces
[i
] == s
->face
; ++i
)
16848 /* All glyph strings for the same composition has the same width,
16849 i.e. the width set for the first component of the composition. */
16851 s
->width
= s
->first_glyph
->pixel_width
;
16853 /* If the specified font could not be loaded, use the frame's
16854 default font, but record the fact that we couldn't load it in
16855 the glyph string so that we can draw rectangles for the
16856 characters of the glyph string. */
16857 if (s
->font
== NULL
)
16859 s
->font_not_found_p
= 1;
16860 s
->font
= FRAME_FONT (s
->f
);
16863 /* Adjust base line for subscript/superscript text. */
16864 s
->ybase
+= s
->first_glyph
->voffset
;
16866 xassert (s
->face
&& s
->face
->gc
);
16868 /* This glyph string must always be drawn with 16-bit functions. */
16871 return s
->gidx
+ s
->nchars
;
16875 /* Fill glyph string S from a sequence of character glyphs.
16877 FACE_ID is the face id of the string. START is the index of the
16878 first glyph to consider, END is the index of the last + 1.
16879 OVERLAPS_P non-zero means S should draw the foreground only, and
16880 use its physical height for clipping.
16882 Value is the index of the first glyph not in S. */
16885 fill_glyph_string (s
, face_id
, start
, end
, overlaps_p
)
16886 struct glyph_string
*s
;
16888 int start
, end
, overlaps_p
;
16890 struct glyph
*glyph
, *last
;
16892 int glyph_not_available_p
;
16894 xassert (s
->f
== XFRAME (s
->w
->frame
));
16895 xassert (s
->nchars
== 0);
16896 xassert (start
>= 0 && end
> start
);
16898 s
->for_overlaps_p
= overlaps_p
,
16899 glyph
= s
->row
->glyphs
[s
->area
] + start
;
16900 last
= s
->row
->glyphs
[s
->area
] + end
;
16901 voffset
= glyph
->voffset
;
16903 glyph_not_available_p
= glyph
->glyph_not_available_p
;
16905 while (glyph
< last
16906 && glyph
->type
== CHAR_GLYPH
16907 && glyph
->voffset
== voffset
16908 /* Same face id implies same font, nowadays. */
16909 && glyph
->face_id
== face_id
16910 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
16914 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
16915 s
->char2b
+ s
->nchars
,
16917 s
->two_byte_p
= two_byte_p
;
16919 xassert (s
->nchars
<= end
- start
);
16920 s
->width
+= glyph
->pixel_width
;
16924 s
->font
= s
->face
->font
;
16925 s
->font_info
= FONT_INFO_FROM_ID (s
->f
, s
->face
->font_info_id
);
16927 /* If the specified font could not be loaded, use the frame's font,
16928 but record the fact that we couldn't load it in
16929 S->font_not_found_p so that we can draw rectangles for the
16930 characters of the glyph string. */
16931 if (s
->font
== NULL
|| glyph_not_available_p
)
16933 s
->font_not_found_p
= 1;
16934 s
->font
= FRAME_FONT (s
->f
);
16937 /* Adjust base line for subscript/superscript text. */
16938 s
->ybase
+= voffset
;
16940 xassert (s
->face
&& s
->face
->gc
);
16941 return glyph
- s
->row
->glyphs
[s
->area
];
16945 /* Fill glyph string S from image glyph S->first_glyph. */
16948 fill_image_glyph_string (s
)
16949 struct glyph_string
*s
;
16951 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
16952 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
16954 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
16955 s
->font
= s
->face
->font
;
16956 s
->width
= s
->first_glyph
->pixel_width
;
16958 /* Adjust base line for subscript/superscript text. */
16959 s
->ybase
+= s
->first_glyph
->voffset
;
16963 /* Fill glyph string S from a sequence of stretch glyphs.
16965 ROW is the glyph row in which the glyphs are found, AREA is the
16966 area within the row. START is the index of the first glyph to
16967 consider, END is the index of the last + 1.
16969 Value is the index of the first glyph not in S. */
16972 fill_stretch_glyph_string (s
, row
, area
, start
, end
)
16973 struct glyph_string
*s
;
16974 struct glyph_row
*row
;
16975 enum glyph_row_area area
;
16978 struct glyph
*glyph
, *last
;
16979 int voffset
, face_id
;
16981 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
16983 glyph
= s
->row
->glyphs
[s
->area
] + start
;
16984 last
= s
->row
->glyphs
[s
->area
] + end
;
16985 face_id
= glyph
->face_id
;
16986 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
16987 s
->font
= s
->face
->font
;
16988 s
->font_info
= FONT_INFO_FROM_ID (s
->f
, s
->face
->font_info_id
);
16989 s
->width
= glyph
->pixel_width
;
16990 voffset
= glyph
->voffset
;
16994 && glyph
->type
== STRETCH_GLYPH
16995 && glyph
->voffset
== voffset
16996 && glyph
->face_id
== face_id
);
16998 s
->width
+= glyph
->pixel_width
;
17000 /* Adjust base line for subscript/superscript text. */
17001 s
->ybase
+= voffset
;
17003 /* The case that face->gc == 0 is handled when drawing the glyph
17004 string by calling PREPARE_FACE_FOR_DISPLAY. */
17006 return glyph
- s
->row
->glyphs
[s
->area
];
17011 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
17012 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
17013 assumed to be zero. */
17016 x_get_glyph_overhangs (glyph
, f
, left
, right
)
17017 struct glyph
*glyph
;
17021 *left
= *right
= 0;
17023 if (glyph
->type
== CHAR_GLYPH
)
17027 struct font_info
*font_info
;
17031 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
17033 font_info
= FONT_INFO_FROM_ID (f
, face
->font_info_id
);
17034 if (font
/* ++KFS: Should this be font_info ? */
17035 && (pcm
= rif
->per_char_metric (font
, &char2b
, glyph
->font_type
)))
17037 if (pcm
->rbearing
> pcm
->width
)
17038 *right
= pcm
->rbearing
- pcm
->width
;
17039 if (pcm
->lbearing
< 0)
17040 *left
= -pcm
->lbearing
;
17046 /* Return the index of the first glyph preceding glyph string S that
17047 is overwritten by S because of S's left overhang. Value is -1
17048 if no glyphs are overwritten. */
17051 left_overwritten (s
)
17052 struct glyph_string
*s
;
17056 if (s
->left_overhang
)
17059 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
17060 int first
= s
->first_glyph
- glyphs
;
17062 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
17063 x
-= glyphs
[i
].pixel_width
;
17074 /* Return the index of the first glyph preceding glyph string S that
17075 is overwriting S because of its right overhang. Value is -1 if no
17076 glyph in front of S overwrites S. */
17079 left_overwriting (s
)
17080 struct glyph_string
*s
;
17083 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
17084 int first
= s
->first_glyph
- glyphs
;
17088 for (i
= first
- 1; i
>= 0; --i
)
17091 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
17094 x
-= glyphs
[i
].pixel_width
;
17101 /* Return the index of the last glyph following glyph string S that is
17102 not overwritten by S because of S's right overhang. Value is -1 if
17103 no such glyph is found. */
17106 right_overwritten (s
)
17107 struct glyph_string
*s
;
17111 if (s
->right_overhang
)
17114 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
17115 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
17116 int end
= s
->row
->used
[s
->area
];
17118 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
17119 x
+= glyphs
[i
].pixel_width
;
17128 /* Return the index of the last glyph following glyph string S that
17129 overwrites S because of its left overhang. Value is negative
17130 if no such glyph is found. */
17133 right_overwriting (s
)
17134 struct glyph_string
*s
;
17137 int end
= s
->row
->used
[s
->area
];
17138 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
17139 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
17143 for (i
= first
; i
< end
; ++i
)
17146 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
17149 x
+= glyphs
[i
].pixel_width
;
17156 /* Get face and two-byte form of character C in face FACE_ID on frame
17157 F. The encoding of C is returned in *CHAR2B. MULTIBYTE_P non-zero
17158 means we want to display multibyte text. DISPLAY_P non-zero means
17159 make sure that X resources for the face returned are allocated.
17160 Value is a pointer to a realized face that is ready for display if
17161 DISPLAY_P is non-zero. */
17163 static INLINE
struct face
*
17164 get_char_face_and_encoding (f
, c
, face_id
, char2b
, multibyte_p
, display_p
)
17168 int multibyte_p
, display_p
;
17170 struct face
*face
= FACE_FROM_ID (f
, face_id
);
17174 /* Unibyte case. We don't have to encode, but we have to make
17175 sure to use a face suitable for unibyte. */
17176 STORE_XCHAR2B (char2b
, 0, c
);
17177 face_id
= FACE_FOR_CHAR (f
, face
, c
);
17178 face
= FACE_FROM_ID (f
, face_id
);
17180 else if (c
< 128 && face_id
< BASIC_FACE_ID_SENTINEL
)
17182 /* Case of ASCII in a face known to fit ASCII. */
17183 STORE_XCHAR2B (char2b
, 0, c
);
17187 int c1
, c2
, charset
;
17189 /* Split characters into bytes. If c2 is -1 afterwards, C is
17190 really a one-byte character so that byte1 is zero. */
17191 SPLIT_CHAR (c
, charset
, c1
, c2
);
17193 STORE_XCHAR2B (char2b
, c1
, c2
);
17195 STORE_XCHAR2B (char2b
, 0, c1
);
17197 /* Maybe encode the character in *CHAR2B. */
17198 if (face
->font
!= NULL
)
17200 struct font_info
*font_info
17201 = FONT_INFO_FROM_ID (f
, face
->font_info_id
);
17203 rif
->encode_char (c
, char2b
, font_info
, 0);
17207 /* Make sure X resources of the face are allocated. */
17208 #ifdef HAVE_X_WINDOWS
17212 xassert (face
!= NULL
);
17213 PREPARE_FACE_FOR_DISPLAY (f
, face
);
17220 /* Set background width of glyph string S. START is the index of the
17221 first glyph following S. LAST_X is the right-most x-position + 1
17222 in the drawing area. */
17225 set_glyph_string_background_width (s
, start
, last_x
)
17226 struct glyph_string
*s
;
17230 /* If the face of this glyph string has to be drawn to the end of
17231 the drawing area, set S->extends_to_end_of_line_p. */
17232 struct face
*default_face
= FACE_FROM_ID (s
->f
, DEFAULT_FACE_ID
);
17234 if (start
== s
->row
->used
[s
->area
]
17235 && s
->area
== TEXT_AREA
17236 && ((s
->hl
== DRAW_NORMAL_TEXT
17237 && (s
->row
->fill_line_p
17238 || s
->face
->background
!= default_face
->background
17239 || s
->face
->stipple
!= default_face
->stipple
17240 || s
->row
->mouse_face_p
))
17241 || s
->hl
== DRAW_MOUSE_FACE
17242 || ((s
->hl
== DRAW_IMAGE_RAISED
|| s
->hl
== DRAW_IMAGE_SUNKEN
)
17243 && s
->row
->fill_line_p
)))
17244 s
->extends_to_end_of_line_p
= 1;
17246 /* If S extends its face to the end of the line, set its
17247 background_width to the distance to the right edge of the drawing
17249 if (s
->extends_to_end_of_line_p
)
17250 s
->background_width
= last_x
- s
->x
+ 1;
17252 s
->background_width
= s
->width
;
17256 /* Compute overhangs and x-positions for glyph string S and its
17257 predecessors, or successors. X is the starting x-position for S.
17258 BACKWARD_P non-zero means process predecessors. */
17261 compute_overhangs_and_x (s
, x
, backward_p
)
17262 struct glyph_string
*s
;
17270 if (rif
->compute_glyph_string_overhangs
)
17271 rif
->compute_glyph_string_overhangs (s
);
17281 if (rif
->compute_glyph_string_overhangs
)
17282 rif
->compute_glyph_string_overhangs (s
);
17292 /* The following macros are only called from draw_glyphs below.
17293 They reference the following parameters of that function directly:
17294 `w', `row', `area', and `overlap_p'
17295 as well as the following local variables:
17296 `s', `f', and `hdc' (in W32) */
17299 /* On W32, silently add local `hdc' variable to argument list of
17300 init_glyph_string. */
17301 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
17302 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
17304 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
17305 init_glyph_string (s, char2b, w, row, area, start, hl)
17308 /* Add a glyph string for a stretch glyph to the list of strings
17309 between HEAD and TAIL. START is the index of the stretch glyph in
17310 row area AREA of glyph row ROW. END is the index of the last glyph
17311 in that glyph row area. X is the current output position assigned
17312 to the new glyph string constructed. HL overrides that face of the
17313 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
17314 is the right-most x-position of the drawing area. */
17316 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
17317 and below -- keep them on one line. */
17318 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
17321 s = (struct glyph_string *) alloca (sizeof *s); \
17322 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
17323 START = fill_stretch_glyph_string (s, row, area, START, END); \
17324 append_glyph_string (&HEAD, &TAIL, s); \
17330 /* Add a glyph string for an image glyph to the list of strings
17331 between HEAD and TAIL. START is the index of the image glyph in
17332 row area AREA of glyph row ROW. END is the index of the last glyph
17333 in that glyph row area. X is the current output position assigned
17334 to the new glyph string constructed. HL overrides that face of the
17335 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
17336 is the right-most x-position of the drawing area. */
17338 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
17341 s = (struct glyph_string *) alloca (sizeof *s); \
17342 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
17343 fill_image_glyph_string (s); \
17344 append_glyph_string (&HEAD, &TAIL, s); \
17351 /* Add a glyph string for a sequence of character glyphs to the list
17352 of strings between HEAD and TAIL. START is the index of the first
17353 glyph in row area AREA of glyph row ROW that is part of the new
17354 glyph string. END is the index of the last glyph in that glyph row
17355 area. X is the current output position assigned to the new glyph
17356 string constructed. HL overrides that face of the glyph; e.g. it
17357 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
17358 right-most x-position of the drawing area. */
17360 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
17366 c = (row)->glyphs[area][START].u.ch; \
17367 face_id = (row)->glyphs[area][START].face_id; \
17369 s = (struct glyph_string *) alloca (sizeof *s); \
17370 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
17371 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
17372 append_glyph_string (&HEAD, &TAIL, s); \
17374 START = fill_glyph_string (s, face_id, START, END, overlaps_p); \
17379 /* Add a glyph string for a composite sequence to the list of strings
17380 between HEAD and TAIL. START is the index of the first glyph in
17381 row area AREA of glyph row ROW that is part of the new glyph
17382 string. END is the index of the last glyph in that glyph row area.
17383 X is the current output position assigned to the new glyph string
17384 constructed. HL overrides that face of the glyph; e.g. it is
17385 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
17386 x-position of the drawing area. */
17388 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
17390 int cmp_id = (row)->glyphs[area][START].u.cmp_id; \
17391 int face_id = (row)->glyphs[area][START].face_id; \
17392 struct face *base_face = FACE_FROM_ID (f, face_id); \
17393 struct composition *cmp = composition_table[cmp_id]; \
17394 int glyph_len = cmp->glyph_len; \
17396 struct face **faces; \
17397 struct glyph_string *first_s = NULL; \
17400 base_face = base_face->ascii_face; \
17401 char2b = (XChar2b *) alloca ((sizeof *char2b) * glyph_len); \
17402 faces = (struct face **) alloca ((sizeof *faces) * glyph_len); \
17403 /* At first, fill in `char2b' and `faces'. */ \
17404 for (n = 0; n < glyph_len; n++) \
17406 int c = COMPOSITION_GLYPH (cmp, n); \
17407 int this_face_id = FACE_FOR_CHAR (f, base_face, c); \
17408 faces[n] = FACE_FROM_ID (f, this_face_id); \
17409 get_char_face_and_encoding (f, c, this_face_id, \
17410 char2b + n, 1, 1); \
17413 /* Make glyph_strings for each glyph sequence that is drawable by \
17414 the same face, and append them to HEAD/TAIL. */ \
17415 for (n = 0; n < cmp->glyph_len;) \
17417 s = (struct glyph_string *) alloca (sizeof *s); \
17418 INIT_GLYPH_STRING (s, char2b + n, w, row, area, START, HL); \
17419 append_glyph_string (&(HEAD), &(TAIL), s); \
17427 n = fill_composite_glyph_string (s, faces, overlaps_p); \
17435 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
17436 of AREA of glyph row ROW on window W between indices START and END.
17437 HL overrides the face for drawing glyph strings, e.g. it is
17438 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
17439 x-positions of the drawing area.
17441 This is an ugly monster macro construct because we must use alloca
17442 to allocate glyph strings (because draw_glyphs can be called
17443 asynchronously). */
17445 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
17448 HEAD = TAIL = NULL; \
17449 while (START < END) \
17451 struct glyph *first_glyph = (row)->glyphs[area] + START; \
17452 switch (first_glyph->type) \
17455 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
17459 case COMPOSITE_GLYPH: \
17460 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
17464 case STRETCH_GLYPH: \
17465 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
17469 case IMAGE_GLYPH: \
17470 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
17478 set_glyph_string_background_width (s, START, LAST_X); \
17485 /* Draw glyphs between START and END in AREA of ROW on window W,
17486 starting at x-position X. X is relative to AREA in W. HL is a
17487 face-override with the following meaning:
17489 DRAW_NORMAL_TEXT draw normally
17490 DRAW_CURSOR draw in cursor face
17491 DRAW_MOUSE_FACE draw in mouse face.
17492 DRAW_INVERSE_VIDEO draw in mode line face
17493 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
17494 DRAW_IMAGE_RAISED draw an image with a raised relief around it
17496 If OVERLAPS_P is non-zero, draw only the foreground of characters
17497 and clip to the physical height of ROW.
17499 Value is the x-position reached, relative to AREA of W. */
17502 draw_glyphs (w
, x
, row
, area
, start
, end
, hl
, overlaps_p
)
17505 struct glyph_row
*row
;
17506 enum glyph_row_area area
;
17508 enum draw_glyphs_face hl
;
17511 struct glyph_string
*head
, *tail
;
17512 struct glyph_string
*s
;
17513 int last_x
, area_width
;
17516 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
17519 ALLOCATE_HDC (hdc
, f
);
17521 /* Let's rather be paranoid than getting a SEGV. */
17522 end
= min (end
, row
->used
[area
]);
17523 start
= max (0, start
);
17524 start
= min (end
, start
);
17526 /* Translate X to frame coordinates. Set last_x to the right
17527 end of the drawing area. */
17528 if (row
->full_width_p
)
17530 /* X is relative to the left edge of W, without scroll bars
17532 x
+= WINDOW_LEFT_EDGE_X (w
);
17533 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
17537 int area_left
= window_box_left (w
, area
);
17539 area_width
= window_box_width (w
, area
);
17540 last_x
= area_left
+ area_width
;
17543 /* Build a doubly-linked list of glyph_string structures between
17544 head and tail from what we have to draw. Note that the macro
17545 BUILD_GLYPH_STRINGS will modify its start parameter. That's
17546 the reason we use a separate variable `i'. */
17548 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
17550 x_reached
= tail
->x
+ tail
->background_width
;
17554 /* If there are any glyphs with lbearing < 0 or rbearing > width in
17555 the row, redraw some glyphs in front or following the glyph
17556 strings built above. */
17557 if (head
&& !overlaps_p
&& row
->contains_overlapping_glyphs_p
)
17560 struct glyph_string
*h
, *t
;
17562 /* Compute overhangs for all glyph strings. */
17563 if (rif
->compute_glyph_string_overhangs
)
17564 for (s
= head
; s
; s
= s
->next
)
17565 rif
->compute_glyph_string_overhangs (s
);
17567 /* Prepend glyph strings for glyphs in front of the first glyph
17568 string that are overwritten because of the first glyph
17569 string's left overhang. The background of all strings
17570 prepended must be drawn because the first glyph string
17572 i
= left_overwritten (head
);
17576 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
17577 DRAW_NORMAL_TEXT
, dummy_x
, last_x
);
17579 compute_overhangs_and_x (t
, head
->x
, 1);
17580 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
17583 /* Prepend glyph strings for glyphs in front of the first glyph
17584 string that overwrite that glyph string because of their
17585 right overhang. For these strings, only the foreground must
17586 be drawn, because it draws over the glyph string at `head'.
17587 The background must not be drawn because this would overwrite
17588 right overhangs of preceding glyphs for which no glyph
17590 i
= left_overwriting (head
);
17593 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
17594 DRAW_NORMAL_TEXT
, dummy_x
, last_x
);
17595 for (s
= h
; s
; s
= s
->next
)
17596 s
->background_filled_p
= 1;
17597 compute_overhangs_and_x (t
, head
->x
, 1);
17598 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
17601 /* Append glyphs strings for glyphs following the last glyph
17602 string tail that are overwritten by tail. The background of
17603 these strings has to be drawn because tail's foreground draws
17605 i
= right_overwritten (tail
);
17608 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
17609 DRAW_NORMAL_TEXT
, x
, last_x
);
17610 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
17611 append_glyph_string_lists (&head
, &tail
, h
, t
);
17614 /* Append glyph strings for glyphs following the last glyph
17615 string tail that overwrite tail. The foreground of such
17616 glyphs has to be drawn because it writes into the background
17617 of tail. The background must not be drawn because it could
17618 paint over the foreground of following glyphs. */
17619 i
= right_overwriting (tail
);
17622 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
17623 DRAW_NORMAL_TEXT
, x
, last_x
);
17624 for (s
= h
; s
; s
= s
->next
)
17625 s
->background_filled_p
= 1;
17626 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
17627 append_glyph_string_lists (&head
, &tail
, h
, t
);
17631 /* Draw all strings. */
17632 for (s
= head
; s
; s
= s
->next
)
17633 rif
->draw_glyph_string (s
);
17635 if (area
== TEXT_AREA
17636 && !row
->full_width_p
17637 /* When drawing overlapping rows, only the glyph strings'
17638 foreground is drawn, which doesn't erase a cursor
17642 int x0
= head
? head
->x
: x
;
17643 int x1
= tail
? tail
->x
+ tail
->background_width
: x
;
17645 int text_left
= window_box_left (w
, TEXT_AREA
);
17649 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
17650 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
17653 /* Value is the x-position up to which drawn, relative to AREA of W.
17654 This doesn't include parts drawn because of overhangs. */
17655 if (row
->full_width_p
)
17656 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
17658 x_reached
-= window_box_left (w
, area
);
17660 RELEASE_HDC (hdc
, f
);
17666 /* Store one glyph for IT->char_to_display in IT->glyph_row.
17667 Called from x_produce_glyphs when IT->glyph_row is non-null. */
17673 struct glyph
*glyph
;
17674 enum glyph_row_area area
= it
->area
;
17676 xassert (it
->glyph_row
);
17677 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
17679 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
17680 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
17682 glyph
->charpos
= CHARPOS (it
->position
);
17683 glyph
->object
= it
->object
;
17684 glyph
->pixel_width
= it
->pixel_width
;
17685 glyph
->voffset
= it
->voffset
;
17686 glyph
->type
= CHAR_GLYPH
;
17687 glyph
->multibyte_p
= it
->multibyte_p
;
17688 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
17689 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
17690 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
17691 || it
->phys_descent
> it
->descent
);
17692 glyph
->padding_p
= 0;
17693 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
17694 glyph
->face_id
= it
->face_id
;
17695 glyph
->u
.ch
= it
->char_to_display
;
17696 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
17697 ++it
->glyph_row
->used
[area
];
17701 /* Store one glyph for the composition IT->cmp_id in IT->glyph_row.
17702 Called from x_produce_glyphs when IT->glyph_row is non-null. */
17705 append_composite_glyph (it
)
17708 struct glyph
*glyph
;
17709 enum glyph_row_area area
= it
->area
;
17711 xassert (it
->glyph_row
);
17713 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
17714 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
17716 glyph
->charpos
= CHARPOS (it
->position
);
17717 glyph
->object
= it
->object
;
17718 glyph
->pixel_width
= it
->pixel_width
;
17719 glyph
->voffset
= it
->voffset
;
17720 glyph
->type
= COMPOSITE_GLYPH
;
17721 glyph
->multibyte_p
= it
->multibyte_p
;
17722 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
17723 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
17724 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
17725 || it
->phys_descent
> it
->descent
);
17726 glyph
->padding_p
= 0;
17727 glyph
->glyph_not_available_p
= 0;
17728 glyph
->face_id
= it
->face_id
;
17729 glyph
->u
.cmp_id
= it
->cmp_id
;
17730 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
17731 ++it
->glyph_row
->used
[area
];
17736 /* Change IT->ascent and IT->height according to the setting of
17740 take_vertical_position_into_account (it
)
17745 if (it
->voffset
< 0)
17746 /* Increase the ascent so that we can display the text higher
17748 it
->ascent
+= abs (it
->voffset
);
17750 /* Increase the descent so that we can display the text lower
17752 it
->descent
+= it
->voffset
;
17757 /* Produce glyphs/get display metrics for the image IT is loaded with.
17758 See the description of struct display_iterator in dispextern.h for
17759 an overview of struct display_iterator. */
17762 produce_image_glyph (it
)
17768 xassert (it
->what
== IT_IMAGE
);
17770 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
17771 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
17774 /* Make sure X resources of the face and image are loaded. */
17775 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
17776 prepare_image_for_display (it
->f
, img
);
17778 it
->ascent
= it
->phys_ascent
= image_ascent (img
, face
);
17779 it
->descent
= it
->phys_descent
= img
->height
+ 2 * img
->vmargin
- it
->ascent
;
17780 it
->pixel_width
= img
->width
+ 2 * img
->hmargin
;
17784 if (face
->box
!= FACE_NO_BOX
)
17786 if (face
->box_line_width
> 0)
17788 it
->ascent
+= face
->box_line_width
;
17789 it
->descent
+= face
->box_line_width
;
17792 if (it
->start_of_box_run_p
)
17793 it
->pixel_width
+= abs (face
->box_line_width
);
17794 if (it
->end_of_box_run_p
)
17795 it
->pixel_width
+= abs (face
->box_line_width
);
17798 take_vertical_position_into_account (it
);
17802 struct glyph
*glyph
;
17803 enum glyph_row_area area
= it
->area
;
17805 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
17806 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
17808 glyph
->charpos
= CHARPOS (it
->position
);
17809 glyph
->object
= it
->object
;
17810 glyph
->pixel_width
= it
->pixel_width
;
17811 glyph
->voffset
= it
->voffset
;
17812 glyph
->type
= IMAGE_GLYPH
;
17813 glyph
->multibyte_p
= it
->multibyte_p
;
17814 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
17815 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
17816 glyph
->overlaps_vertically_p
= 0;
17817 glyph
->padding_p
= 0;
17818 glyph
->glyph_not_available_p
= 0;
17819 glyph
->face_id
= it
->face_id
;
17820 glyph
->u
.img_id
= img
->id
;
17821 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
17822 ++it
->glyph_row
->used
[area
];
17828 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
17829 of the glyph, WIDTH and HEIGHT are the width and height of the
17830 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
17833 append_stretch_glyph (it
, object
, width
, height
, ascent
)
17835 Lisp_Object object
;
17839 struct glyph
*glyph
;
17840 enum glyph_row_area area
= it
->area
;
17842 xassert (ascent
>= 0 && ascent
<= height
);
17844 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
17845 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
17847 glyph
->charpos
= CHARPOS (it
->position
);
17848 glyph
->object
= object
;
17849 glyph
->pixel_width
= width
;
17850 glyph
->voffset
= it
->voffset
;
17851 glyph
->type
= STRETCH_GLYPH
;
17852 glyph
->multibyte_p
= it
->multibyte_p
;
17853 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
17854 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
17855 glyph
->overlaps_vertically_p
= 0;
17856 glyph
->padding_p
= 0;
17857 glyph
->glyph_not_available_p
= 0;
17858 glyph
->face_id
= it
->face_id
;
17859 glyph
->u
.stretch
.ascent
= ascent
;
17860 glyph
->u
.stretch
.height
= height
;
17861 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
17862 ++it
->glyph_row
->used
[area
];
17867 /* Calculate a width or height in pixels from a specification using
17868 the following elements:
17871 NUM - a (fractional) multiple of the default font width/height
17872 (NUM) - specifies exactly NUM pixels
17873 UNIT - a fixed number of pixels, see below.
17874 ELEMENT - size of a display element in pixels, see below.
17875 (NUM . SPEC) - equals NUM * SPEC
17876 (+ SPEC SPEC ...) - add pixel values
17877 (- SPEC SPEC ...) - subtract pixel values
17878 (- SPEC) - negate pixel value
17881 INT or FLOAT - a number constant
17882 SYMBOL - use symbol's (buffer local) variable binding.
17885 in - pixels per inch *)
17886 mm - pixels per 1/1000 meter *)
17887 cm - pixels per 1/100 meter *)
17888 width - width of current font in pixels.
17889 height - height of current font in pixels.
17891 *) using the ratio(s) defined in display-pixels-per-inch.
17895 left-fringe - left fringe width in pixels
17896 (left-fringe . nil) - left fringe width if inside margins, else 0
17897 (left-fringe . t) - left fringe width if outside margins, else 0
17899 right-fringe - right fringe width in pixels
17900 (right-fringe . nil) - right fringe width if inside margins, else 0
17901 (right-fringe . t) - right fringe width if outside margins, else 0
17903 left-margin - left margin width in pixels
17904 right-margin - right margin width in pixels
17906 scroll-bar - scroll-bar area width in pixels
17907 (scroll-bar . left) - scroll-bar width if on left, else 0
17908 (scroll-bar . right) - scroll-bar width if on right, else 0
17912 Pixels corresponding to 5 inches:
17915 Total width of non-text areas on left side of window:
17916 (+ left-fringe left-margin (scroll-bar . left))
17918 Total width of fringes if inside display margins:
17919 (+ (left-fringe) (right-fringe))
17921 Width of left margin minus width of 1 character in the default font:
17924 Width of left margin minus width of 2 characters in the current font:
17925 (- left-margin (2 . width))
17927 Width of left fringe plus left margin minus one pixel:
17928 (- (+ left-fringe left-margin) (1))
17929 (+ left-fringe left-margin (- (1)))
17930 (+ left-fringe left-margin (-1))
17934 #define NUMVAL(X) \
17935 ((INTEGERP (X) || FLOATP (X)) \
17940 calc_pixel_width_or_height (res
, it
, prop
, font
, width_p
)
17949 #define OK_PIXELS(val) ((*res = (val)), 1)
17951 if (SYMBOLP (prop
))
17953 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
17955 char *unit
= SDATA (SYMBOL_NAME (prop
));
17957 if (unit
[0] == 'i' && unit
[1] == 'n')
17959 else if (unit
[0] == 'm' && unit
[1] == 'm')
17961 else if (unit
[0] == 'c' && unit
[1] == 'm')
17968 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
17969 || (CONSP (Vdisplay_pixels_per_inch
)
17971 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
17972 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
17974 return OK_PIXELS (ppi
/ pixels
);
17980 if (EQ (prop
, Qheight
))
17981 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
17982 if (EQ (prop
, Qwidth
))
17983 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
17984 if (EQ (prop
, Qleft_fringe
))
17985 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
17986 if (EQ (prop
, Qright_fringe
))
17987 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
17988 if (EQ (prop
, Qleft_margin
))
17989 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
17990 if (EQ (prop
, Qright_margin
))
17991 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
17992 if (EQ (prop
, Qscroll_bar
))
17993 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
17995 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
17998 if (INTEGERP (prop
) || FLOATP (prop
))
18000 int base_unit
= (width_p
18001 ? FRAME_COLUMN_WIDTH (it
->f
)
18002 : FRAME_LINE_HEIGHT (it
->f
));
18003 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
18008 Lisp_Object car
= XCAR (prop
);
18009 Lisp_Object cdr
= XCDR (prop
);
18013 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
18019 while (CONSP (cdr
))
18021 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
), font
, width_p
))
18024 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
18029 if (EQ (car
, Qminus
))
18031 return OK_PIXELS (pixels
);
18034 if (EQ (car
, Qleft_fringe
))
18035 return OK_PIXELS ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
18037 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
18039 if (EQ (car
, Qright_fringe
))
18040 return OK_PIXELS ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
18042 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
18044 if (EQ (car
, Qscroll_bar
))
18045 return OK_PIXELS ((WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
18046 == EQ (cdr
, Qleft
))
18047 ? WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
)
18050 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
18053 if (INTEGERP (car
) || FLOATP (car
))
18056 pixels
= XFLOATINT (car
);
18058 return OK_PIXELS (pixels
);
18059 if (calc_pixel_width_or_height (&fact
, it
, cdr
, font
, width_p
))
18060 return OK_PIXELS (pixels
* fact
);
18070 /* Produce a stretch glyph for iterator IT. IT->object is the value
18071 of the glyph property displayed. The value must be a list
18072 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
18075 1. `:width WIDTH' specifies that the space should be WIDTH *
18076 canonical char width wide. WIDTH may be an integer or floating
18079 2. `:relative-width FACTOR' specifies that the width of the stretch
18080 should be computed from the width of the first character having the
18081 `glyph' property, and should be FACTOR times that width.
18083 3. `:align-to HPOS' specifies that the space should be wide enough
18084 to reach HPOS, a value in canonical character units.
18086 Exactly one of the above pairs must be present.
18088 4. `:height HEIGHT' specifies that the height of the stretch produced
18089 should be HEIGHT, measured in canonical character units.
18091 5. `:relative-height FACTOR' specifies that the height of the
18092 stretch should be FACTOR times the height of the characters having
18093 the glyph property.
18095 Either none or exactly one of 4 or 5 must be present.
18097 6. `:ascent ASCENT' specifies that ASCENT percent of the height
18098 of the stretch should be used for the ascent of the stretch.
18099 ASCENT must be in the range 0 <= ASCENT <= 100. */
18102 produce_stretch_glyph (it
)
18105 /* (space :width WIDTH :height HEIGHT ...) */
18106 Lisp_Object prop
, plist
;
18107 int width
= 0, height
= 0;
18108 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
18111 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18112 XFontStruct
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
18114 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
18116 /* List should start with `space'. */
18117 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
18118 plist
= XCDR (it
->object
);
18120 /* Compute the width of the stretch. */
18121 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
18122 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1))
18124 /* Absolute width `:width WIDTH' specified and valid. */
18125 zero_width_ok_p
= 1;
18128 else if (prop
= Fplist_get (plist
, QCrelative_width
),
18131 /* Relative width `:relative-width FACTOR' specified and valid.
18132 Compute the width of the characters having the `glyph'
18135 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
18138 if (it
->multibyte_p
)
18140 int maxlen
= ((IT_BYTEPOS (*it
) >= GPT
? ZV
: GPT
)
18141 - IT_BYTEPOS (*it
));
18142 it2
.c
= STRING_CHAR_AND_LENGTH (p
, maxlen
, it2
.len
);
18145 it2
.c
= *p
, it2
.len
= 1;
18147 it2
.glyph_row
= NULL
;
18148 it2
.what
= IT_CHARACTER
;
18149 x_produce_glyphs (&it2
);
18150 width
= NUMVAL (prop
) * it2
.pixel_width
;
18152 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
18153 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1))
18155 width
= max (0, (int)tem
- it
->current_x
);
18156 zero_width_ok_p
= 1;
18159 /* Nothing specified -> width defaults to canonical char width. */
18160 width
= FRAME_COLUMN_WIDTH (it
->f
);
18162 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
18165 /* Compute height. */
18166 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
18167 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0))
18170 zero_height_ok_p
= 1;
18172 else if (prop
= Fplist_get (plist
, QCrelative_height
),
18174 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
18176 height
= FONT_HEIGHT (font
);
18178 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
18181 /* Compute percentage of height used for ascent. If
18182 `:ascent ASCENT' is present and valid, use that. Otherwise,
18183 derive the ascent from the font in use. */
18184 if (prop
= Fplist_get (plist
, QCascent
),
18185 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
18186 ascent
= height
* NUMVAL (prop
) / 100.0;
18187 else if (!NILP (prop
)
18188 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0))
18189 ascent
= min (max (0, (int)tem
), height
);
18191 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
18193 if (width
> 0 && height
> 0 && it
->glyph_row
)
18195 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
18196 if (!STRINGP (object
))
18197 object
= it
->w
->buffer
;
18198 append_stretch_glyph (it
, object
, width
, height
, ascent
);
18201 it
->pixel_width
= width
;
18202 it
->ascent
= it
->phys_ascent
= ascent
;
18203 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
18204 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
18206 if (width
> 0 && height
> 0 && face
->box
!= FACE_NO_BOX
)
18208 if (face
->box_line_width
> 0)
18210 it
->ascent
+= face
->box_line_width
;
18211 it
->descent
+= face
->box_line_width
;
18214 if (it
->start_of_box_run_p
)
18215 it
->pixel_width
+= abs (face
->box_line_width
);
18216 if (it
->end_of_box_run_p
)
18217 it
->pixel_width
+= abs (face
->box_line_width
);
18220 take_vertical_position_into_account (it
);
18224 Produce glyphs/get display metrics for the display element IT is
18225 loaded with. See the description of struct display_iterator in
18226 dispextern.h for an overview of struct display_iterator. */
18229 x_produce_glyphs (it
)
18232 it
->glyph_not_available_p
= 0;
18234 if (it
->what
== IT_CHARACTER
)
18238 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18240 int font_not_found_p
;
18241 struct font_info
*font_info
;
18242 int boff
; /* baseline offset */
18243 /* We may change it->multibyte_p upon unibyte<->multibyte
18244 conversion. So, save the current value now and restore it
18247 Note: It seems that we don't have to record multibyte_p in
18248 struct glyph because the character code itself tells if or
18249 not the character is multibyte. Thus, in the future, we must
18250 consider eliminating the field `multibyte_p' in the struct
18252 int saved_multibyte_p
= it
->multibyte_p
;
18254 /* Maybe translate single-byte characters to multibyte, or the
18256 it
->char_to_display
= it
->c
;
18257 if (!ASCII_BYTE_P (it
->c
))
18259 if (unibyte_display_via_language_environment
18260 && SINGLE_BYTE_CHAR_P (it
->c
)
18262 || !NILP (Vnonascii_translation_table
)))
18264 it
->char_to_display
= unibyte_char_to_multibyte (it
->c
);
18265 it
->multibyte_p
= 1;
18266 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
);
18267 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18269 else if (!SINGLE_BYTE_CHAR_P (it
->c
)
18270 && !it
->multibyte_p
)
18272 it
->multibyte_p
= 1;
18273 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
);
18274 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18278 /* Get font to use. Encode IT->char_to_display. */
18279 get_char_face_and_encoding (it
->f
, it
->char_to_display
, it
->face_id
,
18280 &char2b
, it
->multibyte_p
, 0);
18283 /* When no suitable font found, use the default font. */
18284 font_not_found_p
= font
== NULL
;
18285 if (font_not_found_p
)
18287 font
= FRAME_FONT (it
->f
);
18288 boff
= FRAME_BASELINE_OFFSET (it
->f
);
18293 font_info
= FONT_INFO_FROM_ID (it
->f
, face
->font_info_id
);
18294 boff
= font_info
->baseline_offset
;
18295 if (font_info
->vertical_centering
)
18296 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
18299 if (it
->char_to_display
>= ' '
18300 && (!it
->multibyte_p
|| it
->char_to_display
< 128))
18302 /* Either unibyte or ASCII. */
18307 pcm
= rif
->per_char_metric (font
, &char2b
,
18308 FONT_TYPE_FOR_UNIBYTE (font
, it
->char_to_display
));
18309 it
->ascent
= FONT_BASE (font
) + boff
;
18310 it
->descent
= FONT_DESCENT (font
) - boff
;
18314 it
->phys_ascent
= pcm
->ascent
+ boff
;
18315 it
->phys_descent
= pcm
->descent
- boff
;
18316 it
->pixel_width
= pcm
->width
;
18320 it
->glyph_not_available_p
= 1;
18321 it
->phys_ascent
= FONT_BASE (font
) + boff
;
18322 it
->phys_descent
= FONT_DESCENT (font
) - boff
;
18323 it
->pixel_width
= FONT_WIDTH (font
);
18326 /* If this is a space inside a region of text with
18327 `space-width' property, change its width. */
18328 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
18330 it
->pixel_width
*= XFLOATINT (it
->space_width
);
18332 /* If face has a box, add the box thickness to the character
18333 height. If character has a box line to the left and/or
18334 right, add the box line width to the character's width. */
18335 if (face
->box
!= FACE_NO_BOX
)
18337 int thick
= face
->box_line_width
;
18341 it
->ascent
+= thick
;
18342 it
->descent
+= thick
;
18347 if (it
->start_of_box_run_p
)
18348 it
->pixel_width
+= thick
;
18349 if (it
->end_of_box_run_p
)
18350 it
->pixel_width
+= thick
;
18353 /* If face has an overline, add the height of the overline
18354 (1 pixel) and a 1 pixel margin to the character height. */
18355 if (face
->overline_p
)
18358 take_vertical_position_into_account (it
);
18360 /* If we have to actually produce glyphs, do it. */
18365 /* Translate a space with a `space-width' property
18366 into a stretch glyph. */
18367 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
18368 / FONT_HEIGHT (font
));
18369 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
18370 it
->ascent
+ it
->descent
, ascent
);
18375 /* If characters with lbearing or rbearing are displayed
18376 in this line, record that fact in a flag of the
18377 glyph row. This is used to optimize X output code. */
18378 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
18379 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
18382 else if (it
->char_to_display
== '\n')
18384 /* A newline has no width but we need the height of the line. */
18385 it
->pixel_width
= 0;
18387 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
18388 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
18390 if (face
->box
!= FACE_NO_BOX
18391 && face
->box_line_width
> 0)
18393 it
->ascent
+= face
->box_line_width
;
18394 it
->descent
+= face
->box_line_width
;
18397 else if (it
->char_to_display
== '\t')
18399 int tab_width
= it
->tab_width
* FRAME_COLUMN_WIDTH (it
->f
);
18400 int x
= it
->current_x
+ it
->continuation_lines_width
;
18401 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
18403 /* If the distance from the current position to the next tab
18404 stop is less than a canonical character width, use the
18405 tab stop after that. */
18406 if (next_tab_x
- x
< FRAME_COLUMN_WIDTH (it
->f
))
18407 next_tab_x
+= tab_width
;
18409 it
->pixel_width
= next_tab_x
- x
;
18411 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
18412 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
18416 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
18417 it
->ascent
+ it
->descent
, it
->ascent
);
18422 /* A multi-byte character. Assume that the display width of the
18423 character is the width of the character multiplied by the
18424 width of the font. */
18426 /* If we found a font, this font should give us the right
18427 metrics. If we didn't find a font, use the frame's
18428 default font and calculate the width of the character
18429 from the charset width; this is what old redisplay code
18432 pcm
= rif
->per_char_metric (font
, &char2b
,
18433 FONT_TYPE_FOR_MULTIBYTE (font
, it
->c
));
18435 if (font_not_found_p
|| !pcm
)
18437 int charset
= CHAR_CHARSET (it
->char_to_display
);
18439 it
->glyph_not_available_p
= 1;
18440 it
->pixel_width
= (FRAME_COLUMN_WIDTH (it
->f
)
18441 * CHARSET_WIDTH (charset
));
18442 it
->phys_ascent
= FONT_BASE (font
) + boff
;
18443 it
->phys_descent
= FONT_DESCENT (font
) - boff
;
18447 it
->pixel_width
= pcm
->width
;
18448 it
->phys_ascent
= pcm
->ascent
+ boff
;
18449 it
->phys_descent
= pcm
->descent
- boff
;
18451 && (pcm
->lbearing
< 0
18452 || pcm
->rbearing
> pcm
->width
))
18453 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
18456 it
->ascent
= FONT_BASE (font
) + boff
;
18457 it
->descent
= FONT_DESCENT (font
) - boff
;
18458 if (face
->box
!= FACE_NO_BOX
)
18460 int thick
= face
->box_line_width
;
18464 it
->ascent
+= thick
;
18465 it
->descent
+= thick
;
18470 if (it
->start_of_box_run_p
)
18471 it
->pixel_width
+= thick
;
18472 if (it
->end_of_box_run_p
)
18473 it
->pixel_width
+= thick
;
18476 /* If face has an overline, add the height of the overline
18477 (1 pixel) and a 1 pixel margin to the character height. */
18478 if (face
->overline_p
)
18481 take_vertical_position_into_account (it
);
18486 it
->multibyte_p
= saved_multibyte_p
;
18488 else if (it
->what
== IT_COMPOSITION
)
18490 /* Note: A composition is represented as one glyph in the
18491 glyph matrix. There are no padding glyphs. */
18494 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18496 int font_not_found_p
;
18497 struct font_info
*font_info
;
18498 int boff
; /* baseline offset */
18499 struct composition
*cmp
= composition_table
[it
->cmp_id
];
18501 /* Maybe translate single-byte characters to multibyte. */
18502 it
->char_to_display
= it
->c
;
18503 if (unibyte_display_via_language_environment
18504 && SINGLE_BYTE_CHAR_P (it
->c
)
18507 && !NILP (Vnonascii_translation_table
))))
18509 it
->char_to_display
= unibyte_char_to_multibyte (it
->c
);
18512 /* Get face and font to use. Encode IT->char_to_display. */
18513 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
);
18514 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18515 get_char_face_and_encoding (it
->f
, it
->char_to_display
, it
->face_id
,
18516 &char2b
, it
->multibyte_p
, 0);
18519 /* When no suitable font found, use the default font. */
18520 font_not_found_p
= font
== NULL
;
18521 if (font_not_found_p
)
18523 font
= FRAME_FONT (it
->f
);
18524 boff
= FRAME_BASELINE_OFFSET (it
->f
);
18529 font_info
= FONT_INFO_FROM_ID (it
->f
, face
->font_info_id
);
18530 boff
= font_info
->baseline_offset
;
18531 if (font_info
->vertical_centering
)
18532 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
18535 /* There are no padding glyphs, so there is only one glyph to
18536 produce for the composition. Important is that pixel_width,
18537 ascent and descent are the values of what is drawn by
18538 draw_glyphs (i.e. the values of the overall glyphs composed). */
18541 /* If we have not yet calculated pixel size data of glyphs of
18542 the composition for the current face font, calculate them
18543 now. Theoretically, we have to check all fonts for the
18544 glyphs, but that requires much time and memory space. So,
18545 here we check only the font of the first glyph. This leads
18546 to incorrect display very rarely, and C-l (recenter) can
18547 correct the display anyway. */
18548 if (cmp
->font
!= (void *) font
)
18550 /* Ascent and descent of the font of the first character of
18551 this composition (adjusted by baseline offset). Ascent
18552 and descent of overall glyphs should not be less than
18553 them respectively. */
18554 int font_ascent
= FONT_BASE (font
) + boff
;
18555 int font_descent
= FONT_DESCENT (font
) - boff
;
18556 /* Bounding box of the overall glyphs. */
18557 int leftmost
, rightmost
, lowest
, highest
;
18558 int i
, width
, ascent
, descent
;
18560 cmp
->font
= (void *) font
;
18562 /* Initialize the bounding box. */
18564 && (pcm
= rif
->per_char_metric (font
, &char2b
,
18565 FONT_TYPE_FOR_MULTIBYTE (font
, it
->c
))))
18567 width
= pcm
->width
;
18568 ascent
= pcm
->ascent
;
18569 descent
= pcm
->descent
;
18573 width
= FONT_WIDTH (font
);
18574 ascent
= FONT_BASE (font
);
18575 descent
= FONT_DESCENT (font
);
18579 lowest
= - descent
+ boff
;
18580 highest
= ascent
+ boff
;
18584 && font_info
->default_ascent
18585 && CHAR_TABLE_P (Vuse_default_ascent
)
18586 && !NILP (Faref (Vuse_default_ascent
,
18587 make_number (it
->char_to_display
))))
18588 highest
= font_info
->default_ascent
+ boff
;
18590 /* Draw the first glyph at the normal position. It may be
18591 shifted to right later if some other glyphs are drawn at
18593 cmp
->offsets
[0] = 0;
18594 cmp
->offsets
[1] = boff
;
18596 /* Set cmp->offsets for the remaining glyphs. */
18597 for (i
= 1; i
< cmp
->glyph_len
; i
++)
18599 int left
, right
, btm
, top
;
18600 int ch
= COMPOSITION_GLYPH (cmp
, i
);
18601 int face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
);
18603 face
= FACE_FROM_ID (it
->f
, face_id
);
18604 get_char_face_and_encoding (it
->f
, ch
, face
->id
,
18605 &char2b
, it
->multibyte_p
, 0);
18609 font
= FRAME_FONT (it
->f
);
18610 boff
= FRAME_BASELINE_OFFSET (it
->f
);
18616 = FONT_INFO_FROM_ID (it
->f
, face
->font_info_id
);
18617 boff
= font_info
->baseline_offset
;
18618 if (font_info
->vertical_centering
)
18619 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
18623 && (pcm
= rif
->per_char_metric (font
, &char2b
,
18624 FONT_TYPE_FOR_MULTIBYTE (font
, ch
))))
18626 width
= pcm
->width
;
18627 ascent
= pcm
->ascent
;
18628 descent
= pcm
->descent
;
18632 width
= FONT_WIDTH (font
);
18637 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
18639 /* Relative composition with or without
18640 alternate chars. */
18641 left
= (leftmost
+ rightmost
- width
) / 2;
18642 btm
= - descent
+ boff
;
18643 if (font_info
&& font_info
->relative_compose
18644 && (! CHAR_TABLE_P (Vignore_relative_composition
)
18645 || NILP (Faref (Vignore_relative_composition
,
18646 make_number (ch
)))))
18649 if (- descent
>= font_info
->relative_compose
)
18650 /* One extra pixel between two glyphs. */
18652 else if (ascent
<= 0)
18653 /* One extra pixel between two glyphs. */
18654 btm
= lowest
- 1 - ascent
- descent
;
18659 /* A composition rule is specified by an integer
18660 value that encodes global and new reference
18661 points (GREF and NREF). GREF and NREF are
18662 specified by numbers as below:
18664 0---1---2 -- ascent
18668 9--10--11 -- center
18670 ---3---4---5--- baseline
18672 6---7---8 -- descent
18674 int rule
= COMPOSITION_RULE (cmp
, i
);
18675 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
;
18677 COMPOSITION_DECODE_RULE (rule
, gref
, nref
);
18678 grefx
= gref
% 3, nrefx
= nref
% 3;
18679 grefy
= gref
/ 3, nrefy
= nref
/ 3;
18682 + grefx
* (rightmost
- leftmost
) / 2
18683 - nrefx
* width
/ 2);
18684 btm
= ((grefy
== 0 ? highest
18686 : grefy
== 2 ? lowest
18687 : (highest
+ lowest
) / 2)
18688 - (nrefy
== 0 ? ascent
+ descent
18689 : nrefy
== 1 ? descent
- boff
18691 : (ascent
+ descent
) / 2));
18694 cmp
->offsets
[i
* 2] = left
;
18695 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
18697 /* Update the bounding box of the overall glyphs. */
18698 right
= left
+ width
;
18699 top
= btm
+ descent
+ ascent
;
18700 if (left
< leftmost
)
18702 if (right
> rightmost
)
18710 /* If there are glyphs whose x-offsets are negative,
18711 shift all glyphs to the right and make all x-offsets
18715 for (i
= 0; i
< cmp
->glyph_len
; i
++)
18716 cmp
->offsets
[i
* 2] -= leftmost
;
18717 rightmost
-= leftmost
;
18720 cmp
->pixel_width
= rightmost
;
18721 cmp
->ascent
= highest
;
18722 cmp
->descent
= - lowest
;
18723 if (cmp
->ascent
< font_ascent
)
18724 cmp
->ascent
= font_ascent
;
18725 if (cmp
->descent
< font_descent
)
18726 cmp
->descent
= font_descent
;
18729 it
->pixel_width
= cmp
->pixel_width
;
18730 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
18731 it
->descent
= it
->phys_descent
= cmp
->descent
;
18733 if (face
->box
!= FACE_NO_BOX
)
18735 int thick
= face
->box_line_width
;
18739 it
->ascent
+= thick
;
18740 it
->descent
+= thick
;
18745 if (it
->start_of_box_run_p
)
18746 it
->pixel_width
+= thick
;
18747 if (it
->end_of_box_run_p
)
18748 it
->pixel_width
+= thick
;
18751 /* If face has an overline, add the height of the overline
18752 (1 pixel) and a 1 pixel margin to the character height. */
18753 if (face
->overline_p
)
18756 take_vertical_position_into_account (it
);
18759 append_composite_glyph (it
);
18761 else if (it
->what
== IT_IMAGE
)
18762 produce_image_glyph (it
);
18763 else if (it
->what
== IT_STRETCH
)
18764 produce_stretch_glyph (it
);
18766 /* Accumulate dimensions. Note: can't assume that it->descent > 0
18767 because this isn't true for images with `:ascent 100'. */
18768 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
18769 if (it
->area
== TEXT_AREA
)
18770 it
->current_x
+= it
->pixel_width
;
18772 it
->descent
+= it
->extra_line_spacing
;
18774 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
18775 it
->max_descent
= max (it
->max_descent
, it
->descent
);
18776 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
18777 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
18781 Output LEN glyphs starting at START at the nominal cursor position.
18782 Advance the nominal cursor over the text. The global variable
18783 updated_window contains the window being updated, updated_row is
18784 the glyph row being updated, and updated_area is the area of that
18785 row being updated. */
18788 x_write_glyphs (start
, len
)
18789 struct glyph
*start
;
18794 xassert (updated_window
&& updated_row
);
18797 /* Write glyphs. */
18799 hpos
= start
- updated_row
->glyphs
[updated_area
];
18800 x
= draw_glyphs (updated_window
, output_cursor
.x
,
18801 updated_row
, updated_area
,
18803 DRAW_NORMAL_TEXT
, 0);
18805 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
18806 if (updated_area
== TEXT_AREA
18807 && updated_window
->phys_cursor_on_p
18808 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
18809 && updated_window
->phys_cursor
.hpos
>= hpos
18810 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
18811 updated_window
->phys_cursor_on_p
= 0;
18815 /* Advance the output cursor. */
18816 output_cursor
.hpos
+= len
;
18817 output_cursor
.x
= x
;
18822 Insert LEN glyphs from START at the nominal cursor position. */
18825 x_insert_glyphs (start
, len
)
18826 struct glyph
*start
;
18831 int line_height
, shift_by_width
, shifted_region_width
;
18832 struct glyph_row
*row
;
18833 struct glyph
*glyph
;
18834 int frame_x
, frame_y
, hpos
;
18836 xassert (updated_window
&& updated_row
);
18838 w
= updated_window
;
18839 f
= XFRAME (WINDOW_FRAME (w
));
18841 /* Get the height of the line we are in. */
18843 line_height
= row
->height
;
18845 /* Get the width of the glyphs to insert. */
18846 shift_by_width
= 0;
18847 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
18848 shift_by_width
+= glyph
->pixel_width
;
18850 /* Get the width of the region to shift right. */
18851 shifted_region_width
= (window_box_width (w
, updated_area
)
18856 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
18857 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
18859 rif
->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
18860 line_height
, shift_by_width
);
18862 /* Write the glyphs. */
18863 hpos
= start
- row
->glyphs
[updated_area
];
18864 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
18866 DRAW_NORMAL_TEXT
, 0);
18868 /* Advance the output cursor. */
18869 output_cursor
.hpos
+= len
;
18870 output_cursor
.x
+= shift_by_width
;
18876 Erase the current text line from the nominal cursor position
18877 (inclusive) to pixel column TO_X (exclusive). The idea is that
18878 everything from TO_X onward is already erased.
18880 TO_X is a pixel position relative to updated_area of
18881 updated_window. TO_X == -1 means clear to the end of this area. */
18884 x_clear_end_of_line (to_x
)
18888 struct window
*w
= updated_window
;
18889 int max_x
, min_y
, max_y
;
18890 int from_x
, from_y
, to_y
;
18892 xassert (updated_window
&& updated_row
);
18893 f
= XFRAME (w
->frame
);
18895 if (updated_row
->full_width_p
)
18896 max_x
= WINDOW_TOTAL_WIDTH (w
);
18898 max_x
= window_box_width (w
, updated_area
);
18899 max_y
= window_text_bottom_y (w
);
18901 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
18902 of window. For TO_X > 0, truncate to end of drawing area. */
18908 to_x
= min (to_x
, max_x
);
18910 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
18912 /* Notice if the cursor will be cleared by this operation. */
18913 if (!updated_row
->full_width_p
)
18914 notice_overwritten_cursor (w
, updated_area
,
18915 output_cursor
.x
, -1,
18917 MATRIX_ROW_BOTTOM_Y (updated_row
));
18919 from_x
= output_cursor
.x
;
18921 /* Translate to frame coordinates. */
18922 if (updated_row
->full_width_p
)
18924 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
18925 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
18929 int area_left
= window_box_left (w
, updated_area
);
18930 from_x
+= area_left
;
18934 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
18935 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
18936 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
18938 /* Prevent inadvertently clearing to end of the X window. */
18939 if (to_x
> from_x
&& to_y
> from_y
)
18942 rif
->clear_frame_area (f
, from_x
, from_y
,
18943 to_x
- from_x
, to_y
- from_y
);
18948 #endif /* HAVE_WINDOW_SYSTEM */
18952 /***********************************************************************
18954 ***********************************************************************/
18956 /* Value is the internal representation of the specified cursor type
18957 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
18958 of the bar cursor. */
18960 static enum text_cursor_kinds
18961 get_specified_cursor_type (arg
, width
)
18965 enum text_cursor_kinds type
;
18970 if (EQ (arg
, Qbox
))
18971 return FILLED_BOX_CURSOR
;
18973 if (EQ (arg
, Qhollow
))
18974 return HOLLOW_BOX_CURSOR
;
18976 if (EQ (arg
, Qbar
))
18983 && EQ (XCAR (arg
), Qbar
)
18984 && INTEGERP (XCDR (arg
))
18985 && XINT (XCDR (arg
)) >= 0)
18987 *width
= XINT (XCDR (arg
));
18991 if (EQ (arg
, Qhbar
))
18994 return HBAR_CURSOR
;
18998 && EQ (XCAR (arg
), Qhbar
)
18999 && INTEGERP (XCDR (arg
))
19000 && XINT (XCDR (arg
)) >= 0)
19002 *width
= XINT (XCDR (arg
));
19003 return HBAR_CURSOR
;
19006 /* Treat anything unknown as "hollow box cursor".
19007 It was bad to signal an error; people have trouble fixing
19008 .Xdefaults with Emacs, when it has something bad in it. */
19009 type
= HOLLOW_BOX_CURSOR
;
19014 /* Set the default cursor types for specified frame. */
19016 set_frame_cursor_types (f
, arg
)
19023 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
19024 FRAME_CURSOR_WIDTH (f
) = width
;
19026 /* By default, set up the blink-off state depending on the on-state. */
19028 tem
= Fassoc (arg
, Vblink_cursor_alist
);
19031 FRAME_BLINK_OFF_CURSOR (f
)
19032 = get_specified_cursor_type (XCDR (tem
), &width
);
19033 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
19036 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
19040 /* Return the cursor we want to be displayed in window W. Return
19041 width of bar/hbar cursor through WIDTH arg. Return with
19042 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
19043 (i.e. if the `system caret' should track this cursor).
19045 In a mini-buffer window, we want the cursor only to appear if we
19046 are reading input from this window. For the selected window, we
19047 want the cursor type given by the frame parameter or buffer local
19048 setting of cursor-type. If explicitly marked off, draw no cursor.
19049 In all other cases, we want a hollow box cursor. */
19051 static enum text_cursor_kinds
19052 get_window_cursor_type (w
, glyph
, width
, active_cursor
)
19054 struct glyph
*glyph
;
19056 int *active_cursor
;
19058 struct frame
*f
= XFRAME (w
->frame
);
19059 struct buffer
*b
= XBUFFER (w
->buffer
);
19060 int cursor_type
= DEFAULT_CURSOR
;
19061 Lisp_Object alt_cursor
;
19062 int non_selected
= 0;
19064 *active_cursor
= 1;
19067 if (cursor_in_echo_area
19068 && FRAME_HAS_MINIBUF_P (f
)
19069 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
19071 if (w
== XWINDOW (echo_area_window
))
19073 *width
= FRAME_CURSOR_WIDTH (f
);
19074 return FRAME_DESIRED_CURSOR (f
);
19077 *active_cursor
= 0;
19081 /* Nonselected window or nonselected frame. */
19082 else if (w
!= XWINDOW (f
->selected_window
)
19083 #ifdef HAVE_WINDOW_SYSTEM
19084 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
19088 *active_cursor
= 0;
19090 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
19096 /* Never display a cursor in a window in which cursor-type is nil. */
19097 if (NILP (b
->cursor_type
))
19100 /* Use cursor-in-non-selected-windows for non-selected window or frame. */
19103 alt_cursor
= Fbuffer_local_value (Qcursor_in_non_selected_windows
, w
->buffer
);
19104 return get_specified_cursor_type (alt_cursor
, width
);
19107 /* Get the normal cursor type for this window. */
19108 if (EQ (b
->cursor_type
, Qt
))
19110 cursor_type
= FRAME_DESIRED_CURSOR (f
);
19111 *width
= FRAME_CURSOR_WIDTH (f
);
19114 cursor_type
= get_specified_cursor_type (b
->cursor_type
, width
);
19116 /* Use normal cursor if not blinked off. */
19117 if (!w
->cursor_off_p
)
19119 if (glyph
->type
== IMAGE_GLYPH
) {
19120 if (cursor_type
== FILLED_BOX_CURSOR
)
19121 cursor_type
= HOLLOW_BOX_CURSOR
;
19123 return cursor_type
;
19126 /* Cursor is blinked off, so determine how to "toggle" it. */
19128 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
19129 if ((alt_cursor
= Fassoc (b
->cursor_type
, Vblink_cursor_alist
), !NILP (alt_cursor
)))
19130 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
19132 /* Then see if frame has specified a specific blink off cursor type. */
19133 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
19135 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
19136 return FRAME_BLINK_OFF_CURSOR (f
);
19140 /* Some people liked having a permanently visible blinking cursor,
19141 while others had very strong opinions against it. So it was
19142 decided to remove it. KFS 2003-09-03 */
19144 /* Finally perform built-in cursor blinking:
19145 filled box <-> hollow box
19146 wide [h]bar <-> narrow [h]bar
19147 narrow [h]bar <-> no cursor
19148 other type <-> no cursor */
19150 if (cursor_type
== FILLED_BOX_CURSOR
)
19151 return HOLLOW_BOX_CURSOR
;
19153 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
19156 return cursor_type
;
19164 #ifdef HAVE_WINDOW_SYSTEM
19166 /* Notice when the text cursor of window W has been completely
19167 overwritten by a drawing operation that outputs glyphs in AREA
19168 starting at X0 and ending at X1 in the line starting at Y0 and
19169 ending at Y1. X coordinates are area-relative. X1 < 0 means all
19170 the rest of the line after X0 has been written. Y coordinates
19171 are window-relative. */
19174 notice_overwritten_cursor (w
, area
, x0
, x1
, y0
, y1
)
19176 enum glyph_row_area area
;
19177 int x0
, y0
, x1
, y1
;
19179 if (area
== TEXT_AREA
&& w
->phys_cursor_on_p
)
19181 int cx0
= w
->phys_cursor
.x
;
19182 int cx1
= cx0
+ w
->phys_cursor_width
;
19183 int cy0
= w
->phys_cursor
.y
;
19184 int cy1
= cy0
+ w
->phys_cursor_height
;
19186 if (x0
<= cx0
&& (x1
< 0 || x1
>= cx1
))
19188 /* The cursor image will be completely removed from the
19189 screen if the output area intersects the cursor area in
19190 y-direction. When we draw in [y0 y1[, and some part of
19191 the cursor is at y < y0, that part must have been drawn
19192 before. When scrolling, the cursor is erased before
19193 actually scrolling, so we don't come here. When not
19194 scrolling, the rows above the old cursor row must have
19195 changed, and in this case these rows must have written
19196 over the cursor image.
19198 Likewise if part of the cursor is below y1, with the
19199 exception of the cursor being in the first blank row at
19200 the buffer and window end because update_text_area
19201 doesn't draw that row. (Except when it does, but
19202 that's handled in update_text_area.) */
19204 if (((y0
>= cy0
&& y0
< cy1
) || (y1
> cy0
&& y1
< cy1
))
19205 && w
->current_matrix
->rows
[w
->phys_cursor
.vpos
].displays_text_p
)
19206 w
->phys_cursor_on_p
= 0;
19211 #endif /* HAVE_WINDOW_SYSTEM */
19214 /************************************************************************
19216 ************************************************************************/
19218 #ifdef HAVE_WINDOW_SYSTEM
19221 Fix the display of area AREA of overlapping row ROW in window W. */
19224 x_fix_overlapping_area (w
, row
, area
)
19226 struct glyph_row
*row
;
19227 enum glyph_row_area area
;
19234 for (i
= 0; i
< row
->used
[area
];)
19236 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
19238 int start
= i
, start_x
= x
;
19242 x
+= row
->glyphs
[area
][i
].pixel_width
;
19245 while (i
< row
->used
[area
]
19246 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
19248 draw_glyphs (w
, start_x
, row
, area
,
19250 DRAW_NORMAL_TEXT
, 1);
19254 x
+= row
->glyphs
[area
][i
].pixel_width
;
19264 Draw the cursor glyph of window W in glyph row ROW. See the
19265 comment of draw_glyphs for the meaning of HL. */
19268 draw_phys_cursor_glyph (w
, row
, hl
)
19270 struct glyph_row
*row
;
19271 enum draw_glyphs_face hl
;
19273 /* If cursor hpos is out of bounds, don't draw garbage. This can
19274 happen in mini-buffer windows when switching between echo area
19275 glyphs and mini-buffer. */
19276 if (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])
19278 int on_p
= w
->phys_cursor_on_p
;
19280 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
19281 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
19283 w
->phys_cursor_on_p
= on_p
;
19285 if (hl
== DRAW_CURSOR
)
19286 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
19287 /* When we erase the cursor, and ROW is overlapped by other
19288 rows, make sure that these overlapping parts of other rows
19290 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
19292 if (row
> w
->current_matrix
->rows
19293 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
19294 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
);
19296 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
19297 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
19298 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
);
19305 Erase the image of a cursor of window W from the screen. */
19308 erase_phys_cursor (w
)
19311 struct frame
*f
= XFRAME (w
->frame
);
19312 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
19313 int hpos
= w
->phys_cursor
.hpos
;
19314 int vpos
= w
->phys_cursor
.vpos
;
19315 int mouse_face_here_p
= 0;
19316 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
19317 struct glyph_row
*cursor_row
;
19318 struct glyph
*cursor_glyph
;
19319 enum draw_glyphs_face hl
;
19321 /* No cursor displayed or row invalidated => nothing to do on the
19323 if (w
->phys_cursor_type
== NO_CURSOR
)
19324 goto mark_cursor_off
;
19326 /* VPOS >= active_glyphs->nrows means that window has been resized.
19327 Don't bother to erase the cursor. */
19328 if (vpos
>= active_glyphs
->nrows
)
19329 goto mark_cursor_off
;
19331 /* If row containing cursor is marked invalid, there is nothing we
19333 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
19334 if (!cursor_row
->enabled_p
)
19335 goto mark_cursor_off
;
19337 /* If row is completely invisible, don't attempt to delete a cursor which
19338 isn't there. This can happen if cursor is at top of a window, and
19339 we switch to a buffer with a header line in that window. */
19340 if (cursor_row
->visible_height
<= 0)
19341 goto mark_cursor_off
;
19343 /* This can happen when the new row is shorter than the old one.
19344 In this case, either draw_glyphs or clear_end_of_line
19345 should have cleared the cursor. Note that we wouldn't be
19346 able to erase the cursor in this case because we don't have a
19347 cursor glyph at hand. */
19348 if (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])
19349 goto mark_cursor_off
;
19351 /* If the cursor is in the mouse face area, redisplay that when
19352 we clear the cursor. */
19353 if (! NILP (dpyinfo
->mouse_face_window
)
19354 && w
== XWINDOW (dpyinfo
->mouse_face_window
)
19355 && (vpos
> dpyinfo
->mouse_face_beg_row
19356 || (vpos
== dpyinfo
->mouse_face_beg_row
19357 && hpos
>= dpyinfo
->mouse_face_beg_col
))
19358 && (vpos
< dpyinfo
->mouse_face_end_row
19359 || (vpos
== dpyinfo
->mouse_face_end_row
19360 && hpos
< dpyinfo
->mouse_face_end_col
))
19361 /* Don't redraw the cursor's spot in mouse face if it is at the
19362 end of a line (on a newline). The cursor appears there, but
19363 mouse highlighting does not. */
19364 && cursor_row
->used
[TEXT_AREA
] > hpos
)
19365 mouse_face_here_p
= 1;
19367 /* Maybe clear the display under the cursor. */
19368 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
19371 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
19373 cursor_glyph
= get_phys_cursor_glyph (w
);
19374 if (cursor_glyph
== NULL
)
19375 goto mark_cursor_off
;
19377 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, w
->phys_cursor
.x
);
19378 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
19380 rif
->clear_frame_area (f
, x
, y
,
19381 cursor_glyph
->pixel_width
, cursor_row
->visible_height
);
19384 /* Erase the cursor by redrawing the character underneath it. */
19385 if (mouse_face_here_p
)
19386 hl
= DRAW_MOUSE_FACE
;
19388 hl
= DRAW_NORMAL_TEXT
;
19389 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
19392 w
->phys_cursor_on_p
= 0;
19393 w
->phys_cursor_type
= NO_CURSOR
;
19398 Display or clear cursor of window W. If ON is zero, clear the
19399 cursor. If it is non-zero, display the cursor. If ON is nonzero,
19400 where to put the cursor is specified by HPOS, VPOS, X and Y. */
19403 display_and_set_cursor (w
, on
, hpos
, vpos
, x
, y
)
19405 int on
, hpos
, vpos
, x
, y
;
19407 struct frame
*f
= XFRAME (w
->frame
);
19408 int new_cursor_type
;
19409 int new_cursor_width
;
19411 struct glyph_matrix
*current_glyphs
;
19412 struct glyph_row
*glyph_row
;
19413 struct glyph
*glyph
;
19415 /* This is pointless on invisible frames, and dangerous on garbaged
19416 windows and frames; in the latter case, the frame or window may
19417 be in the midst of changing its size, and x and y may be off the
19419 if (! FRAME_VISIBLE_P (f
)
19420 || FRAME_GARBAGED_P (f
)
19421 || vpos
>= w
->current_matrix
->nrows
19422 || hpos
>= w
->current_matrix
->matrix_w
)
19425 /* If cursor is off and we want it off, return quickly. */
19426 if (!on
&& !w
->phys_cursor_on_p
)
19429 current_glyphs
= w
->current_matrix
;
19430 glyph_row
= MATRIX_ROW (current_glyphs
, vpos
);
19431 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
19433 /* If cursor row is not enabled, we don't really know where to
19434 display the cursor. */
19435 if (!glyph_row
->enabled_p
)
19437 w
->phys_cursor_on_p
= 0;
19441 xassert (interrupt_input_blocked
);
19443 /* Set new_cursor_type to the cursor we want to be displayed. */
19444 new_cursor_type
= get_window_cursor_type (w
, glyph
,
19445 &new_cursor_width
, &active_cursor
);
19447 /* If cursor is currently being shown and we don't want it to be or
19448 it is in the wrong place, or the cursor type is not what we want,
19450 if (w
->phys_cursor_on_p
19452 || w
->phys_cursor
.x
!= x
19453 || w
->phys_cursor
.y
!= y
19454 || new_cursor_type
!= w
->phys_cursor_type
19455 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
19456 && new_cursor_width
!= w
->phys_cursor_width
)))
19457 erase_phys_cursor (w
);
19459 /* Don't check phys_cursor_on_p here because that flag is only set
19460 to zero in some cases where we know that the cursor has been
19461 completely erased, to avoid the extra work of erasing the cursor
19462 twice. In other words, phys_cursor_on_p can be 1 and the cursor
19463 still not be visible, or it has only been partly erased. */
19466 w
->phys_cursor_ascent
= glyph_row
->ascent
;
19467 w
->phys_cursor_height
= glyph_row
->height
;
19469 /* Set phys_cursor_.* before x_draw_.* is called because some
19470 of them may need the information. */
19471 w
->phys_cursor
.x
= x
;
19472 w
->phys_cursor
.y
= glyph_row
->y
;
19473 w
->phys_cursor
.hpos
= hpos
;
19474 w
->phys_cursor
.vpos
= vpos
;
19477 rif
->draw_window_cursor (w
, glyph_row
, x
, y
,
19478 new_cursor_type
, new_cursor_width
,
19479 on
, active_cursor
);
19483 /* Switch the display of W's cursor on or off, according to the value
19487 update_window_cursor (w
, on
)
19491 /* Don't update cursor in windows whose frame is in the process
19492 of being deleted. */
19493 if (w
->current_matrix
)
19496 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
19497 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
19503 /* Call update_window_cursor with parameter ON_P on all leaf windows
19504 in the window tree rooted at W. */
19507 update_cursor_in_window_tree (w
, on_p
)
19513 if (!NILP (w
->hchild
))
19514 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
19515 else if (!NILP (w
->vchild
))
19516 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
19518 update_window_cursor (w
, on_p
);
19520 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
19526 Display the cursor on window W, or clear it, according to ON_P.
19527 Don't change the cursor's position. */
19530 x_update_cursor (f
, on_p
)
19534 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
19539 Clear the cursor of window W to background color, and mark the
19540 cursor as not shown. This is used when the text where the cursor
19541 is is about to be rewritten. */
19547 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
19548 update_window_cursor (w
, 0);
19553 Display the active region described by mouse_face_* according to DRAW. */
19556 show_mouse_face (dpyinfo
, draw
)
19557 Display_Info
*dpyinfo
;
19558 enum draw_glyphs_face draw
;
19560 struct window
*w
= XWINDOW (dpyinfo
->mouse_face_window
);
19561 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19563 if (/* If window is in the process of being destroyed, don't bother
19565 w
->current_matrix
!= NULL
19566 /* Don't update mouse highlight if hidden */
19567 && (draw
!= DRAW_MOUSE_FACE
|| !dpyinfo
->mouse_face_hidden
)
19568 /* Recognize when we are called to operate on rows that don't exist
19569 anymore. This can happen when a window is split. */
19570 && dpyinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
19572 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
19573 struct glyph_row
*row
, *first
, *last
;
19575 first
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
19576 last
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
19578 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
19580 int start_hpos
, end_hpos
, start_x
;
19582 /* For all but the first row, the highlight starts at column 0. */
19585 start_hpos
= dpyinfo
->mouse_face_beg_col
;
19586 start_x
= dpyinfo
->mouse_face_beg_x
;
19595 end_hpos
= dpyinfo
->mouse_face_end_col
;
19597 end_hpos
= row
->used
[TEXT_AREA
];
19599 if (end_hpos
> start_hpos
)
19601 draw_glyphs (w
, start_x
, row
, TEXT_AREA
,
19602 start_hpos
, end_hpos
,
19606 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
19610 /* When we've written over the cursor, arrange for it to
19611 be displayed again. */
19612 if (phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
19615 display_and_set_cursor (w
, 1,
19616 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
19617 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
19622 /* Change the mouse cursor. */
19623 if (draw
== DRAW_NORMAL_TEXT
)
19624 rif
->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
19625 else if (draw
== DRAW_MOUSE_FACE
)
19626 rif
->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
19628 rif
->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
19632 Clear out the mouse-highlighted active region.
19633 Redraw it un-highlighted first. Value is non-zero if mouse
19634 face was actually drawn unhighlighted. */
19637 clear_mouse_face (dpyinfo
)
19638 Display_Info
*dpyinfo
;
19642 if (!NILP (dpyinfo
->mouse_face_window
))
19644 show_mouse_face (dpyinfo
, DRAW_NORMAL_TEXT
);
19648 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
19649 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
19650 dpyinfo
->mouse_face_window
= Qnil
;
19651 dpyinfo
->mouse_face_overlay
= Qnil
;
19657 Non-zero if physical cursor of window W is within mouse face. */
19660 cursor_in_mouse_face_p (w
)
19663 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
19664 int in_mouse_face
= 0;
19666 if (WINDOWP (dpyinfo
->mouse_face_window
)
19667 && XWINDOW (dpyinfo
->mouse_face_window
) == w
)
19669 int hpos
= w
->phys_cursor
.hpos
;
19670 int vpos
= w
->phys_cursor
.vpos
;
19672 if (vpos
>= dpyinfo
->mouse_face_beg_row
19673 && vpos
<= dpyinfo
->mouse_face_end_row
19674 && (vpos
> dpyinfo
->mouse_face_beg_row
19675 || hpos
>= dpyinfo
->mouse_face_beg_col
)
19676 && (vpos
< dpyinfo
->mouse_face_end_row
19677 || hpos
< dpyinfo
->mouse_face_end_col
19678 || dpyinfo
->mouse_face_past_end
))
19682 return in_mouse_face
;
19688 /* Find the glyph matrix position of buffer position CHARPOS in window
19689 *W. HPOS, *VPOS, *X, and *Y are set to the positions found. W's
19690 current glyphs must be up to date. If CHARPOS is above window
19691 start return (0, 0, 0, 0). If CHARPOS is after end of W, return end
19692 of last line in W. In the row containing CHARPOS, stop before glyphs
19693 having STOP as object. */
19695 #if 1 /* This is a version of fast_find_position that's more correct
19696 in the presence of hscrolling, for example. I didn't install
19697 it right away because the problem fixed is minor, it failed
19698 in 20.x as well, and I think it's too risky to install
19699 so near the release of 21.1. 2001-09-25 gerd. */
19702 fast_find_position (w
, charpos
, hpos
, vpos
, x
, y
, stop
)
19705 int *hpos
, *vpos
, *x
, *y
;
19708 struct glyph_row
*row
, *first
;
19709 struct glyph
*glyph
, *end
;
19712 first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
19713 row
= row_containing_pos (w
, charpos
, first
, NULL
, 0);
19716 if (charpos
< MATRIX_ROW_START_CHARPOS (first
))
19718 *x
= *y
= *hpos
= *vpos
= 0;
19723 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
19730 *vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
19732 glyph
= row
->glyphs
[TEXT_AREA
];
19733 end
= glyph
+ row
->used
[TEXT_AREA
];
19735 /* Skip over glyphs not having an object at the start of the row.
19736 These are special glyphs like truncation marks on terminal
19738 if (row
->displays_text_p
)
19740 && INTEGERP (glyph
->object
)
19741 && !EQ (stop
, glyph
->object
)
19742 && glyph
->charpos
< 0)
19744 *x
+= glyph
->pixel_width
;
19749 && !INTEGERP (glyph
->object
)
19750 && !EQ (stop
, glyph
->object
)
19751 && (!BUFFERP (glyph
->object
)
19752 || glyph
->charpos
< charpos
))
19754 *x
+= glyph
->pixel_width
;
19758 *hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
19765 fast_find_position (w
, pos
, hpos
, vpos
, x
, y
, stop
)
19768 int *hpos
, *vpos
, *x
, *y
;
19773 int maybe_next_line_p
= 0;
19774 int line_start_position
;
19775 int yb
= window_text_bottom_y (w
);
19776 struct glyph_row
*row
, *best_row
;
19777 int row_vpos
, best_row_vpos
;
19780 row
= best_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
19781 row_vpos
= best_row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
19783 while (row
->y
< yb
)
19785 if (row
->used
[TEXT_AREA
])
19786 line_start_position
= row
->glyphs
[TEXT_AREA
]->charpos
;
19788 line_start_position
= 0;
19790 if (line_start_position
> pos
)
19792 /* If the position sought is the end of the buffer,
19793 don't include the blank lines at the bottom of the window. */
19794 else if (line_start_position
== pos
19795 && pos
== BUF_ZV (XBUFFER (w
->buffer
)))
19797 maybe_next_line_p
= 1;
19800 else if (line_start_position
> 0)
19803 best_row_vpos
= row_vpos
;
19806 if (row
->y
+ row
->height
>= yb
)
19813 /* Find the right column within BEST_ROW. */
19815 current_x
= best_row
->x
;
19816 for (i
= 0; i
< best_row
->used
[TEXT_AREA
]; i
++)
19818 struct glyph
*glyph
= best_row
->glyphs
[TEXT_AREA
] + i
;
19819 int charpos
= glyph
->charpos
;
19821 if (BUFFERP (glyph
->object
))
19823 if (charpos
== pos
)
19826 *vpos
= best_row_vpos
;
19831 else if (charpos
> pos
)
19834 else if (EQ (glyph
->object
, stop
))
19839 current_x
+= glyph
->pixel_width
;
19842 /* If we're looking for the end of the buffer,
19843 and we didn't find it in the line we scanned,
19844 use the start of the following line. */
19845 if (maybe_next_line_p
)
19850 current_x
= best_row
->x
;
19853 *vpos
= best_row_vpos
;
19854 *hpos
= lastcol
+ 1;
19863 /* Find the position of the glyph for position POS in OBJECT in
19864 window W's current matrix, and return in *X, *Y the pixel
19865 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
19867 RIGHT_P non-zero means return the position of the right edge of the
19868 glyph, RIGHT_P zero means return the left edge position.
19870 If no glyph for POS exists in the matrix, return the position of
19871 the glyph with the next smaller position that is in the matrix, if
19872 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
19873 exists in the matrix, return the position of the glyph with the
19874 next larger position in OBJECT.
19876 Value is non-zero if a glyph was found. */
19879 fast_find_string_pos (w
, pos
, object
, hpos
, vpos
, x
, y
, right_p
)
19882 Lisp_Object object
;
19883 int *hpos
, *vpos
, *x
, *y
;
19886 int yb
= window_text_bottom_y (w
);
19887 struct glyph_row
*r
;
19888 struct glyph
*best_glyph
= NULL
;
19889 struct glyph_row
*best_row
= NULL
;
19892 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
19893 r
->enabled_p
&& r
->y
< yb
;
19896 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
19897 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
19900 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
19901 if (EQ (g
->object
, object
))
19903 if (g
->charpos
== pos
)
19910 else if (best_glyph
== NULL
19911 || ((abs (g
->charpos
- pos
)
19912 < abs (best_glyph
->charpos
- pos
))
19915 : g
->charpos
> pos
)))
19929 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
19933 *x
+= best_glyph
->pixel_width
;
19938 *vpos
= best_row
- w
->current_matrix
->rows
;
19941 return best_glyph
!= NULL
;
19945 /* Take proper action when mouse has moved to the mode or header line
19946 or marginal area AREA of window W, x-position X and y-position Y.
19947 X is relative to the start of the text display area of W, so the
19948 width of bitmap areas and scroll bars must be subtracted to get a
19949 position relative to the start of the mode line. */
19952 note_mode_line_or_margin_highlight (w
, x
, y
, area
)
19955 enum window_part area
;
19957 struct frame
*f
= XFRAME (w
->frame
);
19958 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
19959 Cursor cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
19961 Lisp_Object string
, help
, map
, pos
;
19963 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
19964 string
= mode_line_string (w
, &x
, &y
, 0, 0, area
, &charpos
);
19966 string
= marginal_area_string (w
, &x
, &y
, 0, 0, area
, &charpos
);
19968 if (STRINGP (string
))
19970 pos
= make_number (charpos
);
19972 /* If we're on a string with `help-echo' text property, arrange
19973 for the help to be displayed. This is done by setting the
19974 global variable help_echo_string to the help string. */
19975 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
19978 help_echo_string
= help
;
19979 XSETWINDOW (help_echo_window
, w
);
19980 help_echo_object
= string
;
19981 help_echo_pos
= charpos
;
19984 /* Change the mouse pointer according to what is under X/Y. */
19985 if (area
== ON_MODE_LINE
)
19987 map
= Fget_text_property (pos
, Qlocal_map
, string
);
19988 if (!KEYMAPP (map
))
19989 map
= Fget_text_property (pos
, Qkeymap
, string
);
19990 if (!KEYMAPP (map
))
19991 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
19995 rif
->define_frame_cursor (f
, cursor
);
20000 Take proper action when the mouse has moved to position X, Y on
20001 frame F as regards highlighting characters that have mouse-face
20002 properties. Also de-highlighting chars where the mouse was before.
20003 X and Y can be negative or out of range. */
20006 note_mouse_highlight (f
, x
, y
)
20010 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
20011 enum window_part part
;
20012 Lisp_Object window
;
20014 Cursor cursor
= No_Cursor
;
20017 /* When a menu is active, don't highlight because this looks odd. */
20018 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NTGUI)
20019 if (popup_activated ())
20023 if (NILP (Vmouse_highlight
)
20024 || !f
->glyphs_initialized_p
)
20027 dpyinfo
->mouse_face_mouse_x
= x
;
20028 dpyinfo
->mouse_face_mouse_y
= y
;
20029 dpyinfo
->mouse_face_mouse_frame
= f
;
20031 if (dpyinfo
->mouse_face_defer
)
20034 if (gc_in_progress
)
20036 dpyinfo
->mouse_face_deferred_gc
= 1;
20040 /* Which window is that in? */
20041 window
= window_from_coordinates (f
, x
, y
, &part
, 0, 0, 1);
20043 /* If we were displaying active text in another window, clear that. */
20044 if (! EQ (window
, dpyinfo
->mouse_face_window
))
20045 clear_mouse_face (dpyinfo
);
20047 /* Not on a window -> return. */
20048 if (!WINDOWP (window
))
20051 /* Reset help_echo_string. It will get recomputed below. */
20052 /* ++KFS: X version didn't do this, but it looks harmless. */
20053 help_echo_string
= Qnil
;
20055 /* Convert to window-relative pixel coordinates. */
20056 w
= XWINDOW (window
);
20057 frame_to_window_pixel_xy (w
, &x
, &y
);
20059 /* Handle tool-bar window differently since it doesn't display a
20061 if (EQ (window
, f
->tool_bar_window
))
20063 note_tool_bar_highlight (f
, x
, y
);
20067 /* Mouse is on the mode, header line or margin? */
20068 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
20069 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
20071 note_mode_line_or_margin_highlight (w
, x
, y
, part
);
20075 if (part
== ON_VERTICAL_BORDER
)
20076 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
20077 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
)
20078 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
20080 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
20082 /* Are we in a window whose display is up to date?
20083 And verify the buffer's text has not changed. */
20084 b
= XBUFFER (w
->buffer
);
20085 if (part
== ON_TEXT
20086 && EQ (w
->window_end_valid
, w
->buffer
)
20087 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
20088 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
20090 int hpos
, vpos
, pos
, i
, area
;
20091 struct glyph
*glyph
;
20092 Lisp_Object object
;
20093 Lisp_Object mouse_face
= Qnil
, overlay
= Qnil
, position
;
20094 Lisp_Object
*overlay_vec
= NULL
;
20095 int len
, noverlays
;
20096 struct buffer
*obuf
;
20097 int obegv
, ozv
, same_region
;
20099 /* Find the glyph under X/Y. */
20100 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &area
, 0);
20102 /* Clear mouse face if X/Y not over text. */
20104 || area
!= TEXT_AREA
20105 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
)
20107 if (clear_mouse_face (dpyinfo
))
20108 cursor
= No_Cursor
;
20109 if (NILP (Vshow_text_cursor_in_void
))
20110 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
20114 pos
= glyph
->charpos
;
20115 object
= glyph
->object
;
20116 if (!STRINGP (object
) && !BUFFERP (object
))
20119 /* If we get an out-of-range value, return now; avoid an error. */
20120 if (BUFFERP (object
) && pos
> BUF_Z (b
))
20123 if (glyph
->type
== IMAGE_GLYPH
)
20124 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
20126 /* Make the window's buffer temporarily current for
20127 overlays_at and compute_char_face. */
20128 obuf
= current_buffer
;
20129 current_buffer
= b
;
20135 /* Is this char mouse-active or does it have help-echo? */
20136 position
= make_number (pos
);
20138 if (BUFFERP (object
))
20140 /* Put all the overlays we want in a vector in overlay_vec.
20141 Store the length in len. If there are more than 10, make
20142 enough space for all, and try again. */
20144 overlay_vec
= (Lisp_Object
*) alloca (len
* sizeof (Lisp_Object
));
20145 noverlays
= overlays_at (pos
, 0, &overlay_vec
, &len
, NULL
, NULL
, 0);
20146 if (noverlays
> len
)
20149 overlay_vec
= (Lisp_Object
*) alloca (len
* sizeof (Lisp_Object
));
20150 noverlays
= overlays_at (pos
, 0, &overlay_vec
, &len
, NULL
, NULL
,0);
20153 /* Sort overlays into increasing priority order. */
20154 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
20159 same_region
= (EQ (window
, dpyinfo
->mouse_face_window
)
20160 && vpos
>= dpyinfo
->mouse_face_beg_row
20161 && vpos
<= dpyinfo
->mouse_face_end_row
20162 && (vpos
> dpyinfo
->mouse_face_beg_row
20163 || hpos
>= dpyinfo
->mouse_face_beg_col
)
20164 && (vpos
< dpyinfo
->mouse_face_end_row
20165 || hpos
< dpyinfo
->mouse_face_end_col
20166 || dpyinfo
->mouse_face_past_end
));
20169 cursor
= No_Cursor
;
20171 /* Check mouse-face highlighting. */
20173 /* If there exists an overlay with mouse-face overlapping
20174 the one we are currently highlighting, we have to
20175 check if we enter the overlapping overlay, and then
20176 highlight only that. */
20177 || (OVERLAYP (dpyinfo
->mouse_face_overlay
)
20178 && mouse_face_overlay_overlaps (dpyinfo
->mouse_face_overlay
)))
20180 /* Find the highest priority overlay that has a mouse-face
20183 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
20185 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
20186 if (!NILP (mouse_face
))
20187 overlay
= overlay_vec
[i
];
20190 /* If we're actually highlighting the same overlay as
20191 before, there's no need to do that again. */
20192 if (!NILP (overlay
)
20193 && EQ (overlay
, dpyinfo
->mouse_face_overlay
))
20194 goto check_help_echo
;
20196 dpyinfo
->mouse_face_overlay
= overlay
;
20198 /* Clear the display of the old active region, if any. */
20199 if (clear_mouse_face (dpyinfo
))
20200 cursor
= No_Cursor
;
20202 /* If no overlay applies, get a text property. */
20203 if (NILP (overlay
))
20204 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
20206 /* Handle the overlay case. */
20207 if (!NILP (overlay
))
20209 /* Find the range of text around this char that
20210 should be active. */
20211 Lisp_Object before
, after
;
20214 before
= Foverlay_start (overlay
);
20215 after
= Foverlay_end (overlay
);
20216 /* Record this as the current active region. */
20217 fast_find_position (w
, XFASTINT (before
),
20218 &dpyinfo
->mouse_face_beg_col
,
20219 &dpyinfo
->mouse_face_beg_row
,
20220 &dpyinfo
->mouse_face_beg_x
,
20221 &dpyinfo
->mouse_face_beg_y
, Qnil
);
20223 dpyinfo
->mouse_face_past_end
20224 = !fast_find_position (w
, XFASTINT (after
),
20225 &dpyinfo
->mouse_face_end_col
,
20226 &dpyinfo
->mouse_face_end_row
,
20227 &dpyinfo
->mouse_face_end_x
,
20228 &dpyinfo
->mouse_face_end_y
, Qnil
);
20229 dpyinfo
->mouse_face_window
= window
;
20231 dpyinfo
->mouse_face_face_id
20232 = face_at_buffer_position (w
, pos
, 0, 0,
20234 !dpyinfo
->mouse_face_hidden
);
20236 /* Display it as active. */
20237 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
20238 cursor
= No_Cursor
;
20240 /* Handle the text property case. */
20241 else if (!NILP (mouse_face
) && BUFFERP (object
))
20243 /* Find the range of text around this char that
20244 should be active. */
20245 Lisp_Object before
, after
, beginning
, end
;
20248 beginning
= Fmarker_position (w
->start
);
20249 end
= make_number (BUF_Z (XBUFFER (object
))
20250 - XFASTINT (w
->window_end_pos
));
20252 = Fprevious_single_property_change (make_number (pos
+ 1),
20254 object
, beginning
);
20256 = Fnext_single_property_change (position
, Qmouse_face
,
20259 /* Record this as the current active region. */
20260 fast_find_position (w
, XFASTINT (before
),
20261 &dpyinfo
->mouse_face_beg_col
,
20262 &dpyinfo
->mouse_face_beg_row
,
20263 &dpyinfo
->mouse_face_beg_x
,
20264 &dpyinfo
->mouse_face_beg_y
, Qnil
);
20265 dpyinfo
->mouse_face_past_end
20266 = !fast_find_position (w
, XFASTINT (after
),
20267 &dpyinfo
->mouse_face_end_col
,
20268 &dpyinfo
->mouse_face_end_row
,
20269 &dpyinfo
->mouse_face_end_x
,
20270 &dpyinfo
->mouse_face_end_y
, Qnil
);
20271 dpyinfo
->mouse_face_window
= window
;
20273 if (BUFFERP (object
))
20274 dpyinfo
->mouse_face_face_id
20275 = face_at_buffer_position (w
, pos
, 0, 0,
20277 !dpyinfo
->mouse_face_hidden
);
20279 /* Display it as active. */
20280 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
20281 cursor
= No_Cursor
;
20283 else if (!NILP (mouse_face
) && STRINGP (object
))
20288 b
= Fprevious_single_property_change (make_number (pos
+ 1),
20291 e
= Fnext_single_property_change (position
, Qmouse_face
,
20294 b
= make_number (0);
20296 e
= make_number (SCHARS (object
) - 1);
20297 fast_find_string_pos (w
, XINT (b
), object
,
20298 &dpyinfo
->mouse_face_beg_col
,
20299 &dpyinfo
->mouse_face_beg_row
,
20300 &dpyinfo
->mouse_face_beg_x
,
20301 &dpyinfo
->mouse_face_beg_y
, 0);
20302 fast_find_string_pos (w
, XINT (e
), object
,
20303 &dpyinfo
->mouse_face_end_col
,
20304 &dpyinfo
->mouse_face_end_row
,
20305 &dpyinfo
->mouse_face_end_x
,
20306 &dpyinfo
->mouse_face_end_y
, 1);
20307 dpyinfo
->mouse_face_past_end
= 0;
20308 dpyinfo
->mouse_face_window
= window
;
20309 dpyinfo
->mouse_face_face_id
20310 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
20311 glyph
->face_id
, 1);
20312 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
20313 cursor
= No_Cursor
;
20315 else if (STRINGP (object
) && NILP (mouse_face
))
20317 /* A string which doesn't have mouse-face, but
20318 the text ``under'' it might have. */
20319 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
20320 int start
= MATRIX_ROW_START_CHARPOS (r
);
20322 pos
= string_buffer_position (w
, object
, start
);
20324 mouse_face
= get_char_property_and_overlay (make_number (pos
),
20328 if (!NILP (mouse_face
) && !NILP (overlay
))
20330 Lisp_Object before
= Foverlay_start (overlay
);
20331 Lisp_Object after
= Foverlay_end (overlay
);
20334 /* Note that we might not be able to find position
20335 BEFORE in the glyph matrix if the overlay is
20336 entirely covered by a `display' property. In
20337 this case, we overshoot. So let's stop in
20338 the glyph matrix before glyphs for OBJECT. */
20339 fast_find_position (w
, XFASTINT (before
),
20340 &dpyinfo
->mouse_face_beg_col
,
20341 &dpyinfo
->mouse_face_beg_row
,
20342 &dpyinfo
->mouse_face_beg_x
,
20343 &dpyinfo
->mouse_face_beg_y
,
20346 dpyinfo
->mouse_face_past_end
20347 = !fast_find_position (w
, XFASTINT (after
),
20348 &dpyinfo
->mouse_face_end_col
,
20349 &dpyinfo
->mouse_face_end_row
,
20350 &dpyinfo
->mouse_face_end_x
,
20351 &dpyinfo
->mouse_face_end_y
,
20353 dpyinfo
->mouse_face_window
= window
;
20354 dpyinfo
->mouse_face_face_id
20355 = face_at_buffer_position (w
, pos
, 0, 0,
20357 !dpyinfo
->mouse_face_hidden
);
20359 /* Display it as active. */
20360 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
20361 cursor
= No_Cursor
;
20368 /* Look for a `help-echo' property. */
20370 Lisp_Object help
, overlay
;
20372 /* Check overlays first. */
20373 help
= overlay
= Qnil
;
20374 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
20376 overlay
= overlay_vec
[i
];
20377 help
= Foverlay_get (overlay
, Qhelp_echo
);
20382 help_echo_string
= help
;
20383 help_echo_window
= window
;
20384 help_echo_object
= overlay
;
20385 help_echo_pos
= pos
;
20389 Lisp_Object object
= glyph
->object
;
20390 int charpos
= glyph
->charpos
;
20392 /* Try text properties. */
20393 if (STRINGP (object
)
20395 && charpos
< SCHARS (object
))
20397 help
= Fget_text_property (make_number (charpos
),
20398 Qhelp_echo
, object
);
20401 /* If the string itself doesn't specify a help-echo,
20402 see if the buffer text ``under'' it does. */
20403 struct glyph_row
*r
20404 = MATRIX_ROW (w
->current_matrix
, vpos
);
20405 int start
= MATRIX_ROW_START_CHARPOS (r
);
20406 int pos
= string_buffer_position (w
, object
, start
);
20409 help
= Fget_char_property (make_number (pos
),
20410 Qhelp_echo
, w
->buffer
);
20414 object
= w
->buffer
;
20419 else if (BUFFERP (object
)
20422 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
20427 help_echo_string
= help
;
20428 help_echo_window
= window
;
20429 help_echo_object
= object
;
20430 help_echo_pos
= charpos
;
20437 current_buffer
= obuf
;
20442 #ifndef HAVE_CARBON
20443 if (cursor
!= No_Cursor
)
20445 if (bcmp (&cursor
, &No_Cursor
, sizeof (Cursor
)))
20447 rif
->define_frame_cursor (f
, cursor
);
20452 Clear any mouse-face on window W. This function is part of the
20453 redisplay interface, and is called from try_window_id and similar
20454 functions to ensure the mouse-highlight is off. */
20457 x_clear_window_mouse_face (w
)
20460 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
20461 Lisp_Object window
;
20464 XSETWINDOW (window
, w
);
20465 if (EQ (window
, dpyinfo
->mouse_face_window
))
20466 clear_mouse_face (dpyinfo
);
20472 Just discard the mouse face information for frame F, if any.
20473 This is used when the size of F is changed. */
20476 cancel_mouse_face (f
)
20479 Lisp_Object window
;
20480 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
20482 window
= dpyinfo
->mouse_face_window
;
20483 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
20485 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
20486 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
20487 dpyinfo
->mouse_face_window
= Qnil
;
20492 #endif /* HAVE_WINDOW_SYSTEM */
20495 /***********************************************************************
20497 ***********************************************************************/
20499 #ifdef HAVE_WINDOW_SYSTEM
20501 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
20502 which intersects rectangle R. R is in window-relative coordinates. */
20505 expose_area (w
, row
, r
, area
)
20507 struct glyph_row
*row
;
20509 enum glyph_row_area area
;
20511 struct glyph
*first
= row
->glyphs
[area
];
20512 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
20513 struct glyph
*last
;
20514 int first_x
, start_x
, x
;
20516 if (area
== TEXT_AREA
&& row
->fill_line_p
)
20517 /* If row extends face to end of line write the whole line. */
20518 draw_glyphs (w
, 0, row
, area
,
20519 0, row
->used
[area
],
20520 DRAW_NORMAL_TEXT
, 0);
20523 /* Set START_X to the window-relative start position for drawing glyphs of
20524 AREA. The first glyph of the text area can be partially visible.
20525 The first glyphs of other areas cannot. */
20526 start_x
= window_box_left_offset (w
, area
);
20528 if (area
== TEXT_AREA
)
20531 /* Find the first glyph that must be redrawn. */
20533 && x
+ first
->pixel_width
< r
->x
)
20535 x
+= first
->pixel_width
;
20539 /* Find the last one. */
20543 && x
< r
->x
+ r
->width
)
20545 x
+= last
->pixel_width
;
20551 draw_glyphs (w
, first_x
- start_x
, row
, area
,
20552 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
20553 DRAW_NORMAL_TEXT
, 0);
20558 /* Redraw the parts of the glyph row ROW on window W intersecting
20559 rectangle R. R is in window-relative coordinates. Value is
20560 non-zero if mouse-face was overwritten. */
20563 expose_line (w
, row
, r
)
20565 struct glyph_row
*row
;
20568 xassert (row
->enabled_p
);
20570 if (row
->mode_line_p
|| w
->pseudo_window_p
)
20571 draw_glyphs (w
, 0, row
, TEXT_AREA
,
20572 0, row
->used
[TEXT_AREA
],
20573 DRAW_NORMAL_TEXT
, 0);
20576 if (row
->used
[LEFT_MARGIN_AREA
])
20577 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
20578 if (row
->used
[TEXT_AREA
])
20579 expose_area (w
, row
, r
, TEXT_AREA
);
20580 if (row
->used
[RIGHT_MARGIN_AREA
])
20581 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
20582 draw_row_fringe_bitmaps (w
, row
);
20585 return row
->mouse_face_p
;
20589 /* Redraw those parts of glyphs rows during expose event handling that
20590 overlap other rows. Redrawing of an exposed line writes over parts
20591 of lines overlapping that exposed line; this function fixes that.
20593 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
20594 row in W's current matrix that is exposed and overlaps other rows.
20595 LAST_OVERLAPPING_ROW is the last such row. */
20598 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
)
20600 struct glyph_row
*first_overlapping_row
;
20601 struct glyph_row
*last_overlapping_row
;
20603 struct glyph_row
*row
;
20605 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
20606 if (row
->overlapping_p
)
20608 xassert (row
->enabled_p
&& !row
->mode_line_p
);
20610 if (row
->used
[LEFT_MARGIN_AREA
])
20611 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
);
20613 if (row
->used
[TEXT_AREA
])
20614 x_fix_overlapping_area (w
, row
, TEXT_AREA
);
20616 if (row
->used
[RIGHT_MARGIN_AREA
])
20617 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
);
20622 /* Return non-zero if W's cursor intersects rectangle R. */
20625 phys_cursor_in_rect_p (w
, r
)
20629 XRectangle cr
, result
;
20630 struct glyph
*cursor_glyph
;
20632 cursor_glyph
= get_phys_cursor_glyph (w
);
20635 /* r is relative to W's box, but w->phys_cursor.x is relative
20636 to left edge of W's TEXT area. Adjust it. */
20637 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
20638 cr
.y
= w
->phys_cursor
.y
;
20639 cr
.width
= cursor_glyph
->pixel_width
;
20640 cr
.height
= w
->phys_cursor_height
;
20641 /* ++KFS: W32 version used W32-specific IntersectRect here, but
20642 I assume the effect is the same -- and this is portable. */
20643 return x_intersect_rectangles (&cr
, r
, &result
);
20651 Draw a vertical window border to the right of window W if W doesn't
20652 have vertical scroll bars. */
20655 x_draw_vertical_border (w
)
20658 /* We could do better, if we knew what type of scroll-bar the adjacent
20659 windows (on either side) have... But we don't :-(
20660 However, I think this works ok. ++KFS 2003-04-25 */
20662 /* Redraw borders between horizontally adjacent windows. Don't
20663 do it for frames with vertical scroll bars because either the
20664 right scroll bar of a window, or the left scroll bar of its
20665 neighbor will suffice as a border. */
20666 if (!WINDOW_RIGHTMOST_P (w
)
20667 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
20669 int x0
, x1
, y0
, y1
;
20671 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
20674 rif
->draw_vertical_window_border (w
, x1
, y0
, y1
);
20676 else if (!WINDOW_LEFTMOST_P (w
)
20677 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
20679 int x0
, x1
, y0
, y1
;
20681 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
20684 rif
->draw_vertical_window_border (w
, x0
, y0
, y1
);
20689 /* Redraw the part of window W intersection rectangle FR. Pixel
20690 coordinates in FR are frame-relative. Call this function with
20691 input blocked. Value is non-zero if the exposure overwrites
20695 expose_window (w
, fr
)
20699 struct frame
*f
= XFRAME (w
->frame
);
20701 int mouse_face_overwritten_p
= 0;
20703 /* If window is not yet fully initialized, do nothing. This can
20704 happen when toolkit scroll bars are used and a window is split.
20705 Reconfiguring the scroll bar will generate an expose for a newly
20707 if (w
->current_matrix
== NULL
)
20710 /* When we're currently updating the window, display and current
20711 matrix usually don't agree. Arrange for a thorough display
20713 if (w
== updated_window
)
20715 SET_FRAME_GARBAGED (f
);
20719 /* Frame-relative pixel rectangle of W. */
20720 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
20721 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
20722 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
20723 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
20725 if (x_intersect_rectangles (fr
, &wr
, &r
))
20727 int yb
= window_text_bottom_y (w
);
20728 struct glyph_row
*row
;
20729 int cursor_cleared_p
;
20730 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
20732 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
20733 r
.x
, r
.y
, r
.width
, r
.height
));
20735 /* Convert to window coordinates. */
20736 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
20737 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
20739 /* Turn off the cursor. */
20740 if (!w
->pseudo_window_p
20741 && phys_cursor_in_rect_p (w
, &r
))
20743 x_clear_cursor (w
);
20744 cursor_cleared_p
= 1;
20747 cursor_cleared_p
= 0;
20749 /* Update lines intersecting rectangle R. */
20750 first_overlapping_row
= last_overlapping_row
= NULL
;
20751 for (row
= w
->current_matrix
->rows
;
20756 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
20758 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
20759 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
20760 || (r
.y
>= y0
&& r
.y
< y1
)
20761 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
20763 if (row
->overlapping_p
)
20765 if (first_overlapping_row
== NULL
)
20766 first_overlapping_row
= row
;
20767 last_overlapping_row
= row
;
20770 if (expose_line (w
, row
, &r
))
20771 mouse_face_overwritten_p
= 1;
20778 /* Display the mode line if there is one. */
20779 if (WINDOW_WANTS_MODELINE_P (w
)
20780 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
20782 && row
->y
< r
.y
+ r
.height
)
20784 if (expose_line (w
, row
, &r
))
20785 mouse_face_overwritten_p
= 1;
20788 if (!w
->pseudo_window_p
)
20790 /* Fix the display of overlapping rows. */
20791 if (first_overlapping_row
)
20792 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
);
20794 /* Draw border between windows. */
20795 x_draw_vertical_border (w
);
20797 /* Turn the cursor on again. */
20798 if (cursor_cleared_p
)
20799 update_window_cursor (w
, 1);
20804 /* Display scroll bar for this window. */
20805 if (!NILP (w
->vertical_scroll_bar
))
20808 If this doesn't work here (maybe some header files are missing),
20809 make a function in macterm.c and call it to do the job! */
20811 = SCROLL_BAR_CONTROL_HANDLE (XSCROLL_BAR (w
->vertical_scroll_bar
));
20817 return mouse_face_overwritten_p
;
20822 /* Redraw (parts) of all windows in the window tree rooted at W that
20823 intersect R. R contains frame pixel coordinates. Value is
20824 non-zero if the exposure overwrites mouse-face. */
20827 expose_window_tree (w
, r
)
20831 struct frame
*f
= XFRAME (w
->frame
);
20832 int mouse_face_overwritten_p
= 0;
20834 while (w
&& !FRAME_GARBAGED_P (f
))
20836 if (!NILP (w
->hchild
))
20837 mouse_face_overwritten_p
20838 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
20839 else if (!NILP (w
->vchild
))
20840 mouse_face_overwritten_p
20841 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
20843 mouse_face_overwritten_p
|= expose_window (w
, r
);
20845 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
20848 return mouse_face_overwritten_p
;
20853 Redisplay an exposed area of frame F. X and Y are the upper-left
20854 corner of the exposed rectangle. W and H are width and height of
20855 the exposed area. All are pixel values. W or H zero means redraw
20856 the entire frame. */
20859 expose_frame (f
, x
, y
, w
, h
)
20864 int mouse_face_overwritten_p
= 0;
20866 TRACE ((stderr
, "expose_frame "));
20868 /* No need to redraw if frame will be redrawn soon. */
20869 if (FRAME_GARBAGED_P (f
))
20871 TRACE ((stderr
, " garbaged\n"));
20876 /* MAC_TODO: this is a kludge, but if scroll bars are not activated
20877 or deactivated here, for unknown reasons, activated scroll bars
20878 are shown in deactivated frames in some instances. */
20879 if (f
== FRAME_MAC_DISPLAY_INFO (f
)->x_focus_frame
)
20880 activate_scroll_bars (f
);
20882 deactivate_scroll_bars (f
);
20885 /* If basic faces haven't been realized yet, there is no point in
20886 trying to redraw anything. This can happen when we get an expose
20887 event while Emacs is starting, e.g. by moving another window. */
20888 if (FRAME_FACE_CACHE (f
) == NULL
20889 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
20891 TRACE ((stderr
, " no faces\n"));
20895 if (w
== 0 || h
== 0)
20898 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
20899 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
20909 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
20910 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
20912 if (WINDOWP (f
->tool_bar_window
))
20913 mouse_face_overwritten_p
20914 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
20916 #ifdef HAVE_X_WINDOWS
20918 #ifndef USE_X_TOOLKIT
20919 if (WINDOWP (f
->menu_bar_window
))
20920 mouse_face_overwritten_p
20921 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
20922 #endif /* not USE_X_TOOLKIT */
20926 /* Some window managers support a focus-follows-mouse style with
20927 delayed raising of frames. Imagine a partially obscured frame,
20928 and moving the mouse into partially obscured mouse-face on that
20929 frame. The visible part of the mouse-face will be highlighted,
20930 then the WM raises the obscured frame. With at least one WM, KDE
20931 2.1, Emacs is not getting any event for the raising of the frame
20932 (even tried with SubstructureRedirectMask), only Expose events.
20933 These expose events will draw text normally, i.e. not
20934 highlighted. Which means we must redo the highlight here.
20935 Subsume it under ``we love X''. --gerd 2001-08-15 */
20936 /* Included in Windows version because Windows most likely does not
20937 do the right thing if any third party tool offers
20938 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
20939 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
20941 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
20942 if (f
== dpyinfo
->mouse_face_mouse_frame
)
20944 int x
= dpyinfo
->mouse_face_mouse_x
;
20945 int y
= dpyinfo
->mouse_face_mouse_y
;
20946 clear_mouse_face (dpyinfo
);
20947 note_mouse_highlight (f
, x
, y
);
20954 Determine the intersection of two rectangles R1 and R2. Return
20955 the intersection in *RESULT. Value is non-zero if RESULT is not
20959 x_intersect_rectangles (r1
, r2
, result
)
20960 XRectangle
*r1
, *r2
, *result
;
20962 XRectangle
*left
, *right
;
20963 XRectangle
*upper
, *lower
;
20964 int intersection_p
= 0;
20966 /* Rearrange so that R1 is the left-most rectangle. */
20968 left
= r1
, right
= r2
;
20970 left
= r2
, right
= r1
;
20972 /* X0 of the intersection is right.x0, if this is inside R1,
20973 otherwise there is no intersection. */
20974 if (right
->x
<= left
->x
+ left
->width
)
20976 result
->x
= right
->x
;
20978 /* The right end of the intersection is the minimum of the
20979 the right ends of left and right. */
20980 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
20983 /* Same game for Y. */
20985 upper
= r1
, lower
= r2
;
20987 upper
= r2
, lower
= r1
;
20989 /* The upper end of the intersection is lower.y0, if this is inside
20990 of upper. Otherwise, there is no intersection. */
20991 if (lower
->y
<= upper
->y
+ upper
->height
)
20993 result
->y
= lower
->y
;
20995 /* The lower end of the intersection is the minimum of the lower
20996 ends of upper and lower. */
20997 result
->height
= (min (lower
->y
+ lower
->height
,
20998 upper
->y
+ upper
->height
)
21000 intersection_p
= 1;
21004 return intersection_p
;
21007 #endif /* HAVE_WINDOW_SYSTEM */
21010 /***********************************************************************
21012 ***********************************************************************/
21017 Vwith_echo_area_save_vector
= Qnil
;
21018 staticpro (&Vwith_echo_area_save_vector
);
21020 Vmessage_stack
= Qnil
;
21021 staticpro (&Vmessage_stack
);
21023 Qinhibit_redisplay
= intern ("inhibit-redisplay");
21024 staticpro (&Qinhibit_redisplay
);
21026 message_dolog_marker1
= Fmake_marker ();
21027 staticpro (&message_dolog_marker1
);
21028 message_dolog_marker2
= Fmake_marker ();
21029 staticpro (&message_dolog_marker2
);
21030 message_dolog_marker3
= Fmake_marker ();
21031 staticpro (&message_dolog_marker3
);
21034 defsubr (&Sdump_frame_glyph_matrix
);
21035 defsubr (&Sdump_glyph_matrix
);
21036 defsubr (&Sdump_glyph_row
);
21037 defsubr (&Sdump_tool_bar_row
);
21038 defsubr (&Strace_redisplay
);
21039 defsubr (&Strace_to_stderr
);
21041 #ifdef HAVE_WINDOW_SYSTEM
21042 defsubr (&Stool_bar_lines_needed
);
21044 defsubr (&Sformat_mode_line
);
21046 staticpro (&Qmenu_bar_update_hook
);
21047 Qmenu_bar_update_hook
= intern ("menu-bar-update-hook");
21049 staticpro (&Qoverriding_terminal_local_map
);
21050 Qoverriding_terminal_local_map
= intern ("overriding-terminal-local-map");
21052 staticpro (&Qoverriding_local_map
);
21053 Qoverriding_local_map
= intern ("overriding-local-map");
21055 staticpro (&Qwindow_scroll_functions
);
21056 Qwindow_scroll_functions
= intern ("window-scroll-functions");
21058 staticpro (&Qredisplay_end_trigger_functions
);
21059 Qredisplay_end_trigger_functions
= intern ("redisplay-end-trigger-functions");
21061 staticpro (&Qinhibit_point_motion_hooks
);
21062 Qinhibit_point_motion_hooks
= intern ("inhibit-point-motion-hooks");
21064 QCdata
= intern (":data");
21065 staticpro (&QCdata
);
21066 Qdisplay
= intern ("display");
21067 staticpro (&Qdisplay
);
21068 Qspace_width
= intern ("space-width");
21069 staticpro (&Qspace_width
);
21070 Qraise
= intern ("raise");
21071 staticpro (&Qraise
);
21072 Qspace
= intern ("space");
21073 staticpro (&Qspace
);
21074 Qmargin
= intern ("margin");
21075 staticpro (&Qmargin
);
21076 Qleft_margin
= intern ("left-margin");
21077 staticpro (&Qleft_margin
);
21078 Qright_margin
= intern ("right-margin");
21079 staticpro (&Qright_margin
);
21080 Qalign_to
= intern ("align-to");
21081 staticpro (&Qalign_to
);
21082 QCalign_to
= intern (":align-to");
21083 staticpro (&QCalign_to
);
21084 Qrelative_width
= intern ("relative-width");
21085 staticpro (&Qrelative_width
);
21086 QCrelative_width
= intern (":relative-width");
21087 staticpro (&QCrelative_width
);
21088 QCrelative_height
= intern (":relative-height");
21089 staticpro (&QCrelative_height
);
21090 QCeval
= intern (":eval");
21091 staticpro (&QCeval
);
21092 QCpropertize
= intern (":propertize");
21093 staticpro (&QCpropertize
);
21094 QCfile
= intern (":file");
21095 staticpro (&QCfile
);
21096 Qfontified
= intern ("fontified");
21097 staticpro (&Qfontified
);
21098 Qfontification_functions
= intern ("fontification-functions");
21099 staticpro (&Qfontification_functions
);
21100 Qtrailing_whitespace
= intern ("trailing-whitespace");
21101 staticpro (&Qtrailing_whitespace
);
21102 Qimage
= intern ("image");
21103 staticpro (&Qimage
);
21104 Qmessage_truncate_lines
= intern ("message-truncate-lines");
21105 staticpro (&Qmessage_truncate_lines
);
21106 Qcursor_in_non_selected_windows
= intern ("cursor-in-non-selected-windows");
21107 staticpro (&Qcursor_in_non_selected_windows
);
21108 Qgrow_only
= intern ("grow-only");
21109 staticpro (&Qgrow_only
);
21110 Qinhibit_menubar_update
= intern ("inhibit-menubar-update");
21111 staticpro (&Qinhibit_menubar_update
);
21112 Qinhibit_eval_during_redisplay
= intern ("inhibit-eval-during-redisplay");
21113 staticpro (&Qinhibit_eval_during_redisplay
);
21114 Qposition
= intern ("position");
21115 staticpro (&Qposition
);
21116 Qbuffer_position
= intern ("buffer-position");
21117 staticpro (&Qbuffer_position
);
21118 Qobject
= intern ("object");
21119 staticpro (&Qobject
);
21120 Qbar
= intern ("bar");
21122 Qhbar
= intern ("hbar");
21123 staticpro (&Qhbar
);
21124 Qbox
= intern ("box");
21126 Qhollow
= intern ("hollow");
21127 staticpro (&Qhollow
);
21128 Qrisky_local_variable
= intern ("risky-local-variable");
21129 staticpro (&Qrisky_local_variable
);
21130 Qinhibit_free_realized_faces
= intern ("inhibit-free-realized-faces");
21131 staticpro (&Qinhibit_free_realized_faces
);
21133 list_of_error
= Fcons (intern ("error"), Qnil
);
21134 staticpro (&list_of_error
);
21136 last_arrow_position
= Qnil
;
21137 last_arrow_string
= Qnil
;
21138 staticpro (&last_arrow_position
);
21139 staticpro (&last_arrow_string
);
21141 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
21142 staticpro (&echo_buffer
[0]);
21143 staticpro (&echo_buffer
[1]);
21145 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
21146 staticpro (&echo_area_buffer
[0]);
21147 staticpro (&echo_area_buffer
[1]);
21149 Vmessages_buffer_name
= build_string ("*Messages*");
21150 staticpro (&Vmessages_buffer_name
);
21152 mode_line_proptrans_alist
= Qnil
;
21153 staticpro (&mode_line_proptrans_alist
);
21155 mode_line_string_list
= Qnil
;
21156 staticpro (&mode_line_string_list
);
21158 help_echo_string
= Qnil
;
21159 staticpro (&help_echo_string
);
21160 help_echo_object
= Qnil
;
21161 staticpro (&help_echo_object
);
21162 help_echo_window
= Qnil
;
21163 staticpro (&help_echo_window
);
21164 previous_help_echo_string
= Qnil
;
21165 staticpro (&previous_help_echo_string
);
21166 help_echo_pos
= -1;
21168 #ifdef HAVE_WINDOW_SYSTEM
21169 DEFVAR_BOOL ("x-stretch-cursor", &x_stretch_cursor_p
,
21170 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
21171 For example, if a block cursor is over a tab, it will be drawn as
21172 wide as that tab on the display. */);
21173 x_stretch_cursor_p
= 0;
21176 DEFVAR_LISP ("show-trailing-whitespace", &Vshow_trailing_whitespace
,
21177 doc
: /* Non-nil means highlight trailing whitespace.
21178 The face used for trailing whitespace is `trailing-whitespace'. */);
21179 Vshow_trailing_whitespace
= Qnil
;
21181 DEFVAR_LISP ("show-text-cursor-in-void", &Vshow_text_cursor_in_void
,
21182 doc
: /* Non-nil means show the text cursor in void text areas.
21183 The default is to show the non-text (typically arrow) cursor. */);
21184 Vshow_text_cursor_in_void
= Qnil
;
21186 DEFVAR_LISP ("inhibit-redisplay", &Vinhibit_redisplay
,
21187 doc
: /* Non-nil means don't actually do any redisplay.
21188 This is used for internal purposes. */);
21189 Vinhibit_redisplay
= Qnil
;
21191 DEFVAR_LISP ("global-mode-string", &Vglobal_mode_string
,
21192 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
21193 Vglobal_mode_string
= Qnil
;
21195 DEFVAR_LISP ("overlay-arrow-position", &Voverlay_arrow_position
,
21196 doc
: /* Marker for where to display an arrow on top of the buffer text.
21197 This must be the beginning of a line in order to work.
21198 See also `overlay-arrow-string'. */);
21199 Voverlay_arrow_position
= Qnil
;
21201 DEFVAR_LISP ("overlay-arrow-string", &Voverlay_arrow_string
,
21202 doc
: /* String to display as an arrow. See also `overlay-arrow-position'. */);
21203 Voverlay_arrow_string
= Qnil
;
21205 DEFVAR_INT ("scroll-step", &scroll_step
,
21206 doc
: /* *The number of lines to try scrolling a window by when point moves out.
21207 If that fails to bring point back on frame, point is centered instead.
21208 If this is zero, point is always centered after it moves off frame.
21209 If you want scrolling to always be a line at a time, you should set
21210 `scroll-conservatively' to a large value rather than set this to 1. */);
21212 DEFVAR_INT ("scroll-conservatively", &scroll_conservatively
,
21213 doc
: /* *Scroll up to this many lines, to bring point back on screen.
21214 A value of zero means to scroll the text to center point vertically
21215 in the window. */);
21216 scroll_conservatively
= 0;
21218 DEFVAR_INT ("scroll-margin", &scroll_margin
,
21219 doc
: /* *Number of lines of margin at the top and bottom of a window.
21220 Recenter the window whenever point gets within this many lines
21221 of the top or bottom of the window. */);
21224 DEFVAR_LISP ("display-pixels-per-inch", &Vdisplay_pixels_per_inch
,
21225 doc
: /* Pixels per inch on current display.
21226 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
21227 Vdisplay_pixels_per_inch
= make_float (72.0);
21230 DEFVAR_INT ("debug-end-pos", &debug_end_pos
, doc
: /* Don't ask. */);
21233 DEFVAR_BOOL ("truncate-partial-width-windows",
21234 &truncate_partial_width_windows
,
21235 doc
: /* *Non-nil means truncate lines in all windows less than full frame wide. */);
21236 truncate_partial_width_windows
= 1;
21238 DEFVAR_BOOL ("mode-line-inverse-video", &mode_line_inverse_video
,
21239 doc
: /* nil means display the mode-line/header-line/menu-bar in the default face.
21240 Any other value means to use the appropriate face, `mode-line',
21241 `header-line', or `menu' respectively. */);
21242 mode_line_inverse_video
= 1;
21244 DEFVAR_LISP ("line-number-display-limit", &Vline_number_display_limit
,
21245 doc
: /* *Maximum buffer size for which line number should be displayed.
21246 If the buffer is bigger than this, the line number does not appear
21247 in the mode line. A value of nil means no limit. */);
21248 Vline_number_display_limit
= Qnil
;
21250 DEFVAR_INT ("line-number-display-limit-width",
21251 &line_number_display_limit_width
,
21252 doc
: /* *Maximum line width (in characters) for line number display.
21253 If the average length of the lines near point is bigger than this, then the
21254 line number may be omitted from the mode line. */);
21255 line_number_display_limit_width
= 200;
21257 DEFVAR_BOOL ("highlight-nonselected-windows", &highlight_nonselected_windows
,
21258 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
21259 highlight_nonselected_windows
= 0;
21261 DEFVAR_BOOL ("multiple-frames", &multiple_frames
,
21262 doc
: /* Non-nil if more than one frame is visible on this display.
21263 Minibuffer-only frames don't count, but iconified frames do.
21264 This variable is not guaranteed to be accurate except while processing
21265 `frame-title-format' and `icon-title-format'. */);
21267 DEFVAR_LISP ("frame-title-format", &Vframe_title_format
,
21268 doc
: /* Template for displaying the title bar of visible frames.
21269 \(Assuming the window manager supports this feature.)
21270 This variable has the same structure as `mode-line-format' (which see),
21271 and is used only on frames for which no explicit name has been set
21272 \(see `modify-frame-parameters'). */);
21274 DEFVAR_LISP ("icon-title-format", &Vicon_title_format
,
21275 doc
: /* Template for displaying the title bar of an iconified frame.
21276 \(Assuming the window manager supports this feature.)
21277 This variable has the same structure as `mode-line-format' (which see),
21278 and is used only on frames for which no explicit name has been set
21279 \(see `modify-frame-parameters'). */);
21281 = Vframe_title_format
21282 = Fcons (intern ("multiple-frames"),
21283 Fcons (build_string ("%b"),
21284 Fcons (Fcons (empty_string
,
21285 Fcons (intern ("invocation-name"),
21286 Fcons (build_string ("@"),
21287 Fcons (intern ("system-name"),
21291 DEFVAR_LISP ("message-log-max", &Vmessage_log_max
,
21292 doc
: /* Maximum number of lines to keep in the message log buffer.
21293 If nil, disable message logging. If t, log messages but don't truncate
21294 the buffer when it becomes large. */);
21295 Vmessage_log_max
= make_number (50);
21297 DEFVAR_LISP ("window-size-change-functions", &Vwindow_size_change_functions
,
21298 doc
: /* Functions called before redisplay, if window sizes have changed.
21299 The value should be a list of functions that take one argument.
21300 Just before redisplay, for each frame, if any of its windows have changed
21301 size since the last redisplay, or have been split or deleted,
21302 all the functions in the list are called, with the frame as argument. */);
21303 Vwindow_size_change_functions
= Qnil
;
21305 DEFVAR_LISP ("window-scroll-functions", &Vwindow_scroll_functions
,
21306 doc
: /* List of Functions to call before redisplaying a window with scrolling.
21307 Each function is called with two arguments, the window
21308 and its new display-start position. Note that the value of `window-end'
21309 is not valid when these functions are called. */);
21310 Vwindow_scroll_functions
= Qnil
;
21312 DEFVAR_BOOL ("mouse-autoselect-window", &mouse_autoselect_window
,
21313 doc
: /* *Non-nil means autoselect window with mouse pointer. */);
21314 mouse_autoselect_window
= 0;
21316 DEFVAR_BOOL ("auto-resize-tool-bars", &auto_resize_tool_bars_p
,
21317 doc
: /* *Non-nil means automatically resize tool-bars.
21318 This increases a tool-bar's height if not all tool-bar items are visible.
21319 It decreases a tool-bar's height when it would display blank lines
21321 auto_resize_tool_bars_p
= 1;
21323 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", &auto_raise_tool_bar_buttons_p
,
21324 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
21325 auto_raise_tool_bar_buttons_p
= 1;
21327 DEFVAR_LISP ("tool-bar-button-margin", &Vtool_bar_button_margin
,
21328 doc
: /* *Margin around tool-bar buttons in pixels.
21329 If an integer, use that for both horizontal and vertical margins.
21330 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
21331 HORZ specifying the horizontal margin, and VERT specifying the
21332 vertical margin. */);
21333 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
21335 DEFVAR_INT ("tool-bar-button-relief", &tool_bar_button_relief
,
21336 doc
: /* *Relief thickness of tool-bar buttons. */);
21337 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
21339 DEFVAR_LISP ("fontification-functions", &Vfontification_functions
,
21340 doc
: /* List of functions to call to fontify regions of text.
21341 Each function is called with one argument POS. Functions must
21342 fontify a region starting at POS in the current buffer, and give
21343 fontified regions the property `fontified'. */);
21344 Vfontification_functions
= Qnil
;
21345 Fmake_variable_buffer_local (Qfontification_functions
);
21347 DEFVAR_BOOL ("unibyte-display-via-language-environment",
21348 &unibyte_display_via_language_environment
,
21349 doc
: /* *Non-nil means display unibyte text according to language environment.
21350 Specifically this means that unibyte non-ASCII characters
21351 are displayed by converting them to the equivalent multibyte characters
21352 according to the current language environment. As a result, they are
21353 displayed according to the current fontset. */);
21354 unibyte_display_via_language_environment
= 0;
21356 DEFVAR_LISP ("max-mini-window-height", &Vmax_mini_window_height
,
21357 doc
: /* *Maximum height for resizing mini-windows.
21358 If a float, it specifies a fraction of the mini-window frame's height.
21359 If an integer, it specifies a number of lines. */);
21360 Vmax_mini_window_height
= make_float (0.25);
21362 DEFVAR_LISP ("resize-mini-windows", &Vresize_mini_windows
,
21363 doc
: /* *How to resize mini-windows.
21364 A value of nil means don't automatically resize mini-windows.
21365 A value of t means resize them to fit the text displayed in them.
21366 A value of `grow-only', the default, means let mini-windows grow
21367 only, until their display becomes empty, at which point the windows
21368 go back to their normal size. */);
21369 Vresize_mini_windows
= Qgrow_only
;
21371 DEFVAR_LISP ("cursor-in-non-selected-windows",
21372 &Vcursor_in_non_selected_windows
,
21373 doc
: /* *Cursor type to display in non-selected windows.
21374 t means to use hollow box cursor. See `cursor-type' for other values. */);
21375 Vcursor_in_non_selected_windows
= Qt
;
21377 DEFVAR_LISP ("blink-cursor-alist", &Vblink_cursor_alist
,
21378 doc
: /* Alist specifying how to blink the cursor off.
21379 Each element has the form (ON-STATE . OFF-STATE). Whenever the
21380 `cursor-type' frame-parameter or variable equals ON-STATE,
21381 comparing using `equal', Emacs uses OFF-STATE to specify
21382 how to blink it off. */);
21383 Vblink_cursor_alist
= Qnil
;
21385 DEFVAR_BOOL ("auto-hscroll-mode", &automatic_hscrolling_p
,
21386 doc
: /* *Non-nil means scroll the display automatically to make point visible. */);
21387 automatic_hscrolling_p
= 1;
21389 DEFVAR_INT ("hscroll-margin", &hscroll_margin
,
21390 doc
: /* *How many columns away from the window edge point is allowed to get
21391 before automatic hscrolling will horizontally scroll the window. */);
21392 hscroll_margin
= 5;
21394 DEFVAR_LISP ("hscroll-step", &Vhscroll_step
,
21395 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
21396 When point is less than `automatic-hscroll-margin' columns from the window
21397 edge, automatic hscrolling will scroll the window by the amount of columns
21398 determined by this variable. If its value is a positive integer, scroll that
21399 many columns. If it's a positive floating-point number, it specifies the
21400 fraction of the window's width to scroll. If it's nil or zero, point will be
21401 centered horizontally after the scroll. Any other value, including negative
21402 numbers, are treated as if the value were zero.
21404 Automatic hscrolling always moves point outside the scroll margin, so if
21405 point was more than scroll step columns inside the margin, the window will
21406 scroll more than the value given by the scroll step.
21408 Note that the lower bound for automatic hscrolling specified by `scroll-left'
21409 and `scroll-right' overrides this variable's effect. */);
21410 Vhscroll_step
= make_number (0);
21412 DEFVAR_LISP ("image-types", &Vimage_types
,
21413 doc
: /* List of supported image types.
21414 Each element of the list is a symbol for a supported image type. */);
21415 Vimage_types
= Qnil
;
21417 DEFVAR_BOOL ("message-truncate-lines", &message_truncate_lines
,
21418 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
21419 Bind this around calls to `message' to let it take effect. */);
21420 message_truncate_lines
= 0;
21422 DEFVAR_LISP ("menu-bar-update-hook", &Vmenu_bar_update_hook
,
21423 doc
: /* Normal hook run for clicks on menu bar, before displaying a submenu.
21424 Can be used to update submenus whose contents should vary. */);
21425 Vmenu_bar_update_hook
= Qnil
;
21427 DEFVAR_BOOL ("inhibit-menubar-update", &inhibit_menubar_update
,
21428 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
21429 inhibit_menubar_update
= 0;
21431 DEFVAR_BOOL ("inhibit-eval-during-redisplay", &inhibit_eval_during_redisplay
,
21432 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
21433 inhibit_eval_during_redisplay
= 0;
21435 DEFVAR_BOOL ("inhibit-free-realized-faces", &inhibit_free_realized_faces
,
21436 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
21437 inhibit_free_realized_faces
= 0;
21440 DEFVAR_BOOL ("inhibit-try-window-id", &inhibit_try_window_id
,
21441 doc
: /* Inhibit try_window_id display optimization. */);
21442 inhibit_try_window_id
= 0;
21444 DEFVAR_BOOL ("inhibit-try-window-reusing", &inhibit_try_window_reusing
,
21445 doc
: /* Inhibit try_window_reusing display optimization. */);
21446 inhibit_try_window_reusing
= 0;
21448 DEFVAR_BOOL ("inhibit-try-cursor-movement", &inhibit_try_cursor_movement
,
21449 doc
: /* Inhibit try_cursor_movement display optimization. */);
21450 inhibit_try_cursor_movement
= 0;
21451 #endif /* GLYPH_DEBUG */
21455 /* Initialize this module when Emacs starts. */
21460 Lisp_Object root_window
;
21461 struct window
*mini_w
;
21463 current_header_line_height
= current_mode_line_height
= -1;
21465 CHARPOS (this_line_start_pos
) = 0;
21467 mini_w
= XWINDOW (minibuf_window
);
21468 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
21470 if (!noninteractive
)
21472 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
21475 XWINDOW (root_window
)->top_line
= make_number (FRAME_TOP_MARGIN (f
));
21476 set_window_height (root_window
,
21477 FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
),
21479 mini_w
->top_line
= make_number (FRAME_LINES (f
) - 1);
21480 set_window_height (minibuf_window
, 1, 0);
21482 XWINDOW (root_window
)->total_cols
= make_number (FRAME_COLS (f
));
21483 mini_w
->total_cols
= make_number (FRAME_COLS (f
));
21485 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
21486 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
21487 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
21489 /* The default ellipsis glyphs `...'. */
21490 for (i
= 0; i
< 3; ++i
)
21491 default_invis_vector
[i
] = make_number ('.');
21495 /* Allocate the buffer for frame titles.
21496 Also used for `format-mode-line'. */
21498 frame_title_buf
= (char *) xmalloc (size
);
21499 frame_title_buf_end
= frame_title_buf
+ size
;
21500 frame_title_ptr
= NULL
;
21503 help_echo_showing_p
= 0;
21507 /* arch-tag: eacc864d-bb6a-4b74-894a-1a4399a1358b
21508 (do not change this comment) */