1 /* Display generation from window structure and buffer text.
2 Copyright (C) 1985, 86, 87, 88, 93, 94, 95, 97, 98, 99, 2000
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 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? 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 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 a iterator structure (struct it)
126 Iteration over things to be be displayed is then simple. It is
127 started by initializing an iterator with a call to init_iterator
128 (or init_string_iterator for that matter). Calls to
129 get_next_display_element fill the iterator structure with relevant
130 information about the next thing to display. Calls to
131 set_iterator_to_next move the iterator to the next thing.
133 Besides this, an iterator also contains information about the
134 display environment in which glyphs for display elements are to be
135 produced. It has fields for the width and height of the display,
136 the information whether long lines are truncated or continued, a
137 current X and Y position, and lots of other stuff you can better
140 Glyphs in a desired matrix are normally constructed in a loop
141 calling get_next_display_element and then produce_glyphs. The call
142 to produce_glyphs will fill the iterator structure with pixel
143 information about the element being displayed and at the same time
144 produce glyphs for it. If the display element fits on the line
145 being displayed, set_iterator_to_next is called next, otherwise the
146 glyphs produced are discarded.
151 That just couldn't be all, could it? What about terminal types not
152 supporting operations on sub-windows of the screen? To update the
153 display on such a terminal, window-based glyph matrices are not
154 well suited. To be able to reuse part of the display (scrolling
155 lines up and down), we must instead have a view of the whole
156 screen. This is what `frame matrices' are for. They are a trick.
158 Frames on terminals like above have a glyph pool. Windows on such
159 a frame sub-allocate their glyph memory from their frame's glyph
160 pool. The frame itself is given its own glyph matrices. By
161 coincidence---or maybe something else---rows in window glyph
162 matrices are slices of corresponding rows in frame matrices. Thus
163 writing to window matrices implicitly updates a frame matrix which
164 provides us with the view of the whole screen that we originally
165 wanted to have without having to move many bytes around. To be
166 honest, there is a little bit more done, but not much more. If you
167 plan to extend that code, take a look at dispnew.c. The function
168 build_frame_matrix is a good starting point. */
173 #include "keyboard.h"
176 #include "termchar.h"
177 #include "dispextern.h"
181 #include "commands.h"
184 #include "termhooks.h"
185 #include "intervals.h"
188 #include "region-cache.h"
191 #ifdef HAVE_X_WINDOWS
201 #define min(a, b) ((a) < (b) ? (a) : (b))
202 #define max(a, b) ((a) > (b) ? (a) : (b))
204 #define INFINITY 10000000
206 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (macintosh)
207 extern void set_frame_menubar
P_ ((struct frame
*f
, int, int));
208 extern int pending_menu_activation
;
211 extern int interrupt_input
;
212 extern int command_loop_level
;
214 extern int minibuffer_auto_raise
;
216 extern Lisp_Object Qface
;
218 extern Lisp_Object Voverriding_local_map
;
219 extern Lisp_Object Voverriding_local_map_menu_flag
;
220 extern Lisp_Object Qmenu_item
;
222 Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
223 Lisp_Object Qwindow_scroll_functions
, Vwindow_scroll_functions
;
224 Lisp_Object Qredisplay_end_trigger_functions
;
225 Lisp_Object Qinhibit_point_motion_hooks
;
226 Lisp_Object QCeval
, Qwhen
, QCfile
, QCdata
;
227 Lisp_Object Qfontified
;
228 Lisp_Object Qgrow_only
;
230 /* Functions called to fontify regions of text. */
232 Lisp_Object Vfontification_functions
;
233 Lisp_Object Qfontification_functions
;
235 /* Non-zero means draw tool bar buttons raised when the mouse moves
238 int auto_raise_tool_bar_buttons_p
;
240 /* Margin around tool bar buttons in pixels. */
242 int tool_bar_button_margin
;
244 /* Thickness of shadow to draw around tool bar buttons. */
246 int tool_bar_button_relief
;
248 /* Non-zero means automatically resize tool-bars so that all tool-bar
249 items are visible, and no blank lines remain. */
251 int auto_resize_tool_bars_p
;
253 /* Non-nil means don't actually do any redisplay. */
255 Lisp_Object Vinhibit_redisplay
, Qinhibit_redisplay
;
257 /* Names of text properties relevant for redisplay. */
259 Lisp_Object Qdisplay
, Qrelative_width
, Qalign_to
;
260 extern Lisp_Object Qface
, Qinvisible
, Qimage
, Qwidth
;
262 /* Symbols used in text property values. */
264 Lisp_Object Qspace
, QCalign_to
, QCrelative_width
, QCrelative_height
;
265 Lisp_Object Qleft_margin
, Qright_margin
, Qspace_width
, Qraise
;
267 extern Lisp_Object Qheight
;
269 /* Non-nil means highlight trailing whitespace. */
271 Lisp_Object Vshow_trailing_whitespace
;
273 /* Name of the face used to highlight trailing whitespace. */
275 Lisp_Object Qtrailing_whitespace
;
277 /* The symbol `image' which is the car of the lists used to represent
282 /* Non-zero means print newline to stdout before next mini-buffer
285 int noninteractive_need_newline
;
287 /* Non-zero means print newline to message log before next message. */
289 static int message_log_need_newline
;
292 /* The buffer position of the first character appearing entirely or
293 partially on the line of the selected window which contains the
294 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
295 redisplay optimization in redisplay_internal. */
297 static struct text_pos this_line_start_pos
;
299 /* Number of characters past the end of the line above, including the
300 terminating newline. */
302 static struct text_pos this_line_end_pos
;
304 /* The vertical positions and the height of this line. */
306 static int this_line_vpos
;
307 static int this_line_y
;
308 static int this_line_pixel_height
;
310 /* X position at which this display line starts. Usually zero;
311 negative if first character is partially visible. */
313 static int this_line_start_x
;
315 /* Buffer that this_line_.* variables are referring to. */
317 static struct buffer
*this_line_buffer
;
319 /* Nonzero means truncate lines in all windows less wide than the
322 int truncate_partial_width_windows
;
324 /* A flag to control how to display unibyte 8-bit character. */
326 int unibyte_display_via_language_environment
;
328 /* Nonzero means we have more than one non-mini-buffer-only frame.
329 Not guaranteed to be accurate except while parsing
330 frame-title-format. */
334 Lisp_Object Vglobal_mode_string
;
336 /* Marker for where to display an arrow on top of the buffer text. */
338 Lisp_Object Voverlay_arrow_position
;
340 /* String to display for the arrow. Only used on terminal frames. */
342 Lisp_Object Voverlay_arrow_string
;
344 /* Values of those variables at last redisplay. However, if
345 Voverlay_arrow_position is a marker, last_arrow_position is its
346 numerical position. */
348 static Lisp_Object last_arrow_position
, last_arrow_string
;
350 /* Like mode-line-format, but for the title bar on a visible frame. */
352 Lisp_Object Vframe_title_format
;
354 /* Like mode-line-format, but for the title bar on an iconified frame. */
356 Lisp_Object Vicon_title_format
;
358 /* List of functions to call when a window's size changes. These
359 functions get one arg, a frame on which one or more windows' sizes
362 static Lisp_Object Vwindow_size_change_functions
;
364 Lisp_Object Qmenu_bar_update_hook
, Vmenu_bar_update_hook
;
366 /* Nonzero if overlay arrow has been displayed once in this window. */
368 static int overlay_arrow_seen
;
370 /* Nonzero means highlight the region even in nonselected windows. */
372 int highlight_nonselected_windows
;
374 /* If cursor motion alone moves point off frame, try scrolling this
375 many lines up or down if that will bring it back. */
377 static int scroll_step
;
379 /* Non-0 means scroll just far enough to bring point back on the
380 screen, when appropriate. */
382 static int scroll_conservatively
;
384 /* Recenter the window whenever point gets within this many lines of
385 the top or bottom of the window. This value is translated into a
386 pixel value by multiplying it with CANON_Y_UNIT, which means that
387 there is really a fixed pixel height scroll margin. */
391 /* Number of windows showing the buffer of the selected window (or
392 another buffer with the same base buffer). keyboard.c refers to
397 /* Vector containing glyphs for an ellipsis `...'. */
399 static Lisp_Object default_invis_vector
[3];
401 /* Zero means display the mode-line/header-line/menu-bar in the default face
402 (this slightly odd definition is for compatibility with previous versions
403 of emacs), non-zero means display them using their respective faces.
405 This variable is deprecated. */
407 int mode_line_inverse_video
;
409 /* Prompt to display in front of the mini-buffer contents. */
411 Lisp_Object minibuf_prompt
;
413 /* Width of current mini-buffer prompt. Only set after display_line
414 of the line that contains the prompt. */
416 int minibuf_prompt_width
;
417 int minibuf_prompt_pixel_width
;
419 /* This is the window where the echo area message was displayed. It
420 is always a mini-buffer window, but it may not be the same window
421 currently active as a mini-buffer. */
423 Lisp_Object echo_area_window
;
425 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
426 pushes the current message and the value of
427 message_enable_multibyte on the stack, the function restore_message
428 pops the stack and displays MESSAGE again. */
430 Lisp_Object Vmessage_stack
;
432 /* Nonzero means multibyte characters were enabled when the echo area
433 message was specified. */
435 int message_enable_multibyte
;
437 /* True if we should redraw the mode lines on the next redisplay. */
439 int update_mode_lines
;
441 /* Nonzero if window sizes or contents have changed since last
442 redisplay that finished */
444 int windows_or_buffers_changed
;
446 /* Nonzero after display_mode_line if %l was used and it displayed a
449 int line_number_displayed
;
451 /* Maximum buffer size for which to display line numbers. */
453 Lisp_Object Vline_number_display_limit
;
455 /* line width to consider when repostioning for line number display */
457 static int line_number_display_limit_width
;
459 /* Number of lines to keep in the message log buffer. t means
460 infinite. nil means don't log at all. */
462 Lisp_Object Vmessage_log_max
;
464 /* The name of the *Messages* buffer, a string. */
466 static Lisp_Object Vmessages_buffer_name
;
468 /* Current, index 0, and last displayed echo area message. Either
469 buffers from echo_buffers, or nil to indicate no message. */
471 Lisp_Object echo_area_buffer
[2];
473 /* The buffers referenced from echo_area_buffer. */
475 static Lisp_Object echo_buffer
[2];
477 /* A vector saved used in with_area_buffer to reduce consing. */
479 static Lisp_Object Vwith_echo_area_save_vector
;
481 /* Non-zero means display_echo_area should display the last echo area
482 message again. Set by redisplay_preserve_echo_area. */
484 static int display_last_displayed_message_p
;
486 /* Nonzero if echo area is being used by print; zero if being used by
489 int message_buf_print
;
491 /* Maximum height for resizing mini-windows. Either a float
492 specifying a fraction of the available height, or an integer
493 specifying a number of lines. */
495 Lisp_Object Vmax_mini_window_height
;
497 /* Non-zero means messages should be displayed with truncated
498 lines instead of being continued. */
500 int message_truncate_lines
;
501 Lisp_Object Qmessage_truncate_lines
;
503 /* Non-zero means we want a hollow cursor in windows that are not
504 selected. Zero means there's no cursor in such windows. */
506 int cursor_in_non_selected_windows
;
508 /* A scratch glyph row with contents used for generating truncation
509 glyphs. Also used in direct_output_for_insert. */
511 #define MAX_SCRATCH_GLYPHS 100
512 struct glyph_row scratch_glyph_row
;
513 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
515 /* Ascent and height of the last line processed by move_it_to. */
517 static int last_max_ascent
, last_height
;
519 /* Non-zero if there's a help-echo in the echo area. */
521 int help_echo_showing_p
;
523 /* If >= 0, computed, exact values of mode-line and header-line height
524 to use in the macros CURRENT_MODE_LINE_HEIGHT and
525 CURRENT_HEADER_LINE_HEIGHT. */
527 int current_mode_line_height
, current_header_line_height
;
529 /* The maximum distance to look ahead for text properties. Values
530 that are too small let us call compute_char_face and similar
531 functions too often which is expensive. Values that are too large
532 let us call compute_char_face and alike too often because we
533 might not be interested in text properties that far away. */
535 #define TEXT_PROP_DISTANCE_LIMIT 100
539 /* Non-zero means print traces of redisplay if compiled with
542 int trace_redisplay_p
;
544 #endif /* GLYPH_DEBUG */
546 #ifdef DEBUG_TRACE_MOVE
547 /* Non-zero means trace with TRACE_MOVE to stderr. */
550 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
552 #define TRACE_MOVE(x) (void) 0
555 /* Non-zero means automatically scroll windows horizontally to make
558 int automatic_hscrolling_p
;
560 /* A list of symbols, one for each supported image type. */
562 Lisp_Object Vimage_types
;
564 /* The variable `resize-mini-windows'. If nil, don't resize
565 mini-windows. If t, always resize them to fit the text they
566 display. If `grow-only', let mini-windows grow only until they
569 Lisp_Object Vresize_mini_windows
;
571 /* Value returned from text property handlers (see below). */
576 HANDLED_RECOMPUTE_PROPS
,
577 HANDLED_OVERLAY_STRING_CONSUMED
,
581 /* A description of text properties that redisplay is interested
586 /* The name of the property. */
589 /* A unique index for the property. */
592 /* A handler function called to set up iterator IT from the property
593 at IT's current position. Value is used to steer handle_stop. */
594 enum prop_handled (*handler
) P_ ((struct it
*it
));
597 static enum prop_handled handle_face_prop
P_ ((struct it
*));
598 static enum prop_handled handle_invisible_prop
P_ ((struct it
*));
599 static enum prop_handled handle_display_prop
P_ ((struct it
*));
600 static enum prop_handled handle_composition_prop
P_ ((struct it
*));
601 static enum prop_handled handle_overlay_change
P_ ((struct it
*));
602 static enum prop_handled handle_fontified_prop
P_ ((struct it
*));
604 /* Properties handled by iterators. */
606 static struct props it_props
[] =
608 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
609 /* Handle `face' before `display' because some sub-properties of
610 `display' need to know the face. */
611 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
612 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
613 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
614 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
618 /* Value is the position described by X. If X is a marker, value is
619 the marker_position of X. Otherwise, value is X. */
621 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
623 /* Enumeration returned by some move_it_.* functions internally. */
627 /* Not used. Undefined value. */
630 /* Move ended at the requested buffer position or ZV. */
631 MOVE_POS_MATCH_OR_ZV
,
633 /* Move ended at the requested X pixel position. */
636 /* Move within a line ended at the end of a line that must be
640 /* Move within a line ended at the end of a line that would
641 be displayed truncated. */
644 /* Move within a line ended at a line end. */
650 /* Function prototypes. */
652 static int cursor_row_p
P_ ((struct window
*, struct glyph_row
*));
653 static int redisplay_mode_lines
P_ ((Lisp_Object
, int));
654 static char *decode_mode_spec_coding
P_ ((Lisp_Object
, char *, int));
655 static int invisible_text_between_p
P_ ((struct it
*, int, int));
656 static int next_element_from_ellipsis
P_ ((struct it
*));
657 static void pint2str
P_ ((char *, int, int));
658 static struct text_pos run_window_scroll_functions
P_ ((Lisp_Object
,
660 static void reconsider_clip_changes
P_ ((struct window
*, struct buffer
*));
661 static int text_outside_line_unchanged_p
P_ ((struct window
*, int, int));
662 static void store_frame_title_char
P_ ((char));
663 static int store_frame_title
P_ ((unsigned char *, int, int));
664 static void x_consider_frame_title
P_ ((Lisp_Object
));
665 static void handle_stop
P_ ((struct it
*));
666 static int tool_bar_lines_needed
P_ ((struct frame
*));
667 static int single_display_prop_intangible_p
P_ ((Lisp_Object
));
668 static void ensure_echo_area_buffers
P_ ((void));
669 static struct glyph_row
*row_containing_pos
P_ ((struct window
*, int,
671 struct glyph_row
*));
672 static Lisp_Object unwind_with_echo_area_buffer
P_ ((Lisp_Object
));
673 static Lisp_Object with_echo_area_buffer_unwind_data
P_ ((struct window
*));
674 static int with_echo_area_buffer
P_ ((struct window
*, int,
675 int (*) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
676 EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
677 static void clear_garbaged_frames
P_ ((void));
678 static int current_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
679 static int truncate_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
680 static int set_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
681 static int display_echo_area
P_ ((struct window
*));
682 static int display_echo_area_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
683 static int resize_mini_window_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
684 static Lisp_Object unwind_redisplay
P_ ((Lisp_Object
));
685 static int string_char_and_length
P_ ((unsigned char *, int, int *));
686 static struct text_pos display_prop_end
P_ ((struct it
*, Lisp_Object
,
688 static int compute_window_start_on_continuation_line
P_ ((struct window
*));
689 static Lisp_Object safe_eval_handler
P_ ((Lisp_Object
));
690 static void insert_left_trunc_glyphs
P_ ((struct it
*));
691 static struct glyph_row
*get_overlay_arrow_glyph_row
P_ ((struct window
*));
692 static void extend_face_to_end_of_line
P_ ((struct it
*));
693 static int append_space
P_ ((struct it
*, int));
694 static void make_cursor_line_fully_visible
P_ ((struct window
*));
695 static int try_scrolling
P_ ((Lisp_Object
, int, int, int, int));
696 static int try_cursor_movement
P_ ((Lisp_Object
, struct text_pos
, int *));
697 static int trailing_whitespace_p
P_ ((int));
698 static int message_log_check_duplicate
P_ ((int, int, int, int));
699 int invisible_p
P_ ((Lisp_Object
, Lisp_Object
));
700 int invisible_ellipsis_p
P_ ((Lisp_Object
, Lisp_Object
));
701 static void push_it
P_ ((struct it
*));
702 static void pop_it
P_ ((struct it
*));
703 static void sync_frame_with_window_matrix_rows
P_ ((struct window
*));
704 static void redisplay_internal
P_ ((int));
705 static int echo_area_display
P_ ((int));
706 static void redisplay_windows
P_ ((Lisp_Object
));
707 static void redisplay_window
P_ ((Lisp_Object
, int));
708 static void update_menu_bar
P_ ((struct frame
*, int));
709 static int try_window_reusing_current_matrix
P_ ((struct window
*));
710 static int try_window_id
P_ ((struct window
*));
711 static int display_line
P_ ((struct it
*));
712 static int display_mode_lines
P_ ((struct window
*));
713 static int display_mode_line
P_ ((struct window
*, enum face_id
, Lisp_Object
));
714 static int display_mode_element
P_ ((struct it
*, int, int, int, Lisp_Object
));
715 static char *decode_mode_spec
P_ ((struct window
*, int, int, int));
716 static void display_menu_bar
P_ ((struct window
*));
717 static int display_count_lines
P_ ((int, int, int, int, int *));
718 static int display_string
P_ ((unsigned char *, Lisp_Object
, Lisp_Object
,
719 int, int, struct it
*, int, int, int, int));
720 static void compute_line_metrics
P_ ((struct it
*));
721 static void run_redisplay_end_trigger_hook
P_ ((struct it
*));
722 static int get_overlay_strings
P_ ((struct it
*));
723 static void next_overlay_string
P_ ((struct it
*));
724 static void reseat
P_ ((struct it
*, struct text_pos
, int));
725 static void reseat_1
P_ ((struct it
*, struct text_pos
, int));
726 static void back_to_previous_visible_line_start
P_ ((struct it
*));
727 static void reseat_at_previous_visible_line_start
P_ ((struct it
*));
728 static void reseat_at_next_visible_line_start
P_ ((struct it
*, int));
729 static int next_element_from_display_vector
P_ ((struct it
*));
730 static int next_element_from_string
P_ ((struct it
*));
731 static int next_element_from_c_string
P_ ((struct it
*));
732 static int next_element_from_buffer
P_ ((struct it
*));
733 static int next_element_from_composition
P_ ((struct it
*));
734 static int next_element_from_image
P_ ((struct it
*));
735 static int next_element_from_stretch
P_ ((struct it
*));
736 static void load_overlay_strings
P_ ((struct it
*));
737 static void init_from_display_pos
P_ ((struct it
*, struct window
*,
738 struct display_pos
*));
739 static void reseat_to_string
P_ ((struct it
*, unsigned char *,
740 Lisp_Object
, int, int, int, int));
741 static enum move_it_result move_it_in_display_line_to
P_ ((struct it
*,
743 void move_it_vertically_backward
P_ ((struct it
*, int));
744 static void init_to_row_start
P_ ((struct it
*, struct window
*,
745 struct glyph_row
*));
746 static void init_to_row_end
P_ ((struct it
*, struct window
*,
747 struct glyph_row
*));
748 static void back_to_previous_line_start
P_ ((struct it
*));
749 static int forward_to_next_line_start
P_ ((struct it
*, int *));
750 static struct text_pos string_pos_nchars_ahead
P_ ((struct text_pos
,
752 static struct text_pos string_pos
P_ ((int, Lisp_Object
));
753 static struct text_pos c_string_pos
P_ ((int, unsigned char *, int));
754 static int number_of_chars
P_ ((unsigned char *, int));
755 static void compute_stop_pos
P_ ((struct it
*));
756 static void compute_string_pos
P_ ((struct text_pos
*, struct text_pos
,
758 static int face_before_or_after_it_pos
P_ ((struct it
*, int));
759 static int next_overlay_change
P_ ((int));
760 static int handle_single_display_prop
P_ ((struct it
*, Lisp_Object
,
761 Lisp_Object
, struct text_pos
*));
762 static int underlying_face_id
P_ ((struct it
*));
764 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
765 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
767 #ifdef HAVE_WINDOW_SYSTEM
769 static void update_tool_bar
P_ ((struct frame
*, int));
770 static void build_desired_tool_bar_string
P_ ((struct frame
*f
));
771 static int redisplay_tool_bar
P_ ((struct frame
*));
772 static void display_tool_bar_line
P_ ((struct it
*));
774 #endif /* HAVE_WINDOW_SYSTEM */
777 /***********************************************************************
778 Window display dimensions
779 ***********************************************************************/
781 /* Return the window-relative maximum y + 1 for glyph rows displaying
782 text in window W. This is the height of W minus the height of a
783 mode line, if any. */
786 window_text_bottom_y (w
)
789 struct frame
*f
= XFRAME (w
->frame
);
790 int height
= XFASTINT (w
->height
) * CANON_Y_UNIT (f
);
792 if (WINDOW_WANTS_MODELINE_P (w
))
793 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
798 /* Return the pixel width of display area AREA of window W. AREA < 0
799 means return the total width of W, not including bitmap areas to
800 the left and right of the window. */
803 window_box_width (w
, area
)
807 struct frame
*f
= XFRAME (w
->frame
);
808 int width
= XFASTINT (w
->width
);
810 if (!w
->pseudo_window_p
)
812 width
-= FRAME_SCROLL_BAR_WIDTH (f
) + FRAME_FLAGS_AREA_COLS (f
);
814 if (area
== TEXT_AREA
)
816 if (INTEGERP (w
->left_margin_width
))
817 width
-= XFASTINT (w
->left_margin_width
);
818 if (INTEGERP (w
->right_margin_width
))
819 width
-= XFASTINT (w
->right_margin_width
);
821 else if (area
== LEFT_MARGIN_AREA
)
822 width
= (INTEGERP (w
->left_margin_width
)
823 ? XFASTINT (w
->left_margin_width
) : 0);
824 else if (area
== RIGHT_MARGIN_AREA
)
825 width
= (INTEGERP (w
->right_margin_width
)
826 ? XFASTINT (w
->right_margin_width
) : 0);
829 return width
* CANON_X_UNIT (f
);
833 /* Return the pixel height of the display area of window W, not
834 including mode lines of W, if any.. */
837 window_box_height (w
)
840 struct frame
*f
= XFRAME (w
->frame
);
841 int height
= XFASTINT (w
->height
) * CANON_Y_UNIT (f
);
843 xassert (height
>= 0);
845 /* Note: the code below that determines the mode-line/header-line
846 height is essentially the same as that contained in the macro
847 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
848 the appropriate glyph row has its `mode_line_p' flag set,
849 and if it doesn't, uses estimate_mode_line_height instead. */
851 if (WINDOW_WANTS_MODELINE_P (w
))
853 struct glyph_row
*ml_row
854 = (w
->current_matrix
&& w
->current_matrix
->rows
855 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
857 if (ml_row
&& ml_row
->mode_line_p
)
858 height
-= ml_row
->height
;
860 height
-= estimate_mode_line_height (f
, MODE_LINE_FACE_ID
);
863 if (WINDOW_WANTS_HEADER_LINE_P (w
))
865 struct glyph_row
*hl_row
866 = (w
->current_matrix
&& w
->current_matrix
->rows
867 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
869 if (hl_row
&& hl_row
->mode_line_p
)
870 height
-= hl_row
->height
;
872 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
879 /* Return the frame-relative coordinate of the left edge of display
880 area AREA of window W. AREA < 0 means return the left edge of the
881 whole window, to the right of any bitmap area at the left side of
885 window_box_left (w
, area
)
889 struct frame
*f
= XFRAME (w
->frame
);
890 int x
= FRAME_INTERNAL_BORDER_WIDTH_SAFE (f
);
892 if (!w
->pseudo_window_p
)
894 x
+= (WINDOW_LEFT_MARGIN (w
) * CANON_X_UNIT (f
)
895 + FRAME_LEFT_FLAGS_AREA_WIDTH (f
));
897 if (area
== TEXT_AREA
)
898 x
+= window_box_width (w
, LEFT_MARGIN_AREA
);
899 else if (area
== RIGHT_MARGIN_AREA
)
900 x
+= (window_box_width (w
, LEFT_MARGIN_AREA
)
901 + window_box_width (w
, TEXT_AREA
));
908 /* Return the frame-relative coordinate of the right edge of display
909 area AREA of window W. AREA < 0 means return the left edge of the
910 whole window, to the left of any bitmap area at the right side of
914 window_box_right (w
, area
)
918 return window_box_left (w
, area
) + window_box_width (w
, area
);
922 /* Get the bounding box of the display area AREA of window W, without
923 mode lines, in frame-relative coordinates. AREA < 0 means the
924 whole window, not including bitmap areas to the left and right of
925 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
926 coordinates of the upper-left corner of the box. Return in
927 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
930 window_box (w
, area
, box_x
, box_y
, box_width
, box_height
)
933 int *box_x
, *box_y
, *box_width
, *box_height
;
935 struct frame
*f
= XFRAME (w
->frame
);
937 *box_width
= window_box_width (w
, area
);
938 *box_height
= window_box_height (w
);
939 *box_x
= window_box_left (w
, area
);
940 *box_y
= (FRAME_INTERNAL_BORDER_WIDTH_SAFE (f
)
941 + XFASTINT (w
->top
) * CANON_Y_UNIT (f
));
942 if (WINDOW_WANTS_HEADER_LINE_P (w
))
943 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
947 /* Get the bounding box of the display area AREA of window W, without
948 mode lines. AREA < 0 means the whole window, not including bitmap
949 areas to the left and right of the window. Return in *TOP_LEFT_X
950 and TOP_LEFT_Y the frame-relative pixel coordinates of the
951 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
952 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
956 window_box_edges (w
, area
, top_left_x
, top_left_y
,
957 bottom_right_x
, bottom_right_y
)
960 int *top_left_x
, *top_left_y
, *bottom_right_x
, *bottom_right_y
;
962 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
964 *bottom_right_x
+= *top_left_x
;
965 *bottom_right_y
+= *top_left_y
;
970 /***********************************************************************
972 ***********************************************************************/
974 /* Return 1 if position CHARPOS is visible in window W. Set *FULLY to
975 1 if POS is visible and the line containing POS is fully visible.
976 EXACT_MODE_LINE_HEIGHTS_P non-zero means compute exact mode-line
977 and header-lines heights. */
980 pos_visible_p (w
, charpos
, fully
, exact_mode_line_heights_p
)
982 int charpos
, *fully
, exact_mode_line_heights_p
;
987 struct buffer
*old_buffer
= NULL
;
989 if (XBUFFER (w
->buffer
) != current_buffer
)
991 old_buffer
= current_buffer
;
992 set_buffer_internal_1 (XBUFFER (w
->buffer
));
995 *fully
= visible_p
= 0;
996 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
998 /* Compute exact mode line heights, if requested. */
999 if (exact_mode_line_heights_p
)
1001 if (WINDOW_WANTS_MODELINE_P (w
))
1002 current_mode_line_height
1003 = display_mode_line (w
, MODE_LINE_FACE_ID
,
1004 current_buffer
->mode_line_format
);
1006 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1007 current_header_line_height
1008 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1009 current_buffer
->header_line_format
);
1012 start_display (&it
, w
, top
);
1013 move_it_to (&it
, charpos
, 0, it
.last_visible_y
, -1,
1014 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
1016 if (IT_CHARPOS (it
) == charpos
)
1018 int line_height
, line_bottom_y
;
1019 int line_top_y
= it
.current_y
;
1020 int window_top_y
= WINDOW_DISPLAY_HEADER_LINE_HEIGHT (w
);
1022 line_height
= it
.max_ascent
+ it
.max_descent
;
1023 if (line_height
== 0)
1026 line_height
= last_height
;
1027 else if (charpos
< ZV
)
1029 move_it_by_lines (&it
, 1, 1);
1030 line_height
= (it
.max_ascent
|| it
.max_descent
1031 ? it
.max_ascent
+ it
.max_descent
1036 /* Use the default character height. */
1037 it
.what
= IT_CHARACTER
;
1040 PRODUCE_GLYPHS (&it
);
1041 line_height
= it
.ascent
+ it
.descent
;
1044 line_bottom_y
= line_top_y
+ line_height
;
1046 if (line_top_y
< window_top_y
)
1047 visible_p
= line_bottom_y
> window_top_y
;
1048 else if (line_top_y
< it
.last_visible_y
)
1051 *fully
= line_bottom_y
<= it
.last_visible_y
;
1054 else if (it
.current_y
+ it
.max_ascent
+ it
.max_descent
> it
.last_visible_y
)
1056 move_it_by_lines (&it
, 1, 0);
1057 if (charpos
< IT_CHARPOS (it
))
1065 set_buffer_internal_1 (old_buffer
);
1067 current_header_line_height
= current_mode_line_height
= -1;
1072 /* Return the next character from STR which is MAXLEN bytes long.
1073 Return in *LEN the length of the character. This is like
1074 STRING_CHAR_AND_LENGTH but never returns an invalid character. If
1075 we find one, we return a `?', but with the length of the invalid
1079 string_char_and_length (str
, maxlen
, len
)
1085 c
= STRING_CHAR_AND_LENGTH (str
, maxlen
, *len
);
1086 if (!CHAR_VALID_P (c
, 1))
1087 /* We may not change the length here because other places in Emacs
1088 don't use this function, i.e. they silently accept invalid
1097 /* Given a position POS containing a valid character and byte position
1098 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1100 static struct text_pos
1101 string_pos_nchars_ahead (pos
, string
, nchars
)
1102 struct text_pos pos
;
1106 xassert (STRINGP (string
) && nchars
>= 0);
1108 if (STRING_MULTIBYTE (string
))
1110 int rest
= STRING_BYTES (XSTRING (string
)) - BYTEPOS (pos
);
1111 unsigned char *p
= XSTRING (string
)->data
+ BYTEPOS (pos
);
1116 string_char_and_length (p
, rest
, &len
);
1117 p
+= len
, rest
-= len
;
1118 xassert (rest
>= 0);
1120 BYTEPOS (pos
) += len
;
1124 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1130 /* Value is the text position, i.e. character and byte position,
1131 for character position CHARPOS in STRING. */
1133 static INLINE
struct text_pos
1134 string_pos (charpos
, string
)
1138 struct text_pos pos
;
1139 xassert (STRINGP (string
));
1140 xassert (charpos
>= 0);
1141 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1146 /* Value is a text position, i.e. character and byte position, for
1147 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1148 means recognize multibyte characters. */
1150 static struct text_pos
1151 c_string_pos (charpos
, s
, multibyte_p
)
1156 struct text_pos pos
;
1158 xassert (s
!= NULL
);
1159 xassert (charpos
>= 0);
1163 int rest
= strlen (s
), len
;
1165 SET_TEXT_POS (pos
, 0, 0);
1168 string_char_and_length (s
, rest
, &len
);
1169 s
+= len
, rest
-= len
;
1170 xassert (rest
>= 0);
1172 BYTEPOS (pos
) += len
;
1176 SET_TEXT_POS (pos
, charpos
, charpos
);
1182 /* Value is the number of characters in C string S. MULTIBYTE_P
1183 non-zero means recognize multibyte characters. */
1186 number_of_chars (s
, multibyte_p
)
1194 int rest
= strlen (s
), len
;
1195 unsigned char *p
= (unsigned char *) s
;
1197 for (nchars
= 0; rest
> 0; ++nchars
)
1199 string_char_and_length (p
, rest
, &len
);
1200 rest
-= len
, p
+= len
;
1204 nchars
= strlen (s
);
1210 /* Compute byte position NEWPOS->bytepos corresponding to
1211 NEWPOS->charpos. POS is a known position in string STRING.
1212 NEWPOS->charpos must be >= POS.charpos. */
1215 compute_string_pos (newpos
, pos
, string
)
1216 struct text_pos
*newpos
, pos
;
1219 xassert (STRINGP (string
));
1220 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1222 if (STRING_MULTIBYTE (string
))
1223 *newpos
= string_pos_nchars_ahead (pos
, string
,
1224 CHARPOS (*newpos
) - CHARPOS (pos
));
1226 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1231 /***********************************************************************
1232 Lisp form evaluation
1233 ***********************************************************************/
1235 /* Error handler for safe_eval and safe_call. */
1238 safe_eval_handler (arg
)
1241 add_to_log ("Error during redisplay: %s", arg
, Qnil
);
1246 /* Evaluate SEXPR and return the result, or nil if something went
1253 int count
= BINDING_STACK_SIZE ();
1254 struct gcpro gcpro1
;
1258 specbind (Qinhibit_redisplay
, Qt
);
1259 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
, safe_eval_handler
);
1261 return unbind_to (count
, val
);
1265 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
1266 Return the result, or nil if something went wrong. */
1269 safe_call (nargs
, args
)
1273 int count
= BINDING_STACK_SIZE ();
1275 struct gcpro gcpro1
;
1278 gcpro1
.nvars
= nargs
;
1279 specbind (Qinhibit_redisplay
, Qt
);
1280 val
= internal_condition_case_2 (Ffuncall
, nargs
, args
, Qerror
,
1283 return unbind_to (count
, val
);
1287 /* Call function FN with one argument ARG.
1288 Return the result, or nil if something went wrong. */
1291 safe_call1 (fn
, arg
)
1292 Lisp_Object fn
, arg
;
1294 Lisp_Object args
[2];
1297 return safe_call (2, args
);
1302 /***********************************************************************
1304 ***********************************************************************/
1308 /* Define CHECK_IT to perform sanity checks on iterators.
1309 This is for debugging. It is too slow to do unconditionally. */
1315 if (it
->method
== next_element_from_string
)
1317 xassert (STRINGP (it
->string
));
1318 xassert (IT_STRING_CHARPOS (*it
) >= 0);
1320 else if (it
->method
== next_element_from_buffer
)
1322 /* Check that character and byte positions agree. */
1323 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
1327 xassert (it
->current
.dpvec_index
>= 0);
1329 xassert (it
->current
.dpvec_index
< 0);
1332 #define CHECK_IT(IT) check_it ((IT))
1336 #define CHECK_IT(IT) (void) 0
1343 /* Check that the window end of window W is what we expect it
1344 to be---the last row in the current matrix displaying text. */
1347 check_window_end (w
)
1350 if (!MINI_WINDOW_P (w
)
1351 && !NILP (w
->window_end_valid
))
1353 struct glyph_row
*row
;
1354 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
1355 XFASTINT (w
->window_end_vpos
)),
1357 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
1358 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
1362 #define CHECK_WINDOW_END(W) check_window_end ((W))
1364 #else /* not GLYPH_DEBUG */
1366 #define CHECK_WINDOW_END(W) (void) 0
1368 #endif /* not GLYPH_DEBUG */
1372 /***********************************************************************
1373 Iterator initialization
1374 ***********************************************************************/
1376 /* Initialize IT for displaying current_buffer in window W, starting
1377 at character position CHARPOS. CHARPOS < 0 means that no buffer
1378 position is specified which is useful when the iterator is assigned
1379 a position later. BYTEPOS is the byte position corresponding to
1380 CHARPOS. BYTEPOS <= 0 means compute it from CHARPOS.
1382 If ROW is not null, calls to produce_glyphs with IT as parameter
1383 will produce glyphs in that row.
1385 BASE_FACE_ID is the id of a base face to use. It must be one of
1386 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID or
1387 HEADER_LINE_FACE_ID for displaying mode lines, or TOOL_BAR_FACE_ID for
1388 displaying the tool-bar.
1390 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID or
1391 HEADER_LINE_FACE_ID, the iterator will be initialized to use the
1392 corresponding mode line glyph row of the desired matrix of W. */
1395 init_iterator (it
, w
, charpos
, bytepos
, row
, base_face_id
)
1398 int charpos
, bytepos
;
1399 struct glyph_row
*row
;
1400 enum face_id base_face_id
;
1402 int highlight_region_p
;
1404 /* Some precondition checks. */
1405 xassert (w
!= NULL
&& it
!= NULL
);
1406 xassert (charpos
< 0 || (charpos
> 0 && charpos
<= ZV
));
1408 /* If face attributes have been changed since the last redisplay,
1409 free realized faces now because they depend on face definitions
1410 that might have changed. */
1411 if (face_change_count
)
1413 face_change_count
= 0;
1414 free_all_realized_faces (Qnil
);
1417 /* Use one of the mode line rows of W's desired matrix if
1421 if (base_face_id
== MODE_LINE_FACE_ID
)
1422 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
1423 else if (base_face_id
== HEADER_LINE_FACE_ID
)
1424 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
1428 bzero (it
, sizeof *it
);
1429 it
->current
.overlay_string_index
= -1;
1430 it
->current
.dpvec_index
= -1;
1431 it
->base_face_id
= base_face_id
;
1433 /* The window in which we iterate over current_buffer: */
1434 XSETWINDOW (it
->window
, w
);
1436 it
->f
= XFRAME (w
->frame
);
1438 /* Extra space between lines (on window systems only). */
1439 if (base_face_id
== DEFAULT_FACE_ID
1440 && FRAME_WINDOW_P (it
->f
))
1442 if (NATNUMP (current_buffer
->extra_line_spacing
))
1443 it
->extra_line_spacing
= XFASTINT (current_buffer
->extra_line_spacing
);
1444 else if (it
->f
->extra_line_spacing
> 0)
1445 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
1448 /* If realized faces have been removed, e.g. because of face
1449 attribute changes of named faces, recompute them. When running
1450 in batch mode, the face cache of Vterminal_frame is null. If
1451 we happen to get called, make a dummy face cache. */
1452 if (noninteractive
&& FRAME_FACE_CACHE (it
->f
) == NULL
)
1453 init_frame_faces (it
->f
);
1454 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
1455 recompute_basic_faces (it
->f
);
1457 /* Current value of the `space-width', and 'height' properties. */
1458 it
->space_width
= Qnil
;
1459 it
->font_height
= Qnil
;
1461 /* Are control characters displayed as `^C'? */
1462 it
->ctl_arrow_p
= !NILP (current_buffer
->ctl_arrow
);
1464 /* -1 means everything between a CR and the following line end
1465 is invisible. >0 means lines indented more than this value are
1467 it
->selective
= (INTEGERP (current_buffer
->selective_display
)
1468 ? XFASTINT (current_buffer
->selective_display
)
1469 : (!NILP (current_buffer
->selective_display
)
1471 it
->selective_display_ellipsis_p
1472 = !NILP (current_buffer
->selective_display_ellipses
);
1474 /* Display table to use. */
1475 it
->dp
= window_display_table (w
);
1477 /* Are multibyte characters enabled in current_buffer? */
1478 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
1480 /* Non-zero if we should highlight the region. */
1482 = (!NILP (Vtransient_mark_mode
)
1483 && !NILP (current_buffer
->mark_active
)
1484 && XMARKER (current_buffer
->mark
)->buffer
!= 0);
1486 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
1487 start and end of a visible region in window IT->w. Set both to
1488 -1 to indicate no region. */
1489 if (highlight_region_p
1490 /* Maybe highlight only in selected window. */
1491 && (/* Either show region everywhere. */
1492 highlight_nonselected_windows
1493 /* Or show region in the selected window. */
1494 || w
== XWINDOW (selected_window
)
1495 /* Or show the region if we are in the mini-buffer and W is
1496 the window the mini-buffer refers to. */
1497 || (MINI_WINDOW_P (XWINDOW (selected_window
))
1498 && w
== XWINDOW (Vminibuf_scroll_window
))))
1500 int charpos
= marker_position (current_buffer
->mark
);
1501 it
->region_beg_charpos
= min (PT
, charpos
);
1502 it
->region_end_charpos
= max (PT
, charpos
);
1505 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
1507 /* Get the position at which the redisplay_end_trigger hook should
1508 be run, if it is to be run at all. */
1509 if (MARKERP (w
->redisplay_end_trigger
)
1510 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
1511 it
->redisplay_end_trigger_charpos
1512 = marker_position (w
->redisplay_end_trigger
);
1513 else if (INTEGERP (w
->redisplay_end_trigger
))
1514 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
1516 /* Correct bogus values of tab_width. */
1517 it
->tab_width
= XINT (current_buffer
->tab_width
);
1518 if (it
->tab_width
<= 0 || it
->tab_width
> 1000)
1521 /* Are lines in the display truncated? */
1522 it
->truncate_lines_p
1523 = (base_face_id
!= DEFAULT_FACE_ID
1524 || XINT (it
->w
->hscroll
)
1525 || (truncate_partial_width_windows
1526 && !WINDOW_FULL_WIDTH_P (it
->w
))
1527 || !NILP (current_buffer
->truncate_lines
));
1529 /* Get dimensions of truncation and continuation glyphs. These are
1530 displayed as bitmaps under X, so we don't need them for such
1532 if (!FRAME_WINDOW_P (it
->f
))
1534 if (it
->truncate_lines_p
)
1536 /* We will need the truncation glyph. */
1537 xassert (it
->glyph_row
== NULL
);
1538 produce_special_glyphs (it
, IT_TRUNCATION
);
1539 it
->truncation_pixel_width
= it
->pixel_width
;
1543 /* We will need the continuation glyph. */
1544 xassert (it
->glyph_row
== NULL
);
1545 produce_special_glyphs (it
, IT_CONTINUATION
);
1546 it
->continuation_pixel_width
= it
->pixel_width
;
1549 /* Reset these values to zero becaue the produce_special_glyphs
1550 above has changed them. */
1551 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
1552 it
->phys_ascent
= it
->phys_descent
= 0;
1555 /* Set this after getting the dimensions of truncation and
1556 continuation glyphs, so that we don't produce glyphs when calling
1557 produce_special_glyphs, above. */
1558 it
->glyph_row
= row
;
1559 it
->area
= TEXT_AREA
;
1561 /* Get the dimensions of the display area. The display area
1562 consists of the visible window area plus a horizontally scrolled
1563 part to the left of the window. All x-values are relative to the
1564 start of this total display area. */
1565 if (base_face_id
!= DEFAULT_FACE_ID
)
1567 /* Mode lines, menu bar in terminal frames. */
1568 it
->first_visible_x
= 0;
1569 it
->last_visible_x
= XFASTINT (w
->width
) * CANON_X_UNIT (it
->f
);
1574 = XFASTINT (it
->w
->hscroll
) * CANON_X_UNIT (it
->f
);
1575 it
->last_visible_x
= (it
->first_visible_x
1576 + window_box_width (w
, TEXT_AREA
));
1578 /* If we truncate lines, leave room for the truncator glyph(s) at
1579 the right margin. Otherwise, leave room for the continuation
1580 glyph(s). Truncation and continuation glyphs are not inserted
1581 for window-based redisplay. */
1582 if (!FRAME_WINDOW_P (it
->f
))
1584 if (it
->truncate_lines_p
)
1585 it
->last_visible_x
-= it
->truncation_pixel_width
;
1587 it
->last_visible_x
-= it
->continuation_pixel_width
;
1590 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
1591 it
->current_y
= WINDOW_DISPLAY_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
1594 /* Leave room for a border glyph. */
1595 if (!FRAME_WINDOW_P (it
->f
)
1596 && !WINDOW_RIGHTMOST_P (it
->w
))
1597 it
->last_visible_x
-= 1;
1599 it
->last_visible_y
= window_text_bottom_y (w
);
1601 /* For mode lines and alike, arrange for the first glyph having a
1602 left box line if the face specifies a box. */
1603 if (base_face_id
!= DEFAULT_FACE_ID
)
1607 it
->face_id
= base_face_id
;
1609 /* If we have a boxed mode line, make the first character appear
1610 with a left box line. */
1611 face
= FACE_FROM_ID (it
->f
, base_face_id
);
1612 if (face
->box
!= FACE_NO_BOX
)
1613 it
->start_of_box_run_p
= 1;
1616 /* If a buffer position was specified, set the iterator there,
1617 getting overlays and face properties from that position. */
1620 it
->end_charpos
= ZV
;
1622 IT_CHARPOS (*it
) = charpos
;
1624 /* Compute byte position if not specified. */
1626 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
1628 IT_BYTEPOS (*it
) = bytepos
;
1630 /* Compute faces etc. */
1631 reseat (it
, it
->current
.pos
, 1);
1638 /* Initialize IT for the display of window W with window start POS. */
1641 start_display (it
, w
, pos
)
1644 struct text_pos pos
;
1646 int start_at_line_beg_p
;
1647 struct glyph_row
*row
;
1648 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
1651 row
= w
->desired_matrix
->rows
+ first_vpos
;
1652 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
1653 first_y
= it
->current_y
;
1655 /* If window start is not at a line start, move back to the line
1656 start. This makes sure that we take continuation lines into
1658 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
1659 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
1660 if (!start_at_line_beg_p
)
1661 reseat_at_previous_visible_line_start (it
);
1663 /* If window start is not at a line start, skip forward to POS to
1664 get the correct continuation_lines_width and current_x. */
1665 if (!start_at_line_beg_p
)
1667 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
1669 /* If lines are continued, this line may end in the middle of a
1670 multi-glyph character (e.g. a control character displayed as
1671 \003, or in the middle of an overlay string). In this case
1672 move_it_to above will not have taken us to the start of
1673 the continuation line but to the end of the continued line. */
1674 if (!it
->truncate_lines_p
)
1676 if (it
->current_x
> 0)
1678 if (it
->current
.dpvec_index
>= 0
1679 || it
->current
.overlay_string_index
>= 0)
1681 set_iterator_to_next (it
, 1);
1682 move_it_in_display_line_to (it
, -1, -1, 0);
1685 it
->continuation_lines_width
+= it
->current_x
;
1688 /* We're starting a new display line, not affected by the
1689 height of the continued line, so clear the appropriate
1690 fields in the iterator structure. */
1691 it
->max_ascent
= it
->max_descent
= 0;
1692 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
1695 it
->current_y
= first_y
;
1697 it
->current_x
= it
->hpos
= 0;
1700 #if 0 /* Don't assert the following because start_display is sometimes
1701 called intentionally with a window start that is not at a
1702 line start. Please leave this code in as a comment. */
1704 /* Window start should be on a line start, now. */
1705 xassert (it
->continuation_lines_width
1706 || IT_CHARPOS (it
) == BEGV
1707 || FETCH_BYTE (IT_BYTEPOS (it
) - 1) == '\n');
1712 /* Initialize IT for stepping through current_buffer in window W,
1713 starting at position POS that includes overlay string and display
1714 vector/ control character translation position information. */
1717 init_from_display_pos (it
, w
, pos
)
1720 struct display_pos
*pos
;
1722 /* Keep in mind: the call to reseat in init_iterator skips invisible
1723 text, so we might end up at a position different from POS. This
1724 is only a problem when POS is a row start after a newline and an
1725 overlay starts there with an after-string, and the overlay has an
1726 invisible property. Since we don't skip invisible text in
1727 display_line and elsewhere immediately after consuming the
1728 newline before the row start, such a POS will not be in a string,
1729 but the call to init_iterator below will move us to the
1731 init_iterator (it
, w
, CHARPOS (pos
->pos
), BYTEPOS (pos
->pos
),
1732 NULL
, DEFAULT_FACE_ID
);
1734 /* If position is within an overlay string, set up IT to
1735 the right overlay string. */
1736 if (pos
->overlay_string_index
>= 0)
1740 /* We already have the first chunk of overlay strings in
1741 IT->overlay_strings. Load more until the one for
1742 pos->overlay_string_index is in IT->overlay_strings. */
1743 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
1745 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
1746 it
->current
.overlay_string_index
= 0;
1749 load_overlay_strings (it
);
1750 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
1754 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
1755 relative_index
= (it
->current
.overlay_string_index
1756 % OVERLAY_STRING_CHUNK_SIZE
);
1757 it
->string
= it
->overlay_strings
[relative_index
];
1758 xassert (STRINGP (it
->string
));
1759 it
->current
.string_pos
= pos
->string_pos
;
1760 it
->method
= next_element_from_string
;
1762 else if (it
->current
.overlay_string_index
>= 0)
1764 /* If POS says we're already after an overlay string ending at
1765 POS, make sure to pop the iterator because it will be in
1766 front of that overlay string. When POS is ZV, we've thereby
1767 also ``processed'' overlay strings at ZV. */
1769 it
->current
.overlay_string_index
= -1;
1770 it
->method
= next_element_from_buffer
;
1771 if (CHARPOS (pos
->pos
) == ZV
)
1772 it
->overlay_strings_at_end_processed_p
= 1;
1775 if (CHARPOS (pos
->string_pos
) >= 0)
1777 /* Recorded position is not in an overlay string, but in another
1778 string. This can only be a string from a `display' property.
1779 IT should already be filled with that string. */
1780 it
->current
.string_pos
= pos
->string_pos
;
1781 xassert (STRINGP (it
->string
));
1784 /* Restore position in display vector translations or control
1785 character translations. */
1786 if (pos
->dpvec_index
>= 0)
1788 /* This fills IT->dpvec. */
1789 get_next_display_element (it
);
1790 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
1791 it
->current
.dpvec_index
= pos
->dpvec_index
;
1798 /* Initialize IT for stepping through current_buffer in window W
1799 starting at ROW->start. */
1802 init_to_row_start (it
, w
, row
)
1805 struct glyph_row
*row
;
1807 init_from_display_pos (it
, w
, &row
->start
);
1808 it
->continuation_lines_width
= row
->continuation_lines_width
;
1813 /* Initialize IT for stepping through current_buffer in window W
1814 starting in the line following ROW, i.e. starting at ROW->end. */
1817 init_to_row_end (it
, w
, row
)
1820 struct glyph_row
*row
;
1822 init_from_display_pos (it
, w
, &row
->end
);
1824 if (row
->continued_p
)
1825 it
->continuation_lines_width
= (row
->continuation_lines_width
1826 + row
->pixel_width
);
1833 /***********************************************************************
1835 ***********************************************************************/
1837 /* Called when IT reaches IT->stop_charpos. Handle text property and
1838 overlay changes. Set IT->stop_charpos to the next position where
1845 enum prop_handled handled
;
1846 int handle_overlay_change_p
= 1;
1850 it
->current
.dpvec_index
= -1;
1854 handled
= HANDLED_NORMALLY
;
1856 /* Call text property handlers. */
1857 for (p
= it_props
; p
->handler
; ++p
)
1859 handled
= p
->handler (it
);
1861 if (handled
== HANDLED_RECOMPUTE_PROPS
)
1863 else if (handled
== HANDLED_RETURN
)
1865 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
1866 handle_overlay_change_p
= 0;
1869 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
1871 /* Don't check for overlay strings below when set to deliver
1872 characters from a display vector. */
1873 if (it
->method
== next_element_from_display_vector
)
1874 handle_overlay_change_p
= 0;
1876 /* Handle overlay changes. */
1877 if (handle_overlay_change_p
)
1878 handled
= handle_overlay_change (it
);
1880 /* Determine where to stop next. */
1881 if (handled
== HANDLED_NORMALLY
)
1882 compute_stop_pos (it
);
1885 while (handled
== HANDLED_RECOMPUTE_PROPS
);
1889 /* Compute IT->stop_charpos from text property and overlay change
1890 information for IT's current position. */
1893 compute_stop_pos (it
)
1896 register INTERVAL iv
, next_iv
;
1897 Lisp_Object object
, limit
, position
;
1899 /* If nowhere else, stop at the end. */
1900 it
->stop_charpos
= it
->end_charpos
;
1902 if (STRINGP (it
->string
))
1904 /* Strings are usually short, so don't limit the search for
1906 object
= it
->string
;
1908 XSETFASTINT (position
, IT_STRING_CHARPOS (*it
));
1914 /* If next overlay change is in front of the current stop pos
1915 (which is IT->end_charpos), stop there. Note: value of
1916 next_overlay_change is point-max if no overlay change
1918 charpos
= next_overlay_change (IT_CHARPOS (*it
));
1919 if (charpos
< it
->stop_charpos
)
1920 it
->stop_charpos
= charpos
;
1922 /* If showing the region, we have to stop at the region
1923 start or end because the face might change there. */
1924 if (it
->region_beg_charpos
> 0)
1926 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
1927 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
1928 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
1929 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
1932 /* Set up variables for computing the stop position from text
1933 property changes. */
1934 XSETBUFFER (object
, current_buffer
);
1935 XSETFASTINT (limit
, IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
1936 XSETFASTINT (position
, IT_CHARPOS (*it
));
1940 /* Get the interval containing IT's position. Value is a null
1941 interval if there isn't such an interval. */
1942 iv
= validate_interval_range (object
, &position
, &position
, 0);
1943 if (!NULL_INTERVAL_P (iv
))
1945 Lisp_Object values_here
[LAST_PROP_IDX
];
1948 /* Get properties here. */
1949 for (p
= it_props
; p
->handler
; ++p
)
1950 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
1952 /* Look for an interval following iv that has different
1954 for (next_iv
= next_interval (iv
);
1955 (!NULL_INTERVAL_P (next_iv
)
1957 || XFASTINT (limit
) > next_iv
->position
));
1958 next_iv
= next_interval (next_iv
))
1960 for (p
= it_props
; p
->handler
; ++p
)
1962 Lisp_Object new_value
;
1964 new_value
= textget (next_iv
->plist
, *p
->name
);
1965 if (!EQ (values_here
[p
->idx
], new_value
))
1973 if (!NULL_INTERVAL_P (next_iv
))
1975 if (INTEGERP (limit
)
1976 && next_iv
->position
>= XFASTINT (limit
))
1977 /* No text property change up to limit. */
1978 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
1980 /* Text properties change in next_iv. */
1981 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
1985 xassert (STRINGP (it
->string
)
1986 || (it
->stop_charpos
>= BEGV
1987 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
1991 /* Return the position of the next overlay change after POS in
1992 current_buffer. Value is point-max if no overlay change
1993 follows. This is like `next-overlay-change' but doesn't use
1997 next_overlay_change (pos
)
2002 Lisp_Object
*overlays
;
2006 /* Get all overlays at the given position. */
2008 overlays
= (Lisp_Object
*) alloca (len
* sizeof *overlays
);
2009 noverlays
= overlays_at (pos
, 0, &overlays
, &len
, &endpos
, NULL
, 1);
2010 if (noverlays
> len
)
2013 overlays
= (Lisp_Object
*) alloca (len
* sizeof *overlays
);
2014 noverlays
= overlays_at (pos
, 0, &overlays
, &len
, &endpos
, NULL
, 1);
2017 /* If any of these overlays ends before endpos,
2018 use its ending point instead. */
2019 for (i
= 0; i
< noverlays
; ++i
)
2024 oend
= OVERLAY_END (overlays
[i
]);
2025 oendpos
= OVERLAY_POSITION (oend
);
2026 endpos
= min (endpos
, oendpos
);
2034 /***********************************************************************
2036 ***********************************************************************/
2038 /* Handle changes in the `fontified' property of the current buffer by
2039 calling hook functions from Qfontification_functions to fontify
2042 static enum prop_handled
2043 handle_fontified_prop (it
)
2046 Lisp_Object prop
, pos
;
2047 enum prop_handled handled
= HANDLED_NORMALLY
;
2049 /* Get the value of the `fontified' property at IT's current buffer
2050 position. (The `fontified' property doesn't have a special
2051 meaning in strings.) If the value is nil, call functions from
2052 Qfontification_functions. */
2053 if (!STRINGP (it
->string
)
2055 && !NILP (Vfontification_functions
)
2056 && !NILP (Vrun_hooks
)
2057 && (pos
= make_number (IT_CHARPOS (*it
)),
2058 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
2061 int count
= BINDING_STACK_SIZE ();
2064 val
= Vfontification_functions
;
2065 specbind (Qfontification_functions
, Qnil
);
2066 specbind (Qafter_change_functions
, Qnil
);
2068 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
2069 safe_call1 (val
, pos
);
2072 Lisp_Object globals
, fn
;
2073 struct gcpro gcpro1
, gcpro2
;
2076 GCPRO2 (val
, globals
);
2078 for (; CONSP (val
); val
= XCDR (val
))
2084 /* A value of t indicates this hook has a local
2085 binding; it means to run the global binding too.
2086 In a global value, t should not occur. If it
2087 does, we must ignore it to avoid an endless
2089 for (globals
= Fdefault_value (Qfontification_functions
);
2091 globals
= XCDR (globals
))
2093 fn
= XCAR (globals
);
2095 safe_call1 (fn
, pos
);
2099 safe_call1 (fn
, pos
);
2105 unbind_to (count
, Qnil
);
2107 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
2108 something. This avoids an endless loop if they failed to
2109 fontify the text for which reason ever. */
2110 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
2111 handled
= HANDLED_RECOMPUTE_PROPS
;
2119 /***********************************************************************
2121 ***********************************************************************/
2123 /* Set up iterator IT from face properties at its current position.
2124 Called from handle_stop. */
2126 static enum prop_handled
2127 handle_face_prop (it
)
2130 int new_face_id
, next_stop
;
2132 if (!STRINGP (it
->string
))
2135 = face_at_buffer_position (it
->w
,
2137 it
->region_beg_charpos
,
2138 it
->region_end_charpos
,
2141 + TEXT_PROP_DISTANCE_LIMIT
),
2144 /* Is this a start of a run of characters with box face?
2145 Caveat: this can be called for a freshly initialized
2146 iterator; face_id is -1 is this case. We know that the new
2147 face will not change until limit, i.e. if the new face has a
2148 box, all characters up to limit will have one. But, as
2149 usual, we don't know whether limit is really the end. */
2150 if (new_face_id
!= it
->face_id
)
2152 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
2154 /* If new face has a box but old face has not, this is
2155 the start of a run of characters with box, i.e. it has
2156 a shadow on the left side. The value of face_id of the
2157 iterator will be -1 if this is the initial call that gets
2158 the face. In this case, we have to look in front of IT's
2159 position and see whether there is a face != new_face_id. */
2160 it
->start_of_box_run_p
2161 = (new_face
->box
!= FACE_NO_BOX
2162 && (it
->face_id
>= 0
2163 || IT_CHARPOS (*it
) == BEG
2164 || new_face_id
!= face_before_it_pos (it
)));
2165 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
2170 int base_face_id
, bufpos
;
2172 if (it
->current
.overlay_string_index
>= 0)
2173 bufpos
= IT_CHARPOS (*it
);
2177 /* For strings from a buffer, i.e. overlay strings or strings
2178 from a `display' property, use the face at IT's current
2179 buffer position as the base face to merge with, so that
2180 overlay strings appear in the same face as surrounding
2181 text, unless they specify their own faces. */
2182 base_face_id
= underlying_face_id (it
);
2184 new_face_id
= face_at_string_position (it
->w
,
2186 IT_STRING_CHARPOS (*it
),
2188 it
->region_beg_charpos
,
2189 it
->region_end_charpos
,
2193 #if 0 /* This shouldn't be neccessary. Let's check it. */
2194 /* If IT is used to display a mode line we would really like to
2195 use the mode line face instead of the frame's default face. */
2196 if (it
->glyph_row
== MATRIX_MODE_LINE_ROW (it
->w
->desired_matrix
)
2197 && new_face_id
== DEFAULT_FACE_ID
)
2198 new_face_id
= MODE_LINE_FACE_ID
;
2201 /* Is this a start of a run of characters with box? Caveat:
2202 this can be called for a freshly allocated iterator; face_id
2203 is -1 is this case. We know that the new face will not
2204 change until the next check pos, i.e. if the new face has a
2205 box, all characters up to that position will have a
2206 box. But, as usual, we don't know whether that position
2207 is really the end. */
2208 if (new_face_id
!= it
->face_id
)
2210 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
2211 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
2213 /* If new face has a box but old face hasn't, this is the
2214 start of a run of characters with box, i.e. it has a
2215 shadow on the left side. */
2216 it
->start_of_box_run_p
2217 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
2218 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
2222 it
->face_id
= new_face_id
;
2223 return HANDLED_NORMALLY
;
2227 /* Return the ID of the face ``underlying'' IT's current position,
2228 which is in a string. If the iterator is associated with a
2229 buffer, return the face at IT's current buffer position.
2230 Otherwise, use the iterator's base_face_id. */
2233 underlying_face_id (it
)
2236 int face_id
= it
->base_face_id
, i
;
2238 xassert (STRINGP (it
->string
));
2240 for (i
= it
->sp
- 1; i
>= 0; --i
)
2241 if (NILP (it
->stack
[i
].string
))
2242 face_id
= it
->stack
[i
].face_id
;
2248 /* Compute the face one character before or after the current position
2249 of IT. BEFORE_P non-zero means get the face in front of IT's
2250 position. Value is the id of the face. */
2253 face_before_or_after_it_pos (it
, before_p
)
2258 int next_check_charpos
;
2259 struct text_pos pos
;
2261 xassert (it
->s
== NULL
);
2263 if (STRINGP (it
->string
))
2265 int bufpos
, base_face_id
;
2267 /* No face change past the end of the string (for the case
2268 we are padding with spaces). No face change before the
2270 if (IT_STRING_CHARPOS (*it
) >= XSTRING (it
->string
)->size
2271 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
2274 /* Set pos to the position before or after IT's current position. */
2276 pos
= string_pos (IT_STRING_CHARPOS (*it
) - 1, it
->string
);
2278 /* For composition, we must check the character after the
2280 pos
= (it
->what
== IT_COMPOSITION
2281 ? string_pos (IT_STRING_CHARPOS (*it
) + it
->cmp_len
, it
->string
)
2282 : string_pos (IT_STRING_CHARPOS (*it
) + 1, it
->string
));
2284 if (it
->current
.overlay_string_index
>= 0)
2285 bufpos
= IT_CHARPOS (*it
);
2289 base_face_id
= underlying_face_id (it
);
2291 /* Get the face for ASCII, or unibyte. */
2292 face_id
= face_at_string_position (it
->w
,
2296 it
->region_beg_charpos
,
2297 it
->region_end_charpos
,
2298 &next_check_charpos
,
2301 /* Correct the face for charsets different from ASCII. Do it
2302 for the multibyte case only. The face returned above is
2303 suitable for unibyte text if IT->string is unibyte. */
2304 if (STRING_MULTIBYTE (it
->string
))
2306 unsigned char *p
= XSTRING (it
->string
)->data
+ BYTEPOS (pos
);
2307 int rest
= STRING_BYTES (XSTRING (it
->string
)) - BYTEPOS (pos
);
2309 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
2311 c
= string_char_and_length (p
, rest
, &len
);
2312 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
);
2317 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
2318 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
2321 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
2322 pos
= it
->current
.pos
;
2325 DEC_TEXT_POS (pos
, it
->multibyte_p
);
2328 if (it
->what
== IT_COMPOSITION
)
2329 /* For composition, we must check the position after the
2331 pos
.charpos
+= it
->cmp_len
, pos
.bytepos
+= it
->len
;
2333 INC_TEXT_POS (pos
, it
->multibyte_p
);
2336 /* Determine face for CHARSET_ASCII, or unibyte. */
2337 face_id
= face_at_buffer_position (it
->w
,
2339 it
->region_beg_charpos
,
2340 it
->region_end_charpos
,
2341 &next_check_charpos
,
2344 /* Correct the face for charsets different from ASCII. Do it
2345 for the multibyte case only. The face returned above is
2346 suitable for unibyte text if current_buffer is unibyte. */
2347 if (it
->multibyte_p
)
2349 int c
= FETCH_MULTIBYTE_CHAR (CHARPOS (pos
));
2350 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
2351 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
);
2360 /***********************************************************************
2362 ***********************************************************************/
2364 /* Set up iterator IT from invisible properties at its current
2365 position. Called from handle_stop. */
2367 static enum prop_handled
2368 handle_invisible_prop (it
)
2371 enum prop_handled handled
= HANDLED_NORMALLY
;
2373 if (STRINGP (it
->string
))
2375 extern Lisp_Object Qinvisible
;
2376 Lisp_Object prop
, end_charpos
, limit
, charpos
;
2378 /* Get the value of the invisible text property at the
2379 current position. Value will be nil if there is no such
2381 XSETFASTINT (charpos
, IT_STRING_CHARPOS (*it
));
2382 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
2385 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
2387 handled
= HANDLED_RECOMPUTE_PROPS
;
2389 /* Get the position at which the next change of the
2390 invisible text property can be found in IT->string.
2391 Value will be nil if the property value is the same for
2392 all the rest of IT->string. */
2393 XSETINT (limit
, XSTRING (it
->string
)->size
);
2394 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
2397 /* Text at current position is invisible. The next
2398 change in the property is at position end_charpos.
2399 Move IT's current position to that position. */
2400 if (INTEGERP (end_charpos
)
2401 && XFASTINT (end_charpos
) < XFASTINT (limit
))
2403 struct text_pos old
;
2404 old
= it
->current
.string_pos
;
2405 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
2406 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
2410 /* The rest of the string is invisible. If this is an
2411 overlay string, proceed with the next overlay string
2412 or whatever comes and return a character from there. */
2413 if (it
->current
.overlay_string_index
>= 0)
2415 next_overlay_string (it
);
2416 /* Don't check for overlay strings when we just
2417 finished processing them. */
2418 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
2422 struct Lisp_String
*s
= XSTRING (it
->string
);
2423 IT_STRING_CHARPOS (*it
) = s
->size
;
2424 IT_STRING_BYTEPOS (*it
) = STRING_BYTES (s
);
2431 int visible_p
, newpos
, next_stop
;
2432 Lisp_Object pos
, prop
;
2434 /* First of all, is there invisible text at this position? */
2435 XSETFASTINT (pos
, IT_CHARPOS (*it
));
2436 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
2438 /* If we are on invisible text, skip over it. */
2439 if (TEXT_PROP_MEANS_INVISIBLE (prop
)
2440 && IT_CHARPOS (*it
) < it
->end_charpos
)
2442 /* Record whether we have to display an ellipsis for the
2444 int display_ellipsis_p
2445 = TEXT_PROP_MEANS_INVISIBLE_WITH_ELLIPSIS (prop
);
2447 handled
= HANDLED_RECOMPUTE_PROPS
;
2449 /* Loop skipping over invisible text. The loop is left at
2450 ZV or with IT on the first char being visible again. */
2453 /* Try to skip some invisible text. Return value is the
2454 position reached which can be equal to IT's position
2455 if there is nothing invisible here. This skips both
2456 over invisible text properties and overlays with
2457 invisible property. */
2458 newpos
= skip_invisible (IT_CHARPOS (*it
),
2459 &next_stop
, ZV
, it
->window
);
2461 /* If we skipped nothing at all we weren't at invisible
2462 text in the first place. If everything to the end of
2463 the buffer was skipped, end the loop. */
2464 if (newpos
== IT_CHARPOS (*it
) || newpos
>= ZV
)
2468 /* We skipped some characters but not necessarily
2469 all there are. Check if we ended up on visible
2470 text. Fget_char_property returns the property of
2471 the char before the given position, i.e. if we
2472 get visible_p = 1, this means that the char at
2473 newpos is visible. */
2474 XSETFASTINT (pos
, newpos
);
2475 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
2476 visible_p
= !TEXT_PROP_MEANS_INVISIBLE (prop
);
2479 /* If we ended up on invisible text, proceed to
2480 skip starting with next_stop. */
2482 IT_CHARPOS (*it
) = next_stop
;
2486 /* The position newpos is now either ZV or on visible text. */
2487 IT_CHARPOS (*it
) = newpos
;
2488 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
2490 /* Maybe return `...' next for the end of the invisible text. */
2491 if (display_ellipsis_p
)
2494 && VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
2496 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
2497 it
->dpvec
= v
->contents
;
2498 it
->dpend
= v
->contents
+ v
->size
;
2502 /* Default `...'. */
2503 it
->dpvec
= default_invis_vector
;
2504 it
->dpend
= default_invis_vector
+ 3;
2507 /* The ellipsis display does not replace the display of
2508 the character at the new position. Indicate this by
2509 setting IT->dpvec_char_len to zero. */
2510 it
->dpvec_char_len
= 0;
2512 it
->current
.dpvec_index
= 0;
2513 it
->method
= next_element_from_display_vector
;
2523 /***********************************************************************
2525 ***********************************************************************/
2527 /* Set up iterator IT from `display' property at its current position.
2528 Called from handle_stop. */
2530 static enum prop_handled
2531 handle_display_prop (it
)
2534 Lisp_Object prop
, object
;
2535 struct text_pos
*position
;
2536 int space_or_image_found_p
;
2538 if (STRINGP (it
->string
))
2540 object
= it
->string
;
2541 position
= &it
->current
.string_pos
;
2546 position
= &it
->current
.pos
;
2549 /* Reset those iterator values set from display property values. */
2550 it
->font_height
= Qnil
;
2551 it
->space_width
= Qnil
;
2554 /* We don't support recursive `display' properties, i.e. string
2555 values that have a string `display' property, that have a string
2556 `display' property etc. */
2557 if (!it
->string_from_display_prop_p
)
2558 it
->area
= TEXT_AREA
;
2560 prop
= Fget_char_property (make_number (position
->charpos
),
2563 return HANDLED_NORMALLY
;
2565 space_or_image_found_p
= 0;
2567 && CONSP (XCAR (prop
))
2568 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
2570 /* A list of sub-properties. */
2571 while (CONSP (prop
))
2573 if (handle_single_display_prop (it
, XCAR (prop
), object
, position
))
2574 space_or_image_found_p
= 1;
2578 else if (VECTORP (prop
))
2581 for (i
= 0; i
< XVECTOR (prop
)->size
; ++i
)
2582 if (handle_single_display_prop (it
, XVECTOR (prop
)->contents
[i
],
2584 space_or_image_found_p
= 1;
2588 if (handle_single_display_prop (it
, prop
, object
, position
))
2589 space_or_image_found_p
= 1;
2592 return space_or_image_found_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
2596 /* Value is the position of the end of the `display' property starting
2597 at START_POS in OBJECT. */
2599 static struct text_pos
2600 display_prop_end (it
, object
, start_pos
)
2603 struct text_pos start_pos
;
2606 struct text_pos end_pos
;
2608 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
2609 Qdisplay
, object
, Qnil
);
2610 CHARPOS (end_pos
) = XFASTINT (end
);
2611 if (STRINGP (object
))
2612 compute_string_pos (&end_pos
, start_pos
, it
->string
);
2614 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
2620 /* Set up IT from a single `display' sub-property value PROP. OBJECT
2621 is the object in which the `display' property was found. *POSITION
2622 is the position at which it was found.
2624 If PROP is a `space' or `image' sub-property, set *POSITION to the
2625 end position of the `display' property.
2627 Value is non-zero if a `space' or `image' property value was found. */
2630 handle_single_display_prop (it
, prop
, object
, position
)
2634 struct text_pos
*position
;
2637 int space_or_image_found_p
= 0;
2640 /* If PROP is a list of the form `(when FORM . VALUE)', FORM is
2641 evaluated. If the result is nil, VALUE is ignored. */
2643 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
2652 if (!NILP (form
) && !EQ (form
, Qt
))
2654 struct gcpro gcpro1
;
2655 struct text_pos end_pos
, pt
;
2658 end_pos
= display_prop_end (it
, object
, *position
);
2660 /* Temporarily set point to the end position, and then evaluate
2661 the form. This makes `(eolp)' work as FORM. */
2662 if (BUFFERP (object
))
2665 BYTEPOS (pt
) = PT_BYTE
;
2666 TEMP_SET_PT_BOTH (CHARPOS (end_pos
), BYTEPOS (end_pos
));
2669 form
= safe_eval (form
);
2671 if (BUFFERP (object
))
2672 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
2680 && EQ (XCAR (prop
), Qheight
)
2681 && CONSP (XCDR (prop
)))
2683 if (FRAME_TERMCAP_P (it
->f
) || FRAME_MSDOS_P (it
->f
))
2686 /* `(height HEIGHT)'. */
2687 it
->font_height
= XCAR (XCDR (prop
));
2688 if (!NILP (it
->font_height
))
2690 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
2691 int new_height
= -1;
2693 if (CONSP (it
->font_height
)
2694 && (EQ (XCAR (it
->font_height
), Qplus
)
2695 || EQ (XCAR (it
->font_height
), Qminus
))
2696 && CONSP (XCDR (it
->font_height
))
2697 && INTEGERP (XCAR (XCDR (it
->font_height
))))
2699 /* `(+ N)' or `(- N)' where N is an integer. */
2700 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
2701 if (EQ (XCAR (it
->font_height
), Qplus
))
2703 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
2705 else if (FUNCTIONP (it
->font_height
))
2707 /* Call function with current height as argument.
2708 Value is the new height. */
2710 height
= safe_call1 (it
->font_height
,
2711 face
->lface
[LFACE_HEIGHT_INDEX
]);
2712 if (NUMBERP (height
))
2713 new_height
= XFLOATINT (height
);
2715 else if (NUMBERP (it
->font_height
))
2717 /* Value is a multiple of the canonical char height. */
2720 face
= FACE_FROM_ID (it
->f
, DEFAULT_FACE_ID
);
2721 new_height
= (XFLOATINT (it
->font_height
)
2722 * XINT (face
->lface
[LFACE_HEIGHT_INDEX
]));
2726 /* Evaluate IT->font_height with `height' bound to the
2727 current specified height to get the new height. */
2729 int count
= BINDING_STACK_SIZE ();
2731 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
2732 value
= safe_eval (it
->font_height
);
2733 unbind_to (count
, Qnil
);
2735 if (NUMBERP (value
))
2736 new_height
= XFLOATINT (value
);
2740 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
2743 else if (CONSP (prop
)
2744 && EQ (XCAR (prop
), Qspace_width
)
2745 && CONSP (XCDR (prop
)))
2747 /* `(space_width WIDTH)'. */
2748 if (FRAME_TERMCAP_P (it
->f
) || FRAME_MSDOS_P (it
->f
))
2751 value
= XCAR (XCDR (prop
));
2752 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
2753 it
->space_width
= value
;
2755 else if (CONSP (prop
)
2756 && EQ (XCAR (prop
), Qraise
)
2757 && CONSP (XCDR (prop
)))
2759 /* `(raise FACTOR)'. */
2760 if (FRAME_TERMCAP_P (it
->f
) || FRAME_MSDOS_P (it
->f
))
2763 #ifdef HAVE_WINDOW_SYSTEM
2764 value
= XCAR (XCDR (prop
));
2765 if (NUMBERP (value
))
2767 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
2768 it
->voffset
= - (XFLOATINT (value
)
2769 * (FONT_HEIGHT (face
->font
)));
2771 #endif /* HAVE_WINDOW_SYSTEM */
2773 else if (!it
->string_from_display_prop_p
)
2775 /* `((margin left-margin) VALUE)' or `((margin right-margin)
2776 VALUE) or `((margin nil) VALUE)' or VALUE. */
2777 Lisp_Object location
, value
;
2778 struct text_pos start_pos
;
2781 /* Characters having this form of property are not displayed, so
2782 we have to find the end of the property. */
2783 start_pos
= *position
;
2784 *position
= display_prop_end (it
, object
, start_pos
);
2787 /* Let's stop at the new position and assume that all
2788 text properties change there. */
2789 it
->stop_charpos
= position
->charpos
;
2791 location
= Qunbound
;
2792 if (CONSP (prop
) && CONSP (XCAR (prop
)))
2796 value
= XCDR (prop
);
2798 value
= XCAR (value
);
2801 if (EQ (XCAR (tem
), Qmargin
)
2802 && (tem
= XCDR (tem
),
2803 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
2805 || EQ (tem
, Qleft_margin
)
2806 || EQ (tem
, Qright_margin
))))
2810 if (EQ (location
, Qunbound
))
2816 #ifdef HAVE_WINDOW_SYSTEM
2817 if (FRAME_TERMCAP_P (it
->f
))
2818 valid_p
= STRINGP (value
);
2820 valid_p
= (STRINGP (value
)
2821 || (CONSP (value
) && EQ (XCAR (value
), Qspace
))
2822 || valid_image_p (value
));
2823 #else /* not HAVE_WINDOW_SYSTEM */
2824 valid_p
= STRINGP (value
);
2825 #endif /* not HAVE_WINDOW_SYSTEM */
2827 if ((EQ (location
, Qleft_margin
)
2828 || EQ (location
, Qright_margin
)
2832 space_or_image_found_p
= 1;
2834 /* Save current settings of IT so that we can restore them
2835 when we are finished with the glyph property value. */
2838 if (NILP (location
))
2839 it
->area
= TEXT_AREA
;
2840 else if (EQ (location
, Qleft_margin
))
2841 it
->area
= LEFT_MARGIN_AREA
;
2843 it
->area
= RIGHT_MARGIN_AREA
;
2845 if (STRINGP (value
))
2848 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
2849 it
->current
.overlay_string_index
= -1;
2850 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
2851 it
->end_charpos
= it
->string_nchars
2852 = XSTRING (it
->string
)->size
;
2853 it
->method
= next_element_from_string
;
2854 it
->stop_charpos
= 0;
2855 it
->string_from_display_prop_p
= 1;
2857 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
2859 it
->method
= next_element_from_stretch
;
2861 it
->current
.pos
= it
->position
= start_pos
;
2863 #ifdef HAVE_WINDOW_SYSTEM
2866 it
->what
= IT_IMAGE
;
2867 it
->image_id
= lookup_image (it
->f
, value
);
2868 it
->position
= start_pos
;
2869 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
2870 it
->method
= next_element_from_image
;
2872 /* Say that we haven't consumed the characters with
2873 `display' property yet. The call to pop_it in
2874 set_iterator_to_next will clean this up. */
2875 *position
= start_pos
;
2877 #endif /* HAVE_WINDOW_SYSTEM */
2880 /* Invalid property or property not supported. Restore
2881 the position to what it was before. */
2882 *position
= start_pos
;
2885 return space_or_image_found_p
;
2889 /* Check if PROP is a display sub-property value whose text should be
2890 treated as intangible. */
2893 single_display_prop_intangible_p (prop
)
2896 /* Skip over `when FORM'. */
2897 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
2908 /* Skip over `margin LOCATION'. If LOCATION is in the margins,
2909 we don't need to treat text as intangible. */
2910 if (EQ (XCAR (prop
), Qmargin
))
2918 || EQ (XCAR (prop
), Qleft_margin
)
2919 || EQ (XCAR (prop
), Qright_margin
))
2923 return CONSP (prop
) && EQ (XCAR (prop
), Qimage
);
2927 /* Check if PROP is a display property value whose text should be
2928 treated as intangible. */
2931 display_prop_intangible_p (prop
)
2935 && CONSP (XCAR (prop
))
2936 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
2938 /* A list of sub-properties. */
2939 while (CONSP (prop
))
2941 if (single_display_prop_intangible_p (XCAR (prop
)))
2946 else if (VECTORP (prop
))
2948 /* A vector of sub-properties. */
2950 for (i
= 0; i
< XVECTOR (prop
)->size
; ++i
)
2951 if (single_display_prop_intangible_p (XVECTOR (prop
)->contents
[i
]))
2955 return single_display_prop_intangible_p (prop
);
2961 /***********************************************************************
2962 `composition' property
2963 ***********************************************************************/
2965 /* Set up iterator IT from `composition' property at its current
2966 position. Called from handle_stop. */
2968 static enum prop_handled
2969 handle_composition_prop (it
)
2972 Lisp_Object prop
, string
;
2973 int pos
, pos_byte
, end
;
2974 enum prop_handled handled
= HANDLED_NORMALLY
;
2976 if (STRINGP (it
->string
))
2978 pos
= IT_STRING_CHARPOS (*it
);
2979 pos_byte
= IT_STRING_BYTEPOS (*it
);
2980 string
= it
->string
;
2984 pos
= IT_CHARPOS (*it
);
2985 pos_byte
= IT_BYTEPOS (*it
);
2989 /* If there's a valid composition and point is not inside of the
2990 composition (in the case that the composition is from the current
2991 buffer), draw a glyph composed from the composition components. */
2992 if (find_composition (pos
, -1, &pos
, &end
, &prop
, string
)
2993 && COMPOSITION_VALID_P (pos
, end
, prop
)
2994 && (STRINGP (it
->string
) || (PT
<= pos
|| PT
>= end
)))
2996 int id
= get_composition_id (pos
, pos_byte
, end
- pos
, prop
, string
);
3000 it
->method
= next_element_from_composition
;
3002 it
->cmp_len
= COMPOSITION_LENGTH (prop
);
3003 /* For a terminal, draw only the first character of the
3005 it
->c
= COMPOSITION_GLYPH (composition_table
[id
], 0);
3006 it
->len
= (STRINGP (it
->string
)
3007 ? string_char_to_byte (it
->string
, end
)
3008 : CHAR_TO_BYTE (end
)) - pos_byte
;
3009 it
->stop_charpos
= end
;
3010 handled
= HANDLED_RETURN
;
3019 /***********************************************************************
3021 ***********************************************************************/
3023 /* The following structure is used to record overlay strings for
3024 later sorting in load_overlay_strings. */
3026 struct overlay_entry
3028 Lisp_Object overlay
;
3035 /* Set up iterator IT from overlay strings at its current position.
3036 Called from handle_stop. */
3038 static enum prop_handled
3039 handle_overlay_change (it
)
3042 if (!STRINGP (it
->string
) && get_overlay_strings (it
))
3043 return HANDLED_RECOMPUTE_PROPS
;
3045 return HANDLED_NORMALLY
;
3049 /* Set up the next overlay string for delivery by IT, if there is an
3050 overlay string to deliver. Called by set_iterator_to_next when the
3051 end of the current overlay string is reached. If there are more
3052 overlay strings to display, IT->string and
3053 IT->current.overlay_string_index are set appropriately here.
3054 Otherwise IT->string is set to nil. */
3057 next_overlay_string (it
)
3060 ++it
->current
.overlay_string_index
;
3061 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
3063 /* No more overlay strings. Restore IT's settings to what
3064 they were before overlay strings were processed, and
3065 continue to deliver from current_buffer. */
3067 xassert (it
->stop_charpos
>= BEGV
3068 && it
->stop_charpos
<= it
->end_charpos
);
3070 it
->current
.overlay_string_index
= -1;
3071 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
3072 it
->n_overlay_strings
= 0;
3073 it
->method
= next_element_from_buffer
;
3075 /* If we're at the end of the buffer, record that we have
3076 processed the overlay strings there already, so that
3077 next_element_from_buffer doesn't try it again. */
3078 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
3079 it
->overlay_strings_at_end_processed_p
= 1;
3083 /* There are more overlay strings to process. If
3084 IT->current.overlay_string_index has advanced to a position
3085 where we must load IT->overlay_strings with more strings, do
3087 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
3089 if (it
->current
.overlay_string_index
&& i
== 0)
3090 load_overlay_strings (it
);
3092 /* Initialize IT to deliver display elements from the overlay
3094 it
->string
= it
->overlay_strings
[i
];
3095 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
3096 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
3097 it
->method
= next_element_from_string
;
3098 it
->stop_charpos
= 0;
3105 /* Compare two overlay_entry structures E1 and E2. Used as a
3106 comparison function for qsort in load_overlay_strings. Overlay
3107 strings for the same position are sorted so that
3109 1. All after-strings come in front of before-strings, except
3110 when they come from the same overlay.
3112 2. Within after-strings, strings are sorted so that overlay strings
3113 from overlays with higher priorities come first.
3115 2. Within before-strings, strings are sorted so that overlay
3116 strings from overlays with higher priorities come last.
3118 Value is analogous to strcmp. */
3122 compare_overlay_entries (e1
, e2
)
3125 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
3126 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
3129 if (entry1
->after_string_p
!= entry2
->after_string_p
)
3131 /* Let after-strings appear in front of before-strings if
3132 they come from different overlays. */
3133 if (EQ (entry1
->overlay
, entry2
->overlay
))
3134 result
= entry1
->after_string_p
? 1 : -1;
3136 result
= entry1
->after_string_p
? -1 : 1;
3138 else if (entry1
->after_string_p
)
3139 /* After-strings sorted in order of decreasing priority. */
3140 result
= entry2
->priority
- entry1
->priority
;
3142 /* Before-strings sorted in order of increasing priority. */
3143 result
= entry1
->priority
- entry2
->priority
;
3149 /* Load the vector IT->overlay_strings with overlay strings from IT's
3150 current buffer position. Set IT->n_overlays to the total number of
3151 overlay strings found.
3153 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
3154 a time. On entry into load_overlay_strings,
3155 IT->current.overlay_string_index gives the number of overlay
3156 strings that have already been loaded by previous calls to this
3159 IT->add_overlay_start contains an additional overlay start
3160 position to consider for taking overlay strings from, if non-zero.
3161 This position comes into play when the overlay has an `invisible'
3162 property, and both before and after-strings. When we've skipped to
3163 the end of the overlay, because of its `invisible' property, we
3164 nevertheless want its before-string to appear.
3165 IT->add_overlay_start will contain the overlay start position
3168 Overlay strings are sorted so that after-string strings come in
3169 front of before-string strings. Within before and after-strings,
3170 strings are sorted by overlay priority. See also function
3171 compare_overlay_entries. */
3174 load_overlay_strings (it
)
3177 extern Lisp_Object Qafter_string
, Qbefore_string
, Qwindow
, Qpriority
;
3178 Lisp_Object ov
, overlay
, window
, str
, invisible
;
3181 int n
= 0, i
, j
, invis_p
;
3182 struct overlay_entry
*entries
3183 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
3184 int charpos
= IT_CHARPOS (*it
);
3186 /* Append the overlay string STRING of overlay OVERLAY to vector
3187 `entries' which has size `size' and currently contains `n'
3188 elements. AFTER_P non-zero means STRING is an after-string of
3190 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
3193 Lisp_Object priority; \
3197 int new_size = 2 * size; \
3198 struct overlay_entry *old = entries; \
3200 (struct overlay_entry *) alloca (new_size \
3201 * sizeof *entries); \
3202 bcopy (old, entries, size * sizeof *entries); \
3206 entries[n].string = (STRING); \
3207 entries[n].overlay = (OVERLAY); \
3208 priority = Foverlay_get ((OVERLAY), Qpriority); \
3209 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
3210 entries[n].after_string_p = (AFTER_P); \
3215 /* Process overlay before the overlay center. */
3216 for (ov
= current_buffer
->overlays_before
; CONSP (ov
); ov
= XCDR (ov
))
3218 overlay
= XCAR (ov
);
3219 xassert (OVERLAYP (overlay
));
3220 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
3221 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
3226 /* Skip this overlay if it doesn't start or end at IT's current
3228 if (end
!= charpos
&& start
!= charpos
)
3231 /* Skip this overlay if it doesn't apply to IT->w. */
3232 window
= Foverlay_get (overlay
, Qwindow
);
3233 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
3236 /* If the text ``under'' the overlay is invisible, both before-
3237 and after-strings from this overlay are visible; start and
3238 end position are indistinguishable. */
3239 invisible
= Foverlay_get (overlay
, Qinvisible
);
3240 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
3242 /* If overlay has a non-empty before-string, record it. */
3243 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
3244 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
3245 && XSTRING (str
)->size
)
3246 RECORD_OVERLAY_STRING (overlay
, str
, 0);
3248 /* If overlay has a non-empty after-string, record it. */
3249 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
3250 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
3251 && XSTRING (str
)->size
)
3252 RECORD_OVERLAY_STRING (overlay
, str
, 1);
3255 /* Process overlays after the overlay center. */
3256 for (ov
= current_buffer
->overlays_after
; CONSP (ov
); ov
= XCDR (ov
))
3258 overlay
= XCAR (ov
);
3259 xassert (OVERLAYP (overlay
));
3260 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
3261 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
3263 if (start
> charpos
)
3266 /* Skip this overlay if it doesn't start or end at IT's current
3268 if (end
!= charpos
&& start
!= charpos
)
3271 /* Skip this overlay if it doesn't apply to IT->w. */
3272 window
= Foverlay_get (overlay
, Qwindow
);
3273 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
3276 /* If the text ``under'' the overlay is invisible, it has a zero
3277 dimension, and both before- and after-strings apply. */
3278 invisible
= Foverlay_get (overlay
, Qinvisible
);
3279 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
3281 /* If overlay has a non-empty before-string, record it. */
3282 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
3283 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
3284 && XSTRING (str
)->size
)
3285 RECORD_OVERLAY_STRING (overlay
, str
, 0);
3287 /* If overlay has a non-empty after-string, record it. */
3288 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
3289 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
3290 && XSTRING (str
)->size
)
3291 RECORD_OVERLAY_STRING (overlay
, str
, 1);
3294 #undef RECORD_OVERLAY_STRING
3298 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
3300 /* Record the total number of strings to process. */
3301 it
->n_overlay_strings
= n
;
3303 /* IT->current.overlay_string_index is the number of overlay strings
3304 that have already been consumed by IT. Copy some of the
3305 remaining overlay strings to IT->overlay_strings. */
3307 j
= it
->current
.overlay_string_index
;
3308 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
3309 it
->overlay_strings
[i
++] = entries
[j
++].string
;
3315 /* Get the first chunk of overlay strings at IT's current buffer
3316 position. Value is non-zero if at least one overlay string was
3320 get_overlay_strings (it
)
3323 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
3324 process. This fills IT->overlay_strings with strings, and sets
3325 IT->n_overlay_strings to the total number of strings to process.
3326 IT->pos.overlay_string_index has to be set temporarily to zero
3327 because load_overlay_strings needs this; it must be set to -1
3328 when no overlay strings are found because a zero value would
3329 indicate a position in the first overlay string. */
3330 it
->current
.overlay_string_index
= 0;
3331 load_overlay_strings (it
);
3333 /* If we found overlay strings, set up IT to deliver display
3334 elements from the first one. Otherwise set up IT to deliver
3335 from current_buffer. */
3336 if (it
->n_overlay_strings
)
3338 /* Make sure we know settings in current_buffer, so that we can
3339 restore meaningful values when we're done with the overlay
3341 compute_stop_pos (it
);
3342 xassert (it
->face_id
>= 0);
3344 /* Save IT's settings. They are restored after all overlay
3345 strings have been processed. */
3346 xassert (it
->sp
== 0);
3349 /* Set up IT to deliver display elements from the first overlay
3351 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
3352 it
->stop_charpos
= 0;
3353 it
->string
= it
->overlay_strings
[0];
3354 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
3355 xassert (STRINGP (it
->string
));
3356 it
->method
= next_element_from_string
;
3361 it
->current
.overlay_string_index
= -1;
3362 it
->method
= next_element_from_buffer
;
3367 /* Value is non-zero if we found at least one overlay string. */
3368 return STRINGP (it
->string
);
3373 /***********************************************************************
3374 Saving and restoring state
3375 ***********************************************************************/
3377 /* Save current settings of IT on IT->stack. Called, for example,
3378 before setting up IT for an overlay string, to be able to restore
3379 IT's settings to what they were after the overlay string has been
3386 struct iterator_stack_entry
*p
;
3388 xassert (it
->sp
< 2);
3389 p
= it
->stack
+ it
->sp
;
3391 p
->stop_charpos
= it
->stop_charpos
;
3392 xassert (it
->face_id
>= 0);
3393 p
->face_id
= it
->face_id
;
3394 p
->string
= it
->string
;
3395 p
->pos
= it
->current
;
3396 p
->end_charpos
= it
->end_charpos
;
3397 p
->string_nchars
= it
->string_nchars
;
3399 p
->multibyte_p
= it
->multibyte_p
;
3400 p
->space_width
= it
->space_width
;
3401 p
->font_height
= it
->font_height
;
3402 p
->voffset
= it
->voffset
;
3403 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
3408 /* Restore IT's settings from IT->stack. Called, for example, when no
3409 more overlay strings must be processed, and we return to delivering
3410 display elements from a buffer, or when the end of a string from a
3411 `display' property is reached and we return to delivering display
3412 elements from an overlay string, or from a buffer. */
3418 struct iterator_stack_entry
*p
;
3420 xassert (it
->sp
> 0);
3422 p
= it
->stack
+ it
->sp
;
3423 it
->stop_charpos
= p
->stop_charpos
;
3424 it
->face_id
= p
->face_id
;
3425 it
->string
= p
->string
;
3426 it
->current
= p
->pos
;
3427 it
->end_charpos
= p
->end_charpos
;
3428 it
->string_nchars
= p
->string_nchars
;
3430 it
->multibyte_p
= p
->multibyte_p
;
3431 it
->space_width
= p
->space_width
;
3432 it
->font_height
= p
->font_height
;
3433 it
->voffset
= p
->voffset
;
3434 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
3439 /***********************************************************************
3441 ***********************************************************************/
3443 /* Set IT's current position to the previous line start. */
3446 back_to_previous_line_start (it
)
3449 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
3450 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
3454 /* Move IT to the next line start.
3456 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
3457 we skipped over part of the text (as opposed to moving the iterator
3458 continuously over the text). Otherwise, don't change the value
3461 Newlines may come from buffer text, overlay strings, or strings
3462 displayed via the `display' property. That's the reason we can't
3463 simply use find_next_newline_no_quit.
3465 Note that this function may not skip over invisible text that is so
3466 because of text properties and immediately follows a newline. If
3467 it would, function reseat_at_next_visible_line_start, when called
3468 from set_iterator_to_next, would effectively make invisible
3469 characters following a newline part of the wrong glyph row, which
3470 leads to wrong cursor motion. */
3473 forward_to_next_line_start (it
, skipped_p
)
3477 int old_selective
, newline_found_p
, n
;
3478 const int MAX_NEWLINE_DISTANCE
= 500;
3480 /* If already on a newline, just consume it to avoid unintended
3481 skipping over invisible text below. */
3482 if (it
->what
== IT_CHARACTER
&& it
->c
== '\n')
3484 set_iterator_to_next (it
, 0);
3488 /* Don't handle selective display in the following. It's (a)
3489 unnecessary because it's done by the caller, and (b) leads to an
3490 infinite recursion because next_element_from_ellipsis indirectly
3491 calls this function. */
3492 old_selective
= it
->selective
;
3495 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
3496 from buffer text. */
3497 n
= newline_found_p
= 0;
3498 while (n
< MAX_NEWLINE_DISTANCE
3499 && get_next_display_element (it
)
3500 && !newline_found_p
)
3502 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
3503 set_iterator_to_next (it
, 0);
3504 if (!STRINGP (it
->string
))
3508 /* If we didn't find a newline near enough, see if we can use a
3510 if (!newline_found_p
&& n
== MAX_NEWLINE_DISTANCE
)
3512 int start
= IT_CHARPOS (*it
);
3513 int limit
= find_next_newline_no_quit (start
, 1);
3516 xassert (!STRINGP (it
->string
));
3518 /* If there isn't any `display' property in sight, and no
3519 overlays, we can just use the position of the newline in
3521 if (it
->stop_charpos
>= limit
3522 || ((pos
= Fnext_single_property_change (make_number (start
),
3524 Qnil
, make_number (limit
)),
3526 && next_overlay_change (start
) == ZV
))
3528 IT_CHARPOS (*it
) = limit
;
3529 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
3530 *skipped_p
= newline_found_p
= 1;
3534 while (get_next_display_element (it
)
3535 && !newline_found_p
)
3537 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
3538 set_iterator_to_next (it
, 0);
3543 it
->selective
= old_selective
;
3544 return newline_found_p
;
3548 /* Set IT's current position to the previous visible line start. Skip
3549 invisible text that is so either due to text properties or due to
3550 selective display. Caution: this does not change IT->current_x and
3554 back_to_previous_visible_line_start (it
)
3559 /* Go back one newline if not on BEGV already. */
3560 if (IT_CHARPOS (*it
) > BEGV
)
3561 back_to_previous_line_start (it
);
3563 /* Move over lines that are invisible because of selective display
3564 or text properties. */
3565 while (IT_CHARPOS (*it
) > BEGV
3570 /* If selective > 0, then lines indented more than that values
3572 if (it
->selective
> 0
3573 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
3580 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
)),
3581 Qinvisible
, it
->window
);
3582 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
3586 /* Back one more newline if the current one is invisible. */
3588 back_to_previous_line_start (it
);
3591 xassert (IT_CHARPOS (*it
) >= BEGV
);
3592 xassert (IT_CHARPOS (*it
) == BEGV
3593 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
3598 /* Reseat iterator IT at the previous visible line start. Skip
3599 invisible text that is so either due to text properties or due to
3600 selective display. At the end, update IT's overlay information,
3601 face information etc. */
3604 reseat_at_previous_visible_line_start (it
)
3607 back_to_previous_visible_line_start (it
);
3608 reseat (it
, it
->current
.pos
, 1);
3613 /* Reseat iterator IT on the next visible line start in the current
3614 buffer. ON_NEWLINE_P non-zero means position IT on the newline
3615 preceding the line start. Skip over invisible text that is so
3616 because of selective display. Compute faces, overlays etc at the
3617 new position. Note that this function does not skip over text that
3618 is invisible because of text properties. */
3621 reseat_at_next_visible_line_start (it
, on_newline_p
)
3625 int newline_found_p
, skipped_p
= 0;
3627 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
3629 /* Skip over lines that are invisible because they are indented
3630 more than the value of IT->selective. */
3631 if (it
->selective
> 0)
3632 while (IT_CHARPOS (*it
) < ZV
3633 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
3635 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
3637 /* Position on the newline if that's what's requested. */
3638 if (on_newline_p
&& newline_found_p
)
3640 if (STRINGP (it
->string
))
3642 if (IT_STRING_CHARPOS (*it
) > 0)
3644 --IT_STRING_CHARPOS (*it
);
3645 --IT_STRING_BYTEPOS (*it
);
3648 else if (IT_CHARPOS (*it
) > BEGV
)
3652 reseat (it
, it
->current
.pos
, 0);
3656 reseat (it
, it
->current
.pos
, 0);
3663 /***********************************************************************
3664 Changing an iterator's position
3665 ***********************************************************************/
3667 /* Change IT's current position to POS in current_buffer. If FORCE_P
3668 is non-zero, always check for text properties at the new position.
3669 Otherwise, text properties are only looked up if POS >=
3670 IT->check_charpos of a property. */
3673 reseat (it
, pos
, force_p
)
3675 struct text_pos pos
;
3678 int original_pos
= IT_CHARPOS (*it
);
3680 reseat_1 (it
, pos
, 0);
3682 /* Determine where to check text properties. Avoid doing it
3683 where possible because text property lookup is very expensive. */
3685 || CHARPOS (pos
) > it
->stop_charpos
3686 || CHARPOS (pos
) < original_pos
)
3693 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
3694 IT->stop_pos to POS, also. */
3697 reseat_1 (it
, pos
, set_stop_p
)
3699 struct text_pos pos
;
3702 /* Don't call this function when scanning a C string. */
3703 xassert (it
->s
== NULL
);
3705 /* POS must be a reasonable value. */
3706 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
3708 it
->current
.pos
= it
->position
= pos
;
3709 XSETBUFFER (it
->object
, current_buffer
);
3711 it
->current
.dpvec_index
= -1;
3712 it
->current
.overlay_string_index
= -1;
3713 IT_STRING_CHARPOS (*it
) = -1;
3714 IT_STRING_BYTEPOS (*it
) = -1;
3716 it
->method
= next_element_from_buffer
;
3718 it
->face_before_selective_p
= 0;
3721 it
->stop_charpos
= CHARPOS (pos
);
3725 /* Set up IT for displaying a string, starting at CHARPOS in window W.
3726 If S is non-null, it is a C string to iterate over. Otherwise,
3727 STRING gives a Lisp string to iterate over.
3729 If PRECISION > 0, don't return more then PRECISION number of
3730 characters from the string.
3732 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
3733 characters have been returned. FIELD_WIDTH < 0 means an infinite
3736 MULTIBYTE = 0 means disable processing of multibyte characters,
3737 MULTIBYTE > 0 means enable it,
3738 MULTIBYTE < 0 means use IT->multibyte_p.
3740 IT must be initialized via a prior call to init_iterator before
3741 calling this function. */
3744 reseat_to_string (it
, s
, string
, charpos
, precision
, field_width
, multibyte
)
3749 int precision
, field_width
, multibyte
;
3751 /* No region in strings. */
3752 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
3754 /* No text property checks performed by default, but see below. */
3755 it
->stop_charpos
= -1;
3757 /* Set iterator position and end position. */
3758 bzero (&it
->current
, sizeof it
->current
);
3759 it
->current
.overlay_string_index
= -1;
3760 it
->current
.dpvec_index
= -1;
3761 xassert (charpos
>= 0);
3763 /* Use the setting of MULTIBYTE if specified. */
3765 it
->multibyte_p
= multibyte
> 0;
3769 xassert (STRINGP (string
));
3770 it
->string
= string
;
3772 it
->end_charpos
= it
->string_nchars
= XSTRING (string
)->size
;
3773 it
->method
= next_element_from_string
;
3774 it
->current
.string_pos
= string_pos (charpos
, string
);
3781 /* Note that we use IT->current.pos, not it->current.string_pos,
3782 for displaying C strings. */
3783 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
3784 if (it
->multibyte_p
)
3786 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
3787 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
3791 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
3792 it
->end_charpos
= it
->string_nchars
= strlen (s
);
3795 it
->method
= next_element_from_c_string
;
3798 /* PRECISION > 0 means don't return more than PRECISION characters
3800 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
3801 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
3803 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
3804 characters have been returned. FIELD_WIDTH == 0 means don't pad,
3805 FIELD_WIDTH < 0 means infinite field width. This is useful for
3806 padding with `-' at the end of a mode line. */
3807 if (field_width
< 0)
3808 field_width
= INFINITY
;
3809 if (field_width
> it
->end_charpos
- charpos
)
3810 it
->end_charpos
= charpos
+ field_width
;
3812 /* Use the standard display table for displaying strings. */
3813 if (DISP_TABLE_P (Vstandard_display_table
))
3814 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
3816 it
->stop_charpos
= charpos
;
3822 /***********************************************************************
3824 ***********************************************************************/
3826 /* Load IT's display element fields with information about the next
3827 display element from the current position of IT. Value is zero if
3828 end of buffer (or C string) is reached. */
3831 get_next_display_element (it
)
3834 /* Non-zero means that we found an display element. Zero means that
3835 we hit the end of what we iterate over. Performance note: the
3836 function pointer `method' used here turns out to be faster than
3837 using a sequence of if-statements. */
3838 int success_p
= (*it
->method
) (it
);
3840 if (it
->what
== IT_CHARACTER
)
3842 /* Map via display table or translate control characters.
3843 IT->c, IT->len etc. have been set to the next character by
3844 the function call above. If we have a display table, and it
3845 contains an entry for IT->c, translate it. Don't do this if
3846 IT->c itself comes from a display table, otherwise we could
3847 end up in an infinite recursion. (An alternative could be to
3848 count the recursion depth of this function and signal an
3849 error when a certain maximum depth is reached.) Is it worth
3851 if (success_p
&& it
->dpvec
== NULL
)
3856 && (dv
= DISP_CHAR_VECTOR (it
->dp
, it
->c
),
3859 struct Lisp_Vector
*v
= XVECTOR (dv
);
3861 /* Return the first character from the display table
3862 entry, if not empty. If empty, don't display the
3863 current character. */
3866 it
->dpvec_char_len
= it
->len
;
3867 it
->dpvec
= v
->contents
;
3868 it
->dpend
= v
->contents
+ v
->size
;
3869 it
->current
.dpvec_index
= 0;
3870 it
->method
= next_element_from_display_vector
;
3873 success_p
= get_next_display_element (it
);
3876 /* Translate control characters into `\003' or `^C' form.
3877 Control characters coming from a display table entry are
3878 currently not translated because we use IT->dpvec to hold
3879 the translation. This could easily be changed but I
3880 don't believe that it is worth doing.
3882 Non-printable multibyte characters are also translated
3884 else if ((it
->c
< ' '
3885 && (it
->area
!= TEXT_AREA
3886 || (it
->c
!= '\n' && it
->c
!= '\t')))
3889 || !CHAR_PRINTABLE_P (it
->c
))
3891 /* IT->c is a control character which must be displayed
3892 either as '\003' or as `^C' where the '\\' and '^'
3893 can be defined in the display table. Fill
3894 IT->ctl_chars with glyphs for what we have to
3895 display. Then, set IT->dpvec to these glyphs. */
3898 if (it
->c
< 128 && it
->ctl_arrow_p
)
3900 /* Set IT->ctl_chars[0] to the glyph for `^'. */
3902 && INTEGERP (DISP_CTRL_GLYPH (it
->dp
))
3903 && GLYPH_CHAR_VALID_P (XINT (DISP_CTRL_GLYPH (it
->dp
))))
3904 g
= XINT (DISP_CTRL_GLYPH (it
->dp
));
3906 g
= FAST_MAKE_GLYPH ('^', 0);
3907 XSETINT (it
->ctl_chars
[0], g
);
3909 g
= FAST_MAKE_GLYPH (it
->c
^ 0100, 0);
3910 XSETINT (it
->ctl_chars
[1], g
);
3912 /* Set up IT->dpvec and return first character from it. */
3913 it
->dpvec_char_len
= it
->len
;
3914 it
->dpvec
= it
->ctl_chars
;
3915 it
->dpend
= it
->dpvec
+ 2;
3916 it
->current
.dpvec_index
= 0;
3917 it
->method
= next_element_from_display_vector
;
3918 get_next_display_element (it
);
3922 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
3927 /* Set IT->ctl_chars[0] to the glyph for `\\'. */
3929 && INTEGERP (DISP_ESCAPE_GLYPH (it
->dp
))
3930 && GLYPH_CHAR_VALID_P (XFASTINT (DISP_ESCAPE_GLYPH (it
->dp
))))
3931 escape_glyph
= XFASTINT (DISP_ESCAPE_GLYPH (it
->dp
));
3933 escape_glyph
= FAST_MAKE_GLYPH ('\\', 0);
3935 if (SINGLE_BYTE_CHAR_P (it
->c
))
3936 str
[0] = it
->c
, len
= 1;
3938 len
= CHAR_STRING (it
->c
, str
);
3940 for (i
= 0; i
< len
; i
++)
3942 XSETINT (it
->ctl_chars
[i
* 4], escape_glyph
);
3943 /* Insert three more glyphs into IT->ctl_chars for
3944 the octal display of the character. */
3945 g
= FAST_MAKE_GLYPH (((str
[i
] >> 6) & 7) + '0', 0);
3946 XSETINT (it
->ctl_chars
[i
* 4 + 1], g
);
3947 g
= FAST_MAKE_GLYPH (((str
[i
] >> 3) & 7) + '0', 0);
3948 XSETINT (it
->ctl_chars
[i
* 4 + 2], g
);
3949 g
= FAST_MAKE_GLYPH ((str
[i
] & 7) + '0', 0);
3950 XSETINT (it
->ctl_chars
[i
* 4 + 3], g
);
3953 /* Set up IT->dpvec and return the first character
3955 it
->dpvec_char_len
= it
->len
;
3956 it
->dpvec
= it
->ctl_chars
;
3957 it
->dpend
= it
->dpvec
+ len
* 4;
3958 it
->current
.dpvec_index
= 0;
3959 it
->method
= next_element_from_display_vector
;
3960 get_next_display_element (it
);
3965 /* Adjust face id for a multibyte character. There are no
3966 multibyte character in unibyte text. */
3969 && FRAME_WINDOW_P (it
->f
))
3971 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3972 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->c
);
3976 /* Is this character the last one of a run of characters with
3977 box? If yes, set IT->end_of_box_run_p to 1. */
3984 it
->end_of_box_run_p
3985 = ((face_id
= face_after_it_pos (it
),
3986 face_id
!= it
->face_id
)
3987 && (face
= FACE_FROM_ID (it
->f
, face_id
),
3988 face
->box
== FACE_NO_BOX
));
3991 /* Value is 0 if end of buffer or string reached. */
3996 /* Move IT to the next display element.
3998 RESEAT_P non-zero means if called on a newline in buffer text,
3999 skip to the next visible line start.
4001 Functions get_next_display_element and set_iterator_to_next are
4002 separate because I find this arrangement easier to handle than a
4003 get_next_display_element function that also increments IT's
4004 position. The way it is we can first look at an iterator's current
4005 display element, decide whether it fits on a line, and if it does,
4006 increment the iterator position. The other way around we probably
4007 would either need a flag indicating whether the iterator has to be
4008 incremented the next time, or we would have to implement a
4009 decrement position function which would not be easy to write. */
4012 set_iterator_to_next (it
, reseat_p
)
4016 /* Reset flags indicating start and end of a sequence of characters
4017 with box. Reset them at the start of this function because
4018 moving the iterator to a new position might set them. */
4019 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
4021 if (it
->method
== next_element_from_buffer
)
4023 /* The current display element of IT is a character from
4024 current_buffer. Advance in the buffer, and maybe skip over
4025 invisible lines that are so because of selective display. */
4026 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
4027 reseat_at_next_visible_line_start (it
, 0);
4030 xassert (it
->len
!= 0);
4031 IT_BYTEPOS (*it
) += it
->len
;
4032 IT_CHARPOS (*it
) += 1;
4033 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
4036 else if (it
->method
== next_element_from_composition
)
4038 xassert (it
->cmp_id
>= 0 && it
->cmp_id
< n_compositions
);
4039 if (STRINGP (it
->string
))
4041 IT_STRING_BYTEPOS (*it
) += it
->len
;
4042 IT_STRING_CHARPOS (*it
) += it
->cmp_len
;
4043 it
->method
= next_element_from_string
;
4044 goto consider_string_end
;
4048 IT_BYTEPOS (*it
) += it
->len
;
4049 IT_CHARPOS (*it
) += it
->cmp_len
;
4050 it
->method
= next_element_from_buffer
;
4053 else if (it
->method
== next_element_from_c_string
)
4055 /* Current display element of IT is from a C string. */
4056 IT_BYTEPOS (*it
) += it
->len
;
4057 IT_CHARPOS (*it
) += 1;
4059 else if (it
->method
== next_element_from_display_vector
)
4061 /* Current display element of IT is from a display table entry.
4062 Advance in the display table definition. Reset it to null if
4063 end reached, and continue with characters from buffers/
4065 ++it
->current
.dpvec_index
;
4067 /* Restore face of the iterator to what they were before the
4068 display vector entry (these entries may contain faces). */
4069 it
->face_id
= it
->saved_face_id
;
4071 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
4074 it
->method
= next_element_from_c_string
;
4075 else if (STRINGP (it
->string
))
4076 it
->method
= next_element_from_string
;
4078 it
->method
= next_element_from_buffer
;
4081 it
->current
.dpvec_index
= -1;
4083 /* Skip over characters which were displayed via IT->dpvec. */
4084 if (it
->dpvec_char_len
< 0)
4085 reseat_at_next_visible_line_start (it
, 1);
4086 else if (it
->dpvec_char_len
> 0)
4088 it
->len
= it
->dpvec_char_len
;
4089 set_iterator_to_next (it
, reseat_p
);
4093 else if (it
->method
== next_element_from_string
)
4095 /* Current display element is a character from a Lisp string. */
4096 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
4097 IT_STRING_BYTEPOS (*it
) += it
->len
;
4098 IT_STRING_CHARPOS (*it
) += 1;
4100 consider_string_end
:
4102 if (it
->current
.overlay_string_index
>= 0)
4104 /* IT->string is an overlay string. Advance to the
4105 next, if there is one. */
4106 if (IT_STRING_CHARPOS (*it
) >= XSTRING (it
->string
)->size
)
4107 next_overlay_string (it
);
4111 /* IT->string is not an overlay string. If we reached
4112 its end, and there is something on IT->stack, proceed
4113 with what is on the stack. This can be either another
4114 string, this time an overlay string, or a buffer. */
4115 if (IT_STRING_CHARPOS (*it
) == XSTRING (it
->string
)->size
4119 if (!STRINGP (it
->string
))
4120 it
->method
= next_element_from_buffer
;
4124 else if (it
->method
== next_element_from_image
4125 || it
->method
== next_element_from_stretch
)
4127 /* The position etc with which we have to proceed are on
4128 the stack. The position may be at the end of a string,
4129 if the `display' property takes up the whole string. */
4132 if (STRINGP (it
->string
))
4134 it
->method
= next_element_from_string
;
4135 goto consider_string_end
;
4138 it
->method
= next_element_from_buffer
;
4141 /* There are no other methods defined, so this should be a bug. */
4144 xassert (it
->method
!= next_element_from_string
4145 || (STRINGP (it
->string
)
4146 && IT_STRING_CHARPOS (*it
) >= 0));
4150 /* Load IT's display element fields with information about the next
4151 display element which comes from a display table entry or from the
4152 result of translating a control character to one of the forms `^C'
4153 or `\003'. IT->dpvec holds the glyphs to return as characters. */
4156 next_element_from_display_vector (it
)
4160 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
4162 /* Remember the current face id in case glyphs specify faces.
4163 IT's face is restored in set_iterator_to_next. */
4164 it
->saved_face_id
= it
->face_id
;
4166 if (INTEGERP (*it
->dpvec
)
4167 && GLYPH_CHAR_VALID_P (XFASTINT (*it
->dpvec
)))
4172 g
= XFASTINT (it
->dpvec
[it
->current
.dpvec_index
]);
4173 it
->c
= FAST_GLYPH_CHAR (g
);
4174 it
->len
= CHAR_BYTES (it
->c
);
4176 /* The entry may contain a face id to use. Such a face id is
4177 the id of a Lisp face, not a realized face. A face id of
4178 zero means no face is specified. */
4179 lface_id
= FAST_GLYPH_FACE (g
);
4182 /* The function returns -1 if lface_id is invalid. */
4183 int face_id
= ascii_face_of_lisp_face (it
->f
, lface_id
);
4185 it
->face_id
= face_id
;
4189 /* Display table entry is invalid. Return a space. */
4190 it
->c
= ' ', it
->len
= 1;
4192 /* Don't change position and object of the iterator here. They are
4193 still the values of the character that had this display table
4194 entry or was translated, and that's what we want. */
4195 it
->what
= IT_CHARACTER
;
4200 /* Load IT with the next display element from Lisp string IT->string.
4201 IT->current.string_pos is the current position within the string.
4202 If IT->current.overlay_string_index >= 0, the Lisp string is an
4206 next_element_from_string (it
)
4209 struct text_pos position
;
4211 xassert (STRINGP (it
->string
));
4212 xassert (IT_STRING_CHARPOS (*it
) >= 0);
4213 position
= it
->current
.string_pos
;
4215 /* Time to check for invisible text? */
4216 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
4217 && IT_STRING_CHARPOS (*it
) == it
->stop_charpos
)
4221 /* Since a handler may have changed IT->method, we must
4223 return get_next_display_element (it
);
4226 if (it
->current
.overlay_string_index
>= 0)
4228 /* Get the next character from an overlay string. In overlay
4229 strings, There is no field width or padding with spaces to
4231 if (IT_STRING_CHARPOS (*it
) >= XSTRING (it
->string
)->size
)
4236 else if (STRING_MULTIBYTE (it
->string
))
4238 int remaining
= (STRING_BYTES (XSTRING (it
->string
))
4239 - IT_STRING_BYTEPOS (*it
));
4240 unsigned char *s
= (XSTRING (it
->string
)->data
4241 + IT_STRING_BYTEPOS (*it
));
4242 it
->c
= string_char_and_length (s
, remaining
, &it
->len
);
4246 it
->c
= XSTRING (it
->string
)->data
[IT_STRING_BYTEPOS (*it
)];
4252 /* Get the next character from a Lisp string that is not an
4253 overlay string. Such strings come from the mode line, for
4254 example. We may have to pad with spaces, or truncate the
4255 string. See also next_element_from_c_string. */
4256 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
4261 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
4263 /* Pad with spaces. */
4264 it
->c
= ' ', it
->len
= 1;
4265 CHARPOS (position
) = BYTEPOS (position
) = -1;
4267 else if (STRING_MULTIBYTE (it
->string
))
4269 int maxlen
= (STRING_BYTES (XSTRING (it
->string
))
4270 - IT_STRING_BYTEPOS (*it
));
4271 unsigned char *s
= (XSTRING (it
->string
)->data
4272 + IT_STRING_BYTEPOS (*it
));
4273 it
->c
= string_char_and_length (s
, maxlen
, &it
->len
);
4277 it
->c
= XSTRING (it
->string
)->data
[IT_STRING_BYTEPOS (*it
)];
4282 /* Record what we have and where it came from. Note that we store a
4283 buffer position in IT->position although it could arguably be a
4285 it
->what
= IT_CHARACTER
;
4286 it
->object
= it
->string
;
4287 it
->position
= position
;
4292 /* Load IT with next display element from C string IT->s.
4293 IT->string_nchars is the maximum number of characters to return
4294 from the string. IT->end_charpos may be greater than
4295 IT->string_nchars when this function is called, in which case we
4296 may have to return padding spaces. Value is zero if end of string
4297 reached, including padding spaces. */
4300 next_element_from_c_string (it
)
4306 it
->what
= IT_CHARACTER
;
4307 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
4310 /* IT's position can be greater IT->string_nchars in case a field
4311 width or precision has been specified when the iterator was
4313 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
4315 /* End of the game. */
4319 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
4321 /* Pad with spaces. */
4322 it
->c
= ' ', it
->len
= 1;
4323 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
4325 else if (it
->multibyte_p
)
4327 /* Implementation note: The calls to strlen apparently aren't a
4328 performance problem because there is no noticeable performance
4329 difference between Emacs running in unibyte or multibyte mode. */
4330 int maxlen
= strlen (it
->s
) - IT_BYTEPOS (*it
);
4331 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
),
4335 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
4341 /* Set up IT to return characters from an ellipsis, if appropriate.
4342 The definition of the ellipsis glyphs may come from a display table
4343 entry. This function Fills IT with the first glyph from the
4344 ellipsis if an ellipsis is to be displayed. */
4347 next_element_from_ellipsis (it
)
4350 if (it
->selective_display_ellipsis_p
)
4352 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4354 /* Use the display table definition for `...'. Invalid glyphs
4355 will be handled by the method returning elements from dpvec. */
4356 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4357 it
->dpvec_char_len
= it
->len
;
4358 it
->dpvec
= v
->contents
;
4359 it
->dpend
= v
->contents
+ v
->size
;
4360 it
->current
.dpvec_index
= 0;
4361 it
->method
= next_element_from_display_vector
;
4365 /* Use default `...' which is stored in default_invis_vector. */
4366 it
->dpvec_char_len
= it
->len
;
4367 it
->dpvec
= default_invis_vector
;
4368 it
->dpend
= default_invis_vector
+ 3;
4369 it
->current
.dpvec_index
= 0;
4370 it
->method
= next_element_from_display_vector
;
4375 /* The face at the current position may be different from the
4376 face we find after the invisible text. Remember what it
4377 was in IT->saved_face_id, and signal that it's there by
4378 setting face_before_selective_p. */
4379 it
->saved_face_id
= it
->face_id
;
4380 it
->method
= next_element_from_buffer
;
4381 reseat_at_next_visible_line_start (it
, 1);
4382 it
->face_before_selective_p
= 1;
4385 return get_next_display_element (it
);
4389 /* Deliver an image display element. The iterator IT is already
4390 filled with image information (done in handle_display_prop). Value
4395 next_element_from_image (it
)
4398 it
->what
= IT_IMAGE
;
4403 /* Fill iterator IT with next display element from a stretch glyph
4404 property. IT->object is the value of the text property. Value is
4408 next_element_from_stretch (it
)
4411 it
->what
= IT_STRETCH
;
4416 /* Load IT with the next display element from current_buffer. Value
4417 is zero if end of buffer reached. IT->stop_charpos is the next
4418 position at which to stop and check for text properties or buffer
4422 next_element_from_buffer (it
)
4427 /* Check this assumption, otherwise, we would never enter the
4428 if-statement, below. */
4429 xassert (IT_CHARPOS (*it
) >= BEGV
4430 && IT_CHARPOS (*it
) <= it
->stop_charpos
);
4432 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
4434 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
4436 int overlay_strings_follow_p
;
4438 /* End of the game, except when overlay strings follow that
4439 haven't been returned yet. */
4440 if (it
->overlay_strings_at_end_processed_p
)
4441 overlay_strings_follow_p
= 0;
4444 it
->overlay_strings_at_end_processed_p
= 1;
4445 overlay_strings_follow_p
= get_overlay_strings (it
);
4448 if (overlay_strings_follow_p
)
4449 success_p
= get_next_display_element (it
);
4453 it
->position
= it
->current
.pos
;
4460 return get_next_display_element (it
);
4465 /* No face changes, overlays etc. in sight, so just return a
4466 character from current_buffer. */
4469 /* Maybe run the redisplay end trigger hook. Performance note:
4470 This doesn't seem to cost measurable time. */
4471 if (it
->redisplay_end_trigger_charpos
4473 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
4474 run_redisplay_end_trigger_hook (it
);
4476 /* Get the next character, maybe multibyte. */
4477 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
4478 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
4480 int maxlen
= ((IT_BYTEPOS (*it
) >= GPT_BYTE
? ZV_BYTE
: GPT_BYTE
)
4481 - IT_BYTEPOS (*it
));
4482 it
->c
= string_char_and_length (p
, maxlen
, &it
->len
);
4485 it
->c
= *p
, it
->len
= 1;
4487 /* Record what we have and where it came from. */
4488 it
->what
= IT_CHARACTER
;;
4489 it
->object
= it
->w
->buffer
;
4490 it
->position
= it
->current
.pos
;
4492 /* Normally we return the character found above, except when we
4493 really want to return an ellipsis for selective display. */
4498 /* A value of selective > 0 means hide lines indented more
4499 than that number of columns. */
4500 if (it
->selective
> 0
4501 && IT_CHARPOS (*it
) + 1 < ZV
4502 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
4503 IT_BYTEPOS (*it
) + 1,
4506 success_p
= next_element_from_ellipsis (it
);
4507 it
->dpvec_char_len
= -1;
4510 else if (it
->c
== '\r' && it
->selective
== -1)
4512 /* A value of selective == -1 means that everything from the
4513 CR to the end of the line is invisible, with maybe an
4514 ellipsis displayed for it. */
4515 success_p
= next_element_from_ellipsis (it
);
4516 it
->dpvec_char_len
= -1;
4521 /* Value is zero if end of buffer reached. */
4522 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
4527 /* Run the redisplay end trigger hook for IT. */
4530 run_redisplay_end_trigger_hook (it
)
4533 Lisp_Object args
[3];
4535 /* IT->glyph_row should be non-null, i.e. we should be actually
4536 displaying something, or otherwise we should not run the hook. */
4537 xassert (it
->glyph_row
);
4539 /* Set up hook arguments. */
4540 args
[0] = Qredisplay_end_trigger_functions
;
4541 args
[1] = it
->window
;
4542 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
4543 it
->redisplay_end_trigger_charpos
= 0;
4545 /* Since we are *trying* to run these functions, don't try to run
4546 them again, even if they get an error. */
4547 it
->w
->redisplay_end_trigger
= Qnil
;
4548 Frun_hook_with_args (3, args
);
4550 /* Notice if it changed the face of the character we are on. */
4551 handle_face_prop (it
);
4555 /* Deliver a composition display element. The iterator IT is already
4556 filled with composition information (done in
4557 handle_composition_prop). Value is always 1. */
4560 next_element_from_composition (it
)
4563 it
->what
= IT_COMPOSITION
;
4564 it
->position
= (STRINGP (it
->string
)
4565 ? it
->current
.string_pos
4572 /***********************************************************************
4573 Moving an iterator without producing glyphs
4574 ***********************************************************************/
4576 /* Move iterator IT to a specified buffer or X position within one
4577 line on the display without producing glyphs.
4579 Begin to skip at IT's current position. Skip to TO_CHARPOS or TO_X
4580 whichever is reached first.
4582 TO_CHARPOS <= 0 means no TO_CHARPOS is specified.
4584 TO_X < 0 means that no TO_X is specified. TO_X is normally a value
4585 0 <= TO_X <= IT->last_visible_x. This means in particular, that
4586 TO_X includes the amount by which a window is horizontally
4591 MOVE_POS_MATCH_OR_ZV
4592 - when TO_POS or ZV was reached.
4595 -when TO_X was reached before TO_POS or ZV were reached.
4598 - when we reached the end of the display area and the line must
4602 - when we reached the end of the display area and the line is
4606 - when we stopped at a line end, i.e. a newline or a CR and selective
4609 static enum move_it_result
4610 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
)
4612 int to_charpos
, to_x
, op
;
4614 enum move_it_result result
= MOVE_UNDEFINED
;
4615 struct glyph_row
*saved_glyph_row
;
4617 /* Don't produce glyphs in produce_glyphs. */
4618 saved_glyph_row
= it
->glyph_row
;
4619 it
->glyph_row
= NULL
;
4623 int x
, i
, ascent
= 0, descent
= 0;
4625 /* Stop when ZV or TO_CHARPOS reached. */
4626 if (!get_next_display_element (it
)
4627 || ((op
& MOVE_TO_POS
) != 0
4628 && BUFFERP (it
->object
)
4629 && IT_CHARPOS (*it
) >= to_charpos
))
4631 result
= MOVE_POS_MATCH_OR_ZV
;
4635 /* The call to produce_glyphs will get the metrics of the
4636 display element IT is loaded with. We record in x the
4637 x-position before this display element in case it does not
4641 /* Remember the line height so far in case the next element doesn't
4643 if (!it
->truncate_lines_p
)
4645 ascent
= it
->max_ascent
;
4646 descent
= it
->max_descent
;
4649 PRODUCE_GLYPHS (it
);
4651 if (it
->area
!= TEXT_AREA
)
4653 set_iterator_to_next (it
, 1);
4657 /* The number of glyphs we get back in IT->nglyphs will normally
4658 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
4659 character on a terminal frame, or (iii) a line end. For the
4660 second case, IT->nglyphs - 1 padding glyphs will be present
4661 (on X frames, there is only one glyph produced for a
4662 composite character.
4664 The behavior implemented below means, for continuation lines,
4665 that as many spaces of a TAB as fit on the current line are
4666 displayed there. For terminal frames, as many glyphs of a
4667 multi-glyph character are displayed in the current line, too.
4668 This is what the old redisplay code did, and we keep it that
4669 way. Under X, the whole shape of a complex character must
4670 fit on the line or it will be completely displayed in the
4673 Note that both for tabs and padding glyphs, all glyphs have
4677 /* More than one glyph or glyph doesn't fit on line. All
4678 glyphs have the same width. */
4679 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
4682 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
4684 new_x
= x
+ single_glyph_width
;
4686 /* We want to leave anything reaching TO_X to the caller. */
4687 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
4690 result
= MOVE_X_REACHED
;
4693 else if (/* Lines are continued. */
4694 !it
->truncate_lines_p
4695 && (/* And glyph doesn't fit on the line. */
4696 new_x
> it
->last_visible_x
4697 /* Or it fits exactly and we're on a window
4699 || (new_x
== it
->last_visible_x
4700 && FRAME_WINDOW_P (it
->f
))))
4702 if (/* IT->hpos == 0 means the very first glyph
4703 doesn't fit on the line, e.g. a wide image. */
4705 || (new_x
== it
->last_visible_x
4706 && FRAME_WINDOW_P (it
->f
)))
4709 it
->current_x
= new_x
;
4710 if (i
== it
->nglyphs
- 1)
4711 set_iterator_to_next (it
, 1);
4716 it
->max_ascent
= ascent
;
4717 it
->max_descent
= descent
;
4720 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
4722 result
= MOVE_LINE_CONTINUED
;
4725 else if (new_x
> it
->first_visible_x
)
4727 /* Glyph is visible. Increment number of glyphs that
4728 would be displayed. */
4733 /* Glyph is completely off the left margin of the display
4734 area. Nothing to do. */
4738 if (result
!= MOVE_UNDEFINED
)
4741 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
4743 /* Stop when TO_X specified and reached. This check is
4744 necessary here because of lines consisting of a line end,
4745 only. The line end will not produce any glyphs and we
4746 would never get MOVE_X_REACHED. */
4747 xassert (it
->nglyphs
== 0);
4748 result
= MOVE_X_REACHED
;
4752 /* Is this a line end? If yes, we're done. */
4753 if (ITERATOR_AT_END_OF_LINE_P (it
))
4755 result
= MOVE_NEWLINE_OR_CR
;
4759 /* The current display element has been consumed. Advance
4761 set_iterator_to_next (it
, 1);
4763 /* Stop if lines are truncated and IT's current x-position is
4764 past the right edge of the window now. */
4765 if (it
->truncate_lines_p
4766 && it
->current_x
>= it
->last_visible_x
)
4768 result
= MOVE_LINE_TRUNCATED
;
4773 /* Restore the iterator settings altered at the beginning of this
4775 it
->glyph_row
= saved_glyph_row
;
4780 /* Move IT forward to a specified buffer position TO_CHARPOS, TO_X,
4781 TO_Y, TO_VPOS. OP is a bit-mask that specifies where to stop. See
4782 the description of enum move_operation_enum.
4784 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
4785 screen line, this function will set IT to the next position >
4789 move_it_to (it
, to_charpos
, to_x
, to_y
, to_vpos
, op
)
4791 int to_charpos
, to_x
, to_y
, to_vpos
;
4794 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
4800 if (op
& MOVE_TO_VPOS
)
4802 /* If no TO_CHARPOS and no TO_X specified, stop at the
4803 start of the line TO_VPOS. */
4804 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
4806 if (it
->vpos
== to_vpos
)
4812 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
4816 /* TO_VPOS >= 0 means stop at TO_X in the line at
4817 TO_VPOS, or at TO_POS, whichever comes first. */
4818 if (it
->vpos
== to_vpos
)
4824 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
4826 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
4831 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
4833 /* We have reached TO_X but not in the line we want. */
4834 skip
= move_it_in_display_line_to (it
, to_charpos
,
4836 if (skip
== MOVE_POS_MATCH_OR_ZV
)
4844 else if (op
& MOVE_TO_Y
)
4846 struct it it_backup
;
4848 /* TO_Y specified means stop at TO_X in the line containing
4849 TO_Y---or at TO_CHARPOS if this is reached first. The
4850 problem is that we can't really tell whether the line
4851 contains TO_Y before we have completely scanned it, and
4852 this may skip past TO_X. What we do is to first scan to
4855 If TO_X is not specified, use a TO_X of zero. The reason
4856 is to make the outcome of this function more predictable.
4857 If we didn't use TO_X == 0, we would stop at the end of
4858 the line which is probably not what a caller would expect
4860 skip
= move_it_in_display_line_to (it
, to_charpos
,
4864 | (op
& MOVE_TO_POS
)));
4866 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
4867 if (skip
== MOVE_POS_MATCH_OR_ZV
)
4873 /* If TO_X was reached, we would like to know whether TO_Y
4874 is in the line. This can only be said if we know the
4875 total line height which requires us to scan the rest of
4877 if (skip
== MOVE_X_REACHED
)
4880 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
4881 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
4883 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
4886 /* Now, decide whether TO_Y is in this line. */
4887 line_height
= it
->max_ascent
+ it
->max_descent
;
4888 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
4890 if (to_y
>= it
->current_y
4891 && to_y
< it
->current_y
+ line_height
)
4893 if (skip
== MOVE_X_REACHED
)
4894 /* If TO_Y is in this line and TO_X was reached above,
4895 we scanned too far. We have to restore IT's settings
4896 to the ones before skipping. */
4900 else if (skip
== MOVE_X_REACHED
)
4903 if (skip
== MOVE_POS_MATCH_OR_ZV
)
4911 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
4915 case MOVE_POS_MATCH_OR_ZV
:
4919 case MOVE_NEWLINE_OR_CR
:
4920 set_iterator_to_next (it
, 1);
4921 it
->continuation_lines_width
= 0;
4924 case MOVE_LINE_TRUNCATED
:
4925 it
->continuation_lines_width
= 0;
4926 reseat_at_next_visible_line_start (it
, 0);
4927 if ((op
& MOVE_TO_POS
) != 0
4928 && IT_CHARPOS (*it
) > to_charpos
)
4935 case MOVE_LINE_CONTINUED
:
4936 it
->continuation_lines_width
+= it
->current_x
;
4943 /* Reset/increment for the next run. */
4944 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
4945 it
->current_x
= it
->hpos
= 0;
4946 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
4948 last_height
= it
->max_ascent
+ it
->max_descent
;
4949 last_max_ascent
= it
->max_ascent
;
4950 it
->max_ascent
= it
->max_descent
= 0;
4955 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
4959 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
4961 If DY > 0, move IT backward at least that many pixels. DY = 0
4962 means move IT backward to the preceding line start or BEGV. This
4963 function may move over more than DY pixels if IT->current_y - DY
4964 ends up in the middle of a line; in this case IT->current_y will be
4965 set to the top of the line moved to. */
4968 move_it_vertically_backward (it
, dy
)
4972 int nlines
, h
, line_height
;
4974 int start_pos
= IT_CHARPOS (*it
);
4978 /* Estimate how many newlines we must move back. */
4979 nlines
= max (1, dy
/ CANON_Y_UNIT (it
->f
));
4981 /* Set the iterator's position that many lines back. */
4982 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
4983 back_to_previous_visible_line_start (it
);
4985 /* Reseat the iterator here. When moving backward, we don't want
4986 reseat to skip forward over invisible text, set up the iterator
4987 to deliver from overlay strings at the new position etc. So,
4988 use reseat_1 here. */
4989 reseat_1 (it
, it
->current
.pos
, 1);
4991 /* We are now surely at a line start. */
4992 it
->current_x
= it
->hpos
= 0;
4994 /* Move forward and see what y-distance we moved. First move to the
4995 start of the next line so that we get its height. We need this
4996 height to be able to tell whether we reached the specified
4999 it2
.max_ascent
= it2
.max_descent
= 0;
5000 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
5001 MOVE_TO_POS
| MOVE_TO_VPOS
);
5002 xassert (IT_CHARPOS (*it
) >= BEGV
);
5003 line_height
= it2
.max_ascent
+ it2
.max_descent
;
5005 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
5006 xassert (IT_CHARPOS (*it
) >= BEGV
);
5007 h
= it2
.current_y
- it
->current_y
;
5008 nlines
= it2
.vpos
- it
->vpos
;
5010 /* Correct IT's y and vpos position. */
5016 /* DY == 0 means move to the start of the screen line. The
5017 value of nlines is > 0 if continuation lines were involved. */
5019 move_it_by_lines (it
, nlines
, 1);
5020 xassert (IT_CHARPOS (*it
) <= start_pos
);
5024 /* The y-position we try to reach. Note that h has been
5025 subtracted in front of the if-statement. */
5026 int target_y
= it
->current_y
+ h
- dy
;
5028 /* If we did not reach target_y, try to move further backward if
5029 we can. If we moved too far backward, try to move forward. */
5030 if (target_y
< it
->current_y
5031 && IT_CHARPOS (*it
) > BEGV
)
5033 move_it_vertically (it
, target_y
- it
->current_y
);
5034 xassert (IT_CHARPOS (*it
) >= BEGV
);
5036 else if (target_y
>= it
->current_y
+ line_height
5037 && IT_CHARPOS (*it
) < ZV
)
5039 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
5040 xassert (IT_CHARPOS (*it
) >= BEGV
);
5046 /* Move IT by a specified amount of pixel lines DY. DY negative means
5047 move backwards. DY = 0 means move to start of screen line. At the
5048 end, IT will be on the start of a screen line. */
5051 move_it_vertically (it
, dy
)
5056 move_it_vertically_backward (it
, -dy
);
5059 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
5060 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
5061 MOVE_TO_POS
| MOVE_TO_Y
);
5062 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
5064 /* If buffer ends in ZV without a newline, move to the start of
5065 the line to satisfy the post-condition. */
5066 if (IT_CHARPOS (*it
) == ZV
5067 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
5068 move_it_by_lines (it
, 0, 0);
5073 /* Return non-zero if some text between buffer positions START_CHARPOS
5074 and END_CHARPOS is invisible. IT->window is the window for text
5078 invisible_text_between_p (it
, start_charpos
, end_charpos
)
5080 int start_charpos
, end_charpos
;
5082 Lisp_Object prop
, limit
;
5083 int invisible_found_p
;
5085 xassert (it
!= NULL
&& start_charpos
<= end_charpos
);
5087 /* Is text at START invisible? */
5088 prop
= Fget_char_property (make_number (start_charpos
), Qinvisible
,
5090 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5091 invisible_found_p
= 1;
5094 limit
= Fnext_single_char_property_change (make_number (start_charpos
),
5096 make_number (end_charpos
));
5097 invisible_found_p
= XFASTINT (limit
) < end_charpos
;
5100 return invisible_found_p
;
5104 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
5105 negative means move up. DVPOS == 0 means move to the start of the
5106 screen line. NEED_Y_P non-zero means calculate IT->current_y. If
5107 NEED_Y_P is zero, IT->current_y will be left unchanged.
5109 Further optimization ideas: If we would know that IT->f doesn't use
5110 a face with proportional font, we could be faster for
5111 truncate-lines nil. */
5114 move_it_by_lines (it
, dvpos
, need_y_p
)
5116 int dvpos
, need_y_p
;
5118 struct position pos
;
5120 if (!FRAME_WINDOW_P (it
->f
))
5122 struct text_pos textpos
;
5124 /* We can use vmotion on frames without proportional fonts. */
5125 pos
= *vmotion (IT_CHARPOS (*it
), dvpos
, it
->w
);
5126 SET_TEXT_POS (textpos
, pos
.bufpos
, pos
.bytepos
);
5127 reseat (it
, textpos
, 1);
5128 it
->vpos
+= pos
.vpos
;
5129 it
->current_y
+= pos
.vpos
;
5131 else if (dvpos
== 0)
5133 /* DVPOS == 0 means move to the start of the screen line. */
5134 move_it_vertically_backward (it
, 0);
5135 xassert (it
->current_x
== 0 && it
->hpos
== 0);
5139 /* If there are no continuation lines, and if there is no
5140 selective display, try the simple method of moving forward
5141 DVPOS newlines, then see where we are. */
5142 if (!need_y_p
&& it
->truncate_lines_p
&& it
->selective
== 0)
5144 int shortage
= 0, charpos
;
5146 if (FETCH_BYTE (IT_BYTEPOS (*it
)) == '\n')
5147 charpos
= IT_CHARPOS (*it
) + 1;
5149 charpos
= scan_buffer ('\n', IT_CHARPOS (*it
), 0, dvpos
,
5152 if (!invisible_text_between_p (it
, IT_CHARPOS (*it
), charpos
))
5154 struct text_pos pos
;
5155 CHARPOS (pos
) = charpos
;
5156 BYTEPOS (pos
) = CHAR_TO_BYTE (charpos
);
5157 reseat (it
, pos
, 1);
5158 it
->vpos
+= dvpos
- shortage
;
5159 it
->hpos
= it
->current_x
= 0;
5164 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
5169 int start_charpos
, i
;
5171 /* If there are no continuation lines, and if there is no
5172 selective display, try the simple method of moving backward
5174 if (!need_y_p
&& it
->truncate_lines_p
&& it
->selective
== 0)
5177 int charpos
= IT_CHARPOS (*it
);
5178 int bytepos
= IT_BYTEPOS (*it
);
5180 /* If in the middle of a line, go to its start. */
5181 if (charpos
> BEGV
&& FETCH_BYTE (bytepos
- 1) != '\n')
5183 charpos
= find_next_newline_no_quit (charpos
, -1);
5184 bytepos
= CHAR_TO_BYTE (charpos
);
5187 if (charpos
== BEGV
)
5189 struct text_pos pos
;
5190 CHARPOS (pos
) = charpos
;
5191 BYTEPOS (pos
) = bytepos
;
5192 reseat (it
, pos
, 1);
5193 it
->hpos
= it
->current_x
= 0;
5198 charpos
= scan_buffer ('\n', charpos
- 1, 0, dvpos
, &shortage
, 0);
5199 if (!invisible_text_between_p (it
, charpos
, IT_CHARPOS (*it
)))
5201 struct text_pos pos
;
5202 CHARPOS (pos
) = charpos
;
5203 BYTEPOS (pos
) = CHAR_TO_BYTE (charpos
);
5204 reseat (it
, pos
, 1);
5205 it
->vpos
+= dvpos
+ (shortage
? shortage
- 1 : 0);
5206 it
->hpos
= it
->current_x
= 0;
5212 /* Go back -DVPOS visible lines and reseat the iterator there. */
5213 start_charpos
= IT_CHARPOS (*it
);
5214 for (i
= -dvpos
; i
&& IT_CHARPOS (*it
) > BEGV
; --i
)
5215 back_to_previous_visible_line_start (it
);
5216 reseat (it
, it
->current
.pos
, 1);
5217 it
->current_x
= it
->hpos
= 0;
5219 /* Above call may have moved too far if continuation lines
5220 are involved. Scan forward and see if it did. */
5222 it2
.vpos
= it2
.current_y
= 0;
5223 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
5224 it
->vpos
-= it2
.vpos
;
5225 it
->current_y
-= it2
.current_y
;
5226 it
->current_x
= it
->hpos
= 0;
5228 /* If we moved too far, move IT some lines forward. */
5229 if (it2
.vpos
> -dvpos
)
5231 int delta
= it2
.vpos
+ dvpos
;
5232 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
5239 /***********************************************************************
5241 ***********************************************************************/
5244 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
5248 add_to_log (format
, arg1
, arg2
)
5250 Lisp_Object arg1
, arg2
;
5252 Lisp_Object args
[3];
5253 Lisp_Object msg
, fmt
;
5256 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
5259 GCPRO4 (fmt
, msg
, arg1
, arg2
);
5261 args
[0] = fmt
= build_string (format
);
5264 msg
= Fformat (3, args
);
5266 len
= STRING_BYTES (XSTRING (msg
)) + 1;
5267 buffer
= (char *) alloca (len
);
5268 strcpy (buffer
, XSTRING (msg
)->data
);
5270 message_dolog (buffer
, len
- 1, 1, 0);
5275 /* Output a newline in the *Messages* buffer if "needs" one. */
5278 message_log_maybe_newline ()
5280 if (message_log_need_newline
)
5281 message_dolog ("", 0, 1, 0);
5285 /* Add a string M of length LEN to the message log, optionally
5286 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
5287 nonzero, means interpret the contents of M as multibyte. This
5288 function calls low-level routines in order to bypass text property
5289 hooks, etc. which might not be safe to run. */
5292 message_dolog (m
, len
, nlflag
, multibyte
)
5294 int len
, nlflag
, multibyte
;
5296 if (!NILP (Vmessage_log_max
))
5298 struct buffer
*oldbuf
;
5299 Lisp_Object oldpoint
, oldbegv
, oldzv
;
5300 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
5301 int point_at_end
= 0;
5303 Lisp_Object old_deactivate_mark
, tem
;
5304 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
5306 old_deactivate_mark
= Vdeactivate_mark
;
5307 oldbuf
= current_buffer
;
5308 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
5309 current_buffer
->undo_list
= Qt
;
5311 oldpoint
= Fpoint_marker ();
5312 oldbegv
= Fpoint_min_marker ();
5313 oldzv
= Fpoint_max_marker ();
5314 GCPRO4 (oldpoint
, oldbegv
, oldzv
, old_deactivate_mark
);
5322 BEGV_BYTE
= BEG_BYTE
;
5325 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
5327 /* Insert the string--maybe converting multibyte to single byte
5328 or vice versa, so that all the text fits the buffer. */
5330 && NILP (current_buffer
->enable_multibyte_characters
))
5333 unsigned char work
[1];
5335 /* Convert a multibyte string to single-byte
5336 for the *Message* buffer. */
5337 for (i
= 0; i
< len
; i
+= nbytes
)
5339 c
= string_char_and_length (m
+ i
, len
- i
, &nbytes
);
5340 work
[0] = (SINGLE_BYTE_CHAR_P (c
)
5342 : multibyte_char_to_unibyte (c
, Qnil
));
5343 insert_1_both (work
, 1, 1, 1, 0, 0);
5346 else if (! multibyte
5347 && ! NILP (current_buffer
->enable_multibyte_characters
))
5350 unsigned char *msg
= (unsigned char *) m
;
5351 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
5352 /* Convert a single-byte string to multibyte
5353 for the *Message* buffer. */
5354 for (i
= 0; i
< len
; i
++)
5356 c
= unibyte_char_to_multibyte (msg
[i
]);
5357 nbytes
= CHAR_STRING (c
, str
);
5358 insert_1_both (str
, 1, nbytes
, 1, 0, 0);
5362 insert_1 (m
, len
, 1, 0, 0);
5366 int this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
, dup
;
5367 insert_1 ("\n", 1, 1, 0, 0);
5369 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
5371 this_bol_byte
= PT_BYTE
;
5375 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
5377 prev_bol_byte
= PT_BYTE
;
5379 dup
= message_log_check_duplicate (prev_bol
, prev_bol_byte
,
5380 this_bol
, this_bol_byte
);
5383 del_range_both (prev_bol
, prev_bol_byte
,
5384 this_bol
, this_bol_byte
, 0);
5390 /* If you change this format, don't forget to also
5391 change message_log_check_duplicate. */
5392 sprintf (dupstr
, " [%d times]", dup
);
5393 duplen
= strlen (dupstr
);
5394 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
5395 insert_1 (dupstr
, duplen
, 1, 0, 1);
5400 if (NATNUMP (Vmessage_log_max
))
5402 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
5403 -XFASTINT (Vmessage_log_max
) - 1, 0);
5404 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
5407 BEGV
= XMARKER (oldbegv
)->charpos
;
5408 BEGV_BYTE
= marker_byte_position (oldbegv
);
5417 ZV
= XMARKER (oldzv
)->charpos
;
5418 ZV_BYTE
= marker_byte_position (oldzv
);
5422 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
5424 /* We can't do Fgoto_char (oldpoint) because it will run some
5426 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
5427 XMARKER (oldpoint
)->bytepos
);
5430 free_marker (oldpoint
);
5431 free_marker (oldbegv
);
5432 free_marker (oldzv
);
5434 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
5435 set_buffer_internal (oldbuf
);
5437 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
5438 message_log_need_newline
= !nlflag
;
5439 Vdeactivate_mark
= old_deactivate_mark
;
5444 /* We are at the end of the buffer after just having inserted a newline.
5445 (Note: We depend on the fact we won't be crossing the gap.)
5446 Check to see if the most recent message looks a lot like the previous one.
5447 Return 0 if different, 1 if the new one should just replace it, or a
5448 value N > 1 if we should also append " [N times]". */
5451 message_log_check_duplicate (prev_bol
, prev_bol_byte
, this_bol
, this_bol_byte
)
5452 int prev_bol
, this_bol
;
5453 int prev_bol_byte
, this_bol_byte
;
5456 int len
= Z_BYTE
- 1 - this_bol_byte
;
5458 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
5459 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
5461 for (i
= 0; i
< len
; i
++)
5463 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
5471 if (*p1
++ == ' ' && *p1
++ == '[')
5474 while (*p1
>= '0' && *p1
<= '9')
5475 n
= n
* 10 + *p1
++ - '0';
5476 if (strncmp (p1
, " times]\n", 8) == 0)
5483 /* Display an echo area message M with a specified length of LEN
5484 chars. The string may include null characters. If M is 0, clear
5485 out any existing message, and let the mini-buffer text show through.
5487 The buffer M must continue to exist until after the echo area gets
5488 cleared or some other message gets displayed there. This means do
5489 not pass text that is stored in a Lisp string; do not pass text in
5490 a buffer that was alloca'd. */
5493 message2 (m
, len
, multibyte
)
5498 /* First flush out any partial line written with print. */
5499 message_log_maybe_newline ();
5501 message_dolog (m
, len
, 1, multibyte
);
5502 message2_nolog (m
, len
, multibyte
);
5506 /* The non-logging counterpart of message2. */
5509 message2_nolog (m
, len
, multibyte
)
5513 struct frame
*sf
= SELECTED_FRAME ();
5514 message_enable_multibyte
= multibyte
;
5518 if (noninteractive_need_newline
)
5519 putc ('\n', stderr
);
5520 noninteractive_need_newline
= 0;
5522 fwrite (m
, len
, 1, stderr
);
5523 if (cursor_in_echo_area
== 0)
5524 fprintf (stderr
, "\n");
5527 /* A null message buffer means that the frame hasn't really been
5528 initialized yet. Error messages get reported properly by
5529 cmd_error, so this must be just an informative message; toss it. */
5530 else if (INTERACTIVE
5531 && sf
->glyphs_initialized_p
5532 && FRAME_MESSAGE_BUF (sf
))
5534 Lisp_Object mini_window
;
5537 /* Get the frame containing the mini-buffer
5538 that the selected frame is using. */
5539 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
5540 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
5542 FRAME_SAMPLE_VISIBILITY (f
);
5543 if (FRAME_VISIBLE_P (sf
)
5544 && ! FRAME_VISIBLE_P (f
))
5545 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
5549 set_message (m
, Qnil
, len
, multibyte
);
5550 if (minibuffer_auto_raise
)
5551 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
5554 clear_message (1, 1);
5556 do_pending_window_change (0);
5557 echo_area_display (1);
5558 do_pending_window_change (0);
5559 if (frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
5560 (*frame_up_to_date_hook
) (f
);
5565 /* Display an echo area message M with a specified length of NBYTES
5566 bytes. The string may include null characters. If M is not a
5567 string, clear out any existing message, and let the mini-buffer
5568 text show through. */
5571 message3 (m
, nbytes
, multibyte
)
5576 struct gcpro gcpro1
;
5580 /* First flush out any partial line written with print. */
5581 message_log_maybe_newline ();
5583 message_dolog (XSTRING (m
)->data
, nbytes
, 1, multibyte
);
5584 message3_nolog (m
, nbytes
, multibyte
);
5590 /* The non-logging version of message3. */
5593 message3_nolog (m
, nbytes
, multibyte
)
5595 int nbytes
, multibyte
;
5597 struct frame
*sf
= SELECTED_FRAME ();
5598 message_enable_multibyte
= multibyte
;
5602 if (noninteractive_need_newline
)
5603 putc ('\n', stderr
);
5604 noninteractive_need_newline
= 0;
5606 fwrite (XSTRING (m
)->data
, nbytes
, 1, stderr
);
5607 if (cursor_in_echo_area
== 0)
5608 fprintf (stderr
, "\n");
5611 /* A null message buffer means that the frame hasn't really been
5612 initialized yet. Error messages get reported properly by
5613 cmd_error, so this must be just an informative message; toss it. */
5614 else if (INTERACTIVE
5615 && sf
->glyphs_initialized_p
5616 && FRAME_MESSAGE_BUF (sf
))
5618 Lisp_Object mini_window
;
5622 /* Get the frame containing the mini-buffer
5623 that the selected frame is using. */
5624 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
5625 frame
= XWINDOW (mini_window
)->frame
;
5628 FRAME_SAMPLE_VISIBILITY (f
);
5629 if (FRAME_VISIBLE_P (sf
)
5630 && !FRAME_VISIBLE_P (f
))
5631 Fmake_frame_visible (frame
);
5633 if (STRINGP (m
) && XSTRING (m
)->size
)
5635 set_message (NULL
, m
, nbytes
, multibyte
);
5636 if (minibuffer_auto_raise
)
5637 Fraise_frame (frame
);
5640 clear_message (1, 1);
5642 do_pending_window_change (0);
5643 echo_area_display (1);
5644 do_pending_window_change (0);
5645 if (frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
5646 (*frame_up_to_date_hook
) (f
);
5651 /* Display a null-terminated echo area message M. If M is 0, clear
5652 out any existing message, and let the mini-buffer text show through.
5654 The buffer M must continue to exist until after the echo area gets
5655 cleared or some other message gets displayed there. Do not pass
5656 text that is stored in a Lisp string. Do not pass text in a buffer
5657 that was alloca'd. */
5663 message2 (m
, (m
? strlen (m
) : 0), 0);
5667 /* The non-logging counterpart of message1. */
5673 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
5676 /* Display a message M which contains a single %s
5677 which gets replaced with STRING. */
5680 message_with_string (m
, string
, log
)
5689 if (noninteractive_need_newline
)
5690 putc ('\n', stderr
);
5691 noninteractive_need_newline
= 0;
5692 fprintf (stderr
, m
, XSTRING (string
)->data
);
5693 if (cursor_in_echo_area
== 0)
5694 fprintf (stderr
, "\n");
5698 else if (INTERACTIVE
)
5700 /* The frame whose minibuffer we're going to display the message on.
5701 It may be larger than the selected frame, so we need
5702 to use its buffer, not the selected frame's buffer. */
5703 Lisp_Object mini_window
;
5704 struct frame
*f
, *sf
= SELECTED_FRAME ();
5706 /* Get the frame containing the minibuffer
5707 that the selected frame is using. */
5708 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
5709 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
5711 /* A null message buffer means that the frame hasn't really been
5712 initialized yet. Error messages get reported properly by
5713 cmd_error, so this must be just an informative message; toss it. */
5714 if (FRAME_MESSAGE_BUF (f
))
5718 a
[0] = (char *) XSTRING (string
)->data
;
5720 len
= doprnt (FRAME_MESSAGE_BUF (f
),
5721 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3, a
);
5724 message2 (FRAME_MESSAGE_BUF (f
), len
,
5725 STRING_MULTIBYTE (string
));
5727 message2_nolog (FRAME_MESSAGE_BUF (f
), len
,
5728 STRING_MULTIBYTE (string
));
5730 /* Print should start at the beginning of the message
5731 buffer next time. */
5732 message_buf_print
= 0;
5738 /* Dump an informative message to the minibuf. If M is 0, clear out
5739 any existing message, and let the mini-buffer text show through. */
5743 message (m
, a1
, a2
, a3
)
5745 EMACS_INT a1
, a2
, a3
;
5751 if (noninteractive_need_newline
)
5752 putc ('\n', stderr
);
5753 noninteractive_need_newline
= 0;
5754 fprintf (stderr
, m
, a1
, a2
, a3
);
5755 if (cursor_in_echo_area
== 0)
5756 fprintf (stderr
, "\n");
5760 else if (INTERACTIVE
)
5762 /* The frame whose mini-buffer we're going to display the message
5763 on. It may be larger than the selected frame, so we need to
5764 use its buffer, not the selected frame's buffer. */
5765 Lisp_Object mini_window
;
5766 struct frame
*f
, *sf
= SELECTED_FRAME ();
5768 /* Get the frame containing the mini-buffer
5769 that the selected frame is using. */
5770 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
5771 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
5773 /* A null message buffer means that the frame hasn't really been
5774 initialized yet. Error messages get reported properly by
5775 cmd_error, so this must be just an informative message; toss
5777 if (FRAME_MESSAGE_BUF (f
))
5788 len
= doprnt (FRAME_MESSAGE_BUF (f
),
5789 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3, a
);
5791 len
= doprnt (FRAME_MESSAGE_BUF (f
),
5792 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3,
5794 #endif /* NO_ARG_ARRAY */
5796 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
5801 /* Print should start at the beginning of the message
5802 buffer next time. */
5803 message_buf_print
= 0;
5809 /* The non-logging version of message. */
5812 message_nolog (m
, a1
, a2
, a3
)
5814 EMACS_INT a1
, a2
, a3
;
5816 Lisp_Object old_log_max
;
5817 old_log_max
= Vmessage_log_max
;
5818 Vmessage_log_max
= Qnil
;
5819 message (m
, a1
, a2
, a3
);
5820 Vmessage_log_max
= old_log_max
;
5824 /* Display the current message in the current mini-buffer. This is
5825 only called from error handlers in process.c, and is not time
5831 if (!NILP (echo_area_buffer
[0]))
5834 string
= Fcurrent_message ();
5835 message3 (string
, XSTRING (string
)->size
,
5836 !NILP (current_buffer
->enable_multibyte_characters
));
5841 /* Make sure echo area buffers in echo_buffers[] are life. If they
5842 aren't, make new ones. */
5845 ensure_echo_area_buffers ()
5849 for (i
= 0; i
< 2; ++i
)
5850 if (!BUFFERP (echo_buffer
[i
])
5851 || NILP (XBUFFER (echo_buffer
[i
])->name
))
5854 Lisp_Object old_buffer
;
5857 old_buffer
= echo_buffer
[i
];
5858 sprintf (name
, " *Echo Area %d*", i
);
5859 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
5860 XBUFFER (echo_buffer
[i
])->truncate_lines
= Qnil
;
5862 for (j
= 0; j
< 2; ++j
)
5863 if (EQ (old_buffer
, echo_area_buffer
[j
]))
5864 echo_area_buffer
[j
] = echo_buffer
[i
];
5869 /* Call FN with args A1..A4 with either the current or last displayed
5870 echo_area_buffer as current buffer.
5872 WHICH zero means use the current message buffer
5873 echo_area_buffer[0]. If that is nil, choose a suitable buffer
5874 from echo_buffer[] and clear it.
5876 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
5877 suitable buffer from echo_buffer[] and clear it.
5879 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
5880 that the current message becomes the last displayed one, make
5881 choose a suitable buffer for echo_area_buffer[0], and clear it.
5883 Value is what FN returns. */
5886 with_echo_area_buffer (w
, which
, fn
, a1
, a2
, a3
, a4
)
5889 int (*fn
) P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
5895 int this_one
, the_other
, clear_buffer_p
, rc
;
5896 int count
= BINDING_STACK_SIZE ();
5898 /* If buffers aren't life, make new ones. */
5899 ensure_echo_area_buffers ();
5904 this_one
= 0, the_other
= 1;
5906 this_one
= 1, the_other
= 0;
5909 this_one
= 0, the_other
= 1;
5912 /* We need a fresh one in case the current echo buffer equals
5913 the one containing the last displayed echo area message. */
5914 if (!NILP (echo_area_buffer
[this_one
])
5915 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
5916 echo_area_buffer
[this_one
] = Qnil
;
5919 /* Choose a suitable buffer from echo_buffer[] is we don't
5921 if (NILP (echo_area_buffer
[this_one
]))
5923 echo_area_buffer
[this_one
]
5924 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
5925 ? echo_buffer
[the_other
]
5926 : echo_buffer
[this_one
]);
5930 buffer
= echo_area_buffer
[this_one
];
5932 record_unwind_protect (unwind_with_echo_area_buffer
,
5933 with_echo_area_buffer_unwind_data (w
));
5935 /* Make the echo area buffer current. Note that for display
5936 purposes, it is not necessary that the displayed window's buffer
5937 == current_buffer, except for text property lookup. So, let's
5938 only set that buffer temporarily here without doing a full
5939 Fset_window_buffer. We must also change w->pointm, though,
5940 because otherwise an assertions in unshow_buffer fails, and Emacs
5942 set_buffer_internal_1 (XBUFFER (buffer
));
5946 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
5949 current_buffer
->undo_list
= Qt
;
5950 current_buffer
->read_only
= Qnil
;
5951 specbind (Qinhibit_read_only
, Qt
);
5953 if (clear_buffer_p
&& Z
> BEG
)
5956 xassert (BEGV
>= BEG
);
5957 xassert (ZV
<= Z
&& ZV
>= BEGV
);
5959 rc
= fn (a1
, a2
, a3
, a4
);
5961 xassert (BEGV
>= BEG
);
5962 xassert (ZV
<= Z
&& ZV
>= BEGV
);
5964 unbind_to (count
, Qnil
);
5969 /* Save state that should be preserved around the call to the function
5970 FN called in with_echo_area_buffer. */
5973 with_echo_area_buffer_unwind_data (w
)
5979 /* Reduce consing by keeping one vector in
5980 Vwith_echo_area_save_vector. */
5981 vector
= Vwith_echo_area_save_vector
;
5982 Vwith_echo_area_save_vector
= Qnil
;
5985 vector
= Fmake_vector (make_number (7), Qnil
);
5987 XSETBUFFER (XVECTOR (vector
)->contents
[i
], current_buffer
); ++i
;
5988 XVECTOR (vector
)->contents
[i
++] = Vdeactivate_mark
;
5989 XVECTOR (vector
)->contents
[i
++] = make_number (windows_or_buffers_changed
);
5993 XSETWINDOW (XVECTOR (vector
)->contents
[i
], w
); ++i
;
5994 XVECTOR (vector
)->contents
[i
++] = w
->buffer
;
5995 XVECTOR (vector
)->contents
[i
++]
5996 = make_number (XMARKER (w
->pointm
)->charpos
);
5997 XVECTOR (vector
)->contents
[i
++]
5998 = make_number (XMARKER (w
->pointm
)->bytepos
);
6004 XVECTOR (vector
)->contents
[i
++] = Qnil
;
6007 xassert (i
== XVECTOR (vector
)->size
);
6012 /* Restore global state from VECTOR which was created by
6013 with_echo_area_buffer_unwind_data. */
6016 unwind_with_echo_area_buffer (vector
)
6019 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
6020 Vdeactivate_mark
= AREF (vector
, 1);
6021 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
6023 if (WINDOWP (AREF (vector
, 3)))
6026 Lisp_Object buffer
, charpos
, bytepos
;
6028 w
= XWINDOW (AREF (vector
, 3));
6029 buffer
= AREF (vector
, 4);
6030 charpos
= AREF (vector
, 5);
6031 bytepos
= AREF (vector
, 6);
6034 set_marker_both (w
->pointm
, buffer
,
6035 XFASTINT (charpos
), XFASTINT (bytepos
));
6038 Vwith_echo_area_save_vector
= vector
;
6043 /* Set up the echo area for use by print functions. MULTIBYTE_P
6044 non-zero means we will print multibyte. */
6047 setup_echo_area_for_printing (multibyte_p
)
6050 ensure_echo_area_buffers ();
6052 if (!message_buf_print
)
6054 /* A message has been output since the last time we printed.
6055 Choose a fresh echo area buffer. */
6056 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
6057 echo_area_buffer
[0] = echo_buffer
[1];
6059 echo_area_buffer
[0] = echo_buffer
[0];
6061 /* Switch to that buffer and clear it. */
6062 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
6066 int count
= BINDING_STACK_SIZE ();
6067 specbind (Qinhibit_read_only
, Qt
);
6069 unbind_to (count
, Qnil
);
6071 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
6073 /* Set up the buffer for the multibyteness we need. */
6075 != !NILP (current_buffer
->enable_multibyte_characters
))
6076 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
6078 /* Raise the frame containing the echo area. */
6079 if (minibuffer_auto_raise
)
6081 struct frame
*sf
= SELECTED_FRAME ();
6082 Lisp_Object mini_window
;
6083 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
6084 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
6087 message_log_maybe_newline ();
6088 message_buf_print
= 1;
6092 if (NILP (echo_area_buffer
[0]))
6094 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
6095 echo_area_buffer
[0] = echo_buffer
[1];
6097 echo_area_buffer
[0] = echo_buffer
[0];
6100 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
6101 /* Someone switched buffers between print requests. */
6102 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
6107 /* Display an echo area message in window W. Value is non-zero if W's
6108 height is changed. If display_last_displayed_message_p is
6109 non-zero, display the message that was last displayed, otherwise
6110 display the current message. */
6113 display_echo_area (w
)
6116 int i
, no_message_p
, window_height_changed_p
, count
;
6118 /* Temporarily disable garbage collections while displaying the echo
6119 area. This is done because a GC can print a message itself.
6120 That message would modify the echo area buffer's contents while a
6121 redisplay of the buffer is going on, and seriously confuse
6123 count
= inhibit_garbage_collection ();
6125 /* If there is no message, we must call display_echo_area_1
6126 nevertheless because it resizes the window. But we will have to
6127 reset the echo_area_buffer in question to nil at the end because
6128 with_echo_area_buffer will sets it to an empty buffer. */
6129 i
= display_last_displayed_message_p
? 1 : 0;
6130 no_message_p
= NILP (echo_area_buffer
[i
]);
6132 window_height_changed_p
6133 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
6134 display_echo_area_1
,
6135 (EMACS_INT
) w
, Qnil
, 0, 0);
6138 echo_area_buffer
[i
] = Qnil
;
6140 unbind_to (count
, Qnil
);
6141 return window_height_changed_p
;
6145 /* Helper for display_echo_area. Display the current buffer which
6146 contains the current echo area message in window W, a mini-window,
6147 a pointer to which is passed in A1. A2..A4 are currently not used.
6148 Change the height of W so that all of the message is displayed.
6149 Value is non-zero if height of W was changed. */
6152 display_echo_area_1 (a1
, a2
, a3
, a4
)
6157 struct window
*w
= (struct window
*) a1
;
6159 struct text_pos start
;
6160 int window_height_changed_p
= 0;
6162 /* Do this before displaying, so that we have a large enough glyph
6163 matrix for the display. */
6164 window_height_changed_p
= resize_mini_window (w
, 0);
6167 clear_glyph_matrix (w
->desired_matrix
);
6168 XSETWINDOW (window
, w
);
6169 SET_TEXT_POS (start
, BEG
, BEG_BYTE
);
6170 try_window (window
, start
);
6172 return window_height_changed_p
;
6176 /* Resize the echo area window to exactly the size needed for the
6177 currently displayed message, if there is one. */
6180 resize_echo_area_axactly ()
6182 if (BUFFERP (echo_area_buffer
[0])
6183 && WINDOWP (echo_area_window
))
6185 struct window
*w
= XWINDOW (echo_area_window
);
6188 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
6189 (EMACS_INT
) w
, Qnil
, 0, 0);
6192 ++windows_or_buffers_changed
;
6193 ++update_mode_lines
;
6194 redisplay_internal (0);
6200 /* Callback function for with_echo_area_buffer, when used from
6201 resize_echo_area_axactly. A1 contains a pointer to the window to
6202 resize, A2 to A4 are not used. Value is what resize_mini_window
6206 resize_mini_window_1 (a1
, a2
, a3
, a4
)
6211 return resize_mini_window ((struct window
*) a1
, 1);
6215 /* Resize mini-window W to fit the size of its contents. EXACT:P
6216 means size the window exactly to the size needed. Otherwise, it's
6217 only enlarged until W's buffer is empty. Value is non-zero if
6218 the window height has been changed. */
6221 resize_mini_window (w
, exact_p
)
6225 struct frame
*f
= XFRAME (w
->frame
);
6226 int window_height_changed_p
= 0;
6228 xassert (MINI_WINDOW_P (w
));
6230 /* Nil means don't try to resize. */
6231 if (NILP (Vresize_mini_windows
)
6232 || (FRAME_X_P (f
) && f
->output_data
.x
== NULL
))
6235 if (!FRAME_MINIBUF_ONLY_P (f
))
6238 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
6239 int total_height
= XFASTINT (root
->height
) + XFASTINT (w
->height
);
6240 int height
, max_height
;
6241 int unit
= CANON_Y_UNIT (f
);
6242 struct text_pos start
;
6243 struct buffer
*old_current_buffer
= NULL
;
6245 if (current_buffer
!= XBUFFER (w
->buffer
))
6247 old_current_buffer
= current_buffer
;
6248 set_buffer_internal (XBUFFER (w
->buffer
));
6251 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
6253 /* Compute the max. number of lines specified by the user. */
6254 if (FLOATP (Vmax_mini_window_height
))
6255 max_height
= XFLOATINT (Vmax_mini_window_height
) * total_height
;
6256 else if (INTEGERP (Vmax_mini_window_height
))
6257 max_height
= XINT (Vmax_mini_window_height
);
6259 max_height
= total_height
/ 4;
6261 /* Correct that max. height if it's bogus. */
6262 max_height
= max (1, max_height
);
6263 max_height
= min (total_height
, max_height
);
6265 /* Find out the height of the text in the window. */
6266 if (it
.truncate_lines_p
)
6271 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
6272 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
6273 height
= it
.current_y
+ last_height
;
6275 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
6276 height
-= it
.extra_line_spacing
;
6277 height
= (height
+ unit
- 1) / unit
;
6280 /* Compute a suitable window start. */
6281 if (height
> max_height
)
6283 height
= max_height
;
6284 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
6285 move_it_vertically_backward (&it
, (height
- 1) * unit
);
6286 start
= it
.current
.pos
;
6289 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
6290 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
6292 if (EQ (Vresize_mini_windows
, Qgrow_only
))
6294 /* Let it grow only, until we display an empty message, in which
6295 case the window shrinks again. */
6296 if (height
> XFASTINT (w
->height
))
6298 int old_height
= XFASTINT (w
->height
);
6299 freeze_window_starts (f
, 1);
6300 grow_mini_window (w
, height
- XFASTINT (w
->height
));
6301 window_height_changed_p
= XFASTINT (w
->height
) != old_height
;
6303 else if (height
< XFASTINT (w
->height
)
6304 && (exact_p
|| BEGV
== ZV
))
6306 int old_height
= XFASTINT (w
->height
);
6307 freeze_window_starts (f
, 0);
6308 shrink_mini_window (w
);
6309 window_height_changed_p
= XFASTINT (w
->height
) != old_height
;
6314 /* Always resize to exact size needed. */
6315 if (height
> XFASTINT (w
->height
))
6317 int old_height
= XFASTINT (w
->height
);
6318 freeze_window_starts (f
, 1);
6319 grow_mini_window (w
, height
- XFASTINT (w
->height
));
6320 window_height_changed_p
= XFASTINT (w
->height
) != old_height
;
6322 else if (height
< XFASTINT (w
->height
))
6324 int old_height
= XFASTINT (w
->height
);
6325 freeze_window_starts (f
, 0);
6326 shrink_mini_window (w
);
6330 freeze_window_starts (f
, 1);
6331 grow_mini_window (w
, height
- XFASTINT (w
->height
));
6334 window_height_changed_p
= XFASTINT (w
->height
) != old_height
;
6338 if (old_current_buffer
)
6339 set_buffer_internal (old_current_buffer
);
6342 return window_height_changed_p
;
6346 /* Value is the current message, a string, or nil if there is no
6354 if (NILP (echo_area_buffer
[0]))
6358 with_echo_area_buffer (0, 0, current_message_1
,
6359 (EMACS_INT
) &msg
, Qnil
, 0, 0);
6361 echo_area_buffer
[0] = Qnil
;
6369 current_message_1 (a1
, a2
, a3
, a4
)
6374 Lisp_Object
*msg
= (Lisp_Object
*) a1
;
6377 *msg
= make_buffer_string (BEG
, Z
, 1);
6384 /* Push the current message on Vmessage_stack for later restauration
6385 by restore_message. Value is non-zero if the current message isn't
6386 empty. This is a relatively infrequent operation, so it's not
6387 worth optimizing. */
6393 msg
= current_message ();
6394 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
6395 return STRINGP (msg
);
6399 /* Restore message display from the top of Vmessage_stack. */
6406 xassert (CONSP (Vmessage_stack
));
6407 msg
= XCAR (Vmessage_stack
);
6409 message3_nolog (msg
, STRING_BYTES (XSTRING (msg
)), STRING_MULTIBYTE (msg
));
6411 message3_nolog (msg
, 0, 0);
6415 /* Pop the top-most entry off Vmessage_stack. */
6420 xassert (CONSP (Vmessage_stack
));
6421 Vmessage_stack
= XCDR (Vmessage_stack
);
6425 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
6426 exits. If the stack is not empty, we have a missing pop_message
6430 check_message_stack ()
6432 if (!NILP (Vmessage_stack
))
6437 /* Truncate to NCHARS what will be displayed in the echo area the next
6438 time we display it---but don't redisplay it now. */
6441 truncate_echo_area (nchars
)
6445 echo_area_buffer
[0] = Qnil
;
6446 /* A null message buffer means that the frame hasn't really been
6447 initialized yet. Error messages get reported properly by
6448 cmd_error, so this must be just an informative message; toss it. */
6449 else if (!noninteractive
6451 && !NILP (echo_area_buffer
[0]))
6453 struct frame
*sf
= SELECTED_FRAME ();
6454 if (FRAME_MESSAGE_BUF (sf
))
6455 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
6460 /* Helper function for truncate_echo_area. Truncate the current
6461 message to at most NCHARS characters. */
6464 truncate_message_1 (nchars
, a2
, a3
, a4
)
6469 if (BEG
+ nchars
< Z
)
6470 del_range (BEG
+ nchars
, Z
);
6472 echo_area_buffer
[0] = Qnil
;
6477 /* Set the current message to a substring of S or STRING.
6479 If STRING is a Lisp string, set the message to the first NBYTES
6480 bytes from STRING. NBYTES zero means use the whole string. If
6481 STRING is multibyte, the message will be displayed multibyte.
6483 If S is not null, set the message to the first LEN bytes of S. LEN
6484 zero means use the whole string. MULTIBYTE_P non-zero means S is
6485 multibyte. Display the message multibyte in that case. */
6488 set_message (s
, string
, nbytes
, multibyte_p
)
6493 message_enable_multibyte
6494 = ((s
&& multibyte_p
)
6495 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
6497 with_echo_area_buffer (0, -1, set_message_1
,
6498 (EMACS_INT
) s
, string
, nbytes
, multibyte_p
);
6499 message_buf_print
= 0;
6500 help_echo_showing_p
= 0;
6504 /* Helper function for set_message. Arguments have the same meaning
6505 as there, with A1 corresponding to S and A2 corresponding to STRING
6506 This function is called with the echo area buffer being
6510 set_message_1 (a1
, a2
, nbytes
, multibyte_p
)
6513 EMACS_INT nbytes
, multibyte_p
;
6515 char *s
= (char *) a1
;
6516 Lisp_Object string
= a2
;
6520 /* Change multibyteness of the echo buffer appropriately. */
6521 if (message_enable_multibyte
6522 != !NILP (current_buffer
->enable_multibyte_characters
))
6523 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
6525 current_buffer
->truncate_lines
= message_truncate_lines
? Qt
: Qnil
;
6527 /* Insert new message at BEG. */
6528 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
6530 if (STRINGP (string
))
6535 nbytes
= XSTRING (string
)->size_byte
;
6536 nchars
= string_byte_to_char (string
, nbytes
);
6538 /* This function takes care of single/multibyte conversion. We
6539 just have to ensure that the echo area buffer has the right
6540 setting of enable_multibyte_characters. */
6541 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
6546 nbytes
= strlen (s
);
6548 if (multibyte_p
&& NILP (current_buffer
->enable_multibyte_characters
))
6550 /* Convert from multi-byte to single-byte. */
6552 unsigned char work
[1];
6554 /* Convert a multibyte string to single-byte. */
6555 for (i
= 0; i
< nbytes
; i
+= n
)
6557 c
= string_char_and_length (s
+ i
, nbytes
- i
, &n
);
6558 work
[0] = (SINGLE_BYTE_CHAR_P (c
)
6560 : multibyte_char_to_unibyte (c
, Qnil
));
6561 insert_1_both (work
, 1, 1, 1, 0, 0);
6564 else if (!multibyte_p
6565 && !NILP (current_buffer
->enable_multibyte_characters
))
6567 /* Convert from single-byte to multi-byte. */
6569 unsigned char *msg
= (unsigned char *) s
;
6570 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
6572 /* Convert a single-byte string to multibyte. */
6573 for (i
= 0; i
< nbytes
; i
++)
6575 c
= unibyte_char_to_multibyte (msg
[i
]);
6576 n
= CHAR_STRING (c
, str
);
6577 insert_1_both (str
, 1, n
, 1, 0, 0);
6581 insert_1 (s
, nbytes
, 1, 0, 0);
6588 /* Clear messages. CURRENT_P non-zero means clear the current
6589 message. LAST_DISPLAYED_P non-zero means clear the message
6593 clear_message (current_p
, last_displayed_p
)
6594 int current_p
, last_displayed_p
;
6597 echo_area_buffer
[0] = Qnil
;
6599 if (last_displayed_p
)
6600 echo_area_buffer
[1] = Qnil
;
6602 message_buf_print
= 0;
6605 /* Clear garbaged frames.
6607 This function is used where the old redisplay called
6608 redraw_garbaged_frames which in turn called redraw_frame which in
6609 turn called clear_frame. The call to clear_frame was a source of
6610 flickering. I believe a clear_frame is not necessary. It should
6611 suffice in the new redisplay to invalidate all current matrices,
6612 and ensure a complete redisplay of all windows. */
6615 clear_garbaged_frames ()
6619 Lisp_Object tail
, frame
;
6621 FOR_EACH_FRAME (tail
, frame
)
6623 struct frame
*f
= XFRAME (frame
);
6625 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
6627 clear_current_matrices (f
);
6633 ++windows_or_buffers_changed
;
6638 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
6639 is non-zero update selected_frame. Value is non-zero if the
6640 mini-windows height has been changed. */
6643 echo_area_display (update_frame_p
)
6646 Lisp_Object mini_window
;
6649 int window_height_changed_p
= 0;
6650 struct frame
*sf
= SELECTED_FRAME ();
6652 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
6653 w
= XWINDOW (mini_window
);
6654 f
= XFRAME (WINDOW_FRAME (w
));
6656 /* Don't display if frame is invisible or not yet initialized. */
6657 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
6660 /* The terminal frame is used as the first Emacs frame on the Mac OS. */
6662 #ifdef HAVE_WINDOW_SYSTEM
6663 /* When Emacs starts, selected_frame may be a visible terminal
6664 frame, even if we run under a window system. If we let this
6665 through, a message would be displayed on the terminal. */
6666 if (EQ (selected_frame
, Vterminal_frame
)
6667 && !NILP (Vwindow_system
))
6669 #endif /* HAVE_WINDOW_SYSTEM */
6672 /* Redraw garbaged frames. */
6674 clear_garbaged_frames ();
6676 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
6678 echo_area_window
= mini_window
;
6679 window_height_changed_p
= display_echo_area (w
);
6680 w
->must_be_updated_p
= 1;
6682 /* Update the display, unless called from redisplay_internal.
6683 Also don't update the screen during redisplay itself. The
6684 update will happen at the end of redisplay, and an update
6685 here could cause confusion. */
6686 if (update_frame_p
&& !redisplaying_p
)
6690 /* If the display update has been interrupted by pending
6691 input, update mode lines in the frame. Due to the
6692 pending input, it might have been that redisplay hasn't
6693 been called, so that mode lines above the echo area are
6694 garbaged. This looks odd, so we prevent it here. */
6695 if (!display_completed
)
6696 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
6698 if (window_height_changed_p
)
6700 /* Must update other windows. */
6701 windows_or_buffers_changed
= 1;
6702 redisplay_internal (0);
6704 else if (FRAME_WINDOW_P (f
) && n
== 0)
6706 /* Window configuration is the same as before.
6707 Can do with a display update of the echo area,
6708 unless we displayed some mode lines. */
6709 update_single_window (w
, 1);
6710 rif
->flush_display (f
);
6713 update_frame (f
, 1, 1);
6715 /* If cursor is in the echo area, make sure that the next
6716 redisplay displays the minibuffer, so that the cursor will
6717 be replaced with what the minibuffer wants. */
6718 if (cursor_in_echo_area
)
6719 ++windows_or_buffers_changed
;
6722 else if (!EQ (mini_window
, selected_window
))
6723 windows_or_buffers_changed
++;
6725 /* Last displayed message is now the current message. */
6726 echo_area_buffer
[1] = echo_area_buffer
[0];
6728 /* Prevent redisplay optimization in redisplay_internal by resetting
6729 this_line_start_pos. This is done because the mini-buffer now
6730 displays the message instead of its buffer text. */
6731 if (EQ (mini_window
, selected_window
))
6732 CHARPOS (this_line_start_pos
) = 0;
6734 return window_height_changed_p
;
6739 /***********************************************************************
6741 ***********************************************************************/
6744 #ifdef HAVE_WINDOW_SYSTEM
6746 /* A buffer for constructing frame titles in it; allocated from the
6747 heap in init_xdisp and resized as needed in store_frame_title_char. */
6749 static char *frame_title_buf
;
6751 /* The buffer's end, and a current output position in it. */
6753 static char *frame_title_buf_end
;
6754 static char *frame_title_ptr
;
6757 /* Store a single character C for the frame title in frame_title_buf.
6758 Re-allocate frame_title_buf if necessary. */
6761 store_frame_title_char (c
)
6764 /* If output position has reached the end of the allocated buffer,
6765 double the buffer's size. */
6766 if (frame_title_ptr
== frame_title_buf_end
)
6768 int len
= frame_title_ptr
- frame_title_buf
;
6769 int new_size
= 2 * len
* sizeof *frame_title_buf
;
6770 frame_title_buf
= (char *) xrealloc (frame_title_buf
, new_size
);
6771 frame_title_buf_end
= frame_title_buf
+ new_size
;
6772 frame_title_ptr
= frame_title_buf
+ len
;
6775 *frame_title_ptr
++ = c
;
6779 /* Store part of a frame title in frame_title_buf, beginning at
6780 frame_title_ptr. STR is the string to store. Do not copy more
6781 than PRECISION number of bytes from STR; PRECISION <= 0 means copy
6782 the whole string. Pad with spaces until FIELD_WIDTH number of
6783 characters have been copied; FIELD_WIDTH <= 0 means don't pad.
6784 Called from display_mode_element when it is used to build a frame
6788 store_frame_title (str
, field_width
, precision
)
6790 int field_width
, precision
;
6794 /* Copy at most PRECISION chars from STR. */
6795 while ((precision
<= 0 || n
< precision
)
6798 store_frame_title_char (*str
++);
6802 /* Fill up with spaces until FIELD_WIDTH reached. */
6803 while (field_width
> 0
6806 store_frame_title_char (' ');
6814 /* Set the title of FRAME, if it has changed. The title format is
6815 Vicon_title_format if FRAME is iconified, otherwise it is
6816 frame_title_format. */
6819 x_consider_frame_title (frame
)
6822 struct frame
*f
= XFRAME (frame
);
6824 if (FRAME_WINDOW_P (f
)
6825 || FRAME_MINIBUF_ONLY_P (f
)
6826 || f
->explicit_name
)
6828 /* Do we have more than one visible frame on this X display? */
6831 struct buffer
*obuf
;
6835 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
6837 struct frame
*tf
= XFRAME (XCAR (tail
));
6840 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
6841 && !FRAME_MINIBUF_ONLY_P (tf
)
6842 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
6846 /* Set global variable indicating that multiple frames exist. */
6847 multiple_frames
= CONSP (tail
);
6849 /* Switch to the buffer of selected window of the frame. Set up
6850 frame_title_ptr so that display_mode_element will output into it;
6851 then display the title. */
6852 obuf
= current_buffer
;
6853 Fset_buffer (XWINDOW (f
->selected_window
)->buffer
);
6854 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
6855 frame_title_ptr
= frame_title_buf
;
6856 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
6857 NULL
, DEFAULT_FACE_ID
);
6858 len
= display_mode_element (&it
, 0, -1, -1, fmt
);
6859 frame_title_ptr
= NULL
;
6860 set_buffer_internal (obuf
);
6862 /* Set the title only if it's changed. This avoids consing in
6863 the common case where it hasn't. (If it turns out that we've
6864 already wasted too much time by walking through the list with
6865 display_mode_element, then we might need to optimize at a
6866 higher level than this.) */
6867 if (! STRINGP (f
->name
)
6868 || STRING_BYTES (XSTRING (f
->name
)) != len
6869 || bcmp (frame_title_buf
, XSTRING (f
->name
)->data
, len
) != 0)
6870 x_implicitly_set_name (f
, make_string (frame_title_buf
, len
), Qnil
);
6874 #else /* not HAVE_WINDOW_SYSTEM */
6876 #define frame_title_ptr ((char *)0)
6877 #define store_frame_title(str, mincol, maxcol) 0
6879 #endif /* not HAVE_WINDOW_SYSTEM */
6884 /***********************************************************************
6886 ***********************************************************************/
6889 /* Prepare for redisplay by updating menu-bar item lists when
6890 appropriate. This can call eval. */
6893 prepare_menu_bars ()
6896 struct gcpro gcpro1
, gcpro2
;
6898 Lisp_Object tooltip_frame
;
6900 #ifdef HAVE_X_WINDOWS
6901 tooltip_frame
= tip_frame
;
6903 tooltip_frame
= Qnil
;
6906 /* Update all frame titles based on their buffer names, etc. We do
6907 this before the menu bars so that the buffer-menu will show the
6908 up-to-date frame titles. */
6909 #ifdef HAVE_WINDOW_SYSTEM
6910 if (windows_or_buffers_changed
|| update_mode_lines
)
6912 Lisp_Object tail
, frame
;
6914 FOR_EACH_FRAME (tail
, frame
)
6917 if (!EQ (frame
, tooltip_frame
)
6918 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
6919 x_consider_frame_title (frame
);
6922 #endif /* HAVE_WINDOW_SYSTEM */
6924 /* Update the menu bar item lists, if appropriate. This has to be
6925 done before any actual redisplay or generation of display lines. */
6926 all_windows
= (update_mode_lines
6927 || buffer_shared
> 1
6928 || windows_or_buffers_changed
);
6931 Lisp_Object tail
, frame
;
6932 int count
= BINDING_STACK_SIZE ();
6934 record_unwind_protect (Fset_match_data
, Fmatch_data (Qnil
, Qnil
));
6936 FOR_EACH_FRAME (tail
, frame
)
6940 /* Ignore tooltip frame. */
6941 if (EQ (frame
, tooltip_frame
))
6944 /* If a window on this frame changed size, report that to
6945 the user and clear the size-change flag. */
6946 if (FRAME_WINDOW_SIZES_CHANGED (f
))
6948 Lisp_Object functions
;
6950 /* Clear flag first in case we get an error below. */
6951 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
6952 functions
= Vwindow_size_change_functions
;
6953 GCPRO2 (tail
, functions
);
6955 while (CONSP (functions
))
6957 call1 (XCAR (functions
), frame
);
6958 functions
= XCDR (functions
);
6964 update_menu_bar (f
, 0);
6965 #ifdef HAVE_WINDOW_SYSTEM
6966 update_tool_bar (f
, 0);
6971 unbind_to (count
, Qnil
);
6975 struct frame
*sf
= SELECTED_FRAME ();
6976 update_menu_bar (sf
, 1);
6977 #ifdef HAVE_WINDOW_SYSTEM
6978 update_tool_bar (sf
, 1);
6982 /* Motif needs this. See comment in xmenu.c. Turn it off when
6983 pending_menu_activation is not defined. */
6984 #ifdef USE_X_TOOLKIT
6985 pending_menu_activation
= 0;
6990 /* Update the menu bar item list for frame F. This has to be done
6991 before we start to fill in any display lines, because it can call
6994 If SAVE_MATCH_DATA is non-zero, we must save and restore it here. */
6997 update_menu_bar (f
, save_match_data
)
6999 int save_match_data
;
7002 register struct window
*w
;
7004 window
= FRAME_SELECTED_WINDOW (f
);
7005 w
= XWINDOW (window
);
7007 if (update_mode_lines
)
7008 w
->update_mode_line
= Qt
;
7010 if (FRAME_WINDOW_P (f
)
7012 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (macintosh)
7013 FRAME_EXTERNAL_MENU_BAR (f
)
7015 FRAME_MENU_BAR_LINES (f
) > 0
7017 : FRAME_MENU_BAR_LINES (f
) > 0)
7019 /* If the user has switched buffers or windows, we need to
7020 recompute to reflect the new bindings. But we'll
7021 recompute when update_mode_lines is set too; that means
7022 that people can use force-mode-line-update to request
7023 that the menu bar be recomputed. The adverse effect on
7024 the rest of the redisplay algorithm is about the same as
7025 windows_or_buffers_changed anyway. */
7026 if (windows_or_buffers_changed
7027 || !NILP (w
->update_mode_line
)
7028 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
7029 < BUF_MODIFF (XBUFFER (w
->buffer
)))
7030 != !NILP (w
->last_had_star
))
7031 || ((!NILP (Vtransient_mark_mode
)
7032 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
7033 != !NILP (w
->region_showing
)))
7035 struct buffer
*prev
= current_buffer
;
7036 int count
= BINDING_STACK_SIZE ();
7038 set_buffer_internal_1 (XBUFFER (w
->buffer
));
7039 if (save_match_data
)
7040 record_unwind_protect (Fset_match_data
, Fmatch_data (Qnil
, Qnil
));
7041 if (NILP (Voverriding_local_map_menu_flag
))
7043 specbind (Qoverriding_terminal_local_map
, Qnil
);
7044 specbind (Qoverriding_local_map
, Qnil
);
7047 /* Run the Lucid hook. */
7048 call1 (Vrun_hooks
, Qactivate_menubar_hook
);
7050 /* If it has changed current-menubar from previous value,
7051 really recompute the menu-bar from the value. */
7052 if (! NILP (Vlucid_menu_bar_dirty_flag
))
7053 call0 (Qrecompute_lucid_menubar
);
7055 safe_run_hooks (Qmenu_bar_update_hook
);
7056 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
7058 /* Redisplay the menu bar in case we changed it. */
7059 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (macintosh)
7060 if (FRAME_WINDOW_P (f
)
7061 #if defined (macintosh)
7062 /* All frames on Mac OS share the same menubar. So only the
7063 selected frame should be allowed to set it. */
7064 && f
== SELECTED_FRAME ()
7067 set_frame_menubar (f
, 0, 0);
7069 /* On a terminal screen, the menu bar is an ordinary screen
7070 line, and this makes it get updated. */
7071 w
->update_mode_line
= Qt
;
7072 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI) */
7073 /* In the non-toolkit version, the menu bar is an ordinary screen
7074 line, and this makes it get updated. */
7075 w
->update_mode_line
= Qt
;
7076 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI) */
7078 unbind_to (count
, Qnil
);
7079 set_buffer_internal_1 (prev
);
7086 /***********************************************************************
7088 ***********************************************************************/
7090 #ifdef HAVE_WINDOW_SYSTEM
7092 /* Update the tool-bar item list for frame F. This has to be done
7093 before we start to fill in any display lines. Called from
7094 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
7095 and restore it here. */
7098 update_tool_bar (f
, save_match_data
)
7100 int save_match_data
;
7102 if (WINDOWP (f
->tool_bar_window
)
7103 && XFASTINT (XWINDOW (f
->tool_bar_window
)->height
) > 0)
7108 window
= FRAME_SELECTED_WINDOW (f
);
7109 w
= XWINDOW (window
);
7111 /* If the user has switched buffers or windows, we need to
7112 recompute to reflect the new bindings. But we'll
7113 recompute when update_mode_lines is set too; that means
7114 that people can use force-mode-line-update to request
7115 that the menu bar be recomputed. The adverse effect on
7116 the rest of the redisplay algorithm is about the same as
7117 windows_or_buffers_changed anyway. */
7118 if (windows_or_buffers_changed
7119 || !NILP (w
->update_mode_line
)
7120 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
7121 < BUF_MODIFF (XBUFFER (w
->buffer
)))
7122 != !NILP (w
->last_had_star
))
7123 || ((!NILP (Vtransient_mark_mode
)
7124 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
7125 != !NILP (w
->region_showing
)))
7127 struct buffer
*prev
= current_buffer
;
7128 int count
= BINDING_STACK_SIZE ();
7130 /* Set current_buffer to the buffer of the selected
7131 window of the frame, so that we get the right local
7133 set_buffer_internal_1 (XBUFFER (w
->buffer
));
7135 /* Save match data, if we must. */
7136 if (save_match_data
)
7137 record_unwind_protect (Fset_match_data
, Fmatch_data (Qnil
, Qnil
));
7139 /* Make sure that we don't accidentally use bogus keymaps. */
7140 if (NILP (Voverriding_local_map_menu_flag
))
7142 specbind (Qoverriding_terminal_local_map
, Qnil
);
7143 specbind (Qoverriding_local_map
, Qnil
);
7146 /* Build desired tool-bar items from keymaps. */
7148 = tool_bar_items (f
->tool_bar_items
, &f
->n_tool_bar_items
);
7150 /* Redisplay the tool-bar in case we changed it. */
7151 w
->update_mode_line
= Qt
;
7153 unbind_to (count
, Qnil
);
7154 set_buffer_internal_1 (prev
);
7160 /* Set F->desired_tool_bar_string to a Lisp string representing frame
7161 F's desired tool-bar contents. F->tool_bar_items must have
7162 been set up previously by calling prepare_menu_bars. */
7165 build_desired_tool_bar_string (f
)
7168 int i
, size
, size_needed
, string_idx
;
7169 struct gcpro gcpro1
, gcpro2
, gcpro3
;
7170 Lisp_Object image
, plist
, props
;
7172 image
= plist
= props
= Qnil
;
7173 GCPRO3 (image
, plist
, props
);
7175 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
7176 Otherwise, make a new string. */
7178 /* The size of the string we might be able to reuse. */
7179 size
= (STRINGP (f
->desired_tool_bar_string
)
7180 ? XSTRING (f
->desired_tool_bar_string
)->size
7183 /* Each image in the string we build is preceded by a space,
7184 and there is a space at the end. */
7185 size_needed
= f
->n_tool_bar_items
+ 1;
7187 /* Reuse f->desired_tool_bar_string, if possible. */
7188 if (size
< size_needed
)
7189 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
7193 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
7194 Fremove_text_properties (make_number (0), make_number (size
),
7195 props
, f
->desired_tool_bar_string
);
7198 /* Put a `display' property on the string for the images to display,
7199 put a `menu_item' property on tool-bar items with a value that
7200 is the index of the item in F's tool-bar item vector. */
7201 for (i
= 0, string_idx
= 0;
7202 i
< f
->n_tool_bar_items
;
7203 ++i
, string_idx
+= 1)
7205 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
7207 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
7208 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
7209 int margin
, relief
, idx
;
7210 extern Lisp_Object QCrelief
, QCmargin
, QCalgorithm
, Qimage
;
7211 extern Lisp_Object Qlaplace
;
7213 /* If image is a vector, choose the image according to the
7215 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
7216 if (VECTORP (image
))
7220 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
7221 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
7224 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
7225 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
7227 xassert (ASIZE (image
) >= idx
);
7228 image
= AREF (image
, idx
);
7233 /* Ignore invalid image specifications. */
7234 if (!valid_image_p (image
))
7237 /* Display the tool-bar button pressed, or depressed. */
7238 plist
= Fcopy_sequence (XCDR (image
));
7240 /* Compute margin and relief to draw. */
7241 relief
= tool_bar_button_relief
> 0 ? tool_bar_button_relief
: 3;
7242 margin
= relief
+ max (0, tool_bar_button_margin
);
7244 if (auto_raise_tool_bar_buttons_p
)
7246 /* Add a `:relief' property to the image spec if the item is
7250 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
7256 /* If image is selected, display it pressed, i.e. with a
7257 negative relief. If it's not selected, display it with a
7259 plist
= Fplist_put (plist
, QCrelief
,
7261 ? make_number (-relief
)
7262 : make_number (relief
)));
7266 /* Put a margin around the image. */
7268 plist
= Fplist_put (plist
, QCmargin
, make_number (margin
));
7270 /* If button is not enabled, and we don't have special images
7271 for the disabled state, make the image appear disabled by
7272 applying an appropriate algorithm to it. */
7273 if (!enabled_p
&& idx
< 0)
7274 plist
= Fplist_put (plist
, QCalgorithm
, Qdisabled
);
7276 /* Put a `display' text property on the string for the image to
7277 display. Put a `menu-item' property on the string that gives
7278 the start of this item's properties in the tool-bar items
7280 image
= Fcons (Qimage
, plist
);
7281 props
= list4 (Qdisplay
, image
,
7282 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
)),
7283 Fadd_text_properties (make_number (string_idx
),
7284 make_number (string_idx
+ 1),
7285 props
, f
->desired_tool_bar_string
);
7293 /* Display one line of the tool-bar of frame IT->f. */
7296 display_tool_bar_line (it
)
7299 struct glyph_row
*row
= it
->glyph_row
;
7300 int max_x
= it
->last_visible_x
;
7303 prepare_desired_row (row
);
7304 row
->y
= it
->current_y
;
7306 /* Note that this isn't made use of if the face hasn't a box,
7307 so there's no need to check the face here. */
7308 it
->start_of_box_run_p
= 1;
7310 while (it
->current_x
< max_x
)
7312 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
7314 /* Get the next display element. */
7315 if (!get_next_display_element (it
))
7318 /* Produce glyphs. */
7319 x_before
= it
->current_x
;
7320 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
7321 PRODUCE_GLYPHS (it
);
7323 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
7328 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
7330 if (x
+ glyph
->pixel_width
> max_x
)
7332 /* Glyph doesn't fit on line. */
7333 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
7339 x
+= glyph
->pixel_width
;
7343 /* Stop at line ends. */
7344 if (ITERATOR_AT_END_OF_LINE_P (it
))
7347 set_iterator_to_next (it
, 1);
7352 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
7353 extend_face_to_end_of_line (it
);
7354 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
7355 last
->right_box_line_p
= 1;
7356 if (last
== row
->glyphs
[TEXT_AREA
])
7357 last
->left_box_line_p
= 1;
7358 compute_line_metrics (it
);
7360 /* If line is empty, make it occupy the rest of the tool-bar. */
7361 if (!row
->displays_text_p
)
7363 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
7364 row
->ascent
= row
->phys_ascent
= 0;
7367 row
->full_width_p
= 1;
7368 row
->continued_p
= 0;
7369 row
->truncated_on_left_p
= 0;
7370 row
->truncated_on_right_p
= 0;
7372 it
->current_x
= it
->hpos
= 0;
7373 it
->current_y
+= row
->height
;
7379 /* Value is the number of screen lines needed to make all tool-bar
7380 items of frame F visible. */
7383 tool_bar_lines_needed (f
)
7386 struct window
*w
= XWINDOW (f
->tool_bar_window
);
7389 /* Initialize an iterator for iteration over
7390 F->desired_tool_bar_string in the tool-bar window of frame F. */
7391 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
7392 it
.first_visible_x
= 0;
7393 it
.last_visible_x
= FRAME_WINDOW_WIDTH (f
) * CANON_X_UNIT (f
);
7394 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
7396 while (!ITERATOR_AT_END_P (&it
))
7398 it
.glyph_row
= w
->desired_matrix
->rows
;
7399 clear_glyph_row (it
.glyph_row
);
7400 display_tool_bar_line (&it
);
7403 return (it
.current_y
+ CANON_Y_UNIT (f
) - 1) / CANON_Y_UNIT (f
);
7407 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
7408 height should be changed. */
7411 redisplay_tool_bar (f
)
7416 struct glyph_row
*row
;
7417 int change_height_p
= 0;
7419 /* If frame hasn't a tool-bar window or if it is zero-height, don't
7420 do anything. This means you must start with tool-bar-lines
7421 non-zero to get the auto-sizing effect. Or in other words, you
7422 can turn off tool-bars by specifying tool-bar-lines zero. */
7423 if (!WINDOWP (f
->tool_bar_window
)
7424 || (w
= XWINDOW (f
->tool_bar_window
),
7425 XFASTINT (w
->height
) == 0))
7428 /* Set up an iterator for the tool-bar window. */
7429 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
7430 it
.first_visible_x
= 0;
7431 it
.last_visible_x
= FRAME_WINDOW_WIDTH (f
) * CANON_X_UNIT (f
);
7434 /* Build a string that represents the contents of the tool-bar. */
7435 build_desired_tool_bar_string (f
);
7436 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
7438 /* Display as many lines as needed to display all tool-bar items. */
7439 while (it
.current_y
< it
.last_visible_y
)
7440 display_tool_bar_line (&it
);
7442 /* It doesn't make much sense to try scrolling in the tool-bar
7443 window, so don't do it. */
7444 w
->desired_matrix
->no_scrolling_p
= 1;
7445 w
->must_be_updated_p
= 1;
7447 if (auto_resize_tool_bars_p
)
7451 /* If there are blank lines at the end, except for a partially
7452 visible blank line at the end that is smaller than
7453 CANON_Y_UNIT, change the tool-bar's height. */
7454 row
= it
.glyph_row
- 1;
7455 if (!row
->displays_text_p
7456 && row
->height
>= CANON_Y_UNIT (f
))
7457 change_height_p
= 1;
7459 /* If row displays tool-bar items, but is partially visible,
7460 change the tool-bar's height. */
7461 if (row
->displays_text_p
7462 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
)
7463 change_height_p
= 1;
7465 /* Resize windows as needed by changing the `tool-bar-lines'
7468 && (nlines
= tool_bar_lines_needed (f
),
7469 nlines
!= XFASTINT (w
->height
)))
7471 extern Lisp_Object Qtool_bar_lines
;
7473 int old_height
= XFASTINT (w
->height
);
7475 XSETFRAME (frame
, f
);
7476 clear_glyph_matrix (w
->desired_matrix
);
7477 Fmodify_frame_parameters (frame
,
7478 Fcons (Fcons (Qtool_bar_lines
,
7479 make_number (nlines
)),
7481 if (XFASTINT (w
->height
) != old_height
)
7482 fonts_changed_p
= 1;
7486 return change_height_p
;
7490 /* Get information about the tool-bar item which is displayed in GLYPH
7491 on frame F. Return in *PROP_IDX the index where tool-bar item
7492 properties start in F->tool_bar_items. Value is zero if
7493 GLYPH doesn't display a tool-bar item. */
7496 tool_bar_item_info (f
, glyph
, prop_idx
)
7498 struct glyph
*glyph
;
7504 /* Get the text property `menu-item' at pos. The value of that
7505 property is the start index of this item's properties in
7506 F->tool_bar_items. */
7507 prop
= Fget_text_property (make_number (glyph
->charpos
),
7508 Qmenu_item
, f
->current_tool_bar_string
);
7509 if (INTEGERP (prop
))
7511 *prop_idx
= XINT (prop
);
7520 #endif /* HAVE_WINDOW_SYSTEM */
7524 /************************************************************************
7525 Horizontal scrolling
7526 ************************************************************************/
7528 static int hscroll_window_tree
P_ ((Lisp_Object
));
7529 static int hscroll_windows
P_ ((Lisp_Object
));
7531 /* For all leaf windows in the window tree rooted at WINDOW, set their
7532 hscroll value so that PT is (i) visible in the window, and (ii) so
7533 that it is not within a certain margin at the window's left and
7534 right border. Value is non-zero if any window's hscroll has been
7538 hscroll_window_tree (window
)
7541 int hscrolled_p
= 0;
7543 while (WINDOWP (window
))
7545 struct window
*w
= XWINDOW (window
);
7547 if (WINDOWP (w
->hchild
))
7548 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
7549 else if (WINDOWP (w
->vchild
))
7550 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
7551 else if (w
->cursor
.vpos
>= 0)
7553 int hscroll_margin
, text_area_x
, text_area_y
;
7554 int text_area_width
, text_area_height
;
7555 struct glyph_row
*current_cursor_row
7556 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
7557 struct glyph_row
*desired_cursor_row
7558 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
7559 struct glyph_row
*cursor_row
7560 = (desired_cursor_row
->enabled_p
7561 ? desired_cursor_row
7562 : current_cursor_row
);
7564 window_box (w
, TEXT_AREA
, &text_area_x
, &text_area_y
,
7565 &text_area_width
, &text_area_height
);
7567 /* Scroll when cursor is inside this scroll margin. */
7568 hscroll_margin
= 5 * CANON_X_UNIT (XFRAME (w
->frame
));
7570 if ((XFASTINT (w
->hscroll
)
7571 && w
->cursor
.x
< hscroll_margin
)
7572 || (cursor_row
->enabled_p
7573 && cursor_row
->truncated_on_right_p
7574 && (w
->cursor
.x
> text_area_width
- hscroll_margin
)))
7578 struct buffer
*saved_current_buffer
;
7581 /* Find point in a display of infinite width. */
7582 saved_current_buffer
= current_buffer
;
7583 current_buffer
= XBUFFER (w
->buffer
);
7585 if (w
== XWINDOW (selected_window
))
7586 pt
= BUF_PT (current_buffer
);
7589 pt
= marker_position (w
->pointm
);
7590 pt
= max (BEGV
, pt
);
7594 /* Move iterator to pt starting at cursor_row->start in
7595 a line with infinite width. */
7596 init_to_row_start (&it
, w
, cursor_row
);
7597 it
.last_visible_x
= INFINITY
;
7598 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
7599 current_buffer
= saved_current_buffer
;
7601 /* Center cursor in window. */
7602 hscroll
= (max (0, it
.current_x
- text_area_width
/ 2)
7603 / CANON_X_UNIT (it
.f
));
7604 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
7606 /* Don't call Fset_window_hscroll if value hasn't
7607 changed because it will prevent redisplay
7609 if (XFASTINT (w
->hscroll
) != hscroll
)
7611 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
7612 w
->hscroll
= make_number (hscroll
);
7621 /* Value is non-zero if hscroll of any leaf window has been changed. */
7626 /* Set hscroll so that cursor is visible and not inside horizontal
7627 scroll margins for all windows in the tree rooted at WINDOW. See
7628 also hscroll_window_tree above. Value is non-zero if any window's
7629 hscroll has been changed. If it has, desired matrices on the frame
7630 of WINDOW are cleared. */
7633 hscroll_windows (window
)
7638 if (automatic_hscrolling_p
)
7640 hscrolled_p
= hscroll_window_tree (window
);
7642 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
7651 /************************************************************************
7653 ************************************************************************/
7655 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
7656 to a non-zero value. This is sometimes handy to have in a debugger
7661 /* First and last unchanged row for try_window_id. */
7663 int debug_first_unchanged_at_end_vpos
;
7664 int debug_last_unchanged_at_beg_vpos
;
7666 /* Delta vpos and y. */
7668 int debug_dvpos
, debug_dy
;
7670 /* Delta in characters and bytes for try_window_id. */
7672 int debug_delta
, debug_delta_bytes
;
7674 /* Values of window_end_pos and window_end_vpos at the end of
7677 int debug_end_pos
, debug_end_vpos
;
7679 /* Append a string to W->desired_matrix->method. FMT is a printf
7680 format string. A1...A9 are a supplement for a variable-length
7681 argument list. If trace_redisplay_p is non-zero also printf the
7682 resulting string to stderr. */
7685 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
7688 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
7691 char *method
= w
->desired_matrix
->method
;
7692 int len
= strlen (method
);
7693 int size
= sizeof w
->desired_matrix
->method
;
7694 int remaining
= size
- len
- 1;
7696 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
7697 if (len
&& remaining
)
7703 strncpy (method
+ len
, buffer
, remaining
);
7705 if (trace_redisplay_p
)
7706 fprintf (stderr
, "%p (%s): %s\n",
7708 ((BUFFERP (w
->buffer
)
7709 && STRINGP (XBUFFER (w
->buffer
)->name
))
7710 ? (char *) XSTRING (XBUFFER (w
->buffer
)->name
)->data
7715 #endif /* GLYPH_DEBUG */
7718 /* This counter is used to clear the face cache every once in a while
7719 in redisplay_internal. It is incremented for each redisplay.
7720 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
7723 #define CLEAR_FACE_CACHE_COUNT 10000
7724 static int clear_face_cache_count
;
7726 /* Record the previous terminal frame we displayed. */
7728 static struct frame
*previous_terminal_frame
;
7730 /* Non-zero while redisplay_internal is in progress. */
7735 /* Value is non-zero if all changes in window W, which displays
7736 current_buffer, are in the text between START and END. START is a
7737 buffer position, END is given as a distance from Z. Used in
7738 redisplay_internal for display optimization. */
7741 text_outside_line_unchanged_p (w
, start
, end
)
7745 int unchanged_p
= 1;
7747 /* If text or overlays have changed, see where. */
7748 if (XFASTINT (w
->last_modified
) < MODIFF
7749 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
7751 /* Gap in the line? */
7752 if (GPT
< start
|| Z
- GPT
< end
)
7755 /* Changes start in front of the line, or end after it? */
7757 && (BEG_UNCHANGED
< start
- 1
7758 || END_UNCHANGED
< end
))
7761 /* If selective display, can't optimize if changes start at the
7762 beginning of the line. */
7764 && INTEGERP (current_buffer
->selective_display
)
7765 && XINT (current_buffer
->selective_display
) > 0
7766 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
7774 /* Do a frame update, taking possible shortcuts into account. This is
7775 the main external entry point for redisplay.
7777 If the last redisplay displayed an echo area message and that message
7778 is no longer requested, we clear the echo area or bring back the
7779 mini-buffer if that is in use. */
7784 redisplay_internal (0);
7787 /* Return 1 if point moved out of or into a composition. Otherwise
7788 return 0. PREV_BUF and PREV_PT are the last point buffer and
7789 position. BUF and PT are the current point buffer and position. */
7792 check_point_in_composition (prev_buf
, prev_pt
, buf
, pt
)
7793 struct buffer
*prev_buf
, *buf
;
7800 XSETBUFFER (buffer
, buf
);
7801 /* Check a composition at the last point if point moved within the
7803 if (prev_buf
== buf
)
7806 /* Point didn't move. */
7809 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
7810 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
7811 && COMPOSITION_VALID_P (start
, end
, prop
)
7812 && start
< prev_pt
&& end
> prev_pt
)
7813 /* The last point was within the composition. Return 1 iff
7814 point moved out of the composition. */
7815 return (pt
<= start
|| pt
>= end
);
7818 /* Check a composition at the current point. */
7819 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
7820 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
7821 && COMPOSITION_VALID_P (start
, end
, prop
)
7822 && start
< pt
&& end
> pt
);
7825 /* Reconsider the setting of B->clip_changed which is displayed
7829 reconsider_clip_changes (w
, b
)
7833 if (b
->prevent_redisplay_optimizations_p
)
7834 b
->clip_changed
= 1;
7835 else if (b
->clip_changed
7836 && !NILP (w
->window_end_valid
)
7837 && w
->current_matrix
->buffer
== b
7838 && w
->current_matrix
->zv
== BUF_ZV (b
)
7839 && w
->current_matrix
->begv
== BUF_BEGV (b
))
7840 b
->clip_changed
= 0;
7842 /* If display wasn't paused, and W is not a tool bar window, see if
7843 point has been moved into or out of a composition. In that case,
7844 we set b->clip_changed to 1 to force updating the screen. If
7845 b->clip_changed has already been set to 1, we can skip this
7847 if (!b
->clip_changed
7848 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
7852 if (w
== XWINDOW (selected_window
))
7853 pt
= BUF_PT (current_buffer
);
7855 pt
= marker_position (w
->pointm
);
7857 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
7858 || pt
!= XINT (w
->last_point
))
7859 && check_point_in_composition (w
->current_matrix
->buffer
,
7860 XINT (w
->last_point
),
7861 XBUFFER (w
->buffer
), pt
))
7862 b
->clip_changed
= 1;
7867 /* If PRESERVE_ECHO_AREA is nonzero, it means this redisplay is not in
7868 response to any user action; therefore, we should preserve the echo
7869 area. (Actually, our caller does that job.) Perhaps in the future
7870 avoid recentering windows if it is not necessary; currently that
7871 causes some problems. */
7874 redisplay_internal (preserve_echo_area
)
7875 int preserve_echo_area
;
7877 struct window
*w
= XWINDOW (selected_window
);
7878 struct frame
*f
= XFRAME (w
->frame
);
7880 int must_finish
= 0;
7881 struct text_pos tlbufpos
, tlendpos
;
7882 int number_of_visible_frames
;
7884 struct frame
*sf
= SELECTED_FRAME ();
7886 /* Non-zero means redisplay has to consider all windows on all
7887 frames. Zero means, only selected_window is considered. */
7888 int consider_all_windows_p
;
7890 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
7892 /* No redisplay if running in batch mode or frame is not yet fully
7893 initialized, or redisplay is explicitly turned off by setting
7894 Vinhibit_redisplay. */
7896 || !NILP (Vinhibit_redisplay
)
7897 || !f
->glyphs_initialized_p
)
7900 /* The flag redisplay_performed_directly_p is set by
7901 direct_output_for_insert when it already did the whole screen
7902 update necessary. */
7903 if (redisplay_performed_directly_p
)
7905 redisplay_performed_directly_p
= 0;
7906 if (!hscroll_windows (selected_window
))
7910 #ifdef USE_X_TOOLKIT
7911 if (popup_activated ())
7915 /* I don't think this happens but let's be paranoid. */
7919 /* Record a function that resets redisplaying_p to its old value
7920 when we leave this function. */
7921 count
= BINDING_STACK_SIZE ();
7922 record_unwind_protect (unwind_redisplay
, make_number (redisplaying_p
));
7927 reconsider_clip_changes (w
, current_buffer
);
7929 /* If new fonts have been loaded that make a glyph matrix adjustment
7930 necessary, do it. */
7931 if (fonts_changed_p
)
7933 adjust_glyphs (NULL
);
7934 ++windows_or_buffers_changed
;
7935 fonts_changed_p
= 0;
7938 if (! FRAME_WINDOW_P (sf
)
7939 && previous_terminal_frame
!= sf
)
7941 /* Since frames on an ASCII terminal share the same display
7942 area, displaying a different frame means redisplay the whole
7944 windows_or_buffers_changed
++;
7945 SET_FRAME_GARBAGED (sf
);
7946 XSETFRAME (Vterminal_frame
, sf
);
7948 previous_terminal_frame
= sf
;
7950 /* Set the visible flags for all frames. Do this before checking
7951 for resized or garbaged frames; they want to know if their frames
7952 are visible. See the comment in frame.h for
7953 FRAME_SAMPLE_VISIBILITY. */
7955 Lisp_Object tail
, frame
;
7957 number_of_visible_frames
= 0;
7959 FOR_EACH_FRAME (tail
, frame
)
7961 struct frame
*f
= XFRAME (frame
);
7963 FRAME_SAMPLE_VISIBILITY (f
);
7964 if (FRAME_VISIBLE_P (f
))
7965 ++number_of_visible_frames
;
7966 clear_desired_matrices (f
);
7970 /* Notice any pending interrupt request to change frame size. */
7971 do_pending_window_change (1);
7973 /* Clear frames marked as garbaged. */
7975 clear_garbaged_frames ();
7977 /* Build menubar and tool-bar items. */
7978 prepare_menu_bars ();
7980 if (windows_or_buffers_changed
)
7981 update_mode_lines
++;
7983 /* Detect case that we need to write or remove a star in the mode line. */
7984 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
7986 w
->update_mode_line
= Qt
;
7987 if (buffer_shared
> 1)
7988 update_mode_lines
++;
7991 /* If %c is in the mode line, update it if needed. */
7992 if (!NILP (w
->column_number_displayed
)
7993 /* This alternative quickly identifies a common case
7994 where no change is needed. */
7995 && !(PT
== XFASTINT (w
->last_point
)
7996 && XFASTINT (w
->last_modified
) >= MODIFF
7997 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
7998 && XFASTINT (w
->column_number_displayed
) != current_column ())
7999 w
->update_mode_line
= Qt
;
8001 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
8003 /* The variable buffer_shared is set in redisplay_window and
8004 indicates that we redisplay a buffer in different windows. See
8006 consider_all_windows_p
= update_mode_lines
|| buffer_shared
> 1;
8008 /* If specs for an arrow have changed, do thorough redisplay
8009 to ensure we remove any arrow that should no longer exist. */
8010 if (! EQ (COERCE_MARKER (Voverlay_arrow_position
), last_arrow_position
)
8011 || ! EQ (Voverlay_arrow_string
, last_arrow_string
))
8012 consider_all_windows_p
= windows_or_buffers_changed
= 1;
8014 /* Normally the message* functions will have already displayed and
8015 updated the echo area, but the frame may have been trashed, or
8016 the update may have been preempted, so display the echo area
8017 again here. Checking both message buffers captures the case that
8018 the echo area should be cleared. */
8019 if (!NILP (echo_area_buffer
[0]) || !NILP (echo_area_buffer
[1]))
8021 int window_height_changed_p
= echo_area_display (0);
8024 if (fonts_changed_p
)
8026 else if (window_height_changed_p
)
8028 consider_all_windows_p
= 1;
8029 ++update_mode_lines
;
8030 ++windows_or_buffers_changed
;
8032 /* If window configuration was changed, frames may have been
8033 marked garbaged. Clear them or we will experience
8034 surprises wrt scrolling. */
8036 clear_garbaged_frames ();
8039 else if (EQ (selected_window
, minibuf_window
)
8040 && (current_buffer
->clip_changed
8041 || XFASTINT (w
->last_modified
) < MODIFF
8042 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
8043 && resize_mini_window (w
, 0))
8045 /* Resized active mini-window to fit the size of what it is
8046 showing if its contents might have changed. */
8048 consider_all_windows_p
= 1;
8049 ++windows_or_buffers_changed
;
8050 ++update_mode_lines
;
8052 /* If window configuration was changed, frames may have been
8053 marked garbaged. Clear them or we will experience
8054 surprises wrt scrolling. */
8056 clear_garbaged_frames ();
8060 /* If showing the region, and mark has changed, we must redisplay
8061 the whole window. The assignment to this_line_start_pos prevents
8062 the optimization directly below this if-statement. */
8063 if (((!NILP (Vtransient_mark_mode
)
8064 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
8065 != !NILP (w
->region_showing
))
8066 || (!NILP (w
->region_showing
)
8067 && !EQ (w
->region_showing
,
8068 Fmarker_position (XBUFFER (w
->buffer
)->mark
))))
8069 CHARPOS (this_line_start_pos
) = 0;
8071 /* Optimize the case that only the line containing the cursor in the
8072 selected window has changed. Variables starting with this_ are
8073 set in display_line and record information about the line
8074 containing the cursor. */
8075 tlbufpos
= this_line_start_pos
;
8076 tlendpos
= this_line_end_pos
;
8077 if (!consider_all_windows_p
8078 && CHARPOS (tlbufpos
) > 0
8079 && NILP (w
->update_mode_line
)
8080 && !current_buffer
->clip_changed
8081 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
8082 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
8083 /* Make sure recorded data applies to current buffer, etc. */
8084 && this_line_buffer
== current_buffer
8085 && current_buffer
== XBUFFER (w
->buffer
)
8086 && NILP (w
->force_start
)
8087 /* Point must be on the line that we have info recorded about. */
8088 && PT
>= CHARPOS (tlbufpos
)
8089 && PT
<= Z
- CHARPOS (tlendpos
)
8090 /* All text outside that line, including its final newline,
8091 must be unchanged */
8092 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
8093 CHARPOS (tlendpos
)))
8095 if (CHARPOS (tlbufpos
) > BEGV
8096 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
8097 && (CHARPOS (tlbufpos
) == ZV
8098 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
8099 /* Former continuation line has disappeared by becoming empty */
8101 else if (XFASTINT (w
->last_modified
) < MODIFF
8102 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
8103 || MINI_WINDOW_P (w
))
8105 /* We have to handle the case of continuation around a
8106 wide-column character (See the comment in indent.c around
8109 For instance, in the following case:
8111 -------- Insert --------
8112 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
8113 J_I_ ==> J_I_ `^^' are cursors.
8117 As we have to redraw the line above, we should goto cancel. */
8120 int line_height_before
= this_line_pixel_height
;
8122 /* Note that start_display will handle the case that the
8123 line starting at tlbufpos is a continuation lines. */
8124 start_display (&it
, w
, tlbufpos
);
8126 /* Implementation note: It this still necessary? */
8127 if (it
.current_x
!= this_line_start_x
)
8130 TRACE ((stderr
, "trying display optimization 1\n"));
8131 w
->cursor
.vpos
= -1;
8132 overlay_arrow_seen
= 0;
8133 it
.vpos
= this_line_vpos
;
8134 it
.current_y
= this_line_y
;
8135 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
8138 /* If line contains point, is not continued,
8139 and ends at same distance from eob as before, we win */
8140 if (w
->cursor
.vpos
>= 0
8141 /* Line is not continued, otherwise this_line_start_pos
8142 would have been set to 0 in display_line. */
8143 && CHARPOS (this_line_start_pos
)
8144 /* Line ends as before. */
8145 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
8146 /* Line has same height as before. Otherwise other lines
8147 would have to be shifted up or down. */
8148 && this_line_pixel_height
== line_height_before
)
8150 /* If this is not the window's last line, we must adjust
8151 the charstarts of the lines below. */
8152 if (it
.current_y
< it
.last_visible_y
)
8154 struct glyph_row
*row
8155 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
8156 int delta
, delta_bytes
;
8158 if (Z
- CHARPOS (tlendpos
) == ZV
)
8160 /* This line ends at end of (accessible part of)
8161 buffer. There is no newline to count. */
8163 - CHARPOS (tlendpos
)
8164 - MATRIX_ROW_START_CHARPOS (row
));
8165 delta_bytes
= (Z_BYTE
8166 - BYTEPOS (tlendpos
)
8167 - MATRIX_ROW_START_BYTEPOS (row
));
8171 /* This line ends in a newline. Must take
8172 account of the newline and the rest of the
8173 text that follows. */
8175 - CHARPOS (tlendpos
)
8176 - MATRIX_ROW_START_CHARPOS (row
));
8177 delta_bytes
= (Z_BYTE
8178 - BYTEPOS (tlendpos
)
8179 - MATRIX_ROW_START_BYTEPOS (row
));
8182 increment_matrix_positions (w
->current_matrix
,
8184 w
->current_matrix
->nrows
,
8185 delta
, delta_bytes
);
8188 /* If this row displays text now but previously didn't,
8189 or vice versa, w->window_end_vpos may have to be
8191 if ((it
.glyph_row
- 1)->displays_text_p
)
8193 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
8194 XSETINT (w
->window_end_vpos
, this_line_vpos
);
8196 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
8197 && this_line_vpos
> 0)
8198 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
8199 w
->window_end_valid
= Qnil
;
8201 /* Update hint: No need to try to scroll in update_window. */
8202 w
->desired_matrix
->no_scrolling_p
= 1;
8205 *w
->desired_matrix
->method
= 0;
8206 debug_method_add (w
, "optimization 1");
8213 else if (/* Cursor position hasn't changed. */
8214 PT
== XFASTINT (w
->last_point
)
8215 /* Make sure the cursor was last displayed
8216 in this window. Otherwise we have to reposition it. */
8217 && 0 <= w
->cursor
.vpos
8218 && XINT (w
->height
) > w
->cursor
.vpos
)
8222 do_pending_window_change (1);
8224 /* We used to always goto end_of_redisplay here, but this
8225 isn't enough if we have a blinking cursor. */
8226 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
8227 goto end_of_redisplay
;
8231 /* If highlighting the region, or if the cursor is in the echo area,
8232 then we can't just move the cursor. */
8233 else if (! (!NILP (Vtransient_mark_mode
)
8234 && !NILP (current_buffer
->mark_active
))
8235 && (EQ (selected_window
, current_buffer
->last_selected_window
)
8236 || highlight_nonselected_windows
)
8237 && NILP (w
->region_showing
)
8238 && NILP (Vshow_trailing_whitespace
)
8239 && !cursor_in_echo_area
)
8242 struct glyph_row
*row
;
8244 /* Skip from tlbufpos to PT and see where it is. Note that
8245 PT may be in invisible text. If so, we will end at the
8246 next visible position. */
8247 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
8248 NULL
, DEFAULT_FACE_ID
);
8249 it
.current_x
= this_line_start_x
;
8250 it
.current_y
= this_line_y
;
8251 it
.vpos
= this_line_vpos
;
8253 /* The call to move_it_to stops in front of PT, but
8254 moves over before-strings. */
8255 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
8257 if (it
.vpos
== this_line_vpos
8258 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
8261 xassert (this_line_vpos
== it
.vpos
);
8262 xassert (this_line_y
== it
.current_y
);
8263 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
8271 /* Text changed drastically or point moved off of line. */
8272 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
8275 CHARPOS (this_line_start_pos
) = 0;
8276 consider_all_windows_p
|= buffer_shared
> 1;
8277 ++clear_face_cache_count
;
8280 /* Build desired matrices, and update the display. If
8281 consider_all_windows_p is non-zero, do it for all windows on all
8282 frames. Otherwise do it for selected_window, only. */
8284 if (consider_all_windows_p
)
8286 Lisp_Object tail
, frame
;
8288 /* Clear the face cache eventually. */
8289 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
8291 clear_face_cache (0);
8292 clear_face_cache_count
= 0;
8295 /* Recompute # windows showing selected buffer. This will be
8296 incremented each time such a window is displayed. */
8299 FOR_EACH_FRAME (tail
, frame
)
8301 struct frame
*f
= XFRAME (frame
);
8303 if (FRAME_WINDOW_P (f
) || f
== sf
)
8305 /* Mark all the scroll bars to be removed; we'll redeem
8306 the ones we want when we redisplay their windows. */
8307 if (condemn_scroll_bars_hook
)
8308 (*condemn_scroll_bars_hook
) (f
);
8310 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
8311 redisplay_windows (FRAME_ROOT_WINDOW (f
));
8313 /* Any scroll bars which redisplay_windows should have
8314 nuked should now go away. */
8315 if (judge_scroll_bars_hook
)
8316 (*judge_scroll_bars_hook
) (f
);
8318 /* If fonts changed, display again. */
8319 if (fonts_changed_p
)
8322 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
8324 /* See if we have to hscroll. */
8325 if (hscroll_windows (f
->root_window
))
8328 /* Prevent various kinds of signals during display
8329 update. stdio is not robust about handling
8330 signals, which can cause an apparent I/O
8332 if (interrupt_input
)
8336 /* Update the display. */
8337 set_window_update_flags (XWINDOW (f
->root_window
), 1);
8338 pause
|= update_frame (f
, 0, 0);
8342 mark_window_display_accurate (f
->root_window
, 1);
8343 if (frame_up_to_date_hook
)
8344 frame_up_to_date_hook (f
);
8349 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
8351 Lisp_Object mini_window
;
8352 struct frame
*mini_frame
;
8354 redisplay_window (selected_window
, 1);
8356 /* Compare desired and current matrices, perform output. */
8359 /* If fonts changed, display again. */
8360 if (fonts_changed_p
)
8363 /* Prevent various kinds of signals during display update.
8364 stdio is not robust about handling signals,
8365 which can cause an apparent I/O error. */
8366 if (interrupt_input
)
8370 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
8372 if (hscroll_windows (selected_window
))
8375 XWINDOW (selected_window
)->must_be_updated_p
= 1;
8376 pause
= update_frame (sf
, 0, 0);
8379 /* We may have called echo_area_display at the top of this
8380 function. If the echo area is on another frame, that may
8381 have put text on a frame other than the selected one, so the
8382 above call to update_frame would not have caught it. Catch
8384 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8385 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8387 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
8389 XWINDOW (mini_window
)->must_be_updated_p
= 1;
8390 pause
|= update_frame (mini_frame
, 0, 0);
8391 if (!pause
&& hscroll_windows (mini_window
))
8396 /* If display was paused because of pending input, make sure we do a
8397 thorough update the next time. */
8400 /* Prevent the optimization at the beginning of
8401 redisplay_internal that tries a single-line update of the
8402 line containing the cursor in the selected window. */
8403 CHARPOS (this_line_start_pos
) = 0;
8405 /* Let the overlay arrow be updated the next time. */
8406 if (!NILP (last_arrow_position
))
8408 last_arrow_position
= Qt
;
8409 last_arrow_string
= Qt
;
8412 /* If we pause after scrolling, some rows in the current
8413 matrices of some windows are not valid. */
8414 if (!WINDOW_FULL_WIDTH_P (w
)
8415 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
8416 update_mode_lines
= 1;
8419 /* Now text on frame agrees with windows, so put info into the
8420 windows for partial redisplay to follow. */
8423 register struct buffer
*b
= XBUFFER (w
->buffer
);
8425 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
8426 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
8427 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
8428 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
8430 if (consider_all_windows_p
)
8431 mark_window_display_accurate (FRAME_ROOT_WINDOW (sf
), 1);
8434 XSETFASTINT (w
->last_point
, BUF_PT (b
));
8435 w
->last_cursor
= w
->cursor
;
8436 w
->last_cursor_off_p
= w
->cursor_off_p
;
8438 b
->clip_changed
= 0;
8439 b
->prevent_redisplay_optimizations_p
= 0;
8440 w
->update_mode_line
= Qnil
;
8441 XSETFASTINT (w
->last_modified
, BUF_MODIFF (b
));
8442 XSETFASTINT (w
->last_overlay_modified
, BUF_OVERLAY_MODIFF (b
));
8444 = (BUF_MODIFF (XBUFFER (w
->buffer
)) > BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
8447 /* Record if we are showing a region, so can make sure to
8448 update it fully at next redisplay. */
8449 w
->region_showing
= (!NILP (Vtransient_mark_mode
)
8450 && (EQ (selected_window
,
8451 current_buffer
->last_selected_window
)
8452 || highlight_nonselected_windows
)
8453 && !NILP (XBUFFER (w
->buffer
)->mark_active
)
8454 ? Fmarker_position (XBUFFER (w
->buffer
)->mark
)
8457 w
->window_end_valid
= w
->buffer
;
8458 last_arrow_position
= COERCE_MARKER (Voverlay_arrow_position
);
8459 last_arrow_string
= Voverlay_arrow_string
;
8460 if (frame_up_to_date_hook
!= 0)
8461 (*frame_up_to_date_hook
) (sf
);
8463 w
->current_matrix
->buffer
= b
;
8464 w
->current_matrix
->begv
= BUF_BEGV (b
);
8465 w
->current_matrix
->zv
= BUF_ZV (b
);
8468 update_mode_lines
= 0;
8469 windows_or_buffers_changed
= 0;
8472 /* Start SIGIO interrupts coming again. Having them off during the
8473 code above makes it less likely one will discard output, but not
8474 impossible, since there might be stuff in the system buffer here.
8475 But it is much hairier to try to do anything about that. */
8476 if (interrupt_input
)
8480 /* If a frame has become visible which was not before, redisplay
8481 again, so that we display it. Expose events for such a frame
8482 (which it gets when becoming visible) don't call the parts of
8483 redisplay constructing glyphs, so simply exposing a frame won't
8484 display anything in this case. So, we have to display these
8485 frames here explicitly. */
8488 Lisp_Object tail
, frame
;
8491 FOR_EACH_FRAME (tail
, frame
)
8493 int this_is_visible
= 0;
8495 if (XFRAME (frame
)->visible
)
8496 this_is_visible
= 1;
8497 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
8498 if (XFRAME (frame
)->visible
)
8499 this_is_visible
= 1;
8501 if (this_is_visible
)
8505 if (new_count
!= number_of_visible_frames
)
8506 windows_or_buffers_changed
++;
8509 /* Change frame size now if a change is pending. */
8510 do_pending_window_change (1);
8512 /* If we just did a pending size change, or have additional
8513 visible frames, redisplay again. */
8514 if (windows_or_buffers_changed
&& !pause
)
8519 unbind_to (count
, Qnil
);
8523 /* Redisplay, but leave alone any recent echo area message unless
8524 another message has been requested in its place.
8526 This is useful in situations where you need to redisplay but no
8527 user action has occurred, making it inappropriate for the message
8528 area to be cleared. See tracking_off and
8529 wait_reading_process_input for examples of these situations. */
8532 redisplay_preserve_echo_area ()
8534 if (!NILP (echo_area_buffer
[1]))
8536 /* We have a previously displayed message, but no current
8537 message. Redisplay the previous message. */
8538 display_last_displayed_message_p
= 1;
8539 redisplay_internal (1);
8540 display_last_displayed_message_p
= 0;
8543 redisplay_internal (1);
8547 /* Function registered with record_unwind_protect in
8548 redisplay_internal. Clears the flag indicating that a redisplay is
8552 unwind_redisplay (old_redisplaying_p
)
8553 Lisp_Object old_redisplaying_p
;
8555 redisplaying_p
= XFASTINT (old_redisplaying_p
);
8560 /* Mark the display of windows in the window tree rooted at WINDOW as
8561 accurate or inaccurate. If FLAG is non-zero mark display of WINDOW
8562 as accurate. If FLAG is zero arrange for WINDOW to be redisplayed
8563 the next time redisplay_internal is called. */
8566 mark_window_display_accurate (window
, accurate_p
)
8572 for (; !NILP (window
); window
= w
->next
)
8574 w
= XWINDOW (window
);
8576 if (BUFFERP (w
->buffer
))
8578 struct buffer
*b
= XBUFFER (w
->buffer
);
8580 XSETFASTINT (w
->last_modified
,
8581 accurate_p
? BUF_MODIFF (b
) : 0);
8582 XSETFASTINT (w
->last_overlay_modified
,
8583 accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
8584 w
->last_had_star
= (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
)
8587 #if 0 /* I don't think this is necessary because display_line does it.
8589 /* Record if we are showing a region, so can make sure to
8590 update it fully at next redisplay. */
8592 = (!NILP (Vtransient_mark_mode
)
8593 && (w
== XWINDOW (current_buffer
->last_selected_window
)
8594 || highlight_nonselected_windows
)
8595 && (!NILP (b
->mark_active
)
8596 ? Fmarker_position (b
->mark
)
8602 b
->clip_changed
= 0;
8603 b
->prevent_redisplay_optimizations_p
= 0;
8604 w
->current_matrix
->buffer
= b
;
8605 w
->current_matrix
->begv
= BUF_BEGV (b
);
8606 w
->current_matrix
->zv
= BUF_ZV (b
);
8607 w
->last_cursor
= w
->cursor
;
8608 w
->last_cursor_off_p
= w
->cursor_off_p
;
8609 if (w
== XWINDOW (selected_window
))
8610 w
->last_point
= make_number (BUF_PT (b
));
8612 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
8616 w
->window_end_valid
= w
->buffer
;
8617 w
->update_mode_line
= Qnil
;
8619 if (!NILP (w
->vchild
))
8620 mark_window_display_accurate (w
->vchild
, accurate_p
);
8621 if (!NILP (w
->hchild
))
8622 mark_window_display_accurate (w
->hchild
, accurate_p
);
8627 last_arrow_position
= COERCE_MARKER (Voverlay_arrow_position
);
8628 last_arrow_string
= Voverlay_arrow_string
;
8632 /* Force a thorough redisplay the next time by setting
8633 last_arrow_position and last_arrow_string to t, which is
8634 unequal to any useful value of Voverlay_arrow_... */
8635 last_arrow_position
= Qt
;
8636 last_arrow_string
= Qt
;
8641 /* Return value in display table DP (Lisp_Char_Table *) for character
8642 C. Since a display table doesn't have any parent, we don't have to
8643 follow parent. Do not call this function directly but use the
8644 macro DISP_CHAR_VECTOR. */
8647 disp_char_vector (dp
, c
)
8648 struct Lisp_Char_Table
*dp
;
8654 if (SINGLE_BYTE_CHAR_P (c
))
8655 return (dp
->contents
[c
]);
8657 SPLIT_CHAR (c
, code
[0], code
[1], code
[2]);
8660 else if (code
[2] < 32)
8663 /* Here, the possible range of code[0] (== charset ID) is
8664 128..max_charset. Since the top level char table contains data
8665 for multibyte characters after 256th element, we must increment
8666 code[0] by 128 to get a correct index. */
8668 code
[3] = -1; /* anchor */
8670 for (i
= 0; code
[i
] >= 0; i
++, dp
= XCHAR_TABLE (val
))
8672 val
= dp
->contents
[code
[i
]];
8673 if (!SUB_CHAR_TABLE_P (val
))
8674 return (NILP (val
) ? dp
->defalt
: val
);
8677 /* Here, val is a sub char table. We return the default value of
8679 return (dp
->defalt
);
8684 /***********************************************************************
8686 ***********************************************************************/
8688 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
8691 redisplay_windows (window
)
8694 while (!NILP (window
))
8696 struct window
*w
= XWINDOW (window
);
8698 if (!NILP (w
->hchild
))
8699 redisplay_windows (w
->hchild
);
8700 else if (!NILP (w
->vchild
))
8701 redisplay_windows (w
->vchild
);
8703 redisplay_window (window
, 0);
8710 /* Set cursor position of W. PT is assumed to be displayed in ROW.
8711 DELTA is the number of bytes by which positions recorded in ROW
8712 differ from current buffer positions. */
8715 set_cursor_from_row (w
, row
, matrix
, delta
, delta_bytes
, dy
, dvpos
)
8717 struct glyph_row
*row
;
8718 struct glyph_matrix
*matrix
;
8719 int delta
, delta_bytes
, dy
, dvpos
;
8721 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
8722 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
8724 int pt_old
= PT
- delta
;
8726 /* Skip over glyphs not having an object at the start of the row.
8727 These are special glyphs like truncation marks on terminal
8729 if (row
->displays_text_p
)
8731 && INTEGERP (glyph
->object
)
8732 && glyph
->charpos
< 0)
8734 x
+= glyph
->pixel_width
;
8739 && !INTEGERP (glyph
->object
)
8740 && (!BUFFERP (glyph
->object
)
8741 || glyph
->charpos
< pt_old
))
8743 x
+= glyph
->pixel_width
;
8747 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
8749 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
8750 w
->cursor
.y
= row
->y
+ dy
;
8752 if (w
== XWINDOW (selected_window
))
8754 if (!row
->continued_p
8755 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
8758 this_line_buffer
= XBUFFER (w
->buffer
);
8760 CHARPOS (this_line_start_pos
)
8761 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
8762 BYTEPOS (this_line_start_pos
)
8763 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
8765 CHARPOS (this_line_end_pos
)
8766 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
8767 BYTEPOS (this_line_end_pos
)
8768 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
8770 this_line_y
= w
->cursor
.y
;
8771 this_line_pixel_height
= row
->height
;
8772 this_line_vpos
= w
->cursor
.vpos
;
8773 this_line_start_x
= row
->x
;
8776 CHARPOS (this_line_start_pos
) = 0;
8781 /* Run window scroll functions, if any, for WINDOW with new window
8782 start STARTP. Sets the window start of WINDOW to that position.
8784 We assume that the window's buffer is really current. */
8786 static INLINE
struct text_pos
8787 run_window_scroll_functions (window
, startp
)
8789 struct text_pos startp
;
8791 struct window
*w
= XWINDOW (window
);
8792 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
8794 if (current_buffer
!= XBUFFER (w
->buffer
))
8797 if (!NILP (Vwindow_scroll_functions
))
8799 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
8800 make_number (CHARPOS (startp
)));
8801 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
8802 /* In case the hook functions switch buffers. */
8803 if (current_buffer
!= XBUFFER (w
->buffer
))
8804 set_buffer_internal_1 (XBUFFER (w
->buffer
));
8811 /* Modify the desired matrix of window W and W->vscroll so that the
8812 line containing the cursor is fully visible. */
8815 make_cursor_line_fully_visible (w
)
8818 struct glyph_matrix
*matrix
;
8819 struct glyph_row
*row
;
8820 int window_height
, header_line_height
;
8822 /* It's not always possible to find the cursor, e.g, when a window
8823 is full of overlay strings. Don't do anything in that case. */
8824 if (w
->cursor
.vpos
< 0)
8827 matrix
= w
->desired_matrix
;
8828 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
8830 /* If the cursor row is not partially visible, there's nothing
8832 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (row
))
8835 /* If the row the cursor is in is taller than the window's height,
8836 it's not clear what to do, so do nothing. */
8837 window_height
= window_box_height (w
);
8838 if (row
->height
>= window_height
)
8841 if (MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (w
, row
))
8843 int dy
= row
->height
- row
->visible_height
;
8846 shift_glyph_matrix (w
, matrix
, 0, matrix
->nrows
, dy
);
8848 else /* MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P (w, row)) */
8850 int dy
= - (row
->height
- row
->visible_height
);
8853 shift_glyph_matrix (w
, matrix
, 0, matrix
->nrows
, dy
);
8856 /* When we change the cursor y-position of the selected window,
8857 change this_line_y as well so that the display optimization for
8858 the cursor line of the selected window in redisplay_internal uses
8859 the correct y-position. */
8860 if (w
== XWINDOW (selected_window
))
8861 this_line_y
= w
->cursor
.y
;
8865 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
8866 non-zero means only WINDOW is redisplayed in redisplay_internal.
8867 TEMP_SCROLL_STEP has the same meaning as scroll_step, and is used
8868 in redisplay_window to bring a partially visible line into view in
8869 the case that only the cursor has moved.
8873 1 if scrolling succeeded
8875 0 if scrolling didn't find point.
8877 -1 if new fonts have been loaded so that we must interrupt
8878 redisplay, adjust glyph matrices, and try again. */
8881 try_scrolling (window
, just_this_one_p
, scroll_conservatively
,
8882 scroll_step
, temp_scroll_step
)
8884 int just_this_one_p
;
8885 int scroll_conservatively
, scroll_step
;
8886 int temp_scroll_step
;
8888 struct window
*w
= XWINDOW (window
);
8889 struct frame
*f
= XFRAME (w
->frame
);
8890 struct text_pos scroll_margin_pos
;
8891 struct text_pos pos
;
8892 struct text_pos startp
;
8894 Lisp_Object window_end
;
8895 int this_scroll_margin
;
8899 int amount_to_scroll
= 0;
8900 Lisp_Object aggressive
;
8904 debug_method_add (w
, "try_scrolling");
8907 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
8909 /* Compute scroll margin height in pixels. We scroll when point is
8910 within this distance from the top or bottom of the window. */
8911 if (scroll_margin
> 0)
8913 this_scroll_margin
= min (scroll_margin
, XINT (w
->height
) / 4);
8914 this_scroll_margin
*= CANON_Y_UNIT (f
);
8917 this_scroll_margin
= 0;
8919 /* Compute how much we should try to scroll maximally to bring point
8921 if (scroll_step
|| scroll_conservatively
|| temp_scroll_step
)
8922 scroll_max
= max (scroll_step
,
8923 max (scroll_conservatively
, temp_scroll_step
));
8924 else if (NUMBERP (current_buffer
->scroll_down_aggressively
)
8925 || NUMBERP (current_buffer
->scroll_up_aggressively
))
8926 /* We're trying to scroll because of aggressive scrolling
8927 but no scroll_step is set. Choose an arbitrary one. Maybe
8928 there should be a variable for this. */
8932 scroll_max
*= CANON_Y_UNIT (f
);
8934 /* Decide whether we have to scroll down. Start at the window end
8935 and move this_scroll_margin up to find the position of the scroll
8937 window_end
= Fwindow_end (window
, Qt
);
8938 CHARPOS (scroll_margin_pos
) = XINT (window_end
);
8939 BYTEPOS (scroll_margin_pos
) = CHAR_TO_BYTE (CHARPOS (scroll_margin_pos
));
8940 if (this_scroll_margin
)
8942 start_display (&it
, w
, scroll_margin_pos
);
8943 move_it_vertically (&it
, - this_scroll_margin
);
8944 scroll_margin_pos
= it
.current
.pos
;
8947 if (PT
>= CHARPOS (scroll_margin_pos
))
8954 /* Point is in the scroll margin at the bottom of the window, or
8955 below. Compute a new window start that makes point visible. */
8957 /* Compute the distance from the scroll margin to PT.
8958 Give up if the distance is greater than scroll_max. */
8959 start_display (&it
, w
, scroll_margin_pos
);
8961 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
8962 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
8963 #if 0 /* Taking the line's height into account here looks wrong. */
8964 line_height
= (it
.max_ascent
+ it
.max_descent
8965 ? it
.max_ascent
+ it
.max_descent
8967 dy
= it
.current_y
+ line_height
- y0
;
8969 /* With a scroll_margin of 0, scroll_margin_pos is at the window
8970 end, which is one line below the window. The iterator's
8971 current_y will be same as y0 in that case, but we have to
8972 scroll a line to make PT visible. That's the reason why 1 is
8974 dy
= 1 + it
.current_y
- y0
;
8977 if (dy
> scroll_max
)
8980 /* Move the window start down. If scrolling conservatively,
8981 move it just enough down to make point visible. If
8982 scroll_step is set, move it down by scroll_step. */
8983 start_display (&it
, w
, startp
);
8985 if (scroll_conservatively
)
8987 max (dy
, CANON_Y_UNIT (f
) * max (scroll_step
, temp_scroll_step
));
8988 else if (scroll_step
|| temp_scroll_step
)
8989 amount_to_scroll
= scroll_max
;
8992 aggressive
= current_buffer
->scroll_down_aggressively
;
8993 height
= (WINDOW_DISPLAY_HEIGHT_NO_MODE_LINE (w
)
8994 - WINDOW_DISPLAY_HEADER_LINE_HEIGHT (w
));
8995 if (NUMBERP (aggressive
))
8996 amount_to_scroll
= XFLOATINT (aggressive
) * height
;
8999 if (amount_to_scroll
<= 0)
9002 move_it_vertically (&it
, amount_to_scroll
);
9003 startp
= it
.current
.pos
;
9007 /* See if point is inside the scroll margin at the top of the
9009 scroll_margin_pos
= startp
;
9010 if (this_scroll_margin
)
9012 start_display (&it
, w
, startp
);
9013 move_it_vertically (&it
, this_scroll_margin
);
9014 scroll_margin_pos
= it
.current
.pos
;
9017 if (PT
< CHARPOS (scroll_margin_pos
))
9019 /* Point is in the scroll margin at the top of the window or
9020 above what is displayed in the window. */
9023 /* Compute the vertical distance from PT to the scroll
9024 margin position. Give up if distance is greater than
9026 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
9027 start_display (&it
, w
, pos
);
9029 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
9030 it
.last_visible_y
, -1,
9031 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
9032 dy
= it
.current_y
- y0
;
9033 if (dy
> scroll_max
)
9036 /* Compute new window start. */
9037 start_display (&it
, w
, startp
);
9039 if (scroll_conservatively
)
9041 max (dy
, CANON_Y_UNIT (f
) * max (scroll_step
, temp_scroll_step
));
9042 else if (scroll_step
|| temp_scroll_step
)
9043 amount_to_scroll
= scroll_max
;
9046 aggressive
= current_buffer
->scroll_up_aggressively
;
9047 height
= (WINDOW_DISPLAY_HEIGHT_NO_MODE_LINE (w
)
9048 - WINDOW_DISPLAY_HEADER_LINE_HEIGHT (w
));
9049 if (NUMBERP (aggressive
))
9050 amount_to_scroll
= XFLOATINT (aggressive
) * height
;
9053 if (amount_to_scroll
<= 0)
9056 move_it_vertically (&it
, - amount_to_scroll
);
9057 startp
= it
.current
.pos
;
9061 /* Run window scroll functions. */
9062 startp
= run_window_scroll_functions (window
, startp
);
9064 /* Display the window. Give up if new fonts are loaded, or if point
9066 if (!try_window (window
, startp
))
9068 else if (w
->cursor
.vpos
< 0)
9070 clear_glyph_matrix (w
->desired_matrix
);
9075 /* Maybe forget recorded base line for line number display. */
9076 if (!just_this_one_p
9077 || current_buffer
->clip_changed
9078 || BEG_UNCHANGED
< CHARPOS (startp
))
9079 w
->base_line_number
= Qnil
;
9081 /* If cursor ends up on a partially visible line, shift display
9082 lines up or down. */
9083 make_cursor_line_fully_visible (w
);
9091 /* Compute a suitable window start for window W if display of W starts
9092 on a continuation line. Value is non-zero if a new window start
9095 The new window start will be computed, based on W's width, starting
9096 from the start of the continued line. It is the start of the
9097 screen line with the minimum distance from the old start W->start. */
9100 compute_window_start_on_continuation_line (w
)
9103 struct text_pos pos
, start_pos
;
9104 int window_start_changed_p
= 0;
9106 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
9108 /* If window start is on a continuation line... Window start may be
9109 < BEGV in case there's invisible text at the start of the
9110 buffer (M-x rmail, for example). */
9111 if (CHARPOS (start_pos
) > BEGV
9112 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
9115 struct glyph_row
*row
;
9117 /* Handle the case that the window start is out of range. */
9118 if (CHARPOS (start_pos
) < BEGV
)
9119 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
9120 else if (CHARPOS (start_pos
) > ZV
)
9121 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
9123 /* Find the start of the continued line. This should be fast
9124 because scan_buffer is fast (newline cache). */
9125 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
9126 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
9127 row
, DEFAULT_FACE_ID
);
9128 reseat_at_previous_visible_line_start (&it
);
9130 /* If the line start is "too far" away from the window start,
9131 say it takes too much time to compute a new window start. */
9132 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
9133 < XFASTINT (w
->height
) * XFASTINT (w
->width
))
9135 int min_distance
, distance
;
9137 /* Move forward by display lines to find the new window
9138 start. If window width was enlarged, the new start can
9139 be expected to be > the old start. If window width was
9140 decreased, the new window start will be < the old start.
9141 So, we're looking for the display line start with the
9142 minimum distance from the old window start. */
9143 pos
= it
.current
.pos
;
9144 min_distance
= INFINITY
;
9145 while ((distance
= abs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
9146 distance
< min_distance
)
9148 min_distance
= distance
;
9149 pos
= it
.current
.pos
;
9150 move_it_by_lines (&it
, 1, 0);
9153 /* Set the window start there. */
9154 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
9155 window_start_changed_p
= 1;
9159 return window_start_changed_p
;
9163 /* Try cursor movement in case text has not changes in window WINDOW,
9164 with window start STARTP. Value is
9168 0 if this method cannot be used
9170 -1 if we know we have to scroll the display. *SCROLL_STEP is
9171 set to 1, under certain circumstances, if we want to scroll as
9172 if scroll-step were set to 1. See the code. */
9175 try_cursor_movement (window
, startp
, scroll_step
)
9177 struct text_pos startp
;
9180 struct window
*w
= XWINDOW (window
);
9181 struct frame
*f
= XFRAME (w
->frame
);
9184 /* Handle case where text has not changed, only point, and it has
9185 not moved off the frame. */
9186 if (/* Point may be in this window. */
9187 PT
>= CHARPOS (startp
)
9188 /* Selective display hasn't changed. */
9189 && !current_buffer
->clip_changed
9190 /* Function force-mode-line-update is used to force a thorough
9191 redisplay. It sets either windows_or_buffers_changed or
9192 update_mode_lines. So don't take a shortcut here for these
9194 && !update_mode_lines
9195 && !windows_or_buffers_changed
9196 /* Can't use this case if highlighting a region. When a
9197 region exists, cursor movement has to do more than just
9199 && !(!NILP (Vtransient_mark_mode
)
9200 && !NILP (current_buffer
->mark_active
))
9201 && NILP (w
->region_showing
)
9202 && NILP (Vshow_trailing_whitespace
)
9203 /* Right after splitting windows, last_point may be nil. */
9204 && INTEGERP (w
->last_point
)
9205 /* This code is not used for mini-buffer for the sake of the case
9206 of redisplaying to replace an echo area message; since in
9207 that case the mini-buffer contents per se are usually
9208 unchanged. This code is of no real use in the mini-buffer
9209 since the handling of this_line_start_pos, etc., in redisplay
9210 handles the same cases. */
9211 && !EQ (window
, minibuf_window
)
9212 /* When splitting windows or for new windows, it happens that
9213 redisplay is called with a nil window_end_vpos or one being
9214 larger than the window. This should really be fixed in
9215 window.c. I don't have this on my list, now, so we do
9216 approximately the same as the old redisplay code. --gerd. */
9217 && INTEGERP (w
->window_end_vpos
)
9218 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
9219 && (FRAME_WINDOW_P (f
)
9220 || !MARKERP (Voverlay_arrow_position
)
9221 || current_buffer
!= XMARKER (Voverlay_arrow_position
)->buffer
))
9223 int this_scroll_margin
;
9224 struct glyph_row
*row
;
9227 debug_method_add (w
, "cursor movement");
9230 /* Scroll if point within this distance from the top or bottom
9231 of the window. This is a pixel value. */
9232 this_scroll_margin
= max (0, scroll_margin
);
9233 this_scroll_margin
= min (this_scroll_margin
, XFASTINT (w
->height
) / 4);
9234 this_scroll_margin
*= CANON_Y_UNIT (f
);
9236 /* Start with the row the cursor was displayed during the last
9237 not paused redisplay. Give up if that row is not valid. */
9238 if (w
->last_cursor
.vpos
< 0
9239 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
9243 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
9244 if (row
->mode_line_p
)
9246 if (!row
->enabled_p
)
9253 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
9255 if (PT
> XFASTINT (w
->last_point
))
9257 /* Point has moved forward. */
9258 while (MATRIX_ROW_END_CHARPOS (row
) < PT
9259 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
9261 xassert (row
->enabled_p
);
9265 /* The end position of a row equals the start position
9266 of the next row. If PT is there, we would rather
9267 display it in the next line. */
9268 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
9269 && MATRIX_ROW_END_CHARPOS (row
) == PT
9270 && !cursor_row_p (w
, row
))
9273 /* If within the scroll margin, scroll. Note that
9274 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
9275 the next line would be drawn, and that
9276 this_scroll_margin can be zero. */
9277 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
9278 || PT
> MATRIX_ROW_END_CHARPOS (row
)
9279 /* Line is completely visible last line in window
9280 and PT is to be set in the next line. */
9281 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
9282 && PT
== MATRIX_ROW_END_CHARPOS (row
)
9283 && !row
->ends_at_zv_p
9284 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
9287 else if (PT
< XFASTINT (w
->last_point
))
9289 /* Cursor has to be moved backward. Note that PT >=
9290 CHARPOS (startp) because of the outer
9292 while (!row
->mode_line_p
9293 && (MATRIX_ROW_START_CHARPOS (row
) > PT
9294 || (MATRIX_ROW_START_CHARPOS (row
) == PT
9295 && MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)))
9296 && (row
->y
> this_scroll_margin
9297 || CHARPOS (startp
) == BEGV
))
9299 xassert (row
->enabled_p
);
9303 /* Consider the following case: Window starts at BEGV,
9304 there is invisible, intangible text at BEGV, so that
9305 display starts at some point START > BEGV. It can
9306 happen that we are called with PT somewhere between
9307 BEGV and START. Try to handle that case. */
9308 if (row
< w
->current_matrix
->rows
9309 || row
->mode_line_p
)
9311 row
= w
->current_matrix
->rows
;
9312 if (row
->mode_line_p
)
9316 /* Due to newlines in overlay strings, we may have to
9317 skip forward over overlay strings. */
9318 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
9319 && MATRIX_ROW_END_CHARPOS (row
) == PT
9320 && !cursor_row_p (w
, row
))
9323 /* If within the scroll margin, scroll. */
9324 if (row
->y
< this_scroll_margin
9325 && CHARPOS (startp
) != BEGV
)
9329 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
9330 || PT
> MATRIX_ROW_END_CHARPOS (row
))
9332 /* if PT is not in the glyph row, give up. */
9335 else if (MATRIX_ROW_PARTIALLY_VISIBLE_P (row
))
9337 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
9338 && !row
->ends_at_zv_p
9339 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
9341 else if (row
->height
> window_box_height (w
))
9343 /* If we end up in a partially visible line, let's
9344 make it fully visible, except when it's taller
9345 than the window, in which case we can't do much
9352 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
9353 try_window (window
, startp
);
9354 make_cursor_line_fully_visible (w
);
9362 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
9372 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
9373 selected_window is redisplayed. */
9376 redisplay_window (window
, just_this_one_p
)
9378 int just_this_one_p
;
9380 struct window
*w
= XWINDOW (window
);
9381 struct frame
*f
= XFRAME (w
->frame
);
9382 struct buffer
*buffer
= XBUFFER (w
->buffer
);
9383 struct buffer
*old
= current_buffer
;
9384 struct text_pos lpoint
, opoint
, startp
;
9385 int update_mode_line
;
9388 /* Record it now because it's overwritten. */
9389 int current_matrix_up_to_date_p
= 0;
9390 int temp_scroll_step
= 0;
9391 int count
= BINDING_STACK_SIZE ();
9394 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
9397 /* W must be a leaf window here. */
9398 xassert (!NILP (w
->buffer
));
9400 *w
->desired_matrix
->method
= 0;
9403 specbind (Qinhibit_point_motion_hooks
, Qt
);
9405 reconsider_clip_changes (w
, buffer
);
9407 /* Has the mode line to be updated? */
9408 update_mode_line
= (!NILP (w
->update_mode_line
)
9409 || update_mode_lines
9410 || buffer
->clip_changed
);
9412 if (MINI_WINDOW_P (w
))
9414 if (w
== XWINDOW (echo_area_window
)
9415 && !NILP (echo_area_buffer
[0]))
9417 if (update_mode_line
)
9418 /* We may have to update a tty frame's menu bar or a
9419 tool-bar. Example `M-x C-h C-h C-g'. */
9420 goto finish_menu_bars
;
9422 /* We've already displayed the echo area glyphs in this window. */
9423 goto finish_scroll_bars
;
9425 else if (w
!= XWINDOW (minibuf_window
))
9427 /* W is a mini-buffer window, but it's not the currently
9428 active one, so clear it. */
9429 int yb
= window_text_bottom_y (w
);
9430 struct glyph_row
*row
;
9433 for (y
= 0, row
= w
->desired_matrix
->rows
;
9435 y
+= row
->height
, ++row
)
9436 blank_row (w
, row
, y
);
9437 goto finish_scroll_bars
;
9441 /* Otherwise set up data on this window; select its buffer and point
9443 /* Really select the buffer, for the sake of buffer-local
9445 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9446 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
9448 current_matrix_up_to_date_p
9449 = (!NILP (w
->window_end_valid
)
9450 && !current_buffer
->clip_changed
9451 && XFASTINT (w
->last_modified
) >= MODIFF
9452 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
9454 /* When windows_or_buffers_changed is non-zero, we can't rely on
9455 the window end being valid, so set it to nil there. */
9456 if (windows_or_buffers_changed
)
9458 /* If window starts on a continuation line, maybe adjust the
9459 window start in case the window's width changed. */
9460 if (XMARKER (w
->start
)->buffer
== current_buffer
)
9461 compute_window_start_on_continuation_line (w
);
9463 w
->window_end_valid
= Qnil
;
9466 /* Some sanity checks. */
9467 CHECK_WINDOW_END (w
);
9468 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
9470 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
9473 /* If %c is in mode line, update it if needed. */
9474 if (!NILP (w
->column_number_displayed
)
9475 /* This alternative quickly identifies a common case
9476 where no change is needed. */
9477 && !(PT
== XFASTINT (w
->last_point
)
9478 && XFASTINT (w
->last_modified
) >= MODIFF
9479 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
9480 && XFASTINT (w
->column_number_displayed
) != current_column ())
9481 update_mode_line
= 1;
9483 /* Count number of windows showing the selected buffer. An indirect
9484 buffer counts as its base buffer. */
9485 if (!just_this_one_p
)
9487 struct buffer
*current_base
, *window_base
;
9488 current_base
= current_buffer
;
9489 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
9490 if (current_base
->base_buffer
)
9491 current_base
= current_base
->base_buffer
;
9492 if (window_base
->base_buffer
)
9493 window_base
= window_base
->base_buffer
;
9494 if (current_base
== window_base
)
9498 /* Point refers normally to the selected window. For any other
9499 window, set up appropriate value. */
9500 if (!EQ (window
, selected_window
))
9502 int new_pt
= XMARKER (w
->pointm
)->charpos
;
9503 int new_pt_byte
= marker_byte_position (w
->pointm
);
9507 new_pt_byte
= BEGV_BYTE
;
9508 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
9510 else if (new_pt
> (ZV
- 1))
9513 new_pt_byte
= ZV_BYTE
;
9514 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
9517 /* We don't use SET_PT so that the point-motion hooks don't run. */
9518 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
9521 /* If any of the character widths specified in the display table
9522 have changed, invalidate the width run cache. It's true that
9523 this may be a bit late to catch such changes, but the rest of
9524 redisplay goes (non-fatally) haywire when the display table is
9525 changed, so why should we worry about doing any better? */
9526 if (current_buffer
->width_run_cache
)
9528 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
9530 if (! disptab_matches_widthtab (disptab
,
9531 XVECTOR (current_buffer
->width_table
)))
9533 invalidate_region_cache (current_buffer
,
9534 current_buffer
->width_run_cache
,
9536 recompute_width_table (current_buffer
, disptab
);
9540 /* If window-start is screwed up, choose a new one. */
9541 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
9544 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
9546 /* If someone specified a new starting point but did not insist,
9547 check whether it can be used. */
9548 if (!NILP (w
->optional_new_start
)
9549 && CHARPOS (startp
) >= BEGV
9550 && CHARPOS (startp
) <= ZV
)
9552 w
->optional_new_start
= Qnil
;
9553 start_display (&it
, w
, startp
);
9554 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
9555 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
9556 if (IT_CHARPOS (it
) == PT
)
9557 w
->force_start
= Qt
;
9560 /* Handle case where place to start displaying has been specified,
9561 unless the specified location is outside the accessible range. */
9562 if (!NILP (w
->force_start
)
9563 || w
->frozen_window_start_p
)
9565 w
->force_start
= Qnil
;
9567 w
->window_end_valid
= Qnil
;
9569 /* Forget any recorded base line for line number display. */
9570 if (!current_matrix_up_to_date_p
9571 || current_buffer
->clip_changed
)
9572 w
->base_line_number
= Qnil
;
9574 /* Redisplay the mode line. Select the buffer properly for that.
9575 Also, run the hook window-scroll-functions
9576 because we have scrolled. */
9577 /* Note, we do this after clearing force_start because
9578 if there's an error, it is better to forget about force_start
9579 than to get into an infinite loop calling the hook functions
9580 and having them get more errors. */
9581 if (!update_mode_line
9582 || ! NILP (Vwindow_scroll_functions
))
9584 update_mode_line
= 1;
9585 w
->update_mode_line
= Qt
;
9586 startp
= run_window_scroll_functions (window
, startp
);
9589 XSETFASTINT (w
->last_modified
, 0);
9590 XSETFASTINT (w
->last_overlay_modified
, 0);
9591 if (CHARPOS (startp
) < BEGV
)
9592 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
9593 else if (CHARPOS (startp
) > ZV
)
9594 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
9596 /* Redisplay, then check if cursor has been set during the
9597 redisplay. Give up if new fonts were loaded. */
9598 if (!try_window (window
, startp
))
9600 w
->force_start
= Qt
;
9601 clear_glyph_matrix (w
->desired_matrix
);
9602 goto restore_buffers
;
9605 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
9607 /* If point does not appear, try to move point so it does
9608 appear. The desired matrix has been built above, so we
9611 struct glyph_row
*row
;
9613 window_height
= window_box_height (w
) / 2;
9614 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
9615 while (MATRIX_ROW_BOTTOM_Y (row
) < window_height
)
9618 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
9619 MATRIX_ROW_START_BYTEPOS (row
));
9621 if (w
!= XWINDOW (selected_window
))
9622 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
9623 else if (current_buffer
== old
)
9624 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
9626 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
9628 /* If we are highlighting the region, then we just changed
9629 the region, so redisplay to show it. */
9630 if (!NILP (Vtransient_mark_mode
)
9631 && !NILP (current_buffer
->mark_active
))
9633 clear_glyph_matrix (w
->desired_matrix
);
9634 if (!try_window (window
, startp
))
9635 goto restore_buffers
;
9639 make_cursor_line_fully_visible (w
);
9641 debug_method_add (w
, "forced window start");
9646 /* Handle case where text has not changed, only point, and it has
9647 not moved off the frame. */
9648 if (current_matrix_up_to_date_p
9649 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
9657 /* If current starting point was originally the beginning of a line
9658 but no longer is, find a new starting point. */
9659 else if (!NILP (w
->start_at_line_beg
)
9660 && !(CHARPOS (startp
) <= BEGV
9661 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
9664 debug_method_add (w
, "recenter 1");
9669 /* Try scrolling with try_window_id. */
9670 else if (/* Windows and buffers haven't changed. */
9671 !windows_or_buffers_changed
9672 /* Window must be either use window-based redisplay or
9674 && (FRAME_WINDOW_P (f
)
9675 || (line_ins_del_ok
&& WINDOW_FULL_WIDTH_P (w
)))
9676 && !MINI_WINDOW_P (w
)
9677 /* Point is not known NOT to appear in window. */
9678 && PT
>= CHARPOS (startp
)
9679 && XFASTINT (w
->last_modified
)
9680 /* Window is not hscrolled. */
9681 && XFASTINT (w
->hscroll
) == 0
9682 /* Selective display has not changed. */
9683 && !current_buffer
->clip_changed
9684 /* Current matrix is up to date. */
9685 && !NILP (w
->window_end_valid
)
9686 /* Can't use this case if highlighting a region because
9687 a cursor movement will do more than just set the cursor. */
9688 && !(!NILP (Vtransient_mark_mode
)
9689 && !NILP (current_buffer
->mark_active
))
9690 && NILP (w
->region_showing
)
9691 && NILP (Vshow_trailing_whitespace
)
9692 /* Overlay arrow position and string not changed. */
9693 && EQ (last_arrow_position
, COERCE_MARKER (Voverlay_arrow_position
))
9694 && EQ (last_arrow_string
, Voverlay_arrow_string
)
9695 /* Value is > 0 if update has been done, it is -1 if we
9696 know that the same window start will not work. It is 0
9697 if unsuccessful for some other reason. */
9698 && (tem
= try_window_id (w
)) != 0)
9701 debug_method_add (w
, "try_window_id %d", tem
);
9704 if (fonts_changed_p
)
9705 goto restore_buffers
;
9709 /* Otherwise try_window_id has returned -1 which means that we
9710 don't want the alternative below this comment to execute. */
9712 else if (CHARPOS (startp
) >= BEGV
9713 && CHARPOS (startp
) <= ZV
9714 && PT
>= CHARPOS (startp
)
9715 && (CHARPOS (startp
) < ZV
9716 /* Avoid starting at end of buffer. */
9717 || CHARPOS (startp
) == BEGV
9718 || (XFASTINT (w
->last_modified
) >= MODIFF
9719 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
9722 debug_method_add (w
, "same window start");
9725 /* Try to redisplay starting at same place as before.
9726 If point has not moved off frame, accept the results. */
9727 if (!current_matrix_up_to_date_p
9728 /* Don't use try_window_reusing_current_matrix in this case
9729 because a window scroll function can have changed the
9731 || !NILP (Vwindow_scroll_functions
)
9732 || MINI_WINDOW_P (w
)
9733 || !try_window_reusing_current_matrix (w
))
9735 IF_DEBUG (debug_method_add (w
, "1"));
9736 try_window (window
, startp
);
9739 if (fonts_changed_p
)
9740 goto restore_buffers
;
9742 if (w
->cursor
.vpos
>= 0)
9744 if (!just_this_one_p
9745 || current_buffer
->clip_changed
9746 || BEG_UNCHANGED
< CHARPOS (startp
))
9747 /* Forget any recorded base line for line number display. */
9748 w
->base_line_number
= Qnil
;
9750 make_cursor_line_fully_visible (w
);
9754 clear_glyph_matrix (w
->desired_matrix
);
9759 XSETFASTINT (w
->last_modified
, 0);
9760 XSETFASTINT (w
->last_overlay_modified
, 0);
9762 /* Redisplay the mode line. Select the buffer properly for that. */
9763 if (!update_mode_line
)
9765 update_mode_line
= 1;
9766 w
->update_mode_line
= Qt
;
9769 /* Try to scroll by specified few lines. */
9770 if ((scroll_conservatively
9773 || NUMBERP (current_buffer
->scroll_up_aggressively
)
9774 || NUMBERP (current_buffer
->scroll_down_aggressively
))
9775 && !current_buffer
->clip_changed
9776 && CHARPOS (startp
) >= BEGV
9777 && CHARPOS (startp
) <= ZV
)
9779 /* The function returns -1 if new fonts were loaded, 1 if
9780 successful, 0 if not successful. */
9781 int rc
= try_scrolling (window
, just_this_one_p
,
9782 scroll_conservatively
,
9788 goto restore_buffers
;
9791 /* Finally, just choose place to start which centers point */
9796 debug_method_add (w
, "recenter");
9799 /* w->vscroll = 0; */
9801 /* Forget any previously recorded base line for line number display. */
9802 if (!current_matrix_up_to_date_p
9803 || current_buffer
->clip_changed
)
9804 w
->base_line_number
= Qnil
;
9806 /* Move backward half the height of the window. */
9807 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
9808 it
.current_y
= it
.last_visible_y
;
9809 move_it_vertically_backward (&it
, it
.last_visible_y
/ 2);
9810 xassert (IT_CHARPOS (it
) >= BEGV
);
9812 /* The function move_it_vertically_backward may move over more
9813 than the specified y-distance. If it->w is small, e.g. a
9814 mini-buffer window, we may end up in front of the window's
9815 display area. Start displaying at the start of the line
9816 containing PT in this case. */
9817 if (it
.current_y
<= 0)
9819 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
9820 move_it_vertically (&it
, 0);
9821 xassert (IT_CHARPOS (it
) <= PT
);
9825 it
.current_x
= it
.hpos
= 0;
9827 /* Set startp here explicitly in case that helps avoid an infinite loop
9828 in case the window-scroll-functions functions get errors. */
9829 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
9831 /* Run scroll hooks. */
9832 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
9834 /* Redisplay the window. */
9835 if (!current_matrix_up_to_date_p
9836 || windows_or_buffers_changed
9837 /* Don't use try_window_reusing_current_matrix in this case
9838 because it can have changed the buffer. */
9839 || !NILP (Vwindow_scroll_functions
)
9841 || MINI_WINDOW_P (w
)
9842 || !try_window_reusing_current_matrix (w
))
9843 try_window (window
, startp
);
9845 /* If new fonts have been loaded (due to fontsets), give up. We
9846 have to start a new redisplay since we need to re-adjust glyph
9848 if (fonts_changed_p
)
9849 goto restore_buffers
;
9851 /* If cursor did not appear assume that the middle of the window is
9852 in the first line of the window. Do it again with the next line.
9853 (Imagine a window of height 100, displaying two lines of height
9854 60. Moving back 50 from it->last_visible_y will end in the first
9856 if (w
->cursor
.vpos
< 0)
9858 if (!NILP (w
->window_end_valid
)
9859 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
9861 clear_glyph_matrix (w
->desired_matrix
);
9862 move_it_by_lines (&it
, 1, 0);
9863 try_window (window
, it
.current
.pos
);
9865 else if (PT
< IT_CHARPOS (it
))
9867 clear_glyph_matrix (w
->desired_matrix
);
9868 move_it_by_lines (&it
, -1, 0);
9869 try_window (window
, it
.current
.pos
);
9873 /* Not much we can do about it. */
9877 /* Consider the following case: Window starts at BEGV, there is
9878 invisible, intangible text at BEGV, so that display starts at
9879 some point START > BEGV. It can happen that we are called with
9880 PT somewhere between BEGV and START. Try to handle that case. */
9881 if (w
->cursor
.vpos
< 0)
9883 struct glyph_row
*row
= w
->current_matrix
->rows
;
9884 if (row
->mode_line_p
)
9886 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
9889 make_cursor_line_fully_visible (w
);
9893 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
9894 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
9895 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
9898 /* Display the mode line, if we must. */
9899 if ((update_mode_line
9900 /* If window not full width, must redo its mode line
9901 if (a) the window to its side is being redone and
9902 (b) we do a frame-based redisplay. This is a consequence
9903 of how inverted lines are drawn in frame-based redisplay. */
9904 || (!just_this_one_p
9905 && !FRAME_WINDOW_P (f
)
9906 && !WINDOW_FULL_WIDTH_P (w
))
9907 /* Line number to display. */
9908 || INTEGERP (w
->base_line_pos
)
9909 /* Column number is displayed and different from the one displayed. */
9910 || (!NILP (w
->column_number_displayed
)
9911 && XFASTINT (w
->column_number_displayed
) != current_column ()))
9912 /* This means that the window has a mode line. */
9913 && (WINDOW_WANTS_MODELINE_P (w
)
9914 || WINDOW_WANTS_HEADER_LINE_P (w
)))
9916 Lisp_Object old_selected_frame
;
9918 old_selected_frame
= selected_frame
;
9920 XSETFRAME (selected_frame
, f
);
9921 display_mode_lines (w
);
9922 selected_frame
= old_selected_frame
;
9924 /* If mode line height has changed, arrange for a thorough
9925 immediate redisplay using the correct mode line height. */
9926 if (WINDOW_WANTS_MODELINE_P (w
)
9927 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
9929 fonts_changed_p
= 1;
9930 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
9931 = DESIRED_MODE_LINE_HEIGHT (w
);
9934 /* If top line height has changed, arrange for a thorough
9935 immediate redisplay using the correct mode line height. */
9936 if (WINDOW_WANTS_HEADER_LINE_P (w
)
9937 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
9939 fonts_changed_p
= 1;
9940 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
9941 = DESIRED_HEADER_LINE_HEIGHT (w
);
9944 if (fonts_changed_p
)
9945 goto restore_buffers
;
9948 if (!line_number_displayed
9949 && !BUFFERP (w
->base_line_pos
))
9951 w
->base_line_pos
= Qnil
;
9952 w
->base_line_number
= Qnil
;
9957 /* When we reach a frame's selected window, redo the frame's menu bar. */
9958 if (update_mode_line
9959 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
9961 int redisplay_menu_p
= 0;
9963 if (FRAME_WINDOW_P (f
))
9965 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (macintosh)
9966 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
9968 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
9972 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
9974 if (redisplay_menu_p
)
9975 display_menu_bar (w
);
9977 #ifdef HAVE_WINDOW_SYSTEM
9978 if (WINDOWP (f
->tool_bar_window
)
9979 && (FRAME_TOOL_BAR_LINES (f
) > 0
9980 || auto_resize_tool_bars_p
))
9981 redisplay_tool_bar (f
);
9987 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f
))
9989 int start
, end
, whole
;
9991 /* Calculate the start and end positions for the current window.
9992 At some point, it would be nice to choose between scrollbars
9993 which reflect the whole buffer size, with special markers
9994 indicating narrowing, and scrollbars which reflect only the
9997 Note that mini-buffers sometimes aren't displaying any text. */
9998 if (!MINI_WINDOW_P (w
)
9999 || (w
== XWINDOW (minibuf_window
)
10000 && NILP (echo_area_buffer
[0])))
10003 start
= marker_position (w
->start
) - BEGV
;
10004 /* I don't think this is guaranteed to be right. For the
10005 moment, we'll pretend it is. */
10006 end
= (Z
- XFASTINT (w
->window_end_pos
)) - BEGV
;
10010 if (whole
< (end
- start
))
10011 whole
= end
- start
;
10014 start
= end
= whole
= 0;
10016 /* Indicate what this scroll bar ought to be displaying now. */
10017 (*set_vertical_scroll_bar_hook
) (w
, end
- start
, whole
, start
);
10019 /* Note that we actually used the scroll bar attached to this
10020 window, so it shouldn't be deleted at the end of redisplay. */
10021 (*redeem_scroll_bar_hook
) (w
);
10026 /* Restore current_buffer and value of point in it. */
10027 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
10028 set_buffer_internal_1 (old
);
10029 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
10031 unbind_to (count
, Qnil
);
10035 /* Build the complete desired matrix of WINDOW with a window start
10036 buffer position POS. Value is non-zero if successful. It is zero
10037 if fonts were loaded during redisplay which makes re-adjusting
10038 glyph matrices necessary. */
10041 try_window (window
, pos
)
10042 Lisp_Object window
;
10043 struct text_pos pos
;
10045 struct window
*w
= XWINDOW (window
);
10047 struct glyph_row
*last_text_row
= NULL
;
10049 /* Make POS the new window start. */
10050 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
10052 /* Mark cursor position as unknown. No overlay arrow seen. */
10053 w
->cursor
.vpos
= -1;
10054 overlay_arrow_seen
= 0;
10056 /* Initialize iterator and info to start at POS. */
10057 start_display (&it
, w
, pos
);
10059 /* Display all lines of W. */
10060 while (it
.current_y
< it
.last_visible_y
)
10062 if (display_line (&it
))
10063 last_text_row
= it
.glyph_row
- 1;
10064 if (fonts_changed_p
)
10068 /* If bottom moved off end of frame, change mode line percentage. */
10069 if (XFASTINT (w
->window_end_pos
) <= 0
10070 && Z
!= IT_CHARPOS (it
))
10071 w
->update_mode_line
= Qt
;
10073 /* Set window_end_pos to the offset of the last character displayed
10074 on the window from the end of current_buffer. Set
10075 window_end_vpos to its row number. */
10078 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
10079 w
->window_end_bytepos
10080 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
10081 XSETFASTINT (w
->window_end_pos
,
10082 Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
10083 XSETFASTINT (w
->window_end_vpos
,
10084 MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
10085 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
10086 ->displays_text_p
);
10090 w
->window_end_bytepos
= 0;
10091 XSETFASTINT (w
->window_end_pos
, 0);
10092 XSETFASTINT (w
->window_end_vpos
, 0);
10095 /* But that is not valid info until redisplay finishes. */
10096 w
->window_end_valid
= Qnil
;
10102 /************************************************************************
10103 Window redisplay reusing current matrix when buffer has not changed
10104 ************************************************************************/
10106 /* Try redisplay of window W showing an unchanged buffer with a
10107 different window start than the last time it was displayed by
10108 reusing its current matrix. Value is non-zero if successful.
10109 W->start is the new window start. */
10112 try_window_reusing_current_matrix (w
)
10115 struct frame
*f
= XFRAME (w
->frame
);
10116 struct glyph_row
*row
, *bottom_row
;
10119 struct text_pos start
, new_start
;
10120 int nrows_scrolled
, i
;
10121 struct glyph_row
*last_text_row
;
10122 struct glyph_row
*last_reused_text_row
;
10123 struct glyph_row
*start_row
;
10124 int start_vpos
, min_y
, max_y
;
10126 if (/* This function doesn't handle terminal frames. */
10127 !FRAME_WINDOW_P (f
)
10128 /* Don't try to reuse the display if windows have been split
10130 || windows_or_buffers_changed
)
10133 /* Can't do this if region may have changed. */
10134 if ((!NILP (Vtransient_mark_mode
)
10135 && !NILP (current_buffer
->mark_active
))
10136 || !NILP (w
->region_showing
)
10137 || !NILP (Vshow_trailing_whitespace
))
10140 /* If top-line visibility has changed, give up. */
10141 if (WINDOW_WANTS_HEADER_LINE_P (w
)
10142 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
10145 /* Give up if old or new display is scrolled vertically. We could
10146 make this function handle this, but right now it doesn't. */
10147 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
10148 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (start_row
))
10151 /* The variable new_start now holds the new window start. The old
10152 start `start' can be determined from the current matrix. */
10153 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
10154 start
= start_row
->start
.pos
;
10155 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
10157 /* Clear the desired matrix for the display below. */
10158 clear_glyph_matrix (w
->desired_matrix
);
10160 if (CHARPOS (new_start
) <= CHARPOS (start
))
10164 IF_DEBUG (debug_method_add (w
, "twu1"));
10166 /* Display up to a row that can be reused. The variable
10167 last_text_row is set to the last row displayed that displays
10168 text. Note that it.vpos == 0 if or if not there is a
10169 header-line; it's not the same as the MATRIX_ROW_VPOS! */
10170 start_display (&it
, w
, new_start
);
10171 first_row_y
= it
.current_y
;
10172 w
->cursor
.vpos
= -1;
10173 last_text_row
= last_reused_text_row
= NULL
;
10175 while (it
.current_y
< it
.last_visible_y
10176 && IT_CHARPOS (it
) < CHARPOS (start
)
10177 && !fonts_changed_p
)
10178 if (display_line (&it
))
10179 last_text_row
= it
.glyph_row
- 1;
10181 /* A value of current_y < last_visible_y means that we stopped
10182 at the previous window start, which in turn means that we
10183 have at least one reusable row. */
10184 if (it
.current_y
< it
.last_visible_y
)
10186 /* IT.vpos always starts from 0; it counts text lines. */
10187 nrows_scrolled
= it
.vpos
;
10189 /* Find PT if not already found in the lines displayed. */
10190 if (w
->cursor
.vpos
< 0)
10192 int dy
= it
.current_y
- first_row_y
;
10194 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
10195 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
10197 if (PT
>= MATRIX_ROW_START_CHARPOS (row
)
10198 && PT
< MATRIX_ROW_END_CHARPOS (row
))
10200 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
10201 dy
, nrows_scrolled
);
10205 if (MATRIX_ROW_BOTTOM_Y (row
) + dy
>= it
.last_visible_y
)
10211 /* Give up if point was not found. This shouldn't
10212 happen often; not more often than with try_window
10214 if (w
->cursor
.vpos
< 0)
10216 clear_glyph_matrix (w
->desired_matrix
);
10221 /* Scroll the display. Do it before the current matrix is
10222 changed. The problem here is that update has not yet
10223 run, i.e. part of the current matrix is not up to date.
10224 scroll_run_hook will clear the cursor, and use the
10225 current matrix to get the height of the row the cursor is
10227 run
.current_y
= first_row_y
;
10228 run
.desired_y
= it
.current_y
;
10229 run
.height
= it
.last_visible_y
- it
.current_y
;
10231 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
10234 rif
->update_window_begin_hook (w
);
10235 rif
->clear_mouse_face (w
);
10236 rif
->scroll_run_hook (w
, &run
);
10237 rif
->update_window_end_hook (w
, 0, 0);
10241 /* Shift current matrix down by nrows_scrolled lines. */
10242 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
10243 rotate_matrix (w
->current_matrix
,
10245 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
10248 /* Disable lines not reused. */
10249 for (i
= 0; i
< it
.vpos
; ++i
)
10250 (start_row
+ i
)->enabled_p
= 0;
10252 /* Re-compute Y positions. */
10253 min_y
= WINDOW_DISPLAY_HEADER_LINE_HEIGHT (w
);
10254 max_y
= it
.last_visible_y
;
10255 for (row
= start_row
+ nrows_scrolled
;
10259 row
->y
= it
.current_y
;
10261 if (row
->y
< min_y
)
10262 row
->visible_height
= row
->height
- (min_y
- row
->y
);
10263 else if (row
->y
+ row
->height
> max_y
)
10264 row
->visible_height
10265 = row
->height
- (row
->y
+ row
->height
- max_y
);
10267 row
->visible_height
= row
->height
;
10269 it
.current_y
+= row
->height
;
10271 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
10272 last_reused_text_row
= row
;
10273 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
10278 /* Update window_end_pos etc.; last_reused_text_row is the last
10279 reused row from the current matrix containing text, if any.
10280 The value of last_text_row is the last displayed line
10281 containing text. */
10282 if (last_reused_text_row
)
10284 w
->window_end_bytepos
10285 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
10286 XSETFASTINT (w
->window_end_pos
,
10287 Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
10288 XSETFASTINT (w
->window_end_vpos
,
10289 MATRIX_ROW_VPOS (last_reused_text_row
,
10290 w
->current_matrix
));
10292 else if (last_text_row
)
10294 w
->window_end_bytepos
10295 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
10296 XSETFASTINT (w
->window_end_pos
,
10297 Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
10298 XSETFASTINT (w
->window_end_vpos
,
10299 MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
10303 /* This window must be completely empty. */
10304 w
->window_end_bytepos
= 0;
10305 XSETFASTINT (w
->window_end_pos
, 0);
10306 XSETFASTINT (w
->window_end_vpos
, 0);
10308 w
->window_end_valid
= Qnil
;
10310 /* Update hint: don't try scrolling again in update_window. */
10311 w
->desired_matrix
->no_scrolling_p
= 1;
10314 debug_method_add (w
, "try_window_reusing_current_matrix 1");
10318 else if (CHARPOS (new_start
) > CHARPOS (start
))
10320 struct glyph_row
*pt_row
, *row
;
10321 struct glyph_row
*first_reusable_row
;
10322 struct glyph_row
*first_row_to_display
;
10324 int yb
= window_text_bottom_y (w
);
10326 IF_DEBUG (debug_method_add (w
, "twu2"));
10328 /* Find the row starting at new_start, if there is one. Don't
10329 reuse a partially visible line at the end. */
10330 first_reusable_row
= start_row
;
10331 while (first_reusable_row
->enabled_p
10332 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
10333 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
10334 < CHARPOS (new_start
)))
10335 ++first_reusable_row
;
10337 /* Give up if there is no row to reuse. */
10338 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
10339 || !first_reusable_row
->enabled_p
10340 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
10341 != CHARPOS (new_start
)))
10344 /* We can reuse fully visible rows beginning with
10345 first_reusable_row to the end of the window. Set
10346 first_row_to_display to the first row that cannot be reused.
10347 Set pt_row to the row containing point, if there is any. */
10348 first_row_to_display
= first_reusable_row
;
10350 while (MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
)
10352 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
10353 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
10354 pt_row
= first_row_to_display
;
10356 ++first_row_to_display
;
10359 /* Start displaying at the start of first_row_to_display. */
10360 xassert (first_row_to_display
->y
< yb
);
10361 init_to_row_start (&it
, w
, first_row_to_display
);
10362 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
10364 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
10366 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
10367 + WINDOW_DISPLAY_HEADER_LINE_HEIGHT (w
));
10369 /* Display lines beginning with first_row_to_display in the
10370 desired matrix. Set last_text_row to the last row displayed
10371 that displays text. */
10372 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
10373 if (pt_row
== NULL
)
10374 w
->cursor
.vpos
= -1;
10375 last_text_row
= NULL
;
10376 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
10377 if (display_line (&it
))
10378 last_text_row
= it
.glyph_row
- 1;
10380 /* Give up If point isn't in a row displayed or reused. */
10381 if (w
->cursor
.vpos
< 0)
10383 clear_glyph_matrix (w
->desired_matrix
);
10387 /* If point is in a reused row, adjust y and vpos of the cursor
10391 w
->cursor
.vpos
-= MATRIX_ROW_VPOS (first_reusable_row
,
10392 w
->current_matrix
);
10393 w
->cursor
.y
-= first_reusable_row
->y
;
10396 /* Scroll the display. */
10397 run
.current_y
= first_reusable_row
->y
;
10398 run
.desired_y
= WINDOW_DISPLAY_HEADER_LINE_HEIGHT (w
);
10399 run
.height
= it
.last_visible_y
- run
.current_y
;
10400 dy
= run
.current_y
- run
.desired_y
;
10404 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
10406 rif
->update_window_begin_hook (w
);
10407 rif
->clear_mouse_face (w
);
10408 rif
->scroll_run_hook (w
, &run
);
10409 rif
->update_window_end_hook (w
, 0, 0);
10413 /* Adjust Y positions of reused rows. */
10414 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
10415 min_y
= WINDOW_DISPLAY_HEADER_LINE_HEIGHT (w
);
10416 max_y
= it
.last_visible_y
;
10417 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
10420 if (row
->y
< min_y
)
10421 row
->visible_height
= row
->height
- (min_y
- row
->y
);
10422 else if (row
->y
+ row
->height
> max_y
)
10423 row
->visible_height
10424 = row
->height
- (row
->y
+ row
->height
- max_y
);
10426 row
->visible_height
= row
->height
;
10429 /* Disable rows not reused. */
10430 while (row
< bottom_row
)
10432 row
->enabled_p
= 0;
10436 /* Scroll the current matrix. */
10437 xassert (nrows_scrolled
> 0);
10438 rotate_matrix (w
->current_matrix
,
10440 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
10443 /* Adjust window end. A null value of last_text_row means that
10444 the window end is in reused rows which in turn means that
10445 only its vpos can have changed. */
10448 w
->window_end_bytepos
10449 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
10450 XSETFASTINT (w
->window_end_pos
,
10451 Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
10452 XSETFASTINT (w
->window_end_vpos
,
10453 MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
10457 XSETFASTINT (w
->window_end_vpos
,
10458 XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
10461 w
->window_end_valid
= Qnil
;
10462 w
->desired_matrix
->no_scrolling_p
= 1;
10465 debug_method_add (w
, "try_window_reusing_current_matrix 2");
10475 /************************************************************************
10476 Window redisplay reusing current matrix when buffer has changed
10477 ************************************************************************/
10479 static struct glyph_row
*find_last_unchanged_at_beg_row
P_ ((struct window
*));
10480 static struct glyph_row
*find_first_unchanged_at_end_row
P_ ((struct window
*,
10482 static struct glyph_row
*
10483 find_last_row_displaying_text
P_ ((struct glyph_matrix
*, struct it
*,
10484 struct glyph_row
*));
10487 /* Return the last row in MATRIX displaying text. If row START is
10488 non-null, start searching with that row. IT gives the dimensions
10489 of the display. Value is null if matrix is empty; otherwise it is
10490 a pointer to the row found. */
10492 static struct glyph_row
*
10493 find_last_row_displaying_text (matrix
, it
, start
)
10494 struct glyph_matrix
*matrix
;
10496 struct glyph_row
*start
;
10498 struct glyph_row
*row
, *row_found
;
10500 /* Set row_found to the last row in IT->w's current matrix
10501 displaying text. The loop looks funny but think of partially
10504 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
10505 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
10507 xassert (row
->enabled_p
);
10509 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
10518 /* Return the last row in the current matrix of W that is not affected
10519 by changes at the start of current_buffer that occurred since the
10520 last time W was redisplayed. Value is null if no such row exists.
10522 The global variable beg_unchanged has to contain the number of
10523 bytes unchanged at the start of current_buffer. BEG +
10524 beg_unchanged is the buffer position of the first changed byte in
10525 current_buffer. Characters at positions < BEG + beg_unchanged are
10526 at the same buffer positions as they were when the current matrix
10529 static struct glyph_row
*
10530 find_last_unchanged_at_beg_row (w
)
10533 int first_changed_pos
= BEG
+ BEG_UNCHANGED
;
10534 struct glyph_row
*row
;
10535 struct glyph_row
*row_found
= NULL
;
10536 int yb
= window_text_bottom_y (w
);
10538 /* Find the last row displaying unchanged text. */
10539 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
10540 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
10541 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
)
10543 if (/* If row ends before first_changed_pos, it is unchanged,
10544 except in some case. */
10545 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
10546 /* When row ends in ZV and we write at ZV it is not
10548 && !row
->ends_at_zv_p
10549 /* When first_changed_pos is the end of a continued line,
10550 row is not unchanged because it may be no longer
10552 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
10553 && row
->continued_p
))
10556 /* Stop if last visible row. */
10557 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
10567 /* Find the first glyph row in the current matrix of W that is not
10568 affected by changes at the end of current_buffer since the last
10569 time the window was redisplayed. Return in *DELTA the number of
10570 chars by which buffer positions in unchanged text at the end of
10571 current_buffer must be adjusted. Return in *DELTA_BYTES the
10572 corresponding number of bytes. Value is null if no such row
10573 exists, i.e. all rows are affected by changes. */
10575 static struct glyph_row
*
10576 find_first_unchanged_at_end_row (w
, delta
, delta_bytes
)
10578 int *delta
, *delta_bytes
;
10580 struct glyph_row
*row
;
10581 struct glyph_row
*row_found
= NULL
;
10583 *delta
= *delta_bytes
= 0;
10585 /* Display must not have been paused, otherwise the current matrix
10586 is not up to date. */
10587 if (NILP (w
->window_end_valid
))
10590 /* A value of window_end_pos >= END_UNCHANGED means that the window
10591 end is in the range of changed text. If so, there is no
10592 unchanged row at the end of W's current matrix. */
10593 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
10596 /* Set row to the last row in W's current matrix displaying text. */
10597 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
10599 /* If matrix is entirely empty, no unchanged row exists. */
10600 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
10602 /* The value of row is the last glyph row in the matrix having a
10603 meaningful buffer position in it. The end position of row
10604 corresponds to window_end_pos. This allows us to translate
10605 buffer positions in the current matrix to current buffer
10606 positions for characters not in changed text. */
10607 int Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
10608 int Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
10609 int last_unchanged_pos
, last_unchanged_pos_old
;
10610 struct glyph_row
*first_text_row
10611 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
10613 *delta
= Z
- Z_old
;
10614 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
10616 /* Set last_unchanged_pos to the buffer position of the last
10617 character in the buffer that has not been changed. Z is the
10618 index + 1 of the last byte in current_buffer, i.e. by
10619 subtracting end_unchanged we get the index of the last
10620 unchanged character, and we have to add BEG to get its buffer
10622 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
10623 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
10625 /* Search backward from ROW for a row displaying a line that
10626 starts at a minimum position >= last_unchanged_pos_old. */
10627 for (; row
> first_text_row
; --row
)
10629 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
10632 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
10637 if (row_found
&& !MATRIX_ROW_DISPLAYS_TEXT_P (row_found
))
10644 /* Make sure that glyph rows in the current matrix of window W
10645 reference the same glyph memory as corresponding rows in the
10646 frame's frame matrix. This function is called after scrolling W's
10647 current matrix on a terminal frame in try_window_id and
10648 try_window_reusing_current_matrix. */
10651 sync_frame_with_window_matrix_rows (w
)
10654 struct frame
*f
= XFRAME (w
->frame
);
10655 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
10657 /* Preconditions: W must be a leaf window and full-width. Its frame
10658 must have a frame matrix. */
10659 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
10660 xassert (WINDOW_FULL_WIDTH_P (w
));
10661 xassert (!FRAME_WINDOW_P (f
));
10663 /* If W is a full-width window, glyph pointers in W's current matrix
10664 have, by definition, to be the same as glyph pointers in the
10665 corresponding frame matrix. */
10666 window_row
= w
->current_matrix
->rows
;
10667 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
10668 frame_row
= f
->current_matrix
->rows
+ XFASTINT (w
->top
);
10669 while (window_row
< window_row_end
)
10673 for (area
= LEFT_MARGIN_AREA
; area
<= LAST_AREA
; ++area
)
10674 frame_row
->glyphs
[area
] = window_row
->glyphs
[area
];
10676 /* Disable frame rows whose corresponding window rows have
10677 been disabled in try_window_id. */
10678 if (!window_row
->enabled_p
)
10679 frame_row
->enabled_p
= 0;
10681 ++window_row
, ++frame_row
;
10686 /* Find the glyph row in window W containing CHARPOS. Consider all
10687 rows between START and END (not inclusive). END null means search
10688 all rows to the end of the display area of W. Value is the row
10689 containing CHARPOS or null. */
10691 static struct glyph_row
*
10692 row_containing_pos (w
, charpos
, start
, end
)
10695 struct glyph_row
*start
, *end
;
10697 struct glyph_row
*row
= start
;
10700 /* If we happen to start on a header-line, skip that. */
10701 if (row
->mode_line_p
)
10704 if ((end
&& row
>= end
) || !row
->enabled_p
)
10707 last_y
= window_text_bottom_y (w
);
10709 while ((end
== NULL
|| row
< end
)
10710 && (MATRIX_ROW_END_CHARPOS (row
) < charpos
10711 /* The end position of a row equals the start
10712 position of the next row. If CHARPOS is there, we
10713 would rather display it in the next line, except
10714 when this line ends in ZV. */
10715 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
10716 && (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)
10717 || !row
->ends_at_zv_p
)))
10718 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
10721 /* Give up if CHARPOS not found. */
10722 if ((end
&& row
>= end
)
10723 || charpos
< MATRIX_ROW_START_CHARPOS (row
)
10724 || charpos
> MATRIX_ROW_END_CHARPOS (row
))
10731 /* Try to redisplay window W by reusing its existing display. W's
10732 current matrix must be up to date when this function is called,
10733 i.e. window_end_valid must not be nil.
10737 1 if display has been updated
10738 0 if otherwise unsuccessful
10739 -1 if redisplay with same window start is known not to succeed
10741 The following steps are performed:
10743 1. Find the last row in the current matrix of W that is not
10744 affected by changes at the start of current_buffer. If no such row
10747 2. Find the first row in W's current matrix that is not affected by
10748 changes at the end of current_buffer. Maybe there is no such row.
10750 3. Display lines beginning with the row + 1 found in step 1 to the
10751 row found in step 2 or, if step 2 didn't find a row, to the end of
10754 4. If cursor is not known to appear on the window, give up.
10756 5. If display stopped at the row found in step 2, scroll the
10757 display and current matrix as needed.
10759 6. Maybe display some lines at the end of W, if we must. This can
10760 happen under various circumstances, like a partially visible line
10761 becoming fully visible, or because newly displayed lines are displayed
10762 in smaller font sizes.
10764 7. Update W's window end information. */
10766 /* Check that window end is what we expect it to be. */
10772 struct frame
*f
= XFRAME (w
->frame
);
10773 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
10774 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
10775 struct glyph_row
*last_unchanged_at_beg_row
;
10776 struct glyph_row
*first_unchanged_at_end_row
;
10777 struct glyph_row
*row
;
10778 struct glyph_row
*bottom_row
;
10781 int delta
= 0, delta_bytes
= 0, stop_pos
, dvpos
, dy
;
10782 struct text_pos start_pos
;
10784 int first_unchanged_at_end_vpos
= 0;
10785 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
10786 struct text_pos start
;
10788 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10790 /* Check pre-conditions. Window end must be valid, otherwise
10791 the current matrix would not be up to date. */
10792 xassert (!NILP (w
->window_end_valid
));
10793 xassert (FRAME_WINDOW_P (XFRAME (w
->frame
))
10794 || (line_ins_del_ok
&& WINDOW_FULL_WIDTH_P (w
)));
10796 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
10797 only if buffer has really changed. The reason is that the gap is
10798 initially at Z for freshly visited files. The code below would
10799 set end_unchanged to 0 in that case. */
10800 if (MODIFF
> SAVE_MODIFF
10801 /* This seems to happen sometimes after saving a buffer. */
10802 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
10804 if (GPT
- BEG
< BEG_UNCHANGED
)
10805 BEG_UNCHANGED
= GPT
- BEG
;
10806 if (Z
- GPT
< END_UNCHANGED
)
10807 END_UNCHANGED
= Z
- GPT
;
10810 /* If window starts after a line end, and the last change is in
10811 front of that newline, then changes don't affect the display.
10812 This case happens with stealth-fontification. Note that although
10813 the display is unchanged, glyph positions in the matrix have to
10814 be adjusted, of course. */
10815 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
10816 if (CHARPOS (start
) > BEGV
10817 && Z
- END_UNCHANGED
< CHARPOS (start
) - 1
10818 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n'
10819 && PT
< MATRIX_ROW_END_CHARPOS (row
))
10821 struct glyph_row
*r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
10822 int delta
= CHARPOS (start
) - MATRIX_ROW_START_CHARPOS (r0
);
10826 struct glyph_row
*r1
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
10827 int delta_bytes
= BYTEPOS (start
) - MATRIX_ROW_START_BYTEPOS (r0
);
10829 increment_matrix_positions (w
->current_matrix
,
10830 MATRIX_ROW_VPOS (r0
, current_matrix
),
10831 MATRIX_ROW_VPOS (r1
, current_matrix
),
10832 delta
, delta_bytes
);
10835 #if 0 /* If changes are all in front of the window start, the
10836 distance of the last displayed glyph from Z hasn't
10839 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
10840 w
->window_end_bytepos
10841 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
10844 row
= row_containing_pos (w
, PT
, r0
, NULL
);
10848 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
10852 /* Return quickly if changes are all below what is displayed in the
10853 window, and if PT is in the window. */
10854 if (BEG_UNCHANGED
> MATRIX_ROW_END_CHARPOS (row
)
10855 && PT
< MATRIX_ROW_END_CHARPOS (row
))
10857 /* We have to update window end positions because the buffer's
10858 size has changed. */
10860 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
10861 w
->window_end_bytepos
10862 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
10864 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
10865 row
= row_containing_pos (w
, PT
, row
, NULL
);
10866 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
10870 /* Check that window start agrees with the start of the first glyph
10871 row in its current matrix. Check this after we know the window
10872 start is not in changed text, otherwise positions would not be
10874 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
10875 if (!TEXT_POS_EQUAL_P (start
, row
->start
.pos
))
10878 /* Compute the position at which we have to start displaying new
10879 lines. Some of the lines at the top of the window might be
10880 reusable because they are not displaying changed text. Find the
10881 last row in W's current matrix not affected by changes at the
10882 start of current_buffer. Value is null if changes start in the
10883 first line of window. */
10884 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
10885 if (last_unchanged_at_beg_row
)
10887 /* Avoid starting to display in the moddle of a character, a TAB
10888 for instance. This is easier than to set up the iterator
10889 exactly, and it's not a frequent case, so the additional
10890 effort wouldn't really pay off. */
10891 while (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
10892 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
10893 --last_unchanged_at_beg_row
;
10895 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
10898 init_to_row_end (&it
, w
, last_unchanged_at_beg_row
);
10899 start_pos
= it
.current
.pos
;
10901 /* Start displaying new lines in the desired matrix at the same
10902 vpos we would use in the current matrix, i.e. below
10903 last_unchanged_at_beg_row. */
10904 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
10906 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
10907 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
10909 xassert (it
.hpos
== 0 && it
.current_x
== 0);
10913 /* There are no reusable lines at the start of the window.
10914 Start displaying in the first line. */
10915 start_display (&it
, w
, start
);
10916 start_pos
= it
.current
.pos
;
10919 /* Find the first row that is not affected by changes at the end of
10920 the buffer. Value will be null if there is no unchanged row, in
10921 which case we must redisplay to the end of the window. delta
10922 will be set to the value by which buffer positions beginning with
10923 first_unchanged_at_end_row have to be adjusted due to text
10925 first_unchanged_at_end_row
10926 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
10927 IF_DEBUG (debug_delta
= delta
);
10928 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
10930 /* Set stop_pos to the buffer position up to which we will have to
10931 display new lines. If first_unchanged_at_end_row != NULL, this
10932 is the buffer position of the start of the line displayed in that
10933 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
10934 that we don't stop at a buffer position. */
10936 if (first_unchanged_at_end_row
)
10938 xassert (last_unchanged_at_beg_row
== NULL
10939 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
10941 /* If this is a continuation line, move forward to the next one
10942 that isn't. Changes in lines above affect this line.
10943 Caution: this may move first_unchanged_at_end_row to a row
10944 not displaying text. */
10945 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
10946 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
10947 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
10948 < it
.last_visible_y
))
10949 ++first_unchanged_at_end_row
;
10951 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
10952 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
10953 >= it
.last_visible_y
))
10954 first_unchanged_at_end_row
= NULL
;
10957 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
10959 first_unchanged_at_end_vpos
10960 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
10961 xassert (stop_pos
>= Z
- END_UNCHANGED
);
10964 else if (last_unchanged_at_beg_row
== NULL
)
10970 /* Either there is no unchanged row at the end, or the one we have
10971 now displays text. This is a necessary condition for the window
10972 end pos calculation at the end of this function. */
10973 xassert (first_unchanged_at_end_row
== NULL
10974 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
10976 debug_last_unchanged_at_beg_vpos
10977 = (last_unchanged_at_beg_row
10978 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
10980 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
10982 #endif /* GLYPH_DEBUG != 0 */
10985 /* Display new lines. Set last_text_row to the last new line
10986 displayed which has text on it, i.e. might end up as being the
10987 line where the window_end_vpos is. */
10988 w
->cursor
.vpos
= -1;
10989 last_text_row
= NULL
;
10990 overlay_arrow_seen
= 0;
10991 while (it
.current_y
< it
.last_visible_y
10992 && !fonts_changed_p
10993 && (first_unchanged_at_end_row
== NULL
10994 || IT_CHARPOS (it
) < stop_pos
))
10996 if (display_line (&it
))
10997 last_text_row
= it
.glyph_row
- 1;
11000 if (fonts_changed_p
)
11004 /* Compute differences in buffer positions, y-positions etc. for
11005 lines reused at the bottom of the window. Compute what we can
11007 if (first_unchanged_at_end_row
11008 /* No lines reused because we displayed everything up to the
11009 bottom of the window. */
11010 && it
.current_y
< it
.last_visible_y
)
11013 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
11015 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
11016 run
.current_y
= first_unchanged_at_end_row
->y
;
11017 run
.desired_y
= run
.current_y
+ dy
;
11018 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
11022 delta
= dvpos
= dy
= run
.current_y
= run
.desired_y
= run
.height
= 0;
11023 first_unchanged_at_end_row
= NULL
;
11025 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
11028 /* Find the cursor if not already found. We have to decide whether
11029 PT will appear on this window (it sometimes doesn't, but this is
11030 not a very frequent case.) This decision has to be made before
11031 the current matrix is altered. A value of cursor.vpos < 0 means
11032 that PT is either in one of the lines beginning at
11033 first_unchanged_at_end_row or below the window. Don't care for
11034 lines that might be displayed later at the window end; as
11035 mentioned, this is not a frequent case. */
11036 if (w
->cursor
.vpos
< 0)
11038 /* Cursor in unchanged rows at the top? */
11039 if (PT
< CHARPOS (start_pos
)
11040 && last_unchanged_at_beg_row
)
11042 row
= row_containing_pos (w
, PT
,
11043 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
11044 last_unchanged_at_beg_row
+ 1);
11046 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
11049 /* Start from first_unchanged_at_end_row looking for PT. */
11050 else if (first_unchanged_at_end_row
)
11052 row
= row_containing_pos (w
, PT
- delta
,
11053 first_unchanged_at_end_row
, NULL
);
11055 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
11056 delta_bytes
, dy
, dvpos
);
11059 /* Give up if cursor was not found. */
11060 if (w
->cursor
.vpos
< 0)
11062 clear_glyph_matrix (w
->desired_matrix
);
11067 /* Don't let the cursor end in the scroll margins. */
11069 int this_scroll_margin
, cursor_height
;
11071 this_scroll_margin
= max (0, scroll_margin
);
11072 this_scroll_margin
= min (this_scroll_margin
,
11073 XFASTINT (w
->height
) / 4);
11074 this_scroll_margin
*= CANON_Y_UNIT (it
.f
);
11075 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
11077 if ((w
->cursor
.y
< this_scroll_margin
11078 && CHARPOS (start
) > BEGV
)
11079 /* Don't take scroll margin into account at the bottom because
11080 old redisplay didn't do it either. */
11081 || w
->cursor
.y
+ cursor_height
> it
.last_visible_y
)
11083 w
->cursor
.vpos
= -1;
11084 clear_glyph_matrix (w
->desired_matrix
);
11089 /* Scroll the display. Do it before changing the current matrix so
11090 that xterm.c doesn't get confused about where the cursor glyph is
11092 if (dy
&& run
.height
)
11096 if (FRAME_WINDOW_P (f
))
11098 rif
->update_window_begin_hook (w
);
11099 rif
->clear_mouse_face (w
);
11100 rif
->scroll_run_hook (w
, &run
);
11101 rif
->update_window_end_hook (w
, 0, 0);
11105 /* Terminal frame. In this case, dvpos gives the number of
11106 lines to scroll by; dvpos < 0 means scroll up. */
11107 int first_unchanged_at_end_vpos
11108 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
11109 int from
= XFASTINT (w
->top
) + first_unchanged_at_end_vpos
;
11110 int end
= XFASTINT (w
->top
) + window_internal_height (w
);
11112 /* Perform the operation on the screen. */
11115 /* Scroll last_unchanged_at_beg_row to the end of the
11116 window down dvpos lines. */
11117 set_terminal_window (end
);
11119 /* On dumb terminals delete dvpos lines at the end
11120 before inserting dvpos empty lines. */
11121 if (!scroll_region_ok
)
11122 ins_del_lines (end
- dvpos
, -dvpos
);
11124 /* Insert dvpos empty lines in front of
11125 last_unchanged_at_beg_row. */
11126 ins_del_lines (from
, dvpos
);
11128 else if (dvpos
< 0)
11130 /* Scroll up last_unchanged_at_beg_vpos to the end of
11131 the window to last_unchanged_at_beg_vpos - |dvpos|. */
11132 set_terminal_window (end
);
11134 /* Delete dvpos lines in front of
11135 last_unchanged_at_beg_vpos. ins_del_lines will set
11136 the cursor to the given vpos and emit |dvpos| delete
11138 ins_del_lines (from
+ dvpos
, dvpos
);
11140 /* On a dumb terminal insert dvpos empty lines at the
11142 if (!scroll_region_ok
)
11143 ins_del_lines (end
+ dvpos
, -dvpos
);
11146 set_terminal_window (0);
11152 /* Shift reused rows of the current matrix to the right position.
11153 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
11155 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
11156 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
11159 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
11160 bottom_vpos
, dvpos
);
11161 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
11164 else if (dvpos
> 0)
11166 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
11167 bottom_vpos
, dvpos
);
11168 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
11169 first_unchanged_at_end_vpos
+ dvpos
, 0);
11172 /* For frame-based redisplay, make sure that current frame and window
11173 matrix are in sync with respect to glyph memory. */
11174 if (!FRAME_WINDOW_P (f
))
11175 sync_frame_with_window_matrix_rows (w
);
11177 /* Adjust buffer positions in reused rows. */
11179 increment_matrix_positions (current_matrix
,
11180 first_unchanged_at_end_vpos
+ dvpos
,
11181 bottom_vpos
, delta
, delta_bytes
);
11183 /* Adjust Y positions. */
11185 shift_glyph_matrix (w
, current_matrix
,
11186 first_unchanged_at_end_vpos
+ dvpos
,
11189 if (first_unchanged_at_end_row
)
11190 first_unchanged_at_end_row
+= dvpos
;
11192 /* If scrolling up, there may be some lines to display at the end of
11194 last_text_row_at_end
= NULL
;
11197 /* Set last_row to the glyph row in the current matrix where the
11198 window end line is found. It has been moved up or down in
11199 the matrix by dvpos. */
11200 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
11201 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
11203 /* If last_row is the window end line, it should display text. */
11204 xassert (last_row
->displays_text_p
);
11206 /* If window end line was partially visible before, begin
11207 displaying at that line. Otherwise begin displaying with the
11208 line following it. */
11209 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
11211 init_to_row_start (&it
, w
, last_row
);
11212 it
.vpos
= last_vpos
;
11213 it
.current_y
= last_row
->y
;
11217 init_to_row_end (&it
, w
, last_row
);
11218 it
.vpos
= 1 + last_vpos
;
11219 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
11223 /* We may start in a continuation line. If so, we have to get
11224 the right continuation_lines_width and current_x. */
11225 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
11226 it
.hpos
= it
.current_x
= 0;
11228 /* Display the rest of the lines at the window end. */
11229 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
11230 while (it
.current_y
< it
.last_visible_y
11231 && !fonts_changed_p
)
11233 /* Is it always sure that the display agrees with lines in
11234 the current matrix? I don't think so, so we mark rows
11235 displayed invalid in the current matrix by setting their
11236 enabled_p flag to zero. */
11237 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
11238 if (display_line (&it
))
11239 last_text_row_at_end
= it
.glyph_row
- 1;
11243 /* Update window_end_pos and window_end_vpos. */
11244 if (first_unchanged_at_end_row
11245 && first_unchanged_at_end_row
->y
< it
.last_visible_y
11246 && !last_text_row_at_end
)
11248 /* Window end line if one of the preserved rows from the current
11249 matrix. Set row to the last row displaying text in current
11250 matrix starting at first_unchanged_at_end_row, after
11252 xassert (first_unchanged_at_end_row
->displays_text_p
);
11253 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
11254 first_unchanged_at_end_row
);
11255 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
11257 XSETFASTINT (w
->window_end_pos
, Z
- MATRIX_ROW_END_CHARPOS (row
));
11258 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
11259 XSETFASTINT (w
->window_end_vpos
,
11260 MATRIX_ROW_VPOS (row
, w
->current_matrix
));
11262 else if (last_text_row_at_end
)
11264 XSETFASTINT (w
->window_end_pos
,
11265 Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
11266 w
->window_end_bytepos
11267 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
11268 XSETFASTINT (w
->window_end_vpos
,
11269 MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
11271 else if (last_text_row
)
11273 /* We have displayed either to the end of the window or at the
11274 end of the window, i.e. the last row with text is to be found
11275 in the desired matrix. */
11276 XSETFASTINT (w
->window_end_pos
,
11277 Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
11278 w
->window_end_bytepos
11279 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
11280 XSETFASTINT (w
->window_end_vpos
,
11281 MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
11283 else if (first_unchanged_at_end_row
== NULL
11284 && last_text_row
== NULL
11285 && last_text_row_at_end
== NULL
)
11287 /* Displayed to end of window, but no line containing text was
11288 displayed. Lines were deleted at the end of the window. */
11290 int header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
11292 for (vpos
= XFASTINT (w
->window_end_vpos
); vpos
> 0; --vpos
)
11293 if ((w
->desired_matrix
->rows
[vpos
+ header_line_p
].enabled_p
11294 && w
->desired_matrix
->rows
[vpos
+ header_line_p
].displays_text_p
)
11295 || (!w
->desired_matrix
->rows
[vpos
+ header_line_p
].enabled_p
11296 && w
->current_matrix
->rows
[vpos
+ header_line_p
].displays_text_p
))
11299 w
->window_end_vpos
= make_number (vpos
);
11304 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
11305 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
11307 /* Record that display has not been completed. */
11308 w
->window_end_valid
= Qnil
;
11309 w
->desired_matrix
->no_scrolling_p
= 1;
11315 /***********************************************************************
11316 More debugging support
11317 ***********************************************************************/
11321 void dump_glyph_row
P_ ((struct glyph_matrix
*, int, int));
11322 void dump_glyph_matrix
P_ ((struct glyph_matrix
*, int));
11325 /* Dump the contents of glyph matrix MATRIX on stderr.
11327 GLYPHS 0 means don't show glyph contents.
11328 GLYPHS 1 means show glyphs in short form
11329 GLYPHS > 1 means show glyphs in long form. */
11332 dump_glyph_matrix (matrix
, glyphs
)
11333 struct glyph_matrix
*matrix
;
11337 for (i
= 0; i
< matrix
->nrows
; ++i
)
11338 dump_glyph_row (matrix
, i
, glyphs
);
11342 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
11343 GLYPHS 0 means don't show glyph contents.
11344 GLYPHS 1 means show glyphs in short form
11345 GLYPHS > 1 means show glyphs in long form. */
11348 dump_glyph_row (matrix
, vpos
, glyphs
)
11349 struct glyph_matrix
*matrix
;
11352 struct glyph_row
*row
;
11354 if (vpos
< 0 || vpos
>= matrix
->nrows
)
11357 row
= MATRIX_ROW (matrix
, vpos
);
11361 fprintf (stderr
, "Row Start End Used oEI><O\\CTZFes X Y W H V A P\n");
11362 fprintf (stderr
, "=======================================================================\n");
11364 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d\
11365 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
11366 row
- matrix
->rows
,
11367 MATRIX_ROW_START_CHARPOS (row
),
11368 MATRIX_ROW_END_CHARPOS (row
),
11369 row
->used
[TEXT_AREA
],
11370 row
->contains_overlapping_glyphs_p
,
11373 row
->truncated_on_left_p
,
11374 row
->truncated_on_right_p
,
11375 row
->overlay_arrow_p
,
11377 MATRIX_ROW_CONTINUATION_LINE_P (row
),
11378 row
->displays_text_p
,
11381 row
->ends_in_middle_of_char_p
,
11382 row
->starts_in_middle_of_char_p
,
11387 row
->visible_height
,
11390 fprintf (stderr
, "%9d %5d\n", row
->start
.overlay_string_index
,
11391 row
->end
.overlay_string_index
);
11392 fprintf (stderr
, "%9d %5d\n",
11393 CHARPOS (row
->start
.string_pos
),
11394 CHARPOS (row
->end
.string_pos
));
11395 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
11396 row
->end
.dpvec_index
);
11401 struct glyph
*glyph
, *glyph_end
;
11402 int prev_had_glyphs_p
;
11404 glyph
= row
->glyphs
[TEXT_AREA
];
11405 glyph_end
= glyph
+ row
->used
[TEXT_AREA
];
11407 /* Glyph for a line end in text. */
11408 if (glyph
== glyph_end
&& glyph
->charpos
> 0)
11411 if (glyph
< glyph_end
)
11413 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
11414 prev_had_glyphs_p
= 1;
11417 prev_had_glyphs_p
= 0;
11419 while (glyph
< glyph_end
)
11421 if (glyph
->type
== CHAR_GLYPH
)
11424 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
11425 glyph
- row
->glyphs
[TEXT_AREA
],
11428 (BUFFERP (glyph
->object
)
11430 : (STRINGP (glyph
->object
)
11433 glyph
->pixel_width
,
11435 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
11439 glyph
->left_box_line_p
,
11440 glyph
->right_box_line_p
);
11442 else if (glyph
->type
== STRETCH_GLYPH
)
11445 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
11446 glyph
- row
->glyphs
[TEXT_AREA
],
11449 (BUFFERP (glyph
->object
)
11451 : (STRINGP (glyph
->object
)
11454 glyph
->pixel_width
,
11458 glyph
->left_box_line_p
,
11459 glyph
->right_box_line_p
);
11461 else if (glyph
->type
== IMAGE_GLYPH
)
11464 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
11465 glyph
- row
->glyphs
[TEXT_AREA
],
11468 (BUFFERP (glyph
->object
)
11470 : (STRINGP (glyph
->object
)
11473 glyph
->pixel_width
,
11477 glyph
->left_box_line_p
,
11478 glyph
->right_box_line_p
);
11483 else if (glyphs
== 1)
11485 char *s
= (char *) alloca (row
->used
[TEXT_AREA
] + 1);
11488 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
11490 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + i
;
11491 if (glyph
->type
== CHAR_GLYPH
11492 && glyph
->u
.ch
< 0x80
11493 && glyph
->u
.ch
>= ' ')
11494 s
[i
] = glyph
->u
.ch
;
11500 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
11505 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
11506 Sdump_glyph_matrix
, 0, 1, "p",
11507 "Dump the current matrix of the selected window to stderr.\n\
11508 Shows contents of glyph row structures. With non-nil\n\
11509 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show\n\
11510 glyphs in short form, otherwise show glyphs in long form.")
11512 Lisp_Object glyphs
;
11514 struct window
*w
= XWINDOW (selected_window
);
11515 struct buffer
*buffer
= XBUFFER (w
->buffer
);
11517 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
11518 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
11519 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
11520 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
11521 fprintf (stderr
, "=============================================\n");
11522 dump_glyph_matrix (w
->current_matrix
,
11523 NILP (glyphs
) ? 0 : XINT (glyphs
));
11528 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 1, "",
11529 "Dump glyph row ROW to stderr.")
11533 CHECK_NUMBER (row
, 0);
11534 dump_glyph_row (XWINDOW (selected_window
)->current_matrix
, XINT (row
), 1);
11539 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
,
11543 struct frame
*sf
= SELECTED_FRAME ();
11544 struct glyph_matrix
*m
= (XWINDOW (sf
->tool_bar_window
)
11546 dump_glyph_row (m
, 0, 1);
11551 DEFUN ("trace-redisplay-toggle", Ftrace_redisplay_toggle
,
11552 Strace_redisplay_toggle
, 0, 0, "",
11553 "Toggle tracing of redisplay.")
11556 trace_redisplay_p
= !trace_redisplay_p
;
11561 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, 1, "",
11562 "Print STRING to stderr.")
11564 Lisp_Object string
;
11566 CHECK_STRING (string
, 0);
11567 fprintf (stderr
, "%s", XSTRING (string
)->data
);
11571 #endif /* GLYPH_DEBUG */
11575 /***********************************************************************
11576 Building Desired Matrix Rows
11577 ***********************************************************************/
11579 /* Return a temporary glyph row holding the glyphs of an overlay
11580 arrow. Only used for non-window-redisplay windows. */
11582 static struct glyph_row
*
11583 get_overlay_arrow_glyph_row (w
)
11586 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
11587 struct buffer
*buffer
= XBUFFER (w
->buffer
);
11588 struct buffer
*old
= current_buffer
;
11589 unsigned char *arrow_string
= XSTRING (Voverlay_arrow_string
)->data
;
11590 int arrow_len
= XSTRING (Voverlay_arrow_string
)->size
;
11591 unsigned char *arrow_end
= arrow_string
+ arrow_len
;
11595 int n_glyphs_before
;
11597 set_buffer_temp (buffer
);
11598 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
11599 it
.glyph_row
->used
[TEXT_AREA
] = 0;
11600 SET_TEXT_POS (it
.position
, 0, 0);
11602 multibyte_p
= !NILP (buffer
->enable_multibyte_characters
);
11604 while (p
< arrow_end
)
11606 Lisp_Object face
, ilisp
;
11608 /* Get the next character. */
11610 it
.c
= string_char_and_length (p
, arrow_len
, &it
.len
);
11612 it
.c
= *p
, it
.len
= 1;
11615 /* Get its face. */
11616 XSETFASTINT (ilisp
, p
- arrow_string
);
11617 face
= Fget_text_property (ilisp
, Qface
, Voverlay_arrow_string
);
11618 it
.face_id
= compute_char_face (f
, it
.c
, face
);
11620 /* Compute its width, get its glyphs. */
11621 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
11622 SET_TEXT_POS (it
.position
, -1, -1);
11623 PRODUCE_GLYPHS (&it
);
11625 /* If this character doesn't fit any more in the line, we have
11626 to remove some glyphs. */
11627 if (it
.current_x
> it
.last_visible_x
)
11629 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
11634 set_buffer_temp (old
);
11635 return it
.glyph_row
;
11639 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
11640 glyphs are only inserted for terminal frames since we can't really
11641 win with truncation glyphs when partially visible glyphs are
11642 involved. Which glyphs to insert is determined by
11643 produce_special_glyphs. */
11646 insert_left_trunc_glyphs (it
)
11649 struct it truncate_it
;
11650 struct glyph
*from
, *end
, *to
, *toend
;
11652 xassert (!FRAME_WINDOW_P (it
->f
));
11654 /* Get the truncation glyphs. */
11656 truncate_it
.current_x
= 0;
11657 truncate_it
.face_id
= DEFAULT_FACE_ID
;
11658 truncate_it
.glyph_row
= &scratch_glyph_row
;
11659 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
11660 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
11661 truncate_it
.object
= make_number (0);
11662 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
11664 /* Overwrite glyphs from IT with truncation glyphs. */
11665 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
11666 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
11667 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
11668 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
11673 /* There may be padding glyphs left over. Remove them. */
11675 while (from
< toend
&& CHAR_GLYPH_PADDING_P (*from
))
11677 while (from
< toend
)
11680 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
11684 /* Compute the pixel height and width of IT->glyph_row.
11686 Most of the time, ascent and height of a display line will be equal
11687 to the max_ascent and max_height values of the display iterator
11688 structure. This is not the case if
11690 1. We hit ZV without displaying anything. In this case, max_ascent
11691 and max_height will be zero.
11693 2. We have some glyphs that don't contribute to the line height.
11694 (The glyph row flag contributes_to_line_height_p is for future
11695 pixmap extensions).
11697 The first case is easily covered by using default values because in
11698 these cases, the line height does not really matter, except that it
11699 must not be zero. */
11702 compute_line_metrics (it
)
11705 struct glyph_row
*row
= it
->glyph_row
;
11708 if (FRAME_WINDOW_P (it
->f
))
11710 int i
, header_line_height
;
11712 /* The line may consist of one space only, that was added to
11713 place the cursor on it. If so, the row's height hasn't been
11715 if (row
->height
== 0)
11717 if (it
->max_ascent
+ it
->max_descent
== 0)
11718 it
->max_descent
= it
->max_phys_descent
= CANON_Y_UNIT (it
->f
);
11719 row
->ascent
= it
->max_ascent
;
11720 row
->height
= it
->max_ascent
+ it
->max_descent
;
11721 row
->phys_ascent
= it
->max_phys_ascent
;
11722 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
11725 /* Compute the width of this line. */
11726 row
->pixel_width
= row
->x
;
11727 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
11728 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
11730 xassert (row
->pixel_width
>= 0);
11731 xassert (row
->ascent
>= 0 && row
->height
> 0);
11733 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
11734 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
11736 /* If first line's physical ascent is larger than its logical
11737 ascent, use the physical ascent, and make the row taller.
11738 This makes accented characters fully visible. */
11739 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
11740 && row
->phys_ascent
> row
->ascent
)
11742 row
->height
+= row
->phys_ascent
- row
->ascent
;
11743 row
->ascent
= row
->phys_ascent
;
11746 /* Compute how much of the line is visible. */
11747 row
->visible_height
= row
->height
;
11749 header_line_height
= WINDOW_DISPLAY_HEADER_LINE_HEIGHT (it
->w
);
11750 if (row
->y
< header_line_height
)
11751 row
->visible_height
-= header_line_height
- row
->y
;
11754 int max_y
= WINDOW_DISPLAY_HEIGHT_NO_MODE_LINE (it
->w
);
11755 if (row
->y
+ row
->height
> max_y
)
11756 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
11761 row
->pixel_width
= row
->used
[TEXT_AREA
];
11762 row
->ascent
= row
->phys_ascent
= 0;
11763 row
->height
= row
->phys_height
= row
->visible_height
= 1;
11766 /* Compute a hash code for this row. */
11768 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
11769 for (i
= 0; i
< row
->used
[area
]; ++i
)
11770 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
11771 + row
->glyphs
[area
][i
].u
.val
11772 + row
->glyphs
[area
][i
].face_id
11773 + row
->glyphs
[area
][i
].padding_p
11774 + (row
->glyphs
[area
][i
].type
<< 2));
11776 it
->max_ascent
= it
->max_descent
= 0;
11777 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
11781 /* Append one space to the glyph row of iterator IT if doing a
11782 window-based redisplay. DEFAULT_FACE_P non-zero means let the
11783 space have the default face, otherwise let it have the same face as
11784 IT->face_id. Value is non-zero if a space was added.
11786 This function is called to make sure that there is always one glyph
11787 at the end of a glyph row that the cursor can be set on under
11788 window-systems. (If there weren't such a glyph we would not know
11789 how wide and tall a box cursor should be displayed).
11791 At the same time this space let's a nicely handle clearing to the
11792 end of the line if the row ends in italic text. */
11795 append_space (it
, default_face_p
)
11797 int default_face_p
;
11799 if (FRAME_WINDOW_P (it
->f
))
11801 int n
= it
->glyph_row
->used
[TEXT_AREA
];
11803 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
11804 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
11806 /* Save some values that must not be changed.
11807 Must save IT->c and IT->len because otherwise
11808 ITERATOR_AT_END_P wouldn't work anymore after
11809 append_space has been called. */
11810 int saved_what
= it
->what
;
11811 int saved_c
= it
->c
, saved_len
= it
->len
;
11812 int saved_x
= it
->current_x
;
11813 int saved_face_id
= it
->face_id
;
11814 struct text_pos saved_pos
;
11815 Lisp_Object saved_object
;
11818 saved_object
= it
->object
;
11819 saved_pos
= it
->position
;
11821 it
->what
= IT_CHARACTER
;
11822 bzero (&it
->position
, sizeof it
->position
);
11823 it
->object
= make_number (0);
11827 if (default_face_p
)
11828 it
->face_id
= DEFAULT_FACE_ID
;
11829 else if (it
->face_before_selective_p
)
11830 it
->face_id
= it
->saved_face_id
;
11831 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
11832 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0);
11834 PRODUCE_GLYPHS (it
);
11836 it
->current_x
= saved_x
;
11837 it
->object
= saved_object
;
11838 it
->position
= saved_pos
;
11839 it
->what
= saved_what
;
11840 it
->face_id
= saved_face_id
;
11841 it
->len
= saved_len
;
11851 /* Extend the face of the last glyph in the text area of IT->glyph_row
11852 to the end of the display line. Called from display_line.
11853 If the glyph row is empty, add a space glyph to it so that we
11854 know the face to draw. Set the glyph row flag fill_line_p. */
11857 extend_face_to_end_of_line (it
)
11861 struct frame
*f
= it
->f
;
11863 /* If line is already filled, do nothing. */
11864 if (it
->current_x
>= it
->last_visible_x
)
11867 /* Face extension extends the background and box of IT->face_id
11868 to the end of the line. If the background equals the background
11869 of the frame, we don't have to do anything. */
11870 if (it
->face_before_selective_p
)
11871 face
= FACE_FROM_ID (it
->f
, it
->saved_face_id
);
11873 face
= FACE_FROM_ID (f
, it
->face_id
);
11875 if (FRAME_WINDOW_P (f
)
11876 && face
->box
== FACE_NO_BOX
11877 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
11881 /* Set the glyph row flag indicating that the face of the last glyph
11882 in the text area has to be drawn to the end of the text area. */
11883 it
->glyph_row
->fill_line_p
= 1;
11885 /* If current character of IT is not ASCII, make sure we have the
11886 ASCII face. This will be automatically undone the next time
11887 get_next_display_element returns a multibyte character. Note
11888 that the character will always be single byte in unibyte text. */
11889 if (!SINGLE_BYTE_CHAR_P (it
->c
))
11891 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0);
11894 if (FRAME_WINDOW_P (f
))
11896 /* If the row is empty, add a space with the current face of IT,
11897 so that we know which face to draw. */
11898 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
11900 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
11901 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
11902 it
->glyph_row
->used
[TEXT_AREA
] = 1;
11907 /* Save some values that must not be changed. */
11908 int saved_x
= it
->current_x
;
11909 struct text_pos saved_pos
;
11910 Lisp_Object saved_object
;
11911 int saved_what
= it
->what
;
11912 int saved_face_id
= it
->face_id
;
11914 saved_object
= it
->object
;
11915 saved_pos
= it
->position
;
11917 it
->what
= IT_CHARACTER
;
11918 bzero (&it
->position
, sizeof it
->position
);
11919 it
->object
= make_number (0);
11922 it
->face_id
= face
->id
;
11924 PRODUCE_GLYPHS (it
);
11926 while (it
->current_x
<= it
->last_visible_x
)
11927 PRODUCE_GLYPHS (it
);
11929 /* Don't count these blanks really. It would let us insert a left
11930 truncation glyph below and make us set the cursor on them, maybe. */
11931 it
->current_x
= saved_x
;
11932 it
->object
= saved_object
;
11933 it
->position
= saved_pos
;
11934 it
->what
= saved_what
;
11935 it
->face_id
= saved_face_id
;
11940 /* Value is non-zero if text starting at CHARPOS in current_buffer is
11941 trailing whitespace. */
11944 trailing_whitespace_p (charpos
)
11947 int bytepos
= CHAR_TO_BYTE (charpos
);
11950 while (bytepos
< ZV_BYTE
11951 && (c
= FETCH_CHAR (bytepos
),
11952 c
== ' ' || c
== '\t'))
11955 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
11957 if (bytepos
!= PT_BYTE
)
11964 /* Highlight trailing whitespace, if any, in ROW. */
11967 highlight_trailing_whitespace (f
, row
)
11969 struct glyph_row
*row
;
11971 int used
= row
->used
[TEXT_AREA
];
11975 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
11976 struct glyph
*glyph
= start
+ used
- 1;
11978 /* Skip over the space glyph inserted to display the
11979 cursor at the end of a line. */
11980 if (glyph
->type
== CHAR_GLYPH
11981 && glyph
->u
.ch
== ' '
11982 && INTEGERP (glyph
->object
))
11985 /* If last glyph is a space or stretch, and it's trailing
11986 whitespace, set the face of all trailing whitespace glyphs in
11987 IT->glyph_row to `trailing-whitespace'. */
11989 && BUFFERP (glyph
->object
)
11990 && (glyph
->type
== STRETCH_GLYPH
11991 || (glyph
->type
== CHAR_GLYPH
11992 && glyph
->u
.ch
== ' '))
11993 && trailing_whitespace_p (glyph
->charpos
))
11995 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
11997 while (glyph
>= start
11998 && BUFFERP (glyph
->object
)
11999 && (glyph
->type
== STRETCH_GLYPH
12000 || (glyph
->type
== CHAR_GLYPH
12001 && glyph
->u
.ch
== ' ')))
12002 (glyph
--)->face_id
= face_id
;
12008 /* Value is non-zero if glyph row ROW in window W should be
12009 used to hold the cursor. */
12012 cursor_row_p (w
, row
)
12014 struct glyph_row
*row
;
12016 int cursor_row_p
= 1;
12018 if (PT
== MATRIX_ROW_END_CHARPOS (row
))
12020 /* If the row ends with a newline from a string, we don't want
12021 the cursor there (if the row is continued it doesn't end in a
12023 if (CHARPOS (row
->end
.string_pos
) >= 0
12024 || MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
12025 cursor_row_p
= row
->continued_p
;
12027 /* If the row ends at ZV, display the cursor at the end of that
12028 row instead of at the start of the row below. */
12029 else if (row
->ends_at_zv_p
)
12035 return cursor_row_p
;
12039 /* Construct the glyph row IT->glyph_row in the desired matrix of
12040 IT->w from text at the current position of IT. See dispextern.h
12041 for an overview of struct it. Value is non-zero if
12042 IT->glyph_row displays text, as opposed to a line displaying ZV
12049 struct glyph_row
*row
= it
->glyph_row
;
12051 /* We always start displaying at hpos zero even if hscrolled. */
12052 xassert (it
->hpos
== 0 && it
->current_x
== 0);
12054 /* We must not display in a row that's not a text row. */
12055 xassert (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
12056 < it
->w
->desired_matrix
->nrows
);
12058 /* Is IT->w showing the region? */
12059 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
12061 /* Clear the result glyph row and enable it. */
12062 prepare_desired_row (row
);
12064 row
->y
= it
->current_y
;
12065 row
->start
= it
->current
;
12066 row
->continuation_lines_width
= it
->continuation_lines_width
;
12067 row
->displays_text_p
= 1;
12068 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
12069 it
->starts_in_middle_of_char_p
= 0;
12071 /* Arrange the overlays nicely for our purposes. Usually, we call
12072 display_line on only one line at a time, in which case this
12073 can't really hurt too much, or we call it on lines which appear
12074 one after another in the buffer, in which case all calls to
12075 recenter_overlay_lists but the first will be pretty cheap. */
12076 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
12078 /* Move over display elements that are not visible because we are
12079 hscrolled. This may stop at an x-position < IT->first_visible_x
12080 if the first glyph is partially visible or if we hit a line end. */
12081 if (it
->current_x
< it
->first_visible_x
)
12082 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
12083 MOVE_TO_POS
| MOVE_TO_X
);
12085 /* Get the initial row height. This is either the height of the
12086 text hscrolled, if there is any, or zero. */
12087 row
->ascent
= it
->max_ascent
;
12088 row
->height
= it
->max_ascent
+ it
->max_descent
;
12089 row
->phys_ascent
= it
->max_phys_ascent
;
12090 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
12092 /* Loop generating characters. The loop is left with IT on the next
12093 character to display. */
12096 int n_glyphs_before
, hpos_before
, x_before
;
12098 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
12100 /* Retrieve the next thing to display. Value is zero if end of
12102 if (!get_next_display_element (it
))
12104 /* Maybe add a space at the end of this line that is used to
12105 display the cursor there under X. Set the charpos of the
12106 first glyph of blank lines not corresponding to any text
12108 if ((append_space (it
, 1) && row
->used
[TEXT_AREA
] == 1)
12109 || row
->used
[TEXT_AREA
] == 0)
12111 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
12112 row
->displays_text_p
= 0;
12114 if (!NILP (XBUFFER (it
->w
->buffer
)->indicate_empty_lines
))
12115 row
->indicate_empty_line_p
= 1;
12118 it
->continuation_lines_width
= 0;
12119 row
->ends_at_zv_p
= 1;
12123 /* Now, get the metrics of what we want to display. This also
12124 generates glyphs in `row' (which is IT->glyph_row). */
12125 n_glyphs_before
= row
->used
[TEXT_AREA
];
12128 /* Remember the line height so far in case the next element doesn't
12129 fit on the line. */
12130 if (!it
->truncate_lines_p
)
12132 ascent
= it
->max_ascent
;
12133 descent
= it
->max_descent
;
12134 phys_ascent
= it
->max_phys_ascent
;
12135 phys_descent
= it
->max_phys_descent
;
12138 PRODUCE_GLYPHS (it
);
12140 /* If this display element was in marginal areas, continue with
12142 if (it
->area
!= TEXT_AREA
)
12144 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
12145 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
12146 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
12147 row
->phys_height
= max (row
->phys_height
,
12148 it
->max_phys_ascent
+ it
->max_phys_descent
);
12149 set_iterator_to_next (it
, 1);
12153 /* Does the display element fit on the line? If we truncate
12154 lines, we should draw past the right edge of the window. If
12155 we don't truncate, we want to stop so that we can display the
12156 continuation glyph before the right margin. If lines are
12157 continued, there are two possible strategies for characters
12158 resulting in more than 1 glyph (e.g. tabs): Display as many
12159 glyphs as possible in this line and leave the rest for the
12160 continuation line, or display the whole element in the next
12161 line. Original redisplay did the former, so we do it also. */
12162 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
12163 hpos_before
= it
->hpos
;
12167 && it
->current_x
< it
->last_visible_x
)
12170 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
12171 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
12172 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
12173 row
->phys_height
= max (row
->phys_height
,
12174 it
->max_phys_ascent
+ it
->max_phys_descent
);
12175 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
12176 row
->x
= x
- it
->first_visible_x
;
12181 struct glyph
*glyph
;
12183 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
12185 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
12186 new_x
= x
+ glyph
->pixel_width
;
12188 if (/* Lines are continued. */
12189 !it
->truncate_lines_p
12190 && (/* Glyph doesn't fit on the line. */
12191 new_x
> it
->last_visible_x
12192 /* Or it fits exactly on a window system frame. */
12193 || (new_x
== it
->last_visible_x
12194 && FRAME_WINDOW_P (it
->f
))))
12196 /* End of a continued line. */
12199 || (new_x
== it
->last_visible_x
12200 && FRAME_WINDOW_P (it
->f
)))
12202 /* Current glyph is the only one on the line or
12203 fits exactly on the line. We must continue
12204 the line because we can't draw the cursor
12205 after the glyph. */
12206 row
->continued_p
= 1;
12207 it
->current_x
= new_x
;
12208 it
->continuation_lines_width
+= new_x
;
12210 if (i
== nglyphs
- 1)
12211 set_iterator_to_next (it
, 1);
12213 else if (CHAR_GLYPH_PADDING_P (*glyph
)
12214 && !FRAME_WINDOW_P (it
->f
))
12216 /* A padding glyph that doesn't fit on this line.
12217 This means the whole character doesn't fit
12219 row
->used
[TEXT_AREA
] = n_glyphs_before
;
12221 /* Fill the rest of the row with continuation
12222 glyphs like in 20.x. */
12223 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
12224 < row
->glyphs
[1 + TEXT_AREA
])
12225 produce_special_glyphs (it
, IT_CONTINUATION
);
12227 row
->continued_p
= 1;
12228 it
->current_x
= x_before
;
12229 it
->continuation_lines_width
+= x_before
;
12231 /* Restore the height to what it was before the
12232 element not fitting on the line. */
12233 it
->max_ascent
= ascent
;
12234 it
->max_descent
= descent
;
12235 it
->max_phys_ascent
= phys_ascent
;
12236 it
->max_phys_descent
= phys_descent
;
12240 /* Display element draws past the right edge of
12241 the window. Restore positions to values
12242 before the element. The next line starts
12243 with current_x before the glyph that could
12244 not be displayed, so that TAB works right. */
12245 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
12247 /* Display continuation glyphs. */
12248 if (!FRAME_WINDOW_P (it
->f
))
12249 produce_special_glyphs (it
, IT_CONTINUATION
);
12250 row
->continued_p
= 1;
12253 it
->continuation_lines_width
+= x
;
12254 if (nglyphs
> 1 && i
> 0)
12256 row
->ends_in_middle_of_char_p
= 1;
12257 it
->starts_in_middle_of_char_p
= 1;
12260 /* Restore the height to what it was before the
12261 element not fitting on the line. */
12262 it
->max_ascent
= ascent
;
12263 it
->max_descent
= descent
;
12264 it
->max_phys_ascent
= phys_ascent
;
12265 it
->max_phys_descent
= phys_descent
;
12270 else if (new_x
> it
->first_visible_x
)
12272 /* Increment number of glyphs actually displayed. */
12275 if (x
< it
->first_visible_x
)
12276 /* Glyph is partially visible, i.e. row starts at
12277 negative X position. */
12278 row
->x
= x
- it
->first_visible_x
;
12282 /* Glyph is completely off the left margin of the
12283 window. This should not happen because of the
12284 move_it_in_display_line at the start of
12290 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
12291 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
12292 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
12293 row
->phys_height
= max (row
->phys_height
,
12294 it
->max_phys_ascent
+ it
->max_phys_descent
);
12296 /* End of this display line if row is continued. */
12297 if (row
->continued_p
)
12301 /* Is this a line end? If yes, we're also done, after making
12302 sure that a non-default face is extended up to the right
12303 margin of the window. */
12304 if (ITERATOR_AT_END_OF_LINE_P (it
))
12306 int used_before
= row
->used
[TEXT_AREA
];
12308 /* Add a space at the end of the line that is used to
12309 display the cursor there. */
12310 append_space (it
, 0);
12312 /* Extend the face to the end of the line. */
12313 extend_face_to_end_of_line (it
);
12315 /* Make sure we have the position. */
12316 if (used_before
== 0)
12317 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
12319 /* Consume the line end. This skips over invisible lines. */
12320 set_iterator_to_next (it
, 1);
12321 it
->continuation_lines_width
= 0;
12325 /* Proceed with next display element. Note that this skips
12326 over lines invisible because of selective display. */
12327 set_iterator_to_next (it
, 1);
12329 /* If we truncate lines, we are done when the last displayed
12330 glyphs reach past the right margin of the window. */
12331 if (it
->truncate_lines_p
12332 && (FRAME_WINDOW_P (it
->f
)
12333 ? (it
->current_x
>= it
->last_visible_x
)
12334 : (it
->current_x
> it
->last_visible_x
)))
12336 /* Maybe add truncation glyphs. */
12337 if (!FRAME_WINDOW_P (it
->f
))
12339 --it
->glyph_row
->used
[TEXT_AREA
];
12340 produce_special_glyphs (it
, IT_TRUNCATION
);
12343 row
->truncated_on_right_p
= 1;
12344 it
->continuation_lines_width
= 0;
12345 reseat_at_next_visible_line_start (it
, 0);
12346 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
12347 it
->hpos
= hpos_before
;
12348 it
->current_x
= x_before
;
12353 /* If line is not empty and hscrolled, maybe insert truncation glyphs
12354 at the left window margin. */
12355 if (it
->first_visible_x
12356 && IT_CHARPOS (*it
) != MATRIX_ROW_START_CHARPOS (row
))
12358 if (!FRAME_WINDOW_P (it
->f
))
12359 insert_left_trunc_glyphs (it
);
12360 row
->truncated_on_left_p
= 1;
12363 /* If the start of this line is the overlay arrow-position, then
12364 mark this glyph row as the one containing the overlay arrow.
12365 This is clearly a mess with variable size fonts. It would be
12366 better to let it be displayed like cursors under X. */
12367 if (MARKERP (Voverlay_arrow_position
)
12368 && current_buffer
== XMARKER (Voverlay_arrow_position
)->buffer
12369 && (MATRIX_ROW_START_CHARPOS (row
)
12370 == marker_position (Voverlay_arrow_position
))
12371 && STRINGP (Voverlay_arrow_string
)
12372 && ! overlay_arrow_seen
)
12374 /* Overlay arrow in window redisplay is a bitmap. */
12375 if (!FRAME_WINDOW_P (it
->f
))
12377 struct glyph_row
*arrow_row
= get_overlay_arrow_glyph_row (it
->w
);
12378 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
12379 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
12380 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
12381 struct glyph
*p2
, *end
;
12383 /* Copy the arrow glyphs. */
12384 while (glyph
< arrow_end
)
12387 /* Throw away padding glyphs. */
12389 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
12390 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
12396 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
12400 overlay_arrow_seen
= 1;
12401 row
->overlay_arrow_p
= 1;
12404 /* Compute pixel dimensions of this line. */
12405 compute_line_metrics (it
);
12407 /* Remember the position at which this line ends. */
12408 row
->end
= it
->current
;
12410 /* Maybe set the cursor. */
12411 if (it
->w
->cursor
.vpos
< 0
12412 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
12413 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
12414 && cursor_row_p (it
->w
, row
))
12415 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
12417 /* Highlight trailing whitespace. */
12418 if (!NILP (Vshow_trailing_whitespace
))
12419 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
12421 /* Prepare for the next line. This line starts horizontally at (X
12422 HPOS) = (0 0). Vertical positions are incremented. As a
12423 convenience for the caller, IT->glyph_row is set to the next
12425 it
->current_x
= it
->hpos
= 0;
12426 it
->current_y
+= row
->height
;
12429 return row
->displays_text_p
;
12434 /***********************************************************************
12436 ***********************************************************************/
12438 /* Redisplay the menu bar in the frame for window W.
12440 The menu bar of X frames that don't have X toolkit support is
12441 displayed in a special window W->frame->menu_bar_window.
12443 The menu bar of terminal frames is treated specially as far as
12444 glyph matrices are concerned. Menu bar lines are not part of
12445 windows, so the update is done directly on the frame matrix rows
12446 for the menu bar. */
12449 display_menu_bar (w
)
12452 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
12457 /* Don't do all this for graphical frames. */
12459 if (!NILP (Vwindow_system
))
12462 #ifdef USE_X_TOOLKIT
12467 if (FRAME_MAC_P (f
))
12471 #ifdef USE_X_TOOLKIT
12472 xassert (!FRAME_WINDOW_P (f
));
12473 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
12474 it
.first_visible_x
= 0;
12475 it
.last_visible_x
= FRAME_WINDOW_WIDTH (f
) * CANON_X_UNIT (f
);
12476 #else /* not USE_X_TOOLKIT */
12477 if (FRAME_WINDOW_P (f
))
12479 /* Menu bar lines are displayed in the desired matrix of the
12480 dummy window menu_bar_window. */
12481 struct window
*menu_w
;
12482 xassert (WINDOWP (f
->menu_bar_window
));
12483 menu_w
= XWINDOW (f
->menu_bar_window
);
12484 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
12486 it
.first_visible_x
= 0;
12487 it
.last_visible_x
= FRAME_WINDOW_WIDTH (f
) * CANON_X_UNIT (f
);
12491 /* This is a TTY frame, i.e. character hpos/vpos are used as
12493 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
12495 it
.first_visible_x
= 0;
12496 it
.last_visible_x
= FRAME_WIDTH (f
);
12498 #endif /* not USE_X_TOOLKIT */
12500 if (! mode_line_inverse_video
)
12501 /* Force the menu-bar to be displayed in the default face. */
12502 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
12504 /* Clear all rows of the menu bar. */
12505 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
12507 struct glyph_row
*row
= it
.glyph_row
+ i
;
12508 clear_glyph_row (row
);
12509 row
->enabled_p
= 1;
12510 row
->full_width_p
= 1;
12513 /* Display all items of the menu bar. */
12514 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
12515 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
12517 Lisp_Object string
;
12519 /* Stop at nil string. */
12520 string
= XVECTOR (items
)->contents
[i
+ 1];
12524 /* Remember where item was displayed. */
12525 XSETFASTINT (XVECTOR (items
)->contents
[i
+ 3], it
.hpos
);
12527 /* Display the item, pad with one space. */
12528 if (it
.current_x
< it
.last_visible_x
)
12529 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
12530 XSTRING (string
)->size
+ 1, 0, 0, -1);
12533 /* Fill out the line with spaces. */
12534 if (it
.current_x
< it
.last_visible_x
)
12535 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
12537 /* Compute the total height of the lines. */
12538 compute_line_metrics (&it
);
12543 /***********************************************************************
12545 ***********************************************************************/
12547 /* Redisplay mode lines in the window tree whose root is WINDOW. If
12548 FORCE is non-zero, redisplay mode lines unconditionally.
12549 Otherwise, redisplay only mode lines that are garbaged. Value is
12550 the number of windows whose mode lines were redisplayed. */
12553 redisplay_mode_lines (window
, force
)
12554 Lisp_Object window
;
12559 while (!NILP (window
))
12561 struct window
*w
= XWINDOW (window
);
12563 if (WINDOWP (w
->hchild
))
12564 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
12565 else if (WINDOWP (w
->vchild
))
12566 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
12568 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
12569 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
12571 Lisp_Object old_selected_frame
;
12572 struct text_pos lpoint
;
12573 struct buffer
*old
= current_buffer
;
12575 /* Set the window's buffer for the mode line display. */
12576 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
12577 set_buffer_internal_1 (XBUFFER (w
->buffer
));
12579 /* Point refers normally to the selected window. For any
12580 other window, set up appropriate value. */
12581 if (!EQ (window
, selected_window
))
12583 struct text_pos pt
;
12585 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
12586 if (CHARPOS (pt
) < BEGV
)
12587 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
12588 else if (CHARPOS (pt
) > (ZV
- 1))
12589 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
12591 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
12594 /* Temporarily set up the selected frame. */
12595 old_selected_frame
= selected_frame
;
12596 selected_frame
= w
->frame
;
12598 /* Display mode lines. */
12599 clear_glyph_matrix (w
->desired_matrix
);
12600 if (display_mode_lines (w
))
12603 w
->must_be_updated_p
= 1;
12606 /* Restore old settings. */
12607 selected_frame
= old_selected_frame
;
12608 set_buffer_internal_1 (old
);
12609 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
12619 /* Display the mode and/or top line of window W. Value is the number
12620 of mode lines displayed. */
12623 display_mode_lines (w
)
12628 /* These will be set while the mode line specs are processed. */
12629 line_number_displayed
= 0;
12630 w
->column_number_displayed
= Qnil
;
12632 if (WINDOW_WANTS_MODELINE_P (w
))
12634 display_mode_line (w
, MODE_LINE_FACE_ID
,
12635 current_buffer
->mode_line_format
);
12639 if (WINDOW_WANTS_HEADER_LINE_P (w
))
12641 display_mode_line (w
, HEADER_LINE_FACE_ID
,
12642 current_buffer
->header_line_format
);
12650 /* Display mode or top line of window W. FACE_ID specifies which line
12651 to display; it is either MODE_LINE_FACE_ID or HEADER_LINE_FACE_ID.
12652 FORMAT is the mode line format to display. Value is the pixel
12653 height of the mode line displayed. */
12656 display_mode_line (w
, face_id
, format
)
12658 enum face_id face_id
;
12659 Lisp_Object format
;
12664 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
12665 prepare_desired_row (it
.glyph_row
);
12667 if (! mode_line_inverse_video
)
12668 /* Force the mode-line to be displayed in the default face. */
12669 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
12671 /* Temporarily make frame's keyboard the current kboard so that
12672 kboard-local variables in the mode_line_format will get the right
12674 push_frame_kboard (it
.f
);
12675 display_mode_element (&it
, 0, 0, 0, format
);
12676 pop_frame_kboard ();
12678 /* Fill up with spaces. */
12679 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
12681 compute_line_metrics (&it
);
12682 it
.glyph_row
->full_width_p
= 1;
12683 it
.glyph_row
->mode_line_p
= 1;
12684 it
.glyph_row
->inverse_p
= 0;
12685 it
.glyph_row
->continued_p
= 0;
12686 it
.glyph_row
->truncated_on_left_p
= 0;
12687 it
.glyph_row
->truncated_on_right_p
= 0;
12689 /* Make a 3D mode-line have a shadow at its right end. */
12690 face
= FACE_FROM_ID (it
.f
, face_id
);
12691 extend_face_to_end_of_line (&it
);
12692 if (face
->box
!= FACE_NO_BOX
)
12694 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
12695 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
12696 last
->right_box_line_p
= 1;
12699 return it
.glyph_row
->height
;
12703 /* Contribute ELT to the mode line for window IT->w. How it
12704 translates into text depends on its data type.
12706 IT describes the display environment in which we display, as usual.
12708 DEPTH is the depth in recursion. It is used to prevent
12709 infinite recursion here.
12711 FIELD_WIDTH is the number of characters the display of ELT should
12712 occupy in the mode line, and PRECISION is the maximum number of
12713 characters to display from ELT's representation. See
12714 display_string for details. *
12716 Returns the hpos of the end of the text generated by ELT. */
12719 display_mode_element (it
, depth
, field_width
, precision
, elt
)
12722 int field_width
, precision
;
12725 int n
= 0, field
, prec
;
12733 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
12737 /* A string: output it and check for %-constructs within it. */
12739 unsigned char *this = XSTRING (elt
)->data
;
12740 unsigned char *lisp_string
= this;
12742 while ((precision
<= 0 || n
< precision
)
12744 && (frame_title_ptr
12745 || it
->current_x
< it
->last_visible_x
))
12747 unsigned char *last
= this;
12749 /* Advance to end of string or next format specifier. */
12750 while ((c
= *this++) != '\0' && c
!= '%')
12753 if (this - 1 != last
)
12755 /* Output to end of string or up to '%'. Field width
12756 is length of string. Don't output more than
12757 PRECISION allows us. */
12758 prec
= --this - last
;
12759 if (precision
> 0 && prec
> precision
- n
)
12760 prec
= precision
- n
;
12762 if (frame_title_ptr
)
12763 n
+= store_frame_title (last
, prec
, prec
);
12765 n
+= display_string (NULL
, elt
, Qnil
, 0, last
- lisp_string
,
12766 it
, 0, prec
, 0, -1);
12768 else /* c == '%' */
12770 unsigned char *percent_position
= this;
12772 /* Get the specified minimum width. Zero means
12775 while ((c
= *this++) >= '0' && c
<= '9')
12776 field
= field
* 10 + c
- '0';
12778 /* Don't pad beyond the total padding allowed. */
12779 if (field_width
- n
> 0 && field
> field_width
- n
)
12780 field
= field_width
- n
;
12782 /* Note that either PRECISION <= 0 or N < PRECISION. */
12783 prec
= precision
- n
;
12786 n
+= display_mode_element (it
, depth
, field
, prec
,
12787 Vglobal_mode_string
);
12790 unsigned char *spec
12791 = decode_mode_spec (it
->w
, c
, field
, prec
);
12793 if (frame_title_ptr
)
12794 n
+= store_frame_title (spec
, field
, prec
);
12798 = it
->glyph_row
->used
[TEXT_AREA
];
12800 = percent_position
- XSTRING (elt
)->data
;
12802 = display_string (spec
, Qnil
, elt
, charpos
, 0, it
,
12803 field
, prec
, 0, -1);
12805 /* Assign to the glyphs written above the
12806 string where the `%x' came from, position
12810 struct glyph
*glyph
12811 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
12815 for (i
= 0; i
< nwritten
; ++i
)
12817 glyph
[i
].object
= elt
;
12818 glyph
[i
].charpos
= charpos
;
12831 /* A symbol: process the value of the symbol recursively
12832 as if it appeared here directly. Avoid error if symbol void.
12833 Special case: if value of symbol is a string, output the string
12836 register Lisp_Object tem
;
12837 tem
= Fboundp (elt
);
12840 tem
= Fsymbol_value (elt
);
12841 /* If value is a string, output that string literally:
12842 don't check for % within it. */
12845 prec
= XSTRING (tem
)->size
;
12846 if (precision
> 0 && prec
> precision
- n
)
12847 prec
= precision
- n
;
12848 if (frame_title_ptr
)
12849 n
+= store_frame_title (XSTRING (tem
)->data
, -1, prec
);
12851 n
+= display_string (NULL
, tem
, Qnil
, 0, 0, it
,
12854 else if (!EQ (tem
, elt
))
12856 /* Give up right away for nil or t. */
12866 register Lisp_Object car
, tem
;
12868 /* A cons cell: three distinct cases.
12869 If first element is a string or a cons, process all the elements
12870 and effectively concatenate them.
12871 If first element is a negative number, truncate displaying cdr to
12872 at most that many characters. If positive, pad (with spaces)
12873 to at least that many characters.
12874 If first element is a symbol, process the cadr or caddr recursively
12875 according to whether the symbol's value is non-nil or nil. */
12877 if (EQ (car
, QCeval
) && CONSP (XCDR (elt
)))
12879 /* An element of the form (:eval FORM) means evaluate FORM
12880 and use the result as mode line elements. */
12881 struct gcpro gcpro1
;
12884 spec
= safe_eval (XCAR (XCDR (elt
)));
12886 n
+= display_mode_element (it
, depth
, field_width
- n
,
12887 precision
- n
, spec
);
12890 else if (SYMBOLP (car
))
12892 tem
= Fboundp (car
);
12896 /* elt is now the cdr, and we know it is a cons cell.
12897 Use its car if CAR has a non-nil value. */
12900 tem
= Fsymbol_value (car
);
12907 /* Symbol's value is nil (or symbol is unbound)
12908 Get the cddr of the original list
12909 and if possible find the caddr and use that. */
12913 else if (!CONSP (elt
))
12918 else if (INTEGERP (car
))
12920 register int lim
= XINT (car
);
12924 /* Negative int means reduce maximum width. */
12925 if (precision
<= 0)
12928 precision
= min (precision
, -lim
);
12932 /* Padding specified. Don't let it be more than
12933 current maximum. */
12935 lim
= min (precision
, lim
);
12937 /* If that's more padding than already wanted, queue it.
12938 But don't reduce padding already specified even if
12939 that is beyond the current truncation point. */
12940 field_width
= max (lim
, field_width
);
12944 else if (STRINGP (car
) || CONSP (car
))
12946 register int limit
= 50;
12947 /* Limit is to protect against circular lists. */
12950 && (precision
<= 0 || n
< precision
))
12952 n
+= display_mode_element (it
, depth
, field_width
- n
,
12953 precision
- n
, XCAR (elt
));
12962 if (frame_title_ptr
)
12963 n
+= store_frame_title ("*invalid*", 0, precision
- n
);
12965 n
+= display_string ("*invalid*", Qnil
, Qnil
, 0, 0, it
, 0,
12966 precision
- n
, 0, 0);
12970 /* Pad to FIELD_WIDTH. */
12971 if (field_width
> 0 && n
< field_width
)
12973 if (frame_title_ptr
)
12974 n
+= store_frame_title ("", field_width
- n
, 0);
12976 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
12984 /* Write a null-terminated, right justified decimal representation of
12985 the positive integer D to BUF using a minimal field width WIDTH. */
12988 pint2str (buf
, width
, d
)
12989 register char *buf
;
12990 register int width
;
12993 register char *p
= buf
;
13001 *p
++ = d
% 10 + '0';
13006 for (width
-= (int) (p
- buf
); width
> 0; --width
)
13017 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
13018 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
13019 type of CODING_SYSTEM. Return updated pointer into BUF. */
13021 static unsigned char invalid_eol_type
[] = "(*invalid*)";
13024 decode_mode_spec_coding (coding_system
, buf
, eol_flag
)
13025 Lisp_Object coding_system
;
13026 register char *buf
;
13030 int multibyte
= !NILP (current_buffer
->enable_multibyte_characters
);
13031 unsigned char *eol_str
;
13033 /* The EOL conversion we are using. */
13034 Lisp_Object eoltype
;
13036 val
= Fget (coding_system
, Qcoding_system
);
13039 if (!VECTORP (val
)) /* Not yet decided. */
13044 eoltype
= eol_mnemonic_undecided
;
13045 /* Don't mention EOL conversion if it isn't decided. */
13049 Lisp_Object eolvalue
;
13051 eolvalue
= Fget (coding_system
, Qeol_type
);
13054 *buf
++ = XFASTINT (XVECTOR (val
)->contents
[1]);
13058 /* The EOL conversion that is normal on this system. */
13060 if (NILP (eolvalue
)) /* Not yet decided. */
13061 eoltype
= eol_mnemonic_undecided
;
13062 else if (VECTORP (eolvalue
)) /* Not yet decided. */
13063 eoltype
= eol_mnemonic_undecided
;
13064 else /* INTEGERP (eolvalue) -- 0:LF, 1:CRLF, 2:CR */
13065 eoltype
= (XFASTINT (eolvalue
) == 0
13066 ? eol_mnemonic_unix
13067 : (XFASTINT (eolvalue
) == 1
13068 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
13074 /* Mention the EOL conversion if it is not the usual one. */
13075 if (STRINGP (eoltype
))
13077 eol_str
= XSTRING (eoltype
)->data
;
13078 eol_str_len
= XSTRING (eoltype
)->size
;
13080 else if (INTEGERP (eoltype
)
13081 && CHAR_VALID_P (XINT (eoltype
), 0))
13083 eol_str
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
13084 eol_str_len
= CHAR_STRING (XINT (eoltype
), eol_str
);
13088 eol_str
= invalid_eol_type
;
13089 eol_str_len
= sizeof (invalid_eol_type
) - 1;
13091 bcopy (eol_str
, buf
, eol_str_len
);
13092 buf
+= eol_str_len
;
13098 /* Return a string for the output of a mode line %-spec for window W,
13099 generated by character C. PRECISION >= 0 means don't return a
13100 string longer than that value. FIELD_WIDTH > 0 means pad the
13101 string returned with spaces to that value. */
13103 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
13106 decode_mode_spec (w
, c
, field_width
, precision
)
13109 int field_width
, precision
;
13112 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
13113 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
13114 struct buffer
*b
= XBUFFER (w
->buffer
);
13121 if (!NILP (b
->read_only
))
13123 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
13128 /* This differs from %* only for a modified read-only buffer. */
13129 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
13131 if (!NILP (b
->read_only
))
13136 /* This differs from %* in ignoring read-only-ness. */
13137 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
13149 if (command_loop_level
> 5)
13151 p
= decode_mode_spec_buf
;
13152 for (i
= 0; i
< command_loop_level
; i
++)
13155 return decode_mode_spec_buf
;
13163 if (command_loop_level
> 5)
13165 p
= decode_mode_spec_buf
;
13166 for (i
= 0; i
< command_loop_level
; i
++)
13169 return decode_mode_spec_buf
;
13176 /* Let lots_of_dashes be a string of infinite length. */
13177 if (field_width
<= 0
13178 || field_width
> sizeof (lots_of_dashes
))
13180 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
13181 decode_mode_spec_buf
[i
] = '-';
13182 decode_mode_spec_buf
[i
] = '\0';
13183 return decode_mode_spec_buf
;
13186 return lots_of_dashes
;
13195 int col
= current_column ();
13196 XSETFASTINT (w
->column_number_displayed
, col
);
13197 pint2str (decode_mode_spec_buf
, field_width
, col
);
13198 return decode_mode_spec_buf
;
13202 /* %F displays the frame name. */
13203 if (!NILP (f
->title
))
13204 return (char *) XSTRING (f
->title
)->data
;
13205 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
13206 return (char *) XSTRING (f
->name
)->data
;
13215 int startpos
= XMARKER (w
->start
)->charpos
;
13216 int startpos_byte
= marker_byte_position (w
->start
);
13217 int line
, linepos
, linepos_byte
, topline
;
13219 int height
= XFASTINT (w
->height
);
13221 /* If we decided that this buffer isn't suitable for line numbers,
13222 don't forget that too fast. */
13223 if (EQ (w
->base_line_pos
, w
->buffer
))
13225 /* But do forget it, if the window shows a different buffer now. */
13226 else if (BUFFERP (w
->base_line_pos
))
13227 w
->base_line_pos
= Qnil
;
13229 /* If the buffer is very big, don't waste time. */
13230 if (INTEGERP (Vline_number_display_limit
)
13231 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
13233 w
->base_line_pos
= Qnil
;
13234 w
->base_line_number
= Qnil
;
13238 if (!NILP (w
->base_line_number
)
13239 && !NILP (w
->base_line_pos
)
13240 && XFASTINT (w
->base_line_pos
) <= startpos
)
13242 line
= XFASTINT (w
->base_line_number
);
13243 linepos
= XFASTINT (w
->base_line_pos
);
13244 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
13249 linepos
= BUF_BEGV (b
);
13250 linepos_byte
= BUF_BEGV_BYTE (b
);
13253 /* Count lines from base line to window start position. */
13254 nlines
= display_count_lines (linepos
, linepos_byte
,
13258 topline
= nlines
+ line
;
13260 /* Determine a new base line, if the old one is too close
13261 or too far away, or if we did not have one.
13262 "Too close" means it's plausible a scroll-down would
13263 go back past it. */
13264 if (startpos
== BUF_BEGV (b
))
13266 XSETFASTINT (w
->base_line_number
, topline
);
13267 XSETFASTINT (w
->base_line_pos
, BUF_BEGV (b
));
13269 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
13270 || linepos
== BUF_BEGV (b
))
13272 int limit
= BUF_BEGV (b
);
13273 int limit_byte
= BUF_BEGV_BYTE (b
);
13275 int distance
= (height
* 2 + 30) * line_number_display_limit_width
;
13277 if (startpos
- distance
> limit
)
13279 limit
= startpos
- distance
;
13280 limit_byte
= CHAR_TO_BYTE (limit
);
13283 nlines
= display_count_lines (startpos
, startpos_byte
,
13285 - (height
* 2 + 30),
13287 /* If we couldn't find the lines we wanted within
13288 line_number_display_limit_width chars per line,
13289 give up on line numbers for this window. */
13290 if (position
== limit_byte
&& limit
== startpos
- distance
)
13292 w
->base_line_pos
= w
->buffer
;
13293 w
->base_line_number
= Qnil
;
13297 XSETFASTINT (w
->base_line_number
, topline
- nlines
);
13298 XSETFASTINT (w
->base_line_pos
, BYTE_TO_CHAR (position
));
13301 /* Now count lines from the start pos to point. */
13302 nlines
= display_count_lines (startpos
, startpos_byte
,
13303 PT_BYTE
, PT
, &junk
);
13305 /* Record that we did display the line number. */
13306 line_number_displayed
= 1;
13308 /* Make the string to show. */
13309 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
13310 return decode_mode_spec_buf
;
13313 char* p
= decode_mode_spec_buf
;
13314 int pad
= field_width
- 2;
13320 return decode_mode_spec_buf
;
13326 obj
= b
->mode_name
;
13330 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
13336 int pos
= marker_position (w
->start
);
13337 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
13339 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
13341 if (pos
<= BUF_BEGV (b
))
13346 else if (pos
<= BUF_BEGV (b
))
13350 if (total
> 1000000)
13351 /* Do it differently for a large value, to avoid overflow. */
13352 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
13354 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
13355 /* We can't normally display a 3-digit number,
13356 so get us a 2-digit number that is close. */
13359 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
13360 return decode_mode_spec_buf
;
13364 /* Display percentage of size above the bottom of the screen. */
13367 int toppos
= marker_position (w
->start
);
13368 int botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
13369 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
13371 if (botpos
>= BUF_ZV (b
))
13373 if (toppos
<= BUF_BEGV (b
))
13380 if (total
> 1000000)
13381 /* Do it differently for a large value, to avoid overflow. */
13382 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
13384 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
13385 /* We can't normally display a 3-digit number,
13386 so get us a 2-digit number that is close. */
13389 if (toppos
<= BUF_BEGV (b
))
13390 sprintf (decode_mode_spec_buf
, "Top%2d%%", total
);
13392 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
13393 return decode_mode_spec_buf
;
13398 /* status of process */
13399 obj
= Fget_buffer_process (w
->buffer
);
13401 return "no process";
13402 #ifdef subprocesses
13403 obj
= Fsymbol_name (Fprocess_status (obj
));
13407 case 't': /* indicate TEXT or BINARY */
13408 #ifdef MODE_LINE_BINARY_TEXT
13409 return MODE_LINE_BINARY_TEXT (b
);
13415 /* coding-system (not including end-of-line format) */
13417 /* coding-system (including end-of-line type) */
13419 int eol_flag
= (c
== 'Z');
13420 char *p
= decode_mode_spec_buf
;
13422 if (! FRAME_WINDOW_P (f
))
13424 /* No need to mention EOL here--the terminal never needs
13425 to do EOL conversion. */
13426 p
= decode_mode_spec_coding (keyboard_coding
.symbol
, p
, 0);
13427 p
= decode_mode_spec_coding (terminal_coding
.symbol
, p
, 0);
13429 p
= decode_mode_spec_coding (b
->buffer_file_coding_system
,
13432 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
13433 #ifdef subprocesses
13434 obj
= Fget_buffer_process (Fcurrent_buffer ());
13435 if (PROCESSP (obj
))
13437 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
13439 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
13442 #endif /* subprocesses */
13445 return decode_mode_spec_buf
;
13450 return (char *) XSTRING (obj
)->data
;
13456 /* Count up to COUNT lines starting from START / START_BYTE.
13457 But don't go beyond LIMIT_BYTE.
13458 Return the number of lines thus found (always nonnegative).
13460 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
13463 display_count_lines (start
, start_byte
, limit_byte
, count
, byte_pos_ptr
)
13464 int start
, start_byte
, limit_byte
, count
;
13467 register unsigned char *cursor
;
13468 unsigned char *base
;
13470 register int ceiling
;
13471 register unsigned char *ceiling_addr
;
13472 int orig_count
= count
;
13474 /* If we are not in selective display mode,
13475 check only for newlines. */
13476 int selective_display
= (!NILP (current_buffer
->selective_display
)
13477 && !INTEGERP (current_buffer
->selective_display
));
13481 while (start_byte
< limit_byte
)
13483 ceiling
= BUFFER_CEILING_OF (start_byte
);
13484 ceiling
= min (limit_byte
- 1, ceiling
);
13485 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
13486 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
13489 if (selective_display
)
13490 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
13493 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
13496 if (cursor
!= ceiling_addr
)
13500 start_byte
+= cursor
- base
+ 1;
13501 *byte_pos_ptr
= start_byte
;
13505 if (++cursor
== ceiling_addr
)
13511 start_byte
+= cursor
- base
;
13516 while (start_byte
> limit_byte
)
13518 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
13519 ceiling
= max (limit_byte
, ceiling
);
13520 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
13521 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
13524 if (selective_display
)
13525 while (--cursor
!= ceiling_addr
13526 && *cursor
!= '\n' && *cursor
!= 015)
13529 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
13532 if (cursor
!= ceiling_addr
)
13536 start_byte
+= cursor
- base
+ 1;
13537 *byte_pos_ptr
= start_byte
;
13538 /* When scanning backwards, we should
13539 not count the newline posterior to which we stop. */
13540 return - orig_count
- 1;
13546 /* Here we add 1 to compensate for the last decrement
13547 of CURSOR, which took it past the valid range. */
13548 start_byte
+= cursor
- base
+ 1;
13552 *byte_pos_ptr
= limit_byte
;
13555 return - orig_count
+ count
;
13556 return orig_count
- count
;
13562 /***********************************************************************
13564 ***********************************************************************/
13566 /* Display a NUL-terminated string, starting with index START.
13568 If STRING is non-null, display that C string. Otherwise, the Lisp
13569 string LISP_STRING is displayed.
13571 If FACE_STRING is not nil, FACE_STRING_POS is a position in
13572 FACE_STRING. Display STRING or LISP_STRING with the face at
13573 FACE_STRING_POS in FACE_STRING:
13575 Display the string in the environment given by IT, but use the
13576 standard display table, temporarily.
13578 FIELD_WIDTH is the minimum number of output glyphs to produce.
13579 If STRING has fewer characters than FIELD_WIDTH, pad to the right
13580 with spaces. If STRING has more characters, more than FIELD_WIDTH
13581 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
13583 PRECISION is the maximum number of characters to output from
13584 STRING. PRECISION < 0 means don't truncate the string.
13586 This is roughly equivalent to printf format specifiers:
13588 FIELD_WIDTH PRECISION PRINTF
13589 ----------------------------------------
13595 MULTIBYTE zero means do not display multibyte chars, > 0 means do
13596 display them, and < 0 means obey the current buffer's value of
13597 enable_multibyte_characters.
13599 Value is the number of glyphs produced. */
13602 display_string (string
, lisp_string
, face_string
, face_string_pos
,
13603 start
, it
, field_width
, precision
, max_x
, multibyte
)
13604 unsigned char *string
;
13605 Lisp_Object lisp_string
;
13606 Lisp_Object face_string
;
13607 int face_string_pos
;
13610 int field_width
, precision
, max_x
;
13613 int hpos_at_start
= it
->hpos
;
13614 int saved_face_id
= it
->face_id
;
13615 struct glyph_row
*row
= it
->glyph_row
;
13617 /* Initialize the iterator IT for iteration over STRING beginning
13618 with index START. We assume that IT may be modified here (which
13619 means that display_line has to do something when displaying a
13620 mini-buffer prompt, which it does). */
13621 reseat_to_string (it
, string
, lisp_string
, start
,
13622 precision
, field_width
, multibyte
);
13624 /* If displaying STRING, set up the face of the iterator
13625 from LISP_STRING, if that's given. */
13626 if (STRINGP (face_string
))
13632 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
13633 0, it
->region_beg_charpos
,
13634 it
->region_end_charpos
,
13635 &endptr
, it
->base_face_id
);
13636 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
13637 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
13640 /* Set max_x to the maximum allowed X position. Don't let it go
13641 beyond the right edge of the window. */
13643 max_x
= it
->last_visible_x
;
13645 max_x
= min (max_x
, it
->last_visible_x
);
13647 /* Skip over display elements that are not visible. because IT->w is
13649 if (it
->current_x
< it
->first_visible_x
)
13650 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
13651 MOVE_TO_POS
| MOVE_TO_X
);
13653 row
->ascent
= it
->max_ascent
;
13654 row
->height
= it
->max_ascent
+ it
->max_descent
;
13655 row
->phys_ascent
= it
->max_phys_ascent
;
13656 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
13658 /* This condition is for the case that we are called with current_x
13659 past last_visible_x. */
13660 while (it
->current_x
< max_x
)
13662 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
13664 /* Get the next display element. */
13665 if (!get_next_display_element (it
))
13668 /* Produce glyphs. */
13669 x_before
= it
->current_x
;
13670 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
13671 PRODUCE_GLYPHS (it
);
13673 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
13676 while (i
< nglyphs
)
13678 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
13680 if (!it
->truncate_lines_p
13681 && x
+ glyph
->pixel_width
> max_x
)
13683 /* End of continued line or max_x reached. */
13684 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
13688 else if (x
+ glyph
->pixel_width
> it
->first_visible_x
)
13690 /* Glyph is at least partially visible. */
13692 if (x
< it
->first_visible_x
)
13693 it
->glyph_row
->x
= x
- it
->first_visible_x
;
13697 /* Glyph is off the left margin of the display area.
13698 Should not happen. */
13702 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
13703 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
13704 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
13705 row
->phys_height
= max (row
->phys_height
,
13706 it
->max_phys_ascent
+ it
->max_phys_descent
);
13707 x
+= glyph
->pixel_width
;
13711 /* Stop if max_x reached. */
13715 /* Stop at line ends. */
13716 if (ITERATOR_AT_END_OF_LINE_P (it
))
13718 it
->continuation_lines_width
= 0;
13722 set_iterator_to_next (it
, 1);
13724 /* Stop if truncating at the right edge. */
13725 if (it
->truncate_lines_p
13726 && it
->current_x
>= it
->last_visible_x
)
13728 /* Add truncation mark, but don't do it if the line is
13729 truncated at a padding space. */
13730 if (IT_CHARPOS (*it
) < it
->string_nchars
)
13732 if (!FRAME_WINDOW_P (it
->f
))
13733 produce_special_glyphs (it
, IT_TRUNCATION
);
13734 it
->glyph_row
->truncated_on_right_p
= 1;
13740 /* Maybe insert a truncation at the left. */
13741 if (it
->first_visible_x
13742 && IT_CHARPOS (*it
) > 0)
13744 if (!FRAME_WINDOW_P (it
->f
))
13745 insert_left_trunc_glyphs (it
);
13746 it
->glyph_row
->truncated_on_left_p
= 1;
13749 it
->face_id
= saved_face_id
;
13751 /* Value is number of columns displayed. */
13752 return it
->hpos
- hpos_at_start
;
13757 /* This is like a combination of memq and assq. Return 1 if PROPVAL
13758 appears as an element of LIST or as the car of an element of LIST.
13759 If PROPVAL is a list, compare each element against LIST in that
13760 way, and return 1 if any element of PROPVAL is found in LIST.
13761 Otherwise return 0. This function cannot quit. */
13764 invisible_p (propval
, list
)
13765 register Lisp_Object propval
;
13768 register Lisp_Object tail
, proptail
;
13770 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
13772 register Lisp_Object tem
;
13774 if (EQ (propval
, tem
))
13776 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
13780 if (CONSP (propval
))
13782 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
13784 Lisp_Object propelt
;
13785 propelt
= XCAR (proptail
);
13786 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
13788 register Lisp_Object tem
;
13790 if (EQ (propelt
, tem
))
13792 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
13802 /* Return 1 if PROPVAL appears as the car of an element of LIST and
13803 the cdr of that element is non-nil. If PROPVAL is a list, check
13804 each element of PROPVAL in that way, and the first time some
13805 element is found, return 1 if the cdr of that element is non-nil.
13806 Otherwise return 0. This function cannot quit. */
13809 invisible_ellipsis_p (propval
, list
)
13810 register Lisp_Object propval
;
13813 register Lisp_Object tail
, proptail
;
13815 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
13817 register Lisp_Object tem
;
13819 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
13820 return ! NILP (XCDR (tem
));
13823 if (CONSP (propval
))
13824 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
13826 Lisp_Object propelt
;
13827 propelt
= XCAR (proptail
);
13828 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
13830 register Lisp_Object tem
;
13832 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
13833 return ! NILP (XCDR (tem
));
13842 /***********************************************************************
13844 ***********************************************************************/
13849 Vwith_echo_area_save_vector
= Qnil
;
13850 staticpro (&Vwith_echo_area_save_vector
);
13852 Vmessage_stack
= Qnil
;
13853 staticpro (&Vmessage_stack
);
13855 Qinhibit_redisplay
= intern ("inhibit-redisplay");
13856 staticpro (&Qinhibit_redisplay
);
13859 defsubr (&Sdump_glyph_matrix
);
13860 defsubr (&Sdump_glyph_row
);
13861 defsubr (&Sdump_tool_bar_row
);
13862 defsubr (&Strace_redisplay_toggle
);
13863 defsubr (&Strace_to_stderr
);
13866 staticpro (&Qmenu_bar_update_hook
);
13867 Qmenu_bar_update_hook
= intern ("menu-bar-update-hook");
13869 staticpro (&Qoverriding_terminal_local_map
);
13870 Qoverriding_terminal_local_map
= intern ("overriding-terminal-local-map");
13872 staticpro (&Qoverriding_local_map
);
13873 Qoverriding_local_map
= intern ("overriding-local-map");
13875 staticpro (&Qwindow_scroll_functions
);
13876 Qwindow_scroll_functions
= intern ("window-scroll-functions");
13878 staticpro (&Qredisplay_end_trigger_functions
);
13879 Qredisplay_end_trigger_functions
= intern ("redisplay-end-trigger-functions");
13881 staticpro (&Qinhibit_point_motion_hooks
);
13882 Qinhibit_point_motion_hooks
= intern ("inhibit-point-motion-hooks");
13884 QCdata
= intern (":data");
13885 staticpro (&QCdata
);
13886 Qdisplay
= intern ("display");
13887 staticpro (&Qdisplay
);
13888 Qspace_width
= intern ("space-width");
13889 staticpro (&Qspace_width
);
13890 Qraise
= intern ("raise");
13891 staticpro (&Qraise
);
13892 Qspace
= intern ("space");
13893 staticpro (&Qspace
);
13894 Qmargin
= intern ("margin");
13895 staticpro (&Qmargin
);
13896 Qleft_margin
= intern ("left-margin");
13897 staticpro (&Qleft_margin
);
13898 Qright_margin
= intern ("right-margin");
13899 staticpro (&Qright_margin
);
13900 Qalign_to
= intern ("align-to");
13901 staticpro (&Qalign_to
);
13902 QCalign_to
= intern (":align-to");
13903 staticpro (&QCalign_to
);
13904 Qrelative_width
= intern ("relative-width");
13905 staticpro (&Qrelative_width
);
13906 QCrelative_width
= intern (":relative-width");
13907 staticpro (&QCrelative_width
);
13908 QCrelative_height
= intern (":relative-height");
13909 staticpro (&QCrelative_height
);
13910 QCeval
= intern (":eval");
13911 staticpro (&QCeval
);
13912 Qwhen
= intern ("when");
13913 staticpro (&Qwhen
);
13914 QCfile
= intern (":file");
13915 staticpro (&QCfile
);
13916 Qfontified
= intern ("fontified");
13917 staticpro (&Qfontified
);
13918 Qfontification_functions
= intern ("fontification-functions");
13919 staticpro (&Qfontification_functions
);
13920 Qtrailing_whitespace
= intern ("trailing-whitespace");
13921 staticpro (&Qtrailing_whitespace
);
13922 Qimage
= intern ("image");
13923 staticpro (&Qimage
);
13924 Qmessage_truncate_lines
= intern ("message-truncate-lines");
13925 staticpro (&Qmessage_truncate_lines
);
13926 Qgrow_only
= intern ("grow-only");
13927 staticpro (&Qgrow_only
);
13929 last_arrow_position
= Qnil
;
13930 last_arrow_string
= Qnil
;
13931 staticpro (&last_arrow_position
);
13932 staticpro (&last_arrow_string
);
13934 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
13935 staticpro (&echo_buffer
[0]);
13936 staticpro (&echo_buffer
[1]);
13938 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
13939 staticpro (&echo_area_buffer
[0]);
13940 staticpro (&echo_area_buffer
[1]);
13942 Vmessages_buffer_name
= build_string ("*Messages*");
13943 staticpro (&Vmessages_buffer_name
);
13945 DEFVAR_LISP ("show-trailing-whitespace", &Vshow_trailing_whitespace
,
13946 "Non-nil means highlight trailing whitespace.\n\
13947 The face used for trailing whitespace is `trailing-whitespace'.");
13948 Vshow_trailing_whitespace
= Qnil
;
13950 DEFVAR_LISP ("inhibit-redisplay", &Vinhibit_redisplay
,
13951 "Non-nil means don't actually do any redisplay.\n\
13952 This is used for internal purposes.");
13953 Vinhibit_redisplay
= Qnil
;
13955 DEFVAR_LISP ("global-mode-string", &Vglobal_mode_string
,
13956 "String (or mode line construct) included (normally) in `mode-line-format'.");
13957 Vglobal_mode_string
= Qnil
;
13959 DEFVAR_LISP ("overlay-arrow-position", &Voverlay_arrow_position
,
13960 "Marker for where to display an arrow on top of the buffer text.\n\
13961 This must be the beginning of a line in order to work.\n\
13962 See also `overlay-arrow-string'.");
13963 Voverlay_arrow_position
= Qnil
;
13965 DEFVAR_LISP ("overlay-arrow-string", &Voverlay_arrow_string
,
13966 "String to display as an arrow. See also `overlay-arrow-position'.");
13967 Voverlay_arrow_string
= Qnil
;
13969 DEFVAR_INT ("scroll-step", &scroll_step
,
13970 "*The number of lines to try scrolling a window by when point moves out.\n\
13971 If that fails to bring point back on frame, point is centered instead.\n\
13972 If this is zero, point is always centered after it moves off frame.\n\
13973 If you want scrolling to always be a line at a time, you should set\n\
13974 `scroll-conservatively' to a large value rather than set this to 1.");
13976 DEFVAR_INT ("scroll-conservatively", &scroll_conservatively
,
13977 "*Scroll up to this many lines, to bring point back on screen.\n\
13978 A value of zero means to scroll the text to center point vertically\n\
13980 scroll_conservatively
= 0;
13982 DEFVAR_INT ("scroll-margin", &scroll_margin
,
13983 "*Number of lines of margin at the top and bottom of a window.\n\
13984 Recenter the window whenever point gets within this many lines\n\
13985 of the top or bottom of the window.");
13989 DEFVAR_INT ("debug-end-pos", &debug_end_pos
, "Don't ask");
13992 DEFVAR_BOOL ("truncate-partial-width-windows",
13993 &truncate_partial_width_windows
,
13994 "*Non-nil means truncate lines in all windows less than full frame wide.");
13995 truncate_partial_width_windows
= 1;
13997 DEFVAR_BOOL ("mode-line-inverse-video", &mode_line_inverse_video
,
13998 "nil means display the mode-line/header-line/menu-bar in the default face.\n\
13999 Any other value means to use the appropriate face, `mode-line',\n\
14000 `header-line', or `menu' respectively.\n\
14002 This variable is deprecated; please change the above faces instead.");
14003 mode_line_inverse_video
= 1;
14005 DEFVAR_LISP ("line-number-display-limit", &Vline_number_display_limit
,
14006 "*Maximum buffer size for which line number should be displayed.\n\
14007 If the buffer is bigger than this, the line number does not appear\n\
14008 in the mode line. A value of nil means no limit.");
14009 Vline_number_display_limit
= Qnil
;
14011 DEFVAR_INT ("line-number-display-limit-width",
14012 &line_number_display_limit_width
,
14013 "*Maximum line width (in characters) for line number display.\n\
14014 If the average length of the lines near point is bigger than this, then the\n\
14015 line number may be omitted from the mode line.");
14016 line_number_display_limit_width
= 200;
14018 DEFVAR_BOOL ("highlight-nonselected-windows", &highlight_nonselected_windows
,
14019 "*Non-nil means highlight region even in nonselected windows.");
14020 highlight_nonselected_windows
= 0;
14022 DEFVAR_BOOL ("multiple-frames", &multiple_frames
,
14023 "Non-nil if more than one frame is visible on this display.\n\
14024 Minibuffer-only frames don't count, but iconified frames do.\n\
14025 This variable is not guaranteed to be accurate except while processing\n\
14026 `frame-title-format' and `icon-title-format'.");
14028 DEFVAR_LISP ("frame-title-format", &Vframe_title_format
,
14029 "Template for displaying the title bar of visible frames.\n\
14030 \(Assuming the window manager supports this feature.)\n\
14031 This variable has the same structure as `mode-line-format' (which see),\n\
14032 and is used only on frames for which no explicit name has been set\n\
14033 \(see `modify-frame-parameters').");
14034 DEFVAR_LISP ("icon-title-format", &Vicon_title_format
,
14035 "Template for displaying the title bar of an iconified frame.\n\
14036 \(Assuming the window manager supports this feature.)\n\
14037 This variable has the same structure as `mode-line-format' (which see),\n\
14038 and is used only on frames for which no explicit name has been set\n\
14039 \(see `modify-frame-parameters').");
14041 = Vframe_title_format
14042 = Fcons (intern ("multiple-frames"),
14043 Fcons (build_string ("%b"),
14044 Fcons (Fcons (build_string (""),
14045 Fcons (intern ("invocation-name"),
14046 Fcons (build_string ("@"),
14047 Fcons (intern ("system-name"),
14051 DEFVAR_LISP ("message-log-max", &Vmessage_log_max
,
14052 "Maximum number of lines to keep in the message log buffer.\n\
14053 If nil, disable message logging. If t, log messages but don't truncate\n\
14054 the buffer when it becomes large.");
14055 XSETFASTINT (Vmessage_log_max
, 50);
14057 DEFVAR_LISP ("window-size-change-functions", &Vwindow_size_change_functions
,
14058 "Functions called before redisplay, if window sizes have changed.\n\
14059 The value should be a list of functions that take one argument.\n\
14060 Just before redisplay, for each frame, if any of its windows have changed\n\
14061 size since the last redisplay, or have been split or deleted,\n\
14062 all the functions in the list are called, with the frame as argument.");
14063 Vwindow_size_change_functions
= Qnil
;
14065 DEFVAR_LISP ("window-scroll-functions", &Vwindow_scroll_functions
,
14066 "List of Functions to call before redisplaying a window with scrolling.\n\
14067 Each function is called with two arguments, the window\n\
14068 and its new display-start position. Note that the value of `window-end'\n\
14069 is not valid when these functions are called.");
14070 Vwindow_scroll_functions
= Qnil
;
14072 DEFVAR_BOOL ("auto-resize-tool-bars", &auto_resize_tool_bars_p
,
14073 "*Non-nil means automatically resize tool-bars.\n\
14074 This increases a tool-bar's height if not all tool-bar items are visible.\n\
14075 It decreases a tool-bar's height when it would display blank lines\n\
14077 auto_resize_tool_bars_p
= 1;
14079 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", &auto_raise_tool_bar_buttons_p
,
14080 "*Non-nil means raise tool-bar buttons when the mouse moves over them.");
14081 auto_raise_tool_bar_buttons_p
= 1;
14083 DEFVAR_INT ("tool-bar-button-margin", &tool_bar_button_margin
,
14084 "*Margin around tool-bar buttons in pixels.");
14085 tool_bar_button_margin
= 1;
14087 DEFVAR_INT ("tool-bar-button-relief", &tool_bar_button_relief
,
14088 "Relief thickness of tool-bar buttons.");
14089 tool_bar_button_relief
= 3;
14091 DEFVAR_LISP ("fontification-functions", &Vfontification_functions
,
14092 "List of functions to call to fontify regions of text.\n\
14093 Each function is called with one argument POS. Functions must\n\
14094 fontify a region starting at POS in the current buffer, and give\n\
14095 fontified regions the property `fontified'.\n\
14096 This variable automatically becomes buffer-local when set.");
14097 Vfontification_functions
= Qnil
;
14098 Fmake_variable_buffer_local (Qfontification_functions
);
14100 DEFVAR_BOOL ("unibyte-display-via-language-environment",
14101 &unibyte_display_via_language_environment
,
14102 "*Non-nil means display unibyte text according to language environment.\n\
14103 Specifically this means that unibyte non-ASCII characters\n\
14104 are displayed by converting them to the equivalent multibyte characters\n\
14105 according to the current language environment. As a result, they are\n\
14106 displayed according to the current fontset.");
14107 unibyte_display_via_language_environment
= 0;
14109 DEFVAR_LISP ("max-mini-window-height", &Vmax_mini_window_height
,
14110 "*Maximum height for resizing mini-windows.\n\
14111 If a float, it specifies a fraction of the mini-window frame's height.\n\
14112 If an integer, it specifies a number of lines.");
14113 Vmax_mini_window_height
= make_float (0.25);
14115 DEFVAR_LISP ("resize-mini-windows", &Vresize_mini_windows
,
14116 "*How to resize the mini-window.\n\
14117 A value of nil means don't automatically resize mini-windows.\n\
14118 A value of t means resize it to fit the text displayed in it.\n\
14119 A value of `grow-only', the default, means let mini-windows grow\n\
14120 only, until the its display becomes empty, at which point the mini-window\n\
14121 goes back to its normal size.");
14122 Vresize_mini_windows
= Qgrow_only
;
14124 DEFVAR_BOOL ("cursor-in-non-selected-windows",
14125 &cursor_in_non_selected_windows
,
14126 "*Non-nil means display a hollow cursor in non-selected windows.\n\
14127 Nil means don't display a cursor there.");
14128 cursor_in_non_selected_windows
= 1;
14130 DEFVAR_BOOL ("automatic-hscrolling", &automatic_hscrolling_p
,
14131 "*Non-nil means scroll the display automatically to make point visible.");
14132 automatic_hscrolling_p
= 1;
14134 DEFVAR_LISP ("image-types", &Vimage_types
,
14135 "List of supported image types.\n\
14136 Each element of the list is a symbol for a supported image type.");
14137 Vimage_types
= Qnil
;
14139 DEFVAR_BOOL ("message-truncate-lines", &message_truncate_lines
,
14140 "If non-nil, messages are truncated instead of resizing the echo area.\n\
14141 Bind this around calls to `message' to let it take effect.");
14142 message_truncate_lines
= 0;
14144 DEFVAR_LISP ("menu-bar-update-hook", &Vmenu_bar_update_hook
,
14145 "Normal hook run for clicks on menu bar, before displaying a submenu.\n\
14146 Can be used to update submenus whose contents should vary.");
14147 Vmenu_bar_update_hook
= Qnil
;
14151 /* Initialize this module when Emacs starts. */
14156 Lisp_Object root_window
;
14157 struct window
*mini_w
;
14159 current_header_line_height
= current_mode_line_height
= -1;
14161 CHARPOS (this_line_start_pos
) = 0;
14163 mini_w
= XWINDOW (minibuf_window
);
14164 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
14166 if (!noninteractive
)
14168 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
14171 XSETFASTINT (XWINDOW (root_window
)->top
, FRAME_TOP_MARGIN (f
));
14172 set_window_height (root_window
,
14173 FRAME_HEIGHT (f
) - 1 - FRAME_TOP_MARGIN (f
),
14175 XSETFASTINT (mini_w
->top
, FRAME_HEIGHT (f
) - 1);
14176 set_window_height (minibuf_window
, 1, 0);
14178 XSETFASTINT (XWINDOW (root_window
)->width
, FRAME_WIDTH (f
));
14179 XSETFASTINT (mini_w
->width
, FRAME_WIDTH (f
));
14181 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
14182 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
14183 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
14185 /* The default ellipsis glyphs `...'. */
14186 for (i
= 0; i
< 3; ++i
)
14187 XSETFASTINT (default_invis_vector
[i
], '.');
14190 #ifdef HAVE_WINDOW_SYSTEM
14192 /* Allocate the buffer for frame titles. */
14194 frame_title_buf
= (char *) xmalloc (size
);
14195 frame_title_buf_end
= frame_title_buf
+ size
;
14196 frame_title_ptr
= NULL
;
14198 #endif /* HAVE_WINDOW_SYSTEM */
14200 help_echo_showing_p
= 0;